@shopify/oxygen-cli 1.3.0 → 1.4.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.
@@ -68,7 +68,7 @@ environment:
   OXYGEN_DEPLOYMENT_TOKEN: ${YOUR_ENV_VARIABLE}
 ```
 
-When run from a supported CI/CD environment, the tool will automatically retrieve metadata from relevant environment variables. Metadata describes the author making the deployment (user), the version (commit Sha) and the deployment URL (workflow URL).
+When run from a supported CI/CD environment, the tool will automatically retrieve metadata from relevant environment variables. Metadata describes the author making the deployment (user), the version (commit Sha) and the deployment URL (workflow URL). This metadata will be saved and used to show details about the Oxygen deployment in the Hydrogen channel within the Shopify Admin.
 
 The following environment variables are relevant, depending on your environment:
 
@@ -78,9 +78,9 @@ The following environment variables are relevant, depending on your environment:
 | Version | BITBUCKET_COMMIT | CIRCLE_SHA1 | GITHUB_SHA | CI_COMMIT_SHA |
 | URL | BITBUCKET_BUILD_URL | CIRCLE_BUILD_URL | `${GITHUB_SERVER_URL}${GITHUB_REPOSITORY}/actions/runs/${GITHUB_RUN_ID}` | CI_PROJECT_URL |
 
-These values can be overruled by the command line flags `metadataUser`, `metadataUrl` and `metadataVersion` respectively.
+These values can be overridden by the command line flags `metadataUser`, `metadataUrl` and `metadataVersion` respectively.
 
-The tag of the environment to deploy to, will be derived from the following variables:
+The environment tag to deploy to will be derived from the following variables:
 
 | Service | Branch |
 | ------- | ------ |
@@ -89,4 +89,4 @@ The tag of the environment to deploy to, will be derived from the following vari
 | Github | GITHUB_REF_NAME |
 | Gitlab | CI_COMMIT_REF_NAME |
 
-The `environmentTag` command line option can be used to override this, and is required when the tool is run from outside a supported CI environment.
+The `environmentTag` command line option can be used to override this. If not provided, or there is no environment with the specified tag, the deployment will be deployed to the default environment for the app (if one exists).

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

@@ -6,8 +6,8 @@ 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>;
+        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>;

package/dist/commands/oxygen/deploy.js

@@ -12,10 +12,10 @@ class Deploy extends Command {
       char: "t",
       description: "Oxygen deployment token",
       env: "OXYGEN_DEPLOYMENT_TOKEN",
-      required: true
+      required: false
     }),
-    rootPath: Flags.string({
-      char: "r",
+    path: Flags.string({
+      char: "p",
       description: "Root path",
       default: "./",
       required: false
@@ -60,24 +60,23 @@ class Deploy extends Command {
       }
     }),
     publicDeployment: Flags.boolean({
-      char: "p",
       env: "OXYGEN_PUBLIC_DEPLOYMENT",
       description: "Marks a preview deployment as publicly accessible.",
       required: false,
       default: false
     }),
     metadataUrl: Flags.string({
-      description: "URL that links to the deployment",
+      description: "URL that links to the deployment. Will be saved and displayed in the Shopify admin",
       required: false,
       env: "OXYGEN_METADATA_URL"
     }),
     metadataUser: Flags.string({
-      description: "User that initiated the deployment",
+      description: "User that initiated the deployment. Will be saved and displayed in the Shopify admin",
       required: false,
       env: "OXYGEN_METADATA_USER"
     }),
     metadataVersion: Flags.string({
-      description: "A version identifier for the deployment",
+      description: "A version identifier for the deployment. Will be saved and displayed in the Shopify admin",
       required: false,
       env: "OXYGEN_METADATA_VERSION"
     })
@@ -102,7 +101,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

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

@@ -1,6 +1,10 @@
 import { DeployConfig } from './types.js';
 import { DeploymentCancelResponse } from './graphql/deployment-cancel.js';
 
-declare function deploymentCancel(config: DeployConfig, deploymentId: string, reason: string): Promise<DeploymentCancelResponse>;
+declare enum DeploymentCancelReason {
+    Failed = "FAILED",
+    Cancelled = "CANCELLED"
+}
+declare function deploymentCancel(config: DeployConfig, deploymentId: string, reason: DeploymentCancelReason): Promise<DeploymentCancelResponse>;
 
-export { deploymentCancel };
+export { DeploymentCancelReason, deploymentCancel };

package/dist/deploy/deployment-cancel.js

@@ -4,6 +4,11 @@ import { outputInfo } from '@shopify/cli-kit/node/output';
 import { Header, stderrLogger, errorHandler } from '../utils/utils.js';
 import { DeploymentCancelQuery } from './graphql/deployment-cancel.js';
 
+var DeploymentCancelReason = /* @__PURE__ */ ((DeploymentCancelReason2) => {
+  DeploymentCancelReason2["Failed"] = "FAILED";
+  DeploymentCancelReason2["Cancelled"] = "CANCELLED";
+  return DeploymentCancelReason2;
+})(DeploymentCancelReason || {});
 async function deploymentCancel(config, deploymentId, reason) {
   const variables = {
     deploymentId,
@@ -33,4 +38,4 @@ async function deploymentCancel(config, deploymentId, reason) {
   }
 }
 
-export { deploymentCancel };
+export { DeploymentCancelReason, deploymentCancel };

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

@@ -3,7 +3,7 @@ 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 { deploymentCancel } from './deployment-cancel.js';
+import { deploymentCancel, DeploymentCancelReason } from './deployment-cancel.js';
 
 vi.mock("@shopify/cli-kit/node/api/graphql");
 vi.mock("@shopify/cli-kit/node/output");
@@ -22,7 +22,7 @@ describe("DeploymentComplete", () => {
     const completeResponse = await deploymentCancel(
       testConfig,
       "deployment-1",
-      "some reason"
+      DeploymentCancelReason.Failed
     );
     expect(completeResponse).toEqual(response.deploymentCancel);
     expect(graphqlRequest).toHaveBeenCalledWith({
@@ -32,7 +32,7 @@ describe("DeploymentComplete", () => {
       token: testConfig.deploymentToken.accessToken,
       variables: {
         deploymentId: "deployment-1",
-        reason: "some reason"
+        reason: DeploymentCancelReason.Failed
       },
       addedHeaders: {
         [Header.OxygenNamespaceHandle]: `${testConfig.deploymentToken.namespace}`
@@ -51,7 +51,11 @@ describe("DeploymentComplete", () => {
     };
     vi.mocked(graphqlRequest).mockResolvedValueOnce(response);
     await expect(
-      deploymentCancel(testConfig, "deployment-1", "some reason")
+      deploymentCancel(
+        testConfig,
+        "deployment-1",
+        DeploymentCancelReason.Failed
+      )
     ).rejects.toThrow(
       new AbortError(
         `Failed to cancel deployment: ${response.deploymentCancel.userErrors[0]?.message}`
@@ -65,7 +69,11 @@ describe("DeploymentComplete", () => {
     vi.mocked(graphqlRequest).mockRejectedValueOnce(error);
     try {
       await expect(
-        deploymentCancel(testConfig, "deployment-1", "some reason")
+        deploymentCancel(
+          testConfig,
+          "deployment-1",
+          DeploymentCancelReason.Failed
+        )
       ).rejects.toThrow(
         new AbortError(
           "You are not authorized to perform this action. Please check your deployment token."

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

@@ -1,6 +1,6 @@
 import { OxygenError } from '../types.js';
 
-declare const DeploymentCompleteQuery = "\n  mutation DeploymentComplete($deploymentId: ID!) {\n    deploymentComplete(id: $deploymentId) {\n      deployment {\n        id\n        status\n        url\n      }\n      userErrors {\n        message\n      }\n    }\n  }\n";
+declare const DeploymentCompleteQuery = "\n  mutation DeploymentComplete($deploymentId: ID!) {\n    deploymentComplete(id: $deploymentId) {\n      deployment {\n        id\n        url\n      }\n      userErrors {\n        message\n      }\n    }\n  }\n";
 interface DeploymentCompleteQueryData {
     deploymentComplete: DeploymentCompleteResponse;
 }
@@ -10,7 +10,6 @@ interface DeploymentCompleteResponse {
 }
 interface Deployment {
     id: string;
-    status: string;
     url: string;
 }
 

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

@@ -3,7 +3,6 @@ const DeploymentCompleteQuery = `
     deploymentComplete(id: $deploymentId) {
       deployment {
         id
-        status
         url
       }
       userErrors {

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

@@ -1,6 +1,6 @@
 import { OxygenError } from '../types.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        status\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      userErrors {\n        message\n      }\n    }\n  }\n";
 interface DeploymentInitiateQueryData {
     deploymentInitiate: DeploymentInitiateResponse;
 }
@@ -18,7 +18,6 @@ interface DeploymentTargetResponse {
 }
 interface Deployment {
     id: string;
-    status: string;
 }
 interface DeploymentInitiateParameters {
     name: string;

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

@@ -3,7 +3,6 @@ const DeploymentInitiateQuery = `
     deploymentInitiate(buildId: $buildId, environment: $environment, labels: $labels, files: $files, isPrivate: $isPrivate) {
       deployment {
         id
-        status
       }
       deploymentTargets {
         filePath

package/dist/deploy/index.js

@@ -5,7 +5,7 @@ import { buildCancel } from './build-cancel.js';
 import { getUploadFiles } from './get-upload-files.js';
 import { deploymentInitiate } from './deployment-initiate.js';
 import { deploymentComplete } from './deployment-complete.js';
-import { deploymentCancel } from './deployment-cancel.js';
+import { deploymentCancel, DeploymentCancelReason } from './deployment-cancel.js';
 import { uploadFiles } from './upload-files.js';
 import { buildProject } from './build-project.js';
 import { getMetadata, createLabels, getEnvironmentInput } from './metadata.js';
@@ -69,16 +69,18 @@ ${urlMessage} preview URL: ${deploymentCompleteOp.deployment.url}`,
         `Deployment failed with: ${error.message}, cancelling deployment.`,
         stderrLogger
       );
-      await deploymentCancel(config, deployment.deployment.id, "failed").catch(
-        (err) => {
-          if (err instanceof Error) {
-            outputWarn(
-              `Failed to cancel deployment: ${err.message}`,
-              stderrLogger
-            );
-          }
+      await deploymentCancel(
+        config,
+        deployment.deployment.id,
+        DeploymentCancelReason.Failed
+      ).catch((err) => {
+        if (err instanceof Error) {
+          outputWarn(
+            `Failed to cancel deployment: ${err.message}`,
+            stderrLogger
+          );
         }
-      );
+      });
     }
     consoleError(error.message);
   }

package/dist/utils/utils.js

@@ -72,6 +72,11 @@ function stderrLogger(log) {
 }
 const maxLabelLength = 90;
 function parseToken(inputToken) {
+  if (!inputToken) {
+    throw new Error(
+      "No deployment token provided. Use the --token flag to set a deployment token."
+    );
+  }
   try {
     const decodedToken = Buffer.from(inputToken, "base64").toString("utf-8");
     const rawToken = JSON.parse(decodedToken);
@@ -99,7 +104,7 @@ async function verifyConfig({
   for (const pathType of Object.keys(checkPaths)) {
     await checkPath(checkPaths[pathType], pathType);
   }
-  const addressRegex = /^(http|https):\/\/(?:[\w-]+\.)*[\w-]+|(?:http|https):\/\/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/;
+  const addressRegex = /^https:\/\/(?:[\w-]+\.)*[\w-]+|^https:\/\/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/;
   if (!addressRegex.test(config.deploymentUrl)) {
     throw new Error(`Invalid deployment service URL: ${config.deploymentUrl}`);
   }

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.3.0",
+  "version": "1.4.0",
   "commands": {
     "oxygen:deploy": {
       "id": "oxygen:deploy",
@@ -16,13 +16,13 @@
           "type": "option",
           "char": "t",
           "description": "Oxygen deployment token",
-          "required": true,
+          "required": false,
           "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
@@ -90,21 +89,21 @@
         "metadataUrl": {
           "name": "metadataUrl",
           "type": "option",
-          "description": "URL that links to the deployment",
+          "description": "URL that links to the deployment. Will be saved and displayed in the Shopify admin",
           "required": false,
           "multiple": false
         },
         "metadataUser": {
           "name": "metadataUser",
           "type": "option",
-          "description": "User that initiated the deployment",
+          "description": "User that initiated the deployment. Will be saved and displayed in the Shopify admin",
           "required": false,
           "multiple": false
         },
         "metadataVersion": {
           "name": "metadataVersion",
           "type": "option",
-          "description": "A version identifier for the deployment",
+          "description": "A version identifier for the deployment. Will be saved and displayed in the Shopify admin",
           "required": false,
           "multiple": false
         }

package/package.json

@@ -5,7 +5,7 @@
     "@shopify:registry": "https://registry.npmjs.org"
   },
   "license": "MIT",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "type": "module",
   "scripts": {
     "build": "tsup --clean --config ./tsup.config.ts && oclif manifest",
@@ -13,7 +13,7 @@
     "dev": "tsup --watch --config ./tsup.config.ts",
     "typecheck": "tsc --noEmit",
     "lint": "eslint --ext .js,.ts --max-warnings 0 src",
-    "lint:format": "npm run lint --fix",
+    "lint:format": "prettier --write \"**/*.*\" && npm run lint --fix",
     "generate:manifest": "oclif manifest",
     "prepack": "npm install && npm run build",
     "release": "npm run build && npx changeset publish",
@@ -31,8 +31,8 @@
     "/oclif.manifest.json"
   ],
   "dependencies": {
-    "@oclif/core": "2.1.4",
-    "@shopify/cli-kit": "^3.46.0",
+    "@oclif/core": "2.8.7",
+    "@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/prettier": "^2.7.2",
-    "eslint": "^8.37.0",
+    "@types/node": "^20.3.1",
+    "@types/prettier": "^2.7.3",
+    "eslint": "^8.43.0",
     "node-fetch": "^3.3.1",
     "oclif": "^3",
     "tsup": "^6.7.0",
-    "typescript": "^5.0.3",
-    "vite": "^4.2.1",
-    "vitest": "^0.29.8"
+    "typescript": "^5.1.3",
+    "vite": "^4.3.9",
+    "vitest": "^0.32.2"
   },
   "prettier": "@shopify/prettier-config",
   "oclif": {