@twin.org/synchronised-storage-models 0.0.1-next.13 → 0.0.1-next.14

package/dist/cjs/index.cjs

@@ -1,5 +1,7 @@
 'use strict';
 
+var standardsW3cOdrl = require('@twin.org/standards-w3c-odrl');
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -17,6 +19,44 @@ const SyncChangeOperation = {
     Delete: "delete"
 };
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The ODRL asset types for SynchronisedStorage.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SynchronisedStorageAssetTypes = {
+    /**
+     * Decryption Key.
+     */
+    DecryptionKey: "decryption-key",
+    /**
+     * Decryption Key Actions.
+     */
+    DecryptionKeyActions: [standardsW3cOdrl.ActionType.Read],
+    /**
+     * Change Set.
+     */
+    ChangeSet: "change-set",
+    /**
+     * Change Set Actions.
+     */
+    ChangeSetActions: [standardsW3cOdrl.ActionType.Write]
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The LD Contexts concerning SynchronisedStorage.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SynchronisedStorageContexts = {
+    /**
+     * The SynchronisedStorage LD Context.
+     */
+    ContextRoot: "https://schema.twindev.org/synchronised-storage"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -62,6 +102,23 @@ const SynchronisedStorageTopics = {
     RemoteItemRemove: "synchronised-storage:remote-item-remove"
 };
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of Synchronised Storage data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SynchronisedStorageTypes = {
+    /**
+     * Represents a synchronised storage request.
+     */
+    SyncRequest: "SyncRequest",
+    /**
+     * Represents a synchronised storage change set.
+     */
+    ChangeSet: "ChangeSet"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -85,4 +142,7 @@ const SyncNodeIdentityMode = {
 
 exports.SyncChangeOperation = SyncChangeOperation;
 exports.SyncNodeIdentityMode = SyncNodeIdentityMode;
+exports.SynchronisedStorageAssetTypes = SynchronisedStorageAssetTypes;
+exports.SynchronisedStorageContexts = SynchronisedStorageContexts;
 exports.SynchronisedStorageTopics = SynchronisedStorageTopics;
+exports.SynchronisedStorageTypes = SynchronisedStorageTypes;

package/dist/esm/index.mjs

@@ -1,3 +1,5 @@
+import { ActionType } from '@twin.org/standards-w3c-odrl';
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -15,6 +17,44 @@ const SyncChangeOperation = {
     Delete: "delete"
 };
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The ODRL asset types for SynchronisedStorage.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SynchronisedStorageAssetTypes = {
+    /**
+     * Decryption Key.
+     */
+    DecryptionKey: "decryption-key",
+    /**
+     * Decryption Key Actions.
+     */
+    DecryptionKeyActions: [ActionType.Read],
+    /**
+     * Change Set.
+     */
+    ChangeSet: "change-set",
+    /**
+     * Change Set Actions.
+     */
+    ChangeSetActions: [ActionType.Write]
+};
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The LD Contexts concerning SynchronisedStorage.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SynchronisedStorageContexts = {
+    /**
+     * The SynchronisedStorage LD Context.
+     */
+    ContextRoot: "https://schema.twindev.org/synchronised-storage"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -60,6 +100,23 @@ const SynchronisedStorageTopics = {
     RemoteItemRemove: "synchronised-storage:remote-item-remove"
 };
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The types of Synchronised Storage data.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+const SynchronisedStorageTypes = {
+    /**
+     * Represents a synchronised storage request.
+     */
+    SyncRequest: "SyncRequest",
+    /**
+     * Represents a synchronised storage change set.
+     */
+    ChangeSet: "ChangeSet"
+};
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -81,4 +138,4 @@ const SyncNodeIdentityMode = {
     All: "all"
 };
 
-export { SyncChangeOperation, SyncNodeIdentityMode, SynchronisedStorageTopics };
+export { SyncChangeOperation, SyncNodeIdentityMode, SynchronisedStorageAssetTypes, SynchronisedStorageContexts, SynchronisedStorageTopics, SynchronisedStorageTypes };

package/dist/types/index.d.ts

@@ -10,10 +10,15 @@ export * from "./models/eventBus/ISyncItemResponse";
 export * from "./models/eventBus/ISyncItemSet";
 export * from "./models/eventBus/ISyncRegisterStorageKey";
 export * from "./models/eventBus/ISyncReset";
-export * from "./models/eventBus/syncChangeOperation";
 export * from "./models/ISyncChange";
 export * from "./models/ISyncChangeSet";
 export * from "./models/ISynchronisedEntity";
+export * from "./models/ISynchronisedEntityCore";
 export * from "./models/ISynchronisedStorageComponent";
+export * from "./models/ISyncRequest";
+export * from "./models/syncChangeOperation";
+export * from "./models/synchronisedStorageAssetTypes";
+export * from "./models/synchronisedStorageContexts";
 export * from "./models/synchronisedStorageTopics";
+export * from "./models/synchronisedStorageTypes";
 export * from "./models/syncNodeIdentityMode";

package/dist/types/models/ISyncChange.d.ts

@@ -1,9 +1,9 @@
-import type { SyncChangeOperation } from "./eventBus/syncChangeOperation";
-import type { ISynchronisedEntity } from "./ISynchronisedEntity";
+import type { ISynchronisedEntityCore } from "./ISynchronisedEntityCore";
+import type { SyncChangeOperation } from "./syncChangeOperation";
 /**
  * The object definition for a sync change.
  */
-export interface ISyncChange<T extends ISynchronisedEntity = ISynchronisedEntity> {
+export interface ISyncChange {
     /**
      * Operation.
      */
@@ -15,5 +15,5 @@ export interface ISyncChange<T extends ISynchronisedEntity = ISynchronisedEntity
     /**
      * The entity to set.
      */
-    entity?: Omit<T, "id" | "nodeIdentity">;
+    entity?: ISynchronisedEntityCore;
 }

package/dist/types/models/ISyncChangeSet.d.ts

@@ -1,10 +1,18 @@
-import type { IProof } from "@twin.org/standards-w3c-did";
 import type { ISyncChange } from "./ISyncChange";
-import type { ISynchronisedEntity } from "./ISynchronisedEntity";
+import type { SynchronisedStorageContexts } from "./synchronisedStorageContexts";
+import type { SynchronisedStorageTypes } from "./synchronisedStorageTypes";
 /**
  * The object definition for a sync change set.
  */
-export interface ISyncChangeSet<T extends ISynchronisedEntity = ISynchronisedEntity> {
+export interface ISyncChangeSet {
+    /**
+     * The LD Context for the change set.
+     */
+    "@context": typeof SynchronisedStorageContexts.ContextRoot;
+    /**
+     * The LD Type for the change set.
+     */
+    type: typeof SynchronisedStorageTypes.ChangeSet;
     /**
      * The id of the change set.
      */
@@ -21,16 +29,12 @@ export interface ISyncChangeSet<T extends ISynchronisedEntity = ISynchronisedEnt
      * The date the change set was last modified.
      */
     dateModified: string;
-    /**
-     * The changes to apply after a snapshot.
-     */
-    changes: ISyncChange<T>[];
     /**
      * The identity of the node that created the change set.
      */
     nodeIdentity: string;
     /**
-     * The proof for the change set.
+     * The changes to apply after a snapshot.
      */
-    proof?: IProof;
+    changes: ISyncChange[];
 }

package/dist/types/models/ISyncRequest.d.ts

@@ -0,0 +1,19 @@
+import type { SynchronisedStorageContexts } from "./synchronisedStorageContexts";
+import type { SynchronisedStorageTypes } from "./synchronisedStorageTypes";
+/**
+ * The object definition for a sync request.
+ */
+export interface ISyncRequest {
+    /**
+     * The LD Context for the request.
+     */
+    "@context": typeof SynchronisedStorageContexts.ContextRoot;
+    /**
+     * The LD Type for the request.
+     */
+    type: typeof SynchronisedStorageTypes.SyncRequest;
+    /**
+     * The identity of the node that created the request.
+     */
+    nodeIdentity: string;
+}

package/dist/types/models/ISynchronisedEntity.d.ts

@@ -1,15 +1,12 @@
+import type { ISynchronisedEntityCore } from "./ISynchronisedEntityCore";
 /**
  * The base definition for synchronised entries.
  */
-export interface ISynchronisedEntity {
+export interface ISynchronisedEntity extends ISynchronisedEntityCore {
     /**
      * The id of the entry.
      */
     id: string;
-    /**
-     * The date the entry was modified
-     */
-    dateModified: string;
     /**
      * The identity of the node that owns the entry.
      */

package/dist/types/models/ISynchronisedEntityCore.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The base definition for synchronised entries.
+ */
+export interface ISynchronisedEntityCore {
+    /**
+     * The date the entry was modified.
+     */
+    dateModified: string;
+}

package/dist/types/models/ISynchronisedStorageComponent.d.ts

@@ -1,5 +1,4 @@
 import type { IComponent } from "@twin.org/core";
-import type { IProof } from "@twin.org/standards-w3c-did";
 import type { ISyncChangeSet } from "./ISyncChangeSet";
 /**
  * Class for performing synchronised storage operations.
@@ -8,15 +7,15 @@ export interface ISynchronisedStorageComponent extends IComponent {
     /**
      * 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 proofToken The proof token to validate the request.
      * @returns The decryption key.
      */
-    getDecryptionKey(nodeIdentity: string, proof: IProof): Promise<string>;
+    getDecryptionKey(proofToken: string): 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 proofToken The proof token to validate the request.
      * @returns Nothing.
      */
-    syncChangeSet(syncChangeSet: ISyncChangeSet): Promise<void>;
+    syncChangeSet(syncChangeSet: ISyncChangeSet, proofToken: string): Promise<void>;
 }

package/dist/types/models/api/ISyncChangeSetRequest.d.ts

@@ -1,8 +1,16 @@
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
 import type { ISyncChangeSet } from "../ISyncChangeSet";
 /**
  * Request a trusted node to perform a sync request for a changeset.
  */
 export interface ISyncChangeSetRequest {
+    /**
+     * The headers which can be used to determine the response data type.
+     */
+    headers: {
+        [HeaderTypes.Accept]?: typeof MimeTypes.JsonLd | typeof MimeTypes.Json;
+        [HeaderTypes.Authorization]: string;
+    };
     /**
      * The body of the request.
      */

package/dist/types/models/api/ISyncDecryptionKeyRequest.d.ts

@@ -1,19 +1,13 @@
-import type { IProof } from "@twin.org/standards-w3c-did";
+import type { HeaderTypes, MimeTypes } from "@twin.org/web";
 /**
  * Request for the decryption key for the synchronised storage.
  */
 export interface ISyncDecryptionKeyRequest {
     /**
-     * The body of the request.
+     * The headers which can be used to determine the response data type.
      */
-    body: {
-        /**
-         * The identity of the node making the request.
-         */
-        nodeIdentity: string;
-        /**
-         * The proof of the request.
-         */
-        proof: IProof;
+    headers: {
+        [HeaderTypes.Accept]?: typeof MimeTypes.JsonLd | typeof MimeTypes.Json;
+        [HeaderTypes.Authorization]: string;
     };
 }

package/dist/types/models/eventBus/ISyncBatchResponse.d.ts

@@ -2,7 +2,7 @@ import type { ISynchronisedEntity } from "../ISynchronisedEntity";
 /**
  * Response for a local batch.
  */
-export interface ISyncBatchResponse<T extends ISynchronisedEntity> {
+export interface ISyncBatchResponse {
     /**
      * The key of the storage for the entities in the batch.
      */
@@ -10,7 +10,7 @@ export interface ISyncBatchResponse<T extends ISynchronisedEntity> {
     /**
      * The entities in the batch.
      */
-    entities: T[];
+    entities: ISynchronisedEntity[];
     /**
      * Is this the last entry in the batch?
      */

package/dist/types/models/eventBus/ISyncItemChange.d.ts

@@ -1,4 +1,4 @@
-import type { SyncChangeOperation } from "./syncChangeOperation";
+import type { SyncChangeOperation } from "../syncChangeOperation";
 /**
  * The payload for an item change.
  */

package/dist/types/models/eventBus/ISyncItemResponse.d.ts

@@ -2,7 +2,7 @@ import type { ISynchronisedEntity } from "../ISynchronisedEntity";
 /**
  * Response for a sync item request.
  */
-export interface ISyncItemResponse<T extends ISynchronisedEntity> {
+export interface ISyncItemResponse {
     /**
      * The key of the storage for the entities in the batch.
      */
@@ -14,5 +14,5 @@ export interface ISyncItemResponse<T extends ISynchronisedEntity> {
     /**
      * The entity in the sync item response, undefined if not found.
      */
-    entity?: T;
+    entity?: ISynchronisedEntity;
 }

package/dist/types/models/eventBus/ISyncItemSet.d.ts

@@ -2,7 +2,7 @@ import type { ISynchronisedEntity } from "../ISynchronisedEntity";
 /**
  * The payload for an item set.
  */
-export interface ISyncItemSet<T extends ISynchronisedEntity = ISynchronisedEntity> {
+export interface ISyncItemSet {
     /**
      * The key of the storage being set.
      */
@@ -10,5 +10,5 @@ export interface ISyncItemSet<T extends ISynchronisedEntity = ISynchronisedEntit
     /**
      * The entity being set in the item set.
      */
-    entity: T;
+    entity: ISynchronisedEntity;
 }

package/dist/types/models/synchronisedStorageAssetTypes.d.ts

@@ -0,0 +1,25 @@
+/**
+ * The ODRL asset types for SynchronisedStorage.
+ */
+export declare const SynchronisedStorageAssetTypes: {
+    /**
+     * Decryption Key.
+     */
+    readonly DecryptionKey: "decryption-key";
+    /**
+     * Decryption Key Actions.
+     */
+    readonly DecryptionKeyActions: readonly ["read"];
+    /**
+     * Change Set.
+     */
+    readonly ChangeSet: "change-set";
+    /**
+     * Change Set Actions.
+     */
+    readonly ChangeSetActions: readonly ["write"];
+};
+/**
+ * The ODRL asset types for SynchronisedStorage.
+ */
+export type SynchronisedStorageAssetTypes = (typeof SynchronisedStorageAssetTypes)[keyof typeof SynchronisedStorageAssetTypes];

package/dist/types/models/synchronisedStorageContexts.d.ts

@@ -0,0 +1,13 @@
+/**
+ * The LD Contexts concerning SynchronisedStorage.
+ */
+export declare const SynchronisedStorageContexts: {
+    /**
+     * The SynchronisedStorage LD Context.
+     */
+    readonly ContextRoot: "https://schema.twindev.org/synchronised-storage";
+};
+/**
+ * The LD Contexts concerning SynchronisedStorage.
+ */
+export type SynchronisedStorageContexts = (typeof SynchronisedStorageContexts)[keyof typeof SynchronisedStorageContexts];

package/dist/types/models/synchronisedStorageTypes.d.ts

@@ -0,0 +1,17 @@
+/**
+ * The types of Synchronised Storage data.
+ */
+export declare const SynchronisedStorageTypes: {
+    /**
+     * Represents a synchronised storage request.
+     */
+    readonly SyncRequest: "SyncRequest";
+    /**
+     * Represents a synchronised storage change set.
+     */
+    readonly ChangeSet: "ChangeSet";
+};
+/**
+ * The types of Synchronised Storage data.
+ */
+export type SynchronisedStorageTypes = (typeof SynchronisedStorageTypes)[keyof typeof SynchronisedStorageTypes];

package/docs/changelog.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [0.0.1-next.14](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.13...synchronised-storage-models-v0.0.1-next.14) (2025-09-22)
+
+
+### Features
+
+* add rights management integration ([d003d33](https://github.com/twinfoundation/synchronised-storage/commit/d003d33d2d2b4a4aa1379071eed71a707ebcb4de))
+
 ## [0.0.1-next.13](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-models-v0.0.1-next.12...synchronised-storage-models-v0.0.1-next.13) (2025-08-29)
 
 

package/docs/reference/index.md

@@ -4,7 +4,9 @@
 
 - [ISyncChange](interfaces/ISyncChange.md)
 - [ISyncChangeSet](interfaces/ISyncChangeSet.md)
+- [ISyncRequest](interfaces/ISyncRequest.md)
 - [ISynchronisedEntity](interfaces/ISynchronisedEntity.md)
+- [ISynchronisedEntityCore](interfaces/ISynchronisedEntityCore.md)
 - [ISynchronisedStorageComponent](interfaces/ISynchronisedStorageComponent.md)
 - [ISyncChangeSetRequest](interfaces/ISyncChangeSetRequest.md)
 - [ISyncDecryptionKeyRequest](interfaces/ISyncDecryptionKeyRequest.md)
@@ -23,10 +25,16 @@
 
 - [SyncChangeOperation](type-aliases/SyncChangeOperation.md)
 - [SyncNodeIdentityMode](type-aliases/SyncNodeIdentityMode.md)
+- [SynchronisedStorageAssetTypes](type-aliases/SynchronisedStorageAssetTypes.md)
+- [SynchronisedStorageContexts](type-aliases/SynchronisedStorageContexts.md)
 - [SynchronisedStorageTopics](type-aliases/SynchronisedStorageTopics.md)
+- [SynchronisedStorageTypes](type-aliases/SynchronisedStorageTypes.md)
 
 ## Variables
 
 - [SyncChangeOperation](variables/SyncChangeOperation.md)
 - [SyncNodeIdentityMode](variables/SyncNodeIdentityMode.md)
+- [SynchronisedStorageAssetTypes](variables/SynchronisedStorageAssetTypes.md)
+- [SynchronisedStorageContexts](variables/SynchronisedStorageContexts.md)
 - [SynchronisedStorageTopics](variables/SynchronisedStorageTopics.md)
+- [SynchronisedStorageTypes](variables/SynchronisedStorageTypes.md)

package/docs/reference/interfaces/ISyncBatchResponse.md

@@ -1,13 +1,7 @@
-# Interface: ISyncBatchResponse\<T\>
+# Interface: ISyncBatchResponse
 
 Response for a local batch.
 
-## Type Parameters
-
-### T
-
-`T` *extends* [`ISynchronisedEntity`](ISynchronisedEntity.md)
-
 ## Properties
 
 ### storageKey
@@ -20,7 +14,7 @@ The key of the storage for the entities in the batch.
 
 ### entities
 
-> **entities**: `T`[]
+> **entities**: [`ISynchronisedEntity`](ISynchronisedEntity.md)[]
 
 The entities in the batch.
 

package/docs/reference/interfaces/ISyncChange.md

@@ -1,13 +1,7 @@
-# Interface: ISyncChange\<T\>
+# Interface: ISyncChange
 
 The object definition for a sync change.
 
-## Type Parameters
-
-### T
-
-`T` *extends* [`ISynchronisedEntity`](ISynchronisedEntity.md) = [`ISynchronisedEntity`](ISynchronisedEntity.md)
-
 ## Properties
 
 ### operation
@@ -28,6 +22,6 @@ The item id.
 
 ### entity?
 
-> `optional` **entity**: `Omit`\<`T`, `"id"` \| `"nodeIdentity"`\>
+> `optional` **entity**: [`ISynchronisedEntityCore`](ISynchronisedEntityCore.md)
 
 The entity to set.

package/docs/reference/interfaces/ISyncChangeSet.md

@@ -1,14 +1,24 @@
-# Interface: ISyncChangeSet\<T\>
+# Interface: ISyncChangeSet
 
 The object definition for a sync change set.
 
-## Type Parameters
+## Properties
 
-### T
+### @context
 
-`T` *extends* [`ISynchronisedEntity`](ISynchronisedEntity.md) = [`ISynchronisedEntity`](ISynchronisedEntity.md)
+> **@context**: `"https://schema.twindev.org/synchronised-storage"`
 
-## Properties
+The LD Context for the change set.
+
+***
+
+### type
+
+> **type**: `"ChangeSet"`
+
+The LD Type for the change set.
+
+***
 
 ### id
 
@@ -42,14 +52,6 @@ The date the change set was last modified.
 
 ***
 
-### changes
-
-> **changes**: [`ISyncChange`](ISyncChange.md)\<`T`\>[]
-
-The changes to apply after a snapshot.
-
-***
-
 ### nodeIdentity
 
 > **nodeIdentity**: `string`
@@ -58,8 +60,8 @@ The identity of the node that created the change set.
 
 ***
 
-### proof?
+### changes
 
-> `optional` **proof**: `IProof`
+> **changes**: [`ISyncChange`](ISyncChange.md)[]
 
-The proof for the change set.
+The changes to apply after a snapshot.

package/docs/reference/interfaces/ISyncChangeSetRequest.md

@@ -4,6 +4,22 @@ Request a trusted node to perform a sync request for a changeset.
 
 ## Properties
 
+### headers
+
+> **headers**: `object`
+
+The headers which can be used to determine the response data type.
+
+#### accept?
+
+> `optional` **accept**: `"application/ld+json"` \| `"application/json"`
+
+#### authorization
+
+> **authorization**: `string`
+
+***
+
 ### body
 
 > **body**: [`ISyncChangeSet`](ISyncChangeSet.md)

package/docs/reference/interfaces/ISyncDecryptionKeyRequest.md

@@ -4,20 +4,16 @@ Request for the decryption key for the synchronised storage.
 
 ## Properties
 
-### body
+### headers
 
-> **body**: `object`
+> **headers**: `object`
 
-The body of the request.
+The headers which can be used to determine the response data type.
 
-#### nodeIdentity
+#### accept?
 
-> **nodeIdentity**: `string`
+> `optional` **accept**: `"application/ld+json"` \| `"application/json"`
 
-The identity of the node making the request.
+#### authorization
 
-#### proof
-
-> **proof**: `IProof`
-
-The proof of the request.
+> **authorization**: `string`

package/docs/reference/interfaces/ISyncItemResponse.md

@@ -1,13 +1,7 @@
-# Interface: ISyncItemResponse\<T\>
+# Interface: ISyncItemResponse
 
 Response for a sync item request.
 
-## Type Parameters
-
-### T
-
-`T` *extends* [`ISynchronisedEntity`](ISynchronisedEntity.md)
-
 ## Properties
 
 ### storageKey
@@ -28,6 +22,6 @@ The id of the entity in the sync item response.
 
 ### entity?
 
-> `optional` **entity**: `T`
+> `optional` **entity**: [`ISynchronisedEntity`](ISynchronisedEntity.md)
 
 The entity in the sync item response, undefined if not found.

package/docs/reference/interfaces/ISyncItemSet.md

@@ -1,13 +1,7 @@
-# Interface: ISyncItemSet\<T\>
+# Interface: ISyncItemSet
 
 The payload for an item set.
 
-## Type Parameters
-
-### T
-
-`T` *extends* [`ISynchronisedEntity`](ISynchronisedEntity.md) = [`ISynchronisedEntity`](ISynchronisedEntity.md)
-
 ## Properties
 
 ### storageKey
@@ -20,6 +14,6 @@ The key of the storage being set.
 
 ### entity
 
-> **entity**: `T`
+> **entity**: [`ISynchronisedEntity`](ISynchronisedEntity.md)
 
 The entity being set in the item set.

package/docs/reference/interfaces/ISyncRequest.md

@@ -0,0 +1,27 @@
+# Interface: ISyncRequest
+
+The object definition for a sync request.
+
+## Properties
+
+### @context
+
+> **@context**: `"https://schema.twindev.org/synchronised-storage"`
+
+The LD Context for the request.
+
+***
+
+### type
+
+> **type**: `"SyncRequest"`
+
+The LD Type for the request.
+
+***
+
+### nodeIdentity
+
+> **nodeIdentity**: `string`
+
+The identity of the node that created the request.

package/docs/reference/interfaces/ISynchronisedEntity.md

@@ -2,6 +2,10 @@
 
 The base definition for synchronised entries.
 
+## Extends
+
+- [`ISynchronisedEntityCore`](ISynchronisedEntityCore.md)
+
 ## Properties
 
 ### id
@@ -12,16 +16,20 @@ The id of the entry.
 
 ***
 
-### dateModified
+### nodeIdentity
 
-> **dateModified**: `string`
+> **nodeIdentity**: `string`
 
-The date the entry was modified
+The identity of the node that owns the entry.
 
 ***
 
-### nodeIdentity
+### dateModified
 
-> **nodeIdentity**: `string`
+> **dateModified**: `string`
 
-The identity of the node that owns the entry.
+The date the entry was modified.
+
+#### Inherited from
+
+[`ISynchronisedEntityCore`](ISynchronisedEntityCore.md).[`dateModified`](ISynchronisedEntityCore.md#datemodified)

package/docs/reference/interfaces/ISynchronisedEntityCore.md

@@ -0,0 +1,15 @@
+# Interface: ISynchronisedEntityCore
+
+The base definition for synchronised entries.
+
+## Extended by
+
+- [`ISynchronisedEntity`](ISynchronisedEntity.md)
+
+## Properties
+
+### dateModified
+
+> **dateModified**: `string`
+
+The date the entry was modified.

package/docs/reference/interfaces/ISynchronisedStorageComponent.md

@@ -10,24 +10,18 @@ Class for performing synchronised storage operations.
 
 ### getDecryptionKey()
 
-> **getDecryptionKey**(`nodeIdentity`, `proof`): `Promise`\<`string`\>
+> **getDecryptionKey**(`proofToken`): `Promise`\<`string`\>
 
 Get the decryption key for the synchronised storage.
 This is used to decrypt the data stored in the synchronised storage.
 
 #### Parameters
 
-##### nodeIdentity
+##### proofToken
 
 `string`
 
-The identity of the node requesting the decryption key.
-
-##### proof
-
-`IProof`
-
-The proof of the request so we know the request is from the specified node.
+The proof token to validate the request.
 
 #### Returns
 
@@ -39,7 +33,7 @@ The decryption key.
 
 ### syncChangeSet()
 
-> **syncChangeSet**(`syncChangeSet`): `Promise`\<`void`\>
+> **syncChangeSet**(`syncChangeSet`, `proofToken`): `Promise`\<`void`\>
 
 Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
 
@@ -51,6 +45,12 @@ Synchronise a set of changes from an untrusted node, assumes this is a trusted n
 
 The change set to synchronise.
 
+##### proofToken
+
+`string`
+
+The proof token to validate the request.
+
 #### Returns
 
 `Promise`\<`void`\>

package/docs/reference/type-aliases/SynchronisedStorageAssetTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: SynchronisedStorageAssetTypes
+
+> **SynchronisedStorageAssetTypes** = *typeof* [`SynchronisedStorageAssetTypes`](../variables/SynchronisedStorageAssetTypes.md)\[keyof *typeof* [`SynchronisedStorageAssetTypes`](../variables/SynchronisedStorageAssetTypes.md)\]
+
+The ODRL asset types for SynchronisedStorage.

package/docs/reference/type-aliases/SynchronisedStorageContexts.md

@@ -0,0 +1,5 @@
+# Type Alias: SynchronisedStorageContexts
+
+> **SynchronisedStorageContexts** = *typeof* [`SynchronisedStorageContexts`](../variables/SynchronisedStorageContexts.md)\[keyof *typeof* [`SynchronisedStorageContexts`](../variables/SynchronisedStorageContexts.md)\]
+
+The LD Contexts concerning SynchronisedStorage.

package/docs/reference/type-aliases/SynchronisedStorageTypes.md

@@ -0,0 +1,5 @@
+# Type Alias: SynchronisedStorageTypes
+
+> **SynchronisedStorageTypes** = *typeof* [`SynchronisedStorageTypes`](../variables/SynchronisedStorageTypes.md)\[keyof *typeof* [`SynchronisedStorageTypes`](../variables/SynchronisedStorageTypes.md)\]
+
+The types of Synchronised Storage data.

package/docs/reference/variables/SynchronisedStorageAssetTypes.md

@@ -0,0 +1,31 @@
+# Variable: SynchronisedStorageAssetTypes
+
+> `const` **SynchronisedStorageAssetTypes**: `object`
+
+The ODRL asset types for SynchronisedStorage.
+
+## Type Declaration
+
+### DecryptionKey
+
+> `readonly` **DecryptionKey**: `"decryption-key"` = `"decryption-key"`
+
+Decryption Key.
+
+### DecryptionKeyActions
+
+> `readonly` **DecryptionKeyActions**: readonly \[`"read"`\]
+
+Decryption Key Actions.
+
+### ChangeSet
+
+> `readonly` **ChangeSet**: `"change-set"` = `"change-set"`
+
+Change Set.
+
+### ChangeSetActions
+
+> `readonly` **ChangeSetActions**: readonly \[`"write"`\]
+
+Change Set Actions.

package/docs/reference/variables/SynchronisedStorageContexts.md

@@ -0,0 +1,13 @@
+# Variable: SynchronisedStorageContexts
+
+> `const` **SynchronisedStorageContexts**: `object`
+
+The LD Contexts concerning SynchronisedStorage.
+
+## Type Declaration
+
+### ContextRoot
+
+> `readonly` **ContextRoot**: `"https://schema.twindev.org/synchronised-storage"` = `"https://schema.twindev.org/synchronised-storage"`
+
+The SynchronisedStorage LD Context.

package/docs/reference/variables/SynchronisedStorageTypes.md

@@ -0,0 +1,19 @@
+# Variable: SynchronisedStorageTypes
+
+> `const` **SynchronisedStorageTypes**: `object`
+
+The types of Synchronised Storage data.
+
+## Type Declaration
+
+### SyncRequest
+
+> `readonly` **SyncRequest**: `"SyncRequest"` = `"SyncRequest"`
+
+Represents a synchronised storage request.
+
+### ChangeSet
+
+> `readonly` **ChangeSet**: `"ChangeSet"` = `"ChangeSet"`
+
+Represents a synchronised storage change set.

package/locales/en.json

@@ -1,3 +1 @@
-{
-	"error": {}
-}
+{}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/synchronised-storage-models",
-	"version": "0.0.1-next.13",
+	"version": "0.0.1-next.14",
 	"description": "Models which define the structure of the synchronised storage connectors and services",
 	"repository": {
 		"type": "git",
@@ -16,8 +16,10 @@
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
+		"@twin.org/identity-models": "next",
 		"@twin.org/nameof": "next",
-		"@twin.org/standards-w3c-did": "next"
+		"@twin.org/standards-w3c-did": "next",
+		"@twin.org/standards-w3c-odrl": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
 	"module": "./dist/esm/index.mjs",