@salesforce/plugin-packaging 2.14.0 → 2.15.0

package/oclif.manifest.json

@@ -1045,6 +1045,134 @@
         "update:package"
       ]
     },
+    "package:install:report": {
+      "aliases": [
+        "force:package:install:report"
+      ],
+      "args": {},
+      "deprecateAliases": true,
+      "examples": [
+        "Retrieve the status of a package installation request with the specified ID on your default org:\n<%= config.bin %> <%= command.id %> --request-id 0Hf...",
+        "Similar to previous example, except use the org with username me@example.com:\n<%= config.bin %> <%= command.id %> --request-id 0Hf... --target-org me@example.com"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-org": {
+          "aliases": [
+            "targetusername",
+            "u"
+          ],
+          "char": "o",
+          "deprecateAliases": true,
+          "name": "target-org",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "aliases": [
+            "apiversion"
+          ],
+          "deprecateAliases": true,
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "loglevel": {
+          "deprecated": {
+            "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
+          },
+          "hidden": true,
+          "name": "loglevel",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "request-id": {
+          "aliases": [
+            "requestid"
+          ],
+          "char": "i",
+          "deprecateAliases": true,
+          "name": "request-id",
+          "required": true,
+          "summary": "ID of the package install request you want to check; starts with 0Hf.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "package:install:report",
+      "pluginAlias": "@salesforce/plugin-packaging",
+      "pluginName": "@salesforce/plugin-packaging",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Retrieve the status of a package installation request.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "package",
+        "install",
+        "report.js"
+      ],
+      "aliasPermutations": [
+        "force:package:install:report",
+        "package:force:install:report",
+        "package:install:force:report",
+        "package:install:report:force",
+        "force:install:package:report",
+        "install:force:package:report",
+        "install:package:force:report",
+        "install:package:report:force",
+        "force:install:report:package",
+        "install:force:report:package",
+        "install:report:force:package",
+        "install:report:package:force",
+        "force:package:report:install",
+        "package:force:report:install",
+        "package:report:force:install",
+        "package:report:install:force",
+        "force:report:package:install",
+        "report:force:package:install",
+        "report:package:force:install",
+        "report:package:install:force",
+        "force:report:install:package",
+        "report:force:install:package",
+        "report:install:force:package",
+        "report:install:package:force"
+      ],
+      "permutations": [
+        "package:install:report",
+        "install:package:report",
+        "install:report:package",
+        "package:report:install",
+        "report:package:install",
+        "report:install:package"
+      ]
+    },
     "package:installed:list": {
       "aliases": [
         "force:package:installed:list"
@@ -1160,15 +1288,95 @@
         "list:installed:package"
       ]
     },
-    "package:install:report": {
+    "package:push-upgrade:abort": {
+      "aliases": [],
+      "args": {},
+      "description": "Specify the request ID for which you want abort the request. If applicable, the command displays errors related to the request.\n\nTo show all requests in the org, run \"<%= config.bin %> package pushupgrade list --package 033...\".",
+      "examples": [
+        "Cancel the specified package push upgrade request with the specified ID; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --push-request-id 0DV...",
+        "Cancel the specified package push upgrade request in the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --push-request-id 0DV... --target-dev-hub devhub@example.com"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-dev-hub": {
+          "char": "v",
+          "name": "target-dev-hub",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "push-request-id": {
+          "char": "i",
+          "name": "push-request-id",
+          "required": true,
+          "summary": "ID of the package push request (starts with 0DV). This ID is returned after the package push-upgrade schedule command completes successfully.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "package:push-upgrade:abort",
+      "pluginAlias": "@salesforce/plugin-packaging",
+      "pluginName": "@salesforce/plugin-packaging",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Abort a package push upgrade that has been scheduled. Only push upgrade requests with a status of Created or Pending can be aborted.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "package",
+        "push-upgrade",
+        "abort.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "package:push-upgrade:abort",
+        "push-upgrade:package:abort",
+        "push-upgrade:abort:package",
+        "package:abort:push-upgrade",
+        "abort:package:push-upgrade",
+        "abort:push-upgrade:package"
+      ]
+    },
+    "package:push-upgrade:list": {
       "aliases": [
-        "force:package:install:report"
+        "force:package:push-upgrade:list"
       ],
       "args": {},
-      "deprecateAliases": true,
+      "description": "Shows the details of each request to create a push upgrade in the Dev Hub org.\n\nAll filter parameters are applied using the AND logical operator (not OR).\n\nTo get information about a specific request, run \"sf package pushupgrade report\" and supply the request ID.",
       "examples": [
-        "Retrieve the status of a package installation request with the specified ID on your default org:\n<%= config.bin %> <%= command.id %> --request-id 0Hf...",
-        "Similar to previous example, except use the org with username me@example.com:\n<%= config.bin %> <%= command.id %> --request-id 0Hf... --target-org me@example.com"
+        "List all package push upgrade requests in the specified Dev Hub org:\n<%= config.bin %> <%= command.id %> --package 033xyz --target-dev-hub myHub",
+        "List all package push upgrade requests in the specified Dev Hub org scheduled in the last 30 days:\n<%= config.bin %> <%= command.id %> --package 033xyz --scheduled-last-days 30 --target-dev-hub myHub",
+        "List all package push upgrade with a status Succeeded:\n<%= config.bin %> <%= command.id %> --package 033xyz –-status Succeeded",
+        "List all package push upgrade with a status Failed:\n<%= config.bin %> <%= command.id %> --package 033xyz –-status Failed"
       ],
       "flags": {
         "json": {
@@ -1186,17 +1394,17 @@
           "multiple": false,
           "type": "option"
         },
-        "target-org": {
+        "target-dev-hub": {
           "aliases": [
-            "targetusername",
-            "u"
+            "targetdevhubusername",
+            "target-hub-org"
           ],
-          "char": "o",
+          "char": "v",
           "deprecateAliases": true,
-          "name": "target-org",
+          "name": "target-dev-hub",
           "noCacheDefault": true,
           "required": true,
-          "summary": "Username or alias of the target org. Not required if the `target-org` configuration variable is already set.",
+          "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
           "hasDynamicHelp": true,
           "multiple": false,
           "type": "option"
@@ -1212,6 +1420,129 @@
           "multiple": false,
           "type": "option"
         },
+        "package": {
+          "char": "p",
+          "name": "package",
+          "required": true,
+          "summary": "Package ID (starts with 033) of the package that you want push upgrade information for.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "scheduled-last-days": {
+          "aliases": [
+            "scheduledlastdays"
+          ],
+          "char": "l",
+          "deprecateAliases": true,
+          "name": "scheduled-last-days",
+          "summary": "Number of days in the past for which to display the list of push upgrade requests that were scheduled. Used to filter the list output to only recently scheduled push upgrades.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "status": {
+          "char": "s",
+          "name": "status",
+          "summary": "Status used to filter the list output Valid values are: Created, Canceled, Pending, In Progress, Failed, or Succeeded",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "options": [
+            "Created",
+            "Cancelled",
+            "Pending",
+            "In Progress",
+            "Failed",
+            "Succeeded"
+          ],
+          "type": "option"
+        },
+        "show-push-migrations-only": {
+          "name": "show-push-migrations-only",
+          "summary": "Display only push upgrade requests for package migrations.",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "package:push-upgrade:list",
+      "pluginAlias": "@salesforce/plugin-packaging",
+      "pluginName": "@salesforce/plugin-packaging",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Lists the status of push upgrade requests for a given package.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "package",
+        "push-upgrade",
+        "list.js"
+      ],
+      "aliasPermutations": [
+        "force:package:push-upgrade:list",
+        "package:force:push-upgrade:list",
+        "package:push-upgrade:force:list",
+        "package:push-upgrade:list:force",
+        "force:push-upgrade:package:list",
+        "push-upgrade:force:package:list",
+        "push-upgrade:package:force:list",
+        "push-upgrade:package:list:force",
+        "force:push-upgrade:list:package",
+        "push-upgrade:force:list:package",
+        "push-upgrade:list:force:package",
+        "push-upgrade:list:package:force",
+        "force:package:list:push-upgrade",
+        "package:force:list:push-upgrade",
+        "package:list:force:push-upgrade",
+        "package:list:push-upgrade:force",
+        "force:list:package:push-upgrade",
+        "list:force:package:push-upgrade",
+        "list:package:force:push-upgrade",
+        "list:package:push-upgrade:force",
+        "force:list:push-upgrade:package",
+        "list:force:push-upgrade:package",
+        "list:push-upgrade:force:package",
+        "list:push-upgrade:package:force"
+      ],
+      "permutations": [
+        "package:push-upgrade:list",
+        "push-upgrade:package:list",
+        "push-upgrade:list:package",
+        "package:list:push-upgrade",
+        "list:package:push-upgrade",
+        "list:push-upgrade:package"
+      ]
+    },
+    "package:push-upgrade:report": {
+      "aliases": [
+        "force:package:push-upgrade:report"
+      ],
+      "args": {},
+      "deprecateAliases": true,
+      "description": "Specify the request ID for which you want to view details. If applicable, the command displays errors related to the request.\n\nTo show all requests in the org, run \"<%= config.bin %> package pushupgrade list\".",
+      "examples": [
+        "Retrieve details about the package push upgrade with the specified ID; uses your default Dev Hub org:\n<%= config.bin %> <%= command.id %> --push-request-id 0DV...",
+        "Retrieve details about the specified package push request in the Dev Hub org with username devhub@example.com:\n<%= config.bin %> <%= command.id %> --push-request-id 0DV... --target-dev-hub devhub@example.com"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
         "loglevel": {
           "deprecated": {
             "message": "The loglevel flag is no longer in use on this command. You may use it without error, but it will be ignored.\nSet the log level using the `SFDX_LOG_LEVEL` environment variable."
@@ -1222,15 +1553,41 @@
           "multiple": false,
           "type": "option"
         },
-        "request-id": {
+        "target-dev-hub": {
           "aliases": [
-            "requestid"
+            "targetdevhubusername",
+            "target-hub-org"
+          ],
+          "char": "v",
+          "deprecateAliases": true,
+          "name": "target-dev-hub",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the Dev Hub org. Not required if the `target-dev-hub` configuration variable is already set.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "aliases": [
+            "apiversion"
+          ],
+          "deprecateAliases": true,
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "push-request-id": {
+          "aliases": [
+            "pushrequestid"
           ],
           "char": "i",
           "deprecateAliases": true,
-          "name": "request-id",
+          "name": "push-request-id",
           "required": true,
-          "summary": "ID of the package install request you want to check; starts with 0Hf.",
+          "summary": "ID of the package push request (starts with 0DV). This ID is returned after the package push-upgrade schedule command completes successfully.",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"
@@ -1238,54 +1595,176 @@
       },
       "hasDynamicHelp": true,
       "hiddenAliases": [],
-      "id": "package:install:report",
+      "id": "package:push-upgrade:report",
       "pluginAlias": "@salesforce/plugin-packaging",
       "pluginName": "@salesforce/plugin-packaging",
       "pluginType": "core",
       "strict": true,
-      "summary": "Retrieve the status of a package installation request.",
+      "summary": "Retrieve the status of a package push upgrade.",
       "enableJsonFlag": true,
       "isESM": true,
       "relativePath": [
         "lib",
         "commands",
         "package",
-        "install",
+        "push-upgrade",
         "report.js"
       ],
       "aliasPermutations": [
-        "force:package:install:report",
-        "package:force:install:report",
-        "package:install:force:report",
-        "package:install:report:force",
-        "force:install:package:report",
-        "install:force:package:report",
-        "install:package:force:report",
-        "install:package:report:force",
-        "force:install:report:package",
-        "install:force:report:package",
-        "install:report:force:package",
-        "install:report:package:force",
-        "force:package:report:install",
-        "package:force:report:install",
-        "package:report:force:install",
-        "package:report:install:force",
-        "force:report:package:install",
-        "report:force:package:install",
-        "report:package:force:install",
-        "report:package:install:force",
-        "force:report:install:package",
-        "report:force:install:package",
-        "report:install:force:package",
-        "report:install:package:force"
+        "force:package:push-upgrade:report",
+        "package:force:push-upgrade:report",
+        "package:push-upgrade:force:report",
+        "package:push-upgrade:report:force",
+        "force:push-upgrade:package:report",
+        "push-upgrade:force:package:report",
+        "push-upgrade:package:force:report",
+        "push-upgrade:package:report:force",
+        "force:push-upgrade:report:package",
+        "push-upgrade:force:report:package",
+        "push-upgrade:report:force:package",
+        "push-upgrade:report:package:force",
+        "force:package:report:push-upgrade",
+        "package:force:report:push-upgrade",
+        "package:report:force:push-upgrade",
+        "package:report:push-upgrade:force",
+        "force:report:package:push-upgrade",
+        "report:force:package:push-upgrade",
+        "report:package:force:push-upgrade",
+        "report:package:push-upgrade:force",
+        "force:report:push-upgrade:package",
+        "report:force:push-upgrade:package",
+        "report:push-upgrade:force:package",
+        "report:push-upgrade:package:force"
       ],
       "permutations": [
-        "package:install:report",
-        "install:package:report",
-        "install:report:package",
-        "package:report:install",
-        "report:package:install",
-        "report:install:package"
+        "package:push-upgrade:report",
+        "push-upgrade:package:report",
+        "push-upgrade:report:package",
+        "package:report:push-upgrade",
+        "report:package:push-upgrade",
+        "report:push-upgrade:package"
+      ]
+    },
+    "package:push-upgrade:schedule": {
+      "aliases": [],
+      "args": {},
+      "description": "Represents a push upgrade request for upgrading a package in one or many orgs from one version to another version.\nTo initiate a push upgrade for an unlocked or second-generation managed package, the Create and Update Second-Generation Packages user permission is required.\nFor second-generation managed packages, the push upgrade feature is available only for packages that have passed AppExchange security review. To enable push upgrades for your managed package, log a support case in the Salesforce Partner Community.\nFor unlocked packages, push upgrades are enabled by default.\n\nUse the -–migrate-to-2GP flag to indicate you’re installing a converted second-generation managed package into an org that has the first-generation managed package version of that package installed.",
+      "examples": [
+        "Schedule a push upgrade that initiates at a specified time:\n<%= config.bin %> <%= command.id %> --package 04txyz --start-time \"2024-12-06T21:00:00\" --org-file upgrade-orgs.csv",
+        "Schedule a push upgrade that initiates as soon as possible:\n<%= config.bin %> <%= command.id %> --package 04txyz --org-file upgrade-orgs.csv",
+        "Schedule a push migration from a 1GP package to a 2GP package:\n<%= config.bin %> <%= command.id %> --migrate-to-2gp --package 04txyz --start-time \"2024-12-06T21:00:00\" --org-file upgrade-orgs.csv --target-dev-hub myHub"
+      ],
+      "flags": {
+        "json": {
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "name": "json",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "flags-dir": {
+          "helpGroup": "GLOBAL",
+          "name": "flags-dir",
+          "summary": "Import flag values from a directory.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "target-dev-hub": {
+          "char": "v",
+          "description": "Overrides the value of the target-dev-hub configuration variable, if set.",
+          "name": "target-dev-hub",
+          "noCacheDefault": true,
+          "required": true,
+          "summary": "Username or alias of the Dev Hub org.",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
+        "api-version": {
+          "aliases": [
+            "apiversion"
+          ],
+          "deprecateAliases": true,
+          "description": "Override the api version used for api requests made by this command",
+          "name": "api-version",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "package": {
+          "char": "p",
+          "name": "package",
+          "required": true,
+          "summary": "ID (starts with 04t) of the package version that the package is being upgraded to. The package version must be an active, non-beta package version.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "start-time": {
+          "char": "t",
+          "description": "Scheduled push upgrades begin as soon as resources are available on the Salesforce instance, which is either at or after the start time you specify. In certain scenarios, the push upgrade starts a few hours after the scheduled start time.\n\nAs a best practice, schedule push upgrades at off-peak hours like 1:00 AM Saturday.  \nIf you don't specify this flag, the push upgrade is scheduled to run as soon as resources are available on the Salesforce instance.",
+          "name": "start-time",
+          "summary": "Date and time (UTC) when the push upgrade is processed. Set to the earliest time that you want Salesforce to attempt to start the upgrade.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "org-list": {
+          "char": "l",
+          "exclusive": [
+            "org-file"
+          ],
+          "name": "org-list",
+          "summary": "Comma-separated list of subscriber org IDs that need the package upgrade.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "org-file": {
+          "char": "f",
+          "description": "The file must contain one org per line. The org ID must be the only value in each row. \nAll listed orgs must have a package version installed in their org that is lower than the package version you specified for the --package-version flag.",
+          "exclusive": [
+            "org-list"
+          ],
+          "name": "org-file",
+          "summary": "Filename of the CSV file that contains the list of orgs that need the package upgrade.",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "migrate-to-2gp": {
+          "name": "migrate-to-2gp",
+          "summary": "Upgrade from a first-generation managed package (1GP) to a second-generation managed package (2GP). Required when you’re pushing a 2GP package to orgs with the 1GP version installed.",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": true,
+      "hiddenAliases": [],
+      "id": "package:push-upgrade:schedule",
+      "pluginAlias": "@salesforce/plugin-packaging",
+      "pluginName": "@salesforce/plugin-packaging",
+      "pluginType": "core",
+      "strict": true,
+      "summary": "Schedule a package push upgrade.",
+      "enableJsonFlag": true,
+      "isESM": true,
+      "relativePath": [
+        "lib",
+        "commands",
+        "package",
+        "push-upgrade",
+        "schedule.js"
+      ],
+      "aliasPermutations": [],
+      "permutations": [
+        "package:push-upgrade:schedule",
+        "push-upgrade:package:schedule",
+        "push-upgrade:schedule:package",
+        "package:schedule:push-upgrade",
+        "schedule:package:push-upgrade",
+        "schedule:push-upgrade:package"
       ]
     },
     "package:uninstall:report": {
@@ -4063,5 +4542,5 @@
       ]
     }
   },
-  "version": "2.14.0"
+  "version": "2.15.0"
 }