@salesforce/plugin-packaging 0.0.1 → 1.2.0

package/messages/package2_version_list.md

@@ -0,0 +1,98 @@
+# cliDescription
+
+list all package versions in the Dev Hub org
+
+# cliLongDescription
+
+Lists all package2 versions in the Dev Hub org.
+
+# conciseDescription
+
+display limited package2 version details
+
+# conciseLongDescription
+
+Displays limited package2 version details.
+
+# package2IdsDescription
+
+filter results on specified comma-delimited package2 ids (start with 0Ho)
+
+# package2IdsLongDescription
+
+Filters results on the specified comma-delimited package2 IDs (start with 0Ho).
+
+# releasedDescription
+
+display released versions only
+
+# releasedLongDescription
+
+Displays released versions only (IsReleased=true).
+
+# orderByDescription
+
+order by the specified package2 version fields
+
+# orderByLongDescription
+
+Orders the list by the specified package2 version fields.
+
+# verboseDescription
+
+display extended package2 versions detail
+
+# verboseLongDescription
+
+Display extended package2 versions detail.
+
+# help
+
+Displays details of each package2 version in the org.
+
+Use --concise or --verbose to display limited or additional details, respectively.
+
+All filter parameters are applied using the AND logical operator (not OR).
+
+Examples:
+$ sfdx force:package2:version:list --verbose --createdlastdays 3 --released --orderby PatchVersion
+$ sfdx force:package2:version:list --package2ids 0Ho000000000000,0Ho000000000001 --released --modifiedlastdays 0
+$ sfdx force:package2:version:list --released
+$ sfdx force:package2:version:list --concise --modifiedlastdays 0
+$ sfdx force:package2:version:list --concise -c 3 -r
+
+# name
+
+Name
+
+# description
+
+Description
+
+# version
+
+Version
+
+# id
+
+Package2 Version Id
+
+# subscriberPackageVersionId
+
+Subscriber Package2 Version Id
+
+# package2Id
+
+Package2 Id
+
+# package2Branch
+
+Branch
+
+# package2Tag
+
+Tag
+
+# installUrl
+
+Installation URL

package/messages/package2_version_update.md

@@ -0,0 +1,89 @@
+# cliDescription
+
+update a second-generation package version
+
+# cliLongDescription
+
+Updates a second-generation package version in the Dev Hub org.
+
+# help
+
+Specify a new value for each option you want to update.
+
+Examples:
+$ sfdx force:package2:version:update --package2versionid 05i... --setasreleased
+$ sfdx force:package2:version:update -i 05i... -b master -t 'Release 1.0.7'
+
+To display details about a package2 version, run "sfdx force:package2:version:get".
+
+# id
+
+the package version ID (starts wtih 05i)
+
+# idLong
+
+The package version ID (starts with 05i).
+
+# name
+
+the package version name
+
+# nameLong
+
+The package version name.
+
+# description
+
+the package version description
+
+# descriptionLong
+
+The second-generation package version description.
+
+# branch
+
+the package version branch
+
+# branchLong
+
+The second-generation package version branch.
+
+# tag
+
+the package version tag
+
+# tagLong
+
+The second-generation package version tag.
+
+# key
+
+installation key for key-protected package (default: null)
+
+# longKey
+
+Installation key for creating the key-protected package. The default is null.
+
+# setasreleased
+
+set the package version as released (can’t be undone)
+
+# setasreleasedLong
+
+Sets the second-generation package version as released. Second-generation packages can’t be changed to beta after they’ve been released.
+
+# setasreleasedForce
+
+no prompt to confirm setting the package version as released
+
+# setasreleasedForceLong
+
+No prompt to confirm setting the package version as released.
+
+# humanSuccess
+
+Successfully updated the package version. ID: %s.
+
+# previousReleased
+
+To release the new package2 version, run "sfdx force:package2:version:update -s <new package2 version ID>".

package/messages/package_convert.md

@@ -0,0 +1,72 @@
+# cliDescription
+
+creates a second-generation package version from a first-generation package
+
+# cliLongDescription
+
+Creates a second-generation package in the Dev Hub from a first-generation package in the Dev Hub org.
+
+# help
+
+The package convert creates a new package in the Dev Hub if one does not already exist for the specified first-generation package.
+
+It then creates a new package version in the Dev Hub with contents based on the specified first-generation package.
+
+The latest released non-patch package version from the specified first-generation package will be converted.
+
+To retrieve details about a package version create request, including status and package version ID (04t), run "sfdx force:package:version:create:report -i 08c...".
+
+We recommend specifying the --installationkey to protect the contents of your package and to prevent unauthorized installation of your package.
+
+To list package version creation requests in the org, run "sfdx force:package:version:create:list".
+
+Examples:
+$ sfdx force:package:convert --package 033xx0000004Gmn -k password123
+
+# package
+
+ID (starts with 033) of the first-generation package to convert
+
+# longPackage
+
+The ID (starts with 033) or alias of the package to convert.
+
+# key
+
+installation key for key-protected package (either --installationkey or --installationkeybypass is required)
+
+# longKey
+
+Installation key for creating the key-protected package. Either an --installationkey value or the --installationkeybypass flag is required.
+
+# keyBypass
+
+bypass the installation key requirement (either --installationkey or --installationkeybypass is required)
+
+# longKeyBypass
+
+Bypasses the installation key requirement. If you bypass this requirement, anyone can install your package. Either an --installationkey value or the --installationkeybypass flag is required.
+
+# wait
+
+minutes to wait for the package version to be created
+
+# longWait
+
+The number of minutes to wait for the package version to be created.
+
+# instance
+
+the instance where the conversion package version will be created——for example, NA50
+
+# longInstance
+
+The instance where the conversion package version will be created——for example, NA50.
+
+# errorMoreThanOnePackage2WithSeed
+
+Only one package in in a Dev Hub is allowed per converted from first-generation package, but the following were found:
+
+# errorNoSubscriberPackageRecord
+
+No subscriber package was found for seed id:

package/messages/package_create.md

@@ -0,0 +1,90 @@
+# cliDescription
+
+create a package
+
+# cliLongDescription
+
+Creates a package.
+
+# help
+
+First, use this command to create a package. Then create a package version.
+
+If you don’t have a namespace defined in your sfdx-project.json file, use --nonamespace.
+
+Your --name value must be unique within your namespace.
+
+Examples:
+$ sfdx force:package:create -n YourPackageName -t Unlocked -r force-app
+$ sfdx force:package:create -n YourPackageName -d "Your Package Descripton" -t Unlocked -r force-app
+
+Run 'sfdx force:package:list' to list all packages in the Dev Hub org.
+
+# name
+
+package name
+
+# nameLong
+
+Name of the package to create.
+
+# orgDependent
+
+depends on unpackaged metadata in the installation org. Applies to unlocked packages only.
+
+# orgDependentLong
+
+Package depends on unpackaged metadata in the installation org. Applies to unlocked packages only.
+Use Source Tracking in Sandboxes to develop your org-dependent unlocked package.
+For more information, see "Create Org-Dependent Unlocked Packages" in the Salesforce DX Developer Guide.
+
+# errorNotificationUsername
+
+active Dev Hub user designated to receive email notifications for package errors
+
+# errorNotificationUsernameLong
+
+An active Dev Hub org user designated to receive email notifications for unhandled Apex exceptions, and install, upgrade, or uninstall failures associated with your package.
+
+# description
+
+package description
+
+# descriptionLong
+
+Description of the package.
+
+# noNamespace
+
+creates the package with no namespace; available only for unlocked packages.
+
+# noNamespaceLong
+
+Creates the package with no namespace. Available only for unlocked packages. Useful when you’re migrating an existing org to packages. But, use a namespaced package for new metadata.
+
+# packageType
+
+package type
+
+# packageTypeLong
+
+Package type for the package.
+The options for package type are Managed and Unlocked (Managed=DeveloperManagedSubscriberManaged, Unlocked=DeveloperControlledSubscriberEditable).
+These options determine upgrade and editability rules.
+
+# path
+
+path to directory that contains the contents of the package
+
+# longPath
+
+The path to the directory that contains the contents of the package.
+
+# errorPathNotSpecified
+
+Add a valid path to packageDirectories in the sfdx-project.json file. When the --path parameter is specified, the path is automatically added to the sfdx-project.json file.
+%s
+
+# humanSuccess
+
+Successfully created a package.

package/messages/package_delete.md

@@ -0,0 +1,63 @@
+# cliDescription
+
+delete a package
+
+# cliLongDescription
+
+Delete unlocked and second-generation managed packages. Before you delete a package, first delete all associated package versions.
+
+# help
+
+Specify the ID or alias of the package you want to delete.
+
+Examples:
+$ sfdx force:package:delete -p "Your Package Alias"
+$ sfdx force:package:delete -p 0Ho...
+
+# package
+
+ID (starts with 0Ho) or alias of the package to delete
+
+# packageLong
+
+The ID (starts with 0Ho) or alias of the package to delete.
+
+# undelete
+
+undelete a deleted package
+
+# undeleteLong
+
+Undelete a deleted package.
+
+# noPrompt
+
+don’t prompt before deleting the package
+
+# noPromptLong
+
+Don’t prompt before deleting the package.
+
+# promptDelete
+
+Deleted packages can’t be recovered.
+
+Do you want to continue? (y/n)
+
+# promptUndelete
+
+This will undelete the package, which may result in unintended consequences for customers. Proceed with caution.
+
+Do you want to continue? (y/n)
+
+# promptDeleteDeny
+
+The request to delete this package was canceled
+
+# humanSuccess
+
+Successfully deleted the package.
+
+# humanSuccessUndelete
+
+Successfully undeleted the package.

package/messages/package_displayancestry.md

@@ -0,0 +1,64 @@
+# cliDescription
+
+display the ancestry tree for a 2GP managed package version
+
+# cliDescriptionLong
+
+Displays the ancestry tree for a 2GP managed package version.
+
+# help
+
+Examples:
+$ sfdx force:package:version:displayancestry -p package_version_alias
+$ sfdx force:package:version:displayancestry -p package_version_alias --dotcode
+$ sfdx force:package:version:displayancestry -p OHo...
+$ sfdx force:package:version:displayancestry -p 04t...
+
+# package
+
+ID or alias of the package (starts with 0Ho) or package version (starts with 04t) to display ancestry for
+
+# packageLong
+
+The ID or alias of the package or package version to display ancestry for. If you specify a package ID (starts with 0Ho) or alias, the ancestor tree for every package version associated with the package ID is displayed.
+If you specify a package version (starts with 04t) or alias, the ancestry tree of the specified package version is displayed.
+
+# dotcode
+
+display the ancestry tree in DOT code
+
+# dotcodeLong
+
+Displays the ancestry tree in DOT code. You can use the DOT code output in graph visualization software to create tree visualizations.
+
+# verbose
+
+display both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in the ancestry tree
+
+# verboseLong
+
+Displays both the package version ID (starts with 04t) and the version number (major.minor.patch.build) in the ancestry tree.
+
+# invalidId
+
+Can’t display the ancestry tree for %s. Specify a valid package ID (starts with 0Ho) or package version ID (starts with 04t), and try creating the ancestry tree again.
+
+# parseError
+
+Can’t display the ancestry tree. The specified package alias can’t be located. Check that you’re running this CLI command from the DX project directory, and try creating the ancestry tree again.
+
+# versionNotFound
+
+Can’t display the ancestry tree for %s. Verify the package version number (starts with 04t) or the package version alias listed in the sfdx-project.json file, and try creating the ancestry tree again.
+
+# invalidAlias
+
+Can’t display the ancestry tree for %s. The specified package alias can’t be found. Verify the package alias name listed in the sfdx-project.json, or specify the package ID or package version ID, and try creating the ancestry tree again.
+
+# unlockedPackageError
+
+Can’t display package ancestry. Package ancestry is available only for second-generation managed packages. Retry this command and specify a second-generation managed package or package version.
+
+# noVersionsError
+
+Can’t display package ancestry. The specified package has no associated released package versions. Retry this command after you create and promote at least one package version.

package/messages/package_install.md

@@ -0,0 +1,178 @@
+# cliDescription
+
+install a package in the target org
+
+# cliDescriptionLong
+
+Installs a package in the target org.
+
+# help
+
+Supply the ID of the package version to install. The package installs in your default target org unless you supply the username for a different target org.
+
+For package upgrades, to specify options for component deprecation or deletion of removed components, include an --upgradetype value. To delete components that can be safely deleted and deprecate the others, specify --upgradetype Mixed (the default). To deprecate all removed components, specify --upgradetype DeprecateOnly. To delete all removed components, except for custom objects and custom fields, that don't have dependencies, specify --upgradetype Delete. (Note: This option can result in the loss of data that is associated with the deleted components.) The default is Mixed.
+
+Examples:
+$ sfdx force:package:beta:install --package 04t... -u me@example.com
+$ sfdx force:package:beta:install --package awesome_package_alias
+$ sfdx force:package:beta:install --package "Awesome Package Alias"
+$ sfdx force:package:beta:install --package 04t... -t DeprecateOnly
+
+# id
+
+ID of the package version to install (starts with 04t)
+
+# idLong
+
+The ID of the package version to install (starts with 04t).
+
+# wait
+
+number of minutes to wait for installation status
+
+# waitLong
+
+Maximum number of minutes to wait for installation status. The default is 0.
+
+# installationKey
+
+installation key for key-protected package (default: null)
+
+# installationKeyLong
+
+Installation key for installing a key-protected package. The default is null.
+
+# noPrompt
+
+do not prompt for confirmation
+
+# noPromptLong
+
+Allows the following without an explicit confirmation response: 1) Remote Site Settings and Content Security Policy websites to send or receive data, and 2) --upgradetype Delete to proceed.
+
+# promptRss
+
+This package might send or receive data from these third-party websites:
+
+%s
+
+Grant access (y/n)?
+
+# promptUpgradeType
+
+The Delete upgrade type permanently deletes metadata types that have been removed from the package. Deleted metadata can’t be recovered. We don't delete custom objects and custom fields. Instead, we deprecate them.
+
+Do you want to continue? (y/n)
+
+# promptUpgradeTypeDeny
+
+We canceled this package installation per your request.
+
+# publishWait
+
+number of minutes to wait for subscriber package version ID to become available in the target org
+
+# publishWaitLong
+
+Maximum number of minutes to wait for the Subscriber Package Version ID to become available in the target org before canceling the install request. The default is 0.
+
+# packageInstallSuccess
+
+Successfully installed package [%s]
+
+# publishWaitProgress
+
+Waiting for the Subscriber Package Version ID to be published to the target org.%s
+
+# errorApvIdNotPublished
+
+The package version is not fully available. If this is a recently created package version, try again in a few minutes or contact the package publisher.
+
+# package
+
+ID (starts with 04t) or alias of the package version to install
+
+# packageLong
+
+The ID (starts with 04t) or alias of the package version to install.
+
+# securityType
+
+security access type for the installed package (deprecation notice: The default --securitytype value will change from AllUsers to AdminsOnly in v47.0 or later.)
+
+# securityTypeLong
+
+Security access type for the installed package.
+
+# upgradeType
+
+the upgrade type for the package installation; available only for unlocked packages
+
+# upgradeTypeLong
+
+For package upgrades, specifies whether to mark all removed components as deprecated (DeprecateOnly), to delete removed components that can be safely deleted and deprecate the others (Mixed), or to delete all removed components, except for custom objects and custom fields, that don't have dependencies (Delete). The default is Mixed. Can specify DeprecateOnly or Delete only for unlocked package upgrades.
+
+# apexCompile
+
+compile all Apex in the org and package, or only Apex in the package; unlocked packages only
+
+# apexCompileLong
+
+Applies to unlocked packages only. Specifies whether to compile all Apex in the org and package, or only the Apex in the package.
+For package installs into production orgs, or any org that has Apex Compile on Deploy enabled, the platform compiles all Apex in the org after the package install or upgrade operation completes.
+This approach assures that package installs and upgrades don’t impact the performance of an org, and is done even if --apexcompile package is specified.
+
+# projectNotFound
+
+Could not find the sfdx-project.json for subscriber package version: [%s]
+
+# projectNotFound.actions
+
+Are you running the command from within the project directory when using an alias?
+
+# packageAliasNotFound
+
+The subscriber package version alias: [%s] isn't defined in the sfdx-project.json.
+
+# packageAliasNotFound.actions
+
+Add it to the packageDirectories section and add the alias to packageAliases with its 04t ID.
+
+# promptEnableRss
+
+This package might send or receive data from these third-party websites:
+
+[%s]
+
+Grant access (y/n)?
+
+# promptUpgradeType
+
+The Delete upgrade type permanently deletes metadata types that have been removed from the package. Deleted metadata can’t be recovered. We don't delete custom objects and custom fields. Instead, we deprecate them.
+
+Do you want to continue? (y/n)
+
+# promptUpgradeTypeDeny
+
+We canceled this package installation per your request.
+
+# apiVersionTooLow
+
+This command is supported only on API versions 36.0 and higher
+
+# packageInstallInProgress
+
+PackageInstallRequest is currently InProgress. You can continue to query the status using
+sfdx force:package:beta:install:report -i %s -u %s
+
+# packageInstallError
+
+Encountered errors installing the package! %s
+
+# packageInstallWaiting
+
+Waiting %s minutes for package install to complete.
+
+# packageInstallWaitingStatus
+
+%d minutes remaining until timeout. Install status: %s

package/messages/package_install_get.md

@@ -0,0 +1,34 @@
+# cliDescription
+
+retrieve the status of a package installation request
+
+# cliDescriptionLong
+
+Retrieves the status of a package installation request.
+
+# help
+
+Examples:
+$ sfdx force:package:install:get -i 0Hf...
+$ sfdx force:package:install:get -i 0Hf... -u me@example.com
+
+# requestId
+
+ID of the package install request you want to check
+
+# requestIdLong
+
+The ID of the package install request you want to check.
+
+# IN_PROGRESS
+
+PackageInstallRequest is currently InProgress. You can continue to query the status using
+sfdx force:package:install:get -i %s -u %s
+
+# UNKNOWN
+
+TODO: fix me
+
+# SUCCESS
+
+Successfully installed package [%s]