refactor: export presetFilter

.changeset/lovely-singers-shop.md

@@ -0,0 +1,5 @@
+---
+"@fn-sphere/filter": patch
+---
+
+Export presetFilter

packages/filter/src/filter-builder.tsx

@@ -3,7 +3,7 @@ import { FilterProvider } from "./hooks/filter-provider.js";
 import { useView } from "./specs/hooks.js";
 import { FilterUiProvider, presetUiSpec } from "./specs/index.js";
 import type { UiSpec } from "./specs/types.js";
-import type { BasicFilterProps } from "./types.js";
+import type { BasicFilterBuilderProps } from "./types.js";
 
 export const FilterBuilder = <Data,>({
   schema,
@@ -22,7 +22,7 @@ export const FilterBuilder = <Data,>({
     views?: Partial<UiSpec["views"]>;
     primitives?: Partial<UiSpec["primitives"]>;
   };
-} & BasicFilterProps<Data>) => {
+} & BasicFilterBuilderProps<Data>) => {
   const FilterGroup = useView("FilterGroup");
 
   const normalizedSchema = {

packages/filter/src/flatten-filter-builder.tsx

@@ -2,15 +2,15 @@ import { countNumberOfRules, type FilterGroup } from "@fn-sphere/core";
 import { Fragment } from "react";
 import { FilterProvider } from "./hooks/filter-provider.js";
 import { useView } from "./specs/index.js";
-import type { BasicFilterProps } from "./types.js";
+import type { BasicFilterBuilderProps } from "./types.js";
 import {
   createEmptyFilterGroup,
   defaultMapFieldName,
   defaultMapFilterName,
   isFlattenFilterGroup,
 } from "./utils.js";
 
-type FilterBuilderProps<Data = unknown> = BasicFilterProps<Data> & {
+type FilterBuilderProps<Data = unknown> = BasicFilterBuilderProps<Data> & {
   rule?: FilterGroup;
   onChange?: (rule: FilterGroup) => void;
 };

packages/filter/src/hooks/filter-provider.tsx

@@ -2,11 +2,12 @@ import {
   type FilterField,
   type FilterGroup,
   findFilterableFields,
+  presetFilter,
 } from "@fn-sphere/core";
-import { type ReactNode, createContext } from "react";
+import { createContext, type ReactNode } from "react";
 import { z } from "zod";
 import { type FilterMap, fromFilterMap, toFilterMap } from "../filter-map.js";
-import type { BasicFilterProps } from "../types.js";
+import type { BasicFilterBuilderProps } from "../types.js";
 import {
   createEmptyFilterGroup,
   defaultMapFieldName,
@@ -16,9 +17,11 @@ import {
 type FilterContextType = {
   filterRule: FilterGroup;
   onRuleChange?: (filterGroup: FilterGroup) => void;
-} & BasicFilterProps<unknown>;
+} & BasicFilterBuilderProps<unknown>;
 
-type NormalizedFilterContextType = Required<BasicFilterProps<unknown>> & {
+type NormalizedFilterContextType = Required<
+  BasicFilterBuilderProps<unknown>
+> & {
   onRuleChange: (filterMap: FilterMap) => void;
 
   // derived properties
@@ -28,7 +31,7 @@ type NormalizedFilterContextType = Required<BasicFilterProps<unknown>> & {
 
 const defaultContext: NormalizedFilterContextType = {
   schema: z.unknown(),
-  filterList: [],
+  filterList: presetFilter,
   deepLimit: 1,
   mapFieldName: defaultMapFieldName,
   mapFilterName: defaultMapFilterName,
@@ -48,24 +51,26 @@ export const FilterProvider = ({
   value: FilterContextType;
   children: ReactNode;
 }) => {
+  const filterList = value.filterList ?? presetFilter;
+
   const filterableFields = findFilterableFields({
     schema: value.schema,
-    filterList: value.filterList,
+    filterList,
     maxDeep: value.deepLimit,
   });
 
   const contextValue = {
     deepLimit: value.deepLimit ?? defaultContext.deepLimit,
     mapFieldName: value.mapFieldName ?? defaultContext.mapFieldName,
     mapFilterName: value.mapFilterName ?? defaultContext.mapFilterName,
+    filterList,
     schema: value.schema,
-    filterList: value.filterList,
     onRuleChange: (filterMap: FilterMap) => {
       value.onRuleChange?.(fromFilterMap(filterMap));
     },
     filterMap: toFilterMap(value.filterRule),
     filterableFields,
-  };
+  } satisfies NormalizedFilterContextType;
 
   return (
     <FilterBuilderContext.Provider value={contextValue}>

packages/filter/src/index.ts

@@ -3,12 +3,21 @@ export { FlattenFilterBuilder } from "./flatten-filter-builder.js";
 export { useFilterGroup } from "./hooks/use-filter-group.js";
 export { useFilterRule } from "./hooks/use-filter-rule.js";
 export * from "./specs/index.js";
-export type { BasicFilterProps } from "./types.js";
+export type { BasicFilterBuilderProps } from "./types.js";
 export {
   createEmptyFilterGroup,
   createEmptyFilterRule,
   defaultMapFieldName,
   defaultMapFilterName,
 } from "./utils.js";
 
+export {
+  booleanFilter,
+  commonFilters,
+  dateFilter,
+  genericFilter,
+  numberFilter,
+  presetFilter,
+  stringFilter,
+} from "@fn-sphere/core";
 export type { FilterGroup, FilterRule, SingleFilter } from "@fn-sphere/core";

packages/filter/src/types.ts

@@ -23,9 +23,9 @@ export type FlattenFilterGroup = {
   }[];
 };
 
-export type BasicFilterProps<Data = unknown> = {
+export type BasicFilterBuilderProps<Data = unknown> = {
   schema: ZodType<Data>;
-  filterList: FnSchema[];
+  filterList?: FnSchema[];
   /**
    * The maximum nesting depth limit of the filter rule.
    *

packages/filter/src/utils.ts

@@ -3,7 +3,7 @@ import {
   type FilterGroup,
   type SingleFilter,
 } from "@fn-sphere/core";
-import type { BasicFilterProps, FlattenFilterGroup } from "./types.js";
+import type { BasicFilterBuilderProps, FlattenFilterGroup } from "./types.js";
 
 export const createEmptyFilterRule = () =>
   ({
@@ -36,7 +36,7 @@ export const isFlattenFilterGroup = (
 };
 
 export const defaultMapFieldName: NonNullable<
-  BasicFilterProps["mapFieldName"]
+  BasicFilterBuilderProps["mapFieldName"]
 > = (field) => {
   if (field.fieldSchema.description) {
     return field.fieldSchema.description;
@@ -48,7 +48,7 @@ export const defaultMapFieldName: NonNullable<
 };
 
 export const defaultMapFilterName: NonNullable<
-  BasicFilterProps["mapFilterName"]
+  BasicFilterBuilderProps["mapFilterName"]
 > = (filterSchema) => {
   return filterSchema.name;
 };

packages/playground/src/filter/create-advanced-filter.ts

@@ -7,7 +7,7 @@ import {
   createEmptyFilterGroup,
   defaultMapFieldName,
   defaultMapFilterName,
-  type BasicFilterProps,
+  type BasicFilterBuilderProps,
 } from "@fn-sphere/filter";
 import { createElement } from "react";
 import { createRoot } from "react-dom/client";
@@ -19,7 +19,7 @@ import {
 } from "./flatten-filter-dialog.js";
 
 type OpenFilterProps<Data = unknown> = {
-  filterBuilder: BasicFilterProps<Data> & {
+  filterBuilder: BasicFilterBuilderProps<Data> & {
     // uncontrolled mode only for the dialog
     defaultRule: FilterGroup | undefined;
   };
@@ -32,7 +32,7 @@ type OpenFilterProps<Data = unknown> = {
 type PartialBy<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
 
 export type CreateAdvancedFilterProps<Data = unknown> = PartialBy<
-  BasicFilterProps<Data>,
+  BasicFilterBuilderProps<Data>,
   "filterList"
 > & {
   defaultRule?: FilterGroup | undefined;