@salesforce/core 3.31.7 → 3.31.8

package/lib/util/sfdc.js

@@ -1,86 +1,86 @@
-"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.sfdc = 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?.length && id.length > 15) {
-            id = id.substring(0, 15);
-        }
-        return id;
-    },
-    /**
-     * Tests whether an API version matches the format `i.0`.
-     *
-     * @param value The API version as a string.
-     */
-    validateApiVersion: (value) => 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) => /^[^.][^@]*@[^.]+(\.[^.\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) => /[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
-    !/[\["\?<>\|\]]+/.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));
-            }
-            return key;
-        });
-        return key;
-    },
-    /**
-     * Tests whether a given string is an access token
-     *
-     * @param value
-     */
-    matchesAccessToken: (value) => /^(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(),
-};
+"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.sfdc = 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?.length && id.length > 15) {
+            id = id.substring(0, 15);
+        }
+        return id;
+    },
+    /**
+     * Tests whether an API version matches the format `i.0`.
+     *
+     * @param value The API version as a string.
+     */
+    validateApiVersion: (value) => 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) => /^[^.][^@]*@[^.]+(\.[^.\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) => /[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
+    !/[\["\?<>\|\]]+/.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));
+            }
+            return key;
+        });
+        return key;
+    },
+    /**
+     * Tests whether a given string is an access token
+     *
+     * @param value
+     */
+    matchesAccessToken: (value) => /^(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(),
+};
 //# sourceMappingURL=sfdc.js.map

package/lib/util/sfdcUrl.d.ts

@@ -1,72 +1,72 @@
-/// <reference types="node" />
-import { URL } from 'url';
-export declare function getLoginAudienceCombos(audienceUrl: string, loginUrl: string): Array<[string, string]>;
-export declare class SfdcUrl extends URL {
-    /**
-     * Salesforce URLs
-     */
-    static readonly SANDBOX = "https://test.salesforce.com";
-    static readonly PRODUCTION = "https://login.salesforce.com";
-    private static readonly cache;
-    private logger;
-    constructor(input: string | URL, base?: string | URL);
-    static isValidUrl(input: string | URL): boolean;
-    /**
-     * Returns the appropriate jwt audience url for this url
-     * Use SFDX_AUDIENCE_URL env var to override the audience url
-     *
-     * @param createdOrgInstance The Salesforce instance the org was created on. e.g. `cs42`
-     * @return {Promise<string>} The audience url
-     */
-    getJwtAudienceUrl(createdOrgInstance?: string): Promise<string>;
-    /**
-     * Tests whether this url contains a Salesforce owned domain
-     *
-     * @return {boolean} true if this is a salesforce domain
-     */
-    isSalesforceDomain(): boolean;
-    /**
-     * Tests whether this url is an internal Salesforce domain
-     *
-     * @returns {boolean} true if this is an internal domain
-     */
-    isInternalUrl(): boolean;
-    /**
-     * Tests whether this url runs on a local machine
-     *
-     * @returns {boolean} true if this is a local machine
-     */
-    isLocalUrl(): boolean;
-    toLightningDomain(): string;
-    /**
-     * Tests whether this url has the lightning domain extension
-     * This method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again until timeout
-     * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
-     *
-     * @returns {Promise<true | never>} The resolved ip address or never
-     * @throws {@link SfError} If can't resolve DNS.
-     */
-    checkLightningDomain(): Promise<true | never>;
-    /**
-     * Method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again until timeout
-     * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
-     *
-     * @returns the resolved ip address.
-     * @throws {@link SfError} If can't resolve DNS.
-     */
-    lookup(): Promise<string>;
-    /**
-     * Tests whether this url is a sandbox url
-     *
-     * @Deprecated - identification of a sandbox instance by URL alone is not deterministic
-     * @param createdOrgInstance The Salesforce instance the org was created on. e.g. `cs42`
-     * @returns {boolean}
-     */
-    isSandboxUrl(createdOrgInstance?: string): boolean;
-    /**
-     * Test whether this url represents a lightning domain
-     *
-     * @returns {boolean} true if this domain is a lightning domain
-     */
-    isLightningDomain(): boolean;
-}
+/// <reference types="node" />
+import { URL } from 'url';
+export declare function getLoginAudienceCombos(audienceUrl: string, loginUrl: string): Array<[string, string]>;
+export declare class SfdcUrl extends URL {
+    /**
+     * Salesforce URLs
+     */
+    static readonly SANDBOX = "https://test.salesforce.com";
+    static readonly PRODUCTION = "https://login.salesforce.com";
+    private static readonly cache;
+    private logger;
+    constructor(input: string | URL, base?: string | URL);
+    static isValidUrl(input: string | URL): boolean;
+    /**
+     * Returns the appropriate jwt audience url for this url
+     * Use SFDX_AUDIENCE_URL env var to override the audience url
+     *
+     * @param createdOrgInstance The Salesforce instance the org was created on. e.g. `cs42`
+     * @return {Promise<string>} The audience url
+     */
+    getJwtAudienceUrl(createdOrgInstance?: string): Promise<string>;
+    /**
+     * Tests whether this url contains a Salesforce owned domain
+     *
+     * @return {boolean} true if this is a salesforce domain
+     */
+    isSalesforceDomain(): boolean;
+    /**
+     * Tests whether this url is an internal Salesforce domain
+     *
+     * @returns {boolean} true if this is an internal domain
+     */
+    isInternalUrl(): boolean;
+    /**
+     * Tests whether this url runs on a local machine
+     *
+     * @returns {boolean} true if this is a local machine
+     */
+    isLocalUrl(): boolean;
+    toLightningDomain(): string;
+    /**
+     * Tests whether this url has the lightning domain extension
+     * This method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again until timeout
+     * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
+     *
+     * @returns {Promise<true | never>} The resolved ip address or never
+     * @throws {@link SfError} If can't resolve DNS.
+     */
+    checkLightningDomain(): Promise<true | never>;
+    /**
+     * Method that performs the dns lookup of the host. If the lookup fails the internal polling (1 second), client will try again until timeout
+     * If SFDX_DOMAIN_RETRY environment variable is set (number) it overrides the default timeout duration (240 seconds)
+     *
+     * @returns the resolved ip address.
+     * @throws {@link SfError} If can't resolve DNS.
+     */
+    lookup(): Promise<string>;
+    /**
+     * Tests whether this url is a sandbox url
+     *
+     * @Deprecated - identification of a sandbox instance by URL alone is not deterministic
+     * @param createdOrgInstance The Salesforce instance the org was created on. e.g. `cs42`
+     * @returns {boolean}
+     */
+    isSandboxUrl(createdOrgInstance?: string): boolean;
+    /**
+     * Test whether this url represents a lightning domain
+     *
+     * @returns {boolean} true if this domain is a lightning domain
+     */
+    isLightningDomain(): boolean;
+}