@shopify/oxygen-cli 3.0.1-unstable.202311291846.0 → 3.1.1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @shopify/oxygen-cli
 
+## 3.1.1
+
+### Patch Changes
+
+- 57f8ad5: Fixes
+
+## 3.1.0
+
+### Minor Changes
+
+- 61dc304: Add deployment completion verification step that allows for faster feedback of the deployment status
+
 ## 3.0.0
 
 ### Major Changes

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

@@ -1,6 +1,7 @@
 import { Logger } from '@shopify/cli-kit/node/output';
 import { DeploymentConfig } from './types.js';
 import { BuildCancelResponse } from './graphql/build-cancel.js';
+import './graphql/deployment-verification-details.js';
 
 interface BuildCancelOptions {
     config: DeploymentConfig;

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

@@ -1,6 +1,7 @@
 import { Logger } from '@shopify/cli-kit/node/output';
 import { DeploymentConfig, EnvironmentInput } from './types.js';
 import { BuildInitiateResponse } from './graphql/build-initiate.js';
+import './graphql/deployment-verification-details.js';
 
 interface BuildInitiateOptions {
     config: DeploymentConfig;

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

@@ -1,5 +1,6 @@
 import { MetricsExporter } from '../utils/metrics-exporter.js';
 import { DeploymentConfig, DeploymentHooks } from './types.js';
+import './graphql/deployment-verification-details.js';
 
 interface BuildProjectOptions {
     config: DeploymentConfig;

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

@@ -1,6 +1,7 @@
 import { Logger } from '@shopify/cli-kit/node/output';
 import { DeploymentConfig } from './types.js';
 import { DeploymentCancelResponse } from './graphql/deployment-cancel.js';
+import './graphql/deployment-verification-details.js';
 
 interface DeploymentCancelOptions {
     config: DeploymentConfig;

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

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

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

@@ -1,6 +1,7 @@
 import { Logger } from '@shopify/cli-kit/node/output';
 import { DeploymentConfig, DeploymentManifestFile, EnvironmentInput } from './types.js';
 import { DeploymentInitiateResponse } from './graphql/deployment-initiate.js';
+import './graphql/deployment-verification-details.js';
 
 type DeploymentInitiateInput = {
     buildId: string;

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

@@ -1,5 +1,6 @@
 import { MetricsExporter } from '../utils/metrics-exporter.js';
 import { DeploymentConfig, DeploymentManifestFile } from './types.js';
+import './graphql/deployment-verification-details.js';
 
 declare function getUploadFiles(config: DeploymentConfig, metricsExporter?: MetricsExporter): Promise<DeploymentManifestFile[]>;
 

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

@@ -1,4 +1,5 @@
 import { OxygenError } from '../types.js';
+import './deployment-verification-details.js';
 
 declare const BuildCancelQuery = "\n  mutation BuildCancel($buildId: ID!, $reason: String!) {\n    buildCancel(id: $buildId, reason: $reason) {\n      build {\n        id\n      }\n      userErrors {\n        message\n      }\n    }\n  }\n";
 interface BuildCancelQueryData {

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

@@ -1,4 +1,5 @@
 import { OxygenError } from '../types.js';
+import './deployment-verification-details.js';
 
 declare const BuildInitiateQuery = "\n  mutation BuildInitiate($environment: EnvironmentSelectorInput, $labels: [String!]) {\n    buildInitiate(environment: $environment, labels: $labels) {\n      build {\n        id\n        assetPath\n      }\n      userErrors {\n        message\n      }\n    }\n  }\n";
 interface BuildInitiateQueryData {

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

@@ -1,4 +1,5 @@
 import { OxygenError } from '../types.js';
+import './deployment-verification-details.js';
 
 declare const DeploymentCancelQuery = "\nmutation DeploymentCancel($deploymentId: ID!, $reason: String!) {\n  deploymentCancel(id: $deploymentId, reason: $reason) {\n    deployment {\n      id\n    }\n    userErrors {\n      message\n    }\n  }\n}\n";
 interface DeploymentCancelQueryData {

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

@@ -1,4 +1,5 @@
 import { OxygenError } from '../types.js';
+import './deployment-verification-details.js';
 
 declare const DeploymentCompleteQuery = "\n  mutation DeploymentComplete($deploymentId: ID!, $generateAuthBypassToken: Boolean) {\n    deploymentComplete(id: $deploymentId, generateAuthBypassToken: $generateAuthBypassToken) {\n      deployment {\n        id\n        url\n      }\n      authBypassToken\n      userErrors {\n        message\n      }\n    }\n  }\n";
 interface DeploymentCompleteQueryData {

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

@@ -1,12 +1,14 @@
 import { OxygenError } from '../types.js';
+import './deployment-verification-details.js';
 
-declare const DeploymentInitiateQuery = "\n  mutation DeploymentInitiate($buildId: ID, $environment: EnvironmentSelectorInput, $labels: [String!], $files: [FileInput!]!, $isPrivate: Boolean) {\n    deploymentInitiate(buildId: $buildId, environment: $environment, labels: $labels, files: $files, isPrivate: $isPrivate) {\n      deployment {\n        id\n      }\n      deploymentTargets {\n        filePath\n        fileSize\n        uploadUrl\n        fileType\n        parameters {\n          name\n          value\n        }\n      }\n      userErrors {\n        message\n      }\n    }\n  }\n";
+declare const DeploymentInitiateQuery = "\n  mutation DeploymentInitiate($buildId: ID, $environment: EnvironmentSelectorInput, $labels: [String!], $files: [FileInput!]!, $isPrivate: Boolean) {\n    deploymentInitiate(buildId: $buildId, environment: $environment, labels: $labels, files: $files, isPrivate: $isPrivate) {\n      deployment {\n        id\n      }\n      deploymentTargets {\n        filePath\n        fileSize\n        uploadUrl\n        fileType\n        parameters {\n          name\n          value\n        }\n      }\n      deploymentConfiguration {\n        timeoutInSeconds\n      }\n      userErrors {\n        message\n      }\n    }\n  }\n";
 interface DeploymentInitiateQueryData {
     deploymentInitiate: DeploymentInitiateResponse;
 }
 interface DeploymentInitiateResponse {
     deployment: Deployment;
     deploymentTargets: DeploymentTargetResponse[];
+    deploymentConfiguration: DeploymentConfigurationResponse;
     userErrors: OxygenError[];
 }
 interface DeploymentTargetResponse {
@@ -16,6 +18,9 @@ interface DeploymentTargetResponse {
     fileType: string;
     parameters: DeploymentInitiateParameters[] | null;
 }
+interface DeploymentConfigurationResponse {
+    timeoutInSeconds: number;
+}
 interface Deployment {
     id: string;
 }
@@ -24,4 +29,4 @@ interface DeploymentInitiateParameters {
     value: string;
 }
 
-export { DeploymentInitiateQuery, type DeploymentInitiateQueryData, type DeploymentInitiateResponse, type DeploymentTargetResponse };
+export { type DeploymentConfigurationResponse, DeploymentInitiateQuery, type DeploymentInitiateQueryData, type DeploymentInitiateResponse, type DeploymentTargetResponse };

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

@@ -14,6 +14,9 @@ const DeploymentInitiateQuery = `
           value
         }
       }
+      deploymentConfiguration {
+        timeoutInSeconds
+      }
       userErrors {
         message
       }

package/dist/deploy/graphql/deployment-initiate.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../src/deploy/graphql/deployment-initiate.ts"],"names":[],"mappings":"AAEO,MAAM,0BAA0B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA","sourcesContent":["import {OxygenError} from '../types.js';\n\nexport const DeploymentInitiateQuery = `\n  mutation DeploymentInitiate($buildId: ID, $environment: EnvironmentSelectorInput, $labels: [String!], $files: [FileInput!]!, $isPrivate: Boolean) {\n    deploymentInitiate(buildId: $buildId, environment: $environment, labels: $labels, files: $files, isPrivate: $isPrivate) {\n      deployment {\n        id\n      }\n      deploymentTargets {\n        filePath\n        fileSize\n        uploadUrl\n        fileType\n        parameters {\n          name\n          value\n        }\n      }\n      userErrors {\n        message\n      }\n    }\n  }\n`;\n\nexport interface DeploymentInitiateQueryData {\n  deploymentInitiate: DeploymentInitiateResponse;\n}\n\nexport interface DeploymentInitiateResponse {\n  deployment: Deployment;\n  deploymentTargets: DeploymentTargetResponse[];\n  userErrors: OxygenError[];\n}\n\nexport interface DeploymentTargetResponse {\n  filePath: string;\n  fileSize: number;\n  uploadUrl: string;\n  fileType: string;\n  parameters: DeploymentInitiateParameters[] | null;\n}\n\ninterface Deployment {\n  id: string;\n}\n\ninterface DeploymentInitiateParameters {\n  name: string;\n  value: string;\n}\n"]}
+{"version":3,"sources":["../../../src/deploy/graphql/deployment-initiate.ts"],"names":[],"mappings":"AAEO,MAAM,0BAA0B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA","sourcesContent":["import {OxygenError} from '../types.js';\n\nexport const DeploymentInitiateQuery = `\n  mutation DeploymentInitiate($buildId: ID, $environment: EnvironmentSelectorInput, $labels: [String!], $files: [FileInput!]!, $isPrivate: Boolean) {\n    deploymentInitiate(buildId: $buildId, environment: $environment, labels: $labels, files: $files, isPrivate: $isPrivate) {\n      deployment {\n        id\n      }\n      deploymentTargets {\n        filePath\n        fileSize\n        uploadUrl\n        fileType\n        parameters {\n          name\n          value\n        }\n      }\n      deploymentConfiguration {\n        timeoutInSeconds\n      }\n      userErrors {\n        message\n      }\n    }\n  }\n`;\n\nexport interface DeploymentInitiateQueryData {\n  deploymentInitiate: DeploymentInitiateResponse;\n}\n\nexport interface DeploymentInitiateResponse {\n  deployment: Deployment;\n  deploymentTargets: DeploymentTargetResponse[];\n  deploymentConfiguration: DeploymentConfigurationResponse;\n  userErrors: OxygenError[];\n}\n\nexport interface DeploymentTargetResponse {\n  filePath: string;\n  fileSize: number;\n  uploadUrl: string;\n  fileType: string;\n  parameters: DeploymentInitiateParameters[] | null;\n}\n\nexport interface DeploymentConfigurationResponse {\n  timeoutInSeconds: number;\n}\n\ninterface Deployment {\n  id: string;\n}\n\ninterface DeploymentInitiateParameters {\n  name: string;\n  value: string;\n}\n"]}

package/dist/deploy/graphql/deployment-verification-details.d.ts

@@ -0,0 +1,17 @@
+declare const DeploymentVerificationDetailsQuery = "\n  query DeploymentVerificationDetails($deploymentId: ID!) {\n    deploymentVerificationDetails(id: $deploymentId) {\n      url\n      status\n      error\n    }\n  }\n";
+interface DeploymentVerificationDetailsQueryData {
+    deploymentVerificationDetails: DeploymentVerificationDetailsResponse;
+}
+interface DeploymentVerificationDetailsResponse {
+    url: string;
+    status: string;
+    error?: string;
+}
+declare enum Status {
+    Pending = "PENDING",
+    Deployed = "DEPLOYED",
+    Failed = "FAILED",
+    Cancelled = "CANCELLED"
+}
+
+export { DeploymentVerificationDetailsQuery, type DeploymentVerificationDetailsQueryData, type DeploymentVerificationDetailsResponse, Status };

package/dist/deploy/graphql/deployment-verification-details.js

@@ -0,0 +1,20 @@
+const DeploymentVerificationDetailsQuery = `
+  query DeploymentVerificationDetails($deploymentId: ID!) {
+    deploymentVerificationDetails(id: $deploymentId) {
+      url
+      status
+      error
+    }
+  }
+`;
+var Status = /* @__PURE__ */ ((Status2) => {
+  Status2["Pending"] = "PENDING";
+  Status2["Deployed"] = "DEPLOYED";
+  Status2["Failed"] = "FAILED";
+  Status2["Cancelled"] = "CANCELLED";
+  return Status2;
+})(Status || {});
+
+export { DeploymentVerificationDetailsQuery, Status };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=deployment-verification-details.js.map

package/dist/deploy/graphql/deployment-verification-details.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/deploy/graphql/deployment-verification-details.ts"],"names":["Status"],"mappings":"AAAO,MAAM,qCAAqC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAoB3C,IAAK,SAAL,kBAAKA,YAAL;AACL,EAAAA,QAAA,aAAU;AACV,EAAAA,QAAA,cAAW;AACX,EAAAA,QAAA,YAAS;AACT,EAAAA,QAAA,eAAY;AAJF,SAAAA;AAAA,GAAA","sourcesContent":["export const DeploymentVerificationDetailsQuery = `\n  query DeploymentVerificationDetails($deploymentId: ID!) {\n    deploymentVerificationDetails(id: $deploymentId) {\n      url\n      status\n      error\n    }\n  }\n`;\n\nexport interface DeploymentVerificationDetailsQueryData {\n  deploymentVerificationDetails: DeploymentVerificationDetailsResponse;\n}\n\nexport interface DeploymentVerificationDetailsResponse {\n  url: string;\n  status: string;\n  error?: string;\n}\n\nexport enum Status {\n  Pending = 'PENDING',\n  Deployed = 'DEPLOYED',\n  Failed = 'FAILED',\n  Cancelled = 'CANCELLED',\n}\n"]}

package/dist/deploy/index.d.ts

@@ -1,6 +1,7 @@
 import { Logger } from '@shopify/cli-kit/node/output';
 import { DeploymentConfig, DeploymentHooks } from './types.js';
 export { parseToken } from '../utils/utils.js';
+import './graphql/deployment-verification-details.js';
 
 interface CreateDeployOptions {
     config: DeploymentConfig;

package/dist/deploy/index.js

@@ -11,7 +11,8 @@ import { deploymentComplete } from './deployment-complete.js';
 import { verifyDeployment } from './verify-deployment.js';
 import { deploymentCancel } from './deployment-cancel.js';
 import { uploadFiles } from './upload-files.js';
-import { VerificationError } from './types.js';
+import { verifyDeploymentCompleted } from './verify-deployment-completed.js';
+import { VerificationError, DeploymentCompletedVerificationError } from './types.js';
 import { buildProject } from './build-project.js';
 import { getMetadata, createLabels, getEnvironmentInput } from './metadata.js';
 
@@ -82,6 +83,15 @@ async function createDeploy(options) {
     );
     metricsExporter.add(MetricName.TotalTime, performance.now() - cliStartTime);
     await metricsExporter.export();
+    await verifyDeploymentCompleted(
+      {
+        config,
+        hooks,
+        logger,
+        timeoutInSeconds: deployment.deploymentConfiguration.timeoutInSeconds
+      },
+      deployment.deployment.id
+    );
     if (!config.skipVerification) {
       await verifyDeployment({
         config,
@@ -113,7 +123,7 @@ The deployment can be reached at the ${completedDeployment.url} ${urlPrivacy} pr
       console.error("Unknown error", error);
       return Promise.reject(new Error("Unknown error"));
     }
-    if (error instanceof VerificationError) {
+    if (error instanceof VerificationError || error instanceof DeploymentCompletedVerificationError) {
       outputWarn(error.message, logger);
     } else if (build.id && !buildCompleted) {
       outputWarn(

package/dist/deploy/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/deploy/index.ts"],"names":[],"mappings":"AAAA;AAAA,EAEE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAQ,cAAc,oBAAmB;AACzC,SAAQ,YAAY,yBAAwB;AAC5C,SAAQ,iBAAiB,kBAAiB;AAE1C,SAAQ,qBAAoB;AAC5B,SAAQ,mBAAkB;AAC1B,SAAQ,sBAAqB;AAC7B,SAAQ,0BAAyB;AACjC,SAAQ,0BAAyB;AACjC,SAAQ,wBAAuB;AAC/B,SAAQ,wBAAuB;AAC/B,SAAQ,mBAAkB;AAC1B;AAAA,EAIE;AAAA,OACK;AACP,SAAQ,oBAAmB;AAC3B,SAAQ,cAAc,aAAa,2BAA0B;AAa7D,eAAsB,aACpB,SAC0C;AAC1C,QAAM,eAAe,YAAY,IAAI;AACrC,oBAAkB,CAAC,QAAQ,OAAO,OAAO;AACzC,QAAM,UAAU,WAAW;AAC3B,WAAS,YAAY,UAAU;AAAA,IAC7B,GAAG,QAAQ;AAAA,IACX,iBAAiB,EAAC,GAAG,QAAQ,OAAO,iBAAiB,aAAa,MAAK;AAAA,EACzE,CAAC;AAED,QAAM,EAAC,QAAQ,MAAK,IAAI;AACxB,QAAM,SAAS,QAAQ,UAAU;AACjC,QAAM,QAAQ,CAAC;AACf,MAAI;AACJ,MAAI;AAEJ,MAAI;AACF,UAAM,WAAW,MAAM,YAAY,QAAQ,MAAM;AACjD,UAAM,SAAS,aAAa,QAAQ;AACpC,UAAM,cAAc,oBAAoB,QAAQ,QAAQ;AACxD,aAAS,YAAY,YAAY;AAAA,MAC/B;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AACD,UAAM,kBAAkB,IAAI,gBAAgB;AAAA,MAC1C,YAAY,SAAS,QAAQ;AAAA,MAC7B,UAAU,OAAO;AAAA,IACnB,CAAC;AAED,QAAI,CAAC,OAAO,cAAc,CAAC,OAAO,WAAW;AAC3C,YAAM,wBAAwB,MAAM,cAAc;AAAA,QAChD;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AACD,YAAM,KAAK,sBAAsB,MAAM;AACvC,YAAM,YAAY,sBAAsB,MAAM;AAAA,IAChD;AAEA,QAAI,CAAC,OAAO,WAAW;AACrB,YAAM,aAAa;AAAA,QACjB;AAAA,QACA,WAAW,MAAM;AAAA,QACjB;AAAA,QACA;AAAA,MACF,CAAC;AACD,YAAM,aAAa,EAAC,QAAQ,gBAAgB,KAAI,CAAC;AAAA,IACnD;AACA,qBAAiB;AAEjB,UAAM,WAAW,MAAM,eAAe,QAAQ,eAAe;AAC7D,aAAS,YAAY,YAAY,QAAQ;AACzC,UAAM,0BAA0B,MAAM,KAClC,EAAC,SAAS,MAAM,IAAI,SAAQ,IAC5B,EAAC,aAAa,UAAU,OAAM;AAElC,iBAAa,MAAM,mBAAmB;AAAA,MACpC;AAAA,MACA,OAAO;AAAA,MACP;AAAA,IACF,CAAC;AAED,UAAM,YAAY;AAAA,MAChB;AAAA,MACA,SAAS,WAAW;AAAA,MACpB;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AACD,UAAM,uBAAuB,MAAM;AAAA,MACjC;AAAA,MACA,WAAW,WAAW;AAAA,IACxB;AACA,oBAAgB,IAAI,WAAW,WAAW,YAAY,IAAI,IAAI,YAAY;AAC1E,UAAM,gBAAgB,OAAO;AAE7B,QAAI,CAAC,OAAO,kBAAkB;AAC5B,YAAM,iBAAiB;AAAA,QACrB;AAAA,QACA,KAAK,qBAAqB,WAAW;AAAA,QACrC;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAEA,UAAM,sBAA2C;AAAA,MAC/C,KAAK,qBAAqB,WAAW;AAAA,IACvC;AAEA,UAAM,aAAa,OAAO,mBAAmB,WAAW;AAExD,QAAI,iBAAiB;AAAA,uCAA0C,oBAAoB,GAAG,IAAI,UAAU;AAEpG,QAAI,qBAAqB,iBAAiB;AACxC,0BAAoB,kBAClB,qBAAqB;AAEvB,wBAAkB,iDAAiD,oBAAoB,eAAe;AAAA,IACxG;AAEA,kBAAc,gBAAgB,MAAM;AAGpC,QAAI,SAAS,SAAS,QAAQ;AAC5B,iBAAW,KAAK,UAAU,mBAAmB,CAAC;AAAA,IAChD;AAEA,WAAO;AAAA,EACT,SAAS,OAAO;AACd,QACE,OAAO,WACP,YACC,iBAAiB,SAAS,OAAO,UAAU,WAC5C;AACA,cAAQ,OAAO,KAAK;AAAA,IACtB;AAEA,QAAI,EAAE,iBAAiB,QAAQ;AAE7B,cAAQ,MAAM,iBAAiB,KAAK;AACpC,aAAO,QAAQ,OAAO,IAAI,MAAM,eAAe,CAAC;AAAA,IAClD;AAEA,QAAI,iBAAiB,mBAAmB;AACtC,iBAAW,MAAM,SAAS,MAAM;AAAA,IAClC,WAAW,MAAM,MAAM,CAAC,gBAAgB;AACtC;AAAA,QACE,sBAAsB,MAAM,OAAO;AAAA,QACnC;AAAA,MACF;AAEA,YAAM,YAAY;AAAA,QAChB;AAAA,QACA,SAAS,MAAM;AAAA,QACf,QAAQ,MAAM;AAAA,QACd;AAAA,MACF,CAAC,EAAE,MAAM,CAAC,QAAQ;AAChB,YAAI,eAAe,OAAO;AACxB,qBAAW,2BAA2B,IAAI,OAAO,IAAI,MAAM;AAAA,QAC7D;AAAA,MACF,CAAC;AAAA,IACH,WAAW,YAAY,WAAW,IAAI;AACpC;AAAA,QACE,2BAA2B,MAAM,OAAO;AAAA,QACxC;AAAA,MACF;AACA,YAAM,iBAAiB;AAAA,QACrB;AAAA,QACA,cAAc,WAAW,WAAW;AAAA,QACpC,QAAQ,MAAM;AAAA,QACd;AAAA,MACF,CAAC,EAAE,MAAM,CAAC,QAAQ;AAChB,YAAI,eAAe,OAAO;AACxB,qBAAW,gCAAgC,IAAI,OAAO,IAAI,MAAM;AAAA,QAClE;AAAA,MACF,CAAC;AAAA,IACH;AACA,WAAO,QAAQ,OAAO,KAAK;AAAA,EAC7B;AACF;AAGA,SAAQ,kBAAiB","sourcesContent":["import {\n  Logger,\n  outputInfo,\n  outputSuccess,\n  outputWarn,\n} from '@shopify/cli-kit/node/output';\n\nimport {stderrLogger, verifyConfig} from '../utils/utils.js';\nimport {getBugsnag, initializeBugsnag} from '../utils/bugsnag.js';\nimport {MetricsExporter, MetricName} from '../utils/metrics-exporter.js';\n\nimport {buildInitiate} from './build-initiate.js';\nimport {buildCancel} from './build-cancel.js';\nimport {getUploadFiles} from './get-upload-files.js';\nimport {deploymentInitiate} from './deployment-initiate.js';\nimport {deploymentComplete} from './deployment-complete.js';\nimport {verifyDeployment} from './verify-deployment.js';\nimport {deploymentCancel} from './deployment-cancel.js';\nimport {uploadFiles} from './upload-files.js';\nimport {\n  Build,\n  DeploymentConfig,\n  DeploymentHooks,\n  VerificationError,\n} from './types.js';\nimport {buildProject} from './build-project.js';\nimport {createLabels, getMetadata, getEnvironmentInput} from './metadata.js';\n\ninterface CreateDeployOptions {\n  config: DeploymentConfig;\n  hooks?: DeploymentHooks;\n  logger?: Logger;\n}\n\ninterface CompletedDeployment {\n  url: string;\n  authBypassToken?: string;\n}\n\nexport async function createDeploy(\n  options: CreateDeployOptions,\n): Promise<CompletedDeployment | undefined> {\n  const cliStartTime = performance.now();\n  initializeBugsnag(!options.config.bugsnag);\n  const Bugsnag = getBugsnag();\n  Bugsnag?.addMetadata('config', {\n    ...options.config,\n    deploymentToken: {...options.config.deploymentToken, accessToken: '***'},\n  });\n\n  const {config, hooks} = options;\n  const logger = options.logger ?? stderrLogger;\n  const build = {} as Build;\n  let buildCompleted;\n  let deployment;\n\n  try {\n    const metadata = await getMetadata(config, logger);\n    const labels = createLabels(metadata);\n    const environment = getEnvironmentInput(config, metadata);\n    Bugsnag?.addMetadata('metadata', {\n      environment,\n      labels,\n      metadata,\n    });\n    const metricsExporter = new MetricsExporter({\n      ciProvider: metadata.name || 'unknown',\n      rootPath: config.rootPath!,\n    });\n\n    if (!config.workerOnly && !config.skipBuild) {\n      const buildInitiateResponse = await buildInitiate({\n        config,\n        environment,\n        labels,\n        logger,\n      });\n      build.id = buildInitiateResponse.build.id;\n      build.assetPath = buildInitiateResponse.build.assetPath;\n    }\n\n    if (!config.skipBuild) {\n      await buildProject({\n        config,\n        assetPath: build.assetPath,\n        hooks,\n        metricsExporter,\n      });\n      await verifyConfig({config, performedBuild: true});\n    }\n    buildCompleted = true;\n\n    const manifest = await getUploadFiles(config, metricsExporter);\n    Bugsnag?.addMetadata('manifest', manifest);\n    const deploymentInitiateInput = build.id\n      ? {buildId: build.id, manifest}\n      : {environment, manifest, labels};\n\n    deployment = await deploymentInitiate({\n      config,\n      input: deploymentInitiateInput,\n      logger,\n    });\n\n    await uploadFiles({\n      config,\n      targets: deployment.deploymentTargets,\n      hooks,\n      logger,\n      metricsExporter,\n    });\n    const deploymentCompleteOp = await deploymentComplete(\n      config,\n      deployment.deployment.id,\n    );\n    metricsExporter.add(MetricName.TotalTime, performance.now() - cliStartTime);\n    await metricsExporter.export();\n\n    if (!config.skipVerification) {\n      await verifyDeployment({\n        config,\n        url: deploymentCompleteOp.deployment.url,\n        logger,\n        hooks,\n      });\n    }\n\n    const completedDeployment: CompletedDeployment = {\n      url: deploymentCompleteOp.deployment.url,\n    };\n\n    const urlPrivacy = config.publicDeployment ? 'public' : 'private';\n\n    let successMessage = `\\nThe deployment can be reached at the ${completedDeployment.url} ${urlPrivacy} preview URL`;\n\n    if (deploymentCompleteOp.authBypassToken) {\n      completedDeployment.authBypassToken =\n        deploymentCompleteOp.authBypassToken;\n\n      successMessage += `. The auth bypass token for the deployment is ${completedDeployment.authBypassToken}`;\n    }\n\n    outputSuccess(successMessage, logger);\n\n    // in CI environments, we want to output the URL + auth bypass token to stdout\n    if (metadata.name !== 'none') {\n      outputInfo(JSON.stringify(completedDeployment));\n    }\n\n    return completedDeployment;\n  } catch (error) {\n    if (\n      config.bugsnag &&\n      Bugsnag &&\n      (error instanceof Error || typeof error === 'string')\n    ) {\n      Bugsnag.notify(error);\n    }\n\n    if (!(error instanceof Error)) {\n      // eslint-disable-next-line no-console\n      console.error('Unknown error', error);\n      return Promise.reject(new Error('Unknown error'));\n    }\n\n    if (error instanceof VerificationError) {\n      outputWarn(error.message, logger);\n    } else if (build.id && !buildCompleted) {\n      outputWarn(\n        `Build failed with: ${error.message}, cancelling build.`,\n        logger,\n      );\n\n      await buildCancel({\n        config,\n        buildId: build.id!,\n        reason: error.message,\n        logger,\n      }).catch((err) => {\n        if (err instanceof Error) {\n          outputWarn(`Failed to cancel build: ${err.message}`, logger);\n        }\n      });\n    } else if (deployment?.deployment.id) {\n      outputWarn(\n        `Deployment failed with: ${error.message}, cancelling deployment.`,\n        logger,\n      );\n      await deploymentCancel({\n        config,\n        deploymentId: deployment.deployment.id,\n        reason: error.message,\n        logger,\n      }).catch((err) => {\n        if (err instanceof Error) {\n          outputWarn(`Failed to cancel deployment: ${err.message}`, logger);\n        }\n      });\n    }\n    return Promise.reject(error);\n  }\n}\n\nexport type {DeploymentConfig, DeploymentHooks, CompletedDeployment};\nexport {parseToken} from '../utils/utils.js';\n"]}
+{"version":3,"sources":["../../src/deploy/index.ts"],"names":[],"mappings":"AAAA;AAAA,EAEE;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAEP,SAAQ,cAAc,oBAAmB;AACzC,SAAQ,YAAY,yBAAwB;AAC5C,SAAQ,iBAAiB,kBAAiB;AAE1C,SAAQ,qBAAoB;AAC5B,SAAQ,mBAAkB;AAC1B,SAAQ,sBAAqB;AAC7B,SAAQ,0BAAyB;AACjC,SAAQ,0BAAyB;AACjC,SAAQ,wBAAuB;AAC/B,SAAQ,wBAAuB;AAC/B,SAAQ,mBAAkB;AAC1B,SAAQ,iCAAgC;AACxC;AAAA,EAEE;AAAA,EAGA;AAAA,OACK;AACP,SAAQ,oBAAmB;AAC3B,SAAQ,cAAc,aAAa,2BAA0B;AAa7D,eAAsB,aACpB,SAC0C;AAC1C,QAAM,eAAe,YAAY,IAAI;AACrC,oBAAkB,CAAC,QAAQ,OAAO,OAAO;AACzC,QAAM,UAAU,WAAW;AAC3B,WAAS,YAAY,UAAU;AAAA,IAC7B,GAAG,QAAQ;AAAA,IACX,iBAAiB,EAAC,GAAG,QAAQ,OAAO,iBAAiB,aAAa,MAAK;AAAA,EACzE,CAAC;AAED,QAAM,EAAC,QAAQ,MAAK,IAAI;AACxB,QAAM,SAAS,QAAQ,UAAU;AACjC,QAAM,QAAQ,CAAC;AACf,MAAI;AACJ,MAAI;AAEJ,MAAI;AACF,UAAM,WAAW,MAAM,YAAY,QAAQ,MAAM;AACjD,UAAM,SAAS,aAAa,QAAQ;AACpC,UAAM,cAAc,oBAAoB,QAAQ,QAAQ;AACxD,aAAS,YAAY,YAAY;AAAA,MAC/B;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AACD,UAAM,kBAAkB,IAAI,gBAAgB;AAAA,MAC1C,YAAY,SAAS,QAAQ;AAAA,MAC7B,UAAU,OAAO;AAAA,IACnB,CAAC;AAED,QAAI,CAAC,OAAO,cAAc,CAAC,OAAO,WAAW;AAC3C,YAAM,wBAAwB,MAAM,cAAc;AAAA,QAChD;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,MACF,CAAC;AACD,YAAM,KAAK,sBAAsB,MAAM;AACvC,YAAM,YAAY,sBAAsB,MAAM;AAAA,IAChD;AAEA,QAAI,CAAC,OAAO,WAAW;AACrB,YAAM,aAAa;AAAA,QACjB;AAAA,QACA,WAAW,MAAM;AAAA,QACjB;AAAA,QACA;AAAA,MACF,CAAC;AACD,YAAM,aAAa,EAAC,QAAQ,gBAAgB,KAAI,CAAC;AAAA,IACnD;AACA,qBAAiB;AAEjB,UAAM,WAAW,MAAM,eAAe,QAAQ,eAAe;AAC7D,aAAS,YAAY,YAAY,QAAQ;AACzC,UAAM,0BAA0B,MAAM,KAClC,EAAC,SAAS,MAAM,IAAI,SAAQ,IAC5B,EAAC,aAAa,UAAU,OAAM;AAElC,iBAAa,MAAM,mBAAmB;AAAA,MACpC;AAAA,MACA,OAAO;AAAA,MACP;AAAA,IACF,CAAC;AAED,UAAM,YAAY;AAAA,MAChB;AAAA,MACA,SAAS,WAAW;AAAA,MACpB;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AACD,UAAM,uBAAuB,MAAM;AAAA,MACjC;AAAA,MACA,WAAW,WAAW;AAAA,IACxB;AACA,oBAAgB,IAAI,WAAW,WAAW,YAAY,IAAI,IAAI,YAAY;AAC1E,UAAM,gBAAgB,OAAO;AAE7B,UAAM;AAAA,MACJ;AAAA,QACE;AAAA,QACA;AAAA,QACA;AAAA,QACA,kBAAkB,WAAW,wBAAwB;AAAA,MACvD;AAAA,MACA,WAAW,WAAW;AAAA,IACxB;AAEA,QAAI,CAAC,OAAO,kBAAkB;AAC5B,YAAM,iBAAiB;AAAA,QACrB;AAAA,QACA,KAAK,qBAAqB,WAAW;AAAA,QACrC;AAAA,QACA;AAAA,MACF,CAAC;AAAA,IACH;AAEA,UAAM,sBAA2C;AAAA,MAC/C,KAAK,qBAAqB,WAAW;AAAA,IACvC;AAEA,UAAM,aAAa,OAAO,mBAAmB,WAAW;AAExD,QAAI,iBAAiB;AAAA,uCAA0C,oBAAoB,GAAG,IAAI,UAAU;AAEpG,QAAI,qBAAqB,iBAAiB;AACxC,0BAAoB,kBAClB,qBAAqB;AAEvB,wBAAkB,iDAAiD,oBAAoB,eAAe;AAAA,IACxG;AAEA,kBAAc,gBAAgB,MAAM;AAGpC,QAAI,SAAS,SAAS,QAAQ;AAC5B,iBAAW,KAAK,UAAU,mBAAmB,CAAC;AAAA,IAChD;AAEA,WAAO;AAAA,EACT,SAAS,OAAO;AACd,QACE,OAAO,WACP,YACC,iBAAiB,SAAS,OAAO,UAAU,WAC5C;AACA,cAAQ,OAAO,KAAK;AAAA,IACtB;AAEA,QAAI,EAAE,iBAAiB,QAAQ;AAE7B,cAAQ,MAAM,iBAAiB,KAAK;AACpC,aAAO,QAAQ,OAAO,IAAI,MAAM,eAAe,CAAC;AAAA,IAClD;AAEA,QACE,iBAAiB,qBACjB,iBAAiB,sCACjB;AACA,iBAAW,MAAM,SAAS,MAAM;AAAA,IAClC,WAAW,MAAM,MAAM,CAAC,gBAAgB;AACtC;AAAA,QACE,sBAAsB,MAAM,OAAO;AAAA,QACnC;AAAA,MACF;AAEA,YAAM,YAAY;AAAA,QAChB;AAAA,QACA,SAAS,MAAM;AAAA,QACf,QAAQ,MAAM;AAAA,QACd;AAAA,MACF,CAAC,EAAE,MAAM,CAAC,QAAQ;AAChB,YAAI,eAAe,OAAO;AACxB,qBAAW,2BAA2B,IAAI,OAAO,IAAI,MAAM;AAAA,QAC7D;AAAA,MACF,CAAC;AAAA,IACH,WAAW,YAAY,WAAW,IAAI;AACpC;AAAA,QACE,2BAA2B,MAAM,OAAO;AAAA,QACxC;AAAA,MACF;AACA,YAAM,iBAAiB;AAAA,QACrB;AAAA,QACA,cAAc,WAAW,WAAW;AAAA,QACpC,QAAQ,MAAM;AAAA,QACd;AAAA,MACF,CAAC,EAAE,MAAM,CAAC,QAAQ;AAChB,YAAI,eAAe,OAAO;AACxB,qBAAW,gCAAgC,IAAI,OAAO,IAAI,MAAM;AAAA,QAClE;AAAA,MACF,CAAC;AAAA,IACH;AACA,WAAO,QAAQ,OAAO,KAAK;AAAA,EAC7B;AACF;AAGA,SAAQ,kBAAiB","sourcesContent":["import {\n  Logger,\n  outputInfo,\n  outputSuccess,\n  outputWarn,\n} from '@shopify/cli-kit/node/output';\n\nimport {stderrLogger, verifyConfig} from '../utils/utils.js';\nimport {getBugsnag, initializeBugsnag} from '../utils/bugsnag.js';\nimport {MetricsExporter, MetricName} from '../utils/metrics-exporter.js';\n\nimport {buildInitiate} from './build-initiate.js';\nimport {buildCancel} from './build-cancel.js';\nimport {getUploadFiles} from './get-upload-files.js';\nimport {deploymentInitiate} from './deployment-initiate.js';\nimport {deploymentComplete} from './deployment-complete.js';\nimport {verifyDeployment} from './verify-deployment.js';\nimport {deploymentCancel} from './deployment-cancel.js';\nimport {uploadFiles} from './upload-files.js';\nimport {verifyDeploymentCompleted} from './verify-deployment-completed.js';\nimport {\n  Build,\n  DeploymentCompletedVerificationError,\n  DeploymentConfig,\n  DeploymentHooks,\n  VerificationError,\n} from './types.js';\nimport {buildProject} from './build-project.js';\nimport {createLabels, getMetadata, getEnvironmentInput} from './metadata.js';\n\ninterface CreateDeployOptions {\n  config: DeploymentConfig;\n  hooks?: DeploymentHooks;\n  logger?: Logger;\n}\n\ninterface CompletedDeployment {\n  url: string;\n  authBypassToken?: string;\n}\n\nexport async function createDeploy(\n  options: CreateDeployOptions,\n): Promise<CompletedDeployment | undefined> {\n  const cliStartTime = performance.now();\n  initializeBugsnag(!options.config.bugsnag);\n  const Bugsnag = getBugsnag();\n  Bugsnag?.addMetadata('config', {\n    ...options.config,\n    deploymentToken: {...options.config.deploymentToken, accessToken: '***'},\n  });\n\n  const {config, hooks} = options;\n  const logger = options.logger ?? stderrLogger;\n  const build = {} as Build;\n  let buildCompleted;\n  let deployment;\n\n  try {\n    const metadata = await getMetadata(config, logger);\n    const labels = createLabels(metadata);\n    const environment = getEnvironmentInput(config, metadata);\n    Bugsnag?.addMetadata('metadata', {\n      environment,\n      labels,\n      metadata,\n    });\n    const metricsExporter = new MetricsExporter({\n      ciProvider: metadata.name || 'unknown',\n      rootPath: config.rootPath!,\n    });\n\n    if (!config.workerOnly && !config.skipBuild) {\n      const buildInitiateResponse = await buildInitiate({\n        config,\n        environment,\n        labels,\n        logger,\n      });\n      build.id = buildInitiateResponse.build.id;\n      build.assetPath = buildInitiateResponse.build.assetPath;\n    }\n\n    if (!config.skipBuild) {\n      await buildProject({\n        config,\n        assetPath: build.assetPath,\n        hooks,\n        metricsExporter,\n      });\n      await verifyConfig({config, performedBuild: true});\n    }\n    buildCompleted = true;\n\n    const manifest = await getUploadFiles(config, metricsExporter);\n    Bugsnag?.addMetadata('manifest', manifest);\n    const deploymentInitiateInput = build.id\n      ? {buildId: build.id, manifest}\n      : {environment, manifest, labels};\n\n    deployment = await deploymentInitiate({\n      config,\n      input: deploymentInitiateInput,\n      logger,\n    });\n\n    await uploadFiles({\n      config,\n      targets: deployment.deploymentTargets,\n      hooks,\n      logger,\n      metricsExporter,\n    });\n    const deploymentCompleteOp = await deploymentComplete(\n      config,\n      deployment.deployment.id,\n    );\n    metricsExporter.add(MetricName.TotalTime, performance.now() - cliStartTime);\n    await metricsExporter.export();\n\n    await verifyDeploymentCompleted(\n      {\n        config,\n        hooks,\n        logger,\n        timeoutInSeconds: deployment.deploymentConfiguration.timeoutInSeconds,\n      },\n      deployment.deployment.id,\n    );\n\n    if (!config.skipVerification) {\n      await verifyDeployment({\n        config,\n        url: deploymentCompleteOp.deployment.url,\n        logger,\n        hooks,\n      });\n    }\n\n    const completedDeployment: CompletedDeployment = {\n      url: deploymentCompleteOp.deployment.url,\n    };\n\n    const urlPrivacy = config.publicDeployment ? 'public' : 'private';\n\n    let successMessage = `\\nThe deployment can be reached at the ${completedDeployment.url} ${urlPrivacy} preview URL`;\n\n    if (deploymentCompleteOp.authBypassToken) {\n      completedDeployment.authBypassToken =\n        deploymentCompleteOp.authBypassToken;\n\n      successMessage += `. The auth bypass token for the deployment is ${completedDeployment.authBypassToken}`;\n    }\n\n    outputSuccess(successMessage, logger);\n\n    // in CI environments, we want to output the URL + auth bypass token to stdout\n    if (metadata.name !== 'none') {\n      outputInfo(JSON.stringify(completedDeployment));\n    }\n\n    return completedDeployment;\n  } catch (error) {\n    if (\n      config.bugsnag &&\n      Bugsnag &&\n      (error instanceof Error || typeof error === 'string')\n    ) {\n      Bugsnag.notify(error);\n    }\n\n    if (!(error instanceof Error)) {\n      // eslint-disable-next-line no-console\n      console.error('Unknown error', error);\n      return Promise.reject(new Error('Unknown error'));\n    }\n\n    if (\n      error instanceof VerificationError ||\n      error instanceof DeploymentCompletedVerificationError\n    ) {\n      outputWarn(error.message, logger);\n    } else if (build.id && !buildCompleted) {\n      outputWarn(\n        `Build failed with: ${error.message}, cancelling build.`,\n        logger,\n      );\n\n      await buildCancel({\n        config,\n        buildId: build.id!,\n        reason: error.message,\n        logger,\n      }).catch((err) => {\n        if (err instanceof Error) {\n          outputWarn(`Failed to cancel build: ${err.message}`, logger);\n        }\n      });\n    } else if (deployment?.deployment.id) {\n      outputWarn(\n        `Deployment failed with: ${error.message}, cancelling deployment.`,\n        logger,\n      );\n      await deploymentCancel({\n        config,\n        deploymentId: deployment.deployment.id,\n        reason: error.message,\n        logger,\n      }).catch((err) => {\n        if (err instanceof Error) {\n          outputWarn(`Failed to cancel deployment: ${err.message}`, logger);\n        }\n      });\n    }\n    return Promise.reject(error);\n  }\n}\n\nexport type {DeploymentConfig, DeploymentHooks, CompletedDeployment};\nexport {parseToken} from '../utils/utils.js';\n"]}

package/dist/deploy/metadata.d.ts

@@ -1,6 +1,7 @@
 import { CIMetadata } from '@shopify/cli-kit/node/context/local';
 import { Logger } from '@shopify/cli-kit/node/output';
 import { DeploymentConfig, EnvironmentInput } from './types.js';
+import './graphql/deployment-verification-details.js';
 
 type Metadata = CIMetadata & {
     commitDate?: string;

package/dist/deploy/types.d.ts

@@ -1,3 +1,5 @@
+import { DeploymentVerificationDetailsResponse } from './graphql/deployment-verification-details.js';
+
 interface Build {
     id: string;
     assetPath: string;
@@ -7,6 +9,10 @@ interface ClientError extends Error {
 }
 interface DeploymentHooks {
     buildFunction?: (urlPath?: string) => Promise<void>;
+    onDeploymentCompletedVerificationStart?: () => void;
+    onDeploymentCompletedVerificationError?: () => void;
+    onDeploymentFailed?: (responseData: DeploymentVerificationDetailsResponse) => void;
+    onDeploymentCompleted?: () => void;
     onVerificationStart?: () => void;
     onVerificationComplete?: () => void;
     onVerificationError?: (error: Error) => void;
@@ -65,5 +71,7 @@ interface OxygenError {
 }
 declare class VerificationError extends Error {
 }
+declare class DeploymentCompletedVerificationError extends Error {
+}
 
-export { type Build, type ClientError, type DeploymentConfig, type DeploymentHooks, type DeploymentManifestFile, type DeploymentToken, type EnvironmentInput, FileType, type OxygenError, VerificationError };
+export { type Build, type ClientError, DeploymentCompletedVerificationError, type DeploymentConfig, type DeploymentHooks, type DeploymentManifestFile, type DeploymentToken, type EnvironmentInput, FileType, type OxygenError, VerificationError };

package/dist/deploy/types.js

@@ -5,7 +5,9 @@ var FileType = /* @__PURE__ */ ((FileType2) => {
 })(FileType || {});
 class VerificationError extends Error {
 }
+class DeploymentCompletedVerificationError extends Error {
+}
 
-export { FileType, VerificationError };
+export { DeploymentCompletedVerificationError, FileType, VerificationError };
 //# sourceMappingURL=out.js.map
 //# sourceMappingURL=types.js.map

package/dist/deploy/types.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/deploy/types.ts"],"names":["FileType"],"mappings":"AAiEO,IAAK,WAAL,kBAAKA,cAAL;AACL,EAAAA,UAAA,YAAS;AACT,EAAAA,UAAA,WAAQ;AAFE,SAAAA;AAAA,GAAA;AASL,MAAM,0BAA0B,MAAM;AAAC","sourcesContent":["export interface Build {\n  id: string;\n  assetPath: string;\n}\n\nexport interface ClientError extends Error {\n  statusCode: number;\n}\n\nexport interface DeploymentHooks {\n  buildFunction?: (urlPath?: string) => Promise<void>;\n  onVerificationStart?: () => void;\n  onVerificationComplete?: () => void;\n  onVerificationError?: (error: Error) => void;\n  onUploadFilesStart?: () => void;\n  onUploadFilesError?: (error: Error) => void;\n  onUploadFilesComplete?: () => void;\n}\n\nexport interface DeploymentConfig {\n  assetsDir?: string;\n  bugsnag: boolean;\n  buildCommand?: string;\n  deploymentToken: DeploymentToken;\n  deploymentUrl: string;\n  environmentTag?: string;\n  metadata: {\n    description?: string;\n    user?: string;\n    version?: string;\n    url?: string;\n  };\n  publicDeployment: boolean;\n  rootPath?: string;\n  skipBuild: boolean;\n  skipVerification: boolean;\n  verificationMaxDuration: number;\n  workerDir?: string;\n  workerOnly: boolean;\n  generateAuthBypassToken: boolean;\n}\n\nexport interface DeploymentToken {\n  accessToken: string;\n  allowedResource: string;\n  appId: string;\n  client: string;\n  expiresAt: string;\n  namespace: string;\n  namespaceId: string;\n}\n\nexport interface DeploymentManifestFile {\n  filePath: string;\n  fileSize: number;\n  mimeType: string;\n  fileHash: string;\n  fileType: string;\n}\n\nexport interface EnvironmentInput {\n  handle?: string;\n  tag?: string;\n}\n\nexport enum FileType {\n  Worker = 'WORKER',\n  Asset = 'ASSET',\n}\n\nexport interface OxygenError {\n  message: string;\n}\n\nexport class VerificationError extends Error {}\n"]}
+{"version":3,"sources":["../../src/deploy/types.ts"],"names":["FileType"],"mappings":"AAyEO,IAAK,WAAL,kBAAKA,cAAL;AACL,EAAAA,UAAA,YAAS;AACT,EAAAA,UAAA,WAAQ;AAFE,SAAAA;AAAA,GAAA;AASL,MAAM,0BAA0B,MAAM;AAAC;AAEvC,MAAM,6CAA6C,MAAM;AAAC","sourcesContent":["import {DeploymentVerificationDetailsResponse} from './graphql/deployment-verification-details.js';\n\nexport interface Build {\n  id: string;\n  assetPath: string;\n}\n\nexport interface ClientError extends Error {\n  statusCode: number;\n}\n\nexport interface DeploymentHooks {\n  buildFunction?: (urlPath?: string) => Promise<void>;\n  onDeploymentCompletedVerificationStart?: () => void;\n  onDeploymentCompletedVerificationError?: () => void;\n  onDeploymentFailed?: (\n    responseData: DeploymentVerificationDetailsResponse,\n  ) => void;\n  onDeploymentCompleted?: () => void;\n  onVerificationStart?: () => void;\n  onVerificationComplete?: () => void;\n  onVerificationError?: (error: Error) => void;\n  onUploadFilesStart?: () => void;\n  onUploadFilesError?: (error: Error) => void;\n  onUploadFilesComplete?: () => void;\n}\n\nexport interface DeploymentConfig {\n  assetsDir?: string;\n  bugsnag: boolean;\n  buildCommand?: string;\n  deploymentToken: DeploymentToken;\n  deploymentUrl: string;\n  environmentTag?: string;\n  metadata: {\n    description?: string;\n    user?: string;\n    version?: string;\n    url?: string;\n  };\n  publicDeployment: boolean;\n  rootPath?: string;\n  skipBuild: boolean;\n  skipVerification: boolean;\n  verificationMaxDuration: number;\n  workerDir?: string;\n  workerOnly: boolean;\n  generateAuthBypassToken: boolean;\n}\n\nexport interface DeploymentToken {\n  accessToken: string;\n  allowedResource: string;\n  appId: string;\n  client: string;\n  expiresAt: string;\n  namespace: string;\n  namespaceId: string;\n}\n\nexport interface DeploymentManifestFile {\n  filePath: string;\n  fileSize: number;\n  mimeType: string;\n  fileHash: string;\n  fileType: string;\n}\n\nexport interface EnvironmentInput {\n  handle?: string;\n  tag?: string;\n}\n\nexport enum FileType {\n  Worker = 'WORKER',\n  Asset = 'ASSET',\n}\n\nexport interface OxygenError {\n  message: string;\n}\n\nexport class VerificationError extends Error {}\n\nexport class DeploymentCompletedVerificationError extends Error {}\n"]}

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

@@ -2,6 +2,7 @@ import { Logger } from '@shopify/cli-kit/node/output';
 import { MetricsExporter } from '../utils/metrics-exporter.js';
 import { DeploymentConfig, DeploymentHooks } from './types.js';
 import { DeploymentTargetResponse } from './graphql/deployment-initiate.js';
+import './graphql/deployment-verification-details.js';
 
 interface UploadFilesOptions {
     config: DeploymentConfig;

package/dist/deploy/verify-deployment-completed.d.ts

@@ -0,0 +1,13 @@
+import { Logger } from '@shopify/cli-kit/node/output';
+import { DeploymentConfig, DeploymentHooks } from './types.js';
+import { DeploymentVerificationDetailsResponse } from './graphql/deployment-verification-details.js';
+
+interface DeploymentVerificationDetailsOptions {
+    config: DeploymentConfig;
+    hooks?: DeploymentHooks;
+    timeoutInSeconds: number;
+    logger: Logger;
+}
+declare function verifyDeploymentCompleted(options: DeploymentVerificationDetailsOptions, deploymentId: string): Promise<DeploymentVerificationDetailsResponse>;
+
+export { verifyDeploymentCompleted };

package/dist/deploy/verify-deployment-completed.js

@@ -0,0 +1,55 @@
+import { graphqlRequest } from '@shopify/cli-kit/node/api/graphql';
+import { outputInfo, outputCompleted } from '@shopify/cli-kit/node/output';
+import { Header } from '../utils/utils.js';
+import { DeploymentCompletedVerificationError } from './types.js';
+import { DeploymentVerificationDetailsQuery, Status } from './graphql/deployment-verification-details.js';
+
+async function verifyDeploymentCompleted(options, deploymentId) {
+  const { config, logger, timeoutInSeconds, hooks } = options;
+  const variables = {
+    deploymentId
+  };
+  hooks?.onDeploymentCompletedVerificationStart?.();
+  outputInfo("Verifying deployment completed...", logger);
+  const startTime = Date.now();
+  const handleInterval = async () => {
+    const delay = 3e3;
+    const elapsedTime = (Date.now() - startTime) / 1e3;
+    if (elapsedTime + delay / 1e3 > timeoutInSeconds) {
+      hooks?.onDeploymentCompletedVerificationError?.();
+      throw new Error(`Deployment not completed after ${timeoutInSeconds}`);
+    }
+    await new Promise((resolve) => setTimeout(resolve, delay));
+    return check();
+  };
+  const check = async () => {
+    const response = await graphqlRequest({
+      query: DeploymentVerificationDetailsQuery,
+      api: "Oxygen",
+      url: `${config.deploymentUrl}/api/v2/admin/graphql`,
+      token: config.deploymentToken.accessToken,
+      variables,
+      addedHeaders: {
+        [Header.OxygenNamespaceHandle]: config.deploymentToken.namespace
+      }
+    });
+    const data = response.deploymentVerificationDetails;
+    if (data.status === Status.Deployed) {
+      outputCompleted("Deployment to Oxygen completed successfully", logger);
+      hooks?.onDeploymentCompleted?.();
+      return data;
+    }
+    if (data.status === Status.Failed || data.status === Status.Cancelled) {
+      hooks?.onDeploymentFailed?.(data);
+      throw new DeploymentCompletedVerificationError(
+        data.error ? `Deployment ${data.status.toLocaleLowerCase()}, error: ${data.error}` : `Deployment ${data.status.toLocaleLowerCase()}`
+      );
+    }
+    return handleInterval();
+  };
+  return check();
+}
+
+export { verifyDeploymentCompleted };
+//# sourceMappingURL=out.js.map
+//# sourceMappingURL=verify-deployment-completed.js.map

package/dist/deploy/verify-deployment-completed.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/deploy/verify-deployment-completed.ts"],"names":[],"mappings":"AAAA,SAAQ,sBAAqB;AAC7B;AAAA,EAEE;AAAA,EACA;AAAA,OACK;AAEP,SAAQ,cAAa;AAErB;AAAA,EAGE;AAAA,OACK;AACP;AAAA,EACE;AAAA,EAGA;AAAA,OACK;AASP,eAAsB,0BACpB,SACA,cACgD;AAChD,QAAM,EAAC,QAAQ,QAAQ,kBAAkB,MAAK,IAAI;AAClD,QAAM,YAAY;AAAA,IAChB;AAAA,EACF;AAEA,SAAO,yCAAyC;AAChD,aAAW,qCAAqC,MAAM;AAEtD,MAAI,WAAW;AACf,QAAM,YAAY,KAAK,IAAI;AAE3B,QAAM,iBAAiB,YAAY;AACjC,UAAM,QAAQ;AACd,UAAM,eAAe,KAAK,IAAI,IAAI,aAAa;AAC/C,QAAI,cAAc,QAAQ,MAAO,kBAAkB;AACjD,aAAO,yCAAyC;AAChD,YAAM,IAAI,MAAM,kCAAkC,gBAAgB,EAAE;AAAA,IACtE;AACA;AACA,UAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,KAAK,CAAC;AACzD,WAAO,MAAM;AAAA,EACf;AAEA,QAAM,QAAQ,YAA4D;AACxE,UAAM,WACJ,MAAM,eAAe;AAAA,MACnB,OAAO;AAAA,MACP,KAAK;AAAA,MACL,KAAK,GAAG,OAAO,aAAa;AAAA,MAC5B,OAAO,OAAO,gBAAgB;AAAA,MAC9B;AAAA,MACA,cAAc;AAAA,QACZ,CAAC,OAAO,qBAAqB,GAAG,OAAO,gBAAgB;AAAA,MACzD;AAAA,IACF,CAAC;AAEH,UAAM,OAAO,SAAS;AACtB,QAAI,KAAK,WAAW,OAAO,UAAU;AACnC,sBAAgB,+CAA+C,MAAM;AACrE,aAAO,wBAAwB;AAC/B,aAAO;AAAA,IACT;AAEA,QAAI,KAAK,WAAW,OAAO,UAAU,KAAK,WAAW,OAAO,WAAW;AACrE,aAAO,qBAAqB,IAAI;AAChC,YAAM,IAAI;AAAA,QACR,KAAK,QACD,cAAc,KAAK,OAAO,kBAAkB,CAAC,YAC3C,KAAK,KACP,KACA,cAAc,KAAK,OAAO,kBAAkB,CAAC;AAAA,MACnD;AAAA,IACF;AAEA,WAAO,eAAe;AAAA,EACxB;AAEA,SAAO,MAAM;AACf","sourcesContent":["import {graphqlRequest} from '@shopify/cli-kit/node/api/graphql';\nimport {\n  Logger,\n  outputCompleted,\n  outputInfo,\n} from '@shopify/cli-kit/node/output';\n\nimport {Header} from '../utils/utils.js';\n\nimport {\n  DeploymentConfig,\n  DeploymentHooks,\n  DeploymentCompletedVerificationError,\n} from './types.js';\nimport {\n  DeploymentVerificationDetailsQuery,\n  DeploymentVerificationDetailsQueryData,\n  DeploymentVerificationDetailsResponse,\n  Status,\n} from './graphql/deployment-verification-details.js';\n\ninterface DeploymentVerificationDetailsOptions {\n  config: DeploymentConfig;\n  hooks?: DeploymentHooks;\n  timeoutInSeconds: number;\n  logger: Logger;\n}\n\nexport async function verifyDeploymentCompleted(\n  options: DeploymentVerificationDetailsOptions,\n  deploymentId: string,\n): Promise<DeploymentVerificationDetailsResponse> {\n  const {config, logger, timeoutInSeconds, hooks} = options;\n  const variables = {\n    deploymentId,\n  };\n\n  hooks?.onDeploymentCompletedVerificationStart?.();\n  outputInfo('Verifying deployment completed...', logger);\n\n  let attempts = 0;\n  const startTime = Date.now();\n\n  const handleInterval = async () => {\n    const delay = 3000;\n    const elapsedTime = (Date.now() - startTime) / 1000;\n    if (elapsedTime + delay / 1000 > timeoutInSeconds) {\n      hooks?.onDeploymentCompletedVerificationError?.();\n      throw new Error(`Deployment not completed after ${timeoutInSeconds}`);\n    }\n    attempts++;\n    await new Promise((resolve) => setTimeout(resolve, delay));\n    return check();\n  };\n\n  const check = async (): Promise<DeploymentVerificationDetailsResponse> => {\n    const response: DeploymentVerificationDetailsQueryData =\n      await graphqlRequest({\n        query: DeploymentVerificationDetailsQuery,\n        api: 'Oxygen',\n        url: `${config.deploymentUrl}/api/v2/admin/graphql`,\n        token: config.deploymentToken.accessToken,\n        variables,\n        addedHeaders: {\n          [Header.OxygenNamespaceHandle]: config.deploymentToken.namespace,\n        },\n      });\n\n    const data = response.deploymentVerificationDetails;\n    if (data.status === Status.Deployed) {\n      outputCompleted('Deployment to Oxygen completed successfully', logger);\n      hooks?.onDeploymentCompleted?.();\n      return data;\n    }\n\n    if (data.status === Status.Failed || data.status === Status.Cancelled) {\n      hooks?.onDeploymentFailed?.(data);\n      throw new DeploymentCompletedVerificationError(\n        data.error\n          ? `Deployment ${data.status.toLocaleLowerCase()}, error: ${\n              data.error\n            }`\n          : `Deployment ${data.status.toLocaleLowerCase()}`,\n      );\n    }\n\n    return handleInterval();\n  };\n\n  return check();\n}\n"]}

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

@@ -1,5 +1,6 @@
 import { Logger } from '@shopify/cli-kit/node/output';
 import { DeploymentConfig, DeploymentHooks } from './types.js';
+import './graphql/deployment-verification-details.js';
 
 interface VerificationOptions {
     config: DeploymentConfig;

package/dist/deploy/verify-deployment.js

@@ -5,7 +5,7 @@ import { VerificationError } from './types.js';
 async function verifyDeployment(options) {
   const { config, url, logger, hooks } = options;
   hooks?.onVerificationStart?.();
-  outputInfo("Verifying worker deployment has been completed...", logger);
+  outputInfo("Verifying worker deployment is routable...", logger);
   let attempts = 0;
   let delay = 0;
   let calledVerificationError = false;
@@ -19,7 +19,7 @@ async function verifyDeployment(options) {
     const elapsedTime = (Date.now() - startTime) / 1e3;
     if (elapsedTime + delay / 1e3 > config.verificationMaxDuration) {
       const error = new VerificationError(
-        "Unable to verify worker deployment completion."
+        "Unable to verify that the worker is accessible."
       );
       if (!calledVerificationError) {
         calledVerificationError = true;

package/dist/deploy/verify-deployment.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/deploy/verify-deployment.ts"],"names":[],"mappings":"AAAA,SAAQ,aAAY;AACpB,SAAgB,kBAAiB;AAEjC,SAA2C,yBAAwB;AASnE,eAAsB,iBACpB,SACe;AACf,QAAM,EAAC,QAAQ,KAAK,QAAQ,MAAK,IAAI;AACrC,SAAO,sBAAsB;AAC7B,aAAW,qDAAqD,MAAM;AAEtE,MAAI,WAAW;AACf,MAAI,QAAQ;AACZ,MAAI,0BAA0B;AAC9B,QAAM,YAAY,KAAK,IAAI;AAE3B,QAAM,iBAAiB,YAAY;AACjC,QAAI,WAAW,IAAI;AACjB,cAAQ;AAAA,IACV,WAAW,WAAW,MAAM,GAAG;AAC7B,eAAS;AAAA,IACX;AACA,UAAM,eAAe,KAAK,IAAI,IAAI,aAAa;AAC/C,QAAI,cAAc,QAAQ,MAAO,OAAO,yBAAyB;AAC/D,YAAM,QAAQ,IAAI;AAAA,QAChB;AAAA,MACF;AACA,UAAI,CAAC,yBAAyB;AAC5B,kCAA0B;AAC1B,eAAO,sBAAsB,KAAK;AAAA,MACpC;AACA,YAAM;AAAA,IACR;AACA;AACA,UAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,KAAK,CAAC;AACzD,UAAM,MAAM;AAAA,EACd;AAEA,QAAM,QAAQ,YAAY;AACxB,QAAI;AACF,YAAM,WAAW,MAAM,MAAM,GAAG,GAAG,uBAAuB;AAAA,QACxD,QAAQ;AAAA,MACV,CAAC;AACD,UAAI,SAAS,WAAW,KAAK;AAC3B,mBAAW,wCAAwC,MAAM;AACzD,eAAO,yBAAyB;AAChC,eAAO,QAAQ,QAAQ;AAAA,MACzB;AACA,YAAM,eAAe;AAAA,IACvB,QAAQ;AACN,YAAM,eAAe;AAAA,IACvB;AAAA,EACF;AAEA,QAAM,MAAM;AACd","sourcesContent":["import {fetch} from '@shopify/cli-kit/node/http';\nimport {Logger, outputInfo} from '@shopify/cli-kit/node/output';\n\nimport {DeploymentConfig, DeploymentHooks, VerificationError} from './types.js';\n\ninterface VerificationOptions {\n  config: DeploymentConfig;\n  hooks?: DeploymentHooks;\n  logger: Logger;\n  url: string;\n}\n\nexport async function verifyDeployment(\n  options: VerificationOptions,\n): Promise<void> {\n  const {config, url, logger, hooks} = options;\n  hooks?.onVerificationStart?.();\n  outputInfo('Verifying worker deployment has been completed...', logger);\n\n  let attempts = 0;\n  let delay = 0;\n  let calledVerificationError = false;\n  const startTime = Date.now();\n\n  const handleInterval = async () => {\n    if (attempts < 10) {\n      delay = 500;\n    } else if (attempts % 5 === 0) {\n      delay += 5000;\n    }\n    const elapsedTime = (Date.now() - startTime) / 1000;\n    if (elapsedTime + delay / 1000 > config.verificationMaxDuration) {\n      const error = new VerificationError(\n        'Unable to verify worker deployment completion.',\n      );\n      if (!calledVerificationError) {\n        calledVerificationError = true;\n        hooks?.onVerificationError?.(error);\n      }\n      throw error;\n    }\n    attempts++;\n    await new Promise((resolve) => setTimeout(resolve, delay));\n    await check();\n  };\n\n  const check = async () => {\n    try {\n      const response = await fetch(`${url}/.oxygen/deployment`, {\n        method: 'HEAD',\n      });\n      if (response.status === 200) {\n        outputInfo('Deployment verification check passed', logger);\n        hooks?.onVerificationComplete?.();\n        return Promise.resolve();\n      }\n      await handleInterval();\n    } catch {\n      await handleInterval();\n    }\n  };\n\n  await check();\n}\n"]}
+{"version":3,"sources":["../../src/deploy/verify-deployment.ts"],"names":[],"mappings":"AAAA,SAAQ,aAAY;AACpB,SAAgB,kBAAiB;AAEjC,SAA2C,yBAAwB;AASnE,eAAsB,iBACpB,SACe;AACf,QAAM,EAAC,QAAQ,KAAK,QAAQ,MAAK,IAAI;AACrC,SAAO,sBAAsB;AAC7B,aAAW,8CAA8C,MAAM;AAE/D,MAAI,WAAW;AACf,MAAI,QAAQ;AACZ,MAAI,0BAA0B;AAC9B,QAAM,YAAY,KAAK,IAAI;AAE3B,QAAM,iBAAiB,YAAY;AACjC,QAAI,WAAW,IAAI;AACjB,cAAQ;AAAA,IACV,WAAW,WAAW,MAAM,GAAG;AAC7B,eAAS;AAAA,IACX;AACA,UAAM,eAAe,KAAK,IAAI,IAAI,aAAa;AAC/C,QAAI,cAAc,QAAQ,MAAO,OAAO,yBAAyB;AAC/D,YAAM,QAAQ,IAAI;AAAA,QAChB;AAAA,MACF;AACA,UAAI,CAAC,yBAAyB;AAC5B,kCAA0B;AAC1B,eAAO,sBAAsB,KAAK;AAAA,MACpC;AACA,YAAM;AAAA,IACR;AACA;AACA,UAAM,IAAI,QAAQ,CAAC,YAAY,WAAW,SAAS,KAAK,CAAC;AACzD,UAAM,MAAM;AAAA,EACd;AAEA,QAAM,QAAQ,YAAY;AACxB,QAAI;AACF,YAAM,WAAW,MAAM,MAAM,GAAG,GAAG,uBAAuB;AAAA,QACxD,QAAQ;AAAA,MACV,CAAC;AACD,UAAI,SAAS,WAAW,KAAK;AAC3B,mBAAW,wCAAwC,MAAM;AACzD,eAAO,yBAAyB;AAChC,eAAO,QAAQ,QAAQ;AAAA,MACzB;AACA,YAAM,eAAe;AAAA,IACvB,QAAQ;AACN,YAAM,eAAe;AAAA,IACvB;AAAA,EACF;AAEA,QAAM,MAAM;AACd","sourcesContent":["import {fetch} from '@shopify/cli-kit/node/http';\nimport {Logger, outputInfo} from '@shopify/cli-kit/node/output';\n\nimport {DeploymentConfig, DeploymentHooks, VerificationError} from './types.js';\n\ninterface VerificationOptions {\n  config: DeploymentConfig;\n  hooks?: DeploymentHooks;\n  logger: Logger;\n  url: string;\n}\n\nexport async function verifyDeployment(\n  options: VerificationOptions,\n): Promise<void> {\n  const {config, url, logger, hooks} = options;\n  hooks?.onVerificationStart?.();\n  outputInfo('Verifying worker deployment is routable...', logger);\n\n  let attempts = 0;\n  let delay = 0;\n  let calledVerificationError = false;\n  const startTime = Date.now();\n\n  const handleInterval = async () => {\n    if (attempts < 10) {\n      delay = 500;\n    } else if (attempts % 5 === 0) {\n      delay += 5000;\n    }\n    const elapsedTime = (Date.now() - startTime) / 1000;\n    if (elapsedTime + delay / 1000 > config.verificationMaxDuration) {\n      const error = new VerificationError(\n        'Unable to verify that the worker is accessible.',\n      );\n      if (!calledVerificationError) {\n        calledVerificationError = true;\n        hooks?.onVerificationError?.(error);\n      }\n      throw error;\n    }\n    attempts++;\n    await new Promise((resolve) => setTimeout(resolve, delay));\n    await check();\n  };\n\n  const check = async () => {\n    try {\n      const response = await fetch(`${url}/.oxygen/deployment`, {\n        method: 'HEAD',\n      });\n      if (response.status === 200) {\n        outputInfo('Deployment verification check passed', logger);\n        hooks?.onVerificationComplete?.();\n        return Promise.resolve();\n      }\n      await handleInterval();\n    } catch {\n      await handleInterval();\n    }\n  };\n\n  await check();\n}\n"]}

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

@@ -1,4 +1,5 @@
 import { DeploymentConfig } from '../deploy/types.js';
+import '../deploy/graphql/deployment-verification-details.js';
 
 declare const testToken: {
     accessToken: string;

package/dist/utils/utils.d.ts

@@ -1,4 +1,5 @@
 import { DeploymentConfig, ClientError, DeploymentToken } from '../deploy/types.js';
+import '../deploy/graphql/deployment-verification-details.js';
 
 declare const deployDefaults: {
     [key: string]: string | number;

package/oclif.manifest.json

@@ -174,5 +174,5 @@
       ]
     }
   },
-  "version": "3.0.1-unstable.202311291846.0"
+  "version": "3.1.1"
 }

package/package.json

@@ -5,7 +5,7 @@
     "@shopify:registry": "https://registry.npmjs.org"
   },
   "license": "MIT",
-  "version": "3.0.1-unstable.202311291846.0",
+  "version": "3.1.1",
   "type": "module",
   "scripts": {
     "build": "tsup --sourcemap --clean --config ./tsup.config.ts && oclif manifest",