@shopify/cli-hydrogen 5.0.2 → 5.1.0

package/dist/generator-templates/routes/policies/$policyHandle.tsx

@@ -1,140 +0,0 @@
-import {
-  json,
-  type MetaFunction,
-  type LoaderArgs,
-  type ErrorBoundaryComponent,
-} from '@shopify/remix-oxygen';
-import {
-  useLoaderData,
-  type V2_MetaFunction,
-  useCatch,
-  useRouteError,
-  isRouteErrorResponse,
-} from '@remix-run/react';
-import {Shop} from '@shopify/hydrogen/storefront-api-types';
-
-export async function loader({params, context}: LoaderArgs) {
-  const handle = params.policyHandle;
-
-  if (!handle) {
-    throw new Response('No handle was passed in', {status: 404});
-  }
-
-  const policyName = handle.replace(/-([a-z])/g, (_: unknown, m1: string) =>
-    m1.toUpperCase(),
-  ) as SelectedPolicies;
-
-  const data = await context.storefront.query<{
-    shop: Pick<Shop, SelectedPolicies>;
-  }>(POLICY_CONTENT_QUERY, {
-    variables: {
-      privacyPolicy: false,
-      shippingPolicy: false,
-      termsOfService: false,
-      refundPolicy: false,
-      [policyName]: true,
-      language: context.storefront.i18n?.language,
-    },
-  });
-
-  const policy = data.shop?.[policyName];
-
-  if (!policy) {
-    throw new Response('Could not find the policy', {status: 404});
-  }
-
-  return json({policy});
-}
-
-export const metaV1: MetaFunction<typeof loader> = ({data}) => {
-  const title = data?.policy?.title ?? 'Policies';
-  return {title};
-};
-
-export const meta: V2_MetaFunction<typeof loader> = ({data}) => {
-  const title = data?.policy?.title ?? 'Policies';
-  return [{title}];
-};
-
-export default function Policies() {
-  const {policy} = useLoaderData<typeof loader>();
-
-  return (
-    <>
-      <h1>{policy.title}</h1>
-      <div dangerouslySetInnerHTML={{__html: policy.body}} />
-    </>
-  );
-}
-
-export const ErrorBoundaryV1: ErrorBoundaryComponent = ({error}) => {
-  console.error(error);
-
-  return <div>There was an error.</div>;
-};
-
-export function CatchBoundary() {
-  const caught = useCatch();
-  console.error(caught);
-
-  return (
-    <div>
-      There was an error. Status: {caught.status}. Message:{' '}
-      {caught.data?.message}
-    </div>
-  );
-}
-
-export function ErrorBoundary() {
-  const error = useRouteError();
-
-  if (isRouteErrorResponse(error)) {
-    console.error(error.status, error.statusText, error.data);
-    return <div>Route Error</div>;
-  } else {
-    console.error((error as Error).message);
-    return <div>Thrown Error</div>;
-  }
-}
-
-const POLICY_CONTENT_QUERY = `#graphql
-  fragment Policy on ShopPolicy {
-    body
-    handle
-    id
-    title
-    url
-  }
-
-  query policy_query(
-    $language: LanguageCode
-    $privacyPolicy: Boolean!
-    $shippingPolicy: Boolean!
-    $termsOfService: Boolean!
-    $refundPolicy: Boolean!
-  ) @inContext(language: $language) {
-    shop {
-      privacyPolicy @include(if: $privacyPolicy) {
-        ...Policy
-      }
-      shippingPolicy @include(if: $shippingPolicy) {
-        ...Policy
-      }
-      termsOfService @include(if: $termsOfService) {
-        ...Policy
-      }
-      refundPolicy @include(if: $refundPolicy) {
-        ...Policy
-      }
-    }
-  }
-`;
-
-const policies = [
-  'privacyPolicy',
-  'shippingPolicy',
-  'refundPolicy',
-  'termsOfService',
-] as const;
-
-type SelectedPolicies = (typeof policies)[number];

package/dist/generator-templates/routes/policies/index.tsx

@@ -1,117 +0,0 @@
-import {
-  json,
-  type LoaderArgs,
-  type ErrorBoundaryComponent,
-} from '@shopify/remix-oxygen';
-import {
-  useLoaderData,
-  Link,
-  useCatch,
-  useRouteError,
-  isRouteErrorResponse,
-} from '@remix-run/react';
-import type {Shop} from '@shopify/hydrogen/storefront-api-types';
-
-export async function loader({context: {storefront}}: LoaderArgs) {
-  const data = await storefront.query<{
-    shop: Pick<Shop, SelectedPolicies>;
-  }>(POLICIES_QUERY);
-
-  const policies = Object.values(data.shop || {});
-
-  if (policies.length === 0) {
-    throw new Response('Not found', {status: 404});
-  }
-
-  return json({
-    policies,
-  });
-}
-
-export default function Policies() {
-  const {policies} = useLoaderData<typeof loader>();
-
-  return (
-    <>
-      {policies.map((policy) => {
-        return (
-          policy && (
-            <Link key={policy.id} to={`/policies/${policy.handle}`}>
-              {policy.title}
-            </Link>
-          )
-        );
-      })}
-    </>
-  );
-}
-
-export const ErrorBoundaryV1: ErrorBoundaryComponent = ({error}) => {
-  console.error(error);
-
-  return <div>There was an error.</div>;
-};
-
-export function CatchBoundary() {
-  const caught = useCatch();
-  console.error(caught);
-
-  return (
-    <div>
-      There was an error. Status: {caught.status}. Message:{' '}
-      {caught.data?.message}
-    </div>
-  );
-}
-
-export function ErrorBoundary() {
-  const error = useRouteError();
-
-  if (isRouteErrorResponse(error)) {
-    console.error(error.status, error.statusText, error.data);
-    return <div>Route Error</div>;
-  } else {
-    console.error((error as Error).message);
-    return <div>Thrown Error</div>;
-  }
-}
-
-const POLICIES_QUERY = `#graphql
-  fragment Policy on ShopPolicy {
-    id
-    title
-    handle
-  }
-
-  query PoliciesQuery {
-    shop {
-      privacyPolicy {
-        ...Policy
-      }
-      shippingPolicy {
-        ...Policy
-      }
-      termsOfService {
-        ...Policy
-      }
-      refundPolicy {
-        ...Policy
-      }
-      subscriptionPolicy {
-        id
-        title
-        handle
-      }
-    }
-  }
-`;
-
-const policies = [
-  'privacyPolicy',
-  'shippingPolicy',
-  'refundPolicy',
-  'termsOfService',
-  'subscriptionPolicy',
-] as const;
-
-type SelectedPolicies = (typeof policies)[number];

package/dist/generator-templates/routes/products/$productHandle.tsx

@@ -1,92 +0,0 @@
-import {
-  defer,
-  type LoaderArgs,
-  type ErrorBoundaryComponent,
-} from '@shopify/remix-oxygen';
-import {
-  useLoaderData,
-  useCatch,
-  useRouteError,
-  isRouteErrorResponse,
-} from '@remix-run/react';
-import type {Product as ProductType} from '@shopify/hydrogen/storefront-api-types';
-
-export async function loader({params, context}: LoaderArgs) {
-  const {productHandle} = params;
-
-  const {product} = await context.storefront.query<{
-    product: Pick<ProductType, 'id' | 'title' | 'descriptionHtml' | 'vendor'>;
-  }>(PRODUCT_QUERY, {
-    variables: {
-      handle: productHandle,
-      country: context.storefront.i18n?.country,
-      language: context.storefront.i18n?.language,
-    },
-  });
-
-  if (!product?.id) {
-    throw new Response(null, {status: 404});
-  }
-
-  return defer({
-    product,
-  });
-}
-
-export default function Product() {
-  const {product} = useLoaderData<typeof loader>();
-  const {title, vendor, descriptionHtml} = product;
-
-  return (
-    <>
-      <h1>{title}</h1>
-      <h2>{vendor}</h2>
-      <div dangerouslySetInnerHTML={{__html: descriptionHtml}} />
-    </>
-  );
-}
-
-export const ErrorBoundaryV1: ErrorBoundaryComponent = ({error}) => {
-  console.error(error);
-
-  return <div>There was an error.</div>;
-};
-
-export function CatchBoundary() {
-  const caught = useCatch();
-  console.error(caught);
-
-  return (
-    <div>
-      There was an error. Status: {caught.status}. Message:{' '}
-      {caught.data?.message}
-    </div>
-  );
-}
-
-export function ErrorBoundary() {
-  const error = useRouteError();
-
-  if (isRouteErrorResponse(error)) {
-    console.error(error.status, error.statusText, error.data);
-    return <div>Route Error</div>;
-  } else {
-    console.error((error as Error).message);
-    return <div>Thrown Error</div>;
-  }
-}
-
-const PRODUCT_QUERY = `#graphql
-  query product_query(
-    $country: CountryCode
-    $language: LanguageCode
-    $handle: String!
-  ) @inContext(country: $country, language: $language) {
-    product(handle: $handle) {
-      id
-      title
-      descriptionHtml
-      vendor
-    }
-  }
-`;

package/dist/hooks/init.d.ts

@@ -1,5 +0,0 @@
-import { Hook } from '@oclif/core';
-
-declare const hook: Hook<'init'>;
-
-export { hook as default };

package/dist/lib/admin-session.d.ts

@@ -1,6 +0,0 @@
-import { AdminSession } from '@shopify/cli-kit/node/session';
-export { AdminSession } from '@shopify/cli-kit/node/session';
-
-declare function getAdminSession(shop: string): Promise<AdminSession>;
-
-export { getAdminSession };

package/dist/lib/admin-session.js

@@ -1,16 +0,0 @@
-import { AbortError } from '@shopify/cli-kit/node/error';
-import { ensureAuthenticatedAdmin } from '@shopify/cli-kit/node/session';
-
-async function getAdminSession(shop) {
-  let adminSession;
-  try {
-    adminSession = await ensureAuthenticatedAdmin(shop);
-  } catch {
-    throw new AbortError("Unable to authenticate with Shopify", void 0, [
-      `Ensure the shop that you specified is correct (you are trying to use: ${shop})`
-    ]);
-  }
-  return adminSession;
-}
-
-export { getAdminSession };

package/dist/lib/admin-session.test.d.ts

@@ -1 +0,0 @@
-

package/dist/lib/admin-session.test.js

@@ -1,27 +0,0 @@
-import { describe, vi, afterEach, it, expect } from 'vitest';
-import { ensureAuthenticatedAdmin } from '@shopify/cli-kit/node/session';
-import { AbortError } from '@shopify/cli-kit/node/error';
-import { getAdminSession } from './admin-session.js';
-
-describe("list", () => {
-  vi.mock("@shopify/cli-kit/node/session");
-  const ADMIN_SESSION = {
-    token: "abc123",
-    storeFqdn: "my-shop"
-  };
-  afterEach(() => {
-    vi.resetAllMocks();
-  });
-  it("returns the admin session", async () => {
-    vi.mocked(ensureAuthenticatedAdmin).mockResolvedValue(ADMIN_SESSION);
-    const adminSession = await getAdminSession("my-shop");
-    expect(ensureAuthenticatedAdmin).toHaveBeenCalledWith("my-shop");
-    expect(adminSession).toStrictEqual(ADMIN_SESSION);
-  });
-  describe("when it fails to authenticate", () => {
-    it("throws an error", async () => {
-      vi.mocked(ensureAuthenticatedAdmin).mockRejectedValue({});
-      await expect(getAdminSession("my-shop")).rejects.toThrow(AbortError);
-    });
-  });
-});

package/dist/lib/admin-urls.d.ts

@@ -1,8 +0,0 @@
-import { AdminSession } from '@shopify/cli-kit/node/session';
-
-declare function newHydrogenStorefrontUrl(session: AdminSession): string;
-declare function hydrogenStorefrontsUrl(session: AdminSession): string;
-declare function hydrogenStorefrontUrl(session: AdminSession, storefrontId: string): string;
-declare function hydrogenStorefrontSettingsUrl(session: AdminSession, storefrontId: string): string;
-
-export { hydrogenStorefrontSettingsUrl, hydrogenStorefrontUrl, hydrogenStorefrontsUrl, newHydrogenStorefrontUrl };

package/dist/lib/check-lockfile.d.ts

@@ -1,3 +0,0 @@
-declare function checkLockfileStatus(directory: string): Promise<void>;
-
-export { checkLockfileStatus };

package/dist/lib/check-lockfile.test.d.ts

@@ -1 +0,0 @@
-

package/dist/lib/check-version.d.ts

@@ -1,16 +0,0 @@
-declare const PACKAGE_NAMES: {
-    readonly main: "@shopify/hydrogen";
-    readonly cli: "@shopify/cli-hydrogen";
-};
-/**
- *
- * @param resolveFrom Path to a directory to resolve from, or directly the path to a package.json file.
- * @param pkgKey Package to check for updates.
- * @returns A function to show the update information if any update is available.
- */
-declare function checkHydrogenVersion(resolveFrom: string, pkgKey?: keyof typeof PACKAGE_NAMES): Promise<((extraMessage?: string) => {
-    currentVersion: string;
-    newVersion: string;
-}) | undefined>;
-
-export { checkHydrogenVersion };

package/dist/lib/check-version.test.d.ts

@@ -1 +0,0 @@
-

package/dist/lib/codegen.d.ts

@@ -1,26 +0,0 @@
-import * as child_process from 'child_process';
-import * as stream from 'stream';
-export { patchGqlPluck } from '@shopify/hydrogen-codegen';
-
-declare function normalizeCodegenError(errorMessage: string, rootDirectory?: string): {
-    message: string;
-    details: string;
-};
-/**
- * Spawns a child process to run GraphlQL CLI Codegen.
- * Running on a separate process splits work from this processor
- * and also allows us to filter out logs.
- */
-declare function spawnCodegenProcess({ rootDirectory, appDirectory, configFilePath, }: CodegenOptions): child_process.ChildProcessByStdio<null, null, stream.Readable>;
-type ProjectDirs = {
-    rootDirectory: string;
-    appDirectory: string;
-};
-type CodegenOptions = ProjectDirs & {
-    watch?: boolean;
-    configFilePath?: string;
-    forceSfapiVersion?: string;
-};
-declare function generateTypes({ watch, configFilePath, forceSfapiVersion, ...dirs }: CodegenOptions): Promise<string[]>;
-
-export { generateTypes, normalizeCodegenError, spawnCodegenProcess };

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

@@ -1,8 +0,0 @@
-interface Arguments {
-    envBranch?: string;
-    root: string;
-    shop?: string;
-}
-declare function combinedEnvironmentVariables({ envBranch, root, shop, }: Arguments): Promise<{}>;
-
-export { combinedEnvironmentVariables };

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

@@ -1,57 +0,0 @@
-import { fileExists } from '@shopify/cli-kit/node/fs';
-import { resolvePath } from '@shopify/cli-kit/node/path';
-import { linesToColumns } from '@shopify/cli-kit/common/string';
-import { outputInfo } from '@shopify/cli-kit/node/output';
-import { readAndParseDotEnv } from '@shopify/cli-kit/node/dot-env';
-import colors from '@shopify/cli-kit/node/colors';
-import { pullRemoteEnvironmentVariables } from './pull-environment-variables.js';
-
-async function combinedEnvironmentVariables({
-  envBranch,
-  root,
-  shop
-}) {
-  const remoteEnvironmentVariables = await pullRemoteEnvironmentVariables({
-    root,
-    flagShop: shop,
-    silent: true,
-    envBranch
-  });
-  const formattedRemoteVariables = remoteEnvironmentVariables?.reduce(
-    (a, v) => ({ ...a, [v.key]: v.value }),
-    {}
-  );
-  const dotEnvPath = resolvePath(root, ".env");
-  const localEnvironmentVariables = await fileExists(dotEnvPath) ? (await readAndParseDotEnv(dotEnvPath)).variables : {};
-  const remoteKeys = new Set(
-    remoteEnvironmentVariables.map((variable) => variable.key)
-  );
-  const localKeys = new Set(Object.keys(localEnvironmentVariables));
-  if ([...remoteKeys, ...localKeys].length) {
-    outputInfo("\nEnvironment variables injected into MiniOxygen:\n");
-  }
-  let rows = [];
-  remoteEnvironmentVariables.filter(({ isSecret }) => !isSecret).forEach(({ key }) => {
-    if (!localKeys.has(key)) {
-      rows.push([key, "from Oxygen"]);
-    }
-  });
-  localKeys.forEach((key) => {
-    rows.push([key, "from local .env"]);
-  });
-  remoteEnvironmentVariables.filter(({ isSecret }) => isSecret).forEach(({ key }) => {
-    if (!localKeys.has(key)) {
-      rows.push([
-        colors.dim(key),
-        colors.dim(`from Oxygen (Marked as secret)`)
-      ]);
-    }
-  });
-  outputInfo(linesToColumns(rows));
-  return {
-    ...formattedRemoteVariables,
-    ...localEnvironmentVariables
-  };
-}
-
-export { combinedEnvironmentVariables };

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

@@ -1 +0,0 @@
-

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

@@ -1,111 +0,0 @@
-import { vi, describe, beforeEach, afterEach, test, expect } from 'vitest';
-import { inTemporaryDirectory, writeFile } from '@shopify/cli-kit/node/fs';
-import { joinPath } from '@shopify/cli-kit/node/path';
-import { mockAndCaptureOutput } from '@shopify/cli-kit/node/testing/output';
-import { combinedEnvironmentVariables } from './combined-environment-variables.js';
-import { pullRemoteEnvironmentVariables } from './pull-environment-variables.js';
-import { getConfig } from './shopify-config.js';
-
-vi.mock("./shopify-config.js");
-vi.mock("./pull-environment-variables.js");
-describe("combinedEnvironmentVariables()", () => {
-  beforeEach(() => {
-    vi.mocked(getConfig).mockResolvedValue({
-      storefront: {
-        id: "gid://shopify/HydrogenStorefront/1",
-        title: "Hydrogen"
-      }
-    });
-    vi.mocked(pullRemoteEnvironmentVariables).mockResolvedValue([
-      {
-        id: "gid://shopify/HydrogenStorefrontEnvironmentVariable/1",
-        key: "PUBLIC_API_TOKEN",
-        value: "abc123",
-        isSecret: false
-      }
-    ]);
-  });
-  afterEach(() => {
-    vi.resetAllMocks();
-    mockAndCaptureOutput().clear();
-  });
-  test("calls pullRemoteEnvironmentVariables", async () => {
-    await inTemporaryDirectory(async (tmpDir) => {
-      await combinedEnvironmentVariables({
-        envBranch: "main",
-        root: tmpDir,
-        shop: "my-shop"
-      });
-      expect(pullRemoteEnvironmentVariables).toHaveBeenCalledWith({
-        envBranch: "main",
-        root: tmpDir,
-        flagShop: "my-shop",
-        silent: true
-      });
-    });
-  });
-  test("renders a message about injection", async () => {
-    await inTemporaryDirectory(async (tmpDir) => {
-      const outputMock = mockAndCaptureOutput();
-      await combinedEnvironmentVariables({ root: tmpDir, shop: "my-shop" });
-      expect(outputMock.info()).toMatch(
-        /Environment variables injected into MiniOxygen:/
-      );
-    });
-  });
-  test("lists all of the variables being used", async () => {
-    await inTemporaryDirectory(async (tmpDir) => {
-      const outputMock = mockAndCaptureOutput();
-      await combinedEnvironmentVariables({ root: tmpDir, shop: "my-shop" });
-      expect(outputMock.info()).toMatch(/PUBLIC_API_TOKEN\s+from Oxygen/);
-    });
-  });
-  describe("when one of the variables is a secret", () => {
-    beforeEach(() => {
-      vi.mocked(pullRemoteEnvironmentVariables).mockResolvedValue([
-        {
-          id: "gid://shopify/HydrogenStorefrontEnvironmentVariable/1",
-          key: "PUBLIC_API_TOKEN",
-          value: "",
-          isSecret: true
-        }
-      ]);
-    });
-    test("uses special messaging to alert the user", async () => {
-      await inTemporaryDirectory(async (tmpDir) => {
-        const outputMock = mockAndCaptureOutput();
-        await combinedEnvironmentVariables({ root: tmpDir, shop: "my-shop" });
-        expect(outputMock.info()).toMatch(
-          /PUBLIC_API_TOKEN\s+from Oxygen \(Marked as secret\)/
-        );
-      });
-    });
-  });
-  describe("when there are local variables", () => {
-    test("includes local variables in the list", async () => {
-      await inTemporaryDirectory(async (tmpDir) => {
-        const filePath = joinPath(tmpDir, ".env");
-        await writeFile(filePath, "LOCAL_TOKEN=1");
-        const outputMock = mockAndCaptureOutput();
-        await combinedEnvironmentVariables({ root: tmpDir });
-        expect(outputMock.info()).toMatch(/LOCAL_TOKEN\s+from local \.env/);
-      });
-    });
-    describe("and they overwrite remote variables", () => {
-      test("uses special messaging to alert the user", async () => {
-        await inTemporaryDirectory(async (tmpDir) => {
-          const filePath = joinPath(tmpDir, ".env");
-          await writeFile(filePath, "PUBLIC_API_TOKEN=abc");
-          const outputMock = mockAndCaptureOutput();
-          await combinedEnvironmentVariables({ root: tmpDir, shop: "my-shop" });
-          expect(outputMock.info()).not.toMatch(
-            /PUBLIC_API_TOKEN\s+from Oxygen/
-          );
-          expect(outputMock.info()).toMatch(
-            /PUBLIC_API_TOKEN\s+from local \.env/
-          );
-        });
-      });
-    });
-  });
-});

package/dist/lib/config.d.ts

@@ -1,20 +0,0 @@
-import { ServerMode } from '@remix-run/dev/dist/config/serverModes.js';
-export { ServerMode } from '@remix-run/dev/dist/config/serverModes.js';
-import { RemixConfig } from '@remix-run/dev/dist/config.js';
-export { RemixConfig } from '@remix-run/dev/dist/config.js';
-
-declare function getProjectPaths(appPath?: string, entry?: string): {
-    root: string;
-    buildPath: string;
-    buildPathClient: string;
-    buildPathWorkerFile: string;
-    publicPath: string;
-};
-declare function getRemixConfig(root: string, skipOxygenChecks?: boolean, mode?: ServerMode): Promise<RemixConfig & {
-    serverConditions?: string[] | undefined;
-    serverMainFields?: string[] | undefined;
-    serverDependenciesToBundle?: string | undefined;
-}>;
-declare function assertEntryFileExists(root: string, fileRelative: string): Promise<void>;
-
-export { assertEntryFileExists, getProjectPaths, getRemixConfig };