Interface DoRunLifecycleTopology

Additive run-lifecycle operations returned by createDoRunTopology.

interface DoRunLifecycleTopology {
    dispatchStatus(
        workflowId: string,
        runId: string,
    ): Promise<RunSummary | undefined>;
    persistedStart(
        workflowId: string,
        runId: string,
    ): Promise<PersistedStartResult<RunSummary> | undefined>;
    resume(
        workflowId: string,
        runId: string,
        body: unknown,
        requestedBy: string,
        requestedByKind: "human" | "service" | "agent" | "system",
    ): Promise<RunSummary>;
    resumeRecord(
        record: ApprovalRecord,
        decision: ApprovalDecision,
    ): Promise<RunSummary>;
    start(input: DoRunStartInput): Promise<RunSummary>;
    startLiveness(workflowId: string, runId: string): Promise<boolean>;
    startPrincipal(
        workflowId: string,
        runId: string,
    ): Promise<StartPrincipalReceipt | undefined>;
    status(workflowId: string, runId: string): Promise<RunSummary | undefined>;
    terminate(
        workflowId: string,
        runId: string,
        principal: ExecutionPrincipal,
        replayOnly?: boolean,
    ): Promise<RunSummary>;
    timeOut(
        workflowId: string,
        runId: string,
        cas: RunLifecycleCas,
        principal: ExecutionPrincipal,
    ): Promise<RunSummary>;
}

Hierarchy (View Summary)

DoRunTopology
- DoRunLifecycleTopology
  - DoRunRemoteStepTopology

Index

Methods

dispatchStatus persistedStart resume resumeRecord start startLiveness startPrincipal status terminate timeOut

Methods

dispatchStatus

dispatchStatus(
workflowId: string,
runId: string,
): Promise<RunSummary | undefined>
Waits behind start/recovery before declaring a dispatch absent.
Parameters
- workflowId: string
- runId: string
Returns Promise<RunSummary | undefined>
Inherited from DoRunTopology.dispatchStatus
- Defined in packages/flowsafe/src/host-kit/do-run-topology.ts:72

persistedStart

persistedStart(
workflowId: string,
runId: string,
): Promise<PersistedStartResult<RunSummary> | undefined>
Parameters
- workflowId: string
- runId: string
Returns Promise<PersistedStartResult<RunSummary> | undefined>
Inherited from DoRunTopology.persistedStart
- Defined in packages/flowsafe/src/host-kit/do-run-topology.ts:63

resume

resume(
    workflowId: string,
    runId: string,
    body: unknown,
    requestedBy: string,
    requestedByKind: "human" | "service" | "agent" | "system",
): Promise<RunSummary>
createRunRouter's resume thunk.
Parameters
- workflowId: string
- runId: string
- body: unknown
- requestedBy: string
- requestedByKind: "human" | "service" | "agent" | "system"
Returns Promise<RunSummary>
Inherited from DoRunTopology.resume
- Defined in packages/flowsafe/src/host-kit/do-run-topology.ts:78

resumeRecord

resumeRecord(
record: ApprovalRecord,
decision: ApprovalDecision,
): Promise<RunSummary>
ApprovalServiceOptions.resumeRun base: resume a DECIDED approval's run through its DO stub with the standard resumeData contract and the record's expectedSuspensionFor(record), so a step that moved to another suspension refuses it with SuspensionChangedError. Hand this to buildHostApprovalService, which wraps it in the SoD-guarded re-queue.
Parameters
- record: ApprovalRecord
- decision: ApprovalDecision
Returns Promise<RunSummary>
Inherited from DoRunTopology.resumeRecord
- Defined in packages/flowsafe/src/host-kit/do-run-topology.ts:92

start

start(input: DoRunStartInput): Promise<RunSummary>
createRunRouter's start thunk.
Parameters
- input: DoRunStartInput
Returns Promise<RunSummary>
Inherited from DoRunTopology.start
- Defined in packages/flowsafe/src/host-kit/do-run-topology.ts:68

startLiveness

startLiveness(workflowId: string, runId: string): Promise<boolean>
Parameters
- workflowId: string
- runId: string
Returns Promise<boolean>
Inherited from DoRunTopology.startLiveness
- Defined in packages/flowsafe/src/host-kit/do-run-topology.ts:76

startPrincipal

startPrincipal(
workflowId: string,
runId: string,
): Promise<StartPrincipalReceipt | undefined>
Reads the authenticated run object's stored start authority.
Parameters
- workflowId: string
- runId: string
Returns Promise<StartPrincipalReceipt | undefined>
- Defined in packages/flowsafe/src/host-kit/do-run-topology.ts:101

status

status(workflowId: string, runId: string): Promise<RunSummary | undefined>
createRunRouter's status thunk (a DO 404 reads as undefined).
Parameters
- workflowId: string
- runId: string
Returns Promise<RunSummary | undefined>
Inherited from DoRunTopology.status
- Defined in packages/flowsafe/src/host-kit/do-run-topology.ts:70

terminate

terminate(
    workflowId: string,
    runId: string,
    principal: ExecutionPrincipal,
    replayOnly?: boolean,
): Promise<RunSummary>
Parameters
- workflowId: string
- runId: string
- principal: ExecutionPrincipal
- OptionalreplayOnly: boolean
Returns Promise<RunSummary>
- Defined in packages/flowsafe/src/host-kit/do-run-topology.ts:105

timeOut

timeOut(
    workflowId: string,
    runId: string,
    cas: RunLifecycleCas,
    principal: ExecutionPrincipal,
): Promise<RunSummary>
Parameters
- workflowId: string
- runId: string
- cas: RunLifecycleCas
- principal: ExecutionPrincipal
Returns Promise<RunSummary>
- Defined in packages/flowsafe/src/host-kit/do-run-topology.ts:111

Interface DoRunLifecycleTopology

Hierarchy (View Summary)

Index

Methods

Methods

dispatchStatus

Parameters

Returns Promise<RunSummary | undefined>

persistedStart

Parameters

Returns Promise<PersistedStartResult<RunSummary> | undefined>

resume

Parameters

Returns Promise<RunSummary>

resumeRecord

Parameters

Returns Promise<RunSummary>

start

Parameters

Returns Promise<RunSummary>

startLiveness

Parameters

Returns Promise<boolean>

startPrincipal

Parameters

Returns Promise<StartPrincipalReceipt | undefined>

status

Parameters

Returns Promise<RunSummary | undefined>

terminate

Parameters

Returns Promise<RunSummary>

timeOut

Parameters

Returns Promise<RunSummary>

Settings

On This Page