quetch 0.2.1 → 0.3.0

package/dist/types/FieldFunctionFormatDate.js

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

package/dist/types/FieldFunctionFormatDate.js.map

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

package/dist/types/FieldFunctionReturn.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Return types of custom field functions.
+ */
+export type FieldFunctionReturn = {
+    formatDate: string;
+};

package/dist/types/FieldFunctionReturn.js

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

package/dist/types/FieldFunctionReturn.js.map

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

package/dist/types/Filter.d.ts

@@ -0,0 +1,12 @@
+import type { FilterArray } from "./FilterArray";
+import type { FilterBoolean } from "./FilterBoolean";
+import type { FilterField } from "./FilterField";
+import type { FilterNumber } from "./FilterNumber";
+import type { FilterSequence } from "./FilterSequence";
+import type { FilterString } from "./FilterString";
+import type { FilterStringIntersect } from "./FilterStringIntersect";
+import type { FilterStringMatch } from "./FilterStringMatch";
+/**
+ * Describes a predicate for filtering items.
+ */
+export type Filter<T extends object> = FilterSequence<T> | FilterField<T> | FilterBoolean<T> | FilterString<T> | FilterStringMatch<T> | FilterStringIntersect<T> | FilterNumber<T> | FilterArray<T>;

package/dist/types/Filter.js

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

package/dist/types/Filter.js.map

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

package/dist/types/FilterArray.d.ts

@@ -0,0 +1,10 @@
+import type { Any } from "./Any";
+import type { FilterKeys } from "./FilterKeys";
+/**
+ * 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[];
+};

package/dist/types/FilterArray.js

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

package/dist/types/FilterArray.js.map

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

package/dist/types/FilterBoolean.d.ts

@@ -0,0 +1,9 @@
+import type { FilterKeys } from "./FilterKeys";
+/**
+ * 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;
+};

package/dist/types/FilterBoolean.js

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

package/dist/types/FilterBoolean.js.map

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

package/dist/types/FilterField.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks if a given field exists.
+ */
+export type FilterField<T extends object> = {
+    operator: "exist";
+    field: keyof T;
+};

package/dist/types/FilterField.js

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

package/dist/types/FilterField.js.map

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

package/dist/types/FilterKeys.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Returns object type with field extending the provided `P` type.
+ */
+export type FilterKeys<T extends object, P> = {
+    [K in keyof T]-?: T[K] extends P ? K : never;
+}[keyof T];

package/dist/types/FilterKeys.js

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

package/dist/types/FilterKeys.js.map

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

package/dist/types/FilterNumber.d.ts

@@ -0,0 +1,9 @@
+import type { FilterKeys } from "./FilterKeys";
+/**
+ * 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;
+};

package/dist/types/FilterNumber.js

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

package/dist/types/FilterNumber.js.map

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

package/dist/types/FilterOperator.d.ts

@@ -0,0 +1,2 @@
+import type { Filter } from "./Filter";
+export type FilterOperator = Filter<never>["operator"];

package/dist/types/FilterOperator.js

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

package/dist/types/FilterOperator.js.map

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

package/dist/types/FilterSequence.d.ts

@@ -0,0 +1,23 @@
+import type { Filter } from "./Filter";
+/**
+ * Joins a list of filters with a specific boolean operator.
+ */
+export type FilterSequence<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>[];
+};

package/dist/types/FilterSequence.js

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

package/dist/types/FilterSequence.js.map

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

package/dist/types/FilterString.d.ts

@@ -0,0 +1,9 @@
+import type { FilterKeys } from "./FilterKeys";
+/**
+ * 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;
+};

package/dist/types/FilterString.js

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

package/dist/types/FilterString.js.map

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

package/dist/types/FilterStringIntersect.d.ts

@@ -0,0 +1,9 @@
+import type { FilterKeys } from "./FilterKeys";
+/**
+ * Checks if a given string field has any of the provided values.
+ */
+export type FilterStringIntersect<T extends object> = {
+    operator: "intersect";
+    field: FilterKeys<T, string>;
+    value: string[];
+};

package/dist/types/FilterStringIntersect.js

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

package/dist/types/FilterStringIntersect.js.map

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

package/dist/types/FilterStringMatch.d.ts

@@ -0,0 +1,29 @@
+import type { FilterKeys } from "./FilterKeys";
+/**
+ * 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;
+};

package/dist/types/FilterStringMatch.js

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

package/dist/types/FilterStringMatch.js.map

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

package/dist/types/Get.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Returns the type of the property at the specified `K` key.
+ */
+export type Get<T extends object, K extends string, D> = T extends {
+    [key in K]: any;
+} ? T[K] : D;

package/dist/types/Get.js

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

package/dist/types/Get.js.map

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

package/dist/types/Group.d.ts

@@ -0,0 +1,8 @@
+import type { CustomFieldAggregateMap } from "./CustomFieldAggregateMap";
+/**
+ * Specifies how items should be grouped.
+ */
+export type Group<T extends object> = keyof T | {
+    field: keyof T;
+    customFields?: CustomFieldAggregateMap<T>;
+};

package/dist/types/Group.js

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

package/dist/types/Group.js.map

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

package/dist/types/Handler.d.ts

@@ -0,0 +1,5 @@
+import type { NextHandler } from "./NextHandler";
+/**
+ * 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>;

package/dist/types/Handler.js

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

package/dist/types/Handler.js.map

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

package/dist/types/Immutable.d.ts

@@ -0,0 +1,3 @@
+export type Immutable<T extends object> = {
+    readonly [K in keyof T]: T[K];
+};

package/dist/types/Immutable.js

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

package/dist/types/Immutable.js.map

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

package/dist/types/InjectCustomFields.d.ts

@@ -0,0 +1,9 @@
+import type { CustomFieldMap } from "./CustomFieldMap";
+import type { FieldFunctionCustom } from "./FieldFunctionCustom";
+import type { FieldFunctionReturn } from "./FieldFunctionReturn";
+/**
+ * Injects the custom fields into the entity type.
+ */
+export type InjectCustomFields<T extends object, C extends CustomFieldMap<T> | undefined> = 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;
+} : T;

package/dist/types/InjectCustomFields.js

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

package/dist/types/InjectCustomFields.js.map

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

package/dist/types/Item.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Returns the inferred item type of an array, or an alternative type if it is something else (e.g., `undefined`).
+ */
+export type Item<T, S = undefined> = T extends Array<infer I> ? I : T extends ReadonlyArray<infer I> ? I : S;

package/dist/types/Item.js

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

package/dist/types/Item.js.map

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

package/dist/types/Key.d.ts

@@ -0,0 +1 @@
+export type Key = string | number | symbol;

package/dist/types/Key.js

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

package/dist/types/Key.js.map

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

package/dist/types/Mutable.d.ts

@@ -0,0 +1,3 @@
+export type Mutable<T extends object> = {
+    -readonly [K in keyof T]: T[K];
+};

package/dist/types/Mutable.js

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

package/dist/types/Mutable.js.map

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

package/dist/types/NextHandler.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Handles an `input` query and returns an `output` promise.
+ */
+export type NextHandler<I, R> = (input: I) => Promise<R>;

package/dist/types/NextHandler.js

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

package/dist/types/NextHandler.js.map

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

package/dist/types/Order.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Order item.
+ */
+export type Order<T extends object> = keyof T | {
+    field: keyof T;
+    descending?: boolean;
+};

package/dist/types/Order.js

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

package/dist/types/Order.js.map

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

package/dist/types/Query.d.ts

@@ -0,0 +1,23 @@
+import type { Context } from "./Context";
+import type { CustomFieldMap } from "./CustomFieldMap";
+import type { InjectCustomFields } from "./InjectCustomFields";
+import type { QueryAggregate } from "./QueryAggregate";
+import type { QueryCreate } from "./QueryCreate";
+import type { QueryCreateMultiple } from "./QueryCreateMultiple";
+import type { QueryDelete } from "./QueryDelete";
+import type { QueryDeleteMultiple } from "./QueryDeleteMultiple";
+import type { QueryRead } from "./QueryRead";
+import type { QueryReadMultiple } from "./QueryReadMultiple";
+import type { QueryUpdate } from "./QueryUpdate";
+import type { QueryUpdateMultiple } from "./QueryUpdateMultiple";
+type QueryBase<T extends object> = QueryRead<T> | QueryReadMultiple<T> | QueryCreate<T> | QueryCreateMultiple<T> | QueryUpdate<T> | QueryUpdateMultiple<T> | QueryDelete<T> | QueryDeleteMultiple<T> | QueryAggregate<T>;
+/**
+ * Query that fetches or mutates an entity.
+ */
+export type Query<T extends object, C extends CustomFieldMap<T> | undefined> = QueryBase<InjectCustomFields<T, C>> & {
+    /**
+     * Common item properties to use for identifying the item.
+     */
+    context?: Context<T>;
+};
+export {};

package/dist/types/Query.js

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

package/dist/types/Query.js.map

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

package/dist/types/QueryAggregate.d.ts

@@ -0,0 +1,10 @@
+import type { AggregateFunction } from "./AggregateFunction";
+import type { Filter } from "./Filter";
+/**
+ * Query for computing an aggregated value.
+ */
+export type QueryAggregate<T extends object> = {
+    method: "aggregate";
+    aggregator: AggregateFunction<T>;
+    filter?: Filter<T>;
+};

package/dist/types/QueryAggregate.js

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

package/dist/types/QueryAggregate.js.map

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

package/dist/types/QueryAny.d.ts

@@ -0,0 +1,7 @@
+import type { CustomFieldMap } from "./CustomFieldMap";
+import type { Key } from "./Key";
+import type { Query } from "./Query";
+export type QueryAny = Query<any, any> & {
+    type: Key | any[];
+    customFields?: CustomFieldMap<any>;
+};

package/dist/types/QueryAny.js

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

package/dist/types/QueryAny.js.map

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

package/dist/types/QueryCreate.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Query for creating an item.
+ */
+export type QueryCreate<T extends object> = {
+    method: "create";
+    value: Partial<T>;
+};

package/dist/types/QueryCreate.js

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

package/dist/types/QueryCreate.js.map

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

package/dist/types/QueryCreateMultiple.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Query for creating multiple items.
+ */
+export type QueryCreateMultiple<T extends object> = {
+    method: "create";
+    multiple: true;
+    value: Partial<T>[];
+};

package/dist/types/QueryCreateMultiple.js

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

package/dist/types/QueryCreateMultiple.js.map

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

package/dist/types/QueryDelete.d.ts

@@ -0,0 +1,10 @@
+import type { CustomFieldMap } from "./CustomFieldMap";
+import type { Filter } from "./Filter";
+/**
+ * Query for deleting an item.
+ */
+export type QueryDelete<T extends object> = {
+    method: "delete";
+    filter?: Filter<T>;
+    customFields?: CustomFieldMap<T>;
+};

package/dist/types/QueryDelete.js

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

package/dist/types/QueryDelete.js.map

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

package/dist/types/QueryDeleteMultiple.d.ts

@@ -0,0 +1,11 @@
+import type { CustomFieldMap } from "./CustomFieldMap";
+import type { Filter } from "./Filter";
+/**
+ * Query for deleting multiple items.
+ */
+export type QueryDeleteMultiple<T extends object> = {
+    method: "delete";
+    multiple: true;
+    filter?: Filter<T>;
+    customFields?: CustomFieldMap<T>;
+};

package/dist/types/QueryDeleteMultiple.js

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

package/dist/types/QueryDeleteMultiple.js.map

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

package/dist/types/QueryMethod.d.ts

@@ -0,0 +1,5 @@
+import type { Query } from "./Query";
+/**
+ * Available query methods.
+ */
+export type QueryMethod = Exclude<Query<never, never>["method"], undefined>;

package/dist/types/QueryMethod.js

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

package/dist/types/QueryMethod.js.map

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

package/dist/types/QueryRead.d.ts

@@ -0,0 +1,23 @@
+import type { Filter } from "./Filter";
+import type { Order } from "./Order";
+/**
+ * Query for reading a single item.
+ */
+export type QueryRead<T extends object> = {
+    method?: "read";
+    multiple?: false;
+    offset?: never;
+    group?: never;
+    /**
+     * 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>;
+    /**
+     * Order by which the items should be sorted.
+     */
+    order?: Order<T>[];
+};

package/dist/types/QueryRead.js

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

package/dist/types/QueryRead.js.map

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