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

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 (26) hide show
  1. package/README.md +3 -1
  2. package/dist/es/models/IVerifiableStorageComponent.js.map +1 -1
  3. package/dist/es/models/IVerifiableStorageConnector.js.map +1 -1
  4. package/dist/es/models/api/IVerifiableStorageCreateResponse.js.map +1 -1
  5. package/dist/es/models/api/IVerifiableStorageGetResponse.js.map +1 -1
  6. package/dist/es/models/api/IVerifiableStorageRemoveRequest.js.map +1 -1
  7. package/dist/es/models/api/IVerifiableStorageUpdateResponse.js.map +1 -1
  8. package/dist/types/models/IVerifiableStorageComponent.d.ts +2 -2
  9. package/dist/types/models/IVerifiableStorageConnector.d.ts +2 -2
  10. package/dist/types/models/api/IVerifiableStorageCreateResponse.d.ts +1 -1
  11. package/dist/types/models/api/IVerifiableStorageGetResponse.d.ts +1 -1
  12. package/dist/types/models/api/IVerifiableStorageRemoveRequest.d.ts +1 -1
  13. package/dist/types/models/api/IVerifiableStorageUpdateResponse.d.ts +1 -1
  14. package/docs/changelog.md +137 -82
  15. package/docs/examples.md +51 -1
  16. package/docs/reference/interfaces/IVerifiableStorageComponent.md +6 -6
  17. package/docs/reference/interfaces/IVerifiableStorageConnector.md +6 -6
  18. package/docs/reference/interfaces/IVerifiableStorageCreateRequest.md +4 -4
  19. package/docs/reference/interfaces/IVerifiableStorageCreateResponse.md +2 -2
  20. package/docs/reference/interfaces/IVerifiableStorageGetRequest.md +5 -5
  21. package/docs/reference/interfaces/IVerifiableStorageGetResponse.md +4 -4
  22. package/docs/reference/interfaces/IVerifiableStorageRemoveRequest.md +2 -2
  23. package/docs/reference/interfaces/IVerifiableStorageUpdateRequest.md +4 -4
  24. package/docs/reference/interfaces/IVerifiableStorageUpdateResponse.md +2 -2
  25. package/docs/reference/variables/VerifiableStorageContexts.md +3 -3
  26. package/package.json +9 -9
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
 
@@ -1 +1 @@
1
- {"version":3,"file":"IVerifiableStorageComponent.js","sourceRoot":"","sources":["../../../src/models/IVerifiableStorageComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Interface describing a Verifiable Storage component.\n */\nexport interface IVerifiableStorageComponent extends IComponent {\n\t/**\n\t * Create an item in verifiable storage.\n\t * @param data The data to store.\n\t * @param allowList The list of identities that are allowed to modify the item.\n\t * @param options Additional options for creating the item.\n\t * @param options.maxAllowListSize The maximum size of the allow list.\n\t * @param namespace The namespace to store the item in.\n\t * @param controller The identity of the controller to access the vault keys.\n\t * @returns The id of the stored verifiable item in urn format and the receipt.\n\t */\n\tcreate(\n\t\tdata: Uint8Array,\n\t\tallowList?: string[],\n\t\toptions?: {\n\t\t\tmaxAllowListSize?: number;\n\t\t},\n\t\tnamespace?: string,\n\t\tcontroller?: string\n\t): Promise<{\n\t\tid: string;\n\t\treceipt: IJsonLdNodeObject;\n\t}>;\n\n\t/**\n\t * Update an item in verifiable storage.\n\t * @param id The id of the item to update.\n\t * @param data The data to store, optional if updating the allow list.\n\t * @param allowList Updated list of identities that are allowed to modify the item.\n\t * @param controller The identity of the controller to access the vault keys.\n\t * @returns The updated receipt.\n\t */\n\tupdate(\n\t\tid: string,\n\t\tdata?: Uint8Array,\n\t\tallowList?: string[],\n\t\tcontroller?: string\n\t): Promise<IJsonLdNodeObject>;\n\n\t/**\n\t * Get an verifiable item.\n\t * @param id The id of the item to get.\n\t * @param options Additional options for getting the item.\n\t * @param options.includeData Should the data be included in the response, defaults to true.\n\t * @param options.includeAllowList Should the allow list be included in the response, defaults to true.\n\t * @returns The data for the item and the receipt.\n\t */\n\tget(\n\t\tid: string,\n\t\toptions?: { includeData?: boolean; includeAllowList?: boolean }\n\t): Promise<{\n\t\tdata?: Uint8Array;\n\t\treceipt: IJsonLdNodeObject;\n\t\tallowList?: string[];\n\t}>;\n\n\t/**\n\t * Remove the item from verifiable storage.\n\t * @param id The id of the verifiable item to remove in urn format.\n\t * @param controller The identity of the controller.\n\t * @returns Nothing.\n\t */\n\tremove(id: string, controller?: string): Promise<void>;\n}\n"]}
1
+ {"version":3,"file":"IVerifiableStorageComponent.js","sourceRoot":"","sources":["../../../src/models/IVerifiableStorageComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Interface describing a Verifiable Storage component.\n */\nexport interface IVerifiableStorageComponent extends IComponent {\n\t/**\n\t * Create an item in verifiable storage.\n\t * @param data The data to store.\n\t * @param allowList The list of identities that are allowed to modify the item.\n\t * @param options Additional options for creating the item.\n\t * @param options.maxAllowListSize The maximum size of the allow list.\n\t * @param namespace The namespace to store the item in.\n\t * @param controller The identity of the controller to access the vault keys.\n\t * @returns The id of the stored verifiable item in urn format and the receipt.\n\t */\n\tcreate(\n\t\tdata: Uint8Array,\n\t\tallowList?: string[],\n\t\toptions?: {\n\t\t\tmaxAllowListSize?: number;\n\t\t},\n\t\tnamespace?: string,\n\t\tcontroller?: string\n\t): Promise<{\n\t\tid: string;\n\t\treceipt: IJsonLdNodeObject;\n\t}>;\n\n\t/**\n\t * Update an item in verifiable storage.\n\t * @param id The id of the item to update.\n\t * @param data The data to store, optional if updating the allow list.\n\t * @param allowList Updated list of identities that are allowed to modify the item.\n\t * @param controller The identity of the controller to access the vault keys.\n\t * @returns The updated receipt.\n\t */\n\tupdate(\n\t\tid: string,\n\t\tdata?: Uint8Array,\n\t\tallowList?: string[],\n\t\tcontroller?: string\n\t): Promise<IJsonLdNodeObject>;\n\n\t/**\n\t * Get a verifiable item.\n\t * @param id The id of the item to get.\n\t * @param options Additional options for getting the item.\n\t * @param options.includeData Should the data be included in the response, defaults to true.\n\t * @param options.includeAllowList Should the allow list be included in the response, defaults to true.\n\t * @returns The data for the item and the receipt.\n\t */\n\tget(\n\t\tid: string,\n\t\toptions?: { includeData?: boolean; includeAllowList?: boolean }\n\t): Promise<{\n\t\tdata?: Uint8Array;\n\t\treceipt: IJsonLdNodeObject;\n\t\tallowList?: string[];\n\t}>;\n\n\t/**\n\t * Remove the item from verifiable storage.\n\t * @param id The id of the verifiable item to remove in urn format.\n\t * @param controller The identity of the controller.\n\t * @returns A promise that resolves when the item has been removed.\n\t */\n\tremove(id: string, controller?: string): Promise<void>;\n}\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"IVerifiableStorageConnector.js","sourceRoot":"","sources":["../../../src/models/IVerifiableStorageConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Interface describing a verifiable storage connector.\n */\nexport interface IVerifiableStorageConnector extends IComponent {\n\t/**\n\t * Create an item in verifiable storage.\n\t * @param controllerIdentity The identity of the user to access the vault keys.\n\t * @param data The data to store.\n\t * @param allowList The list of identities that are allowed to modify the item.\n\t * @param options Additional options for creating the item.\n\t * @param options.maxAllowListSize The maximum size of the allow list.\n\t * @returns The id of the stored verifiable item in urn format and the receipt.\n\t */\n\tcreate(\n\t\tcontrollerIdentity: string,\n\t\tdata: Uint8Array,\n\t\tallowList?: string[],\n\t\toptions?: {\n\t\t\tmaxAllowListSize?: number;\n\t\t}\n\t): Promise<{\n\t\tid: string;\n\t\treceipt: IJsonLdNodeObject;\n\t}>;\n\n\t/**\n\t * Update an item in verifiable storage.\n\t * @param controllerIdentity The identity of the user to access the vault keys.\n\t * @param id The id of the item to update.\n\t * @param data The data to store, optional if updating the allow list.\n\t * @param allowList Updated list of identities that are allowed to modify the item.\n\t * @returns The updated receipt.\n\t */\n\tupdate(\n\t\tcontrollerIdentity: string,\n\t\tid: string,\n\t\tdata?: Uint8Array,\n\t\tallowList?: string[]\n\t): Promise<IJsonLdNodeObject>;\n\n\t/**\n\t * Get an verifiable item.\n\t * @param id The id of the item to get.\n\t * @param options Additional options for getting the item.\n\t * @param options.includeData Should the data be included in the response, defaults to true.\n\t * @param options.includeAllowList Should the allow list be included in the response, defaults to true.\n\t * @returns The data for the item, the receipt and the allow list.\n\t */\n\tget(\n\t\tid: string,\n\t\toptions?: { includeData?: boolean; includeAllowList?: boolean }\n\t): Promise<{\n\t\tdata?: Uint8Array;\n\t\treceipt: IJsonLdNodeObject;\n\t\tallowList?: string[];\n\t}>;\n\n\t/**\n\t * Remove the item from verifiable storage.\n\t * @param controllerIdentity The identity of the user to access the vault keys.\n\t * @param id The id of the verifiable item to remove in urn format.\n\t * @returns Nothing.\n\t */\n\tremove(controllerIdentity: string, id: string): Promise<void>;\n}\n"]}
1
+ {"version":3,"file":"IVerifiableStorageConnector.js","sourceRoot":"","sources":["../../../src/models/IVerifiableStorageConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Interface describing a verifiable storage connector.\n */\nexport interface IVerifiableStorageConnector extends IComponent {\n\t/**\n\t * Create an item in verifiable storage.\n\t * @param controllerIdentity The identity of the user to access the vault keys.\n\t * @param data The data to store.\n\t * @param allowList The list of identities that are allowed to modify the item.\n\t * @param options Additional options for creating the item.\n\t * @param options.maxAllowListSize The maximum size of the allow list.\n\t * @returns The id of the stored verifiable item in urn format and the receipt.\n\t */\n\tcreate(\n\t\tcontrollerIdentity: string,\n\t\tdata: Uint8Array,\n\t\tallowList?: string[],\n\t\toptions?: {\n\t\t\tmaxAllowListSize?: number;\n\t\t}\n\t): Promise<{\n\t\tid: string;\n\t\treceipt: IJsonLdNodeObject;\n\t}>;\n\n\t/**\n\t * Update an item in verifiable storage.\n\t * @param controllerIdentity The identity of the user to access the vault keys.\n\t * @param id The id of the item to update.\n\t * @param data The data to store, optional if updating the allow list.\n\t * @param allowList Updated list of identities that are allowed to modify the item.\n\t * @returns The updated receipt.\n\t */\n\tupdate(\n\t\tcontrollerIdentity: string,\n\t\tid: string,\n\t\tdata?: Uint8Array,\n\t\tallowList?: string[]\n\t): Promise<IJsonLdNodeObject>;\n\n\t/**\n\t * Get a verifiable item.\n\t * @param id The id of the item to get.\n\t * @param options Additional options for getting the item.\n\t * @param options.includeData Should the data be included in the response, defaults to true.\n\t * @param options.includeAllowList Should the allow list be included in the response, defaults to true.\n\t * @returns The data for the item, the receipt and the allow list.\n\t */\n\tget(\n\t\tid: string,\n\t\toptions?: { includeData?: boolean; includeAllowList?: boolean }\n\t): Promise<{\n\t\tdata?: Uint8Array;\n\t\treceipt: IJsonLdNodeObject;\n\t\tallowList?: string[];\n\t}>;\n\n\t/**\n\t * Remove the item from verifiable storage.\n\t * @param controllerIdentity The identity of the user to access the vault keys.\n\t * @param id The id of the verifiable item to remove in urn format.\n\t * @returns A promise that resolves when the item has been removed.\n\t */\n\tremove(controllerIdentity: string, id: string): Promise<void>;\n}\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"IVerifiableStorageCreateResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageCreateResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ICreatedResponse } from \"@twin.org/api-models\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Response to storing the verifiable storage item.\n */\nexport interface IVerifiableStorageCreateResponse extends ICreatedResponse {\n\t/**\n\t * The data that was stored.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The receipt associated to the verifiable storage item.\n\t\t */\n\t\treceipt: IJsonLdNodeObject;\n\n\t\t/**\n\t\t * The id of the verifiable storage item.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
1
+ {"version":3,"file":"IVerifiableStorageCreateResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageCreateResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { ICreatedResponse } from \"@twin.org/api-models\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Response to storing the verifiable storage item.\n */\nexport interface IVerifiableStorageCreateResponse extends ICreatedResponse {\n\t/**\n\t * The created verifiable storage item details.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The receipt associated to the verifiable storage item.\n\t\t */\n\t\treceipt: IJsonLdNodeObject;\n\n\t\t/**\n\t\t * The id of the verifiable storage item.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"IVerifiableStorageGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Response to getting the verifiable storage item.\n */\nexport interface IVerifiableStorageGetResponse {\n\t/**\n\t * The data that was obtained.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The receipt associated to the verifiable storage item.\n\t\t */\n\t\treceipt: IJsonLdNodeObject;\n\n\t\t/**\n\t\t * The data of the verifiable storage item, this is a string serialized as base64.\n\t\t */\n\t\tdata?: string;\n\n\t\t/**\n\t\t * The list of identities that are allowed to modify the item.\n\t\t */\n\t\tallowList?: string[];\n\t};\n}\n"]}
1
+ {"version":3,"file":"IVerifiableStorageGetResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageGetResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Response to getting the verifiable storage item.\n */\nexport interface IVerifiableStorageGetResponse {\n\t/**\n\t * The retrieved verifiable storage item contents.\n\t */\n\tbody: {\n\t\t/**\n\t\t * The receipt associated to the verifiable storage item.\n\t\t */\n\t\treceipt: IJsonLdNodeObject;\n\n\t\t/**\n\t\t * The data of the verifiable storage item, this is a string serialized as base64.\n\t\t */\n\t\tdata?: string;\n\n\t\t/**\n\t\t * The list of identities that are allowed to modify the item.\n\t\t */\n\t\tallowList?: string[];\n\t};\n}\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"IVerifiableStorageRemoveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageRemoveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Remove the verifiable storage item.\n */\nexport interface IVerifiableStorageRemoveRequest {\n\t/**\n\t * The data to be used for resolving.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the verifiable storage item to remove.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
1
+ {"version":3,"file":"IVerifiableStorageRemoveRequest.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageRemoveRequest.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Remove the verifiable storage item.\n */\nexport interface IVerifiableStorageRemoveRequest {\n\t/**\n\t * The path parameters for the request.\n\t */\n\tpathParams: {\n\t\t/**\n\t\t * The id of the verifiable storage item to remove.\n\t\t */\n\t\tid: string;\n\t};\n}\n"]}
@@ -1 +1 @@
1
- {"version":3,"file":"IVerifiableStorageUpdateResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageUpdateResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Response to updating the verifiable storage item.\n */\nexport interface IVerifiableStorageUpdateResponse {\n\t/**\n\t * The data that was updated.\n\t */\n\tbody: IJsonLdNodeObject;\n}\n"]}
1
+ {"version":3,"file":"IVerifiableStorageUpdateResponse.js","sourceRoot":"","sources":["../../../../src/models/api/IVerifiableStorageUpdateResponse.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\n\n/**\n * Response to updating the verifiable storage item.\n */\nexport interface IVerifiableStorageUpdateResponse {\n\t/**\n\t * The receipt for the updated verifiable storage item.\n\t */\n\tbody: IJsonLdNodeObject;\n}\n"]}
@@ -30,7 +30,7 @@ export interface IVerifiableStorageComponent extends IComponent {
30
30
  */
31
31
  update(id: string, data?: Uint8Array, allowList?: string[], controller?: string): Promise<IJsonLdNodeObject>;
32
32
  /**
33
- * Get an verifiable item.
33
+ * Get a verifiable item.
34
34
  * @param id The id of the item to get.
35
35
  * @param options Additional options for getting the item.
36
36
  * @param options.includeData Should the data be included in the response, defaults to true.
@@ -49,7 +49,7 @@ export interface IVerifiableStorageComponent extends IComponent {
49
49
  * Remove the item from verifiable storage.
50
50
  * @param id The id of the verifiable item to remove in urn format.
51
51
  * @param controller The identity of the controller.
52
- * @returns Nothing.
52
+ * @returns A promise that resolves when the item has been removed.
53
53
  */
54
54
  remove(id: string, controller?: string): Promise<void>;
55
55
  }
@@ -29,7 +29,7 @@ export interface IVerifiableStorageConnector extends IComponent {
29
29
  */
30
30
  update(controllerIdentity: string, id: string, data?: Uint8Array, allowList?: string[]): Promise<IJsonLdNodeObject>;
31
31
  /**
32
- * Get an verifiable item.
32
+ * Get a verifiable item.
33
33
  * @param id The id of the item to get.
34
34
  * @param options Additional options for getting the item.
35
35
  * @param options.includeData Should the data be included in the response, defaults to true.
@@ -48,7 +48,7 @@ export interface IVerifiableStorageConnector extends IComponent {
48
48
  * Remove the item from verifiable storage.
49
49
  * @param controllerIdentity The identity of the user to access the vault keys.
50
50
  * @param id The id of the verifiable item to remove in urn format.
51
- * @returns Nothing.
51
+ * @returns A promise that resolves when the item has been removed.
52
52
  */
53
53
  remove(controllerIdentity: string, id: string): Promise<void>;
54
54
  }
@@ -5,7 +5,7 @@ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
5
5
  */
6
6
  export interface IVerifiableStorageCreateResponse extends ICreatedResponse {
7
7
  /**
8
- * The data that was stored.
8
+ * The created verifiable storage item details.
9
9
  */
10
10
  body: {
11
11
  /**
@@ -4,7 +4,7 @@ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
4
4
  */
5
5
  export interface IVerifiableStorageGetResponse {
6
6
  /**
7
- * The data that was obtained.
7
+ * The retrieved verifiable storage item contents.
8
8
  */
9
9
  body: {
10
10
  /**
@@ -3,7 +3,7 @@
3
3
  */
4
4
  export interface IVerifiableStorageRemoveRequest {
5
5
  /**
6
- * The data to be used for resolving.
6
+ * The path parameters for the request.
7
7
  */
8
8
  pathParams: {
9
9
  /**
@@ -4,7 +4,7 @@ import type { IJsonLdNodeObject } from "@twin.org/data-json-ld";
4
4
  */
5
5
  export interface IVerifiableStorageUpdateResponse {
6
6
  /**
7
- * The data that was updated.
7
+ * The receipt for the updated verifiable storage item.
8
8
  */
9
9
  body: IJsonLdNodeObject;
10
10
  }
package/docs/changelog.md CHANGED
@@ -1,255 +1,310 @@
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.9.0-next.1](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.9.0-next.0...verifiable-storage-models-v0.9.0-next.1) (2026-06-23)
4
+
5
+
6
+ ### Features
7
+
8
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
9
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
10
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
11
+ * context updates ([#44](https://github.com/iotaledger/twin-verifiable-storage/issues/44)) ([2f92558](https://github.com/iotaledger/twin-verifiable-storage/commit/2f9255835eddc9620268b6eb3bba723bc38a0591))
12
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
13
+ * typescript 6 update ([66823cf](https://github.com/iotaledger/twin-verifiable-storage/commit/66823cf7a6522622c889afdc49005d016e8574fe))
14
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
15
+ * update context and namespaces ([#42](https://github.com/iotaledger/twin-verifiable-storage/issues/42)) ([7863833](https://github.com/iotaledger/twin-verifiable-storage/commit/78638336c5cd7dce0c53aaf598aef603fbed7a9e))
16
+ * update dependencies ([44f2a99](https://github.com/iotaledger/twin-verifiable-storage/commit/44f2a99954ab54ecc0726c8c984bccffc3eaa433))
17
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
18
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
19
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
20
+ * 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))
21
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
22
+
23
+ ## [0.0.3-next.13](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.12...verifiable-storage-models-v0.0.3-next.13) (2026-06-11)
24
+
25
+
26
+ ### Miscellaneous Chores
27
+
28
+ * **verifiable-storage-models:** Synchronize repo versions
29
+
30
+ ## [0.0.3-next.12](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.11...verifiable-storage-models-v0.0.3-next.12) (2026-05-28)
31
+
32
+
33
+ ### Miscellaneous Chores
34
+
35
+ * **verifiable-storage-models:** Synchronize repo versions
36
+
37
+ ## [0.0.3-next.11](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-models-v0.0.3-next.10...verifiable-storage-models-v0.0.3-next.11) (2026-05-20)
38
+
39
+
40
+ ### Features
41
+
42
+ * update dependencies ([44f2a99](https://github.com/iotaledger/twin-verifiable-storage/commit/44f2a99954ab54ecc0726c8c984bccffc3eaa433))
43
+
44
+ ## [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)
45
+
46
+
47
+ ### Features
48
+
49
+ * typescript 6 update ([66823cf](https://github.com/iotaledger/twin-verifiable-storage/commit/66823cf7a6522622c889afdc49005d016e8574fe))
50
+
51
+ ## [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)
52
+
53
+
54
+ ### Miscellaneous Chores
55
+
56
+ * **verifiable-storage-models:** Synchronize repo versions
57
+
58
+ ## [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)
4
59
 
5
60
 
6
61
  ### Miscellaneous Chores
7
62
 
8
63
  * **verifiable-storage-models:** Synchronize repo versions
9
64
 
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)
65
+ ## [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
66
 
12
67
 
13
68
  ### Features
14
69
 
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))
70
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
71
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
72
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
73
+ * context updates ([#44](https://github.com/iotaledger/twin-verifiable-storage/issues/44)) ([2f92558](https://github.com/iotaledger/twin-verifiable-storage/commit/2f9255835eddc9620268b6eb3bba723bc38a0591))
74
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
75
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
76
+ * update context and namespaces ([#42](https://github.com/iotaledger/twin-verifiable-storage/issues/42)) ([7863833](https://github.com/iotaledger/twin-verifiable-storage/commit/78638336c5cd7dce0c53aaf598aef603fbed7a9e))
77
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
78
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
79
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
80
+ * 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))
81
+ * 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
82
 
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)
83
+ ## [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
84
 
30
85
 
31
86
  ### Miscellaneous Chores
32
87
 
33
88
  * **verifiable-storage-models:** Synchronize repo versions
34
89
 
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)
90
+ ## [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
91
 
37
92
 
38
93
  ### Miscellaneous Chores
39
94
 
40
95
  * **verifiable-storage-models:** Synchronize repo versions
41
96
 
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)
97
+ ## [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
98
 
44
99
 
45
100
  ### Miscellaneous Chores
46
101
 
47
102
  * **verifiable-storage-models:** Synchronize repo versions
48
103
 
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)
104
+ ## [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
105
 
51
106
 
52
107
  ### Features
53
108
 
54
- * context updates ([#44](https://github.com/twinfoundation/verifiable-storage/issues/44)) ([2f92558](https://github.com/twinfoundation/verifiable-storage/commit/2f9255835eddc9620268b6eb3bba723bc38a0591))
109
+ * context updates ([#44](https://github.com/iotaledger/twin-verifiable-storage/issues/44)) ([2f92558](https://github.com/iotaledger/twin-verifiable-storage/commit/2f9255835eddc9620268b6eb3bba723bc38a0591))
55
110
 
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)
111
+ ## [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
112
 
58
113
 
59
114
  ### Features
60
115
 
61
- * update context and namespaces ([#42](https://github.com/twinfoundation/verifiable-storage/issues/42)) ([7863833](https://github.com/twinfoundation/verifiable-storage/commit/78638336c5cd7dce0c53aaf598aef603fbed7a9e))
116
+ * 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
117
 
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)
118
+ ## [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
119
 
65
120
 
66
121
  ### Features
67
122
 
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))
123
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
124
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
125
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
126
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
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
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
131
+ * 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))
132
+ * 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
133
 
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)
134
+ ## [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
135
 
81
136
 
82
137
  ### Features
83
138
 
84
- * add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
139
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
85
140
 
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)
141
+ ## [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
142
 
88
143
 
89
144
  ### Features
90
145
 
91
- * eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
146
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
92
147
 
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)
148
+ ## [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
149
 
95
150
 
96
151
  ### Features
97
152
 
98
- * update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
153
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
99
154
 
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)
155
+ ## [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
156
 
102
157
 
103
158
  ### Miscellaneous Chores
104
159
 
105
160
  * **verifiable-storage-models:** Synchronize repo versions
106
161
 
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)
162
+ ## [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
163
 
109
164
 
110
165
  ### Features
111
166
 
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))
167
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
168
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
169
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
170
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
171
+ * 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))
172
+ * 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
173
 
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)
174
+ ## [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
175
 
121
176
 
122
177
  ### Features
123
178
 
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))
179
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
180
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
181
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
182
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
183
+ * 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))
184
+ * 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
185
 
131
186
  ## 0.0.1 (2025-07-09)
132
187
 
133
188
 
134
189
  ### Features
135
190
 
136
- * release to production ([6ce6744](https://github.com/twinfoundation/verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
191
+ * release to production ([6ce6744](https://github.com/iotaledger/twin-verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
137
192
 
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)
193
+ ## [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
194
 
140
195
 
141
196
  ### Miscellaneous Chores
142
197
 
143
198
  * **verifiable-storage-models:** Synchronize repo versions
144
199
 
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)
200
+ ## [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
201
 
147
202
 
148
203
  ### Features
149
204
 
150
- * update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
205
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
151
206
 
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)
207
+ ## [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
208
 
154
209
 
155
210
  ### Miscellaneous Chores
156
211
 
157
212
  * **verifiable-storage-models:** Synchronize repo versions
158
213
 
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)
214
+ ## [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
215
 
161
216
 
162
217
  ### Features
163
218
 
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))
219
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
220
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
221
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
222
+ * 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))
223
+ * 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
224
 
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)
225
+ ## [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
226
 
172
227
 
173
228
  ### Miscellaneous Chores
174
229
 
175
230
  * **verifiable-storage-models:** Synchronize repo versions
176
231
 
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)
232
+ ## [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
233
 
179
234
 
180
235
  ### Features
181
236
 
182
- * update allow list name case ([278a787](https://github.com/twinfoundation/verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
237
+ * update allow list name case ([278a787](https://github.com/iotaledger/twin-verifiable-storage/commit/278a787e96864c95438f87adaac6f2fc8b6bebcd))
183
238
 
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)
239
+ ## [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
240
 
186
241
 
187
242
  ### Miscellaneous Chores
188
243
 
189
244
  * **verifiable-storage-models:** Synchronize repo versions
190
245
 
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)
246
+ ## [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
247
 
193
248
 
194
249
  ### Features
195
250
 
196
- * add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
251
+ * 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
252
 
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)
253
+ ## [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
254
 
200
255
 
201
256
  ### Miscellaneous Chores
202
257
 
203
258
  * **verifiable-storage-models:** Synchronize repo versions
204
259
 
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)
260
+ ## [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
261
 
207
262
 
208
263
  ### Miscellaneous Chores
209
264
 
210
265
  * **verifiable-storage-models:** Synchronize repo versions
211
266
 
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)
267
+ ## [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
268
 
214
269
 
215
270
  ### Miscellaneous Chores
216
271
 
217
272
  * **verifiable-storage-models:** Synchronize repo versions
218
273
 
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)
274
+ ## [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
275
 
221
276
 
222
277
  ### Miscellaneous Chores
223
278
 
224
279
  * **verifiable-storage-models:** Synchronize repo versions
225
280
 
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)
281
+ ## [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
282
 
228
283
 
229
284
  ### Miscellaneous Chores
230
285
 
231
286
  * **verifiable-storage-models:** Synchronize repo versions
232
287
 
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)
288
+ ## [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
289
 
235
290
 
236
291
  ### Features
237
292
 
238
- * use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
293
+ * 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
294
 
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)
295
+ ## [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
296
 
242
297
 
243
298
  ### Features
244
299
 
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))
300
+ * 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
301
 
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)
302
+ ## [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
303
 
249
304
 
250
305
  ### Features
251
306
 
252
- * update descriptions ([696be4d](https://github.com/twinfoundation/verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
307
+ * update descriptions ([696be4d](https://github.com/iotaledger/twin-verifiable-storage/commit/696be4d253183375d4c96e5b74eca0c814fe2fd1))
253
308
 
254
309
  ## v0.0.1-next.1
255
310
 
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
+ ```
@@ -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,11 +98,11 @@ 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
 
105
- Get an verifiable item.
105
+ Get a verifiable item.
106
106
 
107
107
  #### Parameters
108
108
 
@@ -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
 
@@ -160,4 +160,4 @@ The identity of the controller.
160
160
 
161
161
  `Promise`\<`void`\>
162
162
 
163
- Nothing.
163
+ A promise that resolves when the item has been removed.
@@ -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,11 +92,11 @@ 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
 
99
- Get an verifiable item.
99
+ Get a verifiable item.
100
100
 
101
101
  #### Parameters
102
102
 
@@ -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
 
@@ -154,4 +154,4 @@ The id of the verifiable item to remove in urn format.
154
154
 
155
155
  `Promise`\<`void`\>
156
156
 
157
- Nothing.
157
+ A promise that resolves when the item has been removed.
@@ -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.
@@ -8,11 +8,11 @@ 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
 
15
- The data that was stored.
15
+ The created verifiable storage item details.
16
16
 
17
17
  #### receipt
18
18
 
@@ -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
 
@@ -4,11 +4,11 @@ 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
 
11
- The data that was obtained.
11
+ The retrieved verifiable storage item contents.
12
12
 
13
13
  #### receipt
14
14
 
@@ -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.
@@ -4,11 +4,11 @@ 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
 
11
- The data to be used for resolving.
11
+ The path parameters for the request.
12
12
 
13
13
  #### id
14
14
 
@@ -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.
@@ -4,8 +4,8 @@ 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
 
11
- The data that was updated.
11
+ The receipt for the updated verifiable storage item.
@@ -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.9.0-next.1",
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/twin-verifiable-storage.git",
8
8
  "directory": "packages/verifiable-storage-models"
9
9
  },
10
10
  "author": "martyn.janes@iota.org",
@@ -14,11 +14,11 @@
14
14
  "node": ">=20.0.0"
15
15
  },
16
16
  "dependencies": {
17
- "@twin.org/api-models": "next",
18
- "@twin.org/core": "next",
19
- "@twin.org/data-json-ld": "next",
20
- "@twin.org/nameof": "next",
21
- "@twin.org/web": "next"
17
+ "@twin.org/api-models": "0.9.0-next.1",
18
+ "@twin.org/core": "0.9.0-next.1",
19
+ "@twin.org/data-json-ld": "0.9.0-next.1",
20
+ "@twin.org/nameof": "0.9.0-next.1",
21
+ "@twin.org/web": "0.9.0-next.1"
22
22
  },
23
23
  "main": "./dist/es/index.js",
24
24
  "types": "./dist/types/index.d.ts",
@@ -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/twin-verifiable-storage/issues"
55
55
  },
56
56
  "homepage": "https://twindev.org"
57
57
  }