Merge pull request #936 from gadget-inc/push-uuwwlkkvwzlu

Add `$args` symbol support for field arguments in selections

Author: shardulbee

packages/core/spec/Select-type.spec.ts

@@ -1,6 +1,7 @@
 import type { AssertTrue, IsExact } from "conditional-type-checks";
 import type { DeepFilterNever, Select } from "../src/types.js";
-import type { TestSchema } from "./TestSchema.js";
+import { $args } from "../src/types.js";
+import type { TestSchema, TestSchemaWithFieldCalls, TestSchemaWithNestedFieldCalls } from "./TestSchema.js";
 
 describe("Select<>", () => {
   type _SelectingProperties = AssertTrue<IsExact<Select<TestSchema, { num: true }>, { num: number }>>;
@@ -75,5 +76,40 @@ describe("Select<>", () => {
     >
   >;
 
+  type _fieldCallSelection = Select<
+    TestSchemaWithFieldCalls,
+    { fieldCall: { [$args]: { arg: [1, 2, 3]; limit: 10 }; nestedField1: true; nestedField2: { nestedField3: true } } }
+  >;
+  type _TestSelectingFieldCall = AssertTrue<
+    IsExact<_fieldCallSelection, { fieldCall: { nestedField1: number; nestedField2: { nestedField3: string } } }>
+  >;
+
+  type _simpleFieldCallSelection = Select<
+    { fieldWithArgs: number },
+    {
+      fieldWithArgs: {
+        [$args]: { arg: [1, 2, 3]; limit: 10 };
+      };
+    }
+  >;
+  type _TestSelectingSimpleFieldCall = AssertTrue<IsExact<_simpleFieldCallSelection, { fieldWithArgs: number }>>;
+
+  type _nestedFieldCallSelection = Select<
+    TestSchemaWithNestedFieldCalls,
+    {
+      outerFieldCall: {
+        [$args]: { outerArg: "value" };
+        innerFieldCall: {
+          [$args]: { innerArg: 123 };
+          deepField: { [$args]: { deepArg: "value" } };
+        };
+        regularField: true;
+      };
+    }
+  >;
+  type _TestSelectingNestedFieldCall = AssertTrue<
+    IsExact<_nestedFieldCallSelection, { outerFieldCall: { innerFieldCall: { deepField: string }; regularField: number } }>
+  >;
+
   test("true", () => undefined);
 });

packages/core/spec/TestSchema.ts

@@ -7,6 +7,26 @@ export type NestedThing = {
   nested: NestedThing;
 };
 
+export type TestSchemaWithFieldCalls = {
+  num: number;
+  str: string;
+  fieldCall: {
+    nestedField1: number;
+    nestedField2: {
+      nestedField3: string;
+    };
+  };
+};
+
+export type TestSchemaWithNestedFieldCalls = {
+  outerFieldCall: {
+    innerFieldCall: {
+      deepField: string;
+    };
+    regularField: number;
+  };
+};
+
 export type TestSchema = {
   num: number;
   str: string;

packages/core/src/AnyClient.ts

@@ -22,4 +22,6 @@ export interface AnyClient {
   internal: InternalModelManagerNamespace;
   [$modelRelationships]?: { [modelName: string]: { [apiIdentifier: string]: { type: string; model: string } } };
   [$coreImplementation]?: AnyCoreImplementation;
+  /** Symbol for passing field arguments in selections. Use as `{ field: { [api.$args]: { first: 10 }, nestedField: true } }` */
+  $args?: symbol;
 }

packages/core/src/types.ts

@@ -105,7 +105,7 @@ export type FilterNever<T extends Record<string, unknown>> = NonNeverKeys<T> ext
  * >;  // { apple: "red" }
  * ```
  */
-type InnerSelect<Schema, Selection extends FieldSelection | null | undefined> = IfAny<
+type InnerSelect<Schema, Selection extends FieldSelection | FieldSelectionWithArgs | null | undefined> = IfAny<
   Selection,
   never,
   Selection extends null | undefined
@@ -115,10 +115,12 @@ type InnerSelect<Schema, Selection extends FieldSelection | null | undefined> =
     : Schema extends null
     ? InnerSelect<Exclude<Schema, null>, Selection> | null
     : {
-        [Key in keyof Selection & keyof Schema]: Selection[Key] extends true
+        [Key in Exclude<keyof Selection, typeof $args> & keyof Schema]: Selection[Key] extends true
           ? Schema[Key]
-          : Selection[Key] extends FieldSelection
-          ? InnerSelect<Schema[Key], Selection[Key]>
+          : Selection[Key] extends FieldSelection | FieldSelectionWithArgs
+          ? Exclude<keyof Selection[Key], typeof $args> extends never
+            ? Schema[Key]
+            : InnerSelect<Schema[Key], Selection[Key]>
           : never;
       }
 >;
@@ -148,7 +150,9 @@ export type DeepFilterNever<T> = T extends Record<string, unknown>
  * >;  // { apple: "red" }
  * ```
  */
-export type Select<Schema, Selection extends FieldSelection | null | undefined> = DeepFilterNever<InnerSelect<Schema, Selection>>;
+export type Select<Schema, Selection extends FieldSelection | FieldSelectionWithArgs | null | undefined> = DeepFilterNever<
+  InnerSelect<Schema, Selection>
+>;
 
 /** Represents an amount of some currency. Specified as a string so user's aren't tempted to do math on the value. */
 export type CurrencyAmount = string;
@@ -1004,10 +1008,22 @@ export type ViewResult<F extends ViewFunction<any, any>> = Awaited<
   F extends ViewFunctionWithVariables<any, infer Result> ? Result : F extends ViewFunctionWithoutVariables<infer Result> ? Result : never
 >;
 
+/** Symbol key for field arguments in selections */
+export const $args: unique symbol = Symbol.for("gadget/fieldArgs");
+
+/** Field arguments (e.g., pagination, filtering) */
+export type FieldArgs = Record<string, any>;
+
 /**
  * Represents a list of fields selected from a GraphQL API call. Allows nesting, conditional selection.
  * Example: `{ id: true, name: false, richText: { markdown: true, html: false } }`
  **/
 export interface FieldSelection {
   [key: string]: boolean | null | undefined | FieldSelection;
 }
+
+/** A field selection that includes field arguments via the $args symbol key */
+export type FieldSelectionWithArgs = {
+  [$args]: FieldArgs;
+  [key: string]: boolean | null | undefined | FieldSelection | FieldSelectionWithArgs;
+};