Add GraphQL operation type (#2789)

Shopify · Jun 10, 2024 · bdebd91 · bdebd91
1 parent 06dfac8
commit bdebd91
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 0 deletions.
diff --git a/.changeset/clean-pumpkins-sin.md b/.changeset/clean-pumpkins-sin.md
@@ -0,0 +1,6 @@
+---
+'graphql-mini-transforms': minor
+'graphql-typed': minor
+---
+
+Add `type` field to `SimpleDocument` type
diff --git a/packages/graphql-mini-transforms/src/document.ts b/packages/graphql-mini-transforms/src/document.ts
@@ -101,6 +101,7 @@ export function toSimpleDocument<
 ): SimpleDocument<Data, Variables, DeepPartial> {
   return {
     id: document.id,
+    type: operationTypeForDocument(document),
     name: operationNameForDocument(document),
     source: includeSource ? document.loc?.source?.body! : '',
   };
@@ -120,6 +121,13 @@ export function formatDocument(document: DocumentNode, format: OutputFormat) {
   }
 }
 
+function operationTypeForDocument(document: DocumentNode) {
+  return document.definitions.find(
+    (definition): definition is OperationDefinitionNode =>
+      definition.kind === 'OperationDefinition',
+  )?.operation;
+}
+
 function operationNameForDocument(document: DocumentNode) {
   return document.definitions.find(
     (definition): definition is OperationDefinitionNode =>

diff --git a/packages/graphql-mini-transforms/src/tests/webpack.test.ts b/packages/graphql-mini-transforms/src/tests/webpack.test.ts
@@ -238,6 +238,15 @@ describe('graphql-mini-transforms/webpack', () => {
       );
     });
 
+    it('has a type property that is the operation type of the first operation in the document', async () => {
+      const result = await extractDocumentExport(
+        `query Shop { shop { id } }`,
+        createLoaderContext({query: {format: 'simple'}}),
+      );
+
+      expect(result).toHaveProperty('type', 'query');
+    });
+
     it('has a name property that is the name of the first operation', async () => {
       const result = await extractDocumentExport(
         `query Shop { shop { id } }`,

diff --git a/packages/graphql-typed/src/index.ts b/packages/graphql-typed/src/index.ts
@@ -22,6 +22,7 @@ export interface DocumentNode<Data = {}, Variables = {}, DeepPartial = {}>
 export interface SimpleDocument<Data = {}, Variables = {}, DeepPartial = {}>
   extends GraphQLOperation<Data, Variables, DeepPartial> {
   readonly id: string;
+  readonly type?: 'query' | 'mutation' | 'subscription';
   readonly name?: string;
   readonly source: string;
 }