quetch 0.1.0

package/dist/tools/sortItemList.d.ts

@@ -0,0 +1,9 @@
+import type { Order } from "../types";
+/**
+ * Sorts provided `value` array *in place* according to the `orderList`.
+ *
+ * @param orderList The order to use for sorting.
+ * @param value The array to sort.
+ * @returns The same array sorted in place.
+ */
+export declare function sortItemList<T extends object>(orderList: Order<T>[] | undefined, value: T[]): T[];

package/dist/tools/sortItemList.js

@@ -0,0 +1,28 @@
+import { normalizeOrder } from "./normalizeOrder";
+/**
+ * Sorts provided `value` array *in place* according to the `orderList`.
+ *
+ * @param orderList The order to use for sorting.
+ * @param value The array to sort.
+ * @returns The same array sorted in place.
+ */
+export function sortItemList(orderList, value) {
+    if (orderList === undefined || orderList.length === 0) {
+        return value;
+    }
+    const normalizedOrderBy = orderList.map(normalizeOrder);
+    return value.sort((a, b) => {
+        for (let index = 0; index < normalizedOrderBy.length; index++) {
+            const { field, descending } = normalizedOrderBy[index];
+            if (a[field] === b[field]) {
+                continue;
+            }
+            if (a[field] > b[field]) {
+                return descending ? -1 : 1;
+            }
+            return descending ? 1 : -1;
+        }
+        return 0;
+    });
+}
+//# sourceMappingURL=sortItemList.js.map

package/dist/tools/sortItemList.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortItemList.js","sourceRoot":"","sources":["../../lib/tools/sortItemList.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;;;;GAMG;AACH,MAAM,UAAU,YAAY,CAC1B,SAAiC,EACjC,KAAU;IAEV,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QACrD,OAAO,KAAK,CAAC;KACd;IACD,MAAM,iBAAiB,GAAG,SAAS,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACxD,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;QACzB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,iBAAiB,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YAC7D,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;YACvD,IAAI,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,EAAE;gBACzB,SAAS;aACV;YACD,IAAI,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,EAAE;gBACvB,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;aAC5B;YACD,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;SAC5B;QACD,OAAO,CAAC,CAAC;IACX,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/tools/sortItemList.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tools/sortItemList.test.js

@@ -0,0 +1,47 @@
+import { expect, test } from "vitest";
+import { sortItemList } from "./sortItemList";
+test("sorts items", () => {
+    expect(sortItemList(["a", "c"], [
+        { a: 1, c: "a" },
+        { a: 2, c: "a" },
+        { a: 3, c: "b" },
+        { a: 2, c: "b" },
+        { a: 1, c: "b" },
+    ])).toEqual([
+        { a: 1, c: "a" },
+        { a: 1, c: "b" },
+        { a: 2, c: "a" },
+        { a: 2, c: "b" },
+        { a: 3, c: "b" },
+    ]);
+    expect(sortItemList([
+        { field: "a", descending: true },
+        { field: "c", descending: true },
+    ], [
+        { a: 1, c: "a" },
+        { a: 2, c: "a" },
+        { a: 3, c: "b" },
+        { a: 2, c: "b" },
+        { a: 1, c: "b" },
+    ])).toEqual([
+        { a: 3, c: "b" },
+        { a: 2, c: "b" },
+        { a: 2, c: "a" },
+        { a: 1, c: "b" },
+        { a: 1, c: "a" },
+    ]);
+    expect(sortItemList(["a", { field: "c", descending: true }], [
+        { a: 1, c: "a" },
+        { a: 2, c: "a" },
+        { a: 3, c: "b" },
+        { a: 2, c: "b" },
+        { a: 1, c: "b" },
+    ])).toEqual([
+        { a: 1, c: "b" },
+        { a: 1, c: "a" },
+        { a: 2, c: "b" },
+        { a: 2, c: "a" },
+        { a: 3, c: "b" },
+    ]);
+});
+//# sourceMappingURL=sortItemList.test.js.map

package/dist/tools/sortItemList.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortItemList.test.js","sourceRoot":"","sources":["../../lib/tools/sortItemList.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAE9C,IAAI,CAAC,aAAa,EAAE,GAAG,EAAE;IACvB,MAAM,CACJ,YAAY,CACV,CAAC,GAAG,EAAE,GAAG,CAAC,EACV;QACE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;KACjB,CACF,CACF,CAAC,OAAO,CAAC;QACR,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;KACjB,CAAC,CAAC;IACH,MAAM,CACJ,YAAY,CACV;QACE,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE;QAChC,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE;KACjC,EACD;QACE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;KACjB,CACF,CACF,CAAC,OAAO,CAAC;QACR,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;KACjB,CAAC,CAAC;IACH,MAAM,CACJ,YAAY,CACV,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,UAAU,EAAE,IAAI,EAAE,CAAC,EACvC;QACE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;KACjB,CACF,CACF,CAAC,OAAO,CAAC;QACR,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;QAChB,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,GAAG,EAAE;KACjB,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/tools.d.ts

@@ -0,0 +1,8 @@
+export { defineCheckQuery } from "./tools/defineCheckQuery";
+export { defineCustomFetch } from "./tools/defineCustomFetch";
+export { filterFromContext } from "./tools/filterFromContext";
+export { filterItem } from "./tools/filterItem";
+export { impasse } from "./tools/impasse";
+export { normalizeOrder } from "./tools/normalizeOrder";
+export { queryItemList } from "./tools/queryItemList";
+export { sortItemList } from "./tools/sortItemList";

package/dist/tools.js

@@ -0,0 +1,10 @@
+// File automatically generated by `vite-plugin-module-list`
+export { defineCheckQuery } from "./tools/defineCheckQuery";
+export { defineCustomFetch } from "./tools/defineCustomFetch";
+export { filterFromContext } from "./tools/filterFromContext";
+export { filterItem } from "./tools/filterItem";
+export { impasse } from "./tools/impasse";
+export { normalizeOrder } from "./tools/normalizeOrder";
+export { queryItemList } from "./tools/queryItemList";
+export { sortItemList } from "./tools/sortItemList";
+//# sourceMappingURL=tools.js.map

package/dist/tools.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tools.js","sourceRoot":"","sources":["../lib/tools.ts"],"names":[],"mappings":"AAAA,4DAA4D;AAC5D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,oBAAoB,CAAC;AAChD,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAC1C,OAAO,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AACxD,OAAO,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,396 @@
+export type Any = boolean | string | number | object | symbol | null | undefined | Array<any> | ((...args: any[]) => any);
+export type Store<T = any> = {
+    has(key: string): Promise<boolean>;
+    get(key: string): Promise<T>;
+    set(key: string, value: T): Promise<void>;
+    delete(key: string): Promise<void>;
+};
+/**
+ * Handles an `input` query and returns an `output` promise, eventually using the `next` handler.
+ */
+export type Handler<I, O, NI, No> = (input: I, next: NextHandler<NI, No>) => Promise<O>;
+/**
+ * Handles an `input` query and returns an `output` promise.
+ */
+export type NextHandler<I, R> = (input: I) => Promise<R>;
+/**
+ * Returns the inferred item type of an array, or an alternative type if it is something else (e.g., `undefined`).
+ */
+type ArrayItem<T, S> = T extends Array<infer I> ? I : T extends ReadonlyArray<infer I> ? I : S;
+type Get<T extends object, K extends string, D> = T extends {
+    [key in K]: any;
+} ? T[K] : D;
+/**
+ * Entity type for a given query.
+ */
+export type EntityItem<E extends object, C extends CustomFieldMap<E>, Q extends Query<E, C>> = Q extends {
+    customFields: CustomFieldMap<E>;
+} ? {
+    readonly [K in ArrayItem<Get<Q, "fields", undefined>, keyof E | keyof Q["customFields"]>]: K extends keyof E ? E[K] : K extends keyof Q["customFields"] ? Q["customFields"][K] extends FieldFunctionCustom<E> ? ReturnType<Q["customFields"][K]["value"]> : Q["customFields"][K]["operator"] extends keyof FieldFunctionReturn ? FieldFunctionReturn[Q["customFields"][K]["operator"]] : never : never;
+} : {
+    readonly [K in ArrayItem<Get<Q, "fields", undefined>, keyof E>]: K extends keyof E ? E[K] : never;
+};
+/**
+ * Query that fetches or mutates an entity.
+ */
+export type Query<T extends object, C extends CustomFieldMap<T>> = QueryGet<T, C> | QueryGetMultiple<T, C> | QueryCreate<T> | QueryCreateMultiple<T> | QueryUpdate<T, C> | QueryUpdateMultiple<T, C> | QueryDelete<T> | QueryDeleteMultiple<T> | QueryAggregate<T>;
+export type AnyQuery = Query<any, any>;
+export type AnyQueryExternal = Omit<Query<any, any>, "type"> & {
+    type: string;
+};
+export type AnyQueryLocal = Omit<Query<any, any>, "type"> & {
+    type: object[];
+};
+export type Context<T extends object> = {
+    [K in keyof T]?: T[K];
+};
+export type QueryBase<T extends object> = {
+    type: string | T[];
+    /**
+     * Common item properties to use for identifying the item.
+     *
+     * @example
+     * ```typescript
+     * { context: { id: "000001" } }
+     * { context: { organisation: "World Company" } }
+     * ```
+     */
+    context?: Context<T>;
+    /**
+     * Abort signal to abort the request.
+     */
+    signal?: AbortSignal;
+};
+/**
+ * Available query methods.
+ */
+export type QueryMethod = Exclude<Query<never, never>["method"], undefined>;
+/**
+ * Injects the custom fields into the entity type.
+ */
+type InjectCustomField<T extends object, C extends CustomFieldMap<T>> = {
+    readonly [K in keyof T | keyof C]: K extends keyof T ? T[K] : K extends keyof C ? C[K] extends FieldFunctionCustom<T> ? ReturnType<C[K]["value"]> : C[K]["operator"] extends keyof FieldFunctionReturn ? FieldFunctionReturn[C[K]["operator"]] : never : never;
+};
+/**
+ * Query for getting a single item.
+ */
+export type QueryGet<T extends object, C extends CustomFieldMap<T>> = QueryBase<T> & {
+    method?: "get";
+    multiple?: false;
+    offset?: never;
+    orderBy?: never;
+    groupBy?: never;
+} & ({
+    /**
+     * Item fields to pick. If omitted, all fields are picked.
+     */
+    fields?: readonly (keyof InjectCustomField<T, C>)[];
+    /**
+     * Filter for finding the item, if it cannot be found based on the `context`.
+     */
+    filter?: Filter<InjectCustomField<T, C>>;
+    /**
+     * Custom fields to add to each item, which can be used in the `filter`.
+     */
+    customFields: C;
+} | {
+    /**
+     * Item fields to pick. If omitted, all fields are picked.
+     */
+    fields?: readonly (keyof T)[];
+    /**
+     * Filter for finding the item, if it cannot be found based on the `context`.
+     */
+    filter?: Filter<T>;
+    customFields?: never;
+});
+/**
+ * Query for getting a list of items.
+ */
+export type QueryGetMultiple<T extends object, C extends CustomFieldMap<T>> = QueryBase<T> & {
+    method?: "get";
+    multiple: true;
+    /**
+     * Offset of the first matching item.
+     */
+    offset?: number;
+    /**
+     * Upper bound of the number of items to return.
+     */
+    limit?: number;
+} & ({
+    /**
+     * Item fields to pick. If omitted, all fields are picked.
+     */
+    fields?: readonly (keyof InjectCustomField<T, C>)[];
+    /**
+     * Filter that picks the items.
+     */
+    filter?: Filter<InjectCustomField<T, C>>;
+    /**
+     * Custom fields to add to each item, which can be used in the `filter` and `groupBy`.
+     */
+    customFields: C;
+    /**
+     * Order by which the items should be sorted.
+     */
+    orderBy?: Order<InjectCustomField<T, C>>[];
+    /**
+     * Groups items by specified fields.
+     */
+    groupBy?: Group<InjectCustomField<T, C>>[];
+} | {
+    /**
+     * Item fields to pick. If omitted, all fields are picked.
+     */
+    fields?: readonly (keyof T)[];
+    /**
+     * Filter that picks the items.
+     */
+    filter?: Filter<T>;
+    customFields?: never;
+    /**
+     * Order by which the items should be sorted.
+     */
+    orderBy?: Order<T>[];
+    /**
+     * Groups items by specified fields.
+     */
+    groupBy?: Group<T>[];
+});
+/**
+ * Query for creating an item.
+ */
+export type QueryCreate<T extends object> = QueryBase<T> & {
+    method: "create";
+    value: Partial<T>;
+};
+/**
+ * Query for creating multiple items.
+ */
+export type QueryCreateMultiple<T extends object> = QueryBase<T> & {
+    method: "create";
+    multiple: true;
+    value: Partial<T>[];
+};
+/**
+ * Query for updating an item.
+ */
+export type QueryUpdate<T extends object, C extends CustomFieldMap<T>> = QueryBase<T> & {
+    method: "update";
+    value: Partial<T>;
+    /**
+     * Custom fields to add to each item, which can be used in the `filter`.
+     */
+    customFields?: C;
+    /**
+     * Filter for finding the item, if it cannot be found based on the `context`.
+     */
+    filter?: Filter<InjectCustomField<T, C>>;
+    offset?: never;
+    orderBy: never;
+    groupBy?: never;
+};
+/**
+ * Query for updating multiple items.
+ */
+export type QueryUpdateMultiple<T extends object, C extends CustomFieldMap<T>> = QueryBase<T> & {
+    method: "update";
+    multiple: true;
+    value: Partial<T>[];
+    /**
+     * Custom fields to add to each item, which can be used in the `filter`.
+     */
+    customFields?: C;
+    filter?: Filter<T>;
+    /**
+     * Order by which the items should be sorted.
+     */
+    orderBy?: Order<InjectCustomField<T, C>>[];
+    /**
+     * Offset of the first matching item to update.
+     */
+    offset?: number;
+    /**
+     * Sets the upper bound of the number of items to update.
+     */
+    limit?: number;
+};
+/**
+ * Query for deleting an item.
+ */
+export type QueryDelete<T extends object> = QueryBase<T> & {
+    method: "delete";
+    filter?: Filter<T>;
+};
+/**
+ * Query for deleting multiple items.
+ */
+export type QueryDeleteMultiple<T extends object> = QueryBase<T> & {
+    method: "delete";
+    multiple: true;
+    filter?: Filter<T>;
+};
+/**
+ * Query for computing an aggregated value.
+ */
+export type QueryAggregate<T extends object> = QueryBase<T> & {
+    method: "aggregate";
+    aggregator: AggregateFunction<T>;
+    filter?: Filter<T>;
+};
+/**
+ * Order item.
+ */
+export type Order<T extends object> = keyof T | {
+    field: keyof T;
+    descending?: boolean;
+};
+type FilterKeys<T extends object, P> = {
+    [K in keyof T]-?: T[K] extends P ? K : never;
+}[keyof T];
+export type FieldFunction<T extends object> = FieldFunctionCustom<T> | FieldFunctionFormatDate<T>;
+/**
+ * Applies a custom field transform function.
+ */
+export type FieldFunctionCustom<T extends object> = {
+    operator: "custom";
+    value: (item: T) => any;
+};
+/**
+ * Formats the date found in a given field, which can be an ISO string date or a timestamp.
+ */
+export type FieldFunctionFormatDate<T extends object> = {
+    operator: "formatDate";
+    field: FilterKeys<T, string | number>;
+    format: string;
+};
+/**
+ * Possible field function operators.
+ */
+export type FieldFunctionOperator = FieldFunction<never>["operator"];
+/**
+ * Return types of custom field functions.
+ */
+export type FieldFunctionReturn = {
+    formatDate: string;
+};
+export type CustomFieldMap<T extends object> = Record<string, FieldFunction<T>>;
+/**
+ * Aggregation function.
+ */
+export type AggregateFunction<T extends object> = "length" | {
+    operator: "length";
+} | {
+    operator: "median" | "standardDeviation" | "mean" | "minimum" | "maximum" | "variance" | "mode";
+    field: keyof T;
+};
+export type AggregateFunctionOperator = Exclude<AggregateFunction<{}>, string>["operator"];
+type CustomFieldAggregateMap<T extends object> = Record<string, AggregateFunction<T>>;
+type Group<T extends object> = keyof T | {
+    field: keyof T;
+    customFields?: CustomFieldAggregateMap<T>;
+};
+/**
+ * Describes a predicate for filtering items.
+ */
+export type Filter<T extends object> = FilterList<T> | FilterField<T> | FilterBoolean<T> | FilterString<T> | FilterStringMatch<T> | FilterStringInclude<T> | FilterNumber<T> | FilterArray<T>;
+export type FilterOperator = Filter<never>["operator"];
+/**
+ * Joins a list of filters with a specific boolean operator.
+ */
+export type FilterList<T extends object> = {
+    /**
+     * Boolean operator to use for joining the filters.
+     */
+    operator: "all";
+    /**
+     * Filters to join.
+     */
+    value: Filter<T>[];
+} | {
+    /**
+     * Boolean operator to use for joining the filters.
+     */
+    operator: "any" | "none";
+    /**
+     * Filters to join.
+     */
+    value?: Filter<T>[];
+};
+/**
+ * Checks if a given field exists.
+ */
+export type FilterField<T extends object> = {
+    operator: "exist";
+    field: keyof T;
+};
+/**
+ * Checks if a given boolean field is `true` or `false`.
+ */
+export type FilterBoolean<T extends object> = {
+    operator: "equal" | "notEqual";
+    field: FilterKeys<T, boolean>;
+    value: boolean;
+};
+/**
+ * Checks if a given string field matches a given string value according to a given operator.
+ */
+export type FilterString<T extends object> = {
+    operator: "equal" | "notEqual" | "startWith" | "endWith" | "include" | "greaterThan" | "greaterThanOrEqual" | "lowerThan" | "lowerThanOrEqual";
+    field: FilterKeys<T, string>;
+    value: string;
+};
+/**
+ * Checks if a given string field matches a given regular expression.
+ */
+export type FilterStringMatch<T extends object> = {
+    operator: "match";
+    field: FilterKeys<T, string>;
+    /**
+     * Raw regular expression string.
+     */
+    value: string;
+    /**
+     * Regular expression options.
+     */
+    options?: {
+        /**
+         * When matching, casing differences are ignored.
+         */
+        ignoreCase?: boolean;
+        /**
+         * Allows . to match newlines.
+         */
+        dotAll?: boolean;
+    };
+    /**
+     * Compiled regular expression generated by the `testFilter` function.
+     */
+    regularExpression?: RegExp;
+};
+/**
+ * Checks if a given string field has any of the provided values.
+ */
+export type FilterStringInclude<T extends object> = {
+    operator: "intersect";
+    field: FilterKeys<T, string>;
+    value: string[];
+};
+/**
+ * Checks if a given number field matches a given number value according to a given operator.
+ */
+export type FilterNumber<T extends object> = {
+    operator: "equal" | "notEqual" | "greaterThan" | "greaterThanOrEqual" | "lowerThan" | "lowerThanOrEqual";
+    field: FilterKeys<T, number>;
+    value: number;
+};
+/**
+ * Checks if a given array field matches a given array value according to a given operator.
+ */
+export type FilterArray<T extends object, P = Any> = {
+    operator: "equal" | "include" | "intersect";
+    field: FilterKeys<T, P[]>;
+    value: P[];
+};
+export {};

package/dist/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../lib/types.ts"],"names":[],"mappings":""}