@salesforce/core-bundle 8.11.4 → 8.12.0

package/lib/index.d.ts

@@ -1612,6 +1612,10 @@ declare module '@salesforce/core-bundle/global' {
        * The preferred global folder in which state is stored.
        */
       static readonly STATE_FOLDER = ".sfdx";
+      /**
+       * Whether the code is running in a web browser.
+       */
+      static get isWeb(): boolean;
       /**
        * The full system path to the global sfdx state folder.
        *
@@ -4985,7 +4989,6 @@ declare module '@salesforce/core-bundle/stateAggregator/accessors/aliasAccessor'
        * if the file doesn't exist, create it empty
        */
       private readFileToAliasStore;
-      private saveAliasStoreToFile;
   }
   export const getFileLocation: () => string;
 
@@ -5172,6 +5175,7 @@ declare module '@salesforce/core-bundle/status/myDomainResolver' {
        * executing the dns loookup.
        */
       resolve(): Promise<string>;
+      /** @deprecated there is nothing using this in forcedotcom, salesforcecli, or public github search */
       getCnames(): Promise<string[]>;
       /**
        * Used to initialize asynchronous components.
@@ -6298,6 +6302,7 @@ declare module '@salesforce/core-bundle/util/internal' {
 
 }
 declare module '@salesforce/core-bundle/util/lockRetryOptions' {
+  import fs from 'node:fs';
   export const lockOptions: {
       stale: number;
   };
@@ -6307,6 +6312,7 @@ declare module '@salesforce/core-bundle/util/lockRetryOptions' {
           maxTimeout: number;
           factor: number;
       };
+      fs: typeof fs;
       stale: number;
   };
 
@@ -6449,6 +6455,7 @@ declare module '@salesforce/core-bundle/util/structuredWriter' {
 
 }
 declare module '@salesforce/core-bundle/util/time' {
+  /** using globalThis.performance instead importing from node:perf_hooks so it works in browser */
   export const nowBigInt: () => bigint;
 
 }

package/lib/index.js

@@ -7218,6 +7218,12 @@ var require_global = __commonJS({
        * The preferred global folder in which state is stored.
        */
       static STATE_FOLDER = _Global.SFDX_STATE_FOLDER;
+      /**
+       * Whether the code is running in a web browser.
+       */
+      static get isWeb() {
+        return "window" in globalThis;
+      }
       /**
        * The full system path to the global sfdx state folder.
        *
@@ -7658,7 +7664,7 @@ var require_logger = __commonJS({
        * Gets the name of this logger.
        */
       getName() {
-        return this.pinoLogger.bindings().name ?? "";
+        return (this.pinoLogger?.bindings ? this.pinoLogger.bindings().name : "") ?? "";
       }
       /**
        * Gets the current level of this logger.
@@ -7826,7 +7832,7 @@ var require_logger = __commonJS({
         // write to a rotating file
         target: "pino/file",
         options: {
-          destination: path.join(global_12.Global.SF_DIR, `sf-${rotator.get(logRotationPeriod) ?? rotator.get("1d")}.log`),
+          destination: path.join(global_12.Global.SF_DIR, `sf-${(0, ts_types_1.ensureString)(rotator.get(logRotationPeriod)) ?? rotator.get("1d")}.log`),
           mkdir: true,
           level
         }
@@ -10344,12 +10350,18 @@ var require_retry_promise = __commonJS({
 var require_lockRetryOptions = __commonJS({
   "lib/util/lockRetryOptions.js"(exports2) {
     "use strict";
+    var __importDefault3 = exports2 && exports2.__importDefault || function(mod) {
+      return mod && mod.__esModule ? mod : { "default": mod };
+    };
     Object.defineProperty(exports2, "__esModule", { value: true });
     exports2.lockRetryOptions = exports2.lockOptions = void 0;
+    var node_fs_1 = __importDefault3(require("node:fs"));
     exports2.lockOptions = { stale: 1e4 };
     exports2.lockRetryOptions = {
       ...exports2.lockOptions,
-      retries: { retries: 10, maxTimeout: 1e3, factor: 2 }
+      retries: { retries: 10, maxTimeout: 1e3, factor: 2 },
+      fs: node_fs_1.default
+      // lockfile supports injectable fs, which is needed for browser use
     };
   }
 });
@@ -10401,11 +10413,10 @@ var require_fileLocking = __commonJS({
       } catch (err) {
         throw sfError_12.SfError.wrap(err);
       }
-      const unlock = await (0, proper_lockfile_1.lock)(filePath, { ...lockRetryOptions_1.lockRetryOptions, realpath: false });
+      const unlock = await (0, proper_lockfile_1.lock)(filePath, { ...lockRetryOptions_1.lockRetryOptions, realpath: false, fs });
       return {
         writeAndUnlock: async (data) => {
-          const logger = await logger_12.Logger.child("fileLocking.writeAndUnlock");
-          logger.debug(`Writing to file: ${filePath}`);
+          (await logger_12.Logger.child("fileLocking.writeAndUnlock")).debug(`Writing to file: ${filePath}`);
           try {
             await fs.promises.writeFile(filePath, data);
           } finally {
@@ -10422,7 +10433,7 @@ var require_fileLocking = __commonJS({
       } catch (err) {
         throw sfError_12.SfError.wrap(err);
       }
-      const unlock = (0, proper_lockfile_1.lockSync)(filePath, { ...lockRetryOptions_1.lockOptions, realpath: false });
+      const unlock = (0, proper_lockfile_1.lockSync)(filePath, { ...lockRetryOptions_1.lockOptions, realpath: false, fs });
       return {
         writeAndUnlock: (data) => {
           const logger = logger_12.Logger.childFromRoot("fileLocking.writeAndUnlock");
@@ -12319,7 +12330,7 @@ var require_package2 = __commonJS({
   "package.json"(exports2, module2) {
     module2.exports = {
       name: "@salesforce/core-bundle",
-      version: "8.11.4",
+      version: "8.12.0",
       description: "Core libraries to interact with SFDX projects, orgs, and APIs.",
       main: "lib/index",
       types: "lib/index.d.ts",
@@ -12380,7 +12391,7 @@ var require_package2 = __commonJS({
         "@salesforce/ts-sinon": "^1.4.30",
         "@types/benchmark": "^2.1.5",
         "@types/fast-levenshtein": "^0.0.4",
-        "@types/jsonwebtoken": "9.0.7",
+        "@types/jsonwebtoken": "9.0.9",
         "@types/proper-lockfile": "^4.1.4",
         "@types/semver": "^7.5.8",
         benchmark: "^2.1.4",
@@ -13183,6 +13194,9 @@ var require_keyChain = __commonJS({
             return keyChainImpl_1.keyChainImpl.generic_unix;
           }
         }
+      } else if (platform === "browser") {
+        logger.debug(`platform: ${platform}. Using generic keychain.`);
+        return keyChainImpl_1.keyChainImpl.generic_unix;
       } else {
         throw messages.createError("unsupportedOperatingSystemError", [platform]);
       }
@@ -13633,8 +13647,7 @@ var require_time2 = __commonJS({
     "use strict";
     Object.defineProperty(exports2, "__esModule", { value: true });
     exports2.nowBigInt = void 0;
-    var node_perf_hooks_1 = require("node:perf_hooks");
-    var nowBigInt = () => BigInt((node_perf_hooks_1.performance.now() + node_perf_hooks_1.performance.timeOrigin) * 1e6);
+    var nowBigInt = () => BigInt((globalThis.performance.now() + globalThis.performance.timeOrigin) * 1e6);
     exports2.nowBigInt = nowBigInt;
   }
 });
@@ -14285,7 +14298,7 @@ var require_configFile = __commonJS({
       async write() {
         const lockResponse = await (0, fileLocking_12.lockInit)(this.getPath());
         try {
-          const fileTimestamp = (await fs.promises.stat(this.getPath(), { bigint: true })).mtimeNs;
+          const fileTimestamp = await getNsTimeStamp(this.getPath());
           const fileContents = (0, kit_1.parseJsonMap)(await fs.promises.readFile(this.getPath(), "utf8"), this.getPath());
           this.logAndMergeContents(fileTimestamp, fileContents);
         } catch (err) {
@@ -14303,7 +14316,7 @@ var require_configFile = __commonJS({
       writeSync() {
         const lockResponse = (0, fileLocking_12.lockInitSync)(this.getPath());
         try {
-          const fileTimestamp = fs.statSync(this.getPath(), { bigint: true }).mtimeNs;
+          const fileTimestamp = getNsTimeStampSync(this.getPath());
           const fileContents = (0, kit_1.parseJsonMap)(fs.readFileSync(this.getPath(), "utf8"), this.getPath());
           this.logAndMergeContents(fileTimestamp, fileContents);
         } catch (err) {
@@ -14420,6 +14433,9 @@ var require_configFile = __commonJS({
       }
     };
     exports2.ConfigFile = ConfigFile;
+    var getNsTimeStamp = async (filePath) => getNsTimeStampFromStatus(await fs.promises.stat(filePath, { bigint: true }));
+    var getNsTimeStampSync = (filePath) => getNsTimeStampFromStatus(fs.statSync(filePath, { bigint: true }));
+    var getNsTimeStampFromStatus = (stats) => stats.mtimeNs ?? BigInt(stats.mtimeMs) * BigInt(1e6);
   }
 });
 
@@ -15838,11 +15854,10 @@ var require_aliasAccessor = __commonJS({
     var node_path_1 = require("node:path");
     var node_os_1 = require("node:os");
     var promises_1 = require("node:fs/promises");
-    var proper_lockfile_1 = require_proper_lockfile();
     var kit_1 = require_lib2();
     var global_12 = require_global();
     var sfError_12 = require_sfError();
-    var lockRetryOptions_1 = require_lockRetryOptions();
+    var fileLocking_12 = require_fileLocking();
     exports2.DEFAULT_GROUP = "orgs";
     exports2.FILENAME = "alias.json";
     var AliasAccessor = class extends kit_1.AsyncOptionalCreatable {
@@ -15916,18 +15931,20 @@ var require_aliasAccessor = __commonJS({
        * @param entity the aliasable entity that's being aliased
        */
       async setAndSave(alias, entity) {
-        await this.readFileToAliasStore(true);
+        const lockResponse = await (0, fileLocking_12.lockInit)(this.fileLocation);
+        await this.readFileToAliasStore();
         this.aliasStore.set(alias, getNameOf(entity));
-        return this.saveAliasStoreToFile();
+        return lockResponse.writeAndUnlock(aliasStoreToRawFileContents(this.aliasStore));
       }
       /**
        * Unset the given alias(es).  Writes to the file
        *
        */
       async unsetAndSave(alias) {
-        await this.readFileToAliasStore(true);
+        const lockResponse = await (0, fileLocking_12.lockInit)(this.fileLocation);
+        await this.readFileToAliasStore();
         this.aliasStore.delete(alias);
-        return this.saveAliasStoreToFile();
+        return lockResponse.writeAndUnlock(aliasStoreToRawFileContents(this.aliasStore));
       }
       /**
        * Unset all the aliases for the given array of entity.
@@ -15935,9 +15952,10 @@ var require_aliasAccessor = __commonJS({
        * @param entity the aliasable entity for which you want to unset all aliases
        */
       async unsetValuesAndSave(aliasees) {
-        await this.readFileToAliasStore(true);
+        const lockResponse = await (0, fileLocking_12.lockInit)(this.fileLocation);
+        await this.readFileToAliasStore();
         (0, kit_1.ensureArray)(aliasees).flatMap((a) => this.getAll(a)).map((a) => this.aliasStore.delete(a));
-        return this.saveAliasStoreToFile();
+        return lockResponse.writeAndUnlock(aliasStoreToRawFileContents(this.aliasStore));
       }
       /**
        * Returns true if the provided alias exists
@@ -15955,38 +15973,28 @@ var require_aliasAccessor = __commonJS({
        * go to the fileSystem and read the file, storing a copy in the class's store
        * if the file doesn't exist, create it empty
        */
-      async readFileToAliasStore(useLock = false) {
-        if (useLock) {
-          await (0, proper_lockfile_1.lock)(this.fileLocation, lockRetryOptions_1.lockRetryOptions);
-        }
+      async readFileToAliasStore() {
         try {
           this.aliasStore = fileContentsRawToAliasStore(await (0, promises_1.readFile)(this.fileLocation, "utf-8"));
         } catch (e) {
           if (e instanceof Error && "code" in e && typeof e.code === "string" && ["ENOENT", "ENOTDIR"].includes(e.code)) {
-            this.aliasStore = /* @__PURE__ */ new Map();
             await (0, promises_1.mkdir)((0, node_path_1.dirname)(this.fileLocation), { recursive: true });
-            await this.saveAliasStoreToFile();
-            return;
+            this.aliasStore = /* @__PURE__ */ new Map();
+            return (0, promises_1.writeFile)(this.fileLocation, aliasStoreToRawFileContents(this.aliasStore));
           }
-          if (useLock)
-            return unlockIfLocked(this.fileLocation);
           throw e;
         }
       }
-      async saveAliasStoreToFile() {
-        await (0, promises_1.writeFile)(this.fileLocation, aliasStoreToRawFileContents(this.aliasStore));
-        return unlockIfLocked(this.fileLocation);
-      }
     };
     exports2.AliasAccessor = AliasAccessor;
     var getNameOf = (entity) => {
       if (typeof entity === "string")
         return entity;
-      const aliaseeName = entity.username;
-      if (!aliaseeName) {
+      const { username } = entity;
+      if (!username) {
         throw new sfError_12.SfError(`Invalid aliasee, it must contain a user or username property: ${JSON.stringify(entity)}`);
       }
-      return aliaseeName;
+      return username;
     };
     var fileContentsRawToAliasStore = (contents) => {
       const fileContents = JSON.parse(contents);
@@ -15995,16 +16003,6 @@ var require_aliasAccessor = __commonJS({
     var aliasStoreToRawFileContents = (aliasStore) => JSON.stringify({ [exports2.DEFAULT_GROUP]: Object.fromEntries(Array.from(aliasStore.entries())) });
     var getFileLocation = () => (0, node_path_1.join)((0, node_os_1.homedir)(), global_12.Global.SFDX_STATE_FOLDER, exports2.FILENAME);
     exports2.getFileLocation = getFileLocation;
-    var unlockIfLocked = async (fileLocation) => {
-      try {
-        await (0, proper_lockfile_1.unlock)(fileLocation);
-      } catch (e) {
-        if (errorIsNotAcquired(e))
-          return;
-        throw e;
-      }
-    };
-    var errorIsNotAcquired = (e) => e instanceof Error && "code" in e && e.code === "ENOTACQUIRED";
   }
 });
 
@@ -83829,6 +83827,7 @@ var require_myDomainResolver = __commonJS({
     var kit_1 = require_lib2();
     var logger_12 = require_logger();
     var sfdcUrl_12 = require_sfdcUrl();
+    var global_12 = require_global();
     var pollingClient_12 = require_pollingClient();
     var DNS_TIMEOUT = Math.max(3, new kit_1.Env().getNumber("SFDX_DNS_TIMEOUT", 3));
     var DNS_RETRY_FREQ = Math.max(1, new kit_1.Env().getNumber("SFDX_DNS_RETRY_FREQUENCY", 1));
@@ -83865,6 +83864,10 @@ var require_myDomainResolver = __commonJS({
           this.logger.debug("SF_DISABLE_DNS_CHECK set to true. Skipping DNS check...");
           return this.options.url.host;
         }
+        if (global_12.Global.isWeb) {
+          this.logger.debug("Web browser detected. Skipping DNS check...");
+          return this.options.url.host;
+        }
         const self2 = this;
         const pollingOptions = {
           async poll() {
@@ -83900,6 +83903,7 @@ var require_myDomainResolver = __commonJS({
         const client = await pollingClient_12.PollingClient.create(pollingOptions);
         return (0, ts_types_1.ensureString)(await client.subscribe());
       }
+      /** @deprecated there is nothing using this in forcedotcom, salesforcecli, or public github search */
       async getCnames() {
         try {
           await this.resolve();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/core-bundle",
-  "version": "8.11.4",
+  "version": "8.12.0",
   "description": "Core libraries to interact with SFDX projects, orgs, and APIs.",
   "main": "lib/index",
   "types": "lib/index.d.ts",
@@ -61,7 +61,7 @@
     "@salesforce/ts-sinon": "^1.4.30",
     "@types/benchmark": "^2.1.5",
     "@types/fast-levenshtein": "^0.0.4",
-    "@types/jsonwebtoken": "9.0.7",
+    "@types/jsonwebtoken": "9.0.9",
     "@types/proper-lockfile": "^4.1.4",
     "@types/semver": "^7.5.8",
     "benchmark": "^2.1.4",