@twin.org/verifiable-storage-models 0.0.3-next.1 → 0.0.3-next.10

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 (17) hide show
  1. package/README.md +3 -1
  2. package/dist/es/models/verifiableStorageContexts.js +10 -2
  3. package/dist/es/models/verifiableStorageContexts.js.map +1 -1
  4. package/dist/types/models/verifiableStorageContexts.d.ts +10 -2
  5. package/docs/changelog.md +135 -61
  6. package/docs/examples.md +51 -1
  7. package/docs/reference/interfaces/IVerifiableStorageComponent.md +4 -4
  8. package/docs/reference/interfaces/IVerifiableStorageConnector.md +4 -4
  9. package/docs/reference/interfaces/IVerifiableStorageCreateRequest.md +4 -4
  10. package/docs/reference/interfaces/IVerifiableStorageCreateResponse.md +1 -1
  11. package/docs/reference/interfaces/IVerifiableStorageGetRequest.md +5 -5
  12. package/docs/reference/interfaces/IVerifiableStorageGetResponse.md +3 -3
  13. package/docs/reference/interfaces/IVerifiableStorageRemoveRequest.md +1 -1
  14. package/docs/reference/interfaces/IVerifiableStorageUpdateRequest.md +4 -4
  15. package/docs/reference/interfaces/IVerifiableStorageUpdateResponse.md +1 -1
  16. package/docs/reference/variables/VerifiableStorageContexts.md +15 -3
  17. 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/dist/es/models/verifiableStorageContexts.js CHANGED
@@ -6,8 +6,16 @@
6
6
  // eslint-disable-next-line @typescript-eslint/naming-convention
7
7
  export const VerifiableStorageContexts = {
8
8
  /**
9
- * The context root for the verifiable storage types.
9
+ * The canonical RDF namespace URI for Verifiable Storage.
10
10
  */
11
- ContextRoot: "https://schema.twindev.org/verifiable-storage/"
11
+ Namespace: "https://schema.twindev.org/verifiable-storage/",
12
+ /**
13
+ * The value to use in context for Verifiable Storage.
14
+ */
15
+ Context: "https://schema.twindev.org/verifiable-storage/",
16
+ /**
17
+ * The JSON-LD Context URL for Verifiable Storage.
18
+ */
19
+ JsonLdContext: "https://schema.twindev.org/verifiable-storage/types.jsonld"
12
20
  };
13
21
  //# sourceMappingURL=verifiableStorageContexts.js.map
package/dist/es/models/verifiableStorageContexts.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"verifiableStorageContexts.js","sourceRoot":"","sources":["../../../src/models/verifiableStorageContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACxC;;OAEG;IACH,WAAW,EAAE,gDAAgD;CACpD,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of verifiable storage data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const VerifiableStorageContexts = {\n\t/**\n\t * The context root for the verifiable storage types.\n\t */\n\tContextRoot: \"https://schema.twindev.org/verifiable-storage/\"\n} as const;\n\n/**\n * The contexts of verifiable storage data.\n */\nexport type VerifiableStorageContexts =\n\t(typeof VerifiableStorageContexts)[keyof typeof VerifiableStorageContexts];\n"]}
1
+ {"version":3,"file":"verifiableStorageContexts.js","sourceRoot":"","sources":["../../../src/models/verifiableStorageContexts.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAEvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACxC;;OAEG;IACH,SAAS,EAAE,gDAAgD;IAE3D;;OAEG;IACH,OAAO,EAAE,gDAAgD;IAEzD;;OAEG;IACH,aAAa,EAAE,4DAA4D;CAClE,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * The contexts of verifiable storage data.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const VerifiableStorageContexts = {\n\t/**\n\t * The canonical RDF namespace URI for Verifiable Storage.\n\t */\n\tNamespace: \"https://schema.twindev.org/verifiable-storage/\",\n\n\t/**\n\t * The value to use in context for Verifiable Storage.\n\t */\n\tContext: \"https://schema.twindev.org/verifiable-storage/\",\n\n\t/**\n\t * The JSON-LD Context URL for Verifiable Storage.\n\t */\n\tJsonLdContext: \"https://schema.twindev.org/verifiable-storage/types.jsonld\"\n} as const;\n\n/**\n * The contexts of verifiable storage data.\n */\nexport type VerifiableStorageContexts =\n\t(typeof VerifiableStorageContexts)[keyof typeof VerifiableStorageContexts];\n"]}
package/dist/types/models/verifiableStorageContexts.d.ts CHANGED
@@ -3,9 +3,17 @@
3
3
  */
4
4
  export declare const VerifiableStorageContexts: {
5
5
  /**
6
- * The context root for the verifiable storage types.
6
+ * The canonical RDF namespace URI for Verifiable Storage.
7
7
  */
8
- readonly ContextRoot: "https://schema.twindev.org/verifiable-storage/";
8
+ readonly Namespace: "https://schema.twindev.org/verifiable-storage/";
9
+ /**
10
+ * The value to use in context for Verifiable Storage.
11
+ */
12
+ readonly Context: "https://schema.twindev.org/verifiable-storage/";
13
+ /**
14
+ * The JSON-LD Context URL for Verifiable Storage.
15
+ */
16
+ readonly JsonLdContext: "https://schema.twindev.org/verifiable-storage/types.jsonld";
9
17
  };
10
18
  /**
11
19
  * The contexts of verifiable storage data.
package/docs/changelog.md CHANGED
@@ -1,195 +1,269 @@
1
- # @twin.org/verifiable-storage-models - Changelog
1
+ # Changelog
2
2
 
3
- ## [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)
3
+ ## [0.0.3-next.10](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.9...verifiable-storage-models-v0.0.3-next.10) (2026-05-12)
4
4
 
5
5
 
6
6
  ### Features
7
7
 
8
- * add context id features ([#40](https://github.com/twinfoundation/verifiable-storage/issues/40)) ([260b96a](https://github.com/twinfoundation/verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
9
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
10
- * add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
11
- * eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
12
- * update allow list name case ([278a787](https://github.com/twinfoundation/verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
13
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
14
- * update descriptions ([696be4d](https://github.com/twinfoundation/verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
15
- * update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
16
- * 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))
17
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
8
+ * typescript 6 update ([66823cf](https://github.com/iotaledger/twin-verifiable-storage/commit/66823cf7a6522622c889afdc49005d016e8574fe))
18
9
 
19
- ## [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)
10
+ ## [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)
11
+
12
+
13
+ ### Miscellaneous Chores
14
+
15
+ * **verifiable-storage-models:** Synchronize repo versions
16
+
17
+ ## [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)
18
+
19
+
20
+ ### Miscellaneous Chores
21
+
22
+ * **verifiable-storage-models:** Synchronize repo versions
23
+
24
+ ## [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)
25
+
26
+
27
+ ### Features
28
+
29
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
30
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
31
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
32
+ * context updates ([#44](https://github.com/iotaledger/twin-verifiable-storage/issues/44)) ([2f92558](https://github.com/iotaledger/twin-verifiable-storage/commit/2f9255835eddc9620268b6eb3bba723bc38a0591))
33
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
34
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
35
+ * update context and namespaces ([#42](https://github.com/iotaledger/twin-verifiable-storage/issues/42)) ([7863833](https://github.com/iotaledger/twin-verifiable-storage/commit/78638336c5cd7dce0c53aaf598aef603fbed7a9e))
36
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
37
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
38
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
39
+ * 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))
40
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
41
+
42
+ ## [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)
43
+
44
+
45
+ ### Miscellaneous Chores
46
+
47
+ * **verifiable-storage-models:** Synchronize repo versions
48
+
49
+ ## [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)
50
+
51
+
52
+ ### Miscellaneous Chores
53
+
54
+ * **verifiable-storage-models:** Synchronize repo versions
55
+
56
+ ## [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)
57
+
58
+
59
+ ### Miscellaneous Chores
60
+
61
+ * **verifiable-storage-models:** Synchronize repo versions
62
+
63
+ ## [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)
64
+
65
+
66
+ ### Features
67
+
68
+ * context updates ([#44](https://github.com/iotaledger/twin-verifiable-storage/issues/44)) ([2f92558](https://github.com/iotaledger/twin-verifiable-storage/commit/2f9255835eddc9620268b6eb3bba723bc38a0591))
69
+
70
+ ## [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)
71
+
72
+
73
+ ### Features
74
+
75
+ * update context and namespaces ([#42](https://github.com/iotaledger/twin-verifiable-storage/issues/42)) ([7863833](https://github.com/iotaledger/twin-verifiable-storage/commit/78638336c5cd7dce0c53aaf598aef603fbed7a9e))
76
+
77
+ ## [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)
78
+
79
+
80
+ ### Features
81
+
82
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
83
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
84
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
85
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
86
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
87
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
88
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
89
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
90
+ * 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))
91
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
92
+
93
+ ## [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)
20
94
 
21
95
 
22
96
  ### Features
23
97
 
24
- * add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
98
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
25
99
 
26
- ## [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)
100
+ ## [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)
27
101
 
28
102
 
29
103
  ### Features
30
104
 
31
- * eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
105
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
32
106
 
33
- ## [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)
107
+ ## [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)
34
108
 
35
109
 
36
110
  ### Features
37
111
 
38
- * update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
112
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
39
113
 
40
- ## [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)
114
+ ## [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)
41
115
 
42
116
 
43
117
  ### Miscellaneous Chores
44
118
 
45
119
  * **verifiable-storage-models:** Synchronize repo versions
46
120
 
47
- ## [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)
121
+ ## [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)
48
122
 
49
123
 
50
124
  ### Features
51
125
 
52
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
53
- * update allow list name case ([278a787](https://github.com/twinfoundation/verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
54
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
55
- * update descriptions ([696be4d](https://github.com/twinfoundation/verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
56
- * 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))
57
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
126
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
127
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
128
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
129
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
130
+ * 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))
131
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
58
132
 
59
- ## [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)
133
+ ## [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)
60
134
 
61
135
 
62
136
  ### Features
63
137
 
64
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
65
- * update allow list name case ([278a787](https://github.com/twinfoundation/verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
66
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
67
- * update descriptions ([696be4d](https://github.com/twinfoundation/verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
68
- * 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))
69
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
138
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
139
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
140
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
141
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
142
+ * 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))
143
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
70
144
 
71
145
  ## 0.0.1 (2025-07-09)
72
146
 
73
147
 
74
148
  ### Features
75
149
 
76
- * release to production ([6ce6744](https://github.com/twinfoundation/verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
150
+ * release to production ([6ce6744](https://github.com/iotaledger/twin-verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
77
151
 
78
- ## [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)
152
+ ## [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)
79
153
 
80
154
 
81
155
  ### Miscellaneous Chores
82
156
 
83
157
  * **verifiable-storage-models:** Synchronize repo versions
84
158
 
85
- ## [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)
159
+ ## [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)
86
160
 
87
161
 
88
162
  ### Features
89
163
 
90
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
164
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
91
165
 
92
- ## [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)
166
+ ## [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)
93
167
 
94
168
 
95
169
  ### Miscellaneous Chores
96
170
 
97
171
  * **verifiable-storage-models:** Synchronize repo versions
98
172
 
99
- ## [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)
173
+ ## [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)
100
174
 
101
175
 
102
176
  ### Features
103
177
 
104
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
105
- * update allow list name case ([278a787](https://github.com/twinfoundation/verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
106
- * update descriptions ([696be4d](https://github.com/twinfoundation/verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
107
- * 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))
108
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
178
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
179
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
180
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
181
+ * 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))
182
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
109
183
 
110
- ## [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)
184
+ ## [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)
111
185
 
112
186
 
113
187
  ### Miscellaneous Chores
114
188
 
115
189
  * **verifiable-storage-models:** Synchronize repo versions
116
190
 
117
- ## [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)
191
+ ## [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)
118
192
 
119
193
 
120
194
  ### Features
121
195
 
122
- * update allow list name case ([278a787](https://github.com/twinfoundation/verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
196
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
123
197
 
124
- ## [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)
198
+ ## [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)
125
199
 
126
200
 
127
201
  ### Miscellaneous Chores
128
202
 
129
203
  * **verifiable-storage-models:** Synchronize repo versions
130
204
 
131
- ## [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)
205
+ ## [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)
132
206
 
133
207
 
134
208
  ### Features
135
209
 
136
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
210
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
137
211
 
138
- ## [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)
212
+ ## [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)
139
213
 
140
214
 
141
215
  ### Miscellaneous Chores
142
216
 
143
217
  * **verifiable-storage-models:** Synchronize repo versions
144
218
 
145
- ## [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)
219
+ ## [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)
146
220
 
147
221
 
148
222
  ### Miscellaneous Chores
149
223
 
150
224
  * **verifiable-storage-models:** Synchronize repo versions
151
225
 
152
- ## [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)
226
+ ## [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)
153
227
 
154
228
 
155
229
  ### Miscellaneous Chores
156
230
 
157
231
  * **verifiable-storage-models:** Synchronize repo versions
158
232
 
159
- ## [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)
233
+ ## [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)
160
234
 
161
235
 
162
236
  ### Miscellaneous Chores
163
237
 
164
238
  * **verifiable-storage-models:** Synchronize repo versions
165
239
 
166
- ## [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)
240
+ ## [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)
167
241
 
168
242
 
169
243
  ### Miscellaneous Chores
170
244
 
171
245
  * **verifiable-storage-models:** Synchronize repo versions
172
246
 
173
- ## [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)
247
+ ## [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)
174
248
 
175
249
 
176
250
  ### Features
177
251
 
178
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
252
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
179
253
 
180
- ## [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)
254
+ ## [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)
181
255
 
182
256
 
183
257
  ### Features
184
258
 
185
- * 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))
259
+ * 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))
186
260
 
187
- ## [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)
261
+ ## [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)
188
262
 
189
263
 
190
264
  ### Features
191
265
 
192
- * update descriptions ([696be4d](https://github.com/twinfoundation/verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
266
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
193
267
 
194
268
  ## v0.0.1-next.1
195
269
 
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,8 +6,20 @@ The contexts of verifiable storage data.
6
6
 
7
7
  ## Type Declaration
8
8
 
9
- ### ContextRoot
9
+ ### Namespace {#namespace}
10
10
 
11
- > `readonly` **ContextRoot**: `"https://schema.twindev.org/verifiable-storage/"` = `"https://schema.twindev.org/verifiable-storage/"`
11
+ > `readonly` **Namespace**: `"https://schema.twindev.org/verifiable-storage/"` = `"https://schema.twindev.org/verifiable-storage/"`
12
12
 
13
- The context root for the verifiable storage types.
13
+ The canonical RDF namespace URI for Verifiable Storage.
14
+
15
+ ### Context {#context}
16
+
17
+ > `readonly` **Context**: `"https://schema.twindev.org/verifiable-storage/"` = `"https://schema.twindev.org/verifiable-storage/"`
18
+
19
+ The value to use in context for Verifiable Storage.
20
+
21
+ ### JsonLdContext {#jsonldcontext}
22
+
23
+ > `readonly` **JsonLdContext**: `"https://schema.twindev.org/verifiable-storage/types.jsonld"` = `"https://schema.twindev.org/verifiable-storage/types.jsonld"`
24
+
25
+ The JSON-LD Context URL for Verifiable Storage.
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/verifiable-storage-models",
3
- "version": "0.0.3-next.1",
4
- "description": "Contains models and classes for use with verifiable storage",
3
+ "version": "0.0.3-next.10",
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
  }