@twin.org/verifiable-storage-models 0.0.3-next.8 → 0.0.3-next.9

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 (14) hide show
  1. package/README.md +3 -1
  2. package/docs/changelog.md +89 -82
  3. package/docs/examples.md +51 -1
  4. package/docs/reference/interfaces/IVerifiableStorageComponent.md +4 -4
  5. package/docs/reference/interfaces/IVerifiableStorageConnector.md +4 -4
  6. package/docs/reference/interfaces/IVerifiableStorageCreateRequest.md +4 -4
  7. package/docs/reference/interfaces/IVerifiableStorageCreateResponse.md +1 -1
  8. package/docs/reference/interfaces/IVerifiableStorageGetRequest.md +5 -5
  9. package/docs/reference/interfaces/IVerifiableStorageGetResponse.md +3 -3
  10. package/docs/reference/interfaces/IVerifiableStorageRemoveRequest.md +1 -1
  11. package/docs/reference/interfaces/IVerifiableStorageUpdateRequest.md +4 -4
  12. package/docs/reference/interfaces/IVerifiableStorageUpdateResponse.md +1 -1
  13. package/docs/reference/variables/VerifiableStorageContexts.md +3 -3
  14. package/package.json +4 -4
package/README.md CHANGED
@@ -1,6 +1,8 @@
1
1
  # TWIN Verifiable Storage Models
2
2
 
3
- Contains models and classes for use with verifiable storage.
3
+ This package defines the shared contracts used by verifiable storage components across the repository. It includes common interfaces, API request and response models, and context definitions so integrations can rely on a consistent shape for data and behaviour.
4
+
5
+ By centralising these reusable contracts, it reduces duplication and helps connectors, services, and clients evolve together without introducing mismatched assumptions.
4
6
 
5
7
  ## Installation
6
8
 
package/docs/changelog.md CHANGED
@@ -1,255 +1,262 @@
1
- # @twin.org/verifiable-storage-models - Changelog
1
+ # Changelog
2
2
 
3
- ## [0.0.3-next.8](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.7...verifiable-storage-models-v0.0.3-next.8) (2026-03-03)
3
+ ## [0.0.3-next.9](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.8...verifiable-storage-models-v0.0.3-next.9) (2026-05-08)
4
4
 
5
5
 
6
6
  ### Miscellaneous Chores
7
7
 
8
8
  * **verifiable-storage-models:** Synchronize repo versions
9
9
 
10
- ## [0.0.3-next.7](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.6...verifiable-storage-models-v0.0.3-next.7) (2026-02-25)
10
+ ## [0.0.3-next.8](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.7...verifiable-storage-models-v0.0.3-next.8) (2026-03-03)
11
+
12
+
13
+ ### Miscellaneous Chores
14
+
15
+ * **verifiable-storage-models:** Synchronize repo versions
16
+
17
+ ## [0.0.3-next.7](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.6...verifiable-storage-models-v0.0.3-next.7) (2026-02-25)
11
18
 
12
19
 
13
20
  ### Features
14
21
 
15
- * add context id features ([#40](https://github.com/twinfoundation/verifiable-storage/issues/40)) ([260b96a](https://github.com/twinfoundation/verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
16
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
17
- * add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
18
- * context updates ([#44](https://github.com/twinfoundation/verifiable-storage/issues/44)) ([2f92558](https://github.com/twinfoundation/verifiable-storage/commit/2f9255835eddc9620268b6eb3bba723bc38a0591))
19
- * eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
20
- * update allow list name case ([278a787](https://github.com/twinfoundation/verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
21
- * update context and namespaces ([#42](https://github.com/twinfoundation/verifiable-storage/issues/42)) ([7863833](https://github.com/twinfoundation/verifiable-storage/commit/78638336c5cd7dce0c53aaf598aef603fbed7a9e))
22
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
23
- * update descriptions ([696be4d](https://github.com/twinfoundation/verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
24
- * update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
25
- * use new dlt packages with latency fix ([#6](https://github.com/twinfoundation/verifiable-storage/issues/6)) ([d81c45b](https://github.com/twinfoundation/verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
26
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
22
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
23
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
24
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
25
+ * context updates ([#44](https://github.com/iotaledger/twin-verifiable-storage/issues/44)) ([2f92558](https://github.com/iotaledger/twin-verifiable-storage/commit/2f9255835eddc9620268b6eb3bba723bc38a0591))
26
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
27
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
28
+ * update context and namespaces ([#42](https://github.com/iotaledger/twin-verifiable-storage/issues/42)) ([7863833](https://github.com/iotaledger/twin-verifiable-storage/commit/78638336c5cd7dce0c53aaf598aef603fbed7a9e))
29
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
30
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
31
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
32
+ * use new dlt packages with latency fix ([#6](https://github.com/iotaledger/twin-verifiable-storage/issues/6)) ([d81c45b](https://github.com/iotaledger/twin-verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
33
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
27
34
 
28
- ## [0.0.3-next.6](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.5...verifiable-storage-models-v0.0.3-next.6) (2026-02-25)
35
+ ## [0.0.3-next.6](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.5...verifiable-storage-models-v0.0.3-next.6) (2026-02-25)
29
36
 
30
37
 
31
38
  ### Miscellaneous Chores
32
39
 
33
40
  * **verifiable-storage-models:** Synchronize repo versions
34
41
 
35
- ## [0.0.3-next.5](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.4...verifiable-storage-models-v0.0.3-next.5) (2026-02-09)
42
+ ## [0.0.3-next.5](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.4...verifiable-storage-models-v0.0.3-next.5) (2026-02-09)
36
43
 
37
44
 
38
45
  ### Miscellaneous Chores
39
46
 
40
47
  * **verifiable-storage-models:** Synchronize repo versions
41
48
 
42
- ## [0.0.3-next.4](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.3...verifiable-storage-models-v0.0.3-next.4) (2026-02-09)
49
+ ## [0.0.3-next.4](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.3...verifiable-storage-models-v0.0.3-next.4) (2026-02-09)
43
50
 
44
51
 
45
52
  ### Miscellaneous Chores
46
53
 
47
54
  * **verifiable-storage-models:** Synchronize repo versions
48
55
 
49
- ## [0.0.3-next.3](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.2...verifiable-storage-models-v0.0.3-next.3) (2026-01-21)
56
+ ## [0.0.3-next.3](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.2...verifiable-storage-models-v0.0.3-next.3) (2026-01-21)
50
57
 
51
58
 
52
59
  ### Features
53
60
 
54
- * context updates ([#44](https://github.com/twinfoundation/verifiable-storage/issues/44)) ([2f92558](https://github.com/twinfoundation/verifiable-storage/commit/2f9255835eddc9620268b6eb3bba723bc38a0591))
61
+ * context updates ([#44](https://github.com/iotaledger/twin-verifiable-storage/issues/44)) ([2f92558](https://github.com/iotaledger/twin-verifiable-storage/commit/2f9255835eddc9620268b6eb3bba723bc38a0591))
55
62
 
56
- ## [0.0.3-next.2](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.1...verifiable-storage-models-v0.0.3-next.2) (2026-01-14)
63
+ ## [0.0.3-next.2](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.1...verifiable-storage-models-v0.0.3-next.2) (2026-01-14)
57
64
 
58
65
 
59
66
  ### Features
60
67
 
61
- * update context and namespaces ([#42](https://github.com/twinfoundation/verifiable-storage/issues/42)) ([7863833](https://github.com/twinfoundation/verifiable-storage/commit/78638336c5cd7dce0c53aaf598aef603fbed7a9e))
68
+ * update context and namespaces ([#42](https://github.com/iotaledger/twin-verifiable-storage/issues/42)) ([7863833](https://github.com/iotaledger/twin-verifiable-storage/commit/78638336c5cd7dce0c53aaf598aef603fbed7a9e))
62
69
 
63
- ## [0.0.3-next.1](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.0...verifiable-storage-models-v0.0.3-next.1) (2025-11-12)
70
+ ## [0.0.3-next.1](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.0...verifiable-storage-models-v0.0.3-next.1) (2025-11-12)
64
71
 
65
72
 
66
73
  ### Features
67
74
 
68
- * add context id features ([#40](https://github.com/twinfoundation/verifiable-storage/issues/40)) ([260b96a](https://github.com/twinfoundation/verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
69
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
70
- * add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
71
- * eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
72
- * update allow list name case ([278a787](https://github.com/twinfoundation/verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
73
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
74
- * update descriptions ([696be4d](https://github.com/twinfoundation/verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
75
- * update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
76
- * use new dlt packages with latency fix ([#6](https://github.com/twinfoundation/verifiable-storage/issues/6)) ([d81c45b](https://github.com/twinfoundation/verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
77
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
75
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
76
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
77
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
78
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
79
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
80
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
81
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
82
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
83
+ * use new dlt packages with latency fix ([#6](https://github.com/iotaledger/twin-verifiable-storage/issues/6)) ([d81c45b](https://github.com/iotaledger/twin-verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
84
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
78
85
 
79
- ## [0.0.2-next.6](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.2-next.5...verifiable-storage-models-v0.0.2-next.6) (2025-10-09)
86
+ ## [0.0.2-next.6](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.2-next.5...verifiable-storage-models-v0.0.2-next.6) (2025-10-09)
80
87
 
81
88
 
82
89
  ### Features
83
90
 
84
- * add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
91
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
85
92
 
86
- ## [0.0.2-next.5](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.2-next.4...verifiable-storage-models-v0.0.2-next.5) (2025-09-26)
93
+ ## [0.0.2-next.5](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.2-next.4...verifiable-storage-models-v0.0.2-next.5) (2025-09-26)
87
94
 
88
95
 
89
96
  ### Features
90
97
 
91
- * eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
98
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
92
99
 
93
- ## [0.0.2-next.4](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.2-next.3...verifiable-storage-models-v0.0.2-next.4) (2025-08-20)
100
+ ## [0.0.2-next.4](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.2-next.3...verifiable-storage-models-v0.0.2-next.4) (2025-08-20)
94
101
 
95
102
 
96
103
  ### Features
97
104
 
98
- * update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
105
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
99
106
 
100
- ## [0.0.2-next.3](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.2-next.2...verifiable-storage-models-v0.0.2-next.3) (2025-07-28)
107
+ ## [0.0.2-next.3](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.2-next.2...verifiable-storage-models-v0.0.2-next.3) (2025-07-28)
101
108
 
102
109
 
103
110
  ### Miscellaneous Chores
104
111
 
105
112
  * **verifiable-storage-models:** Synchronize repo versions
106
113
 
107
- ## [0.0.2-next.2](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.2-next.1...verifiable-storage-models-v0.0.2-next.2) (2025-07-16)
114
+ ## [0.0.2-next.2](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.2-next.1...verifiable-storage-models-v0.0.2-next.2) (2025-07-16)
108
115
 
109
116
 
110
117
  ### Features
111
118
 
112
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
113
- * update allow list name case ([278a787](https://github.com/twinfoundation/verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
114
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
115
- * update descriptions ([696be4d](https://github.com/twinfoundation/verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
116
- * use new dlt packages with latency fix ([#6](https://github.com/twinfoundation/verifiable-storage/issues/6)) ([d81c45b](https://github.com/twinfoundation/verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
117
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
119
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
120
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
121
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
122
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
123
+ * use new dlt packages with latency fix ([#6](https://github.com/iotaledger/twin-verifiable-storage/issues/6)) ([d81c45b](https://github.com/iotaledger/twin-verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
124
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
118
125
 
119
- ## [0.0.2-next.0](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.2-next.0...verifiable-storage-models-v0.0.2-next.0) (2025-07-16)
126
+ ## [0.0.2-next.0](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.2-next.0...verifiable-storage-models-v0.0.2-next.0) (2025-07-16)
120
127
 
121
128
 
122
129
  ### Features
123
130
 
124
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
125
- * update allow list name case ([278a787](https://github.com/twinfoundation/verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
126
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
127
- * update descriptions ([696be4d](https://github.com/twinfoundation/verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
128
- * use new dlt packages with latency fix ([#6](https://github.com/twinfoundation/verifiable-storage/issues/6)) ([d81c45b](https://github.com/twinfoundation/verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
129
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
131
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
132
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
133
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
134
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
135
+ * use new dlt packages with latency fix ([#6](https://github.com/iotaledger/twin-verifiable-storage/issues/6)) ([d81c45b](https://github.com/iotaledger/twin-verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
136
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
130
137
 
131
138
  ## 0.0.1 (2025-07-09)
132
139
 
133
140
 
134
141
  ### Features
135
142
 
136
- * release to production ([6ce6744](https://github.com/twinfoundation/verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
143
+ * release to production ([6ce6744](https://github.com/iotaledger/twin-verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
137
144
 
138
- ## [0.0.1-next.17](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.16...verifiable-storage-models-v0.0.1-next.17) (2025-06-25)
145
+ ## [0.0.1-next.17](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.16...verifiable-storage-models-v0.0.1-next.17) (2025-06-25)
139
146
 
140
147
 
141
148
  ### Miscellaneous Chores
142
149
 
143
150
  * **verifiable-storage-models:** Synchronize repo versions
144
151
 
145
- ## [0.0.1-next.16](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.15...verifiable-storage-models-v0.0.1-next.16) (2025-06-12)
152
+ ## [0.0.1-next.16](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.15...verifiable-storage-models-v0.0.1-next.16) (2025-06-12)
146
153
 
147
154
 
148
155
  ### Features
149
156
 
150
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
157
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
151
158
 
152
- ## [0.0.1-next.15](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.14...verifiable-storage-models-v0.0.1-next.15) (2025-06-03)
159
+ ## [0.0.1-next.15](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.14...verifiable-storage-models-v0.0.1-next.15) (2025-06-03)
153
160
 
154
161
 
155
162
  ### Miscellaneous Chores
156
163
 
157
164
  * **verifiable-storage-models:** Synchronize repo versions
158
165
 
159
- ## [0.0.1-next.14](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.13...verifiable-storage-models-v0.0.1-next.14) (2025-05-28)
166
+ ## [0.0.1-next.14](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.13...verifiable-storage-models-v0.0.1-next.14) (2025-05-28)
160
167
 
161
168
 
162
169
  ### Features
163
170
 
164
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
165
- * update allow list name case ([278a787](https://github.com/twinfoundation/verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
166
- * update descriptions ([696be4d](https://github.com/twinfoundation/verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
167
- * use new dlt packages with latency fix ([#6](https://github.com/twinfoundation/verifiable-storage/issues/6)) ([d81c45b](https://github.com/twinfoundation/verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
168
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
171
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
172
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
173
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
174
+ * use new dlt packages with latency fix ([#6](https://github.com/iotaledger/twin-verifiable-storage/issues/6)) ([d81c45b](https://github.com/iotaledger/twin-verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
175
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
169
176
 
170
- ## [0.0.1-next.13](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.12...verifiable-storage-models-v0.0.1-next.13) (2025-05-28)
177
+ ## [0.0.1-next.13](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.12...verifiable-storage-models-v0.0.1-next.13) (2025-05-28)
171
178
 
172
179
 
173
180
  ### Miscellaneous Chores
174
181
 
175
182
  * **verifiable-storage-models:** Synchronize repo versions
176
183
 
177
- ## [0.0.1-next.12](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.11...verifiable-storage-models-v0.0.1-next.12) (2025-05-28)
184
+ ## [0.0.1-next.12](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.11...verifiable-storage-models-v0.0.1-next.12) (2025-05-28)
178
185
 
179
186
 
180
187
  ### Features
181
188
 
182
- * update allow list name case ([278a787](https://github.com/twinfoundation/verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
189
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
183
190
 
184
- ## [0.0.1-next.11](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.10...verifiable-storage-models-v0.0.1-next.11) (2025-05-22)
191
+ ## [0.0.1-next.11](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.10...verifiable-storage-models-v0.0.1-next.11) (2025-05-22)
185
192
 
186
193
 
187
194
  ### Miscellaneous Chores
188
195
 
189
196
  * **verifiable-storage-models:** Synchronize repo versions
190
197
 
191
- ## [0.0.1-next.10](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.9...verifiable-storage-models-v0.0.1-next.10) (2025-05-22)
198
+ ## [0.0.1-next.10](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.9...verifiable-storage-models-v0.0.1-next.10) (2025-05-22)
192
199
 
193
200
 
194
201
  ### Features
195
202
 
196
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
203
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
197
204
 
198
- ## [0.0.1-next.9](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.8...verifiable-storage-models-v0.0.1-next.9) (2025-05-06)
205
+ ## [0.0.1-next.9](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.8...verifiable-storage-models-v0.0.1-next.9) (2025-05-06)
199
206
 
200
207
 
201
208
  ### Miscellaneous Chores
202
209
 
203
210
  * **verifiable-storage-models:** Synchronize repo versions
204
211
 
205
- ## [0.0.1-next.8](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.7...verifiable-storage-models-v0.0.1-next.8) (2025-04-24)
212
+ ## [0.0.1-next.8](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.7...verifiable-storage-models-v0.0.1-next.8) (2025-04-24)
206
213
 
207
214
 
208
215
  ### Miscellaneous Chores
209
216
 
210
217
  * **verifiable-storage-models:** Synchronize repo versions
211
218
 
212
- ## [0.0.1-next.7](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.6...verifiable-storage-models-v0.0.1-next.7) (2025-04-23)
219
+ ## [0.0.1-next.7](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.6...verifiable-storage-models-v0.0.1-next.7) (2025-04-23)
213
220
 
214
221
 
215
222
  ### Miscellaneous Chores
216
223
 
217
224
  * **verifiable-storage-models:** Synchronize repo versions
218
225
 
219
- ## [0.0.1-next.6](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.5...verifiable-storage-models-v0.0.1-next.6) (2025-04-23)
226
+ ## [0.0.1-next.6](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.5...verifiable-storage-models-v0.0.1-next.6) (2025-04-23)
220
227
 
221
228
 
222
229
  ### Miscellaneous Chores
223
230
 
224
231
  * **verifiable-storage-models:** Synchronize repo versions
225
232
 
226
- ## [0.0.1-next.5](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.4...verifiable-storage-models-v0.0.1-next.5) (2025-04-23)
233
+ ## [0.0.1-next.5](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.4...verifiable-storage-models-v0.0.1-next.5) (2025-04-23)
227
234
 
228
235
 
229
236
  ### Miscellaneous Chores
230
237
 
231
238
  * **verifiable-storage-models:** Synchronize repo versions
232
239
 
233
- ## [0.0.1-next.4](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.3...verifiable-storage-models-v0.0.1-next.4) (2025-04-17)
240
+ ## [0.0.1-next.4](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.3...verifiable-storage-models-v0.0.1-next.4) (2025-04-17)
234
241
 
235
242
 
236
243
  ### Features
237
244
 
238
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
245
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
239
246
 
240
- ## [0.0.1-next.3](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.2...verifiable-storage-models-v0.0.1-next.3) (2025-04-17)
247
+ ## [0.0.1-next.3](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.2...verifiable-storage-models-v0.0.1-next.3) (2025-04-17)
241
248
 
242
249
 
243
250
  ### Features
244
251
 
245
- * use new dlt packages with latency fix ([#6](https://github.com/twinfoundation/verifiable-storage/issues/6)) ([d81c45b](https://github.com/twinfoundation/verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
252
+ * use new dlt packages with latency fix ([#6](https://github.com/iotaledger/twin-verifiable-storage/issues/6)) ([d81c45b](https://github.com/iotaledger/twin-verifiable-storage/commit/d81c45bce035864a41bbd498815169d7257fbcb8))
246
253
 
247
- ## [0.0.1-next.2](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.1...verifiable-storage-models-v0.0.1-next.2) (2025-03-28)
254
+ ## [0.0.1-next.2](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.1-next.1...verifiable-storage-models-v0.0.1-next.2) (2025-03-28)
248
255
 
249
256
 
250
257
  ### Features
251
258
 
252
- * update descriptions ([696be4d](https://github.com/twinfoundation/verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
259
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
253
260
 
254
261
  ## v0.0.1-next.1
255
262
 
package/docs/examples.md CHANGED
@@ -1 +1,51 @@
1
- # @twin.org/verifiable-storage-models - Examples
1
+ # Verifiable Storage Models Examples
2
+
3
+ This page provides TypeScript examples for the verifiable storage models, including how to use the main interfaces, types, and the connector factory. These examples are intended to help you understand the structure and usage of the verifiable storage model layer.
4
+
5
+ ## VerifiableStorageConnectorFactory
6
+
7
+ ```typescript
8
+ import { VerifiableStorageConnectorFactory } from '@twin.org/verifiable-storage-models';
9
+
10
+ // List available connector names
11
+ const connectorNames = VerifiableStorageConnectorFactory.names();
12
+ console.log(connectorNames); // Outputs an array of connector names
13
+
14
+ // Get a connector instance (example, replace 'entity-storage' with your connector name)
15
+ const connector = VerifiableStorageConnectorFactory.get('entity-storage');
16
+ console.log(connector.className()); // Outputs the class name of the connector
17
+ ```
18
+
19
+ ## IVerifiableStorageConnector
20
+
21
+ ```typescript
22
+ import type { IVerifiableStorageConnector } from '@twin.org/verifiable-storage-models';
23
+
24
+ async function createAndGetItem(connector: IVerifiableStorageConnector) {
25
+ const controllerIdentity = 'did:example:controller1';
26
+ const data = new TextEncoder().encode('Sample data');
27
+ const allowList = ['did:example:controller1'];
28
+ const { id, receipt } = await connector.create(controllerIdentity, data, allowList, {
29
+ maxAllowListSize: 5
30
+ });
31
+ console.log(id); // Outputs the new item id
32
+ const item = await connector.get(id);
33
+ if (item.data) {
34
+ const decoded = new TextDecoder().decode(item.data);
35
+ console.log(decoded); // Sample data
36
+ }
37
+ }
38
+ ```
39
+
40
+ ## IVerifiableStorageComponent
41
+
42
+ ```typescript
43
+ import type { IVerifiableStorageComponent } from '@twin.org/verifiable-storage-models';
44
+
45
+ async function createItem(component: IVerifiableStorageComponent) {
46
+ const data = new TextEncoder().encode('Component data');
47
+ const allowList = ['did:example:controller1'];
48
+ const { id, receipt } = await component.create(data, allowList, { maxAllowListSize: 3 });
49
+ console.log(id); // Outputs the new item id
50
+ }
51
+ ```
package/docs/reference/interfaces/IVerifiableStorageComponent.md CHANGED
@@ -8,7 +8,7 @@ Interface describing a Verifiable Storage component.
8
8
 
9
9
  ## Methods
10
10
 
11
- ### create()
11
+ ### create() {#create}
12
12
 
13
13
  > **create**(`data`, `allowList?`, `options?`, `namespace?`, `controller?`): `Promise`\<\{ `id`: `string`; `receipt`: `IJsonLdNodeObject`; \}\>
14
14
 
@@ -58,7 +58,7 @@ The id of the stored verifiable item in urn format and the receipt.
58
58
 
59
59
  ***
60
60
 
61
- ### update()
61
+ ### update() {#update}
62
62
 
63
63
  > **update**(`id`, `data?`, `allowList?`, `controller?`): `Promise`\<`IJsonLdNodeObject`\>
64
64
 
@@ -98,7 +98,7 @@ The updated receipt.
98
98
 
99
99
  ***
100
100
 
101
- ### get()
101
+ ### get() {#get}
102
102
 
103
103
  > **get**(`id`, `options?`): `Promise`\<\{ `data?`: `Uint8Array`\<`ArrayBufferLike`\>; `receipt`: `IJsonLdNodeObject`; `allowList?`: `string`[]; \}\>
104
104
 
@@ -136,7 +136,7 @@ The data for the item and the receipt.
136
136
 
137
137
  ***
138
138
 
139
- ### remove()
139
+ ### remove() {#remove}
140
140
 
141
141
  > **remove**(`id`, `controller?`): `Promise`\<`void`\>
142
142
 
package/docs/reference/interfaces/IVerifiableStorageConnector.md CHANGED
@@ -8,7 +8,7 @@ Interface describing a verifiable storage connector.
8
8
 
9
9
  ## Methods
10
10
 
11
- ### create()
11
+ ### create() {#create}
12
12
 
13
13
  > **create**(`controllerIdentity`, `data`, `allowList?`, `options?`): `Promise`\<\{ `id`: `string`; `receipt`: `IJsonLdNodeObject`; \}\>
14
14
 
@@ -52,7 +52,7 @@ The id of the stored verifiable item in urn format and the receipt.
52
52
 
53
53
  ***
54
54
 
55
- ### update()
55
+ ### update() {#update}
56
56
 
57
57
  > **update**(`controllerIdentity`, `id`, `data?`, `allowList?`): `Promise`\<`IJsonLdNodeObject`\>
58
58
 
@@ -92,7 +92,7 @@ The updated receipt.
92
92
 
93
93
  ***
94
94
 
95
- ### get()
95
+ ### get() {#get}
96
96
 
97
97
  > **get**(`id`, `options?`): `Promise`\<\{ `data?`: `Uint8Array`\<`ArrayBufferLike`\>; `receipt`: `IJsonLdNodeObject`; `allowList?`: `string`[]; \}\>
98
98
 
@@ -130,7 +130,7 @@ The data for the item, the receipt and the allow list.
130
130
 
131
131
  ***
132
132
 
133
- ### remove()
133
+ ### remove() {#remove}
134
134
 
135
135
  > **remove**(`controllerIdentity`, `id`): `Promise`\<`void`\>
136
136
 
package/docs/reference/interfaces/IVerifiableStorageCreateRequest.md CHANGED
@@ -4,7 +4,7 @@ Store the data and return the verifiable storage item id.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### body
7
+ ### body {#body}
8
8
 
9
9
  > **body**: `object`
10
10
 
@@ -18,13 +18,13 @@ The data for the verifiable storage item, this is a string serialized as base64.
18
18
 
19
19
  #### allowList?
20
20
 
21
- > `optional` **allowList**: `string`[]
21
+ > `optional` **allowList?**: `string`[]
22
22
 
23
23
  The list of identities that are allowed to modify the item.
24
24
 
25
25
  #### maxAllowListSize?
26
26
 
27
- > `optional` **maxAllowListSize**: `number`
27
+ > `optional` **maxAllowListSize?**: `number`
28
28
 
29
29
  The maximum size of the allow list.
30
30
 
@@ -36,6 +36,6 @@ The maximum size of the allow list.
36
36
 
37
37
  #### namespace?
38
38
 
39
- > `optional` **namespace**: `string`
39
+ > `optional` **namespace?**: `string`
40
40
 
41
41
  The namespace of the connector to use for the verifiable storage item, defaults to component configured namespace.
package/docs/reference/interfaces/IVerifiableStorageCreateResponse.md CHANGED
@@ -8,7 +8,7 @@ Response to storing the verifiable storage item.
8
8
 
9
9
  ## Properties
10
10
 
11
- ### body
11
+ ### body {#body}
12
12
 
13
13
  > **body**: `object`
14
14
 
package/docs/reference/interfaces/IVerifiableStorageGetRequest.md CHANGED
@@ -4,7 +4,7 @@ Get the verifiable storage item.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### pathParams
7
+ ### pathParams {#pathparams}
8
8
 
9
9
  > **pathParams**: `object`
10
10
 
@@ -18,15 +18,15 @@ The id of the verifiable storage item to resolve.
18
18
 
19
19
  ***
20
20
 
21
- ### body?
21
+ ### body? {#body}
22
22
 
23
- > `optional` **body**: `object`
23
+ > `optional` **body?**: `object`
24
24
 
25
25
  The body optional param.
26
26
 
27
27
  #### includeData?
28
28
 
29
- > `optional` **includeData**: `boolean`
29
+ > `optional` **includeData?**: `boolean`
30
30
 
31
31
  The flag to include the data.
32
32
 
@@ -38,7 +38,7 @@ true
38
38
 
39
39
  #### includeAllowList?
40
40
 
41
- > `optional` **includeAllowList**: `boolean`
41
+ > `optional` **includeAllowList?**: `boolean`
42
42
 
43
43
  The flag to include the allow list.
44
44
 
package/docs/reference/interfaces/IVerifiableStorageGetResponse.md CHANGED
@@ -4,7 +4,7 @@ Response to getting the verifiable storage item.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### body
7
+ ### body {#body}
8
8
 
9
9
  > **body**: `object`
10
10
 
@@ -18,12 +18,12 @@ The receipt associated to the verifiable storage item.
18
18
 
19
19
  #### data?
20
20
 
21
- > `optional` **data**: `string`
21
+ > `optional` **data?**: `string`
22
22
 
23
23
  The data of the verifiable storage item, this is a string serialized as base64.
24
24
 
25
25
  #### allowList?
26
26
 
27
- > `optional` **allowList**: `string`[]
27
+ > `optional` **allowList?**: `string`[]
28
28
 
29
29
  The list of identities that are allowed to modify the item.
package/docs/reference/interfaces/IVerifiableStorageRemoveRequest.md CHANGED
@@ -4,7 +4,7 @@ Remove the verifiable storage item.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### pathParams
7
+ ### pathParams {#pathparams}
8
8
 
9
9
  > **pathParams**: `object`
10
10
 
package/docs/reference/interfaces/IVerifiableStorageUpdateRequest.md CHANGED
@@ -4,7 +4,7 @@ Update the data and return the receipt.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### pathParams
7
+ ### pathParams {#pathparams}
8
8
 
9
9
  > **pathParams**: `object`
10
10
 
@@ -18,7 +18,7 @@ The id of the verifiable storage item to update.
18
18
 
19
19
  ***
20
20
 
21
- ### body
21
+ ### body {#body}
22
22
 
23
23
  > **body**: `object`
24
24
 
@@ -26,12 +26,12 @@ The data to be updated.
26
26
 
27
27
  #### data?
28
28
 
29
- > `optional` **data**: `string`
29
+ > `optional` **data?**: `string`
30
30
 
31
31
  The data which is a string serialized as base64, leave empty if just updating the allow list.
32
32
 
33
33
  #### allowList?
34
34
 
35
- > `optional` **allowList**: `string`[]
35
+ > `optional` **allowList?**: `string`[]
36
36
 
37
37
  An updated list of identities that are allowed to modify the item, send an empty list to remove all entries.
package/docs/reference/interfaces/IVerifiableStorageUpdateResponse.md CHANGED
@@ -4,7 +4,7 @@ Response to updating the verifiable storage item.
4
4
 
5
5
  ## Properties
6
6
 
7
- ### body
7
+ ### body {#body}
8
8
 
9
9
  > **body**: `IJsonLdNodeObject`
10
10
 
package/docs/reference/variables/VerifiableStorageContexts.md CHANGED
@@ -6,19 +6,19 @@ The contexts of verifiable storage data.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### Namespace
9
+ ### Namespace {#namespace}
10
10
 
11
11
  > `readonly` **Namespace**: `"https://schema.twindev.org/verifiable-storage/"` = `"https://schema.twindev.org/verifiable-storage/"`
12
12
 
13
13
  The canonical RDF namespace URI for Verifiable Storage.
14
14
 
15
- ### Context
15
+ ### Context {#context}
16
16
 
17
17
  > `readonly` **Context**: `"https://schema.twindev.org/verifiable-storage/"` = `"https://schema.twindev.org/verifiable-storage/"`
18
18
 
19
19
  The value to use in context for Verifiable Storage.
20
20
 
21
- ### JsonLdContext
21
+ ### JsonLdContext {#jsonldcontext}
22
22
 
23
23
  > `readonly` **JsonLdContext**: `"https://schema.twindev.org/verifiable-storage/types.jsonld"` = `"https://schema.twindev.org/verifiable-storage/types.jsonld"`
24
24
 
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/verifiable-storage-models",
3
- "version": "0.0.3-next.8",
4
- "description": "Contains models and classes for use with verifiable storage",
3
+ "version": "0.0.3-next.9",
4
+ "description": "Shared interfaces, API payload models, and connector factory contracts for verifiable storage",
5
5
  "repository": {
6
6
  "type": "git",
7
- "url": "git+https://github.com/twinfoundation/verifiable-storage.git",
7
+ "url": "git+https://github.com/iotaledger/verifiable-storage.git",
8
8
  "directory": "packages/verifiable-storage-models"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -51,7 +51,7 @@
51
51
  "schemas"
52
52
  ],
53
53
  "bugs": {
54
- "url": "git+https://github.com/twinfoundation/verifiable-storage/issues"
54
+ "url": "git+https://github.com/iotaledger/verifiable-storage/issues"
55
55
  },
56
56
  "homepage": "https://twindev.org"
57
57
  }