quetch 0.13.0 → 0.15.0

package/doc/classes/RequestError.md

@@ -27,7 +27,7 @@ Error to be thrown in case there is an issue with the query call. Only instances
 
 ### constructor
 
-• **new RequestError**(`message`, `status`, `query?`, `request?`, `response?`)
+• **new RequestError**(`message`, `status`, `query?`, `request?`, `response?`): [`RequestError`](RequestError.md)
 
 #### Parameters
 
@@ -35,27 +35,31 @@ Error to be thrown in case there is an issue with the query call. Only instances
 | :------ | :------ |
 | `message` | `string` |
 | `status` | `number` |
-| `query?` | [`Query`](../README.md#query)<`any`\> |
+| `query?` | [`Query`](../README.md#query)\<`any`\> |
 | `request?` | `Request` |
 | `response?` | `Response` |
 
+#### Returns
+
+[`RequestError`](RequestError.md)
+
 #### Overrides
 
 Error.constructor
 
 #### Defined in
 
-[lib/errors/RequestError.ts:7](https://github.com/nevoland/quetch/blob/fbf3307/lib/errors/RequestError.ts#L7)
+[lib/errors/RequestError.ts:7](https://github.com/nevoland/quetch/blob/b46dff0534f861059aba3484d2e1d047d841b31f/lib/errors/RequestError.ts#L7)
 
 ## Properties
 
 ### query
 
-• `Optional` **query**: [`Query`](../README.md#query)<`any`\>
+• `Optional` **query**: [`Query`](../README.md#query)\<`any`\>
 
 #### Defined in
 
-[lib/errors/RequestError.ts:10](https://github.com/nevoland/quetch/blob/fbf3307/lib/errors/RequestError.ts#L10)
+[lib/errors/RequestError.ts:10](https://github.com/nevoland/quetch/blob/b46dff0534f861059aba3484d2e1d047d841b31f/lib/errors/RequestError.ts#L10)
 
 ___
 
@@ -65,7 +69,7 @@ ___
 
 #### Defined in
 
-[lib/errors/RequestError.ts:11](https://github.com/nevoland/quetch/blob/fbf3307/lib/errors/RequestError.ts#L11)
+[lib/errors/RequestError.ts:11](https://github.com/nevoland/quetch/blob/b46dff0534f861059aba3484d2e1d047d841b31f/lib/errors/RequestError.ts#L11)
 
 ___
 
@@ -75,7 +79,7 @@ ___
 
 #### Defined in
 
-[lib/errors/RequestError.ts:12](https://github.com/nevoland/quetch/blob/fbf3307/lib/errors/RequestError.ts#L12)
+[lib/errors/RequestError.ts:12](https://github.com/nevoland/quetch/blob/b46dff0534f861059aba3484d2e1d047d841b31f/lib/errors/RequestError.ts#L12)
 
 ___
 
@@ -85,4 +89,4 @@ ___
 
 #### Defined in
 
-[lib/errors/RequestError.ts:9](https://github.com/nevoland/quetch/blob/fbf3307/lib/errors/RequestError.ts#L9)
+[lib/errors/RequestError.ts:9](https://github.com/nevoland/quetch/blob/b46dff0534f861059aba3484d2e1d047d841b31f/lib/errors/RequestError.ts#L9)

package/doc/interfaces/CustomFetch.md

@@ -1,6 +1,6 @@
 [quetch](../README.md) / CustomFetch
 
-# Interface: CustomFetch<T\>
+# Interface: CustomFetch\<T\>
 
 ## Type parameters
 
@@ -12,13 +12,13 @@
 
 ### CustomFetch
 
-▸ **CustomFetch**<`Q`\>(`query`): `Promise`<[`Result`](../README.md#result)<`T`, `Q`\>\>
+▸ **CustomFetch**\<`Q`\>(`query`): `Promise`\<[`Result`](../README.md#result)\<`T`, `Q`\>\>
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Q` | extends [`Query`](../README.md#query)<`T`\> |
+| `Q` | extends [`Query`](../README.md#query)\<`T`\> |
 
 #### Parameters
 
@@ -28,8 +28,8 @@
 
 #### Returns
 
-`Promise`<[`Result`](../README.md#result)<`T`, `Q`\>\>
+`Promise`\<[`Result`](../README.md#result)\<`T`, `Q`\>\>
 
 #### Defined in
 
-[lib/types/CustomFetch.ts:5](https://github.com/nevoland/quetch/blob/fbf3307/lib/types/CustomFetch.ts#L5)
+[lib/types/CustomFetch.ts:5](https://github.com/nevoland/quetch/blob/b46dff0534f861059aba3484d2e1d047d841b31f/lib/types/CustomFetch.ts#L5)

package/lib/tools/filterChildren.ts

@@ -1,10 +1,10 @@
-import type { Filter, FilterKeys } from "../types.ts";
+import type { FieldFiltered, Filter } from "../types.ts";
 
 import { escapeRegex } from "./escapeRegex.js";
 
 export function filterChildren<T extends object>(
   parentPath: string,
-  pathFieldKey: FilterKeys<T, string>,
+  pathFieldKey: FieldFiltered<T, string>,
   deep = false,
   pathSeparator = "/",
 ): Filter<T> {

package/lib/tools/get.test.ts

@@ -0,0 +1,23 @@
+import { expect, test } from "vitest";
+
+import { get } from "./get.js";
+
+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);
+  // @ts-ignore
+  expect(get(value, "z")).toBeUndefined();
+  // @ts-ignore
+  expect(get(value, ["y", "z"])).toBeUndefined();
+});
+
+test("returns whole value if no path specified", () => {
+  const value = { a: { b: 3, c: true } };
+  expect(get(value)).toBe(value);
+  expect(get(value, undefined)).toBe(value);
+});

package/lib/tools/get.ts

@@ -0,0 +1,57 @@
+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;
+
+/**
+ * Gets the property value of the given `value` at the specified `path` (an array of object property names or array indexes).
+ * If the `path` is undefined, returns the `value` itself.
+ * If the `path` is a string, it is considered as a path with one item.
+ * If the `path` leads to an unknown property, returns `undefined`.
+ *
+ * @param value The value from which to get the property value.
+ * @param path The path leading to the property value or a property name or `undefined`.
+ * @returns The property value found at the given path, or `undefined` if it cannot be found.
+ */
+export function get<T, P extends keyof T | Path<T>>(
+  value: T,
+  path?: P,
+): Get<T, P> {
+  if (path === undefined) {
+    return value as any;
+  }
+  switch (typeof path) {
+    case "string":
+    case "number":
+    case "symbol":
+      return (value as any)?.[path];
+    default: {
+      switch (path.length) {
+        case 1:
+          return (value as any)?.[path[0] as any];
+        case 2:
+          return (value as any)?.[path[0] as any]?.[path[1] as any];
+        case 3:
+          return (value as any)?.[path[0] as any]?.[path[1] as any]?.[
+            path[2] as any
+          ];
+        case 4:
+          return (value as any)?.[path[0] as any]?.[path[1] as any]?.[
+            path[2] as any
+          ]?.[path[3] as any];
+        default:
+          return path.reduce(
+            (value, key) => (value as any)?.[key],
+            value,
+          ) as any;
+      }
+    }
+  }
+}

package/lib/tools/queryItemList.ts

@@ -10,8 +10,8 @@ import type {
 } from "../types.js";
 
 import { filterFromContext } from "./filterFromContext.js";
-import { filterItem } from "./filterItem.js";
 import { sortItemList } from "./sortItemList.js";
+import { testFilter } from "./testFilter.js";
 
 function mergeContextAndFilter<T extends object>(
   context?: Context<T>,
@@ -56,7 +56,7 @@ function queryItemList<T extends object, const Q extends Query<T>>(
             filter as Filter<T>,
           );
           result = data.filter((item) =>
-            filterItem(normalizedFilter, item, query.settings),
+            testFilter(normalizedFilter, item, query.settings),
           );
         }
         // Sort
@@ -75,7 +75,7 @@ function queryItemList<T extends object, const Q extends Query<T>>(
         filter as Filter<T>,
       );
       const result = data.find((item) =>
-        filterItem(normalizedFilter, item, query.settings),
+        testFilter(normalizedFilter, item, query.settings),
       );
       if (result === undefined) {
         throw new RequestError("Not found", 404, query as Query<any>);
@@ -94,7 +94,7 @@ function queryItemList<T extends object, const Q extends Query<T>>(
             filter as Filter<T>,
           );
           return data.reduce((result, item) => {
-            if (filterItem(normalizedFilter, item, query.settings)) {
+            if (testFilter(normalizedFilter, item, query.settings)) {
               return result + 1;
             }
             return result;

package/lib/tools/{filterItem.test.ts → testFilter.test.ts}

@@ -3,11 +3,11 @@ import { expect, test } from "vitest";
 import { SymbolCache } from "../constants.js";
 import type { FilterChildren } from "../types.js";
 
-import { filterItem } from "./filterItem.js";
+import { testFilter } from "./testFilter.js";
 
 test("tests filter lists", () => {
   expect(
-    filterItem(
+    testFilter(
       {
         operator: "all",
         value: [
@@ -19,7 +19,7 @@ test("tests filter lists", () => {
     ),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       {
         operator: "all",
         value: [
@@ -31,7 +31,7 @@ test("tests filter lists", () => {
     ),
   ).toBe(false);
   expect(
-    filterItem(
+    testFilter(
       {
         operator: "all",
         value: [],
@@ -40,7 +40,7 @@ test("tests filter lists", () => {
     ),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       {
         operator: "any",
       },
@@ -48,7 +48,7 @@ test("tests filter lists", () => {
     ),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       {
         operator: "none",
       },
@@ -56,7 +56,7 @@ test("tests filter lists", () => {
     ),
   ).toBe(false);
   expect(
-    filterItem(
+    testFilter(
       {
         operator: "any",
         value: [
@@ -68,7 +68,7 @@ test("tests filter lists", () => {
     ),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       {
         operator: "none",
         value: [
@@ -80,7 +80,7 @@ test("tests filter lists", () => {
     ),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       {
         operator: "none",
         value: [
@@ -95,10 +95,16 @@ test("tests filter lists", () => {
 
 test("tests filter on string values", () => {
   expect(
-    filterItem({ field: "a", operator: "equal", value: "foo" }, { a: "foo" }),
+    testFilter({ field: "a", operator: "equal", value: "foo" }, { a: "foo" }),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
+      { field: "a", operator: "equal", valueField: "b" },
+      { a: "foo", b: "foo" },
+    ),
+  ).toBe(true);
+  expect(
+    testFilter(
       {
         field: "a",
         operator: "equal",
@@ -109,10 +115,10 @@ test("tests filter on string values", () => {
     ),
   ).toBe(true);
   expect(
-    filterItem({ field: "a", operator: "equal", value: "bar" }, { a: "foo" }),
+    testFilter({ field: "a", operator: "equal", value: "bar" }, { a: "foo" }),
   ).toBe(false);
   expect(
-    filterItem(
+    testFilter(
       {
         field: "a",
         operator: "equal",
@@ -123,19 +129,19 @@ test("tests filter on string values", () => {
     ),
   ).toBe(false);
   expect(
-    filterItem(
+    testFilter(
       { field: "a", operator: "notEqual", value: "bar" },
       { a: "foo" },
     ),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       { field: "a", operator: "include", value: "bar" },
       { a: "foobar" },
     ),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       {
         field: "a",
         operator: "include",
@@ -146,13 +152,13 @@ test("tests filter on string values", () => {
     ),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       { field: "a", operator: "intersect", value: ["foo", "bar", "foobar"] },
       { a: "foobar" },
     ),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       {
         field: "a",
         operator: "intersect",
@@ -163,13 +169,13 @@ test("tests filter on string values", () => {
     ),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       { field: "a", operator: "intersect", value: ["foo", "bar"] },
       { a: "foobar" },
     ),
   ).toBe(false);
   expect(
-    filterItem(
+    testFilter(
       {
         field: "a",
         operator: "match",
@@ -180,7 +186,7 @@ test("tests filter on string values", () => {
     ),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       {
         field: "a",
         operator: "match",
@@ -194,25 +200,25 @@ test("tests filter on string values", () => {
 
 test("tests filter on number values", () => {
   expect(
-    filterItem({ field: "a", operator: "equal", value: 1 }, { a: 1 }),
+    testFilter({ field: "a", operator: "equal", value: 1 }, { a: 1 }),
   ).toBe(true);
   expect(
-    filterItem({ field: "a", operator: "notEqual", value: 2 }, { a: 1 }),
+    testFilter({ field: "a", operator: "notEqual", value: 2 }, { a: 1 }),
   ).toBe(true);
   expect(
-    filterItem({ field: "a", operator: "greaterThan", value: 0 }, { a: 1 }),
+    testFilter({ field: "a", operator: "greaterThan", value: 0 }, { a: 1 }),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       { field: "a", operator: "greaterThanOrEqual", value: 1 },
       { a: 1 },
     ),
   ).toBe(true);
   expect(
-    filterItem({ field: "a", operator: "lowerThan", value: 2 }, { a: 1 }),
+    testFilter({ field: "a", operator: "lowerThan", value: 2 }, { a: 1 }),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       { field: "a", operator: "lowerThanOrEqual", value: 1 },
       { a: 1 },
     ),
@@ -221,28 +227,28 @@ test("tests filter on number values", () => {
 
 test("tests filter on array values", () => {
   expect(
-    filterItem({ field: "a", operator: "equal", value: [2, 1] }, { a: [1, 2] }),
+    testFilter({ field: "a", operator: "equal", value: [2, 1] }, { a: [1, 2] }),
   ).toBe(true);
   expect(
-    filterItem({ field: "a", operator: "equal", value: [2] }, { a: [1, 2] }),
+    testFilter({ field: "a", operator: "equal", value: [2] }, { a: [1, 2] }),
   ).toBe(false);
   expect(
-    filterItem({ field: "a", operator: "include", value: [1] }, { a: [1, 2] }),
+    testFilter({ field: "a", operator: "include", value: [1] }, { a: [1, 2] }),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       { field: "a", operator: "include", value: [2, 3] },
       { a: [1, 2] },
     ),
   ).toBe(false);
   expect(
-    filterItem(
+    testFilter(
       { field: "a", operator: "intersect", value: [2, 3] },
       { a: [1, 2] },
     ),
   ).toBe(true);
   expect(
-    filterItem(
+    testFilter(
       { field: "a", operator: "intersect", value: [3, 4] },
       { a: [1, 2] },
     ),
@@ -250,11 +256,11 @@ test("tests filter on array values", () => {
 });
 
 test("tests filter with children predicates", () => {
-  expect(filterItem({ operator: "children", value: "a" }, { id: "a/b" })).toBe(
+  expect(testFilter({ operator: "children", value: "a" }, { id: "a/b" })).toBe(
     true,
   );
   expect(
-    filterItem(
+    testFilter(
       { operator: "children", value: ".a" },
       { path: ".a.b" },
       {
@@ -268,7 +274,7 @@ test("tests filter with children predicates", () => {
     value: "a",
   };
   expect(
-    filterItem(
+    testFilter(
       filterChildren,
       { path: ".a.b" },
       {
@@ -283,11 +289,11 @@ test("tests filter with children predicates", () => {
     ),
   ).toBe(true);
   expect(filterChildren[SymbolCache]).toBeDefined();
-  expect(filterItem({ operator: "children", value: "b" }, { id: "a/b" })).toBe(
+  expect(testFilter({ operator: "children", value: "b" }, { id: "a/b" })).toBe(
     false,
   );
   expect(
-    filterItem(
+    testFilter(
       { operator: "children", value: "ba" },
       { path: ".a.b" },
       {