Anchorage API reference
Documentation
GitHub
Preparing search index...
@proofoftech/flowsafe
index
RemoteStepJournal
Class RemoteStepJournal
Index
Constructors
constructor
Accessors
deployment
Id
table
Prefix
Methods
admit
Notification
Effect
admit
Notification
Resume
claim
Resume
claim
Workflow
Resume
consume
Permit
get
get
Workflow
initialize
issue
Permit
next
Notification
Recovery
Batch
notification
Storage
prepare
Notification
Operation
read
Dispatch
Request
Json
read
Notification
Operation
read
Retained
Result
read
Workflow
Dispatch
Request
Json
reconcile
Result
record
Notification
Receipt
record
Result
recoverable
Results
register
register
Workflow
settle
After
Resume
settle
Workflow
After
Resume
Constructors
constructor
new
RemoteStepJournal
(
input
:
{
allowedToolIds
:
readonly
string
[]
;
db
:
ExecutionFenceDatabase
;
deploymentId
:
string
;
fence
:
ExecutionFenceStore
;
now
?:
()
=>
number
;
runtime
:
Pick
<
RunnerRuntime
,
"authoritativeStatus"
|
"authoritativeStartState"
,
>
;
tablePrefix
:
string
;
verifyCompletion
:
(
input
:
{
evidenceJson
:
string
;
invocation
:
RemoteStepInvocation
;
rawPermit
:
string
;
resultJson
:
string
;
}
,
)
=>
Promise
<
void
>
;
verifyWorkflowCompletion
?:
(
input
:
{
evidenceJson
:
string
;
invocation
:
WorkflowRemoteStepInvocation
;
rawPermit
:
string
;
resultJson
:
string
;
}
,
)
=>
Promise
<
void
>
;
}
,
)
:
RemoteStepJournal
Parameters
input
:
{
allowedToolIds
:
readonly
string
[]
;
db
:
ExecutionFenceDatabase
;
deploymentId
:
string
;
fence
:
ExecutionFenceStore
;
now
?:
()
=>
number
;
runtime
:
Pick
<
RunnerRuntime
,
"authoritativeStatus"
|
"authoritativeStartState"
,
>
;
tablePrefix
:
string
;
verifyCompletion
:
(
input
:
{
evidenceJson
:
string
;
invocation
:
RemoteStepInvocation
;
rawPermit
:
string
;
resultJson
:
string
;
}
,
)
=>
Promise
<
void
>
;
verifyWorkflowCompletion
?:
(
input
:
{
evidenceJson
:
string
;
invocation
:
WorkflowRemoteStepInvocation
;
rawPermit
:
string
;
resultJson
:
string
;
}
,
)
=>
Promise
<
void
>
;
}
Returns
RemoteStepJournal
Accessors
deployment
Id
get
deploymentId
()
:
string
Returns
string
table
Prefix
get
tablePrefix
()
:
string
Returns
string
Methods
admit
Notification
Effect
admitNotificationEffect
(
invocationId
:
string
,
)
:
Promise
<
RemoteStepNotificationOperation
>
Parameters
invocationId
:
string
Returns
Promise
<
RemoteStepNotificationOperation
>
admit
Notification
Resume
admitNotificationResume
(
invocationId
:
string
)
:
Promise
<
string
>
Parameters
invocationId
:
string
Returns
Promise
<
string
>
claim
Resume
claimResume
(
invocationId
:
string
,
leaseMs
:
number
)
:
Promise
<
string
>
Parameters
invocationId
:
string
leaseMs
:
number
Returns
Promise
<
string
>
claim
Workflow
Resume
claimWorkflowResume
(
invocationId
:
string
,
leaseMs
:
number
,
expectedMutationEpoch
?:
number
,
)
:
Promise
<
string
>
Parameters
invocationId
:
string
leaseMs
:
number
Optional
expectedMutationEpoch
:
number
Returns
Promise
<
string
>
consume
Permit
consumePermit
(
permit
:
RemoteStepPermit
,
)
:
Promise
<
{
kind
:
"accepted"
;
rawPermit
:
string
}
|
{
kind
:
"already-consumed"
}
,
>
Parameters
permit
:
RemoteStepPermit
Returns
Promise
<
{
kind
:
"accepted"
;
rawPermit
:
string
}
|
{
kind
:
"already-consumed"
}
>
get
get
(
invocationId
:
string
)
:
Promise
<
RemoteStepInvocation
|
undefined
>
Parameters
invocationId
:
string
Returns
Promise
<
RemoteStepInvocation
|
undefined
>
get
Workflow
getWorkflow
(
invocationId
:
string
,
)
:
Promise
<
WorkflowRemoteStepInvocation
|
undefined
>
Parameters
invocationId
:
string
Returns
Promise
<
WorkflowRemoteStepInvocation
|
undefined
>
initialize
initialize
()
:
Promise
<
void
>
Returns
Promise
<
void
>
issue
Permit
issuePermit
(
invocationId
:
string
,
lifetimeMs
:
number
)
:
Promise
<
RemoteStepPermit
>
Parameters
invocationId
:
string
lifetimeMs
:
number
Returns
Promise
<
RemoteStepPermit
>
next
Notification
Recovery
Batch
nextNotificationRecoveryBatch
(
limit
:
number
)
:
Promise
<
string
[]
>
Parameters
limit
:
number
Returns
Promise
<
string
[]
>
notification
Storage
notificationStorage
(
operationReceiptLimit
?:
number
)
:
D1NotificationsStorage
Parameters
operationReceiptLimit
:
number
= DEFAULT_NOTIFICATION_OPERATION_RECEIPT_LIMIT
Returns
D1NotificationsStorage
prepare
Notification
Operation
prepareNotificationOperation
(
invocationId
:
string
,
operationId
:
string
,
input
:
Omit
<
NotificationOperationInput
,
"id"
>
,
)
:
Promise
<
RemoteStepNotificationOperation
>
Parameters
invocationId
:
string
operationId
:
string
input
:
Omit
<
NotificationOperationInput
,
"id"
>
Returns
Promise
<
RemoteStepNotificationOperation
>
read
Dispatch
Request
Json
readDispatchRequestJson
(
invocationId
:
string
)
:
Promise
<
string
>
Parameters
invocationId
:
string
Returns
Promise
<
string
>
read
Notification
Operation
readNotificationOperation
(
invocationId
:
string
,
)
:
Promise
<
RemoteStepNotificationOperation
|
undefined
>
Parameters
invocationId
:
string
Returns
Promise
<
RemoteStepNotificationOperation
|
undefined
>
read
Retained
Result
readRetainedResult
(
invocationId
:
string
,
)
:
Promise
<
RecordedRemoteStepResult
|
undefined
>
Parameters
invocationId
:
string
Returns
Promise
<
RecordedRemoteStepResult
|
undefined
>
read
Workflow
Dispatch
Request
Json
readWorkflowDispatchRequestJson
(
invocationId
:
string
)
:
Promise
<
string
>
Parameters
invocationId
:
string
Returns
Promise
<
string
>
reconcile
Result
reconcileResult
(
invocationId
:
string
,
)
:
Promise
<
|
"retry"
|
"applied"
|
"terminal-not-success"
|
"deadline-expired"
|
"advanced-without-proof"
|
"pending-quiescence"
,
>
Parameters
invocationId
:
string
Returns
Promise
<
|
"retry"
|
"applied"
|
"terminal-not-success"
|
"deadline-expired"
|
"advanced-without-proof"
|
"pending-quiescence"
,
>
record
Notification
Receipt
recordNotificationReceipt
(
invocationId
:
string
,
receipt
:
{
notificationId
:
string
;
operationKey
:
string
;
requestDigest
:
string
;
threadId
:
string
;
}
,
)
:
Promise
<
RemoteStepNotificationOperation
>
Parameters
invocationId
:
string
receipt
:
{
notificationId
:
string
;
operationKey
:
string
;
requestDigest
:
string
;
threadId
:
string
;
}
Returns
Promise
<
RemoteStepNotificationOperation
>
record
Result
recordResult
(
invocationId
:
string
,
rawPermit
:
string
,
resultJson
:
string
,
evidenceJson
:
string
,
)
:
Promise
<
|
{
kind
:
"recorded"
;
resultDigest
:
string
;
resultJson
:
string
}
|
{
kind
:
"replay"
;
resultDigest
:
string
;
resultJson
:
string
}
,
>
Parameters
invocationId
:
string
rawPermit
:
string
resultJson
:
string
evidenceJson
:
string
Returns
Promise
<
|
{
kind
:
"recorded"
;
resultDigest
:
string
;
resultJson
:
string
}
|
{
kind
:
"replay"
;
resultDigest
:
string
;
resultJson
:
string
}
,
>
recoverable
Results
recoverableResults
(
limit
:
number
,
afterInvocationId
?:
string
,
)
:
Promise
<
{
invocationIds
:
string
[]
;
nextCursor
?:
string
}
>
Parameters
limit
:
number
afterInvocationId
:
string
= ''
Returns
Promise
<
{
invocationIds
:
string
[]
;
nextCursor
?:
string
}
>
register
register
(
address
:
RemoteStepAddress
,
hostDeadlineAt
:
number
,
originalPrincipal
:
ExecutionPrincipal
,
)
:
Promise
<
RemoteStepInvocation
>
Parameters
address
:
RemoteStepAddress
hostDeadlineAt
:
number
originalPrincipal
:
ExecutionPrincipal
Returns
Promise
<
RemoteStepInvocation
>
register
Workflow
registerWorkflow
(
address
:
WorkflowRemoteStepAddress
,
hostDeadlineAt
:
number
,
originalPrincipal
:
ExecutionPrincipal
,
)
:
Promise
<
WorkflowRemoteStepInvocation
>
Parameters
address
:
WorkflowRemoteStepAddress
hostDeadlineAt
:
number
originalPrincipal
:
ExecutionPrincipal
Returns
Promise
<
WorkflowRemoteStepInvocation
>
settle
After
Resume
settleAfterResume
(
invocationId
:
string
,
leaseOwner
:
string
,
witnessed
?:
RunSummary
,
)
:
Promise
<
|
"retry"
|
"applied"
|
"terminal-not-success"
|
"deadline-expired"
|
"advanced-without-proof"
,
>
Parameters
invocationId
:
string
leaseOwner
:
string
Optional
witnessed
:
RunSummary
Returns
Promise
<
|
"retry"
|
"applied"
|
"terminal-not-success"
|
"deadline-expired"
|
"advanced-without-proof"
,
>
settle
Workflow
After
Resume
settleWorkflowAfterResume
(
invocationId
:
string
,
leaseOwner
:
string
,
witnessed
:
RunSummary
,
)
:
Promise
<
"applied"
|
"terminal-not-success"
|
"unresolved"
>
Parameters
invocationId
:
string
leaseOwner
:
string
witnessed
:
RunSummary
Returns
Promise
<
"applied"
|
"terminal-not-success"
|
"unresolved"
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Accessors
deployment
Id
table
Prefix
Methods
admit
Notification
Effect
admit
Notification
Resume
claim
Resume
claim
Workflow
Resume
consume
Permit
get
get
Workflow
initialize
issue
Permit
next
Notification
Recovery
Batch
notification
Storage
prepare
Notification
Operation
read
Dispatch
Request
Json
read
Notification
Operation
read
Retained
Result
read
Workflow
Dispatch
Request
Json
reconcile
Result
record
Notification
Receipt
record
Result
recoverable
Results
register
register
Workflow
settle
After
Resume
settle
Workflow
After
Resume
Documentation
GitHub
Anchorage API reference
Loading...