Skip to content
View as Markdown
View as Markdown

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

Interface: NormalizedConfig

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

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

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


authMethods?

optional authMethods: AuthMethod[]

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

Allowed authentication methods in priority order


autoUpload?

optional autoUpload: boolean

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

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


cartridges?

optional cartridges: string[]

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

Cartridge names to include in deploy/watch operations


catalogs?

optional catalogs: string[]

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

Catalog IDs for WebDAV browsing


certificate?

optional certificate: string

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

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

Passphrase for the certificate


cipHost?

optional cipHost: string

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

Optional CIP analytics host override


clientId?

optional clientId: string

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

OAuth client ID


clientSecret?

optional clientSecret: string

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

OAuth client secret


codeVersion?

optional codeVersion: string

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

Code version for deployments


contentLibrary?

optional contentLibrary: string

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

Default content library ID for content export/list commands


hostname?

optional hostname: string

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

B2C instance hostname


instanceName?

optional instanceName: string

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

Instance name (from multi-config supporting sources)


libraries?

optional libraries: string[]

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

Library IDs for WebDAV browsing


mrtApiKey?

optional mrtApiKey: string

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

MRT API key


mrtEnvironment?

optional mrtEnvironment: string

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

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


mrtOrigin?

optional mrtOrigin: string

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

MRT API origin URL override


mrtProject?

optional mrtProject: string

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

MRT project slug


password?

optional password: string

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

Password/access-key for Basic auth (WebDAV)


projectDirectory?

optional projectDirectory: string

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

Starting directory for config file search and project-relative operations


realm?

optional realm: string

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

Default ODS realm for sandbox operations


safety?

optional safety: object

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

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

ODS API hostname


scopes?

optional scopes: string[]

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

OAuth scopes


selfSigned?

optional selfSigned: boolean

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

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


shortCode?

optional shortCode: string

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

SCAPI short code


siteId?

optional siteId: string

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

B2C Commerce site/channel ID


slasClientId?

optional slasClientId: string

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

SLAS client ID for shopper authentication


slasClientSecret?

optional slasClientSecret: string

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

SLAS client secret for private shopper clients


tenantId?

optional tenantId: string

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

Tenant/Organization ID for SCAPI


username?

optional username: string

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

Username for Basic auth (WebDAV)


webdavHostname?

optional webdavHostname: string

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

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


workingDirectory?

optional workingDirectory: string

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

Deprecated

Use projectDirectory instead

Released under the Apache-2.0 License.