@twin.org/document-management-models 0.0.3-next.11 → 0.0.3-next.13

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 (28) hide show
  1. package/README.md +1 -1
  2. package/dist/es/dataTypes/documentManagementDataTypes.js.map +1 -1
  3. package/dist/es/models/IDocument.js.map +1 -1
  4. package/dist/es/models/IDocumentAttestation.js.map +1 -1
  5. package/dist/es/models/IDocumentList.js.map +1 -1
  6. package/dist/es/schemas/Document.json +20 -23
  7. package/dist/types/models/IDocument.d.ts +16 -16
  8. package/dist/types/models/IDocumentAttestation.d.ts +5 -5
  9. package/dist/types/models/IDocumentList.d.ts +2 -2
  10. package/docs/changelog.md +98 -84
  11. package/docs/examples.md +23 -1
  12. package/docs/reference/classes/DocumentManagementDataTypes.md +1 -1
  13. package/docs/reference/interfaces/IDocument.md +29 -45
  14. package/docs/reference/interfaces/IDocumentAttestation.md +7 -12
  15. package/docs/reference/interfaces/IDocumentList.md +5 -7
  16. package/docs/reference/interfaces/IDocumentManagementComponent.md +8 -8
  17. package/docs/reference/interfaces/IDocumentManagementCreateRequest.md +6 -6
  18. package/docs/reference/interfaces/IDocumentManagementGetRequest.md +13 -13
  19. package/docs/reference/interfaces/IDocumentManagementGetResponse.md +4 -4
  20. package/docs/reference/interfaces/IDocumentManagementGetRevisionRequest.md +10 -10
  21. package/docs/reference/interfaces/IDocumentManagementGetRevisionResponse.md +3 -3
  22. package/docs/reference/interfaces/IDocumentManagementQueryRequest.md +5 -5
  23. package/docs/reference/interfaces/IDocumentManagementQueryResponse.md +4 -4
  24. package/docs/reference/interfaces/IDocumentManagementRemoveRequest.md +1 -1
  25. package/docs/reference/interfaces/IDocumentManagementUpdateRequest.md +5 -5
  26. package/docs/reference/variables/DocumentContexts.md +6 -6
  27. package/docs/reference/variables/DocumentTypes.md +2 -2
  28. package/package.json +4 -4
package/docs/changelog.md CHANGED
@@ -1,250 +1,264 @@
1
- # @twin.org/document-management-models - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.11](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.10...document-management-models-v0.0.3-next.11) (2026-02-25)
3
+ ## [0.0.3-next.13](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.12...document-management-models-v0.0.3-next.13) (2026-05-12)
4
4
 
5
5
 
6
6
  ### Features
7
7
 
8
- * update schemas ([310261d](https://github.com/twinfoundation/document-management/commit/310261d620254d9c00dfa8fbb470948af9101778))
8
+ * typescript 6 update ([35631d8](https://github.com/iotaledger/twin-document-management/commit/35631d88551380933009443d77b1a844b631a98e))
9
9
 
10
- ## [0.0.3-next.10](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.9...document-management-models-v0.0.3-next.10) (2026-02-11)
10
+ ## [0.0.3-next.12](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.11...document-management-models-v0.0.3-next.12) (2026-03-26)
11
11
 
12
12
 
13
13
  ### Features
14
14
 
15
- * add ts-to-jsonld-context tool ([da11115](https://github.com/twinfoundation/document-management/commit/da111155614dc7f7789480c8b0d2f03c66a16ae4))
16
- * blobHash to integrity ([#38](https://github.com/twinfoundation/document-management/issues/38)) ([2d45756](https://github.com/twinfoundation/document-management/commit/2d457565ba61d260ace12a762e592b6b1a65788d))
15
+ * update to latest aig method shapes ([497e895](https://github.com/iotaledger/twin-document-management/commit/497e8954f24774db628e057ebb9d158a1fd9d92a))
17
16
 
18
- ## [0.0.3-next.9](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.8...document-management-models-v0.0.3-next.9) (2026-01-26)
17
+ ## [0.0.3-next.11](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.10...document-management-models-v0.0.3-next.11) (2026-02-25)
18
+
19
+
20
+ ### Features
21
+
22
+ * update schemas ([310261d](https://github.com/iotaledger/twin-document-management/commit/310261d620254d9c00dfa8fbb470948af9101778))
23
+
24
+ ## [0.0.3-next.10](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.9...document-management-models-v0.0.3-next.10) (2026-02-11)
25
+
26
+
27
+ ### Features
28
+
29
+ * add ts-to-jsonld-context tool ([da11115](https://github.com/iotaledger/twin-document-management/commit/da111155614dc7f7789480c8b0d2f03c66a16ae4))
30
+ * blobHash to integrity ([#38](https://github.com/iotaledger/twin-document-management/issues/38)) ([2d45756](https://github.com/iotaledger/twin-document-management/commit/2d457565ba61d260ace12a762e592b6b1a65788d))
31
+
32
+ ## [0.0.3-next.9](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.8...document-management-models-v0.0.3-next.9) (2026-01-26)
19
33
 
20
34
 
21
35
  ### Miscellaneous Chores
22
36
 
23
37
  * **document-management-models:** Synchronize repo versions
24
38
 
25
- ## [0.0.3-next.8](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.7...document-management-models-v0.0.3-next.8) (2026-01-26)
39
+ ## [0.0.3-next.8](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.7...document-management-models-v0.0.3-next.8) (2026-01-26)
26
40
 
27
41
 
28
42
  ### Miscellaneous Chores
29
43
 
30
44
  * **document-management-models:** Synchronize repo versions
31
45
 
32
- ## [0.0.3-next.7](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.6...document-management-models-v0.0.3-next.7) (2026-01-23)
46
+ ## [0.0.3-next.7](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.6...document-management-models-v0.0.3-next.7) (2026-01-23)
33
47
 
34
48
 
35
49
  ### Features
36
50
 
37
- * replace nextItem property with Link header ([#34](https://github.com/twinfoundation/document-management/issues/34)) ([3f04c3f](https://github.com/twinfoundation/document-management/commit/3f04c3fb5c9ec0c56f213089a15cc247fbfbd59c))
51
+ * replace nextItem property with Link header ([#34](https://github.com/iotaledger/twin-document-management/issues/34)) ([3f04c3f](https://github.com/iotaledger/twin-document-management/commit/3f04c3fb5c9ec0c56f213089a15cc247fbfbd59c))
38
52
 
39
- ## [0.0.3-next.6](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.5...document-management-models-v0.0.3-next.6) (2026-01-22)
53
+ ## [0.0.3-next.6](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.5...document-management-models-v0.0.3-next.6) (2026-01-22)
40
54
 
41
55
 
42
56
  ### Features
43
57
 
44
- * update contexts ([#32](https://github.com/twinfoundation/document-management/issues/32)) ([2fc1d92](https://github.com/twinfoundation/document-management/commit/2fc1d9200ecd8b755efb552c5f84f996cb61e64a))
58
+ * update contexts ([#32](https://github.com/iotaledger/twin-document-management/issues/32)) ([2fc1d92](https://github.com/iotaledger/twin-document-management/commit/2fc1d9200ecd8b755efb552c5f84f996cb61e64a))
45
59
 
46
- ## [0.0.3-next.5](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.4...document-management-models-v0.0.3-next.5) (2026-01-14)
60
+ ## [0.0.3-next.5](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.4...document-management-models-v0.0.3-next.5) (2026-01-14)
47
61
 
48
62
 
49
63
  ### Features
50
64
 
51
- * update contexts and namespaces ([#29](https://github.com/twinfoundation/document-management/issues/29)) ([ef7abc0](https://github.com/twinfoundation/document-management/commit/ef7abc01d10b3f9528be8afaa21dbd00181939ae))
65
+ * update contexts and namespaces ([#29](https://github.com/iotaledger/twin-document-management/issues/29)) ([ef7abc0](https://github.com/iotaledger/twin-document-management/commit/ef7abc01d10b3f9528be8afaa21dbd00181939ae))
52
66
 
53
- ## [0.0.3-next.4](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.3...document-management-models-v0.0.3-next.4) (2026-01-06)
67
+ ## [0.0.3-next.4](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.3...document-management-models-v0.0.3-next.4) (2026-01-06)
54
68
 
55
69
 
56
70
  ### Features
57
71
 
58
- * update unece dependencies ([a27548c](https://github.com/twinfoundation/document-management/commit/a27548cdebbe1d9577fc8341166538c2f07348a3))
72
+ * update unece dependencies ([a27548c](https://github.com/iotaledger/twin-document-management/commit/a27548cdebbe1d9577fc8341166538c2f07348a3))
59
73
 
60
- ## [0.0.3-next.3](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.2...document-management-models-v0.0.3-next.3) (2025-12-03)
74
+ ## [0.0.3-next.3](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.2...document-management-models-v0.0.3-next.3) (2025-12-03)
61
75
 
62
76
 
63
77
  ### Features
64
78
 
65
- * use updated unece types ([c141a89](https://github.com/twinfoundation/document-management/commit/c141a895138cb45fa0b1e95c42f56e31708c846c))
79
+ * use updated unece types ([c141a89](https://github.com/iotaledger/twin-document-management/commit/c141a895138cb45fa0b1e95c42f56e31708c846c))
66
80
 
67
- ## [0.0.3-next.2](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.1...document-management-models-v0.0.3-next.2) (2025-11-28)
81
+ ## [0.0.3-next.2](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.1...document-management-models-v0.0.3-next.2) (2025-11-28)
68
82
 
69
83
 
70
84
  ### Features
71
85
 
72
- * update background task service ([5c380dc](https://github.com/twinfoundation/document-management/commit/5c380dca3114254201768f184f9486828501ff66))
86
+ * update background task service ([5c380dc](https://github.com/iotaledger/twin-document-management/commit/5c380dca3114254201768f184f9486828501ff66))
73
87
 
74
- ## [0.0.3-next.1](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.3-next.0...document-management-models-v0.0.3-next.1) (2025-11-12)
88
+ ## [0.0.3-next.1](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.3-next.0...document-management-models-v0.0.3-next.1) (2025-11-12)
75
89
 
76
90
 
77
91
  ### Features
78
92
 
79
- * add context id features ([#24](https://github.com/twinfoundation/document-management/issues/24)) ([83f65f1](https://github.com/twinfoundation/document-management/commit/83f65f15e55f2293f5ca0d9d1e4679ba67c4ec8d))
80
- * add validate-locales ([b6b6f9e](https://github.com/twinfoundation/document-management/commit/b6b6f9e9d66c17af3d030247ca168ac0b5844bdc))
81
- * data type registration use fully qualified names ([18d27d0](https://github.com/twinfoundation/document-management/commit/18d27d0c21d0f652b7df4b409bb2d3c66cf22f84))
82
- * document get can perform extraction ([#6](https://github.com/twinfoundation/document-management/issues/6)) ([5ce6d37](https://github.com/twinfoundation/document-management/commit/5ce6d37432ad271ca5783f422846f4be98ec2215))
83
- * eslint migration to flat config ([98635aa](https://github.com/twinfoundation/document-management/commit/98635aa24ebafba265e989e461fe98104f683191))
84
- * get document revision ([080eddc](https://github.com/twinfoundation/document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
85
- * improve comments ([4d2f094](https://github.com/twinfoundation/document-management/commit/4d2f094b23e3320cb739917246c1ee5f6ad41c11))
86
- * store document as a vertex ([#2](https://github.com/twinfoundation/document-management/issues/2)) ([7febedc](https://github.com/twinfoundation/document-management/commit/7febedc3fb31de9c19565d6326341046834f2c74))
87
- * update dependencies ([f9d8641](https://github.com/twinfoundation/document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
88
- * update framework core ([f991a59](https://github.com/twinfoundation/document-management/commit/f991a59d25ec228bcdd7a5b6bd55578985b55a84))
89
- * update ts-to-schema generation ([01a5335](https://github.com/twinfoundation/document-management/commit/01a5335372f6a4764a74d56c446d669724a308aa))
90
- * use standard list json ld types ([20ea04b](https://github.com/twinfoundation/document-management/commit/20ea04b05fd4bc4fcedce8f66958942c3c2fa303))
91
- * use targetId in AIG for edges ([82dec81](https://github.com/twinfoundation/document-management/commit/82dec8190d8b523b350ef133bdcf648cab1023b0))
93
+ * add context id features ([#24](https://github.com/iotaledger/twin-document-management/issues/24)) ([83f65f1](https://github.com/iotaledger/twin-document-management/commit/83f65f15e55f2293f5ca0d9d1e4679ba67c4ec8d))
94
+ * add validate-locales ([b6b6f9e](https://github.com/iotaledger/twin-document-management/commit/b6b6f9e9d66c17af3d030247ca168ac0b5844bdc))
95
+ * data type registration use fully qualified names ([18d27d0](https://github.com/iotaledger/twin-document-management/commit/18d27d0c21d0f652b7df4b409bb2d3c66cf22f84))
96
+ * document get can perform extraction ([#6](https://github.com/iotaledger/twin-document-management/issues/6)) ([5ce6d37](https://github.com/iotaledger/twin-document-management/commit/5ce6d37432ad271ca5783f422846f4be98ec2215))
97
+ * eslint migration to flat config ([98635aa](https://github.com/iotaledger/twin-document-management/commit/98635aa24ebafba265e989e461fe98104f683191))
98
+ * get document revision ([080eddc](https://github.com/iotaledger/twin-document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
99
+ * improve comments ([4d2f094](https://github.com/iotaledger/twin-document-management/commit/4d2f094b23e3320cb739917246c1ee5f6ad41c11))
100
+ * store document as a vertex ([#2](https://github.com/iotaledger/twin-document-management/issues/2)) ([7febedc](https://github.com/iotaledger/twin-document-management/commit/7febedc3fb31de9c19565d6326341046834f2c74))
101
+ * update dependencies ([f9d8641](https://github.com/iotaledger/twin-document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
102
+ * update framework core ([f991a59](https://github.com/iotaledger/twin-document-management/commit/f991a59d25ec228bcdd7a5b6bd55578985b55a84))
103
+ * update ts-to-schema generation ([01a5335](https://github.com/iotaledger/twin-document-management/commit/01a5335372f6a4764a74d56c446d669724a308aa))
104
+ * use standard list json ld types ([20ea04b](https://github.com/iotaledger/twin-document-management/commit/20ea04b05fd4bc4fcedce8f66958942c3c2fa303))
105
+ * use targetId in AIG for edges ([82dec81](https://github.com/iotaledger/twin-document-management/commit/82dec8190d8b523b350ef133bdcf648cab1023b0))
92
106
 
93
107
 
94
108
  ### Bug Fixes
95
109
 
96
- * query params force coercion ([d667d0f](https://github.com/twinfoundation/document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
110
+ * query params force coercion ([d667d0f](https://github.com/iotaledger/twin-document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
97
111
 
98
- ## [0.0.2-next.4](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.2-next.3...document-management-models-v0.0.2-next.4) (2025-10-09)
112
+ ## [0.0.2-next.4](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.2-next.3...document-management-models-v0.0.2-next.4) (2025-10-09)
99
113
 
100
114
 
101
115
  ### Features
102
116
 
103
- * add validate-locales ([b6b6f9e](https://github.com/twinfoundation/document-management/commit/b6b6f9e9d66c17af3d030247ca168ac0b5844bdc))
117
+ * add validate-locales ([b6b6f9e](https://github.com/iotaledger/twin-document-management/commit/b6b6f9e9d66c17af3d030247ca168ac0b5844bdc))
104
118
 
105
- ## [0.0.2-next.3](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.2-next.2...document-management-models-v0.0.2-next.3) (2025-09-29)
119
+ ## [0.0.2-next.3](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.2-next.2...document-management-models-v0.0.2-next.3) (2025-09-29)
106
120
 
107
121
 
108
122
  ### Features
109
123
 
110
- * use targetId in AIG for edges ([82dec81](https://github.com/twinfoundation/document-management/commit/82dec8190d8b523b350ef133bdcf648cab1023b0))
124
+ * use targetId in AIG for edges ([82dec81](https://github.com/iotaledger/twin-document-management/commit/82dec8190d8b523b350ef133bdcf648cab1023b0))
111
125
 
112
- ## [0.0.2-next.2](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.2-next.1...document-management-models-v0.0.2-next.2) (2025-08-29)
126
+ ## [0.0.2-next.2](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.2-next.1...document-management-models-v0.0.2-next.2) (2025-08-29)
113
127
 
114
128
 
115
129
  ### Features
116
130
 
117
- * eslint migration to flat config ([98635aa](https://github.com/twinfoundation/document-management/commit/98635aa24ebafba265e989e461fe98104f683191))
131
+ * eslint migration to flat config ([98635aa](https://github.com/iotaledger/twin-document-management/commit/98635aa24ebafba265e989e461fe98104f683191))
118
132
 
119
- ## [0.0.2-next.1](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.2-next.0...document-management-models-v0.0.2-next.1) (2025-08-21)
133
+ ## [0.0.2-next.1](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.2-next.0...document-management-models-v0.0.2-next.1) (2025-08-21)
120
134
 
121
135
 
122
136
  ### Features
123
137
 
124
- * data type registration use fully qualified names ([18d27d0](https://github.com/twinfoundation/document-management/commit/18d27d0c21d0f652b7df4b409bb2d3c66cf22f84))
125
- * document get can perform extraction ([#6](https://github.com/twinfoundation/document-management/issues/6)) ([5ce6d37](https://github.com/twinfoundation/document-management/commit/5ce6d37432ad271ca5783f422846f4be98ec2215))
126
- * get document revision ([080eddc](https://github.com/twinfoundation/document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
127
- * improve comments ([4d2f094](https://github.com/twinfoundation/document-management/commit/4d2f094b23e3320cb739917246c1ee5f6ad41c11))
128
- * store document as a vertex ([#2](https://github.com/twinfoundation/document-management/issues/2)) ([7febedc](https://github.com/twinfoundation/document-management/commit/7febedc3fb31de9c19565d6326341046834f2c74))
129
- * update dependencies ([f9d8641](https://github.com/twinfoundation/document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
130
- * update framework core ([f991a59](https://github.com/twinfoundation/document-management/commit/f991a59d25ec228bcdd7a5b6bd55578985b55a84))
131
- * update ts-to-schema generation ([01a5335](https://github.com/twinfoundation/document-management/commit/01a5335372f6a4764a74d56c446d669724a308aa))
132
- * use standard list json ld types ([20ea04b](https://github.com/twinfoundation/document-management/commit/20ea04b05fd4bc4fcedce8f66958942c3c2fa303))
138
+ * data type registration use fully qualified names ([18d27d0](https://github.com/iotaledger/twin-document-management/commit/18d27d0c21d0f652b7df4b409bb2d3c66cf22f84))
139
+ * document get can perform extraction ([#6](https://github.com/iotaledger/twin-document-management/issues/6)) ([5ce6d37](https://github.com/iotaledger/twin-document-management/commit/5ce6d37432ad271ca5783f422846f4be98ec2215))
140
+ * get document revision ([080eddc](https://github.com/iotaledger/twin-document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
141
+ * improve comments ([4d2f094](https://github.com/iotaledger/twin-document-management/commit/4d2f094b23e3320cb739917246c1ee5f6ad41c11))
142
+ * store document as a vertex ([#2](https://github.com/iotaledger/twin-document-management/issues/2)) ([7febedc](https://github.com/iotaledger/twin-document-management/commit/7febedc3fb31de9c19565d6326341046834f2c74))
143
+ * update dependencies ([f9d8641](https://github.com/iotaledger/twin-document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
144
+ * update framework core ([f991a59](https://github.com/iotaledger/twin-document-management/commit/f991a59d25ec228bcdd7a5b6bd55578985b55a84))
145
+ * update ts-to-schema generation ([01a5335](https://github.com/iotaledger/twin-document-management/commit/01a5335372f6a4764a74d56c446d669724a308aa))
146
+ * use standard list json ld types ([20ea04b](https://github.com/iotaledger/twin-document-management/commit/20ea04b05fd4bc4fcedce8f66958942c3c2fa303))
133
147
 
134
148
 
135
149
  ### Bug Fixes
136
150
 
137
- * query params force coercion ([d667d0f](https://github.com/twinfoundation/document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
151
+ * query params force coercion ([d667d0f](https://github.com/iotaledger/twin-document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
138
152
 
139
153
  ## 0.0.1 (2025-07-09)
140
154
 
141
155
 
142
156
  ### Features
143
157
 
144
- * release to production ([a009526](https://github.com/twinfoundation/document-management/commit/a009526032a0ee6e6b74f476a01fbe5f4c7fd4da))
158
+ * release to production ([a009526](https://github.com/iotaledger/twin-document-management/commit/a009526032a0ee6e6b74f476a01fbe5f4c7fd4da))
145
159
 
146
- ## [0.0.1-next.20](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.19...document-management-models-v0.0.1-next.20) (2025-06-20)
160
+ ## [0.0.1-next.20](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.1-next.19...document-management-models-v0.0.1-next.20) (2025-06-20)
147
161
 
148
162
 
149
163
  ### Features
150
164
 
151
- * data type registration use fully qualified names ([18d27d0](https://github.com/twinfoundation/document-management/commit/18d27d0c21d0f652b7df4b409bb2d3c66cf22f84))
152
- * document get can perform extraction ([#6](https://github.com/twinfoundation/document-management/issues/6)) ([5ce6d37](https://github.com/twinfoundation/document-management/commit/5ce6d37432ad271ca5783f422846f4be98ec2215))
153
- * get document revision ([080eddc](https://github.com/twinfoundation/document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
154
- * improve comments ([4d2f094](https://github.com/twinfoundation/document-management/commit/4d2f094b23e3320cb739917246c1ee5f6ad41c11))
155
- * store document as a vertex ([#2](https://github.com/twinfoundation/document-management/issues/2)) ([7febedc](https://github.com/twinfoundation/document-management/commit/7febedc3fb31de9c19565d6326341046834f2c74))
156
- * update dependencies ([f9d8641](https://github.com/twinfoundation/document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
157
- * update ts-to-schema generation ([01a5335](https://github.com/twinfoundation/document-management/commit/01a5335372f6a4764a74d56c446d669724a308aa))
158
- * use standard list json ld types ([20ea04b](https://github.com/twinfoundation/document-management/commit/20ea04b05fd4bc4fcedce8f66958942c3c2fa303))
165
+ * data type registration use fully qualified names ([18d27d0](https://github.com/iotaledger/twin-document-management/commit/18d27d0c21d0f652b7df4b409bb2d3c66cf22f84))
166
+ * document get can perform extraction ([#6](https://github.com/iotaledger/twin-document-management/issues/6)) ([5ce6d37](https://github.com/iotaledger/twin-document-management/commit/5ce6d37432ad271ca5783f422846f4be98ec2215))
167
+ * get document revision ([080eddc](https://github.com/iotaledger/twin-document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
168
+ * improve comments ([4d2f094](https://github.com/iotaledger/twin-document-management/commit/4d2f094b23e3320cb739917246c1ee5f6ad41c11))
169
+ * store document as a vertex ([#2](https://github.com/iotaledger/twin-document-management/issues/2)) ([7febedc](https://github.com/iotaledger/twin-document-management/commit/7febedc3fb31de9c19565d6326341046834f2c74))
170
+ * update dependencies ([f9d8641](https://github.com/iotaledger/twin-document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
171
+ * update ts-to-schema generation ([01a5335](https://github.com/iotaledger/twin-document-management/commit/01a5335372f6a4764a74d56c446d669724a308aa))
172
+ * use standard list json ld types ([20ea04b](https://github.com/iotaledger/twin-document-management/commit/20ea04b05fd4bc4fcedce8f66958942c3c2fa303))
159
173
 
160
174
 
161
175
  ### Bug Fixes
162
176
 
163
- * query params force coercion ([d667d0f](https://github.com/twinfoundation/document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
177
+ * query params force coercion ([d667d0f](https://github.com/iotaledger/twin-document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
164
178
 
165
- ## [0.0.1-next.19](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.18...document-management-models-v0.0.1-next.19) (2025-06-20)
179
+ ## [0.0.1-next.19](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.1-next.18...document-management-models-v0.0.1-next.19) (2025-06-20)
166
180
 
167
181
 
168
182
  ### Bug Fixes
169
183
 
170
- * query params force coercion ([d667d0f](https://github.com/twinfoundation/document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
184
+ * query params force coercion ([d667d0f](https://github.com/iotaledger/twin-document-management/commit/d667d0f195accca2887a5ca732e9790063763996))
171
185
 
172
- ## [0.0.1-next.18](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.17...document-management-models-v0.0.1-next.18) (2025-06-18)
186
+ ## [0.0.1-next.18](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.1-next.17...document-management-models-v0.0.1-next.18) (2025-06-18)
173
187
 
174
188
 
175
189
  ### Miscellaneous Chores
176
190
 
177
191
  * **document-management-models:** Synchronize repo versions
178
192
 
179
- ## [0.0.1-next.17](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.16...document-management-models-v0.0.1-next.17) (2025-06-12)
193
+ ## [0.0.1-next.17](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.1-next.16...document-management-models-v0.0.1-next.17) (2025-06-12)
180
194
 
181
195
 
182
196
  ### Features
183
197
 
184
- * update dependencies ([f9d8641](https://github.com/twinfoundation/document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
198
+ * update dependencies ([f9d8641](https://github.com/iotaledger/twin-document-management/commit/f9d86417dba24027699225ec7473296e361dcb00))
185
199
 
186
- ## [0.0.1-next.16](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.15...document-management-models-v0.0.1-next.16) (2025-06-03)
200
+ ## [0.0.1-next.16](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.1-next.15...document-management-models-v0.0.1-next.16) (2025-06-03)
187
201
 
188
202
 
189
203
  ### Features
190
204
 
191
- * update ts-to-schema generation ([01a5335](https://github.com/twinfoundation/document-management/commit/01a5335372f6a4764a74d56c446d669724a308aa))
205
+ * update ts-to-schema generation ([01a5335](https://github.com/iotaledger/twin-document-management/commit/01a5335372f6a4764a74d56c446d669724a308aa))
192
206
 
193
- ## [0.0.1-next.15](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.14...document-management-models-v0.0.1-next.15) (2025-05-28)
207
+ ## [0.0.1-next.15](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.1-next.14...document-management-models-v0.0.1-next.15) (2025-05-28)
194
208
 
195
209
 
196
210
  ### Features
197
211
 
198
- * data type registration use fully qualified names ([18d27d0](https://github.com/twinfoundation/document-management/commit/18d27d0c21d0f652b7df4b409bb2d3c66cf22f84))
212
+ * data type registration use fully qualified names ([18d27d0](https://github.com/iotaledger/twin-document-management/commit/18d27d0c21d0f652b7df4b409bb2d3c66cf22f84))
199
213
 
200
- ## [0.0.1-next.14](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.13...document-management-models-v0.0.1-next.14) (2025-05-08)
214
+ ## [0.0.1-next.14](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.1-next.13...document-management-models-v0.0.1-next.14) (2025-05-08)
201
215
 
202
216
 
203
217
  ### Features
204
218
 
205
- * use standard list json ld types ([20ea04b](https://github.com/twinfoundation/document-management/commit/20ea04b05fd4bc4fcedce8f66958942c3c2fa303))
219
+ * use standard list json ld types ([20ea04b](https://github.com/iotaledger/twin-document-management/commit/20ea04b05fd4bc4fcedce8f66958942c3c2fa303))
206
220
 
207
- ## [0.0.1-next.13](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.12...document-management-models-v0.0.1-next.13) (2025-04-30)
221
+ ## [0.0.1-next.13](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.1-next.12...document-management-models-v0.0.1-next.13) (2025-04-30)
208
222
 
209
223
 
210
224
  ### Miscellaneous Chores
211
225
 
212
226
  * **document-management-models:** Synchronize repo versions
213
227
 
214
- ## [0.0.1-next.12](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.11...document-management-models-v0.0.1-next.12) (2025-04-30)
228
+ ## [0.0.1-next.12](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.1-next.11...document-management-models-v0.0.1-next.12) (2025-04-30)
215
229
 
216
230
 
217
231
  ### Features
218
232
 
219
- * get document revision ([080eddc](https://github.com/twinfoundation/document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
233
+ * get document revision ([080eddc](https://github.com/iotaledger/twin-document-management/commit/080eddcc024c622dda6bb36f60f5fa80a86cf5bb))
220
234
 
221
- ## [0.0.1-next.11](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.10...document-management-models-v0.0.1-next.11) (2025-04-28)
235
+ ## [0.0.1-next.11](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.1-next.10...document-management-models-v0.0.1-next.11) (2025-04-28)
222
236
 
223
237
 
224
238
  ### Features
225
239
 
226
- * document get can perform extraction ([#6](https://github.com/twinfoundation/document-management/issues/6)) ([5ce6d37](https://github.com/twinfoundation/document-management/commit/5ce6d37432ad271ca5783f422846f4be98ec2215))
240
+ * document get can perform extraction ([#6](https://github.com/iotaledger/twin-document-management/issues/6)) ([5ce6d37](https://github.com/iotaledger/twin-document-management/commit/5ce6d37432ad271ca5783f422846f4be98ec2215))
227
241
 
228
- ## [0.0.1-next.10](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.9...document-management-models-v0.0.1-next.10) (2025-04-25)
242
+ ## [0.0.1-next.10](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.1-next.9...document-management-models-v0.0.1-next.10) (2025-04-25)
229
243
 
230
244
 
231
245
  ### Miscellaneous Chores
232
246
 
233
247
  * **document-management-models:** Synchronize repo versions
234
248
 
235
- ## [0.0.1-next.9](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.8...document-management-models-v0.0.1-next.9) (2025-04-17)
249
+ ## [0.0.1-next.9](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.1-next.8...document-management-models-v0.0.1-next.9) (2025-04-17)
236
250
 
237
251
 
238
252
  ### Features
239
253
 
240
- * store document as a vertex ([#2](https://github.com/twinfoundation/document-management/issues/2)) ([7febedc](https://github.com/twinfoundation/document-management/commit/7febedc3fb31de9c19565d6326341046834f2c74))
254
+ * store document as a vertex ([#2](https://github.com/iotaledger/twin-document-management/issues/2)) ([7febedc](https://github.com/iotaledger/twin-document-management/commit/7febedc3fb31de9c19565d6326341046834f2c74))
241
255
 
242
- ## [0.0.1-next.8](https://github.com/twinfoundation/document-management/compare/document-management-models-v0.0.1-next.7...document-management-models-v0.0.1-next.8) (2025-03-28)
256
+ ## [0.0.1-next.8](https://github.com/iotaledger/twin-document-management/compare/document-management-models-v0.0.1-next.7...document-management-models-v0.0.1-next.8) (2025-03-28)
243
257
 
244
258
 
245
259
  ### Features
246
260
 
247
- * improve comments ([4d2f094](https://github.com/twinfoundation/document-management/commit/4d2f094b23e3320cb739917246c1ee5f6ad41c11))
261
+ * improve comments ([4d2f094](https://github.com/iotaledger/twin-document-management/commit/4d2f094b23e3320cb739917246c1ee5f6ad41c11))
248
262
 
249
263
  ## v0.0.1-next.7
250
264
 
package/docs/examples.md CHANGED
@@ -1 +1,23 @@
1
- # @twin.org/document-management-models - Examples
1
+ # Document Management Models Examples
2
+
3
+ These snippets show typical setup steps for registering data types and creating document-shaped data that can be validated and exchanged consistently.
4
+
5
+ ## DocumentManagementDataTypes
6
+
7
+ ```typescript
8
+ import { DataTypeHandlerFactory } from '@twin.org/data-core';
9
+ import {
10
+ DocumentContexts,
11
+ DocumentManagementDataTypes,
12
+ DocumentTypes
13
+ } from '@twin.org/document-management-models';
14
+
15
+ DocumentManagementDataTypes.registerTypes();
16
+
17
+ const handler = DataTypeHandlerFactory.get(
18
+ `${DocumentContexts.Namespace}${DocumentTypes.Document}`
19
+ );
20
+
21
+ console.log(handler.namespace); // https://schema.twindev.org/document-management/
22
+ console.log(handler.type); // Document
23
+ ```
package/docs/reference/classes/DocumentManagementDataTypes.md CHANGED
@@ -14,7 +14,7 @@ Handle all the data types for document management.
14
14
 
15
15
  ## Methods
16
16
 
17
- ### registerTypes()
17
+ ### registerTypes() {#registertypes}
18
18
 
19
19
  > `static` **registerTypes**(): `void`
20
20
 
package/docs/reference/interfaces/IDocument.md CHANGED
@@ -4,7 +4,7 @@ Interface describing a document.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### @context
7
+ ### @context {#context}
8
8
 
9
9
  > **@context**: \[`"https://schema.org"`, `"https://schema.twindev.org/documents/"`, `"https://schema.twindev.org/common/"`, `...IJsonLdContextDefinitionElement[]`\]
10
10
 
@@ -12,7 +12,7 @@ JSON-LD Context.
12
12
 
13
13
  ***
14
14
 
15
- ### type
15
+ ### type {#type}
16
16
 
17
17
  > **type**: `"Document"`
18
18
 
@@ -20,7 +20,7 @@ JSON-LD Type.
20
20
 
21
21
  ***
22
22
 
23
- ### id
23
+ ### id {#id}
24
24
 
25
25
  > **id**: `string`
26
26
 
@@ -28,144 +28,128 @@ The full id of the document.
28
28
 
29
29
  ***
30
30
 
31
- ### documentId
31
+ ### documentId {#documentid}
32
32
 
33
33
  > **documentId**: `string`
34
34
 
35
35
  The id of the document.
36
- json-ld type:schema:identifier
37
36
 
38
37
  ***
39
38
 
40
- ### documentIdFormat?
39
+ ### documentIdFormat? {#documentidformat}
41
40
 
42
- > `optional` **documentIdFormat**: `string`
41
+ > `optional` **documentIdFormat?**: `string`
43
42
 
44
43
  The format of the document id.
45
- json-ld type:schema:Text
46
44
 
47
45
  ***
48
46
 
49
- ### documentCode
47
+ ### documentCode {#documentcode}
50
48
 
51
49
  > **documentCode**: `UneceDocumentCodeList`
52
50
 
53
51
  The code for the document type.
54
- json-ld type:schema:identifier
55
52
 
56
53
  ***
57
54
 
58
- ### documentRevision
55
+ ### documentRevision {#documentrevision}
59
56
 
60
57
  > **documentRevision**: `number`
61
58
 
62
59
  The revision of the document as a 0 based index.
63
- json-ld type:schema:Integer
64
60
 
65
61
  ***
66
62
 
67
- ### annotationObject?
63
+ ### annotationObject? {#annotationobject}
68
64
 
69
- > `optional` **annotationObject**: `IJsonLdNodeObject`
65
+ > `optional` **annotationObject?**: `IJsonLdNodeObject`
70
66
 
71
67
  Additional annotation information for the document.
72
- json-ld namespace:twin-common
73
68
 
74
69
  ***
75
70
 
76
- ### blobStorageId
71
+ ### blobStorageId {#blobstorageid}
77
72
 
78
73
  > **blobStorageId**: `string`
79
74
 
80
75
  The blob storage id for the document.
81
- json-ld type:schema:identifier
82
76
 
83
77
  ***
84
78
 
85
- ### integrity
79
+ ### integrity {#integrity}
86
80
 
87
81
  > **integrity**: `string`
88
82
 
89
83
  The integrity of the blob data.
90
- json-ld namespace:twin-common
91
84
 
92
85
  ***
93
86
 
94
- ### blobStorageEntry?
87
+ ### blobStorageEntry? {#blobstorageentry}
95
88
 
96
- > `optional` **blobStorageEntry**: `IBlobStorageEntry`
89
+ > `optional` **blobStorageEntry?**: `IBlobStorageEntry`
97
90
 
98
91
  The additional JSON-LD for blob storage if it was requested.
99
- json-ld id
100
92
 
101
93
  ***
102
94
 
103
- ### extractedData?
95
+ ### extractedData? {#extracteddata}
104
96
 
105
- > `optional` **extractedData**: `unknown`
97
+ > `optional` **extractedData?**: `unknown`
106
98
 
107
99
  The data extracted from the document using data extraction services.
108
- json-ld type:json
109
100
 
110
101
  ***
111
102
 
112
- ### attestationId?
103
+ ### attestationId? {#attestationid}
113
104
 
114
- > `optional` **attestationId**: `string`
105
+ > `optional` **attestationId?**: `string`
115
106
 
116
107
  The attestation for the document if one was created.
117
- json-ld type:schema:identifier
118
108
 
119
109
  ***
120
110
 
121
- ### attestationInformation?
111
+ ### attestationInformation? {#attestationinformation}
122
112
 
123
- > `optional` **attestationInformation**: `IAttestationInformation`
113
+ > `optional` **attestationInformation?**: `IAttestationInformation`
124
114
 
125
115
  The additional JSON-LD for attestation storage if it was requested.
126
- json-ld id
127
116
 
128
117
  ***
129
118
 
130
- ### dateCreated
119
+ ### dateCreated {#datecreated}
131
120
 
132
121
  > **dateCreated**: `string`
133
122
 
134
123
  The date/time of when the document was created.
135
- json-ld namespace:schema
136
124
 
137
125
  ***
138
126
 
139
- ### dateModified?
127
+ ### dateModified? {#datemodified}
140
128
 
141
- > `optional` **dateModified**: `string`
129
+ > `optional` **dateModified?**: `string`
142
130
 
143
131
  The date/time of when the document was modified.
144
- json-ld namespace:schema
145
132
 
146
133
  ***
147
134
 
148
- ### dateDeleted?
135
+ ### dateDeleted? {#datedeleted}
149
136
 
150
- > `optional` **dateDeleted**: `string`
137
+ > `optional` **dateDeleted?**: `string`
151
138
 
152
139
  The date/time of when the document was deleted, as we never actually remove items.
153
- json-ld namespace:schema
154
140
 
155
141
  ***
156
142
 
157
- ### organizationIdentity?
143
+ ### organizationIdentity? {#organizationidentity}
158
144
 
159
- > `optional` **organizationIdentity**: `string`
145
+ > `optional` **organizationIdentity?**: `string`
160
146
 
161
147
  The organization which added the document to the graph.
162
- json-ld namespace:twin-common
163
148
 
164
149
  ***
165
150
 
166
- ### userIdentity?
151
+ ### userIdentity? {#useridentity}
167
152
 
168
- > `optional` **userIdentity**: `string`
153
+ > `optional` **userIdentity?**: `string`
169
154
 
170
155
  The user who added the document to the graph.
171
- json-ld namespace:twin-common