@andespindola/brainlink 0.1.0-alpha.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 (52) hide show
  1. package/AGENTS.md +142 -0
  2. package/CHANGELOG.md +13 -0
  3. package/CONTRIBUTING.md +28 -0
  4. package/LICENSE +23 -0
  5. package/README.md +715 -0
  6. package/SECURITY.md +35 -0
  7. package/dist/application/add-note.js +30 -0
  8. package/dist/application/analyze-vault.js +28 -0
  9. package/dist/application/build-context.js +15 -0
  10. package/dist/application/frontend/client-css.js +294 -0
  11. package/dist/application/frontend/client-html.js +66 -0
  12. package/dist/application/frontend/client-js.js +416 -0
  13. package/dist/application/get-graph-layout.js +3 -0
  14. package/dist/application/get-graph.js +12 -0
  15. package/dist/application/index-vault.js +67 -0
  16. package/dist/application/list-agents.js +12 -0
  17. package/dist/application/list-links.js +22 -0
  18. package/dist/application/search-knowledge.js +19 -0
  19. package/dist/application/server/host-security.js +6 -0
  20. package/dist/application/server/http.js +13 -0
  21. package/dist/application/server/routes.js +88 -0
  22. package/dist/application/server/types.js +1 -0
  23. package/dist/application/start-server.js +54 -0
  24. package/dist/application/watch-vault.js +36 -0
  25. package/dist/benchmarks/large-vault.js +88 -0
  26. package/dist/cli/commands/read-commands.js +149 -0
  27. package/dist/cli/commands/write-commands.js +107 -0
  28. package/dist/cli/main.js +21 -0
  29. package/dist/cli/runtime.js +18 -0
  30. package/dist/cli/types.js +1 -0
  31. package/dist/domain/agents.js +11 -0
  32. package/dist/domain/context.js +44 -0
  33. package/dist/domain/embeddings.js +117 -0
  34. package/dist/domain/graph-analysis.js +48 -0
  35. package/dist/domain/graph-layout.js +187 -0
  36. package/dist/domain/ids.js +2 -0
  37. package/dist/domain/markdown.js +100 -0
  38. package/dist/domain/note-safety.js +54 -0
  39. package/dist/domain/tokens.js +1 -0
  40. package/dist/domain/types.js +1 -0
  41. package/dist/infrastructure/config.js +60 -0
  42. package/dist/infrastructure/file-system-vault.js +62 -0
  43. package/dist/infrastructure/sqlite/document-writer.js +50 -0
  44. package/dist/infrastructure/sqlite/graph-reader.js +108 -0
  45. package/dist/infrastructure/sqlite/schema.js +87 -0
  46. package/dist/infrastructure/sqlite/search-reader.js +156 -0
  47. package/dist/infrastructure/sqlite/types.js +1 -0
  48. package/dist/infrastructure/sqlite-index.js +20 -0
  49. package/docs/AGENT_USAGE.md +477 -0
  50. package/docs/ARCHITECTURE.md +286 -0
  51. package/docs/RELEASE.md +67 -0
  52. package/package.json +67 -0
@@ -0,0 +1,108 @@
1
+ import { sanitizeAgentId } from '../../domain/agents.js';
2
+ const toGraphLink = (row) => ({
3
+ agentId: row.agent_id,
4
+ fromTitle: row.from_title,
5
+ fromPath: row.from_path,
6
+ toTitle: row.to_title,
7
+ toPath: row.to_path
8
+ });
9
+ const normalizeAgentFilter = (agentId) => agentId ? sanitizeAgentId(agentId) : undefined;
10
+ export const createGraphReader = (database) => ({
11
+ listLinks: (agentId) => {
12
+ const normalizedAgentId = normalizeAgentFilter(agentId);
13
+ const agentFilter = normalizedAgentId ? 'WHERE source.agent_id = ?' : '';
14
+ const rows = database
15
+ .prepare(`
16
+ SELECT
17
+ source.agent_id AS agent_id,
18
+ source.title AS from_title,
19
+ source.path AS from_path,
20
+ COALESCE(target.title, links.to_title) AS to_title,
21
+ target.path AS to_path
22
+ FROM links
23
+ JOIN documents source ON source.id = links.from_document_id
24
+ LEFT JOIN documents target ON target.id = links.to_document_id
25
+ ${agentFilter}
26
+ ORDER BY source.title, to_title
27
+ `)
28
+ .all(...(normalizedAgentId ? [normalizedAgentId] : []));
29
+ return rows.map(toGraphLink);
30
+ },
31
+ listBacklinks: (title, agentId) => {
32
+ const normalizedAgentId = normalizeAgentFilter(agentId);
33
+ const agentFilter = normalizedAgentId ? 'AND source.agent_id = ?' : '';
34
+ const rows = database
35
+ .prepare(`
36
+ SELECT
37
+ source.agent_id AS agent_id,
38
+ source.title AS from_title,
39
+ source.path AS from_path,
40
+ COALESCE(target.title, links.to_title) AS to_title,
41
+ target.path AS to_path
42
+ FROM links
43
+ JOIN documents source ON source.id = links.from_document_id
44
+ LEFT JOIN documents target ON target.id = links.to_document_id
45
+ WHERE (lower(links.to_title) = lower(?) OR lower(target.title) = lower(?))
46
+ ${agentFilter}
47
+ ORDER BY source.title
48
+ `)
49
+ .all(...(normalizedAgentId ? [title, title, normalizedAgentId] : [title, title]));
50
+ return rows.map(toGraphLink);
51
+ },
52
+ getGraph: (agentId) => {
53
+ const normalizedAgentId = normalizeAgentFilter(agentId);
54
+ const documentAgentFilter = normalizedAgentId ? 'WHERE agent_id = ?' : '';
55
+ const edgeAgentFilter = normalizedAgentId ? 'WHERE source.agent_id = ?' : '';
56
+ const nodeRows = database
57
+ .prepare(`
58
+ SELECT id, agent_id, title, path, content, tags_json
59
+ FROM documents
60
+ ${documentAgentFilter}
61
+ ORDER BY title
62
+ `)
63
+ .all(...(normalizedAgentId ? [normalizedAgentId] : []));
64
+ const edgeRows = database
65
+ .prepare(`
66
+ SELECT
67
+ links.from_document_id AS source,
68
+ links.to_document_id AS target,
69
+ links.to_title AS target_title
70
+ FROM links
71
+ JOIN documents source ON source.id = links.from_document_id
72
+ ${edgeAgentFilter}
73
+ ORDER BY links.from_document_id, links.to_title
74
+ `)
75
+ .all(...(normalizedAgentId ? [normalizedAgentId] : []));
76
+ const nodes = nodeRows.map((row) => ({
77
+ id: row.id,
78
+ agentId: row.agent_id,
79
+ title: row.title,
80
+ path: row.path,
81
+ content: row.content,
82
+ tags: JSON.parse(row.tags_json)
83
+ }));
84
+ const edges = edgeRows.map((row) => ({
85
+ source: row.source,
86
+ target: row.target,
87
+ targetTitle: row.target_title
88
+ }));
89
+ return {
90
+ nodes,
91
+ edges
92
+ };
93
+ },
94
+ listAgents: () => {
95
+ const rows = database
96
+ .prepare(`
97
+ SELECT agent_id AS id, count(*) AS document_count
98
+ FROM documents
99
+ GROUP BY agent_id
100
+ ORDER BY agent_id
101
+ `)
102
+ .all();
103
+ return rows.map((row) => ({
104
+ id: row.id,
105
+ documentCount: row.document_count
106
+ }));
107
+ }
108
+ });
@@ -0,0 +1,87 @@
1
+ const schemaVersion = 4;
2
+ const getStoredSchemaVersion = (database) => {
3
+ const hasMetadata = database
4
+ .prepare("SELECT name FROM sqlite_master WHERE type = 'table' AND name = 'metadata'")
5
+ .get();
6
+ if (!hasMetadata) {
7
+ return 0;
8
+ }
9
+ const row = database.prepare("SELECT value FROM metadata WHERE key = 'schema_version'").get();
10
+ return Number.parseInt(row?.value ?? '0', 10);
11
+ };
12
+ const dropDerivedSchema = (database) => {
13
+ database.exec(`
14
+ DROP TABLE IF EXISTS embedding_buckets;
15
+ DROP TABLE IF EXISTS chunks_fts;
16
+ DROP TABLE IF EXISTS links;
17
+ DROP TABLE IF EXISTS chunks;
18
+ DROP TABLE IF EXISTS documents;
19
+ `);
20
+ };
21
+ export const createSchema = (database) => {
22
+ const storedSchemaVersion = getStoredSchemaVersion(database);
23
+ if (storedSchemaVersion > 0 && storedSchemaVersion < schemaVersion) {
24
+ dropDerivedSchema(database);
25
+ }
26
+ database.exec(`
27
+ CREATE TABLE IF NOT EXISTS metadata (
28
+ key TEXT PRIMARY KEY,
29
+ value TEXT NOT NULL
30
+ );
31
+
32
+ CREATE TABLE IF NOT EXISTS documents (
33
+ id TEXT PRIMARY KEY,
34
+ agent_id TEXT NOT NULL,
35
+ title TEXT NOT NULL,
36
+ path TEXT NOT NULL UNIQUE,
37
+ content TEXT NOT NULL,
38
+ tags_json TEXT NOT NULL,
39
+ frontmatter_json TEXT NOT NULL,
40
+ created_at TEXT NOT NULL,
41
+ updated_at TEXT NOT NULL
42
+ );
43
+
44
+ CREATE TABLE IF NOT EXISTS chunks (
45
+ id TEXT PRIMARY KEY,
46
+ document_id TEXT NOT NULL,
47
+ ordinal INTEGER NOT NULL,
48
+ content TEXT NOT NULL,
49
+ token_count INTEGER NOT NULL,
50
+ embedding_provider TEXT NOT NULL,
51
+ embedding_json TEXT NOT NULL,
52
+ FOREIGN KEY (document_id) REFERENCES documents(id) ON DELETE CASCADE
53
+ );
54
+
55
+ CREATE TABLE IF NOT EXISTS embedding_buckets (
56
+ bucket TEXT NOT NULL,
57
+ chunk_id TEXT NOT NULL,
58
+ PRIMARY KEY (bucket, chunk_id),
59
+ FOREIGN KEY (chunk_id) REFERENCES chunks(id) ON DELETE CASCADE
60
+ );
61
+
62
+ CREATE INDEX IF NOT EXISTS idx_embedding_buckets_bucket ON embedding_buckets(bucket);
63
+
64
+ CREATE TABLE IF NOT EXISTS links (
65
+ from_document_id TEXT NOT NULL,
66
+ to_title TEXT NOT NULL,
67
+ to_document_id TEXT,
68
+ FOREIGN KEY (from_document_id) REFERENCES documents(id) ON DELETE CASCADE,
69
+ FOREIGN KEY (to_document_id) REFERENCES documents(id) ON DELETE SET NULL
70
+ );
71
+
72
+ CREATE VIRTUAL TABLE IF NOT EXISTS chunks_fts USING fts5(
73
+ chunk_id UNINDEXED,
74
+ document_id UNINDEXED,
75
+ agent_id UNINDEXED,
76
+ title,
77
+ content
78
+ );
79
+ `);
80
+ database
81
+ .prepare(`
82
+ INSERT INTO metadata (key, value)
83
+ VALUES ('schema_version', ?)
84
+ ON CONFLICT(key) DO UPDATE SET value = excluded.value
85
+ `)
86
+ .run(String(schemaVersion));
87
+ };
@@ -0,0 +1,156 @@
1
+ import { sanitizeAgentId } from '../../domain/agents.js';
2
+ import { cosineSimilarity, createEmbeddingBuckets } from '../../domain/embeddings.js';
3
+ const toFtsQuery = (query) => query
4
+ .toLowerCase()
5
+ .match(/[\p{L}\p{N}_-]+/gu)
6
+ ?.map((term) => `"${term.replaceAll('"', '""')}"*`)
7
+ .join(' OR ') ?? '';
8
+ const normalizeAgentFilter = (agentId) => agentId ? sanitizeAgentId(agentId) : undefined;
9
+ const parseJsonArray = (value) => {
10
+ if (!value) {
11
+ return [];
12
+ }
13
+ try {
14
+ const parsed = JSON.parse(value);
15
+ return Array.isArray(parsed) ? parsed : [];
16
+ }
17
+ catch {
18
+ return [];
19
+ }
20
+ };
21
+ const toTextScore = (index, total) => total === 0 ? 0 : 1 - index / (total + 1);
22
+ const toSearchResult = (row, score, textScore, semanticScore, searchMode) => ({
23
+ documentId: row.document_id,
24
+ agentId: row.agent_id,
25
+ title: row.title,
26
+ path: row.path,
27
+ chunkId: row.chunk_id,
28
+ content: row.content,
29
+ score,
30
+ textScore,
31
+ semanticScore,
32
+ searchMode,
33
+ tags: parseJsonArray(row.tags_json).filter((value) => typeof value === 'string')
34
+ });
35
+ const sortByScore = (results) => [...results].sort((left, right) => right.score - left.score || left.title.localeCompare(right.title));
36
+ const mergeHybridResults = (ftsResults, semanticResults, limit) => {
37
+ const rows = new Map();
38
+ [...semanticResults, ...ftsResults].forEach((result) => {
39
+ const current = rows.get(result.chunkId);
40
+ const textScore = Math.max(current?.textScore ?? 0, result.textScore);
41
+ const semanticScore = Math.max(current?.semanticScore ?? 0, result.semanticScore);
42
+ const score = textScore * 0.62 + semanticScore * 0.38;
43
+ rows.set(result.chunkId, {
44
+ ...result,
45
+ score,
46
+ textScore,
47
+ semanticScore,
48
+ searchMode: 'hybrid'
49
+ });
50
+ });
51
+ return sortByScore(Array.from(rows.values())).slice(0, limit);
52
+ };
53
+ const placeholders = (count) => Array.from({ length: count }, () => '?').join(', ');
54
+ const readAllSemanticRows = (database, normalizedAgentId) => {
55
+ const semanticAgentFilter = normalizedAgentId ? 'WHERE documents.agent_id = ?' : '';
56
+ return database
57
+ .prepare(`
58
+ SELECT
59
+ documents.id AS document_id,
60
+ documents.agent_id AS agent_id,
61
+ documents.title AS title,
62
+ documents.path AS path,
63
+ chunks.id AS chunk_id,
64
+ chunks.content AS content,
65
+ documents.tags_json AS tags_json,
66
+ chunks.embedding_json AS embedding_json
67
+ FROM chunks
68
+ JOIN documents ON documents.id = chunks.document_id
69
+ ${semanticAgentFilter}
70
+ `)
71
+ .all(...(normalizedAgentId ? [normalizedAgentId] : []));
72
+ };
73
+ const readBucketedSemanticRows = (database, normalizedAgentId, queryEmbedding, limit) => {
74
+ const buckets = createEmbeddingBuckets(queryEmbedding);
75
+ if (buckets.length === 0) {
76
+ return [];
77
+ }
78
+ const agentFilter = normalizedAgentId ? 'AND documents.agent_id = ?' : '';
79
+ const params = normalizedAgentId ? [...buckets, normalizedAgentId, limit] : [...buckets, limit];
80
+ return database
81
+ .prepare(`
82
+ SELECT
83
+ documents.id AS document_id,
84
+ documents.agent_id AS agent_id,
85
+ documents.title AS title,
86
+ documents.path AS path,
87
+ chunks.id AS chunk_id,
88
+ chunks.content AS content,
89
+ documents.tags_json AS tags_json,
90
+ chunks.embedding_json AS embedding_json,
91
+ count(*) AS score
92
+ FROM embedding_buckets
93
+ JOIN chunks ON chunks.id = embedding_buckets.chunk_id
94
+ JOIN documents ON documents.id = chunks.document_id
95
+ WHERE embedding_buckets.bucket IN (${placeholders(buckets.length)})
96
+ ${agentFilter}
97
+ GROUP BY chunks.id
98
+ ORDER BY score DESC, chunks.token_count ASC, documents.title ASC
99
+ LIMIT ?
100
+ `)
101
+ .all(...params);
102
+ };
103
+ const readSemanticRows = (database, normalizedAgentId, queryEmbedding, limit) => {
104
+ const candidateLimit = Math.max(limit * 96, 768);
105
+ const bucketedRows = readBucketedSemanticRows(database, normalizedAgentId, queryEmbedding, candidateLimit);
106
+ return bucketedRows.length > 0 ? bucketedRows : readAllSemanticRows(database, normalizedAgentId);
107
+ };
108
+ export const createSearchReader = (database) => ({
109
+ search: (query, limit, agentId, mode = 'hybrid', queryEmbedding = []) => {
110
+ const normalizedQuery = query.trim();
111
+ if (!normalizedQuery || limit <= 0) {
112
+ return [];
113
+ }
114
+ const normalizedAgentId = normalizeAgentFilter(agentId);
115
+ const ftsQuery = toFtsQuery(query);
116
+ const expandedLimit = Math.max(limit * 4, 24);
117
+ const ftsAgentFilter = normalizedAgentId ? 'AND documents.agent_id = ?' : '';
118
+ const ftsParams = normalizedAgentId ? [ftsQuery, normalizedAgentId, expandedLimit] : [ftsQuery, expandedLimit];
119
+ const ftsRows = mode === 'semantic' || !ftsQuery
120
+ ? []
121
+ : database
122
+ .prepare(`
123
+ SELECT
124
+ documents.id AS document_id,
125
+ documents.agent_id AS agent_id,
126
+ documents.title AS title,
127
+ documents.path AS path,
128
+ chunks_fts.chunk_id AS chunk_id,
129
+ chunks_fts.content AS content,
130
+ bm25(chunks_fts) * -1 AS score,
131
+ documents.tags_json AS tags_json
132
+ FROM chunks_fts
133
+ JOIN documents ON documents.id = chunks_fts.document_id
134
+ WHERE chunks_fts MATCH ?
135
+ ${ftsAgentFilter}
136
+ ORDER BY bm25(chunks_fts)
137
+ LIMIT ?
138
+ `)
139
+ .all(...ftsParams);
140
+ const ftsResults = ftsRows.map((row, index) => toSearchResult(row, toTextScore(index, ftsRows.length), toTextScore(index, ftsRows.length), 0, 'fts'));
141
+ const semanticRows = mode === 'fts' || queryEmbedding.length === 0 ? [] : readSemanticRows(database, normalizedAgentId, queryEmbedding, expandedLimit);
142
+ const semanticResults = sortByScore(semanticRows
143
+ .map((row) => {
144
+ const semanticScore = Math.max(0, cosineSimilarity(queryEmbedding, parseJsonArray(row.embedding_json).filter((value) => typeof value === 'number')));
145
+ return toSearchResult(row, semanticScore, 0, semanticScore, 'semantic');
146
+ })
147
+ .filter((result) => result.semanticScore > 0)).slice(0, expandedLimit);
148
+ if (mode === 'fts') {
149
+ return ftsResults.slice(0, limit);
150
+ }
151
+ if (mode === 'semantic') {
152
+ return semanticResults.slice(0, limit);
153
+ }
154
+ return mergeHybridResults(ftsResults, semanticResults, limit);
155
+ }
156
+ });
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,20 @@
1
+ import Database from 'better-sqlite3';
2
+ import { chmodSync } from 'node:fs';
3
+ import { join } from 'node:path';
4
+ import { createIndexWriter } from './sqlite/document-writer.js';
5
+ import { createGraphReader } from './sqlite/graph-reader.js';
6
+ import { createSchema } from './sqlite/schema.js';
7
+ import { createSearchReader } from './sqlite/search-reader.js';
8
+ export const openSqliteIndex = (vaultPath) => {
9
+ const databasePath = join(vaultPath, '.brainlink', 'brainlink.db');
10
+ const database = new Database(databasePath);
11
+ chmodSync(databasePath, 0o600);
12
+ database.exec('PRAGMA foreign_keys = ON;');
13
+ createSchema(database);
14
+ return {
15
+ ...createIndexWriter(database),
16
+ ...createSearchReader(database),
17
+ ...createGraphReader(database),
18
+ close: () => database.close()
19
+ };
20
+ };