@salesforce/plugin-packaging 1.18.2 → 1.19.0

package/lib/commands/package/version/retrieve.d.ts

@@ -0,0 +1,22 @@
+import { SfCommand } from '@salesforce/sf-plugins-core';
+export type FileDownloadEntry = {
+    fullName: string;
+    type: string;
+    filePath: string;
+};
+export type PackageVersionRetrieveCommandResult = FileDownloadEntry[];
+export declare class PackageVersionRetrieveCommand extends SfCommand<PackageVersionRetrieveCommandResult> {
+    static readonly hidden = true;
+    static readonly summary: string;
+    static readonly description: string;
+    static readonly examples: string[];
+    static readonly requiresProject = true;
+    static readonly flags: {
+        loglevel: import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'api-version': import("@oclif/core/lib/interfaces").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'target-org': import("@oclif/core/lib/interfaces").OptionFlag<import("@salesforce/core").Org, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        package: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+        'output-dir': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
+    };
+    run(): Promise<PackageVersionRetrieveCommandResult>;
+}

package/lib/commands/package/version/retrieve.js

@@ -0,0 +1,78 @@
+"use strict";
+/*
+ * Copyright (c) 2022, salesforce.com, inc.
+ * All rights reserved.
+ * Licensed under the BSD 3-Clause license.
+ * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PackageVersionRetrieveCommand = void 0;
+const path = require("path");
+const sf_plugins_core_1 = require("@salesforce/sf-plugins-core");
+const core_1 = require("@salesforce/core");
+const packaging_1 = require("@salesforce/packaging");
+core_1.Messages.importMessagesDirectory(__dirname);
+const messages = core_1.Messages.loadMessages('@salesforce/plugin-packaging', 'package_version_retrieve');
+class PackageVersionRetrieveCommand extends sf_plugins_core_1.SfCommand {
+    async run() {
+        const { flags } = await this.parse(PackageVersionRetrieveCommand);
+        const connection = flags['target-org'].getConnection(flags['api-version']);
+        const options = {
+            subscriberPackageVersionId: flags.package ?? '',
+            destinationFolder: flags['output-dir'],
+        };
+        const result = await packaging_1.Package.downloadPackageVersionMetadata(this.project, options, connection);
+        const results = [];
+        result.converted?.forEach((component) => {
+            if (component.xml) {
+                results.push({
+                    fullName: component.fullName,
+                    type: component.type.name,
+                    filePath: path.relative('.', component.xml),
+                });
+            }
+            if (component.content) {
+                results.push({
+                    fullName: component.fullName,
+                    type: component.type.name,
+                    filePath: path.relative('.', component.content),
+                });
+            }
+        });
+        const columnData = {
+            fullName: {
+                header: messages.getMessage('headers.fullName'),
+            },
+            type: {
+                header: messages.getMessage('headers.type'),
+            },
+            filePath: {
+                header: messages.getMessage('headers.filePath'),
+            },
+        };
+        this.table(results, columnData, { 'no-truncate': true });
+        return results;
+    }
+}
+exports.PackageVersionRetrieveCommand = PackageVersionRetrieveCommand;
+PackageVersionRetrieveCommand.hidden = true;
+PackageVersionRetrieveCommand.summary = messages.getMessage('summary');
+PackageVersionRetrieveCommand.description = messages.getMessage('description');
+PackageVersionRetrieveCommand.examples = messages.getMessages('examples');
+PackageVersionRetrieveCommand.requiresProject = true;
+PackageVersionRetrieveCommand.flags = {
+    loglevel: sf_plugins_core_1.loglevel,
+    'api-version': sf_plugins_core_1.orgApiVersionFlagWithDeprecations,
+    'target-org': sf_plugins_core_1.requiredOrgFlagWithDeprecations,
+    package: sf_plugins_core_1.Flags.string({
+        char: 'p',
+        summary: messages.getMessage('flags.package.summary'),
+        required: true,
+    }),
+    'output-dir': sf_plugins_core_1.Flags.directory({
+        char: 'd',
+        summary: messages.getMessage('flags.outputDir.summary'),
+        default: 'force-app',
+    }),
+};
+//# sourceMappingURL=retrieve.js.map

package/lib/commands/package/version/retrieve.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"retrieve.js","sourceRoot":"","sources":["../../../../src/commands/package/version/retrieve.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEH,6BAA6B;AAC7B,iEAMqC;AACrC,2CAA4C;AAE5C,qDAAsF;AAEtF,eAAQ,CAAC,uBAAuB,CAAC,SAAS,CAAC,CAAC;AAC5C,MAAM,QAAQ,GAAG,eAAQ,CAAC,YAAY,CAAC,8BAA8B,EAAE,0BAA0B,CAAC,CAAC;AAUnG,MAAa,6BAA8B,SAAQ,2BAA8C;IAsBxF,KAAK,CAAC,GAAG;QACd,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;QAClE,MAAM,UAAU,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,aAAa,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC;QAC3E,MAAM,OAAO,GAAG;YACd,0BAA0B,EAAE,KAAK,CAAC,OAAO,IAAI,EAAE;YAC/C,iBAAiB,EAAE,KAAK,CAAC,YAAY,CAAC;SACvC,CAAC;QAEF,MAAM,MAAM,GAAyC,MAAM,mBAAO,CAAC,8BAA8B,CAC/F,IAAI,CAAC,OAAO,EACZ,OAAO,EACP,UAAU,CACX,CAAC;QACF,MAAM,OAAO,GAAwC,EAAE,CAAC;QAExD,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,SAAS,EAAE,EAAE;YACtC,IAAI,SAAS,CAAC,GAAG,EAAE;gBACjB,OAAO,CAAC,IAAI,CAAC;oBACX,QAAQ,EAAE,SAAS,CAAC,QAAQ;oBAC5B,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI;oBACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,GAAG,CAAC;iBAC5C,CAAC,CAAC;aACJ;YACD,IAAI,SAAS,CAAC,OAAO,EAAE;gBACrB,OAAO,CAAC,IAAI,CAAC;oBACX,QAAQ,EAAE,SAAS,CAAC,QAAQ;oBAC5B,IAAI,EAAE,SAAS,CAAC,IAAI,CAAC,IAAI;oBACzB,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,GAAG,EAAE,SAAS,CAAC,OAAO,CAAC;iBAChD,CAAC,CAAC;aACJ;QACH,CAAC,CAAC,CAAC;QAEH,MAAM,UAAU,GAAoD;YAClE,QAAQ,EAAE;gBACR,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,kBAAkB,CAAC;aAChD;YACD,IAAI,EAAE;gBACJ,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,cAAc,CAAC;aAC5C;YACD,QAAQ,EAAE;gBACR,MAAM,EAAE,QAAQ,CAAC,UAAU,CAAC,kBAAkB,CAAC;aAChD;SACF,CAAC;QACF,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,UAAU,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAEzD,OAAO,OAAO,CAAC;IACjB,CAAC;;AApEH,sEAqEC;AApEwB,oCAAM,GAAG,IAAI,CAAC;AACd,qCAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC;AACzC,yCAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AACjD,sCAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,UAAU,CAAC,CAAC;AAC5C,6CAAe,GAAG,IAAI,CAAC;AACvB,mCAAK,GAAG;IAC7B,QAAQ,EAAR,0BAAQ;IACR,aAAa,EAAE,mDAAiC;IAChD,YAAY,EAAE,iDAA+B;IAC7C,OAAO,EAAE,uBAAK,CAAC,MAAM,CAAC;QACpB,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;QACrD,QAAQ,EAAE,IAAI;KACf,CAAC;IACF,YAAY,EAAE,uBAAK,CAAC,SAAS,CAAC;QAC5B,IAAI,EAAE,GAAG;QACT,OAAO,EAAE,QAAQ,CAAC,UAAU,CAAC,yBAAyB,CAAC;QACvD,OAAO,EAAE,WAAW;KACrB,CAAC;CACH,CAAC"}

package/messages/package_version_retrieve.md

@@ -0,0 +1,43 @@
+# summary
+
+Retrieve package metadata for a specified package version.
+
+# description
+
+Retrieving a package version downloads the metadata into the directory you specify.
+
+You can retrieve metadata for a second- or first-generation managed package, or an unlocked package.
+
+Specify the subscriber package version ID (starts with 04t) and the path to an empty directory when you run this command.
+
+# examples
+
+- Retrieve package metadata for a subscriber package version ID (starts with 04t) into my-folder/ within your Salesforce DX project directory:
+
+  <%= config.bin %> <%= command.id %> --package 04t... --output-dir my-folder –-target-org my-scratch
+
+  If you omit --target-org, this command runs against your default org.
+
+# flags.package.summary
+
+Subscriber package version ID (starts with 04t).
+
+# flags.outputDir.summary
+
+Path within your Salesforce DX project directory in which to download the metadata. This directory must be empty.
+
+# headers.fullName
+
+FULL NAME
+
+# headers.type
+
+TYPE
+
+# headers.filePath
+
+PROJECT PATH
+
+# error.failedToDownloadZip
+
+Can’t retrieve package version metadata. Ensure that you've specified the correct 04t ID for the package version and then retry this command.

package/oclif.manifest.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.18.2",
+  "version": "1.19.0",
   "commands": {
     "package:convert": {
       "id": "package:convert",
@@ -1830,6 +1830,78 @@
       "requiresProject": true,
       "hasDynamicHelp": true
     },
+    "package:version:retrieve": {
+      "id": "package:version:retrieve",
+      "summary": "Retrieve package metadata for a specified package version.",
+      "description": "Retrieving a package version downloads the metadata into the directory you specify.\n\nYou can retrieve metadata for a second- or first-generation managed package, or an unlocked package.\n\nSpecify the subscriber package version ID (starts with 04t) and the path to an empty directory when you run this command.",
+      "strict": true,
+      "pluginName": "@salesforce/plugin-packaging",
+      "pluginAlias": "@salesforce/plugin-packaging",
+      "pluginType": "core",
+      "hidden": true,
+      "aliases": [],
+      "examples": [
+        "Retrieve package metadata for a subscriber package version ID (starts with 04t) into my-folder/ within your Salesforce DX project directory:\n<%= config.bin %> <%= command.id %> --package 04t... --output-dir my-folder –-target-org my-scratch\nIf you omit --target-org, this command runs against your default org."
+      ],
+      "flags": {
+        "json": {
+          "name": "json",
+          "type": "boolean",
+          "description": "Format output as json.",
+          "helpGroup": "GLOBAL",
+          "allowNo": false
+        },
+        "loglevel": {
+          "name": "loglevel",
+          "type": "option",
+          "hidden": true,
+          "multiple": false,
+          "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."
+          }
+        },
+        "api-version": {
+          "name": "api-version",
+          "type": "option",
+          "description": "Override the api version used for api requests made by this command",
+          "multiple": false,
+          "aliases": [
+            "apiversion"
+          ]
+        },
+        "target-org": {
+          "name": "target-org",
+          "type": "option",
+          "char": "o",
+          "summary": "Username or alias of the target org.",
+          "required": true,
+          "multiple": false,
+          "aliases": [
+            "targetusername",
+            "u"
+          ]
+        },
+        "package": {
+          "name": "package",
+          "type": "option",
+          "char": "p",
+          "summary": "Subscriber package version ID (starts with 04t).",
+          "required": true,
+          "multiple": false
+        },
+        "output-dir": {
+          "name": "output-dir",
+          "type": "option",
+          "char": "d",
+          "summary": "Path within your Salesforce DX project directory in which to download the metadata. This directory must be empty.",
+          "multiple": false,
+          "default": "force-app"
+        }
+      },
+      "args": {},
+      "requiresProject": true,
+      "hasDynamicHelp": true
+    },
     "package:version:update": {
       "id": "package:version:update",
       "summary": "Update a package version.",

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@salesforce/plugin-packaging",
     "description": "SFDX plugin that support Salesforce Packaging Platform",
-    "version": "1.18.2",
+    "version": "1.19.0",
     "main": "lib/index.js",
     "author": "Salesforce",
     "bugs": "https://github.com/forcedotcom/cli/issues",
@@ -259,7 +259,7 @@
         }
     },
     "sfdx": {
-        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/1.18.2.crt",
-        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/1.18.2.sig"
+        "publicKeyUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/1.19.0.crt",
+        "signatureUrl": "https://developer.salesforce.com/media/salesforce-cli/security/@salesforce/plugin-packaging/1.19.0.sig"
     }
 }

package/schemas/package-version-retrieve.json

@@ -0,0 +1,28 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$ref": "#/definitions/PackageVersionRetrieveCommandResult",
+  "definitions": {
+    "PackageVersionRetrieveCommandResult": {
+      "type": "array",
+      "items": {
+        "$ref": "#/definitions/FileDownloadEntry"
+      }
+    },
+    "FileDownloadEntry": {
+      "type": "object",
+      "properties": {
+        "fullName": {
+          "type": "string"
+        },
+        "type": {
+          "type": "string"
+        },
+        "filePath": {
+          "type": "string"
+        }
+      },
+      "required": ["fullName", "type", "filePath"],
+      "additionalProperties": false
+    }
+  }
+}