@salesforce/core 3.19.1 → 3.19.4

package/lib/org/org.js

@@ -21,7 +21,7 @@ const sfError_1 = require("../sfError");
 const sfdc_1 = require("../util/sfdc");
 const webOAuthServer_1 = require("../webOAuthServer");
 const messages_1 = require("../messages");
-const globalInfo_1 = require("../globalInfo");
+const stateAggregator_1 = require("../stateAggregator");
 const pollingClient_1 = require("../status/pollingClient");
 const connection_1 = require("./connection");
 const authInfo_1 = require("./authInfo");
@@ -225,8 +225,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
     async cleanLocalOrgData(orgDataPath, throwWhenRemoveFails = false) {
         let dataPath;
         try {
-            const rootFolder = await config_1.Config.resolveRootFolder(false);
-            dataPath = (0, path_1.join)(rootFolder, global_1.Global.SFDX_STATE_FOLDER, orgDataPath ? orgDataPath : 'orgs');
+            dataPath = await this.getLocalDataDir(orgDataPath);
             this.logger.debug(`cleaning data for path: ${dataPath}`);
         }
         catch (err) {
@@ -271,7 +270,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      *
      */
     async isSandbox() {
-        return (await globalInfo_1.GlobalInfo.getInstance()).sandboxes.has(this.getOrgId());
+        return await (await stateAggregator_1.StateAggregator.getInstance()).sandboxes.hasFile(this.getOrgId());
     }
     /**
      * Check that this org is a scratch org by asking the dev hub if it knows about it.
@@ -502,8 +501,8 @@ class Org extends kit_1.AsyncOptionalCreatable {
             const organization = await this.retrieveOrganizationInformation();
             const isScratch = organization.IsSandbox && organization.TrialExpirationDate;
             const isSandbox = organization.IsSandbox && !organization.TrialExpirationDate;
-            const info = await globalInfo_1.GlobalInfo.getInstance();
-            info.orgs.update(username, {
+            const stateAggregator = await stateAggregator_1.StateAggregator.getInstance();
+            stateAggregator.orgs.update(username, {
                 [Org.Fields.NAME]: organization.Name,
                 [Org.Fields.INSTANCE_NAME]: organization.InstanceName,
                 [Org.Fields.NAMESPACE_PREFIX]: organization.NamespacePrefix,
@@ -511,7 +510,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
                 [Org.Fields.IS_SCRATCH]: isScratch,
                 [Org.Fields.TRIAL_EXPIRATION_DATE]: organization.TrialExpirationDate,
             });
-            await info.write();
+            await stateAggregator.orgs.write(username);
         }
     }
     /**
@@ -618,10 +617,10 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * set the sandbox config related to this given org
      *
      * @param orgId {string} orgId of the sandbox
-     * @param config {SfSandbox} config of the sandbox
+     * @param config {SandboxFields} config of the sandbox
      */
     async setSandboxConfig(orgId, config) {
-        (await globalInfo_1.GlobalInfo.getInstance()).sandboxes.set(orgId, config);
+        (await stateAggregator_1.StateAggregator.getInstance()).sandboxes.set(orgId, config);
         return this;
     }
     /**
@@ -630,7 +629,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * @param orgId {string} orgId of the sandbox
      */
     async getSandboxConfig(orgId) {
-        return (await globalInfo_1.GlobalInfo.getInstance()).sandboxes.get(orgId);
+        return (await stateAggregator_1.StateAggregator.getInstance()).sandboxes.read(orgId);
     }
     /**
      * Retrieves the highest api version that is supported by the target server instance. If the apiVersion configured for
@@ -733,7 +732,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * Initialize async components.
      */
     async init() {
-        const globalInfo = await globalInfo_1.GlobalInfo.getInstance();
+        const stateAggregator = await stateAggregator_1.StateAggregator.getInstance();
         this.logger = await logger_1.Logger.child('Org');
         this.configAggregator = this.options.aggregator ? this.options.aggregator : await configAggregator_1.ConfigAggregator.create();
         if (!this.options.connection) {
@@ -744,7 +743,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
                     : this.configAggregator.getPropertyValue(orgConfigProperties_1.OrgConfigProperties.TARGET_ORG);
                 this.options.aliasOrUsername = aliasOrUsername || undefined;
             }
-            const username = globalInfo.aliases.resolveUsername(this.options.aliasOrUsername);
+            const username = stateAggregator.aliases.resolveUsername(this.options.aliasOrUsername);
             if (!username) {
                 throw messages.createError('noUsernameFound');
             }
@@ -764,6 +763,10 @@ class Org extends kit_1.AsyncOptionalCreatable {
     getDefaultOptions() {
         throw new sfError_1.SfError('Not Supported', 'NotSupportedError');
     }
+    async getLocalDataDir(orgDataPath) {
+        const rootFolder = await config_1.Config.resolveRootFolder(false);
+        return (0, path_1.join)(rootFolder, global_1.Global.SFDX_STATE_FOLDER, orgDataPath ? orgDataPath : 'orgs');
+    }
     /**
      * Gets the sandboxProcessObject and then polls for it to complete.
      *
@@ -926,14 +929,14 @@ class Org extends kit_1.AsyncOptionalCreatable {
      * this Org. You don't want to call this method directly. Instead consider calling Org.remove()
      */
     async removeAuth() {
-        const config = await globalInfo_1.GlobalInfo.getInstance();
+        const stateAggregator = await stateAggregator_1.StateAggregator.getInstance();
         const username = this.getUsername();
         // If there is no username, it has already been removed from the globalInfo.
         // We can skip the unset and just ensure that globalInfo is updated.
         if (username) {
             this.logger.debug(`Removing auth for user: ${username}`);
             this.logger.debug(`Clearing auth cache for user: ${username}`);
-            config.orgs.unset(username);
+            await stateAggregator.orgs.remove(username);
         }
     }
     /**
@@ -964,7 +967,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
      */
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     async removeUsers(throwWhenRemoveFails) {
-        const globalInfo = await globalInfo_1.GlobalInfo.getInstance();
+        const stateAggregator = await stateAggregator_1.StateAggregator.getInstance();
         this.logger.debug(`Removing users associate with org: ${this.getOrgId()}`);
         const config = await this.retrieveOrgUsersConfig();
         this.logger.debug(`using path for org users: ${config.getPath()}`);
@@ -972,8 +975,8 @@ class Org extends kit_1.AsyncOptionalCreatable {
         await Promise.all(authInfos
             .map((auth) => auth.getFields().username)
             .map(async (username) => {
-            const aliasKeys = (username && globalInfo.aliases.getAll(username)) || [];
-            globalInfo.aliases.unsetAll(username);
+            const aliasKeys = (username && stateAggregator.aliases.getAll(username)) || [];
+            stateAggregator.aliases.unsetAll(username);
             const orgForUser = username === this.getUsername()
                 ? this
                 : await Org.create({
@@ -988,12 +991,11 @@ class Org extends kit_1.AsyncOptionalCreatable {
                 needsConfigUpdate ? config_1.Config.update(configInfo.isGlobal(), orgType, undefined) : undefined,
             ].filter(Boolean);
         }));
-        await globalInfo.write();
+        await stateAggregator.aliases.write();
     }
     async removeSandboxConfig() {
-        const globalInfo = await globalInfo_1.GlobalInfo.getInstance();
-        globalInfo.sandboxes.unset(this.getOrgId());
-        await globalInfo.write();
+        const stateAggregator = await stateAggregator_1.StateAggregator.getInstance();
+        await stateAggregator.sandboxes.remove(this.getOrgId());
     }
     async writeSandboxAuthFile(sandboxProcessObj, sandboxRes) {
         this.logger.debug(`writeSandboxAuthFile sandboxProcessObj: ${JSON.stringify(sandboxProcessObj)}, sandboxRes: ${JSON.stringify(sandboxRes)}`);
@@ -1023,22 +1025,22 @@ class Org extends kit_1.AsyncOptionalCreatable {
             this.logger.debug('Creating AuthInfo for sandbox', sandboxRes.authUserName, productionAuthFields.username, oauth2Options);
             // save auth info for new sandbox
             await authInfo.save();
-            if (!authInfo.getFields().orgId) {
+            const sandboxOrgId = authInfo.getFields().orgId;
+            if (!sandboxOrgId) {
                 throw messages.createError('AuthInfoOrgIdUndefined');
             }
             // set the sandbox config value
             const sfSandbox = {
                 sandboxUsername: sandboxRes.authUserName,
-                sandboxOrgId: authInfo.getFields().orgId,
+                sandboxOrgId,
                 prodOrgUsername: this.getUsername(),
                 sandboxName: sandboxProcessObj.SandboxName,
                 sandboxProcessId: sandboxProcessObj.Id,
                 sandboxInfoId: sandboxProcessObj.SandboxInfoId,
                 timestamp: new Date().toISOString(),
             };
-            await this.setSandboxConfig(authInfo.getFields().orgId, sfSandbox);
-            const globalInfo = await globalInfo_1.GlobalInfo.getInstance();
-            await globalInfo.write();
+            await this.setSandboxConfig(sandboxOrgId, sfSandbox);
+            (await stateAggregator_1.StateAggregator.getInstance()).sandboxes.write(sandboxOrgId);
             await lifecycleEvents_1.Lifecycle.getInstance().emit(SandboxEvents.EVENT_RESULT, {
                 sandboxProcessObj,
                 sandboxRes,

package/lib/org/scratchOrgCreate.js

@@ -13,7 +13,7 @@ const messages_1 = require("../messages");
 const logger_1 = require("../logger");
 const configAggregator_1 = require("../config/configAggregator");
 const sfProject_1 = require("../sfProject");
-const globalInfo_1 = require("../globalInfo");
+const stateAggregator_1 = require("../stateAggregator");
 const org_1 = require("./org");
 const scratchOrgInfoApi_1 = require("./scratchOrgInfoApi");
 const scratchOrgSettingsGenerator_1 = require("./scratchOrgSettingsGenerator");
@@ -24,7 +24,6 @@ const scratchOrgCache_1 = require("./scratchOrgCache");
 const scratchOrgErrorCodes_1 = require("./scratchOrgErrorCodes");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const messages = messages_1.Messages.load('@salesforce/core', 'scratchOrgCreate', [
-    'SourceStatusResetFailureError',
     'DurationDaysValidationMaxError',
     'DurationDaysValidationMinError',
     'RetryNotIntError',
@@ -74,12 +73,10 @@ const scratchOrgResume = async (jobId) => {
     // At this point, the scratch org is "good".
     // Some hubs have all the usernames set to `null`
     const username = (_a = soi.Username) !== null && _a !== void 0 ? _a : soi.SignupUsername;
-    // re-auth only if the org isn't in GlobalInfo
-    const globalInfo = await globalInfo_1.GlobalInfo.getInstance();
-    const scratchOrgAuthInfo = globalInfo.orgs.has(username)
-        ? await authInfo_1.AuthInfo.create({
-            username,
-        })
+    // re-auth only if the org isn't in StateAggregator
+    const stateAggregator = await stateAggregator_1.StateAggregator.getInstance();
+    const scratchOrgAuthInfo = (await stateAggregator.orgs.exists(username))
+        ? await authInfo_1.AuthInfo.create({ username })
         : await (0, scratchOrgInfoApi_1.authorizeScratchOrg)({
             scratchOrgInfoComplete: soi,
             hubOrg,

package/lib/{globalInfo → stateAggregator}/accessors/aliasAccessor.d.ts

@@ -1,8 +1,13 @@
+import { AsyncOptionalCreatable } from '@salesforce/kit';
 import { Nullable } from '@salesforce/ts-types';
+import { ConfigContents } from '../../exported';
 import { GlobalInfo } from '../globalInfoConfig';
 import { SfAliases, SfOrg, SfToken } from '../types';
 export declare type Aliasable = string | Partial<SfOrg> | Partial<SfToken>;
-export declare class AliasAccessor {
+/**
+ * @deprecated
+ */
+export declare class GlobalInfoAliasAccessor {
     private globalInfo;
     constructor(globalInfo: GlobalInfo);
     /**
@@ -81,3 +86,76 @@ export declare class AliasAccessor {
      */
     private getNameOf;
 }
+export declare class AliasAccessor extends AsyncOptionalCreatable {
+    private config;
+    /**
+     * Returns all the aliases for all the values
+     */
+    getAll(): ConfigContents<string>;
+    /**
+     * 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;
+    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;
+    write(): Promise<ConfigContents>;
+    protected init(): Promise<void>;
+    /**
+     * Returns the username of given aliasable entity
+     */
+    private getNameOf;
+}

package/lib/{globalInfo → stateAggregator}/accessors/aliasAccessor.js

@@ -6,10 +6,15 @@
  * 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;
+exports.AliasAccessor = exports.GlobalInfoAliasAccessor = void 0;
+const kit_1 = require("@salesforce/kit");
+const aliasesConfig_1 = require("../../config/aliasesConfig");
 const sfError_1 = require("../../sfError");
 const types_1 = require("../types");
-class AliasAccessor {
+/**
+ * @deprecated
+ */
+class GlobalInfoAliasAccessor {
     constructor(globalInfo) {
         this.globalInfo = globalInfo;
     }
@@ -126,5 +131,117 @@ class AliasAccessor {
         return aliaseeName;
     }
 }
+exports.GlobalInfoAliasAccessor = GlobalInfoAliasAccessor;
+class AliasAccessor extends kit_1.AsyncOptionalCreatable {
+    getAll(entity) {
+        // This will only return aliases under "orgs". This will need to be modified
+        // if/when we want to support more aliases groups.
+        const all = (this.config.getGroup() || {});
+        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) {
+        this.config.set(alias, this.getNameOf(entity));
+    }
+    unset(alias) {
+        this.config.unset(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));
+    }
+    async write() {
+        return this.config.write();
+    }
+    async init() {
+        this.config = await aliasesConfig_1.AliasesConfig.create(aliasesConfig_1.AliasesConfig.getDefaultOptions());
+    }
+    /**
+     * 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 sfError_1.SfError(`Invalid aliasee, it must contain a user or username property: ${JSON.stringify(entity)}`);
+        }
+        return aliaseeName;
+    }
+}
 exports.AliasAccessor = AliasAccessor;
 //# sourceMappingURL=aliasAccessor.js.map

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

@@ -0,0 +1,53 @@
+/// <reference types="node" />
+import * as fs from 'fs';
+import { JsonMap, Nullable, Optional } from '@salesforce/ts-types';
+import { AsyncOptionalCreatable } from '@salesforce/kit';
+import { AuthInfoConfig } from '../../config/authInfoConfig';
+import { GlobalInfo } from '../globalInfoConfig';
+import { SfOrgs, SfOrg } from '../types';
+import { AuthFields } from '../../org';
+import { ConfigFile } from '../../config/configFile';
+import { ConfigContents } from '../../config/configStore';
+/**
+ * @deprecated
+ */
+export declare class GlobalInfoOrgAccessor {
+    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;
+}
+export declare abstract class BaseOrgAccessor<T extends ConfigFile, P extends ConfigContents> extends AsyncOptionalCreatable {
+    private configs;
+    private contents;
+    private logger;
+    read(username: string, decrypt?: boolean, throwOnNotFound?: boolean): Promise<Nullable<P>>;
+    readAll(decrypt?: boolean): Promise<P[]>;
+    get(username: string, decrypt?: boolean): Nullable<P>;
+    getAll(decrypt?: boolean): P[];
+    has(username: string): boolean;
+    exists(username: string): Promise<boolean>;
+    stat(username: string): Promise<Nullable<fs.Stats>>;
+    hasFile(username: string): Promise<boolean>;
+    list(): Promise<string[]>;
+    set(username: string, org: P): void;
+    update(username: string, org: Partial<P> & JsonMap): void;
+    remove(username: string): Promise<void>;
+    write(username: string): Promise<Nullable<P>>;
+    protected init(): Promise<void>;
+    private getAllFiles;
+    private parseUsername;
+    private parseFilename;
+    protected abstract initAuthFile(username: string, throwOnNotFound?: boolean): Promise<T>;
+    protected abstract getFileRegex(): RegExp;
+    protected abstract getFileExtension(): string;
+}
+export declare class OrgAccessor extends BaseOrgAccessor<AuthInfoConfig, AuthFields> {
+    protected initAuthFile(username: string, throwOnNotFound?: boolean): Promise<AuthInfoConfig>;
+    protected getFileRegex(): RegExp;
+    protected getFileExtension(): string;
+}