@salesforce/b2c-tooling-sdk / scapi / ScapiCodeOptions
Interface: ScapiCodeOptions
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:94
Properties
auth()?
optionalauth: (operation,options,signal,call) =>Promise<unknown>
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:103
SLAS token export behind auth.slas(); the program has no auth global when omitted.
Parameters
operation
string
options
unknown
signal
AbortSignal
call
Returns
Promise<unknown>
authType?
optionalauthType:ScapiAuthType
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:99
code
code:
string
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:95
detail?
optionaldetail:"full"|"outline"
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:114
How much prose spec operations carry. outline keeps each operation's own summary, description and tags but drops nested descriptions and examples, keeping discovery results within the output cap. Defaults to full.
documents?
optionaldocuments:ScapiSchemaDocument[]
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:98
input?
optionalinput:unknown
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:96
interceptors?
optionalinterceptors:ScapiCallInterceptor[]
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:124
Wrap every live call; see ScapiCallInterceptor.
journal?
optionaljournal:ScapiJournal
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:126
Record answers here, and replay those already recorded. See ScapiJournal.
maxOutputBytes?
optionalmaxOutputBytes:number
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:109
onControl()?
optionalonControl: (control) =>void
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:116
The host owns cancellation and cleanup while paused; approval may wait indefinitely. Never exposed to the program.
Parameters
control
Returns
void
onJournal()?
optionalonJournal: (journal) =>void
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:128
Called after each journal change, for hosts that persist it.
Parameters
journal
Returns
void
organizationId?
optionalorganizationId:string
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:105
Tenant (zzzz_001) or organization ID (f_ecom_zzzz_001); programs always see the f_ecom_ form.
request()?
optionalrequest: (options,signal,call) =>Promise<unknown>
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:101
Answers scapi.request(); usually createScapiRequest. call identifies the program's call.
Parameters
options
unknown
signal
AbortSignal
call
Returns
Promise<unknown>
safety?
optionalsafety:SafetyConfig
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:122
Hide operations this safety policy always blocks from spec and spec.search, so programs only see what they can call. Pass the same config given to createScapiRequest, which still enforces it.
signal?
optionalsignal:AbortSignal
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:107
siteId?
optionalsiteId:string
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:106
snippets?
optionalsnippets:ScapiSnippet[]
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:97
timeoutMs?
optionaltimeoutMs:number
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:108
wasm?
optionalwasm:object|Promise<object>
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:130
Compiled quickjs-wasi/quickjs.wasm, for bundled hosts where the file is not on disk.
workerUrl?
optionalworkerUrl:string|URL
Defined in: packages/b2c-tooling-sdk/src/scapi/runtime.ts:132
Worker entry importing @earendil-works/pi-codemode/worker, for bundled hosts.