@x12i/memorix-format 2.2.3 → 2.3.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. package/CHANGELOG.md +26 -0
  2. package/README.md +36 -86
  3. package/dist/associated.d.ts +2 -2
  4. package/dist/associated.d.ts.map +1 -1
  5. package/dist/associated.js +1 -1
  6. package/dist/base/classify.d.ts +6 -0
  7. package/dist/base/classify.d.ts.map +1 -0
  8. package/dist/base/classify.js +18 -0
  9. package/dist/base/classify.js.map +1 -0
  10. package/dist/base/compat/legacy-roots.d.ts +24 -0
  11. package/dist/base/compat/legacy-roots.d.ts.map +1 -0
  12. package/dist/base/compat/legacy-roots.js +50 -0
  13. package/dist/base/compat/legacy-roots.js.map +1 -0
  14. package/dist/base/concept.d.ts +21 -0
  15. package/dist/base/concept.d.ts.map +1 -0
  16. package/dist/base/concept.js +87 -0
  17. package/dist/base/concept.js.map +1 -0
  18. package/dist/base/constants.d.ts +18 -0
  19. package/dist/base/constants.d.ts.map +1 -0
  20. package/dist/base/constants.js +21 -0
  21. package/dist/base/constants.js.map +1 -0
  22. package/dist/base/index.d.ts +13 -0
  23. package/dist/base/index.d.ts.map +1 -0
  24. package/dist/base/index.js +11 -0
  25. package/dist/base/index.js.map +1 -0
  26. package/dist/base/inspect.d.ts +3 -0
  27. package/dist/base/inspect.d.ts.map +1 -0
  28. package/dist/base/inspect.js +41 -0
  29. package/dist/base/inspect.js.map +1 -0
  30. package/dist/base/load-meta.d.ts +61 -0
  31. package/dist/base/load-meta.d.ts.map +1 -0
  32. package/dist/base/load-meta.js +45 -0
  33. package/dist/base/load-meta.js.map +1 -0
  34. package/dist/base/meta.d.ts +8 -0
  35. package/dist/base/meta.d.ts.map +1 -0
  36. package/dist/base/meta.js +79 -0
  37. package/dist/base/meta.js.map +1 -0
  38. package/dist/base/types.d.ts +112 -0
  39. package/dist/base/types.d.ts.map +1 -0
  40. package/dist/base/types.js +2 -0
  41. package/dist/base/types.js.map +1 -0
  42. package/dist/base/utils.d.ts +4 -0
  43. package/dist/base/utils.d.ts.map +1 -0
  44. package/dist/base/utils.js +15 -0
  45. package/dist/base/utils.js.map +1 -0
  46. package/dist/base/validate.d.ts +13 -0
  47. package/dist/base/validate.d.ts.map +1 -0
  48. package/dist/base/validate.js +253 -0
  49. package/dist/base/validate.js.map +1 -0
  50. package/dist/cli.js +180 -16
  51. package/dist/cli.js.map +1 -1
  52. package/dist/index.d.ts +5 -2
  53. package/dist/index.d.ts.map +1 -1
  54. package/dist/index.js +5 -3
  55. package/dist/index.js.map +1 -1
  56. package/dist/load-meta.d.ts +1 -1
  57. package/dist/load-meta.d.ts.map +1 -1
  58. package/dist/migrate.d.ts +1 -1
  59. package/dist/migrate.d.ts.map +1 -1
  60. package/dist/migrate.js +1 -1
  61. package/dist/migrate.js.map +1 -1
  62. package/dist/profiles.d.ts +1 -1
  63. package/dist/profiles.d.ts.map +1 -1
  64. package/dist/types.d.ts +3 -3
  65. package/dist/types.d.ts.map +1 -1
  66. package/dist/types.js +1 -1
  67. package/dist/types.js.map +1 -1
  68. package/dist/v2/index.d.ts +7 -0
  69. package/dist/v2/index.d.ts.map +1 -0
  70. package/dist/v2/index.js +6 -0
  71. package/dist/v2/index.js.map +1 -0
  72. package/dist/v2/migrate-present.d.ts +47 -0
  73. package/dist/v2/migrate-present.d.ts.map +1 -0
  74. package/dist/v2/migrate-present.js +225 -0
  75. package/dist/v2/migrate-present.js.map +1 -0
  76. package/dist/v2/profiles.d.ts +9 -0
  77. package/dist/v2/profiles.d.ts.map +1 -0
  78. package/dist/v2/profiles.js +63 -0
  79. package/dist/v2/profiles.js.map +1 -0
  80. package/dist/v2/revision.d.ts +24 -0
  81. package/dist/v2/revision.d.ts.map +1 -0
  82. package/dist/v2/revision.js +44 -0
  83. package/dist/v2/revision.js.map +1 -0
  84. package/dist/v2/types.d.ts +94 -0
  85. package/dist/v2/types.d.ts.map +1 -0
  86. package/dist/v2/types.js +3 -0
  87. package/dist/v2/types.js.map +1 -0
  88. package/dist/v2/validate.d.ts +8 -0
  89. package/dist/v2/validate.d.ts.map +1 -0
  90. package/dist/v2/validate.js +225 -0
  91. package/dist/v2/validate.js.map +1 -0
  92. package/dist/validate.d.ts +1 -1
  93. package/dist/validate.d.ts.map +1 -1
  94. package/dist/validate.js +1 -1
  95. package/dist/validate.js.map +1 -1
  96. package/docs/association-format.md +3 -0
  97. package/docs/memorix-format.md +24 -186
  98. package/docs/memorix-record-v2.md +101 -0
  99. package/docs/memorix-workflow-format.md +13 -1
  100. package/docs/migrate-present-to-v2.md +49 -0
  101. package/examples/v2/activity-events-snapshots.json +31 -0
  102. package/examples/v2/employees-discovery.json +26 -0
  103. package/examples/v2/employees-snapshots.json +27 -0
  104. package/examples/v2/procedures-knowledge.json +27 -0
  105. package/examples/v2/work-items-analysis.json +26 -0
  106. package/examples/v2/work-items-context.json +32 -0
  107. package/examples/v2/work-items-decisions.json +26 -0
  108. package/examples/v2/work-items-raw.json +37 -0
  109. package/examples/v2/work-items-relationships-candidate.json +38 -0
  110. package/examples/v2/work-items-snapshots-lifecycle.json +31 -0
  111. package/examples/v2/work-items-snapshots-lightweight-refs.json +34 -0
  112. package/examples/v2/work-items-snapshots.json +28 -0
  113. package/examples/v2/work-items-workflow.json +28 -0
  114. package/meta/envelope.json +104 -0
  115. package/package.json +7 -5
@@ -0,0 +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
+ }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@x12i/memorix-format",
3
- "version": "2.2.3",
4
- "description": "Memorix product format on @x12i/memorix-base-format: open buckets, associations, SCOPE, migrate CLI.",
3
+ "version": "2.3.3",
4
+ "description": "Memorix format: present envelope + memorix-record/2 (Gate G2 SoT), validators, migrate CLIs.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.js",
7
7
  "types": "./dist/index.d.ts",
@@ -24,6 +24,10 @@
24
24
  "./types": {
25
25
  "types": "./dist/types.d.ts",
26
26
  "import": "./dist/types.js"
27
+ },
28
+ "./v2": {
29
+ "types": "./dist/v2/index.d.ts",
30
+ "import": "./dist/v2/index.js"
27
31
  }
28
32
  },
29
33
  "files": [
@@ -47,9 +51,6 @@
47
51
  "engines": {
48
52
  "node": ">=18.0.0"
49
53
  },
50
- "dependencies": {
51
- "@x12i/memorix-base-format": "^1.2.0"
52
- },
53
54
  "devDependencies": {
54
55
  "@types/node": "^20.14.0",
55
56
  "typescript": "^5.6.0",
@@ -67,6 +68,7 @@
67
68
  "keywords": [
68
69
  "memorix",
69
70
  "format",
71
+ "memorix-record/2",
70
72
  "validator",
71
73
  "profile",
72
74
  "exellix"