@salesforce/core 4.0.0-v3.0 → 4.0.0

package/lib/org/authRemover.d.ts

@@ -1,7 +1,7 @@
 import { AsyncOptionalCreatable } from '@salesforce/kit';
-import { SfOrg, SfOrgs } from '../config/globalInfoConfig';
+import { SfOrg, SfOrgs } from '../globalInfo';
 /**
- * Handles the removing of authorizations, which includes deleting the auth file
+ * Handles  the removing of authorizations, which includes deleting the auth file
  * in the global .sfdx folder, deleting any configs that are associated with the username/alias,
  * and deleting any aliases associated with the username
  *
@@ -24,11 +24,9 @@ import { SfOrg, SfOrgs } from '../config/globalInfoConfig';
  * ```
  */
 export declare class AuthRemover extends AsyncOptionalCreatable {
-    private globalConfig;
-    private localConfig;
+    private config;
     private globalInfo;
     private logger;
-    private aliases;
     /**
      * Removes the authentication and any configs or aliases associated with it
      *
@@ -41,17 +39,17 @@ export declare class AuthRemover extends AsyncOptionalCreatable {
     removeAllAuths(): Promise<void>;
     /**
      * Finds authorization files for username/alias in the global .sfdx folder
-     * **Throws** *{@link SfdxError}{ name: 'DefaultUsernameNotSetError' }* if no defaultusername
+     * **Throws** *{@link SfdxError}{ name: 'TargetOrgNotSetError' }* if no target-org
      * **Throws** *{@link SfdxError}{ name: 'NamedOrgNotFoundError' }* if specified user is not found
      *
-     * @param usernameOrAlias username or alias of the auth you want to find, defaults to the configured defaultusername
-     * @returns {Promise<Authorization>}
+     * @param usernameOrAlias username or alias of the auth you want to find, defaults to the configured target-org
+     * @returns {Promise<SfOrg>}
      */
     findAuth(usernameOrAlias?: string): Promise<SfOrg>;
     /**
-     * Finds all authorization files in the global .sfdx folder
+     * Finds all org authorizations in the global info file (.sf/sf.json)
      *
-     * @returns {Promise<SfOrgs>}
+     * @returns {SfOrgs}
      */
     findAllAuths(): SfOrgs;
     protected init(): Promise<void>;
@@ -63,16 +61,9 @@ export declare class AuthRemover extends AsyncOptionalCreatable {
      */
     private resolveUsername;
     /**
-     * Instantiates config class
-     *
-     * @param isGlobal
-     * @returns {Promise<Nullable<Config>>}
-     */
-    private getConfig;
-    /**
-     * @returns {Promise<string>}
+     * @returns {string}
      */
-    private getDefaultUsername;
+    private getTargetOrg;
     /**
      * Returns aliases for provided username
      *
@@ -92,4 +83,5 @@ export declare class AuthRemover extends AsyncOptionalCreatable {
      * @param username username that you want to remove from aliases
      */
     private unsetAliases;
+    private unsetTokens;
 }

package/lib/org/authRemover.js

@@ -8,17 +8,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthRemover = void 0;
 const kit_1 = require("@salesforce/kit");
-const aliases_1 = require("../config/aliases");
-const config_1 = require("../config/config");
 const configAggregator_1 = require("../config/configAggregator");
 const logger_1 = require("../logger");
 const messages_1 = require("../messages");
-const globalInfoConfig_1 = require("../config/globalInfoConfig");
+const globalInfo_1 = require("../globalInfo");
+const orgConfigProperties_1 = require("./orgConfigProperties");
 messages_1.Messages.importMessagesDirectory(__dirname);
 const coreMessages = messages_1.Messages.load('@salesforce/core', 'core', ['namedOrgNotFound']);
-const messages = messages_1.Messages.load('@salesforce/core', 'auth', ['defaultUsernameNotSet']);
+const messages = messages_1.Messages.load('@salesforce/core', 'auth', ['targetOrgNotSet']);
 /**
- * Handles the removing of authorizations, which includes deleting the auth file
+ * Handles  the removing of authorizations, which includes deleting the auth file
  * in the global .sfdx folder, deleting any configs that are associated with the username/alias,
  * and deleting any aliases associated with the username
  *
@@ -51,7 +50,8 @@ class AuthRemover extends kit_1.AsyncOptionalCreatable {
         this.logger.debug(`Removing authorization for user ${username}`);
         await this.unsetConfigValues(username);
         await this.unsetAliases(username);
-        this.globalInfo.unsetOrg(username);
+        this.unsetTokens(username);
+        this.globalInfo.orgs.unset(username);
         await this.globalInfo.write();
     }
     /**
@@ -66,34 +66,32 @@ class AuthRemover extends kit_1.AsyncOptionalCreatable {
     }
     /**
      * Finds authorization files for username/alias in the global .sfdx folder
-     * **Throws** *{@link SfdxError}{ name: 'DefaultUsernameNotSetError' }* if no defaultusername
+     * **Throws** *{@link SfdxError}{ name: 'TargetOrgNotSetError' }* if no target-org
      * **Throws** *{@link SfdxError}{ name: 'NamedOrgNotFoundError' }* if specified user is not found
      *
-     * @param usernameOrAlias username or alias of the auth you want to find, defaults to the configured defaultusername
-     * @returns {Promise<Authorization>}
+     * @param usernameOrAlias username or alias of the auth you want to find, defaults to the configured target-org
+     * @returns {Promise<SfOrg>}
      */
     async findAuth(usernameOrAlias) {
-        const username = usernameOrAlias ? await this.resolveUsername(usernameOrAlias) : await this.getDefaultUsername();
-        const auth = this.globalInfo.getOrg(username);
+        const username = usernameOrAlias ? await this.resolveUsername(usernameOrAlias) : this.getTargetOrg();
+        const auth = this.globalInfo.orgs.get(username);
         if (!auth) {
             throw coreMessages.createError('namedOrgNotFound');
         }
         return auth;
     }
     /**
-     * Finds all authorization files in the global .sfdx folder
+     * Finds all org authorizations in the global info file (.sf/sf.json)
      *
-     * @returns {Promise<SfOrgs>}
+     * @returns {SfOrgs}
      */
     findAllAuths() {
-        return this.globalInfo.getOrgs();
+        return this.globalInfo.orgs.getAll();
     }
     async init() {
         this.logger = await logger_1.Logger.child(this.constructor.name);
-        this.globalConfig = await this.getConfig(true);
-        this.localConfig = await this.getConfig(false);
-        this.globalInfo = await globalInfoConfig_1.GlobalInfo.getInstance();
-        this.aliases = await aliases_1.Aliases.create(aliases_1.Aliases.getDefaultOptions());
+        this.config = await configAggregator_1.ConfigAggregator.create();
+        this.globalInfo = await globalInfo_1.GlobalInfo.getInstance();
     }
     /**
      * Returns the username for a given alias if the alias exists.
@@ -102,35 +100,17 @@ class AuthRemover extends kit_1.AsyncOptionalCreatable {
      * @returns {Promise<string>}
      */
     async resolveUsername(usernameOrAlias) {
-        const aliasedValue = this.aliases.get(usernameOrAlias);
-        return (aliasedValue || usernameOrAlias);
+        return this.globalInfo.aliases.resolveUsername(usernameOrAlias);
     }
     /**
-     * Instantiates config class
-     *
-     * @param isGlobal
-     * @returns {Promise<Nullable<Config>>}
-     */
-    async getConfig(isGlobal) {
-        let config;
-        try {
-            config = await config_1.Config.create({ isGlobal });
-        }
-        catch (_a) {
-            config = null;
-        }
-        return config;
-    }
-    /**
-     * @returns {Promise<string>}
+     * @returns {string}
      */
-    async getDefaultUsername() {
-        const configAggregator = await configAggregator_1.ConfigAggregator.create();
-        const defaultUsername = configAggregator.getInfo(config_1.Config.DEFAULT_USERNAME).value;
-        if (!defaultUsername) {
-            throw messages.createError('defaultUsernameNotSet');
+    getTargetOrg() {
+        const targetOrg = this.config.getInfo(orgConfigProperties_1.OrgConfigProperties.TARGET_ORG).value;
+        if (!targetOrg) {
+            throw messages.createError('targetOrgNotSet');
         }
-        return defaultUsername;
+        return targetOrg;
     }
     /**
      * Returns aliases for provided username
@@ -139,7 +119,7 @@ class AuthRemover extends kit_1.AsyncOptionalCreatable {
      * @returns {Promise<string[]>}
      */
     getAliases(username) {
-        return this.aliases.getKeysByValue(username) || [];
+        return this.globalInfo.aliases.getAll(username);
     }
     /**
      * Unsets any configured values (both global and local) for provided username
@@ -149,7 +129,8 @@ class AuthRemover extends kit_1.AsyncOptionalCreatable {
     async unsetConfigValues(username) {
         const aliases = this.getAliases(username);
         this.logger.debug(`Clearing config keys for username ${username} and aliases: ${aliases}`);
-        for (const config of [this.globalConfig, this.localConfig]) {
+        const configs = [this.config.getGlobalConfig(), this.config.getLocalConfig()];
+        for (const config of configs) {
             if (config) {
                 const keysWithUsername = config.getKeysByValue(username) || [];
                 const keysWithAlias = aliases
@@ -158,7 +139,14 @@ class AuthRemover extends kit_1.AsyncOptionalCreatable {
                     .reduce((x, y) => x.concat(y), []);
                 const allKeys = keysWithUsername.concat(keysWithAlias);
                 this.logger.debug(`Found these config keys to remove: ${allKeys}`);
-                allKeys.forEach((key) => config.unset(key));
+                allKeys.forEach((key) => {
+                    try {
+                        config.unset(key);
+                    }
+                    catch {
+                        this.logger.debug(`Failed to remove ${key}`);
+                    }
+                });
                 await config.write();
             }
         }
@@ -170,10 +158,20 @@ class AuthRemover extends kit_1.AsyncOptionalCreatable {
      */
     async unsetAliases(username) {
         this.logger.debug(`Clearing aliases for username: ${username}`);
-        const existingAliases = this.aliases.getKeysByValue(username);
+        const existingAliases = this.globalInfo.aliases.getAll(username);
+        if (existingAliases.length === 0)
+            return;
         this.logger.debug(`Found these aliases to remove: ${existingAliases}`);
-        existingAliases.forEach((alias) => this.aliases.unset(alias));
-        await this.aliases.write();
+        existingAliases.forEach((alias) => this.globalInfo.aliases.unset(alias));
+    }
+    unsetTokens(username) {
+        this.logger.debug(`Clearing tokens for username: ${username}`);
+        const tokens = this.globalInfo.tokens.getAll();
+        for (const [key, token] of Object.entries(tokens)) {
+            if (token.user === username) {
+                this.globalInfo.tokens.unset(key);
+            }
+        }
     }
 }
 exports.AuthRemover = AuthRemover;

package/lib/org/connection.d.ts

@@ -1,10 +1,11 @@
 /// <reference types="node" />
 import { AsyncResult, DeployOptions, DeployResultLocator } from 'jsforce/api/metadata';
-import { Callback } from 'jsforce/connection';
 import { JsonCollection, JsonMap, Optional } from '@salesforce/ts-types';
-import { Connection as JSForceConnection, ConnectionOptions, ExecuteOptions, QueryResult, RequestInfo, Tooling as JSForceTooling } from 'jsforce';
-import { AuthFields, AuthInfo } from '../org/authInfo';
+import { Connection as JSForceConnection, ConnectionConfig, HttpRequest, QueryOptions, QueryResult, Record, Schema } from 'jsforce';
+import { Tooling as JSForceTooling } from 'jsforce/lib/api/tooling';
+import { StreamPromise } from 'jsforce/lib/util/promise';
 import { ConfigAggregator } from '../config/configAggregator';
+import { AuthFields, AuthInfo } from './authInfo';
 export declare const SFDX_HTTP_HEADERS: {
     'content-type': string;
     'user-agent': string;
@@ -14,10 +15,11 @@ declare type recentValidationOptions = {
     id: string;
     rest?: boolean;
 };
-export declare type DeployOptionsWithRest = DeployOptions & {
+export declare type DeployOptionsWithRest = Partial<DeployOptions> & {
     rest?: boolean;
 };
-export interface Tooling extends JSForceTooling {
+export interface Tooling<S extends Schema = Schema> extends JSForceTooling<S> {
+    _logger: any;
     /**
      * Executes a query and auto-fetches (i.e., "queryMore") all results.  This is especially
      * useful with large query result sizes, such as over 2000 records.  The default maximum
@@ -26,7 +28,7 @@ export interface Tooling extends JSForceTooling {
      * @param soql The SOQL string.
      * @param options The query options.  NOTE: the autoFetch option will always be true.
      */
-    autoFetchQuery<T>(soql: string, options?: ExecuteOptions): Promise<QueryResult<T>>;
+    autoFetchQuery<T extends Schema = S>(soql: string, options?: QueryOptions): Promise<QueryResult<T>>;
 }
 /**
  * Handles connections and requests to Salesforce Orgs.
@@ -43,14 +45,12 @@ export interface Tooling extends JSForceTooling {
  * connection.query('SELECT Name from Account');
  * ```
  */
-export declare class Connection extends JSForceConnection {
+export declare class Connection<S extends Schema = Schema> extends JSForceConnection<S> {
     /**
      * Tooling api reference.
      */
-    tooling: Tooling;
+    get tooling(): Tooling<S>;
     private logger;
-    private _transport;
-    private _normalizeUrl;
     private options;
     private username;
     /**
@@ -60,13 +60,13 @@ export declare class Connection extends JSForceConnection {
      * @param options The options for the class instance.
      * @ignore
      */
-    constructor(options: Connection.Options);
+    constructor(options: Connection.Options<S>);
     /**
      * Creates an instance of a Connection. Performs additional async initializations.
      *
      * @param options Constructor options.
      */
-    static create(this: new (options: Connection.Options) => Connection, options: Connection.Options): Promise<Connection>;
+    static create<S extends Schema>(this: new (options: Connection.Options<S>) => Connection<S>, options: Connection.Options<S>): Promise<Connection<S>>;
     /**
      * Async initializer.
      */
@@ -81,7 +81,7 @@ export declare class Connection extends JSForceConnection {
      * @param options JSForce deploy options + a boolean for rest
      * @param callback
      */
-    deploy(zipInput: Buffer, options: DeployOptionsWithRest, callback?: Callback<AsyncResult>): Promise<DeployResultLocator<AsyncResult>>;
+    deploy(zipInput: Buffer, options: DeployOptionsWithRest): Promise<DeployResultLocator<AsyncResult & Schema>>;
     /**
      * Send REST API request with given HTTP request info, with connected session information
      * and SFDX headers.
@@ -89,14 +89,7 @@ export declare class Connection extends JSForceConnection {
      * @param request HTTP request object or URL to GET request.
      * @param options HTTP API request options.
      */
-    request(request: RequestInfo | string, options?: JsonMap): Promise<JsonCollection>;
-    /**
-     * Send REST API request with given HTTP request info, with connected session information
-     * and SFDX headers. This method returns a raw http response which includes a response body and statusCode.
-     *
-     * @param request HTTP request object or URL to GET request.
-     */
-    requestRaw(request: RequestInfo): Promise<JsonMap>;
+    request<R = unknown>(request: string | HttpRequest, options?: JsonMap): StreamPromise<R>;
     /**
      * The Force API base url for the instance.
      */
@@ -167,9 +160,9 @@ export declare class Connection extends JSForceConnection {
      * fetch size is 10,000 records. Modify this via the options argument.
      *
      * @param soql The SOQL string.
-     * @param executeOptions The query options. NOTE: the autoFetch option will always be true.
+     * @param queryOptions The query options. NOTE: the autoFetch option will always be true.
      */
-    autoFetchQuery<T>(soql: string, executeOptions?: ExecuteOptions): Promise<QueryResult<T>>;
+    autoFetchQuery<T extends Schema = S>(soql: string, queryOptions?: Partial<QueryOptions>): Promise<QueryResult<T>>;
     /**
      * Executes a query using either standard REST or Tooling API, returning a single record.
      * Will throw if either zero records are found OR multiple records are found.
@@ -177,7 +170,12 @@ export declare class Connection extends JSForceConnection {
      * @param soql The SOQL string.
      * @param options The query options.
      */
-    singleRecordQuery<T>(soql: string, options?: SingleRecordQueryOptions): Promise<T>;
+    singleRecordQuery<T extends Record>(soql: string, options?: SingleRecordQueryOptions): Promise<T>;
+    /**
+     * Executes a get request on the baseUrl to force an auth refresh
+     * Useful for the raw methods (request, requestRaw) that use the accessToken directly and don't handle refreshes
+     */
+    refreshAuth(): Promise<void>;
     private loadInstanceApiVersion;
 }
 export declare const SingleRecordQueryErrors: {
@@ -193,7 +191,7 @@ export declare namespace Connection {
     /**
      * Connection Options.
      */
-    interface Options {
+    interface Options<S extends Schema> {
         /**
          * AuthInfo instance.
          */
@@ -205,7 +203,7 @@ export declare namespace Connection {
         /**
          * Additional connection parameters.
          */
-        connectionOptions?: ConnectionOptions;
+        connectionOptions?: ConnectionConfig<S>;
     }
 }
 export {};