@shopify/oxygen-cli 1.4.0 → 1.6.0

package/README.md

@@ -42,6 +42,8 @@ oxygen:deploy [options]
 - -o, --workerOnly: Worker only deployment.
 - -s, --skipBuild: Skip running build command.
 - -b, --buildCommand <buildCommand>: Build command (default: `yarn build`).
+- -h, --skipHealthCheck: Skip running the health check on the deployment
+- -d, --healthCheckMaxDuration: The maximum duration (in seconds) that the health check is allowed to run before it is considered failed. Accepts values between 10 and 300.
 - --publicDeployment: set the deployment to be publicly accessible.
 - --metadataUrl <metadataUrl>: URL that links to the deployment.
 - --metadataUser <metadataUser>: User that initiated the deployment.

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

@@ -1,20 +1,21 @@
 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';
 
 declare class Deploy extends Command {
     static description: string;
     static hidden: boolean;
     static flags: {
-        token: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _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>;
-        workerOnly: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
-        skipBuild: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
         buildCommand: _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>;
+        healthCheckMaxDuration: _oclif_core_lib_interfaces_parser_js.OptionFlag<number, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
+        path: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         publicDeployment: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
+        skipBuild: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
+        skipHealthCheck: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
+        token: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
+        workerFolder: _oclif_core_lib_interfaces_parser_js.OptionFlag<string, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
+        workerOnly: _oclif_core_lib_interfaces_parser_js.BooleanFlag<boolean>;
         metadataUrl: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         metadataUser: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
         metadataVersion: _oclif_core_lib_interfaces_parser_js.OptionFlag<string | undefined, _oclif_core_lib_interfaces_parser_js.CustomOptions>;
@@ -22,6 +23,5 @@ declare class Deploy extends Command {
     static hasCustomBuildCommand: boolean;
     run(): Promise<void>;
 }
-declare function runInit(options: DeployConfig): void;
 
-export { Deploy, runInit };
+export { Deploy };

package/dist/commands/oxygen/deploy.js

@@ -3,52 +3,18 @@ import { consoleError } from '@shopify/cli-kit/node/output';
 import { normalizePath } from '@shopify/cli-kit/node/path';
 import { createDeploy } from '../../deploy/index.js';
 import { deployDefaults, parseToken, verifyConfig, getBuildCommandFromLockFile } from '../../utils/utils.js';
+import { HealthCheckError } from '../../deploy/types.js';
 
 class Deploy extends Command {
   static description = "Creates a deployment to Oxygen";
   static hidden = false;
   static flags = {
-    token: Flags.string({
-      char: "t",
-      description: "Oxygen deployment token",
-      env: "OXYGEN_DEPLOYMENT_TOKEN",
-      required: false
-    }),
-    path: Flags.string({
-      char: "p",
-      description: "Root path",
-      default: "./",
-      required: false
-    }),
-    environmentTag: Flags.string({
-      char: "e",
-      description: "Tag of the environment to deploy to",
-      required: false
-    }),
-    workerFolder: Flags.string({
-      char: "w",
-      description: "Worker folder",
-      default: String(deployDefaults.workerDirDefault),
-      required: false
-    }),
     assetsFolder: Flags.string({
       char: "a",
       description: "Assets folder",
       default: String(deployDefaults.assetsDirDefault),
       required: false
     }),
-    workerOnly: Flags.boolean({
-      char: "o",
-      description: "Worker only deployment",
-      default: false,
-      required: false
-    }),
-    skipBuild: Flags.boolean({
-      char: "s",
-      description: "Skip running build command",
-      required: false,
-      default: false
-    }),
     buildCommand: Flags.string({
       char: "b",
       description: "Build command",
@@ -59,12 +25,61 @@ class Deploy extends Command {
         return Promise.resolve(input);
       }
     }),
+    environmentTag: Flags.string({
+      char: "e",
+      description: "Tag of the environment to deploy to",
+      required: false
+    }),
+    healthCheckMaxDuration: Flags.integer({
+      char: "d",
+      description: "the maximum duration (in seconds) that the health check is allowed to run before it is considered failed.",
+      min: 10,
+      max: 300,
+      required: false,
+      default: deployDefaults.healthCheckMaxDurationDefault
+    }),
+    path: Flags.string({
+      char: "p",
+      description: "Root path",
+      default: "./",
+      required: false
+    }),
     publicDeployment: Flags.boolean({
       env: "OXYGEN_PUBLIC_DEPLOYMENT",
       description: "Marks a preview deployment as publicly accessible.",
       required: false,
       default: false
     }),
+    skipBuild: Flags.boolean({
+      char: "s",
+      description: "Skip running build command",
+      required: false,
+      default: false
+    }),
+    skipHealthCheck: Flags.boolean({
+      char: "h",
+      description: "Skip running deployment health check",
+      required: false,
+      default: false
+    }),
+    token: Flags.string({
+      char: "t",
+      description: "Oxygen deployment token",
+      env: "OXYGEN_DEPLOYMENT_TOKEN",
+      required: true
+    }),
+    workerFolder: Flags.string({
+      char: "w",
+      description: "Worker folder",
+      default: String(deployDefaults.workerDirDefault),
+      required: false
+    }),
+    workerOnly: Flags.boolean({
+      char: "o",
+      description: "Worker only deployment",
+      default: false,
+      required: false
+    }),
     metadataUrl: Flags.string({
       description: "URL that links to the deployment. Will be saved and displayed in the Shopify admin",
       required: false,
@@ -92,9 +107,11 @@ class Deploy extends Command {
       const config = {
         assetsDir: normalizePath(flags.assetsFolder),
         buildCommand: flags.buildCommand,
+        buildOutput: true,
         deploymentToken: parseToken(flags.token),
         environmentTag: flags.environmentTag,
         deploymentUrl,
+        healthCheckMaxDuration: flags.healthCheckMaxDuration,
         metadata: {
           url: flags.metadataUrl,
           user: flags.metadataUser,
@@ -103,6 +120,7 @@ class Deploy extends Command {
         publicDeployment: flags.publicDeployment,
         rootPath: normalizePath(flags.path),
         skipBuild: flags.skipBuild,
+        skipHealthCheck: flags.skipHealthCheck,
         workerDir: normalizePath(flags.workerFolder),
         workerOnly: flags.workerOnly
       };
@@ -110,19 +128,16 @@ class Deploy extends Command {
       if (!Deploy.hasCustomBuildCommand && !config.skipBuild) {
         config.buildCommand = getBuildCommandFromLockFile(config);
       }
-      runInit(config);
+      await createDeploy({ config });
     } catch (error) {
-      if (error instanceof Error) {
+      if (!(error instanceof Error)) {
+        consoleError(error);
+      } else if (!(error instanceof HealthCheckError)) {
         consoleError(error.message);
-      } else {
-        console.error(error);
       }
       this.exit(1);
     }
   }
 }
-function runInit(options) {
-  createDeploy(options);
-}
 
-export { Deploy, runInit };
+export { Deploy };

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 };