@salesforce/core 3.7.8 → 3.8.1

package/CHANGELOG.md

@@ -2,6 +2,25 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [3.8.1](https://github.com/forcedotcom/sfdx-core/compare/v3.8.0...v3.8.1) (2022-03-18)
+
+### Bug Fixes
+
+- adjust mock org test data to conform to v3 ([38faf50](https://github.com/forcedotcom/sfdx-core/commit/38faf5063931955066312c24b4188b12c40098a5))
+- side effects function should not save when no changes ([#541](https://github.com/forcedotcom/sfdx-core/issues/541)) ([6bfb841](https://github.com/forcedotcom/sfdx-core/commit/6bfb84172fdf74882102b9ffc6e6fbfe58e6ffbc))
+
+## [3.8.0](https://github.com/forcedotcom/sfdx-core/compare/v3.7.9...v3.8.0) (2022-03-09)
+
+### Features
+
+- add handle side effect function to authinfo ([64c78e7](https://github.com/forcedotcom/sfdx-core/commit/64c78e74bc5e1cfb748fd2d64e4b1e8fc1062bf6))
+
+### [3.7.9](https://github.com/forcedotcom/sfdx-core/compare/v3.7.8...v3.7.9) (2022-03-04)
+
+### Bug Fixes
+
+- error literal to match the error thrown ([#533](https://github.com/forcedotcom/sfdx-core/issues/533)) ([b91ce5c](https://github.com/forcedotcom/sfdx-core/commit/b91ce5c329c9b2b88fb4b0ad028aee5f6d5b6e77))
+
 ### [3.7.8](https://github.com/forcedotcom/sfdx-core/compare/v3.7.7...v3.7.8) (2022-03-03)
 
 ### Bug Fixes

package/lib/exported.d.ts

@@ -7,7 +7,7 @@ export { DeviceOauthService, DeviceCodeResponse, DeviceCodePollingResponse } fro
 export { OrgUsersConfig } from './config/orgUsersConfig';
 export { ConfigPropertyMeta, ConfigPropertyMetaInput, Config, SfdxPropertyKeys, SFDX_ALLOWED_PROPERTIES, } from './config/config';
 export { ConfigInfo, ConfigAggregator } from './config/configAggregator';
-export { AuthFields, AuthInfo, OrgAuthorization } from './org/authInfo';
+export { AuthFields, AuthInfo, AuthSideEffects, OrgAuthorization } from './org/authInfo';
 export { AuthRemover } from './org/authRemover';
 export { Connection, SFDX_HTTP_HEADERS } from './org/connection';
 export { Mode, Global } from './global';

package/lib/org/authInfo.d.ts

@@ -59,6 +59,11 @@ export interface AccessTokenOptions {
     loginUrl?: string;
     instanceUrl?: string;
 }
+export declare type AuthSideEffects = {
+    alias: string;
+    setDefault: boolean;
+    setDefaultDevHub: boolean;
+};
 /**
  * A function to update a refresh token when the access token is expired.
  */
@@ -225,6 +230,14 @@ export declare class AuthInfo extends AsyncOptionalCreatable<AuthInfo.Options> {
      * **See** [SFDX Authorization](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_reference.meta/sfdx_cli_reference/cli_reference_force_auth.htm#cli_reference_force_auth)
      */
     getSfdxAuthUrl(): string;
+    /**
+     * Convenience function to handle typical side effects encountered when dealing with an AuthInfo.
+     * Given the values supplied in parameter sideEffects, this function will set auth alias, default auth
+     * and default dev hub.
+     *
+     * @param sideEffects - instance of AuthSideEffects
+     */
+    handleAliasAndDefaultSettings(sideEffects: AuthSideEffects): Promise<void>;
     /**
      * Set the target-env (default) or the target-dev-hub to the alias if
      * it exists otherwise to the username. Method will try to set the local

package/lib/org/authInfo.js

@@ -398,6 +398,24 @@ class AuthInfo extends kit_1.AsyncOptionalCreatable {
         sfdxAuthUrl += `${(0, ts_types_1.ensure)(decryptedFields.refreshToken, 'undefined refreshToken')}@${instanceUrl}`;
         return sfdxAuthUrl;
     }
+    /**
+     * Convenience function to handle typical side effects encountered when dealing with an AuthInfo.
+     * Given the values supplied in parameter sideEffects, this function will set auth alias, default auth
+     * and default dev hub.
+     *
+     * @param sideEffects - instance of AuthSideEffects
+     */
+    async handleAliasAndDefaultSettings(sideEffects) {
+        if (sideEffects.alias || sideEffects.setDefault || sideEffects.setDefaultDevHub) {
+            if (sideEffects.alias)
+                await this.setAlias(sideEffects.alias);
+            if (sideEffects.setDefault)
+                await this.setAsDefault({ org: true });
+            if (sideEffects.setDefaultDevHub)
+                await this.setAsDefault({ devHub: true });
+            await this.save();
+        }
+    }
     /**
      * Set the target-env (default) or the target-dev-hub to the alias if
      * it exists otherwise to the username. Method will try to set the local

package/lib/org/org.js

@@ -850,7 +850,7 @@ class Org extends kit_1.AsyncOptionalCreatable {
             catch (err) {
                 const error = err;
                 this.logger.debug('Exception while calling writeSandboxAuthFile %s', err);
-                if ((error === null || error === void 0 ? void 0 : error.name) === 'JWTAuthError' && ((_a = error === null || error === void 0 ? void 0 : error.stack) === null || _a === void 0 ? void 0 : _a.includes("user hasn't approved"))) {
+                if ((error === null || error === void 0 ? void 0 : error.name) === 'JwtAuthError' && ((_a = error === null || error === void 0 ? void 0 : error.stack) === null || _a === void 0 ? void 0 : _a.includes("user hasn't approved"))) {
                     waitingOnAuth = true;
                 }
                 else {

package/lib/testSetup.d.ts

@@ -377,7 +377,8 @@ export declare class StreamingMockCometClient extends CometClient {
  */
 export declare class MockTestOrgData {
     testId: string;
-    alias?: string;
+    aliases?: string[];
+    configs?: string[];
     username: string;
     devHubUsername?: string;
     orgId: string;
@@ -390,6 +391,9 @@ export declare class MockTestOrgData {
     refreshToken: string;
     userId: string;
     redirectUri: string;
+    isDevHub?: boolean;
+    isScratchOrg?: boolean;
+    isExpired?: boolean | 'unknown';
     constructor(id?: string, options?: {
         username: string;
     });

package/lib/testSetup.js

@@ -493,12 +493,13 @@ class MockTestOrgData {
         this.devHubUsername = username;
     }
     makeDevHub() {
-        (0, kit_1.set)(this, 'isDevHub', true);
+        this.isDevHub = true;
     }
     createUser(user) {
         const userMock = new MockTestOrgData();
         userMock.username = user;
-        userMock.alias = this.alias;
+        userMock.aliases = this.aliases;
+        userMock.configs = this.configs;
         userMock.devHubUsername = this.devHubUsername;
         userMock.orgId = this.orgId;
         userMock.loginUrl = this.loginUrl;
@@ -506,6 +507,9 @@ class MockTestOrgData {
         userMock.clientId = this.clientId;
         userMock.clientSecret = this.clientSecret;
         userMock.redirectUri = this.redirectUri;
+        userMock.isDevHub = this.isDevHub;
+        userMock.isScratchOrg = this.isScratchOrg;
+        userMock.isExpired = this.isExpired;
         return userMock;
     }
     getMockUserInfo() {
@@ -513,7 +517,8 @@ class MockTestOrgData {
             Id: this.userId,
             Username: this.username,
             LastName: `user_lastname_${this.testId}`,
-            Alias: this.alias || 'user_alias_blah',
+            Alias: this.aliases ? this.aliases[0] : 'user_alias_blah',
+            Configs: this.configs,
             TimeZoneSidKey: `user_timezonesidkey_${this.testId}`,
             LocaleSidKey: `user_localesidkey_${this.testId}`,
             EmailEncodingKey: `user_emailencodingkey_${this.testId}`,
@@ -540,14 +545,10 @@ class MockTestOrgData {
         config.createdOrgInstance = 'CS1';
         config.created = '1519163543003';
         config.userId = this.userId;
-        // config.devHubUsername = 'tn@su-blitz.org';
         if (this.devHubUsername) {
             config.devHubUsername = this.devHubUsername;
         }
-        const isDevHub = (0, ts_types_1.getBoolean)(this, 'isDevHub');
-        if (isDevHub) {
-            config.isDevHub = isDevHub;
-        }
+        config.isDevHub = this.isDevHub;
         return config;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.7.8",
+  "version": "3.8.1",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",
@@ -34,9 +34,9 @@
     "!lib/**/*.map"
   ],
   "dependencies": {
-    "@oclif/core": "^1.3.1",
+    "@oclif/core": "^1.5.1",
     "@salesforce/bunyan": "^2.0.0",
-    "@salesforce/kit": "^1.5.28",
+    "@salesforce/kit": "^1.5.34",
     "@salesforce/schemas": "^1.1.0",
     "@salesforce/ts-types": "^1.5.20",
     "@types/graceful-fs": "^4.1.5",
@@ -56,8 +56,8 @@
     "ts-retry-promise": "^0.6.0"
   },
   "devDependencies": {
-    "@salesforce/dev-config": "^3.0.0",
-    "@salesforce/dev-scripts": "^2.0.0",
+    "@salesforce/dev-config": "^3.0.1",
+    "@salesforce/dev-scripts": "^2.0.1",
     "@salesforce/prettier-config": "^0.0.2",
     "@salesforce/ts-sinon": "^1.3.21",
     "@types/archiver": "^5.3.1",