@salesforce/b2c-tooling-sdk / project-index / IndexedEndpoint
Interface: IndexedEndpoint
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:71
A storefront endpoint (Controller-Action).
Properties
action
action:
string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:75
cartridge
cartridge:
string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:78
Cartridge that serves the endpoint (leftmost on the cartridge path).
chain?
optionalchain:IndexedMiddleware[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:90
SFRA: the composed middleware chain.
controller
controller:
string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:74
csrf
csrf:
"none"|"middleware"|"in-handler"|"not-applicable"
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:88
How CSRF tokens are checked. none for endpoints that accept POST without a check.
events?
optionalevents:RouteEventListener[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:92
SFRA: route event listeners registered by the chain, in the order they run.
filters?
optionalfilters:string[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:96
SiteGenesis: guard filters.
https
https:
boolean
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:84
Whether the endpoint requires HTTPS (SFRA server.middleware.https, SiteGenesis https, pipeline secure).
id
id:
string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:73
Cart-AddProduct.
kind
kind:
EndpointKind
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:76
line
line:
number
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:81
loginRequired
loginRequired:
boolean
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:86
Whether the endpoint requires a logged-in customer.
methods
methods:
EndpointMethod[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:82
public?
optionalpublic:boolean
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:98
Pipelines: whether the start node is public (not call-mode="private").
relPath
relPath:
string
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:80
File that defines the effective endpoint, relative to its cartridge.
steps?
optionalsteps:RouteStep[]
Defined in: packages/b2c-tooling-sdk/src/project-index/types.ts:94
SFRA: the statements that produced the chain, across cartridges.