@plumile/router 0.1.12 → 0.1.13

package/lib/esm/routing/filters.d.ts

@@ -0,0 +1,97 @@
+export type FilterOperator = 'eq' | 'neq' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'nin' | 'between' | 'exists' | 'contains' | 'starts' | 'ends' | 'regex';
+export type FilterValueKind = 'string' | 'number';
+export interface FilterFieldDefinition<Kind extends FilterValueKind = FilterValueKind> {
+    __filter: true;
+    kind: Kind;
+    operators?: FilterOperator[];
+    dedupe?: boolean;
+    label?: string;
+    normalize?: (raw: string) => string;
+    defaults?: Partial<Kind extends 'number' ? {
+        eq: number[];
+        neq: number[];
+        gt: number[];
+        gte: number[];
+        lt: number[];
+        lte: number[];
+        in: number[];
+        nin: number[];
+        between: [number, number][];
+        exists: boolean;
+    } : {
+        eq: string[];
+        neq: string[];
+        in: string[];
+        nin: string[];
+        between: [string, string][];
+        exists: boolean;
+        contains: string[];
+        starts: string[];
+        ends: string[];
+        regex: string[];
+    }>;
+}
+export type FilterSchema = Record<string, FilterFieldDefinition>;
+export interface DefinedFilterSchema<F extends FilterSchema> {
+    __defined: true;
+    schema: F;
+}
+export declare function numberFilter(def?: Partial<Omit<FilterFieldDefinition<'number'>, '__filter' | 'kind'>>): FilterFieldDefinition<'number'>;
+export declare function stringFilter(def?: Partial<Omit<FilterFieldDefinition<'string'>, '__filter' | 'kind'>>): FilterFieldDefinition<'string'>;
+export declare function defineFilters<F extends FilterSchema>(schema: F): DefinedFilterSchema<F>;
+export type OperatorValue<K extends FilterValueKind> = K extends 'number' ? {
+    eq?: number[];
+    neq?: number[];
+    gt?: number[];
+    gte?: number[];
+    lt?: number[];
+    lte?: number[];
+    in?: number[];
+    nin?: number[];
+    between?: [number, number][];
+    exists?: boolean;
+} : {
+    eq?: string[];
+    neq?: string[];
+    in?: string[];
+    nin?: string[];
+    between?: [string, string][];
+    exists?: boolean;
+    contains?: string[];
+    starts?: string[];
+    ends?: string[];
+    regex?: string[];
+};
+export type InferFilters<F extends FilterSchema> = {
+    [K in keyof F]: OperatorValue<F[K]['kind']>;
+};
+export declare function parseFilters<F extends DefinedFilterSchema<FilterSchema>>(defined: F, rawQuery: Record<string, string | string[]>): InferFilters<F['schema']>;
+export declare const OPERATOR_PRIORITY: FilterOperator[];
+export type FiltersPatch<F> = {
+    [K in keyof F]?: Partial<F[K]>;
+};
+export declare function buildFiltersQuery<F extends DefinedFilterSchema<FilterSchema>>(defined: F, currentQuery: Record<string, unknown>, next: InferFilters<F['schema']>): Record<string, unknown>;
+export interface UseFiltersHelpers<F> {
+    set: (next: F | ((p: F) => F), navOpts?: {
+        replace?: boolean;
+        batch?: boolean;
+        internalBatch?: boolean;
+    }) => void;
+    patch: (delta: FiltersPatch<F>, navOpts?: {
+        replace?: boolean;
+        batch?: boolean;
+        internalBatch?: boolean;
+    }) => void;
+    clear: (fields?: (keyof F)[], navOpts?: {
+        replace?: boolean;
+        batch?: boolean;
+        internalBatch?: boolean;
+    }) => void;
+}
+export declare function useFilters(defined?: DefinedFilterSchema<FilterSchema>): [
+    Record<string, Record<string, unknown>>,
+    UseFiltersHelpers<Record<string, Record<string, unknown>>>
+];
+export declare const useQueryFilters: typeof useFilters;
+export default useFilters;
+//# sourceMappingURL=filters.d.ts.map

package/lib/esm/routing/filters.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"filters.d.ts","sourceRoot":"","sources":["../../../src/routing/filters.ts"],"names":[],"mappings":"AAOA,MAAM,MAAM,cAAc,GACtB,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,IAAI,GACJ,KAAK,GACL,SAAS,GACT,QAAQ,GACR,UAAU,GACV,QAAQ,GACR,MAAM,GACN,OAAO,CAAC;AAEZ,MAAM,MAAM,eAAe,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAElD,MAAM,WAAW,qBAAqB,CACpC,IAAI,SAAS,eAAe,GAAG,eAAe;IAE9C,QAAQ,EAAE,IAAI,CAAC;IACf,IAAI,EAAE,IAAI,CAAC;IACX,SAAS,CAAC,EAAE,cAAc,EAAE,CAAC;IAC7B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAC;IACpC,QAAQ,CAAC,EAAE,OAAO,CAChB,IAAI,SAAS,QAAQ,GACjB;QACE,EAAE,EAAE,MAAM,EAAE,CAAC;QACb,GAAG,EAAE,MAAM,EAAE,CAAC;QACd,EAAE,EAAE,MAAM,EAAE,CAAC;QACb,GAAG,EAAE,MAAM,EAAE,CAAC;QACd,EAAE,EAAE,MAAM,EAAE,CAAC;QACb,GAAG,EAAE,MAAM,EAAE,CAAC;QACd,EAAE,EAAE,MAAM,EAAE,CAAC;QACb,GAAG,EAAE,MAAM,EAAE,CAAC;QACd,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;QAC5B,MAAM,EAAE,OAAO,CAAC;KACjB,GACD;QACE,EAAE,EAAE,MAAM,EAAE,CAAC;QACb,GAAG,EAAE,MAAM,EAAE,CAAC;QACd,EAAE,EAAE,MAAM,EAAE,CAAC;QACb,GAAG,EAAE,MAAM,EAAE,CAAC;QACd,OAAO,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;QAC5B,MAAM,EAAE,OAAO,CAAC;QAChB,QAAQ,EAAE,MAAM,EAAE,CAAC;QACnB,MAAM,EAAE,MAAM,EAAE,CAAC;QACjB,IAAI,EAAE,MAAM,EAAE,CAAC;QACf,KAAK,EAAE,MAAM,EAAE,CAAC;KACjB,CACN,CAAC;CACH;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;AACjE,MAAM,WAAW,mBAAmB,CAAC,CAAC,SAAS,YAAY;IACzD,SAAS,EAAE,IAAI,CAAC;IAChB,MAAM,EAAE,CAAC,CAAC;CACX;AAGD,wBAAgB,YAAY,CAC1B,GAAG,GAAE,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,CAAM,GAC5E,qBAAqB,CAAC,QAAQ,CAAC,CAEjC;AAED,wBAAgB,YAAY,CAC1B,GAAG,GAAE,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,EAAE,UAAU,GAAG,MAAM,CAAC,CAAM,GAC5E,qBAAqB,CAAC,QAAQ,CAAC,CAEjC;AAED,wBAAgB,aAAa,CAAC,CAAC,SAAS,YAAY,EAClD,MAAM,EAAE,CAAC,GACR,mBAAmB,CAAC,CAAC,CAAC,CAExB;AAKD,MAAM,MAAM,aAAa,CAAC,CAAC,SAAS,eAAe,IAAI,CAAC,SAAS,QAAQ,GACrE;IACE,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IAC7B,MAAM,CAAC,EAAE,OAAO,CAAC;CAClB,GACD;IACE,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;IAC7B,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB,CAAC;AACN,MAAM,MAAM,YAAY,CAAC,CAAC,SAAS,YAAY,IAAI;KAChD,CAAC,IAAI,MAAM,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;CAC5C,CAAC;AA2IF,wBAAgB,YAAY,CAAC,CAAC,SAAS,mBAAmB,CAAC,YAAY,CAAC,EACtE,OAAO,EAAE,CAAC,EACV,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,GAC1C,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAyJ3B;AAKD,eAAO,MAAM,iBAAiB,EAAE,cAAc,EAc7C,CAAC;AAEF,MAAM,MAAM,YAAY,CAAC,CAAC,IAAI;KAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAC;AAwBjE,wBAAgB,iBAAiB,CAAC,CAAC,SAAS,mBAAmB,CAAC,YAAY,CAAC,EAC3E,OAAO,EAAE,CAAC,EACV,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACrC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,GAC9B,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAwGzB;AAKD,MAAM,WAAW,iBAAiB,CAAC,CAAC;IAClC,GAAG,EAAE,CACH,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,EACvB,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE,KACtE,IAAI,CAAC;IACV,KAAK,EAAE,CACL,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC,EACtB,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE,KACtE,IAAI,CAAC;IACV,KAAK,EAAE,CACL,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,EAAE,EACpB,OAAO,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,OAAO,CAAC;QAAC,KAAK,CAAC,EAAE,OAAO,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE,KACtE,IAAI,CAAC;CACX;AAOD,wBAAgB,UAAU,CACxB,OAAO,CAAC,EAAE,mBAAmB,CAAC,YAAY,CAAC,GAC1C;IACD,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACvC,iBAAiB,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAC;CAC3D,CAiLA;AAED,eAAO,MAAM,eAAe,mBAAa,CAAC;AAC1C,eAAe,UAAU,CAAC"}