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

Interface: DwJsonConfig

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

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

Account Manager hostname for OAuth

---

active?

optional active: boolean

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

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

---

authMethods?

optional authMethods: AuthMethod[]

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

Allowed authentication methods in priority order

---

cartridges?

optional cartridges: string | string[]

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

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

Catalog IDs for WebDAV browsing

---

certificate?

optional certificate: string

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

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

Passphrase for the certificate

---

cipHost?

optional cipHost: string

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

Optional CIP analytics host override

---

clientId?

optional clientId: string

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

OAuth client ID

---

clientSecret?

optional clientSecret: string

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

OAuth client secret

---

codeVersion?

optional codeVersion: string

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

Code version for deployments

---

contentLibrary?

optional contentLibrary: string

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

Default content library ID for content export/list commands

---

hostname?

optional hostname: string

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

B2C instance hostname

---

libraries?

optional libraries: string[]

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

Library IDs for WebDAV browsing

---

mrtApiKey?

optional mrtApiKey: string

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

MRT API key

---

mrtEnvironment?

optional mrtEnvironment: string

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

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

---

mrtOrigin?

optional mrtOrigin: string

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

MRT cloud origin URL

---

mrtProject?

optional mrtProject: string

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

MRT project slug

---

name?

optional name: string

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

Instance name (for multi-config files)

---

oauthScopes?

optional oauthScopes: string[]

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

OAuth scopes

---

password?

optional password: string

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

Password/access-key for Basic auth (WebDAV)

---

realm?

optional realm: string

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

Default ODS realm for sandbox operations

---

safety?

optional safety: object

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

Safety configuration for this instance.

confirm?

optional confirm: boolean

level?

optional level: string

rules?

optional rules: object[]

Example

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

---

sandboxApiHost?

optional sandboxApiHost: string

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

ODS API hostname

---

selfSigned?

optional selfSigned: boolean

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

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

---

shortCode?

optional shortCode: string

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

SCAPI short code

---

siteId?

optional siteId: string

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

B2C Commerce site/channel ID

---

slasClientId?

optional slasClientId: string

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

SLAS client ID for shopper authentication

---

slasClientSecret?

optional slasClientSecret: string

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

SLAS client secret for private shopper clients

---

tenantId?

optional tenantId: string

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

Tenant/Organization ID for SCAPI

---

username?

optional username: string

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

Username for Basic auth (WebDAV)

---

webdavHostname?

optional webdavHostname: string

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

Alternate hostname for WebDAV (if different from main hostname)