feat: make resolveConfig() and ConfigSource interface async (#183) (#263)

* feat: make resolveConfig() and ConfigSource interface async

Enable async config sources (keychain lookups, credential vaults,
network-based config stores) by making resolveConfig() return a Promise.

- Add MaybePromise<T> utility type for backwards-compatible async migration
- Convert built-in sources (DwJson, Mobify, PackageJson) to async fs.promises
- Make InstanceManager methods async
- Update CLI commands, MCP server, and VS Code extension callers

* fix: add missing await for resolveConfig in logs integration test

The integration test file was missed during the async migration.

Author: clavery

.changeset/async-resolve-config.md

@@ -0,0 +1,11 @@
+---
+'@salesforce/b2c-tooling-sdk': minor
+'@salesforce/b2c-cli': patch
+'@salesforce/b2c-dx-mcp': patch
+---
+
+`resolveConfig()` and the `ConfigSource` interface are now async. This enables config sources that perform async I/O such as keychain lookups, credential vaults, or network-based config stores.
+
+**Breaking:** `resolveConfig()` now returns `Promise<ResolvedB2CConfig>` — callers must `await` the result. The `ConfigSource.load()` method return type is now `MaybePromise<ConfigLoadResult | undefined>`, so existing sync source implementations continue to work without changes.
+
+Built-in sources (`DwJsonSource`, `MobifySource`, `PackageJsonSource`) now use async `fs.promises` for non-blocking file I/O. `InstanceManager` methods and `ConfigSource` instance management methods (`listInstances`, `createInstance`, `removeInstance`, `setActiveInstance`, `storeCredential`, `removeCredential`) also accept async return values via `MaybePromise<T>`.

packages/b2c-cli/src/commands/setup/inspect.ts

@@ -89,7 +89,7 @@ export default class SetupInspect extends BaseCommand<typeof SetupInspect> {
 
   static hiddenAliases = ['config:show', 'config:inspect'];
 
-  protected override loadConfiguration(): ResolvedB2CConfig {
+  protected override async loadConfiguration(): Promise<ResolvedB2CConfig> {
     // Include EnvSource so that SFCC_* environment variables are visible in inspect output.
     // Other commands handle env vars via oclif flag mappings, but inspect needs to show them
     // as a config source since it doesn't have those flags.

packages/b2c-cli/src/commands/setup/instance/create.ts

@@ -117,7 +117,7 @@ export default class SetupInstanceCreate extends BaseCommand<typeof SetupInstanc
     }
 
     // Check if instance already exists
-    const existingInstances = source.listInstances({configPath: this.flags.config});
+    const existingInstances = await source.listInstances({configPath: this.flags.config});
     if (existingInstances.some((i) => i.name === name)) {
       this.error(`Instance "${name}" already exists. Use a different name.`);
     }
@@ -287,7 +287,7 @@ export default class SetupInstanceCreate extends BaseCommand<typeof SetupInstanc
     }
 
     // Create the instance
-    source.createInstance({
+    await source.createInstance({
       name,
       config,
       setActive,

packages/b2c-cli/src/commands/setup/instance/list.ts

@@ -57,7 +57,7 @@ export default class SetupInstanceList extends BaseCommand<typeof SetupInstanceL
   async run(): Promise<InstanceListResponse> {
     // Get instances from all sources that support listing
     const source = new DwJsonSource();
-    const instances = source.listInstances({
+    const instances = await source.listInstances({
       configPath: this.flags.config,
     });
 

packages/b2c-cli/src/commands/setup/instance/remove.ts

@@ -53,7 +53,7 @@ export default class SetupInstanceRemove extends BaseCommand<typeof SetupInstanc
     const name = this.args.name;
 
     // Check if instance exists
-    const instances = source.listInstances({configPath: this.flags.config});
+    const instances = await source.listInstances({configPath: this.flags.config});
     const instance = instances.find((i) => i.name === name);
 
     if (!instance) {
@@ -82,7 +82,7 @@ export default class SetupInstanceRemove extends BaseCommand<typeof SetupInstanc
     }
 
     // Remove the instance
-    source.removeInstance(name, {configPath: this.flags.config});
+    await source.removeInstance(name, {configPath: this.flags.config});
 
     const result: InstanceRemoveResponse = {
       name,

packages/b2c-cli/src/commands/setup/instance/set-active.ts

@@ -42,7 +42,7 @@ export default class SetupInstanceSetActive extends BaseCommand<typeof SetupInst
 
   async run(): Promise<InstanceSetActiveResponse> {
     const source = new DwJsonSource();
-    const instances = source.listInstances({configPath: this.flags.config});
+    const instances = await source.listInstances({configPath: this.flags.config});
 
     let name = this.args.name;
 
@@ -87,7 +87,7 @@ export default class SetupInstanceSetActive extends BaseCommand<typeof SetupInst
     }
 
     // Set as active
-    source.setActiveInstance(name, {configPath: this.flags.config});
+    await source.setActiveInstance(name, {configPath: this.flags.config});
 
     const result: InstanceSetActiveResponse = {
       name,

packages/b2c-cli/src/commands/slas/token.ts

@@ -73,7 +73,7 @@ export default class SlasToken extends SlasClientCommand<typeof SlasToken> {
     }),
   };
 
-  protected override loadConfiguration(): ResolvedB2CConfig {
+  protected override async loadConfiguration(): Promise<ResolvedB2CConfig> {
     const flags = this.flags as Record<string, unknown>;
     return loadConfig(
       {

packages/b2c-cli/src/lib/scaffold/source-resolver.ts

@@ -43,7 +43,7 @@ export function resolveLocalSource(source: DynamicParameterSource, projectRoot:
  * @throws Error if authentication fails or API call fails
  */
 export async function resolveRemoteSource(source: DynamicParameterSource): Promise<ScaffoldChoice[]> {
-  const config = loadConfig({}, {configPath: undefined});
+  const config = await loadConfig({}, {configPath: undefined});
 
   if (!config.hasB2CInstanceConfig() || !config.hasOAuthConfig()) {
     throw new Error('B2C instance configuration with OAuth required for sites source');

packages/b2c-cli/src/utils/cip/command.ts

@@ -94,7 +94,7 @@ export abstract class CipCommand<T extends typeof Command> extends OAuthCommand<
     return CIP_AUTH_METHODS;
   }
 
-  protected override loadConfiguration(): ResolvedB2CConfig {
+  protected override async loadConfiguration(): Promise<ResolvedB2CConfig> {
     const flags = this.flags as Record<string, unknown>;
     return loadConfig(
       {

packages/b2c-dx-mcp/src/commands/mcp.ts

@@ -261,7 +261,7 @@ export default class McpServerCommand extends BaseCommand<typeof McpServerComman
    * 3. dw.json file (via --config flag or auto-discovered from --project-directory)
    * 4. ~/.mobify file (for MRT API key)
    */
-  protected override loadConfiguration(): ResolvedB2CConfig {
+  protected override async loadConfiguration(): Promise<ResolvedB2CConfig> {
     const mrt = extractMrtFlags(this.flags as Record<string, unknown>);
     const options: LoadConfigOptions = {
       ...this.getBaseConfigOptions(),
@@ -286,8 +286,8 @@ export default class McpServerCommand extends BaseCommand<typeof McpServerComman
    *
    * @returns A new Services instance with loaded configuration
    */
-  protected loadServices(): Services {
-    const config = this.loadConfiguration();
+  protected async loadServices(): Promise<Services> {
+    const config = await this.loadConfiguration();
     return Services.fromResolvedConfig(config);
   }