@shopify/oxygen-cli 1.0.2 → 1.2.0

package/README.md

@@ -41,6 +41,7 @@ oxygen:deploy [options]
 - -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`).
 - --metadataUrl <metadataUrl>: URL that links to the deployment.
 - --metadataUser <metadataUser>: User that initiated the deployment.

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

@@ -14,6 +14,7 @@ declare class Deploy extends Command {
         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>;
+        publicDeployment: _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>;

package/dist/commands/oxygen/deploy.js

@@ -59,6 +59,13 @@ class Deploy extends Command {
         return Promise.resolve(input);
       }
     }),
+    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",
       required: false,
@@ -94,6 +101,7 @@ class Deploy extends Command {
           user: flags.metadataUser,
           version: flags.metadataVersion
         },
+        publicDeployment: flags.publicDeployment,
         rootPath: normalizePath(flags.rootPath),
         skipBuild: flags.skipBuild,
         workerDir: normalizePath(flags.workerFolder),

package/dist/deploy/deployment-initiate.js

@@ -9,7 +9,8 @@ async function deploymentInitiate(config, input) {
     buildId: input.buildId,
     environment: input.environment,
     files: input.manifest,
-    labels: input.labels
+    labels: input.labels,
+    isPrivate: !config.publicDeployment
   };
   try {
     const response = await graphqlRequest({

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!]!) {\n    deploymentInitiate(buildId: $buildId, environment: $environment, labels: $labels, files: $files) {\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        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";
 interface DeploymentInitiateQueryData {
     deploymentInitiate: DeploymentInitiateResponse;
 }

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

@@ -1,6 +1,6 @@
 const DeploymentInitiateQuery = `
-  mutation DeploymentInitiate($buildId: ID, $environment: EnvironmentSelectorInput, $labels: [String!], $files: [FileInput!]!) {
-    deploymentInitiate(buildId: $buildId, environment: $environment, labels: $labels, files: $files) {
+  mutation DeploymentInitiate($buildId: ID, $environment: EnvironmentSelectorInput, $labels: [String!], $files: [FileInput!]!, $isPrivate: Boolean) {
+    deploymentInitiate(buildId: $buildId, environment: $environment, labels: $labels, files: $files, isPrivate: $isPrivate) {
       deployment {
         id
         status

package/dist/deploy/index.js

@@ -40,8 +40,10 @@ async function createDeploy(config) {
       config,
       deployment.deployment.id
     );
+    const urlMessage = config.publicDeployment ? "Public" : "Private";
     outputSuccess(
-      `Deployment complete: ${deploymentCompleteOp.deployment.url}`
+      `Deployment complete.
+${urlMessage} preview URL: ${deploymentCompleteOp.deployment.url}`
     );
   } catch (error) {
     if (!(error instanceof Error)) {

package/dist/deploy/types.d.ts

@@ -16,6 +16,7 @@ interface DeployConfig {
         version?: string;
         url?: string;
     };
+    publicDeployment: boolean;
     rootPath?: string;
     skipBuild: boolean;
     workerDir?: string;

package/dist/utils/test-helper.js

@@ -18,6 +18,7 @@ function createTestConfig(rootFolder) {
     deploymentUrl: "https://localhost:3000",
     metadata: {},
     rootPath: rootFolder,
+    publicDeployment: false,
     skipBuild: false,
     workerDir: "/worker/",
     workerOnly: false

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.2",
+  "version": "1.2.0",
   "commands": {
     "oxygen:deploy": {
       "id": "oxygen:deploy",
@@ -79,6 +79,14 @@
           "multiple": false,
           "default": "yarn build"
         },
+        "publicDeployment": {
+          "name": "publicDeployment",
+          "type": "boolean",
+          "char": "p",
+          "description": "Marks a preview deployment as publicly accessible.",
+          "required": false,
+          "allowNo": false
+        },
         "metadataUrl": {
           "name": "metadataUrl",
           "type": "option",

package/package.json

@@ -5,10 +5,11 @@
     "@shopify:registry": "https://registry.npmjs.org"
   },
   "license": "MIT",
-  "version": "1.0.2",
+  "version": "1.2.0",
   "type": "module",
   "scripts": {
     "build": "tsup --clean --config ./tsup.config.ts && oclif manifest",
+    "changesets:check": "changeset status",
     "dev": "tsup --watch --config ./tsup.config.ts",
     "typecheck": "tsc --noEmit",
     "lint": "eslint --ext .js,.ts --max-warnings 0 src",