Skip to main content
Version: latest (main)

Interface: GatewayClient

Defined in: src/gateway/client.ts:14

Properties​

auditSink?​

readonly optional auditSink?: AuditSinkDisposition

Defined in: src/gateway/client.ts:32

What this client does with hook-layer audit events (AAASM-5681).

Optional so a caller's own GatewayClient keeps compiling unchanged; an omitted value is read as "caller-supplied", i.e. this SDK makes no claim about it. Every client this package ships must declare its disposition explicitly — record / recordResult / scanPrompts all return Promise<void>, so a client that sends the event and one that drops it are otherwise indistinguishable, which is the defect this field closes.


check​

check: (request) => Promise<GatewayDecision>

Defined in: src/gateway/client.ts:35

Parameters​

request​

GatewayCheckRequest

Returns​

Promise<GatewayDecision>


close​

close: () => Promise<void>

Defined in: src/gateway/client.ts:34

Returns​

Promise<void>


httpBaseUrl?​

readonly optional httpBaseUrl?: string

Defined in: src/gateway/client.ts:21

Base URL for the client's HTTP routes. Resolved by initAssembly to controlPlaneUrl when set, otherwise to gatewayUrl. Undefined when the client is constructed without a URL (e.g. a bare no-op test client).


mode​

readonly mode: AssemblyMode

Defined in: src/gateway/client.ts:15


record​

record: (event) => Promise<void>

Defined in: src/gateway/client.ts:41

Parameters​

event​

GatewayRecordEvent

Returns​

Promise<void>


recordResult​

recordResult: (record) => Promise<void>

Defined in: src/gateway/client.ts:42

Parameters​

record​

GatewayResultRecord

Returns​

Promise<void>


scanPrompts​

scanPrompts: (scan) => Promise<void>

Defined in: src/gateway/client.ts:43

Parameters​

scan​

GatewayPromptScan

Returns​

Promise<void>


start​

start: () => Promise<void>

Defined in: src/gateway/client.ts:33

Returns​

Promise<void>


waitForApproval​

waitForApproval: (toolName, runId, timeoutMs) => Promise<GatewayApprovalResult>

Defined in: src/gateway/client.ts:36

Parameters​

toolName​

string

runId​

string

timeoutMs​

number

Returns​

Promise<GatewayApprovalResult>