@salesforce/core 4.0.0-v3.0 → 4.0.1

package/lib/config/config.d.ts

@@ -1,4 +1,5 @@
-import { JsonPrimitive } from '@salesforce/ts-types';
+import { JsonPrimitive, Nullable } from '@salesforce/ts-types';
+import { OrgConfigProperties } from '../org/orgConfigProperties';
 import { ConfigFile } from './configFile';
 import { ConfigContents, ConfigValue } from './configStore';
 /**
@@ -6,21 +7,34 @@ import { ConfigContents, ConfigValue } from './configStore';
  */
 export interface ConfigPropertyMeta {
     /**
-     *  The config property name.
+     * The config property name.
      */
     key: string;
     /**
-     *  Reference to the config data input validation.
+     * Description
+     */
+    description: string;
+    /**
+     * Reference to the config data input validation.
      */
     input?: ConfigPropertyMetaInput;
     /**
-     *  True if the property should be indirectly hidden from the user.
+     * True if the property should be indirectly hidden from the user.
      */
     hidden?: boolean;
     /**
      * True if the property values should be stored encrypted.
      */
     encrypted?: boolean;
+    /**
+     * True if the property is deprecated
+     */
+    deprecated?: boolean;
+    /**
+     * Reference to config property name that will eventually replace this one.
+     * Is only used if deprecated is set to true.
+     */
+    newKey?: string;
 }
 /**
  * Config property input validation
@@ -35,60 +49,162 @@ export interface ConfigPropertyMetaInput {
     /**
      * The message to return in the error if the validation fails.
      */
-    failedMessage: string;
+    failedMessage: string | ((value: ConfigValue) => string);
 }
-export declare type ConfigProperties = {
-    [index: string]: JsonPrimitive;
-};
-/**
- * The files where sfdx config values are stored for projects and the global space.
- *
- * *Note:* It is not recommended to instantiate this object directly when resolving
- * config values. Instead use {@link ConfigAggregator}
- *
- * ```
- * const localConfig = await Config.create();
- * localConfig.set('defaultusername', 'username@company.org');
- * await localConfig.write();
- * ```
- * https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_cli_config_values.htm
- */
-export declare class Config extends ConfigFile<ConfigFile.Options, ConfigProperties> {
+export declare enum SfConfigProperties {
+    /**
+     * Disables telemetry reporting
+     */
+    DISABLE_TELEMETRY = "disable-telemetry"
+}
+export declare const SF_ALLOWED_PROPERTIES: {
+    key: SfConfigProperties;
+    description: string;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
+}[];
+export declare enum SfdxPropertyKeys {
     /**
      * 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}
+     * will remain in v3 for the foreseeable future so that `sfdx-core` can map between `sf` and `sfdx` config values
      */
-    static readonly DEFAULT_DEV_HUB_USERNAME: string;
+    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}
+     * will remain in v3 for the foreseeable future so that `sfdx-core` can map between `sf` and `sfdx` config values
      */
-    static readonly DEFAULT_USERNAME: string;
+    DEFAULT_USERNAME = "defaultusername",
     /**
      * The sid for the debugger configuration.
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_ISV_DEBUGGER_SID in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
-    static readonly ISV_DEBUGGER_SID: string;
+    ISV_DEBUGGER_SID = "isvDebuggerSid",
     /**
      * The url for the debugger configuration.
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_ISV_DEBUGGER_URL in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
-    static readonly ISV_DEBUGGER_URL: string;
+    ISV_DEBUGGER_URL = "isvDebuggerUrl",
     /**
      * The api version
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_API_VERSION in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
-    static readonly API_VERSION = "apiVersion";
+    API_VERSION = "apiVersion",
     /**
      * Disables telemetry reporting
+     *
+     * @deprecated Replaced by SfPropertyKeys.DISABLE_TELEMETRY in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
      */
-    static readonly DISABLE_TELEMETRY = "disableTelemetry";
+    DISABLE_TELEMETRY = "disableTelemetry",
+    /**
+     * Custom templates repo or local location.
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_CUSTOM_METADATA_TEMPLATES in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
+     */
+    CUSTOM_ORG_METADATA_TEMPLATES = "customOrgMetadataTemplates",
     /**
      * allows users to override the 10,000 result query limit
+     *
+     * @deprecated Replaced by OrgConfigProperties.ORG_MAX_QUERY_LIMIT in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
+     */
+    MAX_QUERY_LIMIT = "maxQueryLimit",
+    /**
+     * @deprecated
      */
-    static readonly MAX_QUERY_LIMIT = "maxQueryLimit";
-    private static get propertyConfigMap();
+    REST_DEPLOY = "restDeploy",
+    /**
+     * @deprecated Replaced by OrgConfigProperties.ORG_INSTANCE_URL in v3 {@link https://github.com/forcedotcom/sfdx-core/blob/v3/MIGRATING_V2-V3.md#config}
+     */
+    INSTANCE_URL = "instanceUrl"
+}
+export declare const SFDX_ALLOWED_PROPERTIES: ({
+    key: SfdxPropertyKeys;
+    description: string;
+    newKey: OrgConfigProperties;
+    deprecated: boolean;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
+    encrypted?: undefined;
+    hidden?: undefined;
+} | {
+    key: SfdxPropertyKeys;
+    newKey: OrgConfigProperties;
+    deprecated: boolean;
+    description: string;
+    input?: undefined;
+    encrypted?: undefined;
+    hidden?: undefined;
+} | {
+    key: SfdxPropertyKeys;
+    newKey: OrgConfigProperties;
+    deprecated: boolean;
+    description: string;
+    encrypted: boolean;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
+    hidden?: undefined;
+} | {
+    key: SfdxPropertyKeys;
+    newKey: SfConfigProperties;
+    deprecated: boolean;
+    description: string;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
+    encrypted?: undefined;
+    hidden?: undefined;
+} | {
+    key: SfdxPropertyKeys;
+    description: string;
+    hidden: boolean;
+    newKey: string;
+    deprecated: boolean;
+    input: {
+        validator: (value: ConfigValue) => boolean;
+        failedMessage: string;
+    };
+    encrypted?: undefined;
+})[];
+export declare const SfProperty: {
+    [index: string]: ConfigPropertyMeta;
+};
+export type ConfigProperties = {
+    [index: string]: JsonPrimitive;
+};
+/**
+ * The files where sfdx config values are stored for projects and the global space.
+ *
+ * *Note:* It is not recommended to instantiate this object directly when resolving
+ * config values. Instead use {@link ConfigAggregator}
+ *
+ * ```
+ * const localConfig = await Config.create();
+ * localConfig.set('target-org', 'username@company.org');
+ * await localConfig.write();
+ * ```
+ * https://developer.salesforce.com/docs/atlas.en-us.sfdx_dev.meta/sfdx_dev/sfdx_dev_cli_config_values.htm
+ */
+export declare class Config extends ConfigFile<ConfigFile.Options, ConfigProperties> {
     private static allowedProperties;
+    private sfdxConfig;
     constructor(options?: ConfigFile.Options);
     /**
      * Returns the default file name for a config file.
      *
-     * **See** {@link SFDX_CONFIG_FILE_NAME}
+     * **See** {@link CONFIG_FILE_NAME}
      */
     static getFileName(): string;
     /**
@@ -101,13 +217,6 @@ export declare class Config extends ConfigFile<ConfigFile.Options, ConfigPropert
      * @param metas Array of objects to set as the allowed config properties.
      */
     static addAllowedProperties(metas: ConfigPropertyMeta[]): void;
-    /**
-     * Gets default options.
-     *
-     * @param isGlobal Make the config global.
-     * @param filename Override the default file. {@link Config.getFileName}
-     */
-    static getDefaultOptions(isGlobal?: boolean, filename?: string): ConfigFile.Options;
     /**
      * The value of a supported config property.
      *
@@ -120,10 +229,13 @@ export declare class Config extends ConfigFile<ConfigFile.Options, ConfigPropert
      * Clear all the configured properties both local and global.
      */
     static clear(): Promise<void>;
+    static getPropertyConfigMeta(propertyName: string): Nullable<ConfigPropertyMeta>;
+    private static propertyConfigMap;
     /**
      * Read, assign, and return the config contents.
      */
     read(force?: boolean): Promise<ConfigProperties>;
+    readSync(force?: boolean): ConfigProperties;
     /**
      * Writes Config properties taking into account encrypted properties.
      *
@@ -134,7 +246,7 @@ export declare class Config extends ConfigFile<ConfigFile.Options, ConfigPropert
      * DO NOT CALL - The config file needs to encrypt values which can only be done asynchronously.
      * Call {@link SfdxConfig.write} instead.
      *
-     * **Throws** *{@link SfdxError}{ name: 'InvalidWriteError' }* Always.
+     * **Throws** *{@link SfError}{ name: 'InvalidWriteError' }* Always.
      *
      * @param newContents Contents to write
      */
@@ -142,8 +254,8 @@ export declare class Config extends ConfigFile<ConfigFile.Options, ConfigPropert
     /**
      * Sets a value for a property.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnknownConfigKeyError' }* An attempt to get a property that's not supported.
-     * **Throws** *{@link SfdxError}{ name: 'InvalidConfigValueError' }* If the input validator fails.
+     * **Throws** *{@link SfError}{ name: 'UnknownConfigKeyError' }* An attempt to get a property that's not supported.
+     * **Throws** *{@link SfError}{ name: 'InvalidConfigValueError' }* If the input validator fails.
      *
      * @param key The property to set.
      * @param value The value of the property.
@@ -152,23 +264,23 @@ export declare class Config extends ConfigFile<ConfigFile.Options, ConfigPropert
     /**
      * Unsets a value for a property.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnknownConfigKeyError' }* If the input validator fails.
+     * **Throws** *{@link SfError}{ name: 'UnknownConfigKeyError' }* If the input validator fails.
      *
      * @param key The property to unset.
      */
     unset(key: string): boolean;
-    /**
-     * Initializer for supported config types.
-     */
-    protected init(): Promise<void>;
     /**
      * Get an individual property config.
      *
-     * **Throws** *{@link SfdxError}{ name: 'UnknownConfigKeyError' }* An attempt to get a property that's not supported.
+     * **Throws** *{@link SfError}{ name: 'UnknownConfigKeyError' }* An attempt to get a property that's not supported.
      *
      * @param propertyName The name of the property.
      */
-    private getPropertyConfig;
+    getPropertyConfig(propertyName: string): ConfigPropertyMeta;
+    /**
+     * Initializer for supported config types.
+     */
+    protected init(): Promise<void>;
     /**
      * Encrypts and content properties that have a encryption attribute.
      *
@@ -176,3 +288,24 @@ export declare class Config extends ConfigFile<ConfigFile.Options, ConfigPropert
      */
     private cryptProperties;
 }
+export declare class SfdxConfig {
+    private options;
+    private config;
+    private sfdxPath;
+    constructor(options: ConfigFile.Options, config: Config);
+    /**
+     * If Global.SFDX_INTEROPERABILITY is enabled, merge the sfdx config into the sf config
+     */
+    merge(config: ConfigProperties): ConfigProperties | undefined;
+    write(config?: import("@salesforce/ts-types").JsonMap): Promise<void>;
+    private readSync;
+    private getSfdxPath;
+    /**
+     * If toNew is specified: migrate all deprecated configs with a newKey to the newKey.
+     * - For example, defaultusername will be renamed to target-org.
+     *
+     * If toOld is specified: migrate all deprecated configs back to their original key.
+     * - For example, target-org will be renamed to defaultusername.
+     */
+    private translate;
+}