@salesforce/core 3.7.9 → 3.9.0

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.9.0](https://github.com/forcedotcom/sfdx-core/compare/v3.8.1...v3.9.0) (2022-03-21)
+
+### Features
+
+- add TTLConfig ([#538](https://github.com/forcedotcom/sfdx-core/issues/538)) ([e623241](https://github.com/forcedotcom/sfdx-core/commit/e623241c7e513778c8f179dde4dc16e603a3778c))
+
+### [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

package/lib/config/ttlConfig.d.ts

@@ -0,0 +1,32 @@
+import { Duration } from '@salesforce/kit';
+import { JsonMap, Nullable } from '@salesforce/ts-types';
+import { ConfigFile } from './configFile';
+/**
+ * A Time To Live configuration file where each entry is timestamped and removed once the TTL has expired.
+ *
+ * @example
+ * import { Duration } from '@salesforce/kit';
+ * const config = await TTLConfig.create({
+ *   isGlobal: false,
+ *   ttl: Duration.days(1)
+ * });
+ */
+export declare class TTLConfig<T extends TTLConfig.Options, P extends JsonMap> extends ConfigFile<T, TTLConfig.Contents<P>> {
+    set(key: string, value: Partial<TTLConfig.Entry<P>>): void;
+    getLatestEntry(): Nullable<[string, TTLConfig.Entry<P>]>;
+    getLatestKey(): Nullable<string>;
+    isExpired(dateTime: number, value: P & {
+        timestamp: string;
+    }): boolean;
+    protected init(): Promise<void>;
+    private timestamp;
+}
+export declare namespace TTLConfig {
+    type Options = ConfigFile.Options & {
+        ttl: Duration;
+    };
+    type Entry<T extends JsonMap> = T & {
+        timestamp: string;
+    };
+    type Contents<T extends JsonMap> = Record<string, Entry<T>>;
+}

package/lib/config/ttlConfig.js

@@ -0,0 +1,54 @@
+"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.TTLConfig = void 0;
+const configFile_1 = require("./configFile");
+/**
+ * A Time To Live configuration file where each entry is timestamped and removed once the TTL has expired.
+ *
+ * @example
+ * import { Duration } from '@salesforce/kit';
+ * const config = await TTLConfig.create({
+ *   isGlobal: false,
+ *   ttl: Duration.days(1)
+ * });
+ */
+class TTLConfig extends configFile_1.ConfigFile {
+    set(key, value) {
+        super.set(key, this.timestamp(value));
+    }
+    getLatestEntry() {
+        const entries = this.entries();
+        const sorted = entries.sort(([, valueA], [, valueB]) => {
+            return new Date(valueB.timestamp).getTime() - new Date(valueA.timestamp).getTime();
+        });
+        return sorted.length > 0 ? sorted[0] : null;
+    }
+    getLatestKey() {
+        const [key] = this.getLatestEntry() || [null];
+        return key;
+    }
+    isExpired(dateTime, value) {
+        return dateTime - new Date(value.timestamp).getTime() > this.options.ttl.milliseconds;
+    }
+    async init() {
+        const contents = await this.read(this.options.throwOnNotFound);
+        const purged = {};
+        const date = new Date().getTime();
+        for (const [key, opts] of Object.entries(contents)) {
+            if (!this.isExpired(date, opts))
+                purged[key] = opts;
+        }
+        this.setContents(purged);
+    }
+    timestamp(value) {
+        return { ...value, timestamp: new Date().toISOString() };
+    }
+}
+exports.TTLConfig = TTLConfig;
+//# sourceMappingURL=ttlConfig.js.map

package/lib/exported.d.ts

@@ -1,5 +1,6 @@
 export { OAuth2Config } from 'jsforce';
 export { ConfigFile } from './config/configFile';
+export { TTLConfig } from './config/ttlConfig';
 export { envVars, EnvironmentVariable, SUPPORTED_ENV_VARS, EnvVars } from './config/envVars';
 export { BaseConfigStore, ConfigContents, ConfigEntry, ConfigStore, ConfigValue } from './config/configStore';
 export { GlobalInfo, SfEntry, SfInfo, SfInfoKeys, SfOrg, SfOrgs, SfToken, SfTokens } from './globalInfo';
@@ -7,7 +8,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/exported.js

@@ -16,11 +16,13 @@ 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 });
-exports.scratchOrgCreate = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = exports.DefaultUserFields = exports.MyDomainResolver = exports.StreamingClient = exports.CometClient = exports.PollingClient = exports.SfdxError = exports.SfError = exports.SchemaValidator = exports.SchemaPrinter = exports.SfdxProjectJson = exports.SfdxProject = exports.SfProjectJson = exports.SfProject = exports.ORG_CONFIG_ALLOWED_PROPERTIES = exports.OrgConfigProperties = exports.OrgTypes = exports.SandboxEvents = exports.Org = exports.Messages = exports.Logger = exports.LoggerLevel = exports.getJwtAudienceUrl = exports.SfdcUrl = exports.WebOAuthServer = exports.Lifecycle = exports.Global = exports.Mode = exports.SFDX_HTTP_HEADERS = exports.Connection = exports.AuthRemover = exports.AuthInfo = exports.ConfigAggregator = exports.SFDX_ALLOWED_PROPERTIES = exports.SfdxPropertyKeys = exports.Config = exports.OrgUsersConfig = exports.DeviceOauthService = exports.SfInfoKeys = exports.GlobalInfo = exports.BaseConfigStore = exports.EnvVars = exports.SUPPORTED_ENV_VARS = exports.EnvironmentVariable = exports.envVars = exports.ConfigFile = void 0;
+exports.scratchOrgCreate = exports.PermissionSetAssignment = exports.User = exports.REQUIRED_FIELDS = exports.DefaultUserFields = exports.MyDomainResolver = exports.StreamingClient = exports.CometClient = exports.PollingClient = exports.SfdxError = exports.SfError = exports.SchemaValidator = exports.SchemaPrinter = exports.SfdxProjectJson = exports.SfdxProject = exports.SfProjectJson = exports.SfProject = exports.ORG_CONFIG_ALLOWED_PROPERTIES = exports.OrgConfigProperties = exports.OrgTypes = exports.SandboxEvents = exports.Org = exports.Messages = exports.Logger = exports.LoggerLevel = exports.getJwtAudienceUrl = exports.SfdcUrl = exports.WebOAuthServer = exports.Lifecycle = exports.Global = exports.Mode = exports.SFDX_HTTP_HEADERS = exports.Connection = exports.AuthRemover = exports.AuthInfo = exports.ConfigAggregator = exports.SFDX_ALLOWED_PROPERTIES = exports.SfdxPropertyKeys = exports.Config = exports.OrgUsersConfig = exports.DeviceOauthService = exports.SfInfoKeys = exports.GlobalInfo = exports.BaseConfigStore = exports.EnvVars = exports.SUPPORTED_ENV_VARS = exports.EnvironmentVariable = exports.envVars = exports.TTLConfig = exports.ConfigFile = void 0;
 const messages_1 = require("./messages");
 messages_1.Messages.importMessagesDirectory(__dirname);
 var configFile_1 = require("./config/configFile");
 Object.defineProperty(exports, "ConfigFile", { enumerable: true, get: function () { return configFile_1.ConfigFile; } });
+var ttlConfig_1 = require("./config/ttlConfig");
+Object.defineProperty(exports, "TTLConfig", { enumerable: true, get: function () { return ttlConfig_1.TTLConfig; } });
 var envVars_1 = require("./config/envVars");
 Object.defineProperty(exports, "envVars", { enumerable: true, get: function () { return envVars_1.envVars; } });
 Object.defineProperty(exports, "EnvironmentVariable", { enumerable: true, get: function () { return envVars_1.EnvironmentVariable; } });

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/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.9",
+  "version": "3.9.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",