@lumenflow/cli 4.24.0 → 5.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (287) hide show
  1. package/README.md +54 -52
  2. package/dist/agent-issues-query.js +10 -2
  3. package/dist/agent-issues-query.js.map +1 -1
  4. package/dist/agent-runtime-enrollment-events.js +44 -0
  5. package/dist/agent-runtime-enrollment-events.js.map +1 -0
  6. package/dist/agent-session-end.js +47 -0
  7. package/dist/agent-session-end.js.map +1 -1
  8. package/dist/agent-session-heartbeat.js +250 -0
  9. package/dist/agent-session-heartbeat.js.map +1 -0
  10. package/dist/agent-session.js +299 -5
  11. package/dist/agent-session.js.map +1 -1
  12. package/dist/capacity-snapshot-emitter.js +73 -0
  13. package/dist/capacity-snapshot-emitter.js.map +1 -0
  14. package/dist/claim-queue.js +276 -0
  15. package/dist/claim-queue.js.map +1 -0
  16. package/dist/config-set.js +22 -3
  17. package/dist/config-set.js.map +1 -1
  18. package/dist/control-plane-sidecar-runner.js +145 -0
  19. package/dist/control-plane-sidecar-runner.js.map +1 -0
  20. package/dist/delegation-list.js +160 -1
  21. package/dist/delegation-list.js.map +1 -1
  22. package/dist/delegation-role-resolver.js +69 -0
  23. package/dist/delegation-role-resolver.js.map +1 -0
  24. package/dist/docs-generate-pack-reference.js +500 -0
  25. package/dist/docs-generate-pack-reference.js.map +1 -0
  26. package/dist/docs-sync.js +116 -1
  27. package/dist/docs-sync.js.map +1 -1
  28. package/dist/file-edit.js +28 -8
  29. package/dist/file-edit.js.map +1 -1
  30. package/dist/file-write.js +29 -5
  31. package/dist/file-write.js.map +1 -1
  32. package/dist/gate-co-change.js +25 -7
  33. package/dist/gate-co-change.js.map +1 -1
  34. package/dist/gate-conditional.js +19 -7
  35. package/dist/gate-conditional.js.map +1 -1
  36. package/dist/gates-runners.js +42 -33
  37. package/dist/gates-runners.js.map +1 -1
  38. package/dist/gates-utils.js +34 -20
  39. package/dist/gates-utils.js.map +1 -1
  40. package/dist/gates.js +79 -7
  41. package/dist/gates.js.map +1 -1
  42. package/dist/hooks/config-resolver.js +10 -1
  43. package/dist/hooks/config-resolver.js.map +1 -1
  44. package/dist/init-package-config.js +1 -1
  45. package/dist/init-package-config.js.map +1 -1
  46. package/dist/init-scaffolding.js +5 -1
  47. package/dist/init-scaffolding.js.map +1 -1
  48. package/dist/init-templates.js +10 -0
  49. package/dist/init-templates.js.map +1 -1
  50. package/dist/init.js +1 -1
  51. package/dist/init.js.map +1 -1
  52. package/dist/initiative-create.js +17 -0
  53. package/dist/initiative-create.js.map +1 -1
  54. package/dist/initiative-remove-wu.js +17 -3
  55. package/dist/initiative-remove-wu.js.map +1 -1
  56. package/dist/kernel-event-sync/emitters.js +104 -0
  57. package/dist/kernel-event-sync/emitters.js.map +1 -0
  58. package/dist/kernel-event-sync/index.js +13 -0
  59. package/dist/kernel-event-sync/index.js.map +1 -0
  60. package/dist/kernel-event-sync/lifecycle-emitters.js +160 -0
  61. package/dist/kernel-event-sync/lifecycle-emitters.js.map +1 -0
  62. package/dist/kernel-event-sync/narrow-emissions.js +89 -0
  63. package/dist/kernel-event-sync/narrow-emissions.js.map +1 -0
  64. package/dist/kernel-event-sync/software-delivery-emitters.js +297 -0
  65. package/dist/kernel-event-sync/software-delivery-emitters.js.map +1 -0
  66. package/dist/lane-lock.js +14 -1
  67. package/dist/lane-lock.js.map +1 -1
  68. package/dist/lane-suggest.js +21 -0
  69. package/dist/lane-suggest.js.map +1 -1
  70. package/dist/lumenflow-upgrade.js +7 -5
  71. package/dist/lumenflow-upgrade.js.map +1 -1
  72. package/dist/mem-context.js +145 -0
  73. package/dist/mem-context.js.map +1 -1
  74. package/dist/mem-create.js +39 -6
  75. package/dist/mem-create.js.map +1 -1
  76. package/dist/mem-inbox.js +16 -0
  77. package/dist/mem-inbox.js.map +1 -1
  78. package/dist/mem-roster.js +95 -0
  79. package/dist/mem-roster.js.map +1 -0
  80. package/dist/mem-signal.js +97 -2
  81. package/dist/mem-signal.js.map +1 -1
  82. package/dist/metrics-snapshot.js +3 -2
  83. package/dist/metrics-snapshot.js.map +1 -1
  84. package/dist/orchestrate-init-status.js +117 -2
  85. package/dist/orchestrate-init-status.js.map +1 -1
  86. package/dist/orchestrate-initiative.js +83 -10
  87. package/dist/orchestrate-initiative.js.map +1 -1
  88. package/dist/orchestrate-monitor-quality.js +289 -0
  89. package/dist/orchestrate-monitor-quality.js.map +1 -0
  90. package/dist/orchestrate-monitor.js +85 -0
  91. package/dist/orchestrate-monitor.js.map +1 -1
  92. package/dist/pack-validate.js +127 -2
  93. package/dist/pack-validate.js.map +1 -1
  94. package/dist/plan-create.js +18 -0
  95. package/dist/plan-create.js.map +1 -1
  96. package/dist/plan-link.js +13 -0
  97. package/dist/plan-link.js.map +1 -1
  98. package/dist/plan-promote.js +14 -0
  99. package/dist/plan-promote.js.map +1 -1
  100. package/dist/pre-commit-check.js +4 -3
  101. package/dist/pre-commit-check.js.map +1 -1
  102. package/dist/public-manifest.js +17 -3
  103. package/dist/public-manifest.js.map +1 -1
  104. package/dist/release.js +28 -10
  105. package/dist/release.js.map +1 -1
  106. package/dist/session-cross-link.js +139 -0
  107. package/dist/session-cross-link.js.map +1 -0
  108. package/dist/sidecar-manager.js +208 -0
  109. package/dist/sidecar-manager.js.map +1 -0
  110. package/dist/state-path-resolvers.js +18 -0
  111. package/dist/state-path-resolvers.js.map +1 -1
  112. package/dist/stream-heartbeat.js +151 -0
  113. package/dist/stream-heartbeat.js.map +1 -0
  114. package/dist/sync-templates.js +56 -2
  115. package/dist/sync-templates.js.map +1 -1
  116. package/dist/wu-block.js +47 -5
  117. package/dist/wu-block.js.map +1 -1
  118. package/dist/wu-claim-branch.js +8 -4
  119. package/dist/wu-claim-branch.js.map +1 -1
  120. package/dist/wu-claim-state.js +5 -3
  121. package/dist/wu-claim-state.js.map +1 -1
  122. package/dist/wu-claim-worktree.js +5 -3
  123. package/dist/wu-claim-worktree.js.map +1 -1
  124. package/dist/wu-claim.js +261 -9
  125. package/dist/wu-claim.js.map +1 -1
  126. package/dist/wu-done-auto-cleanup.js +3 -2
  127. package/dist/wu-done-auto-cleanup.js.map +1 -1
  128. package/dist/wu-done-git-ops.js +12 -8
  129. package/dist/wu-done-git-ops.js.map +1 -1
  130. package/dist/wu-done-preflight.js +3 -3
  131. package/dist/wu-done-preflight.js.map +1 -1
  132. package/dist/wu-done.js +46 -10
  133. package/dist/wu-done.js.map +1 -1
  134. package/dist/wu-lifecycle-sync/gate-scope-resolver.js +16 -0
  135. package/dist/wu-lifecycle-sync/gate-scope-resolver.js.map +1 -0
  136. package/dist/wu-lifecycle-sync/kernel-event-sync-shim.js +10 -0
  137. package/dist/wu-lifecycle-sync/kernel-event-sync-shim.js.map +1 -0
  138. package/dist/wu-prep.js +363 -22
  139. package/dist/wu-prep.js.map +1 -1
  140. package/dist/wu-prune.js +68 -27
  141. package/dist/wu-prune.js.map +1 -1
  142. package/dist/wu-release.js +34 -3
  143. package/dist/wu-release.js.map +1 -1
  144. package/dist/wu-review.js +167 -0
  145. package/dist/wu-review.js.map +1 -0
  146. package/dist/wu-spawn-prompt-builders.js +296 -40
  147. package/dist/wu-spawn-prompt-builders.js.map +1 -1
  148. package/dist/wu-spawn-strategy-resolver.js +126 -14
  149. package/dist/wu-spawn-strategy-resolver.js.map +1 -1
  150. package/dist/wu-unblock.js +52 -22
  151. package/dist/wu-unblock.js.map +1 -1
  152. package/package.json +13 -8
  153. package/packs/agent-runtime/agent-heartbeat.ts +163 -0
  154. package/packs/agent-runtime/auto-session-integration.ts +874 -0
  155. package/packs/agent-runtime/delegation-registry-schema.ts +220 -0
  156. package/packs/agent-runtime/delegation-registry-store.ts +269 -0
  157. package/packs/agent-runtime/delegation-tree.ts +328 -0
  158. package/packs/agent-runtime/index.ts +9 -0
  159. package/packs/agent-runtime/manifest.ts +109 -19
  160. package/packs/agent-runtime/manifest.yaml +150 -0
  161. package/packs/agent-runtime/memory-coordination-contract.ts +86 -0
  162. package/packs/agent-runtime/memory.d.ts +19 -0
  163. package/packs/agent-runtime/orchestration.ts +238 -23
  164. package/packs/agent-runtime/package.json +11 -2
  165. package/packs/agent-runtime/remote-controls/index.ts +7 -0
  166. package/packs/agent-runtime/remote-controls/operations.ts +399 -0
  167. package/packs/agent-runtime/remote-controls/port.ts +48 -0
  168. package/packs/agent-runtime/remote-controls/state-store.ts +258 -0
  169. package/packs/agent-runtime/remote-controls/types.ts +105 -0
  170. package/packs/agent-runtime/session-schema.ts +423 -0
  171. package/packs/agent-runtime/tool-impl/index.ts +1 -0
  172. package/packs/agent-runtime/tool-impl/remote-controls.mock.ts +252 -0
  173. package/packs/agent-runtime/tool-impl/remote-controls.ts +273 -0
  174. package/packs/agent-runtime/tsconfig.json +1 -1
  175. package/packs/agent-runtime/turn-lifecycle-events.ts +501 -0
  176. package/packs/sidekick/channel-ingress.ts +137 -0
  177. package/packs/sidekick/manifest.ts +74 -0
  178. package/packs/sidekick/manifest.yaml +88 -0
  179. package/packs/sidekick/package.json +3 -1
  180. package/packs/sidekick/sidekick-events.ts +517 -0
  181. package/packs/sidekick/src/adapters/cloud-queue.ts +101 -0
  182. package/packs/sidekick/src/adapters/control-plane-bridge.adapter.ts +378 -0
  183. package/packs/sidekick/src/adapters/filesystem-bridge.adapter.ts +224 -0
  184. package/packs/sidekick/src/domain/channel.types.ts +84 -0
  185. package/packs/sidekick/src/ports/channel-bridge.port.ts +75 -0
  186. package/packs/sidekick/src/routines/commit.ts +74 -0
  187. package/packs/sidekick/tool-impl/channel-tools.ts +47 -0
  188. package/packs/sidekick/tool-impl/memory-tools.ts +17 -0
  189. package/packs/sidekick/tool-impl/routine-commit.ts +102 -0
  190. package/packs/sidekick/tool-impl/routine-tools.ts +67 -7
  191. package/packs/sidekick/tool-impl/runtime-context.ts +4 -0
  192. package/packs/sidekick/tool-impl/storage.ts +3 -0
  193. package/packs/sidekick/tool-impl/system-tools.ts +7 -0
  194. package/packs/sidekick/tool-impl/task-tools.ts +46 -0
  195. package/packs/sidekick/tsconfig.json +1 -1
  196. package/packs/software-delivery/manifest-schema.ts +30 -0
  197. package/packs/software-delivery/manifest.ts +160 -11
  198. package/packs/software-delivery/manifest.yaml +210 -230
  199. package/packs/software-delivery/package.json +88 -3
  200. package/packs/software-delivery/src/commands/index.ts +5 -0
  201. package/packs/software-delivery/src/config/delivery-review-contract.ts +20 -0
  202. package/packs/software-delivery/src/config/env-accessors.ts +19 -0
  203. package/packs/software-delivery/src/config/index.ts +8 -0
  204. package/packs/software-delivery/src/config/normalize-config-keys.ts +19 -0
  205. package/packs/software-delivery/src/config/schemas/lumenflow-config-schema-types.ts +436 -0
  206. package/packs/software-delivery/src/config/workspace-reader.ts +310 -0
  207. package/packs/software-delivery/src/constants/backlog-patterns.ts +31 -0
  208. package/packs/software-delivery/src/constants/client-ids.ts +19 -0
  209. package/packs/software-delivery/src/constants/config-contract.ts +7 -0
  210. package/packs/software-delivery/src/constants/docs-layout-presets.ts +50 -0
  211. package/packs/software-delivery/src/constants/duration-constants.ts +20 -0
  212. package/packs/software-delivery/src/constants/gate-constants.ts +32 -0
  213. package/packs/software-delivery/src/constants/index.ts +29 -0
  214. package/packs/software-delivery/src/constants/lock-constants.ts +35 -0
  215. package/packs/software-delivery/src/constants/object-guards.ts +12 -0
  216. package/packs/software-delivery/src/constants/section-headings.ts +107 -0
  217. package/packs/software-delivery/src/constants/wu-cli-constants.ts +485 -0
  218. package/packs/software-delivery/src/constants/wu-domain-constants.ts +466 -0
  219. package/packs/software-delivery/src/constants/wu-git-constants.ts +7 -0
  220. package/packs/software-delivery/src/constants/wu-id-format.ts +327 -0
  221. package/packs/software-delivery/src/constants/wu-paths-constants.ts +358 -0
  222. package/packs/software-delivery/src/constants/wu-statuses.ts +287 -0
  223. package/packs/software-delivery/src/constants/wu-type-helpers.ts +67 -0
  224. package/packs/software-delivery/src/constants/wu-ui-constants.ts +267 -0
  225. package/packs/software-delivery/src/constants/wu-validation-constants.ts +73 -0
  226. package/packs/software-delivery/src/domain/index.ts +5 -0
  227. package/packs/software-delivery/src/domain/orchestration.constants.ts +168 -0
  228. package/packs/software-delivery/src/domain/orchestration.schemas.ts +239 -0
  229. package/packs/software-delivery/src/domain/orchestration.types.ts +178 -0
  230. package/packs/software-delivery/src/methodology/incremental-test.ts +90 -0
  231. package/packs/software-delivery/src/methodology/index.ts +6 -0
  232. package/packs/software-delivery/src/methodology/manual-test-validator.ts +292 -0
  233. package/packs/software-delivery/src/policy/coverage-gate.ts +270 -0
  234. package/packs/software-delivery/src/policy/gates-agent-mode.ts +223 -0
  235. package/packs/software-delivery/src/policy/gates-config-internal.ts +121 -0
  236. package/packs/software-delivery/src/policy/gates-config.ts +293 -0
  237. package/packs/software-delivery/src/policy/gates-coverage.ts +247 -0
  238. package/packs/software-delivery/src/policy/gates-presets.ts +134 -0
  239. package/packs/software-delivery/src/policy/gates-schemas.ts +173 -0
  240. package/packs/software-delivery/src/policy/index.ts +22 -0
  241. package/packs/software-delivery/src/policy/package-manager-resolver.ts +319 -0
  242. package/packs/software-delivery/src/policy/resolve-policy.ts +518 -0
  243. package/packs/software-delivery/src/ports/config.ports.ts +90 -0
  244. package/packs/software-delivery/src/ports/dashboard-renderer.port.ts +125 -0
  245. package/packs/software-delivery/src/ports/index.ts +10 -0
  246. package/packs/software-delivery/src/ports/sync-validator.ports.ts +59 -0
  247. package/packs/software-delivery/src/ports/wu-helpers.ports.ts +168 -0
  248. package/packs/software-delivery/src/ports/wu-state.ports.ts +241 -0
  249. package/packs/software-delivery/src/primitives/index.ts +5 -0
  250. package/packs/software-delivery/src/runtime/index.ts +6 -0
  251. package/packs/software-delivery/src/runtime/work-classifier.ts +561 -0
  252. package/packs/software-delivery/src/sandbox/index.ts +10 -0
  253. package/packs/software-delivery/src/sandbox/sandbox-allowlist.ts +118 -0
  254. package/packs/software-delivery/src/sandbox/sandbox-backend-linux.ts +88 -0
  255. package/packs/software-delivery/src/sandbox/sandbox-backend-macos.ts +154 -0
  256. package/packs/software-delivery/src/sandbox/sandbox-backend-windows.ts +47 -0
  257. package/packs/software-delivery/src/sandbox/sandbox-profile.ts +153 -0
  258. package/packs/software-delivery/src/schemas/index.ts +5 -0
  259. package/packs/software-delivery/src/state/date-utils.ts +158 -0
  260. package/packs/software-delivery/src/state/index.ts +15 -0
  261. package/packs/software-delivery/src/state/state-machine.ts +119 -0
  262. package/packs/software-delivery/src/state/wu-doc-types.ts +51 -0
  263. package/packs/software-delivery/src/state/wu-paths.ts +381 -0
  264. package/packs/software-delivery/src/state/wu-schema.ts +1139 -0
  265. package/packs/software-delivery/src/state/wu-state-schema.ts +255 -0
  266. package/packs/software-delivery/src/state/wu-yaml.ts +338 -0
  267. package/packs/software-delivery/src/types.d.ts +16 -0
  268. package/packs/software-delivery/tool-impl/wu-lifecycle-tools.ts +18 -0
  269. package/packs/software-delivery/tsconfig.json +28 -2
  270. package/templates/core/AGENTS.md.template +76 -17
  271. package/templates/core/LUMENFLOW.md.template +265 -66
  272. package/templates/core/_frameworks/lumenflow/wu-sizing-guide.md.template +180 -116
  273. package/templates/core/ai/onboarding/agent-invocation-guide.md.template +26 -8
  274. package/templates/core/ai/onboarding/existing-project-bootstrap.md.template +171 -0
  275. package/templates/core/ai/onboarding/first-15-mins.md.template +3 -1
  276. package/templates/core/ai/onboarding/first-wu-mistakes.md.template +1 -1
  277. package/templates/core/ai/onboarding/initiative-orchestration.md.template +46 -30
  278. package/templates/core/ai/onboarding/quick-ref-commands.md.template +36 -33
  279. package/templates/core/ai/onboarding/release-process.md.template +8 -7
  280. package/templates/core/ai/onboarding/starting-prompt.md.template +2 -0
  281. package/templates/core/ai/onboarding/troubleshooting-wu-done.md.template +62 -0
  282. package/templates/vendors/claude/.claude/CLAUDE.md.template +29 -54
  283. package/templates/vendors/cursor/.cursor/rules/lumenflow.md.template +24 -52
  284. package/templates/vendors/windsurf/.windsurf/rules/lumenflow.md.template +24 -52
  285. package/packs/agent-runtime/.turbo/turbo-build.log +0 -4
  286. package/packs/sidekick/.turbo/turbo-build.log +0 -4
  287. package/packs/software-delivery/.turbo/turbo-build.log +0 -4
@@ -0,0 +1,517 @@
1
+ // Copyright (c) 2026 Hellmai Ltd
2
+ // SPDX-License-Identifier: AGPL-3.0-only
3
+
4
+ import { createHash, randomUUID } from 'node:crypto';
5
+ import { appendFile, mkdir } from 'node:fs/promises';
6
+ import path from 'node:path';
7
+ import { getSidekickRuntimeContext } from './tool-impl/runtime-context.js';
8
+ import {
9
+ getStoragePort,
10
+ type ChannelMessageRecord,
11
+ type ChannelRecord,
12
+ type MemoryRecord,
13
+ type RoutineRecord,
14
+ type SidekickStores,
15
+ type TaskRecord,
16
+ } from './tool-impl/storage.js';
17
+
18
+ const SCHEMA_VERSION_V2 = 2 as const;
19
+ const CONTENT_HASH_ALGORITHM = 'sha256';
20
+ const CONTENT_HASH_ENCODING = 'hex';
21
+ const CONTENT_HASH_PREFIX_LENGTH = 32;
22
+ const OUTBOX_RELATIVE_PATH = path.join(
23
+ '.lumenflow',
24
+ 'state',
25
+ 'conductor',
26
+ 'outbox',
27
+ 'sidekick-events.jsonl',
28
+ );
29
+
30
+ export const SIDEKICK_CHANNEL_ID = 'sidekick' as const;
31
+
32
+ export const SIDEKICK_EVENT_KINDS = {
33
+ TASK_CREATED: 'sidekick:task_created',
34
+ TASK_COMPLETED: 'sidekick:task_completed',
35
+ TASK_SCHEDULED: 'sidekick:task_scheduled',
36
+ TASK_SNOOZED: 'sidekick:task_snoozed',
37
+ MEMORY_STORED: 'sidekick:memory_stored',
38
+ MEMORY_RECALLED: 'sidekick:memory_recalled',
39
+ MEMORY_FORGOTTEN: 'sidekick:memory_forgotten',
40
+ CHANNEL_MESSAGE_SENT: 'sidekick:channel_message_sent',
41
+ CHANNEL_MESSAGE_RECEIVED: 'sidekick:channel_message_received',
42
+ CHANNEL_BRIDGE_CONNECTED: 'sidekick:channel_bridge_connected',
43
+ CHANNEL_BRIDGE_DISCONNECTED: 'sidekick:channel_bridge_disconnected',
44
+ ROUTINE_PLANNED: 'sidekick:routine_planned',
45
+ ROUTINE_COMMITTED: 'sidekick:routine_committed',
46
+ ROUTINE_EXECUTED: 'sidekick:routine_executed',
47
+ ROUTINE_STEP_FAILED: 'sidekick:routine_step_failed',
48
+ STATE_REHYDRATED: 'sidekick:state_rehydrated',
49
+ } as const;
50
+
51
+ export const SIDEKICK_EVENT_KIND_VALUES = [
52
+ SIDEKICK_EVENT_KINDS.TASK_CREATED,
53
+ SIDEKICK_EVENT_KINDS.TASK_COMPLETED,
54
+ SIDEKICK_EVENT_KINDS.TASK_SCHEDULED,
55
+ SIDEKICK_EVENT_KINDS.TASK_SNOOZED,
56
+ SIDEKICK_EVENT_KINDS.MEMORY_STORED,
57
+ SIDEKICK_EVENT_KINDS.MEMORY_RECALLED,
58
+ SIDEKICK_EVENT_KINDS.MEMORY_FORGOTTEN,
59
+ SIDEKICK_EVENT_KINDS.CHANNEL_MESSAGE_SENT,
60
+ SIDEKICK_EVENT_KINDS.CHANNEL_MESSAGE_RECEIVED,
61
+ SIDEKICK_EVENT_KINDS.CHANNEL_BRIDGE_CONNECTED,
62
+ SIDEKICK_EVENT_KINDS.CHANNEL_BRIDGE_DISCONNECTED,
63
+ SIDEKICK_EVENT_KINDS.ROUTINE_PLANNED,
64
+ SIDEKICK_EVENT_KINDS.ROUTINE_COMMITTED,
65
+ SIDEKICK_EVENT_KINDS.ROUTINE_EXECUTED,
66
+ SIDEKICK_EVENT_KINDS.ROUTINE_STEP_FAILED,
67
+ SIDEKICK_EVENT_KINDS.STATE_REHYDRATED,
68
+ ] as const;
69
+
70
+ export type SidekickEventKind = (typeof SIDEKICK_EVENT_KIND_VALUES)[number];
71
+ export type SidekickBackpressurePolicy = 'queue-with-replay' | 'ephemeral';
72
+
73
+ const QUEUE_WITH_REPLAY: SidekickBackpressurePolicy = 'queue-with-replay';
74
+ const EPHEMERAL: SidekickBackpressurePolicy = 'ephemeral';
75
+
76
+ export const SIDEKICK_EVENT_BACKPRESSURE_POLICY: Record<
77
+ SidekickEventKind,
78
+ SidekickBackpressurePolicy
79
+ > = {
80
+ [SIDEKICK_EVENT_KINDS.TASK_CREATED]: QUEUE_WITH_REPLAY,
81
+ [SIDEKICK_EVENT_KINDS.TASK_COMPLETED]: QUEUE_WITH_REPLAY,
82
+ [SIDEKICK_EVENT_KINDS.TASK_SCHEDULED]: QUEUE_WITH_REPLAY,
83
+ [SIDEKICK_EVENT_KINDS.TASK_SNOOZED]: QUEUE_WITH_REPLAY,
84
+ [SIDEKICK_EVENT_KINDS.MEMORY_STORED]: EPHEMERAL,
85
+ [SIDEKICK_EVENT_KINDS.MEMORY_RECALLED]: EPHEMERAL,
86
+ [SIDEKICK_EVENT_KINDS.MEMORY_FORGOTTEN]: EPHEMERAL,
87
+ [SIDEKICK_EVENT_KINDS.CHANNEL_MESSAGE_SENT]: EPHEMERAL,
88
+ [SIDEKICK_EVENT_KINDS.CHANNEL_MESSAGE_RECEIVED]: EPHEMERAL,
89
+ [SIDEKICK_EVENT_KINDS.CHANNEL_BRIDGE_CONNECTED]: EPHEMERAL,
90
+ [SIDEKICK_EVENT_KINDS.CHANNEL_BRIDGE_DISCONNECTED]: EPHEMERAL,
91
+ [SIDEKICK_EVENT_KINDS.ROUTINE_PLANNED]: QUEUE_WITH_REPLAY,
92
+ [SIDEKICK_EVENT_KINDS.ROUTINE_COMMITTED]: QUEUE_WITH_REPLAY,
93
+ [SIDEKICK_EVENT_KINDS.ROUTINE_EXECUTED]: QUEUE_WITH_REPLAY,
94
+ [SIDEKICK_EVENT_KINDS.ROUTINE_STEP_FAILED]: QUEUE_WITH_REPLAY,
95
+ [SIDEKICK_EVENT_KINDS.STATE_REHYDRATED]: QUEUE_WITH_REPLAY,
96
+ };
97
+
98
+ interface SidekickEventEnvelope {
99
+ schema_version: typeof SCHEMA_VERSION_V2;
100
+ timestamp: string;
101
+ event_id: string;
102
+ channel_id: typeof SIDEKICK_CHANNEL_ID;
103
+ seq: number;
104
+ }
105
+
106
+ export interface TaskCreatedEvent extends SidekickEventEnvelope {
107
+ kind: typeof SIDEKICK_EVENT_KINDS.TASK_CREATED;
108
+ task: TaskRecord;
109
+ }
110
+
111
+ export interface TaskCompletedEvent extends SidekickEventEnvelope {
112
+ kind: typeof SIDEKICK_EVENT_KINDS.TASK_COMPLETED;
113
+ task: TaskRecord;
114
+ }
115
+
116
+ export interface TaskScheduledEvent extends SidekickEventEnvelope {
117
+ kind: typeof SIDEKICK_EVENT_KINDS.TASK_SCHEDULED;
118
+ task: TaskRecord;
119
+ }
120
+
121
+ export interface TaskSnoozedEvent extends SidekickEventEnvelope {
122
+ kind: typeof SIDEKICK_EVENT_KINDS.TASK_SNOOZED;
123
+ task_id: string;
124
+ previous_due_at: string | null;
125
+ due_at: string;
126
+ }
127
+
128
+ export interface MemoryStoredEvent extends SidekickEventEnvelope {
129
+ kind: typeof SIDEKICK_EVENT_KINDS.MEMORY_STORED;
130
+ memory: MemoryRecord;
131
+ }
132
+
133
+ export interface MemoryRecalledEvent extends SidekickEventEnvelope {
134
+ kind: typeof SIDEKICK_EVENT_KINDS.MEMORY_RECALLED;
135
+ query: string | null;
136
+ count: number;
137
+ memory_ids: string[];
138
+ }
139
+
140
+ export interface MemoryForgottenEvent extends SidekickEventEnvelope {
141
+ kind: typeof SIDEKICK_EVENT_KINDS.MEMORY_FORGOTTEN;
142
+ memory_id: string;
143
+ }
144
+
145
+ export interface ChannelMessageSentEvent extends SidekickEventEnvelope {
146
+ kind: typeof SIDEKICK_EVENT_KINDS.CHANNEL_MESSAGE_SENT;
147
+ message: Record<string, unknown>;
148
+ }
149
+
150
+ export interface ChannelMessageReceivedEvent extends SidekickEventEnvelope {
151
+ kind: typeof SIDEKICK_EVENT_KINDS.CHANNEL_MESSAGE_RECEIVED;
152
+ channel: string;
153
+ count: number;
154
+ provider?: string;
155
+ }
156
+
157
+ export interface ChannelBridgeConnectedEvent extends SidekickEventEnvelope {
158
+ kind: typeof SIDEKICK_EVENT_KINDS.CHANNEL_BRIDGE_CONNECTED;
159
+ channel: ChannelRecord;
160
+ }
161
+
162
+ export interface ChannelBridgeDisconnectedEvent extends SidekickEventEnvelope {
163
+ kind: typeof SIDEKICK_EVENT_KINDS.CHANNEL_BRIDGE_DISCONNECTED;
164
+ bridge_id: string;
165
+ deleted_message_count: number;
166
+ }
167
+
168
+ export interface RoutinePlannedEvent extends SidekickEventEnvelope {
169
+ kind: typeof SIDEKICK_EVENT_KINDS.ROUTINE_PLANNED;
170
+ routine: RoutineRecord;
171
+ }
172
+
173
+ export interface RoutineCommittedEvent extends SidekickEventEnvelope {
174
+ kind: typeof SIDEKICK_EVENT_KINDS.ROUTINE_COMMITTED;
175
+ routine: RoutineRecord;
176
+ /**
177
+ * WU-2738 (INIT-060, ADR-013 §6 governance): content-hash of the commit
178
+ * envelope carried when the event is emitted by the governed
179
+ * `sidekick:routine:commit_plan` tool. PII stays inside the local
180
+ * envelope; cloud correlates on the hash. Optional so the existing
181
+ * update-triggered emission (routine:update) stays PII-free.
182
+ */
183
+ envelope_content_hash?: string;
184
+ }
185
+
186
+ export interface RoutineExecutedEvent extends SidekickEventEnvelope {
187
+ kind: typeof SIDEKICK_EVENT_KINDS.ROUTINE_EXECUTED;
188
+ routine_id: string;
189
+ name: string;
190
+ step_count: number;
191
+ plan_only: true;
192
+ }
193
+
194
+ export interface RoutineStepFailedEvent extends SidekickEventEnvelope {
195
+ kind: typeof SIDEKICK_EVENT_KINDS.ROUTINE_STEP_FAILED;
196
+ step_index: number;
197
+ reason: string;
198
+ routine_id?: string;
199
+ routine_name?: string;
200
+ }
201
+
202
+ export interface StateRehydratedEvent extends SidekickEventEnvelope {
203
+ kind: typeof SIDEKICK_EVENT_KINDS.STATE_REHYDRATED;
204
+ snapshot: SidekickStores;
205
+ }
206
+
207
+ export type SidekickEvent =
208
+ | TaskCreatedEvent
209
+ | TaskCompletedEvent
210
+ | TaskScheduledEvent
211
+ | TaskSnoozedEvent
212
+ | MemoryStoredEvent
213
+ | MemoryRecalledEvent
214
+ | MemoryForgottenEvent
215
+ | ChannelMessageSentEvent
216
+ | ChannelMessageReceivedEvent
217
+ | ChannelBridgeConnectedEvent
218
+ | ChannelBridgeDisconnectedEvent
219
+ | RoutinePlannedEvent
220
+ | RoutineCommittedEvent
221
+ | RoutineExecutedEvent
222
+ | RoutineStepFailedEvent
223
+ | StateRehydratedEvent;
224
+
225
+ const channelSeqCounters = new Map<string, number>();
226
+
227
+ type EventPayload = Record<string, unknown> & { kind: SidekickEventKind };
228
+
229
+ function nextSeq(channelId: string): number {
230
+ const current = channelSeqCounters.get(channelId) ?? 0;
231
+ const next = current + 1;
232
+ channelSeqCounters.set(channelId, next);
233
+ return next;
234
+ }
235
+
236
+ function resolveTimestamp(timestamp?: string): string {
237
+ return timestamp ?? new Date().toISOString();
238
+ }
239
+
240
+ function resolveEventId(
241
+ kind: SidekickEventKind,
242
+ payload: Record<string, unknown>,
243
+ timestamp: string,
244
+ idempotencyKey?: string,
245
+ ): string {
246
+ if (!idempotencyKey) {
247
+ return randomUUID();
248
+ }
249
+ return createHash(CONTENT_HASH_ALGORITHM)
250
+ .update(
251
+ JSON.stringify({
252
+ kind,
253
+ payload,
254
+ timestamp,
255
+ idempotencyKey,
256
+ }),
257
+ )
258
+ .digest(CONTENT_HASH_ENCODING)
259
+ .slice(0, CONTENT_HASH_PREFIX_LENGTH);
260
+ }
261
+
262
+ function stampSidekickEvent<TEvent extends SidekickEvent>(
263
+ payload: EventPayload,
264
+ options?: { timestamp?: string; idempotencyKey?: string },
265
+ ): TEvent {
266
+ const timestamp = resolveTimestamp(options?.timestamp);
267
+ const event_id = resolveEventId(payload.kind, payload, timestamp, options?.idempotencyKey);
268
+ return {
269
+ ...payload,
270
+ schema_version: SCHEMA_VERSION_V2,
271
+ timestamp,
272
+ event_id,
273
+ channel_id: SIDEKICK_CHANNEL_ID,
274
+ seq: nextSeq(SIDEKICK_CHANNEL_ID),
275
+ } as TEvent;
276
+ }
277
+
278
+ async function queueEvent(event: SidekickEvent, workspaceRoot: string): Promise<void> {
279
+ const outboxPath = path.join(workspaceRoot, OUTBOX_RELATIVE_PATH);
280
+ await mkdir(path.dirname(outboxPath), { recursive: true });
281
+ await appendFile(outboxPath, `${JSON.stringify(event)}\n`, 'utf8');
282
+ }
283
+
284
+ export function resetSidekickSeqCounter(): void {
285
+ channelSeqCounters.clear();
286
+ }
287
+
288
+ export function readSidekickOrgId(config: unknown): string | undefined {
289
+ if (!config || typeof config !== 'object') {
290
+ return undefined;
291
+ }
292
+ const controlPlane = (config as { control_plane?: unknown }).control_plane;
293
+ if (!controlPlane || typeof controlPlane !== 'object') {
294
+ return undefined;
295
+ }
296
+ const raw = (controlPlane as { org_id?: unknown }).org_id;
297
+ if (typeof raw !== 'string') {
298
+ return undefined;
299
+ }
300
+ const trimmed = raw.trim();
301
+ return trimmed.length > 0 ? trimmed : undefined;
302
+ }
303
+
304
+ export async function emitSidekickEvent<TEvent extends SidekickEvent>(
305
+ event: TEvent,
306
+ ): Promise<TEvent> {
307
+ const runtimeContext = getSidekickRuntimeContext();
308
+ const policy = SIDEKICK_EVENT_BACKPRESSURE_POLICY[event.kind];
309
+ const orgId = readSidekickOrgId(runtimeContext?.workspaceConfig);
310
+ const sink = runtimeContext?.eventSink;
311
+
312
+ if (policy === 'ephemeral') {
313
+ if (!orgId || !sink) {
314
+ return event;
315
+ }
316
+ try {
317
+ await sink(event);
318
+ } catch {
319
+ // Ephemeral events fail silent when the control plane is unavailable.
320
+ }
321
+ return event;
322
+ }
323
+
324
+ if (orgId && sink) {
325
+ try {
326
+ await sink(event);
327
+ return event;
328
+ } catch {
329
+ // Fall through to queued replay on transport failure.
330
+ }
331
+ }
332
+
333
+ await queueEvent(event, runtimeContext?.workspaceRoot ?? process.cwd());
334
+ return event;
335
+ }
336
+
337
+ export async function snapshotSidekickState(): Promise<SidekickStores> {
338
+ const storage = getStoragePort();
339
+ const [tasks, memories, channels, messages, routines] = await Promise.all([
340
+ storage.readStore('tasks'),
341
+ storage.readStore('memories'),
342
+ storage.readStore('channels'),
343
+ storage.readStore('messages'),
344
+ storage.readStore('routines'),
345
+ ]);
346
+
347
+ return { tasks, memories, channels, messages, routines };
348
+ }
349
+
350
+ export function buildTaskCreatedEvent(task: TaskRecord): TaskCreatedEvent {
351
+ return stampSidekickEvent<TaskCreatedEvent>({
352
+ kind: SIDEKICK_EVENT_KINDS.TASK_CREATED,
353
+ task,
354
+ });
355
+ }
356
+
357
+ export function buildTaskCompletedEvent(task: TaskRecord): TaskCompletedEvent {
358
+ return stampSidekickEvent<TaskCompletedEvent>({
359
+ kind: SIDEKICK_EVENT_KINDS.TASK_COMPLETED,
360
+ task,
361
+ });
362
+ }
363
+
364
+ export function buildTaskScheduledEvent(task: TaskRecord): TaskScheduledEvent {
365
+ return stampSidekickEvent<TaskScheduledEvent>({
366
+ kind: SIDEKICK_EVENT_KINDS.TASK_SCHEDULED,
367
+ task,
368
+ });
369
+ }
370
+
371
+ export function buildTaskSnoozedEvent(input: {
372
+ task_id: string;
373
+ previous_due_at: string | null;
374
+ due_at: string;
375
+ }): TaskSnoozedEvent {
376
+ return stampSidekickEvent<TaskSnoozedEvent>({
377
+ kind: SIDEKICK_EVENT_KINDS.TASK_SNOOZED,
378
+ ...input,
379
+ });
380
+ }
381
+
382
+ export function buildMemoryStoredEvent(memory: MemoryRecord): MemoryStoredEvent {
383
+ return stampSidekickEvent<MemoryStoredEvent>({
384
+ kind: SIDEKICK_EVENT_KINDS.MEMORY_STORED,
385
+ memory,
386
+ });
387
+ }
388
+
389
+ export function buildMemoryRecalledEvent(input: {
390
+ query: string | null;
391
+ memories: MemoryRecord[];
392
+ }): MemoryRecalledEvent {
393
+ return stampSidekickEvent<MemoryRecalledEvent>({
394
+ kind: SIDEKICK_EVENT_KINDS.MEMORY_RECALLED,
395
+ query: input.query,
396
+ count: input.memories.length,
397
+ memory_ids: input.memories.map((memory) => memory.id),
398
+ });
399
+ }
400
+
401
+ export function buildMemoryForgottenEvent(memory_id: string): MemoryForgottenEvent {
402
+ return stampSidekickEvent<MemoryForgottenEvent>({
403
+ kind: SIDEKICK_EVENT_KINDS.MEMORY_FORGOTTEN,
404
+ memory_id,
405
+ });
406
+ }
407
+
408
+ export function buildChannelMessageSentEvent(
409
+ message: Record<string, unknown>,
410
+ ): ChannelMessageSentEvent {
411
+ return stampSidekickEvent<ChannelMessageSentEvent>({
412
+ kind: SIDEKICK_EVENT_KINDS.CHANNEL_MESSAGE_SENT,
413
+ message,
414
+ });
415
+ }
416
+
417
+ export function buildChannelMessageReceivedEvent(input: {
418
+ channel: string;
419
+ count: number;
420
+ provider?: string;
421
+ }): ChannelMessageReceivedEvent {
422
+ return stampSidekickEvent<ChannelMessageReceivedEvent>({
423
+ kind: SIDEKICK_EVENT_KINDS.CHANNEL_MESSAGE_RECEIVED,
424
+ channel: input.channel,
425
+ count: input.count,
426
+ ...(input.provider ? { provider: input.provider } : {}),
427
+ });
428
+ }
429
+
430
+ export function buildChannelBridgeConnectedEvent(
431
+ channel: ChannelRecord,
432
+ ): ChannelBridgeConnectedEvent {
433
+ return stampSidekickEvent<ChannelBridgeConnectedEvent>({
434
+ kind: SIDEKICK_EVENT_KINDS.CHANNEL_BRIDGE_CONNECTED,
435
+ channel,
436
+ });
437
+ }
438
+
439
+ export function buildChannelBridgeDisconnectedEvent(input: {
440
+ bridge_id: string;
441
+ deleted_message_count: number;
442
+ }): ChannelBridgeDisconnectedEvent {
443
+ return stampSidekickEvent<ChannelBridgeDisconnectedEvent>({
444
+ kind: SIDEKICK_EVENT_KINDS.CHANNEL_BRIDGE_DISCONNECTED,
445
+ ...input,
446
+ });
447
+ }
448
+
449
+ export function buildRoutinePlannedEvent(routine: RoutineRecord): RoutinePlannedEvent {
450
+ return stampSidekickEvent<RoutinePlannedEvent>({
451
+ kind: SIDEKICK_EVENT_KINDS.ROUTINE_PLANNED,
452
+ routine,
453
+ });
454
+ }
455
+
456
+ export function buildRoutineCommittedEvent(
457
+ routine: RoutineRecord,
458
+ options?: { envelope_content_hash?: string },
459
+ ): RoutineCommittedEvent {
460
+ return stampSidekickEvent<RoutineCommittedEvent>({
461
+ kind: SIDEKICK_EVENT_KINDS.ROUTINE_COMMITTED,
462
+ routine,
463
+ ...(options?.envelope_content_hash
464
+ ? { envelope_content_hash: options.envelope_content_hash }
465
+ : {}),
466
+ });
467
+ }
468
+
469
+ export function buildRoutineExecutedEvent(input: {
470
+ routine_id: string;
471
+ name: string;
472
+ step_count: number;
473
+ }): RoutineExecutedEvent {
474
+ return stampSidekickEvent<RoutineExecutedEvent>({
475
+ kind: SIDEKICK_EVENT_KINDS.ROUTINE_EXECUTED,
476
+ routine_id: input.routine_id,
477
+ name: input.name,
478
+ step_count: input.step_count,
479
+ plan_only: true,
480
+ });
481
+ }
482
+
483
+ export function buildRoutineStepFailedEvent(input: {
484
+ step_index: number;
485
+ reason: string;
486
+ routine_id?: string;
487
+ routine_name?: string;
488
+ }): RoutineStepFailedEvent {
489
+ return stampSidekickEvent<RoutineStepFailedEvent>({
490
+ kind: SIDEKICK_EVENT_KINDS.ROUTINE_STEP_FAILED,
491
+ step_index: input.step_index,
492
+ reason: input.reason,
493
+ ...(input.routine_id ? { routine_id: input.routine_id } : {}),
494
+ ...(input.routine_name ? { routine_name: input.routine_name } : {}),
495
+ });
496
+ }
497
+
498
+ export function buildStateRehydratedEvent(snapshot: SidekickStores): StateRehydratedEvent {
499
+ return stampSidekickEvent<StateRehydratedEvent>({
500
+ kind: SIDEKICK_EVENT_KINDS.STATE_REHYDRATED,
501
+ snapshot,
502
+ });
503
+ }
504
+
505
+ export function serializeLocalChannelMessage(
506
+ message: ChannelMessageRecord,
507
+ channelName?: string,
508
+ ): Record<string, unknown> {
509
+ return {
510
+ id: message.id,
511
+ channel_id: message.channel_id,
512
+ ...(channelName ? { channel: channelName } : {}),
513
+ sender: message.sender,
514
+ content: message.content,
515
+ created_at: message.created_at,
516
+ };
517
+ }
@@ -0,0 +1,101 @@
1
+ // Copyright (c) 2026 Hellmai Ltd
2
+ // SPDX-License-Identifier: AGPL-3.0-only
3
+
4
+ /**
5
+ * WU-2737 (INIT-060 WU-7b, ADR-013 §ChannelBridge):
6
+ * Local outbox for queue-kind envelopes when the cloud is unreachable.
7
+ *
8
+ * Backing layout:
9
+ * <outboxDir>/<channel-id>/<timestamp>-<envelope-id>.json
10
+ *
11
+ * Each file is a JSON blob `{ channel_id, envelope }` matching the request
12
+ * body shape published in `channel-bridge-cloud-stub.md`. FIFO ordering comes
13
+ * from the sorted filename (lexicographic on timestamp + envelope id).
14
+ *
15
+ * The outbox is intentionally dumb: no retry state, no backoff, no watcher.
16
+ * The adapter drives drains explicitly via `flush()` or reactively on the
17
+ * next successful POST; ADR-013 §4 treats the outbox as a passive spool.
18
+ */
19
+
20
+ import { mkdir, readdir, readFile, rename, rm, writeFile } from 'node:fs/promises';
21
+ import path from 'node:path';
22
+
23
+ import type { ChannelEnvelope } from '../domain/channel.types.js';
24
+
25
+ export interface OutboxRecord {
26
+ channel_id: string;
27
+ envelope: ChannelEnvelope;
28
+ /** Internal filename so the adapter can remove the entry after a successful replay. */
29
+ _filename: string;
30
+ }
31
+
32
+ /**
33
+ * Seconds-precision epoch plus a short random suffix keeps filenames sortable
34
+ * FIFO while avoiding collisions when two envelopes enqueue in the same
35
+ * millisecond.
36
+ */
37
+ function mintFilename(envelopeId: string): string {
38
+ const ts = new Date().toISOString().replace(/[:.]/g, '-');
39
+ const safeId = envelopeId.replace(/[^a-zA-Z0-9_-]/g, '_');
40
+ const suffix = Math.random().toString(36).slice(2, 8);
41
+ return `${ts}-${safeId}-${suffix}.json`;
42
+ }
43
+
44
+ export class CloudOutbox {
45
+ constructor(private readonly outboxDir: string) {}
46
+
47
+ async enqueue(channelId: string, envelope: ChannelEnvelope): Promise<void> {
48
+ const dir = path.resolve(this.outboxDir);
49
+ await mkdir(dir, { recursive: true });
50
+ const filename = mintFilename(envelope.id);
51
+ const tmpPath = path.join(dir, `.tmp-${process.pid}-${filename}`);
52
+ const finalPath = path.join(dir, filename);
53
+ const payload = JSON.stringify({ channel_id: channelId, envelope });
54
+ await writeFile(tmpPath, payload, 'utf8');
55
+ await rename(tmpPath, finalPath);
56
+ }
57
+
58
+ /**
59
+ * Lists outbox records in FIFO order. The returned filename is opaque; pass
60
+ * it back to `remove()` after a successful replay.
61
+ */
62
+ async list(): Promise<OutboxRecord[]> {
63
+ const dir = path.resolve(this.outboxDir);
64
+ let entries: string[];
65
+ try {
66
+ entries = await readdir(dir);
67
+ } catch (error) {
68
+ const err = error as NodeJS.ErrnoException;
69
+ if (err.code === 'ENOENT') {
70
+ return [];
71
+ }
72
+ throw error;
73
+ }
74
+ const records: OutboxRecord[] = [];
75
+ const sortedEntries = entries
76
+ .filter((e) => e.endsWith('.json') && !e.startsWith('.tmp-'))
77
+ .sort();
78
+ for (const name of sortedEntries) {
79
+ const full = path.join(dir, name);
80
+ try {
81
+ const raw = await readFile(full, 'utf8');
82
+ const parsed = JSON.parse(raw) as { channel_id: string; envelope: ChannelEnvelope };
83
+ records.push({ ...parsed, _filename: name });
84
+ } catch {
85
+ // Corrupt or partial file — skip (will not block FIFO drain).
86
+ continue;
87
+ }
88
+ }
89
+ return records;
90
+ }
91
+
92
+ async remove(filename: string): Promise<void> {
93
+ const full = path.join(path.resolve(this.outboxDir), filename);
94
+ await rm(full, { force: true });
95
+ }
96
+
97
+ async isEmpty(): Promise<boolean> {
98
+ const records = await this.list();
99
+ return records.length === 0;
100
+ }
101
+ }