Skip to content

Graphorin API reference v0.7.0


Graphorin API reference / @graphorin/core / / SessionStoreExt

Interface: SessionStoreExt

Defined in: packages/core/src/contracts/session-store.ts:115

Optional extension surface for storage adapters that expose the additional capabilities @graphorin/sessions consumes. Adapters that opt out leave the property undefined; the sessions facade degrades gracefully (delete becomes retire; audit rows are dropped on the floor with a one-time WARN).

Implementations: SqliteSessionStore (@graphorin/store-sqlite).

Stable

Extends

Methods

appendAuditEntry()

ts
appendAuditEntry(entry): Promise<void>;

Defined in: packages/core/src/contracts/session-store.ts:128

Append a session-lifecycle audit row.

Parameters

ParameterType
entrySessionAuditEntry

Returns

Promise&lt;void&gt;


appendHandoff()

ts
appendHandoff(sessionId, record): Promise<void>;

Defined in: packages/core/src/contracts/session-store.ts:97

Parameters

ParameterType
sessionIdstring
recordHandoffRecord

Returns

Promise&lt;void&gt;

Inherited from

SessionStore.appendHandoff


attachWorkflowRun()

ts
attachWorkflowRun(run): Promise<void>;

Defined in: packages/core/src/contracts/session-store.ts:100

Parameters

ParameterType
runSessionWorkflowRun

Returns

Promise&lt;void&gt;

Inherited from

SessionStore.attachWorkflowRun


closeSession()

ts
closeSession(sessionId, closedAt): Promise<void>;

Defined in: packages/core/src/contracts/session-store.ts:91

Parameters

ParameterType
sessionIdstring
closedAtstring

Returns

Promise&lt;void&gt;

Inherited from

SessionStore.closeSession


createSession()

ts
createSession(metadata): Promise<void>;

Defined in: packages/core/src/contracts/session-store.ts:85

Parameters

ParameterType
metadataSessionMetadata

Returns

Promise&lt;void&gt;

Inherited from

SessionStore.createSession


deleteAgent()

ts
deleteAgent(agentId): Promise<void>;

Defined in: packages/core/src/contracts/session-store.ts:117

Hard-delete an agent. Used by AgentRegistry.delete(...).

Parameters

ParameterType
agentIdstring

Returns

Promise&lt;void&gt;


deleteSession()

ts
deleteSession(sessionId): Promise<void>;

Defined in: packages/core/src/contracts/session-store.ts:152

Hard-delete a session and cascade its session-owned rows - handoffs, workflow-run attachments, and audit entries (RP-6) - plus the session's content: its session_messages rows (with their FTS and vector index entries) and any episodes scoped to the session (store-01). The cascade also erases the checkpoints of suspended runs (W-005): workflow_checkpoints / workflow_pending_writes rows for every thread linked to the session, whether through the workflow-run attachment mapping or through the sessionId checkpoint metadata the agent runtime stamps on HITL suspends - those snapshots embed the full conversation. After this call the conversation is no longer retrievable through memory.session.* search surfaces nor resumable from its checkpoints. A no-op for an unknown id. Custom implementations must honour the same contract in full - leaving any of these surfaces behind defeats erasure.

Parameters

ParameterType
sessionIdstring

Returns

Promise&lt;void&gt;


getSession()

ts
getSession(sessionId): Promise<
  | SessionMetadata
| null>;

Defined in: packages/core/src/contracts/session-store.ts:86

Parameters

ParameterType
sessionIdstring

Returns

Promise< | SessionMetadata | null>

Inherited from

SessionStore.getSession


listAgents()

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

Defined in: packages/core/src/contracts/session-store.ts:119

List all known agents (including retired ones).

Returns

Promise&lt;readonly AgentRegistryEntry[]&gt;


listAuditEntries()

ts
listAuditEntries(sessionId, opts?): Promise<readonly SessionAuditEntry[]>;

Defined in: packages/core/src/contracts/session-store.ts:130

List recent audit rows for a session, newest-first.

Parameters

ParameterType
sessionIdstring
opts?{ limit?: number; }
opts.limit?number

Returns

Promise&lt;readonly SessionAuditEntry[]&gt;


listHandoffs()

ts
listHandoffs(sessionId): Promise<readonly HandoffRecord[]>;

Defined in: packages/core/src/contracts/session-store.ts:98

Parameters

ParameterType
sessionIdstring

Returns

Promise&lt;readonly HandoffRecord[]&gt;

Inherited from

SessionStore.listHandoffs


listSessions()

ts
listSessions(scope): Promise<readonly SessionMetadata[]>;

Defined in: packages/core/src/contracts/session-store.ts:87

Parameters

ParameterType
scopePick&lt;SessionScope, "userId" | "agentId"&gt;

Returns

Promise&lt;readonly SessionMetadata[]&gt;

Inherited from

SessionStore.listSessions


listWorkflowRuns()

ts
listWorkflowRuns(sessionId): Promise<readonly SessionWorkflowRun[]>;

Defined in: packages/core/src/contracts/session-store.ts:101

Parameters

ParameterType
sessionIdstring

Returns

Promise&lt;readonly SessionWorkflowRun[]&gt;

Inherited from

SessionStore.listWorkflowRuns


pruneAuditEntries()

ts
pruneAuditEntries(beforeEpochMs): Promise<number>;

Defined in: packages/core/src/contracts/session-store.ts:135

Delete audit rows older than the supplied epoch ms.

Parameters

ParameterType
beforeEpochMsnumber

Returns

Promise&lt;number&gt;


pruneSessions()

ts
pruneSessions(opts): Promise<number>;

Defined in: packages/core/src/contracts/session-store.ts:159

Retention sweep (RP-6): hard-delete (cascade) every session matching the policy. beforeEpochMs limits to sessions created before that instant; closedOnly limits to closed sessions. With neither, deletes all sessions. Returns the number of sessions deleted.

Parameters

ParameterType
opts{ beforeEpochMs?: number; closedOnly?: boolean; }
opts.beforeEpochMs?number
opts.closedOnly?boolean

Returns

Promise&lt;number&gt;


registerAgent()

ts
registerAgent(entry): Promise<void>;

Defined in: packages/core/src/contracts/session-store.ts:93

Parameters

ParameterType
entryAgentRegistryEntry

Returns

Promise&lt;void&gt;

Inherited from

SessionStore.registerAgent


resolveAgent()

ts
resolveAgent(agentId): Promise<
  | AgentRegistryEntry
| null>;

Defined in: packages/core/src/contracts/session-store.ts:95

Parameters

ParameterType
agentIdstring

Returns

Promise< | AgentRegistryEntry | null>

Inherited from

SessionStore.resolveAgent


retireAgent()

ts
retireAgent(agentId, retiredAt): Promise<void>;

Defined in: packages/core/src/contracts/session-store.ts:94

Parameters

ParameterType
agentIdstring
retiredAtstring

Returns

Promise&lt;void&gt;

Inherited from

SessionStore.retireAgent


updateSession()

ts
updateSession(sessionId, patch): Promise<void>;

Defined in: packages/core/src/contracts/session-store.ts:90

Parameters

ParameterType
sessionIdstring
patchPartial&lt;SessionMetadata&gt;

Returns

Promise&lt;void&gt;

Inherited from

SessionStore.updateSession


updateWorkflowRunStatus()

ts
updateWorkflowRunStatus(
   sessionId, 
   workflowId, 
   threadId, 
status): Promise<void>;

Defined in: packages/core/src/contracts/session-store.ts:121

Update the status of a workflow attachment.

Parameters

ParameterType
sessionIdstring
workflowIdstring
threadIdstring
status"running" | "suspended" | "completed" | "failed"

Returns

Promise&lt;void&gt;