@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)

---

assetQuery?

optional assetQuery: string[]

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

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:126

Catalog IDs for WebDAV browsing

---

certificate?

optional certificate: string

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

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:163

Passphrase for the certificate

---

cipHost?

optional cipHost: string

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

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:123

Default content library ID for content export/list commands

---

hostname?

optional hostname: string

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

B2C instance hostname

---

instanceName?

optional instanceName: string

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

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:138

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

---

mrtEnvironment?

optional mrtEnvironment: string

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

MRT environment name (e.g., staging, production)

---

mrtOrigin?

optional mrtOrigin: string

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

MRT API origin URL override

---

mrtProject?

optional mrtProject: string

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

MRT project slug

---

password?

optional password: string

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

Password/access-key for Basic auth (WebDAV)

---

projectDirectory?

optional projectDirectory: string

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

Starting directory for config file search and project-relative operations

---

realm?

optional realm: string

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

Default ODS realm for sandbox operations

---

safety?

optional safety: object

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

Safety configuration for this instance

confirm?

optional confirm: boolean

When true, level-blocked operations require confirmation instead of hard-blocking

level?

optional level: SafetyLevel

Safety level

rules?

optional rules: SafetyRule[]

Ordered safety rules. First matching rule wins.

---

sandboxApiHost?

optional sandboxApiHost: string

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

ODS API hostname

---

scopes?

optional scopes: string[]

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

OAuth scopes

---

selfSigned?

optional selfSigned: boolean

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

Whether to skip SSL/TLS certificate verification (self-signed certs)

---

shortCode?

optional shortCode: string

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

SCAPI short code

---

siteId?

optional siteId: string

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

B2C Commerce site/channel ID

---

slasClientId?

optional slasClientId: string

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

SLAS client ID for shopper authentication

---

slasClientSecret?

optional slasClientSecret: string

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

SLAS client secret for private shopper clients

---

tenantId?

optional tenantId: string

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

Tenant/Organization ID for SCAPI

---

username?

optional username: string

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

Username for Basic auth (WebDAV)

---

webdavHostname?

optional webdavHostname: string

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

Separate hostname for WebDAV operations (if different from main hostname)

---

workingDirectory?

optional workingDirectory: string

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

Deprecated

Use projectDirectory instead