Implement documentsReadOnly for typescript-operations

- Flow documentsReadOnly to typescript-operations
- Set up documents-readonly dev-test
- Update dev-tests output
- Merge standard and read-only documents
- Fix Source vs Types.DocumentFile usage for type correctness

Author: ikusakov

dev-test/codegen.ts

@@ -265,6 +265,19 @@ const config: CodegenConfig = {
         },
       },
     },
+    // #region documentsReadOnly
+    './dev-test/documents-readonly/app/types.generated.ts': {
+      schema: './dev-test/documents-readonly/schema.graphqls',
+      documents: ['./dev-test/documents-readonly/app/*.graphql.ts'],
+      documentsReadOnly: ['./dev-test/documents-readonly/lib/*.graphql.ts'],
+      plugins: ['typescript-operations'],
+    },
+    './dev-test/documents-readonly/lib/types.generated.ts': {
+      schema: './dev-test/documents-readonly/schema.graphqls',
+      documents: ['./dev-test/documents-readonly/lib/*.graphql.ts'],
+      plugins: ['typescript-operations'],
+    },
+    // #endregion
   },
 };
 

dev-test/documents-readonly/app/User.graphql.ts

@@ -0,0 +1,8 @@
+/* GraphQL */ `
+  query User($id: ID!) {
+    user(id: $id) {
+      id
+      ...UserFragment
+    }
+  }
+`;

dev-test/documents-readonly/app/types.generated.ts

@@ -0,0 +1,8 @@
+export type UserQueryVariables = Exact<{
+  id: Scalars['ID']['input'];
+}>;
+
+export type UserQuery = {
+  __typename?: 'Query';
+  user?: { __typename?: 'User'; id: string; name: string; role: UserRole } | null;
+};

dev-test/documents-readonly/lib/UserFragment.graphql.ts

@@ -0,0 +1,7 @@
+/* GraphQL */ `
+  fragment UserFragment on User {
+    id
+    name
+    role
+  }
+`;

dev-test/documents-readonly/lib/types.generated.ts

@@ -0,0 +1 @@
+export type UserFragmentFragment = { __typename?: 'User'; id: string; name: string; role: UserRole };

dev-test/documents-readonly/schema.graphqls

@@ -0,0 +1,14 @@
+type Query {
+  user(id: ID!): User
+}
+
+type User {
+  id: ID!
+  name: String!
+  role: UserRole!
+}
+
+enum UserRole {
+  ADMIN
+  CUSTOMER
+}

packages/graphql-codegen-cli/src/codegen.ts

@@ -4,7 +4,7 @@ import { createRequire } from 'module';
 import { resolve } from 'path';
 import { cosmiconfig, defaultLoaders } from 'cosmiconfig';
 import { GraphQLSchema, GraphQLSchemaExtensions, print } from 'graphql';
-import { GraphQLConfig } from 'graphql-config';
+import { GraphQLConfig, type Source } from 'graphql-config';
 import { createJiti } from 'jiti';
 import { env } from 'string-env-interpolation';
 import yaml from 'yaml';
@@ -16,6 +16,7 @@ import {
   Profiler,
   Types,
 } from '@graphql-codegen/plugin-helpers';
+import type { UnnormalizedTypeDefPointer } from '@graphql-tools/load';
 import { findAndLoadGraphQLConfig } from './graphql-config.js';
 import {
   defaultDocumentsLoadOptions,
@@ -464,18 +465,22 @@ export class CodegenContext {
     return addHashToSchema(loadSchema(pointer, config));
   }
 
-  async loadDocuments(pointer: Types.OperationDocument[]): Promise<Types.DocumentFile[]> {
+  async loadDocuments(
+    pointer: UnnormalizedTypeDefPointer,
+    type: 'standard' | 'read-only',
+  ): Promise<Types.DocumentFile[]> {
     const config = this.getConfig(defaultDocumentsLoadOptions);
     if (this._graphqlConfig) {
       // TODO: pointer won't work here
       return addHashToDocumentFiles(
         this._graphqlConfig
           .getProject(this._project)
           .loadDocuments(pointer, { ...config, ...config.config }),
+        type,
       );
     }
 
-    return addHashToDocumentFiles(loadDocuments(pointer, config));
+    return addHashToDocumentFiles(loadDocuments(pointer, config), type);
   }
 }
 
@@ -502,24 +507,27 @@ function addHashToSchema(schemaPromise: Promise<GraphQLSchema>): Promise<GraphQL
   });
 }
 
-function hashDocument(doc: Types.DocumentFile) {
-  if (doc.rawSDL) {
-    return hashContent(doc.rawSDL);
-  }
+async function addHashToDocumentFiles(
+  documentFilesPromise: Promise<Source[]>,
+  type: 'standard' | 'read-only',
+): Promise<Types.DocumentFile[]> {
+  function hashDocument(doc: Source) {
+    if (doc.rawSDL) {
+      return hashContent(doc.rawSDL);
+    }
 
-  if (doc.document) {
-    return hashContent(print(doc.document));
-  }
+    if (doc.document) {
+      return hashContent(print(doc.document));
+    }
 
-  return null;
-}
+    return null;
+  }
 
-function addHashToDocumentFiles(
-  documentFilesPromise: Promise<Types.DocumentFile[]>,
-): Promise<Types.DocumentFile[]> {
   return documentFilesPromise.then(documentFiles =>
-    documentFiles.map(doc => {
+    // Note: `doc` here is technically `Source`, but by the end of the funciton it's `Types.DocumentFile`. This re-declaration makes TypeScript happy.
+    documentFiles.map((doc: Types.DocumentFile): Types.DocumentFile => {
       doc.hash = hashDocument(doc);
+      doc.type = type;
 
       return doc;
     }),

packages/graphql-codegen-cli/src/config.ts

@@ -1,5 +1,6 @@
 import { extname, join } from 'path';
 import { GraphQLError, GraphQLSchema } from 'graphql';
+import type { Source } from 'graphql-config';
 import { Types } from '@graphql-codegen/plugin-helpers';
 import { ApolloEngineLoader } from '@graphql-tools/apollo-engine-loader';
 import { CodeFileLoader } from '@graphql-tools/code-file-loader';
@@ -69,7 +70,7 @@ export async function loadSchema(
 export async function loadDocuments(
   documentPointers: UnnormalizedTypeDefPointer | UnnormalizedTypeDefPointer[],
   config: Types.Config,
-): Promise<Types.DocumentFile[]> {
+): Promise<Source[]> {
   const loaders = [
     new CodeFileLoader({
       pluckConfig: {

packages/graphql-codegen-cli/src/load.ts

@@ -1553,10 +1553,10 @@ describe('Codegen Executor', () => {
       expect(capturedDocumentsReadOnly).toHaveLength(1);
 
       const documentNames = capturedDocuments.flatMap(
-        d => d.document?.definitions.map((def: any) => def.name?.value) ?? []
+        d => d.document?.definitions.map((def: any) => def.name?.value) ?? [],
       );
       const readOnlyNames = capturedDocumentsReadOnly.flatMap(
-        d => d.document?.definitions.map((def: any) => def.name?.value) ?? []
+        d => d.document?.definitions.map((def: any) => def.name?.value) ?? [],
       );
 
       expect(documentNames).toContain('root');