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

Interface: DwJsonConfig

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:33

Configuration structure for dw.json after key normalization.

All keys are normalized to camelCase by normalizeConfigKeys() when loading. Both camelCase and kebab-case are accepted in the raw file; the interface documents the canonical (post-normalization) field names.

Legacy aliases (e.g., server, secureHostname, passphrase, selfsigned, cloudOrigin, scapi-shortcode) are also accepted and mapped to their canonical names during normalization.

Extended by

DwJsonMultiConfig

Properties

accountManagerHost?

optional accountManagerHost: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:75

Account Manager hostname for OAuth

active?

optional active: boolean

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:37

Whether this config is active (for multi-config files)

apiBackend?

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

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:133

API backend preference for operations that support both OCAPI and SCAPI

assetQuery?

optional assetQuery: string[]

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:113

JSON dot-paths for asset extraction during content library parsing (defaults to ['image.path'])

authMethods?

optional authMethods: AuthMethod[]

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

Allowed authentication methods in priority order

autoUpload?

optional autoUpload: boolean

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

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

cartridgeIgnoreDirs?

optional cartridgeIgnoreDirs: string[]

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

Directory names skipped at any depth when archiving cartridges for deploy

cartridges?

optional cartridges: string | string[]

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

Cartridge names to include in deploy/watch (string with colon/comma separators, or array)

catalogs?

optional catalogs: string[]

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:103

Catalog IDs for WebDAV browsing

certificate?

optional certificate: string

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

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

certificatePassphrase?

optional certificatePassphrase: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:123

Passphrase for the certificate

cipHost?

optional cipHost: string

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

Optional CIP analytics host override

clientAuthMethod?

optional clientAuthMethod: ClientAuthMethod

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

How client credentials are sent to Account Manager

clientId?

optional clientId: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:47

OAuth client ID

clientSecret?

optional clientSecret: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:49

OAuth client secret

codeVersion?

optional codeVersion: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:41

Code version for deployments

contentLibrary?

optional contentLibrary: string

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

Default content library ID for content export/list commands

docsCategories?

optional docsCategories: string[]

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:117

Documentation categories to expose (allowlist); dw.json key docs-categories

hostname?

optional hostname: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:39

B2C instance hostname

importSetExclude?

optional importSetExclude: string[]

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:97

Directory paths to exclude recursively from import-set source discovery

jwtCertPath?

optional jwtCertPath: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:137

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

jwtKeyPath?

optional jwtKeyPath: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:139

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

jwtPassphrase?

optional jwtPassphrase: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:141

Optional passphrase for encrypted JWT private key

libraries?

optional libraries: (string | LibraryEntry)[]

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

Library IDs for WebDAV browsing and the Content Libraries tree.

Accepts either a string array or a mixed array of strings and {id, siteLibrary?} objects. Object entries can mark individual libraries as site-private.

mrtApiKey?

optional mrtApiKey: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:83

MRT API key

mrtBackend?

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

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:135

MRT backend preference: legacy MRT Cloud API vs SCAPI MRT deployments API

mrtEnvironment?

optional mrtEnvironment: string

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

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

mrtOrigin?

optional mrtOrigin: string

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

MRT cloud origin URL

mrtProject?

optional mrtProject: string

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

MRT project slug

name?

optional name: string

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

Instance name (for multi-config files)

oauthScopes?

optional oauthScopes: string[]

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

OAuth scopes

password?

optional password: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:45

Password/access-key for Basic auth (WebDAV)

realm?

optional realm: string

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:91

Default ODS realm for sandbox operations

safety?

optional safety: object

Defined in: packages/b2c-tooling-sdk/src/config/dw-json.ts:159

Safety configuration for this instance.

confirm?

optional confirm: boolean

level?

optional level: string

rules?

optional rules: object[]

Example

json

{
  "safety": {
    "level": "NO_UPDATE",
    "confirm": true,
    "rules": [
      { "job": "sfcc-site-archive-export", "action": "allow" },
      { "command": "sandbox:*", "action": "confirm" }
    ]
  }
}