quetch 0.30.0 → 0.31.1

package/lib/types/PathFiltered.ts

@@ -1,20 +1,23 @@
-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]
+export type PathFiltered<T, P, D = DepthLimit> = [unknown] extends [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];
-            }[keyof T]
-          : 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/lib/types/QuerySettings.ts

@@ -1,4 +1,4 @@
-import type { FieldFiltered } from "./FieldFiltered";
+import type { Field } from "./Field";
 import type { FilterChildren } from "./FilterChildren";
 import type { IntrinsicFilter } from "./IntrinsicFilter";
 
@@ -6,22 +6,6 @@ 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`.
    *
@@ -29,6 +13,21 @@ 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/lib/types.ts

@@ -6,6 +6,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";
@@ -30,7 +32,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";
@@ -41,6 +42,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quetch",
-  "version": "0.30.0",
+  "version": "0.31.1",
   "type": "module",
   "main": "./dist/main.js",
   "exports": {
@@ -39,7 +39,7 @@
     "lint": "npm run lint:ts",
     "lint:fix": "npm run lint:ts:fix",
     "lint:ts": "eslint . && tsc --project tsconfig.package.json --noEmit",
-    "lint:types": "tsc --project tsconfig.package.json --noEmit",
+    "lint:types:trace": "tsc --project tsconfig.package.json --noEmit --generateTrace ./trace",
     "lint:ts:fix": "eslint --fix .",
     "release:init": "npm publish --access=public",
     "release:patch": "npm version patch && git push origin --follow-tags && npm publish",

package/dist/types/Increment.d.ts

@@ -1,4 +0,0 @@
-type Digit = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
-type NextDigit = [1, 2, 3, 4, 5, 6, 7, 8, 9, -1];
-export type Increment<D> = D extends Digit ? NextDigit[D] : -1;
-export {};

package/dist/types/Increment.js

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

package/dist/types/Increment.js.map

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

package/doc/type-aliases/Increment.md

@@ -1,17 +0,0 @@
-[**quetch**](../README.md)
-
-***
-
-[quetch](../README.md) / Increment
-
-# Type Alias: Increment\<D\>
-
-> **Increment**\<`D`\>: `D` *extends* `Digit` ? `NextDigit`\[`D`\] : `-1`
-
-## Type Parameters
-
-• **D**
-
-## Defined in
-
-[lib/types/Increment.ts:5](https://github.com/nevoland/quetch/blob/94f546831241bf41f83cf97787b7e923c8cf7824/lib/types/Increment.ts#L5)

package/lib/types/Increment.ts

@@ -1,5 +0,0 @@
-type Digit = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
-
-type NextDigit = [1, 2, 3, 4, 5, 6, 7, 8, 9, -1];
-
-export type Increment<D> = D extends Digit ? NextDigit[D] : -1;