@twin.org/synchronised-storage-rest-client 0.0.3-next.1 → 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/synchronisedStorageRestClient.js

@@ -1,8 +1,8 @@
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 import { BaseRestClient } from "@twin.org/api-core";
-import { ContextIdKeys } from "@twin.org/context";
 import { Guards } from "@twin.org/core";
+import { HeaderHelper, HeaderTypes } from "@twin.org/web";
 /**
  * Client for performing synchronised storage through to REST endpoints.
  */
@@ -28,16 +28,14 @@ export class SynchronisedStorageRestClient extends BaseRestClient {
     /**
      * Get the decryption key for the synchronised storage.
      * This is used to decrypt the data stored in the synchronised storage.
-     * @param actionRequest The action request used in the verifiable credential.
+     * @param trustPayload Trust payload to verify the requesters identity.
      * @returns The decryption key.
      */
-    async getDecryptionKey(actionRequest) {
-        Guards.object(SynchronisedStorageRestClient.CLASS_NAME, "actionRequest", actionRequest);
-        const response = await this.fetch("/decryption-key", "GET", undefined, {
-            authenticationGeneratorType: "verifiable-credential",
-            authenticationData: {
-                contextId: ContextIdKeys.Organization,
-                subject: actionRequest
+    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;
@@ -45,19 +43,17 @@ export class SynchronisedStorageRestClient extends BaseRestClient {
     /**
      * Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
      * @param syncChangeSet The change set to synchronise.
-     * @param actionRequest The action request used in the verifiable credential.
+     * @param trustPayload Trust payload to verify the requesters identity.
      * @returns Nothing.
      */
-    async syncChangeSet(syncChangeSet, actionRequest) {
+    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
-        }, {
-            authenticationGeneratorType: "verifiable-credential",
-            authenticationData: {
-                contextId: ContextIdKeys.Organization,
-                subject: actionRequest
-            }
         });
     }
 }

package/dist/es/synchronisedStorageRestClient.js.map

@@ -1 +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,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAWxC;;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,CAC5B,aAAmD;QAEnD,MAAM,CAAC,MAAM,CACZ,6BAA6B,CAAC,UAAU,mBAExC,aAAa,CACb,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAChC,iBAAiB,EACjB,KAAK,EACL,SAAS,EACT;YACC,2BAA2B,EAAE,uBAAuB;YACpD,kBAAkB,EAAE;gBACnB,SAAS,EAAE,aAAa,CAAC,YAAY;gBACrC,OAAO,EAAE,aAAa;aACtB;SACD,CACD,CAAC;QAEF,OAAO,QAAQ,CAAC,IAAI,CAAC,aAAa,CAAC;IACpC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,aAAa,CACzB,aAA6B,EAC7B,aAAmD;QAEnD,MAAM,CAAC,MAAM,CACZ,6BAA6B,CAAC,UAAU,mBAExC,aAAa,CACb,CAAC;QAEF,MAAM,IAAI,CAAC,KAAK,CACf,iBAAiB,EACjB,MAAM,EACN;YACC,IAAI,EAAE,aAAa;SACnB,EACD;YACC,2BAA2B,EAAE,uBAAuB;YACpD,kBAAkB,EAAE;gBACnB,SAAS,EAAE,aAAa,CAAC,YAAY;gBACrC,OAAO,EAAE,aAAa;aACtB;SACD,CACD,CAAC;IACH,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 { ContextIdKeys } from \"@twin.org/context\";\nimport { Guards } from \"@twin.org/core\";\nimport type { IIdentityAuthenticationActionRequest } from \"@twin.org/identity-authentication\";\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\";\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 actionRequest The action request used in the verifiable credential.\n\t * @returns The decryption key.\n\t */\n\tpublic async getDecryptionKey(\n\t\tactionRequest: IIdentityAuthenticationActionRequest\n\t): Promise<string> {\n\t\tGuards.object<IIdentityAuthenticationActionRequest>(\n\t\t\tSynchronisedStorageRestClient.CLASS_NAME,\n\t\t\tnameof(actionRequest),\n\t\t\tactionRequest\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\tundefined,\n\t\t\t{\n\t\t\t\tauthenticationGeneratorType: \"verifiable-credential\",\n\t\t\t\tauthenticationData: {\n\t\t\t\t\tcontextId: ContextIdKeys.Organization,\n\t\t\t\t\tsubject: actionRequest\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 actionRequest The action request used in the verifiable credential.\n\t * @returns Nothing.\n\t */\n\tpublic async syncChangeSet(\n\t\tsyncChangeSet: ISyncChangeSet,\n\t\tactionRequest: IIdentityAuthenticationActionRequest\n\t): 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\tawait this.fetch<ISyncChangeSetRequest, INoContentResponse>(\n\t\t\t\"/sync-changeset\",\n\t\t\t\"POST\",\n\t\t\t{\n\t\t\t\tbody: syncChangeSet\n\t\t\t},\n\t\t\t{\n\t\t\t\tauthenticationGeneratorType: \"verifiable-credential\",\n\t\t\t\tauthenticationData: {\n\t\t\t\t\tcontextId: ContextIdKeys.Organization,\n\t\t\t\t\tsubject: actionRequest\n\t\t\t\t}\n\t\t\t}\n\t\t);\n\t}\n}\n"]}
+{"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/synchronisedStorageRestClient.d.ts

@@ -1,6 +1,5 @@
 import { BaseRestClient } from "@twin.org/api-core";
 import type { IBaseRestClientConfig } from "@twin.org/api-models";
-import type { IIdentityAuthenticationActionRequest } from "@twin.org/identity-authentication";
 import type { ISyncChangeSet, ISynchronisedStorageComponent } from "@twin.org/synchronised-storage-models";
 /**
  * Client for performing synchronised storage through to REST endpoints.
@@ -23,15 +22,15 @@ export declare class SynchronisedStorageRestClient extends BaseRestClient implem
     /**
      * Get the decryption key for the synchronised storage.
      * This is used to decrypt the data stored in the synchronised storage.
-     * @param actionRequest The action request used in the verifiable credential.
+     * @param trustPayload Trust payload to verify the requesters identity.
      * @returns The decryption key.
      */
-    getDecryptionKey(actionRequest: IIdentityAuthenticationActionRequest): 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 actionRequest The action request used in the verifiable credential.
+     * @param trustPayload Trust payload to verify the requesters identity.
      * @returns Nothing.
      */
-    syncChangeSet(syncChangeSet: ISyncChangeSet, actionRequest: IIdentityAuthenticationActionRequest): Promise<void>;
+    syncChangeSet(syncChangeSet: ISyncChangeSet, trustPayload: unknown): Promise<void>;
 }

package/docs/changelog.md

@@ -1,5 +1,131 @@
 # 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)
 
 
@@ -245,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/SynchronisedStorageRestClient.md

@@ -36,7 +36,7 @@ The configuration for the client.
 
 ## Properties
 
-### CLASS\_NAME
+### CLASS\_NAME {#class_name}
 
 > `readonly` `static` **CLASS\_NAME**: `string`
 
@@ -44,7 +44,7 @@ Runtime name for the class.
 
 ## Methods
 
-### className()
+### className() {#classname}
 
 > **className**(): `string`
 
@@ -62,20 +62,20 @@ The class name of the component.
 
 ***
 
-### getDecryptionKey()
+### getDecryptionKey() {#getdecryptionkey}
 
-> **getDecryptionKey**(`actionRequest`): `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
 
-##### actionRequest
+##### trustPayload
 
-`IIdentityAuthenticationActionRequest`
+`unknown`
 
-The action request used in the verifiable credential.
+Trust payload to verify the requesters identity.
 
 #### Returns
 
@@ -89,9 +89,9 @@ The decryption key.
 
 ***
 
-### syncChangeSet()
+### syncChangeSet() {#syncchangeset}
 
-> **syncChangeSet**(`syncChangeSet`, `actionRequest`): `Promise`\<`void`\>
+> **syncChangeSet**(`syncChangeSet`, `trustPayload`): `Promise`\<`void`\>
 
 Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
 
@@ -103,11 +103,11 @@ Synchronise a set of changes from an untrusted node, assumes this is a trusted n
 
 The change set to synchronise.
 
-##### actionRequest
+##### trustPayload
 
-`IIdentityAuthenticationActionRequest`
+`unknown`
 
-The action request used in the verifiable credential.
+Trust payload to verify the requesters identity.
 
 #### Returns
 

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@twin.org/synchronised-storage-rest-client",
-	"version": "0.0.3-next.1",
-	"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",
@@ -19,10 +19,8 @@
 		"@twin.org/context": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/identity-authentication": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/standards-w3c-did": "next",
-		"@twin.org/synchronised-storage-models": "0.0.3-next.1",
+		"@twin.org/synchronised-storage-models": "0.0.3-next.10",
 		"@twin.org/web": "next"
 	},
 	"main": "./dist/es/index.js",