@salesforce/b2c-tooling-sdk / config / ResolvedB2CConfig
Interface: ResolvedB2CConfig
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:625
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
readonlysources:ConfigSourceInfo[]
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:633
Information about sources that contributed values or instance-catalog context
values
readonlyvalues:NormalizedConfig
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:627
Raw configuration values
warnings
readonlywarnings:ConfigWarning[]
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:630
Warnings generated during resolution
Methods
createB2CInstance()
createB2CInstance(
options?):B2CInstance
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:668
Creates a B2CInstance from the resolved configuration.
Parameters
options?
OAuth runtime options and optional pre-resolved strategy
Returns
Throws
Error if hostname is not configured
createBasicAuth()
createBasicAuth():
AuthStrategy
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:674
Creates a Basic auth strategy.
Returns
Throws
Error if username or password is not configured
createMrtAuth()
createMrtAuth():
AuthStrategy
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:687
Creates an MRT auth strategy (API key).
Returns
Throws
Error if mrtApiKey is not configured
createOAuth()
createOAuth(
options?):AuthStrategy
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:681
Creates an OAuth auth strategy.
Parameters
options?
OAuth options (allowed methods)
Returns
Throws
Error if clientId is not configured
createWebDavAuth()
createWebDavAuth():
AuthStrategy
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:694
Creates a WebDAV auth strategy. Prefers Basic auth if available, falls back to OAuth.
Returns
Throws
Error if neither Basic auth nor OAuth is configured
hasB2CInstanceConfig()
hasB2CInstanceConfig():
boolean
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:641
Check if B2C instance configuration is available. Requires: hostname
Returns
boolean
hasBasicAuthConfig()
hasBasicAuthConfig():
boolean
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:659
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:647
Check if MRT configuration is available. Requires: mrtApiKey
Returns
boolean
hasOAuthConfig()
hasOAuthConfig():
boolean
Defined in: packages/b2c-tooling-sdk/src/config/types.ts:653
Check if OAuth configuration is available. Requires: clientId
Returns
boolean