@ferricstore/ferricstore 0.12.2 → 0.13.1

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 (110) hide show
  1. package/README.md +45 -3
  2. package/dist/index.cjs +804 -198
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.d.cts +87 -9
  5. package/dist/index.d.ts +87 -9
  6. package/dist/index.js +798 -194
  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/openai-agents.cjs.map +1 -1
  13. package/dist/openai-agents.js.map +1 -1
  14. package/dist/{outcomes-DmBwnq0Y.d.cts → outcomes-CcX956h4.d.cts} +20 -1
  15. package/dist/{outcomes-BbFDp3AH.d.ts → outcomes-DLJYTrX8.d.ts} +20 -1
  16. package/docs/api/assets/hierarchy.js +1 -1
  17. package/docs/api/assets/highlight.css +9 -2
  18. package/docs/api/assets/navigation.js +1 -1
  19. package/docs/api/assets/search.js +1 -1
  20. package/docs/api/classes/ConnectionClosedError.html +5 -5
  21. package/docs/api/classes/FerricStoreClient.html +68 -23
  22. package/docs/api/classes/FerricStoreError.html +2 -1
  23. package/docs/api/classes/FlowAlreadyExistsError.html +3 -3
  24. package/docs/api/classes/FlowBatchError.html +1 -1
  25. package/docs/api/classes/FlowNotFoundError.html +3 -3
  26. package/docs/api/classes/FlowQueryError.html +1 -1
  27. package/docs/api/classes/FlowWrongStateError.html +3 -3
  28. package/docs/api/classes/HTTPTransportError.html +14 -8
  29. package/docs/api/classes/InvalidCommandError.html +3 -3
  30. package/docs/api/classes/LeaseRenewalError.html +3 -3
  31. package/docs/api/classes/LockHeldError.html +3 -3
  32. package/docs/api/classes/LockNotOwnedError.html +3 -3
  33. package/docs/api/classes/NativeAdapter.html +3 -3
  34. package/docs/api/classes/OverloadedError.html +5 -5
  35. package/docs/api/classes/QueueCompletionError.html +1 -1
  36. package/docs/api/classes/RequestNotSentError.html +225 -0
  37. package/docs/api/classes/RequestTimeoutError.html +6 -6
  38. package/docs/api/classes/RerouteError.html +3 -3
  39. package/docs/api/classes/StaleLeaseError.html +3 -3
  40. package/docs/api/classes/StalePolicyGenerationError.html +3 -3
  41. package/docs/api/classes/Workflow.html +19 -19
  42. package/docs/api/classes/WorkflowClient.html +4 -4
  43. package/docs/api/classes/WorkflowContext.html +73 -37
  44. package/docs/api/classes/WorkflowFlowCommands.html +26 -22
  45. package/docs/api/classes/WorkflowWorker.html +6 -6
  46. package/docs/api/functions/classifyServerError.html +1 -1
  47. package/docs/api/functions/complete.html +1 -1
  48. package/docs/api/functions/fail.html +1 -1
  49. package/docs/api/functions/isAlreadyAppliedOutcome.html +41 -0
  50. package/docs/api/functions/isOutcome.html +1 -1
  51. package/docs/api/functions/mapException.html +1 -1
  52. package/docs/api/functions/retry.html +1 -1
  53. package/docs/api/functions/transition.html +1 -1
  54. package/docs/api/hierarchy.html +56 -47
  55. package/docs/api/index.html +32 -4
  56. package/docs/api/interfaces/AdminListOptions.html +1 -1
  57. package/docs/api/interfaces/AdvanceOptions.html +145 -0
  58. package/docs/api/interfaces/AlreadyAppliedOutcome.html +69 -0
  59. package/docs/api/interfaces/AppliedStepOutcome.html +87 -0
  60. package/docs/api/interfaces/CancelOptions.html +13 -9
  61. package/docs/api/interfaces/CompleteOptions.html +13 -9
  62. package/docs/api/interfaces/CompleteOutcome.html +13 -13
  63. package/docs/api/interfaces/CreateManyOptions.html +1 -1
  64. package/docs/api/interfaces/EffectCompensateOptions.html +1 -1
  65. package/docs/api/interfaces/EffectConfirmOptions.html +1 -1
  66. package/docs/api/interfaces/EffectFailOptions.html +1 -1
  67. package/docs/api/interfaces/EffectStatusOptions.html +1 -1
  68. package/docs/api/interfaces/ExtendLeaseOptions.html +10 -8
  69. package/docs/api/interfaces/FailOptions.html +13 -9
  70. package/docs/api/interfaces/FailOutcome.html +13 -13
  71. package/docs/api/interfaces/FerricStoreClientFromUrlOptions.html +1 -1
  72. package/docs/api/interfaces/FerricStoreClientOptions.html +1 -1
  73. package/docs/api/interfaces/FlowQueryCountResult.html +1 -1
  74. package/docs/api/interfaces/FlowQueryIndexBuild.html +1 -1
  75. package/docs/api/interfaces/FlowQueryIndexProgress.html +1 -1
  76. package/docs/api/interfaces/FlowQueryIndexValidation.html +1 -1
  77. package/docs/api/interfaces/FlowQueryRecordsResult.html +1 -1
  78. package/docs/api/interfaces/HistoryOptions.html +16 -16
  79. package/docs/api/interfaces/InvocationCreateOptions.html +1 -1
  80. package/docs/api/interfaces/LeaseMutationOptions.html +11 -7
  81. package/docs/api/interfaces/LimitListOptions.html +1 -1
  82. package/docs/api/interfaces/MutateOptions.html +8 -4
  83. package/docs/api/interfaces/NamedValueMutation.html +9 -9
  84. package/docs/api/interfaces/ReadOptions.html +12 -12
  85. package/docs/api/interfaces/ReclaimOptions.html +1 -1
  86. package/docs/api/interfaces/ReplayedStepResult.html +73 -0
  87. package/docs/api/interfaces/RequestContextOptions.html +1 -1
  88. package/docs/api/interfaces/RetryOptions.html +13 -9
  89. package/docs/api/interfaces/RetryOutcome.html +13 -13
  90. package/docs/api/interfaces/RunStepsItem.html +3 -3
  91. package/docs/api/interfaces/RunStepsManyOptions.html +11 -11
  92. package/docs/api/interfaces/SearchOptions.html +13 -13
  93. package/docs/api/interfaces/StepContinueOptions.html +16 -12
  94. package/docs/api/interfaces/StepOptions.html +166 -0
  95. package/docs/api/interfaces/StepResult.html +67 -0
  96. package/docs/api/interfaces/TDigestCreateOptions.html +1 -1
  97. package/docs/api/interfaces/TDigestMergeOptions.html +1 -1
  98. package/docs/api/interfaces/TransitionOptions.html +15 -11
  99. package/docs/api/interfaces/TransitionOutcome.html +14 -14
  100. package/docs/api/media/design.md +12 -1
  101. package/docs/api/modules.html +8 -8
  102. package/docs/api/types/ConnectionRequestDisposition.html +1 -1
  103. package/docs/api/types/ManagementPairs.html +1 -1
  104. package/docs/api/types/Outcome.html +1 -1
  105. package/docs/api/types/RequestDisposition.html +1 -1
  106. package/docs/api/types/SearchStateMeta.html +1 -1
  107. package/docs/api/types/WorkflowStepResult.html +38 -0
  108. package/docs/api/variables/FERRICSTORE_SDK_VERSION.html +1 -1
  109. package/docs/design.md +12 -1
  110. 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#L30">src/workflow-context.ts:30</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,18 +62,17 @@
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-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>
67
69
  <ul class="tsd-parameter-list">
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
- <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>
72
+ <li><span><span class="tsd-kind-parameter">stateName</span>: <span class="tsd-signature-type">string</span></span></li></ul></div>
72
73
  <h4 class="tsd-returns-title">Returns <a href="" class="tsd-signature-type tsd-kind-class">WorkflowContext</a></h4><aside class="tsd-sources">
73
74
  <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>
75
+ <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></section></details>
75
76
  <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
77
  <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
78
  <section>
@@ -79,22 +80,17 @@
79
80
  <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
81
  <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
82
  <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>
83
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L33">src/workflow-context.ts:33</a></li></ul></aside></section>
83
84
  <section class="tsd-panel tsd-member">
84
85
  <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
86
  <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
87
  <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>
88
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L32">src/workflow-context.ts:32</a></li></ul></aside></section>
93
89
  <section class="tsd-panel tsd-member">
94
90
  <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
91
  <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
92
  <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>
93
+ <li>Defined in <a href="https://github.com/ferricstore/ferricstore-typescript/blob/main/workflow-context.ts#L31">src/workflow-context.ts:31</a></li></ul></aside></section></section></details>
98
94
  <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
95
  <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
96
  <section>
@@ -106,7 +102,7 @@
106
102
  <div class="tsd-description">
107
103
  <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
104
  <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>
105
+ <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
106
  <section class="tsd-panel tsd-member">
111
107
  <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
108
  <ul class="tsd-signatures">
@@ -115,7 +111,7 @@
115
111
  <div class="tsd-description">
116
112
  <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
113
  <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>
114
+ <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
115
  <section class="tsd-panel tsd-member">
120
116
  <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
117
  <ul class="tsd-signatures">
@@ -124,7 +120,7 @@
124
120
  <div class="tsd-description">
125
121
  <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
122
  <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>
123
+ <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
124
  <section class="tsd-panel tsd-member">
129
125
  <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
126
  <ul class="tsd-signatures">
@@ -133,7 +129,7 @@
133
129
  <div class="tsd-description">
134
130
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
135
131
  <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>
132
+ <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
133
  <section class="tsd-panel tsd-member">
138
134
  <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
135
  <ul class="tsd-signatures">
@@ -142,7 +138,7 @@
142
138
  <div class="tsd-description">
143
139
  <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
140
  <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>
141
+ <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
142
  <section class="tsd-panel tsd-member">
147
143
  <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
144
  <ul class="tsd-signatures">
@@ -151,7 +147,7 @@
151
147
  <div class="tsd-description">
152
148
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Buffer</span></h4><aside class="tsd-sources">
153
149
  <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>
150
+ <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
151
  <section class="tsd-panel tsd-member">
156
152
  <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
153
  <ul class="tsd-signatures">
@@ -160,7 +156,7 @@
160
156
  <div class="tsd-description">
161
157
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
162
158
  <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>
159
+ <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
160
  <section class="tsd-panel tsd-member">
165
161
  <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
162
  <ul class="tsd-signatures">
@@ -169,7 +165,7 @@
169
165
  <div class="tsd-description">
170
166
  <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
167
  <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>
168
+ <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
169
  <section class="tsd-panel tsd-member">
174
170
  <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
171
  <ul class="tsd-signatures">
@@ -178,7 +174,7 @@
178
174
  <div class="tsd-description">
179
175
  <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
176
  <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>
177
+ <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
178
  <section class="tsd-panel tsd-member">
183
179
  <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
180
  <ul class="tsd-signatures">
@@ -187,7 +183,7 @@
187
183
  <div class="tsd-description">
188
184
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">unknown</span></h4><aside class="tsd-sources">
189
185
  <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>
186
+ <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
187
  <section class="tsd-panel tsd-member">
192
188
  <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
189
  <ul class="tsd-signatures">
@@ -196,7 +192,7 @@
196
192
  <div class="tsd-description">
197
193
  <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
194
  <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>
195
+ <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
196
  <section class="tsd-panel tsd-member">
201
197
  <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
198
  <ul class="tsd-signatures">
@@ -205,7 +201,7 @@
205
201
  <div class="tsd-description">
206
202
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
207
203
  <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>
204
+ <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
205
  <section class="tsd-panel tsd-member">
210
206
  <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
207
  <ul class="tsd-signatures">
@@ -214,7 +210,16 @@
214
210
  <div class="tsd-description">
215
211
  <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
212
  <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>
213
+ <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>
214
+ <section class="tsd-panel tsd-member">
215
+ <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>
216
+ <ul class="tsd-signatures">
217
+ <li>
218
+ <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>
219
+ <div class="tsd-description">
220
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
221
+ <ul>
222
+ <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
223
  <section class="tsd-panel tsd-member">
219
224
  <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
225
  <ul class="tsd-signatures">
@@ -223,7 +228,7 @@
223
228
  <div class="tsd-description">
224
229
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><aside class="tsd-sources">
225
230
  <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>
231
+ <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
232
  <section class="tsd-panel tsd-member">
228
233
  <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
234
  <ul class="tsd-signatures">
@@ -232,7 +237,7 @@
232
237
  <div class="tsd-description">
233
238
  <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
239
  <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>
240
+ <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
241
  <section class="tsd-panel tsd-member">
237
242
  <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
243
  <ul class="tsd-signatures">
@@ -241,7 +246,7 @@
241
246
  <div class="tsd-description">
242
247
  <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
248
  <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>
249
+ <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
250
  <section class="tsd-panel tsd-member">
246
251
  <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
252
  <ul class="tsd-signatures">
@@ -250,11 +255,42 @@
250
255
  <div class="tsd-description">
251
256
  <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">number</span></h4><aside class="tsd-sources">
252
257
  <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>
258
+ <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
259
  <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
260
  <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
261
  <section>
257
262
  <section class="tsd-panel tsd-member">
263
+ <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>
264
+ <ul class="tsd-signatures">
265
+ <li class="">
266
+ <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>
267
+ <div class="tsd-description">
268
+ <div class="tsd-parameters">
269
+ <h4 class="tsd-parameters-title">Parameters</h4>
270
+ <ul class="tsd-parameter-list">
271
+ <li><span><span class="tsd-kind-parameter">toState</span>: <span class="tsd-signature-type">string</span></span></li>
272
+ <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>
273
+ <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">
274
+ <ul>
275
+ <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>
276
+ <section class="tsd-panel tsd-member">
277
+ <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>
278
+ <ul class="tsd-signatures">
279
+ <li class="">
280
+ <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>
281
+ <div class="tsd-description">
282
+ <section class="tsd-panel">
283
+ <h4>Type Parameters</h4>
284
+ <ul class="tsd-type-parameter-list">
285
+ <li><span id="steptresult"><span class="tsd-kind-type-parameter">TResult</span></span></li></ul></section>
286
+ <div class="tsd-parameters">
287
+ <h4 class="tsd-parameters-title">Parameters</h4>
288
+ <ul class="tsd-parameter-list">
289
+ <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>
290
+ <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">
291
+ <ul>
292
+ <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>
293
+ <section class="tsd-panel tsd-member">
258
294
  <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
295
  <ul class="tsd-signatures">
260
296
  <li class="">
@@ -268,7 +304,7 @@
268
304
  <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
305
  <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
306
  <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>
307
+ <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
308
  <section class="tsd-panel tsd-member">
273
309
  <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
310
  <ul class="tsd-signatures">
@@ -282,7 +318,7 @@
282
318
  <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
319
  <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
320
  <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>
321
+ <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
322
  <div class="col-sidebar">
287
323
  <div class="page-menu">
288
324
  <div class="tsd-navigation settings">
@@ -301,11 +337,11 @@
301
337
  <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
338
  <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
339
  <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>
340
+ <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
341
  <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>
342
+ <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
343
  <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>
344
+ <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
345
  <div class="site-menu">
310
346
  <nav class="tsd-navigation"><a href="../modules.html">@ferricstore/ferricstore</a>
311
347
  <ul class="tsd-small-nested-navigation" id="tsd-nav-container">