quetch 0.29.1 → 0.31.0

package/dist/types/NormalizedPathFieldSettings.d.ts

@@ -0,0 +1,24 @@
+import type { FieldFiltered } from "./FieldFiltered";
+/**
+ * Settings for fields that contain path values of items, used for displaying items in a tree.
+ */
+export type NormalizedPathFieldSettings<T> = {
+    /**
+     * Path to the field that contains the path value of an item, used for displaying items in a tree.
+     *
+     * @default "path"
+     */
+    pathField?: FieldFiltered<T, string>;
+    /**
+     * String used to escape the separator.
+     *
+     * @default "\\"
+     */
+    pathFieldSeparatorEscape?: string;
+    /**
+     * Maps path fields to a string used to separate the path nodes of a field value.
+     *
+     * @default "/"
+     */
+    pathFieldSeparator?: string;
+};

package/dist/types/NormalizedPathFieldSettings.js

@@ -0,0 +1 @@
+//# sourceMappingURL=NormalizedPathFieldSettings.js.map

package/dist/types/NormalizedPathFieldSettings.js.map

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

package/dist/types/Path.d.ts

@@ -1,6 +1,7 @@
-import type { Increment } from "./Increment";
+import type { Decrement } from "./Decrement";
+import type { DepthLimit } from "./DepthLimit";
 import type { Key } from "./Key";
 import type { Primitive } from "./Primitive";
-export type Path<T, D = 7> = [0] extends [1 & T] ? readonly (Key | never)[] : D extends -1 ? never : T extends Primitive ? readonly never[] : T extends Array<infer P> ? readonly [number] | readonly [number, ...Path<P, Increment<D>>] : T extends object ? {
-    [K in keyof T]: readonly [K] | readonly [K, ...Path<T[K], Increment<D>>];
+export type Path<T, D = DepthLimit> = [unknown] extends [T] ? readonly (Key | never)[] : [0] extends [1 & T] ? readonly (Key | never)[] : D extends -1 ? never : T extends Primitive ? readonly never[] : T extends Array<infer P> ? readonly [number] | readonly [number, ...Path<P, Decrement<D>>] : T extends object ? {
+    [K in keyof T]: readonly [K] | readonly [K, ...Path<T[K], Decrement<D>>];
 }[keyof T] : never;

package/dist/types/PathFiltered.d.ts

@@ -1,5 +1,6 @@
-import type { Increment } from "./Increment";
+import type { Decrement } from "./Decrement";
+import type { DepthLimit } from "./DepthLimit";
 import type { Key } from "./Key";
-export type PathFiltered<T, P, D = 7> = [0] extends [1 & T] ? readonly (Key | never)[] : D extends -1 ? never : T extends P ? readonly never[] : T extends ReadonlyArray<infer I> ? Extract<I, P> extends never ? readonly [number, ...PathFiltered<I, P, Increment<D>>] : readonly [number] : T extends object ? {
-    [K in keyof T]: Extract<T[K], P> extends never ? readonly [K, ...PathFiltered<T[K], P, Increment<D>>] : readonly [K];
+export type PathFiltered<T, P, D = DepthLimit> = [unknown] extends [T] ? readonly (Key | never)[] : [0] extends [1 & T] ? readonly (Key | never)[] : D extends -1 ? never : T extends P ? readonly never[] : T extends ReadonlyArray<infer I> ? Extract<I, P> extends never ? readonly [number, ...PathFiltered<I, P, Decrement<D>>] : readonly [number] : T extends object ? {
+    [K in keyof T]: Extract<T[K], P> extends never ? readonly [K, ...PathFiltered<T[K], P, Decrement<D>>] : readonly [K];
 }[keyof T] : never;

package/dist/types/QuerySettings.d.ts

@@ -1,26 +1,10 @@
-import type { FieldFiltered } from "./FieldFiltered";
+import type { Field } from "./Field";
 import type { FilterChildren } from "./FilterChildren";
 import type { IntrinsicFilter } from "./IntrinsicFilter";
 /**
  * Settings to use when doing a query.
  */
 export type QuerySettings<T> = {
-    /**
-     * Path to the field that contains the path value of an item, used for displaying items in a tree.
-     */
-    pathField?: FieldFiltered<T, string>;
-    /**
-     * String used to escape the separator.
-     *
-     * @default "\\"
-     */
-    pathFieldSeparatorEscape?: string;
-    /**
-     * Maps path fields to a string used to separate the path nodes of a field value.
-     *
-     * @default "/"
-     */
-    pathFieldSeparator?: string;
     /**
      * Returns a filter that captures the items expressed by the provided `FilterChildren`. The return filter cannot use filters of type `FilterChildren` or `FilterContext`.
      *
@@ -28,6 +12,17 @@ export type QuerySettings<T> = {
      * @returns A filter that captures the items expressed by the provided `FilterChildren`.
      */
     transformFilterChildren?: (filter: FilterChildren<T>) => IntrinsicFilter<T>;
+    /**
+     * Compares two values of a field for sorting purposes. If not provided, values are compared using the default comparison operators (`>`, `<`, `===`).
+     *
+     * This function is called only when both `a` and `b` are defined and different. If it returns `undefined`, the default comparison operators are used as a fallback.
+     *
+     * @param a - The first value to compare.
+     * @param b - The second value to compare.
+     * @param field - The field for which the values are compared.
+     * @returns `-1` if `a` should be sorted before `b`, `1` if `a` should be sorted after `b`, `0` if they are considered equal, or `undefined` to use the default comparison operators.
+     */
+    compareFieldValues?<T>(field: Field<T>, a: NonNullable<any>, b: NonNullable<any>): -1 | 0 | 1 | undefined;
     /**
      * Abort signal to abort the query.
      */

package/dist/types.d.ts

@@ -5,6 +5,8 @@ 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 { Decrement } from "./types/Decrement";
+export type { DepthLimit } from "./types/DepthLimit";
 export type { Field } from "./types/Field";
 export type { FieldFiltered } from "./types/FieldFiltered";
 export type { FieldFunction } from "./types/FieldFunction";
@@ -29,7 +31,6 @@ export type { Get } from "./types/Get";
 export type { Group } from "./types/Group";
 export type { Handler } from "./types/Handler";
 export type { Immutable } from "./types/Immutable";
-export type { Increment } from "./types/Increment";
 export type { InjectCustomFields } from "./types/InjectCustomFields";
 export type { IntersectUnion } from "./types/IntersectUnion";
 export type { IntrinsicFilter } from "./types/IntrinsicFilter";
@@ -40,6 +41,7 @@ export type { KeyFiltered } from "./types/KeyFiltered";
 export type { KeyFromUnion } from "./types/KeyFromUnion";
 export type { Locale } from "./types/Locale";
 export type { NextHandler } from "./types/NextHandler";
+export type { NormalizedPathFieldSettings } from "./types/NormalizedPathFieldSettings";
 export type { Order } from "./types/Order";
 export type { OrderNormalized } from "./types/OrderNormalized";
 export type { Parameters } from "./types/Parameters";

package/doc/README.md

@@ -20,6 +20,8 @@
 - [Context](type-aliases/Context.md)
 - [CustomFieldAggregateMap](type-aliases/CustomFieldAggregateMap.md)
 - [CustomFieldMap](type-aliases/CustomFieldMap.md)
+- [Decrement](type-aliases/Decrement.md)
+- [DepthLimit](type-aliases/DepthLimit.md)
 - [Field](type-aliases/Field.md)
 - [FieldFiltered](type-aliases/FieldFiltered.md)
 - [FieldFunction](type-aliases/FieldFunction.md)
@@ -44,7 +46,6 @@
 - [Group](type-aliases/Group.md)
 - [Handler](type-aliases/Handler.md)
 - [Immutable](type-aliases/Immutable.md)
-- [Increment](type-aliases/Increment.md)
 - [InjectCustomFields](type-aliases/InjectCustomFields.md)
 - [IntersectUnion](type-aliases/IntersectUnion.md)
 - [IntrinsicFilter](type-aliases/IntrinsicFilter.md)
@@ -55,6 +56,7 @@
 - [KeyFromUnion](type-aliases/KeyFromUnion.md)
 - [Locale](type-aliases/Locale.md)
 - [NextHandler](type-aliases/NextHandler.md)
+- [NormalizedPathFieldSettings](type-aliases/NormalizedPathFieldSettings.md)
 - [Order](type-aliases/Order.md)
 - [OrderNormalized](type-aliases/OrderNormalized.md)
 - [Parameters](type-aliases/Parameters.md)
@@ -92,6 +94,7 @@
 - [branch](functions/branch.md)
 - [cache](functions/cache.md)
 - [combine](functions/combine.md)
+- [comparatorFieldValues](functions/comparatorFieldValues.md)
 - [cork](functions/cork.md)
 - [defineCheckQuery](functions/defineCheckQuery.md)
 - [defineCustomFetch](functions/defineCustomFetch.md)
@@ -110,9 +113,11 @@
 - [log](functions/log.md)
 - [normalizeOrder](functions/normalizeOrder.md)
 - [queryItemList](functions/queryItemList.md)
+- [querySettings](functions/querySettings.md)
 - [retry](functions/retry.md)
 - [reverseOrder](functions/reverseOrder.md)
 - [sameField](functions/sameField.md)
 - [sortItemList](functions/sortItemList.md)
 - [splitPath](functions/splitPath.md)
 - [testFilter](functions/testFilter.md)
+- [transformerFilterChildren](functions/transformerFilterChildren.md)

package/doc/classes/RequestError.md

@@ -50,7 +50,7 @@ Error to be thrown in case there is an issue with the query call. Only instances
 
 #### Defined in
 
-[lib/errors/RequestError.ts:7](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/errors/RequestError.ts#L7)
+[lib/errors/RequestError.ts:7](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/errors/RequestError.ts#L7)
 
 ## Properties
 
@@ -60,7 +60,7 @@ Error to be thrown in case there is an issue with the query call. Only instances
 
 #### Defined in
 
-[lib/errors/RequestError.ts:10](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/errors/RequestError.ts#L10)
+[lib/errors/RequestError.ts:10](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/errors/RequestError.ts#L10)
 
 ***
 
@@ -70,7 +70,7 @@ Error to be thrown in case there is an issue with the query call. Only instances
 
 #### Defined in
 
-[lib/errors/RequestError.ts:11](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/errors/RequestError.ts#L11)
+[lib/errors/RequestError.ts:11](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/errors/RequestError.ts#L11)
 
 ***
 
@@ -80,7 +80,7 @@ Error to be thrown in case there is an issue with the query call. Only instances
 
 #### Defined in
 
-[lib/errors/RequestError.ts:12](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/errors/RequestError.ts#L12)
+[lib/errors/RequestError.ts:12](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/errors/RequestError.ts#L12)
 
 ***
 
@@ -90,4 +90,4 @@ Error to be thrown in case there is an issue with the query call. Only instances
 
 #### Defined in
 
-[lib/errors/RequestError.ts:9](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/errors/RequestError.ts#L9)
+[lib/errors/RequestError.ts:9](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/errors/RequestError.ts#L9)

package/doc/functions/aggregate.md

@@ -58,4 +58,4 @@ If a query occurs twice, `mergeQuery(query, currentQuery)` is called and the out
 
 ## Defined in
 
-[lib/middlewares/aggregate.ts:17](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/middlewares/aggregate.ts#L17)
+[lib/middlewares/aggregate.ts:17](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/middlewares/aggregate.ts#L17)

package/doc/functions/branch.md

@@ -49,4 +49,4 @@ const customFetch = combine(
 
 ## Defined in
 
-[lib/middlewares/branch.ts:21](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/middlewares/branch.ts#L21)
+[lib/middlewares/branch.ts:21](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/middlewares/branch.ts#L21)

package/doc/functions/cache.md

@@ -68,4 +68,4 @@ Cache store.
 
 ## Defined in
 
-[lib/middlewares/cache.ts:8](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/middlewares/cache.ts#L8)
+[lib/middlewares/cache.ts:8](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/middlewares/cache.ts#L8)

package/doc/functions/combine.md

@@ -116,4 +116,4 @@ Handler that combines all provided handlers.
 
 ## Defined in
 
-[lib/middlewares/combine.ts:801](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/middlewares/combine.ts#L801)
+[lib/middlewares/combine.ts:801](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/middlewares/combine.ts#L801)

package/doc/functions/comparatorFieldValues.md

@@ -0,0 +1,33 @@
+[**quetch**](../README.md)
+
+***
+
+[quetch](../README.md) / comparatorFieldValues
+
+# Function: comparatorFieldValues()
+
+> **comparatorFieldValues**\<`T`\>(`options`): [`QuerySettings`](../type-aliases/QuerySettings.md)\<`T`\>\[`"compareFieldValues"`\]
+
+Returns a function that transforms a `FilterChildren` into a `FilterStringMatch`.
+
+## Type Parameters
+
+• **T**
+
+## Parameters
+
+### options
+
+[`NormalizedPathFieldSettings`](../type-aliases/NormalizedPathFieldSettings.md)\<`T`\> = `EMPTY_OBJECT`
+
+Options for the transformer.
+
+## Returns
+
+[`QuerySettings`](../type-aliases/QuerySettings.md)\<`T`\>\[`"compareFieldValues"`\]
+
+A function that takes a `FilterChildren` and returns a `FilterStringMatch` that matches the paths of the children of the item specified in the `FilterChildren`.
+
+## Defined in
+
+[lib/tools/comparatorFieldValues.ts:18](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/comparatorFieldValues.ts#L18)

package/doc/functions/cork.md

@@ -22,4 +22,4 @@ Uncallable handler used to terminate a sequence of handlers combined with `combi
 
 ## Defined in
 
-[lib/tools/cork.ts:6](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/cork.ts#L6)
+[lib/tools/cork.ts:6](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/cork.ts#L6)

package/doc/functions/defineCheckQuery.md

@@ -56,4 +56,4 @@ Function that checks queries.
 
 ## Defined in
 
-[lib/tools/defineCheckQuery.ts:8](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/defineCheckQuery.ts#L8)
+[lib/tools/defineCheckQuery.ts:8](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/defineCheckQuery.ts#L8)

package/doc/functions/defineCustomFetch.md

@@ -68,4 +68,4 @@ A custom fetch function.
 
 ## Defined in
 
-[lib/tools/defineCustomFetch.ts:11](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/defineCustomFetch.ts#L11)
+[lib/tools/defineCustomFetch.ts:11](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/defineCustomFetch.ts#L11)

package/doc/functions/defineGenericFetch.md

@@ -55,4 +55,4 @@ A curried generic fetch function.
 
 ## Defined in
 
-[lib/tools/defineGenericFetch.ts:14](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/defineGenericFetch.ts#L14)
+[lib/tools/defineGenericFetch.ts:14](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/defineGenericFetch.ts#L14)

package/doc/functions/escapeRegex.md

@@ -26,4 +26,4 @@ Escaped regular expression
 
 ## Defined in
 
-[lib/tools/escapeRegex.ts:7](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/escapeRegex.ts#L7)
+[lib/tools/escapeRegex.ts:7](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/escapeRegex.ts#L7)

package/doc/functions/fetchExternal.md

@@ -26,4 +26,4 @@ Handler that returns a promise that resolves to the response.
 
 ## Defined in
 
-[lib/middlewares/fetchExternal.ts:12](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/middlewares/fetchExternal.ts#L12)
+[lib/middlewares/fetchExternal.ts:12](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/middlewares/fetchExternal.ts#L12)

package/doc/functions/fetchLocal.md

@@ -22,4 +22,4 @@ Promise that resolves to the response.
 
 ## Defined in
 
-[lib/middlewares/fetchLocal.ts:9](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/middlewares/fetchLocal.ts#L9)
+[lib/middlewares/fetchLocal.ts:9](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/middlewares/fetchLocal.ts#L9)

package/doc/functions/fieldListFromFilter.md

@@ -30,4 +30,4 @@ A list of fields.
 
 ## Defined in
 
-[lib/tools/fieldListFromFilter.ts:11](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/fieldListFromFilter.ts#L11)
+[lib/tools/fieldListFromFilter.ts:11](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/fieldListFromFilter.ts#L11)

package/doc/functions/filterChildren.md

@@ -54,4 +54,4 @@ A filter that can be used to match child items.
 
 ## Defined in
 
-[lib/tools/filterChildren.ts:15](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/filterChildren.ts#L15)
+[lib/tools/filterChildren.ts:15](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/filterChildren.ts#L15)

package/doc/functions/filterFromValue.md

@@ -24,4 +24,4 @@
 
 ## Defined in
 
-[lib/tools/filterFromValue.ts:8](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/filterFromValue.ts#L8)
+[lib/tools/filterFromValue.ts:8](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/filterFromValue.ts#L8)

package/doc/functions/get.md

@@ -17,7 +17,7 @@ If the `path` leads to an unknown property, returns `undefined`.
 
 • **T**
 
-• **P** *extends* `string` \| `number` \| `symbol` \| readonly [`number`] \| readonly `never`[] \| readonly [`Key`](../type-aliases/Key.md)[] \| readonly [keyof `T`\<`T`\>] \| readonly [keyof `T`\<`T`\>, [`Path`](../type-aliases/Path.md)\<`T`\<`T`\>\[keyof `T`\<`T`\>\], `8`\>]
+• **P**
 
 ## Parameters
 
@@ -41,4 +41,4 @@ The property value found at the given path, or `undefined` if it cannot be found
 
 ## Defined in
 
-[lib/tools/get.ts:14](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/get.ts#L14)
+[lib/tools/get.ts:16](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/get.ts#L16)

package/doc/functions/groupFilters.md

@@ -38,4 +38,4 @@ The filters to group together.
 
 ## Defined in
 
-[lib/tools/groupFilters.ts:16](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/groupFilters.ts#L16)
+[lib/tools/groupFilters.ts:16](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/groupFilters.ts#L16)

package/doc/functions/identity.md

@@ -34,4 +34,4 @@
 
 ## Defined in
 
-[lib/middlewares/identity.ts:3](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/middlewares/identity.ts#L3)
+[lib/middlewares/identity.ts:3](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/middlewares/identity.ts#L3)

package/doc/functions/intrinsicFilter.md

@@ -6,7 +6,7 @@
 
 # Function: intrinsicFilter()
 
-> **intrinsicFilter**\<`T`\>(`filter`, `settings`): [`IntrinsicFilter`](../type-aliases/IntrinsicFilter.md)\<`T`\>
+> **intrinsicFilter**\<`T`\>(`settings`, `filter`): [`IntrinsicFilter`](../type-aliases/IntrinsicFilter.md)\<`T`\>
 
 Transforms a filter into an intrinsic filter by replacing `children` and `notChildren` filters with their transformed versions from the query settings.
 
@@ -16,18 +16,18 @@ Transforms a filter into an intrinsic filter by replacing `children` and `notChi
 
 ## Parameters
 
-### filter
-
-[`Filter`](../type-aliases/Filter.md)\<`T`\>
-
-The filter to transform.
-
 ### settings
 
 `Required`\<`Pick`\<[`QuerySettings`](../type-aliases/QuerySettings.md)\<`T`\>, `"transformFilterChildren"`\>\>
 
 The query settings that may contain a `transformFilterChildren` function to transform `children` and `notChildren` filters.
 
+### filter
+
+[`Filter`](../type-aliases/Filter.md)\<`T`\>
+
+The filter to transform.
+
 ## Returns
 
 [`IntrinsicFilter`](../type-aliases/IntrinsicFilter.md)\<`T`\>
@@ -36,4 +36,4 @@ The transformed intrinsic filter.
 
 ## Defined in
 
-[lib/tools/intrinsicFilter.ts:10](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/intrinsicFilter.ts#L10)
+[lib/tools/intrinsicFilter.ts:10](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/intrinsicFilter.ts#L10)

package/doc/functions/isFilterGroup.md

@@ -28,4 +28,4 @@ Whether the provided filter is a group filter or not.
 
 ## Defined in
 
-[lib/tools/isFilterGroup.ts:9](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/isFilterGroup.ts#L9)
+[lib/tools/isFilterGroup.ts:9](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/isFilterGroup.ts#L9)

package/doc/functions/log.md

@@ -34,4 +34,4 @@ Query handler
 
 ## Defined in
 
-[lib/middlewares/log.ts:13](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/middlewares/log.ts#L13)
+[lib/middlewares/log.ts:13](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/middlewares/log.ts#L13)

package/doc/functions/normalizeOrder.md

@@ -38,4 +38,4 @@ The normalized order object.
 
 ## Defined in
 
-[lib/tools/normalizeOrder.ts:11](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/normalizeOrder.ts#L11)
+[lib/tools/normalizeOrder.ts:11](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/normalizeOrder.ts#L11)

package/doc/functions/queryItemList.md

@@ -32,4 +32,4 @@ The result of the query.
 
 ## Defined in
 
-[lib/tools/queryItemList.ts:48](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/queryItemList.ts#L48)
+[lib/tools/queryItemList.ts:48](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/queryItemList.ts#L48)

package/doc/functions/querySettings.md

@@ -0,0 +1,33 @@
+[**quetch**](../README.md)
+
+***
+
+[quetch](../README.md) / querySettings
+
+# Function: querySettings()
+
+> **querySettings**\<`T`\>(`settings`): [`QuerySettings`](../type-aliases/QuerySettings.md)\<`T`\>
+
+Returns query settings for path fields.
+
+## Type Parameters
+
+• **T**
+
+## Parameters
+
+### settings
+
+[`NormalizedPathFieldSettings`](../type-aliases/NormalizedPathFieldSettings.md)\<`T`\> = `EMPTY_OBJECT`
+
+Settings for normalizing path fields.
+
+## Returns
+
+[`QuerySettings`](../type-aliases/QuerySettings.md)\<`T`\>
+
+Query settings for path fields.
+
+## Defined in
+
+[lib/tools/querySettings.ts:13](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/querySettings.ts#L13)

package/doc/functions/retry.md

@@ -36,4 +36,4 @@ Handler
 
 ## Defined in
 
-[lib/middlewares/retry.ts:15](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/middlewares/retry.ts#L15)
+[lib/middlewares/retry.ts:15](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/middlewares/retry.ts#L15)

package/doc/functions/reverseOrder.md

@@ -38,4 +38,4 @@ The reversed order.
 
 ## Defined in
 
-[lib/tools/reverseOrder.ts:11](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/reverseOrder.ts#L11)
+[lib/tools/reverseOrder.ts:11](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/reverseOrder.ts#L11)

package/doc/functions/sameField.md

@@ -32,4 +32,4 @@ Whether the fields are the same.
 
 ## Defined in
 
-[lib/tools/sameField.ts:12](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/sameField.ts#L12)
+[lib/tools/sameField.ts:12](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/sameField.ts#L12)

package/doc/functions/sortItemList.md

@@ -18,7 +18,7 @@ Sorts provided `value` array according to the `orderList`.
 
 ### orderList
 
-`undefined` | readonly [`Order`](../type-aliases/Order.md)\<`T`\>[]
+`undefined` | `NoInfer`\<readonly [`Order`](../type-aliases/Order.md)\<`T`\>[]\>
 
 ### value
 
@@ -40,4 +40,4 @@ A new sorted array.
 
 ## Defined in
 
-[lib/tools/sortItemList.ts:16](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/sortItemList.ts#L16)
+[lib/tools/sortItemList.ts:16](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/sortItemList.ts#L16)

package/doc/functions/splitPath.md

@@ -38,7 +38,7 @@ An array containing the splitted path items if `path` is defined, or a function
 
 ### Defined in
 
-[lib/tools/splitPath.ts:22](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/splitPath.ts#L22)
+[lib/tools/splitPath.ts:22](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/splitPath.ts#L22)
 
 ## Call Signature
 
@@ -70,4 +70,4 @@ An array containing the splitted path items if `path` is defined, or a function
 
 ### Defined in
 
-[lib/tools/splitPath.ts:27](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/splitPath.ts#L27)
+[lib/tools/splitPath.ts:27](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/splitPath.ts#L27)

package/doc/functions/testFilter.md

@@ -18,7 +18,7 @@ Checks wether the provided `value` matches the `filter` or not.
 
 ### filter
 
-`undefined` | [`Filter`](../type-aliases/Filter.md)\<`T`\>
+`undefined` | `NoInfer`\<[`Filter`](../type-aliases/Filter.md)\<`T`\>\>
 
 ### value
 
@@ -38,4 +38,4 @@ Optional query settings.
 
 ## Defined in
 
-[lib/tools/testFilter.ts:34](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/tools/testFilter.ts#L34)
+[lib/tools/testFilter.ts:25](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/testFilter.ts#L25)

package/doc/functions/transformerFilterChildren.md

@@ -0,0 +1,43 @@
+[**quetch**](../README.md)
+
+***
+
+[quetch](../README.md) / transformerFilterChildren
+
+# Function: transformerFilterChildren()
+
+> **transformerFilterChildren**\<`T`\>(`options`): (`filter`) => [`FilterStringMatch`](../type-aliases/FilterStringMatch.md)\<`T`\>
+
+Returns a function that transforms a `FilterChildren` into a `FilterStringMatch`.
+
+## Type Parameters
+
+• **T**
+
+## Parameters
+
+### options
+
+[`NormalizedPathFieldSettings`](../type-aliases/NormalizedPathFieldSettings.md)\<`T`\> = `EMPTY_OBJECT`
+
+Options for the transformer.
+
+## Returns
+
+`Function`
+
+A function that takes a `FilterChildren` and returns a `FilterStringMatch` that matches the paths of the children of the item specified in the `FilterChildren`.
+
+### Parameters
+
+#### filter
+
+[`FilterChildren`](../type-aliases/FilterChildren.md)\<`T`\>
+
+### Returns
+
+[`FilterStringMatch`](../type-aliases/FilterStringMatch.md)\<`T`\>
+
+## Defined in
+
+[lib/tools/transformerFilterChildren.ts:19](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/tools/transformerFilterChildren.ts#L19)

package/doc/interfaces/CustomFetch.md

@@ -28,4 +28,4 @@
 
 ## Defined in
 
-[lib/types/CustomFetch.ts:5](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/CustomFetch.ts#L5)
+[lib/types/CustomFetch.ts:5](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/types/CustomFetch.ts#L5)

package/doc/type-aliases/AggregateFunction.md

@@ -6,7 +6,7 @@
 
 # Type Alias: AggregateFunction\<T\>
 
-> **AggregateFunction**\<`T`\>: `"length"` \| \{`operator`: `"length"`; \} \| \{`filter`: [`Filter`](Filter.md)\<`T`\>;`last`: `boolean`;`operator`: `"index"`; \} \| \{`field`: [`Field`](Field.md)\<`T`\>;`operator`: `"median"` \| `"standardDeviation"` \| `"mean"` \| `"minimum"` \| `"maximum"` \| `"variance"` \| `"mode"`; \}
+> **AggregateFunction**\<`T`\>: `"length"` \| \{`operator`: `"length"`; \} \| \{`filter`: [`Filter`](Filter.md)\<`T`\>;`last`: `boolean`;`operator`: `"index"`; \} \| \{`field`: [`Field`](Field.md)\<`T`\>;`operator`: `"median"` \| `"standardDeviation"` \| `"mean"` \| `"min"` \| `"max"` \| `"variance"` \| `"mode"`; \}
 
 Aggregation function.
 
@@ -16,4 +16,4 @@ Aggregation function.
 
 ## Defined in
 
-[lib/types/AggregateFunction.ts:7](https://github.com/nevoland/quetch/blob/f881c4f19d7899ff86da90e179fb6d9e199b8525/lib/types/AggregateFunction.ts#L7)
+[lib/types/AggregateFunction.ts:7](https://github.com/nevoland/quetch/blob/1cf615b166541d2a753e34c0a2dd4a9474026d7a/lib/types/AggregateFunction.ts#L7)