Skip to main content

RateLimitPolicy

@totemsdk/agent-policy


@totemsdk/agent-policy / RateLimitPolicy

Class: RateLimitPolicy

A single composable middleware layer in the policy evaluation pipeline.

Each middleware receives the full AgentProposal and returns a decision. Evaluation is read-only. Implementors that need state (rate limits, daily caps) expose the optional reservation lifecycle below.

The middleware API replaces the boolean-based AgentPolicy with a richer three-state result that includes a reason string for auditability.

Implements​

Constructors​

Constructor​

new RateLimitPolicy(maxProposals, windowMs): RateLimitPolicy

Parameters​

maxProposals​

number

windowMs​

number

Returns​

RateLimitPolicy

Methods​

commit()​

commit(operationId): Promise<void>

Commit a prior reservation after execution succeeds.

Parameters​

operationId​

string

Returns​

Promise<void>

Implementation of​

PolicyMiddleware.commit


evaluate()​

evaluate(proposal, now?): Promise<PolicyEvalResult>

Evaluate a proposal. Called in sequence by ComposablePolicy.

Parameters​

proposal​

AgentProposal

now?​

number = ...

Returns​

Promise<PolicyEvalResult>

Implementation of​

PolicyMiddleware.evaluate


release()​

release(operationId): Promise<void>

Release a reservation. Monotonic: only reserved → released is allowed; releasing a committed operation is a no-op so committed quota can never be recycled by a later reservation under the same operation ID.

Parameters​

operationId​

string

Returns​

Promise<void>

Implementation of​

PolicyMiddleware.release


reserve()​

reserve(proposal, now?): Promise<PolicyEvalResult>

Reserve state for execution using proposal.id as the idempotency key. Implementations must not consume committed quota during evaluation.

Parameters​

proposal​

AgentProposal

now?​

number = ...

Returns​

Promise<PolicyEvalResult>

Implementation of​

PolicyMiddleware.reserve


reset()​

reset(): Promise<void>

Optional: reset internal state (useful in tests or at midnight rollover).

Returns​

Promise<void>

Implementation of​

PolicyMiddleware.reset