@salesforce/core-bundle 8.18.7 → 8.19.0

package/lib/index.d.ts

@@ -563,7 +563,7 @@ declare module '@salesforce/core-bundle/config/configFile' {
    * const myConfig = await MyConfig.create({
    *   isGlobal: true
    * });
-   * myConfig.set('mykey', 'myvalue');
+   * myConfig.set('myKey', 'myValue');
    * await myConfig.write();
    * ```
    */
@@ -1352,9 +1352,9 @@ declare module '@salesforce/core-bundle/crypto/keyChain' {
 }
 declare module '@salesforce/core-bundle/crypto/keyChainImpl' {
   import * as childProcess from 'node:child_process';
-  import * as nodeFs from 'node:fs';
   import { Nullable } from '@salesforce/ts-types';
-  export type FsIfc = Pick<typeof nodeFs, 'statSync'>;
+  import { fs } from '@salesforce/core-bundle/fs/fs';
+  export type FsIfc = Pick<typeof fs, 'statSync'>;
   /**
    * Basic keychain interface.
    */
@@ -1587,6 +1587,49 @@ declare module '@salesforce/core-bundle/deviceOauthService' {
       private pollForDeviceApproval;
   }
 
+}
+declare module '@salesforce/core-bundle/fs/fs' {
+  import * as memfs from 'memfs';
+  import type { VirtualFs } from '@salesforce/core-bundle/fs/types';
+  export let fs: VirtualFs;
+  export const getVirtualFs: (memfsVolume?: memfs.Volume) => VirtualFs;
+  export const setFs: (providedFs: VirtualFs) => void;
+  export const resetFs: () => void;
+
+}
+declare module '@salesforce/core-bundle/fs/types' {
+  import type * as nodeFs from 'node:fs';
+  import type { IFs as MemFs } from 'memfs';
+  type NodeFs = typeof nodeFs;
+  type CommonKeys<T, U> = keyof T & keyof U;
+  type IntersectionType<T, U> = {
+      [K in CommonKeys<T, U>]: T[K] extends (...args: any[]) => any ? T[K] extends U[K] ? T[K] : U[K] extends T[K] ? U[K] : any : T[K] extends U[K] ? T[K] : U[K] extends T[K] ? U[K] : T[K];
+  };
+  type BaseVirtualFs = IntersectionType<NodeFs, MemFs>;
+  export type VirtualFs = Omit<BaseVirtualFs, 'writeFileSync' | 'readFileSync' | 'statSync' | 'promises' | 'mkdtempSync' | 'createWriteStream' | 'mkdirSync'> & {
+      promises: Omit<BaseVirtualFs['promises'], 'writeFile' | 'readFile'> & {
+          writeFile: (file: string, data: string | Buffer, options?: BufferEncoding | {
+              encoding?: BufferEncoding;
+              mode?: string | number;
+          }) => Promise<void>;
+          readFile: {
+              (path: string): Promise<Buffer>;
+              (path: string, encoding: BufferEncoding): Promise<string>;
+          };
+      };
+      readFileSync: {
+          (path: string): Buffer;
+          (path: string, encoding: BufferEncoding): string;
+      };
+      writeFileSync: (file: string, data: string | Buffer, encoding?: BufferEncoding) => void;
+      /** there are some differences between node:fs and memfs for statSync around bigint stats.  Be careful if using those */
+      statSync: typeof nodeFs.statSync;
+      mkdtempSync: typeof nodeFs.mkdtempSync;
+      createWriteStream: typeof nodeFs.createWriteStream;
+      mkdirSync: typeof nodeFs.mkdirSync;
+  };
+  export {};
+
 }
 declare module '@salesforce/core-bundle/global' {
   /**
@@ -1662,7 +1705,8 @@ declare module '@salesforce/core-bundle/global' {
 
 }
 declare module '@salesforce/core-bundle/index' {
-  export { OAuth2Config } from '@jsforce/jsforce-node';
+  import { OAuth2Config } from '@jsforce/jsforce-node';
+  export { OAuth2Config };
   export { ConfigFile } from '@salesforce/core-bundle/config/configFile';
   export { TTLConfig } from '@salesforce/core-bundle/config/ttlConfig';
   export { envVars, EnvironmentVariable, SUPPORTED_ENV_VARS, EnvVars } from '@salesforce/core-bundle/config/envVars';
@@ -1702,6 +1746,8 @@ declare module '@salesforce/core-bundle/index' {
   export { ScratchOrgCache } from '@salesforce/core-bundle/org/scratchOrgCache';
   export { default as ScratchOrgSettingsGenerator } from '@salesforce/core-bundle/org/scratchOrgSettingsGenerator';
   export * from '@salesforce/core-bundle/util/sfdc';
+  /** for use by other libraries that need to support web and node */
+  export { fs } from '@salesforce/core-bundle/fs/fs';
   export * from '@salesforce/core-bundle/util/mutex';
   export * from '@salesforce/core-bundle/testSetup';
 
@@ -1832,7 +1878,7 @@ declare module '@salesforce/core-bundle/logger/filters' {
 
 }
 declare module '@salesforce/core-bundle/logger/logger' {
-  import { Logger as PinoLogger } from 'pino';
+  import { type Logger as PinoLogger } from 'pino';
   /**
    * The common set of `Logger` options.
    */
@@ -2890,8 +2936,8 @@ declare module '@salesforce/core-bundle/org/connection' {
   import { ConfigAggregator } from '@salesforce/core-bundle/config/configAggregator';
   import { AuthFields, AuthInfo } from '@salesforce/core-bundle/org/authInfo';
   export const SFDX_HTTP_HEADERS: {
+      'user-agent'?: string | undefined;
       'content-type': string;
-      'user-agent': string;
   };
   export const DNS_ERROR_NAME = "DomainNotFoundError";
   export type DeployOptionsWithRest = Partial<DeployOptions> & {
@@ -5077,9 +5123,9 @@ declare module '@salesforce/core-bundle/stateAggregator/accessors/aliasAccessor'
 
 }
 declare module '@salesforce/core-bundle/stateAggregator/accessors/orgAccessor' {
-  import * as fs from 'node:fs';
   import { Nullable } from '@salesforce/ts-types';
   import { AsyncOptionalCreatable } from '@salesforce/kit';
+  import { fs } from '@salesforce/core-bundle/fs/fs';
   import { AuthInfoConfig } from '@salesforce/core-bundle/config/authInfoConfig';
   import { AuthFields } from '@salesforce/core-bundle/org/authInfo';
   import { ConfigFile } from '@salesforce/core-bundle/config/configFile';
@@ -5128,7 +5174,7 @@ declare module '@salesforce/core-bundle/stateAggregator/accessors/orgAccessor' {
        *
        * @param username
        */
-      stat(username: string): Promise<Nullable<fs.Stats>>;
+      stat(username: string): Promise<Nullable<Awaited<ReturnType<typeof fs.promises.stat>>>>;
       /**
        * Returns true if there is an auth file for the given username
        *
@@ -5266,8 +5312,6 @@ 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.
        */
@@ -5388,8 +5432,8 @@ declare module '@salesforce/core-bundle/status/pollingClient' {
 
 }
 declare module '@salesforce/core-bundle/status/streamingClient' {
-  import { AsyncOptionalCreatable, Duration, Env } from '@salesforce/kit/lib';
-  import { AnyJson } from '@salesforce/ts-types/lib';
+  import { AsyncOptionalCreatable, Duration, Env } from '@salesforce/kit';
+  import { AnyJson } from '@salesforce/ts-types';
   import { Org } from '@salesforce/core-bundle/org/org';
   import { CometClient, CometSubscription, Message, StatusResult, StreamingExtension, StreamProcessor } from '@salesforce/core-bundle/status/types';
   export { CometClient, CometSubscription, Message, StatusResult, StreamingExtension, StreamProcessor };
@@ -6265,7 +6309,7 @@ declare module '@salesforce/core-bundle/util/directoryWriter' {
 
 }
 declare module '@salesforce/core-bundle/util/fileLocking' {
-  type LockInitResponse = {
+  export type LockInitResponse = {
       writeAndUnlock: (data: string) => Promise<void>;
       unlock: () => Promise<void>;
   };
@@ -6273,6 +6317,8 @@ declare module '@salesforce/core-bundle/util/fileLocking' {
       writeAndUnlock: (data: string) => void;
       unlock: () => void;
   };
+  export const noop: () => void;
+  export const asyncNoop: () => Promise<void>;
   /**
    *
    *This method exists as a separate function so it can be used by ConfigFile OR outside of ConfigFile.
@@ -6393,7 +6439,6 @@ declare module '@salesforce/core-bundle/util/internal' {
 
 }
 declare module '@salesforce/core-bundle/util/lockRetryOptions' {
-  import fs from 'node:fs';
   export const lockOptions: {
       stale: number;
   };
@@ -6403,7 +6448,7 @@ declare module '@salesforce/core-bundle/util/lockRetryOptions' {
           maxTimeout: number;
           factor: number;
       };
-      fs: typeof fs;
+      fs: import("@salesforce/core-bundle/fs/types").VirtualFs;
       stale: number;
   };