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

Interface: NormalizedConfig

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

Normalized B2C configuration with camelCase fields.

This is the canonical intermediate format that all configuration sources map to. It provides a consistent interface regardless of the source format (dw.json uses kebab-case, env vars use SCREAMING_SNAKE_CASE, etc.).

Properties

accountManagerHost?

optional accountManagerHost: string

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

Account Manager hostname for OAuth (default: account.demandware.com)

apiBackend?

optional apiBackend: "ocapi" | "scapi" | "auto"

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

API backend preference for operations that support both OCAPI and SCAPI

assetQuery?

optional assetQuery: string[]

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

JSON dot-paths for asset extraction from component data during content library parsing. Used by content export and the VS Code content library browser. Defaults to ['image.path'] when unset.

authMethods?

optional authMethods: AuthMethod[]

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

Allowed authentication methods in priority order

autoUpload?

optional autoUpload: boolean

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

Whether to auto-start code upload/sync in IDE extensions

cartridges?

optional cartridges: string[]

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

Cartridge names to include in deploy/watch operations

catalogs?

optional catalogs: string[]

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

Catalog IDs for WebDAV browsing

certificate?

optional certificate: string

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

Path to PKCS12 certificate file for client mTLS (two-factor auth)

certificatePassphrase?

optional certificatePassphrase: string

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

Passphrase for the certificate

cipHost?

optional cipHost: string

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

Optional CIP analytics host override

clientId?

optional clientId: string

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

OAuth client ID

clientSecret?

optional clientSecret: string

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

OAuth client secret

codeVersion?

optional codeVersion: string

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

Code version for deployments

contentLibrary?

optional contentLibrary: string

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

Default content library ID for content export/list commands

docsCategories?

optional docsCategories: string[]

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

Allowlist of documentation categories to expose from the docs search/read surface (CLI b2c docs, MCP docs tools). When set, bounds the entire available corpus to these categories; unset means no restriction (full corpus). Category names are validated by resolveEnabledCategories in the docs module (unknown names are dropped with a warning).

Sourced from docs-categories (dw.json), SFCC_DOCS_CATEGORIES (env), or docsCategories (package.json). A CLI --topics / MCP --docs-topics flag, when provided, overrides this config value.

Example

["script-api", "job-step", "help-admin", "tooling"]

hostname?

optional hostname: string

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

B2C instance hostname

importSetExclude?

optional importSetExclude: string[]

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

Project-relative directory paths to exclude recursively from import-set source discovery

instanceName?

optional instanceName: string

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

Instance name (from multi-config supporting sources)

jwtCertPath?

optional jwtCertPath: string

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

Path to JWT certificate file (cert.pem) for JWT authentication

jwtKeyPath?

optional jwtKeyPath: string

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

Path to JWT private key file (key.pem) for JWT authentication

jwtPassphrase?

optional jwtPassphrase: string

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

Optional passphrase for encrypted JWT private key

libraries?

optional libraries: (string | LibraryEntry)[]

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

Library IDs for WebDAV browsing and the Content Libraries tree.

Accepts either a string array (all treated as shared libraries) or an array of LibraryEntry objects that can mark individual libraries as site-private. Both forms can be mixed in the same array.

Example

["RefArch", { id: "homepage", siteLibrary: true }]

mrtApiKey?

optional mrtApiKey: string

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

MRT API key

mrtBackend?

optional mrtBackend: "scapi" | "auto" | "legacy"

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

MRT backend preference for MRT operations that support both the legacy MRT Cloud API and the SCAPI MRT backend. Independent of apiBackend (MRT is a distinct subsystem). legacy = the per-user API-key MRT Cloud API; scapi = the OAuth SCAPI MRT backend; auto prefers SCAPI when prerequisites are present and falls back to legacy.