Add getMainDefinition back to @apollo/client/utilities (#12725)

Author: jerelmiller

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

@@ -10,6 +10,7 @@ import type { DocumentNode } from 'graphql';
 import type { FormattedExecutionResult } from 'graphql';
 import type { GraphQLFormattedError } from 'graphql';
 import type { Observable } from 'rxjs';
+import type { OperationTypeNode } from 'graphql';
 
 // @public (undocumented)
 export interface AdditionalFetchResultTypes<TData = Record<string, any>, TExtensions = Record<string, any>> {
@@ -82,6 +83,8 @@ export interface GraphQLRequest<TVariables = Record<string, any>> {
     // (undocumented)
     operationName?: string;
     // (undocumented)
+    operationType?: OperationTypeNode;
+    // (undocumented)
     query: DocumentNode;
     // (undocumented)
     variables?: TVariables;
@@ -101,6 +104,8 @@ export interface Operation {
     // (undocumented)
     operationName: string;
     // (undocumented)
+    operationType: OperationTypeNode | undefined;
+    // (undocumented)
     query: DocumentNode;
     // (undocumented)
     setContext: {

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

@@ -11,6 +11,7 @@ import type { DocumentNode as DocumentNode_2 } from '@apollo/client';
 import type { FieldNode } from 'graphql';
 import type { FieldPolicy } from '@apollo/client/cache';
 import type { FormattedExecutionResult } from 'graphql';
+import { getMainDefinition } from '@apollo/client/utilities/internal';
 import { Observable } from 'rxjs';
 import type { Primitive } from '@apollo/client/utilities/internal';
 import type { Reference as Reference_2 } from '@apollo/client/cache';
@@ -120,6 +121,8 @@ interface DocumentTransformOptions {
     getCacheKey?: (document: DocumentNode) => DocumentTransformCacheKey | undefined;
 }
 
+export { getMainDefinition }
+
 // @beta
 export interface HKT {
     // (undocumented)

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

@@ -1127,6 +1127,8 @@ export interface GraphQLRequest<TVariables = Record<string, any>> {
     // (undocumented)
     operationName?: string;
     // (undocumented)
+    operationType?: OperationTypeNode;
+    // (undocumented)
     query: DocumentNode;
     // (undocumented)
     variables?: TVariables;
@@ -1953,6 +1955,8 @@ export interface Operation {
     // (undocumented)
     operationName: string;
     // (undocumented)
+    operationType: OperationTypeNode | undefined;
+    // (undocumented)
     query: DocumentNode;
     // (undocumented)
     setContext: {

.changeset/lucky-camels-compete.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Export `getMainDefinition` from `@apollo/client/utilities`.

.changeset/thirty-lemons-rhyme.md

@@ -0,0 +1,26 @@
+---
+"@apollo/client": minor
+---
+
+Add `operationType` to `operation` in `ApolloLink`. This means that determining whether a `query` is a specific operation type can now be compared with this property instead of using `getMainDefinition`.
+
+```diff
+- import { getMainDefinition } from "@apollo/client/utilities";
++ import { OperationTypeNode } from "graphql";
+
+ApolloLink.split(
+- ({ query }) => {
+-   const definition = getMainDefinition(query);
+-   return (
+-     definition.kind === 'OperationDefinition' &&
+-     definition.operation === 'subscription'
+-   );
+-   return
+- },
++ ({ operationType }) => {
++   return operationType === OperationTypeNode.SUBSCRIPTION;
++ },
+  conditionTrueLink,
+  conditionFalseLink,
+);
+```

.size-limits.json

@@ -1,6 +1,6 @@
 {
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (CJS)": 43730,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production) (CJS)": 38702,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\"": 33448,
-  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production)": 27662
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (CJS)": 43674,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production) (CJS)": 38705,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\"": 33447,
+  "import { ApolloClient, InMemoryCache, HttpLink } from \"@apollo/client\" (production)": 27639
 }

src/__tests__/__snapshots__/exports.ts.snap

@@ -394,6 +394,7 @@ Array [
   "cacheSizes",
   "canonicalStringify",
   "concatPagination",
+  "getMainDefinition",
   "isFormattedExecutionResult",
   "isMutationOperation",
   "isQueryOperation",

src/core/QueryManager.ts

@@ -894,6 +894,7 @@ export class QueryManager {
           query: serverQuery,
           variables,
           operationName,
+          operationType,
           context: {
             ...this.defaultContext,
             ...context,

src/link/core/types.ts

@@ -1,4 +1,8 @@
-import type { FormattedExecutionResult, GraphQLFormattedError } from "graphql";
+import type {
+  FormattedExecutionResult,
+  GraphQLFormattedError,
+  OperationTypeNode,
+} from "graphql";
 import type { DocumentNode } from "graphql";
 import type { Observable } from "rxjs";
 
@@ -20,6 +24,7 @@ export interface GraphQLRequest<TVariables = Record<string, any>> {
   query: DocumentNode;
   variables?: TVariables;
   operationName?: string;
+  operationType?: OperationTypeNode;
   context?: DefaultContext;
   extensions?: Record<string, any>;
 }
@@ -28,6 +33,7 @@ export interface Operation {
   query: DocumentNode;
   variables: Record<string, any>;
   operationName: string;
+  operationType: OperationTypeNode | undefined;
   extensions: Record<string, any>;
   setContext: {
     (context: Partial<OperationContext>): void;

src/link/utils/validateOperation.ts

@@ -5,6 +5,7 @@ export function validateOperation(operation: GraphQLRequest): GraphQLRequest {
   const OPERATION_FIELDS = [
     "query",
     "operationName",
+    "operationType",
     "variables",
     "extensions",
     "context",