@shopify/hydrogen-codegen 0.2.2 → 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/index.cjs

@@ -14,10 +14,6 @@ Object.defineProperty(exports, 'getSchema', {
   enumerable: true,
   get: function () { return schema_js.getSchema; }
 });
-Object.defineProperty(exports, 'schema', {
-  enumerable: true,
-  get: function () { return schema_js.schema; }
-});
 Object.defineProperty(exports, 'pluckConfig', {
   enumerable: true,
   get: function () { return graphqlCodegen.pluckConfig; }

package/dist/cjs/index.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,SAAQ,cAAgC;AACxC,SAAQ,QAAQ,iBAAgB;AAChC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAOK","sourcesContent":["export {preset, type PresetConfig} from './preset.js';\nexport {schema, 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"]}
+{"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/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/index.d.ts

@@ -368,17 +368,18 @@ export type ClientVariablesInRestParams<GeneratedOperations extends CodegenOpera
 ];
 type PresetConfig$1 = Partial<PresetConfig>;
 export declare const preset: Types.OutputPreset<PresetConfig$1>;
+export type Api = "storefront" | "customer-account";
+export type Options<T extends boolean> = {
+	throwIfMissing?: T;
+};
 /**
  * Resolves a schema path for the provided API type. Only the API types currently
  * bundled in Hydrogen are allowed: "storefront" and "customer".
  * @param api
  * @returns
  */
-export declare const getSchema: (api?: "storefront" | "customer-account") => string;
-/**
- * The resolved schema path for the Storefront API.
- */
-export declare const schema: string;
+export declare function getSchema(api: Api, options?: Options<true>): string;
+export declare function getSchema(api: Api, options: Options<false>): string | undefined;
 
 export {
 	PresetConfig$1 as PresetConfig,

package/dist/esm/index.js

@@ -1,5 +1,5 @@
 export { preset } from './preset.js';
-export { getSchema, schema } from './schema.js';
+export { getSchema } from './schema.js';
 export { pluckConfig, plugin, processSources } from '@shopify/graphql-codegen';
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,SAAQ,cAAgC;AACxC,SAAQ,QAAQ,iBAAgB;AAChC;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,OAOK","sourcesContent":["export {preset, type PresetConfig} from './preset.js';\nexport {schema, 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"]}
+{"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/esm/schema.js

@@ -1,19 +1,22 @@
  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;
 
-export { getSchema, schema };
+export { getSchema };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=schema.js.map

package/dist/esm/schema.js.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/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "@shopify:registry": "https://registry.npmjs.org"
   },
-  "version": "0.2.2",
+  "version": "0.3.0",
   "license": "MIT",
   "type": "module",
   "main": "dist/cjs/index.cjs",