move AdditionalApolloLinkResultTypes into TypeOverrides

Author: phryneas

.changeset/four-rockets-live.md

@@ -0,0 +1,14 @@
+---
+"@apollo/client": major
+---
+
+If you use an incremental delivery handler, you now have to explicitly opt into adding the chunk types to the `ApolloLink.Result` type.
+
+
+```ts title="apollo-client.d.ts
+import { Defer20220824Handler } from "@apollo/client/incremental";
+
+declare module "@apollo/client" {
+  export interface TypeOverrides extends Defer20220824Handler.TypeOverrides {}
+}
+```

integration-tests/vite/src/ApolloLinkResultType.ts

@@ -0,0 +1,12 @@
+import type { ApolloLink } from "@apollo/client";
+import type { FormattedExecutionResult } from "graphql";
+
+// ensure that without manual addition to `TypeOverrides`,
+// `ApolloLink.Result` equals `FormattedExecutionResult`
+// with no additional alternatives
+
+type TData = { foo: string };
+type TExtensions = { bar: number };
+expectTypeOf<ApolloLink.Result<TData, TExtensions>>().toEqualTypeOf<
+  FormattedExecutionResult<TData, TExtensions>
+>();

src/incremental/handlers/defer20220824.ts

@@ -5,7 +5,7 @@ import type {
 } from "graphql";
 
 import type { ApolloLink } from "@apollo/client/link";
-import type { DeepPartial } from "@apollo/client/utilities";
+import type { DeepPartial, HKT } from "@apollo/client/utilities";
 import {
   DeepMerger,
   hasDirectives,
@@ -15,6 +15,15 @@ import {
 import type { Incremental } from "../types.js";
 
 export declare namespace Defer20220824Handler {
+  interface Defer20220824Result extends HKT {
+    arg1: unknown; // TData
+    arg2: unknown; // TExtensions
+    return: Defer20220824Handler.Chunk<Record<string, unknown>>;
+  }
+  export interface TypeOverrides {
+    AdditionalApolloLinkResultTypes: Defer20220824Result;
+  }
+
   export type InitialResult<TData = Record<string, unknown>> = {
     data?: TData | null | undefined;
     errors?: ReadonlyArray<GraphQLFormattedError>;
@@ -43,12 +52,6 @@ export declare namespace Defer20220824Handler {
   };
 }
 
-declare module "@apollo/client/link" {
-  export interface AdditionalApolloLinkResultTypes {
-    Defer20220824Handler: Defer20220824Handler.Chunk<Record<string, unknown>>;
-  }
-}
-
 class DeferRequest<TData extends Record<string, unknown>>
   implements
     Incremental.IncrementalRequest<Defer20220824Handler.Chunk<TData>, TData>

src/incremental/handlers/notImplemented.ts

@@ -1,9 +1,21 @@
 import type { ApolloLink } from "@apollo/client/link";
+import type { HKT } from "@apollo/client/utilities";
 import { hasDirectives } from "@apollo/client/utilities/internal";
 import { invariant } from "@apollo/client/utilities/invariant";
 
 import type { Incremental } from "../types.js";
 
+export declare namespace NotImplementedHandler {
+  interface NotImplementedResult extends HKT {
+    arg1: unknown; // TData
+    arg2: unknown; // TExtensions
+    return: never;
+  }
+  export interface TypeOverrides {
+    AdditionalApolloLinkResultTypes: NotImplementedResult;
+  }
+}
+
 export class NotImplementedHandler implements Incremental.Handler<never> {
   isIncrementalResult(_: any): _ is never {
     return false;

src/link/core/ApolloLink.ts

@@ -11,15 +11,16 @@ import type {
   DefaultContext,
   OperationVariables,
 } from "@apollo/client";
+import type { TypeOverrides } from "@apollo/client";
+import type { NotImplementedHandler } from "@apollo/client/incremental";
 import { createOperation } from "@apollo/client/link/utils";
 import { __DEV__ } from "@apollo/client/utilities/environment";
+import type { ApplyHKTImplementationWithDefault } from "@apollo/client/utilities/internal";
 import {
   invariant,
   newInvariantError,
 } from "@apollo/client/utilities/invariant";
 
-import type { AdditionalApolloLinkResultTypes } from "./types.js";
-
 export declare namespace ApolloLink {
   /**
    * Context provided for link execution, such as the client executing the
@@ -73,15 +74,23 @@ export declare namespace ApolloLink {
     forward: ApolloLink.ForwardFunction
   ) => Observable<ApolloLink.Result>;
 
+  export type AdditionalResultTypes<
+    TData = Record<string, any>,
+    TExtensions = Record<string, any>,
+  > = ApplyHKTImplementationWithDefault<
+    TypeOverrides,
+    "AdditionalApolloLinkResultTypes",
+    NotImplementedHandler.TypeOverrides,
+    TData,
+    TExtensions
+  >;
+
   export type Result<
     TData = Record<string, any>,
     TExtensions = Record<string, any>,
   > =
     | FormattedExecutionResult<TData, TExtensions>
-    | AdditionalApolloLinkResultTypes<
-        TData,
-        TExtensions
-      >[keyof AdditionalApolloLinkResultTypes<TData, TExtensions>];
+    | AdditionalResultTypes<TData, TExtensions>;
 
   /**
    * The currently executed operation object provided to an `ApolloLink.RequestHandler`

src/link/core/types.ts

@@ -1,7 +1,4 @@
 import type { FormattedExecutionResult, GraphQLFormattedError } from "graphql";
-import type { DocumentNode } from "graphql";
-
-export type { DocumentNode };
 
 export interface ApolloPayloadResult<
   TData = Record<string, any>,
@@ -12,8 +9,3 @@ export interface ApolloPayloadResult<
   // these are fatal errors that will include done: true.
   errors?: ReadonlyArray<GraphQLFormattedError>;
 }
-
-export interface AdditionalApolloLinkResultTypes<
-  TData = Record<string, any>,
-  TExtensions = Record<string, any>,
-> {}

src/link/index.ts

@@ -1,15 +1,13 @@
+export type { DocumentNode } from "graphql";
+
 export { empty } from "./core/empty.js";
 export { from } from "./core/from.js";
 export { split } from "./core/split.js";
 export { concat } from "./core/concat.js";
 export { execute } from "./core/execute.js";
 export { ApolloLink } from "./core/ApolloLink.js";
 
-export type {
-  AdditionalApolloLinkResultTypes,
-  ApolloPayloadResult,
-  DocumentNode,
-} from "./core/types.js";
+export type { ApolloPayloadResult } from "./core/types.js";
 
 export type {
   FetchResult,

src/testing/internal/declarations.d.ts

@@ -1,4 +1,5 @@
 import { Streaming } from "@apollo/client";
+import type { Defer20220824Handler } from "@apollo/client/incremental";
 import type { GraphQLCodegenDataMasking } from "@apollo/client/masking";
 import type { HKT } from "@apollo/client/utilities";
 import { DeepPartial } from "@apollo/client/utilities";
@@ -11,9 +12,11 @@ type StreamingOverride<TData> = TData & { __streaming?: true };
 interface StreamingOverrideHKT extends HKT {
   return: StreamingOverride<this["arg1"]>;
 }
+
 declare module "@apollo/client" {
   export interface TypeOverrides
-    extends GraphQLCodegenDataMasking.TypeOverrides {
+    extends GraphQLCodegenDataMasking.TypeOverrides,
+      Defer20220824Handler.TypeOverrides {
     Streaming: StreamingOverrideHKT;
   }
 }