---
editLink: false
lastUpdated: false
---

[@salesforce/b2c-tooling-sdk](../modules.md) / 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](interfaces/CartridgeFileSystemHost.md). 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

- [CartridgeResolver](classes/CartridgeResolver.md)

## Interfaces

- [CartridgeFileSystemHost](interfaces/CartridgeFileSystemHost.md)
- [CartridgeLocation](interfaces/CartridgeLocation.md)
- [DiscoverCartridgesOptions](interfaces/DiscoverCartridgesOptions.md)
- [DiscoveredCartridge](interfaces/DiscoveredCartridge.md)
- [FindSiteCartridgePathsOptions](interfaces/FindSiteCartridgePathsOptions.md)
- [ResolvedCartridgeModule](interfaces/ResolvedCartridgeModule.md)
- [ResolveRequireOptions](interfaces/ResolveRequireOptions.md)
- [SiteCartridgePathFile](interfaces/SiteCartridgePathFile.md)
- [SiteCartridgePathSelection](interfaces/SiteCartridgePathSelection.md)

## Type Aliases

- [CartridgeResolutionKind](type-aliases/CartridgeResolutionKind.md)
- [SelectedSiteCartridgePath](type-aliases/SelectedSiteCartridgePath.md)

## Variables

- [BASE\_CARTRIDGE\_RANK](variables/BASE_CARTRIDGE_RANK.md)
- [CARTRIDGE\_MODULE\_EXTENSIONS](variables/CARTRIDGE_MODULE_EXTENSIONS.md)
- [DEFAULT\_DISCOVERY\_MAX\_DEPTH](variables/DEFAULT_DISCOVERY_MAX_DEPTH.md)
- [DISCOVERY\_IGNORED\_DIRECTORIES](variables/DISCOVERY_IGNORED_DIRECTORIES.md)

## Functions

- [createNodeFileSystemHost](functions/createNodeFileSystemHost.md)
- [discoverCartridges](functions/discoverCartridges.md)
- [findSiteCartridgePaths](functions/findSiteCartridgePaths.md)
- [orderCartridges](functions/orderCartridges.md)
- [parseCartridgePath](functions/parseCartridgePath.md)
- [selectSiteCartridgePath](functions/selectSiteCartridgePath.md)
- [toForwardSlashes](functions/toForwardSlashes.md)
