@salesforce/plugin-org 3.3.16 → 3.4.0

package/oclif.manifest.json

@@ -912,10 +912,11 @@
       ],
       "args": {},
       "deprecateAliases": true,
-      "description": "There are two ways to create a sandbox org: specify a definition file that contains the sandbox options or use the --name and --license-type flags to specify the two required options. If you want to set an option other than name or license type, such as apexClassId, you must use a definition file.",
+      "description": "There are two ways to create a sandbox org: specify a definition file that contains the sandbox options or use the --name and --license-type flags to specify the two required options. If you want to set an option other than name or license type, such as apexClassId, you must use a definition file.\n\nYou can also use this command to clone an existing sandbox. Use the --clone flag to specify the existing sandbox name and the --name flag to the name of the new sandbox.",
       "examples": [
-        "Create a sandbox org using a definition file and give it the alias \"MyDevSandbox\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> -f config/dev-sandbox-def.json --alias MyDevSandbox --target-org prodOrg",
-        "Create a sandbox org by directly specifying its name and type of license (Developer) instead of using a definition file. Set the sandbox org as your default.\n<%= config.bin %> <%= command.id %> --name mysandbox --license-type Developer --alias MyDevSandbox --target-org prodOrg --set-default"
+        "Create a sandbox org using a definition file and give it the alias \"MyDevSandbox\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file config/dev-sandbox-def.json --alias MyDevSandbox --target-org prodOrg",
+        "Create a sandbox org by directly specifying its name and type of license (Developer) instead of using a definition file. Set the sandbox org as your default.\n<%= config.bin %> <%= command.id %> --name mysandbox --license-type Developer --alias MyDevSandbox --target-org prodOrg --set-default",
+        "Clone the existing sandbox with name \"ExistingSandbox\" and name the new sandbox \"NewClonedSandbox\". Set the new sandbox as your default org. Wait for 30 minutes for the sandbox creation to complete.\n<%= config.bin %> <%= command.id %> --clone ExistingSandbox --name NewClonedSandbox --target-org prodOrg --alias MyDevSandbox --set-default --wait 30"
       ],
       "flags": {
         "json": {
@@ -927,7 +928,7 @@
         },
         "definition-file": {
           "char": "f",
-          "description": "The sandbox definition file is a blueprint for the sandbox. You can create different definition files for each sandbox type that you use in the development process. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the defintion file.",
+          "description": "The sandbox definition file is a blueprint for the sandbox. You can create different definition files for each sandbox type that you use in the development process. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
           "exclusive": [
             "name",
             "license-type"
@@ -1012,7 +1013,7 @@
         },
         "clone": {
           "char": "c",
-          "description": "The value of clone must be an existing sandbox in the same target-org.",
+          "description": "The value of --clone must be an existing sandbox. The existing sandbox, and the new sandbox specified with the --name flag, must both be associated with the production org (--target-org) that contains the sandbox licenses.",
           "exclusive": [
             "license-type"
           ],
@@ -1841,6 +1842,133 @@
         "metadata:list:org"
       ]
     },
+    "org:refresh:sandbox": {
+      "aliases": [],
+      "args": {},
+      "description": "Refreshing a sandbox copies the metadata, and optionally data, from your production org to the refreshed sandbox org. You can optionally specify a definition file if you want to change the configuration of the refreshed sandbox, such as its license type or template ID.\n\nYou're not allowed to change the sandbox name when you refresh it with this command. If you want to change the sandbox name, first delete it with the \"org delete sandbox\" command. And then recreate it with the \"org create sandbox\" command and give it a new name.",
+      "examples": [
+        "Refresh the sandbox named \"devSbx1\". The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --name devSbx1 --target-org prodOrg",
+        "Refresh the sandbox named \"devSbx2\", and override the configuration of the refreshed sandbox with the properties in the specified defintion file. The default target org is the production org, so you don't need to specify the `--target-org` flag in this case.\n<%= config.bin %> <%= command.id %> --name devSbx2 --definition-file devSbx2-config.json",
+        "Refresh the sandbox using the name defined in the definition file. The production org that contains the sandbox license has the alias \"prodOrg\".\n<%= config.bin %> <%= command.id %> --definition-file devSbx3-config.json --target-org prodOrg"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "auto-activate": {
+          "name": "auto-activate",
+          "summary": "Activates the sandbox after a successful refresh.",
+          "allowNo": true,
+          "type": "boolean"
+        },
+        "wait": {
+          "char": "w",
+          "description": "If the command continues to run after the wait period, the CLI returns control of the terminal to you and displays the \"<%= config.bin %> org resume sandbox\" command for you run to check the status of the refresh. The displayed command includes the job ID for the running sandbox refresh.",
+          "exclusive": [
+            "async"
+          ],
+          "name": "wait",
+          "summary": "Number of minutes to poll for sandbox refresh status.",
+          "default": {
+            "quantity": 30,
+            "unit": 0
+          },
+          "hasDynamicHelp": false,
+          "helpValue": "<minutes>",
+          "multiple": false,
+          "type": "option"
+        },
+        "poll-interval": {
+          "char": "i",
+          "exclusive": [
+            "async"
+          ],
+          "name": "poll-interval",
+          "summary": "Number of seconds to wait between status polling requests.",
+          "default": {
+            "quantity": 30,
+            "unit": 2
+          },
+          "hasDynamicHelp": false,
+          "helpValue": "<seconds>",
+          "multiple": false,
+          "type": "option"
+        },
+        "async": {
+          "description": "The command immediately displays the job ID and returns control of the terminal to you. This way, you can continue to use the CLI. To check the status of the sandbox refresh, run \"<%= config.bin %> org resume sandbox\".",
+          "exclusive": [
+            "wait",
+            "poll-interval"
+          ],
+          "name": "async",
+          "summary": "Request the sandbox refresh, but don't wait for it to complete.",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "name": {
+          "char": "n",
+          "name": "name",
+          "summary": "Name of the existing sandbox org in your production org that you want to refresh.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "definition-file": {
+          "char": "f",
+          "description": "The sandbox definition file is a blueprint for the sandbox; use the file to change the sandbox configuration during a refresh. If you don't want to change the sandbox configuration when you refresh it, then simply use the --name flag to specify the sandbox and don't use this flag. See <https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_sandbox_definition.htm> for all the options you can specify in the definition file.",
+          "name": "definition-file",
+          "summary": "Path to a sandbox definition file for overriding its configuration when you refresh it.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "char": "o",
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the production org that contains the sandbox license.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "no-prompt": {
+          "name": "no-prompt",
+          "summary": "Don't prompt for confirmation about the sandbox refresh.",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "org:refresh:sandbox",
+      "pluginAlias": "@salesforce/plugin-org",
+      "pluginName": "@salesforce/plugin-org",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Refresh a sandbox org using the sandbox name.",
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "org",
+        "refresh",
+        "sandbox.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "org:refresh:sandbox",
+        "refresh:org:sandbox",
+        "refresh:sandbox:org",
+        "org:sandbox:refresh",
+        "sandbox:org:refresh",
+        "sandbox:refresh:org"
+      ]
+    },
     "org:resume:sandbox": {
       "aliases": [
         "env:resume:sandbox"
@@ -2020,5 +2148,5 @@
       ]
     }
   },
-  "version": "3.3.16"
+  "version": "3.4.0"
 }

package/package.json

@@ -1,14 +1,14 @@
 {
     "name": "@salesforce/plugin-org",
     "description": "Commands to interact with Salesforce orgs",
-    "version": "3.3.16",
+    "version": "3.4.0",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
     "dependencies": {
         "@oclif/core": "^3.18.1",
-        "@salesforce/core": "^6.5.1",
+        "@salesforce/core": "^6.6.0",
         "@salesforce/kit": "^3.0.15",
-        "@salesforce/sf-plugins-core": "^7.1.12",
+        "@salesforce/sf-plugins-core": "^7.1.14",
         "@salesforce/source-deploy-retrieve": "^10.3.8",
         "chalk": "^5.3.0",
         "change-case": "^5.4.3",
@@ -16,17 +16,16 @@
         "open": "^10.0.3"
     },
     "devDependencies": {
-        "@oclif/plugin-command-snapshot": "^5.0.6",
+        "@oclif/plugin-command-snapshot": "^5.0.9",
         "@salesforce/cli-plugins-testkit": "^5.1.9",
-        "@salesforce/dev-scripts": "^8.3.0",
-        "@salesforce/plugin-command-reference": "^3.0.65",
+        "@salesforce/dev-scripts": "^8.4.1",
+        "@salesforce/plugin-command-reference": "^3.0.69",
         "@salesforce/ts-sinon": "1.4.19",
         "@types/shelljs": "^0.8.14",
         "eslint-plugin-sf-plugin": "^1.17.3",
         "moment": "^2.30.1",
         "oclif": "^4.4.12",
         "shelljs": "^0.8.5",
-        "shx": "0.3.4",
         "ts-node": "^10.9.2",
         "typescript": "^5.3.3"
     },
@@ -36,8 +35,9 @@
     "files": [
         "/lib",
         "/messages",
-        "/oclif.manifest.json",
-        "/oclif.lock"
+        "/npm-shrinkwrap.json",
+        "/oclif.lock",
+        "/oclif.manifest.json"
     ],
     "homepage": "https://github.com/salesforcecli/plugin-org",
     "keywords": [
@@ -100,13 +100,12 @@
         "build": "wireit",
         "clean": "sf-clean",
         "clean-all": "sf-clean all",
-        "clean:lib": "shx rm -rf lib && shx rm -rf coverage && shx rm -rf .nyc_output && shx rm -f oclif.manifest.json oclif.lock",
         "compile": "wireit",
         "docs": "sf-docs",
         "format": "wireit",
         "link-check": "wireit",
         "lint": "wireit",
-        "postpack": "shx rm -f oclif.manifest.json oclif.lock",
+        "postpack": "sf-clean --ignore-signing-artifacts",
         "prepack": "sf-prepack",
         "prepare": "sf-install",
         "test": "wireit",
@@ -238,7 +237,7 @@
     "exports": "./lib/index.js",
     "type": "module",
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/3.3.16.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/3.3.16.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/3.4.0.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-org/3.4.0.sig"
     }
 }