salesforce-alm/dist/lib/core/fileKeyValueStore.js

This package contains tools, and APIs, for an improved salesforce.com developer experience.

"use strict";
/*
 * Copyright (c) 2020, 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.FileKeyValueStore = void 0;
/* --------------------------------------------------------------------------------------------------------------------
 * WARNING: This file has been deprecated and should now be considered locked against further changes.  Its contents
 * have been partially or wholly superseded by functionality included in the @salesforce/core npm package, and exists
 * now to service prior uses in this repository only until they can be ported to use the new @salesforce/core library.
 *
 * If you need or want help deciding where to add new functionality or how to migrate to the new library, please
 * contact the CLI team at alm-cli@salesforce.com.
 * ----------------------------------------------------------------------------------------------------------------- */
const _ = require("lodash");
const srcDevUtil = require("./srcDevUtil");
const _set = (aliases, group, alias, property) => {
    if (_.isNil(aliases[group])) {
        aliases[group] = {};
    }
    if (_.isUndefined(property)) {
        delete aliases[group][alias];
    }
    else {
        const value = _.entries(aliases[group]).find((val) => val[1] === property);
        if (value) {
            delete aliases[group][value[0]];
        }
        aliases[group][alias] = property;
    }
    return aliases;
};
/**
 * Manages access to a key value store in the global .sfdx folder under <fileStoreName>.
 *
 * All key value pairs are stored under a group.
 *
 */
class FileKeyValueStore {
    constructor(fileName) {
        this.fileStoreName = fileName;
    }
    /**
     * Set a group of aliases in a bulk save.
     *
     * @param {array} keyAndValues An object representing the aliases to set.
     * @param {string} group The group the alias belongs to.
     * @returns {Promise<object>} The new aliases that were saved.
     */
    setValues(newAliases, group = 'default') {
        return srcDevUtil
            .getGlobalConfig(this.fileStoreName, {})
            .then((aliases) => {
            _.forEach(newAliases, (val, key) => _set(aliases, group, key, val));
            return aliases;
        })
            .then((aliases) => srcDevUtil.saveGlobalConfig(this.fileStoreName, aliases))
            .then(() => newAliases);
    }
    /**
     * Delete an alias from a group
     *
     * @param {string} alias The name of the alias to delete
     * @param {string} group The group the alias belongs to. Defaults to Orgs
     * @returns {Promise} The promise resolved when the alias is deleted
     */
    delete(alias, group = 'default') {
        return this.set(alias, undefined, group);
    }
    /**
     * Set an alias on a group
     *
     * @param {string} alias The name of the alias to set
     * @param {string} property The value of the alias
     * @param {string} group The group the alias belongs to. Defaults to Orgs
     * @returns {Promise} The promise resolved when the alias is set
     */
    set(alias, property, group = 'default') {
        return srcDevUtil
            .getGlobalConfig(this.fileStoreName, {})
            .then((aliases) => _set(aliases, group, alias, property))
            .then((aliases) => srcDevUtil.saveGlobalConfig(this.fileStoreName, aliases));
    }
    /**
     * Unset one or more aliases on a group
     *
     * @param {string[]} aliases The names of the aliases to unset
     * @param {string} group The group the alias belongs to. Defaults to Orgs
     * @returns {Promise} The promise resolved when the aliases are unset
     */
    unset(aliasesToUnset, group = 'default') {
        return srcDevUtil
            .getGlobalConfig(this.fileStoreName, {})
            .then((aliases) => {
            aliases[group] = _.omit(aliases[group], aliasesToUnset);
            return aliases;
        })
            .then((aliases) => srcDevUtil.saveGlobalConfig(this.fileStoreName, aliases));
    }
    /**
     * Get an alias from a group
     *
     * @param {string} alias The name of the alias to get
     * @param {string} group The group the alias belongs to. Defaults to Orgs
     * @returns {Promise} The promise resolved when the alias is retrieved
     */
    get(alias, group = 'default') {
        return this.list(group).then((aliases) => aliases[alias]);
    }
    /**
     * Get all alias from a group
     *
     * @param {string} group The group of aliases to retrieve. Defaults to Orgs
     * @returns {Promise} The promise resolved when the aliases are retrieved
     */
    list(group = 'default') {
        return srcDevUtil.getGlobalConfig(this.fileStoreName, {}).then((aliases) => aliases[group] || {});
    }
    /**
     * Get an alias from a group by value
     *
     * @param {string} value The value of the alias to match
     * @param {string} group The group the alias belongs to. Defaults to Orgs
     * @returns {Promise} The promise resolved when the alias is retrieved
     */
    byValue(value, group = 'default') {
        return this.list(group).then((aliases) => Object.keys(aliases).find((key) => aliases[key] === value));
    }
}
exports.FileKeyValueStore = FileKeyValueStore;

//# sourceMappingURL=fileKeyValueStore.js.map