memorix 1.2.1 → 1.2.2

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 (199) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/README.md +14 -2
  3. package/README.zh-CN.md +14 -2
  4. package/TEAM.md +86 -86
  5. package/dist/cli/index.js +15407 -13779
  6. package/dist/cli/index.js.map +1 -1
  7. package/dist/index.js +1321 -529
  8. package/dist/index.js.map +1 -1
  9. package/dist/maintenance-runner.d.ts +1 -1
  10. package/dist/maintenance-runner.js +8458 -8087
  11. package/dist/maintenance-runner.js.map +1 -1
  12. package/dist/memcode-runtime/CHANGELOG.md +16 -0
  13. package/dist/sdk.d.ts +7 -2
  14. package/dist/sdk.js +1349 -535
  15. package/dist/sdk.js.map +1 -1
  16. package/dist/types.d.ts +49 -1
  17. package/dist/types.js.map +1 -1
  18. package/docs/1.2.2-MEMORY-CONTROL-PLANE.md +434 -0
  19. package/docs/AGENT_OPERATOR_PLAYBOOK.md +4 -0
  20. package/docs/API_REFERENCE.md +24 -4
  21. package/docs/DESIGN_DECISIONS.md +357 -357
  22. package/docs/README.md +1 -1
  23. package/docs/dev-log/progress.txt +91 -11
  24. package/package.json +1 -1
  25. package/plugins/codex/memorix/.codex-plugin/plugin.json +1 -1
  26. package/src/audit/index.ts +156 -156
  27. package/src/cli/command-guide.ts +192 -0
  28. package/src/cli/commands/audit-list.ts +89 -89
  29. package/src/cli/commands/audit.ts +9 -4
  30. package/src/cli/commands/background.ts +659 -659
  31. package/src/cli/commands/cleanup.ts +5 -1
  32. package/src/cli/commands/codegraph.ts +15 -5
  33. package/src/cli/commands/context.ts +3 -2
  34. package/src/cli/commands/doctor.ts +4 -2
  35. package/src/cli/commands/explain.ts +9 -3
  36. package/src/cli/commands/formation.ts +48 -48
  37. package/src/cli/commands/git-hook-install.ts +111 -111
  38. package/src/cli/commands/handoff.ts +75 -61
  39. package/src/cli/commands/hooks-status.ts +63 -63
  40. package/src/cli/commands/identity.ts +116 -0
  41. package/src/cli/commands/ingest-commit.ts +153 -153
  42. package/src/cli/commands/ingest-image.ts +71 -69
  43. package/src/cli/commands/ingest-log.ts +180 -180
  44. package/src/cli/commands/ingest.ts +44 -44
  45. package/src/cli/commands/integrate-shared.ts +15 -15
  46. package/src/cli/commands/lock.ts +93 -92
  47. package/src/cli/commands/memory.ts +58 -21
  48. package/src/cli/commands/message.ts +123 -118
  49. package/src/cli/commands/operator-shared.ts +98 -3
  50. package/src/cli/commands/poll.ts +74 -64
  51. package/src/cli/commands/purge-all-memory.ts +85 -85
  52. package/src/cli/commands/purge-project-memory.ts +83 -83
  53. package/src/cli/commands/reasoning.ts +135 -121
  54. package/src/cli/commands/retention.ts +9 -4
  55. package/src/cli/commands/serve-http.ts +8 -2
  56. package/src/cli/commands/serve-shared.ts +118 -118
  57. package/src/cli/commands/session.ts +29 -3
  58. package/src/cli/commands/skills.ts +124 -119
  59. package/src/cli/commands/status.ts +4 -3
  60. package/src/cli/commands/task.ts +193 -184
  61. package/src/cli/commands/team.ts +14 -10
  62. package/src/cli/commands/transfer.ts +108 -55
  63. package/src/cli/commands/uninstall-project-artifacts.ts +85 -85
  64. package/src/cli/identity.ts +89 -0
  65. package/src/cli/index.ts +96 -19
  66. package/src/cli/invocation.ts +115 -0
  67. package/src/cli/tui/ChatView.tsx +234 -234
  68. package/src/cli/tui/CommandBar.tsx +312 -312
  69. package/src/cli/tui/ContextRail.tsx +118 -118
  70. package/src/cli/tui/HeaderBar.tsx +72 -72
  71. package/src/cli/tui/LogoBanner.tsx +51 -51
  72. package/src/cli/tui/Sidebar.tsx +179 -179
  73. package/src/cli/tui/chat-service.ts +41 -18
  74. package/src/cli/tui/data.ts +23 -44
  75. package/src/cli/tui/index.ts +41 -41
  76. package/src/cli/tui/markdown-render.tsx +371 -371
  77. package/src/cli/tui/operator-context.ts +60 -0
  78. package/src/cli/tui/use-mouse.ts +157 -157
  79. package/src/cli/tui/useNavigation.ts +56 -56
  80. package/src/cli/tui/views/MemoryView.tsx +10 -8
  81. package/src/cli/update-checker.ts +211 -211
  82. package/src/cli/version.ts +7 -7
  83. package/src/cli/workbench.ts +1 -1
  84. package/src/codegraph/auto-context.ts +31 -2
  85. package/src/codegraph/context-pack.ts +1 -0
  86. package/src/codegraph/project-context.ts +2 -0
  87. package/src/compact/engine.ts +26 -10
  88. package/src/compact/index-format.ts +25 -2
  89. package/src/compact/token-budget.ts +74 -74
  90. package/src/dashboard/project-classification.ts +64 -64
  91. package/src/dashboard/server.ts +46 -9
  92. package/src/embedding/fastembed-provider.ts +142 -142
  93. package/src/embedding/transformers-provider.ts +111 -111
  94. package/src/git/extractor.ts +209 -209
  95. package/src/git/hooks-path.ts +85 -85
  96. package/src/hooks/admission.ts +117 -0
  97. package/src/hooks/handler.ts +98 -91
  98. package/src/hooks/pattern-detector.ts +173 -173
  99. package/src/hooks/significance-filter.ts +250 -250
  100. package/src/knowledge/context-assembly.ts +97 -0
  101. package/src/knowledge/workset.ts +179 -10
  102. package/src/llm/memory-manager.ts +328 -328
  103. package/src/llm/provider.ts +885 -885
  104. package/src/llm/quality.ts +248 -248
  105. package/src/memory/admission.ts +57 -0
  106. package/src/memory/attribution-guard.ts +249 -249
  107. package/src/memory/consolidation.ts +13 -2
  108. package/src/memory/disclosure-policy.ts +140 -135
  109. package/src/memory/entity-extractor.ts +197 -197
  110. package/src/memory/export-import.ts +11 -3
  111. package/src/memory/formation/evaluate.ts +217 -217
  112. package/src/memory/formation/extract.ts +361 -361
  113. package/src/memory/formation/index.ts +417 -417
  114. package/src/memory/formation/resolve.ts +344 -344
  115. package/src/memory/formation/types.ts +315 -315
  116. package/src/memory/freshness.ts +122 -122
  117. package/src/memory/graph-context.ts +8 -2
  118. package/src/memory/graph.ts +197 -197
  119. package/src/memory/observations.ts +162 -4
  120. package/src/memory/quality-audit.ts +2 -0
  121. package/src/memory/refs.ts +94 -94
  122. package/src/memory/retention.ts +22 -2
  123. package/src/memory/secret-filter.ts +79 -79
  124. package/src/memory/session.ts +5 -2
  125. package/src/memory/visibility.ts +80 -0
  126. package/src/multimodal/image-loader.ts +143 -143
  127. package/src/orchestrate/adapters/claude-stream.ts +192 -192
  128. package/src/orchestrate/adapters/claude.ts +111 -111
  129. package/src/orchestrate/adapters/codex-stream.ts +134 -134
  130. package/src/orchestrate/adapters/codex.ts +41 -41
  131. package/src/orchestrate/adapters/gemini-stream.ts +166 -166
  132. package/src/orchestrate/adapters/gemini.ts +42 -42
  133. package/src/orchestrate/adapters/index.ts +73 -73
  134. package/src/orchestrate/adapters/opencode-stream.ts +143 -143
  135. package/src/orchestrate/adapters/opencode.ts +47 -47
  136. package/src/orchestrate/adapters/spawn-helper.ts +286 -286
  137. package/src/orchestrate/adapters/types.ts +77 -77
  138. package/src/orchestrate/capability-router.ts +284 -284
  139. package/src/orchestrate/context-compact.ts +188 -188
  140. package/src/orchestrate/cost-tracker.ts +219 -219
  141. package/src/orchestrate/error-recovery.ts +191 -191
  142. package/src/orchestrate/evidence.ts +140 -140
  143. package/src/orchestrate/ledger.ts +110 -110
  144. package/src/orchestrate/memorix-bridge.ts +378 -340
  145. package/src/orchestrate/output-budget.ts +80 -80
  146. package/src/orchestrate/permission.ts +152 -152
  147. package/src/orchestrate/pipeline-trace.ts +131 -131
  148. package/src/orchestrate/prompt-builder.ts +155 -155
  149. package/src/orchestrate/ring-buffer.ts +37 -37
  150. package/src/orchestrate/task-graph.ts +389 -389
  151. package/src/orchestrate/worktree.ts +232 -232
  152. package/src/project/aliases.ts +374 -374
  153. package/src/project/detector.ts +268 -268
  154. package/src/rules/adapters/claude-code.ts +99 -99
  155. package/src/rules/adapters/codex.ts +97 -97
  156. package/src/rules/adapters/copilot.ts +124 -124
  157. package/src/rules/adapters/cursor.ts +114 -114
  158. package/src/rules/adapters/kiro.ts +126 -126
  159. package/src/rules/adapters/trae.ts +56 -56
  160. package/src/rules/adapters/windsurf.ts +83 -83
  161. package/src/rules/syncer.ts +235 -235
  162. package/src/runtime/control-plane-maintenance.ts +1 -0
  163. package/src/runtime/isolated-maintenance.ts +1 -0
  164. package/src/runtime/lifecycle.ts +18 -0
  165. package/src/runtime/maintenance-jobs.ts +1 -0
  166. package/src/runtime/maintenance-runner.ts +2 -0
  167. package/src/runtime/project-maintenance.ts +89 -0
  168. package/src/sdk.ts +334 -304
  169. package/src/search/intent-detector.ts +289 -289
  170. package/src/search/query-expansion.ts +52 -52
  171. package/src/server/formation-timeout.ts +27 -27
  172. package/src/server.ts +260 -81
  173. package/src/skills/mini-skills.ts +386 -386
  174. package/src/store/chat-store.ts +119 -119
  175. package/src/store/graph-store.ts +249 -249
  176. package/src/store/mini-skill-store.ts +349 -349
  177. package/src/store/orama-store.ts +61 -6
  178. package/src/store/persistence-json.ts +212 -212
  179. package/src/store/persistence.ts +291 -291
  180. package/src/store/project-affinity.ts +195 -195
  181. package/src/store/sqlite-db.ts +23 -1
  182. package/src/store/sqlite-store.ts +12 -2
  183. package/src/team/event-bus.ts +76 -76
  184. package/src/team/file-locks.ts +173 -173
  185. package/src/team/handoff.ts +168 -161
  186. package/src/team/messages.ts +203 -203
  187. package/src/team/poll.ts +132 -132
  188. package/src/team/tasks.ts +211 -211
  189. package/src/types.ts +51 -0
  190. package/src/wiki/generator.ts +2 -0
  191. package/src/workspace/mcp-adapters/codex.ts +191 -191
  192. package/src/workspace/mcp-adapters/copilot.ts +105 -105
  193. package/src/workspace/mcp-adapters/cursor.ts +53 -53
  194. package/src/workspace/mcp-adapters/kiro.ts +64 -64
  195. package/src/workspace/mcp-adapters/opencode.ts +123 -123
  196. package/src/workspace/mcp-adapters/trae.ts +134 -134
  197. package/src/workspace/mcp-adapters/windsurf.ts +91 -91
  198. package/src/workspace/sanitizer.ts +60 -60
  199. package/src/workspace/workflow-sync.ts +131 -131
@@ -1,79 +1,79 @@
1
- /**
2
- * Secret Filter
3
- *
4
- * Conservative credential detection and redaction for Memorix memory content.
5
- * Designed for low false-positive risk: only matches explicit credential
6
- * assignments (key=value / key: value), not generic discussion of auth concepts.
7
- *
8
- * sanitizeCredentials() — store-time: called inside storeObservation() before write
9
- * redactCredentials() — retrieval-time: called in format/output paths for legacy safety
10
- * containsCredential() — predicate used for testing and optional logging
11
- *
12
- * Both sanitize and redact share the same pattern logic. They are kept as
13
- * separate named exports so call-site semantics remain clear.
14
- */
15
-
16
- /**
17
- * Replaces the VALUE portion of matched credential patterns with [REDACTED].
18
- * The credential key name is preserved so context is not lost.
19
- *
20
- * Pattern categories:
21
- * 1. key=value / key: value forms — password, token, api_key, secret, etc.
22
- * Requires a real value (6+ non-whitespace chars) to avoid matching
23
- * discussion text like "password must be 8 chars".
24
- * 2. Bearer authorization header tokens (20+ chars)
25
- * 3. Structured token prefixes: GitHub (ghp_/ghs_/gho_), OpenAI (sk-), JWT (eyJ)
26
- */
27
- function applyRedaction(text: string): string {
28
- if (!text) return text;
29
- let out = text;
30
-
31
- // key=value / key: "value" / key='value' — preserve key, redact value
32
- out = out.replace(
33
- /((?:password|passwd|pwd|secret|token|api[_-]?key|auth[_-]?key|access[_-]?key|private[_-]?key|client[_-]?secret)\s*[:=]\s*["']?)([^\s"',;\n]{6,})/gi,
34
- '$1[REDACTED]',
35
- );
36
-
37
- // Bearer <token> — preserve "Bearer ", redact token
38
- out = out.replace(
39
- /(Bearer\s+)([A-Za-z0-9._\-/+]{20,})/g,
40
- '$1[REDACTED]',
41
- );
42
-
43
- // GitHub tokens (ghp_, ghs_, gho_, github_pat_)
44
- out = out.replace(/\b(?:ghp|ghs|gho|github_pat)_[A-Za-z0-9]{36,}\b/g, '[REDACTED]');
45
-
46
- // OpenAI / similar keys (sk-...)
47
- out = out.replace(/\bsk-[A-Za-z0-9T-]{20,}\b/g, '[REDACTED]');
48
-
49
- // JWT tokens (base64url header eyJ...)
50
- out = out.replace(/\beyJ[A-Za-z0-9._-]{40,}\b/g, '[REDACTED]');
51
-
52
- return out;
53
- }
54
-
55
- /**
56
- * Store-time sanitization: strips credential values before any durable write.
57
- * Called inside storeObservation() / upsertObservation() so that every write
58
- * path (hooks, git-ingest, CLI, reasoning, compact-on-write) is covered.
59
- */
60
- export function sanitizeCredentials(text: string): string {
61
- return applyRedaction(text);
62
- }
63
-
64
- /**
65
- * Retrieval-time redaction: masks credential values in display output.
66
- * Applied in all output formatters (detail, index table, timeline, session context)
67
- * as a safety net for legacy observations stored before sanitization was in place.
68
- */
69
- export function redactCredentials(text: string): string {
70
- return applyRedaction(text);
71
- }
72
-
73
- /**
74
- * Returns true if the text contains an obvious credential pattern.
75
- * Used for testing and optional diagnostic logging.
76
- */
77
- export function containsCredential(text: string): boolean {
78
- return applyRedaction(text) !== text;
79
- }
1
+ /**
2
+ * Secret Filter
3
+ *
4
+ * Conservative credential detection and redaction for Memorix memory content.
5
+ * Designed for low false-positive risk: only matches explicit credential
6
+ * assignments (key=value / key: value), not generic discussion of auth concepts.
7
+ *
8
+ * sanitizeCredentials() — store-time: called inside storeObservation() before write
9
+ * redactCredentials() — retrieval-time: called in format/output paths for legacy safety
10
+ * containsCredential() — predicate used for testing and optional logging
11
+ *
12
+ * Both sanitize and redact share the same pattern logic. They are kept as
13
+ * separate named exports so call-site semantics remain clear.
14
+ */
15
+
16
+ /**
17
+ * Replaces the VALUE portion of matched credential patterns with [REDACTED].
18
+ * The credential key name is preserved so context is not lost.
19
+ *
20
+ * Pattern categories:
21
+ * 1. key=value / key: value forms — password, token, api_key, secret, etc.
22
+ * Requires a real value (6+ non-whitespace chars) to avoid matching
23
+ * discussion text like "password must be 8 chars".
24
+ * 2. Bearer authorization header tokens (20+ chars)
25
+ * 3. Structured token prefixes: GitHub (ghp_/ghs_/gho_), OpenAI (sk-), JWT (eyJ)
26
+ */
27
+ function applyRedaction(text: string): string {
28
+ if (!text) return text;
29
+ let out = text;
30
+
31
+ // key=value / key: "value" / key='value' — preserve key, redact value
32
+ out = out.replace(
33
+ /((?:password|passwd|pwd|secret|token|api[_-]?key|auth[_-]?key|access[_-]?key|private[_-]?key|client[_-]?secret)\s*[:=]\s*["']?)([^\s"',;\n]{6,})/gi,
34
+ '$1[REDACTED]',
35
+ );
36
+
37
+ // Bearer <token> — preserve "Bearer ", redact token
38
+ out = out.replace(
39
+ /(Bearer\s+)([A-Za-z0-9._\-/+]{20,})/g,
40
+ '$1[REDACTED]',
41
+ );
42
+
43
+ // GitHub tokens (ghp_, ghs_, gho_, github_pat_)
44
+ out = out.replace(/\b(?:ghp|ghs|gho|github_pat)_[A-Za-z0-9]{36,}\b/g, '[REDACTED]');
45
+
46
+ // OpenAI / similar keys (sk-...)
47
+ out = out.replace(/\bsk-[A-Za-z0-9T-]{20,}\b/g, '[REDACTED]');
48
+
49
+ // JWT tokens (base64url header eyJ...)
50
+ out = out.replace(/\beyJ[A-Za-z0-9._-]{40,}\b/g, '[REDACTED]');
51
+
52
+ return out;
53
+ }
54
+
55
+ /**
56
+ * Store-time sanitization: strips credential values before any durable write.
57
+ * Called inside storeObservation() / upsertObservation() so that every write
58
+ * path (hooks, git-ingest, CLI, reasoning, compact-on-write) is covered.
59
+ */
60
+ export function sanitizeCredentials(text: string): string {
61
+ return applyRedaction(text);
62
+ }
63
+
64
+ /**
65
+ * Retrieval-time redaction: masks credential values in display output.
66
+ * Applied in all output formatters (detail, index table, timeline, session context)
67
+ * as a safety net for legacy observations stored before sanitization was in place.
68
+ */
69
+ export function redactCredentials(text: string): string {
70
+ return applyRedaction(text);
71
+ }
72
+
73
+ /**
74
+ * Returns true if the text contains an obvious credential pattern.
75
+ * Used for testing and optional diagnostic logging.
76
+ */
77
+ export function containsCredential(text: string): boolean {
78
+ return applyRedaction(text) !== text;
79
+ }
@@ -12,6 +12,7 @@
12
12
  */
13
13
 
14
14
  import type { Observation, Session } from '../types.js';
15
+ import { isEligibleForAutomaticDelivery } from './admission.js';
15
16
  import { classifyLayer } from './disclosure-policy.js';
16
17
  import { resolveAliases } from '../project/aliases.js';
17
18
  import { getObservationStore } from '../store/obs-store.js';
@@ -369,13 +370,15 @@ export async function getSessionContext(
369
370
 
370
371
  // L1: recent hook activity signals (titles only, most recent first)
371
372
  const l1HookObs = projectObs
372
- .filter((obs) => classifyLayer(obs) === 'L1')
373
+ .filter((obs) => isEligibleForAutomaticDelivery(obs) && classifyLayer(obs) === 'L1')
373
374
  .sort((a, b) => new Date(b.createdAt).getTime() - new Date(a.createdAt).getTime())
374
375
  .slice(0, 3);
375
376
 
376
377
  // L3: git-ingest evidence count (pointer only, not injected)
377
378
  const l3GitCount = projectObs.filter((obs) => classifyLayer(obs) === 'L3').length;
378
- const totalHookCount = projectObs.filter((obs) => classifyLayer(obs) === 'L1').length;
379
+ const totalHookCount = projectObs
380
+ .filter((obs) => isEligibleForAutomaticDelivery(obs) && classifyLayer(obs) === 'L1')
381
+ .length;
379
382
 
380
383
  // Active entities: unique entity names from top-scored L2 memories.
381
384
  // Surfaced in L1 Routing as next-hop search guidance — not working context.
@@ -0,0 +1,80 @@
1
+ import type { ObservationReader, ObservationVisibility } from '../types.js';
2
+
3
+ /** Minimal common shape shared by persisted observations and Orama documents. */
4
+ export interface VisibilityRecord {
5
+ projectId: string;
6
+ visibility?: ObservationVisibility | string;
7
+ createdByAgentId?: string;
8
+ sharedWithAgentIds?: string[] | string;
9
+ }
10
+
11
+ /**
12
+ * Pre-control-plane records were intentionally project-shared. Preserve that
13
+ * behavior so an upgrade does not make a user's historical memory disappear.
14
+ */
15
+ export function resolveObservationVisibility(record: Pick<VisibilityRecord, 'visibility'>): ObservationVisibility {
16
+ switch (record.visibility) {
17
+ case 'personal':
18
+ case 'team':
19
+ case 'project':
20
+ return record.visibility;
21
+ default:
22
+ return 'project';
23
+ }
24
+ }
25
+
26
+ function sharedAgentIds(record: VisibilityRecord): string[] {
27
+ if (Array.isArray(record.sharedWithAgentIds)) return record.sharedWithAgentIds;
28
+ if (typeof record.sharedWithAgentIds !== 'string' || !record.sharedWithAgentIds) return [];
29
+ try {
30
+ const parsed = JSON.parse(record.sharedWithAgentIds);
31
+ return Array.isArray(parsed) ? parsed.filter((id): id is string => typeof id === 'string') : [];
32
+ } catch {
33
+ return [];
34
+ }
35
+ }
36
+
37
+ /**
38
+ * The policy is intentionally fail-closed for personal and team scopes. A
39
+ * missing actor never turns a private record into a project-wide result.
40
+ * `undefined` is reserved for trusted internal maintenance, not MCP delivery.
41
+ */
42
+ export function canReadObservation(record: VisibilityRecord, reader?: ObservationReader): boolean {
43
+ if (!reader) return true;
44
+
45
+ const sameProject = reader.projectId === record.projectId;
46
+ const visibility = resolveObservationVisibility(record);
47
+ // An explicit global search may inspect project-visible facts across projects,
48
+ // but it never gains a team or personal scope without a bound project.
49
+ if (visibility === 'project') return !reader.projectId || sameProject;
50
+ if (!sameProject || !reader.agentId) return false;
51
+
52
+ if (visibility === 'team') return reader.isTeamMember === true;
53
+ return record.createdByAgentId === reader.agentId || sharedAgentIds(record).includes(reader.agentId);
54
+ }
55
+
56
+ /**
57
+ * Reading a targeted handoff does not grant the recipient permission to alter
58
+ * it. Project evidence is jointly maintainable; personal records stay owned by
59
+ * their creator; team records require an active team member.
60
+ */
61
+ export function canManageObservation(record: VisibilityRecord, reader?: ObservationReader): boolean {
62
+ if (!reader) return true;
63
+ if (!reader.projectId || reader.projectId !== record.projectId) return false;
64
+
65
+ switch (resolveObservationVisibility(record)) {
66
+ case 'project':
67
+ return true;
68
+ case 'team':
69
+ return reader.isTeamMember === true;
70
+ case 'personal':
71
+ return Boolean(reader.agentId && record.createdByAgentId === reader.agentId);
72
+ }
73
+ }
74
+
75
+ export function filterReadableObservations<T extends VisibilityRecord>(
76
+ observations: readonly T[],
77
+ reader?: ObservationReader,
78
+ ): T[] {
79
+ return reader ? observations.filter((observation) => canReadObservation(observation, reader)) : [...observations];
80
+ }
@@ -1,143 +1,143 @@
1
- /**
2
- * Image Loader — Vision LLM Integration
3
- *
4
- * Analyzes images via OpenAI Vision API (or compatible),
5
- * extracting descriptions, tags, and entities.
6
- */
7
-
8
- import { getLLMApiKey, getLLMBaseUrl, getLLMModel } from '../config.js';
9
- import { isLLMEnabled, getLLMConfig } from '../llm/provider.js';
10
-
11
- // Providers that use the OpenAI-compatible /chat/completions Vision endpoint
12
- const OPENAI_COMPATIBLE_PROVIDERS = new Set(['openai', 'openrouter', 'custom']);
13
-
14
- // ── Types ────────────────────────────────────────────────────────────
15
-
16
- export interface ImageInput {
17
- /** Base64-encoded image data */
18
- base64: string;
19
- /** Image MIME type (default: image/png) */
20
- mimeType?: string;
21
- /** Original filename */
22
- filename?: string;
23
- /** Custom analysis prompt */
24
- prompt?: string;
25
- }
26
-
27
- export interface ImageAnalysisResult {
28
- /** Natural language description of the image */
29
- description: string;
30
- /** Relevant tags/categories */
31
- tags: string[];
32
- /** Key entities/concepts depicted */
33
- entities: string[];
34
- }
35
-
36
- // ── Internal Vision LLM Call ─────────────────────────────────────────
37
-
38
- async function callVisionLLM(
39
- systemPrompt: string,
40
- imageBase64: string,
41
- mimeType: string,
42
- ): Promise<string> {
43
- const apiKey = getLLMApiKey();
44
- if (!apiKey) {
45
- throw new Error('No LLM API key configured for image analysis.');
46
- }
47
-
48
- let baseUrl = getLLMBaseUrl('https://api.openai.com/v1').replace(/\/+$/, '');
49
- if (!baseUrl.endsWith('/v1')) baseUrl += '/v1';
50
- const model = getLLMModel('gpt-4o');
51
-
52
- const response = await fetch(`${baseUrl}/chat/completions`, {
53
- method: 'POST',
54
- headers: {
55
- 'Content-Type': 'application/json',
56
- 'Authorization': `Bearer ${apiKey}`,
57
- },
58
- body: JSON.stringify({
59
- model,
60
- messages: [{
61
- role: 'user',
62
- content: [
63
- { type: 'text', text: systemPrompt },
64
- {
65
- type: 'image_url',
66
- image_url: { url: `data:${mimeType};base64,${imageBase64}` },
67
- },
68
- ],
69
- }],
70
- temperature: 0.1,
71
- max_tokens: 1024,
72
- }),
73
- signal: AbortSignal.timeout(30_000),
74
- });
75
-
76
- if (!response.ok) {
77
- const errorText = await response.text().catch(() => 'unknown error');
78
- throw new Error(`Vision LLM error (${response.status}): ${errorText}`);
79
- }
80
-
81
- const data = await response.json() as {
82
- choices: Array<{ message: { content: string } }>;
83
- };
84
-
85
- return data.choices[0]?.message?.content ?? '';
86
- }
87
-
88
- // ── Public API ───────────────────────────────────────────────────────
89
-
90
- const DEFAULT_PROMPT =
91
- 'Analyze this image. Return ONLY a JSON object with this exact format: ' +
92
- '{"description": "detailed description", "tags": ["tag1", "tag2"], "entities": ["entity1", "entity2"]}';
93
-
94
- /**
95
- * Analyze an image using Vision LLM.
96
- *
97
- * @throws Error if LLM not configured.
98
- */
99
- export async function analyzeImage(input: ImageInput): Promise<ImageAnalysisResult> {
100
- if (!isLLMEnabled()) {
101
- throw new Error(
102
- 'LLM not configured for image analysis. ' +
103
- 'Set MEMORIX_LLM_API_KEY or OPENAI_API_KEY.',
104
- );
105
- }
106
-
107
- const config = getLLMConfig()!;
108
- if (!OPENAI_COMPATIBLE_PROVIDERS.has(config.provider)) {
109
- throw new Error(
110
- `Image analysis requires an OpenAI-compatible provider (openai, openrouter, or custom). ` +
111
- `Current provider "${config.provider}" uses a different API shape. ` +
112
- `Set MEMORIX_LLM_PROVIDER=openai or configure an OpenAI-compatible base URL.`,
113
- );
114
- }
115
-
116
- const mimeType = input.mimeType ?? 'image/png';
117
- const prompt = input.prompt ?? DEFAULT_PROMPT;
118
-
119
- const response = await callVisionLLM(prompt, input.base64, mimeType);
120
-
121
- // Try to parse structured JSON response
122
- try {
123
- // Extract JSON from response (may be wrapped in markdown code block)
124
- const jsonMatch = response.match(/\{[\s\S]*\}/);
125
- if (jsonMatch) {
126
- const parsed = JSON.parse(jsonMatch[0]);
127
- return {
128
- description: parsed.description ?? response,
129
- tags: Array.isArray(parsed.tags) ? parsed.tags : [],
130
- entities: Array.isArray(parsed.entities) ? parsed.entities : [],
131
- };
132
- }
133
- } catch {
134
- // JSON parse failed — fall through to text extraction
135
- }
136
-
137
- // Fallback: treat entire response as description
138
- return {
139
- description: response,
140
- tags: [],
141
- entities: [],
142
- };
143
- }
1
+ /**
2
+ * Image Loader — Vision LLM Integration
3
+ *
4
+ * Analyzes images via OpenAI Vision API (or compatible),
5
+ * extracting descriptions, tags, and entities.
6
+ */
7
+
8
+ import { getLLMApiKey, getLLMBaseUrl, getLLMModel } from '../config.js';
9
+ import { isLLMEnabled, getLLMConfig } from '../llm/provider.js';
10
+
11
+ // Providers that use the OpenAI-compatible /chat/completions Vision endpoint
12
+ const OPENAI_COMPATIBLE_PROVIDERS = new Set(['openai', 'openrouter', 'custom']);
13
+
14
+ // ── Types ────────────────────────────────────────────────────────────
15
+
16
+ export interface ImageInput {
17
+ /** Base64-encoded image data */
18
+ base64: string;
19
+ /** Image MIME type (default: image/png) */
20
+ mimeType?: string;
21
+ /** Original filename */
22
+ filename?: string;
23
+ /** Custom analysis prompt */
24
+ prompt?: string;
25
+ }
26
+
27
+ export interface ImageAnalysisResult {
28
+ /** Natural language description of the image */
29
+ description: string;
30
+ /** Relevant tags/categories */
31
+ tags: string[];
32
+ /** Key entities/concepts depicted */
33
+ entities: string[];
34
+ }
35
+
36
+ // ── Internal Vision LLM Call ─────────────────────────────────────────
37
+
38
+ async function callVisionLLM(
39
+ systemPrompt: string,
40
+ imageBase64: string,
41
+ mimeType: string,
42
+ ): Promise<string> {
43
+ const apiKey = getLLMApiKey();
44
+ if (!apiKey) {
45
+ throw new Error('No LLM API key configured for image analysis.');
46
+ }
47
+
48
+ let baseUrl = getLLMBaseUrl('https://api.openai.com/v1').replace(/\/+$/, '');
49
+ if (!baseUrl.endsWith('/v1')) baseUrl += '/v1';
50
+ const model = getLLMModel('gpt-4o');
51
+
52
+ const response = await fetch(`${baseUrl}/chat/completions`, {
53
+ method: 'POST',
54
+ headers: {
55
+ 'Content-Type': 'application/json',
56
+ 'Authorization': `Bearer ${apiKey}`,
57
+ },
58
+ body: JSON.stringify({
59
+ model,
60
+ messages: [{
61
+ role: 'user',
62
+ content: [
63
+ { type: 'text', text: systemPrompt },
64
+ {
65
+ type: 'image_url',
66
+ image_url: { url: `data:${mimeType};base64,${imageBase64}` },
67
+ },
68
+ ],
69
+ }],
70
+ temperature: 0.1,
71
+ max_tokens: 1024,
72
+ }),
73
+ signal: AbortSignal.timeout(30_000),
74
+ });
75
+
76
+ if (!response.ok) {
77
+ const errorText = await response.text().catch(() => 'unknown error');
78
+ throw new Error(`Vision LLM error (${response.status}): ${errorText}`);
79
+ }
80
+
81
+ const data = await response.json() as {
82
+ choices: Array<{ message: { content: string } }>;
83
+ };
84
+
85
+ return data.choices[0]?.message?.content ?? '';
86
+ }
87
+
88
+ // ── Public API ───────────────────────────────────────────────────────
89
+
90
+ const DEFAULT_PROMPT =
91
+ 'Analyze this image. Return ONLY a JSON object with this exact format: ' +
92
+ '{"description": "detailed description", "tags": ["tag1", "tag2"], "entities": ["entity1", "entity2"]}';
93
+
94
+ /**
95
+ * Analyze an image using Vision LLM.
96
+ *
97
+ * @throws Error if LLM not configured.
98
+ */
99
+ export async function analyzeImage(input: ImageInput): Promise<ImageAnalysisResult> {
100
+ if (!isLLMEnabled()) {
101
+ throw new Error(
102
+ 'LLM not configured for image analysis. ' +
103
+ 'Set MEMORIX_LLM_API_KEY or OPENAI_API_KEY.',
104
+ );
105
+ }
106
+
107
+ const config = getLLMConfig()!;
108
+ if (!OPENAI_COMPATIBLE_PROVIDERS.has(config.provider)) {
109
+ throw new Error(
110
+ `Image analysis requires an OpenAI-compatible provider (openai, openrouter, or custom). ` +
111
+ `Current provider "${config.provider}" uses a different API shape. ` +
112
+ `Set MEMORIX_LLM_PROVIDER=openai or configure an OpenAI-compatible base URL.`,
113
+ );
114
+ }
115
+
116
+ const mimeType = input.mimeType ?? 'image/png';
117
+ const prompt = input.prompt ?? DEFAULT_PROMPT;
118
+
119
+ const response = await callVisionLLM(prompt, input.base64, mimeType);
120
+
121
+ // Try to parse structured JSON response
122
+ try {
123
+ // Extract JSON from response (may be wrapped in markdown code block)
124
+ const jsonMatch = response.match(/\{[\s\S]*\}/);
125
+ if (jsonMatch) {
126
+ const parsed = JSON.parse(jsonMatch[0]);
127
+ return {
128
+ description: parsed.description ?? response,
129
+ tags: Array.isArray(parsed.tags) ? parsed.tags : [],
130
+ entities: Array.isArray(parsed.entities) ? parsed.entities : [],
131
+ };
132
+ }
133
+ } catch {
134
+ // JSON parse failed — fall through to text extraction
135
+ }
136
+
137
+ // Fallback: treat entire response as description
138
+ return {
139
+ description: response,
140
+ tags: [],
141
+ entities: [],
142
+ };
143
+ }