@salesforce/core 3.8.1 → 3.9.0

package/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 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

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';

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "3.8.1",
+  "version": "3.9.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "types": "lib/exported.d.ts",