@shopify/cli-hydrogen 5.0.2 → 5.1.1

package/dist/lib/config.js

@@ -1,141 +0,0 @@
-import { renderFatalError } from '@shopify/cli-kit/node/ui';
-import { outputWarn } from '@shopify/cli-kit/node/output';
-import { fileExists } from '@shopify/cli-kit/node/fs';
-import { fileURLToPath } from 'url';
-import path from 'path';
-import fs from 'fs/promises';
-
-const BUILD_DIR = "dist";
-const CLIENT_SUBDIR = "client";
-const WORKER_SUBDIR = "worker";
-const oxygenServerMainFields = ["browser", "module", "main"];
-function getProjectPaths(appPath, entry) {
-  const root = appPath ?? process.cwd();
-  const publicPath = path.join(root, "public");
-  const buildPath = path.join(root, BUILD_DIR);
-  const buildPathClient = path.join(buildPath, CLIENT_SUBDIR);
-  const buildPathWorkerFile = path.join(buildPath, WORKER_SUBDIR, "index.js");
-  return {
-    root,
-    buildPath,
-    buildPathClient,
-    buildPathWorkerFile,
-    publicPath
-  };
-}
-async function getRemixConfig(root, skipOxygenChecks = false, mode = process.env.NODE_ENV) {
-  const { readConfig } = await import('@remix-run/dev/dist/config.js');
-  const config = await readConfig(root, mode);
-  if (!skipOxygenChecks) {
-    if (!config.serverEntryPoint) {
-      throwConfigError(
-        "Could not find a server entry point.",
-        "Please add a server option to your remix.config.js pointing to an Oxygen worker entry file."
-      );
-    } else {
-      assertEntryFileExists(config.rootDirectory, config.serverEntryPoint);
-    }
-    if (config.serverPlatform !== "neutral") {
-      throwConfigError(
-        'The serverPlatform in remix.config.js must be "neutral".'
-      );
-    }
-    if (config.serverModuleFormat !== "esm") {
-      throwConfigError(
-        'The serverModuleFormat in remix.config.js must be "esm".'
-      );
-    }
-    if (config.serverDependenciesToBundle !== "all") {
-      throwConfigError(
-        'The serverDependenciesToBundle in remix.config.js must be "all".'
-      );
-    }
-    if (!config.serverConditions?.includes("worker")) {
-      throwConfigError(
-        'The serverConditions in remix.config.js must include "worker".'
-      );
-    }
-    if (process.env.NODE_ENV === "development" && !config.serverConditions?.includes("development")) {
-      outputWarn(
-        "Add `process.env.NODE_ENV` value to serverConditions in remix.config.js to enable debugging features in development."
-      );
-    }
-    if (!config.serverMainFields || !oxygenServerMainFields.every(
-      (v, i) => config.serverMainFields?.[i] === v
-    )) {
-      throwConfigError(
-        `The serverMainFields in remix.config.js must be ${JSON.stringify(
-          oxygenServerMainFields
-        )}.`
-      );
-    }
-    const cdnUrl = process.env.HYDROGEN_ASSET_BASE_URL;
-    if (cdnUrl && !config.publicPath.startsWith(cdnUrl)) {
-      throwConfigError(
-        "The publicPath in remix.config.js must be prepended with the value of `process.env.HYDROGEN_ASSET_BASE_URL`."
-      );
-    }
-    const expectedServerBuildPath = path.join(
-      BUILD_DIR,
-      WORKER_SUBDIR,
-      "index.js"
-    );
-    if (config.serverBuildPath !== path.resolve(root, expectedServerBuildPath)) {
-      throwConfigError(
-        `The serverBuildPath in remix.config.js must be "${expectedServerBuildPath}".`
-      );
-    }
-    const expectedAssetsBuildDirectory = path.join(BUILD_DIR, CLIENT_SUBDIR);
-    if (!config.assetsBuildDirectory.startsWith(
-      path.resolve(root, expectedAssetsBuildDirectory)
-    )) {
-      throwConfigError(
-        `The assetsBuildDirectory in remix.config.js must be in "${expectedAssetsBuildDirectory}".`
-      );
-    }
-  }
-  if (process.env.LOCAL_DEV) {
-    const packagesPath = fileURLToPath(new URL("../../..", import.meta.url));
-    config.watchPaths ??= [];
-    config.watchPaths.push(
-      ...(await fs.readdir(packagesPath)).map(
-        (pkg) => pkg === "hydrogen-react" ? path.resolve(packagesPath, pkg, "dist", "browser-dev", "index.mjs") : path.resolve(packagesPath, pkg, "dist", "development", "index.js")
-      )
-    );
-    config.watchPaths.push(
-      path.join(packagesPath, "cli", "dist", "virtual-routes", "**", "*")
-    );
-  }
-  return config;
-}
-function throwConfigError(message, tryMessage = null) {
-  renderFatalError({
-    name: "ConfigError",
-    type: 0,
-    message,
-    tryMessage
-  });
-  process.exit(1);
-}
-async function assertEntryFileExists(root, fileRelative) {
-  const fileAbsolute = path.resolve(root, fileRelative);
-  const exists = await fileExists(fileAbsolute);
-  if (!exists) {
-    if (!path.extname(fileAbsolute)) {
-      const { readdir } = await import('fs/promises');
-      const files = await readdir(path.dirname(fileAbsolute));
-      const exists2 = files.some((file) => {
-        const { name, ext } = path.parse(file);
-        return name === path.basename(fileAbsolute) && /^\.[jt]s$/.test(ext);
-      });
-      if (exists2)
-        return;
-    }
-    throwConfigError(
-      `Entry file "${fileRelative}" not found.`,
-      "Please ensure the file exists and that the path is correctly added to the `server` property in remix.config.js."
-    );
-  }
-}
-
-export { assertEntryFileExists, getProjectPaths, getRemixConfig };

package/dist/lib/flags.d.ts

@@ -1,27 +0,0 @@
-import * as _oclif_core_lib_interfaces_parser_js from '@oclif/core/lib/interfaces/parser.js';
-
-declare const commonFlags: {
-    path: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
-    port: _oclif_core_lib_interfaces_parser_js.OptionFlag<number, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
-    force: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
-    shop: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
-    "env-branch": _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
-    sourcemap: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
-};
-declare function flagsToCamelObject(obj: Record<string, any>): any;
-/**
- * Parse process arguments into an object for use in the cli as flags.
- * This is used when starting the init command from create-hydrogen without Oclif.
- * @example
- * input: `node ./bin --force --no-install-deps --language js`
- * output: { force: true, installDeps: false,  language: 'js' }
- */
-declare function parseProcessFlags(processArgv: string[], flagMap?: Record<string, string>): any;
-/**
- * Create a deprecated flag to prevent the CLI from crashing when a deprecated flag is used.
- * Displays an info message when the flag is used.
- * @param name The name of the flag.
- */
-declare function deprecated(name: string): _oclif_core_lib_interfaces_parser_js.FlagDefinition<unknown, Record<string, unknown>>;
-
-export { commonFlags, deprecated, flagsToCamelObject, parseProcessFlags };

package/dist/lib/flags.test.d.ts

@@ -1 +0,0 @@
-

package/dist/lib/graphql/admin/create-storefront.d.ts

@@ -1,17 +0,0 @@
-import { AdminSession } from '@shopify/cli-kit/node/session';
-import { UserError } from '../../user-errors.js';
-
-declare const CreateStorefrontMutation = "#graphql\n  mutation CreateStorefront($title: String!) {\n    hydrogenStorefrontCreate(title: $title) {\n      hydrogenStorefront {\n        id\n        title\n        productionUrl\n      }\n      userErrors {\n        code\n        field\n        message\n      }\n      jobId\n    }\n  }\n";
-interface HydrogenStorefront {
-    id: string;
-    title: string;
-    productionUrl: string;
-}
-declare function createStorefront(shop: string, title: string): Promise<{
-    adminSession: AdminSession;
-    storefront: HydrogenStorefront | undefined;
-    userErrors: UserError[];
-    jobId: string | undefined;
-}>;
-
-export { CreateStorefrontMutation, createStorefront };

package/dist/lib/graphql/admin/fetch-job.d.ts

@@ -1,23 +0,0 @@
-import { AdminSession } from '@shopify/cli-kit/node/session';
-
-declare const FetchJobQuery = "#graphql\n  query FetchJob($id: ID!) {\n    hydrogenStorefrontJob(id: $id) {\n      id\n      done\n      errors {\n        code\n        message\n      }\n    }\n  }\n";
-interface JobError {
-    code: string;
-    message: string | undefined;
-}
-interface JobSchema {
-    hydrogenStorefrontJob: {
-        id: string;
-        done: boolean;
-        errors: JobError[];
-    };
-}
-declare function fetchJob(shop: string, jobId: string): Promise<{
-    adminSession: AdminSession;
-    id: string;
-    done: boolean;
-    errors: JobError[];
-}>;
-declare function waitForJob(shop: string, jobId: string): Promise<void>;
-
-export { FetchJobQuery, JobSchema, fetchJob, waitForJob };

package/dist/lib/graphql/admin/link-storefront.d.ts

@@ -1,14 +0,0 @@
-import { AdminSession } from '@shopify/cli-kit/node/session';
-
-declare const LinkStorefrontQuery = "#graphql\n  query LinkStorefront {\n    hydrogenStorefronts {\n      id\n      title\n      productionUrl\n    }\n  }\n";
-declare function getStorefronts(shop: string): Promise<{
-    adminSession: AdminSession;
-    storefronts: {
-        parsedId: string;
-        id: string;
-        title: string;
-        productionUrl: string;
-    }[];
-}>;
-
-export { LinkStorefrontQuery, getStorefronts };

package/dist/lib/graphql/admin/list-environments.d.ts

@@ -1,21 +0,0 @@
-import { AdminSession } from '@shopify/cli-kit/node/session';
-
-type EnvironmentType = 'PREVIEW' | 'PRODUCTION' | 'CUSTOM';
-interface Environment {
-    branch: string | null;
-    createdAt: string;
-    id: string;
-    name: string;
-    type: EnvironmentType;
-    url: string | null;
-}
-interface HydrogenStorefront {
-    id: string;
-    environments: Environment[];
-    productionUrl: string;
-}
-declare function getStorefrontEnvironments(adminSession: AdminSession, storefrontId: string): Promise<{
-    storefront: HydrogenStorefront | null;
-}>;
-
-export { Environment, getStorefrontEnvironments };

package/dist/lib/graphql/admin/list-storefronts.d.ts

@@ -1,25 +0,0 @@
-import { AdminSession } from '@shopify/cli-kit/node/session';
-
-interface Deployment {
-    id: string;
-    createdAt: string;
-    commitMessage: string | null;
-}
-interface HydrogenStorefront {
-    id: string;
-    title: string;
-    productionUrl?: string;
-    currentProductionDeployment: Deployment | null;
-}
-declare function getStorefrontsWithDeployment(shop: string): Promise<{
-    adminSession: AdminSession;
-    storefronts: {
-        parsedId: string;
-        id: string;
-        title: string;
-        productionUrl?: string | undefined;
-        currentProductionDeployment: Deployment | null;
-    }[];
-}>;
-
-export { Deployment, HydrogenStorefront, getStorefrontsWithDeployment };

package/dist/lib/graphql/admin/pull-variables.d.ts

@@ -1,21 +0,0 @@
-import { AdminSession } from '@shopify/cli-kit/node/session';
-
-declare const PullVariablesQuery = "#graphql\n  query PullVariables($id: ID!, $branch: String) {\n    hydrogenStorefront(id: $id) {\n      id\n      environmentVariables(branchName: $branch) {\n        id\n        isSecret\n        key\n        value\n      }\n    }\n  }\n";
-interface EnvironmentVariable {
-    id: string;
-    isSecret: boolean;
-    key: string;
-    value: string;
-}
-interface HydrogenStorefront {
-    id: string;
-    environmentVariables: EnvironmentVariable[];
-}
-interface PullVariablesSchema {
-    hydrogenStorefront: HydrogenStorefront | null;
-}
-declare function getStorefrontEnvVariables(adminSession: AdminSession, storefrontId: string, envBranch?: string): Promise<{
-    storefront: HydrogenStorefront | null;
-}>;
-
-export { EnvironmentVariable, PullVariablesQuery, PullVariablesSchema, getStorefrontEnvVariables };

package/dist/lib/graphql.d.ts

@@ -1,21 +0,0 @@
-import { GraphQLVariables } from '@shopify/cli-kit/node/api/graphql';
-import { AdminSession } from '@shopify/cli-kit/node/session';
-
-/**
- * This is a temporary workaround until cli-kit includes a way to specify
- * API versions for the Admin API because we need to target the unstable
- * branch for this early access phase.
- *
- * @param query - GraphQL query to execute.
- * @param session - Shopify admin session including token and Store FQDN.
- * @param variables - GraphQL variables to pass to the query.
- * @returns The response of the query of generic type <T>.
- */
-declare function adminRequest<T>(query: string, session: AdminSession, variables?: GraphQLVariables): Promise<T>;
-/**
- * @param gid a Global ID to parse (e.g. 'gid://shopify/HydrogenStorefront/1')
- * @returns the ID of the record (e.g. '1')
- */
-declare function parseGid(gid: string): string;
-
-export { adminRequest, parseGid };

package/dist/lib/graphql.js

@@ -1,18 +0,0 @@
-import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
-import { AbortError } from '@shopify/cli-kit/node/error';
-
-async function adminRequest(query, session, variables) {
-  const api = "Admin";
-  const url = `https://${session.storeFqdn}/admin/api/unstable/graphql.json`;
-  return graphqlRequest({ query, api, url, token: session.token, variables });
-}
-const GID_REGEXP = /gid:\/\/shopify\/\w*\/(\d+)/;
-function parseGid(gid) {
-  const matches = GID_REGEXP.exec(gid);
-  if (matches && matches[1] !== void 0) {
-    return matches[1];
-  }
-  throw new AbortError(`Invalid Global ID: ${gid}`);
-}
-
-export { adminRequest, parseGid };

package/dist/lib/graphql.test.d.ts

@@ -1 +0,0 @@
-

package/dist/lib/log.d.ts

@@ -1,6 +0,0 @@
-declare function muteDevLogs({ workerReload }?: {
-    workerReload?: boolean;
-}): void;
-declare const warnOnce: (string: string) => void;
-
-export { muteDevLogs, warnOnce };

package/dist/lib/mini-oxygen.d.ts

@@ -1,22 +0,0 @@
-type MiniOxygenOptions = {
-    root: string;
-    port?: number;
-    watch?: boolean;
-    buildPathClient: string;
-    buildPathWorkerFile: string;
-    environmentVariables?: {
-        [key: string]: string;
-    };
-};
-declare function startMiniOxygen({ root, port, watch, buildPathWorkerFile, buildPathClient, environmentVariables, }: MiniOxygenOptions): Promise<{
-    listeningAt: string;
-    port: number;
-    showBanner(options?: {
-        mode?: string;
-        headlinePrefix?: string;
-        extraLines?: string[];
-    }): void;
-}>;
-declare function logResponse(request: Request, response: Response): void;
-
-export { logResponse, startMiniOxygen };

package/dist/lib/missing-routes.d.ts

@@ -1,8 +0,0 @@
-import { RemixConfig } from '@remix-run/dev/dist/config.js';
-
-declare function findMissingRoutes(config: {
-    routes: RemixConfig['routes'];
-}, requiredRoutes?: string[]): string[];
-declare function logMissingRoutes(routes: string[]): void;
-
-export { findMissingRoutes, logMissingRoutes };

package/dist/lib/missing-routes.test.d.ts

@@ -1 +0,0 @@
-

package/dist/lib/missing-storefronts.d.ts

@@ -1,5 +0,0 @@
-import { AdminSession } from '@shopify/cli-kit/node/session';
-
-declare function logMissingStorefronts(adminSession: AdminSession): void;
-
-export { logMissingStorefronts };

package/dist/lib/missing-storefronts.js

@@ -1,18 +0,0 @@
-import { renderInfo } from '@shopify/cli-kit/node/ui';
-import { newHydrogenStorefrontUrl } from './admin-urls.js';
-
-function logMissingStorefronts(adminSession) {
-  renderInfo({
-    headline: "Hydrogen storefronts",
-    body: "There are no Hydrogen storefronts on your Shop.",
-    nextSteps: [
-      `Ensure you have specified the correct shop (you specified: ${adminSession.storeFqdn})`,
-      `Ensure you have the Hydrogen sales channel installed https://apps.shopify.com/hydrogen`,
-      `Create a new Hydrogen storefront: ${newHydrogenStorefrontUrl(
-        adminSession
-      )}`
-    ]
-  });
-}
-
-export { logMissingStorefronts };

package/dist/lib/process.d.ts

@@ -1,6 +0,0 @@
-import { exec } from 'node:child_process';
-
-declare const execAsync: typeof exec.__promisify__;
-declare function supressNodeExperimentalWarnings(): void;
-
-export { execAsync, supressNodeExperimentalWarnings };

package/dist/lib/pull-environment-variables.d.ts

@@ -1,20 +0,0 @@
-import { EnvironmentVariable } from './graphql/admin/pull-variables.js';
-import '@shopify/cli-kit/node/session';
-
-interface Arguments {
-    envBranch?: string;
-    root: string;
-    /**
-     * Optional shop override that developers would have passed using the --shop
-     * flag.
-     */
-    flagShop?: string;
-    /**
-     * Does not prompt the user to fix any errors that are encountered (e.g. no
-     * linked storefront)
-     */
-    silent?: boolean;
-}
-declare function pullRemoteEnvironmentVariables({ envBranch, root, flagShop, silent, }: Arguments): Promise<EnvironmentVariable[]>;
-
-export { pullRemoteEnvironmentVariables };

package/dist/lib/pull-environment-variables.js

@@ -1,57 +0,0 @@
-import { renderConfirmationPrompt } from '@shopify/cli-kit/node/ui';
-import { outputContent, outputToken, outputInfo } from '@shopify/cli-kit/node/output';
-import { linkStorefront } from '../commands/hydrogen/link.js';
-import { getHydrogenShop } from './shop.js';
-import { getAdminSession } from './admin-session.js';
-import { getConfig } from './shopify-config.js';
-import { renderMissingLink, renderMissingStorefront } from './render-errors.js';
-import { getStorefrontEnvVariables } from './graphql/admin/pull-variables.js';
-
-async function pullRemoteEnvironmentVariables({
-  envBranch,
-  root,
-  flagShop,
-  silent
-}) {
-  const shop = await getHydrogenShop({ path: root, shop: flagShop });
-  const adminSession = await getAdminSession(shop);
-  let configStorefront = (await getConfig(root)).storefront;
-  if (!configStorefront?.id) {
-    if (!silent) {
-      renderMissingLink({ adminSession });
-      const runLink = await renderConfirmationPrompt({
-        message: outputContent`Run ${outputToken.genericShellCommand(
-          `npx shopify hydrogen link`
-        )}?`.value
-      });
-      if (!runLink) {
-        return [];
-      }
-      await linkStorefront({ path: root, shop: flagShop, silent });
-    }
-  }
-  configStorefront = (await getConfig(root)).storefront;
-  if (!configStorefront) {
-    return [];
-  }
-  const { storefront } = await getStorefrontEnvVariables(
-    adminSession,
-    configStorefront.id,
-    envBranch
-  );
-  if (!storefront) {
-    if (!silent) {
-      renderMissingStorefront({ adminSession, storefront: configStorefront });
-    }
-    return [];
-  }
-  if (!storefront.environmentVariables.length) {
-    if (!silent) {
-      outputInfo(`No environment variables found.`);
-    }
-    return [];
-  }
-  return storefront.environmentVariables;
-}
-
-export { pullRemoteEnvironmentVariables };

package/dist/lib/pull-environment-variables.test.d.ts

@@ -1 +0,0 @@
-