@shopify/hydrogen-codegen 0.1.0 → 0.2.1

package/dist/esm/schema.js

@@ -1,11 +1,18 @@
  import {createRequire} from 'module'; const require = createRequire(import.meta.url);
-const getSchema = () => require.resolve("@shopify/hydrogen-react/storefront.schema.json");
-let staticSchema = "";
+const getSchema = (api = "storefront") => {
+  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 {
-  staticSchema = getSchema();
+  staticSFAPISchema = getSchema("storefront");
 } catch (error) {
 }
-const schema = staticSchema;
+const schema = staticSFAPISchema;
 
 export { getSchema, schema };
 //# sourceMappingURL=out.js.map

package/dist/esm/schema.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/schema.ts"],"names":[],"mappings":"AACA;AACO,MAAM,YAAY,MACvB,gBAAgB,gDAAgD;AAElE,IAAI,eAAe;AAEnB,IAAI;AACF,iBAAe,UAAU;AAC3B,SAAS,OAAO;AAIhB;AAEO,MAAM,SAAS","sourcesContent":["// This comment is used during ESM build:\n//! import {createRequire} from 'module'; const require = createRequire(import.meta.url);\nexport const getSchema = () =>\n  require.resolve('@shopify/hydrogen-react/storefront.schema.json');\n\nlet staticSchema = '';\n\ntry {\n  staticSchema = getSchema();\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\nexport const schema = staticSchema;\n"]}
+{"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"]}

package/package.json

@@ -4,7 +4,7 @@
     "access": "public",
     "@shopify:registry": "https://registry.npmjs.org"
   },
-  "version": "0.1.0",
+  "version": "0.2.1",
   "license": "MIT",
   "type": "module",
   "main": "dist/cjs/index.cjs",
@@ -15,8 +15,8 @@
     "build": "tsup --clean",
     "dev": "tsup --watch",
     "typecheck": "tsc --noEmit",
-    "test": "cross-env SHOPIFY_UNIT_TEST=1 vitest run",
-    "test:watch": "cross-env SHOPIFY_UNIT_TEST=1 vitest"
+    "test": "cross-env SHOPIFY_UNIT_TEST=1 vitest run --typecheck",
+    "test:watch": "cross-env SHOPIFY_UNIT_TEST=1 vitest --typecheck"
   },
   "exports": {
     ".": {
@@ -39,19 +39,19 @@
     "directory": "packages/hydrogen-codegen"
   },
   "files": [
-    "dist",
-    "vendor"
+    "dist"
   ],
   "devDependencies": {
-    "@graphql-codegen/cli": "^5.0.0",
-    "@graphql-codegen/plugin-helpers": "^5.0.0",
-    "@graphql-tools/utils": "^10.0.3",
-    "vitest": "^0.33.0"
+    "@graphql-codegen/cli": "^5.0.1",
+    "@graphql-codegen/plugin-helpers": "^5.0.2",
+    "@graphql-tools/utils": "^10.0.13",
+    "vitest": "^1.0.4"
   },
   "dependencies": {
-    "@graphql-codegen/add": "^5.0.0",
-    "@graphql-codegen/typescript": "^4.0.1",
-    "@graphql-codegen/typescript-operations": "^4.0.1"
+    "@graphql-codegen/add": "^5.0.1",
+    "@graphql-codegen/typescript": "^4.0.2",
+    "@graphql-codegen/typescript-operations": "^4.1.0",
+    "type-fest": "^4.5.0"
   },
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"

package/dist/esm/pluck.d.ts

@@ -1,22 +0,0 @@
-/**
- * This is a modified version of graphql-tag-pluck's default config.
- * https://github.com/ardatan/graphql-tools/issues/5127
- */
-declare const pluckConfig: {
-    /**
-     * Hook to determine if a node is a gql template literal.
-     * By default, graphql-tag-pluck only looks for leading comments or `gql` tag.
-     */
-    isGqlTemplateLiteral: (node: any, options: any) => boolean;
-    /**
-     * Instruct how to extract the gql template literal from the code.
-     * By default, embedded expressions in template literals (e.g. ${foo})
-     * are removed from the template string. This hook allows us to annotate
-     * the template string with the required embedded expressions instead of
-     * removing them. Later, we can use this information to reconstruct the
-     * embedded expressions.
-     */
-    pluckStringFromFile: (code: string, { start, end, leadingComments }: any) => string;
-};
-
-export { pluckConfig };

package/dist/esm/plugin.d.ts

@@ -1,20 +0,0 @@
-import { PluginFunction } from '@graphql-codegen/plugin-helpers';
-import { Source } from '@graphql-tools/utils';
-import { OperationDefinitionNode, FragmentDefinitionNode } from 'graphql';
-
-type OperationOrFragment = {
-    initialName: string;
-    definition: OperationDefinitionNode | FragmentDefinitionNode;
-};
-type SourceWithOperations = {
-    source: Source;
-    operations: Array<OperationOrFragment>;
-};
-declare const plugin: PluginFunction<{
-    sourcesWithOperations: Array<SourceWithOperations>;
-    interfaceExtensionCode: string;
-}>;
-declare const GENERATED_QUERY_INTERFACE_NAME = "GeneratedQueryTypes";
-declare const GENERATED_MUTATION_INTERFACE_NAME = "GeneratedMutationTypes";
-
-export { GENERATED_MUTATION_INTERFACE_NAME, GENERATED_QUERY_INTERFACE_NAME, OperationOrFragment, SourceWithOperations, plugin };

package/dist/esm/preset.d.ts

@@ -1,35 +0,0 @@
-import { Types } from '@graphql-codegen/plugin-helpers';
-
-type HydrogenPresetConfig = {
-    /**
-     * Name for the variable that contains the imported types.
-     * @default 'StorefrontAPI'
-     */
-    namespacedImportName?: string;
-    /**
-     * Module to import the types from.
-     * @default '@shopify/hydrogen/storefront-api-types'
-     */
-    importTypesFrom?: string;
-    /**
-     * Whether types should be imported from the `importTypesFrom` module, or generated inline.
-     * @default true
-     */
-    importTypes?: boolean;
-    /**
-     * Whether to skip adding `__typename` to generated operation types.
-     * @default true
-     */
-    skipTypenameInOperations?: boolean;
-    /**
-     * Override the default interface extension.
-     */
-    interfaceExtension?: (options: {
-        queryType: string;
-        mutationType: string;
-    }) => string;
-};
-declare const defaultInterfaceExtensionCode = "\ndeclare module '@shopify/hydrogen' {\n  interface StorefrontQueries extends GeneratedQueryTypes {}\n  interface StorefrontMutations extends GeneratedMutationTypes {}\n}";
-declare const preset: Types.OutputPreset<HydrogenPresetConfig>;
-
-export { HydrogenPresetConfig, defaultInterfaceExtensionCode, preset };

package/dist/esm/schema.d.ts

@@ -1,4 +0,0 @@
-declare const getSchema: () => string;
-declare const schema: string;
-
-export { getSchema, schema };

package/dist/esm/sources.d.ts

@@ -1,8 +0,0 @@
-import { SourceWithOperations } from './plugin.js';
-import { Source } from '@graphql-tools/utils';
-import { OperationDefinitionNode, FragmentDefinitionNode } from 'graphql';
-import '@graphql-codegen/plugin-helpers';
-
-declare function processSources(sources: Array<Source>, buildName?: (node: OperationDefinitionNode | FragmentDefinitionNode) => string): SourceWithOperations[];
-
-export { processSources };

package/vendor/graphql-tag-pluck/visitor.cjs

@@ -1,377 +0,0 @@
-'use strict';
-Object.defineProperty(exports, '__esModule', {value: true});
-const types_1 = require('@babel/types');
-const utils_1 = require('@graphql-tools/utils');
-const utils_js_1 = require('./utils.js');
-const defaults = {
-  modules: [
-    {
-      name: 'graphql-tag',
-    },
-    {
-      name: 'graphql-tag.macro',
-    },
-    {
-      name: '@apollo/client',
-      identifier: 'gql',
-    },
-    {
-      name: '@apollo/client/core',
-      identifier: 'gql',
-    },
-    {
-      name: 'apollo-angular',
-      identifier: 'gql',
-    },
-    {
-      name: 'gatsby',
-      identifier: 'graphql',
-    },
-    {
-      name: 'apollo-server-express',
-      identifier: 'gql',
-    },
-    {
-      name: 'apollo-server',
-      identifier: 'gql',
-    },
-    {
-      name: 'react-relay',
-      identifier: 'graphql',
-    },
-    {
-      name: 'react-relay/hooks',
-      identifier: 'graphql',
-    },
-    {
-      name: 'relay-runtime',
-      identifier: 'graphql',
-    },
-    {
-      name: 'babel-plugin-relay/macro',
-      identifier: 'graphql',
-    },
-    {
-      name: 'apollo-boost',
-      identifier: 'gql',
-    },
-    {
-      name: 'apollo-server-koa',
-      identifier: 'gql',
-    },
-    {
-      name: 'apollo-server-hapi',
-      identifier: 'gql',
-    },
-    {
-      name: 'apollo-server-fastify',
-      identifier: 'gql',
-    },
-    {
-      name: ' apollo-server-lambda',
-      identifier: 'gql',
-    },
-    {
-      name: 'apollo-server-micro',
-      identifier: 'gql',
-    },
-    {
-      name: 'apollo-server-azure-functions',
-      identifier: 'gql',
-    },
-    {
-      name: 'apollo-server-cloud-functions',
-      identifier: 'gql',
-    },
-    {
-      name: 'apollo-server-cloudflare',
-      identifier: 'gql',
-    },
-    {
-      name: 'graphql.macro',
-      identifier: 'gql',
-    },
-    {
-      name: '@urql/core',
-      identifier: 'gql',
-    },
-    {
-      name: 'urql',
-      identifier: 'gql',
-    },
-    {
-      name: '@urql/preact',
-      identifier: 'gql',
-    },
-    {
-      name: '@urql/svelte',
-      identifier: 'gql',
-    },
-    {
-      name: '@urql/vue',
-      identifier: 'gql',
-    },
-  ],
-  gqlMagicComment: 'graphql',
-  globalGqlIdentifierName: ['gql', 'graphql'],
-};
-function defaultPluckStringFromFile(code, {start, end}, options = {}) {
-  return (0, utils_js_1.freeText)(
-    code
-      // Slice quotes
-      .slice(start + 1, end - 1)
-      // Erase string interpolations as we gonna export everything as a single
-      // string anyway
-      .replace(/\$\{[^}]*\}/g, '')
-      .split('\\`')
-      .join('`'),
-    options.skipIndent,
-  );
-}
-function defaultIsGqlTemplateLiteral(node, options) {
-  const leadingComments = node.leadingComments;
-  if (!leadingComments) {
-    return;
-  }
-  if (!leadingComments.length) {
-    return;
-  }
-  const leadingComment = leadingComments[leadingComments.length - 1];
-  const leadingCommentValue = leadingComment.value.trim().toLowerCase();
-  if (leadingCommentValue === options.gqlMagicComment) {
-    return true;
-  }
-  return false;
-}
-exports.default = (code, out, options = {}) => {
-  // Apply defaults to options
-  let {
-    modules = [],
-    globalGqlIdentifierName,
-    gqlMagicComment,
-    skipIndent,
-    isGqlTemplateLiteral = defaultIsGqlTemplateLiteral,
-    pluckStringFromFile = defaultPluckStringFromFile,
-  } = {
-    ...defaults,
-    ...options,
-  };
-  // Prevent case related potential errors
-  gqlMagicComment = gqlMagicComment.toLowerCase();
-  // normalize `name` and `identifier` values
-  modules = modules.map((mod) => {
-    return {
-      name: mod.name,
-      identifier: mod.identifier && mod.identifier.toLowerCase(),
-    };
-  });
-  globalGqlIdentifierName = (0, utils_1.asArray)(globalGqlIdentifierName).map(
-    (s) => s.toLowerCase(),
-  );
-  const hooksOptions = {
-    skipIndent,
-    gqlMagicComment,
-    modules,
-    globalGqlIdentifierName,
-  };
-  // Keep imported identifiers
-  // import gql from 'graphql-tag' -> gql
-  // import { graphql } from 'gatsby' -> graphql
-  // Will result with ['gql', 'graphql']
-  const definedIdentifierNames = [];
-  const alreadyProcessedOperationsCache = new Set();
-  // Will accumulate all template literals
-  const gqlTemplateLiterals = [];
-  // Check if package is registered
-  function isValidPackage(name) {
-    return modules.some(
-      (pkg) =>
-        pkg.name && name && pkg.name.toLowerCase() === name.toLowerCase(),
-    );
-  }
-  // Check if identifier is defined and imported from registered packages
-  function isValidIdentifier(name) {
-    return (
-      definedIdentifierNames.some((id) => id === name) ||
-      globalGqlIdentifierName.includes(name)
-    );
-  }
-  const addTemplateLiteralToResult = (content) => {
-    const cacheKey = `end/${content.end}/start/${content.start}/${content.content}`;
-    if (alreadyProcessedOperationsCache.has(cacheKey)) {
-      return;
-    }
-    alreadyProcessedOperationsCache.add(cacheKey);
-    gqlTemplateLiterals.push(content);
-  };
-  // Push all template literals leaded by graphql magic comment
-  // e.g. /* GraphQL */ `query myQuery {}` -> query myQuery {}
-  const pluckMagicTemplateLiteral = (node, takeExpression = false) => {
-    if (!isGqlTemplateLiteral(node, hooksOptions)) {
-      return;
-    }
-    const nodeToUse = takeExpression ? node.expression : node;
-    const gqlTemplateLiteral = pluckStringFromFile(
-      code,
-      nodeToUse,
-      hooksOptions,
-    );
-    if (gqlTemplateLiteral) {
-      addTemplateLiteralToResult({
-        content: gqlTemplateLiteral,
-        loc: node.loc,
-        end: node.end,
-        start: node.start,
-      });
-    }
-  };
-  const visitor = {
-    CallExpression: {
-      enter(path) {
-        // Find the identifier name used from graphql-tag, commonJS
-        // e.g. import gql from 'graphql-tag' -> gql
-        const arg0 = path.node.arguments[0];
-        if (
-          'name' in path.node.callee &&
-          path.node.callee.name === 'require' &&
-          'value' in arg0 &&
-          typeof arg0.value === 'string' &&
-          isValidPackage(arg0.value)
-        ) {
-          if (!(0, types_1.isVariableDeclarator)(path.parent)) {
-            return;
-          }
-          if (!(0, types_1.isIdentifier)(path.parent.id)) {
-            return;
-          }
-          definedIdentifierNames.push(path.parent.id.name);
-          return;
-        }
-        // Checks to see if a node represents a typescript '<expression> as const' expression
-        function isTSAsConstExpression(node) {
-          return (
-            (0, types_1.isTSAsExpression)(node) &&
-            (0, types_1.isTSTypeReference)(node.typeAnnotation) &&
-            (0, types_1.isIdentifier)(node.typeAnnotation.typeName) &&
-            node.typeAnnotation.typeName.name === 'const'
-          );
-        }
-        // Extract template literal from as const expression if applicable
-        // e.g. gql(`query myQuery {}` as const)
-        const unwrappedExpression = isTSAsConstExpression(arg0)
-          ? arg0.expression
-          : arg0;
-        // Push strings template literals to gql calls
-        // e.g. gql(`query myQuery {}`) -> query myQuery {}
-        if (
-          (0, types_1.isIdentifier)(path.node.callee) &&
-          isValidIdentifier(path.node.callee.name) &&
-          (0, types_1.isTemplateLiteral)(unwrappedExpression)
-        ) {
-          const {start, end, loc} = unwrappedExpression;
-          if (start != null && end != null && start != null && loc != null) {
-            const gqlTemplateLiteral = pluckStringFromFile(
-              code,
-              unwrappedExpression,
-              hooksOptions,
-            );
-            // If the entire template was made out of interpolations it should be an empty
-            // string by now and thus should be ignored
-            if (gqlTemplateLiteral) {
-              addTemplateLiteralToResult({
-                content: gqlTemplateLiteral,
-                loc,
-                end,
-                start,
-              });
-            }
-          }
-        }
-      },
-    },
-    ImportDeclaration: {
-      enter(path) {
-        // Find the identifier name used from graphql-tag, es6
-        // e.g. import gql from 'graphql-tag' -> gql
-        if (!isValidPackage(path.node.source.value)) {
-          return;
-        }
-        const moduleNode = modules.find(
-          (pkg) =>
-            pkg.name.toLowerCase() === path.node.source.value.toLowerCase(),
-        );
-        if (moduleNode == null) {
-          return;
-        }
-        const gqlImportSpecifier = path.node.specifiers.find(
-          (importSpecifier) => {
-            // When it's a default import and registered package has no named identifier
-            if (
-              (0, types_1.isImportDefaultSpecifier)(importSpecifier) &&
-              !moduleNode.identifier
-            ) {
-              return true;
-            }
-            // When it's a named import that matches registered package's identifier
-            if (
-              (0, types_1.isImportSpecifier)(importSpecifier) &&
-              'name' in importSpecifier.imported &&
-              importSpecifier.imported.name === moduleNode.identifier
-            ) {
-              return true;
-            }
-            return false;
-          },
-        );
-        if (!gqlImportSpecifier) {
-          return;
-        }
-        definedIdentifierNames.push(gqlImportSpecifier.local.name);
-      },
-    },
-    ExpressionStatement: {
-      exit(path) {
-        // Push all template literals leaded by graphql magic comment
-        // e.g. /* GraphQL */ `query myQuery {}` -> query myQuery {}
-        if (!(0, types_1.isTemplateLiteral)(path.node.expression)) {
-          return;
-        }
-        pluckMagicTemplateLiteral(path.node, true);
-      },
-    },
-    TemplateLiteral: {
-      exit(path) {
-        pluckMagicTemplateLiteral(path.node);
-      },
-    },
-    TaggedTemplateExpression: {
-      exit(path) {
-        // Push all template literals provided to the found identifier name
-        // e.g. gql `query myQuery {}` -> query myQuery {}
-        if (
-          !(0, types_1.isIdentifier)(path.node.tag) ||
-          !isValidIdentifier(path.node.tag.name)
-        ) {
-          return;
-        }
-        const gqlTemplateLiteral = pluckStringFromFile(
-          code,
-          path.node.quasi,
-          hooksOptions,
-        );
-        if (gqlTemplateLiteral) {
-          addTemplateLiteralToResult({
-            content: gqlTemplateLiteral,
-            end: path.node.quasi.end,
-            start: path.node.quasi.start,
-            loc: path.node.quasi.loc,
-          });
-        }
-      },
-    },
-    exit() {
-      out.returnValue = gqlTemplateLiterals;
-    },
-  };
-  return visitor;
-};