quetch 0.33.1 → 0.34.0

package/lib/types/Path.ts

@@ -1,15 +1,17 @@
 import type { Decrement } from "./Decrement";
 import type { DepthLimit } from "./DepthLimit";
-import type { Key } from "./Key";
 import type { Primitive } from "./Primitive";
 
+/**
+ * Returns the type of paths that can be used to select fields from a value of type `T`, with an optional depth limit `D`.
+ */
 export type Path<T, D = DepthLimit> = [unknown] extends [T]
-  ? readonly (Key | never)[]
+  ? readonly (PropertyKey | never)[]
   : [0] extends [1 & T]
-    ? readonly (Key | never)[]
+    ? readonly (PropertyKey | never)[]
     : D extends -1
       ? never
-      : T extends Primitive
+      : T extends Primitive | undefined
         ? readonly never[]
         : T extends Array<infer P>
           ? readonly [number] | readonly [number, ...Path<P, Decrement<D>>]

package/lib/types/PathFiltered.ts

@@ -1,11 +1,13 @@
 import type { Decrement } from "./Decrement";
 import type { DepthLimit } from "./DepthLimit";
-import type { Key } from "./Key";
 
+/**
+ * Returns the type of paths that can be used to select fields from a value of type `T` whose mapped value extend the provided `P` type, with an optional depth limit `D`.
+ */
 export type PathFiltered<T, P, D = DepthLimit> = [unknown] extends [T]
-  ? readonly (Key | never)[]
+  ? readonly (PropertyKey | never)[]
   : [0] extends [1 & T]
-    ? readonly (Key | never)[]
+    ? readonly (PropertyKey | never)[]
     : D extends -1
       ? never
       : T extends P

package/lib/types/Primitive.ts

@@ -1 +1,4 @@
+/**
+ * Defined primitive types.
+ */
 export type Primitive = string | number | boolean | bigint | symbol;

package/lib/types/Result.ts

@@ -8,37 +8,39 @@ import type { QueryRead } from "./QueryRead";
 import type { QueryReadMultiple } from "./QueryReadMultiple";
 
 /**
- * Picks fields `F` from object `T`.
+ * Picks fields `F` from value `T`.
  */
 type PickFields<T, F extends readonly Field<T>[]> = [unknown] extends [T]
   ? T
   : T extends Primitive
     ? T
-    : [F] extends [readonly [infer J, ...infer R]]
-      ? Merge<
-          | // J is a single key
-          ([J] extends [keyof T]
-              ? PickField<T, J, T[J]>
-              : // J is a path
-                [J] extends [readonly [infer K, ...infer S]]
-                ? [K] extends [keyof T]
-                  ? PickField<
-                      T,
-                      K,
-                      PickFields<
-                        T[K],
-                        S extends readonly Field<T[K]>[] ? S : never
+    : T extends undefined
+      ? never
+      : [F] extends [readonly [infer J, ...infer R]]
+        ? Merge<
+            | // J is a single key
+            ([J] extends [keyof T]
+                ? PickField<T, J, T[J]>
+                : // J is a path
+                  [J] extends [readonly [infer K, ...infer S]]
+                  ? [K] extends [keyof T]
+                    ? PickField<
+                        T,
+                        K,
+                        PickFields<
+                          T[K],
+                          S extends readonly Field<T[K]>[] ? S : never
+                        >
                       >
-                    >
-                  : never
-                : never)
-          | (R extends readonly never[]
-              ? never
-              : R extends readonly Field<T>[]
-                ? PickFields<T, R>
-                : never)
-        >
-      : never;
+                    : never
+                  : never)
+            | (R extends readonly never[]
+                ? never
+                : R extends readonly Field<T>[]
+                  ? PickFields<T, R>
+                  : never)
+          >
+        : never;
 
 type Merge<T> = Prettify<IntersectUnion<T>>;
 

package/lib/types.ts

@@ -38,7 +38,6 @@ export type { IntersectUnion } from "./types/IntersectUnion";
 export type { IntrinsicFilter } from "./types/IntrinsicFilter";
 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 { KeyFromUnion } from "./types/KeyFromUnion";
 export type { Locale } from "./types/Locale";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "quetch",
-  "version": "0.33.1",
+  "version": "0.34.0",
   "type": "module",
   "main": "./dist/main.js",
   "exports": {

package/dist/types/Key.d.ts

@@ -1 +0,0 @@
-export type Key = string | number | symbol;

package/dist/types/Key.js

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

package/dist/types/Key.js.map

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

package/doc/type-aliases/Key.md

@@ -1,13 +0,0 @@
-[**quetch**](../README.md)
-
-***
-
-[quetch](../README.md) / Key
-
-# Type Alias: Key
-
-> **Key**: `string` \| `number` \| `symbol`
-
-## Defined in
-
-[lib/types/Key.ts:1](https://github.com/nevoland/quetch/blob/26a6a149fc06ca974acb5d9f3e9fe2273dcb9969/lib/types/Key.ts#L1)

package/lib/types/Key.ts

@@ -1 +0,0 @@
-export type Key = string | number | symbol;