quetch 0.15.0 → 0.16.0

package/dist/types/FieldFiltered.d.ts

@@ -1,3 +1,3 @@
 import type { KeyFiltered } from "./KeyFiltered";
 import type { PathFiltered } from "./PathFiltered";
-export type FieldFiltered<T extends object, P> = KeyFiltered<T, P> | PathFiltered<T, P>;
+export type FieldFiltered<T extends object, P> = KeyFiltered<Required<T>, P> | PathFiltered<Required<T>, P>;

package/dist/types/FieldFiltered.js

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

package/dist/types/FieldFunction.js

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

package/dist/types/FieldFunctionCustom.js

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

package/dist/types/FieldFunctionFormatDate.js

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

package/dist/types/FieldFunctionReturn.js

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

package/dist/types/Filter.js

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

package/dist/types/FilterArray.js

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

package/dist/types/FilterBoolean.js

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

package/dist/types/FilterChildren.js

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

package/dist/types/FilterCustom.js

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

package/dist/types/FilterField.d.ts

@@ -7,5 +7,5 @@ export type FilterField<T extends object> = {
     /**
      * The field name or path for which to check its existence.
      */
-    value: Field<T>;
+    field: Field<T>;
 };

package/dist/types/FilterField.js

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

package/dist/types/FilterGroup.js

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

package/dist/types/FilterNumber.js

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

package/dist/types/FilterOperator.js

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

package/dist/types/FilterString.js

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

package/dist/types/FilterStringIntersect.js

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

package/dist/types/FilterStringMatch.js

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

package/dist/types/Get.d.ts

@@ -1,5 +1,5 @@
 import type { Path } from "./Path";
 /**
- * Returns the type of the property at the specified `K` key.
+ * Returns the type of the property at the specified `P` path.
  */
-export type Get<T, P> = [P] extends [[infer K, ...infer R]] ? K extends keyof T ? R extends Path<T[K]> ? Get<T[K], R> : T[K] : never : never;
+export type Get<T, P> = [P] extends [[infer K, ...infer R]] ? K extends keyof T ? R extends Path<T[K]> ? Get<T[K], R> : T[K] : never : [P] extends [keyof T] ? T[P] : T;

package/dist/types/Get.js

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

package/dist/types/Group.js

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

package/dist/types/Handler.js

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

package/dist/types/Immutable.js

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

package/dist/types/Increment.d.ts

@@ -0,0 +1,4 @@
+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

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

package/dist/types/Increment.js.map

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

package/dist/types/InjectCustomFields.js

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

package/dist/types/Item.js

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

package/dist/types/Join.d.ts

@@ -0,0 +1 @@
+export type Join<T extends Array<any>, Separator extends string = "."> = T extends readonly [infer I, ...infer R] ? I extends string | number ? R extends [] ? I : R extends string[] ? `${I}${Separator}${Join<R, Separator>}` : never : never : never;

package/dist/types/Join.js

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

package/dist/types/Join.js.map

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

package/dist/types/Key.js

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

package/dist/types/KeyFiltered.js

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

package/dist/types/Locale.js

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

package/dist/types/Mutable.js

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

package/dist/types/NextHandler.js

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

package/dist/types/Order.d.ts

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

package/dist/types/Order.js

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

package/dist/types/Parameters.js

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

package/dist/types/Path.d.ts

@@ -1,3 +1,4 @@
-export type Path<T> = T extends Array<infer P> ? [number] | [number, ...Path<P>] : T extends object ? {
-    [K in keyof T]-?: [K] | [K, ...Path<T[K]>];
+import type { Increment } from "./Increment";
+export type Path<T, D = 0> = D extends 4 ? never : T extends Array<infer P> ? [number] | [number, ...Path<P, Increment<D>>] : T extends object ? {
+    [K in keyof T]-?: [K] | [K, ...Path<T[K], Increment<D>>];
 }[keyof T] : never;

package/dist/types/Path.js

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

package/dist/types/PathFiltered.d.ts

@@ -1,3 +1,4 @@
-export type PathFiltered<T, P> = T extends Array<infer I> ? I extends P ? [number] : [number, ...PathFiltered<I, P>] : T extends object ? {
-    [K in keyof T]-?: T[K] extends P ? [K] : [K, ...PathFiltered<T[K], P>];
+import type { Increment } from "./Increment";
+export type PathFiltered<T, P, D = 0> = D extends 4 ? never : T extends Array<infer I> ? I extends P ? [number] : [number, ...PathFiltered<I, P, Increment<D>>] : T extends object ? {
+    [K in keyof T]-?: T[K] extends P ? [K] : [K, ...PathFiltered<T[K], P, Increment<D>>];
 }[keyof T] : never;

package/dist/types/PathFiltered.js

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

package/dist/types/Query.js

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

package/dist/types/QueryAggregate.d.ts

@@ -1,6 +1,7 @@
 import type { AggregateFunction } from "./AggregateFunction";
 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";
 /**
@@ -13,7 +14,22 @@ export type QueryAggregate<T extends object> = {
      */
     context?: Context<T>;
     aggregator: AggregateFunction<T>;
+    /**
+     * Filter that picks the items.
+     */
     filter?: Filter<T>;
+    /**
+     * Order by which the items should be sorted.
+     */
+    order?: Order<T>[];
+    /**
+     * Offset of the first matching item.
+     */
+    offset?: number;
+    /**
+     * Upper bound of the number of items to return.
+     */
+    limit?: number;
     /**
      * Query parameters.
      */

package/dist/types/QueryAggregate.js

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

package/dist/types/QueryCreate.js

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

package/dist/types/QueryCreateMultiple.js

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

package/dist/types/QueryDelete.js

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

package/dist/types/QueryDeleteMultiple.js

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

package/dist/types/QueryMethod.js

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

package/dist/types/QueryRead.d.ts

@@ -10,10 +10,13 @@ export type QueryRead<T extends object> = {
     method?: "read";
     multiple?: false;
     /**
-     * Common item properties to use for identifying the context in which to delete the item.
+     * Common item properties to use for identifying the context in which to get the item.
      */
     context?: Context<T>;
-    offset?: never;
+    /**
+     * Offset of the first matching item.
+     */
+    offset?: number;
     limit?: never;
     group?: never;
     /**

package/dist/types/QueryRead.js

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

package/dist/types/QueryReadMultiple.js

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

package/dist/types/QuerySettings.js

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

package/dist/types/QueryUpdate.js

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

package/dist/types/QueryUpdateMultiple.js

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

package/dist/types/Result.js

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

package/dist/types/Store.js

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

package/dist/types/Value.js

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

package/dist/types.d.ts

@@ -27,8 +27,10 @@ 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 { Item } from "./types/Item";
+export type { Join } from "./types/Join";
 export type { Key } from "./types/Key";
 export type { KeyFiltered } from "./types/KeyFiltered";
 export type { Locale } from "./types/Locale";

package/dist/types.js

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