@hassangameryt/freeflow 0.4.0 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (285) hide show
  1. package/.claude-plugin/marketplace.json +1 -1
  2. package/.claude-plugin/plugin.json +2 -1
  3. package/.codex-plugin/plugin.json +2 -1
  4. package/README.md +150 -155
  5. package/capabilities/cognitive-routing/SKILL.md +229 -0
  6. package/capabilities/context-virtualization/SKILL.md +103 -0
  7. package/capabilities/conversation-history/SKILL.md +53 -0
  8. package/command-surface.json +17 -13
  9. package/hooks/freeflow-runtime-context.mjs +393 -159
  10. package/hooks/hooks.json +26 -1
  11. package/hooks/tests/check-runtime-context-hook.sh +223 -54
  12. package/package.json +25 -16
  13. package/pi-extension/dist/cognitive-routing/commands.js +96 -0
  14. package/pi-extension/dist/cognitive-routing/config.js +236 -0
  15. package/pi-extension/dist/cognitive-routing/controller.js +862 -0
  16. package/pi-extension/dist/cognitive-routing/history.js +439 -0
  17. package/pi-extension/dist/cognitive-routing/host.js +126 -0
  18. package/pi-extension/dist/cognitive-routing/runtime.js +43 -0
  19. package/pi-extension/dist/cognitive-routing/tool.js +211 -0
  20. package/pi-extension/dist/cognitive-routing/types.js +6 -0
  21. package/pi-extension/dist/context-virtualization/commands.js +89 -0
  22. package/pi-extension/dist/context-virtualization/projector.js +42 -0
  23. package/pi-extension/dist/context-virtualization/runtime.js +356 -0
  24. package/pi-extension/dist/context-virtualization/state.js +57 -0
  25. package/pi-extension/dist/context-virtualization/types.js +10 -0
  26. package/pi-extension/dist/conversation-history/passages.js +66 -0
  27. package/pi-extension/dist/conversation-history/ranking.js +105 -0
  28. package/pi-extension/dist/conversation-history/runtime.js +226 -0
  29. package/pi-extension/dist/conversation-history/search.js +56 -0
  30. package/pi-extension/dist/conversation-history/types.js +1 -0
  31. package/pi-extension/dist/freeflow-context/resolver.js +120 -0
  32. package/pi-extension/dist/freeflow-context/runtime.js +80 -0
  33. package/pi-extension/dist/freeflow-context/source-projector.js +95 -0
  34. package/pi-extension/dist/freeflow-context/tool.js +308 -0
  35. package/pi-extension/dist/freeflow-context/types.js +12 -0
  36. package/pi-extension/dist/freeflow-context/visibility.js +28 -0
  37. package/pi-extension/dist/index.js +516 -98
  38. package/pi-extension/dist/runtime/runtime-context.js +318 -271
  39. package/pi-extension/dist/runtime/runtime-identity.js +5 -0
  40. package/pi-extension/dist/settings/settings-tui.js +78 -0
  41. package/pi-extension/dist/settings/settings-ui.js +593 -563
  42. package/pi-extension/dist/ui/text-component.js +57 -0
  43. package/pi-extension/src/cognitive-routing/commands.ts +119 -0
  44. package/pi-extension/src/cognitive-routing/config.ts +307 -0
  45. package/pi-extension/src/cognitive-routing/controller.ts +1118 -0
  46. package/pi-extension/src/cognitive-routing/history.ts +638 -0
  47. package/pi-extension/src/cognitive-routing/host.ts +172 -0
  48. package/pi-extension/src/cognitive-routing/runtime.ts +57 -0
  49. package/pi-extension/src/cognitive-routing/tool.ts +272 -0
  50. package/pi-extension/src/cognitive-routing/types.ts +89 -0
  51. package/pi-extension/src/context-virtualization/commands.ts +111 -0
  52. package/pi-extension/src/context-virtualization/projector.ts +62 -0
  53. package/pi-extension/src/context-virtualization/runtime.ts +406 -0
  54. package/pi-extension/src/context-virtualization/state.ts +79 -0
  55. package/pi-extension/src/context-virtualization/types.ts +92 -0
  56. package/pi-extension/src/conversation-history/passages.ts +81 -0
  57. package/pi-extension/src/conversation-history/ranking.ts +155 -0
  58. package/pi-extension/src/conversation-history/runtime.ts +250 -0
  59. package/pi-extension/src/conversation-history/search.ts +79 -0
  60. package/pi-extension/src/conversation-history/types.ts +31 -0
  61. package/pi-extension/src/freeflow-context/resolver.ts +139 -0
  62. package/pi-extension/src/freeflow-context/runtime.ts +100 -0
  63. package/pi-extension/src/freeflow-context/source-projector.ts +106 -0
  64. package/pi-extension/src/freeflow-context/tool.ts +360 -0
  65. package/pi-extension/src/freeflow-context/types.ts +70 -0
  66. package/pi-extension/src/freeflow-context/visibility.ts +53 -0
  67. package/pi-extension/src/index.ts +553 -101
  68. package/pi-extension/src/runtime/runtime-context.ts +339 -281
  69. package/pi-extension/src/runtime/runtime-identity.ts +8 -0
  70. package/pi-extension/src/settings/settings-tui.ts +93 -0
  71. package/pi-extension/src/settings/settings-ui.ts +700 -613
  72. package/pi-extension/src/ui/text-component.ts +66 -0
  73. package/pi-extension/tests/cognitive-routing/commands.test.js +134 -0
  74. package/pi-extension/tests/cognitive-routing/controller.test.js +1099 -0
  75. package/pi-extension/tests/cognitive-routing/extension-lifecycle.test.js +1071 -0
  76. package/pi-extension/tests/cognitive-routing/history.test.js +274 -0
  77. package/pi-extension/tests/cognitive-routing/host-fixture.js +4 -0
  78. package/pi-extension/tests/cognitive-routing/host-identity.test.js +63 -0
  79. package/pi-extension/tests/cognitive-routing/profile-resolution.test.js +236 -0
  80. package/pi-extension/tests/cognitive-routing/tool.test.js +230 -0
  81. package/pi-extension/tests/context-virtualization/extension.test.js +749 -0
  82. package/pi-extension/tests/context-virtualization/projector.test.js +110 -0
  83. package/pi-extension/tests/context-virtualization/runtime.test.js +216 -0
  84. package/pi-extension/tests/conversation-history/runtime.test.js +98 -0
  85. package/pi-extension/tests/conversation-history/search.test.js +97 -0
  86. package/pi-extension/tests/integration/pi-extension.test.js +928 -2047
  87. package/pi-extension/tests/integration/prompt-architecture.test.js +305 -0
  88. package/runtime/prompts/cognitive-routing.md +9 -0
  89. package/runtime/prompts/context-virtualization.md +3 -0
  90. package/runtime/prompts/conversation-history.md +3 -0
  91. package/runtime/prompts/core.md +13 -0
  92. package/runtime/prompts/interaction-contract.md +7 -0
  93. package/runtime/prompts/skills.md +65 -0
  94. package/skills/action-selection/SKILL.md +91 -0
  95. package/skills/bypass/SKILL.md +3 -2
  96. package/skills/commit-work/SKILL.md +1 -1
  97. package/skills/commit-work/references/staging-decisions.md +1 -1
  98. package/skills/decision-gate/SKILL.md +1 -1
  99. package/skills/design-for-depth/SKILL.md +14 -33
  100. package/skills/design-for-depth/references/design-pressure-signals.md +1 -1
  101. package/skills/design-for-depth/references/interface-design-loop.md +1 -1
  102. package/skills/design-for-depth/references/software-design-philosophy.md +1 -1
  103. package/skills/diagnose-failure/SKILL.md +20 -14
  104. package/skills/diagnose-failure/references/diagnostic-loop-catalog.md +1 -3
  105. package/skills/diagnose-failure/references/{flaky-and-performance.md → flaky-and-performance-diagnosis.md} +1 -1
  106. package/skills/discuss/SKILL.md +34 -22
  107. package/skills/discuss/references/discussion-continuity.md +71 -0
  108. package/skills/evaluate-skill/SKILL.md +5 -5
  109. package/skills/evaluate-skill/references/{definition-schema.md → evaluation-definition-schema.md} +42 -2
  110. package/skills/evaluate-skill/references/execution-and-evidence.md +8 -3
  111. package/skills/evaluate-skill/scripts/lib/definitions.mjs +114 -3
  112. package/skills/evaluate-skill/scripts/lib/grade-interaction.mjs +156 -1
  113. package/skills/evaluate-skill/scripts/lib/grade.mjs +9 -1
  114. package/skills/evaluate-skill/scripts/lib/pi.mjs +147 -32
  115. package/skills/evaluate-skill/scripts/lib/rpc.mjs +4 -4
  116. package/skills/evaluate-skill/scripts/lib/runner.mjs +36 -14
  117. package/skills/evaluate-skill/scripts/lib/sandbox.mjs +92 -0
  118. package/skills/evaluate-skill/scripts/pi-guard.mjs +1 -1
  119. package/skills/evaluate-skill/scripts/pi-observer.mjs +66 -0
  120. package/skills/evaluate-skill/scripts/skill-eval.mjs +6 -5
  121. package/skills/execute-work/SKILL.md +18 -15
  122. package/skills/execute-work/references/code-practices.md +1 -1
  123. package/skills/execute-work/references/execute-work-edges.md +42 -0
  124. package/skills/finish-branch/SKILL.md +2 -2
  125. package/skills/finish-branch/references/integration-options.md +1 -1
  126. package/skills/handoff/SKILL.md +3 -3
  127. package/skills/launch-work/SKILL.md +1 -1
  128. package/skills/launch-work/references/launch-readiness.md +2 -2
  129. package/skills/migration-work/SKILL.md +2 -2
  130. package/skills/migration-work/references/migration-lifecycle.md +1 -1
  131. package/skills/mode-contract/SKILL.md +32 -10
  132. package/skills/release-work/SKILL.md +1 -1
  133. package/skills/release-work/references/release-evidence.md +1 -1
  134. package/skills/review-artifact/SKILL.md +28 -26
  135. package/skills/review-work/SKILL.md +28 -26
  136. package/skills/review-work/references/{reviewer-prompt.md → independent-work-reviewer-contract.md} +1 -1
  137. package/skills/review-work/references/security-risk-lens.md +1 -1
  138. package/skills/setup-freeflow/SKILL.md +6 -10
  139. package/skills/setup-freeflow/references/activation-contract.md +5 -10
  140. package/skills/setup-freeflow/references/host-setup.md +3 -7
  141. package/skills/simplify-code/SKILL.md +1 -1
  142. package/skills/simplify-code/references/simplification-patterns.md +1 -1
  143. package/skills/tdd/SKILL.md +18 -38
  144. package/skills/tdd/references/test-design.md +2 -2
  145. package/skills/track-work/SKILL.md +362 -58
  146. package/skills/track-work/scripts/lib/codec.mjs +570 -0
  147. package/skills/track-work/scripts/lib/commands.mjs +568 -0
  148. package/skills/track-work/scripts/lib/contract.mjs +303 -0
  149. package/skills/track-work/scripts/lib/model.mjs +506 -0
  150. package/skills/track-work/scripts/lib/operations.mjs +965 -0
  151. package/skills/track-work/scripts/lib/record-store.mjs +264 -0
  152. package/skills/track-work/scripts/lib/result.mjs +37 -0
  153. package/skills/track-work/scripts/lib/rewrites.mjs +740 -0
  154. package/skills/track-work/scripts/lib/schema.mjs +277 -0
  155. package/skills/track-work/scripts/lib/source-inventory.mjs +162 -0
  156. package/skills/track-work/scripts/lib/views.mjs +443 -0
  157. package/skills/track-work/scripts/lib/workspace.mjs +134 -0
  158. package/skills/track-work/scripts/working-record.mjs +122 -0
  159. package/skills/verify-work/SKILL.md +14 -2
  160. package/skills/verify-work/references/browser-runtime-evidence.md +1 -1
  161. package/skills/verify-work/references/integration-evidence.md +1 -1
  162. package/skills/verify-work/references/performance-evidence.md +1 -1
  163. package/skills/workflow/SKILL.md +105 -53
  164. package/skills/workflow/references/domain-skill-composition.md +22 -42
  165. package/skills/write-plan/SKILL.md +1 -1
  166. package/skills/write-skill/SKILL.md +3 -2
  167. package/skills/write-skill/references/progressive-disclosure.md +17 -3
  168. package/pi-extension/dist/output-router/host-producer-identification.js +0 -232
  169. package/pi-extension/dist/output-router/native-safety-net.js +0 -216
  170. package/pi-extension/dist/output-router/observed-tool-routing.js +0 -122
  171. package/pi-extension/dist/output-router/renderers.js +0 -1023
  172. package/pi-extension/dist/output-router/router-tools.js +0 -554
  173. package/pi-extension/dist/output-router/schemas.js +0 -383
  174. package/pi-extension/dist/output-router/status.js +0 -744
  175. package/pi-extension/dist/output-router/utils.js +0 -502
  176. package/pi-extension/src/output-router/host-producer-identification.ts +0 -256
  177. package/pi-extension/src/output-router/native-safety-net.ts +0 -248
  178. package/pi-extension/src/output-router/observed-tool-routing.ts +0 -134
  179. package/pi-extension/src/output-router/renderers.ts +0 -1108
  180. package/pi-extension/src/output-router/router-tools.ts +0 -579
  181. package/pi-extension/src/output-router/schemas.ts +0 -387
  182. package/pi-extension/src/output-router/status.ts +0 -791
  183. package/pi-extension/src/output-router/utils.ts +0 -554
  184. package/pi-extension/tests/output-router/observed-producers.test.js +0 -132
  185. package/pi-extension/tests/output-router/search.test.js +0 -722
  186. package/router/dist/benchmarks/benchmark-harness.d.ts +0 -35
  187. package/router/dist/benchmarks/benchmark-harness.js +0 -92
  188. package/router/dist/benchmarks/benchmarks.d.ts +0 -109
  189. package/router/dist/benchmarks/benchmarks.js +0 -979
  190. package/router/dist/benchmarks/codex-qa-benchmarks.d.ts +0 -95
  191. package/router/dist/benchmarks/codex-qa-benchmarks.js +0 -500
  192. package/router/dist/benchmarks/command-benchmarks.d.ts +0 -143
  193. package/router/dist/benchmarks/command-benchmarks.js +0 -698
  194. package/router/dist/benchmarks/context-mode-normalized-benchmarks.d.ts +0 -82
  195. package/router/dist/benchmarks/context-mode-normalized-benchmarks.js +0 -773
  196. package/router/dist/benchmarks/context-mode-real-deep-benchmark.d.ts +0 -132
  197. package/router/dist/benchmarks/context-mode-real-deep-benchmark.js +0 -1380
  198. package/router/dist/benchmarks/context-saving-baseline.d.ts +0 -60
  199. package/router/dist/benchmarks/context-saving-baseline.js +0 -470
  200. package/router/dist/benchmarks/index-benchmarks.d.ts +0 -103
  201. package/router/dist/benchmarks/index-benchmarks.js +0 -862
  202. package/router/dist/benchmarks/storage-policy-benchmarks.d.ts +0 -101
  203. package/router/dist/benchmarks/storage-policy-benchmarks.js +0 -618
  204. package/router/dist/benchmarks/vault-index-benchmarks.d.ts +0 -56
  205. package/router/dist/benchmarks/vault-index-benchmarks.js +0 -322
  206. package/router/dist/config/config.d.ts +0 -103
  207. package/router/dist/config/config.js +0 -632
  208. package/router/dist/config/router-contract.d.ts +0 -10
  209. package/router/dist/config/router-contract.js +0 -54
  210. package/router/dist/config/schema.d.ts +0 -27
  211. package/router/dist/config/schema.js +0 -648
  212. package/router/dist/config/types.d.ts +0 -573
  213. package/router/dist/config/types.js +0 -41
  214. package/router/dist/evidence/bounded-evidence.d.ts +0 -40
  215. package/router/dist/evidence/bounded-evidence.js +0 -323
  216. package/router/dist/evidence/evidence-range-selector.d.ts +0 -24
  217. package/router/dist/evidence/evidence-range-selector.js +0 -232
  218. package/router/dist/evidence/evidence-search.d.ts +0 -27
  219. package/router/dist/evidence/evidence-search.js +0 -490
  220. package/router/dist/evidence/evidence.d.ts +0 -38
  221. package/router/dist/evidence/evidence.js +0 -200
  222. package/router/dist/evidence/failure-contracts.d.ts +0 -37
  223. package/router/dist/evidence/failure-contracts.js +0 -166
  224. package/router/dist/evidence/line-ranges.d.ts +0 -24
  225. package/router/dist/evidence/line-ranges.js +0 -22
  226. package/router/dist/experiments/local-index.d.ts +0 -64
  227. package/router/dist/experiments/local-index.js +0 -581
  228. package/router/dist/index.d.ts +0 -30
  229. package/router/dist/index.js +0 -32
  230. package/router/dist/local/local-traversal.d.ts +0 -18
  231. package/router/dist/local/local-traversal.js +0 -334
  232. package/router/dist/processing/engine.d.ts +0 -132
  233. package/router/dist/processing/engine.js +0 -533
  234. package/router/dist/processing/reducers.d.ts +0 -280
  235. package/router/dist/processing/reducers.js +0 -1673
  236. package/router/dist/processing/renderers.d.ts +0 -31
  237. package/router/dist/processing/renderers.js +0 -195
  238. package/router/dist/processing/scripts.d.ts +0 -91
  239. package/router/dist/processing/scripts.js +0 -386
  240. package/router/dist/repo/repo-traversal.d.ts +0 -18
  241. package/router/dist/repo/repo-traversal.js +0 -245
  242. package/router/dist/routing/observed-reducers.d.ts +0 -41
  243. package/router/dist/routing/observed-reducers.js +0 -661
  244. package/router/dist/routing/observed-routing.d.ts +0 -26
  245. package/router/dist/routing/observed-routing.js +0 -378
  246. package/router/dist/routing/parsers.d.ts +0 -16
  247. package/router/dist/routing/parsers.js +0 -521
  248. package/router/dist/routing/run-filters.d.ts +0 -60
  249. package/router/dist/routing/run-filters.js +0 -238
  250. package/router/dist/routing/run-reducers.d.ts +0 -49
  251. package/router/dist/routing/run-reducers.js +0 -122
  252. package/router/dist/sandbox/adapter-roots.d.ts +0 -46
  253. package/router/dist/sandbox/adapter-roots.js +0 -66
  254. package/router/dist/sandbox/eryx-python-adapter.d.ts +0 -13
  255. package/router/dist/sandbox/eryx-python-adapter.js +0 -868
  256. package/router/dist/sandbox/jq-wasm-adapter.d.ts +0 -9
  257. package/router/dist/sandbox/jq-wasm-adapter.js +0 -429
  258. package/router/dist/sandbox/quickjs-wasi-adapter.d.ts +0 -13
  259. package/router/dist/sandbox/quickjs-wasi-adapter.js +0 -384
  260. package/router/dist/sandbox/script-sandbox.d.ts +0 -134
  261. package/router/dist/sandbox/script-sandbox.js +0 -337
  262. package/router/dist/setup/script-transform-adapters.d.ts +0 -32
  263. package/router/dist/setup/script-transform-adapters.js +0 -278
  264. package/router/dist/tools/batch.d.ts +0 -33
  265. package/router/dist/tools/batch.js +0 -586
  266. package/router/dist/tools/run.d.ts +0 -62
  267. package/router/dist/tools/run.js +0 -1304
  268. package/router/dist/tools/search.d.ts +0 -66
  269. package/router/dist/tools/search.js +0 -1364
  270. package/router/dist/transform/engine.d.ts +0 -168
  271. package/router/dist/transform/engine.js +0 -2072
  272. package/router/dist/vault/vault-index.d.ts +0 -125
  273. package/router/dist/vault/vault-index.js +0 -416
  274. package/router/dist/vault/vault.d.ts +0 -138
  275. package/router/dist/vault/vault.js +0 -630
  276. package/runtime/interaction-contract.md +0 -16
  277. package/skills/discuss/references/checkpoints.md +0 -66
  278. package/skills/execute-work/references/execution-loop.md +0 -77
  279. package/skills/output-router/SKILL.md +0 -206
  280. package/skills/output-router/references/safety-policy.md +0 -40
  281. package/skills/setup-freeflow/references/output-router-setup.md +0 -110
  282. package/skills/track-work/references/working-record-schema.md +0 -378
  283. package/skills/workflow/references/workflow-loop.md +0 -92
  284. /package/skills/handoff/references/{templates.md → handoff-templates.md} +0 -0
  285. /package/skills/review-artifact/references/{reviewer-prompt.md → independent-artifact-reviewer-contract.md} +0 -0
@@ -1,125 +0,0 @@
1
- import type { EvidencePersistence, OutputStream, ProducerDescriptor, VaultRecord } from "../config/types.js";
2
- import type { VaultHandle } from "./vault.js";
3
- export interface VaultIndexRecordMetadata {
4
- sessionId: string;
5
- stream?: OutputStream;
6
- hostToolName?: string;
7
- routingDecisionId?: string;
8
- summary?: string;
9
- tags?: readonly string[];
10
- extra?: Record<string, unknown>;
11
- }
12
- export interface VaultIndexQueryFilters {
13
- sessionId?: string;
14
- outputId?: string;
15
- recordKind?: VaultRecord["kind"];
16
- producerKind?: ProducerDescriptor["kind"];
17
- server?: string;
18
- tool?: string;
19
- hostToolName?: string;
20
- stream?: OutputStream;
21
- recoverability?: EvidencePersistence["recoverability"];
22
- }
23
- export interface VaultIndexQueryCaps {
24
- topK?: number;
25
- maxExcerptBytes?: number;
26
- }
27
- export interface VaultIndexMatch {
28
- entryId: string;
29
- outputId: string;
30
- recordId: string;
31
- sessionId: string;
32
- recordKind: VaultRecord["kind"];
33
- producer: ProducerDescriptor;
34
- stream?: OutputStream;
35
- recoverability: EvidencePersistence["recoverability"];
36
- chunkId: string;
37
- lineStart?: number;
38
- lineEnd?: number;
39
- excerpt: string;
40
- score: number;
41
- metadataOnly: boolean;
42
- }
43
- export interface VaultIndexQueryResult {
44
- query: string;
45
- matches: VaultIndexMatch[];
46
- totalIndexedEntries: number;
47
- }
48
- export interface VaultIndexRecordResult {
49
- indexed: boolean;
50
- outputId: string;
51
- entriesWritten: number;
52
- reason: string;
53
- }
54
- export interface VaultIndexDeleteExpiredOptions {
55
- now?: string;
56
- sessionId?: string;
57
- }
58
- export interface VaultIndexDeleteExpiredResult {
59
- removedEntries: number;
60
- remainingEntries: number;
61
- }
62
- export interface VaultIndexStatus {
63
- engine: string;
64
- root: string;
65
- available: boolean;
66
- degraded: boolean;
67
- stale: boolean;
68
- rebuildRecommended: boolean;
69
- entryCount: number;
70
- textEntryCount: number;
71
- metadataOnlyEntryCount: number;
72
- outputCount: number;
73
- lastIndexedAt?: string;
74
- lastError?: string;
75
- }
76
- export interface VaultIndexEngine {
77
- indexRecord(
78
- record: VaultRecord,
79
- text: string | undefined,
80
- metadata: VaultIndexRecordMetadata,
81
- ): Promise<VaultIndexRecordResult>;
82
- queryVault(
83
- query: string,
84
- filters?: VaultIndexQueryFilters,
85
- caps?: VaultIndexQueryCaps,
86
- ): Promise<VaultIndexQueryResult>;
87
- deleteExpired(options?: VaultIndexDeleteExpiredOptions): Promise<VaultIndexDeleteExpiredResult>;
88
- status(): Promise<VaultIndexStatus>;
89
- }
90
- interface LocalVaultIndexOptions {
91
- root: string;
92
- chunkLineCount?: number;
93
- chunkMaxBytes?: number;
94
- now?: () => string;
95
- }
96
- export declare function createLocalVaultIndex(
97
- vault: VaultHandle,
98
- options?: Partial<LocalVaultIndexOptions>,
99
- ): VaultIndexEngine;
100
- export declare function recordVaultIndexFailure(vault: VaultHandle, error: unknown): Promise<void>;
101
- export declare class LocalVaultIndex implements VaultIndexEngine {
102
- private readonly root;
103
- private readonly chunkLineCount;
104
- private readonly chunkMaxBytes;
105
- private readonly now;
106
- constructor(options: LocalVaultIndexOptions);
107
- indexRecord(
108
- record: VaultRecord,
109
- text: string | undefined,
110
- metadata: VaultIndexRecordMetadata,
111
- ): Promise<VaultIndexRecordResult>;
112
- queryVault(
113
- query: string,
114
- filters?: VaultIndexQueryFilters,
115
- caps?: VaultIndexQueryCaps,
116
- ): Promise<VaultIndexQueryResult>;
117
- deleteExpired(options?: VaultIndexDeleteExpiredOptions): Promise<VaultIndexDeleteExpiredResult>;
118
- recordFailure(error: unknown): Promise<void>;
119
- status(): Promise<VaultIndexStatus>;
120
- private entriesForRecord;
121
- private readState;
122
- private writeState;
123
- private statePath;
124
- }
125
- export {};
@@ -1,416 +0,0 @@
1
- import { createHash } from "node:crypto";
2
- import { mkdir, open, readFile, rename, unlink, writeFile } from "node:fs/promises";
3
- import { dirname, join } from "node:path";
4
- const DEFAULT_CHUNK_LINE_COUNT = 40;
5
- const DEFAULT_CHUNK_MAX_BYTES = 8_192;
6
- const DEFAULT_TOP_K = 5;
7
- const MAX_TOP_K = 50;
8
- const DEFAULT_EXCERPT_BYTES = 2_048;
9
- const LOCAL_INDEX_LOCK_RETRY_MS = 10;
10
- const LOCAL_INDEX_LOCK_TIMEOUT_MS = 5_000;
11
- const localIndexWriteLocks = new Map();
12
- export function createLocalVaultIndex(vault, options = {}) {
13
- return new LocalVaultIndex({ root: join(vault.root, "index", "v1"), ...options });
14
- }
15
- export async function recordVaultIndexFailure(vault, error) {
16
- const index = createLocalVaultIndex(vault);
17
- if (index instanceof LocalVaultIndex) {
18
- await index.recordFailure(error);
19
- }
20
- }
21
- export class LocalVaultIndex {
22
- root;
23
- chunkLineCount;
24
- chunkMaxBytes;
25
- now;
26
- constructor(options) {
27
- this.root = options.root;
28
- this.chunkLineCount = options.chunkLineCount ?? DEFAULT_CHUNK_LINE_COUNT;
29
- this.chunkMaxBytes = options.chunkMaxBytes ?? DEFAULT_CHUNK_MAX_BYTES;
30
- this.now = options.now ?? (() => new Date().toISOString());
31
- }
32
- async indexRecord(record, text, metadata) {
33
- return withLocalIndexWriteLock(this.root, async () => {
34
- const state = await this.readState();
35
- state.entries = state.entries.filter(
36
- (entry) => !(entry.sessionId === metadata.sessionId && entry.outputId === record.outputId),
37
- );
38
- if (record.persistence.recoverability === "none") {
39
- await this.writeState({ ...state, updatedAt: this.now() });
40
- return {
41
- indexed: false,
42
- outputId: record.outputId,
43
- entriesWritten: 0,
44
- reason: "Record persistence is none; no index entry was written.",
45
- };
46
- }
47
- const indexedAt = this.now();
48
- const entries = this.entriesForRecord(record, text, metadata, indexedAt);
49
- state.entries.push(...entries);
50
- delete state.lastError;
51
- await this.writeState({ ...state, updatedAt: indexedAt });
52
- return {
53
- indexed: entries.length > 0,
54
- outputId: record.outputId,
55
- entriesWritten: entries.length,
56
- reason:
57
- record.persistence.recoverability === "metadata_only"
58
- ? "Indexed metadata-only record without raw content."
59
- : "Indexed exact record text chunks and metadata.",
60
- };
61
- });
62
- }
63
- async queryVault(query, filters = {}, caps = {}) {
64
- const state = await this.readState();
65
- const terms = tokenize(query);
66
- const topK = boundedPositiveInteger(caps.topK, DEFAULT_TOP_K, MAX_TOP_K);
67
- const maxExcerptBytes = boundedPositiveInteger(
68
- caps.maxExcerptBytes,
69
- DEFAULT_EXCERPT_BYTES,
70
- DEFAULT_EXCERPT_BYTES * 8,
71
- );
72
- const matches = state.entries
73
- .filter((entry) => entryMatchesFilters(entry, filters))
74
- .map((entry) => ({ entry, score: scoreEntry(entry, terms) }))
75
- .filter((scored) => (terms.length === 0 ? false : scored.score > 0))
76
- .sort(
77
- (a, b) =>
78
- b.score - a.score ||
79
- a.entry.createdAt.localeCompare(b.entry.createdAt) ||
80
- a.entry.entryId.localeCompare(b.entry.entryId),
81
- )
82
- .slice(0, topK)
83
- .map(({ entry, score }) => entryToMatch(entry, score, maxExcerptBytes));
84
- return {
85
- query,
86
- matches,
87
- totalIndexedEntries: state.entries.length,
88
- };
89
- }
90
- async deleteExpired(options = {}) {
91
- return withLocalIndexWriteLock(this.root, async () => {
92
- const state = await this.readState();
93
- const now = Date.parse(options.now ?? this.now());
94
- const before = state.entries.length;
95
- state.entries = state.entries.filter((entry) => {
96
- if (options.sessionId !== undefined && entry.sessionId !== options.sessionId) {
97
- return true;
98
- }
99
- if (!entry.expiresAt) {
100
- return true;
101
- }
102
- const expiresAt = Date.parse(entry.expiresAt);
103
- return !Number.isFinite(expiresAt) || expiresAt > now;
104
- });
105
- await this.writeState({ ...state, updatedAt: this.now() });
106
- return { removedEntries: before - state.entries.length, remainingEntries: state.entries.length };
107
- });
108
- }
109
- async recordFailure(error) {
110
- await withLocalIndexWriteLock(this.root, async () => {
111
- const state = await this.readState().catch(() => ({ version: 1, updatedAt: this.now(), entries: [] }));
112
- await this.writeState({ ...state, updatedAt: this.now(), lastError: errorMessage(error) });
113
- });
114
- }
115
- async status() {
116
- let state;
117
- try {
118
- state = await this.readState();
119
- } catch (error) {
120
- return {
121
- engine: "local-json-sidecar",
122
- root: this.root,
123
- available: false,
124
- degraded: true,
125
- stale: true,
126
- rebuildRecommended: true,
127
- entryCount: 0,
128
- textEntryCount: 0,
129
- metadataOnlyEntryCount: 0,
130
- outputCount: 0,
131
- lastError: errorMessage(error),
132
- };
133
- }
134
- const status = {
135
- engine: "local-json-sidecar",
136
- root: this.root,
137
- available: true,
138
- degraded: state.lastError !== undefined,
139
- stale: state.lastError !== undefined,
140
- rebuildRecommended: state.lastError !== undefined,
141
- entryCount: state.entries.length,
142
- textEntryCount: state.entries.filter((entry) => !entry.metadataOnly).length,
143
- metadataOnlyEntryCount: state.entries.filter((entry) => entry.metadataOnly).length,
144
- outputCount: new Set(state.entries.map((entry) => `${entry.sessionId}:${entry.outputId}`)).size,
145
- };
146
- const lastIndexedAt = state.entries
147
- .map((entry) => entry.indexedAt)
148
- .sort()
149
- .at(-1);
150
- if (lastIndexedAt !== undefined) {
151
- status.lastIndexedAt = lastIndexedAt;
152
- }
153
- if (state.lastError !== undefined) {
154
- status.lastError = state.lastError;
155
- }
156
- return status;
157
- }
158
- entriesForRecord(record, text, metadata, indexedAt) {
159
- const base = {
160
- version: 1,
161
- outputId: record.outputId,
162
- recordId: record.recordId,
163
- sessionId: metadata.sessionId,
164
- recordKind: record.kind,
165
- producer: record.producer,
166
- ...(metadata.stream !== undefined ? { stream: metadata.stream } : {}),
167
- ...(metadata.hostToolName !== undefined ? { hostToolName: metadata.hostToolName } : {}),
168
- createdAt: record.createdAt,
169
- ...(record.expiresAt !== undefined ? { expiresAt: record.expiresAt } : {}),
170
- recoverability: record.persistence.recoverability,
171
- contentHashSha256: record.contentHashSha256,
172
- indexedAt,
173
- };
174
- const metadataText = metadataSearchText(record, metadata);
175
- if (record.persistence.recoverability !== "exact" || text === undefined || text.length === 0) {
176
- return [
177
- {
178
- ...base,
179
- entryId: entryId(record, metadata.sessionId, "metadata", 0),
180
- chunkId: "metadata",
181
- metadataText,
182
- metadataOnly: true,
183
- },
184
- ];
185
- }
186
- return chunkText(text, this.chunkLineCount, this.chunkMaxBytes).map((chunk, index) => ({
187
- ...base,
188
- entryId: entryId(record, metadata.sessionId, chunk.chunkId, index),
189
- chunkId: chunk.chunkId,
190
- lineStart: chunk.lineStart,
191
- lineEnd: chunk.lineEnd,
192
- text: chunk.text,
193
- metadataText,
194
- metadataOnly: false,
195
- }));
196
- }
197
- async readState() {
198
- try {
199
- return JSON.parse(await readFile(this.statePath(), "utf8"));
200
- } catch (error) {
201
- const code = typeof error === "object" && error !== null && "code" in error ? error.code : undefined;
202
- if (code !== "ENOENT") {
203
- throw error;
204
- }
205
- return { version: 1, updatedAt: this.now(), entries: [] };
206
- }
207
- }
208
- async writeState(state) {
209
- const path = this.statePath();
210
- await mkdir(dirname(path), { recursive: true });
211
- const temp = `${path}.${process.pid}.${Date.now()}.tmp`;
212
- await writeFile(temp, `${JSON.stringify(state, null, 2)}\n`, "utf8");
213
- await rename(temp, path);
214
- }
215
- statePath() {
216
- return join(this.root, "entries.json");
217
- }
218
- }
219
- function chunkText(text, maxLines, maxBytes) {
220
- const lines = splitLines(text);
221
- const chunks = [];
222
- let start = 0;
223
- while (start < lines.length) {
224
- let end = start;
225
- let candidate = "";
226
- while (end < lines.length && end - start < maxLines) {
227
- const line = lines[end] ?? "";
228
- const next = candidate.length === 0 ? line : `${candidate}\n${line}`;
229
- if (Buffer.byteLength(next, "utf8") > maxBytes && candidate.length > 0) {
230
- break;
231
- }
232
- candidate = next;
233
- end += 1;
234
- if (Buffer.byteLength(candidate, "utf8") >= maxBytes) {
235
- break;
236
- }
237
- }
238
- if (end === start) {
239
- candidate = truncateUtf8(lines[start] ?? "", maxBytes);
240
- end = start + 1;
241
- }
242
- chunks.push({ chunkId: `chunk-${chunks.length + 1}`, lineStart: start + 1, lineEnd: end, text: candidate });
243
- start = end;
244
- }
245
- return chunks.length > 0 ? chunks : [{ chunkId: "chunk-1", lineStart: 1, lineEnd: 1, text: "" }];
246
- }
247
- async function withLocalIndexWriteLock(root, operation) {
248
- const previous = localIndexWriteLocks.get(root) ?? Promise.resolve();
249
- let releaseCurrent;
250
- const current = new Promise((resolve) => {
251
- releaseCurrent = resolve;
252
- });
253
- const chained = previous.catch(() => undefined).then(() => current);
254
- localIndexWriteLocks.set(root, chained);
255
- await previous.catch(() => undefined);
256
- try {
257
- return await withLocalIndexFileLock(root, operation);
258
- } finally {
259
- releaseCurrent();
260
- if (localIndexWriteLocks.get(root) === chained) {
261
- localIndexWriteLocks.delete(root);
262
- }
263
- }
264
- }
265
- async function withLocalIndexFileLock(root, operation) {
266
- const lockPath = join(root, ".entries.lock");
267
- await mkdir(root, { recursive: true });
268
- const startedAt = Date.now();
269
- let handle;
270
- while (handle === undefined) {
271
- try {
272
- handle = await open(lockPath, "wx");
273
- await handle.writeFile(`${process.pid}\n${new Date().toISOString()}\n`, "utf8");
274
- } catch (error) {
275
- const code = typeof error === "object" && error !== null && "code" in error ? error.code : undefined;
276
- if (code !== "EEXIST") {
277
- throw error;
278
- }
279
- if (Date.now() - startedAt > LOCAL_INDEX_LOCK_TIMEOUT_MS) {
280
- throw new Error(`Timed out waiting for vault index lock at ${root}.`);
281
- }
282
- await sleep(LOCAL_INDEX_LOCK_RETRY_MS);
283
- }
284
- }
285
- try {
286
- return await operation();
287
- } finally {
288
- await handle.close().catch(() => undefined);
289
- await unlink(lockPath).catch(() => undefined);
290
- }
291
- }
292
- function metadataSearchText(record, metadata) {
293
- return stableJson({
294
- outputId: record.outputId,
295
- recordId: record.recordId,
296
- kind: record.kind,
297
- producer: record.producer,
298
- persistence: record.persistence,
299
- recordMetadata: record.kind === "metadata" ? record.metadata : undefined,
300
- repoReference: record.kind === "repo-file" ? { path: record.path, hashSha256: record.hashSha256 } : undefined,
301
- createdAt: record.createdAt,
302
- expiresAt: record.expiresAt,
303
- stream: metadata.stream,
304
- hostToolName: metadata.hostToolName,
305
- routingDecisionId: metadata.routingDecisionId,
306
- summary: metadata.summary,
307
- tags: metadata.tags,
308
- extra: metadata.extra,
309
- });
310
- }
311
- function entryMatchesFilters(entry, filters) {
312
- if (filters.sessionId !== undefined && entry.sessionId !== filters.sessionId) return false;
313
- if (filters.outputId !== undefined && entry.outputId !== filters.outputId) return false;
314
- if (filters.recordKind !== undefined && entry.recordKind !== filters.recordKind) return false;
315
- if (filters.producerKind !== undefined && entry.producer.kind !== filters.producerKind) return false;
316
- if (filters.server !== undefined && entry.producer.server !== filters.server) return false;
317
- if (filters.tool !== undefined && entry.producer.tool !== filters.tool) return false;
318
- if (filters.hostToolName !== undefined && entry.hostToolName !== filters.hostToolName) return false;
319
- if (filters.stream !== undefined && entry.stream !== filters.stream) return false;
320
- if (filters.recoverability !== undefined && entry.recoverability !== filters.recoverability) return false;
321
- return true;
322
- }
323
- function scoreEntry(entry, terms) {
324
- const haystack = `${entry.text ?? ""}\n${entry.metadataText}`.toLowerCase();
325
- let score = 0;
326
- for (const term of terms) {
327
- const count = countOccurrences(haystack, term);
328
- if (count === 0) {
329
- continue;
330
- }
331
- score += entry.metadataOnly ? count : count * 2;
332
- }
333
- return score;
334
- }
335
- function entryToMatch(entry, score, maxExcerptBytes) {
336
- return {
337
- entryId: entry.entryId,
338
- outputId: entry.outputId,
339
- recordId: entry.recordId,
340
- sessionId: entry.sessionId,
341
- recordKind: entry.recordKind,
342
- producer: entry.producer,
343
- ...(entry.stream !== undefined ? { stream: entry.stream } : {}),
344
- recoverability: entry.recoverability,
345
- chunkId: entry.chunkId,
346
- ...(entry.lineStart !== undefined ? { lineStart: entry.lineStart } : {}),
347
- ...(entry.lineEnd !== undefined ? { lineEnd: entry.lineEnd } : {}),
348
- excerpt: truncateUtf8(entry.text ?? entry.metadataText, maxExcerptBytes),
349
- score,
350
- metadataOnly: entry.metadataOnly,
351
- };
352
- }
353
- function tokenize(query) {
354
- return Array.from(new Set(query.toLowerCase().match(/[a-z0-9_./:-]+/g) ?? []));
355
- }
356
- function countOccurrences(text, term) {
357
- let count = 0;
358
- let index = text.indexOf(term);
359
- while (index !== -1) {
360
- count += 1;
361
- index = text.indexOf(term, index + term.length);
362
- }
363
- return count;
364
- }
365
- function boundedPositiveInteger(value, defaultValue, max) {
366
- if (!Number.isFinite(value) || Number(value) <= 0) {
367
- return defaultValue;
368
- }
369
- return Math.min(max, Math.max(1, Math.floor(Number(value))));
370
- }
371
- function entryId(record, sessionId, chunkId, index) {
372
- return `ffvix_${sha256Text(`${sessionId}:${record.outputId}:${chunkId}:${index}`).slice(0, 20)}`;
373
- }
374
- function splitLines(text) {
375
- if (text.length === 0) {
376
- return [];
377
- }
378
- return text.split(/\r?\n/);
379
- }
380
- function stableJson(value) {
381
- return JSON.stringify(value, sortJsonKeys, 2);
382
- }
383
- function sortJsonKeys(_key, value) {
384
- if (!value || typeof value !== "object" || Array.isArray(value)) {
385
- return value;
386
- }
387
- return Object.keys(value)
388
- .sort()
389
- .reduce((sorted, key) => {
390
- sorted[key] = value[key];
391
- return sorted;
392
- }, {});
393
- }
394
- function truncateUtf8(text, maxBytes) {
395
- if (Buffer.byteLength(text, "utf8") <= maxBytes) {
396
- return text;
397
- }
398
- let output = "";
399
- for (const char of text) {
400
- const next = `${output}${char}`;
401
- if (Buffer.byteLength(next, "utf8") > Math.max(0, maxBytes - 1)) {
402
- return `${output}…`;
403
- }
404
- output = next;
405
- }
406
- return output;
407
- }
408
- function sha256Text(text) {
409
- return createHash("sha256").update(text).digest("hex");
410
- }
411
- function sleep(ms) {
412
- return new Promise((resolve) => setTimeout(resolve, ms));
413
- }
414
- function errorMessage(error) {
415
- return error instanceof Error ? error.message : String(error);
416
- }
@@ -1,138 +0,0 @@
1
- import type {
2
- CommandOutputRecord,
3
- EvidenceLineage,
4
- EvidencePersistence,
5
- ExecutionStatus,
6
- MetadataOutputRecord,
7
- OutputFingerprints,
8
- OutputStream,
9
- ProducerDescriptor,
10
- RepoFileReferenceRecord,
11
- RouterVaultConfig,
12
- SessionIndexEntry,
13
- TextOutputRecord,
14
- VaultRecord,
15
- VaultRetentionPolicy,
16
- VaultSessionIndex,
17
- } from "../config/types.js";
18
- export interface VaultHandle {
19
- root: string;
20
- retention: VaultRetentionPolicy;
21
- }
22
- export interface CreateVaultOptions extends Partial<RouterVaultConfig> {}
23
- export interface StoreCommandOutputOptions {
24
- sessionId: string;
25
- command: string | readonly string[];
26
- stdout: string;
27
- stderr: string;
28
- executionStatus: ExecutionStatus;
29
- exitCode: number | null;
30
- combined?: string;
31
- cwd?: string;
32
- durationMs?: number;
33
- decisionIds?: string[];
34
- createdAt?: string;
35
- producer?: ProducerDescriptor;
36
- persistence?: EvidencePersistence;
37
- lineage?: EvidenceLineage;
38
- }
39
- export interface StoreTextOutputOptions {
40
- sessionId: string;
41
- raw: string;
42
- sourceKind: TextOutputRecord["sourceKind"];
43
- decisionIds?: string[];
44
- createdAt?: string;
45
- producer?: ProducerDescriptor;
46
- persistence?: EvidencePersistence;
47
- lineage?: EvidenceLineage;
48
- }
49
- export interface StoreRepoFileReferenceOptions {
50
- sessionId: string;
51
- path: string;
52
- hashSha256?: string;
53
- decisionIds?: string[];
54
- createdAt?: string;
55
- producer?: ProducerDescriptor;
56
- persistence?: EvidencePersistence;
57
- lineage?: EvidenceLineage;
58
- }
59
- export interface StoreMetadataOutputOptions {
60
- sessionId: string;
61
- sourceKind: MetadataOutputRecord["sourceKind"];
62
- rawLineCount: number;
63
- rawByteCount: number;
64
- rawSha256?: string;
65
- metadata?: Record<string, unknown>;
66
- decisionIds?: string[];
67
- createdAt?: string;
68
- producer?: ProducerDescriptor;
69
- persistence?: EvidencePersistence;
70
- lineage?: EvidenceLineage;
71
- }
72
- export interface ReadOutputLinesOptions {
73
- sessionId: string;
74
- outputId: string;
75
- stream: OutputStream;
76
- startLine: number;
77
- endLine: number;
78
- }
79
- export interface CommandOutputFingerprintOptions {
80
- command: string | readonly string[];
81
- stdout: string;
82
- stderr: string;
83
- executionStatus: ExecutionStatus;
84
- exitCode: number | null;
85
- combined?: string;
86
- cwd?: string;
87
- }
88
- export interface TextOutputFingerprintOptions {
89
- raw: string;
90
- }
91
- export interface FindExactDuplicateCommandOutputOptions {
92
- sessionId: string;
93
- fingerprints: OutputFingerprints & {
94
- commandFingerprintSha256: string;
95
- };
96
- excludeOutputId?: string;
97
- }
98
- export interface FindExactDuplicateTextOutputOptions {
99
- sessionId: string;
100
- fingerprints: OutputFingerprints;
101
- excludeOutputId?: string;
102
- }
103
- export declare function createVault(options?: CreateVaultOptions): VaultHandle;
104
- export declare function resolveVaultRoot(root: string): string;
105
- export declare function commandOutputFingerprints(options: CommandOutputFingerprintOptions): OutputFingerprints & {
106
- commandFingerprintSha256: string;
107
- };
108
- export declare function textOutputFingerprints(options: TextOutputFingerprintOptions): OutputFingerprints;
109
- export declare function findExactDuplicateCommandOutput(
110
- vault: VaultHandle,
111
- options: FindExactDuplicateCommandOutputOptions,
112
- ): Promise<SessionIndexEntry | undefined>;
113
- export declare function findExactDuplicateTextOutput(
114
- vault: VaultHandle,
115
- options: FindExactDuplicateTextOutputOptions,
116
- ): Promise<SessionIndexEntry | undefined>;
117
- export declare function storeCommandOutput(
118
- vault: VaultHandle,
119
- options: StoreCommandOutputOptions,
120
- ): Promise<CommandOutputRecord>;
121
- export declare function storeTextOutput(vault: VaultHandle, options: StoreTextOutputOptions): Promise<TextOutputRecord>;
122
- export declare function storeMetadataOutput(
123
- vault: VaultHandle,
124
- options: StoreMetadataOutputOptions,
125
- ): Promise<MetadataOutputRecord>;
126
- export declare function storeRepoFileReference(
127
- vault: VaultHandle,
128
- options: StoreRepoFileReferenceOptions,
129
- ): Promise<RepoFileReferenceRecord>;
130
- export declare function readVaultRecord(vault: VaultHandle, sessionId: string, outputId: string): Promise<VaultRecord>;
131
- export declare function readOutputText(
132
- vault: VaultHandle,
133
- sessionId: string,
134
- outputId: string,
135
- stream: OutputStream,
136
- ): Promise<string>;
137
- export declare function readOutputLines(vault: VaultHandle, options: ReadOutputLinesOptions): Promise<string>;
138
- export declare function readSessionIndex(vault: VaultHandle, sessionId: string): Promise<VaultSessionIndex>;