@salesforce/core 5.4.0-crdt.1 → 6.1.0

package/lib/config/configFile.js

@@ -7,17 +7,16 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigFile = void 0;
-const fs = require("fs");
-const fs_1 = require("fs");
-const os_1 = require("os");
-const path_1 = require("path");
-const proper_lockfile_1 = require("proper-lockfile");
+const fs = require("node:fs");
+const node_fs_1 = require("node:fs");
+const node_os_1 = require("node:os");
+const node_path_1 = require("node:path");
 const kit_1 = require("@salesforce/kit");
 const global_1 = require("../global");
 const logger_1 = require("../logger/logger");
 const sfError_1 = require("../sfError");
 const internal_1 = require("../util/internal");
-const lockRetryOptions_1 = require("../util/lockRetryOptions");
+const fileLocking_1 = require("../util/fileLocking");
 const configStore_1 = require("./configStore");
 const lwwMap_1 = require("./lwwMap");
 /**
@@ -90,7 +89,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
      * @param isGlobal True if the config should be global. False for local.
      */
     static async resolveRootFolder(isGlobal) {
-        return isGlobal ? (0, os_1.homedir)() : (0, internal_1.resolveProjectPath)();
+        return isGlobal ? (0, node_os_1.homedir)() : (0, internal_1.resolveProjectPath)();
     }
     /**
      * Helper used to determine what the local and global folder point to. Returns the file path of the root folder.
@@ -98,7 +97,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
      * @param isGlobal True if the config should be global. False for local.
      */
     static resolveRootFolderSync(isGlobal) {
-        return isGlobal ? (0, os_1.homedir)() : (0, internal_1.resolveProjectPathSync)();
+        return isGlobal ? (0, node_os_1.homedir)() : (0, internal_1.resolveProjectPathSync)();
     }
     /**
      * Determines if the config file is read/write accessible. Returns `true` if the user has capabilities specified
@@ -148,7 +147,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
             // Only need to read config files once.  They are kept up to date
             // internally and updated persistently via write().
             if (!this.hasRead || force) {
-                this.logger.info(`Reading config file: ${this.getPath()} because ${!this.hasRead ? 'hasRead is false' : 'force parameter is true'}`);
+                this.logger.debug(`Reading config file: ${this.getPath()} because ${!this.hasRead ? 'hasRead is false' : 'force parameter is true'}`);
                 const obj = (0, kit_1.parseJsonMap)(await fs.promises.readFile(this.getPath(), 'utf8'), this.getPath());
                 this.setContentsFromFileContents(obj, (await fs.promises.stat(this.getPath(), { bigint: true })).mtimeNs);
             }
@@ -161,7 +160,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
             this.hasRead = true;
             if (err.code === 'ENOENT') {
                 if (!throwOnNotFound) {
-                    this.setContentsFromFileContents({}, process.hrtime.bigint());
+                    this.setContentsFromFileContents({});
                     return this.getContents();
                 }
             }
@@ -184,7 +183,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
             // Only need to read config files once.  They are kept up to date
             // internally and updated persistently via write().
             if (!this.hasRead || force) {
-                this.logger.info(`Reading config file: ${this.getPath()}`);
+                this.logger.debug(`Reading config file: ${this.getPath()}`);
                 const obj = (0, kit_1.parseJsonMap)(fs.readFileSync(this.getPath(), 'utf8'));
                 this.setContentsFromFileContents(obj, fs.statSync(this.getPath(), { bigint: true }).mtimeNs);
             }
@@ -197,7 +196,7 @@ class ConfigFile extends configStore_1.BaseConfigStore {
             this.hasRead = true;
             if (err.code === 'ENOENT') {
                 if (!throwOnNotFound) {
-                    this.setContentsFromFileContents({}, process.hrtime.bigint());
+                    this.setContentsFromFileContents({});
                     return this.getContents();
                 }
             }
@@ -216,39 +215,18 @@ class ConfigFile extends configStore_1.BaseConfigStore {
      * @param newContents The new contents of the file.
      */
     async write() {
-        // make sure we can write to the directory
-        try {
-            await fs.promises.mkdir((0, path_1.dirname)(this.getPath()), { recursive: true });
-        }
-        catch (err) {
-            throw sfError_1.SfError.wrap(err);
-        }
-        let unlockFn;
+        const lockResponse = await (0, fileLocking_1.lockInit)(this.getPath());
         // lock the file.  Returns an unlock function to call when done.
         try {
-            unlockFn = await (0, proper_lockfile_1.lock)(this.getPath(), lockRetryOptions_1.lockRetryOptions);
-            // get the file modstamp.  Do this after the lock acquisition in case the file is being written to.
             const fileTimestamp = (await fs.promises.stat(this.getPath(), { bigint: true })).mtimeNs;
-            // read the file contents into a LWWMap using the modstamp
-            const stateFromFile = (0, lwwMap_1.stateFromContents)((0, kit_1.parseJsonMap)(await fs.promises.readFile(this.getPath(), 'utf8'), this.getPath()), fileTimestamp, this.getPath());
-            // merge the new contents into the in-memory LWWMap
-            this.contents.merge(stateFromFile);
+            const fileContents = (0, kit_1.parseJsonMap)(await fs.promises.readFile(this.getPath(), 'utf8'), this.getPath());
+            this.logAndMergeContents(fileTimestamp, fileContents);
         }
         catch (err) {
-            if (err instanceof Error && err.message.includes('ENOENT')) {
-                this.logger.debug(`No file found at ${this.getPath()}.  Write will create it.`);
-            }
-            else {
-                throw err;
-            }
+            this.handleWriteError(err);
         }
         // write the merged LWWMap to file
-        this.logger.info(`Writing to config file: ${this.getPath()}`);
-        await fs.promises.writeFile(this.getPath(), JSON.stringify(this.toObject(), null, 2));
-        // unlock the file
-        if (typeof unlockFn !== 'undefined') {
-            await unlockFn();
-        }
+        await lockResponse.writeAndUnlock(JSON.stringify(this.getContents(), null, 2));
         return this.getContents();
     }
     /**
@@ -258,51 +236,31 @@ class ConfigFile extends configStore_1.BaseConfigStore {
      * @param newContents The new contents of the file.
      */
     writeSync() {
+        const lockResponse = (0, fileLocking_1.lockInitSync)(this.getPath());
         try {
-            fs.mkdirSync((0, path_1.dirname)(this.getPath()), { recursive: true });
-        }
-        catch (err) {
-            throw sfError_1.SfError.wrap(err);
-        }
-        let unlockFn;
-        try {
-            // lock the file.  Returns an unlock function to call when done.
-            unlockFn = (0, proper_lockfile_1.lockSync)(this.getPath(), lockRetryOptions_1.lockOptions);
             // get the file modstamp.  Do this after the lock acquisition in case the file is being written to.
             const fileTimestamp = fs.statSync(this.getPath(), { bigint: true }).mtimeNs;
-            // read the file contents into a LWWMap using the modstamp
-            const stateFromFile = (0, lwwMap_1.stateFromContents)((0, kit_1.parseJsonMap)(fs.readFileSync(this.getPath(), 'utf8'), this.getPath()), fileTimestamp, this.getPath());
-            // merge the new contents into the in-memory LWWMap
-            this.contents.merge(stateFromFile);
+            const fileContents = (0, kit_1.parseJsonMap)(fs.readFileSync(this.getPath(), 'utf8'), this.getPath());
+            this.logAndMergeContents(fileTimestamp, fileContents);
         }
         catch (err) {
-            if (err instanceof Error && err.message.includes('ENOENT')) {
-                this.logger.debug(`No file found at ${this.getPath()}.  Write will create it.`);
-            }
-            else {
-                throw err;
-            }
+            this.handleWriteError(err);
         }
         // write the merged LWWMap to file
-        this.logger.info(`Writing to config file: ${this.getPath()}`);
-        fs.writeFileSync(this.getPath(), JSON.stringify(this.toObject(), null, 2));
-        if (typeof unlockFn !== 'undefined') {
-            // unlock the file
-            unlockFn();
-        }
+        lockResponse.writeAndUnlock(JSON.stringify(this.getContents(), null, 2));
         return this.getContents();
     }
     /**
      * Check to see if the config file exists. Returns `true` if the config file exists and has access, false otherwise.
      */
     async exists() {
-        return this.access(fs_1.constants.R_OK);
+        return this.access(node_fs_1.constants.R_OK);
     }
     /**
      * Check to see if the config file exists. Returns `true` if the config file exists and has access, false otherwise.
      */
     existsSync() {
-        return this.accessSync(fs_1.constants.R_OK);
+        return this.accessSync(node_fs_1.constants.R_OK);
     }
     /**
      * Get the stats of the file. Returns the stats of the file.
@@ -363,9 +321,9 @@ class ConfigFile extends configStore_1.BaseConfigStore {
                 ? this.options.rootFolder
                 : ConfigFile.resolveRootFolderSync(Boolean(this.options.isGlobal));
             if (this.options.isGlobal === true || this.options.isState === true) {
-                configRootFolder = (0, path_1.join)(configRootFolder, this.options.stateFolder ?? global_1.Global.SFDX_STATE_FOLDER);
+                configRootFolder = (0, node_path_1.join)(configRootFolder, this.options.stateFolder ?? global_1.Global.SFDX_STATE_FOLDER);
             }
-            this.path = (0, path_1.join)(configRootFolder, this.options.filePath ? this.options.filePath : '', this.options.filename);
+            this.path = (0, node_path_1.join)(configRootFolder, this.options.filePath ? this.options.filePath : '', this.options.filename);
         }
         return this.path;
     }
@@ -386,6 +344,25 @@ class ConfigFile extends configStore_1.BaseConfigStore {
         // Read the file, which also sets the path and throws any errors around project paths.
         await this.read(this.options.throwOnNotFound);
     }
+    // method exists to share code between write() and writeSync()
+    logAndMergeContents(fileTimestamp, fileContents) {
+        this.logger.debug(`Existing file contents on filesystem (timestamp: ${fileTimestamp.toString()}`, fileContents);
+        this.logger.debug('Contents in configFile in-memory', this.getContents());
+        // read the file contents into a LWWMap using the modstamp
+        const stateFromFile = (0, lwwMap_1.stateFromContents)(fileContents, fileTimestamp);
+        // merge the new contents into the in-memory LWWMap
+        this.contents.merge(stateFromFile);
+        this.logger.debug('Result from merge', this.getContents());
+    }
+    // shared error handling for both write() and writeSync()
+    handleWriteError(err) {
+        if (err instanceof Error && err.message.includes('ENOENT')) {
+            this.logger.debug(`No file found at ${this.getPath()}.  Write will create it.`);
+        }
+        else {
+            throw err;
+        }
+    }
 }
 exports.ConfigFile = ConfigFile;
 //# sourceMappingURL=configFile.js.map

package/lib/config/configStore.d.ts

@@ -22,9 +22,7 @@ export interface ConfigStore<P extends ConfigContents = ConfigContents> {
     clear(): void;
     values(): ConfigValue[];
     forEach(actionFn: (key: string, value: ConfigValue) => void): void;
-    awaitEach(actionFn: (key: string, value: ConfigValue) => Promise<void>): Promise<void>;
     getContents(): P;
-    setContents(contents?: P): void;
 }
 /**
  * An abstract class that implements all the config management functions but
@@ -52,7 +50,7 @@ export declare abstract class BaseConfigStore<T extends BaseConfigStore.Options
     /**
      * Returns the value associated to the key, or undefined if there is none.
      *
-     * @param key The key. Supports query key like `a.b[0]`.
+     * @param key The key (object property)
      * @param decrypt If it is an encrypted key, decrypt the value.
      * If the value is an object, a clone will be returned.
      */
@@ -81,30 +79,28 @@ export declare abstract class BaseConfigStore<T extends BaseConfigStore.Options
      * @param value The value.
      */
     set<K extends Key<P>>(key: K, value: P[K]): void;
-    set<V = ConfigValue>(key: string, value: V): void;
     /**
      * Updates the value for the key in the config object. If the value is an object, it
      * will be merged with the existing object.
      *
-     * @param key The key. Supports query key like `a.b[0]`.
+     * @param key The key.
      * @param value The value.
      */
     update<K extends Key<P>>(key: K, value: Partial<P[K]>): void;
-    update<V = ConfigValue>(key: string, value: Partial<V>): void;
     /**
      * Returns `true` if an element in the config object existed and has been removed, or `false` if the element does not
      * exist. {@link BaseConfigStore.has} will return false afterwards.
      *
      * @param key The key
      */
-    unset(key: string): boolean;
+    unset<K extends Key<P>>(key: K): boolean;
     /**
      * Returns `true` if all elements in the config object existed and have been removed, or `false` if all the elements
      * do not exist (some may have been removed). {@link BaseConfigStore.has(key)} will return false afterwards.
      *
-     * @param keys The keys. Supports query keys like `a.b[0]`.
+     * @param keys The keys
      */
-    unsetAll(keys: string[]): boolean;
+    unsetAll(keys: Array<Key<P>>): boolean;
     /**
      * Removes all key/value pairs from the config object.
      */
@@ -123,27 +119,13 @@ export declare abstract class BaseConfigStore<T extends BaseConfigStore.Options
      * @param decrypt: decrypt all data in the config. A clone of the data will be returned.
      *
      */
-    getContents(decrypt?: boolean): P;
-    /**
-     * Sets the entire config contents.
-     *
-     * @param contents The contents.
-     */
-    setContents(contents?: P): void;
+    getContents(decrypt?: boolean): Readonly<P>;
     /**
      * Invokes `actionFn` once for each key-value pair present in the config object.
      *
      * @param {function} actionFn The function `(key: string, value: ConfigValue) => void` to be called for each element.
      */
     forEach(actionFn: (key: string, value: ConfigValue) => void): void;
-    /**
-     * Asynchronously invokes `actionFn` once for each key-value pair present in the config object.
-     *
-     * @param {function} actionFn The function `(key: string, value: ConfigValue) => Promise<void>` to be called for
-     * each element.
-     * @returns {Promise<void>}
-     */
-    awaitEach(actionFn: (key: string, value: ConfigValue) => Promise<void>): Promise<void>;
     /**
      * Convert the config object to a JSON object. Returns the config contents.
      * Same as calling {@link ConfigStore.getContents}
@@ -154,8 +136,19 @@ export declare abstract class BaseConfigStore<T extends BaseConfigStore.Options
      *
      * @param obj The object.
      */
-    setContentsFromObject<U extends P>(obj: U): void;
-    protected setContentsFromFileContents(contents: P, timestamp: bigint): void;
+    setContentsFromObject(obj: P): void;
+    /**
+     * Keep ConfigFile concurrency-friendly.
+     * Avoid using this unless you're reading the file for the first time
+     * and guaranteed to no be cross-saving existing contents
+     * */
+    protected setContentsFromFileContents(contents: P, timestamp?: bigint): void;
+    /**
+     * Sets the entire config contents.
+     *
+     * @param contents The contents.
+     */
+    protected setContents(contents?: P): void;
     protected getEncryptedKeys(): Array<string | RegExp>;
     /**
      * This config file has encrypted keys and it should attempt to encrypt them.
@@ -163,8 +156,6 @@ export declare abstract class BaseConfigStore<T extends BaseConfigStore.Options
      * @returns Has encrypted keys
      */
     protected hasEncryption(): boolean;
-    protected setMethod(contents: ConfigContents, key: string, value?: ConfigValue): void;
-    protected getMethod(contents: ConfigContents, key: string): Optional<ConfigValue>;
     protected initialContents(): P;
     /**
      * Used to initialize asynchronous components.
@@ -186,7 +177,7 @@ export declare abstract class BaseConfigStore<T extends BaseConfigStore.Options
      */
     protected isCryptoKey(key: string): string | RegExp | undefined;
     protected encrypt(value: unknown): Optional<string>;
-    protected decrypt(value: unknown): Optional<string>;
+    protected decrypt(value: unknown): string | undefined;
     /**
      * Encrypt all values in a nested JsonMap.
      *

package/lib/config/configStore.js

@@ -12,6 +12,7 @@ const ts_types_1 = require("@salesforce/ts-types");
 const ts_types_2 = require("@salesforce/ts-types");
 const crypto_1 = require("../crypto/crypto");
 const sfError_1 = require("../sfError");
+const time_1 = require("../util/time");
 const lwwMap_1 = require("./lwwMap");
 /**
  * An abstract class that implements all the config management functions but
@@ -41,17 +42,16 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
         return (0, ts_types_2.definiteEntriesOf)(this.contents.value ?? {});
     }
     get(key, decrypt = false) {
-        const k = key;
-        let value = this.getMethod(this.contents.value ?? {}, k);
+        const rawValue = this.contents.get(key);
         if (this.hasEncryption() && decrypt) {
-            if ((0, ts_types_2.isJsonMap)(value)) {
-                value = this.recursiveDecrypt((0, kit_1.cloneJson)(value), k);
+            if ((0, ts_types_2.isJsonMap)(rawValue)) {
+                return this.recursiveDecrypt((0, kit_1.cloneJson)(rawValue), key);
             }
-            else if (this.isCryptoKey(k)) {
-                value = this.decrypt(value);
+            else if (this.isCryptoKey(key)) {
+                return this.decrypt(rawValue);
             }
         }
-        return value;
+        return rawValue;
     }
     /**
      * Returns the list of keys that contain a value.
@@ -76,6 +76,13 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
     keys() {
         return Object.keys(this.contents.value ?? {});
     }
+    /**
+     * Sets the value for the key in the config object. This will override the existing value.
+     * To do a partial update, use {@link BaseConfigStore.update}.
+     *
+     * @param key The key.
+     * @param value The value.
+     */
     set(key, value) {
         if (this.hasEncryption()) {
             if ((0, ts_types_2.isJsonMap)(value)) {
@@ -85,21 +92,30 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
                 value = this.encrypt(value);
             }
         }
-        // undefined value means unset
+        // set(key, undefined) means unset
         if (value === undefined) {
             this.unset(key);
         }
         else {
-            // @ts-expect-error TODO: why isn't key guaranteed to be a string
             this.contents.set(key, value);
         }
     }
+    /**
+     * Updates the value for the key in the config object. If the value is an object, it
+     * will be merged with the existing object.
+     *
+     * @param key The key.
+     * @param value The value.
+     */
     update(key, value) {
         const existingValue = this.get(key, true);
         if ((0, ts_types_1.isPlainObject)(existingValue) && (0, ts_types_1.isPlainObject)(value)) {
-            value = Object.assign({}, existingValue, value);
+            const mergedValue = Object.assign({}, existingValue, value);
+            this.set(key, mergedValue);
+        }
+        else {
+            this.set(key, value);
         }
-        this.set(key, value);
     }
     /**
      * Returns `true` if an element in the config object existed and has been removed, or `false` if the element does not
@@ -118,7 +134,7 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
      * Returns `true` if all elements in the config object existed and have been removed, or `false` if all the elements
      * do not exist (some may have been removed). {@link BaseConfigStore.has(key)} will return false afterwards.
      *
-     * @param keys The keys. Supports query keys like `a.b[0]`.
+     * @param keys The keys
      */
     unsetAll(keys) {
         return keys.map((key) => this.unset(key)).every(Boolean);
@@ -151,19 +167,6 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
         }
         return this.contents?.value ?? {};
     }
-    /**
-     * Sets the entire config contents.
-     *
-     * @param contents The contents.
-     */
-    setContents(contents = {}) {
-        if (this.hasEncryption()) {
-            contents = this.recursiveEncrypt(contents);
-        }
-        (0, ts_types_1.entriesOf)(contents).map(([key, value]) => {
-            this.contents.set(key, value);
-        });
-    }
     /**
      * Invokes `actionFn` once for each key-value pair present in the config object.
      *
@@ -172,17 +175,6 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
     forEach(actionFn) {
         this.entries().map((entry) => actionFn(entry[0], entry[1]));
     }
-    /**
-     * Asynchronously invokes `actionFn` once for each key-value pair present in the config object.
-     *
-     * @param {function} actionFn The function `(key: string, value: ConfigValue) => Promise<void>` to be called for
-     * each element.
-     * @returns {Promise<void>}
-     */
-    async awaitEach(actionFn) {
-        const entries = this.entries();
-        await Promise.all(entries.map((entry) => actionFn(entry[0], entry[1])));
-    }
     /**
      * Convert the config object to a JSON object. Returns the config contents.
      * Same as calling {@link ConfigStore.getContents}
@@ -201,9 +193,27 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
             this.set(key, value);
         });
     }
+    /**
+     * Keep ConfigFile concurrency-friendly.
+     * Avoid using this unless you're reading the file for the first time
+     * and guaranteed to no be cross-saving existing contents
+     * */
     setContentsFromFileContents(contents, timestamp) {
-        const state = (0, lwwMap_1.stateFromContents)(contents, timestamp, this.contents.id);
-        this.contents = new lwwMap_1.LWWMap(this.contents.id, state);
+        const state = (0, lwwMap_1.stateFromContents)(contents, timestamp ?? (0, time_1.nowBigInt)());
+        this.contents = new lwwMap_1.LWWMap(state);
+    }
+    /**
+     * Sets the entire config contents.
+     *
+     * @param contents The contents.
+     */
+    setContents(contents = {}) {
+        if (this.hasEncryption()) {
+            contents = this.recursiveEncrypt(contents);
+        }
+        (0, ts_types_1.entriesOf)(contents).map(([key, value]) => {
+            this.contents.set(key, value);
+        });
     }
     getEncryptedKeys() {
         return [...(this.options?.encryptedKeys ?? []), ...(this.statics?.encryptedKeys ?? [])];
@@ -216,19 +226,6 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
     hasEncryption() {
         return this.getEncryptedKeys().length > 0;
     }
-    // Allows extended classes the ability to override the set method. i.e. maybe they want
-    // nested object set from kit.
-    // eslint-disable-next-line class-methods-use-this
-    setMethod(contents, key, value) {
-        (0, kit_1.set)(contents, key, value);
-    }
-    // Allows extended classes the ability to override the get method. i.e. maybe they want
-    // nested object get from ts-types.
-    // NOTE: Key must stay string to be reliably overwritten.
-    // eslint-disable-next-line class-methods-use-this
-    getMethod(contents, key) {
-        return (0, ts_types_2.get)(contents, key);
-    }
     // eslint-disable-next-line class-methods-use-this
     initialContents() {
         return {};
@@ -291,7 +288,7 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
         if (!this.crypto)
             throw new sfError_1.SfError('crypto is not initialized', 'CryptoNotInitializedError');
         if (!(0, ts_types_2.isString)(value))
-            throw new sfError_1.SfError(`can only encrypt strings but found: ${typeof value} : ${value.toString()}`, 'InvalidCryptoValueError');
+            throw new sfError_1.SfError(`can only encrypt strings but found: ${typeof value} : ${JSON.stringify(value)}`, 'InvalidCryptoValueError');
         return this.crypto.isEncrypted(value) ? value : this.crypto.encrypt(value);
     }
     decrypt(value) {
@@ -300,7 +297,7 @@ class BaseConfigStore extends kit_1.AsyncOptionalCreatable {
         if (!this.crypto)
             throw new sfError_1.SfError('crypto is not initialized', 'CryptoNotInitializedError');
         if (!(0, ts_types_2.isString)(value))
-            throw new sfError_1.SfError(`can only encrypt strings but found: ${typeof value} : ${value.toString()}`, 'InvalidCryptoValueError');
+            throw new sfError_1.SfError(`can only encrypt strings but found: ${typeof value} : ${JSON.stringify(value)}`, 'InvalidCryptoValueError');
         return this.crypto.isEncrypted(value) ? this.crypto.decrypt(value) : value;
     }
     /**

package/lib/config/envVars.js

@@ -7,11 +7,12 @@ exports.envVars = exports.EnvVars = exports.SUPPORTED_ENV_VARS = exports.Environ
  * 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
  */
-const path_1 = require("path");
+const node_path_1 = require("node:path");
 const change_case_1 = require("change-case");
 const kit_1 = require("@salesforce/kit");
 const messages_1 = require("../messages");
 const lifecycleEvents_1 = require("../lifecycleEvents");
+;
 const messages = new messages_1.Messages('@salesforce/core', 'envVars', new Map([["forceOpenUrl", "Web page that opens in your browser when you connect to an org. For example, to open Lightning Experience, set to \"lightning\"."], ["forceShowSpinner", "Set to true to show a spinner animation on the command line when running asynchronous CLI commands. Default is false."], ["forceSpinnerDelay", "Speed of the spinner in milliseconds. Default is 60."], ["httpProxy", "HTTP URL and port of the proxy server when using Salesforce CLI behind a corporate firewall or web proxy."], ["httpsProxy", "HTTPS URL and port of the proxy server when using Salesforce CLI behind a corporate firewall or web proxy."], ["nodeExtraCaCerts", "Fully qualified path to your self-signed certificate. Will be installed after you run \"sfdx update\"."], ["nodeTlsRejectUnauthorized", "Set to 0 to allow Node.js to use the self-signed certificate in the certificate chain."], ["sfdxAccessToken", "Specifies an access token when using the auth:accesstoken:store command."], ["sfdxApiVersion", "The API version for a specific project or all projects. Default value is the API version of your Dev Hub. Overrides the apiVersion config value."], ["sfdxAudienceUrl", "URL that overrides the aud (audience) field used for JWT authentication so that it matches the expected value of the authorization server URL for the org you\u2019re logging into."], ["sfdxCodeCoverageRequirement", "Code coverage percentages that are displayed in green when you run force:apex:test:\\* with the --codecoverage parameter."], ["sfdxContentType", "Set to JSON so that all CLI commands output results in JSON format."], ["sfdxDefaultdevhubusername", "Username or alias of your default Dev Hub org. Overrides the defaultdevhubusername configuration value."], ["sfdxDefaultusername", "Username or alias of your default org. Overrides the defaultusername configuration value."], ["sfdxDisableAutoupdate", "Set to true to disable the auto-update feature of Salesforce CLI. Default value is false."], ["sfdxAutoupdateDisable", "Set to true to disable the auto-update feature of Salesforce CLI. Default value is false."], ["sfdxDisableSourceMemberPolling", "Set to true to disable polling of your org\u2019s SourceMember object when you run the force:source:push|pull commands. Default value is false."], ["sfdxDisableTelemetry", "Set to true to disable Salesforce CLI from collecting usage information, user environment information, and crash reports. Default value is false. Overrides the disableTelemetry configration variable."], ["sfdxDnsTimeout", "Number of seconds that the force:org:\\* commands wait for a response when checking whether an org is connected. Default value is 3."], ["sfdxDomainRetry", "Time, in seconds, that Salesforce CLI waits for the Lightning Experience custom domain to resolve and become available in a scratch org. Default value is 240."], ["sfdxImprovedCodeCoverage", "Set to true to scope Apex test results to the classes entered during a test run when running force:apex:test:\\*."], ["sfdxInstanceUrl", "URL of the Salesforce instance that is hosting your org. Default value is https://login.salesforce.com. Overrides the instanceUrl configuration value."], ["sfdxJsonToStdout", "Set to true to send messages resulting from failed Salesforce CLI commands to stdout instead of stderr."], ["sfdxDisableLogFile", "Set to true to disable log file writing"], ["sfdxLogLevel", "Level of messages that the CLI writes to the log file. Valid values are trace, debug, info, warn, error, fatal. Default value is warn."], ["sfdxLogRotationCount", "The default rotation period for logs. Example '1d' will rotate logs daily (at midnight)."], ["sfdxLogRotationPeriod", "The number of backup rotated log files to keep. Example: '3' will have the base sf.log file, and the past 3 (period) log files."], ["sfdxMaxQueryLimit", "Maximum number of Salesforce records returned by a CLI command. Default value is 10,000. Overrides the maxQueryLimit configuration value."], ["sfdxMdapiTempDir", "Directory that contains files (in metadata format) when running certain Salesforce CLI commands, such as force:source:\\*."], ["sfdxNpmRegistry", "URL to a private npm server, where all packages that you publish are private."], ["sfdxPrecompileEnable", "Set to true to enable Apex pre-compile before the tests are run with the force:apex:test:run command. Default is false."], ["sfdxProjectAutoupdateDisableForPackageCreate", "Set to true to disable automatic updates to sfdx-project.json when running force:package:create."], ["sfdxProjectAutoupdateDisableForPackageVersionCreate", "Set to true to disable automatic updates to sfdx-project.json when running force:package:version:create."], ["sfdxRestDeploy", "Set to true to make Salesforce CLI use the Metadata REST API for deployments. By default, the CLI uses SOAP."], ["sfdxSourceMemberPollingTimeout", "Number of seconds you want the force:source:push command to keep polling the SourceMember object before the command times out."], ["sfdxUseGenericUnixKeychain", "(Linux and macOS only) Set to true if you want to use the generic UNIX keychain instead of the Linux libsecret library or macOS keychain."], ["sfdxUseProgressBar", "Set to false to disable the progress bar when running force:mdapi:deploy, force:source:deploy, or force:source:push."], ["sfdxLazyLoadModules", "Set to true to enable lazy loading of sfdx modules"], ["sfdxS3Host", "URL to S3 host"], ["sfdxUpdateInstructions", "Text that describes how to update sfdx"], ["sfdxInstaller", "Boolean indicating that the installer is running"], ["sfdxEnv", "Describes if sfdx is in \"demo\" mode"], ["sfTargetOrg", "Username or alias of your default org. Overrides the target-org configuration variable."], ["sfTargetDevHub", "Username or alias of your default Dev Hub org. Overrides the target-dev-hub configuration variable."], ["sfAccessToken", "Specifies an access token when using a login command that uses access tokens."], ["sfOrgApiVersion", "API version for a specific project or all projects. Default value is the API version of your Dev Hub. Overrides the apiVersion configuration variable."], ["sfAudienceUrl", "URL that overrides the aud (audience) field used for JWT authentication so that it matches the expected value of the authorization server URL for the org you\u2019re logging into."], ["sfCodeCoverageRequirement", "Code coverage percentages that are displayed in green when you run the Apex test CLIcommands with the --code-coverage flag."], ["sfContentType", "Set to JSON so that all CLI commands output results in JSON format."], ["sfDisableAutoupdate", "Set to true to disable the auto-update feature of Salesforce CLI. Default value is false."], ["sfAutoupdateDisable", "Set to true to disable the auto-update feature of Salesforce CLI. Default value is false."], ["sfDisableSourceMemberPolling", "Set to true to disable polling of your org\u2019s SourceMember object when you run the commands to push and pull source. Default value is false."], ["sfDisableTelemetry", "Set to true to disable Salesforce CLI from collecting usage information, user environment information, and crash reports. Default value is false. Overrides the disableTelemetry configration variable."], ["sfDnsTimeout", "Number of seconds that the env commands wait for a response when checking whether an org is connected. Default value is 3."], ["sfDomainRetry", "Time, in seconds, that Salesforce CLI waits for the Lightning Experience custom domain to resolve and become available in a scratch org. Default value is 240."], ["sfImprovedCodeCoverage", "Set to true to scope Apex test results to the classes entered during a test run when running the Apex test commands."], ["sfOrgInstanceUrl", "URL of the Salesforce instance that is hosting your org. Default value is https://login.salesforce.com. Overrides the instanceUrl configuration variable."], ["sfJsonToStdout", "Set to true to send messages resulting from failed Salesforce CLI commands to stdout instead of stderr."], ["sfDisableLogFile", "Set to true to disable log file writing"], ["sfLogLevel", "Level of messages that the CLI writes to the log file. Valid values are trace, debug, info, warn, error, fatal. Default value is warn."], ["sfLogRotationCount", "The default rotation period for logs. Example '1d' will rotate logs daily (at midnight)."], ["sfLogRotationPeriod", "The number of backup rotated log files to keep. Example: '3' will have the base sf.log file, and the past 3 (period) log files."], ["sfOrgMaxQueryLimit", "Maximum number of Salesforce records returned by a CLI command. Default value is 10,000. Overrides the maxQueryLimit configuration variable."], ["sfMdapiTempDir", "Directory that contains files (in metadata format) when running certain Salesforce CLI commands."], ["sfNpmRegistry", "URL to a private npm server, where all packages that you publish are private."], ["sfPrecompileEnable", "Set to true to enable Apex pre-compile before the tests are run with the Apex test run command. Default is false."], ["sfProjectAutoupdateDisableForPackageCreate", "Set to true to disable automatic updates to sfdx-project.json when running the package create command."], ["sfProjectAutoupdateDisableForPackageVersionCreate", "Set to true to disable automatic updates to sfdx-project.json when running the package version create command."], ["sfSourceMemberPollingTimeout", "Number of seconds you want the source push command to keep polling the SourceMember object before the command times out."], ["sfUseGenericUnixKeychain", "(Linux and macOS only) Set to true if you want to use the generic UNIX keychain instead of the Linux libsecret library or macOS keychain."], ["sfUseProgressBar", "Set to false to disable the progress bar when running the metadata deploy command."], ["sfLazyLoadModules", "Set to true to enable lazy loading of sf modules"], ["sfS3Host", "URL to S3 host"], ["sfUpdateInstructions", "Text that describes how to update sf"], ["sfInstaller", "Boolean indicating that the installer is running"], ["sfEnv", "Describes if sf is in \"demo\" mode"], ["deprecatedEnv", "Deprecated environment variable: %s. Please use %s instead."], ["deprecatedEnvDisagreement", "Deprecated environment variable: %s. Please use %s instead.\n\nYour environment has both variables populated, and with different values. The value from %s will be used."]]));
 var EnvironmentVariable;
 (function (EnvironmentVariable) {
@@ -91,7 +92,7 @@ var EnvironmentVariable;
     EnvironmentVariable["SF_UPDATE_INSTRUCTIONS"] = "SF_UPDATE_INSTRUCTIONS";
     EnvironmentVariable["SF_INSTALLER"] = "SF_INSTALLER";
     EnvironmentVariable["SF_ENV"] = "SF_ENV";
-})(EnvironmentVariable = exports.EnvironmentVariable || (exports.EnvironmentVariable = {}));
+})(EnvironmentVariable || (exports.EnvironmentVariable = EnvironmentVariable = {}));
 const getMessage = (environmentVariable) => messages.getMessage((0, change_case_1.camelCase)(environmentVariable));
 exports.SUPPORTED_ENV_VARS = {
     [EnvironmentVariable.FORCE_SHOW_SPINNER]: {

package/lib/config/lwwMap.d.ts

@@ -8,18 +8,17 @@ export type LWWState<P> = {
  * @param contents object aligning with ConfigContents
  * @param timestamp a bigInt that sets the timestamp.  Defaults to the current time
  * construct a LWWState from an object
- *
+ * @param keysToCheckForDeletion if a key is in this array, AND not in the contents, it will be marked as deleted
  * */
-export declare const stateFromContents: <P extends ConfigContents<import("@salesforce/ts-types").AnyJson>>(contents: P, timestamp?: bigint, id?: string) => LWWState<P>;
+export declare const stateFromContents: <P extends ConfigContents>(contents: P, timestamp?: bigint) => LWWState<P>;
 export declare class LWWMap<P extends ConfigContents> {
     #private;
-    readonly id: string;
-    constructor(id?: string, state?: LWWState<P>);
+    constructor(state?: LWWState<P>);
     get value(): P;
     get state(): LWWState<P>;
     merge(state: LWWState<P>): LWWState<P>;
     set<K extends Key<P>>(key: K, value: P[K]): void;
     get<K extends Key<P>>(key: K): P[K] | undefined;
-    delete(key: string): void;
+    delete<K extends Key<P>>(key: K): void;
     has(key: string): boolean;
 }