@salesforce/b2c-tooling-sdk / cartridges / CartridgeResolver
Class: CartridgeResolver
Defined in: packages/b2c-tooling-sdk/src/cartridges/resolver.ts:97
Resolves B2C Commerce cartridge module specifiers to files, following the platform's cartridge path rules.
The resolver is synchronous and does all filesystem access through a CartridgeFileSystemHost, so it can run inside the TypeScript language service as well as in Node.
Example
import {CartridgeResolver, createNodeFileSystemHost, orderCartridges} from '@salesforce/b2c-tooling-sdk/cartridges';
import {findCartridges} from '@salesforce/b2c-tooling-sdk/operations/code';
const resolver = new CartridgeResolver(orderCartridges(findCartridges(), ['app_custom', 'app_storefront_base', 'modules']), createNodeFileSystemHost());
resolver.resolveRequire('*/cartridge/scripts/middleware/csrf', '/proj/cartridges/app_custom/cartridge/controllers/Cart.js');
resolver.resolveSuperModule('/proj/cartridges/app_custom/cartridge/controllers/Cart.js');Constructors
Constructor
new CartridgeResolver(
cartridges,host):CartridgeResolver
Defined in: packages/b2c-tooling-sdk/src/cartridges/resolver.ts:104
Parameters
cartridges
readonly CartridgeLocation[]
Cartridges in cartridge path order (leftmost, highest priority, first).
host
Filesystem access.
Returns
CartridgeResolver
Accessors
cartridges
Get Signature
get cartridges(): readonly
CartridgeLocation[]
Defined in: packages/b2c-tooling-sdk/src/cartridges/resolver.ts:115
The cartridges this resolver was created with, in cartridge path order.
Returns
readonly CartridgeLocation[]
Methods
getCartridge()
getCartridge(
name):CartridgeLocation|undefined
Defined in: packages/b2c-tooling-sdk/src/cartridges/resolver.ts:120
Returns the cartridge with the given name, if it is on the path.
Parameters
name
string
Returns
CartridgeLocation | undefined
isCartridgeFile()
isCartridgeFile(
filePath):boolean
Defined in: packages/b2c-tooling-sdk/src/cartridges/resolver.ts:125
Returns true when filePath is inside one of the cartridges.
Parameters
filePath
string
Returns
boolean
ownerOf()
ownerOf(
filePath):CartridgeLocation|undefined
Defined in: packages/b2c-tooling-sdk/src/cartridges/resolver.ts:130
Returns the cartridge that contains filePath, if any.
Parameters
filePath
string
Returns
CartridgeLocation | undefined
relativePath()
relativePath(
filePath):string|undefined
Defined in: packages/b2c-tooling-sdk/src/cartridges/resolver.ts:138
Returns filePath relative to the root of its owning cartridge (forward slashes, original case), for example cartridge/controllers/Cart.js.
Parameters
filePath
string
Returns
string | undefined
resolveRequire()
resolveRequire(
specifier,fromFile,options):ResolvedCartridgeModule|undefined
Defined in: packages/b2c-tooling-sdk/src/cartridges/resolver.ts:150
Resolves a require() specifier from fromFile to a file.
Returns undefined for Script API modules (dw/...) and for specifiers that don't resolve to a file in any cartridge.
Parameters
specifier
string
fromFile
string
options
Returns
ResolvedCartridgeModule | undefined
resolveSuperModule()
resolveSuperModule(
fromFile):ResolvedCartridgeModule|undefined
Defined in: packages/b2c-tooling-sdk/src/cartridges/resolver.ts:190
Resolves module.superModule for fromFile: the module with the same cartridge-relative path in the next cartridge to the right on the path.
Parameters
fromFile
string
Returns
ResolvedCartridgeModule | undefined