@twin.org/verifiable-storage-rest-client 0.0.3-next.9 → 0.9.0

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 (6) hide show
  1. package/dist/es/verifiableStorageRestClient.js +3 -3
  2. package/dist/es/verifiableStorageRestClient.js.map +1 -1
  3. package/dist/types/verifiableStorageRestClient.d.ts +3 -3
  4. package/docs/changelog.md +86 -0
  5. package/docs/reference/classes/VerifiableStorageRestClient.md +3 -3
  6. package/package.json +10 -10
package/dist/es/verifiableStorageRestClient.js CHANGED
@@ -64,11 +64,11 @@ export class VerifiableStorageRestClient extends BaseRestClient {
64
64
  return response.body;
65
65
  }
66
66
  /**
67
- * Get an verifiable storage item.
67
+ * Get a verifiable storage item.
68
68
  * @param id The id of the verifiable storage item to get.
69
69
  * @param options Additional options for getting the verifiable storage item.
70
70
  * @param options.includeData Should the data be included in the response, defaults to true.
71
- * @returns The data for the verifiable storage item.
71
+ * @returns The data and receipt for the verifiable storage item.
72
72
  */
73
73
  async get(id, options) {
74
74
  Guards.stringValue(VerifiableStorageRestClient.CLASS_NAME, "id", id);
@@ -87,7 +87,7 @@ export class VerifiableStorageRestClient extends BaseRestClient {
87
87
  /**
88
88
  * Remove a verifiable storage item.
89
89
  * @param id The id of the verifiable storage item to remove.
90
- * @returns Nothing.
90
+ * @returns A promise that resolves when the item has been removed.
91
91
  */
92
92
  async remove(id) {
93
93
  Urn.guard(VerifiableStorageRestClient.CLASS_NAME, "id", id);
package/dist/es/verifiableStorageRestClient.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"verifiableStorageRestClient.js","sourceRoot":"","sources":["../../src/verifiableStorageRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAc5D;;GAEG;AACH,MAAM,OAAO,2BACZ,SAAQ,cAAc;IAGtB;;OAEG;IACI,MAAM,CAAU,UAAU,iCAAiD;IAElF;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,gCAAwC,MAAM,EAAE,YAAY,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,2BAA2B,CAAC,UAAU,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CAClB,IAAgB,EAChB,SAAoB,EACpB,OAEC;QAKD,MAAM,CAAC,UAAU,CAAC,2BAA2B,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAE9E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,GAAG,EAAE,MAAM,EAAE;YACd,IAAI,EAAE;gBACL,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC;gBACnC,SAAS;gBACT,gBAAgB,EAAE,OAAO,EAAE,gBAAgB;aAC3C;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAClB,EAAU,EACV,IAAiB,EACjB,SAAoB;QAEpB,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAElE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,MAAM,EAAE,KAAK,EAAE;YAChB,UAAU,EAAE;gBACX,EAAE;aACF;YACD,IAAI,EAAE;gBACL,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;gBACrE,SAAS;aACT;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACf,EAAU,EACV,OAAkC;QAKlC,MAAM,CAAC,WAAW,CAAC,2BAA2B,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAE3E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,MAAM,EACN,KAAK,EACL;YACC,UAAU,EAAE;gBACX,EAAE;aACF;YACD,IAAI,EAAE,OAAO;SACb,CACD,CAAC;QAEF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1F,OAAO;YACN,IAAI;YACJ,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,OAAO;SAC9B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC7B,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAElE,MAAM,IAAI,CAAC,KAAK,CAAsD,MAAM,EAAE,QAAQ,EAAE;YACvF,UAAU,EAAE;gBACX,EAAE;aACF;SACD,CAAC,CAAC;IACJ,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport type { IBaseRestClientConfig, INoContentResponse } from \"@twin.org/api-models\";\nimport { Converter, Guards, Is, Urn } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type {\n\tIVerifiableStorageRemoveRequest,\n\tIVerifiableStorageComponent,\n\tIVerifiableStorageCreateRequest,\n\tIVerifiableStorageCreateResponse,\n\tIVerifiableStorageGetRequest,\n\tIVerifiableStorageGetResponse,\n\tIVerifiableStorageUpdateRequest,\n\tIVerifiableStorageUpdateResponse\n} from \"@twin.org/verifiable-storage-models\";\n\n/**\n * Client for performing Verifiable Storage through to REST endpoints.\n */\nexport class VerifiableStorageRestClient\n\textends BaseRestClient\n\timplements IVerifiableStorageComponent\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<VerifiableStorageRestClient>();\n\n\t/**\n\t * Create a new instance of VerifiableStorageRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(nameof<VerifiableStorageRestClient>(), config, \"verifiable\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn VerifiableStorageRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Create a verifiable storage item.\n\t * @param data The data for the verifiable storage item.\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 created verifiable storage item.\n\t */\n\tpublic async create(\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\t\tGuards.uint8Array(VerifiableStorageRestClient.CLASS_NAME, nameof(data), data);\n\n\t\tconst response = await this.fetch<\n\t\t\tIVerifiableStorageCreateRequest,\n\t\t\tIVerifiableStorageCreateResponse\n\t\t>(\"/\", \"POST\", {\n\t\t\tbody: {\n\t\t\t\tdata: Converter.bytesToBase64(data),\n\t\t\t\tallowList,\n\t\t\t\tmaxAllowListSize: options?.maxAllowListSize\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\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 * @returns The updated receipt.\n\t */\n\tpublic async update(\n\t\tid: string,\n\t\tdata?: Uint8Array,\n\t\tallowList?: string[]\n\t): Promise<IJsonLdNodeObject> {\n\t\tUrn.guard(VerifiableStorageRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tconst response = await this.fetch<\n\t\t\tIVerifiableStorageUpdateRequest,\n\t\t\tIVerifiableStorageUpdateResponse\n\t\t>(\"/:id\", \"PUT\", {\n\t\t\tpathParams: {\n\t\t\t\tid\n\t\t\t},\n\t\t\tbody: {\n\t\t\t\tdata: Is.uint8Array(data) ? Converter.bytesToBase64(data) : undefined,\n\t\t\t\tallowList\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Get an verifiable storage item.\n\t * @param id The id of the verifiable storage item to get.\n\t * @param options Additional options for getting the verifiable storage item.\n\t * @param options.includeData Should the data be included in the response, defaults to true.\n\t * @returns The data for the verifiable storage item.\n\t */\n\tpublic async get(\n\t\tid: string,\n\t\toptions?: { includeData: boolean }\n\t): Promise<{\n\t\tdata?: Uint8Array;\n\t\treceipt: IJsonLdNodeObject;\n\t}> {\n\t\tGuards.stringValue(VerifiableStorageRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tconst response = await this.fetch<IVerifiableStorageGetRequest, IVerifiableStorageGetResponse>(\n\t\t\t\"/:id\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tid\n\t\t\t\t},\n\t\t\t\tbody: options\n\t\t\t}\n\t\t);\n\n\t\tconst data = response.body.data ? Converter.base64ToBytes(response.body.data) : undefined;\n\n\t\treturn {\n\t\t\tdata,\n\t\t\treceipt: response.body.receipt\n\t\t};\n\t}\n\n\t/**\n\t * Remove a verifiable storage item.\n\t * @param id The id of the verifiable storage item to remove.\n\t * @returns Nothing.\n\t */\n\tpublic async remove(id: string): Promise<void> {\n\t\tUrn.guard(VerifiableStorageRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tawait this.fetch<IVerifiableStorageRemoveRequest, INoContentResponse>(\"/:id\", \"DELETE\", {\n\t\t\tpathParams: {\n\t\t\t\tid\n\t\t\t}\n\t\t});\n\t}\n}\n"]}
1
+ {"version":3,"file":"verifiableStorageRestClient.js","sourceRoot":"","sources":["../../src/verifiableStorageRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,MAAM,gBAAgB,CAAC;AAc5D;;GAEG;AACH,MAAM,OAAO,2BACZ,SAAQ,cAAc;IAGtB;;OAEG;IACI,MAAM,CAAU,UAAU,iCAAiD;IAElF;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,gCAAwC,MAAM,EAAE,YAAY,CAAC,CAAC;IACpE,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,2BAA2B,CAAC,UAAU,CAAC;IAC/C,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,MAAM,CAClB,IAAgB,EAChB,SAAoB,EACpB,OAEC;QAKD,MAAM,CAAC,UAAU,CAAC,2BAA2B,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAE9E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,GAAG,EAAE,MAAM,EAAE;YACd,IAAI,EAAE;gBACL,IAAI,EAAE,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC;gBACnC,SAAS;gBACT,gBAAgB,EAAE,OAAO,EAAE,gBAAgB;aAC3C;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CAClB,EAAU,EACV,IAAiB,EACjB,SAAoB;QAEpB,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAElE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAG/B,MAAM,EAAE,KAAK,EAAE;YAChB,UAAU,EAAE;gBACX,EAAE;aACF;YACD,IAAI,EAAE;gBACL,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;gBACrE,SAAS;aACT;SACD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACtB,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,GAAG,CACf,EAAU,EACV,OAAkC;QAKlC,MAAM,CAAC,WAAW,CAAC,2BAA2B,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAE3E,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,MAAM,EACN,KAAK,EACL;YACC,UAAU,EAAE;gBACX,EAAE;aACF;YACD,IAAI,EAAE,OAAO;SACb,CACD,CAAC;QAEF,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAE1F,OAAO;YACN,IAAI;YACJ,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,OAAO;SAC9B,CAAC;IACH,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,MAAM,CAAC,EAAU;QAC7B,GAAG,CAAC,KAAK,CAAC,2BAA2B,CAAC,UAAU,QAAc,EAAE,CAAC,CAAC;QAElE,MAAM,IAAI,CAAC,KAAK,CAAsD,MAAM,EAAE,QAAQ,EAAE;YACvF,UAAU,EAAE;gBACX,EAAE;aACF;SACD,CAAC,CAAC;IACJ,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { BaseRestClient } from \"@twin.org/api-core\";\nimport type { IBaseRestClientConfig, INoContentResponse } from \"@twin.org/api-models\";\nimport { Converter, Guards, Is, Urn } from \"@twin.org/core\";\nimport type { IJsonLdNodeObject } from \"@twin.org/data-json-ld\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type {\n\tIVerifiableStorageRemoveRequest,\n\tIVerifiableStorageComponent,\n\tIVerifiableStorageCreateRequest,\n\tIVerifiableStorageCreateResponse,\n\tIVerifiableStorageGetRequest,\n\tIVerifiableStorageGetResponse,\n\tIVerifiableStorageUpdateRequest,\n\tIVerifiableStorageUpdateResponse\n} from \"@twin.org/verifiable-storage-models\";\n\n/**\n * Client for performing Verifiable Storage through to REST endpoints.\n */\nexport class VerifiableStorageRestClient\n\textends BaseRestClient\n\timplements IVerifiableStorageComponent\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<VerifiableStorageRestClient>();\n\n\t/**\n\t * Create a new instance of VerifiableStorageRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(nameof<VerifiableStorageRestClient>(), config, \"verifiable\");\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn VerifiableStorageRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Create a verifiable storage item.\n\t * @param data The data for the verifiable storage item.\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 created verifiable storage item.\n\t */\n\tpublic async create(\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\t\tGuards.uint8Array(VerifiableStorageRestClient.CLASS_NAME, nameof(data), data);\n\n\t\tconst response = await this.fetch<\n\t\t\tIVerifiableStorageCreateRequest,\n\t\t\tIVerifiableStorageCreateResponse\n\t\t>(\"/\", \"POST\", {\n\t\t\tbody: {\n\t\t\t\tdata: Converter.bytesToBase64(data),\n\t\t\t\tallowList,\n\t\t\t\tmaxAllowListSize: options?.maxAllowListSize\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\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 * @returns The updated receipt.\n\t */\n\tpublic async update(\n\t\tid: string,\n\t\tdata?: Uint8Array,\n\t\tallowList?: string[]\n\t): Promise<IJsonLdNodeObject> {\n\t\tUrn.guard(VerifiableStorageRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tconst response = await this.fetch<\n\t\t\tIVerifiableStorageUpdateRequest,\n\t\t\tIVerifiableStorageUpdateResponse\n\t\t>(\"/:id\", \"PUT\", {\n\t\t\tpathParams: {\n\t\t\t\tid\n\t\t\t},\n\t\t\tbody: {\n\t\t\t\tdata: Is.uint8Array(data) ? Converter.bytesToBase64(data) : undefined,\n\t\t\t\tallowList\n\t\t\t}\n\t\t});\n\n\t\treturn response.body;\n\t}\n\n\t/**\n\t * Get a verifiable storage item.\n\t * @param id The id of the verifiable storage item to get.\n\t * @param options Additional options for getting the verifiable storage item.\n\t * @param options.includeData Should the data be included in the response, defaults to true.\n\t * @returns The data and receipt for the verifiable storage item.\n\t */\n\tpublic async get(\n\t\tid: string,\n\t\toptions?: { includeData: boolean }\n\t): Promise<{\n\t\tdata?: Uint8Array;\n\t\treceipt: IJsonLdNodeObject;\n\t}> {\n\t\tGuards.stringValue(VerifiableStorageRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tconst response = await this.fetch<IVerifiableStorageGetRequest, IVerifiableStorageGetResponse>(\n\t\t\t\"/:id\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\tpathParams: {\n\t\t\t\t\tid\n\t\t\t\t},\n\t\t\t\tbody: options\n\t\t\t}\n\t\t);\n\n\t\tconst data = response.body.data ? Converter.base64ToBytes(response.body.data) : undefined;\n\n\t\treturn {\n\t\t\tdata,\n\t\t\treceipt: response.body.receipt\n\t\t};\n\t}\n\n\t/**\n\t * Remove a verifiable storage item.\n\t * @param id The id of the verifiable storage item to remove.\n\t * @returns A promise that resolves when the item has been removed.\n\t */\n\tpublic async remove(id: string): Promise<void> {\n\t\tUrn.guard(VerifiableStorageRestClient.CLASS_NAME, nameof(id), id);\n\n\t\tawait this.fetch<IVerifiableStorageRemoveRequest, INoContentResponse>(\"/:id\", \"DELETE\", {\n\t\t\tpathParams: {\n\t\t\t\tid\n\t\t\t}\n\t\t});\n\t}\n}\n"]}
package/dist/types/verifiableStorageRestClient.d.ts CHANGED
@@ -43,11 +43,11 @@ export declare class VerifiableStorageRestClient extends BaseRestClient implemen
43
43
  */
44
44
  update(id: string, data?: Uint8Array, allowList?: string[]): Promise<IJsonLdNodeObject>;
45
45
  /**
46
- * Get an verifiable storage item.
46
+ * Get a verifiable storage item.
47
47
  * @param id The id of the verifiable storage item to get.
48
48
  * @param options Additional options for getting the verifiable storage item.
49
49
  * @param options.includeData Should the data be included in the response, defaults to true.
50
- * @returns The data for the verifiable storage item.
50
+ * @returns The data and receipt for the verifiable storage item.
51
51
  */
52
52
  get(id: string, options?: {
53
53
  includeData: boolean;
@@ -58,7 +58,7 @@ export declare class VerifiableStorageRestClient extends BaseRestClient implemen
58
58
  /**
59
59
  * Remove a verifiable storage item.
60
60
  * @param id The id of the verifiable storage item to remove.
61
- * @returns Nothing.
61
+ * @returns A promise that resolves when the item has been removed.
62
62
  */
63
63
  remove(id: string): Promise<void>;
64
64
  }
package/docs/changelog.md CHANGED
@@ -1,5 +1,91 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.9.0](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.9.0...verifiable-storage-rest-client-v0.9.0) (2026-06-25)
4
+
5
+
6
+ ### Features
7
+
8
+ * release to production ([6ce6744](https://github.com/iotaledger/twin-verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
9
+ * release to production ([#75](https://github.com/iotaledger/twin-verifiable-storage/issues/75)) ([d631cd7](https://github.com/iotaledger/twin-verifiable-storage/commit/d631cd74bba5ac37d67178632eed5a779348170f))
10
+
11
+ ## [0.9.0-next.1](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.9.0-next.0...verifiable-storage-rest-client-v0.9.0-next.1) (2026-06-23)
12
+
13
+
14
+ ### Features
15
+
16
+ * add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
17
+ * add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
18
+ * add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
19
+ * eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
20
+ * typescript 6 update ([66823cf](https://github.com/iotaledger/twin-verifiable-storage/commit/66823cf7a6522622c889afdc49005d016e8574fe))
21
+ * update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
22
+ * update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
23
+ * 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))
24
+ * use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
25
+
26
+
27
+ ### Dependencies
28
+
29
+ * The following workspace dependencies were updated
30
+ * dependencies
31
+ * @twin.org/verifiable-storage-models bumped from 0.9.0-next.0 to 0.9.0-next.1
32
+
33
+ ## [0.0.3-next.13](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.12...verifiable-storage-rest-client-v0.0.3-next.13) (2026-06-11)
34
+
35
+
36
+ ### Miscellaneous Chores
37
+
38
+ * **verifiable-storage-rest-client:** Synchronize repo versions
39
+
40
+
41
+ ### Dependencies
42
+
43
+ * The following workspace dependencies were updated
44
+ * dependencies
45
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.12 to 0.0.3-next.13
46
+
47
+ ## [0.0.3-next.12](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.11...verifiable-storage-rest-client-v0.0.3-next.12) (2026-05-28)
48
+
49
+
50
+ ### Miscellaneous Chores
51
+
52
+ * **verifiable-storage-rest-client:** Synchronize repo versions
53
+
54
+
55
+ ### Dependencies
56
+
57
+ * The following workspace dependencies were updated
58
+ * dependencies
59
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.11 to 0.0.3-next.12
60
+
61
+ ## [0.0.3-next.11](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.10...verifiable-storage-rest-client-v0.0.3-next.11) (2026-05-20)
62
+
63
+
64
+ ### Miscellaneous Chores
65
+
66
+ * **verifiable-storage-rest-client:** Synchronize repo versions
67
+
68
+
69
+ ### Dependencies
70
+
71
+ * The following workspace dependencies were updated
72
+ * dependencies
73
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.10 to 0.0.3-next.11
74
+
75
+ ## [0.0.3-next.10](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.9...verifiable-storage-rest-client-v0.0.3-next.10) (2026-05-12)
76
+
77
+
78
+ ### Features
79
+
80
+ * typescript 6 update ([66823cf](https://github.com/iotaledger/twin-verifiable-storage/commit/66823cf7a6522622c889afdc49005d016e8574fe))
81
+
82
+
83
+ ### Dependencies
84
+
85
+ * The following workspace dependencies were updated
86
+ * dependencies
87
+ * @twin.org/verifiable-storage-models bumped from 0.0.3-next.9 to 0.0.3-next.10
88
+
3
89
  ## [0.0.3-next.9](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.8...verifiable-storage-rest-client-v0.0.3-next.9) (2026-05-08)
4
90
 
5
91
 
package/docs/reference/classes/VerifiableStorageRestClient.md CHANGED
@@ -146,7 +146,7 @@ The updated receipt.
146
146
 
147
147
  > **get**(`id`, `options?`): `Promise`\<\{ `data?`: `Uint8Array`\<`ArrayBufferLike`\>; `receipt`: `IJsonLdNodeObject`; \}\>
148
148
 
149
- Get an verifiable storage item.
149
+ Get a verifiable storage item.
150
150
 
151
151
  #### Parameters
152
152
 
@@ -170,7 +170,7 @@ Should the data be included in the response, defaults to true.
170
170
 
171
171
  `Promise`\<\{ `data?`: `Uint8Array`\<`ArrayBufferLike`\>; `receipt`: `IJsonLdNodeObject`; \}\>
172
172
 
173
- The data for the verifiable storage item.
173
+ The data and receipt for the verifiable storage item.
174
174
 
175
175
  #### Implementation of
176
176
 
@@ -196,7 +196,7 @@ The id of the verifiable storage item to remove.
196
196
 
197
197
  `Promise`\<`void`\>
198
198
 
199
- Nothing.
199
+ A promise that resolves when the item has been removed.
200
200
 
201
201
  #### Implementation of
202
202
 
package/package.json CHANGED
@@ -1,10 +1,10 @@
1
1
  {
2
2
  "name": "@twin.org/verifiable-storage-rest-client",
3
- "version": "0.0.3-next.9",
3
+ "version": "0.9.0",
4
4
  "description": "REST client component for calling verifiable storage service endpoints",
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-rest-client"
9
9
  },
10
10
  "contributors": [
@@ -17,13 +17,13 @@
17
17
  "node": ">=20.0.0"
18
18
  },
19
19
  "dependencies": {
20
- "@twin.org/api-core": "next",
21
- "@twin.org/api-models": "next",
22
- "@twin.org/core": "next",
23
- "@twin.org/entity": "next",
24
- "@twin.org/nameof": "next",
25
- "@twin.org/verifiable-storage-models": "0.0.3-next.9",
26
- "@twin.org/web": "next"
20
+ "@twin.org/api-core": "^0.9.0",
21
+ "@twin.org/api-models": "^0.9.0",
22
+ "@twin.org/core": "^0.9.0",
23
+ "@twin.org/entity": "^0.9.0",
24
+ "@twin.org/nameof": "^0.9.0",
25
+ "@twin.org/verifiable-storage-models": "^0.9.0",
26
+ "@twin.org/web": "^0.9.0"
27
27
  },
28
28
  "main": "./dist/es/index.js",
29
29
  "types": "./dist/types/index.d.ts",
@@ -54,7 +54,7 @@
54
54
  "immutable"
55
55
  ],
56
56
  "bugs": {
57
- "url": "git+https://github.com/iotaledger/verifiable-storage/issues"
57
+ "url": "git+https://github.com/iotaledger/twin-verifiable-storage/issues"
58
58
  },
59
59
  "homepage": "https://twindev.org"
60
60
  }