@sanqianx/project-knowledge 4.7.0 → 4.8.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 (192) hide show
  1. package/.agents/plugins/marketplace.json +17 -17
  2. package/.claude-plugin/marketplace.json +1 -1
  3. package/CHANGELOG.md +817 -799
  4. package/README.md +48 -36
  5. package/_modules/knowledge-engine/README.md +88 -0
  6. package/_modules/knowledge-engine/package.json +38 -0
  7. package/_modules/knowledge-engine/src/analysis-contract.js +25 -0
  8. package/_modules/knowledge-engine/src/analysis-worker.js +54 -0
  9. package/_modules/knowledge-engine/src/bin.js +52 -0
  10. package/_modules/knowledge-engine/src/bridge-client.js +24 -0
  11. package/_modules/knowledge-engine/src/coordinator.js +255 -0
  12. package/_modules/knowledge-engine/src/headless-analyzer.js +75 -0
  13. package/_modules/knowledge-engine/src/memories.js +85 -0
  14. package/_modules/knowledge-engine/src/migration.js +88 -0
  15. package/_modules/knowledge-engine/src/retrieval.js +116 -0
  16. package/_modules/knowledge-engine/src/runtime/README.md +7 -0
  17. package/_modules/knowledge-engine/src/runtime/atomic-file.js +204 -0
  18. package/_modules/knowledge-engine/src/runtime/automation-config.js +140 -0
  19. package/_modules/knowledge-engine/src/runtime/commit-conversation-binder.js +249 -0
  20. package/_modules/knowledge-engine/src/runtime/commit-processing-ledger.js +26 -0
  21. package/_modules/knowledge-engine/src/runtime/commit-prompt.js +202 -0
  22. package/_modules/knowledge-engine/src/runtime/commit-reconciler.js +432 -0
  23. package/_modules/knowledge-engine/src/runtime/content-hash.js +4 -0
  24. package/_modules/knowledge-engine/src/runtime/contracts.js +279 -0
  25. package/_modules/knowledge-engine/src/runtime/conversation-exclusions.js +204 -0
  26. package/_modules/knowledge-engine/src/runtime/conversation-store.js +387 -0
  27. package/_modules/knowledge-engine/src/runtime/evidence-bundle.js +228 -0
  28. package/_modules/knowledge-engine/src/runtime/git-runner.js +62 -0
  29. package/_modules/knowledge-engine/src/runtime/knowledge-promotion.js +444 -0
  30. package/_modules/knowledge-engine/src/runtime/knowledge-retrieval-service.js +402 -0
  31. package/_modules/knowledge-engine/src/runtime/layout.js +44 -0
  32. package/_modules/knowledge-engine/src/runtime/markdown-knowledge-indexer.js +230 -0
  33. package/_modules/knowledge-engine/src/runtime/scanner.js +298 -0
  34. package/_modules/knowledge-engine/src/server.js +155 -0
  35. package/_modules/knowledge-engine/src/store.js +239 -0
  36. package/_modules/knowledge-engine/ui/app.css +172 -0
  37. package/_modules/knowledge-engine/ui/app.js +297 -0
  38. package/_modules/knowledge-engine/ui/index.html +95 -0
  39. package/_site/README.md +30 -30
  40. package/_site/_test/ai-profile-resolver-test.js +137 -137
  41. package/_site/_test/automation-queue-test.js +14 -14
  42. package/_site/_test/automation-ui-test.js +40 -40
  43. package/_site/_test/background-task-registry-test.js +43 -43
  44. package/_site/_test/baseline-schema-test.js +91 -91
  45. package/_site/_test/chat-claudecodeui-match-test.js +92 -92
  46. package/_site/_test/claude-executable-discovery-test.js +62 -62
  47. package/_site/_test/claude-workbench-test.js +170 -170
  48. package/_site/_test/codex-conversation-projection-test.js +2 -1
  49. package/_site/_test/commit-conversation-binding-test.js +95 -95
  50. package/_site/_test/commit-evidence-test.js +110 -110
  51. package/_site/_test/conversation-api-test.js +109 -109
  52. package/_site/_test/conversation-store-test.js +136 -136
  53. package/_site/_test/data-dir-migration-test.js +57 -57
  54. package/_site/_test/desktop-browser-compat-test.js +28 -28
  55. package/_site/_test/desktop-hook-runtime-regression-test.js +204 -204
  56. package/_site/_test/explicit-commit-processor-test.js +37 -37
  57. package/_site/_test/fixtures/make-git-repos.js +12 -1
  58. package/_site/_test/folder-picker-output-test.js +19 -19
  59. package/_site/_test/full-integration-e2e-test.js +165 -165
  60. package/_site/_test/git-validation-test.js +2 -2
  61. package/_site/_test/hook-runtime-endpoint-test.js +88 -88
  62. package/_site/_test/hook-status-repair-api-test.js +152 -152
  63. package/_site/_test/hook-trigger-test.js +85 -85
  64. package/_site/_test/import-preflight-api-test.js +234 -233
  65. package/_site/_test/index-writer-concurrency-test.js +135 -135
  66. package/_site/_test/integration-adapters-test.js +171 -171
  67. package/_site/_test/integration-surface-coverage-test.js +164 -164
  68. package/_site/_test/knowledge-language-control-test.js +170 -170
  69. package/_site/_test/knowledge-promotion-recovery-test.js +260 -260
  70. package/_site/_test/knowledge-query-test.js +54 -54
  71. package/_site/_test/knowledge-retrieval-service-test.js +77 -77
  72. package/_site/_test/knowledge-storage-startup-test.js +52 -52
  73. package/_site/_test/knowledge-store-logs-supervision-test.js +89 -89
  74. package/_site/_test/legacy-forward-compat-test.js +257 -257
  75. package/_site/_test/legacy-project-upgrade-e2e-test.js +363 -363
  76. package/_site/_test/logging-api-test.js +89 -89
  77. package/_site/_test/logging-sse-no-gap-test.js +88 -88
  78. package/_site/_test/logging-ui-test.js +106 -104
  79. package/_site/_test/markdown-delta-overlay-test.js +85 -85
  80. package/_site/_test/markdown-maintenance-api-test.js +75 -75
  81. package/_site/_test/mcp-server-test.js +149 -149
  82. package/_site/_test/module-artifact-integrity-test.js +27 -0
  83. package/_site/_test/module-boundary-test.js +30 -0
  84. package/_site/_test/module-bridge-eventbridge-test.js +7 -0
  85. package/_site/_test/module-model-configuration-test.js +43 -0
  86. package/_site/_test/module-process-lifecycle-test.js +24 -0
  87. package/_site/_test/module-stream-proxy-test.js +34 -0
  88. package/_site/_test/non-release-ci-test.js +34 -34
  89. package/_site/_test/offline-boundary-isolation-test.js +32 -32
  90. package/_site/_test/p0-data-migration-characterization-test.js +37 -37
  91. package/_site/_test/p0-e2e-gate-test.js +347 -347
  92. package/_site/_test/packaged-ui-smoke-test.js +11 -9
  93. package/_site/_test/path-consistency-test.js +151 -151
  94. package/_site/_test/pending-sweep-test.js +9 -9
  95. package/_site/_test/post-commit-automation-test.js +87 -87
  96. package/_site/_test/product-diagnostics-ui-test.js +75 -0
  97. package/_site/_test/product-import-ui-test.js +92 -0
  98. package/_site/_test/project-delete-recovery-test.js +64 -64
  99. package/_site/_test/project-goal-editor-test.js +144 -144
  100. package/_site/_test/project-layout-v2-migration-test.js +127 -127
  101. package/_site/_test/project-lifecycle-transaction-test.js +106 -106
  102. package/_site/_test/prompt-settings-test.js +115 -115
  103. package/_site/_test/protected-architecture-gate-test.js +122 -122
  104. package/_site/_test/refactor-characterization-test.js +36 -36
  105. package/_site/_test/release-version-sync-test.js +1 -1
  106. package/_site/_test/requirement-recorder-test.js +173 -173
  107. package/_site/_test/run-all-tests.js +159 -156
  108. package/_site/_test/server-runtime-migration-safety-test.js +27 -27
  109. package/_site/_test/shared-contracts-test.js +58 -58
  110. package/_site/_test/startup-analysis-disabled-test.js +10 -10
  111. package/_site/_test/storage-foundation-test.js +78 -78
  112. package/_site/_test/structured-logger-test.js +101 -101
  113. package/_site/_test/tracking-start-test.js +108 -108
  114. package/_site/_test/v4122-upgrade-data-contract-test.js +56 -56
  115. package/_site/_test/workbench-permission-test.js +117 -117
  116. package/_site/_test/workspace-ui-contract-test.js +28 -43
  117. package/_site/lib/ai-profile-resolver.js +78 -78
  118. package/_site/lib/ai-workspace.js +101 -101
  119. package/_site/lib/automation-config.js +140 -140
  120. package/_site/lib/bridge-adapter.js +1 -0
  121. package/_site/lib/bridge-consumer-service.js +402 -402
  122. package/_site/lib/claude-cli-runner.js +1510 -1510
  123. package/_site/lib/commit-conversation-binder.js +234 -234
  124. package/_site/lib/commit-processing-ledger.js +27 -27
  125. package/_site/lib/commit-prompt.js +202 -202
  126. package/_site/lib/commit-reconciler.js +406 -406
  127. package/_site/lib/contracts.js +284 -279
  128. package/_site/lib/conversation-query-service.js +144 -144
  129. package/_site/lib/conversation-store.js +385 -385
  130. package/_site/lib/data-dir.js +74 -74
  131. package/_site/lib/data-state-classifier.js +40 -40
  132. package/_site/lib/engine-cutover.js +97 -0
  133. package/_site/lib/evidence-bundle.js +228 -228
  134. package/_site/lib/folder-picker-output.js +21 -21
  135. package/_site/lib/git-runner.js +62 -62
  136. package/_site/lib/github-team-store.js +1172 -1172
  137. package/_site/lib/hook-manager.js +203 -202
  138. package/_site/lib/index-service.js +173 -173
  139. package/_site/lib/integration-installer.js +907 -907
  140. package/_site/lib/kb-framework.js +176 -176
  141. package/_site/lib/kb-validator.js +124 -124
  142. package/_site/lib/knowledge-promotion.js +435 -435
  143. package/_site/lib/knowledge-retrieval-service.js +401 -401
  144. package/_site/lib/knowledge-tool-runtime.js +359 -359
  145. package/_site/lib/legacy-data-manifest.js +26 -26
  146. package/_site/lib/llm-client.js +161 -161
  147. package/_site/lib/markdown-knowledge-indexer.js +230 -230
  148. package/_site/lib/migration-service.js +442 -442
  149. package/_site/lib/module-bridge.js +198 -33
  150. package/_site/lib/post-commit-automation.js +87 -87
  151. package/_site/lib/project-lifecycle-service.js +519 -497
  152. package/_site/lib/project-store.js +268 -262
  153. package/_site/lib/requirement-recorder.js +278 -278
  154. package/_site/lib/runtime-endpoint.js +155 -155
  155. package/_site/lib/scanner.js +298 -298
  156. package/_site/lib/server-app.js +1590 -1520
  157. package/_site/lib/settings-store.js +133 -113
  158. package/_site/lib/storage-layout.js +162 -162
  159. package/_site/lib/structured-logger.js +574 -574
  160. package/_site/scripts/folder-picker.ps1 +156 -156
  161. package/_site/scripts/hook-trigger.js +157 -156
  162. package/_site/scripts/install-module-candidates.js +69 -0
  163. package/_site/scripts/pack-module-candidates.js +72 -0
  164. package/_site/scripts/sync-release-version.js +2 -2
  165. package/_site/scripts/vendor-modules.js +47 -0
  166. package/_site/scripts/verify-module-runtime.js +45 -0
  167. package/_site/scripts/verify-product-runtime.js +34 -0
  168. package/bin/project-knowledge-mcp.js +194 -194
  169. package/docs/README.zh-CN.md +34 -25
  170. package/docs/project-registry-schema.md +22 -22
  171. package/docs/testing-strategy.md +33 -33
  172. package/module-runtime-manifest.json +220 -0
  173. package/package.json +13 -9
  174. package/plugins/project-knowledge/.claude-plugin/plugin.json +1 -1
  175. package/plugins/project-knowledge/.codex-plugin/plugin.json +1 -1
  176. package/plugins/project-knowledge/.mcp.json +1 -1
  177. package/plugins/project-knowledge/opencode/project-knowledge.md +3 -3
  178. package/plugins/project-knowledge/skills/project-knowledge/SKILL.md +28 -28
  179. package/templates/project-readme.md +34 -34
  180. package/ui/favicon.svg +38 -38
  181. package/ui/index.html +51 -149
  182. package/ui/product.css +9 -0
  183. package/ui/product.js +386 -0
  184. package/vendor-manifest.json +46 -0
  185. package/_site/_test/import-ui-flow-test.js +0 -171
  186. package/_site/_test/project-control-panel-task14-test.js +0 -63
  187. package/_site/_test/task15-20-ui-flow-test.js +0 -148
  188. package/_site/_test/ui-i18n-toggle-test.js +0 -114
  189. package/_site/_test/ui-smoke-test.js +0 -73
  190. package/ui/app.css +0 -58
  191. package/ui/app.js +0 -607
  192. package/ui/i18n.js +0 -146
@@ -0,0 +1,402 @@
1
+ const fs = require('fs');
2
+ const path = require('path');
3
+ const crypto = require('crypto');
4
+ const { DomainError, validateProjectId } = require('./contracts');
5
+ const { CHUNKER_VERSION, chunkMarkdown, listMarkdownFiles, inferEntryType, parseKnowledgeMetadata } = require('./markdown-knowledge-indexer');
6
+ const { sha256: documentSha256 } = require('./content-hash');
7
+
8
+ const DEFAULT_CONTEXT_BUDGET = 256 * 1024;
9
+ const DEFAULT_CANDIDATE_LIMIT = 50;
10
+
11
+ function hash(value) {
12
+ return `sha256:${crypto.createHash('sha256').update(String(value == null ? '' : value), 'utf8').digest('hex')}`;
13
+ }
14
+
15
+ function tokens(value) {
16
+ const normalized = String(value || '').toLowerCase().replace(/\\/g, '/');
17
+ const out = normalized.match(/[\p{L}\p{N}_-]+/gu) || [];
18
+ for (const segment of normalized.match(/[\p{Script=Han}]+/gu) || []) {
19
+ for (let index = 0; index < segment.length - 1; index += 1) out.push(segment.slice(index, index + 2));
20
+ }
21
+ return [...new Set(out.filter(item => item.length > 1))];
22
+ }
23
+
24
+ function normalizePath(value) {
25
+ return String(value || '').replace(/\\/g, '/').replace(/^\.\//, '').toLowerCase();
26
+ }
27
+
28
+ function titleFromMarkdown(markdown, fallback) {
29
+ const match = /^#\s+(.+)$/m.exec(String(markdown || ''));
30
+ return match ? match[1].trim() : fallback;
31
+ }
32
+
33
+ function occurrences(text, terms, cap = 12) {
34
+ const source = String(text || '').toLowerCase();
35
+ let count = 0;
36
+ for (const term of terms) {
37
+ let offset = 0;
38
+ let matches = 0;
39
+ while (term && matches < cap && (offset = source.indexOf(term, offset)) >= 0) {
40
+ matches += 1;
41
+ count += 1;
42
+ offset += term.length;
43
+ }
44
+ }
45
+ return count;
46
+ }
47
+
48
+ function safeCurrentFile(layout, knowledgePath, entryId) {
49
+ const root = path.resolve(knowledgePath);
50
+ const target = path.resolve(root, ...String(entryId).split('/'));
51
+ if (!layout.isPathInside(root, target, { realpath: true }) || !fs.existsSync(target)
52
+ || !fs.statSync(target).isFile() || fs.lstatSync(target).isSymbolicLink()) return null;
53
+ return target;
54
+ }
55
+
56
+ function manifestHash(manifest) {
57
+ const { manifestHash: ignored, ...payload } = manifest;
58
+ void ignored;
59
+ return hash(JSON.stringify(payload));
60
+ }
61
+
62
+ class KnowledgeRetrievalService {
63
+ constructor(options = {}) {
64
+ this.layout = options.layout;
65
+ this.registryStore = options.registryStore;
66
+ this.projectStore = options.projectStore;
67
+ this.databaseProvider = options.databaseProvider || (() => options.database || null);
68
+ this.embedderProvider = options.embedderProvider || (() => options.embedder || null);
69
+ this.logger = options.logger || null;
70
+ this.candidateLimit = Number(options.candidateLimit || DEFAULT_CANDIDATE_LIMIT);
71
+ }
72
+
73
+ async log(level, event, message, context) {
74
+ try { if (this.logger && typeof this.logger[level] === 'function') await this.logger[level](event, message, context); } catch {
75
+ // Retrieval truth and logging availability are independent.
76
+ }
77
+ }
78
+
79
+ project(input = {}) {
80
+ if (input.project && input.project.projectId) return input.project;
81
+ const projectId = validateProjectId(input.projectId);
82
+ const config = this.projectStore.readConfig(projectId);
83
+ const state = this.projectStore.readState(projectId);
84
+ if (config.enabled === false) throw new DomainError('PROJECT_NOT_FOUND', 'The requested project is disabled.', { status: 404 });
85
+ return {
86
+ projectId,
87
+ projectSlug: config.legacyExtensions && config.legacyExtensions.slug || projectId,
88
+ primarySpaceId: `project:${projectId}`,
89
+ knowledgePath: path.resolve(config.knowledgePath),
90
+ relatedProjectIds: Array.isArray(config.relatedProjectIds) ? config.relatedProjectIds : [],
91
+ index: state.index,
92
+ };
93
+ }
94
+
95
+ scopes(project) {
96
+ const scopes = [{ projectId: project.projectId, spaceId: project.primarySpaceId || `project:${project.projectId}`, knowledgePath: project.knowledgePath, weight: 1, reason: 'primary' }];
97
+ for (const relatedId of project.relatedProjectIds || []) {
98
+ if (!this.registryStore || !this.registryStore.readDisplaySnapshot(relatedId)) continue;
99
+ const config = this.projectStore.readConfig(relatedId);
100
+ if (config.enabled === false) continue;
101
+ scopes.push({ projectId: relatedId, spaceId: `project:${relatedId}`, knowledgePath: path.resolve(config.knowledgePath), weight: 0.88, reason: 'related' });
102
+ }
103
+ return scopes;
104
+ }
105
+
106
+ sourceManifest(projectId) {
107
+ const filePath = this.layout.getRuntimePath('index-sources', `${projectId}.json`);
108
+ try {
109
+ const value = JSON.parse(fs.readFileSync(filePath, 'utf8'));
110
+ return value && value.schema === 'knowledge-index-source-manifest/v1' ? value : null;
111
+ } catch { return null; }
112
+ }
113
+
114
+ scanCurrent(scopes) {
115
+ const candidates = new Map();
116
+ const scopeHealth = [];
117
+ for (const scope of scopes) {
118
+ const state = this.projectStore.readState(scope.projectId);
119
+ const sourceManifest = this.sourceManifest(scope.projectId);
120
+ const manifestEntries = sourceManifest && sourceManifest.entries || {};
121
+ const files = listMarkdownFiles(scope.knowledgePath);
122
+ let overlayEntries = 0;
123
+ for (const filePath of files) {
124
+ const entryId = path.relative(scope.knowledgePath, filePath).replace(/\\/g, '/');
125
+ const markdown = fs.readFileSync(filePath, 'utf8');
126
+ const documentHash = documentSha256(`chunker:${CHUNKER_VERSION}\n${markdown}`);
127
+ const metadata = parseKnowledgeMetadata(markdown);
128
+ const title = titleFromMarkdown(markdown, path.basename(entryId, '.md'));
129
+ const rawChunks = chunkMarkdown(markdown);
130
+ const fromOverlay = !sourceManifest || !manifestEntries[entryId] || manifestEntries[entryId].documentHash !== documentHash;
131
+ if (fromOverlay) overlayEntries += 1;
132
+ for (const chunk of rawChunks) {
133
+ const chunkId = `${entryId}:${chunk.chunkOrder}`;
134
+ candidates.set(`${scope.spaceId}:${chunkId}`, {
135
+ recordId: `${scope.spaceId}:${chunkId}`,
136
+ spaceId: scope.spaceId,
137
+ projectId: scope.projectId,
138
+ scopeReason: scope.reason,
139
+ scopeWeight: scope.weight,
140
+ knowledgePath: scope.knowledgePath,
141
+ entryId,
142
+ entryType: inferEntryType(entryId),
143
+ chunkId,
144
+ chunkOrder: chunk.chunkOrder,
145
+ title,
146
+ headingPath: chunk.headingPath,
147
+ chunkText: chunk.chunkText,
148
+ documentHash,
149
+ contentHash: documentSha256(chunk.chunkText),
150
+ metadata,
151
+ fromOverlay,
152
+ indexScore: 0,
153
+ indexChannels: [],
154
+ });
155
+ }
156
+ }
157
+ const deletedEntries = sourceManifest
158
+ ? Object.keys(manifestEntries).filter(entryId => !safeCurrentFile(this.layout, scope.knowledgePath, entryId)).length
159
+ : 0;
160
+ scopeHealth.push({
161
+ projectId: scope.projectId,
162
+ generation: Number(state.index && state.index.generation || 0),
163
+ dirty: state.index && state.index.dirty === true,
164
+ sourceManifest: sourceManifest ? 'available' : 'missing',
165
+ overlayEntries,
166
+ deletedEntries,
167
+ });
168
+ }
169
+ return { candidates, scopeHealth };
170
+ }
171
+
172
+ async recallIndex(scopes, query, current, health) {
173
+ if (!query || !fs.existsSync(this.layout.getIndexPath())) {
174
+ health.index = 'missing';
175
+ return;
176
+ }
177
+ const database = this.databaseProvider();
178
+ const embedder = this.embedderProvider();
179
+ if (!database || !embedder || typeof embedder.embedQuery !== 'function') {
180
+ health.index = 'unavailable';
181
+ return;
182
+ }
183
+ try {
184
+ const vector = await embedder.embedQuery(query);
185
+ const rows = await database.hybridSearch({
186
+ text: query,
187
+ vector,
188
+ spaceIds: scopes.map(scope => scope.spaceId),
189
+ limit: this.candidateLimit,
190
+ candidates: Math.min(200, this.candidateLimit * 4),
191
+ });
192
+ for (const row of rows) {
193
+ const key = `${row.space_id}:${row.chunk_id}`;
194
+ const candidate = current.get(key);
195
+ if (!candidate) continue;
196
+ candidate.indexScore = Number(row.relevance_score || 0);
197
+ candidate.indexChannels = Array.isArray(row.match_channels) ? row.match_channels : [];
198
+ }
199
+ health.index = 'ok';
200
+ } catch (error) {
201
+ health.index = 'degraded';
202
+ health.reason = 'index-query-failed';
203
+ health.errorCode = error && error.code || 'INDEX_UNAVAILABLE';
204
+ }
205
+ }
206
+
207
+ score(candidate, signals) {
208
+ const selectionSignals = [];
209
+ let score = candidate.indexScore * 1000;
210
+ if (candidate.indexScore) selectionSignals.push(...candidate.indexChannels.map(channel => `index:${channel}`));
211
+ const primaryMatches = occurrences(`${candidate.title}\n${candidate.headingPath.join(' ')}\n${candidate.chunkText}`, signals.primaryTokens);
212
+ if (primaryMatches) { score += Math.min(primaryMatches, 20) * 8; selectionSignals.push(`user-keyword:${primaryMatches}`); }
213
+ const implementationMatches = occurrences(`${candidate.entryId}\n${candidate.title}\n${candidate.chunkText}`, signals.implementationTokens);
214
+ if (implementationMatches) { score += Math.min(implementationMatches, 16) * 3; selectionSignals.push(`implementation:${implementationMatches}`); }
215
+ const assistantMatches = occurrences(candidate.chunkText, signals.assistantTokens);
216
+ if (assistantMatches) { score += Math.min(assistantMatches, 8); selectionSignals.push(`assistant-hint:${assistantMatches}`); }
217
+
218
+ const changedPaths = signals.changedPaths;
219
+ const metadataPaths = candidate.metadata.sourcePaths.map(normalizePath);
220
+ const exactPaths = metadataPaths.filter(value => changedPaths.has(value));
221
+ if (exactPaths.length) { score += 300 + exactPaths.length * 20; selectionSignals.push(`exact-source-path:${exactPaths.join(',')}`); }
222
+ const changedBasenames = signals.changedBasenames;
223
+ const basenameMatches = metadataPaths.filter(value => changedBasenames.has(path.posix.basename(value)));
224
+ if (!exactPaths.length && basenameMatches.length) { score += 70; selectionSignals.push(`source-basename:${basenameMatches.join(',')}`); }
225
+
226
+ const structured = [...candidate.metadata.symbols, ...candidate.metadata.tags, ...candidate.metadata.routes, ...candidate.metadata.affectedModules].map(value => value.toLowerCase());
227
+ const structuredMatches = structured.filter(value => signals.allTerms.has(value)
228
+ || signals.allTerms.has(normalizePath(value))
229
+ || tokens(value).some(term => signals.allTerms.has(term)));
230
+ if (structuredMatches.length) { score += 90 + structuredMatches.length * 10; selectionSignals.push(`structured:${structuredMatches.join(',')}`); }
231
+ score *= candidate.scopeWeight;
232
+ if (candidate.scopeReason === 'primary') selectionSignals.push('scope:primary');
233
+ else selectionSignals.push('scope:related');
234
+ if (candidate.fromOverlay) selectionSignals.push('markdown-delta-overlay');
235
+ return { score, selectionSignals };
236
+ }
237
+
238
+ signalSet(input = {}) {
239
+ const primaryTexts = input.primaryTexts || [];
240
+ const implementationTexts = input.implementationTexts || [];
241
+ const assistantTexts = input.assistantTexts || [];
242
+ const changedPaths = new Set((input.changedPaths || []).map(normalizePath).filter(Boolean));
243
+ const implementationTokens = tokens(implementationTexts.join(' '));
244
+ for (const changedPath of changedPaths) {
245
+ implementationTokens.push(...tokens(changedPath), ...tokens(path.posix.basename(changedPath)));
246
+ }
247
+ const primaryTokens = tokens(primaryTexts.join(' '));
248
+ const assistantTokens = tokens(assistantTexts.join(' '));
249
+ const allTerms = new Set([...primaryTokens, ...implementationTokens]);
250
+ return {
251
+ primaryTokens,
252
+ implementationTokens: [...new Set(implementationTokens)],
253
+ assistantTokens,
254
+ changedPaths,
255
+ changedBasenames: new Set([...changedPaths].map(value => path.posix.basename(value))),
256
+ allTerms,
257
+ indexQuery: [...primaryTexts, ...implementationTexts].join('\n').slice(0, 12_000),
258
+ signalHash: hash(JSON.stringify({ primaryTexts, implementationTexts, changedPaths: [...changedPaths], assistantHintHashes: assistantTexts.map(hash) })),
259
+ };
260
+ }
261
+
262
+ async retrieve(input = {}) {
263
+ const project = this.project(input);
264
+ const scopes = Array.isArray(input.scopes) && input.scopes.length ? input.scopes : this.scopes(project);
265
+ const signals = this.signalSet(input.signals);
266
+ const scanned = this.scanCurrent(scopes);
267
+ const health = { index: 'unknown', scopes: scanned.scopeHealth };
268
+ await this.recallIndex(scopes, signals.indexQuery, scanned.candidates, health);
269
+ const ranked = [];
270
+ for (const candidate of scanned.candidates.values()) {
271
+ const scored = this.score(candidate, signals);
272
+ if (scored.score <= 0) continue;
273
+ ranked.push({ ...candidate, relevanceScore: scored.score, selectionSignals: scored.selectionSignals });
274
+ }
275
+ ranked.sort((left, right) => right.relevanceScore - left.relevanceScore || left.recordId.localeCompare(right.recordId));
276
+ return { project, scopes, signals, health, candidates: ranked.slice(0, this.candidateLimit), totalCurrentChunks: scanned.candidates.size };
277
+ }
278
+
279
+ async search(input = {}) {
280
+ const query = String(input.query || '').trim();
281
+ if (!query) throw new DomainError('INVALID_ARGUMENT', 'query is required.');
282
+ const limit = Math.max(1, Math.min(Number(input.limit || 8), 30));
283
+ const retrieved = await this.retrieve({ ...input, signals: { primaryTexts: [query] } });
284
+ const results = retrieved.candidates.slice(0, limit).map(candidate => ({
285
+ record_id: candidate.recordId,
286
+ space_id: candidate.spaceId,
287
+ entry_id: candidate.entryId,
288
+ chunk_id: candidate.chunkId,
289
+ chunk_order: candidate.chunkOrder,
290
+ title: candidate.title,
291
+ heading_path: candidate.headingPath.join(' > '),
292
+ chunk_text: candidate.chunkText,
293
+ document_hash: candidate.documentHash,
294
+ content_hash: candidate.contentHash,
295
+ relevance_score: candidate.relevanceScore,
296
+ match_channels: candidate.selectionSignals,
297
+ scope_reason: candidate.scopeReason,
298
+ scope_project_id: candidate.projectId,
299
+ from_delta_overlay: candidate.fromOverlay,
300
+ }));
301
+ await this.log('info', 'retrieval.search_completed', 'Knowledge search completed against authoritative Markdown.', {
302
+ projectId: retrieved.project.projectId,
303
+ component: 'knowledge-retrieval',
304
+ context: { queryHash: hash(query), resultCount: results.length, backend: retrieved.health.index, currentChunkCount: retrieved.totalCurrentChunks },
305
+ });
306
+ return {
307
+ ok: true,
308
+ projectId: retrieved.project.projectId,
309
+ projectSlug: retrieved.project.projectSlug || retrieved.project.projectId,
310
+ query,
311
+ backend: retrieved.health.index === 'ok' ? 'hybrid+markdown-truth' : 'markdown-hybrid-fallback',
312
+ source: 'knowledge-retrieval-service',
313
+ health: retrieved.health,
314
+ results,
315
+ };
316
+ }
317
+
318
+ async retrieveForCommit(input = {}) {
319
+ const snapshot = input.conversationSnapshot || { turns: [] };
320
+ const evidence = input.commitEvidence || {};
321
+ const userTexts = (snapshot.turns || []).flatMap(turn => (turn.userEvents || []).map(event => event.content));
322
+ const assistantTexts = (snapshot.turns || []).flatMap(turn => (turn.assistantEvents || []).map(event => event.content));
323
+ const changedPaths = (evidence.files || []).flatMap(file => [file.path, file.oldPath]).filter(Boolean);
324
+ const retrieved = await this.retrieve({
325
+ projectId: input.projectId,
326
+ project: input.project,
327
+ signals: {
328
+ primaryTexts: userTexts,
329
+ assistantTexts,
330
+ implementationTexts: [evidence.subject || '', ...(evidence.files || []).map(file => `${file.status || ''} ${file.path || ''}`)],
331
+ changedPaths,
332
+ },
333
+ });
334
+ const budget = Math.max(8 * 1024, Number(input.contextBudget || DEFAULT_CONTEXT_BUDGET));
335
+ const selected = [];
336
+ let totalBytes = 0;
337
+ for (const candidate of retrieved.candidates) {
338
+ const bytes = Buffer.byteLength(candidate.chunkText, 'utf8');
339
+ if (totalBytes + bytes > budget) continue;
340
+ totalBytes += bytes;
341
+ selected.push(candidate);
342
+ }
343
+ const manifest = {
344
+ schema: 'knowledge-retrieval-manifest/v1',
345
+ projectId: retrieved.project.projectId,
346
+ commitSha: evidence.commitSha || null,
347
+ signalHash: retrieved.signals.signalHash,
348
+ backend: retrieved.health.index,
349
+ health: retrieved.health,
350
+ indexGeneration: Object.fromEntries(retrieved.health.scopes.map(scope => [scope.projectId, scope.generation])),
351
+ candidateCount: retrieved.candidates.length,
352
+ currentChunkCount: retrieved.totalCurrentChunks,
353
+ selected: selected.map(candidate => ({
354
+ projectId: candidate.projectId,
355
+ spaceId: candidate.spaceId,
356
+ entryId: candidate.entryId,
357
+ chunkId: candidate.chunkId,
358
+ chunkOrder: candidate.chunkOrder,
359
+ headingPath: candidate.headingPath,
360
+ documentHash: candidate.documentHash,
361
+ contentHash: candidate.contentHash,
362
+ selectionSignals: candidate.selectionSignals,
363
+ relevanceScore: candidate.relevanceScore,
364
+ fromDeltaOverlay: candidate.fromOverlay,
365
+ bytes: Buffer.byteLength(candidate.chunkText, 'utf8'),
366
+ })),
367
+ totalBytes,
368
+ tokenEstimate: Math.ceil(totalBytes / 4),
369
+ contextBudget: budget,
370
+ manifestHash: '',
371
+ };
372
+ manifest.manifestHash = manifestHash(manifest);
373
+ const entries = selected.map(candidate => ({
374
+ path: candidate.entryId,
375
+ projectId: candidate.projectId,
376
+ spaceId: candidate.spaceId,
377
+ chunkId: candidate.chunkId,
378
+ headingPath: candidate.headingPath,
379
+ hash: candidate.contentHash,
380
+ documentHash: candidate.documentHash,
381
+ content: candidate.chunkText,
382
+ selectionSignals: candidate.selectionSignals,
383
+ }));
384
+ await this.log('info', 'retrieval.commit_context_frozen', 'Commit knowledge context was selected from authoritative Markdown.', {
385
+ projectId: retrieved.project.projectId,
386
+ commitSha: evidence.commitSha,
387
+ component: 'knowledge-retrieval',
388
+ context: { manifestHash: manifest.manifestHash, selectedCount: entries.length, totalBytes, candidateCount: manifest.candidateCount, backend: manifest.backend },
389
+ });
390
+ return { entries, omitted: [], totalBytes, limitBytes: budget, manifest, manifestHash: manifest.manifestHash };
391
+ }
392
+ }
393
+
394
+ module.exports = {
395
+ KnowledgeRetrievalService,
396
+ DEFAULT_CONTEXT_BUDGET,
397
+ DEFAULT_CANDIDATE_LIMIT,
398
+ hash,
399
+ tokens,
400
+ normalizePath,
401
+ manifestHash,
402
+ };
@@ -0,0 +1,44 @@
1
+ 'use strict';
2
+ const fs = require('node:fs');
3
+ const path = require('node:path');
4
+ const { DomainError, validateProjectId } = require('./contracts');
5
+
6
+ function realpathWithMissingLeaf(value) {
7
+ const absolute = path.resolve(value);
8
+ if (fs.existsSync(absolute)) return fs.realpathSync(absolute);
9
+ const parent = path.dirname(absolute);
10
+ return parent === absolute ? absolute : path.join(realpathWithMissingLeaf(parent), path.basename(absolute));
11
+ }
12
+
13
+ class RuntimeLayout {
14
+ constructor(dataDir) { this.dataDir = path.resolve(dataDir); }
15
+ pathsEqual(a, b) {
16
+ const normalize = v => process.platform === 'win32' ? realpathWithMissingLeaf(v).toLowerCase() : realpathWithMissingLeaf(v);
17
+ return normalize(a) === normalize(b);
18
+ }
19
+ isPathInside(root, target, { realpath = false } = {}) {
20
+ const canonical = v => realpath ? realpathWithMissingLeaf(v) : path.resolve(v);
21
+ const relative = path.relative(canonical(root), canonical(target));
22
+ return !relative || (!relative.startsWith(`..${path.sep}`) && relative !== '..' && !path.isAbsolute(relative));
23
+ }
24
+ under(root, parts) {
25
+ const target = path.resolve(root, ...parts.map(String));
26
+ if (!this.isPathInside(root, target, { realpath: true })) throw new DomainError('PATH_OUTSIDE_ROOT', 'Runtime path escapes its root.', { status: 403 });
27
+ return target;
28
+ }
29
+ getRuntimePath(...parts) { return this.under(path.join(this.dataDir, 'runtime'), parts); }
30
+ getRecoveryPath(...parts) { return this.under(path.join(this.dataDir, 'recovery'), parts); }
31
+ getIndexPath() { return this.getRuntimePath('index-sources'); }
32
+ getProjectMetadataDir(id) { return this.getRuntimePath('projects', validateProjectId(id)); }
33
+ getProjectConversationEventsPath(id) { return path.join(this.getProjectMetadataDir(id), 'conversation-events.jsonl'); }
34
+ getProjectCommitBoundariesDir(id) { return path.join(this.getProjectMetadataDir(id), 'commit-boundaries'); }
35
+ getProjectCommitConversationsDir(id) { return path.join(this.getProjectMetadataDir(id), 'commit-conversations'); }
36
+ validateCommitSha(sha) {
37
+ if (!/^[a-f0-9]{7,64}$/i.test(String(sha || ''))) throw new DomainError('INVALID_ARGUMENT', 'An explicit commit SHA is required.');
38
+ return String(sha).toLowerCase();
39
+ }
40
+ getProjectCommitBoundaryPath(id, sha) { return path.join(this.getProjectCommitBoundariesDir(id), `${this.validateCommitSha(sha)}.json`); }
41
+ getProjectCommitConversationPath(id, sha) { return path.join(this.getProjectCommitConversationsDir(id), `${this.validateCommitSha(sha)}.json`); }
42
+ }
43
+
44
+ module.exports = { RuntimeLayout, realpathWithMissingLeaf };
@@ -0,0 +1,230 @@
1
+ const fs = require('fs');
2
+ const path = require('path');
3
+ const { sha256 } = require('./content-hash');
4
+
5
+ const CHUNKER_VERSION = 1;
6
+ const DEFAULT_MAX_CHARS = 1200;
7
+ const DEFAULT_OVERLAP_CHARS = 120;
8
+ const EXCLUDED_DIRS = new Set(['.git', '_ai', '_backup', 'node_modules']);
9
+ const DERIVED_INDEX_FILENAME = '00-index.md';
10
+
11
+ function normalizeRel(value) {
12
+ return String(value || '').replace(/\\/g, '/').replace(/^\.\//, '');
13
+ }
14
+
15
+ function stripFrontmatter(markdown) {
16
+ return String(markdown || '').replace(/^---\s*\r?\n[\s\S]*?\r?\n---\s*\r?\n?/, '');
17
+ }
18
+
19
+ function parseListValue(value) {
20
+ const raw = String(value || '').trim();
21
+ const body = raw.startsWith('[') && raw.endsWith(']') ? raw.slice(1, -1) : raw;
22
+ return body.split(',').map(item => item.trim().replace(/^['"]|['"]$/g, '')).filter(Boolean);
23
+ }
24
+
25
+ function parseKnowledgeMetadata(markdown) {
26
+ const match = /^---\s*\r?\n([\s\S]*?)\r?\n---\s*(?:\r?\n|$)/.exec(String(markdown || ''));
27
+ if (!match) return { tags: [], sourcePaths: [], routes: [], symbols: [], affectedModules: [] };
28
+ const values = {};
29
+ for (const line of match[1].split(/\r?\n/)) {
30
+ const field = /^([A-Za-z][A-Za-z0-9_-]*)\s*:\s*(.*)$/.exec(line);
31
+ if (field) values[field[1].toLowerCase()] = field[2];
32
+ }
33
+ return {
34
+ tags: parseListValue(values.tags),
35
+ sourcePaths: parseListValue(values.sourcepaths || values.source_paths),
36
+ routes: parseListValue(values.routes),
37
+ symbols: parseListValue(values.symbols),
38
+ affectedModules: parseListValue(values.affectedmodules || values.affected_modules),
39
+ };
40
+ }
41
+
42
+ function splitLongText(text, maxChars, overlapChars) {
43
+ const clean = String(text || '').trim();
44
+ if (!clean) return [];
45
+ if (clean.length <= maxChars) return [clean];
46
+ const parts = [];
47
+ let start = 0;
48
+ while (start < clean.length) {
49
+ let end = Math.min(start + maxChars, clean.length);
50
+ if (end < clean.length) {
51
+ const floor = start + Math.floor(maxChars * 0.6);
52
+ const boundary = Math.max(clean.lastIndexOf('\n\n', end), clean.lastIndexOf('。', end), clean.lastIndexOf('. ', end));
53
+ if (boundary >= floor) end = boundary + 1;
54
+ }
55
+ parts.push(clean.slice(start, end).trim());
56
+ if (end >= clean.length) break;
57
+ start = Math.max(start + 1, end - overlapChars);
58
+ }
59
+ return parts.filter(Boolean);
60
+ }
61
+
62
+ function chunkMarkdown(markdown, options = {}) {
63
+ const maxChars = Number(options.maxChars || DEFAULT_MAX_CHARS);
64
+ const overlapChars = Math.min(Number(options.overlapChars || DEFAULT_OVERLAP_CHARS), Math.floor(maxChars / 3));
65
+ const body = stripFrontmatter(markdown).replace(/\r\n/g, '\n');
66
+ const lines = body.split('\n');
67
+ const headings = [];
68
+ const sections = [];
69
+ let buffer = [];
70
+ let sectionHeadings = [];
71
+
72
+ const flush = () => {
73
+ const text = buffer.join('\n').trim();
74
+ if (text) sections.push({ headingPath: [...sectionHeadings], text });
75
+ buffer = [];
76
+ };
77
+
78
+ for (const line of lines) {
79
+ const match = /^(#{1,6})\s+(.+?)\s*$/.exec(line);
80
+ if (match) {
81
+ flush();
82
+ const level = match[1].length;
83
+ headings.length = level - 1;
84
+ headings[level - 1] = match[2].trim();
85
+ sectionHeadings = headings.filter(Boolean);
86
+ buffer.push(line);
87
+ } else {
88
+ buffer.push(line);
89
+ }
90
+ }
91
+ flush();
92
+
93
+ const chunks = [];
94
+ for (const section of sections) {
95
+ for (const text of splitLongText(section.text, maxChars, overlapChars)) {
96
+ chunks.push({
97
+ chunkOrder: chunks.length,
98
+ headingPath: section.headingPath,
99
+ chunkText: text,
100
+ });
101
+ }
102
+ }
103
+ return chunks;
104
+ }
105
+
106
+ function isDerivedIndex(filePath) {
107
+ return path.basename(String(filePath || '')).toLowerCase() === DERIVED_INDEX_FILENAME;
108
+ }
109
+
110
+ function listMarkdownFiles(root, options = {}) {
111
+ const includeDerived = options.includeDerived === true;
112
+ const files = [];
113
+ const walk = (dir) => {
114
+ for (const entry of fs.readdirSync(dir, { withFileTypes: true })) {
115
+ if (entry.name.startsWith('.') || EXCLUDED_DIRS.has(entry.name)) continue;
116
+ const abs = path.join(dir, entry.name);
117
+ if (entry.isDirectory()) walk(abs);
118
+ else if (entry.isFile() && /\.md$/i.test(entry.name) && (includeDerived || !isDerivedIndex(entry.name))) files.push(abs);
119
+ }
120
+ };
121
+ if (fs.existsSync(root)) walk(path.resolve(root));
122
+ return files.sort();
123
+ }
124
+
125
+ function inferEntryType(relativePath) {
126
+ const rel = normalizeRel(relativePath).toLowerCase();
127
+ if (rel === 'goal.md') return 'goal';
128
+ if (rel === 'architecture.md') return 'architecture';
129
+ if (rel.startsWith('modules/')) return 'module';
130
+ if (rel.startsWith('changes/')) return 'change';
131
+ return 'document';
132
+ }
133
+
134
+ function inferTitle(markdown, relativePath) {
135
+ const heading = /^#\s+(.+)$/m.exec(stripFrontmatter(markdown));
136
+ return heading ? heading[1].trim() : path.basename(relativePath, path.extname(relativePath));
137
+ }
138
+
139
+ class MarkdownKnowledgeIndexer {
140
+ constructor(options = {}) {
141
+ if (!options.database) throw new Error('database is required');
142
+ if (!options.embedder) throw new Error('embedder is required');
143
+ this.database = options.database;
144
+ this.embedder = options.embedder;
145
+ this.maxChars = options.maxChars || DEFAULT_MAX_CHARS;
146
+ this.overlapChars = options.overlapChars || DEFAULT_OVERLAP_CHARS;
147
+ }
148
+
149
+ async indexFile(input) {
150
+ const filePath = path.resolve(input.filePath);
151
+ const relativePath = normalizeRel(input.relativePath || path.basename(filePath));
152
+ const markdown = fs.readFileSync(filePath, 'utf8');
153
+ const documentHash = sha256(`chunker:${CHUNKER_VERSION}\n${markdown}`);
154
+ const existing = await this.database.rowsForEntry(input.spaceId, relativePath);
155
+ if (existing.length && existing.every(row => row.document_hash === documentHash)) {
156
+ return { ok: true, action: 'unchanged', entryId: relativePath, chunks: existing.length, documentHash };
157
+ }
158
+ const title = inferTitle(markdown, relativePath);
159
+ const metadata = parseKnowledgeMetadata(markdown);
160
+ const rawChunks = chunkMarkdown(markdown, { maxChars: this.maxChars, overlapChars: this.overlapChars });
161
+ const chunks = [];
162
+ for (const chunk of rawChunks) {
163
+ const embeddingText = [title, chunk.headingPath.join(' > '), chunk.chunkText].filter(Boolean).join('\n');
164
+ chunks.push({
165
+ ...chunk,
166
+ title,
167
+ entryType: inferEntryType(relativePath),
168
+ // Keyword search now indexes chunk_text directly. Keep only compact
169
+ // title/heading metadata in the legacy search_text column so new rows
170
+ // do not duplicate the entire document body.
171
+ searchText: [title, chunk.headingPath.join(' > ')].filter(Boolean).join('\n'),
172
+ vector: await this.embedder.embedPassage(embeddingText),
173
+ tags: [...new Set([...metadata.tags, ...metadata.affectedModules])],
174
+ sourcePaths: metadata.sourcePaths.length ? metadata.sourcePaths : input.sourcePaths || [],
175
+ routes: metadata.routes,
176
+ symbols: metadata.symbols,
177
+ sourceProjectId: input.sourceProjectId || '',
178
+ sourceCommit: input.sourceCommit || '',
179
+ documentHash,
180
+ });
181
+ }
182
+ const result = await this.database.replaceEntry(input.spaceId, relativePath, chunks);
183
+ return { ...result, entryId: relativePath, chunks: chunks.length, documentHash };
184
+ }
185
+
186
+ async indexDirectory(input) {
187
+ const root = path.resolve(input.kbPath);
188
+ const files = listMarkdownFiles(root);
189
+ const present = new Set();
190
+ const results = [];
191
+ for (const filePath of files) {
192
+ const relativePath = normalizeRel(path.relative(root, filePath));
193
+ present.add(relativePath);
194
+ results.push(await this.indexFile({ ...input, filePath, relativePath }));
195
+ }
196
+ const stale = (await this.database.entryIds(input.spaceId)).filter(entryId => !present.has(entryId));
197
+ let deletedChunks = 0;
198
+ for (const entryId of stale) deletedChunks += (await this.database.deleteEntry(input.spaceId, entryId)).deleted;
199
+ const changed = results.filter(item => item.action !== 'unchanged');
200
+ const operations = changed.length + stale.length;
201
+ const rows = changed.reduce((sum, item) => sum + Number(item.upserted || 0) + Number(item.deleted || 0), 0) + deletedChunks;
202
+ const mutationState = this.database.noteMutations({ operations, rows });
203
+ let maintenance = { ok: true, optimized: false, deferred: input.deferMaintenance === true, state: mutationState };
204
+ if (await this.database.count([input.spaceId])) {
205
+ await this.database.ensureSearchIndexes();
206
+ if (input.deferMaintenance !== true) maintenance = await this.database.maybeOptimize();
207
+ }
208
+ return {
209
+ ok: true,
210
+ spaceId: input.spaceId,
211
+ files: files.length,
212
+ indexed: changed.length,
213
+ unchanged: results.filter(item => item.action === 'unchanged').length,
214
+ deletedEntries: stale.length,
215
+ deletedChunks,
216
+ maintenance,
217
+ results,
218
+ };
219
+ }
220
+ }
221
+
222
+ module.exports = {
223
+ MarkdownKnowledgeIndexer,
224
+ CHUNKER_VERSION,
225
+ chunkMarkdown,
226
+ listMarkdownFiles,
227
+ isDerivedIndex,
228
+ inferEntryType,
229
+ parseKnowledgeMetadata,
230
+ };