Skip to content

Graphorin API reference v0.1.0


Graphorin API reference / @graphorin/sessions / agent-registry / AgentRegistry

Class: AgentRegistry

Defined in: packages/sessions/src/agent-registry.ts:64

In-memory + write-through registry of agent metadata.

Stable

Constructors

Constructor

ts
new AgentRegistry(args): AgentRegistry;

Defined in: packages/sessions/src/agent-registry.ts:69

Parameters

ParameterType
args{ now?: () => number; store: SessionStoreExt; }
args.now?() => number
args.storeSessionStoreExt

Returns

AgentRegistry

Methods

delete()

ts
delete(id, opts?): Promise<void>;

Defined in: packages/sessions/src/agent-registry.ts:127

Hard-delete an agent. Subsequent resolveOrPlaceholder(id) returns { kind: 'unknown', id } so replay can substitute a placeholder.

Parameters

ParameterType
idstring
optsRetireAgentOptions

Returns

Promise&lt;void&gt;


get()

ts
get(id): Promise<
  | AgentRegistryEntry
| null>;

Defined in: packages/sessions/src/agent-registry.ts:140

Best-effort lookup. Returns null when the agent is unknown.

Parameters

ParameterType
idstring

Returns

Promise< | AgentRegistryEntry | null>


hydrate()

ts
hydrate(): Promise<void>;

Defined in: packages/sessions/src/agent-registry.ts:79

Hydrate the in-memory cache from the store. Useful when a process boots after a restart and wants the agent catalogue ready before any Session.list({...}) call.

Returns

Promise&lt;void&gt;


list()

ts
list(): Promise<readonly AgentRegistryEntry[]>;

Defined in: packages/sessions/src/agent-registry.ts:151

List every known agent (active + retired).

Returns

Promise&lt;readonly AgentRegistryEntry[]&gt;


register()

ts
register(id, opts): Promise<AgentRegistryEntry>;

Defined in: packages/sessions/src/agent-registry.ts:89

Idempotent registration. Re-registering the same id refreshes the display name + tags but preserves the original registeredAt.

Parameters

ParameterType
idstring
optsRegisterAgentOptions

Returns

Promise&lt;AgentRegistryEntry&gt;


resolveOrPlaceholder()

ts
resolveOrPlaceholder(id): Promise<AgentRegistryLookup>;

Defined in: packages/sessions/src/agent-registry.ts:160

Replay-safe lookup. Returns { kind: 'agent', agent } when the id is known (active or retired), or { kind: 'unknown', id } when the agent has been hard-deleted.

Parameters

ParameterType
idstring

Returns

Promise&lt;AgentRegistryLookup&gt;


retire()

ts
retire(id, opts?): Promise<void>;

Defined in: packages/sessions/src/agent-registry.ts:110

Soft-retire an agent. Subsequent resolveOrPlaceholder(id) still returns the metadata (with retiredAt set) so replay shows "(retired) Worker Agent". Pass { assertExists: true } to throw on an unknown id.

Parameters

ParameterType
idstring
optsRetireAgentOptions

Returns

Promise&lt;void&gt;


snapshot()

ts
snapshot(): readonly AgentRegistryEntry[];

Defined in: packages/sessions/src/agent-registry.ts:170

Snapshot of the in-memory cache. Used by JSONL export to embed kind: 'agent' records without an extra round-trip to the store.

Returns

readonly AgentRegistryEntry[]