@ferricstore/ferricstore 0.12.2 → 0.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (98) hide show
  1. package/README.md +2 -2
  2. package/dist/index.cjs +591 -133
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +61 -7
  5. package/dist/index.d.ts +61 -7
  6. package/dist/index.js +586 -129
  7. package/dist/index.js.map +1 -1
  8. package/dist/langgraph.cjs.map +1 -1
  9. package/dist/langgraph.d.cts +1 -1
  10. package/dist/langgraph.d.ts +1 -1
  11. package/dist/langgraph.js.map +1 -1
  12. package/dist/{outcomes-DmBwnq0Y.d.cts → outcomes-CcX956h4.d.cts} +20 -1
  13. package/dist/{outcomes-BbFDp3AH.d.ts → outcomes-DLJYTrX8.d.ts} +20 -1
  14. package/docs/api/assets/hierarchy.js +1 -1
  15. package/docs/api/assets/navigation.js +1 -1
  16. package/docs/api/assets/search.js +1 -1
  17. package/docs/api/classes/ConnectionClosedError.html +1 -1
  18. package/docs/api/classes/FerricStoreClient.html +68 -23
  19. package/docs/api/classes/FerricStoreError.html +1 -1
  20. package/docs/api/classes/FlowAlreadyExistsError.html +1 -1
  21. package/docs/api/classes/FlowBatchError.html +1 -1
  22. package/docs/api/classes/FlowNotFoundError.html +1 -1
  23. package/docs/api/classes/FlowQueryError.html +1 -1
  24. package/docs/api/classes/FlowWrongStateError.html +1 -1
  25. package/docs/api/classes/HTTPTransportError.html +1 -1
  26. package/docs/api/classes/InvalidCommandError.html +1 -1
  27. package/docs/api/classes/LeaseRenewalError.html +3 -3
  28. package/docs/api/classes/LockHeldError.html +1 -1
  29. package/docs/api/classes/LockNotOwnedError.html +1 -1
  30. package/docs/api/classes/OverloadedError.html +1 -1
  31. package/docs/api/classes/QueueCompletionError.html +1 -1
  32. package/docs/api/classes/RequestTimeoutError.html +1 -1
  33. package/docs/api/classes/RerouteError.html +1 -1
  34. package/docs/api/classes/StaleLeaseError.html +1 -1
  35. package/docs/api/classes/StalePolicyGenerationError.html +1 -1
  36. package/docs/api/classes/Workflow.html +19 -19
  37. package/docs/api/classes/WorkflowClient.html +4 -4
  38. package/docs/api/classes/WorkflowContext.html +74 -36
  39. package/docs/api/classes/WorkflowFlowCommands.html +26 -22
  40. package/docs/api/classes/WorkflowWorker.html +6 -6
  41. package/docs/api/functions/complete.html +1 -1
  42. package/docs/api/functions/fail.html +1 -1
  43. package/docs/api/functions/isAlreadyAppliedOutcome.html +41 -0
  44. package/docs/api/functions/isOutcome.html +1 -1
  45. package/docs/api/functions/retry.html +1 -1
  46. package/docs/api/functions/transition.html +1 -1
  47. package/docs/api/hierarchy.html +55 -47
  48. package/docs/api/index.html +2 -2
  49. package/docs/api/interfaces/AdminListOptions.html +1 -1
  50. package/docs/api/interfaces/AdvanceOptions.html +141 -0
  51. package/docs/api/interfaces/AlreadyAppliedOutcome.html +69 -0
  52. package/docs/api/interfaces/AppliedStepOutcome.html +87 -0
  53. package/docs/api/interfaces/CancelOptions.html +6 -6
  54. package/docs/api/interfaces/CompleteOptions.html +4 -4
  55. package/docs/api/interfaces/CompleteOutcome.html +13 -13
  56. package/docs/api/interfaces/CreateManyOptions.html +1 -1
  57. package/docs/api/interfaces/EffectCompensateOptions.html +1 -1
  58. package/docs/api/interfaces/EffectConfirmOptions.html +1 -1
  59. package/docs/api/interfaces/EffectFailOptions.html +1 -1
  60. package/docs/api/interfaces/EffectStatusOptions.html +1 -1
  61. package/docs/api/interfaces/FailOptions.html +4 -4
  62. package/docs/api/interfaces/FailOutcome.html +13 -13
  63. package/docs/api/interfaces/FerricStoreClientFromUrlOptions.html +1 -1
  64. package/docs/api/interfaces/FerricStoreClientOptions.html +1 -1
  65. package/docs/api/interfaces/FlowQueryCountResult.html +1 -1
  66. package/docs/api/interfaces/FlowQueryIndexBuild.html +1 -1
  67. package/docs/api/interfaces/FlowQueryIndexProgress.html +1 -1
  68. package/docs/api/interfaces/FlowQueryIndexValidation.html +1 -1
  69. package/docs/api/interfaces/FlowQueryRecordsResult.html +1 -1
  70. package/docs/api/interfaces/HistoryOptions.html +16 -16
  71. package/docs/api/interfaces/InvocationCreateOptions.html +1 -1
  72. package/docs/api/interfaces/LeaseMutationOptions.html +1 -1
  73. package/docs/api/interfaces/LimitListOptions.html +1 -1
  74. package/docs/api/interfaces/MutateOptions.html +1 -1
  75. package/docs/api/interfaces/NamedValueMutation.html +9 -9
  76. package/docs/api/interfaces/ReadOptions.html +12 -12
  77. package/docs/api/interfaces/ReclaimOptions.html +1 -1
  78. package/docs/api/interfaces/ReplayedStepResult.html +73 -0
  79. package/docs/api/interfaces/RequestContextOptions.html +1 -1
  80. package/docs/api/interfaces/RetryOptions.html +4 -4
  81. package/docs/api/interfaces/RetryOutcome.html +13 -13
  82. package/docs/api/interfaces/RunStepsItem.html +3 -3
  83. package/docs/api/interfaces/RunStepsManyOptions.html +11 -11
  84. package/docs/api/interfaces/SearchOptions.html +13 -13
  85. package/docs/api/interfaces/StepContinueOptions.html +1 -1
  86. package/docs/api/interfaces/StepOptions.html +159 -0
  87. package/docs/api/interfaces/StepResult.html +67 -0
  88. package/docs/api/interfaces/TDigestCreateOptions.html +1 -1
  89. package/docs/api/interfaces/TDigestMergeOptions.html +1 -1
  90. package/docs/api/interfaces/TransitionOptions.html +1 -1
  91. package/docs/api/interfaces/TransitionOutcome.html +14 -14
  92. package/docs/api/modules.html +6 -6
  93. package/docs/api/types/ConnectionRequestDisposition.html +1 -1
  94. package/docs/api/types/ManagementPairs.html +1 -1
  95. package/docs/api/types/Outcome.html +1 -1
  96. package/docs/api/types/SearchStateMeta.html +1 -1
  97. package/docs/api/types/WorkflowStepResult.html +38 -0
  98. package/package.json +1 -1
package/docs/api/classes/WorkflowContext.html CHANGED
@@ -11,7 +11,7 @@
11
11
  <li><a href="" aria-current="page">WorkflowContext</a></li></ul>
12
12
  <h1>Class WorkflowContext</h1></div><aside class="tsd-sources">
13
13
  <ul>
14
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L9">src/workflow-context.ts:9</a></li></ul></aside>
14
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L35">src/workflow-context.ts:35</a></li></ul></aside>
15
15
  <section class="tsd-panel-group tsd-index-group">
16
16
  <section class="tsd-panel tsd-index-panel">
17
17
  <details class="tsd-index-content tsd-accordion" open><summary class="tsd-accordion-summary tsd-index-summary"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
@@ -25,7 +25,6 @@
25
25
  <h3 class="tsd-index-heading tsd-anchor-link" id="properties">Properties<a href="#properties" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
26
26
  <div class="tsd-index-list"><a href="#flow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>flow</span></a>
27
27
  <a href="#job" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>job</span></a>
28
- <a href="#statename" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state<wbr/>Name</span></a>
29
28
  <a href="#workflow" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow</span></a>
30
29
  </div></section>
31
30
  <section class="tsd-index-section">
@@ -43,6 +42,7 @@
43
42
  <a href="#rootflowid" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>root<wbr/>Flow<wbr/>Id</span></a>
44
43
  <a href="#state" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>state</span></a>
45
44
  <a href="#statemeta" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>state<wbr/>Meta</span></a>
45
+ <a href="#statename" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>state<wbr/>Name</span></a>
46
46
  <a href="#type" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>type</span></a>
47
47
  <a href="#valuerefs" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>value<wbr/>Refs</span></a>
48
48
  <a href="#values" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>values</span></a>
@@ -50,7 +50,9 @@
50
50
  </div></section>
51
51
  <section class="tsd-index-section">
52
52
  <h3 class="tsd-index-heading tsd-anchor-link" id="methods">Methods<a href="#methods" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
53
- <div class="tsd-index-list"><a href="#value" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>value</span></a>
53
+ <div class="tsd-index-list"><a href="#advance" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>advance</span></a>
54
+ <a href="#step" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>step</span></a>
55
+ <a href="#value" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>value</span></a>
54
56
  <a href="#valuemany" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>value<wbr/>Many</span></a>
55
57
  </div></section></div></details></section></section>
56
58
  <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
@@ -60,7 +62,7 @@
60
62
  <h3 class="tsd-anchor-link" id="constructor"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
61
63
  <ul class="tsd-signatures">
62
64
  <li class="">
63
- <div class="tsd-signature tsd-anchor-link" id="constructorworkflowcontext"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">WorkflowContext</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">workflow</span><span class="tsd-signature-symbol">:</span> <a href="Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">job</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/FlowRecord.html" class="tsd-signature-type tsd-kind-interface">FlowRecord</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">stateName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">leaseJob</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">WorkflowContext</a><a href="#constructorworkflowcontext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
65
+ <div class="tsd-signature tsd-anchor-link" id="constructorworkflowcontext"><span class="tsd-signature-keyword">new</span> <span class="tsd-kind-constructor-signature">WorkflowContext</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">workflow</span><span class="tsd-signature-symbol">:</span> <a href="Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">job</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/FlowRecord.html" class="tsd-signature-type tsd-kind-interface">FlowRecord</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">stateName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">leaseJob</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">mutationCoordinator</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">WorkflowMutationCoordinator</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <a href="" class="tsd-signature-type tsd-kind-class">WorkflowContext</a><a href="#constructorworkflowcontext" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
64
66
  <div class="tsd-description">
65
67
  <div class="tsd-parameters">
66
68
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -68,10 +70,11 @@
68
70
  <li><span><span class="tsd-kind-parameter">workflow</span>: <a href="Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a></span></li>
69
71
  <li><span><span class="tsd-kind-parameter">job</span>: <a href="../interfaces/FlowRecord.html" class="tsd-signature-type tsd-kind-interface">FlowRecord</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></span></li>
70
72
  <li><span><span class="tsd-kind-parameter">stateName</span>: <span class="tsd-signature-type">string</span></span></li>
71
- <li><span><span class="tsd-kind-parameter">leaseJob</span>: <a href="../interfaces/ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a><span class="tsd-signature-symbol"> = job</span></span></li></ul></div>
73
+ <li><span><span class="tsd-kind-parameter">leaseJob</span>: <a href="../interfaces/ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a><span class="tsd-signature-symbol"> = job</span></span></li>
74
+ <li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">mutationCoordinator</span>: <span class="tsd-signature-type">WorkflowMutationCoordinator</span></span></li></ul></div>
72
75
  <h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">WorkflowContext</a></h4><aside class="tsd-sources">
73
76
  <ul>
74
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L17">src/workflow-context.ts:17</a></li></ul></aside></div></li></ul></section></section></details>
77
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L46">src/workflow-context.ts:46</a></li></ul></aside></div></li></ul></section></section></details>
75
78
  <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
76
79
  <h2 class="tsd-anchor-link" id="properties-1">Properties<a href="#properties-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
77
80
  <section>
@@ -79,22 +82,17 @@
79
82
  <h3 class="tsd-anchor-link" id="flow"><code class="tsd-tag">Readonly</code><span>flow</span><a href="#flow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
80
83
  <div class="tsd-signature"><span class="tsd-kind-property">flow</span><span class="tsd-signature-symbol">:</span> <a href="WorkflowFlowCommands.html" class="tsd-signature-type tsd-kind-class">WorkflowFlowCommands</a></div><aside class="tsd-sources">
81
84
  <ul>
82
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L13">src/workflow-context.ts:13</a></li></ul></aside></section>
85
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L38">src/workflow-context.ts:38</a></li></ul></aside></section>
83
86
  <section class="tsd-panel tsd-member">
84
87
  <h3 class="tsd-anchor-link" id="job"><code class="tsd-tag">Readonly</code><span>job</span><a href="#job" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
85
88
  <div class="tsd-signature"><span class="tsd-kind-property">job</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/FlowRecord.html" class="tsd-signature-type tsd-kind-interface">FlowRecord</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/ClaimedItem.html" class="tsd-signature-type tsd-kind-interface">ClaimedItem</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></div><aside class="tsd-sources">
86
89
  <ul>
87
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L11">src/workflow-context.ts:11</a></li></ul></aside></section>
88
- <section class="tsd-panel tsd-member">
89
- <h3 class="tsd-anchor-link" id="statename"><code class="tsd-tag">Readonly</code><span>state<wbr/>Name</span><a href="#statename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
90
- <div class="tsd-signature"><span class="tsd-kind-property">stateName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div><aside class="tsd-sources">
91
- <ul>
92
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L12">src/workflow-context.ts:12</a></li></ul></aside></section>
90
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L37">src/workflow-context.ts:37</a></li></ul></aside></section>
93
91
  <section class="tsd-panel tsd-member">
94
92
  <h3 class="tsd-anchor-link" id="workflow"><code class="tsd-tag">Readonly</code><span>workflow</span><a href="#workflow" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
95
93
  <div class="tsd-signature"><span class="tsd-kind-property">workflow</span><span class="tsd-signature-symbol">:</span> <a href="Workflow.html" class="tsd-signature-type tsd-kind-class">Workflow</a></div><aside class="tsd-sources">
96
94
  <ul>
97
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L10">src/workflow-context.ts:10</a></li></ul></aside></section></section></details>
95
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L36">src/workflow-context.ts:36</a></li></ul></aside></section></section></details>
98
96
  <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
99
97
  <h2 class="tsd-anchor-link" id="accessors-1">Accessors<a href="#accessors-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
100
98
  <section>
@@ -106,7 +104,7 @@
106
104
  <div class="tsd-description">
107
105
  <h4 class="tsd-returns-title">Returns <a href="FerricStoreClient.html" class="tsd-signature-type tsd-kind-class">FerricStoreClient</a></h4><aside class="tsd-sources">
108
106
  <ul>
109
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L30">src/workflow-context.ts:30</a></li></ul></aside></div></li></ul></section>
107
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L60">src/workflow-context.ts:60</a></li></ul></aside></div></li></ul></section>
110
108
  <section class="tsd-panel tsd-member">
111
109
  <h3 class="tsd-anchor-link" id="correlationid"><span>correlation<wbr/>Id</span><a href="#correlationid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
112
110
  <ul class="tsd-signatures">
@@ -115,7 +113,7 @@
115
113
  <div class="tsd-description">
116
114
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources">
117
115
  <ul>
118
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L94">src/workflow-context.ts:94</a></li></ul></aside></div></li></ul></section>
116
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L128">src/workflow-context.ts:128</a></li></ul></aside></div></li></ul></section>
119
117
  <section class="tsd-panel tsd-member">
120
118
  <h3 class="tsd-anchor-link" id="fencingtoken"><span>fencing<wbr/>Token</span><a href="#fencingtoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
121
119
  <ul class="tsd-signatures">
@@ -124,7 +122,7 @@
124
122
  <div class="tsd-description">
125
123
  <h4 class="tsd-returns-title">Returns <a href="../types/FencingToken.html" class="tsd-signature-type tsd-kind-type-alias">FencingToken</a></h4><aside class="tsd-sources">
126
124
  <ul>
127
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L78">src/workflow-context.ts:78</a></li></ul></aside></div></li></ul></section>
125
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L112">src/workflow-context.ts:112</a></li></ul></aside></div></li></ul></section>
128
126
  <section class="tsd-panel tsd-member">
129
127
  <h3 class="tsd-anchor-link" id="id"><span>id</span><a href="#id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
130
128
  <ul class="tsd-signatures">
@@ -133,7 +131,7 @@
133
131
  <div class="tsd-description">
134
132
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
135
133
  <ul>
136
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L34">src/workflow-context.ts:34</a></li></ul></aside></div></li></ul></section>
134
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L68">src/workflow-context.ts:68</a></li></ul></aside></div></li></ul></section>
137
135
  <section class="tsd-panel tsd-member">
138
136
  <h3 class="tsd-anchor-link" id="indexedstatemeta"><span>indexed<wbr/>State<wbr/>Meta</span><a href="#indexedstatemeta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
139
137
  <ul class="tsd-signatures">
@@ -142,7 +140,7 @@
142
140
  <div class="tsd-description">
143
141
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources">
144
142
  <ul>
145
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L66">src/workflow-context.ts:66</a></li></ul></aside></div></li></ul></section>
143
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L100">src/workflow-context.ts:100</a></li></ul></aside></div></li></ul></section>
146
144
  <section class="tsd-panel tsd-member">
147
145
  <h3 class="tsd-anchor-link" id="leasetoken"><span>lease<wbr/>Token</span><a href="#leasetoken" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
148
146
  <ul class="tsd-signatures">
@@ -151,7 +149,7 @@
151
149
  <div class="tsd-description">
152
150
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4><aside class="tsd-sources">
153
151
  <ul>
154
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L74">src/workflow-context.ts:74</a></li></ul></aside></div></li></ul></section>
152
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L108">src/workflow-context.ts:108</a></li></ul></aside></div></li></ul></section>
155
153
  <section class="tsd-panel tsd-member">
156
154
  <h3 class="tsd-anchor-link" id="logicalstate"><span>logical<wbr/>State</span><a href="#logicalstate" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
157
155
  <ul class="tsd-signatures">
@@ -160,7 +158,7 @@
160
158
  <div class="tsd-description">
161
159
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
162
160
  <ul>
163
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L46">src/workflow-context.ts:46</a></li></ul></aside></div></li></ul></section>
161
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L80">src/workflow-context.ts:80</a></li></ul></aside></div></li></ul></section>
164
162
  <section class="tsd-panel tsd-member">
165
163
  <h3 class="tsd-anchor-link" id="parentflowid"><span>parent<wbr/>Flow<wbr/>Id</span><a href="#parentflowid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
166
164
  <ul class="tsd-signatures">
@@ -169,7 +167,7 @@
169
167
  <div class="tsd-description">
170
168
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources">
171
169
  <ul>
172
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L86">src/workflow-context.ts:86</a></li></ul></aside></div></li></ul></section>
170
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L120">src/workflow-context.ts:120</a></li></ul></aside></div></li></ul></section>
173
171
  <section class="tsd-panel tsd-member">
174
172
  <h3 class="tsd-anchor-link" id="partitionkey"><span>partition<wbr/>Key</span><a href="#partitionkey" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
175
173
  <ul class="tsd-signatures">
@@ -178,7 +176,7 @@
178
176
  <div class="tsd-description">
179
177
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources">
180
178
  <ul>
181
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L50">src/workflow-context.ts:50</a></li></ul></aside></div></li></ul></section>
179
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L84">src/workflow-context.ts:84</a></li></ul></aside></div></li></ul></section>
182
180
  <section class="tsd-panel tsd-member">
183
181
  <h3 class="tsd-anchor-link" id="payload"><span>payload</span><a href="#payload" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
184
182
  <ul class="tsd-signatures">
@@ -187,7 +185,7 @@
187
185
  <div class="tsd-description">
188
186
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4><aside class="tsd-sources">
189
187
  <ul>
190
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L54">src/workflow-context.ts:54</a></li></ul></aside></div></li></ul></section>
188
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L88">src/workflow-context.ts:88</a></li></ul></aside></div></li></ul></section>
191
189
  <section class="tsd-panel tsd-member">
192
190
  <h3 class="tsd-anchor-link" id="rootflowid"><span>root<wbr/>Flow<wbr/>Id</span><a href="#rootflowid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
193
191
  <ul class="tsd-signatures">
@@ -196,7 +194,7 @@
196
194
  <div class="tsd-description">
197
195
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">undefined</span></h4><aside class="tsd-sources">
198
196
  <ul>
199
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L90">src/workflow-context.ts:90</a></li></ul></aside></div></li></ul></section>
197
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L124">src/workflow-context.ts:124</a></li></ul></aside></div></li></ul></section>
200
198
  <section class="tsd-panel tsd-member">
201
199
  <h3 class="tsd-anchor-link" id="state"><span>state</span><a href="#state" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
202
200
  <ul class="tsd-signatures">
@@ -205,7 +203,7 @@
205
203
  <div class="tsd-description">
206
204
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
207
205
  <ul>
208
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L42">src/workflow-context.ts:42</a></li></ul></aside></div></li></ul></section>
206
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L76">src/workflow-context.ts:76</a></li></ul></aside></div></li></ul></section>
209
207
  <section class="tsd-panel tsd-member">
210
208
  <h3 class="tsd-anchor-link" id="statemeta"><span>state<wbr/>Meta</span><a href="#statemeta" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
211
209
  <ul class="tsd-signatures">
@@ -214,7 +212,16 @@
214
212
  <div class="tsd-description">
215
213
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
216
214
  <ul>
217
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L62">src/workflow-context.ts:62</a></li></ul></aside></div></li></ul></section>
215
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L96">src/workflow-context.ts:96</a></li></ul></aside></div></li></ul></section>
216
+ <section class="tsd-panel tsd-member">
217
+ <h3 class="tsd-anchor-link" id="statename"><span>state<wbr/>Name</span><a href="#statename" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
218
+ <ul class="tsd-signatures">
219
+ <li>
220
+ <div class="tsd-signature" id="statenamestatename"><span class="tsd-signature-keyword">get</span> <span class="tsd-kind-get-signature">stateName</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
221
+ <div class="tsd-description">
222
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
223
+ <ul>
224
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L64">src/workflow-context.ts:64</a></li></ul></aside></div></li></ul></section>
218
225
  <section class="tsd-panel tsd-member">
219
226
  <h3 class="tsd-anchor-link" id="type"><span>type</span><a href="#type" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
220
227
  <ul class="tsd-signatures">
@@ -223,7 +230,7 @@
223
230
  <div class="tsd-description">
224
231
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
225
232
  <ul>
226
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L38">src/workflow-context.ts:38</a></li></ul></aside></div></li></ul></section>
233
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L72">src/workflow-context.ts:72</a></li></ul></aside></div></li></ul></section>
227
234
  <section class="tsd-panel tsd-member">
228
235
  <h3 class="tsd-anchor-link" id="valuerefs"><span>value<wbr/>Refs</span><a href="#valuerefs" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
229
236
  <ul class="tsd-signatures">
@@ -232,7 +239,7 @@
232
239
  <div class="tsd-description">
233
240
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
234
241
  <ul>
235
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L70">src/workflow-context.ts:70</a></li></ul></aside></div></li></ul></section>
242
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L104">src/workflow-context.ts:104</a></li></ul></aside></div></li></ul></section>
236
243
  <section class="tsd-panel tsd-member">
237
244
  <h3 class="tsd-anchor-link" id="values"><span>values</span><a href="#values" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
238
245
  <ul class="tsd-signatures">
@@ -241,7 +248,7 @@
241
248
  <div class="tsd-description">
242
249
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
243
250
  <ul>
244
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L58">src/workflow-context.ts:58</a></li></ul></aside></div></li></ul></section>
251
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L92">src/workflow-context.ts:92</a></li></ul></aside></div></li></ul></section>
245
252
  <section class="tsd-panel tsd-member">
246
253
  <h3 class="tsd-anchor-link" id="version"><span>version</span><a href="#version" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
247
254
  <ul class="tsd-signatures">
@@ -250,11 +257,42 @@
250
257
  <div class="tsd-description">
251
258
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
252
259
  <ul>
253
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L82">src/workflow-context.ts:82</a></li></ul></aside></div></li></ul></section></section></details>
260
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L116">src/workflow-context.ts:116</a></li></ul></aside></div></li></ul></section></section></details>
254
261
  <details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>
255
262
  <h2 class="tsd-anchor-link" id="methods-1">Methods<a href="#methods-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h2></summary>
256
263
  <section>
257
264
  <section class="tsd-panel tsd-member">
265
+ <h3 class="tsd-anchor-link" id="advance"><span>advance</span><a href="#advance" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
266
+ <ul class="tsd-signatures">
267
+ <li class="">
268
+ <div class="tsd-signature tsd-anchor-link" id="advance-1"><span class="tsd-kind-call-signature">advance</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">toState</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AdvanceOptions.html" class="tsd-signature-type tsd-kind-interface">AdvanceOptions</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;toState&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AlreadyAppliedOutcome.html" class="tsd-signature-type tsd-kind-interface">AlreadyAppliedOutcome</a><span class="tsd-signature-symbol">&gt;</span><a href="#advance-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
269
+ <div class="tsd-description">
270
+ <div class="tsd-parameters">
271
+ <h4 class="tsd-parameters-title">Parameters</h4>
272
+ <ul class="tsd-parameter-list">
273
+ <li><span><span class="tsd-kind-parameter">toState</span>: <span class="tsd-signature-type">string</span></span></li>
274
+ <li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">Omit</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AdvanceOptions.html" class="tsd-signature-type tsd-kind-interface">AdvanceOptions</a><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">&quot;toState&quot;</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div>
275
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/AlreadyAppliedOutcome.html" class="tsd-signature-type tsd-kind-interface">AlreadyAppliedOutcome</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
276
+ <ul>
277
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L132">src/workflow-context.ts:132</a></li></ul></aside></div></li></ul></section>
278
+ <section class="tsd-panel tsd-member">
279
+ <h3 class="tsd-anchor-link" id="step"><span>step</span><a href="#step" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
280
+ <ul class="tsd-signatures">
281
+ <li class="">
282
+ <div class="tsd-signature tsd-anchor-link" id="step-1"><span class="tsd-kind-call-signature">step</span><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#steptresult">TResult</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">(</span><br/>    <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/StepOptions.html" class="tsd-signature-type tsd-kind-interface">StepOptions</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#steptresult">TResult</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/WorkflowStepResult.html" class="tsd-signature-type tsd-kind-type-alias">WorkflowStepResult</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#steptresult">TResult</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span><a href="#step-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div>
283
+ <div class="tsd-description">
284
+ <section class="tsd-panel">
285
+ <h4>Type Parameters</h4>
286
+ <ul class="tsd-type-parameter-list">
287
+ <li><span id="steptresult"><span class="tsd-kind-type-parameter">TResult</span></span></li></ul></section>
288
+ <div class="tsd-parameters">
289
+ <h4 class="tsd-parameters-title">Parameters</h4>
290
+ <ul class="tsd-parameter-list">
291
+ <li><span><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/StepOptions.html" class="tsd-signature-type tsd-kind-interface">StepOptions</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#steptresult">TResult</a><span class="tsd-signature-symbol">&gt;</span></span></li></ul></div>
292
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../types/WorkflowStepResult.html" class="tsd-signature-type tsd-kind-type-alias">WorkflowStepResult</a><span class="tsd-signature-symbol">&lt;</span><a class="tsd-signature-type tsd-kind-type-parameter" href="#steptresult">TResult</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
293
+ <ul>
294
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L152">src/workflow-context.ts:152</a></li></ul></aside></div></li></ul></section>
295
+ <section class="tsd-panel tsd-member">
258
296
  <h3 class="tsd-anchor-link" id="value"><span>value</span><a href="#value" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
259
297
  <ul class="tsd-signatures">
260
298
  <li class="">
@@ -268,7 +306,7 @@
268
306
  <li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">localCache</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div>
269
307
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
270
308
  <ul>
271
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L98">src/workflow-context.ts:98</a></li></ul></aside></div></li></ul></section>
309
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L191">src/workflow-context.ts:191</a></li></ul></aside></div></li></ul></section>
272
310
  <section class="tsd-panel tsd-member">
273
311
  <h3 class="tsd-anchor-link" id="valuemany"><span>value<wbr/>Many</span><a href="#valuemany" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3>
274
312
  <ul class="tsd-signatures">
@@ -282,7 +320,7 @@
282
320
  <li><span><span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-symbol">{</span> <span class="tsd-kind-property">localCache</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol"> = {}</span></span></li></ul></div>
283
321
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
284
322
  <ul>
285
- <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L129">src/workflow-context.ts:129</a></li></ul></aside></div></li></ul></section></section></details></div>
323
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L222">src/workflow-context.ts:222</a></li></ul></aside></div></li></ul></section></section></details></div>
286
324
  <div class="col-sidebar">
287
325
  <div class="page-menu">
288
326
  <div class="tsd-navigation settings">
@@ -301,11 +339,11 @@
301
339
  <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Constructors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Constructors</summary>
302
340
  <div><a href="#constructor"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Constructor"><use href="../assets/icons.svg#icon-512"></use></svg><span>constructor</span></a></div></details>
303
341
  <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Properties</summary>
304
- <div><a href="#flow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>flow</span></a><a href="#job"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>job</span></a><a href="#statename"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>state<wbr/>Name</span></a><a href="#workflow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow</span></a></div></details>
342
+ <div><a href="#flow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>flow</span></a><a href="#job"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>job</span></a><a href="#workflow"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>workflow</span></a></div></details>
305
343
  <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Accessors"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Accessors</summary>
306
- <div><a href="#client"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>client</span></a><a href="#correlationid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>correlation<wbr/>Id</span></a><a href="#fencingtoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>fencing<wbr/>Token</span></a><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>id</span></a><a href="#indexedstatemeta"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>indexed<wbr/>State<wbr/>Meta</span></a><a href="#leasetoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>lease<wbr/>Token</span></a><a href="#logicalstate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>logical<wbr/>State</span></a><a href="#parentflowid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>parent<wbr/>Flow<wbr/>Id</span></a><a href="#partitionkey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>partition<wbr/>Key</span></a><a href="#payload"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>payload</span></a><a href="#rootflowid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>root<wbr/>Flow<wbr/>Id</span></a><a href="#state"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>state</span></a><a href="#statemeta"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>state<wbr/>Meta</span></a><a href="#type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>type</span></a><a href="#valuerefs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>value<wbr/>Refs</span></a><a href="#values"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>values</span></a><a href="#version"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>version</span></a></div></details>
344
+ <div><a href="#client"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>client</span></a><a href="#correlationid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>correlation<wbr/>Id</span></a><a href="#fencingtoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>fencing<wbr/>Token</span></a><a href="#id"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>id</span></a><a href="#indexedstatemeta"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>indexed<wbr/>State<wbr/>Meta</span></a><a href="#leasetoken"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>lease<wbr/>Token</span></a><a href="#logicalstate"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>logical<wbr/>State</span></a><a href="#parentflowid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>parent<wbr/>Flow<wbr/>Id</span></a><a href="#partitionkey"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>partition<wbr/>Key</span></a><a href="#payload"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>payload</span></a><a href="#rootflowid"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>root<wbr/>Flow<wbr/>Id</span></a><a href="#state"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>state</span></a><a href="#statemeta"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>state<wbr/>Meta</span></a><a href="#statename"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>state<wbr/>Name</span></a><a href="#type"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>type</span></a><a href="#valuerefs"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>value<wbr/>Refs</span></a><a href="#values"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>values</span></a><a href="#version"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Accessor"><use href="../assets/icons.svg#icon-262144"></use></svg><span>version</span></a></div></details>
307
345
  <details open class="tsd-accordion tsd-page-navigation-section"><summary class="tsd-accordion-summary" data-key="section-Methods"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Methods</summary>
308
- <div><a href="#value"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>value</span></a><a href="#valuemany"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>value<wbr/>Many</span></a></div></details></div></details></div>
346
+ <div><a href="#advance"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>advance</span></a><a href="#step"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>step</span></a><a href="#value"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>value</span></a><a href="#valuemany"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Method"><use href="../assets/icons.svg#icon-2048"></use></svg><span>value<wbr/>Many</span></a></div></details></div></details></div>
309
347
  <div class="site-menu">
310
348
  <nav class="tsd-navigation"><a href="../modules.html">@ferricstore/ferricstore</a>
311
349
  <ul class="tsd-small-nested-navigation" id="tsd-nav-container">