quetch 0.9.2 → 0.10.1

package/dist/types/QueryReadMultiple.d.ts

@@ -1,12 +1,19 @@
+import type { Context } from "./Context";
 import type { Filter } from "./Filter";
 import type { Group } from "./Group";
 import type { Order } from "./Order";
+import type { Parameters } from "./Parameters";
+import type { QuerySettings } from "./QuerySettings";
 /**
  * Query for getting a list of items.
  */
 export type QueryReadMultiple<T extends object> = {
     method?: "read";
     multiple: true;
+    /**
+     * Common item properties to use for identifying the item.
+     */
+    context?: Context<T>;
     /**
      * Offset of the first matching item.
      */
@@ -31,4 +38,12 @@ export type QueryReadMultiple<T extends object> = {
      * Groups items by specified fields.
      */
     group?: Group<T>[];
+    /**
+     * Query parameters.
+     */
+    parameters?: Parameters;
+    /**
+     * Query settings.
+     */
+    settings?: QuerySettings<T>;
 };

package/dist/types/QuerySettings.d.ts

@@ -1,8 +1,29 @@
 import type { Filter } from "./Filter";
 import type { FilterChildren } from "./FilterChildren";
 import type { FilterKeys } from "./FilterKeys";
+/**
+ * Settings to use when doing a query.
+ */
 export type QuerySettings<T extends object> = {
+    /**
+     * String used to separate the path nodes of an item.
+     */
     pathFieldSeparator?: string;
+    /**
+     * Field key to that contains the path value of an item.
+     */
     pathFieldKey?: FilterKeys<T, string>;
-    transformFilterChildren?: (filter: FilterChildren<T>) => Filter<T>;
+    /**
+     * Returns a filter that captures the items expressed by the provided `FilterChildren`. The return filter cannot use filters of type `FilterChildren`.
+     *
+     * @param filter The provided `FilterChildren` to express.
+     * @returns A filter that captures the items expressed by the provided `FilterChildren`.
+     */
+    transformFilterChildren?: (filter: FilterChildren<T>) => Exclude<Filter<T>, {
+        operator: "children";
+    }>;
+    /**
+     * Abort signal to abort the query.
+     */
+    signal?: AbortSignal;
 };

package/dist/types/QueryUpdate.d.ts

@@ -1,10 +1,17 @@
+import type { Context } from "./Context";
 import type { Filter } from "./Filter";
+import type { Parameters } from "./Parameters";
+import type { QuerySettings } from "./QuerySettings";
 /**
  * Query for updating an item.
  */
 export type QueryUpdate<T extends object> = {
     method: "update";
     multiple?: false;
+    /**
+     * Common item properties to use for identifying the context in which to update the item.
+     */
+    context?: Context<T>;
     /**
      * Partial property values to update.
      */
@@ -16,4 +23,12 @@ export type QueryUpdate<T extends object> = {
     offset?: never;
     order: never;
     group?: never;
+    /**
+     * Query parameters.
+     */
+    parameters?: Parameters;
+    /**
+     * Query settings.
+     */
+    settings?: QuerySettings<T>;
 };

package/dist/types/QueryUpdateMultiple.d.ts

@@ -1,11 +1,18 @@
+import type { Context } from "./Context";
 import type { Filter } from "./Filter";
 import type { Order } from "./Order";
+import type { Parameters } from "./Parameters";
+import type { QuerySettings } from "./QuerySettings";
 /**
  * Query for updating multiple items.
  */
 export type QueryUpdateMultiple<T extends object> = {
     method: "update";
     multiple: true;
+    /**
+     * Common item properties to use for identifying the context in which to update the item.
+     */
+    context?: Context<T>;
     /**
      * Partial property values to update.
      */
@@ -23,4 +30,12 @@ export type QueryUpdateMultiple<T extends object> = {
      * Sets the upper bound of the number of items to update.
      */
     limit?: number;
+    /**
+     * Query parameters.
+     */
+    parameters?: Parameters;
+    /**
+     * Query settings.
+     */
+    settings?: QuerySettings<T>;
 };

package/dist/types/Result.d.ts

@@ -1,23 +1,26 @@
-import type { CustomFieldMap } from "./CustomFieldMap";
-import type { InjectCustomFields } from "./InjectCustomFields";
 import type { Item } from "./Item";
 import type { Query } from "./Query";
+/**
+ * Picks fields `F` from object `T`.
+ */
 export type PickFields<T extends object | undefined, F extends string | number | symbol> = [F] extends [keyof T] ? {
     readonly [K in F]: T[K];
 } : {
     readonly [K in keyof T]: T[K];
 };
-export type ResultRead<T extends object, Q extends Query<T, C>, C extends CustomFieldMap<T> | undefined, U extends InjectCustomFields<T, C> | undefined = InjectCustomFields<T, C>> = [C] extends [CustomFieldMap<T>] ? [Q] extends [{
-    fields: (keyof U)[];
-}] ? PickFields<U, Item<Q["fields"]>> : U : [Q] extends [{
-    fields: (keyof T)[];
-}] ? PickFields<T, Item<Q["fields"]>> : T;
-export type Result<T extends object, Q extends Query<T, C>, C extends CustomFieldMap<T> | undefined, U extends InjectCustomFields<T, C> | undefined = InjectCustomFields<T, C>> = [Q] extends [{
-    method: "read";
-}] ? [Q] extends [{
+export type ResultRead<T extends object, Q extends Query<T>> = [Q] extends [
+    {
+        fields: (keyof T)[];
+    }
+] ? PickFields<T, Item<Q["fields"]>> : T;
+export type Result<T extends object, Q extends Query<T>> = [Q] extends [
+    {
+        method: "read";
+    }
+] ? [Q] extends [{
     multiple: true;
-}] ? ResultRead<T, Q, C, U>[] : ResultRead<T, Q, C, U> : [Q] extends [{
+}] ? ResultRead<T, Q>[] : ResultRead<T, Q> : [Q] extends [{
     method: "aggregate";
 }] ? number : [Q] extends [{
     multiple: true;
-}] ? ResultRead<T, Q, C, U>[] : ResultRead<T, Q, C, U>;
+}] ? ResultRead<T, Q>[] : ResultRead<T, Q>;

package/dist/types.d.ts

@@ -5,7 +5,6 @@ export type { Context } from "./types/Context";
 export type { CustomFetch } from "./types/CustomFetch";
 export type { CustomFieldAggregateMap } from "./types/CustomFieldAggregateMap";
 export type { CustomFieldMap } from "./types/CustomFieldMap";
-export type { CustomRequest } from "./types/CustomRequest";
 export type { FieldFunction } from "./types/FieldFunction";
 export type { FieldFunctionCustom } from "./types/FieldFunctionCustom";
 export type { FieldFunctionFormatDate } from "./types/FieldFunctionFormatDate";
@@ -14,6 +13,7 @@ export type { Filter } from "./types/Filter";
 export type { FilterArray } from "./types/FilterArray";
 export type { FilterBoolean } from "./types/FilterBoolean";
 export type { FilterChildren } from "./types/FilterChildren";
+export type { FilterCustom } from "./types/FilterCustom";
 export type { FilterField } from "./types/FilterField";
 export type { FilterGroup } from "./types/FilterGroup";
 export type { FilterKeys } from "./types/FilterKeys";
@@ -32,9 +32,9 @@ export type { Key } from "./types/Key";
 export type { Mutable } from "./types/Mutable";
 export type { NextHandler } from "./types/NextHandler";
 export type { Order } from "./types/Order";
+export type { Parameters } from "./types/Parameters";
 export type { Query } from "./types/Query";
 export type { QueryAggregate } from "./types/QueryAggregate";
-export type { QueryAny } from "./types/QueryAny";
 export type { QueryCreate } from "./types/QueryCreate";
 export type { QueryCreateMultiple } from "./types/QueryCreateMultiple";
 export type { QueryDelete } from "./types/QueryDelete";