@salesforce/b2c-tooling-sdk / config / ResolvedB2CConfig

Interface: ResolvedB2CConfig

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:494

Result of configuration resolution with factory methods.

Provides both raw configuration values and factory methods for creating B2C SDK objects (B2CInstance, AuthStrategy, MrtClient) based on the resolved configuration. Use the has* methods to check availability before calling factory methods, which throw errors if required configuration is missing.

Example

import { resolveConfig } from '@salesforce/b2c-tooling-sdk/config';

const config = resolveConfig({
  hostname: process.env.SFCC_SERVER,
  clientId: process.env.SFCC_CLIENT_ID,
});

if (config.hasB2CInstanceConfig()) {
  const instance = config.createB2CInstance();
  await instance.webdav.propfind('Cartridges');
}

if (config.hasMrtConfig()) {
  const mrtAuth = config.createMrtAuth();
}

Properties

sources

readonly sources: ConfigSourceInfo[]

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:502

Information about which sources contributed to the config

---

values

readonly values: NormalizedConfig

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:496

Raw configuration values

---

warnings

readonly warnings: ConfigWarning[]

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:499

Warnings generated during resolution

Methods

createB2CInstance()

createB2CInstance(options?): B2CInstance

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:537

Creates a B2CInstance from the resolved configuration.

Parameters

options?

CreateB2CInstanceOptions

OAuth runtime options and optional pre-resolved strategy

Returns

B2CInstance

Throws

Error if hostname is not configured

---

createBasicAuth()

createBasicAuth(): AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:543

Creates a Basic auth strategy.

Returns

AuthStrategy

Throws

Error if username or password is not configured

---

createMrtAuth()

createMrtAuth(): AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:556

Creates an MRT auth strategy (API key).

Returns

AuthStrategy

Throws

Error if mrtApiKey is not configured

---

createOAuth()

createOAuth(options?): AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:550

Creates an OAuth auth strategy.

Parameters

options?

CreateOAuthOptions

OAuth options (allowed methods)

Returns

AuthStrategy

Throws

Error if clientId is not configured

---

createWebDavAuth()

createWebDavAuth(): AuthStrategy

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:563

Creates a WebDAV auth strategy. Prefers Basic auth if available, falls back to OAuth.

Returns

AuthStrategy

Throws

Error if neither Basic auth nor OAuth is configured

---

hasB2CInstanceConfig()

hasB2CInstanceConfig(): boolean

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:510

Check if B2C instance configuration is available. Requires: hostname

Returns

boolean

---

hasBasicAuthConfig()

hasBasicAuthConfig(): boolean

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:528

Check if Basic auth configuration is available. Requires: username and password

Returns

boolean

---

hasMrtConfig()

hasMrtConfig(): boolean

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:516

Check if MRT configuration is available. Requires: mrtApiKey

Returns

boolean

---

hasOAuthConfig()

hasOAuthConfig(): boolean

Defined in: packages/b2c-tooling-sdk/src/config/types.ts:522

Check if OAuth configuration is available. Requires: clientId

Returns

boolean