@salesforce/b2c-tooling-sdk / project-index / ProjectIndex
Interface: ProjectIndex
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:246
A JSON-serializable model of a B2C Commerce project's server-side entry points.
Properties
cartridgeOrder?
optionalcartridgeOrder:CartridgeOrder
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:250
Where the cartridge order came from.
cartridges
cartridges:
IndexedCartridge[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:248
customApis
customApis:
IndexedCustomApiEndpoint[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:259
endpoints
endpoints:
IndexedEndpoint[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:257
errors
errors:
object[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:262
Files that could not be parsed while indexing.
cartridge
cartridge:
string
message
message:
string
relPath
relPath:
string
hooks
hooks:
IndexedHook[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:258
jobSteps
jobSteps:
IndexedJobStep[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:260
otherCartridges?
optionalotherCartridges:IndexedCartridge[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:256
Cartridges found in the project but not on the cartridge path. They are not indexed: no endpoints, route steps, hooks, Custom APIs, or job steps come from them. Absent when the order is a guess or includeAllCartridges is set (all cartridges are used).
version
version:
1
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:247