Allow FragmentType to be called as FragmentType<TypedDocumentNode> (#13009)

* Allow `FragmentType` not only to be called as `FragmentType<TData>`, but also as `FragmentType<TypedDocumentNode>`.

* update non-type-import

* simplify type

* chores

* fixup 🤦

* lint

* Clean up Prettier, Size-limit, and Api-Extractor

---------

Co-authored-by: phryneas <[email protected]>

Author: phryneas

.api-reports/api-report-masking.api.md

@@ -7,6 +7,7 @@
 import type { ApolloCache } from '@apollo/client';
 import type { ApplyHKTImplementationWithDefault } from '@apollo/client/utilities/internal';
 import type { DocumentNode } from '@apollo/client';
+import type { DocumentTypeDecoration } from '@graphql-typed-document-node/core';
 import type { HKT } from '@apollo/client/utilities';
 import type { IsAny } from '@apollo/client/utilities/internal';
 import type { Prettify } from '@apollo/client/utilities/internal';
@@ -63,7 +64,7 @@ type ExtractByMatchingTypeNames<Union extends {
 // Warning: (ae-forgotten-export) The symbol "PreserveTypes" needs to be exported by the entry point index.d.ts
 //
 // @public
-export type FragmentType<TFragmentData> = ApplyHKTImplementationWithDefault<TypeOverrides, "FragmentType", PreserveTypes.TypeOverrides, TFragmentData>;
+export type FragmentType<TFragmentDataOrTypedDocumentNode> = ApplyHKTImplementationWithDefault<TypeOverrides, "FragmentType", PreserveTypes.TypeOverrides, TFragmentDataOrTypedDocumentNode extends (DocumentTypeDecoration<infer TFragmentData, any>) ? TFragmentData : TFragmentDataOrTypedDocumentNode>;
 
 // @public (undocumented)
 export namespace GraphQLCodegenDataMasking {

.api-reports/api-report.api.md

@@ -8,6 +8,7 @@ import type { ASTNode } from 'graphql';
 import { disableExperimentalFragmentVariables } from 'graphql-tag';
 import { disableFragmentWarnings } from 'graphql-tag';
 import { DocumentNode } from 'graphql';
+import type { DocumentTypeDecoration } from '@graphql-typed-document-node/core';
 import { enableExperimentalFragmentVariables } from 'graphql-tag';
 import type { FieldNode } from 'graphql';
 import type { FormattedExecutionResult } from 'graphql';
@@ -1216,7 +1217,7 @@ interface FragmentRegistryAPI {
 // Warning: (ae-forgotten-export) The symbol "PreserveTypes" needs to be exported by the entry point index.d.ts
 //
 // @public
-export type FragmentType<TFragmentData> = ApplyHKTImplementationWithDefault<TypeOverrides, "FragmentType", PreserveTypes.TypeOverrides, TFragmentData>;
+export type FragmentType<TFragmentDataOrTypedDocumentNode> = ApplyHKTImplementationWithDefault<TypeOverrides, "FragmentType", PreserveTypes.TypeOverrides, TFragmentDataOrTypedDocumentNode extends (DocumentTypeDecoration<infer TFragmentData, any>) ? TFragmentData : TFragmentDataOrTypedDocumentNode>;
 
 // @public @deprecated (undocumented)
 export const from: typeof ApolloLink.from;

.changeset/few-parrots-raise.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Allow `FragmentType` not only to be called as `FragmentType<TData>`, but also as `FragmentType<TypedDocumentNode>`.

.size-limits.json

@@ -1,6 +1,6 @@
 {
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (CJS)": 45497,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production) (CJS)": 40156,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\"": 34540,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production)": 28414
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (CJS)": 45545,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production) (CJS)": 40136,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\"": 34567,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production)": 28389
 }

src/masking/__benches__/types.bench.ts

@@ -3,7 +3,11 @@ import { setup } from "@ark/attest";
 import { expectTypeOf } from "expect-type";
 
 import type { TypedDocumentNode } from "@apollo/client";
-import type { MaybeMasked, Unmasked } from "@apollo/client/masking";
+import type {
+  FragmentType,
+  MaybeMasked,
+  Unmasked,
+} from "@apollo/client/masking";
 import type { DeepPartial } from "@apollo/client/utilities";
 
 import type { ContainsFragmentsRefs } from "../internal/types.js";
@@ -267,7 +271,7 @@ test("Unmasked handles odd types", (prefix) => {
 
   bench(prefix + "unknown instantiations", () => {
     attest<unknown, Unmasked<unknown>>();
-  }).types([48, "instantiations"]);
+  }).types([46, "instantiations"]);
 
   bench(prefix + "unknown functionality", () => {
     expectTypeOf<Unmasked<unknown>>().toBeUnknown();
@@ -661,3 +665,47 @@ test("Unmasked handles branded primitive types", (prefix) => {
     }>();
   });
 });
+
+test("FragmentType", () => {
+  type UserFieldsFragment = {
+    __typename: "User";
+    id: number;
+    age: number;
+  } & { " $fragmentName"?: "UserFieldsFragment" } & {
+    " $fragmentRefs"?: {
+      NameFieldsFragment: NameFieldsFragment;
+    };
+  };
+
+  type NameFieldsFragment = {
+    __typename: "User";
+    firstName: string;
+    lastName: string;
+  } & { " $fragmentName"?: "NameFieldsFragment" };
+
+  type Source = UserFieldsFragment;
+
+  const USER_FIELDS_FRAGMENT: TypedDocumentNode<UserFieldsFragment> = {} as any;
+
+  bench("normal usage", () => {
+    expectTypeOf<FragmentType<Source>>().toEqualTypeOf<{
+      " $fragmentRefs"?: {
+        UserFieldsFragment: UserFieldsFragment;
+      };
+    }>();
+  });
+
+  bench("passing in the type of a `TypedDocumentNode`", () => {
+    expectTypeOf<FragmentType<typeof USER_FIELDS_FRAGMENT>>().toEqualTypeOf<{
+      " $fragmentRefs"?: {
+        UserFieldsFragment: UserFieldsFragment;
+      };
+    }>();
+  });
+
+  bench("both usages yield the same result", () => {
+    expectTypeOf<FragmentType<Source>>().toEqualTypeOf<
+      FragmentType<typeof USER_FIELDS_FRAGMENT>
+    >();
+  });
+});

src/masking/types.ts

@@ -1,3 +1,5 @@
+import type { DocumentTypeDecoration } from "@graphql-typed-document-node/core";
+
 import type { TypeOverrides } from "@apollo/client";
 import type { ApplyHKTImplementationWithDefault } from "@apollo/client/utilities/internal";
 
@@ -6,12 +8,17 @@ import type { PreserveTypes } from "./PreserveTypes.js";
 /**
  * Type used with [fragments](https://apollographql.com/docs/react/data/fragments#using-with-fragments) to ensure parent objects contain the fragment spread from the type.
  */
-export type FragmentType<TFragmentData> = ApplyHKTImplementationWithDefault<
-  TypeOverrides,
-  "FragmentType",
-  PreserveTypes.TypeOverrides,
-  TFragmentData
->;
+export type FragmentType<TFragmentDataOrTypedDocumentNode> =
+  ApplyHKTImplementationWithDefault<
+    TypeOverrides,
+    "FragmentType",
+    PreserveTypes.TypeOverrides,
+    TFragmentDataOrTypedDocumentNode extends (
+      DocumentTypeDecoration<infer TFragmentData, any>
+    ) ?
+      TFragmentData
+    : TFragmentDataOrTypedDocumentNode
+  >;
 
 /** Unwraps `TData` into its unmasked type. */
 export type Unmasked<TData> = ApplyHKTImplementationWithDefault<