policy

Types

InterruptDataKey

export type InterruptDataKey = string

(source)

InterruptDataVal

export type InterruptDataVal = string

(source)

InterruptKind

export type InterruptKind = string

(source)

PolicyRule

export type PolicyRule = {
  match?: Record<InterruptDataKey, InterruptDataVal>;
  action: "approve" | "reject" | "propagate"
}

(source)

Policy

export type Policy = Record<InterruptKind, PolicyRule[]>

(source)

Functions

checkPolicy

checkPolicy(policy: Record<string, any>, interrupt: Record<string, any>)

Evaluate a policy against an interrupt. Returns approve(), reject(), or propagate() based on the first matching rule. Policy is a JSON object keyed by interrupt kind, where each kind maps to an ordered array of rules with optional match fields (glob patterns) and an action.

Parameters:

Name	Type	Default
policy	Record<string, any>
interrupt	Record<string, any>

(source)

validatePolicy

validatePolicy(policy: Record<string, any>)

Validate that a policy object is well-formed. Returns { success: true } if valid, or { success: false, error: "..." } with a description of the problem.

Parameters:

Name	Type	Default
policy	Record<string, any>

(source)

writePolicyFile

writePolicyFile(path: string, policy: Policy)

Validate and write a policy to a JSON file. Throws if the policy is invalid.

Parameters:

Name	Type	Default
path	string
policy	Policy

(source)