@graffy/core 0.16.20-alpha.4 → 0.16.20-alpha.6

package/package.json

@@ -2,7 +2,7 @@
   "name": "@graffy/core",
   "description": "The main module for Graffy, a library for intuitive real-time data APIs.",
   "author": "aravind (https://github.com/aravindet)",
-  "version": "0.16.20-alpha.4",
+  "version": "0.16.20-alpha.6",
   "main": "./index.cjs",
   "exports": {
     "import": "./index.mjs",
@@ -16,8 +16,8 @@
   },
   "license": "Apache-2.0",
   "dependencies": {
-    "@graffy/common": "0.16.20-alpha.4",
-    "@graffy/stream": "0.16.20-alpha.4",
+    "@graffy/common": "0.16.20-alpha.6",
+    "@graffy/stream": "0.16.20-alpha.6",
     "debug": "^4.3.7"
   }
 }

package/types/index.d.ts

@@ -9,6 +9,15 @@ type AnyFunction = (...args: any[]) => any;
 // biome-ignore lint/suspicious/noExplicitAny: Keys can be anything.
 type Key = any;
 
+// biome-ignore lint/suspicious/noExplicitAny: Any value is for results.
+type AnyValue = any;
+
+type AnyProjection =
+  | boolean
+  | { $key: Key }
+  | Record<string, AnyProjection>
+  | AnyProjection[];
+
 export type GraffyCollection<CollectionSchema extends AnyObject> = {
   [name: string]: CollectionSchema;
 } & { __brand: 'GraffyCollection' };
@@ -27,6 +36,13 @@ export default class Graffy<S> {
     options?: GraffyReadOptions,
   ): Promise<ReadResult<S, Q>>;
 
+  // Generic one, when the path is not known at compile time.
+  read<Q extends AnyProjection>(
+    path: string | Key[],
+    projection: Q,
+    options?: GraffyReadOptions,
+  ): Promise<BlindReadResult<Q>>;
+
   on: AnyFunction;
   call: AnyFunction;
   use: AnyFunction;
@@ -63,8 +79,9 @@ export type Project<S> = S extends AnyLeaf
   ? boolean
   : S extends GraffyCollection<AnyObject>
     ?
-        | (Project<S[string]> & { $key: Key })
-        | (Project<S[string]> & { $key: Key })[]
+        | { [key: string]: Project<S[string]> } //  Object form
+        | (Project<S[string]> & { $key: Key }) //   Single $key
+        | (Project<S[string]> & { $key: Key })[] // Array $key
     : S extends AnyObject
       ? Partial<{ [K in keyof S]: Project<S[K]> }> | boolean
       : never;
@@ -73,11 +90,28 @@ export type Project<S> = S extends AnyLeaf
 type ResultArray<R> = R[] & { $page: any; $next: any; $prev: any };
 
 type ReadResult<S, Q> = S extends GraffyCollection<AnyObject>
-  ? Q extends Array<AnyObject> | { $key: Key }
-    ? ResultArray<S[string] & { $key: Key }>
-    : S[string] & { $key: Key }
-  : S extends AnyObject
-    ? { [K in keyof S & keyof Q]: ReadResult<S[K], Q[K]> }
-    : S;
+  ? Q extends Array<infer QItem>
+    ? ResultArray<PlainReadResult<S[string], QItem> & { $key: Key }> // Array $key
+    : Q extends { $key: Key }
+      ? ResultArray<PlainReadResult<S[string], Q> & { $key: Key }> //   Single $key
+      : { [K in keyof Q]: PlainReadResult<S[string], Q[K]> } //         Object form
+  : PlainReadResult<S, Q>;
+
+// Ignore $key in Q
+type PlainReadResult<S, Q> = Q extends AnyObject
+  ? { [K in keyof S & keyof Q]: ReadResult<S[K], Q[K]> }
+  : S;
+
+// What can we tell about ReadResult when schema isn’t known?
+type BlindReadResult<Q> = Q extends Array<infer QItem>
+  ? ResultArray<BlindPlainReadResult<QItem>>
+  : Q extends { $key: Key }
+    ? ResultArray<BlindPlainReadResult<Q>>
+    : BlindPlainReadResult<Q>;
+
+// Ignore $key in Q
+type BlindPlainReadResult<Q> = Q extends AnyObject
+  ? { [K in keyof Q]: BlindReadResult<Q[K]> }
+  : AnyValue;
 
 type GraffyReadOptions = AnyObject;