@synth-coder/memhub 0.2.2 → 0.2.3

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 (71) hide show
  1. package/.eslintrc.cjs +45 -45
  2. package/.factory/commands/opsx-apply.md +150 -0
  3. package/.factory/commands/opsx-archive.md +155 -0
  4. package/.factory/commands/opsx-explore.md +171 -0
  5. package/.factory/commands/opsx-propose.md +104 -0
  6. package/.factory/skills/openspec-apply-change/SKILL.md +156 -0
  7. package/.factory/skills/openspec-archive-change/SKILL.md +114 -0
  8. package/.factory/skills/openspec-explore/SKILL.md +288 -0
  9. package/.factory/skills/openspec-propose/SKILL.md +110 -0
  10. package/.github/workflows/ci.yml +74 -74
  11. package/.iflow/commands/opsx-apply.md +152 -152
  12. package/.iflow/commands/opsx-archive.md +157 -157
  13. package/.iflow/commands/opsx-explore.md +173 -173
  14. package/.iflow/commands/opsx-propose.md +106 -106
  15. package/.iflow/skills/openspec-apply-change/SKILL.md +156 -156
  16. package/.iflow/skills/openspec-archive-change/SKILL.md +114 -114
  17. package/.iflow/skills/openspec-explore/SKILL.md +288 -288
  18. package/.iflow/skills/openspec-propose/SKILL.md +110 -110
  19. package/.prettierrc +11 -11
  20. package/AGENTS.md +169 -26
  21. package/README.md +195 -195
  22. package/README.zh-CN.md +193 -193
  23. package/dist/src/contracts/mcp.js +34 -34
  24. package/dist/src/server/mcp-server.d.ts +8 -0
  25. package/dist/src/server/mcp-server.d.ts.map +1 -1
  26. package/dist/src/server/mcp-server.js +23 -2
  27. package/dist/src/server/mcp-server.js.map +1 -1
  28. package/dist/src/services/memory-service.d.ts +1 -0
  29. package/dist/src/services/memory-service.d.ts.map +1 -1
  30. package/dist/src/services/memory-service.js +125 -82
  31. package/dist/src/services/memory-service.js.map +1 -1
  32. package/docs/architecture-diagrams.md +368 -0
  33. package/docs/architecture.md +381 -349
  34. package/docs/contracts.md +190 -119
  35. package/docs/prompt-template.md +33 -79
  36. package/docs/proposals/mcp-typescript-sdk-refactor.md +568 -568
  37. package/docs/proposals/proposal-close-gates.md +58 -58
  38. package/docs/tool-calling-policy.md +101 -107
  39. package/docs/vector-search.md +306 -0
  40. package/package.json +59 -58
  41. package/src/contracts/index.ts +12 -12
  42. package/src/contracts/mcp.ts +222 -222
  43. package/src/contracts/schemas.ts +307 -307
  44. package/src/contracts/types.ts +410 -410
  45. package/src/index.ts +8 -8
  46. package/src/server/index.ts +5 -5
  47. package/src/server/mcp-server.ts +185 -161
  48. package/src/services/embedding-service.ts +114 -114
  49. package/src/services/index.ts +5 -5
  50. package/src/services/memory-service.ts +663 -621
  51. package/src/storage/frontmatter-parser.ts +243 -243
  52. package/src/storage/index.ts +6 -6
  53. package/src/storage/markdown-storage.ts +236 -236
  54. package/src/storage/vector-index.ts +160 -160
  55. package/src/utils/index.ts +5 -5
  56. package/src/utils/slugify.ts +63 -63
  57. package/test/contracts/schemas.test.ts +313 -313
  58. package/test/contracts/types.test.ts +21 -21
  59. package/test/frontmatter-parser-more.test.ts +94 -94
  60. package/test/server/mcp-server.test.ts +210 -169
  61. package/test/services/memory-service-edge.test.ts +248 -248
  62. package/test/services/memory-service.test.ts +278 -278
  63. package/test/storage/frontmatter-parser.test.ts +222 -222
  64. package/test/storage/markdown-storage.test.ts +216 -216
  65. package/test/storage/storage-edge.test.ts +238 -238
  66. package/test/storage/vector-index.test.ts +153 -153
  67. package/test/utils/slugify-edge.test.ts +94 -94
  68. package/test/utils/slugify.test.ts +68 -68
  69. package/tsconfig.json +25 -25
  70. package/tsconfig.test.json +8 -8
  71. package/vitest.config.ts +29 -29
@@ -1,238 +1,238 @@
1
- /**
2
- * Storage Edge Case Tests
3
- * Additional tests for better coverage
4
- */
5
-
6
- import { describe, it, expect, beforeEach, afterEach } from 'vitest';
7
- import { mkdtempSync, rmSync, writeFileSync } from 'fs';
8
- import { tmpdir } from 'os';
9
- import { join } from 'path';
10
- import { MarkdownStorage, StorageError } from '../../src/storage/markdown-storage.js';
11
- import { FrontMatterError } from '../../src/storage/frontmatter-parser.js';
12
-
13
- describe('MarkdownStorage Edge Cases', () => {
14
- let tempDir: string;
15
- let storage: MarkdownStorage;
16
-
17
- beforeEach(() => {
18
- tempDir = mkdtempSync(join(tmpdir(), 'memhub-storage-edge-'));
19
- storage = new MarkdownStorage({ storagePath: tempDir });
20
- });
21
-
22
- afterEach(() => {
23
- rmSync(tempDir, { recursive: true, force: true });
24
- });
25
-
26
- describe('initialize', () => {
27
- it('should create directory if it does not exist', async () => {
28
- const newDir = join(tempDir, 'subdir', 'new-storage');
29
- const newStorage = new MarkdownStorage({ storagePath: newDir });
30
- await newStorage.initialize();
31
- // Directory should be created
32
- const { existsSync } = await import('fs');
33
- expect(existsSync(newDir)).toBe(true);
34
- });
35
- });
36
-
37
- describe('write edge cases', () => {
38
- it('should handle memory with empty title', async () => {
39
- const memory = {
40
- id: '550e8400-e29b-41d4-a716-446655440000',
41
- createdAt: '2024-03-15T10:30:00Z',
42
- updatedAt: '2024-03-15T10:30:00Z',
43
- tags: [],
44
- category: 'test',
45
- importance: 3,
46
- title: '',
47
- content: 'Content with empty title',
48
- };
49
-
50
- const filePath = await storage.write(memory);
51
- expect(filePath).toContain('untitled');
52
- });
53
-
54
- it('should handle memory with special characters in title', async () => {
55
- const memory = {
56
- id: '550e8400-e29b-41d4-a716-446655440001',
57
- createdAt: '2024-03-15T10:30:00Z',
58
- updatedAt: '2024-03-15T10:30:00Z',
59
- tags: [],
60
- category: 'test',
61
- importance: 3,
62
- title: 'Title with @#$%^&*()',
63
- content: 'Content',
64
- };
65
-
66
- const filePath = await storage.write(memory);
67
- expect(filePath).toBeDefined();
68
- });
69
-
70
- it('should handle very long content', async () => {
71
- const memory = {
72
- id: '550e8400-e29b-41d4-a716-446655440002',
73
- createdAt: '2024-03-15T10:30:00Z',
74
- updatedAt: '2024-03-15T10:30:00Z',
75
- tags: [],
76
- category: 'test',
77
- importance: 3,
78
- title: 'Long Content',
79
- content: 'A'.repeat(10000),
80
- };
81
-
82
- const filePath = await storage.write(memory);
83
- const { readFileSync } = await import('fs');
84
- const content = readFileSync(filePath, 'utf-8');
85
- expect(content).toContain('A'.repeat(100));
86
- });
87
- });
88
-
89
- describe('read edge cases', () => {
90
- it('should throw error for invalid front matter', async () => {
91
- const invalidContent = '---\ninvalid yaml: [\n---\n\n# Title';
92
- writeFileSync(join(tempDir, 'invalid.md'), invalidContent);
93
-
94
- await expect(storage.read('any-id')).rejects.toThrow(StorageError);
95
- });
96
-
97
- it('should throw error for missing required fields', async () => {
98
- const incompleteContent = '---\nid: "test-id"\n---\n\n# Title';
99
- writeFileSync(join(tempDir, 'incomplete.md'), incompleteContent);
100
-
101
- await expect(storage.read('test-id')).rejects.toThrow(StorageError);
102
- });
103
-
104
- it('should handle file with no H1 title', async () => {
105
- const noTitleContent = `---
106
- id: "550e8400-e29b-41d4-a716-446655440000"
107
- created_at: "2024-03-15T10:30:00Z"
108
- updated_at: "2024-03-15T10:30:00Z"
109
- tags: []
110
- category: "general"
111
- importance: 3
112
- ---
113
-
114
- Just some content without H1.
115
- `;
116
- writeFileSync(join(tempDir, 'no-title.md'), noTitleContent);
117
-
118
- const memory = await storage.read('550e8400-e29b-41d4-a716-446655440000');
119
- expect(memory.title).toBe('');
120
- expect(memory.content).toContain('Just some content');
121
- });
122
- });
123
-
124
- describe('list edge cases', () => {
125
- it('should skip invalid markdown files', async () => {
126
- // Create valid file
127
- const validContent = `---
128
- id: "valid-id"
129
- created_at: "2024-03-15T10:30:00Z"
130
- updated_at: "2024-03-15T10:30:00Z"
131
- tags: []
132
- category: "general"
133
- importance: 3
134
- ---
135
-
136
- # Valid
137
- `;
138
- writeFileSync(join(tempDir, 'valid.md'), validContent);
139
-
140
- // Create invalid file
141
- writeFileSync(join(tempDir, 'invalid.md'), 'Not valid markdown');
142
-
143
- const files = await storage.list();
144
- expect(files).toHaveLength(2);
145
- });
146
-
147
- it('should handle empty directory', async () => {
148
- const files = await storage.list();
149
- expect(files).toEqual([]);
150
- });
151
-
152
- it('should ignore non-markdown files', async () => {
153
- writeFileSync(join(tempDir, 'test.txt'), 'Text file');
154
- writeFileSync(join(tempDir, 'test.json'), '{}');
155
-
156
- const files = await storage.list();
157
- expect(files).toHaveLength(0);
158
- });
159
- });
160
-
161
- describe('findById edge cases', () => {
162
- it('should return null when no files exist', async () => {
163
- const result = await storage.findById('any-id');
164
- expect(result).toBeNull();
165
- });
166
-
167
- it('should skip files with invalid front matter', async () => {
168
- writeFileSync(join(tempDir, 'invalid.md'), 'Invalid content');
169
-
170
- const result = await storage.findById('any-id');
171
- expect(result).toBeNull();
172
- });
173
-
174
- it('should find correct file among multiple files', async () => {
175
- const content1 = `---
176
- id: "id-1"
177
- created_at: "2024-03-15T10:30:00Z"
178
- updated_at: "2024-03-15T10:30:00Z"
179
- tags: []
180
- category: "general"
181
- importance: 3
182
- ---
183
-
184
- # File 1
185
- `;
186
- const content2 = `---
187
- id: "id-2"
188
- created_at: "2024-03-15T10:30:00Z"
189
- updated_at: "2024-03-15T10:30:00Z"
190
- tags: []
191
- category: "general"
192
- importance: 3
193
- ---
194
-
195
- # File 2
196
- `;
197
- writeFileSync(join(tempDir, 'file1.md'), content1);
198
- writeFileSync(join(tempDir, 'file2.md'), content2);
199
-
200
- const result = await storage.findById('id-2');
201
- expect(result).toContain('file2.md');
202
- });
203
- });
204
-
205
- describe('delete edge cases', () => {
206
- it('should throw error when trying to delete non-existent memory', async () => {
207
- await expect(storage.delete('non-existent-id')).rejects.toThrow(StorageError);
208
- });
209
- });
210
- });
211
-
212
- describe('FrontMatterError', () => {
213
- it('should create error with message', () => {
214
- const error = new FrontMatterError('Test error');
215
- expect(error.message).toBe('Test error');
216
- expect(error.name).toBe('FrontMatterError');
217
- });
218
-
219
- it('should create error with cause', () => {
220
- const cause = new Error('Original error');
221
- const error = new FrontMatterError('Test error', cause);
222
- expect(error.cause).toBe(cause);
223
- });
224
- });
225
-
226
- describe('StorageError', () => {
227
- it('should create error with message', () => {
228
- const error = new StorageError('Test error');
229
- expect(error.message).toBe('Test error');
230
- expect(error.name).toBe('StorageError');
231
- });
232
-
233
- it('should create error with cause', () => {
234
- const cause = new Error('Original error');
235
- const error = new StorageError('Test error', cause);
236
- expect(error.cause).toBe(cause);
237
- });
238
- });
1
+ /**
2
+ * Storage Edge Case Tests
3
+ * Additional tests for better coverage
4
+ */
5
+
6
+ import { describe, it, expect, beforeEach, afterEach } from 'vitest';
7
+ import { mkdtempSync, rmSync, writeFileSync } from 'fs';
8
+ import { tmpdir } from 'os';
9
+ import { join } from 'path';
10
+ import { MarkdownStorage, StorageError } from '../../src/storage/markdown-storage.js';
11
+ import { FrontMatterError } from '../../src/storage/frontmatter-parser.js';
12
+
13
+ describe('MarkdownStorage Edge Cases', () => {
14
+ let tempDir: string;
15
+ let storage: MarkdownStorage;
16
+
17
+ beforeEach(() => {
18
+ tempDir = mkdtempSync(join(tmpdir(), 'memhub-storage-edge-'));
19
+ storage = new MarkdownStorage({ storagePath: tempDir });
20
+ });
21
+
22
+ afterEach(() => {
23
+ rmSync(tempDir, { recursive: true, force: true });
24
+ });
25
+
26
+ describe('initialize', () => {
27
+ it('should create directory if it does not exist', async () => {
28
+ const newDir = join(tempDir, 'subdir', 'new-storage');
29
+ const newStorage = new MarkdownStorage({ storagePath: newDir });
30
+ await newStorage.initialize();
31
+ // Directory should be created
32
+ const { existsSync } = await import('fs');
33
+ expect(existsSync(newDir)).toBe(true);
34
+ });
35
+ });
36
+
37
+ describe('write edge cases', () => {
38
+ it('should handle memory with empty title', async () => {
39
+ const memory = {
40
+ id: '550e8400-e29b-41d4-a716-446655440000',
41
+ createdAt: '2024-03-15T10:30:00Z',
42
+ updatedAt: '2024-03-15T10:30:00Z',
43
+ tags: [],
44
+ category: 'test',
45
+ importance: 3,
46
+ title: '',
47
+ content: 'Content with empty title',
48
+ };
49
+
50
+ const filePath = await storage.write(memory);
51
+ expect(filePath).toContain('untitled');
52
+ });
53
+
54
+ it('should handle memory with special characters in title', async () => {
55
+ const memory = {
56
+ id: '550e8400-e29b-41d4-a716-446655440001',
57
+ createdAt: '2024-03-15T10:30:00Z',
58
+ updatedAt: '2024-03-15T10:30:00Z',
59
+ tags: [],
60
+ category: 'test',
61
+ importance: 3,
62
+ title: 'Title with @#$%^&*()',
63
+ content: 'Content',
64
+ };
65
+
66
+ const filePath = await storage.write(memory);
67
+ expect(filePath).toBeDefined();
68
+ });
69
+
70
+ it('should handle very long content', async () => {
71
+ const memory = {
72
+ id: '550e8400-e29b-41d4-a716-446655440002',
73
+ createdAt: '2024-03-15T10:30:00Z',
74
+ updatedAt: '2024-03-15T10:30:00Z',
75
+ tags: [],
76
+ category: 'test',
77
+ importance: 3,
78
+ title: 'Long Content',
79
+ content: 'A'.repeat(10000),
80
+ };
81
+
82
+ const filePath = await storage.write(memory);
83
+ const { readFileSync } = await import('fs');
84
+ const content = readFileSync(filePath, 'utf-8');
85
+ expect(content).toContain('A'.repeat(100));
86
+ });
87
+ });
88
+
89
+ describe('read edge cases', () => {
90
+ it('should throw error for invalid front matter', async () => {
91
+ const invalidContent = '---\ninvalid yaml: [\n---\n\n# Title';
92
+ writeFileSync(join(tempDir, 'invalid.md'), invalidContent);
93
+
94
+ await expect(storage.read('any-id')).rejects.toThrow(StorageError);
95
+ });
96
+
97
+ it('should throw error for missing required fields', async () => {
98
+ const incompleteContent = '---\nid: "test-id"\n---\n\n# Title';
99
+ writeFileSync(join(tempDir, 'incomplete.md'), incompleteContent);
100
+
101
+ await expect(storage.read('test-id')).rejects.toThrow(StorageError);
102
+ });
103
+
104
+ it('should handle file with no H1 title', async () => {
105
+ const noTitleContent = `---
106
+ id: "550e8400-e29b-41d4-a716-446655440000"
107
+ created_at: "2024-03-15T10:30:00Z"
108
+ updated_at: "2024-03-15T10:30:00Z"
109
+ tags: []
110
+ category: "general"
111
+ importance: 3
112
+ ---
113
+
114
+ Just some content without H1.
115
+ `;
116
+ writeFileSync(join(tempDir, 'no-title.md'), noTitleContent);
117
+
118
+ const memory = await storage.read('550e8400-e29b-41d4-a716-446655440000');
119
+ expect(memory.title).toBe('');
120
+ expect(memory.content).toContain('Just some content');
121
+ });
122
+ });
123
+
124
+ describe('list edge cases', () => {
125
+ it('should skip invalid markdown files', async () => {
126
+ // Create valid file
127
+ const validContent = `---
128
+ id: "valid-id"
129
+ created_at: "2024-03-15T10:30:00Z"
130
+ updated_at: "2024-03-15T10:30:00Z"
131
+ tags: []
132
+ category: "general"
133
+ importance: 3
134
+ ---
135
+
136
+ # Valid
137
+ `;
138
+ writeFileSync(join(tempDir, 'valid.md'), validContent);
139
+
140
+ // Create invalid file
141
+ writeFileSync(join(tempDir, 'invalid.md'), 'Not valid markdown');
142
+
143
+ const files = await storage.list();
144
+ expect(files).toHaveLength(2);
145
+ });
146
+
147
+ it('should handle empty directory', async () => {
148
+ const files = await storage.list();
149
+ expect(files).toEqual([]);
150
+ });
151
+
152
+ it('should ignore non-markdown files', async () => {
153
+ writeFileSync(join(tempDir, 'test.txt'), 'Text file');
154
+ writeFileSync(join(tempDir, 'test.json'), '{}');
155
+
156
+ const files = await storage.list();
157
+ expect(files).toHaveLength(0);
158
+ });
159
+ });
160
+
161
+ describe('findById edge cases', () => {
162
+ it('should return null when no files exist', async () => {
163
+ const result = await storage.findById('any-id');
164
+ expect(result).toBeNull();
165
+ });
166
+
167
+ it('should skip files with invalid front matter', async () => {
168
+ writeFileSync(join(tempDir, 'invalid.md'), 'Invalid content');
169
+
170
+ const result = await storage.findById('any-id');
171
+ expect(result).toBeNull();
172
+ });
173
+
174
+ it('should find correct file among multiple files', async () => {
175
+ const content1 = `---
176
+ id: "id-1"
177
+ created_at: "2024-03-15T10:30:00Z"
178
+ updated_at: "2024-03-15T10:30:00Z"
179
+ tags: []
180
+ category: "general"
181
+ importance: 3
182
+ ---
183
+
184
+ # File 1
185
+ `;
186
+ const content2 = `---
187
+ id: "id-2"
188
+ created_at: "2024-03-15T10:30:00Z"
189
+ updated_at: "2024-03-15T10:30:00Z"
190
+ tags: []
191
+ category: "general"
192
+ importance: 3
193
+ ---
194
+
195
+ # File 2
196
+ `;
197
+ writeFileSync(join(tempDir, 'file1.md'), content1);
198
+ writeFileSync(join(tempDir, 'file2.md'), content2);
199
+
200
+ const result = await storage.findById('id-2');
201
+ expect(result).toContain('file2.md');
202
+ });
203
+ });
204
+
205
+ describe('delete edge cases', () => {
206
+ it('should throw error when trying to delete non-existent memory', async () => {
207
+ await expect(storage.delete('non-existent-id')).rejects.toThrow(StorageError);
208
+ });
209
+ });
210
+ });
211
+
212
+ describe('FrontMatterError', () => {
213
+ it('should create error with message', () => {
214
+ const error = new FrontMatterError('Test error');
215
+ expect(error.message).toBe('Test error');
216
+ expect(error.name).toBe('FrontMatterError');
217
+ });
218
+
219
+ it('should create error with cause', () => {
220
+ const cause = new Error('Original error');
221
+ const error = new FrontMatterError('Test error', cause);
222
+ expect(error.cause).toBe(cause);
223
+ });
224
+ });
225
+
226
+ describe('StorageError', () => {
227
+ it('should create error with message', () => {
228
+ const error = new StorageError('Test error');
229
+ expect(error.message).toBe('Test error');
230
+ expect(error.name).toBe('StorageError');
231
+ });
232
+
233
+ it('should create error with cause', () => {
234
+ const cause = new Error('Original error');
235
+ const error = new StorageError('Test error', cause);
236
+ expect(error.cause).toBe(cause);
237
+ });
238
+ });