@x12i/memorix-format 2.2.2 → 2.3.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.
- package/CHANGELOG.md +30 -0
- package/README.md +36 -86
- package/dist/base-reexport.d.ts +8 -0
- package/dist/base-reexport.d.ts.map +1 -0
- package/dist/base-reexport.js +8 -0
- package/dist/base-reexport.js.map +1 -0
- package/dist/cli.js +179 -15
- package/dist/cli.js.map +1 -1
- package/dist/index.d.ts +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/v2/index.d.ts +7 -0
- package/dist/v2/index.d.ts.map +1 -0
- package/dist/v2/index.js +6 -0
- package/dist/v2/index.js.map +1 -0
- package/dist/v2/migrate-present.d.ts +47 -0
- package/dist/v2/migrate-present.d.ts.map +1 -0
- package/dist/v2/migrate-present.js +225 -0
- package/dist/v2/migrate-present.js.map +1 -0
- package/dist/v2/profiles.d.ts +9 -0
- package/dist/v2/profiles.d.ts.map +1 -0
- package/dist/v2/profiles.js +63 -0
- package/dist/v2/profiles.js.map +1 -0
- package/dist/v2/revision.d.ts +24 -0
- package/dist/v2/revision.d.ts.map +1 -0
- package/dist/v2/revision.js +44 -0
- package/dist/v2/revision.js.map +1 -0
- package/dist/v2/types.d.ts +94 -0
- package/dist/v2/types.d.ts.map +1 -0
- package/dist/v2/types.js +3 -0
- package/dist/v2/types.js.map +1 -0
- package/dist/v2/validate.d.ts +8 -0
- package/dist/v2/validate.d.ts.map +1 -0
- package/dist/v2/validate.js +225 -0
- package/dist/v2/validate.js.map +1 -0
- package/docs/association-format.md +26 -445
- package/docs/memorix-format.md +24 -186
- package/docs/memorix-record-v2.md +101 -0
- package/docs/memorix-workflow-format.md +13 -1
- package/docs/migrate-present-to-v2.md +49 -0
- package/examples/v2/activity-events-snapshots.json +31 -0
- package/examples/v2/employees-discovery.json +26 -0
- package/examples/v2/employees-snapshots.json +27 -0
- package/examples/v2/procedures-knowledge.json +27 -0
- package/examples/v2/work-items-analysis.json +26 -0
- package/examples/v2/work-items-context.json +32 -0
- package/examples/v2/work-items-decisions.json +26 -0
- package/examples/v2/work-items-raw.json +37 -0
- package/examples/v2/work-items-relationships-candidate.json +38 -0
- package/examples/v2/work-items-snapshots-lifecycle.json +31 -0
- package/examples/v2/work-items-snapshots-lightweight-refs.json +34 -0
- package/examples/v2/work-items-snapshots.json +28 -0
- package/examples/v2/work-items-workflow.json +28 -0
- package/package.json +7 -2
- package/docs/memorix-format-additions.md +0 -956
- package/docs/memorix-format-for-dummies-association-corrections.md +0 -113
package/docs/memorix-format.md
CHANGED
|
@@ -1,55 +1,50 @@
|
|
|
1
1
|
# Memorix Record Format
|
|
2
2
|
|
|
3
|
-
> **
|
|
4
|
-
>
|
|
5
|
-
>
|
|
6
|
-
>
|
|
3
|
+
> **Canonical SoT for new work:** [memorix-record/2](./memorix-record-v2.md) (`validateMemorixRecordV2`).
|
|
4
|
+
> **Present envelope (migration source):** documented below — still enforced by default in writer/pipeline until `MEMORIX_RECORD_FORMAT=v2`.
|
|
5
|
+
> Core present envelope helpers: [`@x12i/memorix-base-format`](https://www.npmjs.com/package/@x12i/memorix-base-format) (temporary; folding into this package).
|
|
6
|
+
> Requirements: [memorix-format-requirements.md](./memorix-format-requirements.md).
|
|
7
7
|
|
|
8
8
|
## Purpose
|
|
9
9
|
|
|
10
10
|
A Memorix record is a structured memory object: a stable envelope around domain payload, with clear separation between business data, derived analytics, external enrichment, AI insights, and cross-entity references.
|
|
11
11
|
|
|
12
|
-
**
|
|
12
|
+
**Prefer `memorix-record/2` for all new platform paths.** Present envelope remains for reading/migrating existing data.
|
|
13
13
|
|
|
14
14
|
---
|
|
15
15
|
|
|
16
|
-
##
|
|
16
|
+
## Present envelope (migration source)
|
|
17
17
|
|
|
18
18
|
```ts
|
|
19
|
-
type
|
|
20
|
-
_id?: string;
|
|
21
|
-
recordId: string;
|
|
19
|
+
type MemorixRecordPresent = {
|
|
20
|
+
_id?: string;
|
|
21
|
+
recordId: string;
|
|
22
22
|
concept: {
|
|
23
23
|
_extIdentifier: { kind: string; key: string; [kindValue: string]: string };
|
|
24
24
|
title: string;
|
|
25
|
-
// other human/LLM-readable fields allowed
|
|
26
25
|
};
|
|
27
|
-
data: JsonObject;
|
|
28
|
-
|
|
26
|
+
data: JsonObject;
|
|
29
27
|
analytics?: JsonObject;
|
|
30
28
|
enrichment?: JsonObject;
|
|
31
29
|
insights?: JsonObject;
|
|
32
|
-
// associated…?: JsonObject[];
|
|
33
|
-
|
|
30
|
+
// associated…?: JsonObject[]; // copied payloads — removed in V2
|
|
34
31
|
_system?: {
|
|
35
32
|
state?: "active" | "archived" | "superseded";
|
|
36
33
|
lifecycle?: Array<{ process: string; processedAt: string }>;
|
|
37
|
-
// …
|
|
38
34
|
};
|
|
39
35
|
};
|
|
40
36
|
```
|
|
41
37
|
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
Human/LLM readers SHOULD omit root `_…` and `concept._extIdentifier` by default; keep `recordId` for joins.
|
|
38
|
+
Migrate legacy → present: `npx memorix-format migrate`.
|
|
39
|
+
Migrate present → V2: `npx memorix-format migrate-to-v2 --object-type=… --content-type=… --data-category=…`.
|
|
45
40
|
|
|
46
|
-
|
|
41
|
+
Associated properties use the reserved `associated` prefix on **present** records only. See [association-format.md](./association-format.md). V2 rejects copied association roots.
|
|
47
42
|
|
|
48
|
-
|
|
43
|
+
Human/LLM readers SHOULD omit root `_…` and `concept._extIdentifier` by default; keep `recordId` for joins.
|
|
49
44
|
|
|
50
45
|
---
|
|
51
46
|
|
|
52
|
-
## Data And Associated Buckets
|
|
47
|
+
## Data And Associated Buckets (present)
|
|
53
48
|
|
|
54
49
|
Every piece of business data lives in **exactly one** of these buckets (plus the envelope fields above):
|
|
55
50
|
|
|
@@ -58,173 +53,16 @@ Every piece of business data lives in **exactly one** of these buckets (plus the
|
|
|
58
53
|
| **`data`** | Native facts about the subject itself |
|
|
59
54
|
| **`analytics`** | Numeric rollups computed from other records |
|
|
60
55
|
| **`enrichment`** | External / prior-system values as received |
|
|
61
|
-
| **`insights`** |
|
|
62
|
-
| **`
|
|
63
|
-
| **`associatedDiscovery`** | Linked discovery content copied from associated records' `data` payloads |
|
|
64
|
-
| **`associatedAnalysis`** | Linked analysis content copied from associated records' `data` payloads |
|
|
65
|
-
| **`associatedSiblings`** | Self-association: other snapshot `data` payloads sharing the same join key; each item includes linked `recordId`. Default cap: 99 items. |
|
|
66
|
-
| **`associatedChildren`** | Parent-to-child association: child `data` payloads whose join key matches the parent; each item includes linked `recordId`. Default cap: 99 items. |
|
|
67
|
-
|
|
68
|
-
Do not duplicate a value across buckets. When reshaping legacy records, promote `sourceFacts` values into the correct bucket rather than wrapping them.
|
|
69
|
-
|
|
70
|
-
Associated properties are always arrays and are omitted when no linked data was resolved. Do not write empty arrays, and do not switch between object and array shape. Custom associated content uses the same root-level pattern: `associatedCompliance`, `associatedBusinessContext`, and so on.
|
|
71
|
-
|
|
72
|
-
**Ranked top associations** use `associatedTop<ObjectType><ContentType>` (e.g. `associatedTopItemsAnalysis`). Candidates are sorted by the linked object type’s `importanceIndicator` (or rule `rankBy`) and capped (default 5). See [association-format.md](./association-format.md).
|
|
73
|
-
|
|
74
|
-
**Enrichment associations** use `associated<ObjectType>Enrichment` (e.g. `associatedItemGroupsEnrichment`). They copy the linked snapshot’s root `enrichment` bucket as a flat object array — not a separate `*-enrichment` content collection. See [association-format.md](./association-format.md).
|
|
75
|
-
|
|
76
|
-
Associated items contain the linked record's `data` payload (or `enrichment` / `concept` / root property for the specialized forms). Legacy associations may also include inline `recordId` and `contentType`; v2 associations store traceability in optional item-level `_system.association` metadata. Do not wrap associated items with redundant envelope keys; failure and diagnostic details belong in `<objectType>-failed` collections instead.
|
|
77
|
-
|
|
78
|
-
**Associated property metadata:** Consumers should prefer Memorix associated-property metadata when available (`@x12i/memorix-associator`). Associated snapshot properties are exposed through managed descriptors plus discovery. Until metadata is available, or when reading older/custom records, fall back to the prefix rule: root-level fields on snapshots whose names start with `associated`. The well-known names `associatedData`, `associatedDiscovery`, and `associatedAnalysis` are conventions only — the complete set comes from metadata plus the `associated*` fallback rule.
|
|
79
|
-
|
|
80
|
-
When a field can naturally have more than one value, processing contracts use array shape even if the current record has only one value. Join-key recipes (which paths and shapes) are defined on **entity descriptors** for each Catalox object type — not in this format package.
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
## Concept
|
|
85
|
-
|
|
86
|
-
```ts
|
|
87
|
-
type MemorixConcept = {
|
|
88
|
-
_extIdentifier: {
|
|
89
|
-
kind: string;
|
|
90
|
-
/** Primary value — property name matches `kind`. */
|
|
91
|
-
[kind: string]: string;
|
|
92
|
-
/**
|
|
93
|
-
* Deterministic join key: `kind` first, then the kind-named value,
|
|
94
|
-
* then any other scalar fields in sorted key order, joined by `:`.
|
|
95
|
-
*/
|
|
96
|
-
key: string;
|
|
97
|
-
};
|
|
98
|
-
title: string;
|
|
99
|
-
};
|
|
100
|
-
```
|
|
101
|
-
|
|
102
|
-
`_extIdentifier` is a discriminated object: `kind` names the id type, and a same-named property holds the value. `key` is required. How `kind` / title are derived for an object type is defined on the **entity descriptor**, not here.
|
|
103
|
-
|
|
104
|
-
```json
|
|
105
|
-
"concept": {
|
|
106
|
-
"_extIdentifier": {
|
|
107
|
-
"kind": "sku",
|
|
108
|
-
"sku": "SKU-100",
|
|
109
|
-
"key": "sku:SKU-100"
|
|
110
|
-
},
|
|
111
|
-
"title": "Blue widget"
|
|
112
|
-
}
|
|
113
|
-
```
|
|
114
|
-
|
|
115
|
-
`concept.name` is not used. `concept.identifier` / `identifierKey` are legacy — migrate to `_extIdentifier` / `key`. `title` is the human-readable display name; it may differ from the identifier value.
|
|
116
|
-
|
|
117
|
-
### Identifier `kind` (illustrative — not format law)
|
|
118
|
-
|
|
119
|
-
| Object type (abstract) | `kind` | Example |
|
|
120
|
-
|---|---|---|
|
|
121
|
-
| Items | `sku` | `{"kind":"sku","sku":"SKU-100","key":"sku:SKU-100"}` |
|
|
122
|
-
| Groups | `groupCode` | `{"kind":"groupCode","groupCode":"G-42","key":"groupCode:G-42"}` |
|
|
123
|
-
| Locations | `locationCode` | `{"kind":"locationCode","locationCode":"WH-A","key":"locationCode:WH-A"}` |
|
|
124
|
-
| Documents | `docId` | `{"kind":"docId","docId":"DOC-9","key":"docId:DOC-9"}` |
|
|
125
|
-
|
|
126
|
-
Domain packs (Catalox) may use different `kind` values; those recipes live on descriptors.
|
|
127
|
-
|
|
128
|
-
---
|
|
129
|
-
|
|
130
|
-
## `_system`
|
|
131
|
-
|
|
132
|
-
System metadata — provenance, processing history, graph-run stamps — never belongs in `data` or the other business buckets.
|
|
133
|
-
|
|
134
|
-
```ts
|
|
135
|
-
type MemorixLifecycleEvent = { process: string; processedAt: string };
|
|
136
|
-
|
|
137
|
-
type MemorixSystemBlock = {
|
|
138
|
-
state?: "active" | "archived" | "superseded";
|
|
139
|
-
lifecycle?: MemorixLifecycleEvent[];
|
|
140
|
-
_graphRuns?: Record<string, GraphRunEntry>;
|
|
141
|
-
_jobTypeRuns?: Record<string, GraphRunEntry>;
|
|
142
|
-
provenance?: JsonObject;
|
|
143
|
-
// other system keys as needed (memorix, scoping, …)
|
|
144
|
-
};
|
|
145
|
-
```
|
|
146
|
-
|
|
147
|
-
### Lifecycle
|
|
148
|
-
|
|
149
|
-
Root-level `lifecycle` is gone. Processing events live at `_system.lifecycle`:
|
|
150
|
-
|
|
151
|
-
```json
|
|
152
|
-
"lifecycle": [
|
|
153
|
-
{ "process": "enriched", "processedAt": "2026-04-05T08:01:15.511Z" }
|
|
154
|
-
]
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
- Each entry is `{ process, processedAt }`.
|
|
158
|
-
- When `createdAt`, `modifiedAt`, and `capturedAt` are identical (the common snapshot case), emit a single `"enriched"` event rather than three duplicate timestamps.
|
|
159
|
-
- Distinct events (e.g. a future re-enrichment) append as additional array entries.
|
|
160
|
-
- Omit `lifecycle` entirely when no timestamp is known — do not emit an empty array.
|
|
161
|
-
- `_system.state` is the present-tense lifecycle state enum (`active` \| `archived` \| `superseded`).
|
|
162
|
-
|
|
163
|
-
`_system.provenance.enrichedAt` (when present) is separate provenance metadata about a prior enrichment step, not a substitute for `lifecycle`.
|
|
164
|
-
|
|
165
|
-
### Graph and job-type runs
|
|
166
|
-
|
|
167
|
-
`_graphRuns` and `_jobTypeRuns` are stored under `_system`, keyed by graph id and sanitized job-type id respectively. Each entry tracks execution status, timestamps, and result metadata. These fields are written by Memorix writer during graph execution and are not part of the domain payload.
|
|
168
|
-
|
|
169
|
-
Dot-path references: `_system._graphRuns.<graphId>`, `_system._jobTypeRuns.<jobTypeId>`.
|
|
170
|
-
|
|
171
|
-
---
|
|
172
|
-
|
|
173
|
-
## Complete example
|
|
174
|
-
|
|
175
|
-
Abstract item snapshot showing envelope fields and open buckets:
|
|
176
|
-
|
|
177
|
-
```json
|
|
178
|
-
{
|
|
179
|
-
"recordId": "rec-item-1",
|
|
180
|
-
"concept": {
|
|
181
|
-
"_extIdentifier": {
|
|
182
|
-
"kind": "sku",
|
|
183
|
-
"sku": "SKU-100",
|
|
184
|
-
"key": "sku:SKU-100"
|
|
185
|
-
},
|
|
186
|
-
"title": "Blue widget"
|
|
187
|
-
},
|
|
188
|
-
"data": {
|
|
189
|
-
"sku": "SKU-100",
|
|
190
|
-
"color": "blue",
|
|
191
|
-
"family": "widgets"
|
|
192
|
-
},
|
|
193
|
-
"associatedData": [
|
|
194
|
-
{ "locationCode": "WH-A", "qty": 12 },
|
|
195
|
-
{ "locationCode": "WH-B", "qty": 3 }
|
|
196
|
-
],
|
|
197
|
-
"analytics": {
|
|
198
|
-
"linkedLocations": { "total": 2 }
|
|
199
|
-
},
|
|
200
|
-
"enrichment": {
|
|
201
|
-
"catalogScore": 0.91,
|
|
202
|
-
"sourceSystem": "erp-feed"
|
|
203
|
-
},
|
|
204
|
-
"insights": {
|
|
205
|
-
"priority": { "level": "high", "confidence": 0.9 }
|
|
206
|
-
},
|
|
207
|
-
"_system": {
|
|
208
|
-
"state": "active",
|
|
209
|
-
"provenance": {
|
|
210
|
-
"source": {
|
|
211
|
-
"database": "example-db",
|
|
212
|
-
"collection": "items-rawdata"
|
|
213
|
-
}
|
|
214
|
-
},
|
|
215
|
-
"lifecycle": [
|
|
216
|
-
{ "process": "enriched", "processedAt": "2026-04-05T08:01:15.511Z" }
|
|
217
|
-
]
|
|
218
|
-
}
|
|
219
|
-
}
|
|
220
|
-
```
|
|
56
|
+
| **`insights`** | AI / judgment outputs |
|
|
57
|
+
| **`associated*`** | Copied related payloads (present only; removed in V2) |
|
|
221
58
|
|
|
222
|
-
|
|
59
|
+
On **memorix-record/2**, snapshot buckets are optional and **omitted when empty**. Root `associated*` may hold **lightweight refs** only (Option A — still format-valid). **Authoritative relationship storage (Gate G4)** is centralized per-category collections (Candidate C); see `docs/re-factoring-and-ops-agent/RELATIONSHIP-STORAGE-DECISION.md`.
|
|
223
60
|
|
|
224
61
|
---
|
|
225
62
|
|
|
226
|
-
##
|
|
63
|
+
## Further reading
|
|
227
64
|
|
|
228
|
-
-
|
|
229
|
-
-
|
|
230
|
-
-
|
|
65
|
+
- [memorix-record-v2.md](./memorix-record-v2.md) — Gate G2 contract
|
|
66
|
+
- [association-format.md](./association-format.md) — present association naming
|
|
67
|
+
- [memorix-workflow-format.md](./memorix-workflow-format.md) — workflow as sibling content
|
|
68
|
+
- Golden V2 examples: `examples/v2/`
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
# memorix-record/2
|
|
2
|
+
|
|
3
|
+
**Status:** Gate G2 contract — preferred source of truth for new platform work.
|
|
4
|
+
**Package:** `@x12i/memorix-format` (`validateMemorixRecordV2`, `migratePresentToV2`, CLI `validate-v2` / `migrate-to-v2`).
|
|
5
|
+
|
|
6
|
+
Present-tense envelope docs remain in [memorix-format.md](./memorix-format.md) for migration only.
|
|
7
|
+
Migration semantics: [migrate-present-to-v2.md](./migrate-present-to-v2.md).
|
|
8
|
+
|
|
9
|
+
## Envelope
|
|
10
|
+
|
|
11
|
+
```ts
|
|
12
|
+
type MemorixRecordV2 = {
|
|
13
|
+
format: "memorix-record/2";
|
|
14
|
+
recordId: string;
|
|
15
|
+
revision: number; // starts at 1; increments every successful mutation
|
|
16
|
+
objectType: string;
|
|
17
|
+
contentType: string;
|
|
18
|
+
dataCategory: "entity" | "event" | "knowledge";
|
|
19
|
+
concept: {
|
|
20
|
+
title: string;
|
|
21
|
+
identifiers: {
|
|
22
|
+
primary: { kind: string; value: string; issuer?: string; normalizedValue?: string };
|
|
23
|
+
alternates?: Array<...>; // omit when empty
|
|
24
|
+
};
|
|
25
|
+
};
|
|
26
|
+
data: Record<string, unknown>;
|
|
27
|
+
analytics?: Record<string, unknown>; // snapshots (and knowledge) only; omit when unused
|
|
28
|
+
enrichment?: Record<string, unknown>;
|
|
29
|
+
insights?: Record<string, unknown>;
|
|
30
|
+
// Option A — lightweight relationship refs remain FORMAT-VALID (G2).
|
|
31
|
+
// Gate G4 selected authoritative storage = central per-category collections (Candidate C).
|
|
32
|
+
// associatedPeople?: Array<{
|
|
33
|
+
// relationshipDefinitionId: string; // required
|
|
34
|
+
// recordId: string; // required
|
|
35
|
+
// relationshipId?: string; // optional — deterministically derivable
|
|
36
|
+
// }>;
|
|
37
|
+
_system: {
|
|
38
|
+
state: "active" | "archived" | "superseded";
|
|
39
|
+
createdAt: string;
|
|
40
|
+
modifiedAt: string;
|
|
41
|
+
observedAt?: string;
|
|
42
|
+
lifecycle?: Array<{ process: string; processedAt: string }>; // omit when empty
|
|
43
|
+
provenance?: Record<string, unknown>;
|
|
44
|
+
};
|
|
45
|
+
};
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
## Locked decisions (Gate G2)
|
|
49
|
+
|
|
50
|
+
1. **Empty optional snapshot buckets are omitted** — never emit `{}`.
|
|
51
|
+
2. **Workflow is a sibling content record** (`contentType: "workflow"`), not a separate document system.
|
|
52
|
+
3. **Composition** = same `recordId` across content types; not a relationship.
|
|
53
|
+
4. **`_graphRuns` / `_jobTypeRuns` stay off the subject** — operational run ledger owns run history.
|
|
54
|
+
5. **V2 rejects copied related-record payloads.** Root `associated*` may hold **lightweight relationship refs** only: required `relationshipDefinitionId` + `recordId`; optional `relationshipId` (derivable). Without `relationshipDefinitionId` the item is not a relationship. **Option A** (direct-record lightweight `associated*` roots) remains **format-valid** for validation and migration compatibility.
|
|
55
|
+
6. **Authoritative physical relationship storage is Gate G4 Candidate C** — org-prefixed per-category `relationships` collections (`entity` / `event` / `knowledge`). Option A lightweight roots and sibling `relationships` content are **not** the selected authoritative storage model; see `docs/re-factoring-and-ops-agent/RELATIONSHIP-STORAGE-DECISION.md`.
|
|
56
|
+
7. **Present format remains the writer/pipeline default** until cutover (`MEMORIX_RECORD_FORMAT=v2`). All **new** refactor packages and the `ops` harness use V2 exclusively. The env switch is transitional (`DEL-FORMAT-PRESENT-SOT`).
|
|
57
|
+
|
|
58
|
+
## Revision vs lifecycle
|
|
59
|
+
|
|
60
|
+
| Rule | Behavior |
|
|
61
|
+
|---|---|
|
|
62
|
+
| Revision | Increments on every successful mutation |
|
|
63
|
+
| Lifecycle | Appended only for meaningful process/state events |
|
|
64
|
+
| Independence | Revision may change with no lifecycle entry |
|
|
65
|
+
| Concurrency | Stale `expectedRevision` is rejected (`checkExpectedRevision`) |
|
|
66
|
+
|
|
67
|
+
Helpers: `applySuccessfulMutation`, `nextRevision`, `checkExpectedRevision`.
|
|
68
|
+
|
|
69
|
+
## Discriminators
|
|
70
|
+
|
|
71
|
+
- Pure structural V2 validation does not invent discriminator values.
|
|
72
|
+
- Content-type **profiles** (from metadata) may declare `path`, `required`, `defaultValue`, `allowedValues`.
|
|
73
|
+
- Missing + profile default → warning `V2-DISCRIMINATOR-DEFAULT` (writers apply default).
|
|
74
|
+
- Missing + required + no default → error `V2-DISCRIMINATOR`.
|
|
75
|
+
|
|
76
|
+
## Examples
|
|
77
|
+
|
|
78
|
+
See [`examples/v2/`](../examples/v2/) — includes lifecycle, lightweight refs, analysis/decision/discovery, workflow sibling, relationships-candidate sibling.
|
|
79
|
+
|
|
80
|
+
## Migrate
|
|
81
|
+
|
|
82
|
+
```bash
|
|
83
|
+
npx memorix-format migrate-to-v2 ./present.json \
|
|
84
|
+
--object-type=work-items \
|
|
85
|
+
--content-type=snapshots \
|
|
86
|
+
--data-category=entity \
|
|
87
|
+
--issuer=ops-source
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
Output includes `v2`, `extractedRelationships`, and `warnings`.
|
|
91
|
+
|
|
92
|
+
## Writer cutover flag
|
|
93
|
+
|
|
94
|
+
```bash
|
|
95
|
+
MEMORIX_RECORD_FORMAT=v2 # writer uses validateMemorixRecordV2
|
|
96
|
+
# default: present (legacy paths only)
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Folding `@x12i/memorix-base-format`
|
|
100
|
+
|
|
101
|
+
Present base validation still depends on `@x12i/memorix-base-format`. That package becomes a temporary re-export after consumers move to `@x12i/memorix-format` / V2, then is deleted (Phase 0 deletion ledger).
|
|
@@ -1,7 +1,19 @@
|
|
|
1
|
-
# Memorix Workflow Format
|
|
1
|
+
# Memorix Workflow Format
|
|
2
2
|
|
|
3
3
|
## Purpose
|
|
4
4
|
|
|
5
|
+
**Gate G2:** Workflow is a **sibling content record** on `memorix-record/2` with
|
|
6
|
+
`contentType: "workflow"` and the same `recordId` as the subject — not a separate
|
|
7
|
+
document system. See [memorix-record-v2.md](./memorix-record-v2.md) and
|
|
8
|
+
`examples/v2/work-items-workflow.json`.
|
|
9
|
+
|
|
10
|
+
Legacy product shape (`memorix-workflow/1`) below remains for migration until
|
|
11
|
+
workflow-api cutover.
|
|
12
|
+
|
|
13
|
+
---
|
|
14
|
+
|
|
15
|
+
## Legacy: `memorix-workflow/1`
|
|
16
|
+
|
|
5
17
|
Versioned JSON for **product workflow state** attached to a subject object via the
|
|
6
18
|
content type `workflow` (collection `{objectType}-workflow`).
|
|
7
19
|
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# memorix-record/2 — present → V2 migration semantics
|
|
2
|
+
|
|
3
|
+
## Result shape
|
|
4
|
+
|
|
5
|
+
`migratePresentToV2` returns:
|
|
6
|
+
|
|
7
|
+
```ts
|
|
8
|
+
{
|
|
9
|
+
ok: boolean;
|
|
10
|
+
v2: MemorixRecordV2; // clean V2; no copied associated payloads
|
|
11
|
+
extractedRelationships: [...]; // out-of-band; NOT persisted (Gate G4)
|
|
12
|
+
warnings: string[];
|
|
13
|
+
}
|
|
14
|
+
```
|
|
15
|
+
|
|
16
|
+
## Associated* handling
|
|
17
|
+
|
|
18
|
+
| Input | V2 record | extractedRelationships |
|
|
19
|
+
|---|---|---|
|
|
20
|
+
| Item with `recordId` (+ copied fields) | `associated*` removed from V2 | status `mapped` or `pending-metadata-resolution`; `droppedPayloadKeys` lists copied fields |
|
|
21
|
+
| Item without target `recordId` | removed | `quarantined-missing-recordId` |
|
|
22
|
+
| Non-array associated* | removed | warning; skipped |
|
|
23
|
+
|
|
24
|
+
Copied payload is never written onto V2. Resolvable links are never silently discarded.
|
|
25
|
+
|
|
26
|
+
Optional `associatedPropertyMap: { associatedPeople: "people-assigned-to-work-items" }` supplies `relationshipDefinitionId` when known.
|
|
27
|
+
|
|
28
|
+
## Timestamps / identifiers
|
|
29
|
+
|
|
30
|
+
| Situation | Behavior |
|
|
31
|
+
|---|---|
|
|
32
|
+
| `createdAt` missing | default `now`; warning |
|
|
33
|
+
| `modifiedAt` missing | default to `createdAt`/`now`; warning |
|
|
34
|
+
| kind-named value missing | fall back to `value` / key tail / `recordId`; warning |
|
|
35
|
+
| Multiple old identifiers | primary from `_extIdentifier` only; extras not auto-alternates (warning path for future) |
|
|
36
|
+
| Unrecognized roots | dropped with warning |
|
|
37
|
+
| Subject `_graphRuns` etc. | dropped with warning (ops ledger owns run history) |
|
|
38
|
+
|
|
39
|
+
## Success vs failure
|
|
40
|
+
|
|
41
|
+
- Migration **succeeds with warnings** when a V2 envelope is produced (`ok: true`) even if relationships are pending/quarantined.
|
|
42
|
+
- Callers should still run `validateMemorixRecordV2(result.v2)`.
|
|
43
|
+
- Migration does not throw on missing association targets; it quarantines.
|
|
44
|
+
|
|
45
|
+
## Gate G4 boundary
|
|
46
|
+
|
|
47
|
+
**Authoritative physical relationship storage (Gate G4):** centralized org-prefixed per-category `relationships` collections (Candidate C). See `docs/re-factoring-and-ops-agent/RELATIONSHIP-STORAGE-DECISION.md`.
|
|
48
|
+
|
|
49
|
+
`migratePresentToV2` still extracts relationship candidates **out-of-band** and does not persist them onto the V2 record. Option A root `associated*` lightweight refs remain **format-valid** but are **not** the selected authoritative storage model.
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
{
|
|
2
|
+
"format": "memorix-record/2",
|
|
3
|
+
"recordId": "ae-500",
|
|
4
|
+
"revision": 1,
|
|
5
|
+
"objectType": "activity-events",
|
|
6
|
+
"contentType": "snapshots",
|
|
7
|
+
"dataCategory": "event",
|
|
8
|
+
"concept": {
|
|
9
|
+
"title": "status-note on WI-100",
|
|
10
|
+
"identifiers": {
|
|
11
|
+
"primary": {
|
|
12
|
+
"kind": "activityEventId",
|
|
13
|
+
"value": "AE-500",
|
|
14
|
+
"issuer": "ops-source"
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"data": {
|
|
19
|
+
"workItemId": "WI-100",
|
|
20
|
+
"actorId": "E-10",
|
|
21
|
+
"type": "status-note",
|
|
22
|
+
"message": "Draft outline complete",
|
|
23
|
+
"occurredAt": "2026-01-15T14:00:00.000Z"
|
|
24
|
+
},
|
|
25
|
+
"_system": {
|
|
26
|
+
"state": "active",
|
|
27
|
+
"createdAt": "2026-01-15T14:00:00.000Z",
|
|
28
|
+
"modifiedAt": "2026-01-15T14:00:00.000Z",
|
|
29
|
+
"observedAt": "2026-01-15T14:00:00.000Z"
|
|
30
|
+
}
|
|
31
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"format": "memorix-record/2",
|
|
3
|
+
"recordId": "employee-10",
|
|
4
|
+
"revision": 1,
|
|
5
|
+
"objectType": "employees",
|
|
6
|
+
"contentType": "discovery",
|
|
7
|
+
"dataCategory": "entity",
|
|
8
|
+
"concept": {
|
|
9
|
+
"title": "Discovery for employee-10",
|
|
10
|
+
"identifiers": {
|
|
11
|
+
"primary": {
|
|
12
|
+
"kind": "recordId",
|
|
13
|
+
"value": "employee-10"
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"data": {
|
|
18
|
+
"discoveryType": "role-cluster",
|
|
19
|
+
"cluster": "operations"
|
|
20
|
+
},
|
|
21
|
+
"_system": {
|
|
22
|
+
"state": "active",
|
|
23
|
+
"createdAt": "2026-01-15T16:00:00.000Z",
|
|
24
|
+
"modifiedAt": "2026-01-15T16:00:00.000Z"
|
|
25
|
+
}
|
|
26
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
{
|
|
2
|
+
"format": "memorix-record/2",
|
|
3
|
+
"recordId": "employee-10",
|
|
4
|
+
"revision": 1,
|
|
5
|
+
"objectType": "employees",
|
|
6
|
+
"contentType": "snapshots",
|
|
7
|
+
"dataCategory": "entity",
|
|
8
|
+
"concept": {
|
|
9
|
+
"title": "Alex Rivera",
|
|
10
|
+
"identifiers": {
|
|
11
|
+
"primary": {
|
|
12
|
+
"kind": "employeeId",
|
|
13
|
+
"value": "E-10",
|
|
14
|
+
"issuer": "ops-source"
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"data": {
|
|
19
|
+
"role": "operations-lead",
|
|
20
|
+
"email": "alex@fieldstone.example"
|
|
21
|
+
},
|
|
22
|
+
"_system": {
|
|
23
|
+
"state": "active",
|
|
24
|
+
"createdAt": "2026-01-10T10:00:00.000Z",
|
|
25
|
+
"modifiedAt": "2026-01-10T10:00:00.000Z"
|
|
26
|
+
}
|
|
27
|
+
}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
{
|
|
2
|
+
"format": "memorix-record/2",
|
|
3
|
+
"recordId": "proc-1",
|
|
4
|
+
"revision": 1,
|
|
5
|
+
"objectType": "procedures",
|
|
6
|
+
"contentType": "snapshots",
|
|
7
|
+
"dataCategory": "knowledge",
|
|
8
|
+
"concept": {
|
|
9
|
+
"title": "Quarterly review checklist",
|
|
10
|
+
"identifiers": {
|
|
11
|
+
"primary": {
|
|
12
|
+
"kind": "procedureId",
|
|
13
|
+
"value": "PROC-1",
|
|
14
|
+
"issuer": "ops-source"
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
},
|
|
18
|
+
"data": {
|
|
19
|
+
"body": "1. Collect metrics\n2. Draft summary\n3. Review with lead",
|
|
20
|
+
"contentHash": "hash-proc-1-v1"
|
|
21
|
+
},
|
|
22
|
+
"_system": {
|
|
23
|
+
"state": "active",
|
|
24
|
+
"createdAt": "2026-01-01T00:00:00.000Z",
|
|
25
|
+
"modifiedAt": "2026-01-01T00:00:00.000Z"
|
|
26
|
+
}
|
|
27
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"format": "memorix-record/2",
|
|
3
|
+
"recordId": "wi-100",
|
|
4
|
+
"revision": 1,
|
|
5
|
+
"objectType": "work-items",
|
|
6
|
+
"contentType": "analysis",
|
|
7
|
+
"dataCategory": "entity",
|
|
8
|
+
"concept": {
|
|
9
|
+
"title": "Analysis for wi-100",
|
|
10
|
+
"identifiers": {
|
|
11
|
+
"primary": {
|
|
12
|
+
"kind": "recordId",
|
|
13
|
+
"value": "wi-100"
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"data": {
|
|
18
|
+
"analysisType": "delivery-risk",
|
|
19
|
+
"risk": "low"
|
|
20
|
+
},
|
|
21
|
+
"_system": {
|
|
22
|
+
"state": "active",
|
|
23
|
+
"createdAt": "2026-01-15T13:00:00.000Z",
|
|
24
|
+
"modifiedAt": "2026-01-15T13:00:00.000Z"
|
|
25
|
+
}
|
|
26
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
{
|
|
2
|
+
"format": "memorix-record/2",
|
|
3
|
+
"recordId": "wi-100",
|
|
4
|
+
"revision": 1,
|
|
5
|
+
"objectType": "work-items",
|
|
6
|
+
"contentType": "context",
|
|
7
|
+
"dataCategory": "entity",
|
|
8
|
+
"concept": {
|
|
9
|
+
"title": "Context for wi-100",
|
|
10
|
+
"identifiers": {
|
|
11
|
+
"primary": {
|
|
12
|
+
"kind": "recordId",
|
|
13
|
+
"value": "wi-100"
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"data": {
|
|
18
|
+
"workItemId": "WI-100",
|
|
19
|
+
"notes": "Current blockers: waiting on finance figures",
|
|
20
|
+
"temporary": true
|
|
21
|
+
},
|
|
22
|
+
"_system": {
|
|
23
|
+
"state": "active",
|
|
24
|
+
"createdAt": "2026-01-15T15:00:00.000Z",
|
|
25
|
+
"modifiedAt": "2026-01-15T15:00:00.000Z",
|
|
26
|
+
"provenance": {
|
|
27
|
+
"mode": "context",
|
|
28
|
+
"sourceId": "ops-source",
|
|
29
|
+
"ttlPolicy": "work-scoped"
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
{
|
|
2
|
+
"format": "memorix-record/2",
|
|
3
|
+
"recordId": "wi-100",
|
|
4
|
+
"revision": 1,
|
|
5
|
+
"objectType": "work-items",
|
|
6
|
+
"contentType": "decisions",
|
|
7
|
+
"dataCategory": "entity",
|
|
8
|
+
"concept": {
|
|
9
|
+
"title": "Decision for wi-100",
|
|
10
|
+
"identifiers": {
|
|
11
|
+
"primary": {
|
|
12
|
+
"kind": "recordId",
|
|
13
|
+
"value": "wi-100"
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
},
|
|
17
|
+
"data": {
|
|
18
|
+
"decisionType": "priority",
|
|
19
|
+
"decision": "keep-current-priority"
|
|
20
|
+
},
|
|
21
|
+
"_system": {
|
|
22
|
+
"state": "active",
|
|
23
|
+
"createdAt": "2026-01-15T13:30:00.000Z",
|
|
24
|
+
"modifiedAt": "2026-01-15T13:30:00.000Z"
|
|
25
|
+
}
|
|
26
|
+
}
|