@salesforce/core 4.0.0 → 4.1.0

package/lib/stateAggregator/accessors/orgAccessor.js

@@ -0,0 +1,240 @@
+"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 = exports.BaseOrgAccessor = void 0;
+const fs = require("fs");
+const path = require("path");
+const kit_1 = require("@salesforce/kit");
+const authInfoConfig_1 = require("../../config/authInfoConfig");
+const global_1 = require("../../global");
+const logger_1 = require("../../logger");
+const messages_1 = require("../../messages");
+function chunk(array, chunkSize) {
+    const final = [];
+    for (let i = 0, len = array.length; i < len; i += chunkSize)
+        final.push(array.slice(i, i + chunkSize));
+    return final;
+}
+class BaseOrgAccessor extends kit_1.AsyncOptionalCreatable {
+    constructor() {
+        super(...arguments);
+        this.configs = new Map();
+        this.contents = new Map();
+    }
+    /**
+     * Read the auth file for the given username. Once the file has been read, it can be re-accessed with the `get` method.
+     *
+     * @param username username to read
+     * @param decrypt if true, decrypt encrypted values
+     * @param throwOnNotFound throw if file is not found for username
+     */
+    async read(username, decrypt = false, throwOnNotFound = true) {
+        try {
+            const config = await this.initAuthFile(username, throwOnNotFound);
+            this.configs.set(username, config);
+            return this.get(username, decrypt);
+        }
+        catch (err) {
+            return null;
+        }
+    }
+    /**
+     * Read all the auth files under the global state directory
+     *
+     * @param decrypt if true, decrypt encrypted values
+     */
+    async readAll(decrypt = false) {
+        const fileChunks = chunk(await this.getAllFiles(), 50);
+        for (const fileChunk of fileChunks) {
+            const promises = fileChunk.map(async (f) => {
+                const username = this.parseUsername(f);
+                const config = await this.initAuthFile(username);
+                this.configs.set(username, config);
+            });
+            // eslint-disable-next-line no-await-in-loop
+            await Promise.all(promises);
+        }
+        return this.getAll(decrypt);
+    }
+    /**
+     * Return the contents of the username's auth file from cache.
+     * The `read` or `readAll` methods must be called first in order to populate the cache.
+     * If throwOnNotFound is not true, an empty object {} is returned if the org is not found.
+     *
+     * @param username username to get
+     * @param decrypt if true, decrypt encrypted values
+     * @param throwOnNotFound if true, throw if the auth file does not already exist in the cache
+     */
+    get(username, decrypt = false, throwOnNotFound = false) {
+        const config = this.configs.get(username);
+        if (throwOnNotFound && config?.keys().length === 0) {
+            const messages = new messages_1.Messages('@salesforce/core', 'core', new Map([["authInfoCreationError", "Must pass a username and/or OAuth options when creating an AuthInfo instance."], ["authInfoOverwriteError", "Cannot create an AuthInfo instance that will overwrite existing auth data."], ["authInfoOverwriteError.actions", ["Create the AuthInfo instance using existing auth data by just passing the username. E.g., `AuthInfo.create({ username: 'my@user.org' });`."]], ["authCodeExchangeError", "Error authenticating with auth code due to: %s"], ["authCodeUsernameRetrievalError", "Could not retrieve the username after successful auth code exchange.\n\nDue to: %s"], ["jwtAuthError", "Error authenticating with JWT config due to: %s"], ["jwtAuthErrors", "Error authenticating with JWT.\nErrors encountered:\n%s"], ["refreshTokenAuthError", "Error authenticating with the refresh token due to: %s"], ["orgDataNotAvailableError", "An attempt to refresh the authentication token failed with a 'Data Not Found Error'. The org identified by username %s does not appear to exist. Likely cause is that the org was deleted by another user or has expired."], ["orgDataNotAvailableError.actions", ["Run `sfdx force:org:list --clean` to remove stale org authentications.", "Use `sfdx force:config:set` to update the defaultusername.", "Use `sfdx force:org:create` to create a new org.", "Use `sfdx auth` to authenticate an existing org."]], ["namedOrgNotFound", "No authorization information found for %s."], ["noAliasesFound", "Nothing to set."], ["invalidFormat", "Setting aliases must be in the format <key>=<value> but found: [%s]."], ["invalidJsonCasing", "All JSON input must have heads down camelcase keys. E.g., `{ sfdcLoginUrl: \"https://login.salesforce.com\" }`\nFound \"%s\" at %s"], ["missingClientId", "Client ID is required for JWT authentication."]]));
+            throw messages.createError('namedOrgNotFound', [username]);
+        }
+        if (config) {
+            this.contents.set(username, config.getContents(decrypt));
+        }
+        return this.contents.get(username);
+    }
+    /**
+     * Return the contents of all the auth files from cache. The `read` or `readAll` methods must be called first in order to populate the cache.
+     *
+     * @param decrypt if true, decrypt encrypted values
+     * @returns
+     */
+    getAll(decrypt = false) {
+        return [...this.configs.keys()].map((username) => this.get(username, decrypt)).filter((org) => !(0, kit_1.isEmpty)(org));
+    }
+    /**
+     * Returns true if the username has been cached.
+     *
+     * @param username
+     */
+    has(username) {
+        return this.contents.has(username);
+    }
+    /**
+     * Returns true if there is an auth file for the given username. The `read` or `readAll` methods must be called first in order to populate the cache.
+     *
+     * @param username
+     */
+    async exists(username) {
+        const config = this.configs.get(username);
+        return config ? config.exists() : false;
+    }
+    /**
+     * Return the file stats for a given userame's auth file.
+     *
+     * @param username
+     */
+    async stat(username) {
+        const config = this.configs.get(username);
+        return config ? config.stat() : null;
+    }
+    /**
+     * Returns true if there is an auth file for the given username
+     *
+     * @param username
+     */
+    async hasFile(username) {
+        try {
+            await fs.promises.access(this.parseFilename(username));
+            return true;
+        }
+        catch {
+            this.logger.debug(`No auth file found for ${username}`);
+            return false;
+        }
+    }
+    /**
+     * Return all auth files under the global state directory.
+     */
+    async list() {
+        return this.getAllFiles();
+    }
+    /**
+     * Set the contents for a given username.
+     *
+     * @param username
+     * @param org
+     */
+    set(username, org) {
+        const config = this.configs.get(username);
+        if (config) {
+            config.setContentsFromObject(org);
+            const contents = config.getContents();
+            contents.username ??= username;
+            this.contents.set(username, contents);
+        }
+        else {
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-ignore
+            org.username ??= username;
+            this.contents.set(username, org);
+        }
+    }
+    /**
+     * Update the contents for a given username.
+     *
+     * @param username
+     * @param org
+     */
+    update(username, org) {
+        const existing = this.get(username) || {};
+        const merged = Object.assign({}, existing, org);
+        return this.set(username, merged);
+    }
+    /**
+     * Delete the auth file for a given username.
+     *
+     * @param username
+     */
+    async remove(username) {
+        await this.configs.get(username)?.unlink();
+        this.configs.delete(username);
+        this.contents.delete(username);
+    }
+    /**
+     * Write the contents of the auth file for a given username.
+     *
+     * @param username
+     */
+    async write(username) {
+        const config = this.configs.get(username);
+        if (config) {
+            return (await config.write());
+        }
+        else {
+            const contents = this.contents.get(username) ?? {};
+            await this.read(username, false, false);
+            // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+            const readConfig = this.configs.get(username);
+            readConfig.setContentsFromObject(contents);
+            return (await readConfig.write());
+        }
+    }
+    async init() {
+        this.logger = await logger_1.Logger.child(this.constructor.name);
+    }
+    async getAllFiles() {
+        const regex = this.getFileRegex();
+        try {
+            return (await fs.promises.readdir(global_1.Global.DIR)).filter((file) => regex.test(file));
+        }
+        catch {
+            return [];
+        }
+    }
+    parseUsername(filename) {
+        return filename.replace(this.getFileExtension(), '');
+    }
+    parseFilename(username) {
+        return path.join(global_1.Global.DIR, `${username}${this.getFileExtension()}`);
+    }
+}
+exports.BaseOrgAccessor = BaseOrgAccessor;
+class OrgAccessor extends BaseOrgAccessor {
+    // eslint-disable-next-line class-methods-use-this
+    async initAuthFile(username, throwOnNotFound = false) {
+        return authInfoConfig_1.AuthInfoConfig.create({
+            ...authInfoConfig_1.AuthInfoConfig.getOptions(username),
+            throwOnNotFound,
+        });
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getFileRegex() {
+        // The regular expression that filters files stored in $HOME/.sfdx
+        return /^[^.][^@]*@[^.]+(\.[^.\s]+)+\.json$/;
+    }
+    // eslint-disable-next-line class-methods-use-this
+    getFileExtension() {
+        return '.json';
+    }
+}
+exports.OrgAccessor = OrgAccessor;
+//# sourceMappingURL=orgAccessor.js.map

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

@@ -0,0 +1,8 @@
+import { SandboxOrgConfig } from '../../config/sandboxOrgConfig';
+import { SandboxFields } from '../../org';
+import { BaseOrgAccessor } from './orgAccessor';
+export declare class SandboxAccessor extends BaseOrgAccessor<SandboxOrgConfig, SandboxFields> {
+    protected initAuthFile(username: string, throwOnNotFound?: boolean): Promise<SandboxOrgConfig>;
+    protected getFileRegex(): RegExp;
+    protected getFileExtension(): string;
+}

package/lib/stateAggregator/accessors/sandboxAccessor.js

@@ -0,0 +1,28 @@
+"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
+ */
+/* eslint-disable class-methods-use-this */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SandboxAccessor = void 0;
+const sandboxOrgConfig_1 = require("../../config/sandboxOrgConfig");
+const orgAccessor_1 = require("./orgAccessor");
+class SandboxAccessor extends orgAccessor_1.BaseOrgAccessor {
+    async initAuthFile(username, throwOnNotFound = false) {
+        return sandboxOrgConfig_1.SandboxOrgConfig.create({
+            ...sandboxOrgConfig_1.SandboxOrgConfig.getOptions(username),
+            throwOnNotFound,
+        });
+    }
+    getFileRegex() {
+        return /^(00D.*?)\.sandbox\.json$/;
+    }
+    getFileExtension() {
+        return '.sandbox.json';
+    }
+}
+exports.SandboxAccessor = SandboxAccessor;
+//# sourceMappingURL=sandboxAccessor.js.map

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

@@ -0,0 +1,63 @@
+import { AsyncOptionalCreatable } from '@salesforce/kit';
+import { JsonMap, Optional } from '@salesforce/ts-types';
+export type SfToken = {
+    token: string;
+    url: string;
+    user?: string;
+    timestamp: string;
+} & JsonMap;
+export type SfTokens = {
+    [key: string]: SfToken;
+};
+export declare class TokenAccessor extends AsyncOptionalCreatable {
+    private config;
+    /**
+     * Return all tokens.
+     *
+     * @param decrypt
+     * @returns {SfTokens}
+     */
+    getAll(decrypt?: boolean): SfTokens;
+    /**
+     * Return a token for the provided name.
+     *
+     * @param name
+     * @param decrypt
+     * @returns {Optional<SfToken>}
+     */
+    get(name: string, decrypt?: boolean): Optional<SfToken>;
+    /**
+     * Return true if a given name has a token associated with it.
+     *
+     * @param name
+     * @returns {boolean}
+     */
+    has(name: string): boolean;
+    /**
+     * Set the token for the provided name.
+     *
+     * @param name
+     * @param token
+     */
+    set(name: string, token: Partial<SfToken>): void;
+    /**
+     * Update the token for the provided name.
+     *
+     * @param name
+     * @param token
+     */
+    update(name: string, token: Partial<SfToken>): void;
+    /**
+     * Unet the token for the provided name.
+     *
+     * @param name
+     */
+    unset(name: string): void;
+    /**
+     * Write the contents to the token file.
+     *
+     * @returns {Promise<SfTokens>}
+     */
+    write(): Promise<SfTokens>;
+    protected init(): Promise<void>;
+}

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}