@pikku/core 0.12.79 → 0.12.82

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 (479) hide show
  1. package/CHANGELOG.md +473 -0
  2. package/dist/dev/hot-reload.js +1 -6
  3. package/dist/ecosystem.d.ts +27 -0
  4. package/dist/ecosystem.js +26 -0
  5. package/dist/errors/error-handler.js +4 -2
  6. package/dist/errors/index.d.ts +1 -1
  7. package/dist/errors/index.js +1 -1
  8. package/dist/function/function-runner.js +22 -47
  9. package/dist/function/functions.types.d.ts +9 -5
  10. package/dist/function/index.d.ts +1 -1
  11. package/dist/index.d.ts +14 -19
  12. package/dist/index.js +6 -11
  13. package/dist/middleware/auth-cookie.d.ts +0 -4
  14. package/dist/middleware/auth-cookie.js +38 -2
  15. package/dist/middleware/cors.js +1 -0
  16. package/dist/middleware/index.d.ts +1 -1
  17. package/dist/middleware/index.js +1 -1
  18. package/dist/middleware/remote-auth.js +14 -3
  19. package/dist/permissions.d.ts +8 -10
  20. package/dist/permissions.js +0 -11
  21. package/dist/pikku-state.js +16 -5
  22. package/dist/schema.js +35 -1
  23. package/dist/services/ai-agent-runner-service.d.ts +7 -0
  24. package/dist/services/ai-run-state-service.d.ts +17 -1
  25. package/dist/services/in-memory-ai-run-state-service.d.ts +6 -2
  26. package/dist/services/in-memory-ai-run-state-service.js +11 -1
  27. package/dist/services/in-memory-workflow-service.js +2 -0
  28. package/dist/services/index.d.ts +15 -15
  29. package/dist/services/index.js +5 -5
  30. package/dist/services/local-content-request-handler.d.ts +21 -0
  31. package/dist/services/local-content-request-handler.js +72 -53
  32. package/dist/services/local-content.d.ts +6 -0
  33. package/dist/services/local-content.js +14 -1
  34. package/dist/services/scoped-credential-service.d.ts +21 -0
  35. package/dist/services/scoped-credential-service.js +53 -0
  36. package/dist/services/workflow-service.d.ts +4 -2
  37. package/dist/testing/service-tests/agent-run-service-tests.d.ts +10 -0
  38. package/dist/testing/service-tests/agent-run-service-tests.js +72 -0
  39. package/dist/testing/service-tests/ai-storage-service-tests.d.ts +3 -0
  40. package/dist/testing/service-tests/ai-storage-service-tests.js +302 -0
  41. package/dist/testing/service-tests/channel-store-tests.d.ts +3 -0
  42. package/dist/testing/service-tests/channel-store-tests.js +72 -0
  43. package/dist/testing/service-tests/credential-service-tests.d.ts +3 -0
  44. package/dist/testing/service-tests/credential-service-tests.js +109 -0
  45. package/dist/testing/service-tests/deployment-service-tests.d.ts +3 -0
  46. package/dist/testing/service-tests/deployment-service-tests.js +21 -0
  47. package/dist/testing/service-tests/event-hub-store-tests.d.ts +3 -0
  48. package/dist/testing/service-tests/event-hub-store-tests.js +34 -0
  49. package/dist/testing/service-tests/secret-service-tests.d.ts +3 -0
  50. package/dist/testing/service-tests/secret-service-tests.js +80 -0
  51. package/dist/testing/service-tests/session-store-tests.d.ts +3 -0
  52. package/dist/testing/service-tests/session-store-tests.js +43 -0
  53. package/dist/testing/service-tests/workflow-run-service-tests.d.ts +3 -0
  54. package/dist/testing/service-tests/workflow-run-service-tests.js +42 -0
  55. package/dist/testing/service-tests/workflow-service-tests.d.ts +3 -0
  56. package/dist/testing/service-tests/workflow-service-tests.js +150 -0
  57. package/dist/testing/service-tests.d.ts +6 -0
  58. package/dist/testing/service-tests.js +26 -791
  59. package/dist/types/core.types.d.ts +11 -3
  60. package/dist/types/state.types.d.ts +14 -1
  61. package/dist/wirings/actor-flow/index.d.ts +1 -1
  62. package/dist/wirings/actor-flow/run-conversation.js +1 -6
  63. package/dist/wirings/ai-agent/agent-rpc.d.ts +15 -0
  64. package/dist/wirings/ai-agent/agent-rpc.js +53 -0
  65. package/dist/wirings/ai-agent/ai-agent-agui.js +1 -5
  66. package/dist/wirings/ai-agent/ai-agent-finalize.d.ts +58 -0
  67. package/dist/wirings/ai-agent/ai-agent-finalize.js +138 -0
  68. package/dist/wirings/ai-agent/ai-agent-interrupt.js +1 -0
  69. package/dist/wirings/ai-agent/ai-agent-memory.d.ts +2 -8
  70. package/dist/wirings/ai-agent/ai-agent-memory.js +37 -18
  71. package/dist/wirings/ai-agent/ai-agent-model-config.d.ts +7 -0
  72. package/dist/wirings/ai-agent/ai-agent-model-config.js +44 -1
  73. package/dist/wirings/ai-agent/ai-agent-prepare.js +5 -9
  74. package/dist/wirings/ai-agent/ai-agent-runner.js +89 -147
  75. package/dist/wirings/ai-agent/ai-agent-stream.js +109 -97
  76. package/dist/wirings/ai-agent/ai-agent-turn.d.ts +57 -0
  77. package/dist/wirings/ai-agent/ai-agent-turn.js +82 -0
  78. package/dist/wirings/ai-agent/ai-agent.types.d.ts +47 -2
  79. package/dist/wirings/ai-agent/index.d.ts +8 -7
  80. package/dist/wirings/ai-agent/index.js +5 -4
  81. package/dist/wirings/ai-agent/voice-input.js +1 -6
  82. package/dist/wirings/ai-agent/voice-output.js +2 -12
  83. package/dist/wirings/ai-scorer/ai-scorer-grade.d.ts +26 -0
  84. package/dist/wirings/ai-scorer/ai-scorer-grade.js +33 -0
  85. package/dist/wirings/ai-scorer/ai-scorer-judge.d.ts +17 -0
  86. package/dist/wirings/ai-scorer/ai-scorer-judge.js +92 -0
  87. package/dist/wirings/ai-scorer/ai-scorer-live.d.ts +15 -0
  88. package/dist/wirings/ai-scorer/ai-scorer-live.js +38 -0
  89. package/dist/wirings/ai-scorer/ai-scorer-registry.d.ts +18 -0
  90. package/dist/wirings/ai-scorer/ai-scorer-registry.js +46 -0
  91. package/dist/wirings/ai-scorer/ai-scorer-sampling.d.ts +8 -0
  92. package/dist/wirings/ai-scorer/ai-scorer-sampling.js +31 -0
  93. package/dist/wirings/ai-scorer/ai-scorer-snapshots.d.ts +10 -0
  94. package/dist/wirings/ai-scorer/ai-scorer-snapshots.js +40 -0
  95. package/dist/wirings/ai-scorer/ai-scorer-worker.d.ts +15 -0
  96. package/dist/wirings/ai-scorer/ai-scorer-worker.js +58 -0
  97. package/dist/wirings/ai-scorer/ai-scorer.d.ts +39 -0
  98. package/dist/wirings/ai-scorer/ai-scorer.js +40 -0
  99. package/dist/wirings/ai-scorer/ai-scorer.types.d.ts +90 -0
  100. package/dist/wirings/ai-scorer/ai-scorer.types.js +4 -0
  101. package/dist/wirings/ai-scorer/index.d.ts +6 -0
  102. package/dist/wirings/ai-scorer/index.js +5 -0
  103. package/dist/wirings/channel/channel-common.js +1 -0
  104. package/dist/wirings/channel/channel-handler.js +3 -5
  105. package/dist/wirings/channel/channel-rpc-service.d.ts +0 -6
  106. package/dist/wirings/channel/channel-rpc-service.js +0 -8
  107. package/dist/wirings/channel/channel-rpc.types.d.ts +6 -0
  108. package/dist/wirings/channel/channel-rpc.types.js +8 -0
  109. package/dist/wirings/channel/channel-runner.d.ts +1 -3
  110. package/dist/wirings/channel/channel-runner.js +16 -8
  111. package/dist/wirings/channel/channel.types.d.ts +2 -0
  112. package/dist/wirings/channel/index.d.ts +5 -6
  113. package/dist/wirings/channel/index.js +3 -4
  114. package/dist/wirings/channel/local/local-channel-runner.js +8 -1
  115. package/dist/wirings/channel/pikku-abstract-channel-handler.js +1 -0
  116. package/dist/wirings/channel/serverless/serverless-channel-runner.js +3 -0
  117. package/dist/wirings/cli/channel/cli-channel-runner.js +2 -0
  118. package/dist/wirings/cli/channel/cli-raw-channel-runner.js +9 -1
  119. package/dist/wirings/cli/channel/index.d.ts +1 -2
  120. package/dist/wirings/cli/channel/index.js +0 -1
  121. package/dist/wirings/cli/cli-runner.js +17 -3
  122. package/dist/wirings/cli/cli.types.d.ts +0 -8
  123. package/dist/wirings/cli/command-parser.js +13 -0
  124. package/dist/wirings/credential/index.d.ts +1 -1
  125. package/dist/wirings/gateway/gateway-runner.js +9 -2
  126. package/dist/wirings/gateway/index.d.ts +1 -1
  127. package/dist/wirings/http/http-routes.js +2 -0
  128. package/dist/wirings/http/http-runner.d.ts +0 -10
  129. package/dist/wirings/http/http-runner.js +14 -15
  130. package/dist/wirings/http/http.types.d.ts +0 -10
  131. package/dist/wirings/http/index.d.ts +2 -3
  132. package/dist/wirings/http/index.js +1 -1
  133. package/dist/wirings/mcp/index.d.ts +1 -1
  134. package/dist/wirings/mcp/mcp-runner.d.ts +15 -7
  135. package/dist/wirings/mcp/mcp-runner.js +18 -11
  136. package/dist/wirings/persona/index.d.ts +3 -4
  137. package/dist/wirings/persona/index.js +2 -3
  138. package/dist/wirings/queue/index.d.ts +1 -3
  139. package/dist/wirings/queue/index.js +1 -3
  140. package/dist/wirings/rpc/addon-runner.d.ts +4 -0
  141. package/dist/wirings/rpc/addon-runner.js +19 -3
  142. package/dist/wirings/rpc/rpc-runner.d.ts +8 -51
  143. package/dist/wirings/rpc/rpc-runner.js +55 -86
  144. package/dist/wirings/rpc/rpc-types.d.ts +7 -0
  145. package/dist/wirings/rpc/wire-addon.d.ts +13 -0
  146. package/dist/wirings/rpc/wire-addon.js +4 -0
  147. package/dist/wirings/scheduler/index.d.ts +1 -1
  148. package/dist/wirings/secret/validate-secret-definitions.js +2 -2
  149. package/dist/wirings/trigger/index.d.ts +1 -1
  150. package/dist/wirings/trigger/pikku-trigger-service.d.ts +0 -4
  151. package/dist/wirings/trigger/trigger-runner.js +1 -0
  152. package/dist/wirings/virtual-user/index.d.ts +5 -6
  153. package/dist/wirings/virtual-user/index.js +2 -4
  154. package/dist/wirings/virtual-user/run-virtual-user.js +11 -11
  155. package/dist/wirings/virtual-user/virtual-user-derive.js +4 -25
  156. package/dist/wirings/virtual-user/virtual-user-dispositions.js +1 -4
  157. package/dist/wirings/workflow/dsl/workflow-dsl.types.d.ts +100 -3
  158. package/dist/wirings/workflow/feature.js +7 -4
  159. package/dist/wirings/workflow/graph/graph-runner.d.ts +1 -2
  160. package/dist/wirings/workflow/graph/graph-runner.js +8 -7
  161. package/dist/wirings/workflow/graph/workflow-graph.types.d.ts +0 -4
  162. package/dist/wirings/workflow/index.d.ts +12 -7
  163. package/dist/wirings/workflow/index.js +7 -3
  164. package/dist/wirings/workflow/pikku-scenario-service.d.ts +17 -3
  165. package/dist/wirings/workflow/pikku-scenario-service.js +64 -10
  166. package/dist/wirings/workflow/pikku-workflow-service.d.ts +28 -147
  167. package/dist/wirings/workflow/pikku-workflow-service.js +85 -493
  168. package/dist/wirings/workflow/scenario-step.types.d.ts +8 -0
  169. package/dist/wirings/workflow/workflow-approval-audit.d.ts +16 -0
  170. package/dist/wirings/workflow/workflow-approval-audit.js +40 -0
  171. package/dist/wirings/workflow/workflow-approval-policy.d.ts +20 -0
  172. package/dist/wirings/workflow/workflow-approval-policy.js +48 -0
  173. package/dist/wirings/workflow/workflow-approval.d.ts +67 -0
  174. package/dist/wirings/workflow/workflow-approval.js +177 -0
  175. package/dist/wirings/workflow/workflow-constants.d.ts +26 -0
  176. package/dist/wirings/workflow/workflow-constants.js +35 -0
  177. package/dist/wirings/workflow/workflow-errors.d.ts +58 -0
  178. package/dist/wirings/workflow/workflow-errors.js +112 -0
  179. package/dist/wirings/workflow/workflow-meta-resolver.d.ts +11 -0
  180. package/dist/wirings/workflow/workflow-meta-resolver.js +31 -0
  181. package/dist/wirings/workflow/workflow-queue-routing.d.ts +8 -0
  182. package/dist/wirings/workflow/workflow-queue-routing.js +38 -0
  183. package/dist/wirings/workflow/workflow-queue-wiring.d.ts +20 -0
  184. package/dist/wirings/workflow/workflow-queue-wiring.js +79 -0
  185. package/dist/wirings/workflow/workflow-recovery.d.ts +68 -0
  186. package/dist/wirings/workflow/workflow-recovery.js +101 -0
  187. package/dist/wirings/workflow/workflow-run-engine.types.d.ts +54 -0
  188. package/dist/wirings/workflow/workflow-run-ownership.d.ts +17 -0
  189. package/dist/wirings/workflow/workflow-run-ownership.js +30 -0
  190. package/dist/wirings/workflow/workflow-suspend.d.ts +12 -0
  191. package/dist/wirings/workflow/workflow-suspend.js +33 -0
  192. package/dist/wirings/workflow/workflow.types.d.ts +8 -1
  193. package/knowledge/decisions/internals/a-non-streaming-agent-run-registers-with-airunstate-too.md +22 -0
  194. package/knowledge/decisions/internals/a-resumed-agent-turn-is-as-interruptible-as-the-first.md +20 -0
  195. package/knowledge/decisions/internals/a-scenario-step-template-is-offered-unfilled.md +21 -0
  196. package/knowledge/decisions/internals/a-virtual-user-decides-whether-to-trust-memory-once-per-turn.md +21 -0
  197. package/knowledge/decisions/internals/a-wall-clock-threshold-is-a-load-test-in-disguise.md +46 -0
  198. package/knowledge/decisions/internals/a-workflow-wire-is-built-from-the-run-not-from-the-rpc-service.md +45 -0
  199. package/knowledge/decisions/internals/addon-pikku-meta-ships-at-the-package-root-or-under-dist.md +32 -0
  200. package/knowledge/decisions/internals/agent-context-waits-for-a-tool-result-still-being-written.md +21 -0
  201. package/knowledge/decisions/internals/agent-speech-travels-as-a-custom-agui-event.md +22 -0
  202. package/knowledge/decisions/internals/an-addon-scope-root-loses-to-a-root-the-host-already-declares.md +39 -0
  203. package/knowledge/decisions/internals/an-agent-interrupt-is-not-a-failure.md +23 -0
  204. package/knowledge/decisions/internals/an-agent-run-owned-by-another-instance-says-so.md +25 -0
  205. package/knowledge/decisions/internals/an-agent-stream-send-must-return-the-inner-sends-promise.md +22 -0
  206. package/knowledge/decisions/internals/an-empty-text-part-is-omitted-from-an-agent-message.md +20 -0
  207. package/knowledge/decisions/internals/an-empty-transcript-is-not-recorded.md +22 -0
  208. package/knowledge/decisions/internals/an-unref-d-timer-cannot-be-awaited-under-node-test.md +66 -0
  209. package/knowledge/decisions/internals/channel-state-accessors-are-unsound-generics-that-every-implementation-asserts.md +33 -0
  210. package/knowledge/decisions/internals/gateway-listener-middleware-runs-without-an-rpc-on-the-wire.md +43 -0
  211. package/knowledge/decisions/internals/hot-reload-writes-into-the-function-map-captured-at-startup.md +26 -0
  212. package/knowledge/decisions/internals/index.md +42 -3
  213. package/knowledge/decisions/internals/only-exposed-functions-enter-a-virtual-user-catalogue.md +21 -0
  214. package/knowledge/decisions/internals/scenario-given-and-when-are-sugar-but-then-is-not.md +24 -0
  215. package/knowledge/decisions/internals/side-effects-are-an-allowlist-not-a-boolean.md +34 -0
  216. package/knowledge/decisions/internals/speech-synthesis-picks-a-voice-per-sentence-and-warns-once.md +24 -0
  217. package/knowledge/decisions/internals/the-actor-prompt-says-json-because-of-json-object-mode.md +22 -0
  218. package/knowledge/decisions/internals/the-agent-done-event-goes-through-the-middleware-and-is-awaited.md +26 -0
  219. package/knowledge/decisions/internals/the-api-report-pins-members-not-just-names.md +43 -0
  220. package/knowledge/decisions/internals/the-ecosystem-entry-point-carries-the-adapter-surface.md +58 -0
  221. package/knowledge/decisions/internals/the-middleware-resolution-cache-is-deliberately-unbounded.md +40 -0
  222. package/knowledge/decisions/internals/the-per-invocation-rpc-view-is-a-class.md +40 -0
  223. package/knowledge/decisions/internals/the-persona-runtime-is-exported-from-the-persona-entry-point.md +28 -0
  224. package/knowledge/decisions/internals/the-transcript-event-is-sent-ahead-of-the-run.md +25 -0
  225. package/knowledge/decisions/internals/the-virtual-user-catalogue-is-the-only-gate-on-what-may-be-called.md +21 -0
  226. package/knowledge/decisions/internals/the-worker-disposition-is-the-one-that-is-not-testing.md +22 -0
  227. package/knowledge/decisions/internals/thread-history-records-the-transcript-not-the-audio.md +25 -0
  228. package/knowledge/decisions/internals/validate-runs-checks-by-precondition.md +115 -0
  229. package/knowledge/decisions/internals/virtual-user-step-order-comes-from-insertion-order.md +21 -0
  230. package/knowledge/decisions/internals/voice-output-speaks-unless-voice-input-explicitly-says-otherwise.md +24 -0
  231. package/knowledge/decisions/internals/wiring-registries-erase-the-generics-their-wire-functions-capture.md +35 -0
  232. package/knowledge/decisions/security/a-dropped-audit-write-is-always-logged.md +4 -2
  233. package/knowledge/decisions/security/a-function-never-receives-the-secret-service.md +37 -0
  234. package/knowledge/decisions/security/a-graph-run-starts-at-an-entry-node-the-graph-declared.md +33 -0
  235. package/knowledge/decisions/security/a-permission-gets-a-wire-it-cannot-reply-on.md +33 -0
  236. package/knowledge/decisions/security/a-step-runs-the-function-the-workflow-dispatched-it-with.md +37 -0
  237. package/knowledge/decisions/security/a-virtual-user-is-never-offered-a-step-that-would-forge-its-own-oracle.md +28 -0
  238. package/knowledge/decisions/security/a-workflow-run-is-read-and-approved-by-its-owner.md +50 -0
  239. package/knowledge/decisions/security/an-agent-approval-is-claimed-before-the-tool-runs.md +33 -0
  240. package/knowledge/decisions/security/an-approval-answer-outlives-the-run-it-answered.md +59 -0
  241. package/knowledge/decisions/security/an-upload-is-counted-as-it-arrives-not-buffered-then-measured.md +24 -0
  242. package/knowledge/decisions/security/index.md +9 -0
  243. package/knowledge/questions/channel-middleware-accepts-bare-factories-that-nothing-resolves.md +35 -0
  244. package/knowledge/questions/index.md +2 -1
  245. package/knowledge/questions/unauthorized-channel-replies-escape-the-declared-out-type.md +44 -0
  246. package/package.json +15 -3
  247. package/scripts/generate-api-report.d.mts +1 -0
  248. package/scripts/generate-api-report.mjs +89 -0
  249. package/scripts/generate-api-report.mts +343 -0
  250. package/src/api-report.test.ts +69 -0
  251. package/src/column-form.ts +1 -4
  252. package/src/crypto-utils.test.ts +15 -2
  253. package/src/dev/hot-reload.ts +2 -7
  254. package/src/ecosystem.ts +40 -0
  255. package/src/errors/error-handler.ts +5 -3
  256. package/src/errors/error.test.ts +4 -1
  257. package/src/errors/index.ts +1 -1
  258. package/src/function/function-runner.test.ts +53 -1
  259. package/src/function/function-runner.ts +33 -48
  260. package/src/function/functions.types.ts +15 -9
  261. package/src/function/index.ts +0 -2
  262. package/src/handle-error.ts +1 -1
  263. package/src/index.ts +3 -57
  264. package/src/middleware/auth-cookie.test.ts +50 -0
  265. package/src/middleware/auth-cookie.ts +38 -2
  266. package/src/middleware/cors.ts +2 -1
  267. package/src/middleware/index.ts +1 -1
  268. package/src/middleware/remote-auth.test.ts +43 -0
  269. package/src/middleware/remote-auth.ts +17 -3
  270. package/src/middleware-runner.ts +4 -2
  271. package/src/no-any-casts.test.ts +57 -0
  272. package/src/permissions.test.ts +3 -1
  273. package/src/permissions.ts +22 -24
  274. package/src/pikku-state.ts +22 -6
  275. package/src/public-surface.json +554 -0
  276. package/src/public-surface.json.README +25 -0
  277. package/src/public-surface.test.ts +105 -0
  278. package/src/removed-legacy-exports.test.ts +62 -0
  279. package/src/schema.test.ts +78 -0
  280. package/src/schema.ts +36 -1
  281. package/src/services/ai-agent-runner-service.ts +12 -1
  282. package/src/services/ai-run-state-service.ts +18 -1
  283. package/src/services/audit-service.ts +2 -2
  284. package/src/services/in-memory-ai-run-state-service.ts +16 -2
  285. package/src/services/in-memory-workflow-service.ts +2 -0
  286. package/src/services/index.ts +4 -47
  287. package/src/services/local-content-request-handler.test.ts +43 -5
  288. package/src/services/local-content-request-handler.ts +103 -74
  289. package/src/services/local-content.ts +15 -1
  290. package/src/services/local-email-service.ts +5 -1
  291. package/src/services/scoped-credential-service.test.ts +86 -0
  292. package/src/services/scoped-credential-service.ts +63 -0
  293. package/src/services/system-role-guard.test.ts +4 -1
  294. package/src/services/workflow-service.ts +9 -2
  295. package/src/side-effects-are-declared.test.ts +84 -0
  296. package/src/source-files-stay-composable.test.ts +41 -0
  297. package/src/testing/service-tests/agent-run-service-tests.ts +98 -0
  298. package/src/testing/service-tests/ai-storage-service-tests.ts +379 -0
  299. package/src/testing/service-tests/channel-store-tests.ts +98 -0
  300. package/src/testing/service-tests/credential-service-tests.ts +143 -0
  301. package/src/testing/service-tests/deployment-service-tests.ts +33 -0
  302. package/src/testing/service-tests/event-hub-store-tests.ts +48 -0
  303. package/src/testing/service-tests/secret-service-tests.ts +105 -0
  304. package/src/testing/service-tests/session-store-tests.ts +62 -0
  305. package/src/testing/service-tests/workflow-run-service-tests.ts +59 -0
  306. package/src/testing/service-tests/workflow-service-tests.ts +308 -0
  307. package/src/testing/service-tests.ts +31 -1111
  308. package/src/types/core.types.ts +14 -3
  309. package/src/types/state.types.ts +17 -1
  310. package/src/wirings/actor-flow/index.ts +0 -3
  311. package/src/wirings/actor-flow/run-conversation.ts +1 -6
  312. package/src/wirings/ai-agent/agent-rpc.ts +120 -0
  313. package/src/wirings/ai-agent/ai-agent-agui.ts +1 -5
  314. package/src/wirings/ai-agent/ai-agent-finalize.test.ts +186 -0
  315. package/src/wirings/ai-agent/ai-agent-finalize.ts +197 -0
  316. package/src/wirings/ai-agent/ai-agent-interrupt.test.ts +2 -1
  317. package/src/wirings/ai-agent/ai-agent-interrupt.ts +1 -0
  318. package/src/wirings/ai-agent/ai-agent-memory.ts +62 -39
  319. package/src/wirings/ai-agent/ai-agent-model-config.test.ts +72 -3
  320. package/src/wirings/ai-agent/ai-agent-model-config.ts +49 -1
  321. package/src/wirings/ai-agent/ai-agent-prepare.ts +12 -12
  322. package/src/wirings/ai-agent/ai-agent-resume-authorization.test.ts +1 -0
  323. package/src/wirings/ai-agent/ai-agent-runner.test.ts +82 -2
  324. package/src/wirings/ai-agent/ai-agent-runner.ts +120 -160
  325. package/src/wirings/ai-agent/ai-agent-stream-output-hooks.test.ts +353 -0
  326. package/src/wirings/ai-agent/ai-agent-stream.test.ts +2 -0
  327. package/src/wirings/ai-agent/ai-agent-stream.ts +152 -117
  328. package/src/wirings/ai-agent/ai-agent-thread-ownership.test.ts +1 -1
  329. package/src/wirings/ai-agent/ai-agent-turn.test.ts +67 -0
  330. package/src/wirings/ai-agent/ai-agent-turn.ts +122 -0
  331. package/src/wirings/ai-agent/ai-agent.types.ts +65 -5
  332. package/src/wirings/ai-agent/index.ts +2 -16
  333. package/src/wirings/ai-agent/voice-input.ts +1 -6
  334. package/src/wirings/ai-agent/voice-output.ts +2 -12
  335. package/src/wirings/ai-scorer/ai-scorer-grade.test.ts +106 -0
  336. package/src/wirings/ai-scorer/ai-scorer-grade.ts +55 -0
  337. package/src/wirings/ai-scorer/ai-scorer-judge.test.ts +143 -0
  338. package/src/wirings/ai-scorer/ai-scorer-judge.ts +120 -0
  339. package/src/wirings/ai-scorer/ai-scorer-live.test.ts +174 -0
  340. package/src/wirings/ai-scorer/ai-scorer-live.ts +56 -0
  341. package/src/wirings/ai-scorer/ai-scorer-registry.ts +63 -0
  342. package/src/wirings/ai-scorer/ai-scorer-sampling.test.ts +34 -0
  343. package/src/wirings/ai-scorer/ai-scorer-sampling.ts +36 -0
  344. package/src/wirings/ai-scorer/ai-scorer-snapshots.test.ts +49 -0
  345. package/src/wirings/ai-scorer/ai-scorer-snapshots.ts +46 -0
  346. package/src/wirings/ai-scorer/ai-scorer-worker.test.ts +122 -0
  347. package/src/wirings/ai-scorer/ai-scorer-worker.ts +69 -0
  348. package/src/wirings/ai-scorer/ai-scorer.ts +76 -0
  349. package/src/wirings/ai-scorer/ai-scorer.types.ts +107 -0
  350. package/src/wirings/ai-scorer/index.ts +24 -0
  351. package/src/wirings/channel/channel-common.ts +5 -2
  352. package/src/wirings/channel/channel-handler-shapes.test.ts +72 -0
  353. package/src/wirings/channel/channel-handler.ts +7 -7
  354. package/src/wirings/channel/channel-rpc-service.ts +0 -14
  355. package/src/wirings/channel/channel-rpc.test.ts +25 -4
  356. package/src/wirings/channel/channel-rpc.types.ts +14 -0
  357. package/src/wirings/channel/channel-runner.ts +33 -20
  358. package/src/wirings/channel/channel.types.ts +2 -0
  359. package/src/wirings/channel/index.ts +1 -20
  360. package/src/wirings/channel/local/local-channel-runner.test.ts +68 -0
  361. package/src/wirings/channel/local/local-channel-runner.ts +9 -2
  362. package/src/wirings/channel/pikku-abstract-channel-handler.ts +2 -1
  363. package/src/wirings/channel/serverless/serverless-channel-runner.ts +6 -3
  364. package/src/wirings/cli/channel/cli-channel-runner.ts +3 -1
  365. package/src/wirings/cli/channel/cli-raw-channel-runner.test.ts +23 -0
  366. package/src/wirings/cli/channel/cli-raw-channel-runner.ts +12 -1
  367. package/src/wirings/cli/channel/cli-raw-client-runner.ts +4 -1
  368. package/src/wirings/cli/channel/index.ts +0 -7
  369. package/src/wirings/cli/cli-runner.test.ts +68 -0
  370. package/src/wirings/cli/cli-runner.ts +25 -5
  371. package/src/wirings/cli/cli.types.ts +0 -39
  372. package/src/wirings/cli/command-parser.test.ts +19 -0
  373. package/src/wirings/cli/command-parser.ts +17 -1
  374. package/src/wirings/credential/index.ts +0 -1
  375. package/src/wirings/gateway/gateway-channel-meta.test.ts +44 -0
  376. package/src/wirings/gateway/gateway-runner.ts +27 -19
  377. package/src/wirings/gateway/index.ts +0 -3
  378. package/src/wirings/http/http-routes.ts +4 -1
  379. package/src/wirings/http/http-runner.test.ts +66 -0
  380. package/src/wirings/http/http-runner.ts +21 -28
  381. package/src/wirings/http/http.types.ts +0 -15
  382. package/src/wirings/http/index.ts +2 -8
  383. package/src/wirings/http/pikku-fetch-http-request.ts +2 -2
  384. package/src/wirings/http/web-request.ts +1 -1
  385. package/src/wirings/mcp/index.ts +0 -1
  386. package/src/wirings/mcp/mcp-runner.test.ts +181 -0
  387. package/src/wirings/mcp/mcp-runner.ts +37 -21
  388. package/src/wirings/persona/index.ts +0 -8
  389. package/src/wirings/persona/persona-environments.test.ts +14 -3
  390. package/src/wirings/persona/persona.test.ts +13 -3
  391. package/src/wirings/persona/validate-personas.ts +5 -1
  392. package/src/wirings/queue/index.ts +0 -14
  393. package/src/wirings/queue/queue-runner.ts +1 -1
  394. package/src/wirings/rpc/addon-auth-tags.test.ts +1 -5
  395. package/src/wirings/rpc/addon-runner.ts +34 -3
  396. package/src/wirings/rpc/addon-secrets.test.ts +261 -0
  397. package/src/wirings/rpc/rpc-runner.test.ts +2 -0
  398. package/src/wirings/rpc/rpc-runner.ts +60 -136
  399. package/src/wirings/rpc/rpc-types.ts +11 -0
  400. package/src/wirings/rpc/wire-addon.ts +20 -1
  401. package/src/wirings/scheduler/index.ts +0 -1
  402. package/src/wirings/secret/validate-secret-definitions.test.ts +22 -0
  403. package/src/wirings/secret/validate-secret-definitions.ts +2 -2
  404. package/src/wirings/trigger/index.ts +0 -1
  405. package/src/wirings/trigger/pikku-trigger-service.ts +0 -5
  406. package/src/wirings/trigger/trigger-runner.ts +7 -5
  407. package/src/wirings/virtual-user/index.ts +0 -16
  408. package/src/wirings/virtual-user/run-virtual-user.test.ts +18 -9
  409. package/src/wirings/virtual-user/run-virtual-user.ts +28 -15
  410. package/src/wirings/virtual-user/virtual-user-agents.test.ts +4 -1
  411. package/src/wirings/virtual-user/virtual-user-derive.ts +4 -25
  412. package/src/wirings/virtual-user/virtual-user-dispositions.test.ts +7 -2
  413. package/src/wirings/virtual-user/virtual-user-dispositions.ts +1 -4
  414. package/src/wirings/virtual-user/virtual-user-intents.test.ts +13 -3
  415. package/src/wirings/workflow/dsl/workflow-dsl.types.ts +117 -4
  416. package/src/wirings/workflow/feature.ts +7 -4
  417. package/src/wirings/workflow/graph/graph-node.ts +1 -1
  418. package/src/wirings/workflow/graph/graph-runner.test.ts +76 -2
  419. package/src/wirings/workflow/graph/graph-runner.ts +13 -16
  420. package/src/wirings/workflow/graph/workflow-graph.types.ts +0 -5
  421. package/src/wirings/workflow/index.ts +14 -24
  422. package/src/wirings/workflow/pikku-scenario-service.ts +101 -27
  423. package/src/wirings/workflow/pikku-workflow-service.test.ts +15 -14
  424. package/src/wirings/workflow/pikku-workflow-service.ts +214 -743
  425. package/src/wirings/workflow/scenario-expectations.test.ts +75 -0
  426. package/src/wirings/workflow/scenario-hooks.test.ts +52 -0
  427. package/src/wirings/workflow/scenario-step.types.ts +8 -0
  428. package/src/wirings/workflow/workflow-approval-audit.ts +47 -0
  429. package/src/wirings/workflow/workflow-approval-policy.test.ts +524 -0
  430. package/src/wirings/workflow/workflow-approval-policy.ts +68 -0
  431. package/src/wirings/workflow/workflow-approval.ts +289 -0
  432. package/src/wirings/workflow/workflow-child-run-session.test.ts +89 -0
  433. package/src/wirings/workflow/workflow-constants.ts +47 -0
  434. package/src/wirings/workflow/workflow-dispatch-durability.test.ts +1 -1
  435. package/src/wirings/workflow/workflow-errors.ts +128 -0
  436. package/src/wirings/workflow/workflow-inline-authority.test.ts +12 -6
  437. package/src/wirings/workflow/workflow-meta-resolver.ts +45 -0
  438. package/src/wirings/workflow/workflow-missing-meta.test.ts +92 -0
  439. package/src/wirings/workflow/workflow-queue-routing.ts +85 -0
  440. package/src/wirings/workflow/workflow-queue-wiring.ts +149 -0
  441. package/src/wirings/workflow/workflow-recovery.ts +162 -0
  442. package/src/wirings/workflow/workflow-retry-policy.test.ts +1 -1
  443. package/src/wirings/workflow/workflow-run-authority.test.ts +212 -0
  444. package/src/wirings/workflow/workflow-run-engine.types.ts +91 -0
  445. package/src/wirings/workflow/workflow-run-ownership.ts +37 -0
  446. package/src/wirings/workflow/workflow-suspend.ts +61 -0
  447. package/src/wirings/workflow/workflow.types.ts +7 -9
  448. package/src/wirings-stay-decoupled.test.ts +127 -0
  449. package/tsconfig.json +1 -1
  450. package/tsconfig.tsbuildinfo +1 -1
  451. package/dist/internal.d.ts +0 -3
  452. package/dist/internal.js +0 -2
  453. package/dist/middleware/timeout.d.ts +0 -9
  454. package/dist/middleware/timeout.js +0 -15
  455. package/dist/pikku-response.d.ts +0 -6
  456. package/dist/pikku-response.js +0 -6
  457. package/dist/services/gopass-secrets.d.ts +0 -15
  458. package/dist/services/gopass-secrets.js +0 -76
  459. package/dist/services/http-scenario-actors.d.ts +0 -75
  460. package/dist/services/http-scenario-actors.js +0 -195
  461. package/dist/services/http-user-flow-actors.d.ts +0 -67
  462. package/dist/services/http-user-flow-actors.js +0 -193
  463. package/dist/services/scenario-actors-service.d.ts +0 -127
  464. package/dist/services/scenario-actors-service.js +0 -40
  465. package/dist/services/user-flow-actors-service.d.ts +0 -39
  466. package/dist/wirings/credential/wire-credential.d.ts +0 -48
  467. package/dist/wirings/credential/wire-credential.js +0 -47
  468. package/dist/wirings/oauth2/oauth2-client.d.ts +0 -47
  469. package/dist/wirings/oauth2/oauth2-client.js +0 -263
  470. package/dist/wirings/oauth2/oauth2-routes.d.ts +0 -35
  471. package/dist/wirings/oauth2/oauth2-routes.js +0 -146
  472. package/dist/wirings/scope/wire-scope.d.ts +0 -33
  473. package/dist/wirings/scope/wire-scope.js +0 -32
  474. package/dist/wirings/workflow/dsl/index.d.ts +0 -5
  475. package/dist/wirings/workflow/dsl/index.js +0 -4
  476. package/dist/wirings/workflow/graph/index.d.ts +0 -5
  477. package/dist/wirings/workflow/graph/index.js +0 -4
  478. package/src/internal.ts +0 -10
  479. /package/dist/{services/user-flow-actors-service.js → wirings/workflow/workflow-run-engine.types.js} +0 -0
@@ -210,6 +210,14 @@ export interface ScenarioBrowserProvider {
210
210
  * scenario cannot leave the next signed in as somebody else.
211
211
  */
212
212
  reset?(): Promise<void>;
213
+ /**
214
+ * Name the scenario about to run, so anything it captures is filed under it.
215
+ *
216
+ * Called before each scenario. A provider that is never told has to fall
217
+ * back to one shared label, which puts every run's artifacts in a single
218
+ * folder — findable only by timestamp.
219
+ */
220
+ beginScenario?(scenario: string): void;
213
221
  /**
214
222
  * Snapshot every open window for a failed scenario. `label` identifies the
215
223
  * scenario in artifact filenames. Never throws: a failure to capture must
@@ -0,0 +1,16 @@
1
+ import type { ApprovalAuditEvent } from './workflow-approval.js';
2
+ /** The audit type an answer to an approval gate is recorded under. */
3
+ export declare const APPROVAL_AUDIT_TYPE = "workflow.approval.decided";
4
+ /**
5
+ * Record an answer to an approval gate where it outlives the run.
6
+ *
7
+ * The step result carries the settled decision, but it is deleted with the run
8
+ * — `deleteRun` cascades to steps and to history — and a refused attempt never
9
+ * reaches a step at all. An approval is asked for precisely so it can be
10
+ * answered for afterwards, so the answer also goes to the audit sink, which
11
+ * holds no foreign key to the run.
12
+ *
13
+ * A project with no sink wired records nothing, and a sink that fails is logged
14
+ * rather than thrown: the trail must not be the reason a decision is lost.
15
+ */
16
+ export declare const auditApprovalDecision: (event: ApprovalAuditEvent) => Promise<void>;
@@ -0,0 +1,40 @@
1
+ import { getSingletonServices } from '../../pikku-state.js';
2
+ /** The audit type an answer to an approval gate is recorded under. */
3
+ export const APPROVAL_AUDIT_TYPE = 'workflow.approval.decided';
4
+ /**
5
+ * Record an answer to an approval gate where it outlives the run.
6
+ *
7
+ * The step result carries the settled decision, but it is deleted with the run
8
+ * — `deleteRun` cascades to steps and to history — and a refused attempt never
9
+ * reaches a step at all. An approval is asked for precisely so it can be
10
+ * answered for afterwards, so the answer also goes to the audit sink, which
11
+ * holds no foreign key to the run.
12
+ *
13
+ * A project with no sink wired records nothing, and a sink that fails is logged
14
+ * rather than thrown: the trail must not be the reason a decision is lost.
15
+ */
16
+ export const auditApprovalDecision = async (event) => {
17
+ const services = getSingletonServices();
18
+ if (!services?.audit) {
19
+ return;
20
+ }
21
+ try {
22
+ await services.audit.audit({
23
+ type: APPROVAL_AUDIT_TYPE,
24
+ source: 'explicit',
25
+ outcome: event.outcome,
26
+ occurredAt: new Date().toISOString(),
27
+ wireType: 'workflow',
28
+ userIdentity: { pikkuUserId: event.decidedBy?.userId },
29
+ metadata: {
30
+ runId: event.runId,
31
+ reason: event.reason,
32
+ scopes: event.decidedBy?.scopes,
33
+ refusal: event.refusal,
34
+ },
35
+ });
36
+ }
37
+ catch (error) {
38
+ services.logger?.warn(`Failed to audit the decision on approval '${event.reason}' for run ${event.runId}`, error);
39
+ }
40
+ };
@@ -0,0 +1,20 @@
1
+ import { ForbiddenError } from '../../errors/errors.js';
2
+ import type { CoreUserSession } from '../../types/core.types.js';
3
+ import type { ApprovalDecider, WorkflowApprovalPolicy } from './dsl/workflow-dsl.types.js';
4
+ export declare class WorkflowApprovalForbiddenError extends ForbiddenError {
5
+ payload: {
6
+ reason: string;
7
+ detail: string;
8
+ };
9
+ constructor(reason: string, detail: string);
10
+ }
11
+ export declare const approvalDeciderFrom: (session: CoreUserSession | undefined) => ApprovalDecider | undefined;
12
+ /**
13
+ * Judge a decision against the gate's declared policy, returning the reason it
14
+ * is refused or `undefined` if it stands.
15
+ *
16
+ * Returns a message rather than throwing because the same judgement is needed
17
+ * in two places with different outcomes: refusing a live submission with a 403,
18
+ * and clearing an already-recorded decision on replay.
19
+ */
20
+ export declare const approvalPolicyRefusal: (policy: WorkflowApprovalPolicy, owner: string | undefined, decider: ApprovalDecider | undefined) => string | undefined;
@@ -0,0 +1,48 @@
1
+ import { ForbiddenError } from '../../errors/errors.js';
2
+ import { addError } from '../../errors/error-handler.js';
3
+ export class WorkflowApprovalForbiddenError extends ForbiddenError {
4
+ payload;
5
+ constructor(reason, detail) {
6
+ super(detail);
7
+ this.payload = { reason, detail };
8
+ }
9
+ }
10
+ addError(WorkflowApprovalForbiddenError, {
11
+ status: 403,
12
+ message: 'Not authorized to answer this approval.',
13
+ });
14
+ export const approvalDeciderFrom = (session) => session ? { userId: session.userId, scopes: session.scopes } : undefined;
15
+ /**
16
+ * Judge a decision against the gate's declared policy, returning the reason it
17
+ * is refused or `undefined` if it stands.
18
+ *
19
+ * Returns a message rather than throwing because the same judgement is needed
20
+ * in two places with different outcomes: refusing a live submission with a 403,
21
+ * and clearing an already-recorded decision on replay.
22
+ */
23
+ export const approvalPolicyRefusal = (policy, owner, decider) => {
24
+ if (policy.approverScope &&
25
+ !decider?.scopes?.includes(policy.approverScope)) {
26
+ return `Answering this approval requires the '${policy.approverScope}' scope`;
27
+ }
28
+ switch (policy.approvers ?? 'any') {
29
+ case 'owner':
30
+ if (!owner) {
31
+ return undefined;
32
+ }
33
+ if (!decider?.userId || decider.userId !== owner) {
34
+ return 'Only the user who started this run may answer this approval';
35
+ }
36
+ return undefined;
37
+ case 'not-initiator':
38
+ if (!decider?.userId) {
39
+ return 'Answering this approval requires a signed-in user';
40
+ }
41
+ if (owner && decider.userId === owner) {
42
+ return 'The user who started this run may not answer this approval';
43
+ }
44
+ return undefined;
45
+ case 'any':
46
+ return undefined;
47
+ }
48
+ };
@@ -0,0 +1,67 @@
1
+ import type { ApprovalOutcome, StepState, WorkflowApprovalOptions } from './workflow.types.js';
2
+ import type { ApprovalDecider } from './dsl/workflow-dsl.types.js';
3
+ /** The durable step name an approval point is recorded under. */
4
+ export declare const approvalStepNameFor: (reason: string) => string;
5
+ /**
6
+ * The run-state key holding an approval's decision.
7
+ *
8
+ * Hex-encoded because the key is composed from a caller-supplied reason, and
9
+ * run state is a flat record — an unescaped reason could collide with, or
10
+ * shadow, another key.
11
+ */
12
+ export declare const approvalStateKey: (stepName: string) => string;
13
+ /**
14
+ * An answer to an approval gate, as the audit trail sees it.
15
+ *
16
+ * `denied` covers both a submission refused at the door and a decision cleared
17
+ * on replay — from the trail's point of view they are the same event, someone
18
+ * tried to answer a gate they could not.
19
+ */
20
+ export type ApprovalAuditEvent = {
21
+ runId: string;
22
+ reason: string;
23
+ outcome: 'success' | 'denied';
24
+ decidedBy?: ApprovalDecider;
25
+ refusal?: string;
26
+ };
27
+ /** What the approval gate needs from the workflow service. */
28
+ export type ApprovalStore = {
29
+ getStepState: (runId: string, stepName: string) => Promise<StepState>;
30
+ insertStepState: (runId: string, stepName: string, rpcName: string, input: unknown, output: undefined, fromStepName?: string) => Promise<StepState>;
31
+ setStepRunning: (stepId: string) => Promise<void>;
32
+ setStepResult: (stepId: string, result: unknown) => Promise<void>;
33
+ getRunState: (runId: string) => Promise<Record<string, unknown>>;
34
+ updateRunState: (runId: string, key: string, value: unknown) => Promise<void>;
35
+ resumeWorkflow: (runId: string) => Promise<void>;
36
+ scheduleRunWake: (runId: string, delay: number) => Promise<void>;
37
+ getRunOwner: (runId: string) => Promise<string | undefined>;
38
+ auditApproval: (event: ApprovalAuditEvent) => Promise<void>;
39
+ };
40
+ /**
41
+ * Record a decision against an approval point and wake the run.
42
+ *
43
+ * A decision arriving for an already-settled approval is refused rather than
44
+ * overwriting it: the run has moved on, and a second answer would be recorded
45
+ * against a gate nobody is waiting at.
46
+ *
47
+ * The decider is recorded rather than judged here, for the same reason the
48
+ * payload is: the gate's policy is a value on the workflow, and a decision can
49
+ * legitimately arrive before the run has ever reached the gate. Where the run
50
+ * has already published its policy, it is applied eagerly so a caller who
51
+ * cannot answer is told so rather than left waiting.
52
+ */
53
+ export declare const recordApprovalDecision: (store: ApprovalStore, runId: string, reason: string, decision: unknown, decidedBy?: ApprovalDecider) => Promise<void>;
54
+ /**
55
+ * Evaluate an approval gate on replay.
56
+ *
57
+ * The payload is validated here rather than where it was submitted, because the
58
+ * schema is a value on the workflow and only the workflow has it. A payload
59
+ * that fails validation is cleared and the run suspends again, so a bad
60
+ * submission cannot settle the gate.
61
+ *
62
+ * The decider is judged here for the same reason, and for one more: a decision
63
+ * can be recorded before the run has ever reached the gate, so submission time
64
+ * is not a point at which the policy is reliably knowable. Judging on replay is
65
+ * what makes the policy hold in every ordering.
66
+ */
67
+ export declare const evaluateApprovalStep: (store: ApprovalStore, runId: string, reason: string, approvalStepName: string, fromStepName: string | undefined, options: WorkflowApprovalOptions) => Promise<ApprovalOutcome<unknown>>;
@@ -0,0 +1,177 @@
1
+ import { getDurationInMilliseconds } from '../../time-utils.js';
2
+ import { WorkflowApprovalResolvedError, WorkflowSuspendedException, } from './workflow-errors.js';
3
+ import { approvalPolicyRefusal, WorkflowApprovalForbiddenError, } from './workflow-approval-policy.js';
4
+ /** The durable step name an approval point is recorded under. */
5
+ export const approvalStepNameFor = (reason) => `__workflow_approval:${reason}`;
6
+ /**
7
+ * The run-state key holding an approval's decision.
8
+ *
9
+ * Hex-encoded because the key is composed from a caller-supplied reason, and
10
+ * run state is a flat record — an unescaped reason could collide with, or
11
+ * shadow, another key.
12
+ */
13
+ export const approvalStateKey = (stepName) => {
14
+ let hex = '';
15
+ for (const byte of new TextEncoder().encode(stepName)) {
16
+ hex += byte.toString(16).padStart(2, '0');
17
+ }
18
+ return `__approval_${hex}`;
19
+ };
20
+ /**
21
+ * Record a decision against an approval point and wake the run.
22
+ *
23
+ * A decision arriving for an already-settled approval is refused rather than
24
+ * overwriting it: the run has moved on, and a second answer would be recorded
25
+ * against a gate nobody is waiting at.
26
+ *
27
+ * The decider is recorded rather than judged here, for the same reason the
28
+ * payload is: the gate's policy is a value on the workflow, and a decision can
29
+ * legitimately arrive before the run has ever reached the gate. Where the run
30
+ * has already published its policy, it is applied eagerly so a caller who
31
+ * cannot answer is told so rather than left waiting.
32
+ */
33
+ export const recordApprovalDecision = async (store, runId, reason, decision, decidedBy) => {
34
+ const stepName = approvalStepNameFor(reason);
35
+ const stateKey = approvalStateKey(stepName);
36
+ let resolved;
37
+ try {
38
+ resolved = await store.getStepState(runId, stepName);
39
+ }
40
+ catch {
41
+ // knowledge: decisions/security/workflow-approval-payloads-are-validated-on-replay-inside-the-workflow.md
42
+ }
43
+ if (resolved?.stepId && resolved.status === 'succeeded') {
44
+ const outcome = resolved.result;
45
+ throw new WorkflowApprovalResolvedError(reason, outcome?.status ?? 'decided');
46
+ }
47
+ const state = await store.getRunState(runId);
48
+ const record = (state[stateKey] ?? {});
49
+ if (record.policy) {
50
+ const refusal = approvalPolicyRefusal(record.policy, await store.getRunOwner(runId), decidedBy);
51
+ if (refusal) {
52
+ await store.auditApproval({
53
+ runId,
54
+ reason,
55
+ outcome: 'denied',
56
+ decidedBy,
57
+ refusal,
58
+ });
59
+ throw new WorkflowApprovalForbiddenError(reason, refusal);
60
+ }
61
+ }
62
+ await store.updateRunState(runId, stateKey, {
63
+ ...record,
64
+ decision,
65
+ decidedAt: new Date().toISOString(),
66
+ decidedBy,
67
+ error: undefined,
68
+ });
69
+ await store.auditApproval({ runId, reason, outcome: 'success', decidedBy });
70
+ await store.resumeWorkflow(runId);
71
+ };
72
+ /**
73
+ * Evaluate an approval gate on replay.
74
+ *
75
+ * The payload is validated here rather than where it was submitted, because the
76
+ * schema is a value on the workflow and only the workflow has it. A payload
77
+ * that fails validation is cleared and the run suspends again, so a bad
78
+ * submission cannot settle the gate.
79
+ *
80
+ * The decider is judged here for the same reason, and for one more: a decision
81
+ * can be recorded before the run has ever reached the gate, so submission time
82
+ * is not a point at which the policy is reliably knowable. Judging on replay is
83
+ * what makes the policy hold in every ordering.
84
+ */
85
+ export const evaluateApprovalStep = async (store, runId, reason, approvalStepName, fromStepName, options) => {
86
+ const insert = () => store.insertStepState(runId, approvalStepName, 'pikkuWorkflowApproval', {
87
+ reason,
88
+ expiry: options.expiry,
89
+ approvers: options.approvers,
90
+ approverScope: options.approverScope,
91
+ }, undefined, fromStepName);
92
+ let stepState;
93
+ try {
94
+ stepState = await store.getStepState(runId, approvalStepName);
95
+ }
96
+ catch {
97
+ stepState = await insert();
98
+ }
99
+ if (!stepState.stepId) {
100
+ stepState = await insert();
101
+ }
102
+ if (stepState.status === 'succeeded') {
103
+ return stepState.result;
104
+ }
105
+ const stateKey = approvalStateKey(approvalStepName);
106
+ let record = ((await store.getRunState(runId))[stateKey] ?? {});
107
+ const policy = {
108
+ approvers: options.approvers,
109
+ approverScope: options.approverScope,
110
+ };
111
+ if (stepState.status === 'pending') {
112
+ await store.setStepRunning(stepState.stepId);
113
+ record = { ...record, policy };
114
+ if (options.expiry !== undefined && !record.expiresAt) {
115
+ const expiry = getDurationInMilliseconds(options.expiry);
116
+ record = {
117
+ ...record,
118
+ expiresAt: new Date(Date.now() + expiry).toISOString(),
119
+ };
120
+ await store.updateRunState(runId, stateKey, record);
121
+ await store.scheduleRunWake(runId, expiry);
122
+ }
123
+ else {
124
+ await store.updateRunState(runId, stateKey, record);
125
+ }
126
+ }
127
+ if (record.decision !== undefined) {
128
+ const refusal = approvalPolicyRefusal(policy, await store.getRunOwner(runId), record.decidedBy);
129
+ if (refusal) {
130
+ await store.updateRunState(runId, stateKey, {
131
+ ...record,
132
+ decision: undefined,
133
+ decidedAt: undefined,
134
+ decidedBy: undefined,
135
+ error: [{ message: refusal }],
136
+ });
137
+ await store.auditApproval({
138
+ runId,
139
+ reason,
140
+ outcome: 'denied',
141
+ decidedBy: record.decidedBy,
142
+ refusal,
143
+ });
144
+ throw new WorkflowSuspendedException(runId, reason);
145
+ }
146
+ const validation = await options.schema['~standard'].validate(record.decision);
147
+ if (validation.issues) {
148
+ await store.updateRunState(runId, stateKey, {
149
+ ...record,
150
+ decision: undefined,
151
+ decidedAt: undefined,
152
+ decidedBy: undefined,
153
+ error: validation.issues.map((issue) => ({
154
+ message: issue.message,
155
+ path: issue.path?.map((segment) => typeof segment === 'object' ? segment.key : segment),
156
+ })),
157
+ });
158
+ throw new WorkflowSuspendedException(runId, reason);
159
+ }
160
+ // Spread rather than assigned, so a gate answered without a session keeps
161
+ // the shape it had before there was anything to record.
162
+ const outcome = {
163
+ status: 'decided',
164
+ data: validation.value,
165
+ ...(record.decidedBy ? { decidedBy: record.decidedBy } : {}),
166
+ ...(record.decidedAt ? { decidedAt: record.decidedAt } : {}),
167
+ };
168
+ await store.setStepResult(stepState.stepId, outcome);
169
+ return outcome;
170
+ }
171
+ if (record.expiresAt && Date.now() >= Date.parse(record.expiresAt)) {
172
+ const outcome = { status: 'expired' };
173
+ await store.setStepResult(stepState.stepId, outcome);
174
+ return outcome;
175
+ }
176
+ throw new WorkflowSuspendedException(runId, reason);
177
+ };
@@ -0,0 +1,26 @@
1
+ export declare const DEFAULT_STEP_RETRIES = 5;
2
+ /** Statuses from which a run never advances again on its own. */
3
+ export declare const WORKFLOW_END_STATES: ReadonlySet<string>;
4
+ /** Statuses a run cannot leave at all. */
5
+ export declare const WORKFLOW_TERMINAL_STATES: ReadonlySet<string>;
6
+ export declare const WORKFLOW_POLL_MIN_MS = 10;
7
+ export declare const WORKFLOW_POLL_FACTOR = 1.6;
8
+ export declare const WORKFLOW_CHILD_POLL_MAX_MS = 500;
9
+ /** Idle window before a `running` run with nothing in flight is treated as stalled. */
10
+ export declare const DEFAULT_STALLED_RUN_MS: number;
11
+ /** Runs re-driven per `recoverStalledRuns` call, so one sweep is bounded. */
12
+ export declare const DEFAULT_STALLED_RUN_LIMIT = 100;
13
+ /**
14
+ * How long a step may sit `pending` before the relay assumes its dispatch was
15
+ * lost. This is a bet that no healthy queue takes this long to move a job from
16
+ * `pending` to `running`; set it above the observed p99 of that latency.
17
+ */
18
+ export declare const DEFAULT_UNDISPATCHED_STEP_MS = 30000;
19
+ /** Steps re-driven per `relayUndispatchedSteps` call, so one tick is bounded. */
20
+ export declare const DEFAULT_UNDISPATCHED_STEP_LIMIT = 100;
21
+ /** First wait before a step already re-dispatched once is re-dispatched again. */
22
+ export declare const REDISPATCH_BACKOFF_MS = 30000;
23
+ /** Ceiling on the doubling backoff, so a permanently stuck step still gets swept. */
24
+ export declare const REDISPATCH_BACKOFF_MAX_MS: number;
25
+ /** Bound on the in-process backoff map, so a long-lived process cannot grow it without bound. */
26
+ export declare const REDISPATCH_BACKOFF_MAX_ENTRIES = 10000;
@@ -0,0 +1,35 @@
1
+ export const DEFAULT_STEP_RETRIES = 5;
2
+ /** Statuses from which a run never advances again on its own. */
3
+ export const WORKFLOW_END_STATES = new Set([
4
+ 'completed',
5
+ 'failed',
6
+ 'cancelled',
7
+ 'suspended',
8
+ ]);
9
+ /** Statuses a run cannot leave at all. */
10
+ export const WORKFLOW_TERMINAL_STATES = new Set([
11
+ 'completed',
12
+ 'failed',
13
+ 'cancelled',
14
+ ]);
15
+ export const WORKFLOW_POLL_MIN_MS = 10;
16
+ export const WORKFLOW_POLL_FACTOR = 1.6;
17
+ export const WORKFLOW_CHILD_POLL_MAX_MS = 500;
18
+ /** Idle window before a `running` run with nothing in flight is treated as stalled. */
19
+ export const DEFAULT_STALLED_RUN_MS = 5 * 60_000;
20
+ /** Runs re-driven per `recoverStalledRuns` call, so one sweep is bounded. */
21
+ export const DEFAULT_STALLED_RUN_LIMIT = 100;
22
+ /**
23
+ * How long a step may sit `pending` before the relay assumes its dispatch was
24
+ * lost. This is a bet that no healthy queue takes this long to move a job from
25
+ * `pending` to `running`; set it above the observed p99 of that latency.
26
+ */
27
+ export const DEFAULT_UNDISPATCHED_STEP_MS = 30_000;
28
+ /** Steps re-driven per `relayUndispatchedSteps` call, so one tick is bounded. */
29
+ export const DEFAULT_UNDISPATCHED_STEP_LIMIT = 100;
30
+ /** First wait before a step already re-dispatched once is re-dispatched again. */
31
+ export const REDISPATCH_BACKOFF_MS = 30_000;
32
+ /** Ceiling on the doubling backoff, so a permanently stuck step still gets swept. */
33
+ export const REDISPATCH_BACKOFF_MAX_MS = 10 * 60_000;
34
+ /** Bound on the in-process backoff map, so a long-lived process cannot grow it without bound. */
35
+ export const REDISPATCH_BACKOFF_MAX_ENTRIES = 10_000;
@@ -0,0 +1,58 @@
1
+ import { PikkuError } from '../../errors/error-handler.js';
2
+ import type { ApprovalOutcome } from './workflow.types.js';
3
+ /**
4
+ * Thrown to unwind a run that cannot continue on this tick. Not a failure:
5
+ * the run resumes from its recorded step state.
6
+ */
7
+ export declare class WorkflowAsyncException extends Error {
8
+ readonly runId: string;
9
+ readonly stepName: string;
10
+ constructor(runId: string, stepName: string);
11
+ }
12
+ export declare class WorkflowCancelledException extends Error {
13
+ readonly runId: string;
14
+ readonly reason?: string | undefined;
15
+ constructor(runId: string, reason?: string | undefined);
16
+ }
17
+ export declare class WorkflowSuspendedException extends Error {
18
+ readonly runId: string;
19
+ readonly reason: string;
20
+ constructor(runId: string, reason: string);
21
+ }
22
+ export declare class WorkflowDispatchException extends Error {
23
+ readonly runId: string;
24
+ readonly stepName: string;
25
+ constructor(runId: string, stepName: string, options?: {
26
+ cause?: unknown;
27
+ });
28
+ }
29
+ export declare class WorkflowNotFoundError extends PikkuError {
30
+ constructor(name: string);
31
+ }
32
+ export declare class WorkflowRunNotFoundError extends PikkuError {
33
+ constructor(runId: string);
34
+ }
35
+ export declare class WorkflowRunFailedError extends PikkuError {
36
+ payload: {
37
+ message?: string;
38
+ };
39
+ constructor(message?: string);
40
+ }
41
+ export declare class WorkflowRunCancelledError extends PikkuError {
42
+ constructor();
43
+ }
44
+ export declare class WorkflowApprovalResolvedError extends PikkuError {
45
+ payload: {
46
+ reason: string;
47
+ outcome: ApprovalOutcome<unknown>['status'];
48
+ };
49
+ constructor(reason: string, outcome: ApprovalOutcome<unknown>['status']);
50
+ }
51
+ export declare class WorkflowStepFunctionMismatchError extends PikkuError {
52
+ readonly runId: string;
53
+ readonly stepName: string;
54
+ constructor(runId: string, stepName: string);
55
+ }
56
+ export declare class WorkflowStepNameNotString extends Error {
57
+ constructor(stepName: unknown);
58
+ }
@@ -0,0 +1,112 @@
1
+ import { PikkuError, addError } from '../../errors/error-handler.js';
2
+ /**
3
+ * Thrown to unwind a run that cannot continue on this tick. Not a failure:
4
+ * the run resumes from its recorded step state.
5
+ */
6
+ export class WorkflowAsyncException extends Error {
7
+ runId;
8
+ stepName;
9
+ constructor(runId, stepName) {
10
+ super(`Workflow paused at step: ${stepName}`);
11
+ this.runId = runId;
12
+ this.stepName = stepName;
13
+ this.name = 'WorkflowAsyncException';
14
+ }
15
+ }
16
+ export class WorkflowCancelledException extends Error {
17
+ runId;
18
+ reason;
19
+ constructor(runId, reason) {
20
+ super(reason || 'Workflow cancelled');
21
+ this.runId = runId;
22
+ this.reason = reason;
23
+ this.name = 'WorkflowCancelledException';
24
+ }
25
+ }
26
+ export class WorkflowSuspendedException extends Error {
27
+ runId;
28
+ reason;
29
+ constructor(runId, reason) {
30
+ super(reason || 'Workflow suspended');
31
+ this.runId = runId;
32
+ this.reason = reason;
33
+ this.name = 'WorkflowSuspendedException';
34
+ }
35
+ }
36
+ export class WorkflowDispatchException extends Error {
37
+ runId;
38
+ stepName;
39
+ constructor(runId, stepName, options) {
40
+ super(`Failed to dispatch workflow step '${stepName}' (run ${runId})`, options);
41
+ this.runId = runId;
42
+ this.stepName = stepName;
43
+ this.name = 'WorkflowDispatchException';
44
+ }
45
+ }
46
+ export class WorkflowNotFoundError extends PikkuError {
47
+ constructor(name) {
48
+ super(`Workflow not found: ${name}`);
49
+ }
50
+ }
51
+ addError(WorkflowNotFoundError, {
52
+ status: 404,
53
+ message: 'Workflow not found.',
54
+ });
55
+ export class WorkflowRunNotFoundError extends PikkuError {
56
+ constructor(runId) {
57
+ super(`Workflow run not found: ${runId}`);
58
+ }
59
+ }
60
+ addError(WorkflowRunNotFoundError, {
61
+ status: 404,
62
+ message: 'Workflow run not found.',
63
+ });
64
+ export class WorkflowRunFailedError extends PikkuError {
65
+ payload;
66
+ constructor(message) {
67
+ super(`Workflow run failed: ${message ?? 'unknown'}`);
68
+ this.payload = { message };
69
+ }
70
+ }
71
+ addError(WorkflowRunFailedError, {
72
+ status: 422,
73
+ message: 'Workflow run failed.',
74
+ });
75
+ export class WorkflowRunCancelledError extends PikkuError {
76
+ constructor() {
77
+ super('Workflow was cancelled');
78
+ }
79
+ }
80
+ addError(WorkflowRunCancelledError, {
81
+ status: 409,
82
+ message: 'Workflow was cancelled.',
83
+ });
84
+ export class WorkflowApprovalResolvedError extends PikkuError {
85
+ payload;
86
+ constructor(reason, outcome) {
87
+ super(`Approval already ${outcome}: ${reason}`);
88
+ this.payload = { reason, outcome };
89
+ }
90
+ }
91
+ addError(WorkflowApprovalResolvedError, {
92
+ status: 409,
93
+ message: 'Approval has already been resolved.',
94
+ });
95
+ export class WorkflowStepFunctionMismatchError extends PikkuError {
96
+ runId;
97
+ stepName;
98
+ constructor(runId, stepName) {
99
+ super(`Workflow step '${stepName}' (run ${runId}) was dispatched with a different function`);
100
+ this.runId = runId;
101
+ this.stepName = stepName;
102
+ }
103
+ }
104
+ addError(WorkflowStepFunctionMismatchError, {
105
+ status: 409,
106
+ message: 'Workflow step was dispatched with a different function.',
107
+ });
108
+ export class WorkflowStepNameNotString extends Error {
109
+ constructor(stepName) {
110
+ super(`Workflow step name must be a string. Received: ${typeof stepName}`);
111
+ }
112
+ }
@@ -0,0 +1,11 @@
1
+ import type { WorkflowRuntimeMeta } from './workflow.types.js';
2
+ export type ResolvedWorkflowMeta = {
3
+ meta: WorkflowRuntimeMeta;
4
+ packageName: string | null;
5
+ resolvedName: string;
6
+ };
7
+ /**
8
+ * Resolves a workflow name against the root registry, then — for a
9
+ * `namespace:name` form — against the addon package that claims the namespace.
10
+ */
11
+ export declare const resolveWorkflowMeta: (name: string) => ResolvedWorkflowMeta | null;
@@ -0,0 +1,31 @@
1
+ import { pikkuState } from '../../pikku-state.js';
2
+ /**
3
+ * Resolves a workflow name against the root registry, then — for a
4
+ * `namespace:name` form — against the addon package that claims the namespace.
5
+ */
6
+ export const resolveWorkflowMeta = (name) => {
7
+ const rootMeta = pikkuState(null, 'workflows', 'meta');
8
+ if (rootMeta[name]) {
9
+ return { meta: rootMeta[name], packageName: null, resolvedName: name };
10
+ }
11
+ const colonIndex = name.indexOf(':');
12
+ if (colonIndex === -1) {
13
+ return null;
14
+ }
15
+ const namespace = name.substring(0, colonIndex);
16
+ const localName = name.substring(colonIndex + 1);
17
+ const addons = pikkuState(null, 'addons', 'packages');
18
+ const pkgConfig = addons?.get(namespace);
19
+ if (!pkgConfig) {
20
+ return null;
21
+ }
22
+ const addonMeta = pikkuState(pkgConfig.package, 'workflows', 'meta');
23
+ if (!addonMeta?.[localName]) {
24
+ return null;
25
+ }
26
+ return {
27
+ meta: addonMeta[localName],
28
+ packageName: pkgConfig.package,
29
+ resolvedName: localName,
30
+ };
31
+ };
@@ -0,0 +1,8 @@
1
+ import type { JobGroup, JobOptions } from '../queue/queue.types.js';
2
+ import type { WorkflowServiceConfig, WorkflowStepOptions } from './workflow.types.js';
3
+ export type WorkflowQueueStrategy = 'per-workflow' | 'shared-groups';
4
+ export declare const resolveWorkflowConfig: () => WorkflowServiceConfig;
5
+ export declare const orchestratorQueueName: (strategy: WorkflowQueueStrategy, workflowName?: string) => string;
6
+ export declare const stepWorkerQueueName: (strategy: WorkflowQueueStrategy, rpcName?: string) => string;
7
+ export declare const jobGroupFor: (strategy: WorkflowQueueStrategy, id?: string) => JobGroup | undefined;
8
+ export declare const stepJobOptions: (stepOptions?: WorkflowStepOptions) => JobOptions;