@twin.org/verifiable-storage-models 0.0.3-next.9 → 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 (20) hide show
  1. package/dist/es/models/IVerifiableStorageComponent.js.map +1 -1
  2. package/dist/es/models/IVerifiableStorageConnector.js.map +1 -1
  3. package/dist/es/models/api/IVerifiableStorageCreateResponse.js.map +1 -1
  4. package/dist/es/models/api/IVerifiableStorageGetResponse.js.map +1 -1
  5. package/dist/es/models/api/IVerifiableStorageRemoveRequest.js.map +1 -1
  6. package/dist/es/models/api/IVerifiableStorageUpdateResponse.js.map +1 -1
  7. package/dist/types/models/IVerifiableStorageComponent.d.ts +2 -2
  8. package/dist/types/models/IVerifiableStorageConnector.d.ts +2 -2
  9. package/dist/types/models/api/IVerifiableStorageCreateResponse.d.ts +1 -1
  10. package/dist/types/models/api/IVerifiableStorageGetResponse.d.ts +1 -1
  11. package/dist/types/models/api/IVerifiableStorageRemoveRequest.d.ts +1 -1
  12. package/dist/types/models/api/IVerifiableStorageUpdateResponse.d.ts +1 -1
  13. package/docs/changelog.md +48 -0
  14. package/docs/reference/interfaces/IVerifiableStorageComponent.md +2 -2
  15. package/docs/reference/interfaces/IVerifiableStorageConnector.md +2 -2
  16. package/docs/reference/interfaces/IVerifiableStorageCreateResponse.md +1 -1
  17. package/docs/reference/interfaces/IVerifiableStorageGetResponse.md +1 -1
  18. package/docs/reference/interfaces/IVerifiableStorageRemoveRequest.md +1 -1
  19. package/docs/reference/interfaces/IVerifiableStorageUpdateResponse.md +1 -1
  20. package/package.json +8 -8
package/dist/es/models/IVerifiableStorageComponent.js.map CHANGED
@@ -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"]}
package/dist/es/models/IVerifiableStorageConnector.js.map CHANGED
@@ -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"]}
package/dist/es/models/api/IVerifiableStorageCreateResponse.js.map CHANGED
@@ -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"]}
package/dist/es/models/api/IVerifiableStorageGetResponse.js.map CHANGED
@@ -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"]}
package/dist/es/models/api/IVerifiableStorageRemoveRequest.js.map CHANGED
@@ -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"]}
package/dist/es/models/api/IVerifiableStorageUpdateResponse.js.map CHANGED
@@ -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"]}
package/dist/types/models/IVerifiableStorageComponent.d.ts CHANGED
@@ -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
  }
package/dist/types/models/IVerifiableStorageConnector.d.ts CHANGED
@@ -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
  }
package/dist/types/models/api/IVerifiableStorageCreateResponse.d.ts CHANGED
@@ -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
  /**
package/dist/types/models/api/IVerifiableStorageGetResponse.d.ts CHANGED
@@ -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
  /**
package/dist/types/models/api/IVerifiableStorageRemoveRequest.d.ts CHANGED
@@ -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
  /**
package/dist/types/models/api/IVerifiableStorageUpdateResponse.d.ts CHANGED
@@ -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,5 +1,53 @@
1
1
  # Changelog
2
2
 
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
+
3
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)
4
52
 
5
53
 
package/docs/reference/interfaces/IVerifiableStorageComponent.md CHANGED
@@ -102,7 +102,7 @@ The updated receipt.
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
 
@@ -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.
package/docs/reference/interfaces/IVerifiableStorageConnector.md CHANGED
@@ -96,7 +96,7 @@ The updated receipt.
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
 
@@ -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.
package/docs/reference/interfaces/IVerifiableStorageCreateResponse.md CHANGED
@@ -12,7 +12,7 @@ Response to storing the verifiable storage item.
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
 
package/docs/reference/interfaces/IVerifiableStorageGetResponse.md CHANGED
@@ -8,7 +8,7 @@ Response to getting the verifiable storage item.
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
 
package/docs/reference/interfaces/IVerifiableStorageRemoveRequest.md CHANGED
@@ -8,7 +8,7 @@ Remove the verifiable storage item.
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
 
package/docs/reference/interfaces/IVerifiableStorageUpdateResponse.md CHANGED
@@ -8,4 +8,4 @@ Response to updating the verifiable storage item.
8
8
 
9
9
  > **body**: `IJsonLdNodeObject`
10
10
 
11
- The data that was updated.
11
+ The receipt for the updated verifiable storage item.
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/verifiable-storage-models",
3
- "version": "0.0.3-next.9",
3
+ "version": "0.9.0-next.1",
4
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/iotaledger/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/iotaledger/verifiable-storage/issues"
54
+ "url": "git+https://github.com/iotaledger/twin-verifiable-storage/issues"
55
55
  },
56
56
  "homepage": "https://twindev.org"
57
57
  }