@x12i/memorix-format 3.0.3 → 3.0.4

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 (43) hide show
  1. package/CHANGELOG.md +65 -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 +1 -0
  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/docs/association-format.md +47 -47
  17. package/docs/memorix-format-requirements.md +54 -54
  18. package/docs/memorix-format.md +68 -68
  19. package/docs/memorix-record-v2.md +102 -101
  20. package/docs/memorix-workflow-format.md +126 -126
  21. package/docs/migrate-present-to-v2.md +49 -49
  22. package/examples/invalid-record.json +11 -11
  23. package/examples/v2/activity-events-snapshots.json +31 -31
  24. package/examples/v2/people-discovery.json +26 -26
  25. package/examples/v2/people-snapshots-employee.json +27 -27
  26. package/examples/v2/playbooks-knowledge.json +27 -27
  27. package/examples/v2/work-items-analysis.json +26 -26
  28. package/examples/v2/work-items-context.json +32 -32
  29. package/examples/v2/work-items-decisions.json +26 -26
  30. package/examples/v2/work-items-raw.json +37 -37
  31. package/examples/v2/work-items-relationships-candidate.json +38 -38
  32. package/examples/v2/work-items-snapshots-lifecycle.json +31 -31
  33. package/examples/v2/work-items-snapshots-lightweight-refs.json +34 -34
  34. package/examples/v2/work-items-snapshots.json +28 -28
  35. package/examples/v2/work-items-workflow.json +28 -28
  36. package/examples/valid-snapshot.json +30 -30
  37. package/meta/associated-conventions.json +59 -59
  38. package/meta/content-type-profiles.json +27 -27
  39. package/meta/content-types.json +80 -80
  40. package/meta/envelope.json +104 -104
  41. package/meta/inventory/managed-descriptors.json +78 -78
  42. package/meta/open-buckets.json +24 -24
  43. package/package.json +77 -77
@@ -1,59 +1,59 @@
1
- {
2
- "$schemaNote": "Associated* naming conventions + legacy short names. No objectType bindings.",
3
- "version": "2.1.0",
4
- "prefix": "associated",
5
- "defaultTopMaxItems": 5,
6
- "legacyNames": [
7
- "associatedData",
8
- "associatedDiscovery",
9
- "associatedAnalysis",
10
- "associatedSiblings",
11
- "associatedChildren",
12
- "associatedAssets",
13
- "associatedSubnets"
14
- ],
15
- "namingForms": [
16
- {
17
- "form": "content",
18
- "pattern": "associated[Top?]<ObjectType><ContentType>",
19
- "kind": "linked-payloads",
20
- "shape": "array-of-objects"
21
- },
22
- {
23
- "form": "enrichment",
24
- "pattern": "associated[Top?]<ObjectType>Enrichment",
25
- "kind": "linked-payloads",
26
- "shape": "array-of-objects"
27
- },
28
- {
29
- "form": "snapshotsRootProperty",
30
- "pattern": "associated[Top?]<ObjectType>Snapshots<RootProperty>",
31
- "kind": "linked-payloads",
32
- "shape": "array-of-objects"
33
- },
34
- {
35
- "form": "concepts",
36
- "pattern": "associated[Top?]<ObjectType>Concepts",
37
- "kind": "linked-payloads",
38
- "shape": "array-of-objects"
39
- },
40
- {
41
- "form": "recordIds",
42
- "pattern": "associated[Top?]<ObjectType>RecordIds",
43
- "kind": "linked-payloads",
44
- "shape": "array-of-objects"
45
- },
46
- {
47
- "form": "customDomain",
48
- "pattern": "associated<CustomName>",
49
- "kind": "linked-payloads",
50
- "shape": "array-of-objects",
51
- "examples": ["associatedTopology", "associatedCompliance"]
52
- }
53
- ],
54
- "rules": {
55
- "ASSOC-2": "when present MUST be an array",
56
- "ASSOC-3": "MUST be omitted when empty — never []",
57
- "ASSOC-6": "resolution MUST be snapshot-first (match *-snapshots, then content by recordId)"
58
- }
59
- }
1
+ {
2
+ "$schemaNote": "Associated* naming conventions + legacy short names. No objectType bindings.",
3
+ "version": "2.1.0",
4
+ "prefix": "associated",
5
+ "defaultTopMaxItems": 5,
6
+ "legacyNames": [
7
+ "associatedData",
8
+ "associatedDiscovery",
9
+ "associatedAnalysis",
10
+ "associatedSiblings",
11
+ "associatedChildren",
12
+ "associatedAssets",
13
+ "associatedSubnets"
14
+ ],
15
+ "namingForms": [
16
+ {
17
+ "form": "content",
18
+ "pattern": "associated[Top?]<ObjectType><ContentType>",
19
+ "kind": "linked-payloads",
20
+ "shape": "array-of-objects"
21
+ },
22
+ {
23
+ "form": "enrichment",
24
+ "pattern": "associated[Top?]<ObjectType>Enrichment",
25
+ "kind": "linked-payloads",
26
+ "shape": "array-of-objects"
27
+ },
28
+ {
29
+ "form": "snapshotsRootProperty",
30
+ "pattern": "associated[Top?]<ObjectType>Snapshots<RootProperty>",
31
+ "kind": "linked-payloads",
32
+ "shape": "array-of-objects"
33
+ },
34
+ {
35
+ "form": "concepts",
36
+ "pattern": "associated[Top?]<ObjectType>Concepts",
37
+ "kind": "linked-payloads",
38
+ "shape": "array-of-objects"
39
+ },
40
+ {
41
+ "form": "recordIds",
42
+ "pattern": "associated[Top?]<ObjectType>RecordIds",
43
+ "kind": "linked-payloads",
44
+ "shape": "array-of-objects"
45
+ },
46
+ {
47
+ "form": "customDomain",
48
+ "pattern": "associated<CustomName>",
49
+ "kind": "linked-payloads",
50
+ "shape": "array-of-objects",
51
+ "examples": ["associatedTopology", "associatedCompliance"]
52
+ }
53
+ ],
54
+ "rules": {
55
+ "ASSOC-2": "when present MUST be an array",
56
+ "ASSOC-3": "MUST be omitted when empty — never []",
57
+ "ASSOC-6": "resolution MUST be snapshot-first (match *-snapshots, then content by recordId)"
58
+ }
59
+ }
@@ -1,27 +1,27 @@
1
- {
2
- "$schemaNote": "Content-type profiles (policies). objectType is filled by the caller — never hardcoded here.",
3
- "version": "2.1.0",
4
- "profiles": {
5
- "snapshots": {
6
- "contentType": "snapshots",
7
- "collectionPostfix": "snapshots",
8
- "openBucketsRef": "open-buckets.json",
9
- "policy": {
10
- "unknownOpenBuckets": "allow",
11
- "emptyBuckets": "reject"
12
- },
13
- "read": {
14
- "missingOptionalIsNa": true
15
- }
16
- },
17
- "minimal": {
18
- "policy": {
19
- "unknownOpenBuckets": "warn",
20
- "emptyBuckets": "reject"
21
- },
22
- "read": {
23
- "missingOptionalIsNa": true
24
- }
25
- }
26
- }
27
- }
1
+ {
2
+ "$schemaNote": "Content-type profiles (policies). objectType is filled by the caller — never hardcoded here.",
3
+ "version": "2.1.0",
4
+ "profiles": {
5
+ "snapshots": {
6
+ "contentType": "snapshots",
7
+ "collectionPostfix": "snapshots",
8
+ "openBucketsRef": "open-buckets.json",
9
+ "policy": {
10
+ "unknownOpenBuckets": "allow",
11
+ "emptyBuckets": "reject"
12
+ },
13
+ "read": {
14
+ "missingOptionalIsNa": true
15
+ }
16
+ },
17
+ "minimal": {
18
+ "policy": {
19
+ "unknownOpenBuckets": "warn",
20
+ "emptyBuckets": "reject"
21
+ },
22
+ "read": {
23
+ "missingOptionalIsNa": true
24
+ }
25
+ }
26
+ }
27
+ }
@@ -1,80 +1,80 @@
1
- {
2
- "$schemaNote": "Content-type vocabulary used by Memorix. Not object types. Aligned with managed Catalox entity descriptors + product vocabulary.",
3
- "version": "2.1.0",
4
- "canonicalContentType": "snapshots",
5
- "contentTypes": {
6
- "snapshots": {
7
- "profile": "snapshots",
8
- "description": "Full readable object view — may carry known open buckets and associated*"
9
- },
10
- "discovery": {
11
- "profile": "minimal",
12
- "description": "Discovery / Q&A style content"
13
- },
14
- "analysis": {
15
- "profile": "minimal",
16
- "description": "Analysis content"
17
- },
18
- "decisions": {
19
- "profile": "minimal",
20
- "description": "Decision content",
21
- "collectionPostfixVariants": ["decision", "decisions"]
22
- },
23
- "scoped": {
24
- "profile": "minimal",
25
- "description": "Scoped slice"
26
- },
27
- "legacy": {
28
- "profile": "minimal",
29
- "description": "Quarantined / legacy slice"
30
- },
31
- "narratives": {
32
- "profile": "minimal",
33
- "description": "Narrative records"
34
- },
35
- "narrative-steps": {
36
- "profile": "minimal",
37
- "description": "Narrative step records"
38
- },
39
- "workflow": {
40
- "profile": "workflow",
41
- "description": "Product workflow overlay (memorix-workflow/1) — not the snapshot envelope"
42
- },
43
- "extrated": {
44
- "profile": "minimal",
45
- "description": "Extracted document content (managed key spelling as in Catalox descriptors)"
46
- },
47
- "chunks": {
48
- "profile": "minimal",
49
- "description": "Document chunks"
50
- },
51
- "ai-processing": {
52
- "profile": "minimal",
53
- "description": "Product vocabulary — optional CT"
54
- },
55
- "context": {
56
- "profile": "minimal",
57
- "description": "Product vocabulary — optional CT"
58
- },
59
- "suggested-plans": {
60
- "profile": "minimal",
61
- "description": "Product vocabulary — optional CT"
62
- },
63
- "suggested-actions": {
64
- "profile": "minimal",
65
- "description": "Product vocabulary — optional CT"
66
- },
67
- "knowx": {
68
- "profile": "minimal",
69
- "description": "Native KnowX knowledge facet — data.kind NODE|EDGE; provenance (docHash + SourceSpan) mandatory; epistemic.state ≠ extraction confidence"
70
- },
71
- "nexum": {
72
- "profile": "minimal",
73
- "description": "Nexum contribution / node / claim records (write-record mode nexum)"
74
- },
75
- "confirmations": {
76
- "profile": "minimal",
77
- "description": "Accept/reject decision sibling for reviewed claims (e.g. KnowX assertions)"
78
- }
79
- }
80
- }
1
+ {
2
+ "$schemaNote": "Content-type vocabulary used by Memorix. Not object types. Aligned with managed Catalox entity descriptors + product vocabulary.",
3
+ "version": "2.1.0",
4
+ "canonicalContentType": "snapshots",
5
+ "contentTypes": {
6
+ "snapshots": {
7
+ "profile": "snapshots",
8
+ "description": "Full readable object view — may carry known open buckets and associated*"
9
+ },
10
+ "discovery": {
11
+ "profile": "minimal",
12
+ "description": "Discovery / Q&A style content"
13
+ },
14
+ "analysis": {
15
+ "profile": "minimal",
16
+ "description": "Analysis content"
17
+ },
18
+ "decisions": {
19
+ "profile": "minimal",
20
+ "description": "Decision content",
21
+ "collectionPostfixVariants": ["decision", "decisions"]
22
+ },
23
+ "scoped": {
24
+ "profile": "minimal",
25
+ "description": "Scoped slice"
26
+ },
27
+ "legacy": {
28
+ "profile": "minimal",
29
+ "description": "Quarantined / legacy slice"
30
+ },
31
+ "narratives": {
32
+ "profile": "minimal",
33
+ "description": "Narrative records"
34
+ },
35
+ "narrative-steps": {
36
+ "profile": "minimal",
37
+ "description": "Narrative step records"
38
+ },
39
+ "workflow": {
40
+ "profile": "workflow",
41
+ "description": "Product workflow overlay (memorix-workflow/1) — not the snapshot envelope"
42
+ },
43
+ "extrated": {
44
+ "profile": "minimal",
45
+ "description": "Extracted document content (managed key spelling as in Catalox descriptors)"
46
+ },
47
+ "chunks": {
48
+ "profile": "minimal",
49
+ "description": "Document chunks"
50
+ },
51
+ "ai-processing": {
52
+ "profile": "minimal",
53
+ "description": "Product vocabulary — optional CT"
54
+ },
55
+ "context": {
56
+ "profile": "minimal",
57
+ "description": "Product vocabulary — optional CT"
58
+ },
59
+ "suggested-plans": {
60
+ "profile": "minimal",
61
+ "description": "Product vocabulary — optional CT"
62
+ },
63
+ "suggested-actions": {
64
+ "profile": "minimal",
65
+ "description": "Product vocabulary — optional CT"
66
+ },
67
+ "knowx": {
68
+ "profile": "minimal",
69
+ "description": "Native KnowX knowledge facet — data.kind NODE|EDGE; provenance (docHash + SourceSpan) mandatory; epistemic.state ≠ extraction confidence"
70
+ },
71
+ "nexum": {
72
+ "profile": "minimal",
73
+ "description": "Nexum contribution / node / claim records (write-record mode nexum)"
74
+ },
75
+ "confirmations": {
76
+ "profile": "minimal",
77
+ "description": "Accept/reject decision sibling for reviewed claims (e.g. KnowX assertions)"
78
+ }
79
+ }
80
+ }
@@ -1,104 +1,104 @@
1
- {
2
- "$schemaNote": "Base Memorix envelope meta-metadata (present tense only). No domain object types. Source of truth for @x12i/memorix-format present base envelope.",
3
- "version": "1.2.0",
4
- "categories": {
5
- "identity": {
6
- "keys": [
7
- "recordId",
8
- "concept"
9
- ],
10
- "required": true,
11
- "description": "Join and display identity \u2014 fixed names. recordId is join plumbing (not human/LLM content). concept is human/LLM-facing except nested _extIdentifier."
12
- },
13
- "core": {
14
- "keys": [
15
- "data"
16
- ],
17
- "required": true,
18
- "description": "Native facts about this entity \u2014 fixed name"
19
- },
20
- "underscore": {
21
- "keyPrefix": "_",
22
- "wellKnown": [
23
- "_id",
24
- "_system"
25
- ],
26
- "description": "Machine-only roots. Any _-prefixed root is omitted by default for humans/LLMs."
27
- },
28
- "open": {
29
- "description": "Any other top-level key \u2014 names not reserved by base"
30
- }
31
- },
32
- "concept": {
33
- "requiredFields": [
34
- "_extIdentifier",
35
- "title"
36
- ],
37
- "extIdentifier": {
38
- "path": "concept._extIdentifier",
39
- "description": "External machine join key. Nested _ means omitted from human/LLM projection of concept.",
40
- "requiredFields": [
41
- "kind",
42
- "key"
43
- ],
44
- "rules": [
45
- "kind must be a non-empty string",
46
- "a same-named property must hold the identifier value when used for key construction",
47
- "key is kind, then kind-value, then other scalar fields sorted, joined by :",
48
- "how key and title are derived for a given object type is defined on the object-type descriptor, not in this envelope"
49
- ],
50
- "forbiddenFields": [
51
- "name",
52
- "identifierKey"
53
- ]
54
- },
55
- "forbiddenFields": [
56
- "name",
57
- "identifier"
58
- ],
59
- "otherKeys": {
60
- "description": "Additional concept keys (non-_ prefixed) are allowed when important and human/LLM readable"
61
- }
62
- },
63
- "underscoreBlock": {
64
- "allowUnderscoreKeys": true,
65
- "state": {
66
- "path": "_system.state",
67
- "enum": [
68
- "active",
69
- "archived",
70
- "superseded"
71
- ],
72
- "default": "active",
73
- "description": "Which document among same-recordId siblings is live vs not"
74
- },
75
- "lifecycle": {
76
- "path": "_system.lifecycle",
77
- "shape": "array-of-events",
78
- "omitIfEmpty": true
79
- },
80
- "wellKnownSystemPaths": [
81
- "_system.state",
82
- "_system.lifecycle",
83
- "_system.timestamps",
84
- "_system.provenance",
85
- "_system._graphRuns",
86
- "_system._jobTypeRuns",
87
- "_system.memorix",
88
- "_system.processing",
89
- "_system.narratives",
90
- "_system.quarantine"
91
- ]
92
- },
93
- "openBucketKinds": [
94
- "rollup",
95
- "sourced",
96
- "interpretive",
97
- "linked-payloads",
98
- "custom"
99
- ],
100
- "defaults": {
101
- "unknownOpenBuckets": "allow",
102
- "emptyBuckets": "reject"
103
- }
104
- }
1
+ {
2
+ "$schemaNote": "Base Memorix envelope meta-metadata (present tense only). No domain object types. Source of truth for @x12i/memorix-format present base envelope.",
3
+ "version": "1.2.0",
4
+ "categories": {
5
+ "identity": {
6
+ "keys": [
7
+ "recordId",
8
+ "concept"
9
+ ],
10
+ "required": true,
11
+ "description": "Join and display identity \u2014 fixed names. recordId is join plumbing (not human/LLM content). concept is human/LLM-facing except nested _extIdentifier."
12
+ },
13
+ "core": {
14
+ "keys": [
15
+ "data"
16
+ ],
17
+ "required": true,
18
+ "description": "Native facts about this entity \u2014 fixed name"
19
+ },
20
+ "underscore": {
21
+ "keyPrefix": "_",
22
+ "wellKnown": [
23
+ "_id",
24
+ "_system"
25
+ ],
26
+ "description": "Machine-only roots. Any _-prefixed root is omitted by default for humans/LLMs."
27
+ },
28
+ "open": {
29
+ "description": "Any other top-level key \u2014 names not reserved by base"
30
+ }
31
+ },
32
+ "concept": {
33
+ "requiredFields": [
34
+ "_extIdentifier",
35
+ "title"
36
+ ],
37
+ "extIdentifier": {
38
+ "path": "concept._extIdentifier",
39
+ "description": "External machine join key. Nested _ means omitted from human/LLM projection of concept.",
40
+ "requiredFields": [
41
+ "kind",
42
+ "key"
43
+ ],
44
+ "rules": [
45
+ "kind must be a non-empty string",
46
+ "a same-named property must hold the identifier value when used for key construction",
47
+ "key is kind, then kind-value, then other scalar fields sorted, joined by :",
48
+ "how key and title are derived for a given object type is defined on the object-type descriptor, not in this envelope"
49
+ ],
50
+ "forbiddenFields": [
51
+ "name",
52
+ "identifierKey"
53
+ ]
54
+ },
55
+ "forbiddenFields": [
56
+ "name",
57
+ "identifier"
58
+ ],
59
+ "otherKeys": {
60
+ "description": "Additional concept keys (non-_ prefixed) are allowed when important and human/LLM readable"
61
+ }
62
+ },
63
+ "underscoreBlock": {
64
+ "allowUnderscoreKeys": true,
65
+ "state": {
66
+ "path": "_system.state",
67
+ "enum": [
68
+ "active",
69
+ "archived",
70
+ "superseded"
71
+ ],
72
+ "default": "active",
73
+ "description": "Which document among same-recordId siblings is live vs not"
74
+ },
75
+ "lifecycle": {
76
+ "path": "_system.lifecycle",
77
+ "shape": "array-of-events",
78
+ "omitIfEmpty": true
79
+ },
80
+ "wellKnownSystemPaths": [
81
+ "_system.state",
82
+ "_system.lifecycle",
83
+ "_system.timestamps",
84
+ "_system.provenance",
85
+ "_system._graphRuns",
86
+ "_system._jobTypeRuns",
87
+ "_system.memorix",
88
+ "_system.processing",
89
+ "_system.narratives",
90
+ "_system.quarantine"
91
+ ]
92
+ },
93
+ "openBucketKinds": [
94
+ "rollup",
95
+ "sourced",
96
+ "interpretive",
97
+ "linked-payloads",
98
+ "custom"
99
+ ],
100
+ "defaults": {
101
+ "unknownOpenBuckets": "allow",
102
+ "emptyBuckets": "reject"
103
+ }
104
+ }