Update api reference docs for links: part 1

.api-reports/api-report-link_batch-http.api.md

@@ -19,10 +19,11 @@ export class BaseBatchHttpLink extends ApolloLink {
 
 // @public (undocumented)
 export namespace BatchHttpLink {
-    // (undocumented)
-    export type ContextOptions = HttpLink.ContextOptions;
-    // (undocumented)
-    export type Options = Pick<BatchLink.Options, "batchMax" | "batchDebounce" | "batchInterval" | "batchKey"> & Omit<HttpLink.Options, "useGETForQueries">;
+    export interface ContextOptions extends HttpLink.ContextOptions {
+    }
+    export interface Options extends BatchLink.Shared.Options, HttpLink.Shared.Options {
+        batchMax?: number;
+    }
 }
 
 // @public

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

@@ -12,13 +12,19 @@ export namespace BatchLink {
     // (undocumented)
     export type BatchHandler = (operations: ApolloLink.Operation[], forward: ApolloLink.ForwardFunction[]) => Observable<ApolloLink.Result[]>;
     // (undocumented)
-    export interface Options {
-        batchDebounce?: boolean;
+    export interface Options extends Shared.Options {
         batchHandler?: BatchLink.BatchHandler;
-        batchInterval?: number;
-        batchKey?: (operation: ApolloLink.Operation) => string;
         batchMax?: number;
     }
+    // (undocumented)
+    export namespace Shared {
+        export interface Options {
+            batchDebounce?: boolean;
+            batchInterval?: number;
+            batchKey?: (operation: ApolloLink.Operation) => string;
+            batchMax?: number;
+        }
+    }
 }
 
 // @public (undocumented)

.api-reports/api-report-link_client-awareness.api.md

@@ -20,12 +20,12 @@ export namespace ClientAwarenessLink {
     }
     // (undocumented)
     export interface Options {
-        clientAwareness?: ClientAwarenessOptions;
-        enhancedClientAwareness?: EnhancedClientAwarenessOptions;
+        clientAwareness?: ClientAwarenessLink.ClientAwarenessOptions;
+        enhancedClientAwareness?: ClientAwarenessLink.EnhancedClientAwarenessOptions;
     }
 }
 
-// @public (undocumented)
+// @public
 export class ClientAwarenessLink extends ApolloLink {
     constructor(constructorOptions?: ClientAwarenessLink.Options);
 }

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

@@ -14,16 +14,19 @@ export namespace ErrorLink {
         // (undocumented)
         (options: ErrorHandlerOptions): Observable<ApolloLink.Result> | void;
     }
-    // (undocumented)
     export interface ErrorHandlerOptions {
         error: ErrorLike;
         forward: ApolloLink.ForwardFunction;
         operation: ApolloLink.Operation;
         result?: ApolloLink.Result;
     }
+    // (undocumented)
+    export namespace ErrorLinkDocumentationTypes {
+        export function ErrorHandler(options: ErrorHandlerOptions): Observable<ApolloLink.Result> | void;
+    }
 }
 
-// @public (undocumented)
+// @public
 export class ErrorLink extends ApolloLink {
     constructor(errorHandler: ErrorLink.ErrorHandler);
 }

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

@@ -74,33 +74,38 @@ export namespace HttpLink {
         fetchOptions?: RequestInit;
         headers?: Record<string, string>;
         http?: HttpLink.HttpOptions;
-        uri?: string | UriFunction;
+        uri?: string | HttpLink.UriFunction;
     }
     export interface HttpOptions {
         accept?: string[];
         includeExtensions?: boolean;
         includeQuery?: boolean;
         preserveHeaderCase?: boolean;
     }
-    export interface Options {
-        credentials?: RequestCredentials;
-        fetch?: typeof fetch;
-        fetchOptions?: RequestInit;
-        headers?: Record<string, string>;
-        includeExtensions?: boolean;
-        includeUnusedVariables?: boolean;
-        preserveHeaderCase?: boolean;
-        print?: Printer;
-        uri?: string | UriFunction;
+    export interface Options extends Shared.Options {
         useGETForQueries?: boolean;
     }
     // (undocumented)
     export type Printer = (node: ASTNode, originalPrint: typeof print_2) => string;
     // (undocumented)
+    export namespace Shared {
+        export interface Options {
+            credentials?: RequestCredentials;
+            fetch?: typeof fetch;
+            fetchOptions?: RequestInit;
+            headers?: Record<string, string>;
+            includeExtensions?: boolean;
+            includeUnusedVariables?: boolean;
+            preserveHeaderCase?: boolean;
+            print?: HttpLink.Printer;
+            uri?: string | HttpLink.UriFunction;
+        }
+    }
+    // (undocumented)
     export type UriFunction = (operation: ApolloLink.Operation) => string;
 }
 
-// @public (undocumented)
+// @public
 export class HttpLink extends ApolloLink {
     constructor(options?: HttpLink.Options & ClientAwarenessLink.Options);
 }

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

@@ -8,7 +8,7 @@ import { ApolloLink } from '@apollo/client/link';
 import type { Client } from 'graphql-ws';
 import { Observable } from 'rxjs';
 
-// @public (undocumented)
+// @public
 export class GraphQLWsLink extends ApolloLink {
     constructor(client: Client);
     // (undocumented)

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

@@ -667,14 +667,12 @@ namespace ClientAwarenessLink {
     }
     // (undocumented)
     interface Options {
-        // Warning: (ae-forgotten-export) The symbol "ClientAwarenessLink" needs to be exported by the entry point index.d.ts
-        clientAwareness?: ClientAwarenessOptions;
-        // Warning: (ae-forgotten-export) The symbol "ClientAwarenessLink" needs to be exported by the entry point index.d.ts
-        enhancedClientAwareness?: EnhancedClientAwarenessOptions;
+        clientAwareness?: ClientAwarenessLink.ClientAwarenessOptions;
+        enhancedClientAwareness?: ClientAwarenessLink.EnhancedClientAwarenessOptions;
     }
 }
 
-// @public (undocumented)
+// @public
 class ClientAwarenessLink extends ApolloLink {
     constructor(constructorOptions?: ClientAwarenessLink.Options);
 }
@@ -1354,35 +1352,40 @@ export namespace HttpLink {
         fetchOptions?: RequestInit;
         headers?: Record<string, string>;
         http?: HttpLink.HttpOptions;
-        uri?: string | UriFunction;
+        uri?: string | HttpLink.UriFunction;
     }
     export interface HttpOptions {
         accept?: string[];
         includeExtensions?: boolean;
         includeQuery?: boolean;
         preserveHeaderCase?: boolean;
     }
-    export interface Options {
-        credentials?: RequestCredentials;
-        fetch?: typeof fetch;
-        fetchOptions?: RequestInit;
-        headers?: Record<string, string>;
-        includeExtensions?: boolean;
-        includeUnusedVariables?: boolean;
-        preserveHeaderCase?: boolean;
-        print?: Printer;
-        uri?: string | UriFunction;
+    export interface Options extends Shared.Options {
         useGETForQueries?: boolean;
     }
     // Warning: (ae-forgotten-export) The symbol "print_2" needs to be exported by the entry point index.d.ts
     //
     // (undocumented)
     export type Printer = (node: ASTNode, originalPrint: typeof print_2) => string;
     // (undocumented)
+    export namespace Shared {
+        export interface Options {
+            credentials?: RequestCredentials;
+            fetch?: typeof fetch;
+            fetchOptions?: RequestInit;
+            headers?: Record<string, string>;
+            includeExtensions?: boolean;
+            includeUnusedVariables?: boolean;
+            preserveHeaderCase?: boolean;
+            print?: HttpLink.Printer;
+            uri?: string | HttpLink.UriFunction;
+        }
+    }
+    // (undocumented)
     export type UriFunction = (operation: ApolloLink.Operation) => string;
 }
 
-// @public (undocumented)
+// @public
 export class HttpLink extends ApolloLink {
     constructor(options?: HttpLink.Options & ClientAwarenessLink.Options);
 }

.changeset/plenty-flies-relate.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+update type of `HttpLink.Options.fetchOptions` to `RequestInit`

config/helpers.ts

@@ -248,6 +248,7 @@ export function patchApiExtractorInternals() {
         for (const excerpt of item.excerptTokens) {
           const stringified = excerpt.canonicalReference?.toString();
           if (stringified?.startsWith("@apollo/client!entrypoint_")) {
+            // @ts-ignore
             excerpt["_canonicalReference"] = DeclarationReference.parse(
               stringified.replace(
                 /(@apollo\/client!entrypoint_[^.]+)[.:]/,

config/inlineInheritDoc.ts

@@ -37,7 +37,7 @@ import {
 } from "@microsoft/api-extractor";
 import { ApiDocumentedItem, ApiModel } from "@microsoft/api-extractor-model";
 import type { DocComment, DocExcerpt, DocNode } from "@microsoft/tsdoc";
-import { TextRange } from "@microsoft/tsdoc";
+import type { TextRange } from "@microsoft/tsdoc";
 import { DeclarationReference } from "@microsoft/tsdoc/lib-commonjs/beta/DeclarationReference.js";
 import { visit } from "recast";
 
@@ -77,7 +77,7 @@ function getCommentFor(
     const unusedVariables = new Set(Object.keys(variables || {}));
     let string = renderDocComment(apiItem.tsdocComment);
 
-    string = string.replaceAll(/\{\{(\w+)\}\}/g, (_, variable) => {
+    string = string.replaceAll(/\\?\{\\?\{(\w+)\\?\}\\?\}/g, (_, variable) => {
       unusedVariables.delete(variable);
       const value = variables?.[variable];
       if (value === undefined) {

docs/source/_sidebar.yaml

@@ -189,27 +189,27 @@ items:
             href: ./api/link/introduction
           - label: ApolloLink
             href: ./api/link/apollo-link
-          - label: HttpLink
-            href: ./api/link/apollo-link-http
           - label: BatchHttpLink
             href: ./api/link/apollo-link-batch-http
-          - label: SetContextLink
-            href: ./api/link/apollo-link-context
+          - label: ClientAwarenessLink
+            href: ./api/link/apollo-link-client-awareness
           - label: ErrorLink
             href: ./api/link/apollo-link-error
+          - label: GraphQLWsLink
+            href: ./api/link/apollo-link-subscriptions
+          - label: HttpLink
+            href: ./api/link/apollo-link-http
           - label: PersistedQueryLink
             href: ./api/link/persisted-queries
           - label: RemoveTypenameFromVariablesLink
             href: ./api/link/apollo-link-remove-typename
-          - label: RestLink
-            href: ./api/link/apollo-link-rest
           - label: RetryLink
             href: ./api/link/apollo-link-retry
           - label: SchemaLink
             href: ./api/link/apollo-link-schema
-          - label: GraphQLWsLink (newer protocol)
-            href: ./api/link/apollo-link-subscriptions
-          - label: WebSocketLink (older protocol)
+          - label: SetContextLink
+            href: ./api/link/apollo-link-context
+          - label: WebSocketLink (deprecated)
             href: ./api/link/apollo-link-ws
           - label: Community links
             href: ./api/link/community-links