@salesforce/core 4.0.0 → 4.1.0

package/lib/config/keychainConfig.d.ts

@@ -1,19 +0,0 @@
-import { ConfigFile } from './configFile';
-import { ConfigContents } from './configStore';
-/**
- * Represent a key chain config backed by a json file.
- */
-export declare class KeychainConfig extends ConfigFile<ConfigFile.Options> {
-    static getFileName(): string;
-    /**
-     * Gets default options for the KeychainConfig
-     */
-    static getDefaultOptions(): ConfigFile.Options;
-    /**
-     * Write the config file with new contents. If no new contents are passed in
-     * it will write this.contents that was set from read(). Returns the written contents.
-     *
-     * @param newContents the new contents of the file
-     */
-    write(newContents?: ConfigContents): Promise<ConfigContents>;
-}

package/lib/config/keychainConfig.js

@@ -1,43 +0,0 @@
-"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.KeychainConfig = void 0;
-const path_1 = require("path");
-const fs_1 = require("../util/fs");
-const configFile_1 = require("./configFile");
-/**
- * Represent a key chain config backed by a json file.
- */
-// istanbul ignore next - getPassword/setPassword is always mocked out
-class KeychainConfig extends configFile_1.ConfigFile {
-    static getFileName() {
-        return 'key.json';
-    }
-    /**
-     * Gets default options for the KeychainConfig
-     */
-    static getDefaultOptions() {
-        return configFile_1.ConfigFile.getDefaultOptions(true, KeychainConfig.getFileName());
-    }
-    /**
-     * Write the config file with new contents. If no new contents are passed in
-     * it will write this.contents that was set from read(). Returns the written contents.
-     *
-     * @param newContents the new contents of the file
-     */
-    async write(newContents) {
-        if (newContents != null) {
-            this.setContents(newContents);
-        }
-        await fs_1.fs.mkdirp((0, path_1.dirname)(this.getPath()));
-        await fs_1.fs.writeFile(this.getPath(), JSON.stringify(this.getContents(), null, 4), { mode: '600' });
-        return this.getContents();
-    }
-}
-exports.KeychainConfig = KeychainConfig;
-//# sourceMappingURL=keychainConfig.js.map

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

@@ -1,83 +0,0 @@
-import { Nullable } from '@salesforce/ts-types';
-import { GlobalInfo } from '../globalInfoConfig';
-import { SfAliases, SfOrg, SfToken } from '../types';
-export declare type Aliasable = string | Partial<SfOrg> | Partial<SfToken>;
-export declare class AliasAccessor {
-    private globalInfo;
-    constructor(globalInfo: GlobalInfo);
-    /**
-     * Returns all the aliases for all the values
-     */
-    getAll(): SfAliases;
-    /**
-     * Returns all the aliases for a given entity
-     *
-     * @param entity the aliasable entity that you want to get the aliases of
-     */
-    getAll(entity: Aliasable): string[];
-    /**
-     * Returns the first alias found for a given entity
-     *
-     * @param entity the aliasable entity that you want to get the alias of
-     */
-    get(entity: Aliasable): Nullable<string>;
-    /**
-     * Returns the value that corresponds to the given alias if it exists
-     *
-     * @param alias the alias that corresponds to a value
-     */
-    getValue(alias: string): Nullable<string>;
-    /**
-     * Returns the username that corresponds to the given alias if it exists
-     *
-     * @param alias the alias that corresponds to a username
-     */
-    getUsername(alias: string): Nullable<string>;
-    /**
-     * If the provided string is an alias, it returns the corresponding value.
-     * If the provided string is not an alias, we assume that the provided string
-     * is the value and return it.
-     *
-     * This method is helpful when you don't know if the string you have is a value
-     * or an alias.
-     *
-     * @param valueOrAlias a string that might be a value or might be an alias
-     */
-    resolveValue(valueOrAlias: string): string;
-    /**
-     * If the provided string is an alias, it returns the corresponding username.
-     * If the provided string is not an alias, we assume that the provided string
-     * is the username and return it.
-     *
-     * 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
-     */
-    resolveUsername(usernameOrAlias: string): string;
-    /**
-     * Set an alias for the given aliasable entity
-     *
-     * @param alias the alias you want to set
-     * @param entity the aliasable entity that's being aliased
-     */
-    set(alias: string, entity: Aliasable): void;
-    /**
-     * Updates the alias for the given aliasable entity
-     *
-     * @param alias the alias you want to set
-     * @param entity the aliasable entity that's being aliased
-     */
-    update(alias: string, entity: Aliasable): void;
-    unset(alias: string): void;
-    /**
-     * This method 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;
-    /**
-     * Returns the username of given aliasable entity
-     */
-    private getNameOf;
-}

package/lib/globalInfo/accessors/aliasAccessor.js

@@ -1,130 +0,0 @@
-"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.AliasAccessor = void 0;
-const sfdxError_1 = require("../../sfdxError");
-const types_1 = require("../types");
-class AliasAccessor {
-    constructor(globalInfo) {
-        this.globalInfo = globalInfo;
-    }
-    getAll(entity) {
-        const all = this.globalInfo.get(types_1.SfInfoKeys.ALIASES) || {};
-        if (entity) {
-            const value = this.getNameOf(entity);
-            return Object.entries(all)
-                .filter((entry) => entry[1] === value)
-                .map((entry) => entry[0]);
-        }
-        else {
-            return all;
-        }
-    }
-    /**
-     * Returns the first alias found for a given entity
-     *
-     * @param entity the aliasable entity that you want to get the alias of
-     */
-    get(entity) {
-        var _a;
-        return (_a = this.getAll(entity).find((alias) => alias)) !== null && _a !== void 0 ? _a : null;
-    }
-    /**
-     * Returns the value that corresponds to the given alias if it exists
-     *
-     * @param alias the alias that corresponds to a value
-     */
-    getValue(alias) {
-        var _a;
-        return (_a = this.getAll()[alias]) !== null && _a !== void 0 ? _a : null;
-    }
-    /**
-     * Returns the username that corresponds to the given alias if it exists
-     *
-     * @param alias the alias that corresponds to a username
-     */
-    getUsername(alias) {
-        var _a;
-        return (_a = this.getAll()[alias]) !== null && _a !== void 0 ? _a : null;
-    }
-    /**
-     * If the provided string is an alias, it returns the corresponding value.
-     * If the provided string is not an alias, we assume that the provided string
-     * is the value and return it.
-     *
-     * This method is helpful when you don't know if the string you have is a value
-     * or an alias.
-     *
-     * @param valueOrAlias a string that might be a value or might be an alias
-     */
-    resolveValue(valueOrAlias) {
-        var _a;
-        return (_a = this.getValue(valueOrAlias)) !== null && _a !== void 0 ? _a : valueOrAlias;
-    }
-    /**
-     * If the provided string is an alias, it returns the corresponding username.
-     * If the provided string is not an alias, we assume that the provided string
-     * is the username and return it.
-     *
-     * 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
-     */
-    resolveUsername(usernameOrAlias) {
-        var _a;
-        return (_a = this.getUsername(usernameOrAlias)) !== null && _a !== void 0 ? _a : usernameOrAlias;
-    }
-    /**
-     * Set an alias for the given aliasable entity
-     *
-     * @param alias the alias you want to set
-     * @param entity the aliasable entity that's being aliased
-     */
-    set(alias, entity) {
-        const value = this.getNameOf(entity);
-        this.globalInfo.set(`${types_1.SfInfoKeys.ALIASES}["${alias}"]`, value);
-    }
-    /**
-     * Updates the alias for the given aliasable entity
-     *
-     * @param alias the alias you want to set
-     * @param entity the aliasable entity that's being aliased
-     */
-    update(alias, entity) {
-        const value = this.getNameOf(entity);
-        this.globalInfo.update(`${types_1.SfInfoKeys.ALIASES}["${alias}"]`, value);
-    }
-    unset(alias) {
-        delete this.globalInfo.get(types_1.SfInfoKeys.ALIASES)[alias];
-    }
-    /**
-     * This method unsets all the aliases for the given entity.
-     *
-     * @param entity the aliasable entity for which you want to unset all aliases
-     */
-    unsetAll(entity) {
-        const aliases = this.getAll(entity);
-        aliases.forEach((alias) => this.unset(alias));
-    }
-    /**
-     * Returns the username of given aliasable entity
-     */
-    getNameOf(entity) {
-        var _a;
-        if (typeof entity === 'string')
-            return entity;
-        const aliaseeName = (_a = entity.username) !== null && _a !== void 0 ? _a : entity.user;
-        if (!aliaseeName) {
-            throw new sfdxError_1.SfdxError(`Invalid aliasee, it must contain a user or username property: ${JSON.stringify(entity)}`);
-        }
-        return aliaseeName;
-    }
-}
-exports.AliasAccessor = AliasAccessor;
-//# sourceMappingURL=aliasAccessor.js.map

package/lib/globalInfo/accessors/orgAccessor.d.ts

@@ -1,13 +0,0 @@
-import { Optional } from '@salesforce/ts-types';
-import { GlobalInfo } from '../globalInfoConfig';
-import { SfOrgs, SfOrg } from '../types';
-export declare class OrgAccessor {
-    private globalInfo;
-    constructor(globalInfo: GlobalInfo);
-    getAll(decrypt?: boolean): SfOrgs;
-    get(username: string, decrypt?: boolean): Optional<SfOrg>;
-    has(username: string): boolean;
-    set(username: string, org: SfOrg): void;
-    update(username: string, org: Partial<SfOrg>): void;
-    unset(username: string): void;
-}

package/lib/globalInfo/accessors/orgAccessor.js

@@ -1,45 +0,0 @@
-"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.OrgAccessor = void 0;
-const types_1 = require("../types");
-class OrgAccessor {
-    constructor(globalInfo) {
-        this.globalInfo = globalInfo;
-    }
-    getAll(decrypt = false) {
-        return this.globalInfo.get(types_1.SfInfoKeys.ORGS, decrypt);
-    }
-    get(username, decrypt = false) {
-        const auth = this.globalInfo.get(`${types_1.SfInfoKeys.ORGS}["${username}"]`, decrypt);
-        // For legacy, some things wants the username in the returned auth info.
-        if (auth && !auth.username)
-            auth.username = username;
-        return auth;
-    }
-    has(username) {
-        return !!this.getAll()[username];
-    }
-    set(username, org) {
-        // For legacy, and to keep things standard, some things wants the username in auth info.
-        if (!org.username)
-            org.username = username;
-        this.globalInfo.set(`${types_1.SfInfoKeys.ORGS}["${username}"]`, org);
-    }
-    update(username, org) {
-        // For legacy, and to keep things standard, some things wants the username in auth info.
-        if (!org.username)
-            org.username = username;
-        this.globalInfo.update(`${types_1.SfInfoKeys.ORGS}["${username}"]`, org);
-    }
-    unset(username) {
-        delete this.globalInfo.get(types_1.SfInfoKeys.ORGS)[username];
-    }
-}
-exports.OrgAccessor = OrgAccessor;
-//# sourceMappingURL=orgAccessor.js.map

package/lib/globalInfo/accessors/tokenAccessor.d.ts

@@ -1,13 +0,0 @@
-import { Optional } from '@salesforce/ts-types';
-import { GlobalInfo } from '../globalInfoConfig';
-import { SfTokens, SfToken, Timestamp } from '../types';
-export declare class TokenAccessor {
-    private globalInfo;
-    constructor(globalInfo: GlobalInfo);
-    getAll(decrypt?: boolean): SfTokens;
-    get(name: string, decrypt?: boolean): Optional<SfToken & Timestamp>;
-    has(name: string): boolean;
-    set(name: string, token: SfToken): void;
-    update(name: string, token: Partial<SfToken>): void;
-    unset(name: string): void;
-}

package/lib/globalInfo/accessors/tokenAccessor.js

@@ -1,35 +0,0 @@
-"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.TokenAccessor = void 0;
-const types_1 = require("../types");
-class TokenAccessor {
-    constructor(globalInfo) {
-        this.globalInfo = globalInfo;
-    }
-    getAll(decrypt = false) {
-        return this.globalInfo.get(types_1.SfInfoKeys.TOKENS, decrypt) || {};
-    }
-    get(name, decrypt = false) {
-        return this.globalInfo.get(`${types_1.SfInfoKeys.TOKENS}["${name}"]`, decrypt);
-    }
-    has(name) {
-        return !!this.getAll()[name];
-    }
-    set(name, token) {
-        this.globalInfo.set(`${types_1.SfInfoKeys.TOKENS}["${name}"]`, token);
-    }
-    update(name, token) {
-        this.globalInfo.update(`${types_1.SfInfoKeys.TOKENS}["${name}"]`, token);
-    }
-    unset(name) {
-        delete this.globalInfo.get(types_1.SfInfoKeys.TOKENS)[name];
-    }
-}
-exports.TokenAccessor = TokenAccessor;
-//# sourceMappingURL=tokenAccessor.js.map

package/lib/globalInfo/globalInfoConfig.d.ts

@@ -1,36 +0,0 @@
-import { AnyJson } from '@salesforce/ts-types';
-import { ConfigFile } from '../config/configFile';
-import { ConfigValue } from '../config/configStore';
-import { OrgAccessor } from './accessors/orgAccessor';
-import { TokenAccessor } from './accessors/tokenAccessor';
-import { AliasAccessor } from './accessors/aliasAccessor';
-import { SfInfo } from './types';
-export declare function deepCopy<T extends AnyJson>(data: T): T;
-export declare class GlobalInfo extends ConfigFile<ConfigFile.Options, SfInfo> {
-    protected static encryptedKeys: RegExp[];
-    private static EMPTY_DATA_MODEL;
-    private static instance;
-    private sfdxHandler;
-    static get emptyDataModel(): SfInfo;
-    static getInstance(): Promise<GlobalInfo>;
-    /**
-     * Clear the cache to force reading from disk.
-     *
-     * *NOTE: Only call this method if you must and you know what you are doing.*
-     */
-    static clearInstance(): void;
-    static getFileName(): string;
-    /**
-     * Gets default options for the SfConfig
-     */
-    static getDefaultOptions(): ConfigFile.Options;
-    get orgs(): OrgAccessor;
-    get tokens(): TokenAccessor;
-    get aliases(): AliasAccessor;
-    set(key: string, value: ConfigValue): void;
-    write(newContents?: SfInfo): Promise<SfInfo>;
-    protected init(): Promise<void>;
-    private timestamp;
-    private loadSfData;
-    private mergeWithSfdxData;
-}

package/lib/globalInfo/globalInfoConfig.js

@@ -1,105 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.GlobalInfo = exports.deepCopy = void 0;
-/*
- * 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
- */
-const ts_types_1 = require("@salesforce/ts-types");
-const global_1 = require("../global");
-const configFile_1 = require("../config/configFile");
-const sfdxDataHandler_1 = require("./sfdxDataHandler");
-const orgAccessor_1 = require("./accessors/orgAccessor");
-const tokenAccessor_1 = require("./accessors/tokenAccessor");
-const aliasAccessor_1 = require("./accessors/aliasAccessor");
-const types_1 = require("./types");
-function deepCopy(data) {
-    return JSON.parse(JSON.stringify(data));
-}
-exports.deepCopy = deepCopy;
-class GlobalInfo extends configFile_1.ConfigFile {
-    constructor() {
-        super(...arguments);
-        this.sfdxHandler = new sfdxDataHandler_1.SfdxDataHandler();
-    }
-    static get emptyDataModel() {
-        return deepCopy(GlobalInfo.EMPTY_DATA_MODEL);
-    }
-    static async getInstance() {
-        if (!GlobalInfo.instance) {
-            GlobalInfo.instance = await GlobalInfo.create();
-        }
-        return GlobalInfo.instance;
-    }
-    /**
-     * Clear the cache to force reading from disk.
-     *
-     * *NOTE: Only call this method if you must and you know what you are doing.*
-     */
-    static clearInstance() {
-        delete GlobalInfo.instance;
-    }
-    static getFileName() {
-        return 'sf.json';
-    }
-    /**
-     * Gets default options for the SfConfig
-     */
-    static getDefaultOptions() {
-        return {
-            isGlobal: true,
-            isState: true,
-            filename: GlobalInfo.getFileName(),
-            stateFolder: global_1.Global.SF_STATE_FOLDER,
-        };
-    }
-    get orgs() {
-        return new orgAccessor_1.OrgAccessor(this);
-    }
-    get tokens() {
-        return new tokenAccessor_1.TokenAccessor(this);
-    }
-    get aliases() {
-        return new aliasAccessor_1.AliasAccessor(this);
-    }
-    set(key, value) {
-        if ((0, ts_types_1.isPlainObject)(value)) {
-            value = this.timestamp(value);
-        }
-        super.set(key, value);
-    }
-    async write(newContents) {
-        const result = await super.write(newContents);
-        if (global_1.Global.SFDX_INTEROPERABILITY)
-            await this.sfdxHandler.write(result);
-        return result;
-    }
-    async init() {
-        await this.initCrypto();
-        const contents = global_1.Global.SFDX_INTEROPERABILITY ? await this.mergeWithSfdxData() : await this.loadSfData();
-        this.setContents(contents);
-    }
-    timestamp(data) {
-        return { ...data, timestamp: new Date() };
-    }
-    async loadSfData() {
-        const data = await this.read();
-        return { ...GlobalInfo.emptyDataModel, ...data };
-    }
-    async mergeWithSfdxData() {
-        const sfData = await this.loadSfData();
-        const merged = await this.sfdxHandler.merge(sfData);
-        await this.write(merged);
-        return merged;
-    }
-}
-exports.GlobalInfo = GlobalInfo;
-GlobalInfo.encryptedKeys = [/token/gi, /password/gi, /secret/gi];
-GlobalInfo.EMPTY_DATA_MODEL = {
-    [types_1.SfInfoKeys.ORGS]: {},
-    [types_1.SfInfoKeys.TOKENS]: {},
-    [types_1.SfInfoKeys.ALIASES]: {},
-};
-//# sourceMappingURL=globalInfoConfig.js.map

package/lib/globalInfo/index.d.ts

@@ -1,6 +0,0 @@
-export * from './globalInfoConfig';
-export * from './sfdxDataHandler';
-export * from './types';
-export { OrgAccessor } from './accessors/orgAccessor';
-export { AliasAccessor } from './accessors/aliasAccessor';
-export { TokenAccessor } from './accessors/tokenAccessor';

package/lib/globalInfo/index.js

@@ -1,29 +0,0 @@
-"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
- */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TokenAccessor = exports.AliasAccessor = exports.OrgAccessor = void 0;
-__exportStar(require("./globalInfoConfig"), exports);
-__exportStar(require("./sfdxDataHandler"), exports);
-__exportStar(require("./types"), exports);
-var orgAccessor_1 = require("./accessors/orgAccessor");
-Object.defineProperty(exports, "OrgAccessor", { enumerable: true, get: function () { return orgAccessor_1.OrgAccessor; } });
-var aliasAccessor_1 = require("./accessors/aliasAccessor");
-Object.defineProperty(exports, "AliasAccessor", { enumerable: true, get: function () { return aliasAccessor_1.AliasAccessor; } });
-var tokenAccessor_1 = require("./accessors/tokenAccessor");
-Object.defineProperty(exports, "TokenAccessor", { enumerable: true, get: function () { return tokenAccessor_1.TokenAccessor; } });
-//# sourceMappingURL=index.js.map

package/lib/globalInfo/sfdxDataHandler.d.ts

@@ -1,43 +0,0 @@
-import { ConfigFile } from '../config/configFile';
-import { SfOrgs, SfOrg, SfInfo, SfInfoKeys } from './types';
-interface Handler<T extends SfInfoKeys> {
-    sfKey: T;
-    merge: (sfData: SfInfo) => Promise<Partial<SfInfo>>;
-    migrate: () => Promise<Pick<SfInfo, T>>;
-    write: (latest: SfInfo, original: SfInfo) => Promise<void>;
-}
-interface Changes<T> {
-    changed: T;
-    deleted: string[];
-}
-export declare class SfdxDataHandler {
-    handlers: (AuthHandler | AliasesHandler)[];
-    private original;
-    write(latest?: SfInfo): Promise<void>;
-    merge(sfData?: SfInfo): Promise<SfInfo>;
-    private setOriginal;
-}
-declare abstract class BaseHandler<T extends SfInfoKeys> implements Handler<T> {
-    abstract sfKey: T;
-    merge(sfData?: SfInfo): Promise<Partial<SfInfo>>;
-    abstract migrate(): Promise<Pick<SfInfo, T>>;
-    abstract write(latest: SfInfo, original: SfInfo): Promise<void>;
-}
-export declare class AuthHandler extends BaseHandler<SfInfoKeys.ORGS> {
-    private static authFilenameFilterRegEx;
-    sfKey: typeof SfInfoKeys.ORGS;
-    migrate(): Promise<Pick<SfInfo, SfInfoKeys.ORGS>>;
-    write(latest: SfInfo, original: SfInfo): Promise<void>;
-    findChanges(latest: SfInfo, original: SfInfo): Promise<Changes<SfOrgs>>;
-    createAuthFileConfig(username: string): Promise<ConfigFile<ConfigFile.Options>>;
-    listAllAuthFiles(): Promise<string[]>;
-    listAllAuthorizations(): Promise<SfOrg[]>;
-}
-export declare class AliasesHandler extends BaseHandler<SfInfoKeys.ALIASES> {
-    private static SFDX_ALIASES_FILENAME;
-    sfKey: typeof SfInfoKeys.ALIASES;
-    migrate(): Promise<Pick<SfInfo, SfInfoKeys.ALIASES>>;
-    merge(sfData?: SfInfo): Promise<Partial<SfInfo>>;
-    write(latest: SfInfo): Promise<void>;
-}
-export {};