@salesforce/core 4.0.0 → 4.1.0

package/lib/util/cache.d.ts

@@ -1,11 +1,11 @@
 export declare class Cache extends Map {
     #private;
     private constructor();
+    static get hits(): number;
+    static get lookups(): number;
     static instance(): Cache;
     static set<V>(key: string, value: V): void;
     static get<V>(key: string): V | undefined;
     static disable(): void;
     static enable(): void;
-    static get hits(): number;
-    static get lookups(): number;
 }

package/lib/util/cache.js

@@ -28,6 +28,12 @@ class Cache extends Map {
         __classPrivateFieldSet(this, _Cache_hits, 0, "f");
         __classPrivateFieldSet(this, _Cache_lookups, 0, "f");
     }
+    static get hits() {
+        return __classPrivateFieldGet(Cache.instance(), _Cache_hits, "f");
+    }
+    static get lookups() {
+        return __classPrivateFieldGet(Cache.instance(), _Cache_lookups, "f");
+    }
     static instance() {
         if (!__classPrivateFieldGet(Cache, _a, "f", _Cache_instance)) {
             __classPrivateFieldSet(Cache, _a, true, "f", _Cache_enabled);
@@ -55,12 +61,6 @@ class Cache extends Map {
     static enable() {
         __classPrivateFieldSet(Cache, _a, true, "f", _Cache_enabled);
     }
-    static get hits() {
-        return __classPrivateFieldGet(Cache.instance(), _Cache_hits, "f");
-    }
-    static get lookups() {
-        return __classPrivateFieldGet(Cache.instance(), _Cache_lookups, "f");
-    }
 }
 exports.Cache = Cache;
 _a = Cache, _Cache_hits = new WeakMap(), _Cache_lookups = new WeakMap();

package/lib/util/checkLightningDomain.js

@@ -11,11 +11,10 @@ const kit_1 = require("@salesforce/kit");
 const myDomainResolver_1 = require("../status/myDomainResolver");
 const sfdc_1 = require("./sfdc");
 async function checkLightningDomain(url) {
-    var _a, _b;
-    const domain = `https://${(_a = /https?:\/\/([^.]*)/.exec(url)) === null || _a === void 0 ? void 0 : _a.slice(1, 2).pop()}.lightning.force.com`;
-    const quantity = (_b = new kit_1.Env().getNumber('SFDX_DOMAIN_RETRY', 240)) !== null && _b !== void 0 ? _b : 0;
+    const domain = `https://${/https?:\/\/([^.]*)/.exec(url)?.slice(1, 2).pop()}.lightning.force.com`;
+    const quantity = new kit_1.Env().getNumber('SFDX_DOMAIN_RETRY', 240) ?? 0;
     const timeout = new kit_1.Duration(quantity, kit_1.Duration.Unit.SECONDS);
-    if (sfdc_1.sfdc.isInternalUrl(url) || timeout.seconds === 0) {
+    if ((0, sfdc_1.isInternalUrl)(url) || timeout.seconds === 0) {
         return true;
     }
     const resolver = await myDomainResolver_1.MyDomainResolver.create({

package/lib/util/directoryWriter.d.ts

@@ -0,0 +1,12 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Readable } from 'stream';
+import { StructuredWriter } from './structuredWriter';
+export declare class DirectoryWriter implements StructuredWriter {
+    private readonly rootDestination?;
+    constructor(rootDestination?: string | undefined);
+    get buffer(): Buffer;
+    addToStore(contents: string | Readable | Buffer, targetPath: string): Promise<void>;
+    finalize(): Promise<void>;
+    getDestinationPath(): string | undefined;
+}

package/lib/util/directoryWriter.js

@@ -0,0 +1,54 @@
+"use strict";
+/*
+ * Copyright (c) 2021, 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.DirectoryWriter = void 0;
+const stream_1 = require("stream");
+const fs = require("fs");
+const os = require("os");
+const path = require("path");
+const util_1 = require("util");
+const pipeline = (0, util_1.promisify)(stream_1.pipeline);
+class DirectoryWriter {
+    constructor(rootDestination) {
+        this.rootDestination = rootDestination;
+        if (!this.rootDestination) {
+            this.rootDestination = fs.mkdtempSync(`${os.tmpdir()}${path.sep}`);
+        }
+        else {
+            fs.mkdirSync(this.rootDestination, { recursive: true });
+        }
+    }
+    // eslint-disable-next-line class-methods-use-this
+    get buffer() {
+        throw new Error('Not implemented');
+    }
+    async addToStore(contents, targetPath) {
+        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+        const destPath = path.join(this.rootDestination, targetPath);
+        fs.mkdirSync(path.dirname(destPath), { recursive: true });
+        if (contents instanceof stream_1.Readable) {
+            const writeStream = fs.createWriteStream(destPath);
+            await pipeline(contents, writeStream);
+        }
+        else if (typeof contents === 'string') {
+            fs.writeFileSync(destPath, contents);
+        }
+        else if (contents instanceof Buffer) {
+            fs.writeFileSync(destPath, contents);
+        }
+    }
+    // eslint-disable-next-line class-methods-use-this
+    finalize() {
+        return Promise.resolve(undefined);
+    }
+    getDestinationPath() {
+        return this.rootDestination;
+    }
+}
+exports.DirectoryWriter = DirectoryWriter;
+//# sourceMappingURL=directoryWriter.js.map

package/lib/util/getJwtAudienceUrl.js

@@ -11,7 +11,7 @@ const sfdcUrl_1 = require("./sfdcUrl");
 async function getJwtAudienceUrl(options) {
     if (options.loginUrl) {
         const url = new sfdcUrl_1.SfdcUrl(options.loginUrl);
-        return await url.getJwtAudienceUrl(options.createdOrgInstance);
+        return url.getJwtAudienceUrl(options.createdOrgInstance);
     }
     return sfdcUrl_1.SfdcUrl.PRODUCTION;
 }

package/lib/util/internal.d.ts

@@ -1,3 +1,4 @@
+import { Optional } from '@salesforce/ts-types';
 /**
  * The name of the project config file.
  *
@@ -11,7 +12,7 @@ export declare const SFDX_PROJECT_JSON = "sfdx-project.json";
  *
  * **See** {@link traverseForFile}
  *
- * **Throws** *{@link SfdxError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
+ * **Throws** *{@link SfError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
  *
  * @param dir The directory path to start traversing from.
  * @ignore
@@ -24,9 +25,34 @@ export declare function resolveProjectPath(dir?: string): Promise<string>;
  *
  * **See** {@link traverseForFile}
  *
- * **Throws** *{@link SfdxError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
+ * **Throws** *{@link SfError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
  *
  * @param dir The directory path to start traversing from.
  * @ignore
  */
 export declare function resolveProjectPathSync(dir?: string): string;
+/**
+ * These methods were moved from the deprecated 'fs' module in v2 and are only used in sfdx-core above
+ *
+ * They were migrated into the 'traverse' constant in order to stub them in unit tests
+ */
+export declare const traverse: {
+    /**
+     * Searches a file path in an ascending manner (until reaching the filesystem root) for the first occurrence a
+     * specific file name.  Resolves with the directory path containing the located file, or `null` if the file was
+     * not found.
+     *
+     * @param dir The directory path in which to start the upward search.
+     * @param file The file name to look for.
+     */
+    forFile: (dir: string, file: string) => Promise<Optional<string>>;
+    /**
+     * Searches a file path synchronously in an ascending manner (until reaching the filesystem root) for the first occurrence a
+     * specific file name.  Resolves with the directory path containing the located file, or `null` if the file was
+     * not found.
+     *
+     * @param dir The directory path in which to start the upward search.
+     * @param file The file name to look for.
+     */
+    forFileSync: (dir: string, file: string) => Optional<string>;
+};

package/lib/util/internal.js

@@ -6,11 +6,11 @@
  * 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.resolveProjectPathSync = exports.resolveProjectPath = exports.SFDX_PROJECT_JSON = void 0;
+exports.traverse = exports.resolveProjectPathSync = exports.resolveProjectPath = exports.SFDX_PROJECT_JSON = void 0;
+const fs = require("fs");
+const path_1 = require("path");
 const messages_1 = require("../messages");
-const fs_1 = require("./fs");
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.load('@salesforce/core', 'config', ['invalidProjectWorkspace']);
+const messages = new messages_1.Messages('@salesforce/core', 'config', new Map([["unknownConfigKey", "Unknown config name: %s."], ["deprecatedConfigKey", "Deprecated config name: %s. Please use %s instead."], ["invalidWrite", "The writeSync method is not allowed on SfdxConfig. Use the async write method instead."], ["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."], ["invalidBooleanConfigValue", "The config value can only be set to true or false."], ["invalidProjectWorkspace", "This directory does not contain a valid Salesforce DX project."], ["schemaValidationError", "The config file \"%s\" is not schema valid.\nDue to: %s"], ["schemaValidationError.actions", ["Fix the invalid entries at %s."]], ["missingDefaultPath", "In sfdx-project.json, be sure to specify which package directory (path) is the default. Example: `[{ \"path\": \"packageDirectory1\", \"default\": true }, { \"path\": \"packageDirectory2\" }]`"], ["missingPackageDirectory", "The path \"%s\", specified in sfdx-project.json, does not exist. Be sure this directory is included in your project root."], ["invalidPackageDirectory", "The path \"%s\", specified in sfdx-project.json, must be indicated as a relative path to the project root."], ["multipleDefaultPaths", "In sfdx-project.json, indicate only one package directory (path) as the default."], ["singleNonDefaultPackage", "The sfdx-project.json file must include one, and only one, default package directory (path). Because your sfdx-project.json file contains only one package directory, it must be the default. Remove the `\"default\": false` key and try again."], ["target-org", "Username or alias of the org that all commands run against by default. (sf only)"], ["target-dev-hub", "Username or alias of your default Dev Hub org. (sf only)"], ["defaultUsername", "Username or alias of the org that all commands run against by default. (sfdx only)"], ["defaultDevHubUsername", "Username or alias of your default Dev Hub org. (sfdx only)"], ["isvDebuggerSid", "ISV debugger SID (sfdx only)"], ["isvDebuggerUrl", "ISV debugger URL (sfdx only)"], ["org-isv-debugger-sid", "ISV debugger SID."], ["org-isv-debugger-url", "ISV debugger URL."], ["apiVersion", "API version of your project. Default: API version of your Dev Hub org. (sfdx only)"], ["org-api-version", "API version of your project. Default: API version of your Dev Hub org."], ["disableTelemetry", "Disables the collection of usage and user environment information, etc. Default: false. (sfdx only)"], ["disable-telemetry", "Disables the collection of usage and user environment information, etc. Default: false."], ["maxQueryLimit", "Maximum number of Salesforce records returned by a CLI command. Default: 10,000. (sfdx only)"], ["org-max-query-limit", "Maximum number of Salesforce records returned by a CLI command. Default: 10,000."], ["restDeploy", "Whether deployments use the Metadata REST API (true) or SOAP API (false, default value). (sfdx only)"], ["instanceUrl", "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com. (sfdx only)"], ["org-instance-url", "URL of the Salesforce instance hosting your org. Default: https://login.salesforce.com."], ["customOrgMetadataTemplates", "A valid repository URL or directory for the custom org metadata templates."], ["org-custom-metadata-templates", "A valid repository URL or directory for the custom org metadata templates."], ["invalidId", "The given id %s is not a valid 15 or 18 character Salesforce ID."]]));
 /**
  * The name of the project config file.
  *
@@ -25,13 +25,13 @@ exports.SFDX_PROJECT_JSON = 'sfdx-project.json';
  *
  * **See** {@link traverseForFile}
  *
- * **Throws** *{@link SfdxError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
+ * **Throws** *{@link SfError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
  *
  * @param dir The directory path to start traversing from.
  * @ignore
  */
 async function resolveProjectPath(dir = process.cwd()) {
-    const projectPath = await fs_1.fs.traverseForFile(dir, exports.SFDX_PROJECT_JSON);
+    const projectPath = await exports.traverse.forFile(dir, exports.SFDX_PROJECT_JSON);
     if (!projectPath) {
         throw messages.createError('invalidProjectWorkspace');
     }
@@ -45,17 +45,74 @@ exports.resolveProjectPath = resolveProjectPath;
  *
  * **See** {@link traverseForFile}
  *
- * **Throws** *{@link SfdxError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
+ * **Throws** *{@link SfError}{ name: 'InvalidProjectWorkspaceError' }* If the current folder is not located in a workspace.
  *
  * @param dir The directory path to start traversing from.
  * @ignore
  */
 function resolveProjectPathSync(dir = process.cwd()) {
-    const projectPath = fs_1.fs.traverseForFileSync(dir, exports.SFDX_PROJECT_JSON);
+    const projectPath = exports.traverse.forFileSync(dir, exports.SFDX_PROJECT_JSON);
     if (!projectPath) {
         throw messages.createError('invalidProjectWorkspace');
     }
     return projectPath;
 }
 exports.resolveProjectPathSync = resolveProjectPathSync;
+/**
+ * These methods were moved from the deprecated 'fs' module in v2 and are only used in sfdx-core above
+ *
+ * They were migrated into the 'traverse' constant in order to stub them in unit tests
+ */
+exports.traverse = {
+    /**
+     * Searches a file path in an ascending manner (until reaching the filesystem root) for the first occurrence a
+     * specific file name.  Resolves with the directory path containing the located file, or `null` if the file was
+     * not found.
+     *
+     * @param dir The directory path in which to start the upward search.
+     * @param file The file name to look for.
+     */
+    forFile: async (dir, file) => {
+        let foundProjectDir;
+        try {
+            fs.statSync((0, path_1.join)(dir, file));
+            foundProjectDir = dir;
+        }
+        catch (err) {
+            if (err && err.code === 'ENOENT') {
+                const nextDir = (0, path_1.resolve)(dir, '..');
+                if (nextDir !== dir) {
+                    // stop at root
+                    foundProjectDir = await exports.traverse.forFile(nextDir, file);
+                }
+            }
+        }
+        return foundProjectDir;
+    },
+    /**
+     * Searches a file path synchronously in an ascending manner (until reaching the filesystem root) for the first occurrence a
+     * specific file name.  Resolves with the directory path containing the located file, or `null` if the file was
+     * not found.
+     *
+     * @param dir The directory path in which to start the upward search.
+     * @param file The file name to look for.
+     */
+    forFileSync: (dir, file) => {
+        let foundProjectDir;
+        try {
+            fs.statSync((0, path_1.join)(dir, file));
+            foundProjectDir = dir;
+        }
+        catch (err) {
+            if (err && err.code === 'ENOENT') {
+                const nextDir = (0, path_1.resolve)(dir, '..');
+                if (nextDir !== dir) {
+                    // stop at root
+                    foundProjectDir = exports.traverse.forFileSync(nextDir, file);
+                }
+            }
+        }
+        return foundProjectDir;
+    },
+};
 //# sourceMappingURL=internal.js.map

package/lib/util/jsonXmlTools.js

@@ -21,12 +21,10 @@ exports.standardOptions = {
 };
 const writeJSONasXML = async ({ path, json, type, options = exports.standardOptions, }) => {
     const xml = jsToXml.parse(type, (0, exports.fixExistingDollarSign)(json), options);
-    return await fs_1.promises.writeFile(path, xml);
+    return fs_1.promises.writeFile(path, xml);
 };
 exports.writeJSONasXML = writeJSONasXML;
-const JsonAsXml = ({ json, type, options = exports.standardOptions }) => {
-    return jsToXml.parse(type, (0, exports.fixExistingDollarSign)(json), options);
-};
+const JsonAsXml = ({ json, type, options = exports.standardOptions }) => jsToXml.parse(type, (0, exports.fixExistingDollarSign)(json), options);
 exports.JsonAsXml = JsonAsXml;
 const fixExistingDollarSign = (existing) => {
     const existingCopy = { ...existing };

package/lib/util/mapKeys.d.ts

@@ -1,14 +1,14 @@
 /**
- *  Use mapKeys to convert object keys to another format using the specified conversion function.
+ * Use mapKeys to convert object keys to another format using the specified conversion function.
  *
- *  E.g., to deep convert all object keys to camelCase:  mapKeys(myObj, _.camelCase, true)
- *        to shallow convert object keys to lower case:  mapKeys(myObj, _.toLower)
+ * E.g., to deep convert all object keys to camelCase:  mapKeys(myObj, _.camelCase, true)
+ * to shallow convert object keys to lower case:  mapKeys(myObj, _.toLower)
  *
- *  NOTE: This mutates the object passed in for conversion.
+ * NOTE: This mutates the object passed in for conversion.
  *
- *  @param target - {Object} The object to convert the keys
- *  @param converter - {Function} The function that converts the object key
- *  @param deep - {boolean} Whether to do a deep object key conversion
- *  @return {Object} - the object with the converted keys
+ * @param target - {Object} The object to convert the keys
+ * @param converter - {Function} The function that converts the object key
+ * @param deep - {boolean} Whether to do a deep object key conversion
+ * @return {Object} - the object with the converted keys
  */
-export default function mapKeys(obj: any, converter: (key: string) => string, deep?: boolean): Record<string, unknown>;
+export default function mapKeys<T>(obj: T, converter: (key: string) => string, deep?: boolean): Record<string, unknown>;

package/lib/util/mapKeys.js

@@ -8,23 +8,26 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const ts_types_1 = require("@salesforce/ts-types");
 /**
- *  Use mapKeys to convert object keys to another format using the specified conversion function.
+ * Use mapKeys to convert object keys to another format using the specified conversion function.
  *
- *  E.g., to deep convert all object keys to camelCase:  mapKeys(myObj, _.camelCase, true)
- *        to shallow convert object keys to lower case:  mapKeys(myObj, _.toLower)
+ * E.g., to deep convert all object keys to camelCase:  mapKeys(myObj, _.camelCase, true)
+ * to shallow convert object keys to lower case:  mapKeys(myObj, _.toLower)
  *
- *  NOTE: This mutates the object passed in for conversion.
+ * NOTE: This mutates the object passed in for conversion.
  *
- *  @param target - {Object} The object to convert the keys
- *  @param converter - {Function} The function that converts the object key
- *  @param deep - {boolean} Whether to do a deep object key conversion
- *  @return {Object} - the object with the converted keys
+ * @param target - {Object} The object to convert the keys
+ * @param converter - {Function} The function that converts the object key
+ * @param deep - {boolean} Whether to do a deep object key conversion
+ * @return {Object} - the object with the converted keys
  */
 function mapKeys(
 // eslint-disable-next-line @typescript-eslint/no-explicit-any, @typescript-eslint/explicit-module-boundary-types
 obj, converter, deep) {
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
     const target = Object.assign({}, obj);
-    return Object.fromEntries(Object.entries(target).map(([key, value]) => {
+    return Object.fromEntries(
+    // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+    Object.entries(target).map(([key, value]) => {
         const k = converter.call(null, key);
         if (deep) {
             let v = value;
@@ -33,6 +36,7 @@ obj, converter, deep) {
                     if ((0, ts_types_1.isPlainObject)(v1)) {
                         return mapKeys(v1, converter, deep);
                     }
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
                     return v1;
                 });
             }

package/lib/util/sfdc.d.ts

@@ -1,52 +1,52 @@
 import { JsonMap, Optional } from '@salesforce/ts-types';
-export declare const sfdc: {
-    /**
-     * Converts an 18 character Salesforce ID to 15 characters.
-     *
-     * @param id The id to convert.
-     */
-    trimTo15: (id?: string | undefined) => Optional<string>;
-    /**
-     * Tests whether an API version matches the format `i.0`.
-     *
-     * @param value The API version as a string.
-     */
-    validateApiVersion: (value: string) => boolean;
-    /**
-     * Tests whether an email matches the format `me@my.org`
-     *
-     * @param value The email as a string.
-     */
-    validateEmail: (value: string) => boolean;
-    /**
-     * Tests whether a Salesforce ID is in the correct format, a 15- or 18-character length string with only letters and numbers
-     *
-     * @param value The ID as a string.
-     */
-    validateSalesforceId: (value: string) => boolean;
-    /**
-     * Tests whether a path is in the correct format; the value doesn't include the characters "[", "]", "?", "<", ">", "?", "|"
-     *
-     * @param value The path as a string.
-     */
-    validatePathDoesNotContainInvalidChars: (value: string) => boolean;
-    /**
-     * Returns the first key within the object that has an upper case first letter.
-     *
-     * @param data The object in which to check key casing.
-     * @param sectionBlocklist properties in the object to exclude from the search. e.g. a blocklist of `["a"]` and data of `{ "a": { "B" : "b"}}` would ignore `B` because it is in the object value under `a`.
-     */
-    findUpperCaseKeys: (data?: JsonMap | undefined, sectionBlocklist?: string[]) => Optional<string>;
-    /**
-     * Tests whether a given string is an access token
-     *
-     * @param value
-     */
-    matchesAccessToken: (value: string) => boolean;
-    /**
-     * Tests whether a given url is an internal Salesforce domain
-     *
-     * @param url
-     */
-    isInternalUrl: (url: string) => boolean;
-};
+/**
+ * Converts an 18 character Salesforce ID to 15 characters.
+ *
+ * @param id The id to convert.
+ */
+export declare function trimTo15(id: string): string;
+export declare function trimTo15(id?: undefined): undefined;
+export declare function trimTo15(id: string | undefined): string | undefined;
+/**
+ * Tests whether an API version matches the format `i.0`.
+ *
+ * @param value The API version as a string.
+ */
+export declare const validateApiVersion: (value: string) => boolean;
+/**
+ * Tests whether an email matches the format `me@my.org`
+ *
+ * @param value The email as a string.
+ */
+export declare const validateEmail: (value: string) => boolean;
+/**
+ * Tests whether a given url is an internal Salesforce domain
+ *
+ * @param url
+ */
+export declare const isInternalUrl: (url: string) => boolean;
+/**
+ * Tests whether a Salesforce ID is in the correct format, a 15- or 18-character length string with only letters and numbers
+ *
+ * @param value The ID as a string.
+ */
+export declare const validateSalesforceId: (value: string) => boolean;
+/**
+ * Tests whether a path is in the correct format; the value doesn't include the characters "[", "]", "?", "<", ">", "?", "|"
+ *
+ * @param value The path as a string.
+ */
+export declare const validatePathDoesNotContainInvalidChars: (value: string) => boolean;
+/**
+ * Returns the first key within the object that has an upper case first letter.
+ *
+ * @param data The object in which to check key casing.
+ * @param sectionBlocklist properties in the object to exclude from the search. e.g. a blocklist of `["a"]` and data of `{ "a": { "B" : "b"}}` would ignore `B` because it is in the object value under `a`.
+ */
+export declare const findUpperCaseKeys: (data?: JsonMap, sectionBlocklist?: string[]) => Optional<string>;
+/**
+ * Tests whether a given string is an access token
+ *
+ * @param value
+ */
+export declare const matchesAccessToken: (value: string) => boolean;

package/lib/util/sfdc.js

@@ -6,90 +6,85 @@
  * 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.sfdc = void 0;
+exports.matchesAccessToken = exports.findUpperCaseKeys = exports.validatePathDoesNotContainInvalidChars = exports.validateSalesforceId = exports.isInternalUrl = exports.validateEmail = exports.validateApiVersion = exports.trimTo15 = void 0;
 const kit_1 = require("@salesforce/kit");
 const ts_types_1 = require("@salesforce/ts-types");
 const sfdcUrl_1 = require("./sfdcUrl");
-exports.sfdc = {
-    /**
-     * Converts an 18 character Salesforce ID to 15 characters.
-     *
-     * @param id The id to convert.
-     */
-    trimTo15: (id) => {
-        if (id && id.length && id.length > 15) {
-            id = id.substring(0, 15);
+function trimTo15(id) {
+    if (!id) {
+        return undefined;
+    }
+    if (id.length && id.length > 15) {
+        id = id.substring(0, 15);
+    }
+    return id;
+}
+exports.trimTo15 = trimTo15;
+/**
+ * Tests whether an API version matches the format `i.0`.
+ *
+ * @param value The API version as a string.
+ */
+const validateApiVersion = (value) => value == null || /^[1-9]\d\.0$/.test(value);
+exports.validateApiVersion = validateApiVersion;
+/**
+ * Tests whether an email matches the format `me@my.org`
+ *
+ * @param value The email as a string.
+ */
+const validateEmail = (value) => /^[^.][^@]*@[^.]+(\.[^.\s]+)+$/.test(value);
+exports.validateEmail = validateEmail;
+/**
+ * Tests whether a given url is an internal Salesforce domain
+ *
+ * @param url
+ */
+const isInternalUrl = (url) => new sfdcUrl_1.SfdcUrl(url).isInternalUrl();
+exports.isInternalUrl = isInternalUrl;
+/**
+ * Tests whether a Salesforce ID is in the correct format, a 15- or 18-character length string with only letters and numbers
+ *
+ * @param value The ID as a string.
+ */
+const validateSalesforceId = (value) => /[a-zA-Z0-9]{18}|[a-zA-Z0-9]{15}/.test(value) && (value.length === 15 || value.length === 18);
+exports.validateSalesforceId = validateSalesforceId;
+/**
+ * Tests whether a path is in the correct format; the value doesn't include the characters "[", "]", "?", "<", ">", "?", "|"
+ *
+ * @param value The path as a string.
+ */
+const validatePathDoesNotContainInvalidChars = (value) => 
+// eslint-disable-next-line no-useless-escape
+!/[\["\?<>\|\]]+/.test(value);
+exports.validatePathDoesNotContainInvalidChars = validatePathDoesNotContainInvalidChars;
+/**
+ * Returns the first key within the object that has an upper case first letter.
+ *
+ * @param data The object in which to check key casing.
+ * @param sectionBlocklist properties in the object to exclude from the search. e.g. a blocklist of `["a"]` and data of `{ "a": { "B" : "b"}}` would ignore `B` because it is in the object value under `a`.
+ */
+const findUpperCaseKeys = (data, sectionBlocklist = []) => {
+    let key;
+    (0, kit_1.findKey)(data, (val, k) => {
+        if (/^[A-Z]/.test(k)) {
+            key = k;
         }
-        return id;
-    },
-    /**
-     * Tests whether an API version matches the format `i.0`.
-     *
-     * @param value The API version as a string.
-     */
-    validateApiVersion: (value) => {
-        return value == null || /^[1-9]\d\.0$/.test(value);
-    },
-    /**
-     * Tests whether an email matches the format `me@my.org`
-     *
-     * @param value The email as a string.
-     */
-    validateEmail: (value) => {
-        return /^[^.][^@]*@[^.]+(\.[^.\s]+)+$/.test(value);
-    },
-    /**
-     * Tests whether a Salesforce ID is in the correct format, a 15- or 18-character length string with only letters and numbers
-     *
-     * @param value The ID as a string.
-     */
-    validateSalesforceId: (value) => {
-        return /[a-zA-Z0-9]{18}|[a-zA-Z0-9]{15}/.test(value) && (value.length === 15 || value.length === 18);
-    },
-    /**
-     * Tests whether a path is in the correct format; the value doesn't include the characters "[", "]", "?", "<", ">", "?", "|"
-     *
-     * @param value The path as a string.
-     */
-    validatePathDoesNotContainInvalidChars: (value) => {
-        // eslint-disable-next-line no-useless-escape
-        return !/[\["\?<>\|\]]+/.test(value);
-    },
-    /**
-     * Returns the first key within the object that has an upper case first letter.
-     *
-     * @param data The object in which to check key casing.
-     * @param sectionBlocklist properties in the object to exclude from the search. e.g. a blocklist of `["a"]` and data of `{ "a": { "B" : "b"}}` would ignore `B` because it is in the object value under `a`.
-     */
-    findUpperCaseKeys: (data, sectionBlocklist = []) => {
-        let key;
-        (0, kit_1.findKey)(data, (val, k) => {
-            if (k.substr(0, 1) === k.substr(0, 1).toUpperCase()) {
-                key = k;
-            }
-            else if ((0, ts_types_1.isJsonMap)(val)) {
-                if (sectionBlocklist.includes(k)) {
-                    return key;
-                }
-                key = exports.sfdc.findUpperCaseKeys((0, ts_types_1.asJsonMap)(val));
+        else if ((0, ts_types_1.isJsonMap)(val)) {
+            if (sectionBlocklist.includes(k)) {
+                return key;
             }
-            return key;
-        });
+            key = (0, exports.findUpperCaseKeys)((0, ts_types_1.asJsonMap)(val));
+        }
         return key;
-    },
-    /**
-     * Tests whether a given string is an access token
-     *
-     * @param value
-     */
-    matchesAccessToken: (value) => {
-        return /^(00D\w{12,15})![.\w]*$/.test(value);
-    },
-    /**
-     * Tests whether a given url is an internal Salesforce domain
-     *
-     * @param url
-     */
-    isInternalUrl: (url) => new sfdcUrl_1.SfdcUrl(url).isInternalUrl(),
+    });
+    return key;
 };
+exports.findUpperCaseKeys = findUpperCaseKeys;
+/**
+ * Tests whether a given string is an access token
+ *
+ * @param value
+ */
+const matchesAccessToken = (value) => /^(00D\w{12,15})![.\w]*$/.test(value);
+exports.matchesAccessToken = matchesAccessToken;
 //# sourceMappingURL=sfdc.js.map