@salesforce/core 3.31.7 → 3.31.9

package/lib/util/internal.js

@@ -1,119 +1,119 @@
-"use strict";
-/*
- * Copyright (c) 2020, 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.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");
-messages_1.Messages.importMessagesDirectory(__dirname);
-const messages = messages_1.Messages.load('@salesforce/core', 'config', ['invalidProjectWorkspace']);
-/**
- * The name of the project config file.
- *
- * @ignore
- */
-// This has to be defined on util to prevent circular deps with project and configFile.
-exports.SFDX_PROJECT_JSON = 'sfdx-project.json';
-/**
- * Performs an upward directory search for an sfdx project file. Returns the absolute path to the project.
- *
- * **See** {@link SFDX_PROJECT_JSON}
- *
- * **See** {@link traverseForFile}
- *
- * **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 exports.traverse.forFile(dir, exports.SFDX_PROJECT_JSON);
-    if (!projectPath) {
-        throw messages.createError('invalidProjectWorkspace');
-    }
-    return projectPath;
-}
-exports.resolveProjectPath = resolveProjectPath;
-/**
- * Performs a synchronous upward directory search for an sfdx project file. Returns the absolute path to the project.
- *
- * **See** {@link SFDX_PROJECT_JSON}
- *
- * **See** {@link traverseForFile}
- *
- * **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 = 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;
-    },
-};
+"use strict";
+/*
+ * Copyright (c) 2020, 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.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");
+messages_1.Messages.importMessagesDirectory(__dirname);
+const messages = messages_1.Messages.load('@salesforce/core', 'config', ['invalidProjectWorkspace']);
+/**
+ * The name of the project config file.
+ *
+ * @ignore
+ */
+// This has to be defined on util to prevent circular deps with project and configFile.
+exports.SFDX_PROJECT_JSON = 'sfdx-project.json';
+/**
+ * Performs an upward directory search for an sfdx project file. Returns the absolute path to the project.
+ *
+ * **See** {@link SFDX_PROJECT_JSON}
+ *
+ * **See** {@link traverseForFile}
+ *
+ * **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 exports.traverse.forFile(dir, exports.SFDX_PROJECT_JSON);
+    if (!projectPath) {
+        throw messages.createError('invalidProjectWorkspace');
+    }
+    return projectPath;
+}
+exports.resolveProjectPath = resolveProjectPath;
+/**
+ * Performs a synchronous upward directory search for an sfdx project file. Returns the absolute path to the project.
+ *
+ * **See** {@link SFDX_PROJECT_JSON}
+ *
+ * **See** {@link traverseForFile}
+ *
+ * **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 = 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.d.ts

@@ -1,14 +1,14 @@
-import { JsonMap } from '@salesforce/ts-types';
-import { IOptions } from 'js2xmlparser/lib/options';
-export interface JSONasXML {
-    json: JsonMap;
-    type: string;
-    options?: IOptions;
-}
-export interface WriteJSONasXMLInputs extends JSONasXML {
-    path: string;
-}
-export declare const standardOptions: IOptions;
-export declare const writeJSONasXML: ({ path, json, type, options, }: WriteJSONasXMLInputs) => Promise<void>;
-export declare const JsonAsXml: ({ json, type, options }: JSONasXML) => string;
-export declare const fixExistingDollarSign: (existing: WriteJSONasXMLInputs['json']) => Record<string, unknown>;
+import { JsonMap } from '@salesforce/ts-types';
+import { IOptions } from 'js2xmlparser/lib/options';
+export interface JSONasXML {
+    json: JsonMap;
+    type: string;
+    options?: IOptions;
+}
+export interface WriteJSONasXMLInputs extends JSONasXML {
+    path: string;
+}
+export declare const standardOptions: IOptions;
+export declare const writeJSONasXML: ({ path, json, type, options, }: WriteJSONasXMLInputs) => Promise<void>;
+export declare const JsonAsXml: ({ json, type, options }: JSONasXML) => string;
+export declare const fixExistingDollarSign: (existing: WriteJSONasXMLInputs['json']) => Record<string, unknown>;

package/lib/util/jsonXmlTools.js

@@ -1,39 +1,39 @@
-"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.fixExistingDollarSign = exports.JsonAsXml = exports.writeJSONasXML = exports.standardOptions = void 0;
-const fs_1 = require("fs");
-const jsToXml = require("js2xmlparser");
-exports.standardOptions = {
-    declaration: {
-        include: true,
-        encoding: 'UTF-8',
-        version: '1.0',
-    },
-    format: {
-        doubleQuotes: true,
-    },
-};
-const writeJSONasXML = async ({ path, json, type, options = exports.standardOptions, }) => {
-    const xml = jsToXml.parse(type, (0, exports.fixExistingDollarSign)(json), options);
-    return fs_1.promises.writeFile(path, xml);
-};
-exports.writeJSONasXML = writeJSONasXML;
-const JsonAsXml = ({ json, type, options = exports.standardOptions }) => jsToXml.parse(type, (0, exports.fixExistingDollarSign)(json), options);
-exports.JsonAsXml = JsonAsXml;
-const fixExistingDollarSign = (existing) => {
-    const existingCopy = { ...existing };
-    if (existingCopy.$) {
-        const temp = existingCopy.$;
-        delete existingCopy.$;
-        existingCopy['@'] = temp;
-    }
-    return existingCopy;
-};
-exports.fixExistingDollarSign = fixExistingDollarSign;
+"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.fixExistingDollarSign = exports.JsonAsXml = exports.writeJSONasXML = exports.standardOptions = void 0;
+const fs_1 = require("fs");
+const jsToXml = require("js2xmlparser");
+exports.standardOptions = {
+    declaration: {
+        include: true,
+        encoding: 'UTF-8',
+        version: '1.0',
+    },
+    format: {
+        doubleQuotes: true,
+    },
+};
+const writeJSONasXML = async ({ path, json, type, options = exports.standardOptions, }) => {
+    const xml = jsToXml.parse(type, (0, exports.fixExistingDollarSign)(json), options);
+    return fs_1.promises.writeFile(path, xml);
+};
+exports.writeJSONasXML = writeJSONasXML;
+const JsonAsXml = ({ json, type, options = exports.standardOptions }) => jsToXml.parse(type, (0, exports.fixExistingDollarSign)(json), options);
+exports.JsonAsXml = JsonAsXml;
+const fixExistingDollarSign = (existing) => {
+    const existingCopy = { ...existing };
+    if (existingCopy.$) {
+        const temp = existingCopy.$;
+        delete existingCopy.$;
+        existingCopy['@'] = temp;
+    }
+    return existingCopy;
+};
+exports.fixExistingDollarSign = fixExistingDollarSign;
 //# sourceMappingURL=jsonXmlTools.js.map

package/lib/util/mapKeys.d.ts

@@ -1,14 +1,14 @@
-/**
- * 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)
- *
- * 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
- */
-export default function mapKeys<T>(obj: T, converter: (key: string) => string, deep?: boolean): Record<string, unknown>;
+/**
+ * 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)
+ *
+ * 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
+ */
+export default function mapKeys<T>(obj: T, converter: (key: string) => string, deep?: boolean): Record<string, unknown>;

package/lib/util/mapKeys.js

@@ -1,52 +1,52 @@
-"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 });
-const ts_types_1 = require("@salesforce/ts-types");
-/**
- * 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)
- *
- * 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
- */
-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(
-    // 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;
-            if (Array.isArray(value)) {
-                v = value.map((v1) => {
-                    if ((0, ts_types_1.isPlainObject)(v1)) {
-                        return mapKeys(v1, converter, deep);
-                    }
-                    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-                    return v1;
-                });
-            }
-            else if ((0, ts_types_1.isPlainObject)(value)) {
-                v = mapKeys(value, converter, deep);
-            }
-            return [k, v];
-        }
-        return [k, value];
-    }));
-}
-exports.default = mapKeys;
+"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 });
+const ts_types_1 = require("@salesforce/ts-types");
+/**
+ * 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)
+ *
+ * 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
+ */
+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(
+    // 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;
+            if (Array.isArray(value)) {
+                v = value.map((v1) => {
+                    if ((0, ts_types_1.isPlainObject)(v1)) {
+                        return mapKeys(v1, converter, deep);
+                    }
+                    // eslint-disable-next-line @typescript-eslint/no-unsafe-return
+                    return v1;
+                });
+            }
+            else if ((0, ts_types_1.isPlainObject)(value)) {
+                v = mapKeys(value, converter, deep);
+            }
+            return [k, v];
+        }
+        return [k, value];
+    }));
+}
+exports.default = mapKeys;
 //# sourceMappingURL=mapKeys.js.map

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) => 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, 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;
-};
+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) => 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, 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;
+};