ts-workflow-engine-lite 2.1.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 (525) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +352 -0
  3. package/dist/src/api/ConsoleWebSocketManager.d.ts +57 -0
  4. package/dist/src/api/ConsoleWebSocketManager.js +206 -0
  5. package/dist/src/api/ConsoleWebSocketManager.js.map +1 -0
  6. package/dist/src/api/ErrorHandler.d.ts +52 -0
  7. package/dist/src/api/ErrorHandler.js +115 -0
  8. package/dist/src/api/ErrorHandler.js.map +1 -0
  9. package/dist/src/api/EventHistory.d.ts +73 -0
  10. package/dist/src/api/EventHistory.js +309 -0
  11. package/dist/src/api/EventHistory.js.map +1 -0
  12. package/dist/src/api/WebhookManager.d.ts +67 -0
  13. package/dist/src/api/WebhookManager.js +568 -0
  14. package/dist/src/api/WebhookManager.js.map +1 -0
  15. package/dist/src/api/docsPage.d.ts +1 -0
  16. package/dist/src/api/docsPage.js +321 -0
  17. package/dist/src/api/docsPage.js.map +1 -0
  18. package/dist/src/api/index.d.ts +8 -0
  19. package/dist/src/api/index.js +8 -0
  20. package/dist/src/api/index.js.map +1 -0
  21. package/dist/src/api/middleware/auth.d.ts +19 -0
  22. package/dist/src/api/middleware/auth.js +122 -0
  23. package/dist/src/api/middleware/auth.js.map +1 -0
  24. package/dist/src/api/middleware/index.d.ts +3 -0
  25. package/dist/src/api/middleware/index.js +3 -0
  26. package/dist/src/api/middleware/index.js.map +1 -0
  27. package/dist/src/api/middleware/rateLimit.d.ts +6 -0
  28. package/dist/src/api/middleware/rateLimit.js +69 -0
  29. package/dist/src/api/middleware/rateLimit.js.map +1 -0
  30. package/dist/src/api/middleware/rateLimitStore.d.ts +14 -0
  31. package/dist/src/api/middleware/rateLimitStore.js +44 -0
  32. package/dist/src/api/middleware/rateLimitStore.js.map +1 -0
  33. package/dist/src/api/middleware/rbac.d.ts +12 -0
  34. package/dist/src/api/middleware/rbac.js +120 -0
  35. package/dist/src/api/middleware/rbac.js.map +1 -0
  36. package/dist/src/api/openapi.d.ts +1917 -0
  37. package/dist/src/api/openapi.js +1758 -0
  38. package/dist/src/api/openapi.js.map +1 -0
  39. package/dist/src/api/playgroundPage.d.ts +1 -0
  40. package/dist/src/api/playgroundPage.js +765 -0
  41. package/dist/src/api/playgroundPage.js.map +1 -0
  42. package/dist/src/api/response.d.ts +22 -0
  43. package/dist/src/api/response.js +119 -0
  44. package/dist/src/api/response.js.map +1 -0
  45. package/dist/src/api/router.d.ts +17 -0
  46. package/dist/src/api/router.js +94 -0
  47. package/dist/src/api/router.js.map +1 -0
  48. package/dist/src/api/routes/analytics.d.ts +10 -0
  49. package/dist/src/api/routes/analytics.js +144 -0
  50. package/dist/src/api/routes/analytics.js.map +1 -0
  51. package/dist/src/api/routes/dlq.d.ts +3 -0
  52. package/dist/src/api/routes/dlq.js +248 -0
  53. package/dist/src/api/routes/dlq.js.map +1 -0
  54. package/dist/src/api/routes/eventHistory.d.ts +3 -0
  55. package/dist/src/api/routes/eventHistory.js +48 -0
  56. package/dist/src/api/routes/eventHistory.js.map +1 -0
  57. package/dist/src/api/routes/events.d.ts +3 -0
  58. package/dist/src/api/routes/events.js +205 -0
  59. package/dist/src/api/routes/events.js.map +1 -0
  60. package/dist/src/api/routes/functions.d.ts +3 -0
  61. package/dist/src/api/routes/functions.js +85 -0
  62. package/dist/src/api/routes/functions.js.map +1 -0
  63. package/dist/src/api/routes/instances.d.ts +3 -0
  64. package/dist/src/api/routes/instances.js +790 -0
  65. package/dist/src/api/routes/instances.js.map +1 -0
  66. package/dist/src/api/routes/templates.d.ts +3 -0
  67. package/dist/src/api/routes/templates.js +195 -0
  68. package/dist/src/api/routes/templates.js.map +1 -0
  69. package/dist/src/api/routes/webhooks.d.ts +3 -0
  70. package/dist/src/api/routes/webhooks.js +263 -0
  71. package/dist/src/api/routes/webhooks.js.map +1 -0
  72. package/dist/src/api/routes/workflows/analysis.d.ts +2 -0
  73. package/dist/src/api/routes/workflows/analysis.js +112 -0
  74. package/dist/src/api/routes/workflows/analysis.js.map +1 -0
  75. package/dist/src/api/routes/workflows/crud.d.ts +2 -0
  76. package/dist/src/api/routes/workflows/crud.js +140 -0
  77. package/dist/src/api/routes/workflows/crud.js.map +1 -0
  78. package/dist/src/api/routes/workflows/execution.d.ts +2 -0
  79. package/dist/src/api/routes/workflows/execution.js +204 -0
  80. package/dist/src/api/routes/workflows/execution.js.map +1 -0
  81. package/dist/src/api/routes/workflows/graph.d.ts +2 -0
  82. package/dist/src/api/routes/workflows/graph.js +51 -0
  83. package/dist/src/api/routes/workflows/graph.js.map +1 -0
  84. package/dist/src/api/routes/workflows/import.d.ts +2 -0
  85. package/dist/src/api/routes/workflows/import.js +238 -0
  86. package/dist/src/api/routes/workflows/import.js.map +1 -0
  87. package/dist/src/api/routes/workflows/index.d.ts +3 -0
  88. package/dist/src/api/routes/workflows/index.js +18 -0
  89. package/dist/src/api/routes/workflows/index.js.map +1 -0
  90. package/dist/src/api/routes/workflows/shared.d.ts +64 -0
  91. package/dist/src/api/routes/workflows/shared.js +304 -0
  92. package/dist/src/api/routes/workflows/shared.js.map +1 -0
  93. package/dist/src/api/routes/workflows/variables.d.ts +2 -0
  94. package/dist/src/api/routes/workflows/variables.js +34 -0
  95. package/dist/src/api/routes/workflows/variables.js.map +1 -0
  96. package/dist/src/api/routes/workflows/versioning.d.ts +2 -0
  97. package/dist/src/api/routes/workflows/versioning.js +235 -0
  98. package/dist/src/api/routes/workflows/versioning.js.map +1 -0
  99. package/dist/src/api/server.d.ts +13 -0
  100. package/dist/src/api/server.js +311 -0
  101. package/dist/src/api/server.js.map +1 -0
  102. package/dist/src/api/services/InstanceApplicationService.d.ts +74 -0
  103. package/dist/src/api/services/InstanceApplicationService.js +215 -0
  104. package/dist/src/api/services/InstanceApplicationService.js.map +1 -0
  105. package/dist/src/api/services/WorkflowApplicationService.d.ts +92 -0
  106. package/dist/src/api/services/WorkflowApplicationService.js +282 -0
  107. package/dist/src/api/services/WorkflowApplicationService.js.map +1 -0
  108. package/dist/src/api/services/index.d.ts +4 -0
  109. package/dist/src/api/services/index.js +3 -0
  110. package/dist/src/api/services/index.js.map +1 -0
  111. package/dist/src/api/types.d.ts +118 -0
  112. package/dist/src/api/types.js +2 -0
  113. package/dist/src/api/types.js.map +1 -0
  114. package/dist/src/api/utils/IdempotencyStore.d.ts +36 -0
  115. package/dist/src/api/utils/IdempotencyStore.js +121 -0
  116. package/dist/src/api/utils/IdempotencyStore.js.map +1 -0
  117. package/dist/src/api/utils/authConfig.d.ts +2 -0
  118. package/dist/src/api/utils/authConfig.js +25 -0
  119. package/dist/src/api/utils/authConfig.js.map +1 -0
  120. package/dist/src/api/utils/requestContext.d.ts +14 -0
  121. package/dist/src/api/utils/requestContext.js +31 -0
  122. package/dist/src/api/utils/requestContext.js.map +1 -0
  123. package/dist/src/api/utils/routeHelper.d.ts +25 -0
  124. package/dist/src/api/utils/routeHelper.js +30 -0
  125. package/dist/src/api/utils/routeHelper.js.map +1 -0
  126. package/dist/src/api/welcomePage.d.ts +1 -0
  127. package/dist/src/api/welcomePage.js +259 -0
  128. package/dist/src/api/welcomePage.js.map +1 -0
  129. package/dist/src/bootstrap.d.ts +20 -0
  130. package/dist/src/bootstrap.js +128 -0
  131. package/dist/src/bootstrap.js.map +1 -0
  132. package/dist/src/cli.d.ts +2 -0
  133. package/dist/src/cli.js +32 -0
  134. package/dist/src/cli.js.map +1 -0
  135. package/dist/src/config/AppConfig.d.ts +102 -0
  136. package/dist/src/config/AppConfig.js +452 -0
  137. package/dist/src/config/AppConfig.js.map +1 -0
  138. package/dist/src/config/redis.config.d.ts +6 -0
  139. package/dist/src/config/redis.config.js +9 -0
  140. package/dist/src/config/redis.config.js.map +1 -0
  141. package/dist/src/container.d.ts +29 -0
  142. package/dist/src/container.js +62 -0
  143. package/dist/src/container.js.map +1 -0
  144. package/dist/src/debug/BreakpointManager.d.ts +17 -0
  145. package/dist/src/debug/BreakpointManager.js +59 -0
  146. package/dist/src/debug/BreakpointManager.js.map +1 -0
  147. package/dist/src/debug/WorkflowDebugger.d.ts +34 -0
  148. package/dist/src/debug/WorkflowDebugger.js +117 -0
  149. package/dist/src/debug/WorkflowDebugger.js.map +1 -0
  150. package/dist/src/debug/index.d.ts +2 -0
  151. package/dist/src/debug/index.js +3 -0
  152. package/dist/src/debug/index.js.map +1 -0
  153. package/dist/src/demo/demoWorkflow.d.ts +3 -0
  154. package/dist/src/demo/demoWorkflow.js +82 -0
  155. package/dist/src/demo/demoWorkflow.js.map +1 -0
  156. package/dist/src/demo/exampleWorkflow.d.ts +36 -0
  157. package/dist/src/demo/exampleWorkflow.js +184 -0
  158. package/dist/src/demo/exampleWorkflow.js.map +1 -0
  159. package/dist/src/demo/index.d.ts +2 -0
  160. package/dist/src/demo/index.js +3 -0
  161. package/dist/src/demo/index.js.map +1 -0
  162. package/dist/src/dlq/DeadLetterQueue.d.ts +62 -0
  163. package/dist/src/dlq/DeadLetterQueue.js +342 -0
  164. package/dist/src/dlq/DeadLetterQueue.js.map +1 -0
  165. package/dist/src/dlq/index.d.ts +2 -0
  166. package/dist/src/dlq/index.js +2 -0
  167. package/dist/src/dlq/index.js.map +1 -0
  168. package/dist/src/dsl/DSLParser.d.ts +7 -0
  169. package/dist/src/dsl/DSLParser.js +252 -0
  170. package/dist/src/dsl/DSLParser.js.map +1 -0
  171. package/dist/src/dsl/WorkflowDSL.d.ts +40 -0
  172. package/dist/src/dsl/WorkflowDSL.js +2 -0
  173. package/dist/src/dsl/WorkflowDSL.js.map +1 -0
  174. package/dist/src/engine/CanaryReleaseManager.d.ts +39 -0
  175. package/dist/src/engine/CanaryReleaseManager.js +192 -0
  176. package/dist/src/engine/CanaryReleaseManager.js.map +1 -0
  177. package/dist/src/engine/ConcurrencyControl.d.ts +38 -0
  178. package/dist/src/engine/ConcurrencyControl.js +181 -0
  179. package/dist/src/engine/ConcurrencyControl.js.map +1 -0
  180. package/dist/src/engine/ContinueAsNewManager.d.ts +18 -0
  181. package/dist/src/engine/ContinueAsNewManager.js +29 -0
  182. package/dist/src/engine/ContinueAsNewManager.js.map +1 -0
  183. package/dist/src/engine/DataValidator.d.ts +15 -0
  184. package/dist/src/engine/DataValidator.js +121 -0
  185. package/dist/src/engine/DataValidator.js.map +1 -0
  186. package/dist/src/engine/DryRunExecutor.d.ts +48 -0
  187. package/dist/src/engine/DryRunExecutor.js +256 -0
  188. package/dist/src/engine/DryRunExecutor.js.map +1 -0
  189. package/dist/src/engine/ExecutionOrchestrator.d.ts +19 -0
  190. package/dist/src/engine/ExecutionOrchestrator.js +579 -0
  191. package/dist/src/engine/ExecutionOrchestrator.js.map +1 -0
  192. package/dist/src/engine/ExpressionEvaluator.d.ts +44 -0
  193. package/dist/src/engine/ExpressionEvaluator.js +1046 -0
  194. package/dist/src/engine/ExpressionEvaluator.js.map +1 -0
  195. package/dist/src/engine/HeartbeatManager.d.ts +42 -0
  196. package/dist/src/engine/HeartbeatManager.js +209 -0
  197. package/dist/src/engine/HeartbeatManager.js.map +1 -0
  198. package/dist/src/engine/InstanceManager.d.ts +21 -0
  199. package/dist/src/engine/InstanceManager.js +165 -0
  200. package/dist/src/engine/InstanceManager.js.map +1 -0
  201. package/dist/src/engine/InstanceSearch.d.ts +30 -0
  202. package/dist/src/engine/InstanceSearch.js +119 -0
  203. package/dist/src/engine/InstanceSearch.js.map +1 -0
  204. package/dist/src/engine/LifecycleManager.d.ts +18 -0
  205. package/dist/src/engine/LifecycleManager.js +82 -0
  206. package/dist/src/engine/LifecycleManager.js.map +1 -0
  207. package/dist/src/engine/ParallelExecutor.d.ts +26 -0
  208. package/dist/src/engine/ParallelExecutor.js +138 -0
  209. package/dist/src/engine/ParallelExecutor.js.map +1 -0
  210. package/dist/src/engine/SandboxEvaluator.d.ts +18 -0
  211. package/dist/src/engine/SandboxEvaluator.js +200 -0
  212. package/dist/src/engine/SandboxEvaluator.js.map +1 -0
  213. package/dist/src/engine/SchemaValidator.d.ts +30 -0
  214. package/dist/src/engine/SchemaValidator.js +630 -0
  215. package/dist/src/engine/SchemaValidator.js.map +1 -0
  216. package/dist/src/engine/SearchAttributeManager.d.ts +48 -0
  217. package/dist/src/engine/SearchAttributeManager.js +119 -0
  218. package/dist/src/engine/SearchAttributeManager.js.map +1 -0
  219. package/dist/src/engine/StateMachine.d.ts +13 -0
  220. package/dist/src/engine/StateMachine.js +66 -0
  221. package/dist/src/engine/StateMachine.js.map +1 -0
  222. package/dist/src/engine/StickyExecutionManager.d.ts +34 -0
  223. package/dist/src/engine/StickyExecutionManager.js +163 -0
  224. package/dist/src/engine/StickyExecutionManager.js.map +1 -0
  225. package/dist/src/engine/SubworkflowExecutor.d.ts +17 -0
  226. package/dist/src/engine/SubworkflowExecutor.js +157 -0
  227. package/dist/src/engine/SubworkflowExecutor.js.map +1 -0
  228. package/dist/src/engine/TaskExecutor.d.ts +12 -0
  229. package/dist/src/engine/TaskExecutor.js +124 -0
  230. package/dist/src/engine/TaskExecutor.js.map +1 -0
  231. package/dist/src/engine/TaskQueueManager.d.ts +42 -0
  232. package/dist/src/engine/TaskQueueManager.js +175 -0
  233. package/dist/src/engine/TaskQueueManager.js.map +1 -0
  234. package/dist/src/engine/WorkflowEngine.d.ts +117 -0
  235. package/dist/src/engine/WorkflowEngine.js +443 -0
  236. package/dist/src/engine/WorkflowEngine.js.map +1 -0
  237. package/dist/src/engine/WorkflowInstanceControl.d.ts +21 -0
  238. package/dist/src/engine/WorkflowInstanceControl.js +306 -0
  239. package/dist/src/engine/WorkflowInstanceControl.js.map +1 -0
  240. package/dist/src/engine/WorkflowPersistenceCoordinator.d.ts +12 -0
  241. package/dist/src/engine/WorkflowPersistenceCoordinator.js +93 -0
  242. package/dist/src/engine/WorkflowPersistenceCoordinator.js.map +1 -0
  243. package/dist/src/engine/WorkflowRegistry.d.ts +38 -0
  244. package/dist/src/engine/WorkflowRegistry.js +130 -0
  245. package/dist/src/engine/WorkflowRegistry.js.map +1 -0
  246. package/dist/src/engine/WorkflowVersionManager.d.ts +24 -0
  247. package/dist/src/engine/WorkflowVersionManager.js +121 -0
  248. package/dist/src/engine/WorkflowVersionManager.js.map +1 -0
  249. package/dist/src/engine/createEngine.d.ts +8 -0
  250. package/dist/src/engine/createEngine.js +21 -0
  251. package/dist/src/engine/createEngine.js.map +1 -0
  252. package/dist/src/engine/errors.d.ts +18 -0
  253. package/dist/src/engine/errors.js +37 -0
  254. package/dist/src/engine/errors.js.map +1 -0
  255. package/dist/src/engine/executors/ApprovalNodeExecutor.d.ts +12 -0
  256. package/dist/src/engine/executors/ApprovalNodeExecutor.js +68 -0
  257. package/dist/src/engine/executors/ApprovalNodeExecutor.js.map +1 -0
  258. package/dist/src/engine/executors/ConditionNodeExecutor.d.ts +16 -0
  259. package/dist/src/engine/executors/ConditionNodeExecutor.js +63 -0
  260. package/dist/src/engine/executors/ConditionNodeExecutor.js.map +1 -0
  261. package/dist/src/engine/executors/HttpNodeExecutor.d.ts +27 -0
  262. package/dist/src/engine/executors/HttpNodeExecutor.js +179 -0
  263. package/dist/src/engine/executors/HttpNodeExecutor.js.map +1 -0
  264. package/dist/src/engine/executors/JoinNodeExecutor.d.ts +13 -0
  265. package/dist/src/engine/executors/JoinNodeExecutor.js +37 -0
  266. package/dist/src/engine/executors/JoinNodeExecutor.js.map +1 -0
  267. package/dist/src/engine/executors/LoopNodeExecutor.d.ts +20 -0
  268. package/dist/src/engine/executors/LoopNodeExecutor.js +165 -0
  269. package/dist/src/engine/executors/LoopNodeExecutor.js.map +1 -0
  270. package/dist/src/engine/executors/NotificationNodeExecutor.d.ts +8 -0
  271. package/dist/src/engine/executors/NotificationNodeExecutor.js +33 -0
  272. package/dist/src/engine/executors/NotificationNodeExecutor.js.map +1 -0
  273. package/dist/src/engine/executors/QueueNodeExecutor.d.ts +23 -0
  274. package/dist/src/engine/executors/QueueNodeExecutor.js +87 -0
  275. package/dist/src/engine/executors/QueueNodeExecutor.js.map +1 -0
  276. package/dist/src/engine/executors/RouterNodeExecutor.d.ts +20 -0
  277. package/dist/src/engine/executors/RouterNodeExecutor.js +82 -0
  278. package/dist/src/engine/executors/RouterNodeExecutor.js.map +1 -0
  279. package/dist/src/engine/executors/SqlNodeExecutor.d.ts +27 -0
  280. package/dist/src/engine/executors/SqlNodeExecutor.js +74 -0
  281. package/dist/src/engine/executors/SqlNodeExecutor.js.map +1 -0
  282. package/dist/src/engine/executors/TransformNodeExecutor.d.ts +9 -0
  283. package/dist/src/engine/executors/TransformNodeExecutor.js +44 -0
  284. package/dist/src/engine/executors/TransformNodeExecutor.js.map +1 -0
  285. package/dist/src/engine/functions/collectionFunctions.d.ts +2 -0
  286. package/dist/src/engine/functions/collectionFunctions.js +129 -0
  287. package/dist/src/engine/functions/collectionFunctions.js.map +1 -0
  288. package/dist/src/engine/functions/customFunctions.d.ts +11 -0
  289. package/dist/src/engine/functions/customFunctions.js +42 -0
  290. package/dist/src/engine/functions/customFunctions.js.map +1 -0
  291. package/dist/src/engine/functions/dateFunctions.d.ts +2 -0
  292. package/dist/src/engine/functions/dateFunctions.js +71 -0
  293. package/dist/src/engine/functions/dateFunctions.js.map +1 -0
  294. package/dist/src/engine/functions/index.d.ts +14 -0
  295. package/dist/src/engine/functions/index.js +35 -0
  296. package/dist/src/engine/functions/index.js.map +1 -0
  297. package/dist/src/engine/functions/stringFunctions.d.ts +2 -0
  298. package/dist/src/engine/functions/stringFunctions.js +66 -0
  299. package/dist/src/engine/functions/stringFunctions.js.map +1 -0
  300. package/dist/src/engine/functions/typeFunctions.d.ts +2 -0
  301. package/dist/src/engine/functions/typeFunctions.js +70 -0
  302. package/dist/src/engine/functions/typeFunctions.js.map +1 -0
  303. package/dist/src/engine/functions/types.d.ts +6 -0
  304. package/dist/src/engine/functions/types.js +2 -0
  305. package/dist/src/engine/functions/types.js.map +1 -0
  306. package/dist/src/engine/index.d.ts +21 -0
  307. package/dist/src/engine/index.js +18 -0
  308. package/dist/src/engine/index.js.map +1 -0
  309. package/dist/src/engine/nodeDispatch/controlNodes.d.ts +2 -0
  310. package/dist/src/engine/nodeDispatch/controlNodes.js +208 -0
  311. package/dist/src/engine/nodeDispatch/controlNodes.js.map +1 -0
  312. package/dist/src/engine/nodeDispatch/helpers.d.ts +27 -0
  313. package/dist/src/engine/nodeDispatch/helpers.js +185 -0
  314. package/dist/src/engine/nodeDispatch/helpers.js.map +1 -0
  315. package/dist/src/engine/nodeDispatch/ioNodes.d.ts +2 -0
  316. package/dist/src/engine/nodeDispatch/ioNodes.js +89 -0
  317. package/dist/src/engine/nodeDispatch/ioNodes.js.map +1 -0
  318. package/dist/src/engine/nodeDispatch/types.d.ts +13 -0
  319. package/dist/src/engine/nodeDispatch/types.js +2 -0
  320. package/dist/src/engine/nodeDispatch/types.js.map +1 -0
  321. package/dist/src/engine/nodeDispatch/workflowNodes.d.ts +2 -0
  322. package/dist/src/engine/nodeDispatch/workflowNodes.js +33 -0
  323. package/dist/src/engine/nodeDispatch/workflowNodes.js.map +1 -0
  324. package/dist/src/engine/worker/ActionSandboxMessage.d.ts +29 -0
  325. package/dist/src/engine/worker/ActionSandboxMessage.js +7 -0
  326. package/dist/src/engine/worker/ActionSandboxMessage.js.map +1 -0
  327. package/dist/src/engine/worker/ActionSandboxPool.d.ts +34 -0
  328. package/dist/src/engine/worker/ActionSandboxPool.js +204 -0
  329. package/dist/src/engine/worker/ActionSandboxPool.js.map +1 -0
  330. package/dist/src/engine/worker/ActionSandboxWorker.d.ts +1 -0
  331. package/dist/src/engine/worker/ActionSandboxWorker.js +25 -0
  332. package/dist/src/engine/worker/ActionSandboxWorker.js.map +1 -0
  333. package/dist/src/engine/worker/WorkerMessage.d.ts +35 -0
  334. package/dist/src/engine/worker/WorkerMessage.js +7 -0
  335. package/dist/src/engine/worker/WorkerMessage.js.map +1 -0
  336. package/dist/src/engine/worker/WorkerPool.d.ts +42 -0
  337. package/dist/src/engine/worker/WorkerPool.js +273 -0
  338. package/dist/src/engine/worker/WorkerPool.js.map +1 -0
  339. package/dist/src/engine/worker/WorkerProcess.d.ts +1 -0
  340. package/dist/src/engine/worker/WorkerProcess.js +76 -0
  341. package/dist/src/engine/worker/WorkerProcess.js.map +1 -0
  342. package/dist/src/event/EventBus.d.ts +11 -0
  343. package/dist/src/event/EventBus.js +44 -0
  344. package/dist/src/event/EventBus.js.map +1 -0
  345. package/dist/src/event/EventCoordinator.d.ts +26 -0
  346. package/dist/src/event/EventCoordinator.js +205 -0
  347. package/dist/src/event/EventCoordinator.js.map +1 -0
  348. package/dist/src/event/EventDeduplicator.d.ts +31 -0
  349. package/dist/src/event/EventDeduplicator.js +100 -0
  350. package/dist/src/event/EventDeduplicator.js.map +1 -0
  351. package/dist/src/event/HookManager.d.ts +31 -0
  352. package/dist/src/event/HookManager.js +88 -0
  353. package/dist/src/event/HookManager.js.map +1 -0
  354. package/dist/src/event/MessageBus.d.ts +39 -0
  355. package/dist/src/event/MessageBus.js +131 -0
  356. package/dist/src/event/MessageBus.js.map +1 -0
  357. package/dist/src/event/index.d.ts +3 -0
  358. package/dist/src/event/index.js +4 -0
  359. package/dist/src/event/index.js.map +1 -0
  360. package/dist/src/index.d.ts +40 -0
  361. package/dist/src/index.js +33 -0
  362. package/dist/src/index.js.map +1 -0
  363. package/dist/src/lifecycle.d.ts +17 -0
  364. package/dist/src/lifecycle.js +84 -0
  365. package/dist/src/lifecycle.js.map +1 -0
  366. package/dist/src/metrics/AnalyticsCollector.d.ts +57 -0
  367. package/dist/src/metrics/AnalyticsCollector.js +140 -0
  368. package/dist/src/metrics/AnalyticsCollector.js.map +1 -0
  369. package/dist/src/metrics/AnomalyDetector.d.ts +21 -0
  370. package/dist/src/metrics/AnomalyDetector.js +120 -0
  371. package/dist/src/metrics/AnomalyDetector.js.map +1 -0
  372. package/dist/src/metrics/MetricsAggregator.d.ts +43 -0
  373. package/dist/src/metrics/MetricsAggregator.js +243 -0
  374. package/dist/src/metrics/MetricsAggregator.js.map +1 -0
  375. package/dist/src/metrics/SlaMonitor.d.ts +48 -0
  376. package/dist/src/metrics/SlaMonitor.js +130 -0
  377. package/dist/src/metrics/SlaMonitor.js.map +1 -0
  378. package/dist/src/metrics/index.d.ts +75 -0
  379. package/dist/src/metrics/index.js +293 -0
  380. package/dist/src/metrics/index.js.map +1 -0
  381. package/dist/src/model/Instance.d.ts +38 -0
  382. package/dist/src/model/Instance.js +12 -0
  383. package/dist/src/model/Instance.js.map +1 -0
  384. package/dist/src/model/RetryPolicy.d.ts +11 -0
  385. package/dist/src/model/RetryPolicy.js +30 -0
  386. package/dist/src/model/RetryPolicy.js.map +1 -0
  387. package/dist/src/model/Schedule.d.ts +34 -0
  388. package/dist/src/model/Schedule.js +50 -0
  389. package/dist/src/model/Schedule.js.map +1 -0
  390. package/dist/src/model/Workflow.d.ts +73 -0
  391. package/dist/src/model/Workflow.js +2 -0
  392. package/dist/src/model/Workflow.js.map +1 -0
  393. package/dist/src/model/WorkflowGraph.d.ts +32 -0
  394. package/dist/src/model/WorkflowGraph.js +267 -0
  395. package/dist/src/model/WorkflowGraph.js.map +1 -0
  396. package/dist/src/model/WorkflowSchema.d.ts +154 -0
  397. package/dist/src/model/WorkflowSchema.js +233 -0
  398. package/dist/src/model/WorkflowSchema.js.map +1 -0
  399. package/dist/src/model/WorkflowVariables.d.ts +15 -0
  400. package/dist/src/model/WorkflowVariables.js +77 -0
  401. package/dist/src/model/WorkflowVariables.js.map +1 -0
  402. package/dist/src/notification/NotificationChannel.d.ts +19 -0
  403. package/dist/src/notification/NotificationChannel.js +2 -0
  404. package/dist/src/notification/NotificationChannel.js.map +1 -0
  405. package/dist/src/notification/NotificationManager.d.ts +20 -0
  406. package/dist/src/notification/NotificationManager.js +59 -0
  407. package/dist/src/notification/NotificationManager.js.map +1 -0
  408. package/dist/src/notification/channels/DingtalkChannel.d.ts +7 -0
  409. package/dist/src/notification/channels/DingtalkChannel.js +18 -0
  410. package/dist/src/notification/channels/DingtalkChannel.js.map +1 -0
  411. package/dist/src/notification/channels/EmailChannel.d.ts +21 -0
  412. package/dist/src/notification/channels/EmailChannel.js +32 -0
  413. package/dist/src/notification/channels/EmailChannel.js.map +1 -0
  414. package/dist/src/notification/channels/FeishuChannel.d.ts +7 -0
  415. package/dist/src/notification/channels/FeishuChannel.js +18 -0
  416. package/dist/src/notification/channels/FeishuChannel.js.map +1 -0
  417. package/dist/src/notification/channels/SlackChannel.d.ts +7 -0
  418. package/dist/src/notification/channels/SlackChannel.js +18 -0
  419. package/dist/src/notification/channels/SlackChannel.js.map +1 -0
  420. package/dist/src/notification/channels/SmsChannel.d.ts +24 -0
  421. package/dist/src/notification/channels/SmsChannel.js +37 -0
  422. package/dist/src/notification/channels/SmsChannel.js.map +1 -0
  423. package/dist/src/notification/channels/WebhookChannel.d.ts +17 -0
  424. package/dist/src/notification/channels/WebhookChannel.js +61 -0
  425. package/dist/src/notification/channels/WebhookChannel.js.map +1 -0
  426. package/dist/src/notification/index.d.ts +24 -0
  427. package/dist/src/notification/index.js +61 -0
  428. package/dist/src/notification/index.js.map +1 -0
  429. package/dist/src/scheduler/CronScheduler.d.ts +20 -0
  430. package/dist/src/scheduler/CronScheduler.js +82 -0
  431. package/dist/src/scheduler/CronScheduler.js.map +1 -0
  432. package/dist/src/scheduler/EnhancedCronScheduler.d.ts +27 -0
  433. package/dist/src/scheduler/EnhancedCronScheduler.js +177 -0
  434. package/dist/src/scheduler/EnhancedCronScheduler.js.map +1 -0
  435. package/dist/src/storage/ArchiveManager.d.ts +21 -0
  436. package/dist/src/storage/ArchiveManager.js +140 -0
  437. package/dist/src/storage/ArchiveManager.js.map +1 -0
  438. package/dist/src/storage/LocalFileStorage.d.ts +64 -0
  439. package/dist/src/storage/LocalFileStorage.js +470 -0
  440. package/dist/src/storage/LocalFileStorage.js.map +1 -0
  441. package/dist/src/storage/MemoryStorage.d.ts +65 -0
  442. package/dist/src/storage/MemoryStorage.js +422 -0
  443. package/dist/src/storage/MemoryStorage.js.map +1 -0
  444. package/dist/src/storage/StorageProvider.d.ts +223 -0
  445. package/dist/src/storage/StorageProvider.js +2 -0
  446. package/dist/src/storage/StorageProvider.js.map +1 -0
  447. package/dist/src/storage/builtin-adapters.d.ts +1 -0
  448. package/dist/src/storage/builtin-adapters.js +20 -0
  449. package/dist/src/storage/builtin-adapters.js.map +1 -0
  450. package/dist/src/storage/index.d.ts +17 -0
  451. package/dist/src/storage/index.js +52 -0
  452. package/dist/src/storage/index.js.map +1 -0
  453. package/dist/src/storage/registry.d.ts +6 -0
  454. package/dist/src/storage/registry.js +23 -0
  455. package/dist/src/storage/registry.js.map +1 -0
  456. package/dist/src/telemetry/index.d.ts +53 -0
  457. package/dist/src/telemetry/index.js +73 -0
  458. package/dist/src/telemetry/index.js.map +1 -0
  459. package/dist/src/telemetry/spanRegistry.d.ts +9 -0
  460. package/dist/src/telemetry/spanRegistry.js +14 -0
  461. package/dist/src/telemetry/spanRegistry.js.map +1 -0
  462. package/dist/src/templates/AutoExtract.d.ts +2 -0
  463. package/dist/src/templates/AutoExtract.js +124 -0
  464. package/dist/src/templates/AutoExtract.js.map +1 -0
  465. package/dist/src/templates/TemplateGallery.d.ts +54 -0
  466. package/dist/src/templates/TemplateGallery.js +139 -0
  467. package/dist/src/templates/TemplateGallery.js.map +1 -0
  468. package/dist/src/templates/TemplateRegistry.d.ts +16 -0
  469. package/dist/src/templates/TemplateRegistry.js +92 -0
  470. package/dist/src/templates/TemplateRegistry.js.map +1 -0
  471. package/dist/src/templates/WorkflowTemplate.d.ts +24 -0
  472. package/dist/src/templates/WorkflowTemplate.js +2 -0
  473. package/dist/src/templates/WorkflowTemplate.js.map +1 -0
  474. package/dist/src/templates/builtin/HttpCallbackTemplate.d.ts +2 -0
  475. package/dist/src/templates/builtin/HttpCallbackTemplate.js +47 -0
  476. package/dist/src/templates/builtin/HttpCallbackTemplate.js.map +1 -0
  477. package/dist/src/templates/builtin/index.d.ts +3 -0
  478. package/dist/src/templates/builtin/index.js +11 -0
  479. package/dist/src/templates/builtin/index.js.map +1 -0
  480. package/dist/src/templates/index.d.ts +3 -0
  481. package/dist/src/templates/index.js +3 -0
  482. package/dist/src/templates/index.js.map +1 -0
  483. package/dist/src/testing/MutationTester.d.ts +27 -0
  484. package/dist/src/testing/MutationTester.js +157 -0
  485. package/dist/src/testing/MutationTester.js.map +1 -0
  486. package/dist/src/testing/TestGenerator.d.ts +31 -0
  487. package/dist/src/testing/TestGenerator.js +345 -0
  488. package/dist/src/testing/TestGenerator.js.map +1 -0
  489. package/dist/src/testing/index.d.ts +2 -0
  490. package/dist/src/testing/index.js +3 -0
  491. package/dist/src/testing/index.js.map +1 -0
  492. package/dist/src/testing/testWorkflow.d.ts +51 -0
  493. package/dist/src/testing/testWorkflow.js +167 -0
  494. package/dist/src/testing/testWorkflow.js.map +1 -0
  495. package/dist/src/utils/AuditLogger.d.ts +36 -0
  496. package/dist/src/utils/AuditLogger.js +148 -0
  497. package/dist/src/utils/AuditLogger.js.map +1 -0
  498. package/dist/src/utils/BoundedMap.d.ts +34 -0
  499. package/dist/src/utils/BoundedMap.js +125 -0
  500. package/dist/src/utils/BoundedMap.js.map +1 -0
  501. package/dist/src/utils/LeaseStore.d.ts +7 -0
  502. package/dist/src/utils/LeaseStore.js +102 -0
  503. package/dist/src/utils/LeaseStore.js.map +1 -0
  504. package/dist/src/utils/Logger.d.ts +26 -0
  505. package/dist/src/utils/Logger.js +279 -0
  506. package/dist/src/utils/Logger.js.map +1 -0
  507. package/dist/src/utils/SecretManager.d.ts +41 -0
  508. package/dist/src/utils/SecretManager.js +139 -0
  509. package/dist/src/utils/SecretManager.js.map +1 -0
  510. package/dist/src/utils/StructuredLogger.d.ts +45 -0
  511. package/dist/src/utils/StructuredLogger.js +118 -0
  512. package/dist/src/utils/StructuredLogger.js.map +1 -0
  513. package/dist/src/utils/concurrency.d.ts +3 -0
  514. package/dist/src/utils/concurrency.js +22 -0
  515. package/dist/src/utils/concurrency.js.map +1 -0
  516. package/dist/src/utils/env.d.ts +5 -0
  517. package/dist/src/utils/env.js +15 -0
  518. package/dist/src/utils/env.js.map +1 -0
  519. package/dist/src/utils/index.d.ts +5 -0
  520. package/dist/src/utils/index.js +4 -0
  521. package/dist/src/utils/index.js.map +1 -0
  522. package/dist/src/utils/secrets.d.ts +5 -0
  523. package/dist/src/utils/secrets.js +27 -0
  524. package/dist/src/utils/secrets.js.map +1 -0
  525. package/package.json +159 -0
@@ -0,0 +1,321 @@
1
+ const OPERATORS = [
2
+ { op: "|", precedence: 0, desc: "管道,左到右将结果传给下一个函数调用" },
3
+ { op: "||", precedence: 1, desc: "逻辑或" },
4
+ { op: "&&", precedence: 2, desc: "逻辑与" },
5
+ { op: "== / != / === / !==", precedence: 3, desc: "相等 / 不等比较" },
6
+ { op: "< / > / <= / >=", precedence: 4, desc: "大小比较" },
7
+ { op: "+ / -", precedence: 5, desc: "加 / 减(+ 也用于字符串拼接)" },
8
+ { op: "* / / / %", precedence: 6, desc: "乘 / 除 / 取余" },
9
+ { op: "**", precedence: 7, desc: "幂运算(右结合)" },
10
+ { op: "! / u-", precedence: 8, desc: "逻辑非 / 取负(一元运算符)" },
11
+ ];
12
+ const FN_GROUPS = [
13
+ { category: "数学", items: "abs, ceil, floor, round, min, max, sqrt, pow" },
14
+ {
15
+ category: "字符串(内置)",
16
+ items: "length, substring, toLowerCase, toUpperCase, trim, concat, includes, startsWith, endsWith",
17
+ },
18
+ {
19
+ category: "字符串(函数库)",
20
+ items: "uuid, base64Encode, base64Decode, sha256, md5, slugify, truncate, padStart, padEnd, replaceAll, split",
21
+ },
22
+ {
23
+ category: "日期(内置)",
24
+ items: "now, parse, format, addDays, addHours",
25
+ },
26
+ {
27
+ category: "日期(函数库)",
28
+ items: "formatDate, dateDiff, addMinutes, startOfDay, endOfDay, isBefore, isAfter",
29
+ },
30
+ {
31
+ category: "数组(内置)",
32
+ items: "join, map, filter, reduce, find, some, every, flat, flatMap",
33
+ },
34
+ {
35
+ category: "集合(函数库)",
36
+ items: "flatten, unique, chunk, groupBy, sortBy, pick, omit, first, last, size, sum, avg, keys, values",
37
+ },
38
+ {
39
+ category: "类型转换",
40
+ items: "toNumber, toString, toBoolean, toJson, fromJson, typeOf, isEmpty, defaultTo",
41
+ },
42
+ ];
43
+ function escapeHtml(value) {
44
+ return value
45
+ .replace(/&/g, "&amp;")
46
+ .replace(/</g, "&lt;")
47
+ .replace(/>/g, "&gt;");
48
+ }
49
+ export function generateConceptsDocHtml(port) {
50
+ const opRows = OPERATORS.map((o) => `<tr><td><code>${escapeHtml(o.op)}</code></td><td>${o.precedence}</td><td>${escapeHtml(o.desc)}</td></tr>`).join("\n");
51
+ const fnRows = FN_GROUPS.map((g) => `<tr><td>${escapeHtml(g.category)}</td><td><code>${escapeHtml(g.items)}</code></td></tr>`).join("\n");
52
+ return `<!DOCTYPE html>
53
+ <html lang="zh-CN">
54
+ <head>
55
+ <meta charset="UTF-8" />
56
+ <meta name="viewport" content="width=device-width, initial-scale=1" />
57
+ <title>核心概念文档 - ts-workflow-engine-lite</title>
58
+ <style>
59
+ :root { color-scheme: light dark; }
60
+ * { box-sizing: border-box; }
61
+ body {
62
+ margin: 0;
63
+ font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif;
64
+ background: #0f172a;
65
+ color: #e2e8f0;
66
+ line-height: 1.65;
67
+ }
68
+ header {
69
+ padding: 32px 24px;
70
+ border-bottom: 1px solid #1e293b;
71
+ background: #111827;
72
+ }
73
+ header h1 { margin: 0 0 4px; font-size: 22px; }
74
+ header a { color: #60a5fa; text-decoration: none; font-size: 13px; }
75
+ .layout { display: flex; max-width: 1100px; margin: 0 auto; }
76
+ nav {
77
+ flex: 0 0 200px;
78
+ padding: 24px 16px;
79
+ position: sticky;
80
+ top: 0;
81
+ align-self: flex-start;
82
+ }
83
+ nav a {
84
+ display: block;
85
+ padding: 6px 10px;
86
+ border-radius: 6px;
87
+ color: #94a3b8;
88
+ text-decoration: none;
89
+ font-size: 13px;
90
+ margin-bottom: 2px;
91
+ }
92
+ nav a:hover { background: #1e293b; color: #e2e8f0; }
93
+ main { flex: 1; padding: 24px 24px 100px; min-width: 0; }
94
+ section { margin-bottom: 48px; scroll-margin-top: 16px; }
95
+ h2 {
96
+ font-size: 20px;
97
+ margin: 0 0 6px;
98
+ color: #f1f5f9;
99
+ }
100
+ h2 .tag {
101
+ font-size: 12px;
102
+ font-weight: 400;
103
+ color: #64748b;
104
+ margin-left: 8px;
105
+ }
106
+ h3 { font-size: 15px; color: #cbd5e1; margin: 24px 0 8px; }
107
+ p { color: #cbd5e1; }
108
+ code {
109
+ background: #1e293b;
110
+ padding: 2px 6px;
111
+ border-radius: 4px;
112
+ font-size: 13px;
113
+ color: #7dd3fc;
114
+ }
115
+ pre {
116
+ background: #1e293b;
117
+ border: 1px solid #334155;
118
+ border-radius: 8px;
119
+ padding: 14px 16px;
120
+ overflow-x: auto;
121
+ font-size: 13px;
122
+ }
123
+ table { width: 100%; border-collapse: collapse; font-size: 13.5px; margin-top: 8px; }
124
+ th, td { text-align: left; padding: 7px 10px; border-bottom: 1px solid #1e293b; vertical-align: top; }
125
+ th { color: #94a3b8; font-weight: 600; }
126
+ .callout {
127
+ border-left: 3px solid #2563eb;
128
+ background: #1e293b55;
129
+ padding: 10px 14px;
130
+ border-radius: 0 6px 6px 0;
131
+ font-size: 13.5px;
132
+ color: #cbd5e1;
133
+ margin: 12px 0;
134
+ }
135
+ .back { display: inline-block; margin-top: 8px; }
136
+ </style>
137
+ </head>
138
+ <body>
139
+ <header>
140
+ <h1>核心概念文档</h1>
141
+ <a href="/">&larr; 返回首页</a>
142
+ </header>
143
+ <div class="layout">
144
+ <nav>
145
+ <a href="#node-output">节点输出引用</a>
146
+ <a href="#expressions">表达式引擎</a>
147
+ <a href="#operators">运算符优先级</a>
148
+ <a href="#functions">内置函数</a>
149
+ <a href="#cas">并发控制(CAS)</a>
150
+ <a href="#lease">Lease 自动续期</a>
151
+ <a href="#heartbeat">Heartbeat 跟踪</a>
152
+ <a href="#storage">本地文件持久化</a>
153
+ <a href="#secrets">密钥解析</a>
154
+ <a href="#worker-pool">Worker 线程池</a>
155
+ <a href="#task-queue">任务队列路由</a>
156
+ <a href="#archive">终态实例归档</a>
157
+ <a href="#join-transform">join / transform / durable wait</a>
158
+ <a href="#integration">持久化与外部集成增强</a>
159
+ </nav>
160
+ <main>
161
+
162
+ <section id="node-output">
163
+ <h2>节点输出引用</h2>
164
+ <p>后续节点可以通过 <code>\${nodeId.output}</code> 或 <code>\${nodeId.output.path.to.value}</code> 引用前面已执行节点的输出结果,用于配置字段(如 <code>condition</code>、HTTP body、通知内容等)。</p>
165
+ <pre><code>{
166
+ "type": "action",
167
+ "config": {
168
+ // 直接引用整个输出对象
169
+ "input": "\${validate-order.output}",
170
+
171
+ // 引用输出对象的某个字段
172
+ "amount": "\${validate-order.output.amount}",
173
+
174
+ // 在表达式中参与运算
175
+ "discountedPrice": "\${node1.output.price * 0.8}",
176
+
177
+ // 结合比较运算做条件路由
178
+ "isPremium": "\${check-amount.output.total > 1000}"
179
+ }
180
+ }</code></pre>
181
+ <div class="callout">
182
+ 引用不存在的节点或字段时不会抛出异常,而是解析为 <code>undefined</code> 并记录一条 warn 日志(详见
183
+ <code>resolveNodeOutput</code>,<a href="https://github.com/CracKerMe/ts-workflow-engine-lite/blob/main/src/engine/ExpressionEvaluator.ts" target="_blank" rel="noopener">ExpressionEvaluator.ts</a>)。
184
+ 调试时可查看该节点日志确认输出结构是否符合预期。
185
+ </div>
186
+ <p>普通上下文变量(工作流启动时传入的 <code>input</code>)同样用 <code>\${variable}</code> 或 <code>\${context.path}</code> 语法引用,与节点输出引用可以混用在同一个字符串模板中。</p>
187
+ </section>
188
+
189
+ <section id="expressions">
190
+ <h2>表达式引擎</h2>
191
+ <p>表达式字符串(如 <code>condition</code> 节点的 <code>condition</code> 字段)由内置的 Shunting-Yard 解析器求值,支持数学 / 比较 / 逻辑运算符、函数调用、数组/对象访问,以及箭头函数(用于 <code>map</code>/<code>filter</code> 等高阶函数)。</p>
192
+ <pre><code>\${amount > 1000 && status == "approved"}
193
+ \${max(a, b) * 1.1}
194
+ \${round(price * (1 - discount), 2)}
195
+ \${items.filter(x => x.qty > 0).length}
196
+ \${user.roles.includes("admin")}</code></pre>
197
+ <h3 id="operators">运算符优先级</h3>
198
+ <p>数字越大优先级越高,同级按结合方向从左到右(<code>**</code> 例外,右结合)求值:</p>
199
+ <table>
200
+ <thead><tr><th>运算符</th><th>优先级</th><th>说明</th></tr></thead>
201
+ <tbody>
202
+ ${opRows}
203
+ </tbody>
204
+ </table>
205
+
206
+ <h3 id="functions">内置函数</h3>
207
+ <p>共 20+ 内置函数,按类别列出:</p>
208
+ <table>
209
+ <thead><tr><th>分类</th><th>函数</th></tr></thead>
210
+ <tbody>
211
+ ${fnRows}
212
+ </tbody>
213
+ </table>
214
+ <div class="callout">
215
+ 完整函数目录(含参数签名与中文说明)可通过接口实时获取:
216
+ <code>GET http://localhost:${port}/workflow-api/v1/functions</code>。
217
+ 也可以通过 <code>POST /workflow-api/v1/functions</code> 注册自定义函数,实现见
218
+ <code>src/engine/functions/customFunctions.ts</code>。
219
+ </div>
220
+ </section>
221
+
222
+ <section id="cas">
223
+ <h2>并发控制(CAS)</h2>
224
+ <p><code>WorkflowInstance</code> 携带 <code>version</code> 字段。每次更新实例状态时,存储层会比对期望版本号,
225
+ 版本不一致(说明有并发写入)则更新失败并自动重试,从根本上避免 Lost Update 问题。</p>
226
+ <p>实现见 <code>src/engine/ConcurrencyControl.ts</code>。</p>
227
+ </section>
228
+
229
+ <section id="lease">
230
+ <h2>Lease 自动续期</h2>
231
+ <p>防止长运行任务因超时被误判为失败而重复执行。任务开始时获取一个带过期时间的 Lease,
232
+ <code>LeaseStore.startAutoRenewal()</code> 在后台周期性续期,任务结束或进程退出时释放。</p>
233
+ <p>单进程内存实现,不提供跨进程协调;实现见 <code>src/utils/LeaseStore.ts</code>。</p>
234
+ </section>
235
+
236
+ <section id="heartbeat">
237
+ <h2>Heartbeat 跟踪</h2>
238
+ <p>长时间运行的 <code>action</code> 节点可通过 <code>heartbeat</code> 配置定期上报进度。
239
+ <code>HeartbeatManager</code> 通过 <code>StorageProvider</code> 保存和恢复 Heartbeat 状态:
240
+ 使用默认 <code>LocalFileStorage</code> 时可跨进程重启恢复,使用 <code>MemoryStorage</code> 时仅在当前进程生命周期内保留。</p>
241
+ <p>实现见 <code>src/engine/HeartbeatManager.ts</code>。</p>
242
+ </section>
243
+
244
+ <section id="storage">
245
+ <h2>本地文件持久化</h2>
246
+ <p>非测试环境默认使用 <code>LocalFileStorage</code>,数据目录由 <code>STORAGE_DIR</code> 指定(默认 <code>.ts-workflow-engine-data/</code>)。
247
+ 每条记录独立保存为 JSON 文件,通过临时文件 + 原子 rename 更新,避免写入过程中数据损坏。</p>
248
+ <p>数据按 <code>instances</code>、<code>workflows</code>、<code>workflow-versions</code>、<code>waiting</code>、<code>metrics</code>、<code>events</code>、<code>heartbeats</code>、<code>dlq</code> 等目录分类;
249
+ 启动时无法解析的记录会被隔离到对应分类下的 <code>corrupt/</code> 目录,不阻断其余数据恢复。</p>
250
+ <div class="callout">
251
+ 含 JavaScript 函数/闭包的工作流定义无法序列化。启动时应先关闭自动恢复、由应用代码重新注册这些定义,
252
+ 再调用 <code>engine.resumeRunningInstancesFromStorage()</code> 恢复未完成实例。
253
+ </div>
254
+ <p>本地文件存储不提供跨进程锁,同一个 <code>STORAGE_DIR</code> 只能由一个引擎进程使用。</p>
255
+ </section>
256
+
257
+ <section id="secrets">
258
+ <h2>密钥解析(SecretManager)</h2>
259
+ <p>节点配置中可写 <code>\${secret:NAME}</code>,在 <code>http</code> / <code>sql</code> / <code>queue</code> 节点执行前解析(含嵌套字段)。
260
+ 由 <code>SECRET_PROVIDER</code> 选择后端,默认 <code>env</code>(从环境变量读取)。</p>
261
+ <div class="callout">
262
+ <code>vault</code> / <code>aws-secrets-manager</code> 尚未实现,配置后在启动时抛 <code>UnsupportedSecretProviderError</code>,不会静默回退。
263
+ 未找到的密钥保留原样并记录 warn 日志,不会替换成 <code>undefined</code>。
264
+ </div>
265
+ <p>实现见 <code>src/utils/SecretManager.ts</code> 与 <code>src/utils/secrets.ts</code>。</p>
266
+ </section>
267
+
268
+ <section id="worker-pool">
269
+ <h2>Worker 线程池与 Sticky 亲和性</h2>
270
+ <p><code>WORKER_POOL_ENABLED=true</code> 时,<code>http</code> 节点卸载到 worker 线程执行。
271
+ 每个 worker 有稳定 <code>workerId</code>;同一实例的后续任务优先路由回已绑定的 worker(<code>WORKER_STICKY_ENABLED</code>),
272
+ 绑定的 worker 忙碌时会回退到任意空闲 worker —— 亲和性只做优化,不会阻塞任务。worker 退出或池关闭时释放绑定,
273
+ 避免实例被绑死在已终止的线程上。</p>
274
+ <p>实现见 <code>src/engine/worker/WorkerPool.ts</code> 与 <code>src/engine/StickyExecutionManager.ts</code>。</p>
275
+ </section>
276
+
277
+ <section id="task-queue">
278
+ <h2>任务队列路由(TaskQueueManager)</h2>
279
+ <p><code>action</code> / <code>rollback</code> 节点可通过 <code>taskQueue: "queue-name"</code> 路由到命名队列。
280
+ 队列 worker 通过 <code>taskQueueManager.registerWorker()</code> 注册,受 <code>maxConcurrent</code> 限流;
281
+ 队列无 worker 时回退为本地直接执行,节点不会被卡住。</p>
282
+ <p>与 <code>queue</code> 节点类型不同:后者对接外部消息中间件,这里是进程内的工作分发。实现见 <code>src/engine/TaskQueueManager.ts</code>。</p>
283
+ </section>
284
+
285
+ <section id="archive">
286
+ <h2>终态实例归档</h2>
287
+ <p>归档默认关闭,通过 <code>ARCHIVE_ENABLED=true</code> 启用。终态实例写入 <code>archive/YYYY-MM-DD/&lt;instanceId&gt;.json</code>
288
+ 后,才从热存储移除。<code>ARCHIVE_RETENTION_DAYS</code> 控制日期分区保留时间,<code>ARCHIVE_CLEANUP_INTERVAL_MS</code> 控制清理周期。</p>
289
+ <div class="callout">归档文件是冷数据,不会自动参与实例查询或启动恢复。</div>
290
+ </section>
291
+
292
+ <section id="join-transform">
293
+ <h2>join / transform 节点与 durable wait</h2>
294
+ <p><code>join</code>:等待 <code>config.waitFor</code> 列出的分支节点完成,<code>mode: "all" | "any"</code>;
295
+ 依赖引擎批量 fan-out 执行,单进程场景下无需额外 CAS/加锁。</p>
296
+ <p><code>transform</code>:通过类型化表达式求值重塑节点输出(而非字符串插值),数字/数组/对象保持原生类型,不强制转成字符串。</p>
297
+ <p><code>wait</code> 节点新增 <code>config.durationMs</code> / <code>config.until</code>(绝对截止时间)作为相对时长/绝对时间的显式写法,
298
+ 优先级高于旧的顶层 <code>timeout</code> 字段。</p>
299
+ <p>字段详情见 <a href="https://github.com/CracKerMe/ts-workflow-engine-lite/blob/main/docs/NODE_REFERENCE.md" target="_blank" rel="noopener">docs/NODE_REFERENCE.md</a> 的
300
+ <code>join</code>/<code>transform</code>/<code>wait</code> 章节。</p>
301
+ </section>
302
+
303
+ <section id="integration">
304
+ <h2>持久化与外部集成增强</h2>
305
+ <p><code>FSYNC_ON_WRITE=true</code> 时,<code>LocalFileStorage</code> 每次写入会 fsync 临时文件和所在目录,
306
+ 换取主机级崩溃/断电下的持久性(代价是写入延迟明显增加);默认 <code>false</code>,仅保证原子 rename 后文件本身完整。</p>
307
+ <p><code>createWorkflowRouter()</code> / <code>createWorkflowRouterBundle()</code> 允许宿主 Express 应用将工作流 API
308
+ 挂载为普通 <code>express.Router</code>,无需通过 <code>startApiServer()</code> 独立运行。</p>
309
+ <p>高频查找/并发错误改用具名错误类导出(<code>WorkflowNotFoundError</code>、<code>InstanceNotFoundError</code>、
310
+ <code>ConcurrencyConflictError</code>、<code>LockAcquisitionError</code>),支持 <code>instanceof</code> 判断而非匹配错误消息字符串。</p>
311
+ <div class="callout">
312
+ 示例见 <code>examples/embedded-express-app.ts</code> 与 <code>examples/error-handling.ts</code>。
313
+ </div>
314
+ </section>
315
+
316
+ </main>
317
+ </div>
318
+ </body>
319
+ </html>`;
320
+ }
321
+ //# sourceMappingURL=docsPage.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"docsPage.js","sourceRoot":"","sources":["../../../src/api/docsPage.ts"],"names":[],"mappings":"AAWA,MAAM,SAAS,GAAmB;IAChC,EAAE,EAAE,EAAE,GAAG,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,oBAAoB,EAAE;IACtD,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE;IACxC,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE;IACxC,EAAE,EAAE,EAAE,qBAAqB,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE;IAC/D,EAAE,EAAE,EAAE,iBAAiB,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE;IACtD,EAAE,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,mBAAmB,EAAE;IACzD,EAAE,EAAE,EAAE,WAAW,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,YAAY,EAAE;IACtD,EAAE,EAAE,EAAE,IAAI,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE;IAC7C,EAAE,EAAE,EAAE,QAAQ,EAAE,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,iBAAiB,EAAE;CACzD,CAAC;AAOF,MAAM,SAAS,GAAc;IAC3B,EAAE,QAAQ,EAAE,IAAI,EAAE,KAAK,EAAE,8CAA8C,EAAE;IACzE;QACE,QAAQ,EAAE,SAAS;QACnB,KAAK,EACH,2FAA2F;KAC9F;IACD;QACE,QAAQ,EAAE,UAAU;QACpB,KAAK,EACH,uGAAuG;KAC1G;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,KAAK,EAAE,uCAAuC;KAC/C;IACD;QACE,QAAQ,EAAE,SAAS;QACnB,KAAK,EACH,2EAA2E;KAC9E;IACD;QACE,QAAQ,EAAE,QAAQ;QAClB,KAAK,EAAE,6DAA6D;KACrE;IACD;QACE,QAAQ,EAAE,SAAS;QACnB,KAAK,EACH,gGAAgG;KACnG;IACD;QACE,QAAQ,EAAE,MAAM;QAChB,KAAK,EACH,6EAA6E;KAChF;CACF,CAAC;AAEF,SAAS,UAAU,CAAC,KAAa;IAC/B,OAAO,KAAK;SACT,OAAO,CAAC,IAAI,EAAE,OAAO,CAAC;SACtB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC;SACrB,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,UAAU,uBAAuB,CAAC,IAAY;IAClD,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAC1B,CAAC,CAAC,EAAE,EAAE,CACJ,iBAAiB,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC,mBAAmB,CAAC,CAAC,UAAU,YAAY,UAAU,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAC7G,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,MAAM,MAAM,GAAG,SAAS,CAAC,GAAG,CAC1B,CAAC,CAAC,EAAE,EAAE,CACJ,WAAW,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,kBAAkB,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,mBAAmB,CAC5F,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAsJP,MAAM;;;;;;;;;EASN,MAAM;;;;;mCAK2B,IAAI;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;QAuG/B,CAAC;AACT,CAAC"}
@@ -0,0 +1,8 @@
1
+ export { ApiError, ErrorCode, errorHandler } from "./ErrorHandler.js";
2
+ export { EventHistoryManager } from "./EventHistory.js";
3
+ export { generateConceptsDocHtml } from "./docsPage.js";
4
+ export { generateApiDocsHtml, openApiSpec } from "./openapi.js";
5
+ export { generateWelcomeHtml } from "./welcomePage.js";
6
+ export type { ApiServerConfig } from "./server.js";
7
+ export { startApiServer, startServer } from "./server.js";
8
+ export { WebhookManager } from "./WebhookManager.js";
@@ -0,0 +1,8 @@
1
+ export { ApiError, ErrorCode, errorHandler } from "./ErrorHandler.js";
2
+ export { EventHistoryManager } from "./EventHistory.js";
3
+ export { generateConceptsDocHtml } from "./docsPage.js";
4
+ export { generateApiDocsHtml, openApiSpec } from "./openapi.js";
5
+ export { generateWelcomeHtml } from "./welcomePage.js";
6
+ export { startApiServer, startServer } from "./server.js";
7
+ export { WebhookManager } from "./WebhookManager.js";
8
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,gBAAgB,CAAC;AACrD,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC;AACrD,OAAO,EAAE,mBAAmB,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAC7D,OAAO,EAAE,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAEpD,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC"}
@@ -0,0 +1,19 @@
1
+ import type { NextFunction, Request, Response } from "express";
2
+ export interface AuthUser {
3
+ id: string;
4
+ tenantId?: string;
5
+ role?: string;
6
+ [key: string]: unknown;
7
+ }
8
+ declare global {
9
+ namespace Express {
10
+ interface Request {
11
+ user?: AuthUser;
12
+ }
13
+ }
14
+ }
15
+ export declare const jwtAuthMiddleware: (req: Request, res: Response, next: NextFunction) => void;
16
+ export declare const apiKeyAuthMiddleware: (req: Request, res: Response, next: NextFunction) => void;
17
+ export declare const combinedAuthMiddleware: (req: Request, res: Response, next: NextFunction) => void;
18
+ export declare function verifyWsToken(token: string): AuthUser | null;
19
+ export declare function generateToken(payload: AuthUser, expiresIn?: string): string;
@@ -0,0 +1,122 @@
1
+ import { createHash, timingSafeEqual } from "node:crypto";
2
+ import jwt from "jsonwebtoken";
3
+ import { getAppConfig } from "../../config/AppConfig.js";
4
+ import { Logger } from "../../utils/Logger.js";
5
+ import { sendError } from "../response.js";
6
+ import { isAuthEnabled } from "../utils/authConfig.js";
7
+ export const jwtAuthMiddleware = (req, res, next) => {
8
+ if (req.path === "/health" || req.path.endsWith("/health")) {
9
+ next();
10
+ return;
11
+ }
12
+ if (!isAuthEnabled()) {
13
+ next();
14
+ return;
15
+ }
16
+ const authHeader = req.headers.authorization;
17
+ if (!authHeader || !authHeader.startsWith("Bearer ")) {
18
+ sendError(res, 401, "UNAUTHORIZED", "Missing or invalid authorization header");
19
+ return;
20
+ }
21
+ const token = authHeader.split(" ")[1];
22
+ const jwtSecret = process.env.JWT_SECRET;
23
+ if (!jwtSecret) {
24
+ Logger.error("system", "auth", "JWT_SECRET not configured");
25
+ sendError(res, 500, "SERVER_ERROR", "Authentication not properly configured");
26
+ return;
27
+ }
28
+ try {
29
+ const decoded = jwt.verify(token, jwtSecret, {
30
+ algorithms: ["HS256", "HS384", "HS512"],
31
+ });
32
+ req.user = decoded;
33
+ next();
34
+ }
35
+ catch (error) {
36
+ const message = error instanceof jwt.TokenExpiredError
37
+ ? "Token has expired"
38
+ : "Invalid token";
39
+ sendError(res, 403, "FORBIDDEN", message);
40
+ }
41
+ };
42
+ function safeStringEqual(a, b) {
43
+ const hashA = createHash("sha256").update(a).digest();
44
+ const hashB = createHash("sha256").update(b).digest();
45
+ return timingSafeEqual(hashA, hashB);
46
+ }
47
+ export const apiKeyAuthMiddleware = (req, res, next) => {
48
+ if (req.path === "/health" || req.path.endsWith("/health")) {
49
+ next();
50
+ return;
51
+ }
52
+ if (!isAuthEnabled()) {
53
+ next();
54
+ return;
55
+ }
56
+ const apiKey = req.headers["x-api-key"];
57
+ const validApiKey = process.env.API_KEY;
58
+ if (!validApiKey) {
59
+ Logger.error("system", "auth", "API_KEY not configured");
60
+ sendError(res, 500, "SERVER_ERROR", "Authentication not properly configured");
61
+ return;
62
+ }
63
+ if (!apiKey || !safeStringEqual(apiKey, validApiKey)) {
64
+ sendError(res, 401, "UNAUTHORIZED", "Invalid or missing API key");
65
+ return;
66
+ }
67
+ const config = getAppConfig();
68
+ req.user = {
69
+ id: config.auth.apiKeyUserId,
70
+ role: config.auth.apiKeyRole,
71
+ };
72
+ next();
73
+ };
74
+ export const combinedAuthMiddleware = (req, res, next) => {
75
+ if (req.path === "/health" || req.path.endsWith("/health")) {
76
+ next();
77
+ return;
78
+ }
79
+ if (!isAuthEnabled()) {
80
+ next();
81
+ return;
82
+ }
83
+ const authHeader = req.headers.authorization;
84
+ if (authHeader?.startsWith("Bearer ")) {
85
+ jwtAuthMiddleware(req, res, next);
86
+ return;
87
+ }
88
+ const apiKey = req.headers["x-api-key"];
89
+ if (apiKey) {
90
+ apiKeyAuthMiddleware(req, res, next);
91
+ return;
92
+ }
93
+ Logger.warn("api", "auth", "Unauthenticated request rejected", {
94
+ path: req.path,
95
+ method: req.method,
96
+ ip: req.ip,
97
+ });
98
+ sendError(res, 401, "UNAUTHORIZED", "Authentication required. Provide Bearer token or X-API-Key header.");
99
+ };
100
+ export function verifyWsToken(token) {
101
+ const jwtSecret = process.env.JWT_SECRET;
102
+ if (!jwtSecret)
103
+ return null;
104
+ try {
105
+ return jwt.verify(token, jwtSecret, {
106
+ algorithms: ["HS256", "HS384", "HS512"],
107
+ });
108
+ }
109
+ catch {
110
+ return null;
111
+ }
112
+ }
113
+ export function generateToken(payload, expiresIn = "24h") {
114
+ const jwtSecret = process.env.JWT_SECRET;
115
+ if (!jwtSecret) {
116
+ throw new Error("JWT_SECRET not configured");
117
+ }
118
+ return jwt.sign(payload, jwtSecret, {
119
+ expiresIn: expiresIn,
120
+ });
121
+ }
122
+ //# sourceMappingURL=auth.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"auth.js","sourceRoot":"","sources":["../../../../src/api/middleware/auth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,aAAa,CAAC;AAE1D,OAAO,GAAG,MAAM,cAAc,CAAC;AAC/B,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAoBpD,MAAM,CAAC,MAAM,iBAAiB,GAAG,CAC/B,GAAY,EACZ,GAAa,EACb,IAAkB,EACZ,EAAE;IAER,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3D,IAAI,EAAE,CAAC;QACP,OAAO;IACT,CAAC;IAGD,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;QACrB,IAAI,EAAE,CAAC;QACP,OAAO;IACT,CAAC;IAED,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC;IAC7C,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QACrD,SAAS,CACP,GAAG,EACH,GAAG,EACH,cAAc,EACd,yCAAyC,CAC1C,CAAC;QACF,OAAO;IACT,CAAC;IAED,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;IACvC,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;IAEzC,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,2BAA2B,CAAC,CAAC;QAC5D,SAAS,CACP,GAAG,EACH,GAAG,EACH,cAAc,EACd,wCAAwC,CACzC,CAAC;QACF,OAAO;IACT,CAAC;IAED,IAAI,CAAC;QACH,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE;YAC3C,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC;SACxC,CAAa,CAAC;QACf,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC;QACnB,IAAI,EAAE,CAAC;IACT,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,OAAO,GACX,KAAK,YAAY,GAAG,CAAC,iBAAiB;YACpC,CAAC,CAAC,mBAAmB;YACrB,CAAC,CAAC,eAAe,CAAC;QAEtB,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;IAC5C,CAAC;AACH,CAAC,CAAC;AAMF,SAAS,eAAe,CAAC,CAAS,EAAE,CAAS;IAC3C,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACtD,MAAM,KAAK,GAAG,UAAU,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC;IACtD,OAAO,eAAe,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;AACvC,CAAC;AAKD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAClC,GAAY,EACZ,GAAa,EACb,IAAkB,EACZ,EAAE;IAER,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3D,IAAI,EAAE,CAAC;QACP,OAAO;IACT,CAAC;IAGD,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;QACrB,IAAI,EAAE,CAAC;QACP,OAAO;IACT,CAAC;IAED,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,CAAW,CAAC;IAClD,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC;IAExC,IAAI,CAAC,WAAW,EAAE,CAAC;QACjB,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,MAAM,EAAE,wBAAwB,CAAC,CAAC;QACzD,SAAS,CACP,GAAG,EACH,GAAG,EACH,cAAc,EACd,wCAAwC,CACzC,CAAC;QACF,OAAO;IACT,CAAC;IAGD,IAAI,CAAC,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,CAAC;QACrD,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,cAAc,EAAE,4BAA4B,CAAC,CAAC;QAClE,OAAO;IACT,CAAC;IAGD,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;IAC9B,GAAG,CAAC,IAAI,GAAG;QACT,EAAE,EAAE,MAAM,CAAC,IAAI,CAAC,YAAY;QAC5B,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU;KAC7B,CAAC;IAEF,IAAI,EAAE,CAAC;AACT,CAAC,CAAC;AAKF,MAAM,CAAC,MAAM,sBAAsB,GAAG,CACpC,GAAY,EACZ,GAAa,EACb,IAAkB,EACZ,EAAE;IAER,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3D,IAAI,EAAE,CAAC;QACP,OAAO;IACT,CAAC;IAGD,IAAI,CAAC,aAAa,EAAE,EAAE,CAAC;QACrB,IAAI,EAAE,CAAC;QACP,OAAO;IACT,CAAC;IAGD,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,aAAa,CAAC;IAC7C,IAAI,UAAU,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;QACtC,iBAAiB,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QAClC,OAAO;IACT,CAAC;IAGD,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACxC,IAAI,MAAM,EAAE,CAAC;QACX,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC,CAAC;QACrC,OAAO;IACT,CAAC;IAED,MAAM,CAAC,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,kCAAkC,EAAE;QAC7D,IAAI,EAAE,GAAG,CAAC,IAAI;QACd,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,EAAE,EAAE,GAAG,CAAC,EAAE;KACX,CAAC,CAAC;IAEH,SAAS,CACP,GAAG,EACH,GAAG,EACH,cAAc,EACd,oEAAoE,CACrE,CAAC;AACJ,CAAC,CAAC;AAMF,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;IACzC,IAAI,CAAC,SAAS;QAAE,OAAO,IAAI,CAAC;IAE5B,IAAI,CAAC;QACH,OAAO,GAAG,CAAC,MAAM,CAAC,KAAK,EAAE,SAAS,EAAE;YAClC,UAAU,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC;SACxC,CAAa,CAAC;IACjB,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAKD,MAAM,UAAU,aAAa,CAAC,OAAiB,EAAE,SAAS,GAAG,KAAK;IAChE,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC;IACzC,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;IAC/C,CAAC;IACD,OAAO,GAAG,CAAC,IAAI,CAAC,OAAiB,EAAE,SAAS,EAAE;QAC5C,SAAS,EAAE,SAAyC;KACrD,CAAC,CAAC;AACL,CAAC"}
@@ -0,0 +1,3 @@
1
+ export type { AuthUser } from "./auth.js";
2
+ export { apiKeyAuthMiddleware, combinedAuthMiddleware, generateToken, jwtAuthMiddleware, } from "./auth.js";
3
+ export { createRateLimiter, rateLimitMiddleware } from "./rateLimit.js";
@@ -0,0 +1,3 @@
1
+ export { apiKeyAuthMiddleware, combinedAuthMiddleware, generateToken, jwtAuthMiddleware, } from "./auth.js";
2
+ export { createRateLimiter, rateLimitMiddleware } from "./rateLimit.js";
3
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/api/middleware/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,oBAAoB,EACpB,sBAAsB,EACtB,aAAa,EACb,iBAAiB,GAClB,MAAM,QAAQ,CAAC;AAEhB,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC"}
@@ -0,0 +1,6 @@
1
+ import type { NextFunction, Request, Response } from "express";
2
+ import type { StorageProvider } from "../../storage/StorageProvider.js";
3
+ import { type RateLimitStore } from "./rateLimitStore.js";
4
+ export declare function initRateLimiter(_storage: StorageProvider): void;
5
+ export declare const rateLimitMiddleware: (req: Request, res: Response, next: NextFunction) => Promise<void>;
6
+ export declare function createRateLimiter(windowMs: number, maxRequests: number, store?: RateLimitStore): (req: Request, res: Response, next: NextFunction) => Promise<void>;
@@ -0,0 +1,69 @@
1
+ import { parseEnvInt } from "../../utils/env.js";
2
+ import { Logger } from "../../utils/Logger.js";
3
+ import { sendError } from "../response.js";
4
+ import { MemoryRateLimitStore, } from "./rateLimitStore.js";
5
+ function getDefaultWindowMs() {
6
+ return parseEnvInt(process.env.RATE_LIMIT_WINDOW_MS, 60_000, { min: 1 });
7
+ }
8
+ function getDefaultMaxRequests() {
9
+ return parseEnvInt(process.env.RATE_LIMIT_MAX_REQUESTS, 100, { min: 1 });
10
+ }
11
+ const defaultStore = new MemoryRateLimitStore();
12
+ export function initRateLimiter(_storage) { }
13
+ async function checkLimit(store, key, windowMs, maxRequests) {
14
+ try {
15
+ return await store.hit(key, windowMs, maxRequests);
16
+ }
17
+ catch (error) {
18
+ Logger.warn("system", "rateLimit", "Rate limit store error, failing open", {
19
+ error: error instanceof Error ? error.message : String(error),
20
+ });
21
+ return {
22
+ allowed: true,
23
+ remaining: maxRequests,
24
+ resetTime: Date.now() + windowMs,
25
+ };
26
+ }
27
+ }
28
+ function applyRateLimitHeaders(res, maxRequests, result) {
29
+ res.setHeader("X-RateLimit-Limit", maxRequests.toString());
30
+ res.setHeader("X-RateLimit-Remaining", result.remaining.toString());
31
+ res.setHeader("X-RateLimit-Reset", Math.ceil(result.resetTime / 1000).toString());
32
+ }
33
+ export const rateLimitMiddleware = async (req, res, next) => {
34
+ if (req.path === "/health" || req.path.endsWith("/health")) {
35
+ next();
36
+ return;
37
+ }
38
+ if (process.env.RATE_LIMIT_ENABLED === "false") {
39
+ next();
40
+ return;
41
+ }
42
+ const key = req.ip || req.socket.remoteAddress || "unknown";
43
+ const maxRequests = getDefaultMaxRequests();
44
+ const result = await checkLimit(defaultStore, key, getDefaultWindowMs(), maxRequests);
45
+ applyRateLimitHeaders(res, maxRequests, result);
46
+ if (!result.allowed) {
47
+ Logger.warn("system", "rateLimit", `Rate limit exceeded for ${key}`);
48
+ sendError(res, 429, "RATE_LIMIT_EXCEEDED", "Too many requests, please try again later", {
49
+ retryAfter: Math.ceil((result.resetTime - Date.now()) / 1000),
50
+ });
51
+ return;
52
+ }
53
+ next();
54
+ };
55
+ export function createRateLimiter(windowMs, maxRequests, store = new MemoryRateLimitStore()) {
56
+ return async (req, res, next) => {
57
+ const key = req.ip || req.socket.remoteAddress || "unknown";
58
+ const result = await checkLimit(store, key, windowMs, maxRequests);
59
+ applyRateLimitHeaders(res, maxRequests, result);
60
+ if (!result.allowed) {
61
+ sendError(res, 429, "RATE_LIMIT_EXCEEDED", "Too many requests", {
62
+ retryAfter: Math.ceil((result.resetTime - Date.now()) / 1000),
63
+ });
64
+ return;
65
+ }
66
+ next();
67
+ };
68
+ }
69
+ //# sourceMappingURL=rateLimit.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rateLimit.js","sourceRoot":"","sources":["../../../../src/api/middleware/rateLimit.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAC5C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,OAAO,EACL,oBAAoB,GAGrB,MAAM,kBAAkB,CAAC;AAK1B,SAAS,kBAAkB;IACzB,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,MAAM,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;AAC3E,CAAC;AAED,SAAS,qBAAqB;IAC5B,OAAO,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,uBAAuB,EAAE,GAAG,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;AAC3E,CAAC;AAGD,MAAM,YAAY,GAAmB,IAAI,oBAAoB,EAAE,CAAC;AAKhE,MAAM,UAAU,eAAe,CAAC,QAAyB,IAAS,CAAC;AAEnE,KAAK,UAAU,UAAU,CACvB,KAAqB,EACrB,GAAW,EACX,QAAgB,EAChB,WAAmB;IAEnB,IAAI,CAAC;QACH,OAAO,MAAM,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;IACrD,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAEf,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,sCAAsC,EAAE;YACzE,KAAK,EAAE,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC;SAC9D,CAAC,CAAC;QACH,OAAO;YACL,OAAO,EAAE,IAAI;YACb,SAAS,EAAE,WAAW;YACtB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,QAAQ;SACjC,CAAC;IACJ,CAAC;AACH,CAAC;AAED,SAAS,qBAAqB,CAC5B,GAAa,EACb,WAAmB,EACnB,MAAuB;IAEvB,GAAG,CAAC,SAAS,CAAC,mBAAmB,EAAE,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAC;IAC3D,GAAG,CAAC,SAAS,CAAC,uBAAuB,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IACpE,GAAG,CAAC,SAAS,CACX,mBAAmB,EACnB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC,QAAQ,EAAE,CAC9C,CAAC;AACJ,CAAC;AAKD,MAAM,CAAC,MAAM,mBAAmB,GAAG,KAAK,EACtC,GAAY,EACZ,GAAa,EACb,IAAkB,EACH,EAAE;IAEjB,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QAC3D,IAAI,EAAE,CAAC;QACP,OAAO;IACT,CAAC;IAGD,IAAI,OAAO,CAAC,GAAG,CAAC,kBAAkB,KAAK,OAAO,EAAE,CAAC;QAC/C,IAAI,EAAE,CAAC;QACP,OAAO;IACT,CAAC;IAGD,MAAM,GAAG,GAAG,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa,IAAI,SAAS,CAAC;IAC5D,MAAM,WAAW,GAAG,qBAAqB,EAAE,CAAC;IAC5C,MAAM,MAAM,GAAG,MAAM,UAAU,CAC7B,YAAY,EACZ,GAAG,EACH,kBAAkB,EAAE,EACpB,WAAW,CACZ,CAAC;IAEF,qBAAqB,CAAC,GAAG,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;IAEhD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,CAAC,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,2BAA2B,GAAG,EAAE,CAAC,CAAC;QACrE,SAAS,CACP,GAAG,EACH,GAAG,EACH,qBAAqB,EACrB,2CAA2C,EAC3C;YACE,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC;SAC9D,CACF,CAAC;QACF,OAAO;IACT,CAAC;IAED,IAAI,EAAE,CAAC;AACT,CAAC,CAAC;AAKF,MAAM,UAAU,iBAAiB,CAC/B,QAAgB,EAChB,WAAmB,EACnB,QAAwB,IAAI,oBAAoB,EAAE;IAElD,OAAO,KAAK,EACV,GAAY,EACZ,GAAa,EACb,IAAkB,EACH,EAAE;QACjB,MAAM,GAAG,GAAG,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa,IAAI,SAAS,CAAC;QAC5D,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,KAAK,EAAE,GAAG,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;QAEnE,qBAAqB,CAAC,GAAG,EAAE,WAAW,EAAE,MAAM,CAAC,CAAC;QAEhD,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;YACpB,SAAS,CAAC,GAAG,EAAE,GAAG,EAAE,qBAAqB,EAAE,mBAAmB,EAAE;gBAC9D,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC;aAC9D,CAAC,CAAC;YACH,OAAO;QACT,CAAC;QAED,IAAI,EAAE,CAAC;IACT,CAAC,CAAC;AACJ,CAAC"}
@@ -0,0 +1,14 @@
1
+ export interface RateLimitResult {
2
+ allowed: boolean;
3
+ remaining: number;
4
+ resetTime: number;
5
+ }
6
+ export interface RateLimitStore {
7
+ hit(key: string, windowMs: number, maxRequests: number): Promise<RateLimitResult>;
8
+ }
9
+ export declare class MemoryRateLimitStore implements RateLimitStore {
10
+ private store;
11
+ private lastCleanup;
12
+ hit(key: string, windowMs: number, maxRequests: number): Promise<RateLimitResult>;
13
+ private maybeCleanup;
14
+ }