Class GovernanceMiddleware

Index

Constructors

Accessors

Methods

requiresCheck checkProposed reportOutcome

Constructors

constructor

new GovernanceMiddleware(
    governanceConfig: GovernanceConfig,
    onActivity?: (activity: Activity) => void | Promise<void>,
    adcpVersion?: string,
): GovernanceMiddleware
Parameters
- governanceConfig: GovernanceConfig
- OptionalonActivity: (activity: Activity) => void | Promise<void>
- OptionaladcpVersion: string
  Buyer's per-instance AdCP version pin. Forwarded to the governance agent's ProtocolClient.callTool so a buyer pinned to e.g. '4.0.0-beta.1' doesn't silently fall back to the SDK default ADCP_MAJOR_VERSION constant when calling the governance agent. Defaults to undefined, which ProtocolClient.callTool resolves to the SDK constant — same shape as a no-pin call.
Returns GovernanceMiddleware
- Defined in src/lib/core/GovernanceMiddleware.ts:121

Accessors

campaign

get campaign(): CampaignGovernanceConfig | undefined
Get the campaign governance config. Returns undefined if not configured.

Returns CampaignGovernanceConfig | undefined
- Defined in src/lib/core/GovernanceMiddleware.ts:168

Methods

requiresCheck

requiresCheck(tool: string): boolean
Check whether this tool requires a governance check.
Parameters
- tool: string
Returns boolean
- Defined in src/lib/core/GovernanceMiddleware.ts:161

checkProposed

checkProposed(
    tool: string,
    params: Record<string, unknown>,
    debugLogs?: GovernanceDebugEntry[],
): Promise<
    { result: GovernanceCheckResult; params: Record<string, unknown> },
>
Run a proposed governance check before sending a tool call to a seller.

Returns the governance result. The caller decides how to handle each status:
- approved: proceed with execution (params may be modified by conditions)
- denied: do not execute
When conditions are returned with required_value, this method auto-applies them and re-checks, up to maxConditionsIterations.
Parameters
- tool: string
- params: Record<string, unknown>
- debugLogs: GovernanceDebugEntry[] = []
Returns Promise<{ result: GovernanceCheckResult; params: Record<string, unknown> }>
- Defined in src/lib/core/GovernanceMiddleware.ts:182

reportOutcome

reportOutcome(
    checkId: string,
    outcome: OutcomeType,
    sellerResponse?: Record<string, unknown>,
    error?: { code?: string; message: string },
    debugLogs?: GovernanceDebugEntry[],
    governanceContext?: string,
): Promise<GovernanceOutcome | undefined>
Report the outcome of a tool execution to the governance agent. Called after the seller responds (success or failure).
Parameters
- checkId: string
- outcome: OutcomeType
- OptionalsellerResponse: Record<string, unknown>
- Optionalerror: { code?: string; message: string }
- debugLogs: GovernanceDebugEntry[] = []
- OptionalgovernanceContext: string
Returns Promise<GovernanceOutcome | undefined>
- Defined in src/lib/core/GovernanceMiddleware.ts:296