@twin.org/synchronised-storage-service 0.0.1-next.8 → 0.0.3-next.1

package/docs/architecture.md

@@ -62,7 +62,6 @@ The Synchronised Storage Service implements a distributed, eventually-consistent
                     ┌───────────▼────────────┐
                     │  Verifiable Storage    │
                     │   • On-chain Pointers  │
-                    │   • State Root Hashes  │
                     │   • Access Control     │
                     └───────────┬────────────┘
                                 │
@@ -70,7 +69,6 @@ The Synchronised Storage Service implements a distributed, eventually-consistent
                     │ Decentralised Storage  │
                     │   • IPFS/Content Hash  │
                     │   • Immutable Blobs    │
-                    │   • Distributed Refs   │
                     └────────────────────────┘
 ```
 
@@ -89,10 +87,9 @@ The Synchronised Storage Service implements a distributed, eventually-consistent
 
 - **Multi-Node Architecture**: Multiple trusted nodes operate in parallel to distribute processing load and provide high availability
 - **Change Validation**: Verify cryptographic signatures and node permissions across the cluster
-- **Change Set Consolidation**: Periodic compaction of historical change logs distributed across trusted node instances
-- **Decentralised Storage Interface**: Upload/download operations to IPFS-like systems with load balancing
+- **Change Set Consolidation**: Periodic compaction of changes to create complete data sets
+- **Decentralised Storage Interface**: Upload/download operations to e.g. IPFS
 - **Verifiable Storage Updates**: Atomic updates to on-chain state pointers with consensus agreement
-- **Load Distribution**: Automatic distribution of regular node connections and change processing across available trusted nodes
 
 ## Data Flow Architecture
 
@@ -105,24 +102,183 @@ EntityStorage → ChangeCapture → LocalSnapshot → EventBus
 ### 2. Change Set Propagation
 
 ```typescript
-LocalNode → [Sign] → ChangeSet → TrustedNode → [Validation] → GlobalState
+RegularNode → [Sign] → ChangeSet → TrustedNode → [Verify] → GlobalState
 ```
 
 ### 3. Global State Persistence
 
 ```typescript
-TrustedNode → [Sign & Compression] → DecentralisedStorage → [StateRoot] → VerifiableStorage
+TrustedNode → [Encrypt & Compress] → DecentralisedStorage → [StateRoot] → VerifiableStorage
 ```
 
 ### 4. Remote Synchronisation
 
 ```typescript
-AnyNode → [Poll] → VerifiableStorage → [Fetch] → DecentralisedStorage → [Merge] → LocalState
+AnyNode → [Poll] → VerifiableStorage → [Fetch] → DecentralisedStorage → [Decrypt & Decompress] → LocalState
 ```
 
+## Synchronisation Algorithms
+
+### Apply Sync State Logic
+
+The `applySyncState` method in `LocalSyncStateHelper` implements the core synchronisation algorithm that reconciles remote sync state with local state. This algorithm handles both full and incremental synchronisation scenarios:
+
+#### Algorithm Overview
+
+**Input Processing:**
+
+- Retrieves existing local snapshots and remote sync state snapshots
+- Sorts both collections by creation date (newest to oldest) for temporal ordering
+- Extracts epoch information for gap detection analysis
+
+**Epoch Gap Detection:**
+
+If the node has not been running for a while or has failed communications it might start to miss data, so we use gap detection to determine if we need to use a full consolidation snapshot.
+
+```typescript
+const newestExistingEpoch = existingSnapshots[0]?.epoch ?? 0;
+const oldestSyncStateEpoch = syncStateSnapshots[syncStateSnapshots.length - 1]?.epoch ?? 0;
+const hasEpochGap = newestExistingEpoch + 1 < oldestSyncStateEpoch;
+```
+
+**Synchronisation Strategy Decision:**
+
+1. **Full Synchronisation Trigger:**
+   - No existing consolidated snapshots locally, OR
+   - Detected epoch gap between local and remote state
+
+2. **Incremental Synchronisation Trigger:**
+   - Existing consolidated snapshots present AND
+   - No epoch gaps detected
+
+#### Full Synchronisation Process
+
+When full sync is required:
+
+1. **Consolidation Search:** Locates the most recent consolidated snapshot in remote state
+2. **Entity Storage Reset:** Clears all remote entities from local storage to ensure clean state, but retains all local entries maintained by this node
+3. **Progressive Application:** Processes snapshots from the consolidation point forward to the newest, ensuring newer changes override older ones
+4. **Change Set Processing:** Applies all change sets from the consolidation and subsequent modifications
+
+#### Incremental Synchronisation Process
+
+When incremental sync is sufficient:
+
+1. **Snapshot Mapping:** Creates lookup map of existing local snapshots for efficient comparison
+2. **Change Detection:** Categorises remote snapshots into:
+   - **New Snapshots:** Not present locally
+   - **Modified Snapshots:** Present but with different `dateModified`
+   - **Unchanged Snapshots:** Identical local and remote versions
+
+3. **Processing Optimisation:** Stops processing when encountering an unchanged snapshot (temporal consistency guarantee)
+
+4. **Change Set Application:**
+   - Processes modified snapshots to apply incremental changes
+   - Processes new snapshots in chronological order (oldest to newest)
+   - Removes unreferenced local snapshots for storage clean-up
+
+#### Key Design Principles
+
+- **Temporal Consistency:** Changes are applied in chronological order to maintain causality
+- **Conflict Resolution:** Newer changes automatically override older ones within the same entity
+- **Storage Efficiency:** Only processes changed or new snapshots, avoiding redundant operations
+- **Data Integrity:** Maintains referential integrity by cleaning up orphaned snapshot references
+- **Gap Recovery:** Automatically triggers full synchronisation when data continuity is compromised
+
+#### Error Handling & Edge Cases
+
+- **Missing Consolidations:** Logs warning when full sync is needed but no consolidated snapshot is available
+- **Empty Remote State:** Handles scenarios where remote sync state contains no snapshots
+- **Epoch Inconsistencies:** Automatically recovers from epoch gaps through full synchronisation
+- **Processing Interruption:** Uses `completedProcessing` flag to optimise incremental sync execution
+
+This algorithm ensures eventually consistent data replication across distributed nodes while minimising network traffic and computational overhead through intelligent synchronisation strategy selection.
+
 ## Data Structures
 
-- Sync Pointer Store - stored in verifiable storage, for each storage type contains a storage id of the location for sync states
-- Sync State - stored in decentralised storage, contains all of the snapshots for a specific storage key
-- Sync Snapshot - contains a list of all the decentralised storage ids for the change sets which make up the snapshot
-- Change Set - contains a set of changes to be made to the entity storage
+### Sync Pointer Store
+
+Stored in verifiable storage, for each storage type contains a storage id of the location for sync states.
+
+```json
+{
+  "syncPointers": {
+    "my-type-1": "blob:ipfs:0x11...1111",
+    "my-type-2": "blob:ipfs:0x22...2222"
+  }
+}
+```
+
+### Sync State
+
+Stored in decentralised storage, contains all of the snapshots for a specific storage key
+
+```json
+{
+    "storageKey": "my-type-1",
+    "snapshots": [
+        {
+            "id": "0xaaa...aaa",
+            ...
+        },
+        {
+            "id": "0xbbb...bbb",
+            ...
+        }
+    ]
+}
+```
+
+### Sync Snapshot
+
+Contains a list of all the storage ids for the change sets which make up the snapshot
+
+```json
+{
+    "id": "0xaaa...aaa",
+    "dateCreated": "2025-05-29T01:00:00.000Z",
+    "dateModified": "2025-05-29T01:00:00.000Z",
+    "isConsolidated": false, // Determines if this contains a complete data set
+    "epoch": 123, // A counter that is incremented for each snapshot
+    "changeSetStorageIds": [
+        "blob:ipfs:0x111...1111",
+        "blob:ipfs:0x111...1112"
+        ...
+    ]
+}
+```
+
+### Sync Change Set
+
+Contains a set of changes to be made to the entity storage, the proof is generated by the node identity which guarantees the validity of the data from the node
+
+```json
+{
+    "id": "0xaaa...aaa",
+    "storageKey": "my-type-1",
+    "dateCreated": "2025-05-29T01:00:00.000Z",
+    "dateModified": "2025-05-29T01:00:00.000Z",
+    "changes": [
+        ...
+    ],
+    "nodeIdentity": "did:iota:0xccc.cccccc",
+    "proof": {
+        // Cryptographic proof signed by the node identity
+    }
+}
+```
+
+### Sync Change
+
+Contains a mutation for an entry in entity storage, either a `set` of `delete`. The `id` and `nodeIdentity` are omitted from the entity and stored at a higher level in the data structures to shrink the data set size.
+
+```json
+{
+  "operation": "set",
+  "id": "my-item-1",
+  "entity": {
+    "foo": true,
+    "bar": 123
+  }
+}
+```

package/docs/changelog.md

@@ -1,5 +1,154 @@
 # Changelog
 
+## [0.0.3-next.1](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-service-v0.0.3-next.0...synchronised-storage-service-v0.0.3-next.1) (2025-11-12)
+
+
+### Features
+
+* add async item requests to reduce storage overhead ([#3](https://github.com/twinfoundation/synchronised-storage/issues/3)) ([af4e17d](https://github.com/twinfoundation/synchronised-storage/commit/af4e17d826f0a8278fd60dc69aaa21fe6895425f))
+* add context id features ([#24](https://github.com/twinfoundation/synchronised-storage/issues/24)) ([5266b18](https://github.com/twinfoundation/synchronised-storage/commit/5266b18088317c7dc274a209a79102a6fc88a8e4))
+* add guards for verifiable storage keys ([5182e8b](https://github.com/twinfoundation/synchronised-storage/commit/5182e8b2a7868e8d396fd02964b0ed7f0c0a5947))
+* add payload versioning ([3bbbce0](https://github.com/twinfoundation/synchronised-storage/commit/3bbbce0bdf24bbe67c1a265704538d505d7feb91))
+* add rights management integration ([56fff6b](https://github.com/twinfoundation/synchronised-storage/commit/56fff6b4074f7ffaa40920e0c1e9fc98ca669111))
+* 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))
+* additional node identity checks ([76257c4](https://github.com/twinfoundation/synchronised-storage/commit/76257c4173303d484391f71f581fd0e214204029))
+* 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))
+* improve consolidation logic ([698232f](https://github.com/twinfoundation/synchronised-storage/commit/698232f57640f87642ecd323cb1e4670eda33343))
+* initial commit ([16949b8](https://github.com/twinfoundation/synchronised-storage/commit/16949b8e5bdb190f053c52af352290e3fd964f9a))
+* remove isTrustedNode from config and rely on trusted component ([cc2d987](https://github.com/twinfoundation/synchronised-storage/commit/cc2d98795044fc97b33fadf871188f6103f5c987))
+* removed unused properties ([7d4e916](https://github.com/twinfoundation/synchronised-storage/commit/7d4e9169e923142cd767c8830f2c009675484df8))
+* switch to chacha20poly1305 for encryption ([ecc7137](https://github.com/twinfoundation/synchronised-storage/commit/ecc713775bc958c15453729aa1d6dacafd789906))
+* switch to logging component ([a606302](https://github.com/twinfoundation/synchronised-storage/commit/a606302d7b89b922d33456b420d8f140d4fd565a))
+* sync testing ([#5](https://github.com/twinfoundation/synchronised-storage/issues/5)) ([f78d5ac](https://github.com/twinfoundation/synchronised-storage/commit/f78d5ac661b891f9912e0a81d028453f909a64b4))
+* update assertion method naming ([fb0118c](https://github.com/twinfoundation/synchronised-storage/commit/fb0118c494f0f520e1850a4e77b54e91235ce9a9))
+* update framework core ([99f09cc](https://github.com/twinfoundation/synchronised-storage/commit/99f09cc94cfb9fff6b3a345775eeae2ab3192ed2))
+* update RSA components ([c57c7b8](https://github.com/twinfoundation/synchronised-storage/commit/c57c7b85d4225deb6efa1228c77b8148bf6e11f7))
+* 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-service-v0.0.1-next.15...synchronised-storage-service-v0.0.1-next.16) (2025-10-09)
+
+
+### Features
+
+* add validate-locales ([e3d7b98](https://github.com/twinfoundation/synchronised-storage/commit/e3d7b98839e9ca624855717c8957d572c4e09abf))
+* update assertion method naming ([fb0118c](https://github.com/twinfoundation/synchronised-storage/commit/fb0118c494f0f520e1850a4e77b54e91235ce9a9))
+
+
+### 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-service-v0.0.1-next.14...synchronised-storage-service-v0.0.1-next.15) (2025-09-23)
+
+
+### Features
+
+* add rights management integration ([56fff6b](https://github.com/twinfoundation/synchronised-storage/commit/56fff6b4074f7ffaa40920e0c1e9fc98ca669111))
+* 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-service-v0.0.1-next.13...synchronised-storage-service-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-service-v0.0.1-next.12...synchronised-storage-service-v0.0.1-next.13) (2025-08-29)
+
+
+### Features
+
+* eslint migration to flat config ([f601c14](https://github.com/twinfoundation/synchronised-storage/commit/f601c14f6adef3290554dc7df6e6b3528aa0dc2b))
+* removed unused properties ([7d4e916](https://github.com/twinfoundation/synchronised-storage/commit/7d4e9169e923142cd767c8830f2c009675484df8))
+
+
+### 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-service-v0.0.1-next.11...synchronised-storage-service-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-service-v0.0.1-next.10...synchronised-storage-service-v0.0.1-next.11) (2025-08-15)
+
+
+### Features
+
+* switch to chacha20poly1305 for encryption ([ecc7137](https://github.com/twinfoundation/synchronised-storage/commit/ecc713775bc958c15453729aa1d6dacafd789906))
+
+
+### 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-service-v0.0.1-next.9...synchronised-storage-service-v0.0.1-next.10) (2025-08-15)
+
+
+### Features
+
+* update RSA components ([c57c7b8](https://github.com/twinfoundation/synchronised-storage/commit/c57c7b85d4225deb6efa1228c77b8148bf6e11f7))
+
+
+### 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-service-v0.0.1-next.8...synchronised-storage-service-v0.0.1-next.9) (2025-08-13)
+
+
+### Features
+
+* add guards for verifiable storage keys ([5182e8b](https://github.com/twinfoundation/synchronised-storage/commit/5182e8b2a7868e8d396fd02964b0ed7f0c0a5947))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.1-next.8 to 0.0.1-next.9
+
 ## [0.0.1-next.8](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-service-v0.0.1-next.7...synchronised-storage-service-v0.0.1-next.8) (2025-08-13)
 
 

package/docs/open-api/spec.json

@@ -28,6 +28,27 @@
 				"tags": [
 					"Synchronised Storage"
 				],
+				"parameters": [
+					{
+						"name": "accept",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple"
+					},
+					{
+						"name": "authorization",
+						"in": "header",
+						"required": true,
+						"schema": {
+							"type": "string"
+						},
+						"style": "simple",
+						"example": "z3V32BP9ShC...z3V32BP9ShC"
+					}
+				],
 				"requestBody": {
 					"description": "Request a trusted node to perform a sync request for a changeset.",
 					"required": true,
@@ -39,10 +60,12 @@
 							"examples": {
 								"synchronisedStorageSyncChangeSetRequestExample": {
 									"value": {
+										"@context": "https://schema.twindev.org/synchronised-storage",
+										"type": "ChangeSet",
 										"id": "0909090909090909090909090909090909090909090909090909090909090909",
 										"dateCreated": "2025-05-29T01:00:00.000Z",
 										"dateModified": "2025-05-29T01:00:00.000Z",
-										"nodeIdentity": "did:entity-storage:0xd2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2",
+										"nodeId": "did:entity-storage:0xd2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2",
 										"changes": [
 											{
 												"entity": {
@@ -52,15 +75,6 @@
 												"operation": "set"
 											}
 										],
-										"proof": {
-											"@context": "https://www.w3.org/ns/credentials/v2",
-											"created": "2025-05-29T01:00:00.000Z",
-											"cryptosuite": "eddsa-jcs-2022",
-											"proofPurpose": "assertionMethod",
-											"proofValue": "z5efBErQs3YBLZoH7jgKMQaRc9YjAxA5XSYKmW3FmTBDw9WionT2NS2x1SMvcRyBvw53cSSoaCT1xQH9tkWngGCX3",
-											"type": "DataIntegrityProof",
-											"verificationMethod": "did:entity-storage:0xd0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0#synchronised-storage-assertion"
-										},
 										"storageKey": "test-type"
 									}
 								}
@@ -83,7 +97,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -104,7 +118,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -128,22 +142,6 @@
 						"application/json": {
 							"schema": {
 								"$ref": "#/components/schemas/SyncChangeSet"
-							},
-							"examples": {
-								"synchronisedStorageSyncGetDecryptionKeyRequestExample": {
-									"value": {
-										"nodeIdentity": "did:entity-storage:0xd2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2d2",
-										"proof": {
-											"@context": "https://www.w3.org/ns/credentials/v2",
-											"created": "2025-05-29T01:00:00.000Z",
-											"cryptosuite": "eddsa-jcs-2022",
-											"proofPurpose": "assertionMethod",
-											"proofValue": "z5efBErQs3YBLZoH7jgKMQaRc9YjAxA5XSYKmW3FmTBDw9WionT2NS2x1SMvcRyBvw53cSSoaCT1xQH9tkWngGCX3",
-											"type": "DataIntegrityProof",
-											"verificationMethod": "did:entity-storage:0xd0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0d0#synchronised-storage-assertion"
-										}
-									}
-								}
 							}
 						}
 					}
@@ -177,7 +175,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "GeneralError",
-											"message": "component.error",
+											"message": "errorMessage",
 											"properties": {
 												"foo": "bar"
 											}
@@ -198,7 +196,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "UnauthorizedError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -216,7 +214,7 @@
 									"exampleResponse": {
 										"value": {
 											"name": "InternalServerError",
-											"message": "component.error"
+											"message": "errorMessage"
 										}
 									}
 								}
@@ -253,7 +251,7 @@
 						"type": "string",
 						"description": "The stack trace for the error."
 					},
-					"inner": {
+					"cause": {
 						"$ref": "#/components/schemas/Error"
 					}
 				},
@@ -264,7 +262,7 @@
 				"additionalProperties": false,
 				"description": "Model to describe serialized error."
 			},
-			"SyncChange<SynchronisedEntity>": {
+			"SyncChange": {
 				"type": "object",
 				"properties": {
 					"operation": {
@@ -275,7 +273,7 @@
 						"description": "The item id."
 					},
 					"entity": {
-						"$ref": "#/components/schemas/SynchronisedEntity"
+						"$ref": "#/components/schemas/SynchronisedEntityCore"
 					}
 				},
 				"required": [
@@ -303,47 +301,53 @@
 			"SyncChangeSet": {
 				"type": "object",
 				"properties": {
-					"id": {
+					"@context": {
 						"type": "string",
-						"description": "The id of the change set."
+						"const": "https://schema.twindev.org/synchronised-storage",
+						"description": "The LD Context for the change set."
 					},
-					"dateCreated": {
+					"type": {
 						"type": "string",
-						"description": "The date the change set was created."
+						"const": "ChangeSet",
+						"description": "The LD Type for the change set."
+					},
+					"id": {
+						"type": "string",
+						"description": "The id of the change set."
 					},
 					"storageKey": {
 						"type": "string",
 						"description": "The storage key of the change set. This is used to identify the entities being synchronised."
 					},
+					"dateCreated": {
+						"type": "string",
+						"description": "The date the change set was created."
+					},
 					"dateModified": {
 						"type": "string",
 						"description": "The date the change set was last modified."
 					},
-					"changes": {
-						"type": "array",
-						"items": false,
-						"description": "The changes to apply after a snapshot.",
-						"prefixItems": [
-							{
-								"$ref": "#/components/schemas/SyncChange<SynchronisedEntity>"
-							}
-						]
-					},
-					"nodeIdentity": {
+					"nodeId": {
 						"type": "string",
 						"description": "The identity of the node that created the change set."
 					},
-					"proof": {
-						"$ref": "https://schema.twindev.org/w3c-did/Proof"
+					"changes": {
+						"type": "array",
+						"items": {
+							"$ref": "#/components/schemas/SyncChange"
+						},
+						"description": "The changes to apply after a snapshot."
 					}
 				},
 				"required": [
+					"@context",
+					"type",
 					"id",
-					"dateCreated",
 					"storageKey",
+					"dateCreated",
 					"dateModified",
-					"changes",
-					"nodeIdentity"
+					"nodeId",
+					"changes"
 				],
 				"additionalProperties": false,
 				"description": "The object definition for a sync change set."
@@ -362,18 +366,19 @@
 				"additionalProperties": false,
 				"description": "The body of the response."
 			},
-			"SynchronisedEntity": {
+			"SynchronisedEntityCore": {
 				"type": "object",
 				"properties": {
 					"dateModified": {
 						"type": "string",
-						"description": "The date the entry was modified"
+						"description": "The date the entry was modified."
 					}
 				},
 				"required": [
 					"dateModified"
 				],
-				"additionalProperties": false
+				"additionalProperties": false,
+				"description": "The base definition for synchronised entries."
 			}
 		},
 		"securitySchemes": {

package/docs/reference/classes/SyncSnapshotEntry.md

@@ -1,22 +1,16 @@
-# Class: SyncSnapshotEntry\<T\>
+# Class: SyncSnapshotEntry
 
 Class representing an entry for the sync snapshot.
 
-## Type Parameters
-
-### T
-
-`T` *extends* `ISynchronisedEntity` = `ISynchronisedEntity`
-
 ## Constructors
 
 ### Constructor
 
-> **new SyncSnapshotEntry**\<`T`\>(): `SyncSnapshotEntry`\<`T`\>
+> **new SyncSnapshotEntry**(): `SyncSnapshotEntry`
 
 #### Returns
 
-`SyncSnapshotEntry`\<`T`\>
+`SyncSnapshotEntry`
 
 ## Properties
 
@@ -94,6 +88,6 @@ The ids of the storage for the change sets in the snapshot, if this is not a loc
 
 ### changes?
 
-> `optional` **changes**: `ISyncChange`\<`T`\>[]
+> `optional` **changes**: `ISyncChange`[]
 
 The changes that were made in this snapshot, if this is a local snapshot.