@shopify/hydrogen-codegen 0.2.1 → 0.3.0

package/README.md

@@ -1,6 +1,6 @@
 # Hydrogen Codegen
 
-A codegen plugin and preset for generating TypeScript types from GraphQL queries in a `d.ts` file. It does not require any function wrapper and adds no runtime overhead (0 bytes to the bundle).
+A codegen plugin and preset for generating TypeScript types from GraphQL queries in a `d.ts` file. It wraps the [`@shopify/graphql-codegen` package](https://github.com/Shopify/graphql-codegen) and adds utilities for Hydrogen. It does not require any function wrapper and adds no runtime overhead (0 bytes to the bundle).
 
 ```ts
 const {shop} = await client.query(`#graphql
@@ -16,7 +16,7 @@ The GraphQL client must use TypeScript interfaces that are extended in the gener
 
 ## Usage
 
-When using Hydrogen CLI, this package is already included and configured for you to generate types for the Shopify Storefront API. However, if you want to use it standalone with the GraphQL CLI or just want to add other APIs to Hydrogen, you can use the following example configuration:
+When using Hydrogen CLI, this package is already configured for you to generate types for the Shopify Storefront API. However, if you want to use it standalone with the GraphQL CLI or just want to add other APIs to Hydrogen, you can use the following example configuration:
 
 ```ts
 // <root>/codegen.ts
@@ -51,3 +51,5 @@ export default {
   },
 } as CodegenConfig;
 ```
+
+For more examples and information, refer to [@shopify/graphql-codegen](https://github.com/Shopify/graphql-codegen).

package/dist/cjs/defaults.cjs

@@ -1,26 +1,37 @@
 'use strict';
 
-var plugin_js = require('./plugin.cjs');
-
+const QUERIES_PLACEHOLDER = "%queries%";
+const MUTATIONS_PLACEHOLDER = "%mutations%";
 const sfapiDefaultInterfaceExtensionCode = `
 declare module '@shopify/hydrogen' {
-  interface StorefrontQueries extends ${plugin_js.GENERATED_QUERY_INTERFACE_NAME} {}
-  interface StorefrontMutations extends ${plugin_js.GENERATED_MUTATION_INTERFACE_NAME} {}
+  interface StorefrontQueries extends ${QUERIES_PLACEHOLDER} {}
+  interface StorefrontMutations extends ${MUTATIONS_PLACEHOLDER} {}
 }`;
 const caapiDefaultInterfaceExtensionCode = `
 declare module '@shopify/hydrogen' {
-  interface CustomerAccountQueries extends ${plugin_js.GENERATED_QUERY_INTERFACE_NAME} {}
-  interface CustomerAccountMutations extends ${plugin_js.GENERATED_MUTATION_INTERFACE_NAME} {}
+  interface CustomerAccountQueries extends ${QUERIES_PLACEHOLDER} {}
+  interface CustomerAccountMutations extends ${MUTATIONS_PLACEHOLDER} {}
 }`;
+function replacePlaceholders(code, queryType, mutationType) {
+  return code.replace(QUERIES_PLACEHOLDER, queryType).replace(MUTATIONS_PLACEHOLDER, mutationType);
+}
 const sfapiDefaultValues = {
   importTypesFrom: "@shopify/hydrogen/storefront-api-types",
   namespacedImportName: "StorefrontAPI",
-  interfaceExtensionCode: sfapiDefaultInterfaceExtensionCode
+  interfaceExtensionCode: ({ queryType, mutationType }) => replacePlaceholders(
+    sfapiDefaultInterfaceExtensionCode,
+    queryType,
+    mutationType
+  )
 };
 const caapiDefaultValues = {
   importTypesFrom: "@shopify/hydrogen/customer-account-api-types",
   namespacedImportName: "CustomerAccountAPI",
-  interfaceExtensionCode: caapiDefaultInterfaceExtensionCode
+  interfaceExtensionCode: ({ queryType, mutationType }) => replacePlaceholders(
+    caapiDefaultInterfaceExtensionCode,
+    queryType,
+    mutationType
+  )
 };
 function getDefaultOptions(outputFile = "") {
   return /^(customer|caapi\.)/i.test(outputFile) ? caapiDefaultValues : sfapiDefaultValues;

package/dist/cjs/defaults.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/defaults.ts"],"names":[],"mappings":"AAAA;AAAA,EACE;AAAA,EACA;AAAA,OACK;AAEP,MAAM,qCAAqC;AAAA;AAAA,wCAEH,8BAA8B;AAAA,0CAC5B,iCAAiC;AAAA;AAG3E,MAAM,qCAAqC;AAAA;AAAA,6CAEE,8BAA8B;AAAA,+CAC5B,iCAAiC;AAAA;AAShF,MAAM,qBAAoC;AAAA,EACxC,iBAAiB;AAAA,EACjB,sBAAsB;AAAA,EACtB,wBAAwB;AAC1B;AAEA,MAAM,qBAAoC;AAAA,EACxC,iBAAiB;AAAA,EACjB,sBAAsB;AAAA,EACtB,wBAAwB;AAC1B;AAEO,SAAS,kBAAkB,aAAa,IAAI;AACjD,SAAO,uBAAuB,KAAK,UAAU,IACzC,qBACA;AACN","sourcesContent":["import {\n  GENERATED_MUTATION_INTERFACE_NAME,\n  GENERATED_QUERY_INTERFACE_NAME,\n} from './plugin.js';\n\nconst sfapiDefaultInterfaceExtensionCode = `\ndeclare module '@shopify/hydrogen' {\n  interface StorefrontQueries extends ${GENERATED_QUERY_INTERFACE_NAME} {}\n  interface StorefrontMutations extends ${GENERATED_MUTATION_INTERFACE_NAME} {}\n}`;\n\nconst caapiDefaultInterfaceExtensionCode = `\ndeclare module '@shopify/hydrogen' {\n  interface CustomerAccountQueries extends ${GENERATED_QUERY_INTERFACE_NAME} {}\n  interface CustomerAccountMutations extends ${GENERATED_MUTATION_INTERFACE_NAME} {}\n}`;\n\ntype DefaultValues = {\n  importTypesFrom: string;\n  namespacedImportName: string;\n  interfaceExtensionCode: string;\n};\n\nconst sfapiDefaultValues: DefaultValues = {\n  importTypesFrom: '@shopify/hydrogen/storefront-api-types',\n  namespacedImportName: 'StorefrontAPI',\n  interfaceExtensionCode: sfapiDefaultInterfaceExtensionCode,\n};\n\nconst caapiDefaultValues: DefaultValues = {\n  importTypesFrom: '@shopify/hydrogen/customer-account-api-types',\n  namespacedImportName: 'CustomerAccountAPI',\n  interfaceExtensionCode: caapiDefaultInterfaceExtensionCode,\n};\n\nexport function getDefaultOptions(outputFile = '') {\n  return /^(customer|caapi\\.)/i.test(outputFile)\n    ? caapiDefaultValues\n    : sfapiDefaultValues;\n}\n"]}
+{"version":3,"sources":["../../src/defaults.ts"],"names":[],"mappings":"AAEA,MAAM,sBAAsB;AAC5B,MAAM,wBAAwB;AAE9B,MAAM,qCAAqC;AAAA;AAAA,wCAEH,mBAAmB;AAAA,0CACjB,qBAAqB;AAAA;AAG/D,MAAM,qCAAqC;AAAA;AAAA,6CAEE,mBAAmB;AAAA,+CACjB,qBAAqB;AAAA;AAGpE,SAAS,oBACP,MACA,WACA,cACA;AACA,SAAO,KACJ,QAAQ,qBAAqB,SAAS,EACtC,QAAQ,uBAAuB,YAAY;AAChD;AAQA,MAAM,qBAAoC;AAAA,EACxC,iBAAiB;AAAA,EACjB,sBAAsB;AAAA,EACtB,wBAAwB,CAAC,EAAC,WAAW,aAAY,MAC/C;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACJ;AAEA,MAAM,qBAAoC;AAAA,EACxC,iBAAiB;AAAA,EACjB,sBAAsB;AAAA,EACtB,wBAAwB,CAAC,EAAC,WAAW,aAAY,MAC/C;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACJ;AAEO,SAAS,kBAAkB,aAAa,IAAI;AACjD,SAAO,uBAAuB,KAAK,UAAU,IACzC,qBACA;AACN","sourcesContent":["import type {PresetConfig} from './preset';\n\nconst QUERIES_PLACEHOLDER = '%queries%';\nconst MUTATIONS_PLACEHOLDER = '%mutations%';\n\nconst sfapiDefaultInterfaceExtensionCode = `\ndeclare module '@shopify/hydrogen' {\n  interface StorefrontQueries extends ${QUERIES_PLACEHOLDER} {}\n  interface StorefrontMutations extends ${MUTATIONS_PLACEHOLDER} {}\n}`;\n\nconst caapiDefaultInterfaceExtensionCode = `\ndeclare module '@shopify/hydrogen' {\n  interface CustomerAccountQueries extends ${QUERIES_PLACEHOLDER} {}\n  interface CustomerAccountMutations extends ${MUTATIONS_PLACEHOLDER} {}\n}`;\n\nfunction replacePlaceholders(\n  code: string,\n  queryType: string,\n  mutationType: string,\n) {\n  return code\n    .replace(QUERIES_PLACEHOLDER, queryType)\n    .replace(MUTATIONS_PLACEHOLDER, mutationType);\n}\n\ntype DefaultValues = {\n  importTypesFrom: string;\n  namespacedImportName: string;\n  interfaceExtensionCode: NonNullable<PresetConfig['interfaceExtension']>;\n};\n\nconst sfapiDefaultValues: DefaultValues = {\n  importTypesFrom: '@shopify/hydrogen/storefront-api-types',\n  namespacedImportName: 'StorefrontAPI',\n  interfaceExtensionCode: ({queryType, mutationType}) =>\n    replacePlaceholders(\n      sfapiDefaultInterfaceExtensionCode,\n      queryType,\n      mutationType,\n    ),\n};\n\nconst caapiDefaultValues: DefaultValues = {\n  importTypesFrom: '@shopify/hydrogen/customer-account-api-types',\n  namespacedImportName: 'CustomerAccountAPI',\n  interfaceExtensionCode: ({queryType, mutationType}) =>\n    replacePlaceholders(\n      caapiDefaultInterfaceExtensionCode,\n      queryType,\n      mutationType,\n    ),\n};\n\nexport function getDefaultOptions(outputFile = '') {\n  return /^(customer|caapi\\.)/i.test(outputFile)\n    ? caapiDefaultValues\n    : sfapiDefaultValues;\n}\n"]}

package/dist/cjs/index.cjs

@@ -1,10 +1,8 @@
 'use strict';
 
 var preset_js = require('./preset.cjs');
-var plugin_js = require('./plugin.cjs');
 var schema_js = require('./schema.cjs');
-var sources_js = require('./sources.cjs');
-var pluck_js = require('./pluck.cjs');
+var graphqlCodegen = require('@shopify/graphql-codegen');
 
 
 
@@ -12,25 +10,21 @@ Object.defineProperty(exports, 'preset', {
   enumerable: true,
   get: function () { return preset_js.preset; }
 });
-Object.defineProperty(exports, 'plugin', {
-  enumerable: true,
-  get: function () { return plugin_js.plugin; }
-});
 Object.defineProperty(exports, 'getSchema', {
   enumerable: true,
   get: function () { return schema_js.getSchema; }
 });
-Object.defineProperty(exports, 'schema', {
+Object.defineProperty(exports, 'pluckConfig', {
   enumerable: true,
-  get: function () { return schema_js.schema; }
+  get: function () { return graphqlCodegen.pluckConfig; }
 });
-Object.defineProperty(exports, 'processSources', {
+Object.defineProperty(exports, 'plugin', {
   enumerable: true,
-  get: function () { return sources_js.processSources; }
+  get: function () { return graphqlCodegen.plugin; }
 });
-Object.defineProperty(exports, 'pluckConfig', {
+Object.defineProperty(exports, 'processSources', {
   enumerable: true,
-  get: function () { return pluck_js.pluckConfig; }
+  get: function () { return graphqlCodegen.processSources; }
 });
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.cjs.map

package/dist/cjs/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,SAAQ,cAAa;AACrB,SAAQ,cAAa;AACrB,SAAQ,QAAQ,iBAAgB;AAChC,SAAQ,sBAAqB;AAC7B,SAAQ,mBAAkB","sourcesContent":["export {preset} from './preset.js';\nexport {plugin} from './plugin.js';\nexport {schema, getSchema} from './schema.js';\nexport {processSources} from './sources.js';\nexport {pluckConfig} from './pluck.js';\nexport type * from './client.js';\n"]}
+{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,SAAQ,cAAgC;AACxC,SAAQ,iBAAgB;AACxB;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAOK","sourcesContent":["export {preset, type PresetConfig} from './preset.js';\nexport {getSchema} from './schema.js';\nexport {\n  plugin,\n  pluckConfig,\n  processSources,\n  type GenericVariables,\n  type EmptyVariables,\n  type ClientReturn,\n  type IsOptionalVariables,\n  type ClientVariables,\n  type ClientVariablesInRestParams,\n} from '@shopify/graphql-codegen';\n"]}

package/dist/cjs/preset.cjs

@@ -1,119 +1,32 @@
 'use strict';
 
-var addPlugin = require('@graphql-codegen/add');
-var typescriptPlugin = require('@graphql-codegen/typescript');
-var typescriptOperationPlugin = require('@graphql-codegen/typescript-operations');
-var sources_js = require('./sources.cjs');
+var graphqlCodegen = require('@shopify/graphql-codegen');
 var defaults_js = require('./defaults.cjs');
-var plugin_js = require('./plugin.cjs');
-
-function _interopNamespace(e) {
-  if (e && e.__esModule) return e;
-  var n = Object.create(null);
-  if (e) {
-    Object.keys(e).forEach(function (k) {
-      if (k !== 'default') {
-        var d = Object.getOwnPropertyDescriptor(e, k);
-        Object.defineProperty(n, k, d.get ? d : {
-          enumerable: true,
-          get: function () { return e[k]; }
-        });
-      }
-    });
-  }
-  n.default = e;
-  return Object.freeze(n);
-}
-
-var addPlugin__namespace = /*#__PURE__*/_interopNamespace(addPlugin);
-var typescriptPlugin__namespace = /*#__PURE__*/_interopNamespace(typescriptPlugin);
-var typescriptOperationPlugin__namespace = /*#__PURE__*/_interopNamespace(typescriptOperationPlugin);
 
 const preset = {
   [Symbol.for("name")]: "hydrogen",
   buildGeneratesSection: (options) => {
-    if (!options.baseOutputDir.endsWith(".d.ts")) {
-      throw new Error("[hydrogen-preset] target output should be a .d.ts file");
-    }
-    if (options.plugins?.length > 0 && Object.keys(options.plugins).some((p) => p.startsWith("typescript"))) {
-      throw new Error(
-        "[hydrogen-preset] providing additional typescript-based `plugins` leads to duplicated generated types"
+    try {
+      const defaultOptions = defaults_js.getDefaultOptions(options.baseOutputDir);
+      return graphqlCodegen.preset.buildGeneratesSection({
+        ...options,
+        presetConfig: {
+          importTypes: {
+            namespace: defaultOptions.namespacedImportName,
+            from: defaultOptions.importTypesFrom
+          },
+          interfaceExtension: defaultOptions.interfaceExtensionCode,
+          ...options.presetConfig
+        }
+      });
+    } catch (err) {
+      const error = err;
+      error.message = error.message.replace(
+        "[@shopify/graphql-codegen]",
+        "[hydrogen-preset]"
       );
+      throw error;
     }
-    const sourcesWithOperations = sources_js.processSources(options.documents);
-    const sources = sourcesWithOperations.map(({ source }) => source);
-    const defaultOptions = defaults_js.getDefaultOptions(options.baseOutputDir);
-    const importTypes = options.presetConfig.importTypes ?? true;
-    const namespacedImportName = options.presetConfig.namespacedImportName ?? defaultOptions.namespacedImportName;
-    const importTypesFrom = options.presetConfig.importTypesFrom ?? defaultOptions.importTypesFrom;
-    const interfaceExtensionCode = options.presetConfig.interfaceExtension?.({
-      queryType: plugin_js.GENERATED_QUERY_INTERFACE_NAME,
-      mutationType: plugin_js.GENERATED_MUTATION_INTERFACE_NAME
-    }) ?? defaultOptions.interfaceExtensionCode;
-    const pluginMap = {
-      ...options.pluginMap,
-      [`add`]: addPlugin__namespace,
-      [`typescript`]: typescriptPlugin__namespace,
-      [`typescript-operations`]: typescriptOperationPlugin__namespace,
-      [`gen-dts`]: { plugin: plugin_js.plugin }
-    };
-    const plugins = [
-      // 1. Disable eslint for the generated file
-      {
-        [`add`]: {
-          content: `/* eslint-disable eslint-comments/disable-enable-pair */
-/* eslint-disable eslint-comments/no-unlimited-disable */
-/* eslint-disable */`
-        }
-      },
-      // 2. Import all the generated API types from Hydrogen or generate all the types from the schema.
-      importTypes ? {
-        [`add`]: {
-          content: `import * as ${namespacedImportName} from '${importTypesFrom}';
-`
-        }
-      } : {
-        [`typescript`]: {
-          useTypeImports: true,
-          useImplementingTypes: true,
-          enumsAsTypes: true
-        }
-      },
-      // 3. Generate the operations (i.e. queries, mutations, and fragments types)
-      {
-        [`typescript-operations`]: {
-          useTypeImports: true,
-          // Use `import type` instead of `import`
-          preResolveTypes: false,
-          // Use Pick<...> instead of primitives
-          mergeFragmentTypes: true,
-          // Merge equal fragment interfaces. Avoids adding `| {}` to Metaobject
-          skipTypename: options.presetConfig.skipTypenameInOperations ?? true,
-          // Skip __typename fields
-          namespacedImportName: importTypes ? namespacedImportName : void 0
-        }
-      },
-      // 4.  Augment Hydrogen query/mutation interfaces with the generated operations
-      { [`gen-dts`]: { sourcesWithOperations, interfaceExtensionCode } },
-      // 5. Custom plugins from the user
-      ...options.plugins
-    ];
-    return [
-      {
-        filename: options.baseOutputDir,
-        plugins,
-        pluginMap,
-        schema: options.schema,
-        config: {
-          // For the TS plugin:
-          defaultScalarType: "unknown",
-          // Allow overwriting defaults:
-          ...options.config
-        },
-        documents: sources,
-        documentTransforms: options.documentTransforms
-      }
-    ];
   }
 };
 

package/dist/cjs/preset.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/preset.ts"],"names":[],"mappings":"AACA,YAAY,eAAe;AAC3B,YAAY,sBAAsB;AAClC,YAAY,+BAA+B;AAC3C,SAAQ,sBAAqB;AAC7B,SAAQ,yBAAwB;AAChC;AAAA,EACE,UAAU;AAAA,EACV;AAAA,EACA;AAAA,OACK;AAgCA,MAAM,SAAmD;AAAA,EAC9D,CAAC,OAAO,IAAI,MAAM,CAAC,GAAG;AAAA,EACtB,uBAAuB,CAAC,YAAY;AAClC,QAAI,CAAC,QAAQ,cAAc,SAAS,OAAO,GAAG;AAC5C,YAAM,IAAI,MAAM,wDAAwD;AAAA,IAC1E;AAEA,QACE,QAAQ,SAAS,SAAS,KAC1B,OAAO,KAAK,QAAQ,OAAO,EAAE,KAAK,CAAC,MAAM,EAAE,WAAW,YAAY,CAAC,GACnE;AACA,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,UAAM,wBAAwB,eAAe,QAAQ,SAAS;AAC9D,UAAM,UAAU,sBAAsB,IAAI,CAAC,EAAC,OAAM,MAAM,MAAM;AAE9D,UAAM,iBAAiB,kBAAkB,QAAQ,aAAa;AAE9D,UAAM,cAAc,QAAQ,aAAa,eAAe;AACxD,UAAM,uBACJ,QAAQ,aAAa,wBACrB,eAAe;AACjB,UAAM,kBACJ,QAAQ,aAAa,mBAAmB,eAAe;AAEzD,UAAM,yBACJ,QAAQ,aAAa,qBAAqB;AAAA,MACxC,WAAW;AAAA,MACX,cAAc;AAAA,IAChB,CAAC,KAAK,eAAe;AAEvB,UAAM,YAAY;AAAA,MAChB,GAAG,QAAQ;AAAA,MACX,CAAC,KAAK,GAAG;AAAA,MACT,CAAC,YAAY,GAAG;AAAA,MAChB,CAAC,uBAAuB,GAAG;AAAA,MAC3B,CAAC,SAAS,GAAG,EAAC,QAAQ,UAAS;AAAA,IACjC;AAEA,UAAM,UAAyC;AAAA;AAAA,MAE7C;AAAA,QACE,CAAC,KAAK,GAAG;AAAA,UACP,SAAS;AAAA;AAAA;AAAA,QACX;AAAA,MACF;AAAA;AAAA,MAEA,cACI;AAAA,QACE,CAAC,KAAK,GAAG;AAAA,UACP,SAAS,eAAe,oBAAoB,UAAU,eAAe;AAAA;AAAA,QACvE;AAAA,MACF,IACA;AAAA,QACE,CAAC,YAAY,GAAG;AAAA,UACd,gBAAgB;AAAA,UAChB,sBAAsB;AAAA,UACtB,cAAc;AAAA,QAChB;AAAA,MACF;AAAA;AAAA,MAEJ;AAAA,QACE,CAAC,uBAAuB,GAAG;AAAA,UACzB,gBAAgB;AAAA;AAAA,UAChB,iBAAiB;AAAA;AAAA,UACjB,oBAAoB;AAAA;AAAA,UACpB,cAAc,QAAQ,aAAa,4BAA4B;AAAA;AAAA,UAC/D,sBAAsB,cAAc,uBAAuB;AAAA,QAC7D;AAAA,MACF;AAAA;AAAA,MAEA,EAAC,CAAC,SAAS,GAAG,EAAC,uBAAuB,uBAAsB,EAAC;AAAA;AAAA,MAE7D,GAAG,QAAQ;AAAA,IACb;AAEA,WAAO;AAAA,MACL;AAAA,QACE,UAAU,QAAQ;AAAA,QAClB;AAAA,QACA;AAAA,QACA,QAAQ,QAAQ;AAAA,QAChB,QAAQ;AAAA;AAAA,UAEN,mBAAmB;AAAA;AAAA,UAEnB,GAAG,QAAQ;AAAA,QACb;AAAA,QACA,WAAW;AAAA,QACX,oBAAoB,QAAQ;AAAA,MAC9B;AAAA,IACF;AAAA,EACF;AACF","sourcesContent":["import type {Types} from '@graphql-codegen/plugin-helpers';\nimport * as addPlugin from '@graphql-codegen/add';\nimport * as typescriptPlugin from '@graphql-codegen/typescript';\nimport * as typescriptOperationPlugin from '@graphql-codegen/typescript-operations';\nimport {processSources} from './sources.js';\nimport {getDefaultOptions} from './defaults.js';\nimport {\n  plugin as dtsPlugin,\n  GENERATED_MUTATION_INTERFACE_NAME,\n  GENERATED_QUERY_INTERFACE_NAME,\n} from './plugin.js';\n\nexport type HydrogenPresetConfig = {\n  /**\n   * Name for the variable that contains the imported types.\n   * @default 'StorefrontAPI'\n   */\n  namespacedImportName?: string;\n  /**\n   * Module to import the types from.\n   * @default '@shopify/hydrogen/storefront-api-types'\n   */\n  importTypesFrom?: string;\n  /**\n   * Whether types should be imported from the `importTypesFrom` module, or generated inline.\n   * @default true\n   */\n  importTypes?: boolean;\n  /**\n   * Whether to skip adding `__typename` to generated operation types.\n   * @default true\n   */\n  skipTypenameInOperations?: boolean;\n  /**\n   * Override the default interface extension.\n   */\n  interfaceExtension?: (options: {\n    queryType: string;\n    mutationType: string;\n  }) => string;\n};\n\nexport const preset: Types.OutputPreset<HydrogenPresetConfig> = {\n  [Symbol.for('name')]: 'hydrogen',\n  buildGeneratesSection: (options) => {\n    if (!options.baseOutputDir.endsWith('.d.ts')) {\n      throw new Error('[hydrogen-preset] target output should be a .d.ts file');\n    }\n\n    if (\n      options.plugins?.length > 0 &&\n      Object.keys(options.plugins).some((p) => p.startsWith('typescript'))\n    ) {\n      throw new Error(\n        '[hydrogen-preset] providing additional typescript-based `plugins` leads to duplicated generated types',\n      );\n    }\n\n    const sourcesWithOperations = processSources(options.documents);\n    const sources = sourcesWithOperations.map(({source}) => source);\n\n    const defaultOptions = getDefaultOptions(options.baseOutputDir);\n\n    const importTypes = options.presetConfig.importTypes ?? true;\n    const namespacedImportName =\n      options.presetConfig.namespacedImportName ??\n      defaultOptions.namespacedImportName;\n    const importTypesFrom =\n      options.presetConfig.importTypesFrom ?? defaultOptions.importTypesFrom;\n\n    const interfaceExtensionCode =\n      options.presetConfig.interfaceExtension?.({\n        queryType: GENERATED_QUERY_INTERFACE_NAME,\n        mutationType: GENERATED_MUTATION_INTERFACE_NAME,\n      }) ?? defaultOptions.interfaceExtensionCode;\n\n    const pluginMap = {\n      ...options.pluginMap,\n      [`add`]: addPlugin,\n      [`typescript`]: typescriptPlugin,\n      [`typescript-operations`]: typescriptOperationPlugin,\n      [`gen-dts`]: {plugin: dtsPlugin},\n    };\n\n    const plugins: Array<Types.ConfiguredPlugin> = [\n      // 1. Disable eslint for the generated file\n      {\n        [`add`]: {\n          content: `/* eslint-disable eslint-comments/disable-enable-pair */\\n/* eslint-disable eslint-comments/no-unlimited-disable */\\n/* eslint-disable */`,\n        },\n      },\n      // 2. Import all the generated API types from Hydrogen or generate all the types from the schema.\n      importTypes\n        ? {\n            [`add`]: {\n              content: `import * as ${namespacedImportName} from '${importTypesFrom}';\\n`,\n            },\n          }\n        : {\n            [`typescript`]: {\n              useTypeImports: true,\n              useImplementingTypes: true,\n              enumsAsTypes: true,\n            },\n          },\n      // 3. Generate the operations (i.e. queries, mutations, and fragments types)\n      {\n        [`typescript-operations`]: {\n          useTypeImports: true, // Use `import type` instead of `import`\n          preResolveTypes: false, // Use Pick<...> instead of primitives\n          mergeFragmentTypes: true, // Merge equal fragment interfaces. Avoids adding `| {}` to Metaobject\n          skipTypename: options.presetConfig.skipTypenameInOperations ?? true, // Skip __typename fields\n          namespacedImportName: importTypes ? namespacedImportName : undefined,\n        },\n      },\n      // 4.  Augment Hydrogen query/mutation interfaces with the generated operations\n      {[`gen-dts`]: {sourcesWithOperations, interfaceExtensionCode}},\n      // 5. Custom plugins from the user\n      ...options.plugins,\n    ];\n\n    return [\n      {\n        filename: options.baseOutputDir,\n        plugins,\n        pluginMap,\n        schema: options.schema,\n        config: {\n          // For the TS plugin:\n          defaultScalarType: 'unknown',\n          // Allow overwriting defaults:\n          ...options.config,\n        },\n        documents: sources,\n        documentTransforms: options.documentTransforms,\n      },\n    ];\n  },\n};\n"]}
+{"version":3,"sources":["../../src/preset.ts"],"names":[],"mappings":"AACA;AAAA,EACE,UAAU;AAAA,OAEL;AACP,SAAQ,yBAAwB;AAIzB,MAAM,SAA2C;AAAA,EACtD,CAAC,OAAO,IAAI,MAAM,CAAC,GAAG;AAAA,EACtB,uBAAuB,CAAC,YAAY;AAClC,QAAI;AACF,YAAM,iBAAiB,kBAAkB,QAAQ,aAAa;AAE9D,aAAO,eAAe,sBAAsB;AAAA,QAC1C,GAAG;AAAA,QACH,cAAc;AAAA,UACZ,aAAa;AAAA,YACX,WAAW,eAAe;AAAA,YAC1B,MAAM,eAAe;AAAA,UACvB;AAAA,UACA,oBAAoB,eAAe;AAAA,UACnC,GAAG,QAAQ;AAAA,QACb;AAAA,MACF,CAAC;AAAA,IACH,SAAS,KAAK;AACZ,YAAM,QAAQ;AAEd,YAAM,UAAU,MAAM,QAAQ;AAAA,QAC5B;AAAA,QACA;AAAA,MACF;AAEA,YAAM;AAAA,IACR;AAAA,EACF;AACF","sourcesContent":["import type {Types} from '@graphql-codegen/plugin-helpers';\nimport {\n  preset as internalPreset,\n  type PresetConfig as InternalPresetConfig,\n} from '@shopify/graphql-codegen';\nimport {getDefaultOptions} from './defaults.js';\n\nexport type PresetConfig = Partial<InternalPresetConfig>;\n\nexport const preset: Types.OutputPreset<PresetConfig> = {\n  [Symbol.for('name')]: 'hydrogen',\n  buildGeneratesSection: (options) => {\n    try {\n      const defaultOptions = getDefaultOptions(options.baseOutputDir);\n\n      return internalPreset.buildGeneratesSection({\n        ...options,\n        presetConfig: {\n          importTypes: {\n            namespace: defaultOptions.namespacedImportName,\n            from: defaultOptions.importTypesFrom,\n          },\n          interfaceExtension: defaultOptions.interfaceExtensionCode,\n          ...options.presetConfig,\n        } satisfies PresetConfig,\n      });\n    } catch (err) {\n      const error = err as Error;\n\n      error.message = error.message.replace(\n        '[@shopify/graphql-codegen]',\n        '[hydrogen-preset]',\n      );\n\n      throw error;\n    }\n  },\n};\n"]}

package/dist/cjs/schema.cjs

@@ -1,22 +1,24 @@
 'use strict';
 
 //! import {createRequire} from 'module'; const require = createRequire(import.meta.url);
-const getSchema = (api = "storefront") => {
+function getSchema(api, options) {
   if (api !== "storefront" && api !== "customer-account") {
     throw new Error(
       `The provided API type "${api}" is unknown. Please use "storefront" or "customer-account".`
     );
   }
-  return require.resolve(`@shopify/hydrogen-react/${api}.schema.json`);
-};
-let staticSFAPISchema = "";
-try {
-  staticSFAPISchema = getSchema("storefront");
-} catch (error) {
+  try {
+    return require.resolve(`@shopify/hydrogen-react/${api}.schema.json`);
+  } catch {
+    if (options?.throwIfMissing !== false) {
+      throw new Error(
+        `Could not find a schema for "${api}".
+Please make sure a recent version of \`@shopify/hydrogen\` is installed.`
+      );
+    }
+  }
 }
-const schema = staticSFAPISchema;
 
 exports.getSchema = getSchema;
-exports.schema = schema;
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=schema.cjs.map

package/dist/cjs/schema.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/schema.ts"],"names":[],"mappings":"AACA;AAQO,MAAM,YAAY,CACvB,MAAM,iBACH;AACH,MAAI,QAAQ,gBAAgB,QAAQ,oBAAoB;AACtD,UAAM,IAAI;AAAA,MACR,0BAA0B,GAAG;AAAA,IAC/B;AAAA,EACF;AAEA,SAAO,QAAQ,QAAQ,2BAA2B,GAAG,cAAc;AACrE;AAEA,IAAI,oBAAoB;AAExB,IAAI;AACF,sBAAoB,UAAU,YAAY;AAC5C,SAAS,OAAO;AAIhB;AAKO,MAAM,SAAS","sourcesContent":["// This comment is used during ESM build:\n//! import {createRequire} from 'module'; const require = createRequire(import.meta.url);\n\n/**\n * Resolves a schema path for the provided API type. Only the API types currently\n * bundled in Hydrogen are allowed: \"storefront\" and \"customer\".\n * @param api\n * @returns\n */\nexport const getSchema = (\n  api = 'storefront' as 'storefront' | 'customer-account',\n) => {\n  if (api !== 'storefront' && api !== 'customer-account') {\n    throw new Error(\n      `The provided API type \"${api}\" is unknown. Please use \"storefront\" or \"customer-account\".`,\n    );\n  }\n\n  return require.resolve(`@shopify/hydrogen-react/${api}.schema.json`);\n};\n\nlet staticSFAPISchema = '';\n\ntry {\n  staticSFAPISchema = getSchema('storefront');\n} catch (error) {\n  // This can happen at build time or when '@shopify/hydrogen-react' is not found.\n  // Generally this shouldn't be an issue in real apps so let's ignore the error.\n  // Also, this package could be used in non-Hydrogen apps.\n}\n\n/**\n * The resolved schema path for the Storefront API.\n */\nexport const schema = staticSFAPISchema;\n"]}
+{"version":3,"sources":["../../src/schema.ts"],"names":[],"mappings":"AACA;AAgBO,SAAS,UAAU,KAAU,SAA4B;AAC9D,MAAI,QAAQ,gBAAgB,QAAQ,oBAAoB;AACtD,UAAM,IAAI;AAAA,MACR,0BAA0B,GAAG;AAAA,IAC/B;AAAA,EACF;AAEA,MAAI;AACF,WAAO,QAAQ,QAAQ,2BAA2B,GAAG,cAAc;AAAA,EACrE,QAAQ;AACN,QAAI,SAAS,mBAAmB,OAAO;AACrC,YAAM,IAAI;AAAA,QACR,gCAAgC,GAAG;AAAA;AAAA,MACrC;AAAA,IACF;AAAA,EACF;AACF","sourcesContent":["// This comment is used during ESM build:\n//! import {createRequire} from 'module'; const require = createRequire(import.meta.url);\n\ntype Api = 'storefront' | 'customer-account';\ntype Options<T extends boolean> = {throwIfMissing?: T};\n\n/**\n * Resolves a schema path for the provided API type. Only the API types currently\n * bundled in Hydrogen are allowed: \"storefront\" and \"customer\".\n * @param api\n * @returns\n */\nexport function getSchema(api: Api, options?: Options<true>): string;\nexport function getSchema(\n  api: Api,\n  options: Options<false>,\n): string | undefined;\nexport function getSchema(api: Api, options?: Options<boolean>) {\n  if (api !== 'storefront' && api !== 'customer-account') {\n    throw new Error(\n      `The provided API type \"${api}\" is unknown. Please use \"storefront\" or \"customer-account\".`,\n    );\n  }\n\n  try {\n    return require.resolve(`@shopify/hydrogen-react/${api}.schema.json`);\n  } catch {\n    if (options?.throwIfMissing !== false) {\n      throw new Error(\n        `Could not find a schema for \"${api}\".\\nPlease make sure a recent version of \\`@shopify/hydrogen\\` is installed.`,\n      );\n    }\n  }\n}\n"]}

package/dist/esm/defaults.js

@@ -1,24 +1,35 @@
-import { GENERATED_QUERY_INTERFACE_NAME, GENERATED_MUTATION_INTERFACE_NAME } from './plugin.js';
-
+const QUERIES_PLACEHOLDER = "%queries%";
+const MUTATIONS_PLACEHOLDER = "%mutations%";
 const sfapiDefaultInterfaceExtensionCode = `
 declare module '@shopify/hydrogen' {
-  interface StorefrontQueries extends ${GENERATED_QUERY_INTERFACE_NAME} {}
-  interface StorefrontMutations extends ${GENERATED_MUTATION_INTERFACE_NAME} {}
+  interface StorefrontQueries extends ${QUERIES_PLACEHOLDER} {}
+  interface StorefrontMutations extends ${MUTATIONS_PLACEHOLDER} {}
 }`;
 const caapiDefaultInterfaceExtensionCode = `
 declare module '@shopify/hydrogen' {
-  interface CustomerAccountQueries extends ${GENERATED_QUERY_INTERFACE_NAME} {}
-  interface CustomerAccountMutations extends ${GENERATED_MUTATION_INTERFACE_NAME} {}
+  interface CustomerAccountQueries extends ${QUERIES_PLACEHOLDER} {}
+  interface CustomerAccountMutations extends ${MUTATIONS_PLACEHOLDER} {}
 }`;
+function replacePlaceholders(code, queryType, mutationType) {
+  return code.replace(QUERIES_PLACEHOLDER, queryType).replace(MUTATIONS_PLACEHOLDER, mutationType);
+}
 const sfapiDefaultValues = {
   importTypesFrom: "@shopify/hydrogen/storefront-api-types",
   namespacedImportName: "StorefrontAPI",
-  interfaceExtensionCode: sfapiDefaultInterfaceExtensionCode
+  interfaceExtensionCode: ({ queryType, mutationType }) => replacePlaceholders(
+    sfapiDefaultInterfaceExtensionCode,
+    queryType,
+    mutationType
+  )
 };
 const caapiDefaultValues = {
   importTypesFrom: "@shopify/hydrogen/customer-account-api-types",
   namespacedImportName: "CustomerAccountAPI",
-  interfaceExtensionCode: caapiDefaultInterfaceExtensionCode
+  interfaceExtensionCode: ({ queryType, mutationType }) => replacePlaceholders(
+    caapiDefaultInterfaceExtensionCode,
+    queryType,
+    mutationType
+  )
 };
 function getDefaultOptions(outputFile = "") {
   return /^(customer|caapi\.)/i.test(outputFile) ? caapiDefaultValues : sfapiDefaultValues;

package/dist/esm/defaults.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/defaults.ts"],"names":[],"mappings":"AAAA;AAAA,EACE;AAAA,EACA;AAAA,OACK;AAEP,MAAM,qCAAqC;AAAA;AAAA,wCAEH,8BAA8B;AAAA,0CAC5B,iCAAiC;AAAA;AAG3E,MAAM,qCAAqC;AAAA;AAAA,6CAEE,8BAA8B;AAAA,+CAC5B,iCAAiC;AAAA;AAShF,MAAM,qBAAoC;AAAA,EACxC,iBAAiB;AAAA,EACjB,sBAAsB;AAAA,EACtB,wBAAwB;AAC1B;AAEA,MAAM,qBAAoC;AAAA,EACxC,iBAAiB;AAAA,EACjB,sBAAsB;AAAA,EACtB,wBAAwB;AAC1B;AAEO,SAAS,kBAAkB,aAAa,IAAI;AACjD,SAAO,uBAAuB,KAAK,UAAU,IACzC,qBACA;AACN","sourcesContent":["import {\n  GENERATED_MUTATION_INTERFACE_NAME,\n  GENERATED_QUERY_INTERFACE_NAME,\n} from './plugin.js';\n\nconst sfapiDefaultInterfaceExtensionCode = `\ndeclare module '@shopify/hydrogen' {\n  interface StorefrontQueries extends ${GENERATED_QUERY_INTERFACE_NAME} {}\n  interface StorefrontMutations extends ${GENERATED_MUTATION_INTERFACE_NAME} {}\n}`;\n\nconst caapiDefaultInterfaceExtensionCode = `\ndeclare module '@shopify/hydrogen' {\n  interface CustomerAccountQueries extends ${GENERATED_QUERY_INTERFACE_NAME} {}\n  interface CustomerAccountMutations extends ${GENERATED_MUTATION_INTERFACE_NAME} {}\n}`;\n\ntype DefaultValues = {\n  importTypesFrom: string;\n  namespacedImportName: string;\n  interfaceExtensionCode: string;\n};\n\nconst sfapiDefaultValues: DefaultValues = {\n  importTypesFrom: '@shopify/hydrogen/storefront-api-types',\n  namespacedImportName: 'StorefrontAPI',\n  interfaceExtensionCode: sfapiDefaultInterfaceExtensionCode,\n};\n\nconst caapiDefaultValues: DefaultValues = {\n  importTypesFrom: '@shopify/hydrogen/customer-account-api-types',\n  namespacedImportName: 'CustomerAccountAPI',\n  interfaceExtensionCode: caapiDefaultInterfaceExtensionCode,\n};\n\nexport function getDefaultOptions(outputFile = '') {\n  return /^(customer|caapi\\.)/i.test(outputFile)\n    ? caapiDefaultValues\n    : sfapiDefaultValues;\n}\n"]}
+{"version":3,"sources":["../../src/defaults.ts"],"names":[],"mappings":"AAEA,MAAM,sBAAsB;AAC5B,MAAM,wBAAwB;AAE9B,MAAM,qCAAqC;AAAA;AAAA,wCAEH,mBAAmB;AAAA,0CACjB,qBAAqB;AAAA;AAG/D,MAAM,qCAAqC;AAAA;AAAA,6CAEE,mBAAmB;AAAA,+CACjB,qBAAqB;AAAA;AAGpE,SAAS,oBACP,MACA,WACA,cACA;AACA,SAAO,KACJ,QAAQ,qBAAqB,SAAS,EACtC,QAAQ,uBAAuB,YAAY;AAChD;AAQA,MAAM,qBAAoC;AAAA,EACxC,iBAAiB;AAAA,EACjB,sBAAsB;AAAA,EACtB,wBAAwB,CAAC,EAAC,WAAW,aAAY,MAC/C;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACJ;AAEA,MAAM,qBAAoC;AAAA,EACxC,iBAAiB;AAAA,EACjB,sBAAsB;AAAA,EACtB,wBAAwB,CAAC,EAAC,WAAW,aAAY,MAC/C;AAAA,IACE;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACJ;AAEO,SAAS,kBAAkB,aAAa,IAAI;AACjD,SAAO,uBAAuB,KAAK,UAAU,IACzC,qBACA;AACN","sourcesContent":["import type {PresetConfig} from './preset';\n\nconst QUERIES_PLACEHOLDER = '%queries%';\nconst MUTATIONS_PLACEHOLDER = '%mutations%';\n\nconst sfapiDefaultInterfaceExtensionCode = `\ndeclare module '@shopify/hydrogen' {\n  interface StorefrontQueries extends ${QUERIES_PLACEHOLDER} {}\n  interface StorefrontMutations extends ${MUTATIONS_PLACEHOLDER} {}\n}`;\n\nconst caapiDefaultInterfaceExtensionCode = `\ndeclare module '@shopify/hydrogen' {\n  interface CustomerAccountQueries extends ${QUERIES_PLACEHOLDER} {}\n  interface CustomerAccountMutations extends ${MUTATIONS_PLACEHOLDER} {}\n}`;\n\nfunction replacePlaceholders(\n  code: string,\n  queryType: string,\n  mutationType: string,\n) {\n  return code\n    .replace(QUERIES_PLACEHOLDER, queryType)\n    .replace(MUTATIONS_PLACEHOLDER, mutationType);\n}\n\ntype DefaultValues = {\n  importTypesFrom: string;\n  namespacedImportName: string;\n  interfaceExtensionCode: NonNullable<PresetConfig['interfaceExtension']>;\n};\n\nconst sfapiDefaultValues: DefaultValues = {\n  importTypesFrom: '@shopify/hydrogen/storefront-api-types',\n  namespacedImportName: 'StorefrontAPI',\n  interfaceExtensionCode: ({queryType, mutationType}) =>\n    replacePlaceholders(\n      sfapiDefaultInterfaceExtensionCode,\n      queryType,\n      mutationType,\n    ),\n};\n\nconst caapiDefaultValues: DefaultValues = {\n  importTypesFrom: '@shopify/hydrogen/customer-account-api-types',\n  namespacedImportName: 'CustomerAccountAPI',\n  interfaceExtensionCode: ({queryType, mutationType}) =>\n    replacePlaceholders(\n      caapiDefaultInterfaceExtensionCode,\n      queryType,\n      mutationType,\n    ),\n};\n\nexport function getDefaultOptions(outputFile = '') {\n  return /^(customer|caapi\\.)/i.test(outputFile)\n    ? caapiDefaultValues\n    : sfapiDefaultValues;\n}\n"]}