StoreTx
Defined in: packages/core/src/model/store.ts:153
Methods
Section titled “Methods”appendAudit()
Section titled “appendAudit()”appendAudit(
events):Promise<void>
Defined in: packages/core/src/model/store.ts:165
Parameters
Section titled “Parameters”events
Section titled “events”readonly AuditEvent[]
Returns
Section titled “Returns”Promise<void>
enqueueEvents()
Section titled “enqueueEvents()”enqueueEvents(
events,now):Promise<void>
Defined in: packages/core/src/model/store.ts:170
Adds events with zero attempts, due at now.
Parameters
Section titled “Parameters”events
Section titled “events”readonly DomainEvent[]
string
Returns
Section titled “Returns”Promise<void>
findBlocked()
Section titled “findBlocked()”findBlocked(
query):Promise<BlockedStepView[]>
Defined in: packages/core/src/model/store.ts:206
Blocked steps of pending requests, blocked longest first by (blockedAt, requestId). The
tenant must match exactly. Build each item with blockedStepView(state).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<BlockedStepView[]>
findDelegations()
Section titled “findDelegations()”findDelegations(
fromUserIds,tenantId?):Promise<DelegationRule[]>
Defined in: packages/core/src/model/store.ts:212
Every rule of these users, active or not; the engine filters by time, scope and tenant.
With a tenantId: rules of that tenant and rules without one. Without: rules without one.
Parameters
Section titled “Parameters”fromUserIds
Section titled “fromUserIds”readonly string[]
tenantId?
Section titled “tenantId?”string
Returns
Section titled “Returns”Promise<DelegationRule[]>
findDue()
Section titled “findDue()”findDue(
now,limit,options?):Promise<string[]>
Defined in: packages/core/src/model/store.ts:167
Ids of requests with nextDueAt <= now, earliest first.
Parameters
Section titled “Parameters”string
number
options?
Section titled “options?”Returns
Section titled “Returns”Promise<string[]>
findInbox()
Section titled “findInbox()”findInbox(
query):Promise<TaskView[]>
Defined in: packages/core/src/model/store.ts:196
Pending tasks on active steps of pending requests that the user holds (assigneeId) or that a
delegate holds on the user’s behalf (onBehalfOf, EC-60), ordered by (assignedAt, taskId).
The tenant must match exactly. Adapters return the task as stored; the service adds heldBy.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<TaskView[]>
findRequests()
Section titled “findRequests()”findRequests(
query):Promise<RequestSummary[]>
Defined in: packages/core/src/model/store.ts:201
Requests matching every given filter, newest first by (submittedAt desc, id desc). The
tenant must match exactly. Build each item with requestSummary(state).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<RequestSummary[]>
getAudit()
Section titled “getAudit()”getAudit(
requestId):Promise<AuditEvent[]>
Defined in: packages/core/src/model/store.ts:190
Audit events of one request, ordered by seq.
Parameters
Section titled “Parameters”requestId
Section titled “requestId”string
Returns
Section titled “Returns”Promise<AuditEvent[]>
getDelegation()
Section titled “getDelegation()”getDelegation(
id):Promise<DelegationRule|null>
Defined in: packages/core/src/model/store.ts:215
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<DelegationRule | null>
getFlow()
Section titled “getFlow()”getFlow(
ref):Promise<RegisteredFlow|null>
Defined in: packages/core/src/model/store.ts:155
Matches the scope exactly; versions are numbered per (tenantId, key).
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<RegisteredFlow | null>
getIdempotent()
Section titled “getIdempotent()”getIdempotent(
ref):Promise<IdempotentRecord|null>
Defined in: packages/core/src/model/store.ts:186
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<IdempotentRecord | null>
getRequest()
Section titled “getRequest()”getRequest(
id,opts?):Promise<RequestState|null>
Defined in: packages/core/src/model/store.ts:159
Parameters
Section titled “Parameters”string
forUpdate?
Section titled “forUpdate?”boolean
Returns
Section titled “Returns”Promise<RequestState | null>
listDelegations()
Section titled “listDelegations()”listDelegations(
query):Promise<DelegationRule[]>
Defined in: packages/core/src/model/store.ts:217
Rules from or to the user, with the same tenant matching as findDelegations.
Parameters
Section titled “Parameters”tenantId?
Section titled “tenantId?”string
userId
Section titled “userId”string
Returns
Section titled “Returns”Promise<DelegationRule[]>
markDispatched()
Section titled “markDispatched()”markDispatched(
keys,now?):Promise<void>
Defined in: packages/core/src/model/store.ts:180
now: when they were delivered; adapters that keep delivered events may record it.
Parameters
Section titled “Parameters”readonly EventKey[]
string
Returns
Section titled “Returns”Promise<void>
markFailed()
Section titled “markFailed()”markFailed(
key,failure):Promise<void>
Defined in: packages/core/src/model/store.ts:181
Parameters
Section titled “Parameters”failure
Section titled “failure”attempts
Section titled “attempts”number
string
nextAttemptAt
Section titled “nextAttemptAt”string
Returns
Section titled “Returns”Promise<void>
pendingEvents()
Section titled “pendingEvents()”pendingEvents(
query):Promise<OutboxEntry[]>
Defined in: packages/core/src/model/store.ts:176
Due entries (nextAttemptAt <= now), never one while an earlier entry of the same request is
still undelivered: each request contributes its due events in seq order from its oldest
undelivered one. Requests are ordered by that oldest event’s nextAttemptAt, then by id.
Parameters
Section titled “Parameters”object & ClaimOptions
Returns
Section titled “Returns”Promise<OutboxEntry[]>
putIdempotent()
Section titled “putIdempotent()”putIdempotent(
ref,record):Promise<void>
Defined in: packages/core/src/model/store.ts:187
Parameters
Section titled “Parameters”record
Section titled “record”Returns
Section titled “Returns”Promise<void>
saveDelegation()
Section titled “saveDelegation()”saveDelegation(
rule):Promise<void>
Defined in: packages/core/src/model/store.ts:214
Inserts or replaces the rule with this id.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
saveFlow()
Section titled “saveFlow()”saveFlow(
flow):Promise<void>
Defined in: packages/core/src/model/store.ts:157
flow.tenantId sets the scope.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<void>
saveRequest()
Section titled “saveRequest()”saveRequest(
state,expectedVersion):Promise<void>
Defined in: packages/core/src/model/store.ts:164
Compare-and-set on version: expectedVersion null means the request must not exist yet.
A mismatch throws ConflictError (EC-15).
Parameters
Section titled “Parameters”expectedVersion
Section titled “expectedVersion”number | null
Returns
Section titled “Returns”Promise<void>