@lifi/sdk 4.10.0 → 4.12.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 (140) hide show
  1. package/CHANGELOG.md +39 -0
  2. package/README.md +9 -0
  3. package/dist/cjs/client/createClient.js +6 -4
  4. package/dist/cjs/client/createClient.js.map +1 -1
  5. package/dist/cjs/client/findProvider.d.ts +10 -0
  6. package/dist/cjs/client/findProvider.js +11 -0
  7. package/dist/cjs/client/findProvider.js.map +1 -0
  8. package/dist/cjs/core/BaseStepExecutor.d.ts +1 -1
  9. package/dist/cjs/core/BaseStepExecutor.js +21 -9
  10. package/dist/cjs/core/BaseStepExecutor.js.map +1 -1
  11. package/dist/cjs/core/StatusManager.d.ts +10 -0
  12. package/dist/cjs/core/StatusManager.js +107 -3
  13. package/dist/cjs/core/StatusManager.js.map +1 -1
  14. package/dist/cjs/core/execution.js +30 -14
  15. package/dist/cjs/core/execution.js.map +1 -1
  16. package/dist/cjs/core/executionState.d.ts +34 -2
  17. package/dist/cjs/core/executionState.js +44 -1
  18. package/dist/cjs/core/executionState.js.map +1 -1
  19. package/dist/cjs/core/prepareRestart.js +14 -6
  20. package/dist/cjs/core/prepareRestart.js.map +1 -1
  21. package/dist/cjs/core/tasks/WaitForTransactionStatusTask.js +4 -2
  22. package/dist/cjs/core/tasks/WaitForTransactionStatusTask.js.map +1 -1
  23. package/dist/cjs/core/tasks/helpers/getStepStatusRequest.d.ts +10 -0
  24. package/dist/cjs/core/tasks/helpers/getStepStatusRequest.js +20 -0
  25. package/dist/cjs/core/tasks/helpers/getStepStatusRequest.js.map +1 -0
  26. package/dist/cjs/core/tasks/helpers/isKnownToStatusApi.d.ts +21 -0
  27. package/dist/cjs/core/tasks/helpers/isKnownToStatusApi.js +44 -0
  28. package/dist/cjs/core/tasks/helpers/isKnownToStatusApi.js.map +1 -0
  29. package/dist/cjs/core/tasks/helpers/waitForTransactionStatus.d.ts +22 -1
  30. package/dist/cjs/core/tasks/helpers/waitForTransactionStatus.js +76 -17
  31. package/dist/cjs/core/tasks/helpers/waitForTransactionStatus.js.map +1 -1
  32. package/dist/cjs/core/transactionState.d.ts +123 -0
  33. package/dist/cjs/core/transactionState.js +167 -0
  34. package/dist/cjs/core/transactionState.js.map +1 -0
  35. package/dist/cjs/errors/constants.d.ts +2 -1
  36. package/dist/cjs/errors/constants.js +1 -0
  37. package/dist/cjs/errors/constants.js.map +1 -1
  38. package/dist/cjs/errors/errors.d.ts +13 -2
  39. package/dist/cjs/errors/errors.js +5 -2
  40. package/dist/cjs/errors/errors.js.map +1 -1
  41. package/dist/cjs/index.d.ts +5 -2
  42. package/dist/cjs/index.js +14 -0
  43. package/dist/cjs/types/core.d.ts +56 -3
  44. package/dist/cjs/types/execution.d.ts +8 -0
  45. package/dist/cjs/utils/checkPackageUpdates.js +1 -1
  46. package/dist/cjs/utils/waitForResult.d.ts +3 -1
  47. package/dist/cjs/utils/waitForResult.js +15 -10
  48. package/dist/cjs/utils/waitForResult.js.map +1 -1
  49. package/dist/cjs/version.d.ts +1 -1
  50. package/dist/cjs/version.js +1 -1
  51. package/dist/cjs/version.js.map +1 -1
  52. package/dist/esm/actions/getRoutes.d.ts.map +1 -1
  53. package/dist/esm/actions/index.d.ts.map +1 -1
  54. package/dist/esm/client/createClient.d.ts.map +1 -1
  55. package/dist/esm/client/createClient.js +6 -4
  56. package/dist/esm/client/createClient.js.map +1 -1
  57. package/dist/esm/client/findProvider.d.ts +10 -0
  58. package/dist/esm/client/findProvider.d.ts.map +1 -0
  59. package/dist/esm/client/findProvider.js +10 -0
  60. package/dist/esm/client/findProvider.js.map +1 -0
  61. package/dist/esm/core/BaseStepExecutor.d.ts +1 -1
  62. package/dist/esm/core/BaseStepExecutor.d.ts.map +1 -1
  63. package/dist/esm/core/BaseStepExecutor.js +22 -10
  64. package/dist/esm/core/BaseStepExecutor.js.map +1 -1
  65. package/dist/esm/core/StatusManager.d.ts +10 -0
  66. package/dist/esm/core/StatusManager.d.ts.map +1 -1
  67. package/dist/esm/core/StatusManager.js +107 -3
  68. package/dist/esm/core/StatusManager.js.map +1 -1
  69. package/dist/esm/core/execution.d.ts.map +1 -1
  70. package/dist/esm/core/execution.js +30 -14
  71. package/dist/esm/core/execution.js.map +1 -1
  72. package/dist/esm/core/executionState.d.ts +34 -2
  73. package/dist/esm/core/executionState.d.ts.map +1 -1
  74. package/dist/esm/core/executionState.js +44 -1
  75. package/dist/esm/core/executionState.js.map +1 -1
  76. package/dist/esm/core/prepareRestart.d.ts.map +1 -1
  77. package/dist/esm/core/prepareRestart.js +14 -6
  78. package/dist/esm/core/prepareRestart.js.map +1 -1
  79. package/dist/esm/core/tasks/WaitForTransactionStatusTask.d.ts.map +1 -1
  80. package/dist/esm/core/tasks/WaitForTransactionStatusTask.js +4 -2
  81. package/dist/esm/core/tasks/WaitForTransactionStatusTask.js.map +1 -1
  82. package/dist/esm/core/tasks/helpers/getStepStatusRequest.d.ts +10 -0
  83. package/dist/esm/core/tasks/helpers/getStepStatusRequest.d.ts.map +1 -0
  84. package/dist/esm/core/tasks/helpers/getStepStatusRequest.js +19 -0
  85. package/dist/esm/core/tasks/helpers/getStepStatusRequest.js.map +1 -0
  86. package/dist/esm/core/tasks/helpers/isKnownToStatusApi.d.ts +21 -0
  87. package/dist/esm/core/tasks/helpers/isKnownToStatusApi.d.ts.map +1 -0
  88. package/dist/esm/core/tasks/helpers/isKnownToStatusApi.js +43 -0
  89. package/dist/esm/core/tasks/helpers/isKnownToStatusApi.js.map +1 -0
  90. package/dist/esm/core/tasks/helpers/waitForTransactionStatus.d.ts +22 -1
  91. package/dist/esm/core/tasks/helpers/waitForTransactionStatus.d.ts.map +1 -1
  92. package/dist/esm/core/tasks/helpers/waitForTransactionStatus.js +76 -18
  93. package/dist/esm/core/tasks/helpers/waitForTransactionStatus.js.map +1 -1
  94. package/dist/esm/core/transactionState.d.ts +123 -0
  95. package/dist/esm/core/transactionState.d.ts.map +1 -0
  96. package/dist/esm/core/transactionState.js +155 -0
  97. package/dist/esm/core/transactionState.js.map +1 -0
  98. package/dist/esm/errors/constants.d.ts +2 -1
  99. package/dist/esm/errors/constants.d.ts.map +1 -1
  100. package/dist/esm/errors/constants.js +1 -0
  101. package/dist/esm/errors/constants.js.map +1 -1
  102. package/dist/esm/errors/errors.d.ts +13 -2
  103. package/dist/esm/errors/errors.d.ts.map +1 -1
  104. package/dist/esm/errors/errors.js +5 -2
  105. package/dist/esm/errors/errors.js.map +1 -1
  106. package/dist/esm/index.d.ts +5 -2
  107. package/dist/esm/index.js +4 -1
  108. package/dist/esm/types/actions.d.ts.map +1 -1
  109. package/dist/esm/types/core.d.ts +56 -3
  110. package/dist/esm/types/core.d.ts.map +1 -1
  111. package/dist/esm/types/execution.d.ts +8 -0
  112. package/dist/esm/types/execution.d.ts.map +1 -1
  113. package/dist/esm/utils/checkPackageUpdates.js +1 -1
  114. package/dist/esm/utils/waitForResult.d.ts +3 -1
  115. package/dist/esm/utils/waitForResult.d.ts.map +1 -1
  116. package/dist/esm/utils/waitForResult.js +15 -10
  117. package/dist/esm/utils/waitForResult.js.map +1 -1
  118. package/dist/esm/version.d.ts +1 -1
  119. package/dist/esm/version.js +1 -1
  120. package/dist/esm/version.js.map +1 -1
  121. package/package.json +2 -2
  122. package/src/client/createClient.ts +12 -4
  123. package/src/client/findProvider.ts +21 -0
  124. package/src/core/BaseStepExecutor.ts +40 -6
  125. package/src/core/StatusManager.ts +214 -2
  126. package/src/core/execution.ts +69 -20
  127. package/src/core/executionState.ts +84 -1
  128. package/src/core/prepareRestart.ts +29 -13
  129. package/src/core/tasks/WaitForTransactionStatusTask.ts +10 -1
  130. package/src/core/tasks/helpers/getStepStatusRequest.ts +20 -0
  131. package/src/core/tasks/helpers/isKnownToStatusApi.ts +57 -0
  132. package/src/core/tasks/helpers/waitForTransactionStatus.ts +128 -17
  133. package/src/core/transactionState.ts +200 -0
  134. package/src/errors/constants.ts +1 -0
  135. package/src/errors/errors.ts +21 -2
  136. package/src/index.ts +14 -0
  137. package/src/types/core.ts +57 -3
  138. package/src/types/execution.ts +8 -0
  139. package/src/utils/waitForResult.ts +16 -6
  140. package/src/version.ts +1 -1
@@ -1,3 +1,4 @@
1
+ import { getAbortError } from './abort.js'
1
2
  import { sleep } from './sleep.js'
2
3
 
3
4
  /**
@@ -6,14 +7,17 @@ import { sleep } from './sleep.js'
6
7
  * @param interval The timeout in milliseconds between retries, or a function that receives the current poll count and returns the interval. Defaults to 5000
7
8
  * @param maxRetries Maximum number of calls that throw before the error is rethrown, defaults to 3
8
9
  * @param shouldRetry Optional predicate to determine if an error should trigger a retry
10
+ * @param signal Optional signal that ends the wait: no call starts after it aborts, and the sleep between calls ends at once
9
11
  * @returns The result of the fn function
10
12
  * @throws The error of fn if maximum retries is reached, or if shouldRetry returns false
13
+ * @throws The abort reason of `signal` once it aborts
11
14
  */
12
15
  export const waitForResult = async <T>(
13
16
  fn: () => Promise<T | undefined>,
14
17
  interval: number | ((poll: number) => number) = 5000,
15
18
  maxRetries = 3,
16
- shouldRetry: (count: number, error: unknown) => boolean = () => true
19
+ shouldRetry: (count: number, error: unknown) => boolean = () => true,
20
+ signal?: AbortSignal
17
21
  ): Promise<T> => {
18
22
  let result: T | undefined
19
23
  let attempts = 0
@@ -22,13 +26,16 @@ export const waitForResult = async <T>(
22
26
  const getInterval = typeof interval === 'function' ? interval : () => interval
23
27
 
24
28
  while (!result) {
29
+ if (signal?.aborted) {
30
+ throw getAbortError(signal)
31
+ }
25
32
  try {
26
33
  result = await fn()
27
- if (!result) {
28
- await sleep(getInterval(polls))
29
- polls++
30
- }
31
34
  } catch (error) {
35
+ // An error of a call that the abort cut short is not a reason to retry.
36
+ if (signal?.aborted) {
37
+ throw getAbortError(signal)
38
+ }
32
39
  if (!shouldRetry(attempts, error)) {
33
40
  throw error
34
41
  }
@@ -36,7 +43,10 @@ export const waitForResult = async <T>(
36
43
  if (attempts === maxRetries) {
37
44
  throw error
38
45
  }
39
- await sleep(getInterval(polls))
46
+ }
47
+ if (!result) {
48
+ // Rejects at once, also when the signal aborted during the call.
49
+ await sleep(getInterval(polls), { signal })
40
50
  polls++
41
51
  }
42
52
  }
package/src/version.ts CHANGED
@@ -1,2 +1,2 @@
1
1
  export const name = '@lifi/sdk'
2
- export const version = '4.10.0'
2
+ export const version = '4.12.0'