@salesforce/b2c-tooling-sdk / operations/code
operations/code
Code deployment operations for B2C Commerce.
This module provides functions for managing cartridge code versions on B2C Commerce instances via WebDAV and OCAPI.
Cartridge Discovery
- findCartridges - Find cartridges by .project files
Code Versions
- listCodeVersions - List all code versions on an instance
- getActiveCodeVersion - Get the currently active code version
- activateCodeVersion - Activate a code version
- reloadCodeVersion - Reload (re-activate) a code version
- deleteCodeVersion - Delete a code version
- createCodeVersion - Create a new code version
Deployment
- findAndDeployCartridges - Find and deploy cartridges to an instance
- uploadCartridges - Low-level cartridge upload
- deleteCartridges - Low-level cartridge deletion
- watchCartridges - Watch and sync file changes
Download
- downloadCartridges - Download cartridges from an instance
Usage
typescript
import {
findCartridges,
findAndDeployCartridges,
listCodeVersions,
activateCodeVersion,
watchCartridges,
} from '@salesforce/b2c-tooling-sdk/operations/code';
import { resolveConfig } from '@salesforce/b2c-tooling-sdk/config';
const config = resolveConfig();
const instance = config.createB2CInstance();
// Deploy cartridges (requires instance.config.codeVersion to be set)
await findAndDeployCartridges(instance, './cartridges', { reload: true });
// List code versions
const versions = await listCodeVersions(instance);
// Watch for changes
const watcher = await watchCartridges(instance, './cartridges');Authentication
- WebDAV operations support both Basic Auth and OAuth
- OCAPI operations (code versions) require OAuth
Interfaces
- CartridgeMapping
- DeployOptions
- DeployResult
- DownloadOptions
- DownloadProgressInfo
- DownloadResult
- FileChange
- FindCartridgesOptions
- UploadFilesOptions
- UploadOptions
- UploadProgressInfo
- WatchOptions
- WatchResult