@shopify/cli-hydrogen 5.0.2 → 5.1.1

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

@@ -1,174 +0,0 @@
-import { vi, describe, beforeEach, afterEach, it, expect } from 'vitest';
-import { mockAndCaptureOutput } from '@shopify/cli-kit/node/testing/output';
-import { inTemporaryDirectory } from '@shopify/cli-kit/node/fs';
-import { renderConfirmationPrompt } from '@shopify/cli-kit/node/ui';
-import { PullVariablesQuery } from './graphql/admin/pull-variables.js';
-import { getAdminSession } from './admin-session.js';
-import { adminRequest } from './graphql.js';
-import { getConfig } from './shopify-config.js';
-import { renderMissingLink, renderMissingStorefront } from './render-errors.js';
-import { linkStorefront } from '../commands/hydrogen/link.js';
-import { pullRemoteEnvironmentVariables } from './pull-environment-variables.js';
-
-vi.mock("@shopify/cli-kit/node/ui", async () => {
-  const original = await vi.importActual("@shopify/cli-kit/node/ui");
-  return {
-    ...original,
-    renderConfirmationPrompt: vi.fn()
-  };
-});
-vi.mock("../commands/hydrogen/link.js");
-vi.mock("./admin-session.js");
-vi.mock("./shopify-config.js");
-vi.mock("./render-errors.js");
-vi.mock("./graphql.js", async () => {
-  const original = await vi.importActual(
-    "./graphql.js"
-  );
-  return {
-    ...original,
-    adminRequest: vi.fn()
-  };
-});
-vi.mock("./shop.js", () => ({
-  getHydrogenShop: () => "my-shop"
-}));
-describe("pullRemoteEnvironmentVariables", () => {
-  const ENVIRONMENT_VARIABLES_RESPONSE = [
-    {
-      id: "gid://shopify/HydrogenStorefrontEnvironmentVariable/1",
-      key: "PUBLIC_API_TOKEN",
-      value: "abc123",
-      isSecret: false
-    }
-  ];
-  const ADMIN_SESSION = {
-    token: "abc123",
-    storeFqdn: "my-shop"
-  };
-  beforeEach(async () => {
-    vi.mocked(getAdminSession).mockResolvedValue(ADMIN_SESSION);
-    vi.mocked(getConfig).mockResolvedValue({
-      storefront: {
-        id: "gid://shopify/HydrogenStorefront/2",
-        title: "Existing Link"
-      }
-    });
-    vi.mocked(adminRequest).mockResolvedValue({
-      hydrogenStorefront: {
-        id: "gid://shopify/HydrogenStorefront/1",
-        environmentVariables: ENVIRONMENT_VARIABLES_RESPONSE
-      }
-    });
-  });
-  afterEach(() => {
-    vi.resetAllMocks();
-    mockAndCaptureOutput().clear();
-  });
-  it("makes a GraphQL call to fetch environment variables", async () => {
-    await inTemporaryDirectory(async (tmpDir) => {
-      await pullRemoteEnvironmentVariables({
-        root: tmpDir,
-        envBranch: "staging"
-      });
-      expect(adminRequest).toHaveBeenCalledWith(
-        PullVariablesQuery,
-        ADMIN_SESSION,
-        {
-          id: "gid://shopify/HydrogenStorefront/2",
-          branch: "staging"
-        }
-      );
-    });
-  });
-  it("returns environment variables", async () => {
-    await inTemporaryDirectory(async (tmpDir) => {
-      const environmentVariables = await pullRemoteEnvironmentVariables({
-        root: tmpDir
-      });
-      expect(environmentVariables).toBe(ENVIRONMENT_VARIABLES_RESPONSE);
-    });
-  });
-  describe("when environment variables are empty", () => {
-    beforeEach(() => {
-      vi.mocked(adminRequest).mockResolvedValue({
-        hydrogenStorefront: {
-          id: "gid://shopify/HydrogenStorefront/1",
-          environmentVariables: []
-        }
-      });
-    });
-    it("renders a message", async () => {
-      await inTemporaryDirectory(async (tmpDir) => {
-        const outputMock = mockAndCaptureOutput();
-        await pullRemoteEnvironmentVariables({ root: tmpDir });
-        expect(outputMock.info()).toMatch(/No environment variables found\./);
-      });
-    });
-    it("returns an empty array", async () => {
-      await inTemporaryDirectory(async (tmpDir) => {
-        const environmentVariables = await pullRemoteEnvironmentVariables({
-          root: tmpDir
-        });
-        expect(environmentVariables).toStrictEqual([]);
-      });
-    });
-  });
-  describe("when there is no linked storefront", () => {
-    beforeEach(() => {
-      vi.mocked(getConfig).mockResolvedValue({
-        storefront: void 0
-      });
-    });
-    it("calls renderMissingLink", async () => {
-      await inTemporaryDirectory(async (tmpDir) => {
-        await pullRemoteEnvironmentVariables({ root: tmpDir });
-        expect(renderMissingLink).toHaveBeenCalledOnce();
-      });
-    });
-    it("prompts the user to create a link", async () => {
-      vi.mocked(renderConfirmationPrompt).mockResolvedValue(true);
-      await inTemporaryDirectory(async (tmpDir) => {
-        await pullRemoteEnvironmentVariables({ root: tmpDir });
-        expect(renderConfirmationPrompt).toHaveBeenCalledWith({
-          message: expect.stringMatching(/Run .*npx shopify hydrogen link.*\?/)
-        });
-        expect(linkStorefront).toHaveBeenCalledWith({
-          path: tmpDir
-        });
-      });
-    });
-    describe("and the user does not create a new link", () => {
-      it("returns an empty array", async () => {
-        vi.mocked(renderConfirmationPrompt).mockResolvedValue(false);
-        await inTemporaryDirectory(async (tmpDir) => {
-          const environmentVariables = await pullRemoteEnvironmentVariables({
-            root: tmpDir
-          });
-          expect(environmentVariables).toStrictEqual([]);
-        });
-      });
-    });
-  });
-  describe("when there is no matching storefront in the shop", () => {
-    beforeEach(() => {
-      vi.mocked(adminRequest).mockResolvedValue({
-        hydrogenStorefront: null
-      });
-    });
-    it("calls renderMissingStorefront", async () => {
-      await inTemporaryDirectory(async (tmpDir) => {
-        await pullRemoteEnvironmentVariables({ root: tmpDir });
-        expect(renderMissingStorefront).toHaveBeenCalledOnce();
-      });
-    });
-    it("returns an empty array", async () => {
-      await inTemporaryDirectory(async (tmpDir) => {
-        const environmentVariables = await pullRemoteEnvironmentVariables({
-          root: tmpDir
-        });
-        expect(environmentVariables).toStrictEqual([]);
-      });
-    });
-  });
-});

package/dist/lib/remix-version-interop.d.ts

@@ -1,11 +0,0 @@
-declare function isRemixV2(): boolean;
-declare function getV2Flags(root: string): Promise<{
-    isV2Meta: boolean;
-    isV2ErrorBoundary: boolean;
-    isV2RouteConvention: boolean;
-}>;
-type RemixV2Flags = Partial<Awaited<ReturnType<typeof getV2Flags>>>;
-declare function convertRouteToV2(route: string): string;
-declare function convertTemplateToRemixVersion(template: string, { isV2Meta, isV2ErrorBoundary }: RemixV2Flags): string;
-
-export { RemixV2Flags, convertRouteToV2, convertTemplateToRemixVersion, getV2Flags, isRemixV2 };

package/dist/lib/remix-version-interop.test.d.ts

@@ -1 +0,0 @@
-

package/dist/lib/render-errors.d.ts

@@ -1,16 +0,0 @@
-import { AdminSession } from '@shopify/cli-kit/node/session';
-
-interface MissingStorefront {
-    adminSession: AdminSession;
-    storefront: {
-        id: string;
-        title: string;
-    };
-}
-declare function renderMissingStorefront({ adminSession, storefront, }: MissingStorefront): void;
-interface MissingLink {
-    adminSession: AdminSession;
-}
-declare function renderMissingLink({ adminSession }: MissingLink): void;
-
-export { renderMissingLink, renderMissingStorefront };

package/dist/lib/shell.d.ts

@@ -1,11 +0,0 @@
-type UnixShell = 'zsh' | 'bash' | 'fish';
-type WindowsShell = 'PowerShell' | 'PowerShell 7+' | 'CMD';
-type Shell = UnixShell | WindowsShell;
-declare const ALIAS_NAME = "h2";
-declare const isWindows: () => boolean;
-declare const isGitBash: () => boolean;
-declare function shellWriteAlias(shell: UnixShell, aliasName: string, content: string): Promise<boolean>;
-declare function shellRunScript(script: string, shellBin: string): Promise<boolean>;
-declare function getCliCommand(): Promise<"h2" | "yarn shopify hydrogen" | "pnpm shopify hydrogen" | "npx shopify hydrogen">;
-
-export { ALIAS_NAME, Shell, UnixShell, WindowsShell, getCliCommand, isGitBash, isWindows, shellRunScript, shellWriteAlias };

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

@@ -1 +0,0 @@
-

package/dist/lib/shop.d.ts

@@ -1,7 +0,0 @@
-interface Flags {
-    shop?: string;
-    path?: string;
-}
-declare function getHydrogenShop(flags: Flags): Promise<string>;
-
-export { getHydrogenShop };

package/dist/lib/shop.js

@@ -1,32 +0,0 @@
-import { renderTextPrompt } from '@shopify/cli-kit/node/ui';
-import { AbortError } from '@shopify/cli-kit/node/error';
-import { outputContent, outputToken } from '@shopify/cli-kit/node/output';
-import { getConfig, setShop } from './shopify-config.js';
-
-async function getHydrogenShop(flags) {
-  const { shop: flagShop, path: flagPath } = flags;
-  const targetPath = flagPath ?? process.cwd();
-  const { shop: configShop } = await getConfig(targetPath);
-  let promptShop;
-  if (!flagShop && !configShop) {
-    promptShop = await renderTextPrompt({
-      message: "Specify which Shop you would like to use (e.g. janes-goods.myshopify.com)",
-      allowEmpty: false
-    });
-  }
-  const shop = flagShop || configShop || promptShop;
-  if (!shop) {
-    throw new AbortError(
-      "A shop is required",
-      `Specify the shop passing ${outputContent`${outputToken.genericShellCommand(
-        `--shop={your_shop_url}}`
-      )}`.value} or set the ${outputContent`${outputToken.genericShellCommand("SHOPIFY_SHOP")}`.value} environment variable.`
-    );
-  }
-  if (!configShop || flagShop && flagShop != configShop) {
-    await setShop(targetPath, shop);
-  }
-  return shop;
-}
-
-export { getHydrogenShop };

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

@@ -1 +0,0 @@
-

package/dist/lib/shop.test.js

@@ -1,78 +0,0 @@
-import { vi, describe, beforeEach, afterEach, it, expect } from 'vitest';
-import { inTemporaryDirectory } from '@shopify/cli-kit/node/fs';
-import { AbortError } from '@shopify/cli-kit/node/error';
-import { mockAndCaptureOutput } from '@shopify/cli-kit/node/testing/output';
-import { renderTextPrompt } from '@shopify/cli-kit/node/ui';
-import { getHydrogenShop } from './shop.js';
-import { getConfig, setShop } from './shopify-config.js';
-
-vi.mock("@shopify/cli-kit/node/ui");
-vi.mock("./shopify-config.js");
-describe("getHydrogenShop()", () => {
-  beforeEach(() => {
-    vi.mocked(getConfig).mockResolvedValue({});
-  });
-  afterEach(() => {
-    mockAndCaptureOutput().clear();
-    vi.clearAllMocks();
-  });
-  describe("when a shop is passed via flag", () => {
-    it("returns the shop", async () => {
-      await inTemporaryDirectory(async (tmpDir) => {
-        const shop = await getHydrogenShop({ shop: "my-shop", path: tmpDir });
-        expect(shop).toBe("my-shop");
-      });
-    });
-  });
-  describe("when a shop is not provided via flag", () => {
-    describe("and there is no existing SHOP_NAME file", () => {
-      it("prompts the user to enter a new name", async () => {
-        await inTemporaryDirectory(async (tmpDir) => {
-          vi.mocked(renderTextPrompt).mockResolvedValue("my-prompted-shop");
-          const shop = await getHydrogenShop({ path: tmpDir });
-          expect(renderTextPrompt).toHaveBeenCalledWith({
-            message: "Specify which Shop you would like to use (e.g. janes-goods.myshopify.com)",
-            allowEmpty: false
-          });
-          expect(shop).toBe("my-prompted-shop");
-        });
-      });
-      describe("and the user does not enter a value", () => {
-        it("throws an error", async () => {
-          await inTemporaryDirectory(async (tmpDir) => {
-            vi.mocked(renderTextPrompt).mockResolvedValue("");
-            await expect(getHydrogenShop({ path: tmpDir })).rejects.toThrow(
-              AbortError
-            );
-          });
-        });
-      });
-    });
-    describe("and there is an existing shop from the config file", () => {
-      it("returns the shop", async () => {
-        vi.mocked(getConfig).mockResolvedValue({ shop: "previous-shop" });
-        await inTemporaryDirectory(async (tmpDir) => {
-          const shop = await getHydrogenShop({ path: tmpDir });
-          expect(shop).toBe("previous-shop");
-        });
-      });
-    });
-  });
-  describe("when the SHOP_NAME file does not exist", () => {
-    it("gets created", async () => {
-      await inTemporaryDirectory(async (tmpDir) => {
-        await getHydrogenShop({ shop: "new-shop", path: tmpDir });
-        expect(setShop).toHaveBeenCalledWith(tmpDir, "new-shop");
-      });
-    });
-  });
-  describe("when the shop is different from the value in SHOP_NAME", () => {
-    it("overwrites SHOP_NAME with the new value", async () => {
-      vi.mocked(getConfig).mockResolvedValue({ shop: "previous-shop" });
-      await inTemporaryDirectory(async (tmpDir) => {
-        await getHydrogenShop({ shop: "new-shop", path: tmpDir });
-        expect(setShop).toHaveBeenCalledWith(tmpDir, "new-shop");
-      });
-    });
-  });
-});

package/dist/lib/shopify-config.d.ts

@@ -1,35 +0,0 @@
-declare const SHOPIFY_DIR = ".shopify";
-declare const SHOPIFY_DIR_PROJECT = "project.json";
-interface Storefront {
-    id: string;
-    title: string;
-}
-interface ShopifyConfig {
-    shop?: string;
-    storefront?: Storefront;
-}
-declare function getConfig(root: string): Promise<ShopifyConfig>;
-declare function setShop(root: string, shop: string): Promise<ShopifyConfig>;
-/**
- * Adds storefront information to the config
- *
- * @param root the target directory
- * @returns the updated config
- */
-declare function setStorefront(root: string, { id, title }: Storefront): Promise<ShopifyConfig>;
-/**
- * Removes storefront information from the config
- *
- * @param root the target directory
- * @returns the updated config
- */
-declare function unsetStorefront(root: string): Promise<ShopifyConfig>;
-/**
- * Conditionally adds .shopify to the directory's .gitignore file
- * @param root
- * @returns A boolean; true if the .gitignore was updated, false if there was
- * an error or the .gitignore didn't need updating
- */
-declare function ensureShopifyGitIgnore(root: string): Promise<boolean>;
-
-export { SHOPIFY_DIR, SHOPIFY_DIR_PROJECT, ShopifyConfig, ensureShopifyGitIgnore, getConfig, setShop, setStorefront, unsetStorefront };

package/dist/lib/shopify-config.test.d.ts

@@ -1 +0,0 @@
-

package/dist/lib/string.d.ts

@@ -1,3 +0,0 @@
-declare function titleize(name?: string): string;
-
-export { titleize };

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

@@ -1 +0,0 @@
-

package/dist/lib/template-downloader.d.ts

@@ -1,6 +0,0 @@
-declare function getLatestTemplates(): Promise<{
-    version: string;
-    templatesDir: string;
-}>;
-
-export { getLatestTemplates };

package/dist/lib/transpile-ts.d.ts

@@ -1,16 +0,0 @@
-import prettier, { Options } from 'prettier';
-import ts, { CompilerOptions } from 'typescript';
-
-declare function transpileFile(code: string, config?: Omit<ts.CompilerOptions, "target">): string;
-declare function resolveFormatConfig(filePath?: string): Promise<prettier.Options>;
-declare function format(content: string, config: Options, filePath?: string): string;
-declare function convertConfigToJS(tsConfig: {
-    include?: string[];
-    compilerOptions?: CompilerOptions;
-}): {
-    include?: string[] | undefined;
-    compilerOptions?: ts.CompilerOptions | undefined;
-};
-declare function transpileProject(projectDir: string): Promise<void>;
-
-export { convertConfigToJS, format, resolveFormatConfig, transpileFile, transpileProject };

package/dist/lib/user-errors.d.ts

@@ -1,9 +0,0 @@
-interface UserError {
-    code: string | undefined;
-    field: string[];
-    message: string;
-}
-declare function renderUserErrors(userErrors: UserError[]): void;
-declare function renderError(message: string): void;
-
-export { UserError, renderError, renderUserErrors };

package/dist/lib/user-errors.js

@@ -1,11 +0,0 @@
-import { AbortError } from '@shopify/cli-kit/node/error';
-
-function renderUserErrors(userErrors) {
-  const errorMessages = userErrors.map(({ message }) => message).join(", ");
-  renderError(errorMessages);
-}
-function renderError(message) {
-  throw new AbortError(message);
-}
-
-export { renderError, renderUserErrors };

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

@@ -1,7 +0,0 @@
-import { RemixConfig } from '@remix-run/dev/dist/config.js';
-
-declare const VIRTUAL_ROUTES_DIR = "virtual-routes/routes";
-declare const VIRTUAL_ROOT = "virtual-routes/virtual-root";
-declare function addVirtualRoutes(config: RemixConfig): Promise<RemixConfig>;
-
-export { VIRTUAL_ROOT, VIRTUAL_ROUTES_DIR, addVirtualRoutes };

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

@@ -1 +0,0 @@
-