@twin.org/verifiable-storage-rest-client 0.0.2-next.6 → 0.0.3-next.10

package/README.md

@@ -1,6 +1,8 @@
 # TWIN Verifiable Storage REST Client
 
-Verifiable Storage contract implementation which can connect to REST endpoints.
+This package provides a REST client for calling verifiable storage service endpoints from external applications and services. It wraps API requests and responses in the shared model contracts so consumers can integrate with predictable request shapes and result handling.
+
+It is intended for client-side or service-to-service use cases where verifiable storage operations are accessed over HTTP rather than through direct connector invocation.
 
 ## Installation
 

package/dist/es/index.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./verifiableStorageRestClient.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,kCAAkC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./verifiableStorageRestClient.js\";\n"]}

package/dist/{esm/index.mjs → es/verifiableStorageRestClient.js}

@@ -1,23 +1,29 @@
-import { BaseRestClient } from '@twin.org/api-core';
-import { Guards, Converter, Urn, Is } from '@twin.org/core';
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { BaseRestClient } from "@twin.org/api-core";
+import { Converter, Guards, Is, Urn } from "@twin.org/core";
 /**
  * Client for performing Verifiable Storage through to REST endpoints.
  */
-class VerifiableStorageRestClient extends BaseRestClient {
+export class VerifiableStorageRestClient extends BaseRestClient {
     /**
      * Runtime name for the class.
      */
     static CLASS_NAME = "VerifiableStorageRestClient";
     /**
-     * Create a new instance of VerifiableStorageClient.
+     * Create a new instance of VerifiableStorageRestClient.
      * @param config The configuration for the client.
      */
     constructor(config) {
         super("VerifiableStorageRestClient", config, "verifiable");
     }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return VerifiableStorageRestClient.CLASS_NAME;
+    }
     /**
      * Create a verifiable storage item.
      * @param data The data for the verifiable storage item.
@@ -92,5 +98,4 @@ class VerifiableStorageRestClient extends BaseRestClient {
         });
     }
 }
-
-export { VerifiableStorageRestClient };
+//# sourceMappingURL=verifiableStorageRestClient.js.map

package/dist/es/verifiableStorageRestClient.js.map

@@ -0,0 +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"]}

package/dist/types/index.d.ts

@@ -1 +1 @@
-export * from "./verifiableStorageRestClient";
+export * from "./verifiableStorageRestClient.js";

package/dist/types/verifiableStorageRestClient.d.ts

@@ -11,10 +11,15 @@ export declare class VerifiableStorageRestClient extends BaseRestClient implemen
      */
     static readonly CLASS_NAME: string;
     /**
-     * Create a new instance of VerifiableStorageClient.
+     * Create a new instance of VerifiableStorageRestClient.
      * @param config The configuration for the client.
      */
     constructor(config: IBaseRestClientConfig);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Create a verifiable storage item.
      * @param data The data for the verifiable storage item.

package/docs/changelog.md

@@ -1,11 +1,165 @@
-# @twin.org/verifiable-storage-rest-client - Changelog
+# Changelog
 
-## [0.0.2-next.6](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.5...verifiable-storage-rest-client-v0.0.2-next.6) (2025-10-09)
+## [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)
 
 
 ### Features
 
-* add validate-locales ([326384f](https://github.com/twinfoundation/verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
+* typescript 6 update ([66823cf](https://github.com/iotaledger/twin-verifiable-storage/commit/66823cf7a6522622c889afdc49005d016e8574fe))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/verifiable-storage-models bumped from 0.0.3-next.9 to 0.0.3-next.10
+
+## [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)
+
+
+### Miscellaneous Chores
+
+* **verifiable-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/verifiable-storage-models bumped from 0.0.3-next.8 to 0.0.3-next.9
+
+## [0.0.3-next.8](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.7...verifiable-storage-rest-client-v0.0.3-next.8) (2026-03-03)
+
+
+### Miscellaneous Chores
+
+* **verifiable-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/verifiable-storage-models bumped from 0.0.3-next.7 to 0.0.3-next.8
+
+## [0.0.3-next.7](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.6...verifiable-storage-rest-client-v0.0.3-next.7) (2026-02-25)
+
+
+### Features
+
+* add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
+* add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
+* add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
+* eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
+* update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
+* update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
+* 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))
+* use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/verifiable-storage-models bumped from 0.0.3-next.6 to 0.0.3-next.7
+
+## [0.0.3-next.6](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.5...verifiable-storage-rest-client-v0.0.3-next.6) (2026-02-25)
+
+
+### Miscellaneous Chores
+
+* **verifiable-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/verifiable-storage-models bumped from 0.0.3-next.5 to 0.0.3-next.6
+
+## [0.0.3-next.5](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.4...verifiable-storage-rest-client-v0.0.3-next.5) (2026-02-09)
+
+
+### Miscellaneous Chores
+
+* **verifiable-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/verifiable-storage-models bumped from 0.0.3-next.4 to 0.0.3-next.5
+
+## [0.0.3-next.4](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.3...verifiable-storage-rest-client-v0.0.3-next.4) (2026-02-09)
+
+
+### Miscellaneous Chores
+
+* **verifiable-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/verifiable-storage-models bumped from 0.0.3-next.3 to 0.0.3-next.4
+
+## [0.0.3-next.3](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.2...verifiable-storage-rest-client-v0.0.3-next.3) (2026-01-21)
+
+
+### Miscellaneous Chores
+
+* **verifiable-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/verifiable-storage-models bumped from 0.0.3-next.2 to 0.0.3-next.3
+
+## [0.0.3-next.2](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.1...verifiable-storage-rest-client-v0.0.3-next.2) (2026-01-14)
+
+
+### Miscellaneous Chores
+
+* **verifiable-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/verifiable-storage-models bumped from 0.0.3-next.1 to 0.0.3-next.2
+
+## [0.0.3-next.1](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.3-next.0...verifiable-storage-rest-client-v0.0.3-next.1) (2025-11-12)
+
+
+### Features
+
+* add context id features ([#40](https://github.com/iotaledger/twin-verifiable-storage/issues/40)) ([260b96a](https://github.com/iotaledger/twin-verifiable-storage/commit/260b96a8b7d1a26c6c415f2de12e09671ee70220))
+* add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
+* add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
+* eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
+* update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
+* update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
+* 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))
+* use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/verifiable-storage-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [0.0.2-next.6](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.5...verifiable-storage-rest-client-v0.0.2-next.6) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([326384f](https://github.com/iotaledger/twin-verifiable-storage/commit/326384fe867604e7cd450460a6a56c6c7bdc8f98))
 
 
 ### Dependencies
@@ -14,12 +168,12 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.2-next.5 to 0.0.2-next.6
 
-## [0.0.2-next.5](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.4...verifiable-storage-rest-client-v0.0.2-next.5) (2025-09-26)
+## [0.0.2-next.5](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.4...verifiable-storage-rest-client-v0.0.2-next.5) (2025-09-26)
 
 
 ### Features
 
-* eslint migration to flat config ([b0a0b85](https://github.com/twinfoundation/verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
+* eslint migration to flat config ([b0a0b85](https://github.com/iotaledger/twin-verifiable-storage/commit/b0a0b8585a77c1e541531d60b432916b9dc0867e))
 
 
 ### Dependencies
@@ -28,12 +182,12 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.2-next.4 to 0.0.2-next.5
 
-## [0.0.2-next.4](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.3...verifiable-storage-rest-client-v0.0.2-next.4) (2025-08-20)
+## [0.0.2-next.4](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.3...verifiable-storage-rest-client-v0.0.2-next.4) (2025-08-20)
 
 
 ### Features
 
-* update framework core ([efa612e](https://github.com/twinfoundation/verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
+* update framework core ([efa612e](https://github.com/iotaledger/twin-verifiable-storage/commit/efa612e54dbe2d8f223f27ff9e315e08a2fed04b))
 
 
 ### Dependencies
@@ -42,7 +196,7 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.2-next.3 to 0.0.2-next.4
 
-## [0.0.2-next.3](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.2...verifiable-storage-rest-client-v0.0.2-next.3) (2025-07-28)
+## [0.0.2-next.3](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.2...verifiable-storage-rest-client-v0.0.2-next.3) (2025-07-28)
 
 
 ### Miscellaneous Chores
@@ -56,15 +210,15 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.2-next.2 to 0.0.2-next.3
 
-## [0.0.2-next.2](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.1...verifiable-storage-rest-client-v0.0.2-next.2) (2025-07-16)
+## [0.0.2-next.2](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.1...verifiable-storage-rest-client-v0.0.2-next.2) (2025-07-16)
 
 
 ### Features
 
-* add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
-* update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
-* 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))
-* use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
+* add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
+* update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
+* 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))
+* use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
 
 
 ### Dependencies
@@ -73,15 +227,15 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.2-next.0 to 0.0.2-next.2
 
-## [0.0.2-next.0](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.0...verifiable-storage-rest-client-v0.0.2-next.0) (2025-07-16)
+## [0.0.2-next.0](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.2-next.0...verifiable-storage-rest-client-v0.0.2-next.0) (2025-07-16)
 
 
 ### Features
 
-* add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
-* update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
-* 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))
-* use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
+* add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
+* update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
+* 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))
+* use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
 
 
 ### Dependencies
@@ -95,7 +249,7 @@
 
 ### Features
 
-* release to production ([6ce6744](https://github.com/twinfoundation/verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
+* release to production ([6ce6744](https://github.com/iotaledger/twin-verifiable-storage/commit/6ce6744c124cca586c1ef0552624378d1207578d))
 
 
 ### Dependencies
@@ -104,7 +258,7 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from ^0.0.0 to ^0.0.1
 
-## [0.0.1-next.17](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.16...verifiable-storage-rest-client-v0.0.1-next.17) (2025-06-25)
+## [0.0.1-next.17](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.16...verifiable-storage-rest-client-v0.0.1-next.17) (2025-06-25)
 
 
 ### Miscellaneous Chores
@@ -118,12 +272,12 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.16 to 0.0.1-next.17
 
-## [0.0.1-next.16](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.15...verifiable-storage-rest-client-v0.0.1-next.16) (2025-06-12)
+## [0.0.1-next.16](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.15...verifiable-storage-rest-client-v0.0.1-next.16) (2025-06-12)
 
 
 ### Features
 
-* update dependencies ([a16a772](https://github.com/twinfoundation/verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
+* update dependencies ([a16a772](https://github.com/iotaledger/twin-verifiable-storage/commit/a16a77244cb1d312ea5ee74232bcdadd25f2b330))
 
 
 ### Dependencies
@@ -132,7 +286,7 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.15 to 0.0.1-next.16
 
-## [0.0.1-next.15](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.14...verifiable-storage-rest-client-v0.0.1-next.15) (2025-06-03)
+## [0.0.1-next.15](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.14...verifiable-storage-rest-client-v0.0.1-next.15) (2025-06-03)
 
 
 ### Miscellaneous Chores
@@ -146,14 +300,14 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.14 to 0.0.1-next.15
 
-## [0.0.1-next.14](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.13...verifiable-storage-rest-client-v0.0.1-next.14) (2025-05-28)
+## [0.0.1-next.14](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.13...verifiable-storage-rest-client-v0.0.1-next.14) (2025-05-28)
 
 
 ### Features
 
-* add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
-* 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))
-* use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
+* add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
+* 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))
+* use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
 
 
 ### Dependencies
@@ -162,7 +316,7 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.13 to 0.0.1-next.14
 
-## [0.0.1-next.13](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.12...verifiable-storage-rest-client-v0.0.1-next.13) (2025-05-28)
+## [0.0.1-next.13](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.12...verifiable-storage-rest-client-v0.0.1-next.13) (2025-05-28)
 
 
 ### Miscellaneous Chores
@@ -176,7 +330,7 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.12 to 0.0.1-next.13
 
-## [0.0.1-next.12](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.11...verifiable-storage-rest-client-v0.0.1-next.12) (2025-05-28)
+## [0.0.1-next.12](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.11...verifiable-storage-rest-client-v0.0.1-next.12) (2025-05-28)
 
 
 ### Miscellaneous Chores
@@ -190,7 +344,7 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.11 to 0.0.1-next.12
 
-## [0.0.1-next.11](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.10...verifiable-storage-rest-client-v0.0.1-next.11) (2025-05-22)
+## [0.0.1-next.11](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.10...verifiable-storage-rest-client-v0.0.1-next.11) (2025-05-22)
 
 
 ### Miscellaneous Chores
@@ -204,12 +358,12 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.10 to 0.0.1-next.11
 
-## [0.0.1-next.10](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.9...verifiable-storage-rest-client-v0.0.1-next.10) (2025-05-22)
+## [0.0.1-next.10](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.9...verifiable-storage-rest-client-v0.0.1-next.10) (2025-05-22)
 
 
 ### Features
 
-* add support for allowlist ([#17](https://github.com/twinfoundation/verifiable-storage/issues/17)) ([9341ea6](https://github.com/twinfoundation/verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
+* add support for allowlist ([#17](https://github.com/iotaledger/twin-verifiable-storage/issues/17)) ([9341ea6](https://github.com/iotaledger/twin-verifiable-storage/commit/9341ea6b95dfbf2a5dc70a53e5979d7d0e8b2de6))
 
 
 ### Dependencies
@@ -218,7 +372,7 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.9 to 0.0.1-next.10
 
-## [0.0.1-next.9](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.8...verifiable-storage-rest-client-v0.0.1-next.9) (2025-05-06)
+## [0.0.1-next.9](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.8...verifiable-storage-rest-client-v0.0.1-next.9) (2025-05-06)
 
 
 ### Miscellaneous Chores
@@ -232,7 +386,7 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.8 to 0.0.1-next.9
 
-## [0.0.1-next.8](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.7...verifiable-storage-rest-client-v0.0.1-next.8) (2025-04-24)
+## [0.0.1-next.8](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.7...verifiable-storage-rest-client-v0.0.1-next.8) (2025-04-24)
 
 
 ### Miscellaneous Chores
@@ -246,7 +400,7 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.7 to 0.0.1-next.8
 
-## [0.0.1-next.7](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.6...verifiable-storage-rest-client-v0.0.1-next.7) (2025-04-23)
+## [0.0.1-next.7](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.6...verifiable-storage-rest-client-v0.0.1-next.7) (2025-04-23)
 
 
 ### Miscellaneous Chores
@@ -260,7 +414,7 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.6 to 0.0.1-next.7
 
-## [0.0.1-next.6](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.5...verifiable-storage-rest-client-v0.0.1-next.6) (2025-04-23)
+## [0.0.1-next.6](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.5...verifiable-storage-rest-client-v0.0.1-next.6) (2025-04-23)
 
 
 ### Miscellaneous Chores
@@ -274,7 +428,7 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.5 to 0.0.1-next.6
 
-## [0.0.1-next.5](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.4...verifiable-storage-rest-client-v0.0.1-next.5) (2025-04-23)
+## [0.0.1-next.5](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.4...verifiable-storage-rest-client-v0.0.1-next.5) (2025-04-23)
 
 
 ### Miscellaneous Chores
@@ -288,12 +442,12 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.4 to 0.0.1-next.5
 
-## [0.0.1-next.4](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.3...verifiable-storage-rest-client-v0.0.1-next.4) (2025-04-17)
+## [0.0.1-next.4](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.3...verifiable-storage-rest-client-v0.0.1-next.4) (2025-04-17)
 
 
 ### Features
 
-* use shared store mechanism ([#8](https://github.com/twinfoundation/verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/twinfoundation/verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
+* use shared store mechanism ([#8](https://github.com/iotaledger/twin-verifiable-storage/issues/8)) ([8c8ecb8](https://github.com/iotaledger/twin-verifiable-storage/commit/8c8ecb83d32431952c594ea23d37040991f5b4d3))
 
 
 ### Dependencies
@@ -302,12 +456,12 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.3 to 0.0.1-next.4
 
-## [0.0.1-next.3](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.2...verifiable-storage-rest-client-v0.0.1-next.3) (2025-04-17)
+## [0.0.1-next.3](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.2...verifiable-storage-rest-client-v0.0.1-next.3) (2025-04-17)
 
 
 ### Features
 
-* 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))
+* 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))
 
 
 ### Dependencies
@@ -316,7 +470,7 @@
   * dependencies
     * @twin.org/verifiable-storage-models bumped from 0.0.1-next.2 to 0.0.1-next.3
 
-## [0.0.1-next.2](https://github.com/twinfoundation/verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.1...verifiable-storage-rest-client-v0.0.1-next.2) (2025-03-28)
+## [0.0.1-next.2](https://github.com/iotaledger/twin-verifiable-storage/compare/verifiable-storage-rest-client-v0.0.1-next.1...verifiable-storage-rest-client-v0.0.1-next.2) (2025-03-28)
 
 
 ### Miscellaneous Chores

package/docs/examples.md

@@ -1 +1,30 @@
-# @twin.org/verifiable-storage-rest-client - Examples
+# Verifiable Storage REST Client Examples
+
+This page provides TypeScript examples for using the REST client to interact with verifiable storage endpoints. These samples show how to create, retrieve, and update verifiable storage items over HTTP, making it easier to integrate verifiable storage into your applications.
+
+## VerifiableStorageRestClient
+
+```typescript
+import { VerifiableStorageRestClient } from '@twin.org/verifiable-storage-rest-client';
+
+const config = { baseUrl: 'https://api.example.com', apiKey: 'your-api-key' };
+const client = new VerifiableStorageRestClient(config);
+
+// Create a new verifiable storage item
+const data = new TextEncoder().encode('REST data');
+const allowList = ['did:example:controller1'];
+const { id, receipt } = await client.create(data, allowList, { maxAllowListSize: 2 });
+console.log(id); // Outputs the new item id
+console.log(receipt); // Outputs the receipt object
+```
+
+```typescript
+// Retrieve a verifiable storage item
+const item = await client.get(id);
+if (item.data) {
+  const decoded = new TextDecoder().decode(item.data);
+  console.log(decoded); // REST data
+}
+console.log(item.allowList); // Outputs the allow list
+console.log(item.receipt); // Outputs the receipt object
+```

package/docs/reference/classes/VerifiableStorageRestClient.md

@@ -16,7 +16,7 @@ Client for performing Verifiable Storage through to REST endpoints.
 
 > **new VerifiableStorageRestClient**(`config`): `VerifiableStorageRestClient`
 
-Create a new instance of VerifiableStorageClient.
+Create a new instance of VerifiableStorageRestClient.
 
 #### Parameters
 
@@ -36,7 +36,7 @@ The configuration for the client.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -44,7 +44,25 @@ Runtime name for the class.
 
 ## Methods
 
-### create()
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IVerifiableStorageComponent.className`
+
+***
+
+### create() {#create}
 
 > **create**(`data`, `allowList?`, `options?`): `Promise`\<\{ `id`: `string`; `receipt`: `IJsonLdNodeObject`; \}\>
 
@@ -86,7 +104,7 @@ The id of the created verifiable storage item.
 
 ***
 
-### update()
+### update() {#update}
 
 > **update**(`id`, `data?`, `allowList?`): `Promise`\<`IJsonLdNodeObject`\>
 
@@ -124,7 +142,7 @@ The updated receipt.
 
 ***
 
-### get()
+### get() {#get}
 
 > **get**(`id`, `options?`): `Promise`\<\{ `data?`: `Uint8Array`\<`ArrayBufferLike`\>; `receipt`: `IJsonLdNodeObject`; \}\>
 
@@ -160,7 +178,7 @@ The data for the verifiable storage item.
 
 ***
 
-### remove()
+### remove() {#remove}
 
 > **remove**(`id`): `Promise`\<`void`\>
 

package/package.json

@@ -1,13 +1,16 @@
 {
 	"name": "@twin.org/verifiable-storage-rest-client",
-	"version": "0.0.2-next.6",
-	"description": "Verifiable Storage contract implementation which can connect to REST endpoints",
+	"version": "0.0.3-next.10",
+	"description": "REST client component for calling verifiable storage service endpoints",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/twinfoundation/verifiable-storage.git",
+		"url": "git+https://github.com/iotaledger/verifiable-storage.git",
 		"directory": "packages/verifiable-storage-rest-client"
 	},
-	"author": "cornel.filip@iota.org; adrian.sanchez.sequeira@iota.org",
+	"contributors": [
+		"cornel.filip@iota.org",
+		"adrian.sanchez.sequeira@iota.org"
+	],
 	"license": "Apache-2.0",
 	"type": "module",
 	"engines": {
@@ -19,23 +22,21 @@
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/verifiable-storage-models": "0.0.2-next.6",
+		"@twin.org/verifiable-storage-models": "0.0.3-next.10",
 		"@twin.org/web": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/types/index.d.ts",
-			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
 		},
 		"./locales/*.json": "./locales/*.json"
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"
@@ -53,7 +54,7 @@
 		"immutable"
 	],
 	"bugs": {
-		"url": "git+https://github.com/twinfoundation/verifiable-storage/issues"
+		"url": "git+https://github.com/iotaledger/verifiable-storage/issues"
 	},
 	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,98 +0,0 @@
-'use strict';
-
-var apiCore = require('@twin.org/api-core');
-var core = require('@twin.org/core');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Client for performing Verifiable Storage through to REST endpoints.
- */
-class VerifiableStorageRestClient extends apiCore.BaseRestClient {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "VerifiableStorageRestClient";
-    /**
-     * Create a new instance of VerifiableStorageClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super("VerifiableStorageRestClient", config, "verifiable");
-    }
-    /**
-     * Create a verifiable storage item.
-     * @param data The data for the verifiable storage item.
-     * @param allowList The list of identities that are allowed to modify the item.
-     * @param options Additional options for creating the item.
-     * @param options.maxAllowListSize The maximum size of the allow list.
-     * @returns The id of the created verifiable storage item.
-     */
-    async create(data, allowList, options) {
-        core.Guards.uint8Array(VerifiableStorageRestClient.CLASS_NAME, "data", data);
-        const response = await this.fetch("/", "POST", {
-            body: {
-                data: core.Converter.bytesToBase64(data),
-                allowList,
-                maxAllowListSize: options?.maxAllowListSize
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Update an item in verifiable storage.
-     * @param id The id of the item to update.
-     * @param data The data to store, optional if updating the allow list.
-     * @param allowList Updated list of identities that are allowed to modify the item.
-     * @returns The updated receipt.
-     */
-    async update(id, data, allowList) {
-        core.Urn.guard(VerifiableStorageRestClient.CLASS_NAME, "id", id);
-        const response = await this.fetch("/:id", "PUT", {
-            pathParams: {
-                id
-            },
-            body: {
-                data: core.Is.uint8Array(data) ? core.Converter.bytesToBase64(data) : undefined,
-                allowList
-            }
-        });
-        return response.body;
-    }
-    /**
-     * Get an verifiable storage item.
-     * @param id The id of the verifiable storage item to get.
-     * @param options Additional options for getting the verifiable storage item.
-     * @param options.includeData Should the data be included in the response, defaults to true.
-     * @returns The data for the verifiable storage item.
-     */
-    async get(id, options) {
-        core.Guards.stringValue(VerifiableStorageRestClient.CLASS_NAME, "id", id);
-        const response = await this.fetch("/:id", "GET", {
-            pathParams: {
-                id
-            },
-            body: options
-        });
-        const data = response.body.data ? core.Converter.base64ToBytes(response.body.data) : undefined;
-        return {
-            data,
-            receipt: response.body.receipt
-        };
-    }
-    /**
-     * Remove a verifiable storage item.
-     * @param id The id of the verifiable storage item to remove.
-     * @returns Nothing.
-     */
-    async remove(id) {
-        core.Urn.guard(VerifiableStorageRestClient.CLASS_NAME, "id", id);
-        await this.fetch("/:id", "DELETE", {
-            pathParams: {
-                id
-            }
-        });
-    }
-}
-
-exports.VerifiableStorageRestClient = VerifiableStorageRestClient;