Add ability to specify custom document transform during manifest generation

.changeset/dirty-masks-nail.md

@@ -0,0 +1,28 @@
+---
+"@apollo/generate-persisted-query-manifest": minor
+---
+
+Add ability to specify a custom document transform used during manifest generation.
+
+> [!NOTE]
+> You must be running Apollo Client 3.8.0 or greater to use this feature.
+
+> [!IMPORTANT]
+> This should be the same document transform that is passed to your `ApolloClient` instance, otherwise you risk mismatches in the query output.
+
+```ts
+// persisted-query-manifest.config.ts
+import { PersistedQueryManifestConfig } from "@apollo/generate-persisted-query-manifest";
+import { DocumentTransform } from "@apollo/client/core";
+
+const documentTransform = new DocumentTransform((document) => {
+  // transform your document
+  return transformedDocument;
+})
+
+const config: PersistedQueryManifestConfig = {
+  documentTransform,
+};
+
+export default config;
+```

packages/generate-persisted-query-manifest/package.json

@@ -36,10 +36,11 @@
     "vfile-reporter": "^6.0.2"
   },
   "peerDependencies": {
-    "@apollo/client": "^3.7.0 || ^3.8.0-alpha",
+    "@apollo/client": "^3.7.0",
     "graphql": "14.x || 15.x || 16.x"
   },
   "devDependencies": {
+    "@apollo/client": "3.9.5",
     "@gmrchk/cli-testing-library": "0.1.2",
     "@wry/equality": "0.5.7"
   }

packages/generate-persisted-query-manifest/src/__tests__/cli.test.ts

@@ -10,6 +10,7 @@ import { createHash } from "node:crypto";
 import { readFileSync } from "node:fs";
 import path from "node:path";
 import type { PersistedQueryManifestOperation } from "../index";
+import packageJson from "../../package.json";
 
 test("prints help message with --help", async () => {
   const { cleanup, runCommand } = await setup();
@@ -676,7 +677,7 @@ test("can specify custom document location with config file", async () => {
 
 {
   const ymlConfig = `
-documents: 
+documents:
   - queries/**/*.graphql
 `;
 
@@ -690,7 +691,7 @@ module.exports = {
 import { PersistedQueryManifestConfig } from '@apollo/generate-persisted-query-manifest';
 
 const config: PersistedQueryManifestOperation = {
-  documents: ['queries/**/*.graphql'] 
+  documents: ['queries/**/*.graphql']
 }
 
 export default config;
@@ -894,7 +895,7 @@ const config: PersistedQueryManifestConfig = {
         return Buffer.from(query).toString("base64");
       default:
         return createDefaultId();
-    }  
+    }
   }
 };
 
@@ -925,6 +926,71 @@ export default config;
   await cleanup();
 });
 
+test("can specify custom document transform in config", async () => {
+  const { cleanup, runCommand, writeFile, readFile, execute } = await setup();
+  const query = gql`
+    query GreetingQuery {
+      user {
+        id
+        name @custom
+      }
+    }
+  `;
+
+  const expectedQuery = gql`
+    query GreetingQuery {
+      user {
+        id
+        name
+      }
+    }
+  `;
+
+  await writeFile(
+    "./package.json",
+    JSON.stringify({
+      dependencies: {
+        "@apollo/client": packageJson.devDependencies["@apollo/client"],
+      },
+    }),
+  );
+  await execute("npm", "install");
+  await writeFile("./src/greeting-query.graphql", print(query));
+  await writeFile(
+    "./persisted-query-manifest.config.ts",
+    `
+import { PersistedQueryManifestConfig } from '@apollo/generate-persisted-query-manifest';
+import { DocumentTransform } from '@apollo/client/core';
+import { removeDirectivesFromDocument } from '@apollo/client/utilities';
+
+const documentTransform = new DocumentTransform((document) => {
+  return removeDirectivesFromDocument([{ name: 'custom' }], document);
+});
+
+const config: PersistedQueryManifestConfig = {
+  documentTransform,
+};
+
+export default config;
+`,
+  );
+
+  const { code } = await runCommand();
+  const manifest = await readFile("./persisted-query-manifest.json");
+
+  expect(code).toBe(0);
+  expect(manifest).toBeManifestWithOperations([
+    {
+      id: sha256(addTypenameToDocument(expectedQuery)),
+      name: "GreetingQuery",
+      body: print(addTypenameToDocument(expectedQuery)),
+      type: "query",
+    },
+  ]);
+
+  await cleanup();
+});
+
 test("errors on anonymous operations", async () => {
   const { cleanup, runCommand, writeFile } = await setup();
   const query = gql`

packages/generate-persisted-query-manifest/src/__tests__/tsconfig.json

@@ -1,5 +1,8 @@
 {
   "extends": "../../../../tsconfig.test.base",
-  "include": ["**/*"],
+  "compilerOptions": {
+    "resolveJsonModule": true
+  },
+  "include": ["**/*", "../../package.json"],
   "references": [{ "path": "../../" }]
 }

packages/generate-persisted-query-manifest/src/index.ts

@@ -5,6 +5,10 @@ import {
   InMemoryCache,
   Observable,
 } from "@apollo/client/core";
+import type {
+  ApolloClientOptions,
+  DocumentTransform,
+} from "@apollo/client/core";
 import { sortTopLevelDefinitions } from "@apollo/persisted-query-lists";
 import { gqlPluckFromCodeStringSync } from "@graphql-tools/graphql-tag-pluck";
 import globby from "globby";
@@ -40,6 +44,21 @@ export interface PersistedQueryManifestConfig {
    */
   documents?: string | string[];
 
+  /**
+   * A `DocumentTransform` instance that will be used to transform the GraphQL
+   * document before it is saved to the manifest.
+   *
+   * For more information about document transforms, see the [Document
+   * transforms](https://www.apollographql.com/docs/react/data/document-transforms)
+   * documentation page.
+   *
+   * IMPORTANT: You must be running `@apollo/client` 3.8.0 or greater to use
+   * this feature.
+   *
+   * @since 1.2.0
+   */
+  documentTransform?: DocumentTransform;
+
   /**
    * Path where the manifest file will be written.
    */
@@ -298,10 +317,15 @@ export async function generatePersistedQueryManifest(
     ...sources.map(({ node }) => node).filter(Boolean),
   );
   const manifestOperationIds = new Map<string, string>();
-
   const manifestOperations: PersistedQueryManifestOperation[] = [];
+  const clientConfig: Partial<ApolloClientOptions<any>> = {};
+
+  if (config.documentTransform) {
+    clientConfig.documentTransform = config.documentTransform;
+  }
 
   const client = new ApolloClient({
+    ...clientConfig,
     cache: new InMemoryCache({
       fragments,
     }),