@twin.org/synchronised-storage-rest-client 0.0.1-next.9 → 0.0.3-next.10

package/README.md

@@ -1,6 +1,6 @@
-# TWIN Synchronised Storage REST Client
+# Synchronised Storage REST Client
 
-Synchronised storage contract implementation which can connect to REST endpoints.
+This package provides a client for calling trusted synchronised storage REST endpoints, including decryption key retrieval and submission of change sets from connected nodes.
 
 ## Installation
 

package/dist/es/index.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./synchronisedStorageRestClient.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,oCAAoC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./synchronisedStorageRestClient.js\";\n"]}

package/dist/es/synchronisedStorageRestClient.js

@@ -0,0 +1,60 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { BaseRestClient } from "@twin.org/api-core";
+import { Guards } from "@twin.org/core";
+import { HeaderHelper, HeaderTypes } from "@twin.org/web";
+/**
+ * Client for performing synchronised storage through to REST endpoints.
+ */
+export class SynchronisedStorageRestClient extends BaseRestClient {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "SynchronisedStorageRestClient";
+    /**
+     * Create a new instance of SynchronisedStorageRestClient.
+     * @param config The configuration for the client.
+     */
+    constructor(config) {
+        super(SynchronisedStorageRestClient.CLASS_NAME, config, "synchronised-storage");
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return SynchronisedStorageRestClient.CLASS_NAME;
+    }
+    /**
+     * Get the decryption key for the synchronised storage.
+     * This is used to decrypt the data stored in the synchronised storage.
+     * @param trustPayload Trust payload to verify the requesters identity.
+     * @returns The decryption key.
+     */
+    async getDecryptionKey(trustPayload) {
+        Guards.stringValue(SynchronisedStorageRestClient.CLASS_NAME, "trustPayload", trustPayload);
+        const response = await this.fetch("/decryption-key", "GET", {
+            headers: {
+                [HeaderTypes.Authorization]: HeaderHelper.createBearer(trustPayload)
+            }
+        });
+        return response.body.decryptionKey;
+    }
+    /**
+     * Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
+     * @param syncChangeSet The change set to synchronise.
+     * @param trustPayload Trust payload to verify the requesters identity.
+     * @returns Nothing.
+     */
+    async syncChangeSet(syncChangeSet, trustPayload) {
+        Guards.object(SynchronisedStorageRestClient.CLASS_NAME, "syncChangeSet", syncChangeSet);
+        Guards.stringValue(SynchronisedStorageRestClient.CLASS_NAME, "trustPayload", trustPayload);
+        await this.fetch("/sync-changeset", "POST", {
+            headers: {
+                [HeaderTypes.Authorization]: HeaderHelper.createBearer(trustPayload)
+            },
+            body: syncChangeSet
+        });
+    }
+}
+//# sourceMappingURL=synchronisedStorageRestClient.js.map

package/dist/es/synchronisedStorageRestClient.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"synchronisedStorageRestClient.js","sourceRoot":"","sources":["../../src/synchronisedStorageRestClient.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAEpD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AASxC,OAAO,EAAE,YAAY,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAE1D;;GAEG;AACH,MAAM,OAAO,6BACZ,SAAQ,cAAc;IAGtB;;OAEG;IACI,MAAM,CAAU,UAAU,mCAAmD;IAEpF;;;OAGG;IACH,YAAY,MAA6B;QACxC,KAAK,CAAC,6BAA6B,CAAC,UAAU,EAAE,MAAM,EAAE,sBAAsB,CAAC,CAAC;IACjF,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,6BAA6B,CAAC,UAAU,CAAC;IACjD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,gBAAgB,CAAC,YAAqB;QAClD,MAAM,CAAC,WAAW,CACjB,6BAA6B,CAAC,UAAU,kBAExC,YAAY,CACZ,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,iBAAiB,EACjB,KAAK,EACL;YACC,OAAO,EAAE;gBACR,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC,YAAY,CAAC;aACpE;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CAAC,aAA6B,EAAE,YAAqB;QAC9E,MAAM,CAAC,MAAM,CACZ,6BAA6B,CAAC,UAAU,mBAExC,aAAa,CACb,CAAC;QAEF,MAAM,CAAC,WAAW,CACjB,6BAA6B,CAAC,UAAU,kBAExC,YAAY,CACZ,CAAC;QAEF,MAAM,IAAI,CAAC,KAAK,CAA4C,iBAAiB,EAAE,MAAM,EAAE;YACtF,OAAO,EAAE;gBACR,CAAC,WAAW,CAAC,aAAa,CAAC,EAAE,YAAY,CAAC,YAAY,CAAC,YAAY,CAAC;aACpE;YACD,IAAI,EAAE,aAAa;SACnB,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 { Guards } from \"@twin.org/core\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type {\n\tISyncChangeSet,\n\tISyncChangeSetRequest,\n\tISyncDecryptionKeyRequest,\n\tISyncDecryptionKeyResponse,\n\tISynchronisedStorageComponent\n} from \"@twin.org/synchronised-storage-models\";\nimport { HeaderHelper, HeaderTypes } from \"@twin.org/web\";\n\n/**\n * Client for performing synchronised storage through to REST endpoints.\n */\nexport class SynchronisedStorageRestClient\n\textends BaseRestClient\n\timplements ISynchronisedStorageComponent\n{\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<SynchronisedStorageRestClient>();\n\n\t/**\n\t * Create a new instance of SynchronisedStorageRestClient.\n\t * @param config The configuration for the client.\n\t */\n\tconstructor(config: IBaseRestClientConfig) {\n\t\tsuper(SynchronisedStorageRestClient.CLASS_NAME, config, \"synchronised-storage\");\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 SynchronisedStorageRestClient.CLASS_NAME;\n\t}\n\n\t/**\n\t * Get the decryption key for the synchronised storage.\n\t * This is used to decrypt the data stored in the synchronised storage.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns The decryption key.\n\t */\n\tpublic async getDecryptionKey(trustPayload: unknown): Promise<string> {\n\t\tGuards.stringValue(\n\t\t\tSynchronisedStorageRestClient.CLASS_NAME,\n\t\t\tnameof(trustPayload),\n\t\t\ttrustPayload\n\t\t);\n\n\t\tconst response = await this.fetch<ISyncDecryptionKeyRequest, ISyncDecryptionKeyResponse>(\n\t\t\t\"/decryption-key\",\n\t\t\t\"GET\",\n\t\t\t{\n\t\t\t\theaders: {\n\t\t\t\t\t[HeaderTypes.Authorization]: HeaderHelper.createBearer(trustPayload)\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\n\t\treturn response.body.decryptionKey;\n\t}\n\n\t/**\n\t * Synchronise a set of changes from an untrusted node, assumes this is a trusted node.\n\t * @param syncChangeSet The change set to synchronise.\n\t * @param trustPayload Trust payload to verify the requesters identity.\n\t * @returns Nothing.\n\t */\n\tpublic async syncChangeSet(syncChangeSet: ISyncChangeSet, trustPayload: unknown): Promise<void> {\n\t\tGuards.object<ISyncChangeSet>(\n\t\t\tSynchronisedStorageRestClient.CLASS_NAME,\n\t\t\tnameof(syncChangeSet),\n\t\t\tsyncChangeSet\n\t\t);\n\n\t\tGuards.stringValue(\n\t\t\tSynchronisedStorageRestClient.CLASS_NAME,\n\t\t\tnameof(trustPayload),\n\t\t\ttrustPayload\n\t\t);\n\n\t\tawait this.fetch<ISyncChangeSetRequest, INoContentResponse>(\"/sync-changeset\", \"POST\", {\n\t\t\theaders: {\n\t\t\t\t[HeaderTypes.Authorization]: HeaderHelper.createBearer(trustPayload)\n\t\t\t},\n\t\t\tbody: syncChangeSet\n\t\t});\n\t}\n}\n"]}

package/dist/types/index.d.ts

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

package/dist/types/{synchronisedStorageClient.d.ts → synchronisedStorageRestClient.d.ts}

@@ -1,32 +1,36 @@
 import { BaseRestClient } from "@twin.org/api-core";
 import type { IBaseRestClientConfig } from "@twin.org/api-models";
-import type { IProof } from "@twin.org/standards-w3c-did";
 import type { ISyncChangeSet, ISynchronisedStorageComponent } from "@twin.org/synchronised-storage-models";
 /**
  * Client for performing synchronised storage through to REST endpoints.
  */
-export declare class SynchronisedStorageClient extends BaseRestClient implements ISynchronisedStorageComponent {
+export declare class SynchronisedStorageRestClient extends BaseRestClient implements ISynchronisedStorageComponent {
     /**
      * Runtime name for the class.
      */
-    readonly CLASS_NAME: string;
+    static readonly CLASS_NAME: string;
     /**
-     * Create a new instance of SynchronisedStorageClient.
+     * Create a new instance of SynchronisedStorageRestClient.
      * @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;
     /**
      * Get the decryption key for the synchronised storage.
      * This is used to decrypt the data stored in the synchronised storage.
-     * @param nodeIdentity The identity of the node requesting the decryption key.
-     * @param proof The proof of the request so we know the request is from the specified node.
+     * @param trustPayload Trust payload to verify the requesters identity.
      * @returns The decryption key.
      */
-    getDecryptionKey(nodeIdentity: string, proof: IProof): Promise<string>;
+    getDecryptionKey(trustPayload: unknown): Promise<string>;
     /**
      * Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
      * @param syncChangeSet The change set to synchronise.
+     * @param trustPayload Trust payload to verify the requesters identity.
      * @returns Nothing.
      */
-    syncChangeSet(syncChangeSet: ISyncChangeSet): Promise<void>;
+    syncChangeSet(syncChangeSet: ISyncChangeSet, trustPayload: unknown): Promise<void>;
 }

package/docs/changelog.md

@@ -1,5 +1,250 @@
 # Changelog
 
+## [0.0.3-next.10](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.3-next.9...synchronised-storage-rest-client-v0.0.3-next.10) (2026-03-20)
+
+
+### Bug Fixes
+
+* remove redundant code ([19edb23](https://github.com/twinfoundation/synchronised-storage/commit/19edb236f318b9c9454a64259d0ab5098a0c8173))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.3-next.9 to 0.0.3-next.10
+
+## [0.0.3-next.9](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.3-next.8...synchronised-storage-rest-client-v0.0.3-next.9) (2026-03-04)
+
+
+### Miscellaneous Chores
+
+* **synchronised-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.3-next.8 to 0.0.3-next.9
+
+## [0.0.3-next.8](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.3-next.7...synchronised-storage-rest-client-v0.0.3-next.8) (2026-02-25)
+
+
+### Miscellaneous Chores
+
+* **synchronised-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.3-next.7 to 0.0.3-next.8
+
+## [0.0.3-next.7](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.3-next.6...synchronised-storage-rest-client-v0.0.3-next.7) (2026-01-28)
+
+
+### Miscellaneous Chores
+
+* **synchronised-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.3-next.6 to 0.0.3-next.7
+
+## [0.0.3-next.6](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.3-next.5...synchronised-storage-rest-client-v0.0.3-next.6) (2026-01-22)
+
+
+### Miscellaneous Chores
+
+* **synchronised-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.3-next.5 to 0.0.3-next.6
+
+## [0.0.3-next.5](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.3-next.4...synchronised-storage-rest-client-v0.0.3-next.5) (2026-01-19)
+
+
+### Features
+
+* remove unused dependencies ([518c460](https://github.com/twinfoundation/synchronised-storage/commit/518c460d2e5e2b2c487565acb5162a03ddb85eae))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.3-next.4 to 0.0.3-next.5
+
+## [0.0.3-next.4](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.3-next.3...synchronised-storage-rest-client-v0.0.3-next.4) (2026-01-15)
+
+
+### Miscellaneous Chores
+
+* **synchronised-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.3-next.3 to 0.0.3-next.4
+
+## [0.0.3-next.3](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.3-next.2...synchronised-storage-rest-client-v0.0.3-next.3) (2026-01-12)
+
+
+### Features
+
+* add trustPayload guards ([cf1622f](https://github.com/twinfoundation/synchronised-storage/commit/cf1622f8b65a4b77032e31ecaa41664499f4c892))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.3-next.2 to 0.0.3-next.3
+
+## [0.0.3-next.2](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.3-next.1...synchronised-storage-rest-client-v0.0.3-next.2) (2025-12-04)
+
+
+### Features
+
+* use trust component ([424f0d6](https://github.com/twinfoundation/synchronised-storage/commit/424f0d6aaacfdc7700c46fe6c2def23b2eacddc9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.3-next.1 to 0.0.3-next.2
+
+## [0.0.3-next.1](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.3-next.0...synchronised-storage-rest-client-v0.0.3-next.1) (2025-11-12)
+
+
+### Features
+
+* add context id features ([#24](https://github.com/twinfoundation/synchronised-storage/issues/24)) ([5266b18](https://github.com/twinfoundation/synchronised-storage/commit/5266b18088317c7dc274a209a79102a6fc88a8e4))
+* add rights management integration ([d003d33](https://github.com/twinfoundation/synchronised-storage/commit/d003d33d2d2b4a4aa1379071eed71a707ebcb4de))
+* add validate-locales ([e3d7b98](https://github.com/twinfoundation/synchronised-storage/commit/e3d7b98839e9ca624855717c8957d572c4e09abf))
+* blob storage connector instead of component ([#7](https://github.com/twinfoundation/synchronised-storage/issues/7)) ([ea27241](https://github.com/twinfoundation/synchronised-storage/commit/ea27241cf0810b52ab7a6be7346809d127b7109a))
+* eslint migration to flat config ([f601c14](https://github.com/twinfoundation/synchronised-storage/commit/f601c14f6adef3290554dc7df6e6b3528aa0dc2b))
+* initial commit ([16949b8](https://github.com/twinfoundation/synchronised-storage/commit/16949b8e5bdb190f053c52af352290e3fd964f9a))
+* update framework core ([99f09cc](https://github.com/twinfoundation/synchronised-storage/commit/99f09cc94cfb9fff6b3a345775eeae2ab3192ed2))
+* update to in built vc auth mechanism ([411a371](https://github.com/twinfoundation/synchronised-storage/commit/411a3716830195ebf54755a1633b05d5c3f96754))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
+## [0.0.1-next.16](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.1-next.15...synchronised-storage-rest-client-v0.0.1-next.16) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([e3d7b98](https://github.com/twinfoundation/synchronised-storage/commit/e3d7b98839e9ca624855717c8957d572c4e09abf))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.1-next.15 to 0.0.1-next.16
+
+## [0.0.1-next.15](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.1-next.14...synchronised-storage-rest-client-v0.0.1-next.15) (2025-09-23)
+
+
+### Features
+
+* update to in built vc auth mechanism ([411a371](https://github.com/twinfoundation/synchronised-storage/commit/411a3716830195ebf54755a1633b05d5c3f96754))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.1-next.14 to 0.0.1-next.15
+
+## [0.0.1-next.14](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.1-next.13...synchronised-storage-rest-client-v0.0.1-next.14) (2025-09-22)
+
+
+### Features
+
+* add rights management integration ([d003d33](https://github.com/twinfoundation/synchronised-storage/commit/d003d33d2d2b4a4aa1379071eed71a707ebcb4de))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.1-next.13 to 0.0.1-next.14
+
+## [0.0.1-next.13](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.1-next.12...synchronised-storage-rest-client-v0.0.1-next.13) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([f601c14](https://github.com/twinfoundation/synchronised-storage/commit/f601c14f6adef3290554dc7df6e6b3528aa0dc2b))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.1-next.12 to 0.0.1-next.13
+
+## [0.0.1-next.12](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.1-next.11...synchronised-storage-rest-client-v0.0.1-next.12) (2025-08-21)
+
+
+### Features
+
+* update framework core ([99f09cc](https://github.com/twinfoundation/synchronised-storage/commit/99f09cc94cfb9fff6b3a345775eeae2ab3192ed2))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.1-next.11 to 0.0.1-next.12
+
+## [0.0.1-next.11](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.1-next.10...synchronised-storage-rest-client-v0.0.1-next.11) (2025-08-15)
+
+
+### Miscellaneous Chores
+
+* **synchronised-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.1-next.10 to 0.0.1-next.11
+
+## [0.0.1-next.10](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.1-next.9...synchronised-storage-rest-client-v0.0.1-next.10) (2025-08-15)
+
+
+### Miscellaneous Chores
+
+* **synchronised-storage-rest-client:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.1-next.9 to 0.0.1-next.10
+
 ## [0.0.1-next.9](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-rest-client-v0.0.1-next.8...synchronised-storage-rest-client-v0.0.1-next.9) (2025-08-13)
 
 
@@ -126,4 +371,4 @@
   * dependencies
     * @twin.org/synchronised-storage-models bumped from 0.0.1-next.0 to 0.0.1-next.1
 
-## @twin.org/synchronised-storage-rest-client - Changelog
+## Changelog

package/docs/examples.md

@@ -1 +1,56 @@
-# @twin.org/synchronised-storage-rest-client - Examples
+# Synchronised Storage REST Client Examples
+
+These snippets show how to call trusted synchronisation endpoints from a node or backend process using strongly typed request data.
+
+## SynchronisedStorageRestClient
+
+```typescript
+import { SynchronisedStorageRestClient } from '@twin.org/synchronised-storage-rest-client';
+
+const client = new SynchronisedStorageRestClient({
+  endpoint: 'https://api.example.net'
+});
+
+const className = client.className();
+
+console.log(className); // SynchronisedStorageRestClient
+```
+
+```typescript
+import {
+  SynchronisedStorageContexts,
+  SynchronisedStorageTypes,
+  type ISyncChangeSet
+} from '@twin.org/synchronised-storage-models';
+import { SynchronisedStorageRestClient } from '@twin.org/synchronised-storage-rest-client';
+
+const client = new SynchronisedStorageRestClient({
+  endpoint: 'https://api.example.net'
+});
+
+const trustPayload = 'eyJhbGciOiJFZERTQSJ9.sample-payload.signature';
+const decryptionKey = await client.getDecryptionKey(trustPayload);
+
+console.log(decryptionKey.length); // 44
+
+const changeSet: ISyncChangeSet = {
+  '@context': SynchronisedStorageContexts.Context,
+  type: SynchronisedStorageTypes.ChangeSet,
+  id: 'changeset-20260310-01',
+  storageKey: 'profile',
+  dateCreated: '2026-03-10T10:00:00.000Z',
+  dateModified: '2026-03-10T10:00:00.000Z',
+  nodeIdentity: 'did:iota:node-2',
+  changes: [
+    {
+      operation: 'set',
+      id: 'profile-4',
+      entity: {
+        dateModified: '2026-03-10T10:00:00.000Z'
+      }
+    }
+  ]
+};
+
+await client.syncChangeSet(changeSet, trustPayload);
+```

package/docs/reference/classes/{SynchronisedStorageClient.md → SynchronisedStorageRestClient.md}

@@ -1,4 +1,4 @@
-# Class: SynchronisedStorageClient
+# Class: SynchronisedStorageRestClient
 
 Client for performing synchronised storage through to REST endpoints.
 
@@ -14,9 +14,9 @@ Client for performing synchronised storage through to REST endpoints.
 
 ### Constructor
 
-> **new SynchronisedStorageClient**(`config`): `SynchronisedStorageClient`
+> **new SynchronisedStorageRestClient**(`config`): `SynchronisedStorageRestClient`
 
-Create a new instance of SynchronisedStorageClient.
+Create a new instance of SynchronisedStorageRestClient.
 
 #### Parameters
 
@@ -28,7 +28,7 @@ The configuration for the client.
 
 #### Returns
 
-`SynchronisedStorageClient`
+`SynchronisedStorageRestClient`
 
 #### Overrides
 
@@ -36,38 +36,46 @@ The configuration for the client.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
-> `readonly` **CLASS\_NAME**: `string` = `SynchronisedStorageClient._CLASS_NAME`
+> `readonly` `static` **CLASS\_NAME**: `string`
 
 Runtime name for the class.
 
+## Methods
+
+### className() {#classname}
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
 #### Implementation of
 
-`ISynchronisedStorageComponent.CLASS_NAME`
+`ISynchronisedStorageComponent.className`
 
-## Methods
+***
 
-### getDecryptionKey()
+### getDecryptionKey() {#getdecryptionkey}
 
-> **getDecryptionKey**(`nodeIdentity`, `proof`): `Promise`\<`string`\>
+> **getDecryptionKey**(`trustPayload`): `Promise`\<`string`\>
 
 Get the decryption key for the synchronised storage.
 This is used to decrypt the data stored in the synchronised storage.
 
 #### Parameters
 
-##### nodeIdentity
-
-`string`
-
-The identity of the node requesting the decryption key.
+##### trustPayload
 
-##### proof
+`unknown`
 
-`IProof`
-
-The proof of the request so we know the request is from the specified node.
+Trust payload to verify the requesters identity.
 
 #### Returns
 
@@ -81,9 +89,9 @@ The decryption key.
 
 ***
 
-### syncChangeSet()
+### syncChangeSet() {#syncchangeset}
 
-> **syncChangeSet**(`syncChangeSet`): `Promise`\<`void`\>
+> **syncChangeSet**(`syncChangeSet`, `trustPayload`): `Promise`\<`void`\>
 
 Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
 
@@ -95,6 +103,12 @@ Synchronise a set of changes from an untrusted node, assumes this is a trusted n
 
 The change set to synchronise.
 
+##### trustPayload
+
+`unknown`
+
+Trust payload to verify the requesters identity.
+
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/index.md

@@ -2,4 +2,4 @@
 
 ## Classes
 
-- [SynchronisedStorageClient](classes/SynchronisedStorageClient.md)
+- [SynchronisedStorageRestClient](classes/SynchronisedStorageRestClient.md)

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/synchronised-storage-rest-client",
-	"version": "0.0.1-next.9",
-	"description": "Synchronised storage contract implementation which can connect to REST endpoints",
+	"version": "0.0.3-next.10",
+	"description": "REST client for trusted decryption key retrieval and change set synchronisation.",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/twinfoundation/synchronised-storage.git",
@@ -16,28 +16,39 @@
 	"dependencies": {
 		"@twin.org/api-core": "next",
 		"@twin.org/api-models": "next",
+		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/standards-w3c-did": "next",
-		"@twin.org/synchronised-storage-models": "0.0.1-next.9"
+		"@twin.org/synchronised-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"
-	]
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"synchronised-storage"
+	],
+	"bugs": {
+		"url": "git+https://github.com/twinfoundation/synchronised-storage/issues"
+	},
+	"homepage": "https://twindev.org"
 }

package/dist/cjs/index.cjs

@@ -1,59 +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 synchronised storage through to REST endpoints.
- */
-class SynchronisedStorageClient extends apiCore.BaseRestClient {
-    /**
-     * Runtime name for the class.
-     * @internal
-     */
-    static _CLASS_NAME = "SynchronisedStorageClient";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = SynchronisedStorageClient._CLASS_NAME;
-    /**
-     * Create a new instance of SynchronisedStorageClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super(SynchronisedStorageClient._CLASS_NAME, config, "synchronised-storage");
-    }
-    /**
-     * Get the decryption key for the synchronised storage.
-     * This is used to decrypt the data stored in the synchronised storage.
-     * @param nodeIdentity The identity of the node requesting the decryption key.
-     * @param proof The proof of the request so we know the request is from the specified node.
-     * @returns The decryption key.
-     */
-    async getDecryptionKey(nodeIdentity, proof) {
-        core.Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-        core.Guards.object(this.CLASS_NAME, "proof", proof);
-        const response = await this.fetch("/decryption-key", "POST", {
-            body: {
-                nodeIdentity,
-                proof
-            }
-        });
-        return response.body.decryptionKey;
-    }
-    /**
-     * Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
-     * @param syncChangeSet The change set to synchronise.
-     * @returns Nothing.
-     */
-    async syncChangeSet(syncChangeSet) {
-        core.Guards.object(this.CLASS_NAME, "syncChangeSet", syncChangeSet);
-        await this.fetch("/sync-changeset", "POST", {
-            body: syncChangeSet
-        });
-    }
-}
-
-exports.SynchronisedStorageClient = SynchronisedStorageClient;

package/dist/esm/index.mjs

@@ -1,57 +0,0 @@
-import { BaseRestClient } from '@twin.org/api-core';
-import { Guards } from '@twin.org/core';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Client for performing synchronised storage through to REST endpoints.
- */
-class SynchronisedStorageClient extends BaseRestClient {
-    /**
-     * Runtime name for the class.
-     * @internal
-     */
-    static _CLASS_NAME = "SynchronisedStorageClient";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = SynchronisedStorageClient._CLASS_NAME;
-    /**
-     * Create a new instance of SynchronisedStorageClient.
-     * @param config The configuration for the client.
-     */
-    constructor(config) {
-        super(SynchronisedStorageClient._CLASS_NAME, config, "synchronised-storage");
-    }
-    /**
-     * Get the decryption key for the synchronised storage.
-     * This is used to decrypt the data stored in the synchronised storage.
-     * @param nodeIdentity The identity of the node requesting the decryption key.
-     * @param proof The proof of the request so we know the request is from the specified node.
-     * @returns The decryption key.
-     */
-    async getDecryptionKey(nodeIdentity, proof) {
-        Guards.stringValue(this.CLASS_NAME, "nodeIdentity", nodeIdentity);
-        Guards.object(this.CLASS_NAME, "proof", proof);
-        const response = await this.fetch("/decryption-key", "POST", {
-            body: {
-                nodeIdentity,
-                proof
-            }
-        });
-        return response.body.decryptionKey;
-    }
-    /**
-     * Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
-     * @param syncChangeSet The change set to synchronise.
-     * @returns Nothing.
-     */
-    async syncChangeSet(syncChangeSet) {
-        Guards.object(this.CLASS_NAME, "syncChangeSet", syncChangeSet);
-        await this.fetch("/sync-changeset", "POST", {
-            body: syncChangeSet
-        });
-    }
-}
-
-export { SynchronisedStorageClient };