@salesforce/b2c-tooling-sdk / operations/cap

operations/cap

Commerce App Package (CAP) operations for B2C Commerce.

This module provides functions for validating, packaging, installing, and uninstalling Commerce App Packages (CAPs) on B2C Commerce instances.

CAP Operations

• validateCap - Validate CAP structure and manifest (local, no instance required)
• commerceAppInstall - Install a CAP via the sfcc-install-commerce-app job
• commerceAppUninstall - Uninstall a CAP via the sfcc-uninstall-commerce-app job
• commerceAppPackage - Package a CAP directory into a distributable .zip
• discoverLocalApps - Discover local CAPs by finding commerce-app.json files
• listInstalledApps - List installed apps on an instance via commerce_feature_states export

Usage

import {
  validateCap,
  commerceAppInstall,
  commerceAppUninstall,
  commerceAppPackage,
  discoverLocalApps,
  listInstalledApps,
} from '@salesforce/b2c-tooling-sdk/operations/cap';

// Validate locally
const result = await validateCap('./my-commerce-app');
if (!result.valid) console.error(result.errors);

// Package for distribution
const pkg = await commerceAppPackage('./my-commerce-app');

// Install on an instance
await commerceAppInstall(instance, './my-commerce-app', { siteId: 'RefArch' });

// Uninstall
await commerceAppUninstall(instance, 'my-app', 'tax', { siteId: 'RefArch' });

Interfaces

• CapValidationResult
• CommerceAppInstallOptions
• CommerceAppInstallResult
• CommerceAppManifest
• CommerceAppPackageOptions
• CommerceAppPackageResult
• CommerceAppUninstallOptions
• CommerceAppUninstallResult
• CommerceFeatureState
• ListInstalledAppsOptions
• ListInstalledAppsResult
• LocalCommerceApp
• PullCommerceAppsOptions
• PullCommerceAppsResult
• PulledApp

Type Aliases

• PullSource

Functions

• commerceAppInstall
• commerceAppPackage
• commerceAppUninstall
• discoverLocalApps
• listInstalledApps
• parseCommerceFeatureStatesXml
• pullCommerceApps
• readManifest
• validateCap

References

JobExecutionError

Re-exports JobExecutionError