@salesforce/source-deploy-retrieve 5.8.5 → 5.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -2,6 +2,12 @@
2
2
 
3
3
  All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
4
4
 
5
+ ## [5.9.0](https://github.com/forcedotcom/source-deploy-retrieve/compare/v5.8.5...v5.9.0) (2022-01-04)
6
+
7
+ ### Features
8
+
9
+ - add retrieve in mdapi format ([#519](https://github.com/forcedotcom/source-deploy-retrieve/issues/519)) ([4db9b18](https://github.com/forcedotcom/source-deploy-retrieve/commit/4db9b1813712617970c714f30d7d2f1ef2578a2f))
10
+
5
11
  ### [5.8.5](https://github.com/forcedotcom/source-deploy-retrieve/compare/v5.8.4...v5.8.5) (2022-01-04)
6
12
 
7
13
  ### Bug Fixes
@@ -35,8 +35,8 @@ export declare class MetadataApiRetrieve extends MetadataTransfer<MetadataApiRet
35
35
  * checks to the org, unlike {@link MetadataApiDeploy.cancel}.
36
36
  */
37
37
  cancel(): Promise<void>;
38
+ post(result: MetadataApiRetrieveStatus): Promise<RetrieveResult>;
38
39
  protected pre(): Promise<AsyncResult>;
39
- protected post(result: MetadataApiRetrieveStatus): Promise<RetrieveResult>;
40
40
  private getPackageNames;
41
41
  private getPackageOptions;
42
42
  private extract;
@@ -7,6 +7,9 @@ exports.MetadataApiRetrieve = exports.RetrieveResult = void 0;
7
7
  * Licensed under the BSD 3-Clause license.
8
8
  * For full license text, see LICENSE.txt file in the repo root or https://opensource.org/licenses/BSD-3-Clause
9
9
  */
10
+ const path = require("path");
11
+ const fs = require("graceful-fs");
12
+ const unzipper = require("unzipper");
10
13
  const ts_types_1 = require("@salesforce/ts-types");
11
14
  const convert_1 = require("../convert");
12
15
  const collections_1 = require("../collections");
@@ -117,6 +120,33 @@ class MetadataApiRetrieve extends metadataTransfer_1.MetadataTransfer {
117
120
  async cancel() {
118
121
  this.canceled = true;
119
122
  }
123
+ async post(result) {
124
+ let components;
125
+ const isMdapiRetrieve = this.options.format === 'metadata';
126
+ if (result.status === types_1.RequestStatus.Succeeded) {
127
+ const zipFileContents = Buffer.from(result.zipFile, 'base64');
128
+ if (isMdapiRetrieve) {
129
+ const name = this.options.zipFileName || 'unpackaged.zip';
130
+ const zipFilePath = path.join(this.options.output, name);
131
+ fs.writeFileSync(zipFilePath, zipFileContents);
132
+ if (this.options.unzip) {
133
+ const dir = await unzipper.Open.buffer(zipFileContents);
134
+ const extractPath = path.join(this.options.output, path.parse(name).name);
135
+ await dir.extract({ path: extractPath });
136
+ }
137
+ }
138
+ else {
139
+ components = await this.extract(zipFileContents);
140
+ }
141
+ }
142
+ components !== null && components !== void 0 ? components : (components = new collections_1.ComponentSet(undefined, this.options.registry));
143
+ if (!isMdapiRetrieve) {
144
+ // This should only be done when retrieving source format since retrieving
145
+ // mdapi format has no conversion.
146
+ await this.maybeSaveTempDirectory('source', components);
147
+ }
148
+ return new RetrieveResult(result, components, this.components);
149
+ }
120
150
  async pre() {
121
151
  const packageNames = this.getPackageNames();
122
152
  if (this.components.size === 0 && !(packageNames === null || packageNames === void 0 ? void 0 : packageNames.length)) {
@@ -131,20 +161,19 @@ class MetadataApiRetrieve extends metadataTransfer_1.MetadataTransfer {
131
161
  // otherwise don't - it causes errors if undefined or an empty array
132
162
  if (packageNames === null || packageNames === void 0 ? void 0 : packageNames.length) {
133
163
  requestBody.packageNames = packageNames;
164
+ // delete unpackaged when no components and metadata format to prevent
165
+ // sending an empty unpackaged manifest.
166
+ if (this.options.format === 'metadata' && this.components.size === 0) {
167
+ delete requestBody.unpackaged;
168
+ }
169
+ }
170
+ if (this.options.singlePackage) {
171
+ requestBody.singlePackage = this.options.singlePackage;
134
172
  }
135
173
  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
136
174
  // @ts-ignore required callback
137
175
  return connection.metadata.retrieve(requestBody);
138
176
  }
139
- async post(result) {
140
- let components;
141
- if (result.status === types_1.RequestStatus.Succeeded) {
142
- components = await this.extract(Buffer.from(result.zipFile, 'base64'));
143
- }
144
- components = components !== null && components !== void 0 ? components : new collections_1.ComponentSet(undefined, this.options.registry);
145
- await this.maybeSaveTempDirectory('source', components);
146
- return new RetrieveResult(result, components, this.components);
147
- }
148
177
  getPackageNames() {
149
178
  var _a;
150
179
  return (_a = this.getPackageOptions()) === null || _a === void 0 ? void 0 : _a.map((pkg) => pkg.name);
@@ -1 +1 @@
1
- {"version":3,"file":"metadataApiRetrieve.js","sourceRoot":"","sources":["../../../src/client/metadataApiRetrieve.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,mDAA2D;AAC3D,wCAAoE;AACpE,gDAA8C;AAC9C,wCAA+D;AAC/D,sCAAwE;AACxE,oCAA4C;AAE5C,yDAA+E;AAC/E,mCAWiB;AAIjB,MAAa,cAAc;IAOzB;;;;OAIG;IACH,YACkB,QAAmC,EACnC,UAAwB,EACxC,eAA8B;QAFd,aAAQ,GAAR,QAAQ,CAA2B;QACnC,eAAU,GAAV,UAAU,CAAc;QAGxC,IAAI,CAAC,eAAe,GAAG,IAAI,0BAAY,CAAC,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,mBAAmB,EAAE,CAAC,CAAC;IAClF,CAAC;IAEM,gBAAgB;QACrB,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;YACvC,OAAO,IAAI,CAAC,aAAa,CAAC;SAC3B;QAED,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QAExB,qBAAqB;QACrB,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YAC1B,MAAM,gBAAgB,GAAG,IAAA,wBAAgB,EAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAElE,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE;gBACtC,oDAAoD;gBACpD,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACrE,IAAI,OAAO,EAAE;oBACX,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBAC9C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;wBACtB,QAAQ;wBACR,IAAI,EAAE,QAAQ;wBACd,KAAK,EAAE,uBAAe,CAAC,MAAM;wBAC7B,KAAK,EAAE,OAAO,CAAC,OAAO;wBACtB,WAAW,EAAE,OAAO;qBACrB,CAAC,CAAC;iBACJ;qBAAM;oBACL,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;wBACtB,QAAQ,EAAE,EAAE;wBACZ,IAAI,EAAE,EAAE;wBACR,WAAW,EAAE,OAAO;wBACpB,KAAK,EAAE,uBAAe,CAAC,MAAM;wBAC7B,KAAK,EAAE,OAAO,CAAC,OAAO;qBACvB,CAAC,CAAC;iBACJ;aACF;SACF;QAED,sBAAsB;QACtB,KAAK,MAAM,kBAAkB,IAAI,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,EAAE;YACtE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,kBAAkB,CAAC;YACnD,MAAM,YAAY,GAAiB;gBACjC,QAAQ;gBACR,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,uBAAe,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAe,CAAC,OAAO;aACxG,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;gBAClB,KAAK,MAAM,QAAQ,IAAI,kBAAkB,CAAC,WAAW,EAAE,EAAE;oBACvD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,YAAY,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;iBACxE;aACF;YAED,IAAI,GAAG,EAAE;gBACP,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,YAAY,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;aAC7E;SACF;QAED,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;CACF;AA7ED,wCA6EC;AAED,MAAa,mBAAoB,SAAQ,mCAA2D;IAIlG,YAAmB,OAAmC;QACpD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,mBAAmB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACtB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;YACZ,MAAM,IAAI,0BAAiB,CAAC,UAAU,CAAC,CAAC;SACzC;QAED,MAAM,aAAa,GAAG,CAAC,KAAc,EAAW,EAAE;YAChD,IAAI,IAAA,mBAAQ,EAAC,KAAK,CAAC,EAAE;gBACnB,OAAO,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;aACvC;YACD,OAAO,IAAA,oBAAS,EAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACjC,CAAC,CAAC;QACF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAE9C,uEAAuE;QACvE,MAAM,MAAM,GAAG,CAAC,MAAM,UAAU,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC,CAA8B,CAAC;QACrG,MAAM,CAAC,cAAc,GAAG,IAAA,wBAAgB,EAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAChE,MAAM,CAAC,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/C,MAAM,CAAC,IAAI,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACzC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,4DAA4D;IACrD,KAAK,CAAC,MAAM;QACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAES,KAAK,CAAC,GAAG;QACjB,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAE5C,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,CAAA,EAAE;YACvD,MAAM,IAAI,iCAAwB,CAAC,iCAAiC,CAAC,CAAC;SACvE;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC9C,MAAM,WAAW,GAAoB;YACnC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU;YACtC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,OAAO;SAChD,CAAC;QAEF,+CAA+C;QAC/C,oEAAoE;QACpE,IAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,EAAE;YACxB,WAAW,CAAC,YAAY,GAAG,YAAY,CAAC;SACzC;QAED,6DAA6D;QAC7D,+BAA+B;QAC/B,OAAO,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAES,KAAK,CAAC,IAAI,CAAC,MAAiC;QACpD,IAAI,UAAwB,CAAC;QAC7B,IAAI,MAAM,CAAC,MAAM,KAAK,qBAAa,CAAC,SAAS,EAAE;YAC7C,UAAU,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC;SACxE;QAED,UAAU,GAAG,UAAU,aAAV,UAAU,cAAV,UAAU,GAAI,IAAI,0BAAY,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE9E,MAAM,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;QAExD,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACjE,CAAC;IAEO,eAAe;;QACrB,OAAO,MAAA,IAAI,CAAC,iBAAiB,EAAE,0CAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;IAEO,iBAAiB;QACvB,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACxC,IAAI,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,MAAM,EAAE;YAC1B,IAAI,IAAA,mBAAQ,EAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE;gBAC/B,MAAM,YAAY,GAAG,cAA0B,CAAC;gBAChD,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;aACnE;iBAAM;gBACL,MAAM,IAAI,GAAG,cAAiC,CAAC;gBAC/C,+DAA+D;gBAC/D,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;aACpF;SACF;IACH,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,GAAW;;QAC/B,MAAM,UAAU,GAAsB,EAAE,CAAC;QACzC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACjD,MAAM,SAAS,GAAG,IAAI,2BAAiB,CAAC,QAAQ,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,MAAM,0BAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEhD,MAAM,QAAQ,GAA6B,CAAC,EAAE,eAAe,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;QAClG,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC7C,iDAAiD;QACjD,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE;YAC3C,QAAQ,CAAC,IAAI,CAAC,EAAE,eAAe,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;YAC1B,MAAM,YAAY,GAAwB,KAAK;gBAC7C,CAAC,CAAC;oBACE,IAAI,EAAE,OAAO;oBACb,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE;oBAChD,gBAAgB,EAAE,GAAG,CAAC,SAAS;oBAC/B,iBAAiB,EAAE,MAAA,IAAI,CAAC,UAAU,CAAC,iBAAiB,mCAAI,IAAI,GAAG,EAAU;iBAC1E;gBACH,CAAC,CAAC;oBACE,IAAI,EAAE,WAAW;oBACjB,eAAe,EAAE,GAAG,CAAC,SAAS;iBAC/B,CAAC;YACN,MAAM,aAAa,GAAG,0BAAY,CAAC,UAAU,CAAC;gBAC5C,OAAO,EAAE,CAAC,GAAG,CAAC,eAAe,CAAC;gBAC9B,QAAQ;gBACR,IAAI;aACL,CAAC;iBACC,mBAAmB,EAAE;iBACrB,OAAO,EAAE,CAAC;YACb,MAAM,aAAa,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;YACrF,IAAI,aAAa,EAAE;gBACjB,UAAU,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;aAC7C;SACF;QACD,OAAO,IAAI,0BAAY,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;;AA3IH,kDA4IC;AA3Ie,mCAAe,GAAwC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC"}
1
+ {"version":3,"file":"metadataApiRetrieve.js","sourceRoot":"","sources":["../../../src/client/metadataApiRetrieve.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,6BAA6B;AAC7B,kCAAkC;AAClC,qCAAqC;AACrC,mDAA2D;AAC3D,wCAAoE;AACpE,gDAA8C;AAC9C,wCAA+D;AAC/D,sCAAwE;AACxE,oCAA4C;AAE5C,yDAA+E;AAC/E,mCAWiB;AAIjB,MAAa,cAAc;IAOzB;;;;OAIG;IACH,YACkB,QAAmC,EACnC,UAAwB,EACxC,eAA8B;QAFd,aAAQ,GAAR,QAAQ,CAA2B;QACnC,eAAU,GAAV,UAAU,CAAc;QAGxC,IAAI,CAAC,eAAe,GAAG,IAAI,0BAAY,CAAC,eAAe,aAAf,eAAe,uBAAf,eAAe,CAAE,mBAAmB,EAAE,CAAC,CAAC;IAClF,CAAC;IAEM,gBAAgB;QACrB,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,aAAa,EAAE;YACvC,OAAO,IAAI,CAAC,aAAa,CAAC;SAC3B;QAED,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;QAExB,qBAAqB;QACrB,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE;YAC1B,MAAM,gBAAgB,GAAG,IAAA,wBAAgB,EAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAElE,KAAK,MAAM,OAAO,IAAI,gBAAgB,EAAE;gBACtC,oDAAoD;gBACpD,MAAM,OAAO,GAAG,IAAI,MAAM,CAAC,kBAAkB,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;gBACrE,IAAI,OAAO,EAAE;oBACX,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBAC9C,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;wBACtB,QAAQ;wBACR,IAAI,EAAE,QAAQ;wBACd,KAAK,EAAE,uBAAe,CAAC,MAAM;wBAC7B,KAAK,EAAE,OAAO,CAAC,OAAO;wBACtB,WAAW,EAAE,OAAO;qBACrB,CAAC,CAAC;iBACJ;qBAAM;oBACL,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC;wBACtB,QAAQ,EAAE,EAAE;wBACZ,IAAI,EAAE,EAAE;wBACR,WAAW,EAAE,OAAO;wBACpB,KAAK,EAAE,uBAAe,CAAC,MAAM;wBAC7B,KAAK,EAAE,OAAO,CAAC,OAAO;qBACvB,CAAC,CAAC;iBACJ;aACF;SACF;QAED,sBAAsB;QACtB,KAAK,MAAM,kBAAkB,IAAI,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE,EAAE;YACtE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,EAAE,GAAG,kBAAkB,CAAC;YACnD,MAAM,YAAY,GAAiB;gBACjC,QAAQ;gBACR,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,KAAK,EAAE,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,uBAAe,CAAC,OAAO,CAAC,CAAC,CAAC,uBAAe,CAAC,OAAO;aACxG,CAAC;YAEF,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;gBAClB,KAAK,MAAM,QAAQ,IAAI,kBAAkB,CAAC,WAAW,EAAE,EAAE;oBACvD,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,YAAY,EAAE,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC;iBACxE;aACF;YAED,IAAI,GAAG,EAAE;gBACP,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,YAAY,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;aAC7E;SACF;QAED,OAAO,IAAI,CAAC,aAAa,CAAC;IAC5B,CAAC;CACF;AA7ED,wCA6EC;AAED,MAAa,mBAAoB,SAAQ,mCAA2D;IAIlG,YAAmB,OAAmC;QACpD,KAAK,CAAC,OAAO,CAAC,CAAC;QACf,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,mBAAmB,CAAC,eAAe,EAAE,OAAO,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,WAAW;QACtB,IAAI,CAAC,IAAI,CAAC,EAAE,EAAE;YACZ,MAAM,IAAI,0BAAiB,CAAC,UAAU,CAAC,CAAC;SACzC;QAED,MAAM,aAAa,GAAG,CAAC,KAAc,EAAW,EAAE;YAChD,IAAI,IAAA,mBAAQ,EAAC,KAAK,CAAC,EAAE;gBACnB,OAAO,KAAK,CAAC,WAAW,EAAE,KAAK,MAAM,CAAC;aACvC;YACD,OAAO,IAAA,oBAAS,EAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACjC,CAAC,CAAC;QACF,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAE9C,uEAAuE;QACvE,MAAM,MAAM,GAAG,CAAC,MAAM,UAAU,CAAC,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC,CAA8B,CAAC;QACrG,MAAM,CAAC,cAAc,GAAG,IAAA,wBAAgB,EAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QAChE,MAAM,CAAC,OAAO,GAAG,aAAa,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QAC/C,MAAM,CAAC,IAAI,GAAG,aAAa,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACzC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;;OAKG;IACH,4DAA4D;IACrD,KAAK,CAAC,MAAM;QACjB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,MAAiC;QACjD,IAAI,UAAwB,CAAC;QAC7B,MAAM,eAAe,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,UAAU,CAAC;QAE3D,IAAI,MAAM,CAAC,MAAM,KAAK,qBAAa,CAAC,SAAS,EAAE;YAC7C,MAAM,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC9D,IAAI,eAAe,EAAE;gBACnB,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,IAAI,gBAAgB,CAAC;gBAC1D,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;gBACzD,EAAE,CAAC,aAAa,CAAC,WAAW,EAAE,eAAe,CAAC,CAAC;gBAE/C,IAAI,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE;oBACtB,MAAM,GAAG,GAAG,MAAM,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC;oBACxD,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC;oBAC1E,MAAM,GAAG,CAAC,OAAO,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;iBAC1C;aACF;iBAAM;gBACL,UAAU,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;aAClD;SACF;QAED,UAAU,aAAV,UAAU,cAAV,UAAU,IAAV,UAAU,GAAK,IAAI,0BAAY,CAAC,SAAS,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAC;QAElE,IAAI,CAAC,eAAe,EAAE;YACpB,0EAA0E;YAC1E,kCAAkC;YAClC,MAAM,IAAI,CAAC,sBAAsB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;SACzD;QAED,OAAO,IAAI,cAAc,CAAC,MAAM,EAAE,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACjE,CAAC;IAES,KAAK,CAAC,GAAG;QACjB,MAAM,YAAY,GAAG,IAAI,CAAC,eAAe,EAAE,CAAC;QAE5C,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,CAAA,EAAE;YACvD,MAAM,IAAI,iCAAwB,CAAC,iCAAiC,CAAC,CAAC;SACvE;QAED,MAAM,UAAU,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;QAC9C,MAAM,WAAW,GAAoB;YACnC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,UAAU;YACtC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,SAAS,EAAE,CAAC,OAAO;SAChD,CAAC;QAEF,+CAA+C;QAC/C,oEAAoE;QACpE,IAAI,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,MAAM,EAAE;YACxB,WAAW,CAAC,YAAY,GAAG,YAAY,CAAC;YACxC,sEAAsE;YACtE,wCAAwC;YACxC,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,KAAK,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC,EAAE;gBACpE,OAAO,WAAW,CAAC,UAAU,CAAC;aAC/B;SACF;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE;YAC9B,WAAW,CAAC,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC;SACxD;QAED,6DAA6D;QAC7D,+BAA+B;QAC/B,OAAO,UAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAEO,eAAe;;QACrB,OAAO,MAAA,IAAI,CAAC,iBAAiB,EAAE,0CAAE,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1D,CAAC;IAEO,iBAAiB;QACvB,MAAM,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACxC,IAAI,cAAc,aAAd,cAAc,uBAAd,cAAc,CAAE,MAAM,EAAE;YAC1B,IAAI,IAAA,mBAAQ,EAAC,cAAc,CAAC,CAAC,CAAC,CAAC,EAAE;gBAC/B,MAAM,YAAY,GAAG,cAA0B,CAAC;gBAChD,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,GAAG,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;aACnE;iBAAM;gBACL,MAAM,IAAI,GAAG,cAAiC,CAAC;gBAC/C,+DAA+D;gBAC/D,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC;aACpF;SACF;IACH,CAAC;IAEO,KAAK,CAAC,OAAO,CAAC,GAAW;;QAC/B,MAAM,UAAU,GAAsB,EAAE,CAAC;QACzC,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC;QACjD,MAAM,SAAS,GAAG,IAAI,2BAAiB,CAAC,QAAQ,CAAC,CAAC;QAClD,MAAM,IAAI,GAAG,MAAM,0BAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAEhD,MAAM,QAAQ,GAA6B,CAAC,EAAE,eAAe,EAAE,YAAY,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC,CAAC;QAClG,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;QAC7C,iDAAiD;QACjD,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE;YAC3C,QAAQ,CAAC,IAAI,CAAC,EAAE,eAAe,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;QAEH,KAAK,MAAM,GAAG,IAAI,QAAQ,EAAE;YAC1B,MAAM,YAAY,GAAwB,KAAK;gBAC7C,CAAC,CAAC;oBACE,IAAI,EAAE,OAAO;oBACb,SAAS,EAAE,IAAI,CAAC,UAAU,CAAC,mBAAmB,EAAE;oBAChD,gBAAgB,EAAE,GAAG,CAAC,SAAS;oBAC/B,iBAAiB,EAAE,MAAA,IAAI,CAAC,UAAU,CAAC,iBAAiB,mCAAI,IAAI,GAAG,EAAU;iBAC1E;gBACH,CAAC,CAAC;oBACE,IAAI,EAAE,WAAW;oBACjB,eAAe,EAAE,GAAG,CAAC,SAAS;iBAC/B,CAAC;YACN,MAAM,aAAa,GAAG,0BAAY,CAAC,UAAU,CAAC;gBAC5C,OAAO,EAAE,CAAC,GAAG,CAAC,eAAe,CAAC;gBAC9B,QAAQ;gBACR,IAAI;aACL,CAAC;iBACC,mBAAmB,EAAE;iBACrB,OAAO,EAAE,CAAC;YACb,MAAM,aAAa,GAAG,MAAM,SAAS,CAAC,OAAO,CAAC,aAAa,EAAE,QAAQ,EAAE,YAAY,CAAC,CAAC;YACrF,IAAI,aAAa,EAAE;gBACjB,UAAU,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;aAC7C;SACF;QACD,OAAO,IAAI,0BAAY,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;IAChD,CAAC;;AAtKH,kDAuKC;AAtKe,mCAAe,GAAwC,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC"}
@@ -2,6 +2,7 @@ import { ComponentSet } from '../collections';
2
2
  import { PackageTypeMembers } from '../collections/types';
3
3
  import { SourcePath } from '../common/types';
4
4
  import { MetadataComponent, SourceComponent } from '../resolve';
5
+ import { SfdxFileFormat } from '../convert';
5
6
  export declare type RecordId = string;
6
7
  export declare enum ComponentStatus {
7
8
  Created = "Created",
@@ -272,6 +273,23 @@ export interface RetrieveOptions {
272
273
  * A list of package names to retrieve, or package names and their retrieval locations.
273
274
  */
274
275
  packageOptions?: PackageOptions;
276
+ /**
277
+ * The file format desired for the retrieved files.
278
+ */
279
+ format?: SfdxFileFormat;
280
+ /**
281
+ * Specifies whether only a single package is being retrieved (true) or not (false).
282
+ * If false, then more than one package is being retrieved.
283
+ */
284
+ singlePackage?: boolean;
285
+ /**
286
+ * The name of the retrieved zip file containing the source from the org. Only applies when `format: metadata`.
287
+ */
288
+ zipFileName?: string;
289
+ /**
290
+ * Specifies whether to unzip the retrieved zip file. Only applies when `format: metadata`.
291
+ */
292
+ unzip?: boolean;
275
293
  }
276
294
  export interface MetadataApiDeployOptions {
277
295
  allowMissingFiles?: boolean;
@@ -1 +1 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/client/types.ts"],"names":[],"mappings":";;;AAiBA,IAAY,eAMX;AAND,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,sCAAmB,CAAA;IACnB,0CAAuB,CAAA;IACvB,sCAAmB,CAAA;IACnB,oCAAiB,CAAA;AACnB,CAAC,EANW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAM1B;AA+DD,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,0CAAyB,CAAA;IACzB,wCAAuB,CAAA;IACvB,sDAAqC,CAAA;IACrC,kCAAiB,CAAA;IACjB,wCAAuB,CAAA;IACvB,sCAAqB,CAAA;AACvB,CAAC,EARW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAQxB;AAkJD,IAAK,eASJ;AATD,WAAK,eAAe;IAClB,gCAAa,CAAA;IACb,sCAAmB,CAAA;IACnB,4CAAyB,CAAA;IACzB,4DAAyC,CAAA;IACzC,0CAAuB,CAAA;IACvB,0DAAuC,CAAA;IACvC,wCAAqB,CAAA;IACrB,0CAAuB,CAAA;AACzB,CAAC,EATI,eAAe,KAAf,eAAe,QASnB"}
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/client/types.ts"],"names":[],"mappings":";;;AAkBA,IAAY,eAMX;AAND,WAAY,eAAe;IACzB,sCAAmB,CAAA;IACnB,sCAAmB,CAAA;IACnB,0CAAuB,CAAA;IACvB,sCAAmB,CAAA;IACnB,oCAAiB,CAAA;AACnB,CAAC,EANW,eAAe,GAAf,uBAAe,KAAf,uBAAe,QAM1B;AA+DD,IAAY,aAQX;AARD,WAAY,aAAa;IACvB,oCAAmB,CAAA;IACnB,0CAAyB,CAAA;IACzB,wCAAuB,CAAA;IACvB,sDAAqC,CAAA;IACrC,kCAAiB,CAAA;IACjB,wCAAuB,CAAA;IACvB,sCAAqB,CAAA;AACvB,CAAC,EARW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAQxB;AAkJD,IAAK,eASJ;AATD,WAAK,eAAe;IAClB,gCAAa,CAAA;IACb,sCAAmB,CAAA;IACnB,4CAAyB,CAAA;IACzB,4DAAyC,CAAA;IACzC,0CAAuB,CAAA;IACvB,0DAAuC,CAAA;IACvC,wCAAqB,CAAA;IACrB,0CAAuB,CAAA;AACzB,CAAC,EATI,eAAe,KAAf,eAAe,QASnB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@salesforce/source-deploy-retrieve",
3
- "version": "5.8.5",
3
+ "version": "5.9.0",
4
4
  "description": "JavaScript library to run Salesforce metadata deploys and retrieves",
5
5
  "main": "lib/src/index.js",
6
6
  "author": "Salesforce",