Improve support types by making them dynamic with a derived type (and i want to use this dervive-er elsewhere)

Author: airhorns

packages/api-client-core/spec/TestSchema.ts

@@ -1,3 +1,5 @@
+import type { AvailableSelection } from "../src/types.js";
+
 export type NestedThing = {
   bool: boolean;
   string: string;
@@ -45,34 +47,4 @@ export type TestSchema = {
   };
 };
 
-export type AvailableTestSchemaSelection = {
-  num?: boolean | null | undefined;
-  str?: boolean | null | undefined;
-  obj?: {
-    test?: boolean | null | undefined;
-    bool?: boolean | null | undefined;
-  };
-  optionalObj?: {
-    test?: boolean | null | undefined;
-    bool?: boolean | null | undefined;
-  };
-  list?: {
-    title: boolean | null | undefined;
-  };
-  optionalList?: {
-    title: boolean | null | undefined;
-  };
-  nested?: NestedThing;
-  someConnection?: {
-    edges?: {
-      node?: {
-        id: boolean | null | undefined;
-        state: boolean | null | undefined;
-      };
-    };
-    pageInfo?: {
-      hasNextPage?: boolean | null | undefined;
-      hasPreviousPage?: boolean | null | undefined;
-    };
-  };
-};
+export type AvailableTestSchemaSelection = AvailableSelection<TestSchema>;

packages/api-client-core/src/ModelManager.ts

@@ -2,14 +2,23 @@ import type { GadgetConnection } from "./GadgetConnection.js";
 import type { GadgetRecord } from "./GadgetRecord.js";
 import type { GadgetRecordList } from "./GadgetRecordList.js";
 
+export type AnyModelFinderMetadata = {
+  operationName: string;
+  modelApiIdentifier: string;
+  defaultSelection: Record<string, any>;
+  selectionType: any;
+  optionsType: any;
+  schemaType: any | null;
+};
+
 /**
  * Object representing one model's API in a high level way
  * This is a generic interface. Concrete ones are generated by Gadget, */
 export interface AnyModelManager {
   connection: GadgetConnection;
-  findOne(id: string, options: any): Promise<GadgetRecord<any>>;
-  maybeFindOne(id: string, options: any): Promise<GadgetRecord<any> | null>;
-  findMany(options: any): Promise<GadgetRecordList<any>>;
-  findFirst(options: any): Promise<GadgetRecord<any>>;
+  findOne: ((id: string, options: any) => Promise<GadgetRecord<any>>) & AnyModelFinderMetadata;
+  findMany: ((options: any) => Promise<GadgetRecordList<any>>) & AnyModelFinderMetadata;
+  findFirst: ((options: any) => Promise<GadgetRecord<any>>) & AnyModelFinderMetadata;
   maybeFindFirst(options: any): Promise<GadgetRecord<any> | null>;
+  maybeFindOne(id: string, options: any): Promise<GadgetRecord<any> | null>;
 }

packages/api-client-core/src/types.ts

@@ -697,3 +697,30 @@ export type PaginateOptions = {
   last?: number | null;
   select?: AnySelection | InternalFieldSelection | null;
 };
+
+/**
+ * Convert a schema type into the type that a selection of it must extend
+ *
+ * Example Schema:
+ *
+ * {
+ *   foo: boolean;
+ *   bar?: string;
+ *   nested?: {
+ *     count: number
+ *   }
+ * }
+ *
+ * Example available selection:
+ *
+ * {
+ *   foo?: boolean | null | undefined;
+ *   bar?: boolean | null | undefined;
+ *   nested?: {
+ *     count: boolean | null | undefined
+ *   }
+ * }
+ */
+export type AvailableSelection<Schema> = Schema extends string | number | bigint | null | undefined
+  ? boolean | null | undefined
+  : { [key in keyof Schema]?: AvailableSelection<Schema[key]> };