fix: Add type narrowing to readFragment (#372)

0no-co · Aug 18, 2024 · 5328c8a · 5328c8a
1 parent 8849b97
commit 5328c8a
Show file tree

Hide file tree

Showing 3 changed files with 98 additions and 6 deletions.
diff --git a/.changeset/ten-taxis-shop.md b/.changeset/ten-taxis-shop.md
@@ -0,0 +1,5 @@
+---
+"gql.tada": patch
+---
+
+Allow `readFragment(doc, data)` to narrow output's `__typename`s by the input type.
diff --git a/src/__tests__/api.test-d.ts b/src/__tests__/api.test-d.ts
@@ -578,6 +578,83 @@ describe('readFragment', () => {
     type document = getDocumentNode<fragment, schema>;
     const result = readFragment({} as document, {} as FragmentOf<document>);
     expectTypeOf<typeof result>().toEqualTypeOf<ResultOf<document>>();
+
+    const narrowInput = {} as FragmentOf<document> & { __typename?: 'BigTodo' };
+    const narrowed = readFragment({} as document, narrowInput);
+    expectTypeOf<typeof narrowed>().toEqualTypeOf<{
+      __typename?: 'BigTodo';
+      id: unknown;
+      wallOfText: unknown;
+    }>();
+  });
+
+  it('unmasks fragments of interfaces while narrowing types using input', () => {
+    type fragment = parseDocument<`
+      fragment Fields on ITodo {
+        id
+        ... on BigTodo {
+          wallOfText
+        }
+        ... on SmallTodo {
+          maxLength
+        }
+      }
+    `>;
+
+    type document = getDocumentNode<fragment, schema>;
+
+    const data: FragmentOf<document> & { __typename?: 'SmallTodo' } = {} as any;
+    const result = readFragment({} as document, data);
+    expectTypeOf<typeof result>().toEqualTypeOf<{
+      __typename?: 'SmallTodo';
+      id: unknown;
+      maxLength: unknown;
+    }>();
+  });
+
+  it('should allow for gradual narrowing', () => {
+    type childFragment = parseDocument<`
+      fragment Fields on ITodo {
+        id
+        ... on BigTodo {
+          wallOfText
+        }
+        ... on SmallTodo {
+          maxLength
+        }
+      }
+    `>;
+
+    type parentFragment = parseDocument<`
+      fragment Parent on ITodo {
+        __typename
+        ...Fields
+      }
+    `>;
+
+    type childFragmentDoc = getDocumentNode<childFragment, schema>;
+    type parentFragmentDoc = getDocumentNode<
+      parentFragment,
+      schema,
+      getFragmentsOfDocuments<[childFragmentDoc]>
+    >;
+
+    const input: ResultOf<parentFragmentDoc> = {} as any;
+    if (input.__typename === 'SmallTodo') {
+      const result = readFragment({} as childFragmentDoc, input);
+      expectTypeOf<typeof result>().toEqualTypeOf<{
+        __typename?: 'SmallTodo';
+        id: unknown;
+        maxLength: unknown;
+      }>();
+    } else if (input.__typename === 'BigTodo') {
+      const result = readFragment({} as childFragmentDoc, input);
+      expectTypeOf<typeof result>().toEqualTypeOf<{
+        __typename?: 'BigTodo';
+        id: unknown;
+        wallOfText: unknown;
+      }>();
+    }
   });
 
   it('unmasks fragments of interfaces with optional spreads', () => {

diff --git a/src/api.ts b/src/api.ts
@@ -449,6 +449,17 @@ type FragmentOf<Document extends FragmentShape> = makeFragmentRef<Document>;
 
 type resultOrFragmentOf<Document extends FragmentShape> = FragmentOf<Document> | ResultOf<Document>;
 
+type resultOfT<Document extends FragmentShape, T = unknown> = Document extends DocumentDecoration<
+  infer Result,
+  any
+>
+  ? '__typename' extends keyof T
+    ? Result extends { __typename?: T['__typename'] }
+      ? Result
+      : never
+    : Result
+  : never;
+
 type resultOfFragmentsRec<
   Fragments extends readonly any[],
   Result = {},
@@ -513,24 +524,23 @@ type fragmentRefsOfFragmentsRec<
  */
 function readFragment<const Document extends FragmentShape = never>(
   _document: Document,
-  fragment: resultOrFragmentOf<Document>
-): ResultOf<Document>;
-// Reading fragments where input data is an array and nullable
+  fragment: never
+): resultOfT<Document>;
+
 function readFragment<
   const Document extends FragmentShape,
   const T extends resultOrFragmentOf<Document> | null | undefined | {},
 >(
   _document: Document,
   fragments: readonly T[]
-): readonly (T extends resultOrFragmentOf<Document> ? ResultOf<Document> : T)[];
-// Reading fragments where input data is nullable
+): readonly (T extends resultOrFragmentOf<Document> ? resultOfT<Document, T> : T)[];
 function readFragment<
   const Document extends FragmentShape,
   const T extends resultOrFragmentOf<Document> | null | undefined | {},
 >(
   _document: Document,
   fragment: T
-): T extends resultOrFragmentOf<Document> ? ResultOf<Document> : T;
+): T extends resultOrFragmentOf<Document> ? resultOfT<Document, T> : T;
 
 // Reading arrays of fragments with required generic
 function readFragment<const Document extends FragmentShape>(