@salesforce/core 2.27.2 → 2.28.0

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 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.
 
+## [2.28.0](https://github.com/forcedotcom/sfdx-core/compare/v2.27.2...v2.28.0) (2021-09-16)
+
+
+### Features
+
+* add custom templates config ([3cf8a8c](https://github.com/forcedotcom/sfdx-core/commit/3cf8a8cee1e7196efced989dcca9b545e1283386))
+* add validator for custom templates config ([dd2bcfe](https://github.com/forcedotcom/sfdx-core/commit/dd2bcfe8e7fee5c5c1c6321189ec04288103d5b6))
+* update config name ([72e84bf](https://github.com/forcedotcom/sfdx-core/commit/72e84bfacef48a1c2d00a61ebbae3f632601abbd))
+
 ### [2.27.2](https://github.com/forcedotcom/sfdx-core/compare/v2.27.1...v2.27.2) (2021-08-05)
 
 

package/lib/authInfo.d.ts

@@ -163,6 +163,8 @@ export declare class AuthInfo extends AsyncCreatable<AuthInfo.Options> {
      * Get a list of all auth files stored in the global directory.
      *
      * @returns {Promise<string[]>}
+     *
+     * @deprecated Removed in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#globalinfo}
      */
     static listAllAuthFiles(): Promise<string[]>;
     /**
@@ -187,6 +189,8 @@ export declare class AuthInfo extends AsyncCreatable<AuthInfo.Options> {
      * Forces the auth file to be re-read from disk for a given user. Returns `true` if a value was removed.
      *
      * @param username The username for the auth info to re-read.
+     *
+     * @deprecated Removed in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#configstore-configfile-authinfo-and-encrypting-values}
      */
     static clearCache(username: string): boolean;
     /**

package/lib/authInfo.js

@@ -216,6 +216,8 @@ class AuthInfo extends kit_1.AsyncCreatable {
      * Get a list of all auth files stored in the global directory.
      *
      * @returns {Promise<string[]>}
+     *
+     * @deprecated Removed in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#globalinfo}
      */
     static async listAllAuthFiles() {
         const globalFiles = await fs_1.fs.readdir(global_1.Global.DIR);
@@ -306,6 +308,8 @@ class AuthInfo extends kit_1.AsyncCreatable {
      * Forces the auth file to be re-read from disk for a given user. Returns `true` if a value was removed.
      *
      * @param username The username for the auth info to re-read.
+     *
+     * @deprecated Removed in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#configstore-configfile-authinfo-and-encrypting-values}
      */
     static clearCache(username) {
         if (username) {

package/lib/config/aliases.d.ts

@@ -22,6 +22,8 @@ export declare enum AliasGroup {
  * const username: string = await Aliases.fetch('myAlias');
  * ```
  * https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_cli_usernames_orgs.htm
+ *
+ * @deprecated Replaced by GlobalInfo in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#globalinfo}
  */
 export declare class Aliases extends ConfigGroup<ConfigGroup.Options> {
     /**

package/lib/config/aliases.js

@@ -33,6 +33,8 @@ var AliasGroup;
  * const username: string = await Aliases.fetch('myAlias');
  * ```
  * https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_cli_usernames_orgs.htm
+ *
+ * @deprecated Replaced by GlobalInfo in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#globalinfo}
  */
 class Aliases extends configGroup_1.ConfigGroup {
     /**

package/lib/config/authInfoConfig.d.ts

@@ -6,6 +6,8 @@ import { ConfigFile } from './configFile';
  * ```
  * const authInfo = await AuthInfoConfig.create(AuthInfoConfig.getOptions(username));
  * ```
+ *
+ * @deprecated Replaced by GlobalInfo in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#globalinfo}
  */
 export declare class AuthInfoConfig extends ConfigFile<ConfigFile.Options> {
     /**

package/lib/config/authInfoConfig.js

@@ -15,6 +15,8 @@ const configFile_1 = require("./configFile");
  * ```
  * const authInfo = await AuthInfoConfig.create(AuthInfoConfig.getOptions(username));
  * ```
+ *
+ * @deprecated Replaced by GlobalInfo in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#globalinfo}
  */
 class AuthInfoConfig extends configFile_1.ConfigFile {
     /**

package/lib/config/config.d.ts

@@ -52,10 +52,14 @@ export interface ConfigPropertyMetaInput {
 export declare class Config extends ConfigFile<ConfigFile.Options> {
     /**
      * Username associated with the default dev hub org.
+     *
+     * @deprecated Replaced by OrgConfigProperties.TARGET_DEV_HUB in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     static readonly DEFAULT_DEV_HUB_USERNAME: string;
     /**
      * Username associate with the default org.
+     *
+     * @deprecated Replaced by OrgConfigProperties.TARGET_ORG in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
     static readonly DEFAULT_USERNAME: string;
     /**
@@ -74,6 +78,10 @@ export declare class Config extends ConfigFile<ConfigFile.Options> {
      * Disables telemetry reporting
      */
     static readonly DISABLE_TELEMETRY = "disableTelemetry";
+    /**
+     * Custom templates repo or local location.
+     */
+    static readonly CUSTOM_ORG_METADATA_TEMPLATES = "customOrgMetadataTemplates";
     /**
      * allows users to override the 10,000 result query limit
      */

package/lib/config/config.js

@@ -258,10 +258,14 @@ class Config extends configFile_1.ConfigFile {
 exports.Config = Config;
 /**
  * Username associated with the default dev hub org.
+ *
+ * @deprecated Replaced by OrgConfigProperties.TARGET_DEV_HUB in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
  */
 Config.DEFAULT_DEV_HUB_USERNAME = 'defaultdevhubusername';
 /**
  * Username associate with the default org.
+ *
+ * @deprecated Replaced by OrgConfigProperties.TARGET_ORG in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
  */
 Config.DEFAULT_USERNAME = 'defaultusername';
 /**
@@ -280,6 +284,10 @@ Config.API_VERSION = 'apiVersion';
  * Disables telemetry reporting
  */
 Config.DISABLE_TELEMETRY = 'disableTelemetry';
+/**
+ * Custom templates repo or local location.
+ */
+Config.CUSTOM_ORG_METADATA_TEMPLATES = 'customOrgMetadataTemplates';
 /**
  * allows users to override the 10,000 result query limit
  */
@@ -308,6 +316,17 @@ Config.allowedProperties = [
             },
         },
     },
+    {
+        key: Config.CUSTOM_ORG_METADATA_TEMPLATES,
+        input: {
+            // If a value is provided validate it otherwise no value is unset.
+            validator: (value) => value == null || ts_types_1.isString(value),
+            get failedMessage() {
+                var _a;
+                return (_a = Config.messages) === null || _a === void 0 ? void 0 : _a.getMessage('InvalidCustomOrgMetadataTemplates');
+            },
+        },
+    },
     { key: Config.DEFAULT_DEV_HUB_USERNAME },
     { key: Config.DEFAULT_USERNAME },
     {

package/lib/util/fs.d.ts

@@ -10,6 +10,9 @@ export declare type WriteJsonOptions = {
      */
     space?: number;
 };
+/**
+ * @deprecated Use fs/promises instead
+ */
 export declare const fs: typeof fsLib & {
     /**
      * The default file system mode to use when creating directories.

package/lib/util/fs.js

@@ -14,6 +14,9 @@ const kit_1 = require("@salesforce/kit");
 const fsLib = require("graceful-fs");
 const mkdirpLib = require("mkdirp");
 const sfdxError_1 = require("../sfdxError");
+/**
+ * @deprecated Use fs/promises instead
+ */
 exports.fs = Object.assign({}, fsLib, {
     /**
      * The default file system mode to use when creating directories.

package/messages/config.json

@@ -3,6 +3,7 @@
   "InvalidConfigValue": "Invalid config value. %s",
   "InvalidInstanceUrl": "Specify a valid Salesforce instance URL",
   "InvalidApiVersion": "Specify a valid Salesforce API version, for example, 42.0",
+  "InvalidCustomOrgMetadataTemplates": "Specify a valid repository URL or directory for the custom org metadata templates.",
   "InvalidIsvDebuggerSid": "Specify a valid Debugger SID",
   "InvalidIsvDebuggerUrl": "Specify a valid Debugger URL",
   "InvalidNumberConfigValue": "Specify a valid positive integer, for example, 150000",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core",
-  "version": "2.27.2",
+  "version": "2.28.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/exported",
   "license": "BSD-3-Clause",