@salesforce/core 3.23.4 → 3.23.7

package/CHANGELOG.md

@@ -2,6 +2,24 @@
 
 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.
 
+### [3.23.7](https://github.com/forcedotcom/sfdx-core/compare/v3.23.6...v3.23.7) (2022-07-08)
+
+### Bug Fixes
+
+- add structure writer interface and refactor ([daef19c](https://github.com/forcedotcom/sfdx-core/commit/daef19cb3a4d145ebb22c4f721a1bd47ffddce40))
+
+### [3.23.6](https://github.com/forcedotcom/sfdx-core/compare/v3.23.5...v3.23.6) (2022-07-06)
+
+### Bug Fixes
+
+- workaround for jsforce update bug ([1776f50](https://github.com/forcedotcom/sfdx-core/commit/1776f505671a5a764c4e966736c2981df2b178a4))
+
+### [3.23.5](https://github.com/forcedotcom/sfdx-core/compare/v3.23.4...v3.23.5) (2022-07-06)
+
+### Bug Fixes
+
+- add resolveAlias ([#605](https://github.com/forcedotcom/sfdx-core/issues/605)) ([ffa9ed6](https://github.com/forcedotcom/sfdx-core/commit/ffa9ed63ea583baa327071db4030ea5346d1128f))
+
 ### [3.23.4](https://github.com/forcedotcom/sfdx-core/compare/v3.23.3...v3.23.4) (2022-07-05)
 
 ### Bug Fixes

package/lib/org/scratchOrgInfoApi.js

@@ -392,12 +392,22 @@ const updateRevisionCounterToZero = async (scratchOrg) => {
         return;
     }
     try {
-        await conn.tooling
-            .sobject('SourceMember')
-            .update(queryResult.map((record) => ({ Id: record.Id, RevisionCounter: 0 })));
+        // jsforce has a bug in its `update` code such that tooling#update doesn't work right
+        // https://github.com/jsforce/jsforce/blob/265eba5c734439dd7b77610c05b63bde7d4b1e83/src/connection.ts#L1082
+        // will result in `this._ensureVersion is not a function`
+        // so until that is resolved, we hit the API with singular records
+        // once that's fixed, you can use the following code for a single API call
+        // await conn.tooling
+        //   .sobject('SourceMember')
+        //   .update(queryResult.map((record) => ({ Id: record.Id, RevisionCounter: 0 })));
+        await Promise.all(queryResult.map((record) => conn.tooling.sobject('SourceMember').update({ Id: record.Id, RevisionCounter: 0 })));
     }
     catch (err) {
-        await lifecycleEvents_1.Lifecycle.getInstance().emitWarning(messages.getMessage('SourceStatusResetFailureError', [scratchOrg.getOrgId(), scratchOrg.getUsername()]));
+        await lifecycleEvents_1.Lifecycle.getInstance().emitWarning(messages.getMessage('SourceStatusResetFailureError', [
+            scratchOrg.getOrgId(),
+            scratchOrg.getUsername(),
+            err instanceof Error ? err.message : '',
+        ]));
     }
 };
 exports.updateRevisionCounterToZero = updateRevisionCounterToZero;

package/lib/org/scratchOrgSettingsGenerator.d.ts

@@ -10,16 +10,27 @@ export declare enum RequestStatus {
     Canceling = "Canceling",
     Canceled = "Canceled"
 }
-export interface BusinessProcessFileContent extends JsonMap {
-    fullName: string;
-    isActive: boolean;
-    values: [
-        {
-            fullName: string;
-            default?: boolean;
-        }
-    ];
+export interface SettingType {
+    members: string[];
+    name: 'CustomObject' | 'RecordType' | 'BusinessProcess' | 'Settings';
 }
+export interface PackageFile {
+    '@': {
+        xmlns: string;
+    };
+    types: SettingType[];
+    version: string;
+}
+export declare const createObjectFileContent: ({ allRecordTypes, allBusinessProcesses, apiVersion, settingData, objectSettingsData, }: {
+    allRecordTypes?: string[] | undefined;
+    allBusinessProcesses?: string[] | undefined;
+    apiVersion: string;
+    settingData?: Record<string, unknown> | undefined;
+    objectSettingsData?: {
+        [objectName: string]: ObjectSetting;
+    } | undefined;
+}) => PackageFile;
+export declare const createRecordTypeAndBusinessProcessFileContent: (objectName: string, json: Record<string, unknown>, allRecordTypes: string[], allBusinessProcesses: string[]) => JsonMap;
 /**
  * Helper class for dealing with the settings that are defined in a scratch definition file.  This class knows how to extract the
  * settings from the definition, how to expand them into a MD directory and how to generate a package.xml.
@@ -29,8 +40,15 @@ export default class SettingsGenerator {
     private objectSettingsData?;
     private logger;
     private writer;
-    private shapeDirName;
-    constructor();
+    private allRecordTypes;
+    private allBusinessProcesses;
+    private readonly shapeDirName;
+    private readonly packageFilePath;
+    constructor(options?: {
+        mdApiTmpDir?: string;
+        shapeDirName?: string;
+        asDirectory?: boolean;
+    });
     /** extract the settings from the scratch def file, if they are present. */
     extract(scratchDef: ScratchOrgInfo): Promise<{
         settings: Record<string, unknown> | undefined;
@@ -48,11 +66,13 @@ export default class SettingsGenerator {
      * Deploys the settings to the org.
      */
     deploySettingsViaFolder(scratchOrg: Org, apiVersion: string): Promise<void>;
+    createDeployPackageContents(apiVersion: string): Promise<void>;
     getShapeDirName(): string;
+    /**
+     * Returns the destination where the writer placed the settings content.
+     *
+     */
+    getDestinationPath(): string | undefined;
     private writeObjectSettingsIfNeeded;
     private writeSettingsIfNeeded;
-    private createPackageXml;
-    private createObjectFileContent;
-    private createRecordTypeFileContent;
-    private createBusinessProcessFileContent;
 }

package/lib/org/scratchOrgSettingsGenerator.js

@@ -6,16 +6,16 @@
  * 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.RequestStatus = void 0;
+exports.createRecordTypeAndBusinessProcessFileContent = exports.createObjectFileContent = exports.RequestStatus = void 0;
 const path = require("path");
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const js2xmlparser = require("js2xmlparser");
 const logger_1 = require("../logger");
 const sfError_1 = require("../sfError");
-const jsonXmlTools_1 = require("../util/jsonXmlTools");
-const zipWriter_1 = require("../util/zipWriter");
 const pollingClient_1 = require("../status/pollingClient");
+const zipWriter_1 = require("../util/zipWriter");
+const directoryWriter_1 = require("../util/directoryWriter");
 var RequestStatus;
 (function (RequestStatus) {
     RequestStatus["Pending"] = "Pending";
@@ -27,17 +27,132 @@ var RequestStatus;
     RequestStatus["Canceled"] = "Canceled";
 })(RequestStatus = exports.RequestStatus || (exports.RequestStatus = {}));
 const breakPolling = ['Succeeded', 'SucceededPartial', 'Failed', 'Canceled'];
+const createObjectFileContent = ({ allRecordTypes = [], allBusinessProcesses = [], apiVersion, settingData, objectSettingsData, }) => {
+    const output = {
+        '@': {
+            xmlns: 'http://soap.sforce.com/2006/04/metadata',
+        },
+        types: [],
+    };
+    if (settingData) {
+        const strings = Object.keys(settingData).map((item) => (0, kit_1.upperFirst)(item).replace('Settings', ''));
+        output.types.push({ members: strings, name: 'Settings' });
+    }
+    if (objectSettingsData) {
+        const strings = Object.keys(objectSettingsData).map((item) => (0, kit_1.upperFirst)(item));
+        output.types.push({ members: strings, name: 'CustomObject' });
+        if (allRecordTypes.length > 0) {
+            output.types.push({ members: allRecordTypes, name: 'RecordType' });
+        }
+        if (allBusinessProcesses.length > 0) {
+            output.types.push({ members: allBusinessProcesses, name: 'BusinessProcess' });
+        }
+    }
+    return { ...output, ...{ version: apiVersion } };
+};
+exports.createObjectFileContent = createObjectFileContent;
+const calculateBusinessProcess = (objectName, defaultRecordType) => {
+    let businessProcessName = null;
+    let businessProcessPicklistVal = null;
+    // These four objects require any record type to specify a "business process"--
+    // a restricted set of items from a standard picklist on the object.
+    if (['Case', 'Lead', 'Opportunity', 'Solution'].includes(objectName)) {
+        businessProcessName = (0, kit_1.upperFirst)(defaultRecordType) + 'Process';
+        switch (objectName) {
+            case 'Case':
+                businessProcessPicklistVal = 'New';
+                break;
+            case 'Lead':
+                businessProcessPicklistVal = 'New - Not Contacted';
+                break;
+            case 'Opportunity':
+                businessProcessPicklistVal = 'Prospecting';
+                break;
+            case 'Solution':
+                businessProcessPicklistVal = 'Draft';
+        }
+    }
+    return [businessProcessName, businessProcessPicklistVal];
+};
+const createRecordTypeAndBusinessProcessFileContent = (objectName, json, allRecordTypes, allBusinessProcesses) => {
+    let output = {
+        '@': {
+            xmlns: 'http://soap.sforce.com/2006/04/metadata',
+        },
+    };
+    const name = (0, kit_1.upperFirst)(objectName);
+    const sharingModel = json.sharingModel;
+    if (sharingModel) {
+        output = {
+            ...output,
+            sharingModel: (0, kit_1.upperFirst)(sharingModel),
+        };
+    }
+    const defaultRecordType = json.defaultRecordType;
+    if (typeof defaultRecordType === 'string') {
+        // We need to keep track of these globally for when we generate the package XML.
+        allRecordTypes.push(`${name}.${(0, kit_1.upperFirst)(defaultRecordType)}`);
+        const [businessProcessName, businessProcessPicklistVal] = calculateBusinessProcess(name, defaultRecordType);
+        // Create the record type
+        const recordTypes = {
+            fullName: (0, kit_1.upperFirst)(defaultRecordType),
+            label: (0, kit_1.upperFirst)(defaultRecordType),
+            active: true,
+        };
+        output = {
+            ...output,
+            recordTypes: {
+                ...recordTypes,
+            },
+        };
+        if (businessProcessName) {
+            // We need to keep track of these globally for the package.xml
+            const values = {
+                fullName: businessProcessPicklistVal,
+            };
+            if (name !== 'Opportunity') {
+                values.default = true;
+            }
+            allBusinessProcesses.push(`${name}.${businessProcessName}`);
+            output = {
+                ...output,
+                recordTypes: {
+                    ...recordTypes,
+                    businessProcess: businessProcessName,
+                },
+                businessProcesses: {
+                    fullName: businessProcessName,
+                    isActive: true,
+                    values,
+                },
+            };
+        }
+    }
+    return output;
+};
+exports.createRecordTypeAndBusinessProcessFileContent = createRecordTypeAndBusinessProcessFileContent;
 /**
  * Helper class for dealing with the settings that are defined in a scratch definition file.  This class knows how to extract the
  * settings from the definition, how to expand them into a MD directory and how to generate a package.xml.
  */
 class SettingsGenerator {
-    constructor() {
-        this.shapeDirName = `shape_${Date.now()}`;
+    constructor(options) {
+        this.allRecordTypes = [];
+        this.allBusinessProcesses = [];
         this.logger = logger_1.Logger.childFromRoot('SettingsGenerator');
         // If SFDX_MDAPI_TEMP_DIR is set, copy settings to that dir for people to inspect.
-        const mdapiTmpDir = kit_1.env.getString('SFDX_MDAPI_TEMP_DIR');
-        this.writer = new zipWriter_1.ZipWriter(mdapiTmpDir);
+        const mdApiTmpDir = (options === null || options === void 0 ? void 0 : options.mdApiTmpDir) || kit_1.env.getString('SFDX_MDAPI_TEMP_DIR');
+        this.shapeDirName = (options === null || options === void 0 ? void 0 : options.shapeDirName) || `shape_${Date.now()}`;
+        this.packageFilePath = path.join(this.shapeDirName, 'package.xml');
+        let storePath;
+        if (!(options === null || options === void 0 ? void 0 : options.asDirectory)) {
+            storePath = mdApiTmpDir ? path.join(mdApiTmpDir, `${this.shapeDirName}.zip`) : undefined;
+            this.writer = new zipWriter_1.ZipWriter(storePath);
+        }
+        else {
+            storePath = mdApiTmpDir ? path.join(mdApiTmpDir, this.shapeDirName) : undefined;
+            this.writer = new directoryWriter_1.DirectoryWriter(storePath);
+        }
     }
     /** extract the settings from the scratch def file, if they are present. */
     async extract(scratchDef) {
@@ -57,7 +172,10 @@ class SettingsGenerator {
     async createDeploy() {
         const settingsDir = path.join(this.shapeDirName, 'settings');
         const objectsDir = path.join(this.shapeDirName, 'objects');
-        await Promise.all([this.writeSettingsIfNeeded(settingsDir), this.writeObjectSettingsIfNeeded(objectsDir)]);
+        await Promise.all([
+            this.writeSettingsIfNeeded(settingsDir),
+            this.writeObjectSettingsIfNeeded(objectsDir, this.allRecordTypes, this.allBusinessProcesses),
+        ]);
     }
     /**
      * Deploys the settings to the org.
@@ -65,8 +183,7 @@ class SettingsGenerator {
     async deploySettingsViaFolder(scratchOrg, apiVersion) {
         const username = scratchOrg.getUsername();
         const logger = await logger_1.Logger.child('deploySettingsViaFolder');
-        this.createPackageXml(apiVersion);
-        await this.writer.finalize();
+        await this.createDeployPackageContents(apiVersion);
         const connection = scratchOrg.getConnection();
         logger.debug(`deploying to apiVersion: ${apiVersion}`);
         connection.setApiVersion(apiVersion);
@@ -113,40 +230,34 @@ class SettingsGenerator {
             throw error;
         }
     }
+    async createDeployPackageContents(apiVersion) {
+        const packageObjectProps = (0, exports.createObjectFileContent)({
+            allRecordTypes: this.allRecordTypes,
+            allBusinessProcesses: this.allBusinessProcesses,
+            apiVersion,
+            settingData: this.settingData,
+            objectSettingsData: this.objectSettingsData,
+        });
+        const xml = js2xmlparser.parse('Package', packageObjectProps);
+        await this.writer.addToStore(xml, this.packageFilePath);
+        await this.writer.finalize();
+    }
     getShapeDirName() {
         return this.shapeDirName;
     }
-    async writeObjectSettingsIfNeeded(objectsDir) {
-        if (!this.objectSettingsData || !Object.keys(this.objectSettingsData).length) {
-            return;
-        }
-        for (const objectName of Object.keys(this.objectSettingsData)) {
-            const value = this.objectSettingsData[objectName];
-            // writes the object file in source format
-            const objectDir = path.join(objectsDir, (0, kit_1.upperFirst)(objectName));
-            const customObjectDir = path.join(objectDir, `${(0, kit_1.upperFirst)(objectName)}.object`);
-            const customObjectXml = (0, jsonXmlTools_1.JsonAsXml)({
-                json: this.createObjectFileContent(value),
-                type: 'RecordType',
-            });
-            this.writer.addToZip(customObjectXml, customObjectDir);
-            if (value.defaultRecordType) {
-                const recordTypesDir = path.join(objectDir, 'recordTypes', `${(0, kit_1.upperFirst)(value.defaultRecordType)}.recordType`);
-                const recordTypesFileContent = this.createRecordTypeFileContent(objectName, value);
-                const recordTypesXml = (0, jsonXmlTools_1.JsonAsXml)({
-                    json: recordTypesFileContent,
-                    type: 'RecordType',
-                });
-                this.writer.addToZip(recordTypesXml, recordTypesDir);
-                // for things that required a businessProcess
-                if (recordTypesFileContent.businessProcess) {
-                    const businessProcessesDir = path.join(objectDir, 'businessProcesses', `${recordTypesFileContent.businessProcess}.businessProcess`);
-                    const businessProcessesXml = (0, jsonXmlTools_1.JsonAsXml)({
-                        json: this.createBusinessProcessFileContent(objectName, recordTypesFileContent.businessProcess),
-                        type: 'BusinessProcess',
-                    });
-                    this.writer.addToZip(businessProcessesXml, businessProcessesDir);
-                }
+    /**
+     * Returns the destination where the writer placed the settings content.
+     *
+     */
+    getDestinationPath() {
+        return this.writer.getDestinationPath();
+    }
+    async writeObjectSettingsIfNeeded(objectsDir, allRecordTypes, allbusinessProcesses) {
+        if (this.objectSettingsData) {
+            for (const [item, value] of Object.entries(this.objectSettingsData)) {
+                const fileContent = (0, exports.createRecordTypeAndBusinessProcessFileContent)(item, value, allRecordTypes, allbusinessProcesses);
+                const xml = js2xmlparser.parse('CustomObject', fileContent);
+                await this.writer.addToStore(xml, path.join(objectsDir, (0, kit_1.upperFirst)(item) + '.object'));
             }
         }
     }
@@ -157,58 +268,10 @@ class SettingsGenerator {
                 const typeName = (0, kit_1.upperFirst)(item);
                 const fname = typeName.replace('Settings', '');
                 const fileContent = js2xmlparser.parse(typeName, value);
-                this.writer.addToZip(fileContent, path.join(settingsDir, fname + '.settings'));
+                await this.writer.addToStore(fileContent, path.join(settingsDir, fname + '.settings'));
             }
         }
     }
-    createPackageXml(apiVersion) {
-        const pkg = `<?xml version="1.0" encoding="UTF-8"?>
-<Package xmlns="http://soap.sforce.com/2006/04/metadata">
-    <types>
-        <members>*</members>
-        <name>Settings</name>
-    </types>
-    <types>
-        <members>*</members>
-        <name>CustomObject</name>
-    </types>
-    <version>${apiVersion}</version>
-</Package>`;
-        this.writer.addToZip(pkg, path.join(this.shapeDirName, 'package.xml'));
-    }
-    createObjectFileContent(json) {
-        const output = {};
-        if (json.sharingModel) {
-            output.sharingModel = (0, kit_1.upperFirst)(json.sharingModel);
-        }
-        return output;
-    }
-    createRecordTypeFileContent(objectName, setting) {
-        const defaultRecordType = (0, kit_1.upperFirst)(setting.defaultRecordType);
-        const output = {
-            fullName: defaultRecordType,
-            label: defaultRecordType,
-            active: true,
-        };
-        // all the edge cases
-        if (['Case', 'Lead', 'Opportunity', 'Solution'].includes((0, kit_1.upperFirst)(objectName))) {
-            return { ...output, businessProcess: `${defaultRecordType}Process` };
-        }
-        return output;
-    }
-    createBusinessProcessFileContent(objectName, businessProcessName) {
-        const objectToBusinessProcessPicklist = {
-            Opportunity: { fullName: 'Prospecting' },
-            Case: { fullName: 'New', default: true },
-            Lead: { fullName: 'New - Not Contacted', default: true },
-            Solution: { fullName: 'Draft', default: true },
-        };
-        return {
-            fullName: businessProcessName,
-            isActive: true,
-            values: [objectToBusinessProcessPicklist[(0, kit_1.upperFirst)(objectName)]],
-        };
-    }
 }
 exports.default = SettingsGenerator;
 //# sourceMappingURL=scratchOrgSettingsGenerator.js.map

package/lib/stateAggregator/accessors/aliasAccessor.d.ts

@@ -138,6 +138,16 @@ export declare class AliasAccessor extends AsyncOptionalCreatable {
      * @param usernameOrAlias a string that might be a username or might be an alias
      */
     resolveUsername(usernameOrAlias: string): string;
+    /**
+     * If the provided string is an alias, return it.
+     * If the provided string is not an alias, return the username of the provided alias
+     *
+     * This method is helpful when you don't know if the string you have is a username
+     * or an alias.
+     *
+     * @param usernameOrAlias a string that might be a username or might be an alias
+     */
+    resolveAlias(usernameOrAlias: string): Nullable<string>;
     /**
      * Set an alias for the given aliasable entity
      *
@@ -145,14 +155,24 @@ export declare class AliasAccessor extends AsyncOptionalCreatable {
      * @param entity the aliasable entity that's being aliased
      */
     set(alias: string, entity: Aliasable): void;
+    /**
+     * Unset the given alias.
+     *
+     */
     unset(alias: string): void;
     /**
-     * This method unsets all the aliases for the given entity.
+     * Unsets all the aliases for the given entity.
      *
      * @param entity the aliasable entity for which you want to unset all aliases
      */
     unsetAll(entity: Aliasable): void;
     write(): Promise<ConfigContents>;
+    /**
+     * Returns true if the provided alias exists
+     *
+     * @param alias the alias you want to check
+     */
+    has(alias: string): boolean;
     protected init(): Promise<void>;
     /**
      * Returns the username of given aliasable entity

package/lib/stateAggregator/accessors/aliasAccessor.js

@@ -202,6 +202,21 @@ class AliasAccessor extends kit_1.AsyncOptionalCreatable {
         var _a;
         return (_a = this.getUsername(usernameOrAlias)) !== null && _a !== void 0 ? _a : usernameOrAlias;
     }
+    /**
+     * If the provided string is an alias, return it.
+     * If the provided string is not an alias, return the username of the provided alias
+     *
+     * This method is helpful when you don't know if the string you have is a username
+     * or an alias.
+     *
+     * @param usernameOrAlias a string that might be a username or might be an alias
+     */
+    resolveAlias(usernameOrAlias) {
+        var _a;
+        if (this.has(usernameOrAlias))
+            return usernameOrAlias;
+        return (_a = Object.entries(this.getAll()).find(([, username]) => username === usernameOrAlias)) === null || _a === void 0 ? void 0 : _a[0];
+    }
     /**
      * Set an alias for the given aliasable entity
      *
@@ -211,11 +226,15 @@ class AliasAccessor extends kit_1.AsyncOptionalCreatable {
     set(alias, entity) {
         this.config.set(alias, this.getNameOf(entity));
     }
+    /**
+     * Unset the given alias.
+     *
+     */
     unset(alias) {
         this.config.unset(alias);
     }
     /**
-     * This method unsets all the aliases for the given entity.
+     * Unsets all the aliases for the given entity.
      *
      * @param entity the aliasable entity for which you want to unset all aliases
      */
@@ -226,6 +245,14 @@ class AliasAccessor extends kit_1.AsyncOptionalCreatable {
     async write() {
         return this.config.write();
     }
+    /**
+     * Returns true if the provided alias exists
+     *
+     * @param alias the alias you want to check
+     */
+    has(alias) {
+        return this.config.has(alias);
+    }
     async init() {
         this.config = await aliasesConfig_1.AliasesConfig.create(aliasesConfig_1.AliasesConfig.getDefaultOptions());
     }

package/lib/util/directoryWriter.d.ts

@@ -0,0 +1,11 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
+import { StructuredWriter } from './structuredWriter';
+export declare class DirectoryWriter implements StructuredWriter {
+    private readonly rootDestination?;
+    constructor(rootDestination?: string | undefined);
+    addToStore(contents: string | Readable | Buffer, targetPath: string): Promise<void>;
+    finalize(): Promise<void>;
+    getDestinationPath(): string | undefined;
+    get buffer(): Buffer;
+}

package/lib/util/directoryWriter.js

@@ -0,0 +1,52 @@
+"use strict";
+/*
+ * Copyright (c) 2021, 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.DirectoryWriter = void 0;
+const stream_1 = require("stream");
+const fs = require("fs");
+const os = require("os");
+const path = require("path");
+const util_1 = require("util");
+const pipeline = (0, util_1.promisify)(stream_1.pipeline);
+class DirectoryWriter {
+    constructor(rootDestination) {
+        this.rootDestination = rootDestination;
+        if (!this.rootDestination) {
+            this.rootDestination = fs.mkdtempSync(`${os.tmpdir()}${path.sep}`);
+        }
+        else {
+            fs.mkdirSync(this.rootDestination, { recursive: true });
+        }
+    }
+    async addToStore(contents, targetPath) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const destPath = path.join(this.rootDestination, targetPath);
+        fs.mkdirSync(path.dirname(destPath), { recursive: true });
+        if (contents instanceof stream_1.Readable) {
+            const writeStream = fs.createWriteStream(destPath);
+            await pipeline(contents, writeStream);
+        }
+        else if (typeof contents === 'string') {
+            fs.writeFileSync(destPath, contents);
+        }
+        else if (contents instanceof Buffer) {
+            fs.writeFileSync(destPath, contents);
+        }
+    }
+    finalize() {
+        return Promise.resolve(undefined);
+    }
+    getDestinationPath() {
+        return this.rootDestination;
+    }
+    get buffer() {
+        throw new Error('Not implemented');
+    }
+}
+exports.DirectoryWriter = DirectoryWriter;
+//# sourceMappingURL=directoryWriter.js.map

package/lib/util/structuredWriter.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
+export interface StructuredWriter {
+    addToStore(contents: string | Readable | Buffer, path: string): Promise<void>;
+    finalize(): Promise<void>;
+    getDestinationPath(): string | undefined;
+    get buffer(): Buffer;
+}

package/lib/util/structuredWriter.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=structuredWriter.js.map

package/lib/util/zipWriter.d.ts

@@ -1,13 +1,14 @@
 /// <reference types="node" />
-import { pipeline as cbPipeline, Readable, Writable } from 'stream';
-export declare const pipeline: typeof cbPipeline.__promisify__;
-export declare class ZipWriter extends Writable {
-    private rootDestination?;
+import { Readable, Writable } from 'stream';
+import { StructuredWriter } from './structuredWriter';
+export declare class ZipWriter extends Writable implements StructuredWriter {
+    private readonly rootDestination?;
     private zip;
     private buffers;
     constructor(rootDestination?: string | undefined);
-    addToZip(contents: string | Readable | Buffer, path: string): void;
+    addToStore(contents: string | Readable | Buffer, path: string): Promise<void>;
     finalize(): Promise<void>;
+    getDestinationPath(): string | undefined;
     private getOutputStream;
     private getInputBuffer;
     get buffer(): Buffer;

package/lib/util/zipWriter.js

@@ -6,12 +6,12 @@
  * 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.ZipWriter = exports.pipeline = void 0;
+exports.ZipWriter = void 0;
 const fs_1 = require("fs");
 const stream_1 = require("stream");
 const util_1 = require("util");
 const archiver_1 = require("archiver");
-exports.pipeline = (0, util_1.promisify)(stream_1.pipeline);
+const pipeline = (0, util_1.promisify)(stream_1.pipeline);
 class ZipWriter extends stream_1.Writable {
     constructor(rootDestination) {
         super({ objectMode: true });
@@ -21,15 +21,19 @@ class ZipWriter extends stream_1.Writable {
         // higher values = diminishing returns on compression and made conversion slower
         this.zip = (0, archiver_1.create)('zip', { zlib: { level: 3 } });
         this.buffers = [];
-        void (0, exports.pipeline)(this.zip, this.getOutputStream());
+        void pipeline(this.zip, this.getOutputStream());
     }
-    addToZip(contents, path) {
+    async addToStore(contents, path) {
         this.zip.append(contents, { name: path });
+        return Promise.resolve();
     }
     async finalize() {
         await this.zip.finalize();
         await this.getInputBuffer();
     }
+    getDestinationPath() {
+        return this.rootDestination;
+    }
     getOutputStream() {
         if (this.rootDestination) {
             return (0, fs_1.createWriteStream)(this.rootDestination);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.23.4",
+  "version": "3.23.7",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -60,6 +60,7 @@
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.3.21",
     "@types/archiver": "^5.3.1",
+    "@types/chai-string": "^1.4.2",
     "@types/debug": "0.0.31",
     "@types/jsen": "0.0.21",
     "@types/jsonwebtoken": "8.5.7",
@@ -68,6 +69,7 @@
     "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@typescript-eslint/parser": "4.33.0",
     "chai": "^4.3.4",
+    "chai-string": "^1.5.0",
     "commitizen": "^3.1.2",
     "eslint": "^7.27.0",
     "eslint-config-prettier": "^6.15.0",