Add isOneOf typing on builder.inputObject

hayes · Aug 10, 2024 · 8219539 · 8219539
1 parent d5f989b
commit 8219539
Show file tree

Hide file tree

Showing 6 changed files with 58 additions and 3 deletions.
diff --git a/.changeset/smooth-parents-punch.md b/.changeset/smooth-parents-punch.md
@@ -0,0 +1,5 @@
+---
+"@pothos/core": minor
+---
+
+Add proper typeing for isOneOf option on builder.inputType
diff --git a/packages/core/src/builder.ts b/packages/core/src/builder.ts
@@ -55,6 +55,7 @@ import type {
   ObjectFieldsShape,
   ObjectParam,
   ObjectTypeOptions,
+  OneOfInputShapeFromFields,
   OutputShape,
   ParentShape,
   PluginConstructorMap,
@@ -583,18 +584,27 @@ export class SchemaBuilder<Types extends SchemaTypes> {
       : Param extends keyof Types['Inputs']
         ? InputFieldsFromShape<Types, InputShape<Types, Param> & object, 'InputObject'>
         : InputFieldMap,
+    IsOneOf extends boolean = boolean,
   >(
     param: Param,
-    options: PothosSchemaTypes.InputObjectTypeOptions<Types, Fields>,
-  ): PothosSchemaTypes.InputObjectRef<Types, InputShapeFromFields<Fields>> {
+    options: PothosSchemaTypes.InputObjectTypeOptions<Types, Fields> & {
+      isOneOf?: IsOneOf;
+    },
+  ): PothosSchemaTypes.InputObjectRef<
+    Types,
+    [IsOneOf] extends [true] ? OneOfInputShapeFromFields<Fields> : InputShapeFromFields<Fields>
+  > {
     verifyRef(param);
     const name = typeof param === 'string' ? param : (param as { name: string }).name;
 
     const ref = (
       typeof param === 'string'
         ? new InputObjectRef<Types, InputShapeFromFields<Fields>>(name)
         : param
-    ) as PothosSchemaTypes.InputObjectRef<Types, InputShapeFromFields<Fields>>;
+    ) as PothosSchemaTypes.InputObjectRef<
+      Types,
+      [IsOneOf] extends [true] ? OneOfInputShapeFromFields<Fields> : InputShapeFromFields<Fields>
+    >;
 
     ref.updateConfig({
       kind: 'InputObject',

diff --git a/packages/core/src/types/builder-options.ts b/packages/core/src/types/builder-options.ts
@@ -24,6 +24,7 @@ import type {
   Normalize,
   NormalizeNullableFields,
   RemoveNeverKeys,
+  Simplify,
 } from './utils';
 
 export type AddVersionedDefaultsToBuilderOptions<
@@ -211,6 +212,19 @@ export type ValidateInterfaces<
     : 'Object shape must extend interface shape'
   : never;
 
+export type OneOfInputShapeFromFields<Fields extends InputFieldMap> =
+  keyof Fields extends infer K extends keyof Fields
+    ? K extends unknown
+      ? Simplify<
+          {
+            [Name in K]: NonNullable<InputShapeFromField<Fields[K]>>;
+          } & {
+            [Name in keyof Fields as Name extends K ? never : Name]?: never;
+          }
+        >
+      : never
+    : never;
+
 export type InputShapeFromFields<Fields extends InputFieldMap> = NormalizeNullableFields<{
   [K in string & keyof Fields]: InputShapeFromField<Fields[K]>;
 }>;

diff --git a/packages/core/src/types/utils.ts b/packages/core/src/types/utils.ts
@@ -138,3 +138,5 @@ export interface PartialResolveInfo {
   variableValues: GraphQLResolveInfo['variableValues'];
   schema: GraphQLResolveInfo['schema'];
 }
+
+export type Simplify<T> = { [KeyType in keyof T]: T[KeyType] } & {};
diff --git a/packages/core/tests/__snapshots__/index.test.ts.snap b/packages/core/tests/__snapshots__/index.test.ts.snap
@@ -66,9 +66,15 @@ input NestedListInput {
   list: [[Int!]]!
 }
 
+input OneOfExample @oneOf {
+  a: String
+  b: String
+}
+
 type Query {
   constructor: Boolean
   nestedLists(input: [[[String!]!]]!, nestedListInput: NestedListInput): [[[String!]!]]
+  oneOf(oneOf: OneOfExample!): String!
   sheep: Sheep
   stuff: [stuff!]
   user: User

diff --git a/packages/core/tests/examples/random-stuff.ts b/packages/core/tests/examples/random-stuff.ts
@@ -346,6 +346,24 @@ builder.queryType({
         shaved: true,
       }),
     }),
+    oneOf: t.string({
+      args: {
+        oneOf: t.arg({
+          required: true,
+          type: builder.inputType('OneOfExample', {
+            isOneOf: true,
+            fields: (t) => ({
+              a: t.string(),
+              b: t.string(),
+            }),
+          }),
+        }),
+      },
+      nullable: false,
+      resolve: (_, { oneOf }) => {
+        return oneOf.a ?? oneOf.b;
+      },
+    }),
   }),
 });