@shopify/oxygen-cli 1.3.1 → 1.5.0

package/README.md

@@ -35,14 +35,14 @@ oxygen:deploy [options]
 ### Options
 
 - -t, --token <token>: (required) Oxygen deployment token. Can also be set using the `OXYGEN_DEPLOYMENT_TOKEN` environment variable (see below).
-- -r, --rootPath <rootPath>: Root path (defaults to the current working directory).
+- -p, --path <rootPath>: Root path (defaults to the current working directory).
 - -e, --environmentTag <environmentTag>: Tag of the environment to deploy to. Defaults to branch name in supported CI environments (see below).
 - -w, --workerFolder <workerFolder>: Worker folder (default: `dist/worker/`).
 - -a, --assetsFolder <assetsFolder>: Assets folder (default: `dist/client/`).
 - -o, --workerOnly: Worker only deployment.
 - -s, --skipBuild: Skip running build command.
-- -p, --publicDeployment: set the deployment to be publicly accessible.
 - -b, --buildCommand <buildCommand>: Build command (default: `yarn build`).
+- --publicDeployment: set the deployment to be publicly accessible.
 - --metadataUrl <metadataUrl>: URL that links to the deployment.
 - --metadataUser <metadataUser>: User that initiated the deployment.
 - --metadataVersion <metadataVersion>: A version identifier for the deployment.
@@ -52,7 +52,7 @@ oxygen:deploy [options]
 ### Example:
 
 ```
-oxygen:deploy -t my-deployment-token -e staging --rootPath="/my-project" --workerOnly
+oxygen:deploy -t my-deployment-token -e staging --path="/my-project" --workerOnly
 ```
 
 This command will deploy your Oxygen project to the staging environment with the provided deployment token and root path. No static assets will be uploaded.

package/dist/commands/oxygen/deploy.d.ts

@@ -1,13 +1,13 @@
 import * as _oclif_core_lib_interfaces_parser_js from '@oclif/core/lib/interfaces/parser.js';
 import { Command } from '@oclif/core';
-import { DeployConfig } from '../../deploy/types.js';
+import { DeploymentConfig } from '../../deploy/types.js';
 
 declare class Deploy extends Command {
     static description: string;
     static hidden: boolean;
     static flags: {
         token: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
-        rootPath: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
+        path: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         environmentTag: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         workerFolder: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         assetsFolder: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
@@ -22,6 +22,6 @@ declare class Deploy extends Command {
     static hasCustomBuildCommand: boolean;
     run(): Promise<void>;
 }
-declare function runInit(options: DeployConfig): void;
+declare function runInit(config: DeploymentConfig): void;
 
 export { Deploy, runInit };

package/dist/commands/oxygen/deploy.js

@@ -14,8 +14,8 @@ class Deploy extends Command {
       env: "OXYGEN_DEPLOYMENT_TOKEN",
       required: true
     }),
-    rootPath: Flags.string({
-      char: "r",
+    path: Flags.string({
+      char: "p",
       description: "Root path",
       default: "./",
       required: false
@@ -60,7 +60,6 @@ class Deploy extends Command {
       }
     }),
     publicDeployment: Flags.boolean({
-      char: "p",
       env: "OXYGEN_PUBLIC_DEPLOYMENT",
       description: "Marks a preview deployment as publicly accessible.",
       required: false,
@@ -93,6 +92,7 @@ class Deploy extends Command {
       const config = {
         assetsDir: normalizePath(flags.assetsFolder),
         buildCommand: flags.buildCommand,
+        buildOutput: true,
         deploymentToken: parseToken(flags.token),
         environmentTag: flags.environmentTag,
         deploymentUrl,
@@ -102,7 +102,7 @@ class Deploy extends Command {
           version: flags.metadataVersion
         },
         publicDeployment: flags.publicDeployment,
-        rootPath: normalizePath(flags.rootPath),
+        rootPath: normalizePath(flags.path),
         skipBuild: flags.skipBuild,
         workerDir: normalizePath(flags.workerFolder),
         workerOnly: flags.workerOnly
@@ -122,8 +122,8 @@ class Deploy extends Command {
     }
   }
 }
-function runInit(options) {
-  createDeploy(options);
+function runInit(config) {
+  createDeploy({ config });
 }
 
 export { Deploy, runInit };

package/dist/deploy/build-cancel.d.ts

@@ -1,6 +1,13 @@
-import { DeployConfig } from './types.js';
+import { Logger } from '@shopify/cli-kit/node/output';
+import { DeploymentConfig } from './types.js';
 import { BuildCancelResponse } from './graphql/build-cancel.js';
 
-declare function buildCancel(config: DeployConfig, buildId: string, reason: string): Promise<BuildCancelResponse>;
+interface BuildCancelOptions {
+    config: DeploymentConfig;
+    buildId: string;
+    reason: string;
+    logger: Logger;
+}
+declare function buildCancel(options: BuildCancelOptions): Promise<BuildCancelResponse>;
 
 export { buildCancel };

package/dist/deploy/build-cancel.js

@@ -1,10 +1,11 @@
 import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { AbortError } from '@shopify/cli-kit/node/error';
 import { outputInfo } from '@shopify/cli-kit/node/output';
-import { Header, stderrLogger, errorHandler } from '../utils/utils.js';
+import { Header, errorHandler } from '../utils/utils.js';
 import { BuildCancelQuery } from './graphql/build-cancel.js';
 
-async function buildCancel(config, buildId, reason) {
+async function buildCancel(options) {
+  const { config, buildId, reason, logger } = options;
   const variables = {
     buildId,
     reason
@@ -25,7 +26,7 @@ async function buildCancel(config, buildId, reason) {
         `Failed to cancel build: ${response.buildCancel.userErrors[0]?.message}`
       );
     }
-    outputInfo(`Build with id ${buildId} cancelled.`, stderrLogger);
+    outputInfo(`Build with id ${buildId} cancelled.`, logger);
     return response.buildCancel;
   } catch (error) {
     errorHandler(error);

package/dist/deploy/build-cancel.test.js

@@ -2,7 +2,7 @@ import { AbortError } from '@shopify/cli-kit/node/error';
 import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { vi, describe, test, expect } from 'vitest';
 import { createTestConfig } from '../utils/test-helper.js';
-import { Header } from '../utils/utils.js';
+import { stderrLogger, Header } from '../utils/utils.js';
 import { buildCancel } from './build-cancel.js';
 
 vi.mock("@shopify/cli-kit/node/api/graphql");
@@ -20,7 +20,12 @@ describe("BuildCancel", () => {
       }
     };
     vi.mocked(graphqlRequest).mockResolvedValueOnce(response);
-    const cancelResponse = await buildCancel(testConfig, "build-1", "because");
+    const cancelResponse = await buildCancel({
+      config: testConfig,
+      buildId: "build-1",
+      reason: "because",
+      logger: stderrLogger
+    });
     expect(cancelResponse).toEqual(response.buildCancel);
     expect(graphqlRequest).toHaveBeenCalledWith({
       query: expect.any(String),
@@ -47,7 +52,14 @@ describe("BuildCancel", () => {
       }
     };
     vi.mocked(graphqlRequest).mockResolvedValueOnce(response);
-    await expect(buildCancel(testConfig, "build-1", "because")).rejects.toThrow(
+    await expect(
+      buildCancel({
+        config: testConfig,
+        buildId: "build-1",
+        reason: "because",
+        logger: stderrLogger
+      })
+    ).rejects.toThrow(
       new AbortError(
         `Failed to cancel build: ${response.buildCancel.userErrors[0]?.message}`
       )
@@ -60,7 +72,12 @@ describe("BuildCancel", () => {
     vi.mocked(graphqlRequest).mockRejectedValueOnce(error);
     try {
       await expect(
-        buildCancel(testConfig, "build-1", "because")
+        buildCancel({
+          config: testConfig,
+          buildId: "build-1",
+          reason: "because",
+          logger: stderrLogger
+        })
       ).rejects.toThrow(
         new AbortError(
           "You are not authorized to perform this action. Please check your deployment token."

package/dist/deploy/build-initiate.d.ts

@@ -1,6 +1,13 @@
-import { DeployConfig, EnvironmentInput } from './types.js';
+import { Logger } from '@shopify/cli-kit/node/output';
+import { DeploymentConfig, EnvironmentInput } from './types.js';
 import { BuildInitiateResponse } from './graphql/build-initiate.js';
 
-declare function buildInitiate(config: DeployConfig, environment?: EnvironmentInput, labels?: string[]): Promise<BuildInitiateResponse>;
+interface BuildInitiateOptions {
+    config: DeploymentConfig;
+    logger: Logger;
+    environment?: EnvironmentInput;
+    labels?: string[];
+}
+declare function buildInitiate(options: BuildInitiateOptions): Promise<BuildInitiateResponse>;
 
 export { buildInitiate };

package/dist/deploy/build-initiate.js

@@ -1,10 +1,11 @@
 import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { AbortError } from '@shopify/cli-kit/node/error';
 import { outputCompleted } from '@shopify/cli-kit/node/output';
-import { Header, stderrLogger, errorHandler } from '../utils/utils.js';
+import { Header, errorHandler } from '../utils/utils.js';
 import { BuildInitiateQuery } from './graphql/build-initiate.js';
 
-async function buildInitiate(config, environment, labels = []) {
+async function buildInitiate(options) {
+  const { config, logger, environment, labels = [] } = options;
   const variables = {
     environment,
     labels
@@ -27,7 +28,7 @@ async function buildInitiate(config, environment, labels = []) {
     }
     outputCompleted(
       `Build initiated successfully with id ${response.buildInitiate.build.id}.`,
-      stderrLogger
+      logger
     );
     return response.buildInitiate;
   } catch (error) {

package/dist/deploy/build-initiate.test.js

@@ -2,7 +2,7 @@ import { AbortError } from '@shopify/cli-kit/node/error';
 import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { outputCompleted } from '@shopify/cli-kit/node/output';
 import { vi, describe, test, expect } from 'vitest';
-import { Header, stderrLogger } from '../utils/utils.js';
+import { stderrLogger, Header } from '../utils/utils.js';
 import { createTestConfig } from '../utils/test-helper.js';
 import { buildInitiate } from './build-initiate.js';
 
@@ -20,13 +20,14 @@ describe("BuildInitiate", () => {
       }
     };
     vi.mocked(graphqlRequest).mockResolvedValueOnce(response);
-    const initiateResponse = await buildInitiate(
-      testConfig,
-      {
+    const initiateResponse = await buildInitiate({
+      config: testConfig,
+      environment: {
         tag: testConfig.environmentTag
       },
-      []
-    );
+      labels: [],
+      logger: stderrLogger
+    });
     expect(initiateResponse).toEqual(response.buildInitiate);
     expect(graphqlRequest).toHaveBeenCalledWith({
       query: expect.any(String),
@@ -55,7 +56,12 @@ describe("BuildInitiate", () => {
     };
     vi.mocked(graphqlRequest).mockResolvedValueOnce(response);
     await expect(
-      buildInitiate(testConfig, { tag: "preview" }, [])
+      buildInitiate({
+        config: testConfig,
+        environment: { tag: "preview" },
+        labels: [],
+        logger: stderrLogger
+      })
     ).rejects.toThrow(
       new AbortError(
         `Failed to create build. ${response.buildInitiate.userErrors[0]?.message}`
@@ -69,7 +75,12 @@ describe("BuildInitiate", () => {
     vi.mocked(graphqlRequest).mockRejectedValueOnce(error);
     try {
       await expect(
-        buildInitiate(testConfig, { tag: "preview" }, [])
+        buildInitiate({
+          config: testConfig,
+          environment: { tag: "preview" },
+          labels: [],
+          logger: stderrLogger
+        })
       ).rejects.toThrow(
         new AbortError(
           "You are not authorized to perform this action. Please check your deployment token."

package/dist/deploy/build-project.d.ts

@@ -1,5 +1,10 @@
-import { DeployConfig } from './types.js';
+import { DeploymentConfig, DeploymentHooks } from './types.js';
 
-declare function buildProject(config: DeployConfig, assetPath?: string): Promise<void>;
+interface BuildProjectOptions {
+    config: DeploymentConfig;
+    assetPath?: string;
+    hooks?: DeploymentHooks;
+}
+declare function buildProject(options: BuildProjectOptions): Promise<void>;
 
 export { buildProject };

package/dist/deploy/build-project.js

@@ -1,28 +1,43 @@
 import { spawn } from 'child_process';
 
-async function buildProject(config, assetPath) {
+async function buildProject(options) {
+  const { config, assetPath, hooks } = options;
+  hooks?.onBuildStart?.();
   const assetPathEnvironment = assetPath ? { HYDROGEN_ASSET_BASE_URL: assetPath } : {};
-  await new Promise((resolve, reject) => {
-    const buildCommand = spawn(config.buildCommand, [], {
-      stdio: ["inherit", "pipe", "inherit"],
-      env: {
-        // eslint-disable-next-line no-process-env
-        ...process.env,
-        ...assetPathEnvironment
-      },
-      cwd: config.rootPath,
-      shell: true
-    });
-    buildCommand.stdout.pipe(process.stderr);
-    buildCommand.on("close", (code) => {
-      if (code !== 0) {
-        reject(code);
+  try {
+    await new Promise((resolve, reject) => {
+      const buildCommand = spawn(config.buildCommand, [], {
+        stdio: config.buildOutput ? ["inherit", "pipe", "inherit"] : ["ignore", "ignore", "pipe"],
+        env: {
+          // eslint-disable-next-line no-process-env
+          ...process.env,
+          ...assetPathEnvironment
+        },
+        cwd: config.rootPath,
+        shell: true
+      });
+      let stderrOutput = "";
+      if (buildCommand.stderr) {
+        buildCommand.stderr.on("data", (data) => {
+          stderrOutput += data;
+        });
+      }
+      if (config.buildOutput && buildCommand.stdout) {
+        buildCommand.stdout.pipe(process.stderr);
       }
-      resolve(code);
+      buildCommand.on("close", (code) => {
+        if (code !== 0) {
+          hooks?.onBuildError?.(new Error(stderrOutput));
+          reject(code);
+          return;
+        }
+        hooks?.onBuildComplete?.();
+        resolve(code);
+      });
     });
-  }).catch((error) => {
+  } catch (error) {
     throw new Error(`Build failed with error code: ${error}`);
-  });
+  }
 }
 
 export { buildProject };

package/dist/deploy/build-project.test.js

@@ -30,7 +30,11 @@ test("BuildProject builds the project successfully", async () => {
     buildCommand: "npm run build"
   };
   const assetPath = "https://example.com/assets";
-  await buildProject(config, assetPath);
+  const hooks = {
+    onBuildStart: vi.fn(),
+    onBuildComplete: vi.fn()
+  };
+  await buildProject({ config, assetPath, hooks });
   expect(spawn).toBeCalledWith("npm run build", [], {
     cwd: "rootFolder",
     shell: true,
@@ -41,15 +45,17 @@ test("BuildProject builds the project successfully", async () => {
       HYDROGEN_ASSET_BASE_URL: "https://example.com/assets"
     }
   });
+  expect(hooks.onBuildStart).toBeCalled();
+  expect(hooks.onBuildComplete).toBeCalled();
 });
 test("should throw error on build command failure", async () => {
   returnCode = 1;
-  ({
-    ...testConfig,
-    buildCommand: "yarn build"
-  });
+  const hooks = {
+    onBuildError: vi.fn()
+  };
   const assetPath = "https://example.com/assets";
-  await expect(() => buildProject(testConfig, assetPath)).rejects.toThrow(
-    "Build failed with error code: 1"
-  );
+  await expect(
+    () => buildProject({ config: testConfig, assetPath, hooks })
+  ).rejects.toThrow("Build failed with error code: 1");
+  expect(hooks.onBuildError).toBeCalled();
 });

package/dist/deploy/deployment-cancel.d.ts

@@ -1,10 +1,17 @@
-import { DeployConfig } from './types.js';
+import { Logger } from '@shopify/cli-kit/node/output';
+import { DeploymentConfig } from './types.js';
 import { DeploymentCancelResponse } from './graphql/deployment-cancel.js';
 
 declare enum DeploymentCancelReason {
     Failed = "FAILED",
     Cancelled = "CANCELLED"
 }
-declare function deploymentCancel(config: DeployConfig, deploymentId: string, reason: DeploymentCancelReason): Promise<DeploymentCancelResponse>;
+interface DeploymentCancelOptions {
+    config: DeploymentConfig;
+    deploymentId: string;
+    reason: DeploymentCancelReason;
+    logger: Logger;
+}
+declare function deploymentCancel(options: DeploymentCancelOptions): Promise<DeploymentCancelResponse>;
 
 export { DeploymentCancelReason, deploymentCancel };

package/dist/deploy/deployment-cancel.js

@@ -1,7 +1,7 @@
 import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { AbortError } from '@shopify/cli-kit/node/error';
 import { outputInfo } from '@shopify/cli-kit/node/output';
-import { Header, stderrLogger, errorHandler } from '../utils/utils.js';
+import { Header, errorHandler } from '../utils/utils.js';
 import { DeploymentCancelQuery } from './graphql/deployment-cancel.js';
 
 var DeploymentCancelReason = /* @__PURE__ */ ((DeploymentCancelReason2) => {
@@ -9,7 +9,8 @@ var DeploymentCancelReason = /* @__PURE__ */ ((DeploymentCancelReason2) => {
   DeploymentCancelReason2["Cancelled"] = "CANCELLED";
   return DeploymentCancelReason2;
 })(DeploymentCancelReason || {});
-async function deploymentCancel(config, deploymentId, reason) {
+async function deploymentCancel(options) {
+  const { config, deploymentId, reason, logger } = options;
   const variables = {
     deploymentId,
     reason
@@ -30,7 +31,7 @@ async function deploymentCancel(config, deploymentId, reason) {
         `Failed to cancel deployment: ${response.deploymentCancel.userErrors[0]?.message}`
       );
     }
-    outputInfo(`Deployment with id ${deploymentId} cancelled.`, stderrLogger);
+    outputInfo(`Deployment with id ${deploymentId} cancelled.`, logger);
     return response.deploymentCancel;
   } catch (error) {
     errorHandler(error);

package/dist/deploy/deployment-cancel.test.js

@@ -2,7 +2,7 @@ import { AbortError } from '@shopify/cli-kit/node/error';
 import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { vi, describe, test, expect } from 'vitest';
 import { createTestConfig } from '../utils/test-helper.js';
-import { Header } from '../utils/utils.js';
+import { stderrLogger, Header } from '../utils/utils.js';
 import { deploymentCancel, DeploymentCancelReason } from './deployment-cancel.js';
 
 vi.mock("@shopify/cli-kit/node/api/graphql");
@@ -19,11 +19,12 @@ describe("DeploymentComplete", () => {
       }
     };
     vi.mocked(graphqlRequest).mockResolvedValueOnce(response);
-    const completeResponse = await deploymentCancel(
-      testConfig,
-      "deployment-1",
-      DeploymentCancelReason.Failed
-    );
+    const completeResponse = await deploymentCancel({
+      config: testConfig,
+      deploymentId: "deployment-1",
+      reason: DeploymentCancelReason.Failed,
+      logger: stderrLogger
+    });
     expect(completeResponse).toEqual(response.deploymentCancel);
     expect(graphqlRequest).toHaveBeenCalledWith({
       query: expect.any(String),
@@ -51,11 +52,12 @@ describe("DeploymentComplete", () => {
     };
     vi.mocked(graphqlRequest).mockResolvedValueOnce(response);
     await expect(
-      deploymentCancel(
-        testConfig,
-        "deployment-1",
-        DeploymentCancelReason.Failed
-      )
+      deploymentCancel({
+        config: testConfig,
+        deploymentId: "deployment-1",
+        reason: DeploymentCancelReason.Failed,
+        logger: stderrLogger
+      })
     ).rejects.toThrow(
       new AbortError(
         `Failed to cancel deployment: ${response.deploymentCancel.userErrors[0]?.message}`
@@ -69,11 +71,12 @@ describe("DeploymentComplete", () => {
     vi.mocked(graphqlRequest).mockRejectedValueOnce(error);
     try {
       await expect(
-        deploymentCancel(
-          testConfig,
-          "deployment-1",
-          DeploymentCancelReason.Failed
-        )
+        deploymentCancel({
+          config: testConfig,
+          deploymentId: "deployment-1",
+          reason: DeploymentCancelReason.Failed,
+          logger: stderrLogger
+        })
       ).rejects.toThrow(
         new AbortError(
           "You are not authorized to perform this action. Please check your deployment token."

package/dist/deploy/deployment-complete.d.ts

@@ -1,6 +1,6 @@
 import { DeploymentCompleteResponse } from './graphql/deployment-complete.js';
-import { DeployConfig } from './types.js';
+import { DeploymentConfig } from './types.js';
 
-declare function deploymentComplete(config: DeployConfig, deploymentId: string): Promise<DeploymentCompleteResponse>;
+declare function deploymentComplete(config: DeploymentConfig, deploymentId: string): Promise<DeploymentCompleteResponse>;
 
 export { deploymentComplete };

package/dist/deploy/deployment-initiate.d.ts

@@ -1,17 +1,23 @@
-import { DeployConfig, DeploymentManifestFile, EnvironmentInput } from './types.js';
+import { Logger } from '@shopify/cli-kit/node/output';
+import { DeploymentConfig, DeploymentManifestFile, EnvironmentInput } from './types.js';
 import { DeploymentInitiateResponse } from './graphql/deployment-initiate.js';
 
 type DeploymentInitiateInput = {
     buildId: string;
     environment?: never;
-    manifest: DeploymentManifestFile[];
     labels?: string[];
+    manifest: DeploymentManifestFile[];
 } | {
     environment?: EnvironmentInput;
     buildId?: never;
-    manifest: DeploymentManifestFile[];
     labels?: string[];
+    manifest: DeploymentManifestFile[];
 };
-declare function deploymentInitiate(config: DeployConfig, input: DeploymentInitiateInput): Promise<DeploymentInitiateResponse>;
+interface DeploymentInitiateOptions {
+    config: DeploymentConfig;
+    input: DeploymentInitiateInput;
+    logger: Logger;
+}
+declare function deploymentInitiate(options: DeploymentInitiateOptions): Promise<DeploymentInitiateResponse>;
 
 export { deploymentInitiate };

package/dist/deploy/deployment-initiate.js

@@ -1,10 +1,11 @@
 import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { AbortError } from '@shopify/cli-kit/node/error';
 import { outputCompleted } from '@shopify/cli-kit/node/output';
-import { Header, stderrLogger, errorHandler } from '../utils/utils.js';
+import { Header, errorHandler } from '../utils/utils.js';
 import { DeploymentInitiateQuery } from './graphql/deployment-initiate.js';
 
-async function deploymentInitiate(config, input) {
+async function deploymentInitiate(options) {
+  const { config, input, logger } = options;
   const variables = {
     buildId: input.buildId,
     environment: input.environment,
@@ -30,7 +31,7 @@ async function deploymentInitiate(config, input) {
     }
     outputCompleted(
       `Deployment initiated, ${response.deploymentInitiate.deploymentTargets.length} files to upload.`,
-      stderrLogger
+      logger
     );
     return response.deploymentInitiate;
   } catch (error) {

package/dist/deploy/deployment-initiate.test.js

@@ -3,7 +3,7 @@ import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
 import { outputCompleted } from '@shopify/cli-kit/node/output';
 import { vi, describe, test, expect } from 'vitest';
 import { createTestConfig } from '../utils/test-helper.js';
-import { Header, stderrLogger } from '../utils/utils.js';
+import { stderrLogger, Header } from '../utils/utils.js';
 import { deploymentInitiate } from './deployment-initiate.js';
 
 vi.mock("@shopify/cli-kit/node/api/graphql");
@@ -38,9 +38,13 @@ const testResponse = {
 describe("DeploymentInitiate", () => {
   test("should initiate a deployment with a buildId", async () => {
     vi.mocked(graphqlRequest).mockResolvedValueOnce(testResponse);
-    const initiateResponse = await deploymentInitiate(testConfig, {
-      buildId: "build-1",
-      manifest: testManifest
+    const initiateResponse = await deploymentInitiate({
+      config: testConfig,
+      input: {
+        buildId: "build-1",
+        manifest: testManifest
+      },
+      logger: stderrLogger
     });
     expect(initiateResponse).toEqual(testResponse.deploymentInitiate);
     expect(graphqlRequest).toHaveBeenCalledWith({
@@ -65,10 +69,14 @@ describe("DeploymentInitiate", () => {
   });
   test("should initiate a deployment with an environmentName", async () => {
     vi.mocked(graphqlRequest).mockResolvedValueOnce(testResponse);
-    const initiateResponse = await deploymentInitiate(testConfig, {
-      buildId: void 0,
-      environment: { tag: "preview" },
-      manifest: testManifest
+    const initiateResponse = await deploymentInitiate({
+      config: testConfig,
+      input: {
+        buildId: void 0,
+        environment: { tag: "preview" },
+        manifest: testManifest
+      },
+      logger: stderrLogger
     });
     expect(initiateResponse).toEqual(testResponse.deploymentInitiate);
     expect(graphqlRequest).toHaveBeenCalledWith({
@@ -108,7 +116,11 @@ describe("DeploymentInitiate", () => {
       manifest: testManifest
     };
     await expect(
-      deploymentInitiate(testConfig, deploymentInitData)
+      deploymentInitiate({
+        config: testConfig,
+        input: deploymentInitData,
+        logger: stderrLogger
+      })
     ).rejects.toThrow(
       new AbortError(
         `Failed to create deployment. ${response.deploymentInitiate.userErrors[0]?.message}`
@@ -127,7 +139,11 @@ describe("DeploymentInitiate", () => {
         manifest: testManifest
       };
       await expect(
-        deploymentInitiate(testConfig, deploymentInitData)
+        deploymentInitiate({
+          config: testConfig,
+          input: deploymentInitData,
+          logger: stderrLogger
+        })
       ).rejects.toThrow(
         new AbortError(
           "You are not authorized to perform this action. Please check your deployment token."

package/dist/deploy/get-upload-files.d.ts

@@ -1,5 +1,5 @@
-import { DeployConfig, DeploymentManifestFile } from './types.js';
+import { DeploymentConfig, DeploymentManifestFile } from './types.js';
 
-declare function getUploadFiles(config: DeployConfig): Promise<DeploymentManifestFile[]>;
+declare function getUploadFiles(config: DeploymentConfig): Promise<DeploymentManifestFile[]>;
 
 export { getUploadFiles };

package/dist/deploy/index.d.ts

@@ -1,5 +1,12 @@
-import { DeployConfig } from './types.js';
+import { Logger } from '@shopify/cli-kit/node/output';
+import { DeploymentConfig, DeploymentHooks } from './types.js';
+export { parseToken } from '../utils/utils.js';
 
-declare function createDeploy(config: DeployConfig): Promise<void>;
+interface CreateDeployOptions {
+    config: DeploymentConfig;
+    hooks?: DeploymentHooks;
+    logger?: Logger;
+}
+declare function createDeploy(options: CreateDeployOptions): Promise<string | undefined>;
 
-export { createDeploy };
+export { DeploymentConfig, DeploymentHooks, createDeploy };

package/dist/deploy/index.js

@@ -1,5 +1,6 @@
 import { outputSuccess, outputInfo, outputWarn, consoleError } from '@shopify/cli-kit/node/output';
-import { verifyConfig, stderrLogger } from '../utils/utils.js';
+import { stderrLogger, verifyConfig } from '../utils/utils.js';
+export { parseToken } from '../utils/utils.js';
 import { buildInitiate } from './build-initiate.js';
 import { buildCancel } from './build-cancel.js';
 import { getUploadFiles } from './get-upload-files.js';
@@ -10,32 +11,43 @@ import { uploadFiles } from './upload-files.js';
 import { buildProject } from './build-project.js';
 import { getMetadata, createLabels, getEnvironmentInput } from './metadata.js';
 
-async function createDeploy(config) {
+async function createDeploy(options) {
+  const { config, hooks } = options;
+  const logger = options.logger ?? stderrLogger;
   const build = {};
   let buildCompleted;
   let deployment;
   try {
-    const metadata = await getMetadata(config);
+    const metadata = await getMetadata(config, logger);
     const labels = createLabels(metadata);
     const environment = getEnvironmentInput(config, metadata);
     if (!config.workerOnly && !config.skipBuild) {
-      const buildInitiateResponse = await buildInitiate(
+      const buildInitiateResponse = await buildInitiate({
         config,
         environment,
-        labels
-      );
+        labels,
+        logger
+      });
       build.id = buildInitiateResponse.build.id;
       build.assetPath = buildInitiateResponse.build.assetPath;
     }
     if (!config.skipBuild) {
-      await buildProject(config, build.assetPath);
+      await buildProject({
+        config,
+        assetPath: build.assetPath,
+        hooks
+      });
       verifyConfig({ config, performedBuild: true });
     }
     buildCompleted = true;
     const manifest = await getUploadFiles(config);
     const deploymentInitiateInput = build.id ? { buildId: build.id, manifest } : { environment, manifest, labels };
-    deployment = await deploymentInitiate(config, deploymentInitiateInput);
-    await uploadFiles(config, deployment.deploymentTargets);
+    deployment = await deploymentInitiate({
+      config,
+      input: deploymentInitiateInput,
+      logger
+    });
+    await uploadFiles({ config, targets: deployment.deploymentTargets, logger });
     const deploymentCompleteOp = await deploymentComplete(
       config,
       deployment.deployment.id
@@ -44,45 +56,50 @@ async function createDeploy(config) {
     outputSuccess(
       `Deployment complete.
 ${urlMessage} preview URL: ${deploymentCompleteOp.deployment.url}`,
-      stderrLogger
+      logger
     );
     if (metadata.name !== "none") {
       outputInfo(deploymentCompleteOp.deployment.url);
     }
+    return deploymentCompleteOp.deployment.url;
   } catch (error) {
     if (!(error instanceof Error)) {
       console.error("Unknown error", error);
-      return;
+      return Promise.reject(new Error("Unknown error"));
     }
     if (build.id && !buildCompleted) {
       outputWarn(
         `Build failed with: ${error.message}, cancelling build.`,
-        stderrLogger
+        logger
       );
-      await buildCancel(config, build.id, error.message).catch((err) => {
+      await buildCancel({
+        config,
+        buildId: build.id,
+        reason: error.message,
+        logger
+      }).catch((err) => {
         if (err instanceof Error) {
-          outputWarn(`Failed to cancel build: ${err.message}`, stderrLogger);
+          outputWarn(`Failed to cancel build: ${err.message}`, logger);
         }
       });
     } else if (deployment?.deployment.id) {
       outputWarn(
         `Deployment failed with: ${error.message}, cancelling deployment.`,
-        stderrLogger
+        logger
       );
-      await deploymentCancel(
+      await deploymentCancel({
         config,
-        deployment.deployment.id,
-        DeploymentCancelReason.Failed
-      ).catch((err) => {
+        deploymentId: deployment.deployment.id,
+        reason: DeploymentCancelReason.Failed,
+        logger
+      }).catch((err) => {
         if (err instanceof Error) {
-          outputWarn(
-            `Failed to cancel deployment: ${err.message}`,
-            stderrLogger
-          );
+          outputWarn(`Failed to cancel deployment: ${err.message}`, logger);
         }
       });
     }
     consoleError(error.message);
+    return Promise.reject(error);
   }
 }
 

package/dist/deploy/metadata.d.ts

@@ -1,11 +1,12 @@
 import { CIMetadata } from '@shopify/cli-kit/node/context/local';
-import { DeployConfig, EnvironmentInput } from './types.js';
+import { Logger } from '@shopify/cli-kit/node/output';
+import { DeploymentConfig, EnvironmentInput } from './types.js';
 
 type Metadata = CIMetadata & {
     name: string;
 };
-declare function getMetadata(config: DeployConfig): Promise<Metadata>;
-declare function getEnvironmentInput(config: DeployConfig, metadata: CIMetadata): EnvironmentInput | undefined;
+declare function getMetadata(config: DeploymentConfig, logger: Logger): Promise<Metadata>;
+declare function getEnvironmentInput(config: DeploymentConfig, metadata: CIMetadata): EnvironmentInput | undefined;
 declare function createLabels(metadata: Metadata): string[];
 
 export { createLabels, getEnvironmentInput, getMetadata };

package/dist/deploy/metadata.js

@@ -1,9 +1,9 @@
 import { ciPlatform } from '@shopify/cli-kit/node/context/local';
 import { getLatestGitCommit } from '@shopify/cli-kit/node/git';
 import { outputWarn } from '@shopify/cli-kit/node/output';
-import { stderrLogger, maxLabelLength } from '../utils/utils.js';
+import { maxLabelLength } from '../utils/utils.js';
 
-async function getMetadata(config) {
+async function getMetadata(config, logger) {
   const ciInfo = ciPlatform();
   let metadata = {};
   if (ciInfo.isCI && ciInfo.name !== "unknown") {
@@ -19,7 +19,7 @@ async function getMetadata(config) {
         commitMessage: gitCommit.message
       };
     } catch (error) {
-      outputWarn("No CI metadata loaded from environment", stderrLogger);
+      outputWarn("No CI metadata loaded from environment", logger);
     }
   }
   return {

package/dist/deploy/metadata.test.js

@@ -1,7 +1,7 @@
 import { getLatestGitCommit } from '@shopify/cli-kit/node/git';
 import { ciPlatform } from '@shopify/cli-kit/node/context/local';
 import { vi, describe, test, expect } from 'vitest';
-import { maxLabelLength } from '../utils/utils.js';
+import { stderrLogger, maxLabelLength } from '../utils/utils.js';
 import { createTestConfig } from '../utils/test-helper.js';
 import { getMetadata, getEnvironmentInput, createLabels } from './metadata.js';
 
@@ -19,7 +19,7 @@ describe("getMetadata", () => {
       }
     });
     const testConfig = createTestConfig("/tmp/deploymentRoot/");
-    const metadataResult = await getMetadata(testConfig);
+    const metadataResult = await getMetadata(testConfig, stderrLogger);
     expect(metadataResult.actor).toBe("circle_actor");
     expect(metadataResult.commitSha).toBe("circle_sha");
     expect(metadataResult.name).toBe("circle");
@@ -41,7 +41,7 @@ describe("getMetadata", () => {
       version: "custom_version",
       url: "custom_url"
     };
-    const metadataResult = await getMetadata(testConfig);
+    const metadataResult = await getMetadata(testConfig, stderrLogger);
     expect(metadataResult.actor).toBe("custom_user");
     expect(metadataResult.commitSha).toBe("custom_version");
     expect(metadataResult.name).toBe("circle");
@@ -61,7 +61,7 @@ describe("getMetadata", () => {
       body: "gh_body"
     });
     const testConfig = createTestConfig("/tmp/deploymentRoot/");
-    const metadataResult = await getMetadata(testConfig);
+    const metadataResult = await getMetadata(testConfig, stderrLogger);
     expect(metadataResult.actor).toBe("gh_author");
     expect(metadataResult.commitSha).toBe("gh_hash");
     expect(metadataResult.name).toBe("none");

package/dist/deploy/types.d.ts

@@ -5,9 +5,17 @@ interface Build {
 interface ClientError extends Error {
     statusCode: number;
 }
-interface DeployConfig {
+interface DeploymentHooks {
+    onBuildStart?: () => void;
+    onBuildComplete?: () => void;
+    onBuildError?: (error: Error) => void;
+    onUploadFilesStart?: () => void;
+    onUploadFilesComplete?: () => void;
+}
+interface DeploymentConfig {
     assetsDir?: string;
     buildCommand: string;
+    buildOutput: boolean;
     deploymentToken: DeploymentToken;
     deploymentUrl: string;
     environmentTag?: string;
@@ -50,4 +58,4 @@ interface OxygenError {
     message: string;
 }
 
-export { Build, ClientError, DeployConfig, DeploymentManifestFile, DeploymentToken, EnvironmentInput, FileType, OxygenError };
+export { Build, ClientError, DeploymentConfig, DeploymentHooks, DeploymentManifestFile, DeploymentToken, EnvironmentInput, FileType, OxygenError };

package/dist/deploy/upload-files.d.ts

@@ -1,6 +1,13 @@
-import { DeployConfig } from './types.js';
+import { Logger } from '@shopify/cli-kit/node/output';
+import { DeploymentConfig, DeploymentHooks } from './types.js';
 import { DeploymentTargetResponse } from './graphql/deployment-initiate.js';
 
-declare function uploadFiles(config: DeployConfig, targets: DeploymentTargetResponse[]): Promise<void>;
+interface UploadFilesOptions {
+    config: DeploymentConfig;
+    hooks?: DeploymentHooks;
+    logger: Logger;
+    targets: DeploymentTargetResponse[];
+}
+declare function uploadFiles(options: UploadFilesOptions): Promise<void>;
 
 export { uploadFiles };

package/dist/deploy/upload-files.js

@@ -3,14 +3,17 @@ import { createFileReadStream } from '@shopify/cli-kit/node/fs';
 import { outputInfo, outputCompleted } from '@shopify/cli-kit/node/output';
 import { joinPath } from '@shopify/cli-kit/node/path';
 import { mapLimit } from 'async';
-import { stderrLogger, deployDefaults } from '../utils/utils.js';
+import { deployDefaults } from '../utils/utils.js';
 
-async function uploadFiles(config, targets) {
-  outputInfo(`Uploading ${targets.length} files...`, stderrLogger);
+async function uploadFiles(options) {
+  const { config, logger, targets, hooks } = options;
+  outputInfo(`Uploading ${targets.length} files...`, logger);
+  hooks?.onUploadFilesStart?.();
   return mapLimit(targets, 6, async (target) => {
     await uploadFile(config, target);
   }).then(() => {
-    outputCompleted(`Files uploaded successfully`, stderrLogger);
+    hooks?.onUploadFilesComplete?.();
+    outputCompleted(`Files uploaded successfully`, logger);
   });
 }
 async function uploadFile(config, target) {

package/dist/deploy/upload-files.test.js

@@ -3,7 +3,7 @@ import { fetch } from '@shopify/cli-kit/node/http';
 import { vi, describe, beforeEach, it, expect } from 'vitest';
 import { Response } from 'node-fetch';
 import { createTestConfig } from '../utils/test-helper.js';
-import { deployDefaults } from '../utils/utils.js';
+import { stderrLogger, deployDefaults } from '../utils/utils.js';
 import { uploadFiles } from './upload-files.js';
 
 class NamedReadable extends Readable {
@@ -29,22 +29,16 @@ vi.mock("@shopify/cli-kit/node/fs", () => {
     })
   };
 });
-vi.mock("fs", () => {
-  return {
-    createReadStream: vi.fn(() => {
-      const readable = new NamedReadable();
-      readable.push("dummy");
-      readable.emit("end");
-      return readable;
-    })
-  };
-});
 const testConfig = createTestConfig("/tmp/deploymentRoot");
 describe("UploadFiles", () => {
   beforeEach(() => {
     vi.mocked(fetch).mockReset();
   });
   it("Performs a form upload", async () => {
+    const hooks = {
+      onUploadFilesStart: vi.fn(),
+      onUploadFilesComplete: vi.fn()
+    };
     const response = new Response();
     vi.mocked(fetch).mockResolvedValueOnce(response);
     const testWorkerUpload = [
@@ -56,7 +50,12 @@ describe("UploadFiles", () => {
         parameters: [{ name: "someName", value: "someValue" }]
       }
     ];
-    await uploadFiles(testConfig, testWorkerUpload);
+    await uploadFiles({
+      config: testConfig,
+      targets: testWorkerUpload,
+      logger: stderrLogger,
+      hooks
+    });
     expect(vi.mocked(fetch)).toHaveBeenCalledTimes(1);
     expect(vi.mocked(fetch)).toHaveBeenCalledWith(
       "https://storage.googleapis.com/the-bucket/",
@@ -73,6 +72,8 @@ describe("UploadFiles", () => {
         })
       })
     );
+    expect(hooks.onUploadFilesStart).toBeCalled();
+    expect(hooks.onUploadFilesComplete).toBeCalled();
   });
   it("Retries a failed form upload until the max upload attempts then throws", async () => {
     vi.mocked(fetch).mockRejectedValue(new Error("some error"));
@@ -85,9 +86,13 @@ describe("UploadFiles", () => {
         parameters: [{ name: "someName", value: "someValue" }]
       }
     ];
-    await expect(uploadFiles(testConfig, testWorkerUpload)).rejects.toThrow(
-      "Failed to upload file index.js"
-    );
+    await expect(
+      uploadFiles({
+        config: testConfig,
+        targets: testWorkerUpload,
+        logger: stderrLogger
+      })
+    ).rejects.toThrow("Failed to upload file index.js");
     expect(vi.mocked(fetch)).toHaveBeenCalledTimes(
       Number(deployDefaults.maxUploadAttempts) + 1
     );
@@ -108,7 +113,11 @@ describe("UploadFiles", () => {
         parameters: null
       }
     ];
-    await uploadFiles(testConfig, testWorkerUpload);
+    await uploadFiles({
+      config: testConfig,
+      targets: testWorkerUpload,
+      logger: stderrLogger
+    });
     expect(vi.mocked(fetch)).toHaveBeenCalledTimes(2);
     const secondCall = vi.mocked(fetch).mock.calls[1];
     expect(secondCall[0]).toBe("https://upload-it-here.com/");
@@ -145,7 +154,11 @@ describe("UploadFiles", () => {
         parameters: null
       }
     ];
-    await uploadFiles(testConfig, testWorkerUpload);
+    await uploadFiles({
+      config: testConfig,
+      targets: testWorkerUpload,
+      logger: stderrLogger
+    });
     expect(vi.mocked(fetch)).toHaveBeenCalledTimes(4);
     const statusCall = vi.mocked(fetch).mock.calls[2];
     expect(statusCall[0]).toBe("https://upload-it-here.com/");
@@ -183,7 +196,13 @@ describe("UploadFiles", () => {
         parameters: null
       }
     ];
-    await expect(uploadFiles(testConfig, testWorkerUpload)).rejects.toThrow(
+    await expect(
+      uploadFiles({
+        config: testConfig,
+        targets: testWorkerUpload,
+        logger: stderrLogger
+      })
+    ).rejects.toThrow(
       `Failed to upload file index.js after ${deployDefaults.maxResumabeUploadAttempts} attempts`
     );
     expect(vi.mocked(fetch)).toHaveBeenCalledTimes(

package/dist/utils/test-helper.d.ts

@@ -1,4 +1,4 @@
-import { DeployConfig } from '../deploy/types.js';
+import { DeploymentConfig } from '../deploy/types.js';
 
 declare const testToken: {
     accessToken: string;
@@ -9,6 +9,6 @@ declare const testToken: {
     namespace: string;
     namespaceId: string;
 };
-declare function createTestConfig(rootFolder: string): DeployConfig;
+declare function createTestConfig(rootFolder: string): DeploymentConfig;
 
 export { createTestConfig, testToken };

package/dist/utils/test-helper.js

@@ -13,6 +13,7 @@ function createTestConfig(rootFolder) {
   return {
     assetsDir: "/assets/",
     buildCommand: String(deployDefaults.buildCommandDefault),
+    buildOutput: true,
     deploymentToken: testToken,
     environmentTag: "environment",
     deploymentUrl: "https://localhost:3000",

package/dist/utils/utils.d.ts

@@ -1,10 +1,10 @@
-import { DeployConfig, ClientError, DeploymentToken } from '../deploy/types.js';
+import { DeploymentConfig, ClientError, DeploymentToken } from '../deploy/types.js';
 
 declare const deployDefaults: {
     [key: string]: string | number;
 };
 declare function errorHandler(error: any): void;
-declare function getBuildCommandFromLockFile(config: DeployConfig): string;
+declare function getBuildCommandFromLockFile(config: DeploymentConfig): string;
 declare enum Header {
     OxygenNamespaceHandle = "X-Oxygen-Namespace-Handle"
 }
@@ -13,7 +13,7 @@ declare function stderrLogger(log: string): void;
 declare const maxLabelLength = 90;
 declare function parseToken(inputToken: string): DeploymentToken;
 interface VerifyConfigParams {
-    config: DeployConfig;
+    config: DeploymentConfig;
     performedBuild?: boolean;
 }
 declare function verifyConfig({ config, performedBuild, }: VerifyConfigParams): Promise<void>;

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.1",
+  "version": "1.5.0",
   "commands": {
     "oxygen:deploy": {
       "id": "oxygen:deploy",
@@ -19,10 +19,10 @@
           "required": true,
           "multiple": false
         },
-        "rootPath": {
-          "name": "rootPath",
+        "path": {
+          "name": "path",
           "type": "option",
-          "char": "r",
+          "char": "p",
           "description": "Root path",
           "required": false,
           "multiple": false,
@@ -82,7 +82,6 @@
         "publicDeployment": {
           "name": "publicDeployment",
           "type": "boolean",
-          "char": "p",
           "description": "Marks a preview deployment as publicly accessible.",
           "required": false,
           "allowNo": false

package/package.json

@@ -5,7 +5,7 @@
     "@shopify:registry": "https://registry.npmjs.org"
   },
   "license": "MIT",
-  "version": "1.3.1",
+  "version": "1.5.0",
   "type": "module",
   "scripts": {
     "build": "tsup --clean --config ./tsup.config.ts && oclif manifest",
@@ -31,8 +31,8 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@oclif/core": "2.8.6",
-    "@shopify/cli-kit": "^3.46.0",
+    "@oclif/core": "2.8.11",
+    "@shopify/cli-kit": "^3.46.5",
     "async": "^3.2.4"
   },
   "devDependencies": {
@@ -40,15 +40,15 @@
     "@shopify/eslint-plugin": "^42.1.0",
     "@shopify/prettier-config": "^1.1.2",
     "@types/async": "^3.2.18",
-    "@types/node": "^18.15.11",
+    "@types/node": "^20.3.1",
     "@types/prettier": "^2.7.3",
-    "eslint": "^8.42.0",
+    "eslint": "^8.43.0",
     "node-fetch": "^3.3.1",
     "oclif": "^3",
-    "tsup": "^6.7.0",
+    "tsup": "^7.1.0",
     "typescript": "^5.1.3",
     "vite": "^4.3.9",
-    "vitest": "^0.32.0"
+    "vitest": "^0.32.2"
   },
   "prettier": "@shopify/prettier-config",
   "oclif": {