@salesforce/core 4.0.0 → 4.0.1

package/lib/stateAggregator/accessors/tokenAccessor.js

@@ -0,0 +1,80 @@
+"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 kit_1 = require("@salesforce/kit");
+const tokensConfig_1 = require("../../config/tokensConfig");
+class TokenAccessor extends kit_1.AsyncOptionalCreatable {
+    /**
+     * Return all tokens.
+     *
+     * @param decrypt
+     * @returns {SfTokens}
+     */
+    getAll(decrypt = false) {
+        return this.config.getContents(decrypt) || {};
+    }
+    /**
+     * Return a token for the provided name.
+     *
+     * @param name
+     * @param decrypt
+     * @returns {Optional<SfToken>}
+     */
+    get(name, decrypt = false) {
+        return this.config.get(name, decrypt);
+    }
+    /**
+     * Return true if a given name has a token associated with it.
+     *
+     * @param name
+     * @returns {boolean}
+     */
+    has(name) {
+        return !!this.getAll()[name];
+    }
+    /**
+     * Set the token for the provided name.
+     *
+     * @param name
+     * @param token
+     */
+    set(name, token) {
+        this.config.set(name, token);
+    }
+    /**
+     * Update the token for the provided name.
+     *
+     * @param name
+     * @param token
+     */
+    update(name, token) {
+        this.config.update(name, token);
+    }
+    /**
+     * Unet the token for the provided name.
+     *
+     * @param name
+     */
+    unset(name) {
+        this.config.unset(name);
+    }
+    /**
+     * Write the contents to the token file.
+     *
+     * @returns {Promise<SfTokens>}
+     */
+    async write() {
+        return this.config.write();
+    }
+    async init() {
+        this.config = await tokensConfig_1.TokensConfig.create();
+    }
+}
+exports.TokenAccessor = TokenAccessor;
+//# sourceMappingURL=tokenAccessor.js.map

package/lib/stateAggregator/index.d.ts

@@ -0,0 +1,4 @@
+export * from './accessors/orgAccessor';
+export * from './accessors/aliasAccessor';
+export * from './accessors/tokenAccessor';
+export * from './stateAggregator';

package/lib/stateAggregator/index.js

@@ -0,0 +1,27 @@
+"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;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (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 });
+__exportStar(require("./accessors/orgAccessor"), exports);
+__exportStar(require("./accessors/aliasAccessor"), exports);
+__exportStar(require("./accessors/tokenAccessor"), exports);
+__exportStar(require("./stateAggregator"), exports);
+//# sourceMappingURL=index.js.map

package/lib/stateAggregator/stateAggregator.d.ts

@@ -0,0 +1,25 @@
+import { AsyncOptionalCreatable } from '@salesforce/kit';
+import { AliasAccessor } from './accessors/aliasAccessor';
+import { OrgAccessor } from './accessors/orgAccessor';
+import { SandboxAccessor } from './accessors/sandboxAccessor';
+import { TokenAccessor } from './accessors/tokenAccessor';
+export declare class StateAggregator extends AsyncOptionalCreatable {
+    private static instanceMap;
+    aliases: AliasAccessor;
+    orgs: OrgAccessor;
+    sandboxes: SandboxAccessor;
+    tokens: TokenAccessor;
+    /**
+     * Reuse a StateAggregator if one was already created for the current global state directory
+     * Otherwise, create one and adds it to map for future reuse.
+     * HomeDir might be stubbed in tests
+     */
+    static getInstance(): Promise<StateAggregator>;
+    /**
+     * 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(path?: string): void;
+    protected init(): Promise<void>;
+}

package/lib/stateAggregator/stateAggregator.js

@@ -0,0 +1,46 @@
+"use strict";
+/*
+ * Copyright (c) 2022, 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.StateAggregator = void 0;
+const kit_1 = require("@salesforce/kit");
+const global_1 = require("../global");
+const aliasAccessor_1 = require("./accessors/aliasAccessor");
+const orgAccessor_1 = require("./accessors/orgAccessor");
+const sandboxAccessor_1 = require("./accessors/sandboxAccessor");
+const tokenAccessor_1 = require("./accessors/tokenAccessor");
+class StateAggregator extends kit_1.AsyncOptionalCreatable {
+    /**
+     * Reuse a StateAggregator if one was already created for the current global state directory
+     * Otherwise, create one and adds it to map for future reuse.
+     * HomeDir might be stubbed in tests
+     */
+    static async getInstance() {
+        if (!StateAggregator.instanceMap.has(global_1.Global.DIR)) {
+            StateAggregator.instanceMap.set(global_1.Global.DIR, await StateAggregator.create());
+        }
+        // TS assertion is valid because there either was one OR it was just now instantiated
+        return StateAggregator.instanceMap.get(global_1.Global.DIR);
+    }
+    /**
+     * 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(path = global_1.Global.DIR) {
+        StateAggregator.instanceMap.delete(path);
+    }
+    async init() {
+        this.orgs = await orgAccessor_1.OrgAccessor.create();
+        this.sandboxes = await sandboxAccessor_1.SandboxAccessor.create();
+        this.aliases = await aliasAccessor_1.AliasAccessor.create();
+        this.tokens = await tokenAccessor_1.TokenAccessor.create();
+    }
+}
+exports.StateAggregator = StateAggregator;
+StateAggregator.instanceMap = new Map();
+//# sourceMappingURL=stateAggregator.js.map

package/lib/status/myDomainResolver.d.ts

@@ -2,7 +2,7 @@
 import { URL } from 'url';
 import { AsyncOptionalCreatable, Duration } from '@salesforce/kit';
 /**
- * A class used to resolve MyDomains. After a ScratchOrg is created it's host name my not be propagated to the
+ * A class used to resolve MyDomains. After a ScratchOrg is created its host name my not be propagated to the
  * Salesforce DNS service. This service is not exclusive to Salesforce My Domain URL and could be used for any hostname.
  *
  * ```

package/lib/status/myDomainResolver.js

@@ -20,7 +20,7 @@ const DNS_TIMEOUT = Math.max(3, new kit_1.Env().getNumber('SFDX_DNS_TIMEOUT', 3)
 // Retry frequency for DNS lookup polling defaults to 1 second and should be at least 1 second
 const DNS_RETRY_FREQ = Math.max(1, new kit_1.Env().getNumber('SFDX_DNS_RETRY_FREQUENCY', 1));
 /**
- * A class used to resolve MyDomains. After a ScratchOrg is created it's host name my not be propagated to the
+ * A class used to resolve MyDomains. After a ScratchOrg is created its host name my not be propagated to the
  * Salesforce DNS service. This service is not exclusive to Salesforce My Domain URL and could be used for any hostname.
  *
  * ```
@@ -45,13 +45,13 @@ class MyDomainResolver extends kit_1.AsyncOptionalCreatable {
      */
     constructor(options) {
         super(options);
-        this.options = options || { url: MyDomainResolver.DEFAULT_DOMAIN };
+        this.options = options ?? { url: MyDomainResolver.DEFAULT_DOMAIN };
     }
     getTimeout() {
-        return this.options.timeout || kit_1.Duration.seconds(DNS_TIMEOUT);
+        return this.options.timeout ?? kit_1.Duration.seconds(DNS_TIMEOUT);
     }
     getFrequency() {
-        return this.options.frequency || kit_1.Duration.seconds(DNS_RETRY_FREQ);
+        return this.options.frequency ?? kit_1.Duration.seconds(DNS_RETRY_FREQ);
     }
     /**
      * Method that performs the dns lookup of the host. If the lookup fails the internal polling client will try again

package/lib/status/pollingClient.js

@@ -11,7 +11,7 @@ const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const ts_retry_promise_1 = require("ts-retry-promise");
 const logger_1 = require("../logger");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 const lifecycleEvents_1 = require("../lifecycleEvents");
 /**
  * This is a polling client that can be used to poll the status of long running tasks. It can be used as a replacement
@@ -53,7 +53,6 @@ class PollingClient extends kit_1.AsyncOptionalCreatable {
      * in the polling options.
      */
     async subscribe() {
-        var _a;
         let errorInPollingFunction; // keep this around for returning in the catch block
         const doPoll = async () => {
             let result;
@@ -65,7 +64,7 @@ class PollingClient extends kit_1.AsyncOptionalCreatable {
                 if (['ETIMEDOUT', 'ENOTFOUND', 'ECONNRESET', 'socket hang up'].some((retryableNetworkError) => err.message.includes(retryableNetworkError))) {
                     this.logger.debug('Network error on the request', err);
                     await lifecycleEvents_1.Lifecycle.getInstance().emitWarning('Network error occurred. Continuing to poll.');
-                    throw sfdxError_1.SfdxError.wrap(err);
+                    throw sfError_1.SfError.wrap(err);
                 }
                 // there was an actual error thrown, so we don't want to keep retrying
                 throw new ts_retry_promise_1.NotRetryableError(err.name);
@@ -87,8 +86,9 @@ class PollingClient extends kit_1.AsyncOptionalCreatable {
             if (errorInPollingFunction) {
                 throw errorInPollingFunction;
             }
+            await lifecycleEvents_1.Lifecycle.getInstance().emit('POLLING_TIME_OUT', error);
             this.logger.debug('Polling timed out');
-            throw new sfdxError_1.SfdxError('The client has timed out.', (_a = this.options.timeoutErrorName) !== null && _a !== void 0 ? _a : 'PollingClientTimeout');
+            throw new sfError_1.SfError('The client has timed out.', this.options.timeoutErrorName ?? 'PollingClientTimeout');
         }
     }
 }

package/lib/status/streamingClient.d.ts

@@ -1,6 +1,6 @@
 import { AsyncOptionalCreatable, Duration, Env } from '@salesforce/kit/lib';
 import { AnyJson } from '@salesforce/ts-types/lib';
-import { Org } from '../org';
+import { Org } from '../org/org';
 import { CometClient, CometSubscription, Message, StatusResult, StreamingExtension, StreamProcessor } from './types';
 export { CometClient, CometSubscription, Message, StatusResult, StreamingExtension, StreamProcessor };
 /**
@@ -113,7 +113,7 @@ export declare class StreamingClient extends AsyncOptionalCreatable<StreamingCli
      * Subscribe to streaming events. When the streaming processor that's set in the options completes execution it
      * returns a payload in the StatusResult object. The payload is just echoed here for convenience.
      *
-     * **Throws** *{@link SfdxError}{ name: '{@link StreamingClient.TimeoutErrorType.SUBSCRIBE}'}* When the subscribe timeout occurs.
+     * **Throws** *{@link SfError}{ name: '{@link StreamingClient.TimeoutErrorType.SUBSCRIBE}'}* When the subscribe timeout occurs.
      *
      * @param streamInit This function should call the platform apis that result in streaming updates on push topics.
      * {@link StatusResult}

package/lib/status/streamingClient.js

@@ -13,18 +13,11 @@ const lib_1 = require("@salesforce/kit/lib");
 const lib_2 = require("@salesforce/ts-types/lib");
 const Faye = require("faye");
 const logger_1 = require("../logger");
-const sfdxError_1 = require("../sfdxError");
+const sfError_1 = require("../sfError");
 const messages_1 = require("../messages");
 const types_1 = require("./types");
 Object.defineProperty(exports, "CometClient", { enumerable: true, get: function () { return types_1.CometClient; } });
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.load('@salesforce/core', 'streaming', [
-    'waitParamValidValueError',
-    'genericHandshakeTimeout',
-    'invalidApiVersion',
-    'genericTimeout',
-    'handshakeApiVersionError',
-]);
+const messages = new messages_1.Messages('@salesforce/core', 'streaming', new Map([["genericTimeout", "Socket timeout occurred while listening for results."], ["genericHandshakeTimeout", "The streaming request failed to handshake at %s."], ["handshakeApiVersionError", "Invalid API version specified for streaming connection handshake: %s"], ["handshakeApiVersionError.actions", ["Set the API version to match the org as an environment variable (e.g., SFDX_API_VERSION=XX.0)."]], ["waitParamValidValueError", "Invalid value was specified for wait. Please provide a wait value greater than %s minutes."], ["invalidApiVersion", "Invalid api version is being reported by config (apiVersion=%s)."]]));
 /**
  * Validation helper
  *
@@ -151,7 +144,7 @@ class StreamingClient extends lib_1.AsyncOptionalCreatable {
             this.cometClient.setHeader('Authorization', `OAuth ${accessToken}`);
         }
         else {
-            throw new sfdxError_1.SfdxError('Missing or invalid access token', 'MissingOrInvalidAccessToken');
+            throw new sfError_1.SfError('Missing or invalid access token', 'MissingOrInvalidAccessToken');
         }
         this.log(`Streaming client target url: ${this.targetUrl}`);
         this.log(`options.subscribeTimeout (ms): ${this.options.subscribeTimeout.milliseconds}`);
@@ -201,7 +194,7 @@ class StreamingClient extends lib_1.AsyncOptionalCreatable {
      * Subscribe to streaming events. When the streaming processor that's set in the options completes execution it
      * returns a payload in the StatusResult object. The payload is just echoed here for convenience.
      *
-     * **Throws** *{@link SfdxError}{ name: '{@link StreamingClient.TimeoutErrorType.SUBSCRIBE}'}* When the subscribe timeout occurs.
+     * **Throws** *{@link SfError}{ name: '{@link StreamingClient.TimeoutErrorType.SUBSCRIBE}'}* When the subscribe timeout occurs.
      *
      * @param streamInit This function should call the platform apis that result in streaming updates on push topics.
      * {@link StatusResult}
@@ -211,54 +204,52 @@ class StreamingClient extends lib_1.AsyncOptionalCreatable {
         // This outer promise is to hold the streaming promise chain open until the streaming processor
         // says it's complete.
         // eslint-disable-next-line @typescript-eslint/no-misused-promises
-        return new Promise((subscribeResolve, subscribeReject) => {
-            // This is the inner promise chain that's satisfied when the client impl (Faye/Mock) says it's subscribed.
-            return new Promise((subscriptionResolve, subscriptionReject) => {
-                timeout = setTimeout(() => {
-                    const timeoutError = messages.createError('genericTimeout');
-                    this.doTimeout(timeout, timeoutError);
-                    subscribeReject(timeoutError);
-                }, this.options.subscribeTimeout.milliseconds);
-                // Initialize the subscription.
-                const subscription = this.cometClient.subscribe(this.options.channel, (message) => {
-                    try {
-                        // The result of the stream processor determines the state of the outer promise.
-                        const result = this.options.streamProcessor(message);
-                        // The stream processor says it's complete. Clean up and resolve the outer promise.
-                        if (result && result.completed) {
-                            clearTimeout(timeout);
-                            this.disconnectClient();
-                            subscribeResolve(result.payload);
-                        } // This 'if' is intended to be evaluated until it's completed or until the timeout fires.
-                    }
-                    catch (e) {
-                        // it's completely valid for the stream processor to throw an error. If it does we will
-                        // reject the outer promise. Keep in mind if we are here the subscription was resolved.
+        return new Promise((subscribeResolve, subscribeReject) => 
+        // This is the inner promise chain that's satisfied when the client impl (Faye/Mock) says it's subscribed.
+        new Promise((subscriptionResolve, subscriptionReject) => {
+            timeout = setTimeout(() => {
+                const timeoutError = messages.createError('genericTimeout');
+                this.doTimeout(timeout, timeoutError);
+                subscribeReject(timeoutError);
+            }, this.options.subscribeTimeout.milliseconds);
+            // Initialize the subscription.
+            const subscription = this.cometClient.subscribe(this.options.channel, (message) => {
+                try {
+                    // The result of the stream processor determines the state of the outer promise.
+                    const result = this.options.streamProcessor(message);
+                    // The stream processor says it's complete. Clean up and resolve the outer promise.
+                    if (result?.completed) {
                         clearTimeout(timeout);
                         this.disconnectClient();
-                        subscribeReject(e);
-                    }
-                });
-                subscription.callback(() => {
-                    subscriptionResolve();
-                });
-                subscription.errback((error) => {
-                    subscriptionReject(error);
-                });
-            })
-                .then(() => {
-                // Now that we successfully have a subscription started up we are safe to initialize the function that
-                // will affect the streaming events. I.E. create an org or run apex tests.
-                return streamInit && streamInit();
-            })
-                .catch((error) => {
-                this.disconnect();
-                // Need to catch the subscription rejection or it will result in an unhandled rejection error.
-                clearTimeout(timeout);
-                // No subscription so we can reject the out promise as well.
-                subscribeReject(error);
+                        subscribeResolve(result.payload);
+                    } // This 'if' is intended to be evaluated until it's completed or until the timeout fires.
+                }
+                catch (e) {
+                    // it's completely valid for the stream processor to throw an error. If it does we will
+                    // reject the outer promise. Keep in mind if we are here the subscription was resolved.
+                    clearTimeout(timeout);
+                    this.disconnectClient();
+                    subscribeReject(e);
+                }
             });
-        });
+            subscription.callback(() => {
+                subscriptionResolve();
+            });
+            subscription.errback((error) => {
+                subscriptionReject(error);
+            });
+        })
+            .then(() => 
+        // Now that we successfully have a subscription started up we are safe to initialize the function that
+        // will affect the streaming events. I.E. create an org or run apex tests.
+        streamInit?.())
+            .catch((error) => {
+            this.disconnect();
+            // Need to catch the subscription rejection or it will result in an unhandled rejection error.
+            clearTimeout(timeout);
+            // No subscription so we can reject the out promise as well.
+            subscribeReject(error);
+        }));
     }
     /**
      * Handler for incoming streaming messages.
@@ -296,12 +287,17 @@ class StreamingClient extends lib_1.AsyncOptionalCreatable {
         // unauthenticated connections are being made to salesforce. Let's close the dispatcher if it exists and
         // has no clientId.
         // @ts-ignore
+        // eslint-disable-next-line no-underscore-dangle
         if (this.cometClient._dispatcher) {
             this.log('Closing the faye dispatcher');
             // @ts-ignore
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, no-underscore-dangle
             const dispatcher = this.cometClient._dispatcher;
+            // eslint-disable-next-line @typescript-eslint/restrict-template-expressions, @typescript-eslint/no-unsafe-member-access
             this.log(`dispatcher.clientId: ${dispatcher.clientId}`);
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
             if (!dispatcher.clientId) {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
                 dispatcher.close();
             }
             else {
@@ -342,13 +338,13 @@ exports.StreamingClient = StreamingClient;
                 logger.warn('envDep is deprecated');
             }
             if (!streamProcessor) {
-                throw new sfdxError_1.SfdxError('Missing stream processor', 'MissingArg');
+                throw new sfError_1.SfError('Missing stream processor', 'MissingArg');
             }
             if (!org) {
-                throw new sfdxError_1.SfdxError('Missing org', 'MissingArg');
+                throw new sfError_1.SfError('Missing org', 'MissingArg');
             }
             if (!channel) {
-                throw new sfdxError_1.SfdxError('Missing streaming channel', 'MissingArg');
+                throw new sfError_1.SfError('Missing streaming channel', 'MissingArg');
             }
             this.org = org;
             this.apiVersion = org.getConnection().getApiVersion();
@@ -363,10 +359,9 @@ exports.StreamingClient = StreamingClient;
             this.subscribeTimeout = StreamingClient.DefaultOptions.DEFAULT_SUBSCRIBE_TIMEOUT;
             this.handshakeTimeout = StreamingClient.DefaultOptions.DEFAULT_HANDSHAKE_TIMEOUT;
             this.streamingImpl = {
-                getCometClient: (url) => {
-                    // @ts-ignore
-                    return new Faye.Client(url);
-                },
+                getCometClient: (url) => 
+                // @ts-ignore
+                new Faye.Client(url),
                 setLogger: (logLine) => {
                     // @ts-ignore
                     Faye.logger = {};

package/lib/status/types.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="node" />
 import { EventEmitter } from 'events';
 import { AnyFunction, AnyJson, JsonMap } from '@salesforce/ts-types';
-export declare type Message = JsonMap;
-export declare type Callback<T = unknown> = (...args: any[]) => T;
+export type Message = JsonMap;
+export type Callback<T = unknown> = (...args: any[]) => T;
 export interface StatusResult {
     /**
      * If the result of the streaming or polling client is expected to return a result