@salesforce/core 8.12.0 → 8.12.1-dev.0

package/lib/org/authInfo.d.ts

@@ -7,6 +7,15 @@ import { Org } from './org';
  * Fields for authorization, org, and local information.
  */
 export type AuthFields = {
+    apps?: {
+        [key: string]: {
+            clientId: string;
+            clientSecret?: string;
+            accessToken: string;
+            refreshToken: string;
+            oauthFlow: 'web';
+        };
+    };
     accessToken?: string;
     alias?: string;
     authCode?: string;
@@ -234,8 +243,10 @@ export declare class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
     update(authData?: AuthFields): AuthInfo;
     /**
      * Get the auth fields (decrypted) needed to make a connection.
+     *
+     * @param app Name of the CA/ECA associated with the user.
      */
-    getConnectionOptions(): ConnectionOptions;
+    getConnectionOptions(app?: string): ConnectionOptions;
     getClientId(): string;
     getRedirectUri(): string;
     /**
@@ -343,6 +354,13 @@ export declare namespace AuthInfo {
          * OAuth options.
          */
         oauth2Options?: JwtOAuth2Config;
+        apps?: Array<{
+            name: string;
+            accessToken: string;
+            refreshToken: string;
+            clientId: string;
+            clientSecret?: string;
+        }>;
         /**
          * Options for the access token auth.
          */

package/lib/org/authInfo.js

@@ -445,38 +445,85 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
     }
     /**
      * Get the auth fields (decrypted) needed to make a connection.
+     *
+     * @param app Name of the CA/ECA associated with the user.
      */
-    getConnectionOptions() {
+    getConnectionOptions(app) {
         const decryptedCopy = this.getFields(true);
         const { accessToken, instanceUrl, loginUrl } = decryptedCopy;
-        if (this.isAccessTokenFlow()) {
-            this.logger.info('Returning fields for a connection using access token.');
-            // Just auth with the accessToken
-            return { accessToken, instanceUrl, loginUrl };
-        }
-        if (this.isJwt()) {
-            this.logger.info('Returning fields for a connection using JWT config.');
+        // return main app auth fields
+        if (!app) {
+            if (this.isAccessTokenFlow()) {
+                this.logger.info('Returning fields for a connection using access token.');
+                // Just auth with the accessToken
+                return { accessToken, instanceUrl, loginUrl };
+            }
+            if (this.isJwt()) {
+                this.logger.info('Returning fields for a connection using JWT config.');
+                return {
+                    accessToken,
+                    instanceUrl,
+                    refreshFn: this.refreshFn.bind(this),
+                };
+            }
+            // @TODO: figure out loginUrl and redirectUri (probably get from config class)
+            //
+            // redirectUri: org.config.getOauthCallbackUrl()
+            // loginUrl: this.fields.instanceUrl || this.config.getAppConfig().sfdcLoginUrl
+            this.logger.info('Returning fields for a connection using OAuth config.');
+            // Decrypt a user provided client secret or use the default.
             return {
+                oauth2: {
+                    loginUrl: instanceUrl ?? sfdcUrl_1.SfdcUrl.PRODUCTION,
+                    clientId: this.getClientId(),
+                    redirectUri: this.getRedirectUri(),
+                },
                 accessToken,
                 instanceUrl,
                 refreshFn: this.refreshFn.bind(this),
             };
         }
-        // @TODO: figure out loginUrl and redirectUri (probably get from config class)
-        //
-        // redirectUri: org.config.getOauthCallbackUrl()
-        // loginUrl: this.fields.instanceUrl || this.config.getAppConfig().sfdcLoginUrl
-        this.logger.info('Returning fields for a connection using OAuth config.');
-        // Decrypt a user provided client secret or use the default.
+        if (!decryptedCopy.apps) {
+            throw new sfError_1.SfError(`${this.username} does not have any apps linked yet.`);
+        }
+        if (!(app in decryptedCopy.apps)) {
+            throw new sfError_1.SfError(`${this.username} does not have a "${app}" app linked yet.`);
+        }
+        const decryptedApp = decryptedCopy.apps[app];
         return {
             oauth2: {
                 loginUrl: instanceUrl ?? sfdcUrl_1.SfdcUrl.PRODUCTION,
-                clientId: this.getClientId(),
+                clientId: decryptedApp.clientId,
                 redirectUri: this.getRedirectUri(),
             },
-            accessToken,
+            accessToken: decryptedApp.accessToken,
             instanceUrl,
-            refreshFn: this.refreshFn.bind(this),
+            // Specific refreshFn for AuthInfo's apps.
+            //
+            // Each app stores the oauth flow used for its initial auth, here we ensure each refresh returns
+            // a token, update the auth file with it and send it back to jsforce's through the callback.
+            refreshFn: async (_conn, callback) => {
+                // This only handles refresh for web flow.
+                // When more flows are supported for apps, check the `app.oauthFlow` field to set the appropiate refresh helper.
+                const authFields = await this.buildRefreshTokenConfig({
+                    clientId: decryptedApp.clientId,
+                    clientSecret: decryptedApp.clientSecret,
+                    refreshToken: decryptedApp.refreshToken,
+                    loginUrl: instanceUrl,
+                });
+                await this.save({
+                    apps: {
+                        [app]: {
+                            accessToken: (0, ts_types_1.ensureString)(authFields.accessToken),
+                            clientId: decryptedApp.clientId,
+                            clientSecret: decryptedApp.clientSecret,
+                            refreshToken: decryptedApp.refreshToken,
+                            oauthFlow: 'web',
+                        },
+                    },
+                });
+                await callback(null, authFields.accessToken);
+            },
         };
     }
     getClientId() {

package/lib/org/connection.d.ts

@@ -184,5 +184,9 @@ export declare namespace Connection {
          * Additional connection parameters.
          */
         connectionOptions?: ConnectionConfig<S>;
+        /**
+         * App to use for auth info credentials.
+         */
+        app?: string;
     };
 }

package/lib/org/connection.js

@@ -86,7 +86,7 @@ class Connection extends jsforce_node_1.Connection {
             callOptions: {
                 client: clientId,
             },
-            ...options.authInfo.getConnectionOptions(),
+            ...options.authInfo.getConnectionOptions(options.app),
             // this assertion is questionable, but has existed before core7
         };
         const conn = new this({ ...options, connectionOptions });

package/lib/webOAuthServer.d.ts

@@ -26,6 +26,8 @@ export declare class WebOAuthServer extends AsyncCreatable<WebOAuthServer.Option
     private oauth2;
     private oauthConfig;
     private oauthError;
+    private app?;
+    private username?;
     constructor(options: WebOAuthServer.Options);
     /**
      * Returns the configured oauthLocalPort or the WebOAuthServer.DEFAULT_PORT
@@ -80,7 +82,31 @@ export declare class WebOAuthServer extends AsyncCreatable<WebOAuthServer.Option
 }
 export declare namespace WebOAuthServer {
     type Options = {
-        oauthConfig: JwtOAuth2Config;
+        oauthConfig: JwtOAuth2Config & {
+            /**
+             * OAuth scopes to be requested for the access token.
+             *
+             * This should be a string with each scope separated by spaces:
+             * "refresh_token sfap_api chatbot_api web api"
+             *
+             * If not specified, all scopes assigned to the connected app are requested.
+             */
+            scope?: string;
+        };
+    } | {
+        oauthConfig: JwtOAuth2Config & {
+            /**
+             * OAuth scopes to be requested for the access token.
+             *
+             * This should be a string with each scope separated by spaces:
+             * "refresh_token sfap_api chatbot_api web api"
+             *
+             * If not specified, all scopes assigned to the connected app are requested.
+             */
+            scope?: string;
+        };
+        app: string;
+        username: string;
     };
     type Request = http.IncomingMessage & {
         query: {

package/lib/webOAuthServer.js

@@ -73,9 +73,15 @@ class WebOAuthServer extends kit_1.AsyncCreatable {
     oauth2;
     oauthConfig;
     oauthError = new Error('Oauth Error');
+    app;
+    username;
     constructor(options) {
         super(options);
         this.oauthConfig = options.oauthConfig;
+        if ('app' in options) {
+            this.app = options.app;
+            this.username = options.username;
+        }
     }
     /**
      * Returns the configured oauthLocalPort or the WebOAuthServer.DEFAULT_PORT
@@ -113,14 +119,43 @@ class WebOAuthServer extends kit_1.AsyncCreatable {
                 this.executeOauthRequest()
                     .then(async (response) => {
                     try {
-                        const authInfo = await authInfo_1.AuthInfo.create({
-                            oauth2Options: this.oauthConfig,
-                            oauth2: this.oauth2,
-                        });
-                        await authInfo.save();
-                        await this.webServer.handleSuccess(response);
-                        response.end();
-                        resolve(authInfo);
+                        // Link app to an existing auth file.
+                        if (this.app) {
+                            const authInfo = await authInfo_1.AuthInfo.create({
+                                oauth2Options: this.oauthConfig,
+                                oauth2: this.oauth2,
+                            });
+                            const authFields = authInfo.getFields(true);
+                            // get user authInfo and save app creds in `apps`
+                            const userAuthInfo = await authInfo_1.AuthInfo.create({
+                                username: this.username,
+                            });
+                            await userAuthInfo.save({
+                                apps: {
+                                    [this.app]: {
+                                        clientId: (0, ts_types_1.ensureString)(authFields.clientId),
+                                        clientSecret: authFields.clientSecret,
+                                        accessToken: (0, ts_types_1.ensureString)(authFields.accessToken),
+                                        refreshToken: (0, ts_types_1.ensureString)(authFields.refreshToken),
+                                        oauthFlow: 'web',
+                                    },
+                                },
+                            });
+                            await this.webServer.handleSuccess(response);
+                            response.end();
+                            resolve(authInfo);
+                        }
+                        else {
+                            // new auth, create new file.
+                            const authInfo = await authInfo_1.AuthInfo.create({
+                                oauth2Options: this.oauthConfig,
+                                oauth2: this.oauth2,
+                            });
+                            await authInfo.save();
+                            await this.webServer.handleSuccess(response);
+                            response.end();
+                            resolve(authInfo);
+                        }
                     }
                     catch (err) {
                         this.oauthError = err;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "8.12.0",
+  "version": "8.12.1-dev.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/index",
   "types": "lib/index.d.ts",