@salesforce/b2c-tooling-sdk / cartridges
cartridges
Cartridge path primitives: ordering, discovery, and module resolution.
Everything in this module is synchronous, has no dependency on SDK configuration or logging, and reaches the filesystem only through a CartridgeFileSystemHost. That keeps it usable from the CLI, MCP tools, the VS Code extension, and the TypeScript language service plugin.
Example
typescript
import {
CartridgeResolver,
createNodeFileSystemHost,
discoverCartridges,
orderCartridges,
parseCartridgePath,
} from '@salesforce/b2c-tooling-sdk/cartridges';
const host = createNodeFileSystemHost();
const cartridges = orderCartridges(discoverCartridges('./my-project', host), parseCartridgePath('app_custom:app_storefront_base:modules'));
const resolver = new CartridgeResolver(cartridges, host);
const csrf = resolver.resolveRequire('*/cartridge/scripts/middleware/csrf', cartridges[0].src + '/cartridge/controllers/Cart.js');Classes
Interfaces
- CartridgeFileSystemHost
- CartridgeLocation
- DiscoverCartridgesOptions
- DiscoveredCartridge
- FindSiteCartridgePathsOptions
- ResolvedCartridgeModule
- ResolveRequireOptions
- SiteCartridgePathFile
- SiteCartridgePathSelection
Type Aliases
Variables
- BASE_CARTRIDGE_RANK
- CARTRIDGE_MODULE_EXTENSIONS
- DEFAULT_DISCOVERY_MAX_DEPTH
- DISCOVERY_IGNORED_DIRECTORIES