@lumenflow/memory 1.0.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 (55) hide show
  1. package/LICENSE +190 -0
  2. package/README.md +181 -0
  3. package/dist/index.d.ts +16 -0
  4. package/dist/index.d.ts.map +1 -0
  5. package/dist/index.js +16 -0
  6. package/dist/index.js.map +1 -0
  7. package/dist/mem-checkpoint-core.d.ts +91 -0
  8. package/dist/mem-checkpoint-core.d.ts.map +1 -0
  9. package/dist/mem-checkpoint-core.js +175 -0
  10. package/dist/mem-checkpoint-core.js.map +1 -0
  11. package/dist/mem-cleanup-core.d.ts +202 -0
  12. package/dist/mem-cleanup-core.d.ts.map +1 -0
  13. package/dist/mem-cleanup-core.js +364 -0
  14. package/dist/mem-cleanup-core.js.map +1 -0
  15. package/dist/mem-create-core.d.ts +93 -0
  16. package/dist/mem-create-core.d.ts.map +1 -0
  17. package/dist/mem-create-core.js +369 -0
  18. package/dist/mem-create-core.js.map +1 -0
  19. package/dist/mem-id.d.ts +91 -0
  20. package/dist/mem-id.d.ts.map +1 -0
  21. package/dist/mem-id.js +136 -0
  22. package/dist/mem-id.js.map +1 -0
  23. package/dist/mem-init-core.d.ts +91 -0
  24. package/dist/mem-init-core.d.ts.map +1 -0
  25. package/dist/mem-init-core.js +138 -0
  26. package/dist/mem-init-core.js.map +1 -0
  27. package/dist/mem-ready-core.d.ts +56 -0
  28. package/dist/mem-ready-core.d.ts.map +1 -0
  29. package/dist/mem-ready-core.js +232 -0
  30. package/dist/mem-ready-core.js.map +1 -0
  31. package/dist/mem-signal-core.d.ts +132 -0
  32. package/dist/mem-signal-core.d.ts.map +1 -0
  33. package/dist/mem-signal-core.js +249 -0
  34. package/dist/mem-signal-core.js.map +1 -0
  35. package/dist/mem-start-core.d.ts +76 -0
  36. package/dist/mem-start-core.d.ts.map +1 -0
  37. package/dist/mem-start-core.js +133 -0
  38. package/dist/mem-start-core.js.map +1 -0
  39. package/dist/mem-summarize-core.d.ts +105 -0
  40. package/dist/mem-summarize-core.d.ts.map +1 -0
  41. package/dist/mem-summarize-core.js +263 -0
  42. package/dist/mem-summarize-core.js.map +1 -0
  43. package/dist/mem-triage-core.d.ts +127 -0
  44. package/dist/mem-triage-core.d.ts.map +1 -0
  45. package/dist/mem-triage-core.js +332 -0
  46. package/dist/mem-triage-core.js.map +1 -0
  47. package/dist/memory-schema.d.ts +150 -0
  48. package/dist/memory-schema.d.ts.map +1 -0
  49. package/dist/memory-schema.js +149 -0
  50. package/dist/memory-schema.js.map +1 -0
  51. package/dist/memory-store.d.ts +108 -0
  52. package/dist/memory-store.d.ts.map +1 -0
  53. package/dist/memory-store.js +234 -0
  54. package/dist/memory-store.js.map +1 -0
  55. package/package.json +76 -0
package/LICENSE ADDED
@@ -0,0 +1,190 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2026 HellmAI
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,181 @@
1
+ # @lumenflow/memory
2
+
3
+ Memory layer for LumenFlow workflow framework - session tracking, context recovery, and agent coordination.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ npm install @lumenflow/memory
9
+ ```
10
+
11
+ ## Overview
12
+
13
+ This package provides a persistent memory layer for AI agents working within the LumenFlow framework. It enables:
14
+
15
+ - **Session tracking**: Track agent sessions across context window boundaries
16
+ - **Context recovery**: Resume work after `/clear` or session handoff
17
+ - **Agent coordination**: Signal between parallel agents via inbox/outbox
18
+ - **Progress checkpoints**: Save state at milestones for recovery
19
+
20
+ ## Usage
21
+
22
+ ### Memory Store
23
+
24
+ The memory store uses JSONL format for git-friendly, append-only persistence.
25
+
26
+ ```typescript
27
+ import { loadMemory, appendNode, queryReady, queryByWu } from '@lumenflow/memory';
28
+
29
+ // Load all memory nodes
30
+ const memory = await loadMemory('/path/to/project');
31
+ const node = memory.byId.get('mem-abc1');
32
+ const wuNodes = memory.byWu.get('WU-123') ?? [];
33
+
34
+ // Append a new node
35
+ await appendNode('/path/to/project', {
36
+ id: 'mem-xyz9',
37
+ type: 'checkpoint',
38
+ lifecycle: 'wu',
39
+ content: 'Completed port definitions',
40
+ created_at: new Date().toISOString(),
41
+ wu_id: 'WU-123',
42
+ });
43
+
44
+ // Query nodes ready for processing (priority-ordered)
45
+ const ready = await queryReady('/path/to/project', 'WU-123');
46
+
47
+ // Query all nodes for a WU (file order)
48
+ const nodes = await queryByWu('/path/to/project', 'WU-123');
49
+ ```
50
+
51
+ ### Memory Schema
52
+
53
+ Validate memory nodes against the schema:
54
+
55
+ ```typescript
56
+ import {
57
+ validateMemoryNode,
58
+ MemoryNodeSchema,
59
+ MEMORY_NODE_TYPES,
60
+ MEMORY_LIFECYCLES,
61
+ } from '@lumenflow/memory';
62
+
63
+ // Node types: session, discovery, checkpoint, note, summary
64
+ // Lifecycles: ephemeral, session, wu, project
65
+
66
+ const result = validateMemoryNode(nodeData);
67
+ if (!result.success) {
68
+ console.error(result.error.issues);
69
+ }
70
+ ```
71
+
72
+ ### Checkpoints
73
+
74
+ Create progress checkpoints for context recovery:
75
+
76
+ ```typescript
77
+ import { createCheckpoint } from '@lumenflow/memory/checkpoint';
78
+
79
+ await createCheckpoint('/path/to/project', {
80
+ wuId: 'WU-123',
81
+ content: 'Completed acceptance criteria 1-3',
82
+ metadata: { milestone: 'ports-complete' },
83
+ });
84
+ ```
85
+
86
+ ### Signals
87
+
88
+ Send and receive coordination signals between agents:
89
+
90
+ ```typescript
91
+ import { sendSignal } from '@lumenflow/memory/signal';
92
+
93
+ // Signal completion to other agents
94
+ await sendSignal('/path/to/project', {
95
+ wuId: 'WU-123',
96
+ type: 'completion',
97
+ content: 'WU-123 done, WU-124 unblocked',
98
+ });
99
+ ```
100
+
101
+ ## Subpath Exports
102
+
103
+ ```typescript
104
+ // Main entry (all exports)
105
+ import { loadMemory, MemoryNodeSchema } from '@lumenflow/memory';
106
+
107
+ // Specific modules
108
+ import { createCheckpoint } from '@lumenflow/memory/checkpoint';
109
+ import { initMemory } from '@lumenflow/memory/init';
110
+ import { startSession } from '@lumenflow/memory/start';
111
+ import { queryReadyNodes } from '@lumenflow/memory/ready';
112
+ import { sendSignal } from '@lumenflow/memory/signal';
113
+ import { cleanupExpired } from '@lumenflow/memory/cleanup';
114
+ import { createMemoryNode } from '@lumenflow/memory/create';
115
+ import { summarizeWu } from '@lumenflow/memory/summarize';
116
+ import { triageBugs } from '@lumenflow/memory/triage';
117
+ import { MemoryNodeSchema } from '@lumenflow/memory/schema';
118
+ import { loadMemory, appendNode } from '@lumenflow/memory/store';
119
+ ```
120
+
121
+ ## API Reference
122
+
123
+ ### Memory Store
124
+
125
+ | Function | Description |
126
+ | --------------------------- | ------------------------------------------ |
127
+ | `loadMemory(baseDir)` | Load and index all memory nodes from JSONL |
128
+ | `appendNode(baseDir, node)` | Append a validated node to the memory file |
129
+ | `queryReady(baseDir, wuId)` | Get nodes for WU in priority order |
130
+ | `queryByWu(baseDir, wuId)` | Get all nodes for WU in file order |
131
+
132
+ ### Memory Schema
133
+
134
+ | Export | Description |
135
+ | ---------------------------- | ----------------------------------------- |
136
+ | `MemoryNodeSchema` | Zod schema for memory nodes |
137
+ | `RelationshipSchema` | Zod schema for node relationships |
138
+ | `validateMemoryNode(data)` | Validate data against node schema |
139
+ | `validateRelationship(data)` | Validate data against relationship schema |
140
+ | `MEMORY_NODE_TYPES` | Valid node types array |
141
+ | `MEMORY_LIFECYCLES` | Valid lifecycle values array |
142
+ | `RELATIONSHIP_TYPES` | Valid relationship types array |
143
+
144
+ ### Types
145
+
146
+ ```typescript
147
+ interface MemoryNode {
148
+ id: string; // mem-[a-z0-9]{4}
149
+ type: 'session' | 'discovery' | 'checkpoint' | 'note' | 'summary';
150
+ lifecycle: 'ephemeral' | 'session' | 'wu' | 'project';
151
+ content: string;
152
+ created_at: string; // ISO 8601
153
+ updated_at?: string;
154
+ wu_id?: string; // WU-XXX
155
+ session_id?: string; // UUID
156
+ metadata?: Record<string, unknown>;
157
+ tags?: string[];
158
+ }
159
+
160
+ interface IndexedMemory {
161
+ nodes: MemoryNode[];
162
+ byId: Map<string, MemoryNode>;
163
+ byWu: Map<string, MemoryNode[]>;
164
+ }
165
+ ```
166
+
167
+ ## Features
168
+
169
+ - **Append-only writes**: No full file rewrites, git-merge friendly
170
+ - **Indexed lookups**: O(1) access by ID and WU
171
+ - **Priority ordering**: Deterministic query results (P0 > P1 > P2 > P3)
172
+ - **Schema validation**: Zod-based runtime validation
173
+ - **Modern**: Node 22+, ESM-only, TypeScript
174
+
175
+ ## Documentation
176
+
177
+ For complete documentation, see the [LumenFlow documentation](https://github.com/hellmai/os).
178
+
179
+ ## License
180
+
181
+ Apache-2.0
@@ -0,0 +1,16 @@
1
+ /**
2
+ * @lumenflow/memory - Session tracking and context recovery
3
+ * @module @lumenflow/memory
4
+ */
5
+ export * from './mem-checkpoint-core.js';
6
+ export * from './mem-cleanup-core.js';
7
+ export * from './mem-create-core.js';
8
+ export * from './mem-id.js';
9
+ export * from './mem-init-core.js';
10
+ export * from './mem-ready-core.js';
11
+ export * from './mem-signal-core.js';
12
+ export * from './mem-start-core.js';
13
+ export { filterSummarizableNodes, summarizeWu, getCompactionRatio as getSummarizeCompactionRatio, } from './mem-summarize-core.js';
14
+ export * from './mem-triage-core.js';
15
+ export * from './memory-schema.js';
16
+ export * from './memory-store.js';
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC"}
package/dist/index.js ADDED
@@ -0,0 +1,16 @@
1
+ /**
2
+ * @lumenflow/memory - Session tracking and context recovery
3
+ * @module @lumenflow/memory
4
+ */
5
+ export * from './mem-checkpoint-core.js';
6
+ export * from './mem-cleanup-core.js';
7
+ export * from './mem-create-core.js';
8
+ export * from './mem-id.js';
9
+ export * from './mem-init-core.js';
10
+ export * from './mem-ready-core.js';
11
+ export * from './mem-signal-core.js';
12
+ export * from './mem-start-core.js';
13
+ export { filterSummarizableNodes, summarizeWu, getCompactionRatio as getSummarizeCompactionRatio, } from './mem-summarize-core.js';
14
+ export * from './mem-triage-core.js';
15
+ export * from './memory-schema.js';
16
+ export * from './memory-store.js';
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,cAAc,0BAA0B,CAAC;AACzC,cAAc,uBAAuB,CAAC;AACtC,cAAc,sBAAsB,CAAC;AACrC,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC"}
@@ -0,0 +1,91 @@
1
+ /**
2
+ * Memory Checkpoint Core (WU-1467, WU-1748)
3
+ *
4
+ * Core logic for creating checkpoint nodes for context snapshots.
5
+ * Used before /clear or session handoff to preserve progress state.
6
+ *
7
+ * Features:
8
+ * - Creates checkpoint nodes with progress summary and next steps
9
+ * - Optional linking to sessions and WUs
10
+ * - Supports handoff trigger detection
11
+ * - Auto-initializes memory layer if not present
12
+ * - WU-1748: Persists to wu-events.jsonl for cross-agent visibility
13
+ *
14
+ * @see {@link tools/mem-checkpoint.mjs} - CLI wrapper
15
+ * @see {@link tools/__tests__/mem-checkpoint.test.mjs} - Tests
16
+ * @see {@link tools/lib/memory-schema.mjs} - Schema definitions
17
+ */
18
+ /**
19
+ * Checkpoint creation options
20
+ */
21
+ export interface CreateCheckpointOptions {
22
+ /** Checkpoint note/description (required) */
23
+ note: string;
24
+ /** Session ID to link checkpoint to */
25
+ sessionId?: string;
26
+ /** Work Unit ID to link checkpoint to */
27
+ wuId?: string;
28
+ /** Progress summary */
29
+ progress?: string;
30
+ /** Next steps description */
31
+ nextSteps?: string;
32
+ /** Handoff trigger (e.g., 'clear', 'handoff') */
33
+ trigger?: string;
34
+ }
35
+ /**
36
+ * Checkpoint metadata stored in the node
37
+ */
38
+ interface CheckpointMetadata {
39
+ progress?: string;
40
+ nextSteps?: string;
41
+ trigger?: string;
42
+ [key: string]: unknown;
43
+ }
44
+ /**
45
+ * Memory node structure for checkpoints
46
+ */
47
+ interface CheckpointNode {
48
+ id: string;
49
+ type: 'checkpoint';
50
+ lifecycle: 'session';
51
+ content: string;
52
+ created_at: string;
53
+ wu_id?: string;
54
+ session_id?: string;
55
+ metadata?: CheckpointMetadata;
56
+ }
57
+ /**
58
+ * Checkpoint creation result
59
+ */
60
+ export interface CreateCheckpointResult {
61
+ /** Whether the operation succeeded */
62
+ success: boolean;
63
+ /** Created checkpoint node */
64
+ checkpoint: CheckpointNode;
65
+ }
66
+ /**
67
+ * Creates a new checkpoint node for context preservation.
68
+ *
69
+ * Creates a checkpoint-type memory node with:
70
+ * - Unique ID (mem-XXXX format)
71
+ * - User-provided note in content
72
+ * - Optional session and WU linking
73
+ * - Progress summary and next steps in metadata
74
+ *
75
+ * @param baseDir - Base directory containing .beacon/memory/
76
+ * @param options - Checkpoint options
77
+ * @returns Result with created checkpoint node
78
+ * @throws If note is missing or WU ID is invalid
79
+ *
80
+ * @example
81
+ * const result = await createCheckpoint(baseDir, {
82
+ * note: 'Before /clear - completed TDD tests',
83
+ * sessionId: 'session-uuid',
84
+ * wuId: 'WU-1467',
85
+ * progress: 'TDD tests passing, core module implemented',
86
+ * nextSteps: 'Implement CLI wrapper, add package.json script',
87
+ * });
88
+ * console.log(result.checkpoint.id); // 'mem-a1b2'
89
+ */
90
+ export declare function createCheckpoint(baseDir: string, options: CreateCheckpointOptions): Promise<CreateCheckpointResult>;
91
+ export {};
@@ -0,0 +1 @@
1
+ {"version":3,"file":"mem-checkpoint-core.d.ts","sourceRoot":"","sources":["../src/mem-checkpoint-core.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAwEH;;;;;;;;;;GAUG;AAEH;;;;;;GAMG;AAEH;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,wBAAsB,gBAAgB,CAAC,OAAO,KAAA,EAAE,OAAO,KAAA;;;;;;;;;GAmFtD"}
@@ -0,0 +1,175 @@
1
+ /**
2
+ * Memory Checkpoint Core (WU-1467, WU-1748)
3
+ *
4
+ * Core logic for creating checkpoint nodes for context snapshots.
5
+ * Used before /clear or session handoff to preserve progress state.
6
+ *
7
+ * Features:
8
+ * - Creates checkpoint nodes with progress summary and next steps
9
+ * - Optional linking to sessions and WUs
10
+ * - Supports handoff trigger detection
11
+ * - Auto-initializes memory layer if not present
12
+ * - WU-1748: Persists to wu-events.jsonl for cross-agent visibility
13
+ *
14
+ * @see {@link tools/mem-checkpoint.mjs} - CLI wrapper
15
+ * @see {@link tools/__tests__/mem-checkpoint.test.mjs} - Tests
16
+ * @see {@link tools/lib/memory-schema.mjs} - Schema definitions
17
+ */
18
+ import fs from 'node:fs/promises';
19
+ import path from 'node:path';
20
+ import { generateMemId } from './mem-id.js';
21
+ import { appendNode } from './memory-store.js';
22
+ import { MEMORY_PATTERNS } from './memory-schema.js';
23
+ import { WUStateStore } from '@lumenflow/core/dist/wu-state-store.js';
24
+ /**
25
+ * Memory directory path relative to base directory
26
+ */
27
+ const MEMORY_DIR = '.beacon/memory';
28
+ /**
29
+ * WU state directory path relative to base directory (WU-1748)
30
+ */
31
+ const STATE_DIR = '.beacon/state';
32
+ /**
33
+ * Error messages for validation
34
+ */
35
+ const ERROR_MESSAGES = {
36
+ NOTE_REQUIRED: 'note is required',
37
+ NOTE_EMPTY: 'note cannot be empty',
38
+ WU_ID_INVALID: 'Invalid WU ID format. Expected pattern: WU-XXX (e.g., WU-123)',
39
+ };
40
+ /**
41
+ * Checkpoint node type constant
42
+ */
43
+ const NODE_TYPE_CHECKPOINT = 'checkpoint';
44
+ /**
45
+ * Checkpoint lifecycle constant (session-scoped for handoff context)
46
+ */
47
+ const LIFECYCLE_SESSION = 'session';
48
+ /**
49
+ * Validates WU ID format if provided
50
+ *
51
+ * @param wuId - WU ID to validate
52
+ * @returns True if valid or not provided
53
+ */
54
+ function isValidWuId(wuId) {
55
+ if (!wuId)
56
+ return true;
57
+ return MEMORY_PATTERNS.WU_ID.test(wuId);
58
+ }
59
+ /**
60
+ * Ensures the memory directory exists
61
+ *
62
+ * @param baseDir - Base directory
63
+ * @returns Memory directory path
64
+ */
65
+ async function ensureMemoryDir(baseDir) {
66
+ const memoryDir = path.join(baseDir, MEMORY_DIR);
67
+ // eslint-disable-next-line security/detect-non-literal-fs-filename -- Known directory path
68
+ await fs.mkdir(memoryDir, { recursive: true });
69
+ return memoryDir;
70
+ }
71
+ /**
72
+ * Generates content description for checkpoint node
73
+ *
74
+ * @param note - User-provided checkpoint note
75
+ * @returns Content description
76
+ */
77
+ function generateCheckpointContent(note) {
78
+ return `Checkpoint: ${note}`;
79
+ }
80
+ /**
81
+ * Creates a new checkpoint node for context preservation.
82
+ *
83
+ * Creates a checkpoint-type memory node with:
84
+ * - Unique ID (mem-XXXX format)
85
+ * - User-provided note in content
86
+ * - Optional session and WU linking
87
+ * - Progress summary and next steps in metadata
88
+ *
89
+ * @param baseDir - Base directory containing .beacon/memory/
90
+ * @param options - Checkpoint options
91
+ * @returns Result with created checkpoint node
92
+ * @throws If note is missing or WU ID is invalid
93
+ *
94
+ * @example
95
+ * const result = await createCheckpoint(baseDir, {
96
+ * note: 'Before /clear - completed TDD tests',
97
+ * sessionId: 'session-uuid',
98
+ * wuId: 'WU-1467',
99
+ * progress: 'TDD tests passing, core module implemented',
100
+ * nextSteps: 'Implement CLI wrapper, add package.json script',
101
+ * });
102
+ * console.log(result.checkpoint.id); // 'mem-a1b2'
103
+ */
104
+ export async function createCheckpoint(baseDir, options) {
105
+ const { note, sessionId, wuId, progress, nextSteps, trigger } = options;
106
+ // Validate required fields
107
+ if (note === undefined || note === null) {
108
+ throw new Error(ERROR_MESSAGES.NOTE_REQUIRED);
109
+ }
110
+ if (note === '') {
111
+ throw new Error(ERROR_MESSAGES.NOTE_EMPTY);
112
+ }
113
+ // Validate WU ID format if provided
114
+ if (wuId && !isValidWuId(wuId)) {
115
+ throw new Error(ERROR_MESSAGES.WU_ID_INVALID);
116
+ }
117
+ // Ensure memory directory exists
118
+ const memoryDir = await ensureMemoryDir(baseDir);
119
+ // Generate checkpoint node
120
+ const timestamp = new Date().toISOString();
121
+ const content = generateCheckpointContent(note);
122
+ // Generate deterministic ID from content + timestamp for uniqueness
123
+ const idContent = `${content}-${timestamp}`;
124
+ const id = generateMemId(idContent);
125
+ // Build metadata object
126
+ const metadata = {};
127
+ if (progress) {
128
+ metadata.progress = progress;
129
+ }
130
+ if (nextSteps) {
131
+ metadata.nextSteps = nextSteps;
132
+ }
133
+ if (trigger) {
134
+ metadata.trigger = trigger;
135
+ }
136
+ const checkpointNode = {
137
+ id,
138
+ type: NODE_TYPE_CHECKPOINT,
139
+ lifecycle: LIFECYCLE_SESSION,
140
+ content,
141
+ created_at: timestamp,
142
+ };
143
+ // Add optional fields
144
+ if (wuId) {
145
+ checkpointNode.wu_id = wuId;
146
+ }
147
+ if (sessionId) {
148
+ checkpointNode.session_id = sessionId;
149
+ }
150
+ if (Object.keys(metadata).length > 0) {
151
+ checkpointNode.metadata = metadata;
152
+ }
153
+ // Persist to memory store
154
+ await appendNode(memoryDir, checkpointNode);
155
+ // WU-1748: Also persist to wu-events.jsonl for cross-agent visibility
156
+ if (wuId) {
157
+ try {
158
+ const stateDir = path.join(baseDir, STATE_DIR);
159
+ const store = new WUStateStore(stateDir);
160
+ await store.checkpoint(wuId, note, {
161
+ sessionId,
162
+ progress,
163
+ nextSteps,
164
+ });
165
+ }
166
+ catch {
167
+ // Non-fatal: if state store write fails, checkpoint is still in memory store
168
+ // This can happen if the WU hasn't been claimed yet
169
+ }
170
+ }
171
+ return {
172
+ success: true,
173
+ checkpoint: checkpointNode,
174
+ };
175
+ }