@x12i/memorix-format 3.0.3 → 3.0.6

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 (54) hide show
  1. package/CHANGELOG.md +73 -65
  2. package/README.md +78 -78
  3. package/dist/base/concept.d.ts +4 -0
  4. package/dist/base/concept.d.ts.map +1 -1
  5. package/dist/base/concept.js +5 -1
  6. package/dist/base/concept.js.map +1 -1
  7. package/dist/cli.js +36 -36
  8. package/dist/v2/identity.d.ts +19 -0
  9. package/dist/v2/identity.d.ts.map +1 -0
  10. package/dist/v2/identity.js +39 -0
  11. package/dist/v2/identity.js.map +1 -0
  12. package/dist/v2/index.d.ts +2 -1
  13. package/dist/v2/index.d.ts.map +1 -1
  14. package/dist/v2/index.js +1 -0
  15. package/dist/v2/index.js.map +1 -1
  16. package/dist/v2/migrate-present.js +1 -1
  17. package/dist/v2/migrate-present.js.map +1 -1
  18. package/dist/v2/profiles.d.ts +1 -1
  19. package/dist/v2/profiles.d.ts.map +1 -1
  20. package/dist/v2/profiles.js +1 -0
  21. package/dist/v2/profiles.js.map +1 -1
  22. package/dist/v2/types.d.ts +24 -0
  23. package/dist/v2/types.d.ts.map +1 -1
  24. package/dist/v2/validate.d.ts.map +1 -1
  25. package/dist/v2/validate.js +18 -1
  26. package/dist/v2/validate.js.map +1 -1
  27. package/docs/association-format.md +47 -47
  28. package/docs/memorix-format-requirements.md +54 -54
  29. package/docs/memorix-format.md +68 -68
  30. package/docs/memorix-record-v2.md +102 -101
  31. package/docs/memorix-workflow-format.md +126 -126
  32. package/docs/migrate-present-to-v2.md +49 -49
  33. package/examples/invalid-record.json +11 -11
  34. package/examples/v2/activity-events-snapshots.json +31 -31
  35. package/examples/v2/people-discovery.json +26 -26
  36. package/examples/v2/people-snapshots-employee.json +27 -27
  37. package/examples/v2/playbooks-knowledge.json +27 -27
  38. package/examples/v2/work-items-analysis.json +26 -26
  39. package/examples/v2/work-items-context.json +32 -32
  40. package/examples/v2/work-items-decisions.json +26 -26
  41. package/examples/v2/work-items-raw.json +37 -37
  42. package/examples/v2/work-items-relationships-candidate.json +38 -38
  43. package/examples/v2/work-items-snapshots-lifecycle.json +31 -31
  44. package/examples/v2/work-items-snapshots-lightweight-refs.json +34 -34
  45. package/examples/v2/work-items-snapshots.json +28 -28
  46. package/examples/v2/work-items-workflow.json +28 -28
  47. package/examples/valid-snapshot.json +30 -30
  48. package/meta/associated-conventions.json +59 -59
  49. package/meta/content-type-profiles.json +27 -27
  50. package/meta/content-types.json +80 -80
  51. package/meta/envelope.json +104 -104
  52. package/meta/inventory/managed-descriptors.json +78 -78
  53. package/meta/open-buckets.json +24 -24
  54. package/package.json +77 -77
package/examples/v2/people-discovery.json CHANGED
@@ -1,26 +1,26 @@
1
- {
2
- "format": "memorix-record/2",
3
- "recordId": "person-e-10",
4
- "revision": 1,
5
- "objectType": "people",
6
- "contentType": "discovery",
7
- "dataCategory": "entity",
8
- "concept": {
9
- "title": "Discovery for person-e-10",
10
- "identifiers": {
11
- "primary": {
12
- "kind": "recordId",
13
- "value": "person-e-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
- }
1
+ {
2
+ "format": "memorix-record/2",
3
+ "recordId": "person-e-10",
4
+ "revision": 1,
5
+ "objectType": "people",
6
+ "contentType": "discovery",
7
+ "dataCategory": "entity",
8
+ "concept": {
9
+ "title": "Discovery for person-e-10",
10
+ "identifiers": {
11
+ "primary": {
12
+ "kind": "recordId",
13
+ "value": "person-e-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
+ }
package/examples/v2/people-snapshots-employee.json CHANGED
@@ -1,27 +1,27 @@
1
- {
2
- "format": "memorix-record/2",
3
- "recordId": "person-e-10",
4
- "revision": 1,
5
- "objectType": "people",
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": "opx-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
- }
1
+ {
2
+ "format": "memorix-record/2",
3
+ "recordId": "person-e-10",
4
+ "revision": 1,
5
+ "objectType": "people",
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": "opx-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
+ }
package/examples/v2/playbooks-knowledge.json CHANGED
@@ -1,27 +1,27 @@
1
- {
2
- "format": "memorix-record/2",
3
- "recordId": "pb-1",
4
- "revision": 1,
5
- "objectType": "playbooks",
6
- "contentType": "snapshots",
7
- "dataCategory": "knowledge",
8
- "concept": {
9
- "title": "Quarterly review checklist",
10
- "identifiers": {
11
- "primary": {
12
- "kind": "playbookId",
13
- "value": "PB-1",
14
- "issuer": "opx-source"
15
- }
16
- }
17
- },
18
- "data": {
19
- "body": "1. Collect metrics\n2. Draft summary\n3. Review with lead",
20
- "contentHash": "hash-pb-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
- }
1
+ {
2
+ "format": "memorix-record/2",
3
+ "recordId": "pb-1",
4
+ "revision": 1,
5
+ "objectType": "playbooks",
6
+ "contentType": "snapshots",
7
+ "dataCategory": "knowledge",
8
+ "concept": {
9
+ "title": "Quarterly review checklist",
10
+ "identifiers": {
11
+ "primary": {
12
+ "kind": "playbookId",
13
+ "value": "PB-1",
14
+ "issuer": "opx-source"
15
+ }
16
+ }
17
+ },
18
+ "data": {
19
+ "body": "1. Collect metrics\n2. Draft summary\n3. Review with lead",
20
+ "contentHash": "hash-pb-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
+ }
package/examples/v2/work-items-analysis.json CHANGED
@@ -1,26 +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
- }
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
+ }
package/examples/v2/work-items-context.json CHANGED
@@ -1,32 +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": "opx-source",
29
- "ttlPolicy": "work-scoped"
30
- }
31
- }
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": "opx-source",
29
+ "ttlPolicy": "work-scoped"
30
+ }
31
+ }
32
+ }
package/examples/v2/work-items-decisions.json CHANGED
@@ -1,26 +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
- }
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
+ }
package/examples/v2/work-items-raw.json CHANGED
@@ -1,37 +1,37 @@
1
- {
2
- "format": "memorix-record/2",
3
- "recordId": "wi-100",
4
- "revision": 1,
5
- "objectType": "work-items",
6
- "contentType": "raw",
7
- "dataCategory": "entity",
8
- "concept": {
9
- "title": "Prepare quarterly operations review",
10
- "identifiers": {
11
- "primary": {
12
- "kind": "workItemId",
13
- "value": "WI-100",
14
- "issuer": "opx-source"
15
- }
16
- }
17
- },
18
- "data": {
19
- "id": "WI-100",
20
- "title": "Prepare quarterly operations review",
21
- "status": "in-progress",
22
- "priority": "normal",
23
- "assigneeId": "E-10",
24
- "playbookIds": ["PB-1"],
25
- "dependsOnIds": ["WI-90"],
26
- "updatedAt": "2026-01-15T12:00:00.000Z"
27
- },
28
- "_system": {
29
- "state": "active",
30
- "createdAt": "2026-01-15T12:00:00.000Z",
31
- "modifiedAt": "2026-01-15T12:00:00.000Z",
32
- "provenance": {
33
- "sourceId": "opx-source",
34
- "endpoint": "/work-items"
35
- }
36
- }
37
- }
1
+ {
2
+ "format": "memorix-record/2",
3
+ "recordId": "wi-100",
4
+ "revision": 1,
5
+ "objectType": "work-items",
6
+ "contentType": "raw",
7
+ "dataCategory": "entity",
8
+ "concept": {
9
+ "title": "Prepare quarterly operations review",
10
+ "identifiers": {
11
+ "primary": {
12
+ "kind": "workItemId",
13
+ "value": "WI-100",
14
+ "issuer": "opx-source"
15
+ }
16
+ }
17
+ },
18
+ "data": {
19
+ "id": "WI-100",
20
+ "title": "Prepare quarterly operations review",
21
+ "status": "in-progress",
22
+ "priority": "normal",
23
+ "assigneeId": "E-10",
24
+ "playbookIds": ["PB-1"],
25
+ "dependsOnIds": ["WI-90"],
26
+ "updatedAt": "2026-01-15T12:00:00.000Z"
27
+ },
28
+ "_system": {
29
+ "state": "active",
30
+ "createdAt": "2026-01-15T12:00:00.000Z",
31
+ "modifiedAt": "2026-01-15T12:00:00.000Z",
32
+ "provenance": {
33
+ "sourceId": "opx-source",
34
+ "endpoint": "/work-items"
35
+ }
36
+ }
37
+ }
package/examples/v2/work-items-relationships-candidate.json CHANGED
@@ -1,38 +1,38 @@
1
- {
2
- "format": "memorix-record/2",
3
- "recordId": "wi-100",
4
- "revision": 2,
5
- "objectType": "work-items",
6
- "contentType": "relationships",
7
- "dataCategory": "entity",
8
- "concept": {
9
- "title": "Relationships for wi-100",
10
- "identifiers": {
11
- "primary": {
12
- "kind": "recordId",
13
- "value": "wi-100"
14
- }
15
- }
16
- },
17
- "data": {
18
- "associatedPeople": [
19
- {
20
- "relationshipId": "rel-people-assigned-employee-10-wi-100",
21
- "relationshipDefinitionId": "people-assigned-to-work-items",
22
- "recordId": "employee-10"
23
- }
24
- ],
25
- "usedPlaybooks": [
26
- {
27
- "relationshipId": "rel-wi-use-proc-wi-100-pb-1",
28
- "relationshipDefinitionId": "work-items-use-playbooks",
29
- "recordId": "pb-1"
30
- }
31
- ]
32
- },
33
- "_system": {
34
- "state": "active",
35
- "createdAt": "2026-01-15T12:00:00.000Z",
36
- "modifiedAt": "2026-01-15T12:30:00.000Z"
37
- }
38
- }
1
+ {
2
+ "format": "memorix-record/2",
3
+ "recordId": "wi-100",
4
+ "revision": 2,
5
+ "objectType": "work-items",
6
+ "contentType": "relationships",
7
+ "dataCategory": "entity",
8
+ "concept": {
9
+ "title": "Relationships for wi-100",
10
+ "identifiers": {
11
+ "primary": {
12
+ "kind": "recordId",
13
+ "value": "wi-100"
14
+ }
15
+ }
16
+ },
17
+ "data": {
18
+ "associatedPeople": [
19
+ {
20
+ "relationshipId": "rel-people-assigned-employee-10-wi-100",
21
+ "relationshipDefinitionId": "people-assigned-to-work-items",
22
+ "recordId": "employee-10"
23
+ }
24
+ ],
25
+ "usedPlaybooks": [
26
+ {
27
+ "relationshipId": "rel-wi-use-proc-wi-100-pb-1",
28
+ "relationshipDefinitionId": "work-items-use-playbooks",
29
+ "recordId": "pb-1"
30
+ }
31
+ ]
32
+ },
33
+ "_system": {
34
+ "state": "active",
35
+ "createdAt": "2026-01-15T12:00:00.000Z",
36
+ "modifiedAt": "2026-01-15T12:30:00.000Z"
37
+ }
38
+ }
package/examples/v2/work-items-snapshots-lifecycle.json CHANGED
@@ -1,31 +1,31 @@
1
- {
2
- "format": "memorix-record/2",
3
- "recordId": "wi-100",
4
- "revision": 5,
5
- "objectType": "work-items",
6
- "contentType": "snapshots",
7
- "dataCategory": "entity",
8
- "concept": {
9
- "title": "Prepare quarterly operations review",
10
- "identifiers": {
11
- "primary": {
12
- "kind": "workItemId",
13
- "value": "WI-100",
14
- "issuer": "opx-source"
15
- }
16
- }
17
- },
18
- "data": {
19
- "status": "done",
20
- "priority": "normal"
21
- },
22
- "_system": {
23
- "state": "active",
24
- "createdAt": "2026-01-10T10:00:00.000Z",
25
- "modifiedAt": "2026-01-20T09:00:00.000Z",
26
- "lifecycle": [
27
- { "process": "created", "processedAt": "2026-01-10T10:00:00.000Z" },
28
- { "process": "completed", "processedAt": "2026-01-20T09:00:00.000Z" }
29
- ]
30
- }
31
- }
1
+ {
2
+ "format": "memorix-record/2",
3
+ "recordId": "wi-100",
4
+ "revision": 5,
5
+ "objectType": "work-items",
6
+ "contentType": "snapshots",
7
+ "dataCategory": "entity",
8
+ "concept": {
9
+ "title": "Prepare quarterly operations review",
10
+ "identifiers": {
11
+ "primary": {
12
+ "kind": "workItemId",
13
+ "value": "WI-100",
14
+ "issuer": "opx-source"
15
+ }
16
+ }
17
+ },
18
+ "data": {
19
+ "status": "done",
20
+ "priority": "normal"
21
+ },
22
+ "_system": {
23
+ "state": "active",
24
+ "createdAt": "2026-01-10T10:00:00.000Z",
25
+ "modifiedAt": "2026-01-20T09:00:00.000Z",
26
+ "lifecycle": [
27
+ { "process": "created", "processedAt": "2026-01-10T10:00:00.000Z" },
28
+ { "process": "completed", "processedAt": "2026-01-20T09:00:00.000Z" }
29
+ ]
30
+ }
31
+ }
package/examples/v2/work-items-snapshots-lightweight-refs.json CHANGED
@@ -1,34 +1,34 @@
1
- {
2
- "format": "memorix-record/2",
3
- "recordId": "wi-100",
4
- "revision": 2,
5
- "objectType": "work-items",
6
- "contentType": "snapshots",
7
- "dataCategory": "entity",
8
- "concept": {
9
- "title": "Prepare quarterly operations review",
10
- "identifiers": {
11
- "primary": {
12
- "kind": "workItemId",
13
- "value": "WI-100",
14
- "issuer": "opx-source"
15
- }
16
- }
17
- },
18
- "data": {
19
- "status": "in-progress",
20
- "priority": "normal"
21
- },
22
- "associatedPeople": [
23
- {
24
- "relationshipDefinitionId": "people-assigned-to-work-items",
25
- "recordId": "employee-10",
26
- "relationshipId": "rel-people-assigned-employee-10-wi-100"
27
- }
28
- ],
29
- "_system": {
30
- "state": "active",
31
- "createdAt": "2026-01-10T10:00:00.000Z",
32
- "modifiedAt": "2026-01-15T12:30:00.000Z"
33
- }
34
- }
1
+ {
2
+ "format": "memorix-record/2",
3
+ "recordId": "wi-100",
4
+ "revision": 2,
5
+ "objectType": "work-items",
6
+ "contentType": "snapshots",
7
+ "dataCategory": "entity",
8
+ "concept": {
9
+ "title": "Prepare quarterly operations review",
10
+ "identifiers": {
11
+ "primary": {
12
+ "kind": "workItemId",
13
+ "value": "WI-100",
14
+ "issuer": "opx-source"
15
+ }
16
+ }
17
+ },
18
+ "data": {
19
+ "status": "in-progress",
20
+ "priority": "normal"
21
+ },
22
+ "associatedPeople": [
23
+ {
24
+ "relationshipDefinitionId": "people-assigned-to-work-items",
25
+ "recordId": "employee-10",
26
+ "relationshipId": "rel-people-assigned-employee-10-wi-100"
27
+ }
28
+ ],
29
+ "_system": {
30
+ "state": "active",
31
+ "createdAt": "2026-01-10T10:00:00.000Z",
32
+ "modifiedAt": "2026-01-15T12:30:00.000Z"
33
+ }
34
+ }