@@ -20,7 +20,7 @@ npm install @salesforce/b2c-tooling-sdk
2020Use ` resolveConfig() ` to load configuration from project files (dw.json) and create a B2C instance:
2121
2222``` typescript
23- import { resolveConfig } from ' @salesforce/b2c-tooling-sdk/config' ;
23+ import {resolveConfig } from ' @salesforce/b2c-tooling-sdk/config' ;
2424
2525// Load configuration, override secrets from environment
2626const config = resolveConfig ({
@@ -36,8 +36,8 @@ await instance.webdav.mkcol('Cartridges/v1');
3636await instance .webdav .put (' Cartridges/v1/app.zip' , zipBuffer );
3737
3838// Use typed OCAPI client (openapi-fetch)
39- const { data, error } = await instance .ocapi .GET (' /sites' , {
40- params: { query: { select: ' (**)' } },
39+ const {data, error} = await instance .ocapi .GET (' /sites' , {
40+ params: {query: {select: ' (**)' } },
4141});
4242```
4343
@@ -46,16 +46,16 @@ const { data, error } = await instance.ocapi.GET('/sites', {
4646For advanced use cases, you can construct a B2CInstance directly:
4747
4848``` typescript
49- import { B2CInstance } from ' @salesforce/b2c-tooling-sdk' ;
49+ import {B2CInstance } from ' @salesforce/b2c-tooling-sdk' ;
5050
5151const instance = new B2CInstance (
52- { hostname: ' your-sandbox.demandware.net' , codeVersion: ' v1' },
52+ {hostname: ' your-sandbox.demandware.net' , codeVersion: ' v1' },
5353 {
5454 oauth: {
5555 clientId: ' your-client-id' ,
56- clientSecret: ' your-client-secret'
57- }
58- }
56+ clientSecret: ' your-client-secret' ,
57+ },
58+ },
5959);
6060```
6161
@@ -89,24 +89,24 @@ The OCAPI client uses [openapi-fetch](https://openapi-ts.dev/openapi-fetch/) wit
8989
9090``` typescript
9191// List sites
92- const { data, error } = await instance .ocapi .GET (' /sites' , {
93- params: { query: { select: ' (**)' } },
92+ const {data, error} = await instance .ocapi .GET (' /sites' , {
93+ params: {query: {select: ' (**)' } },
9494});
9595
9696// Activate a code version
97- const { data, error } = await instance .ocapi .PATCH (' /code_versions/{code_version_id}' , {
98- params: { path: { code_version_id: ' v1' } },
99- body: { active: true },
97+ const {data, error} = await instance .ocapi .PATCH (' /code_versions/{code_version_id}' , {
98+ params: {path: {code_version_id: ' v1' } },
99+ body: {active: true },
100100});
101101```
102102
103103### Code Deployment
104104
105105``` typescript
106- import { findAndDeployCartridges , activateCodeVersion } from ' @salesforce/b2c-tooling-sdk/operations/code' ;
106+ import {findAndDeployCartridges , activateCodeVersion } from ' @salesforce/b2c-tooling-sdk/operations/code' ;
107107
108108// Deploy cartridges
109- await findAndDeployCartridges (instance , ' ./cartridges' , { reload: true });
109+ await findAndDeployCartridges (instance , ' ./cartridges' , {reload: true });
110110
111111// Activate code version
112112await activateCodeVersion (instance , ' v1' );
@@ -115,7 +115,7 @@ await activateCodeVersion(instance, 'v1');
115115### Job Execution
116116
117117``` typescript
118- import { executeJob , waitForJob , siteArchiveImport } from ' @salesforce/b2c-tooling-sdk/operations/jobs' ;
118+ import {executeJob , waitForJob , siteArchiveImport } from ' @salesforce/b2c-tooling-sdk/operations/jobs' ;
119119
120120// Run a job and wait for completion
121121const execution = await executeJob (instance , ' my-job-id' );
@@ -129,32 +129,32 @@ await siteArchiveImport(instance, './site-data.zip');
129129
130130The SDK provides subpath exports for tree-shaking and organization:
131131
132- | Export | Description |
133- | --------| -------------|
134- | ` @salesforce/b2c-tooling-sdk ` | Main entry point with all exports |
135- | ` @salesforce/b2c-tooling-sdk/config ` | Configuration resolution (resolveConfig) |
136- | ` @salesforce/b2c-tooling-sdk/auth ` | Authentication strategies (OAuth, Basic, API Key) |
137- | ` @salesforce/b2c-tooling-sdk/instance ` | B2CInstance class |
138- | ` @salesforce/b2c-tooling-sdk/clients ` | Low-level API clients (WebDAV, OCAPI, SLAS, ODS, MRT) |
139- | ` @salesforce/b2c-tooling-sdk/operations/code ` | Code deployment operations |
140- | ` @salesforce/b2c-tooling-sdk/operations/jobs ` | Job execution and site import/export |
141- | ` @salesforce/b2c-tooling-sdk/operations/sites ` | Site management |
142- | ` @salesforce/b2c-tooling-sdk/discovery ` | Workspace type detection (PWA Kit, SFRA, etc.) |
143- | ` @salesforce/b2c-tooling-sdk/cli ` | CLI utilities (BaseCommand, table rendering) |
144- | ` @salesforce/b2c-tooling-sdk/logging ` | Structured logging utilities |
132+ | Export | Description |
133+ | ---------------------------------------------- | ----------------------------------------------------- |
134+ | ` @salesforce/b2c-tooling-sdk ` | Main entry point with all exports |
135+ | ` @salesforce/b2c-tooling-sdk/config ` | Configuration resolution (resolveConfig) |
136+ | ` @salesforce/b2c-tooling-sdk/auth ` | Authentication strategies (OAuth, Basic, API Key) |
137+ | ` @salesforce/b2c-tooling-sdk/instance ` | B2CInstance class |
138+ | ` @salesforce/b2c-tooling-sdk/clients ` | Low-level API clients (WebDAV, OCAPI, SLAS, ODS, MRT) |
139+ | ` @salesforce/b2c-tooling-sdk/operations/code ` | Code deployment operations |
140+ | ` @salesforce/b2c-tooling-sdk/operations/jobs ` | Job execution and site import/export |
141+ | ` @salesforce/b2c-tooling-sdk/operations/sites ` | Site management |
142+ | ` @salesforce/b2c-tooling-sdk/discovery ` | Workspace type detection (PWA Kit, SFRA, etc.) |
143+ | ` @salesforce/b2c-tooling-sdk/cli ` | CLI utilities (BaseCommand, table rendering) |
144+ | ` @salesforce/b2c-tooling-sdk/logging ` | Structured logging utilities |
145145
146146## Logging
147147
148148Configure logging for debugging HTTP requests:
149149
150150``` typescript
151- import { configureLogger } from ' @salesforce/b2c-tooling-sdk/logging' ;
151+ import {configureLogger } from ' @salesforce/b2c-tooling-sdk/logging' ;
152152
153153// Enable debug logging (shows HTTP request summaries)
154- configureLogger ({ level: ' debug' });
154+ configureLogger ({level: ' debug' });
155155
156156// Enable trace logging (shows full request/response with headers and bodies)
157- configureLogger ({ level: ' trace' });
157+ configureLogger ({level: ' trace' });
158158```
159159
160160## Documentation
0 commit comments