quetch 0.15.0 → 0.16.1

package/doc/type-aliases/QuerySettings.md

@@ -0,0 +1,63 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / QuerySettings
+
+# Type Alias: QuerySettings\<T\>
+
+> **QuerySettings**\<`T`\>: `object`
+
+Settings to use when doing a query.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### abortController?
+
+> `optional` **abortController**: `AbortController`
+
+Abort controller to abort the query.
+
+### pathFieldKey?
+
+> `optional` **pathFieldKey**: [`FieldFiltered`](FieldFiltered.md)\<`T`, `string`\>
+
+Field key to that contains the path value of an item.
+
+### pathFieldSeparator?
+
+> `optional` **pathFieldSeparator**: `string`
+
+String used to separate the path nodes of an item.
+
+### signal?
+
+> `optional` **signal**: `AbortSignal`
+
+Abort signal to abort the query.
+
+### transformFilterChildren()?
+
+> `optional` **transformFilterChildren**: (`filter`) => `Exclude`\<[`Filter`](Filter.md)\<`T`\>, `object`\>
+
+Returns a filter that captures the items expressed by the provided `FilterChildren`. The return filter cannot use filters of type `FilterChildren`.
+
+#### Parameters
+
+• **filter**: [`FilterChildren`](FilterChildren.md)\<`T`\>
+
+The provided `FilterChildren` to express.
+
+#### Returns
+
+`Exclude`\<[`Filter`](Filter.md)\<`T`\>, `object`\>
+
+A filter that captures the items expressed by the provided `FilterChildren`.
+
+## Defined in
+
+[lib/types/QuerySettings.ts:8](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/QuerySettings.ts#L8)

package/doc/type-aliases/QueryUpdate.md

@@ -0,0 +1,71 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / QueryUpdate
+
+# Type Alias: QueryUpdate\<T\>
+
+> **QueryUpdate**\<`T`\>: `object`
+
+Query for updating an item.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### context?
+
+> `optional` **context**: [`Context`](Context.md)\<`T`\>
+
+Common item properties to use for identifying the context in which to update the item.
+
+### filter?
+
+> `optional` **filter**: [`Filter`](Filter.md)\<`T`\>
+
+Filter for finding the item, if it cannot be found based on the `context`.
+
+### group?
+
+> `optional` **group**: `never`
+
+### method
+
+> **method**: `"update"`
+
+### multiple?
+
+> `optional` **multiple**: `false`
+
+### offset?
+
+> `optional` **offset**: `never`
+
+### order
+
+> **order**: `never`
+
+### parameters?
+
+> `optional` **parameters**: [`Parameters`](Parameters.md)
+
+Query parameters.
+
+### settings?
+
+> `optional` **settings**: [`QuerySettings`](QuerySettings.md)\<`T`\>
+
+Query settings.
+
+### value
+
+> **value**: `Partial`\<`T`\>
+
+Partial property values to update.
+
+## Defined in
+
+[lib/types/QueryUpdate.ts:9](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/QueryUpdate.ts#L9)

package/doc/type-aliases/QueryUpdateMultiple.md

@@ -0,0 +1,75 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / QueryUpdateMultiple
+
+# Type Alias: QueryUpdateMultiple\<T\>
+
+> **QueryUpdateMultiple**\<`T`\>: `object`
+
+Query for updating multiple items.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+## Type declaration
+
+### context?
+
+> `optional` **context**: [`Context`](Context.md)\<`T`\>
+
+Common item properties to use for identifying the context in which to update the item.
+
+### filter?
+
+> `optional` **filter**: [`Filter`](Filter.md)\<`T`\>
+
+### limit?
+
+> `optional` **limit**: `number`
+
+Sets the upper bound of the number of items to update.
+
+### method
+
+> **method**: `"update"`
+
+### multiple
+
+> **multiple**: `true`
+
+### offset?
+
+> `optional` **offset**: `number`
+
+Offset of the first matching item to update.
+
+### order?
+
+> `optional` **order**: [`Order`](Order.md)\<`T`\>[]
+
+Order by which the items should be sorted.
+
+### parameters?
+
+> `optional` **parameters**: [`Parameters`](Parameters.md)
+
+Query parameters.
+
+### settings?
+
+> `optional` **settings**: [`QuerySettings`](QuerySettings.md)\<`T`\>
+
+Query settings.
+
+### value
+
+> **value**: `Partial`\<`T`\>[]
+
+Partial property values to update.
+
+## Defined in
+
+[lib/types/QueryUpdateMultiple.ts:10](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/QueryUpdateMultiple.ts#L10)

package/doc/type-aliases/Result.md

@@ -0,0 +1,19 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Result
+
+# Type Alias: Result\<T, Q\>
+
+> **Result**\<`T`, `Q`\>: [`Q`] *extends* [`object`] ? [`Q`] *extends* [`object`] ? `ResultRead`\<`T`, `Q`\>[] : `ResultRead`\<`T`, `Q`\> : [`Q`] *extends* [`object`] ? `number` : [`Q`] *extends* [`object`] ? `ResultRead`\<`T`, `Q`\>[] : `ResultRead`\<`T`, `Q`\>
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+• **Q** *extends* [`Query`](Query.md)\<`T`\>
+
+## Defined in
+
+[lib/types/Result.ts:20](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Result.ts#L20)

package/doc/type-aliases/Store.md

@@ -0,0 +1,61 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Store
+
+# Type Alias: Store\<T\>
+
+> **Store**\<`T`\>: `object`
+
+## Type Parameters
+
+• **T** = `any`
+
+## Type declaration
+
+### delete()
+
+#### Parameters
+
+• **key**: `string`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+### get()
+
+#### Parameters
+
+• **key**: `string`
+
+#### Returns
+
+`Promise`\<`T`\>
+
+### has()
+
+#### Parameters
+
+• **key**: `string`
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+### set()
+
+#### Parameters
+
+• **key**: `string`
+
+• **value**: `T`
+
+#### Returns
+
+`Promise`\<`void`\>
+
+## Defined in
+
+[lib/types/Store.ts:2](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Store.ts#L2)

package/doc/type-aliases/Value.md

@@ -0,0 +1,21 @@
+[**quetch**](../README.md) • **Docs**
+
+***
+
+[quetch](../README.md) / Value
+
+# Type Alias: Value\<T, V\>
+
+> **Value**\<`T`, `V`\>: `object` \| `object`
+
+Actual `value` or `valueField` leading to the value.
+
+## Type Parameters
+
+• **T** *extends* `object`
+
+• **V**
+
+## Defined in
+
+[lib/types/Value.ts:6](https://github.com/nevoland/quetch/blob/b70842cb9761fe7c217edef26e0fbc90449abccb/lib/types/Value.ts#L6)

package/lib/middlewares/aggregate.ts

@@ -44,7 +44,7 @@ export function aggregate<
     },
     method: "read",
     multiple: true,
-    type: queryList[0].type,
+    type: queryList[0]?.type,
   }),
   resultForQuery = (resultList, query) => {
     const result = resultList.find(

package/lib/middlewares/fetchExternal.ts

@@ -1,4 +1,4 @@
-import { getGlobal } from "@davidbonnet/get-global";
+import { getGlobal } from "@nevoland/get-global";
 
 import { RequestError } from "../errors/RequestError.js";
 import type { Handler } from "../types";

package/lib/middlewares/retry.ts

@@ -1,4 +1,4 @@
-import { getGlobal } from "@davidbonnet/get-global";
+import { getGlobal } from "@nevoland/get-global";
 import { sleep, untilOnline } from "futurise";
 
 import { RequestError } from "../errors/RequestError.js";

package/lib/tools/fieldListFromFilter.ts

@@ -0,0 +1,41 @@
+import { EMPTY_ARRAY } from "unchangeable";
+
+import type { Field, Filter } from "../types";
+
+/**
+ * Returns the list of fields used in the provided `filter`.
+ *
+ * @param filter The filter to extract the fields from.
+ * @returns A list of fields.
+ */
+export function fieldListFromFilter<T extends object>(
+  filter?: Filter<T>,
+): readonly Field<T>[] {
+  if (filter === undefined) {
+    return EMPTY_ARRAY;
+  }
+  switch (filter.operator) {
+    case "equal":
+    case "include":
+    case "intersect":
+    case "notEqual":
+    case "greaterThan":
+    case "greaterThanOrEqual":
+    case "lowerThan":
+    case "lowerThanOrEqual":
+    case "startWith":
+    case "endWith":
+    case "match":
+    case "exist":
+      return [filter.field];
+    case "all":
+    case "any":
+    case "none":
+      return filter.value?.flatMap(fieldListFromFilter) ?? EMPTY_ARRAY;
+    case "children":
+    case "custom":
+      return EMPTY_ARRAY;
+    default:
+      return EMPTY_ARRAY;
+  }
+}

package/lib/tools/get.test.ts

@@ -6,10 +6,19 @@ test("gets properties", () => {
   const value = {
     a: { b: 3, c: true, d: { e: [1, 2, { f: "test" }] } },
   } as const;
-  expect(get(value, ["a", "c"])).toBe(value.a.c);
-  expect(get(value, ["a", "d", "e", 2, "f"])).toBe(value.a.d.e[2].f);
-  expect(get(value, ["a"])).toBe(value.a);
-  expect(get(value, "a")).toBe(value.a);
+
+  const result1 = get(value, ["a", "c"]);
+  expect(result1).toBe(value.a.c);
+
+  const result2 = get(value, ["a", "d", "e", 2, "f"]);
+  expect(result2).toBe(value.a.d.e[2].f);
+
+  const result3 = get(value, ["a"]);
+  expect(result3).toBe(value.a);
+
+  const result4 = get(value, "a");
+  expect(result4).toBe(value.a);
+
   // @ts-ignore
   expect(get(value, "z")).toBeUndefined();
   // @ts-ignore

package/lib/tools/get.ts

@@ -1,14 +1,4 @@
-import type { Path } from "../types";
-
-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;
+import type { Get, Path } from "../types";
 
 /**
  * Gets the property value of the given `value` at the specified `path` (an array of object property names or array indexes).

package/lib/tools/normalizeOrder.ts

@@ -1,13 +1,24 @@
-import type { Order } from "../types";
+import type { Field, Order } from "../types";
 
+const { isArray } = Array;
+
+/**
+ * Returns a normalized order, which is an object with the `field` and `descending` properties.
+ *
+ * @param order The string or order object.
+ * @returns The normalized order object.
+ */
 export function normalizeOrder<T extends object>(
   order: Order<T>,
-): { field: keyof T; descending?: boolean } {
-  if (typeof order === "object") {
-    return order;
+): {
+  field: Field<T>;
+  descending?: boolean | undefined;
+} {
+  if (isArray(order) || typeof order !== "object") {
+    return {
+      field: order,
+      descending: false,
+    };
   }
-  return {
-    descending: false,
-    field: order,
-  };
+  return order;
 }

package/lib/tools/queryItemList.test.ts

@@ -166,6 +166,67 @@ test("aggregates items", () => {
       ],
     }),
   ).toBe(1);
+  expect(
+    queryItemList({
+      aggregator: {
+        operator: "index",
+        filter: {
+          field: "a",
+          operator: "greaterThan",
+          value: 3,
+        },
+      },
+      context: {
+        c: "a",
+      },
+      filter: {
+        field: "a",
+        operator: "greaterThan",
+        value: 1,
+      },
+      method: "aggregate",
+      type: [
+        { a: 1, c: "a" },
+        { a: 2, c: "a" },
+        { a: 3, c: "a" },
+        { a: 4, c: "a" },
+        { a: 5, c: "a" },
+        { a: 11, c: "b" },
+        { a: 12, c: "b" },
+      ],
+    }),
+  ).toBe(2);
+  expect(
+    queryItemList({
+      aggregator: {
+        operator: "index",
+        filter: {
+          field: "a",
+          operator: "greaterThan",
+          value: 3,
+        },
+      },
+      context: {
+        c: "a",
+      },
+      filter: {
+        field: "a",
+        operator: "greaterThan",
+        value: 1,
+      },
+      offset: 1,
+      method: "aggregate",
+      type: [
+        { a: 1, c: "a" },
+        { a: 2, c: "a" },
+        { a: 3, c: "a" },
+        { a: 4, c: "a" },
+        { a: 5, c: "a" },
+        { a: 11, c: "b" },
+        { a: 12, c: "b" },
+      ],
+    }),
+  ).toBe(1);
 });
 
 test("slices items", () => {