@twin.org/synchronised-storage-service 0.0.1-next.3 → 0.0.1-next.5

package/locales/en.json

@@ -4,18 +4,26 @@
 			"changeSetApplyingChange": "Applying remote sync change with operation id \"{operation}\" for item with id \"{id}\"",
 			"changeSetStoring": "Storing remote sync change set with id \"{id}\"",
 			"verifyChangeSetProofMissing": "Verifying change set with id \"{id}\" failed, missing proof",
-			"verifyChangeSetProofInvalid": "Verifying change set with id \"{id}\" failed, invalid proof",
+			"verifyChangeSetProofInvalid": "Verifying change set with id \"{id}\" failed, missing proof",
+			"verifyChangeSetProofNodeIdentityMismatch": "Verifying change set with id \"{id}\" failed, the node identity does not match the proof",
 			"verifyChangeSetProofValid": "Verifying change set with id \"{id}\" succeeded",
-			"createdChangeSetProof": "Created change proof for change set with id \"{id}\", proof value is \"{proofValue}\""
+			"createdChangeSetProof": "Created change proof for change set with id \"{id}\", proof value is \"{proofValue}\"",
+			"getChangeSet": "Retrieving change set with id \"{changeSetStorageId}\"",
+			"getChangeSetEmpty": "No change set found with id \"{changeSetStorageId}\"",
+			"copyChangeSet": "Copying change set with id \"{changeSetStorageId}\"",
+			"storageReset": "Resetting storage for storage key \"{storageKey}\""
 		},
 		"localSyncStateHelper": {
-			"getLocalChangeSnapshot": "Retrieving local change snapshot for storage key \"{storageKey}\"",
-			"localChangeSnapshotExists": "Found existing local change snapshot for storage key \"{storageKey}\"",
-			"localChangeSnapshotDoesNotExist": "No local change snapshot found for storage key \"{storageKey}\", creating new one",
-			"remoteSyncSynchronisation": "Syncing from remote state with \"{snapshotCount}\" snapshots",
-			"remoteSyncSnapshotProcessing": "Processing remote sync snapshot with id \"{snapshotId}\" created on \"{dateCreated}\"",
-			"remoteSyncSnapshotModified": "Processing modified sync snapshot with id \"{snapshotId}\", remote modified on \"{remoteModified}\", local modified on \"{localModified}\"",
-			"remoteSyncSnapshotNew": "Processing new sync snapshot with id \"{snapshotId}\", created on \"{dateCreated}\"",
+			"getSnapshots": "Retrieving snapshot for storage key \"{storageKey}\"",
+			"getSnapshotsExists": "Found existing snapshot for storage key \"{storageKey}\"",
+			"getSnapshotsDoesNotExist": "No local change snapshot found for storage key \"{storageKey}\", creating new one",
+			"applySyncState": "Syncing from remote state with \"{snapshotCount}\" snapshots",
+			"applySnapshot": "Processing sync snapshot with id \"{snapshotId}\" created on \"{dateCreated}\"",
+			"applySnapshotNoExisting": "There are no existing snapshots, find a consolidated snapshot for storage key \"{storageKey}\"",
+			"applySnapshotFoundConsolidated": "Found consolidated snapshot with id \"{snapshotId}\" for storage key \"{storageKey}\"",
+			"applySnapshotNoConsolidated": "No consolidated snapshot found, cannot apply sync state for storage key \"{storageKey}\"",
+			"processModifiedSnapshot": "Processing modified sync snapshot with id \"{snapshotId}\", remote modified on \"{remoteModified}\", local modified on \"{localModified}\"",
+			"processNewSnapshot": "Processing new sync snapshot with id \"{snapshotId}\", created on \"{dateCreated}\"",
 			"removeLocalChangeSnapshot": "Removing local change snapshot with id \"{snapshotId}\"",
 			"addLocalChange": "Adding local change with id \"{id}\" to local change snapshot for storage key \"{storageKey}\", operation \"{operation}\"",
 			"setLocalChangeSnapshot": "Storing local change snapshot for storage key \"{storageKey}\""
@@ -25,27 +33,39 @@
 			"verifiableSyncPointerStoreNotFound": "No verifiable sync pointer store found for key \"{key}\"",
 			"verifiableSyncPointerStoreRetrieved": "Retrieved verifiable sync pointer for key \"{key}\"",
 			"verifiableSyncPointerStoreStoring": "Storing verifiable sync pointer store for key \"{key}\"",
-			"remoteSyncStateStoring": "Storing remote sync state entry with \"{snapshotCount}\" snapshots",
-			"remoteSyncStateRetrieving": "Retrieving remote sync state entry for syncPointerId \"{syncPointerId}\"",
-			"remoteSyncStateRetrieved": "Retrieving remote sync state entry for syncPointerId \"{syncPointerId}\" with \"{snapshotCount}\" snapshots",
-			"remoteSyncStateNotFound": "No remote sync state entry found for syncPointerId \"{syncPointerId}\"",
+			"syncStateStoring": "Storing sync state entry with \"{snapshotCount}\" snapshots",
+			"syncStateRetrieving": "Retrieving sync state entry for syncPointerId \"{syncPointerId}\"",
+			"syncStateRetrieved": "Retrieving sync state entry for syncPointerId \"{syncPointerId}\" with \"{snapshotCount}\" snapshots",
+			"syncStateNotFound": "No sync state entry found for syncPointerId \"{syncPointerId}\"",
 			"consolidationStarting": "Starting consolidation of remote sync state",
 			"consolidationCompleted": "Consolidation of remote sync state completed",
 			"addChangeSetToSyncState": "Adding change set with id \"{changeSetStorageId}\" to remote sync state for storage key \"{storageKey}\"",
-			"createAndStoreChangeSet": "Creating and storing change set for storage key \"{storageKey}\" with \"{changeCount}\" changes",
+			"buildingChangeSet": "Building change set for storage key \"{storageKey}\" with \"{changeCount}\" changes",
 			"finalisingSyncChanges": "Finalising sync changes for storage key \"{storageKey}\""
 		},
 		"synchronisedStorageService": {
-			"registerType": "Registering synchronised storage type \"{storageKey}\"",
-			"activateType": "Activating synchronised storage type \"{storageKey}\"",
-			"startEntitySync": "Starting synchronised entity storage for type \"{storageKey}\"",
-			"updateFromRemoteSyncState": "Updating synchronised entity storage from remote sync state for type \"{storageKey}\"",
-			"updateFromLocalSyncState": "Updating synchronised entity storage from local sync state for type \"{storageKey}\"",
-			"updateFromLocalSyncStateNoChanges": "No changes found in local sync state for type \"{storageKey}\", skipping update",
-			"createdStorageChangeSet": "Created storage change set for type \"{storageKey}\" with id \"{changeSetStorageId}\"",
-			"createdStorageChangeSetNone": "No changes found for type \"{storageKey}\", no storage change set created",
-			"createChangeSetRequestingItem": "Creating change set for type \"{storageKey}\", requesting item with id \"{id}\"",
-			"createChangeSetRespondingItem": "Responding to change set request for type \"{storageKey}\", item with id \"{id}\""
+			"registerStorageKey": "Registering synchronised storage key \"{storageKey}\"",
+			"activateStorageKey": "Activating synchronised storage key \"{storageKey}\"",
+			"startEntitySync": "Starting synchronised entity storage for key \"{storageKey}\"",
+			"updateFromRemoteSyncState": "Updating synchronised entity storage from remote sync state for key \"{storageKey}\"",
+			"updateFromLocalSyncState": "Updating synchronised entity storage from local sync state for key \"{storageKey}\"",
+			"updateFromLocalSyncStateNoChanges": "No changes found in local sync state for key \"{storageKey}\", skipping update",
+			"builtStorageChangeSet": "Built storage change set for key \"{storageKey}\" with id \"{changeSetStorageId}\"",
+			"builtStorageChangeSetNone": "No changes found for key \"{storageKey}\", no storage change set created",
+			"createChangeSetRequestingItem": "Creating change set for key \"{storageKey}\", requesting item with id \"{id}\"",
+			"createChangeSetRespondingItem": "Responding to change set request for key \"{storageKey}\", item with id \"{id}\"",
+			"sendingChangeSetToTrustedNode": "Sending change set with id \"{changeSetStorageId}\" to trusted node for key \"{storageKey}\"",
+			"syncChangeSetForRemoteNode": "Synchronising change set with id \"{changeSetStorageId}\" for remote node for type \"{storageKey}\""
+		},
+		"blobStorageHelper": {
+			"loadBlob": "Loading blob with id \"{blobId}\"",
+			"loadedBlob": "Loaded blob with id \"{blobId}\"",
+			"loadBlobEmpty": "No blob found with id \"{blobId}\"",
+			"saveBlob": "Saving blob",
+			"savedBlob": "Saved blob with id \"{blobId}\"",
+			"removeBlob": "Removing blob with id \"{blobId}\"",
+			"removedBlob": "Removed blob with id \"{blobId}\"",
+			"removeBlobEmpty": "No blob found to remove with id \"{blobId}\""
 		}
 	},
 	"error": {
@@ -56,10 +76,25 @@
 		"synchronisedStorageService": {
 			"notTrustedNode": "This method can only be called on a trusted node",
 			"entitySyncFailed": "Failed to sync synchronised entity storage connector",
-			"consolidationSyncFailed": "Failed to consolidate synchronised entity storage connector"
+			"consolidationSyncFailed": "Failed to consolidate synchronised entity storage connector",
+			"invalidProof": "Invalid proof provided for synchronised entity storage connector",
+			"decryptionKeyNotFound": "Decryption key not found, ensure the synchronised storage component is initialised and the decryption key is set"
 		},
 		"remoteSyncStateHelper": {
 			"finalisingSyncChangesFailed": "Failed to finalise sync changes for storage key \"{storageKey}\""
+		},
+		"blobStorageHelper": {
+			"loadBlobFailed": "Failed to load blob with id \"{blobId}\"",
+			"saveBlobFailed": "Failed to save blob",
+			"notTrustedNode": "Cannot save blob, this is not a trusted node"
+		}
+	},
+	"warn": {
+		"changeSetHelper": {
+			"getChangeSetError": "Failed to retrieve change set with id \"{changeSetStorageId}\""
+		},
+		"remoteSyncStateHelper": {
+			"getSyncStateError": "Failed to retrieve sync state for syncPointerId \"{syncPointerId}\""
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/synchronised-storage-service",
-	"version": "0.0.1-next.3",
+	"version": "0.0.1-next.5",
 	"description": "Synchronised storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -18,6 +18,7 @@
 		"@twin.org/background-task-models": "next",
 		"@twin.org/blob-storage-models": "next",
 		"@twin.org/core": "next",
+		"@twin.org/crypto": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/event-bus-models": "next",
@@ -25,7 +26,7 @@
 		"@twin.org/logging-models": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",
-		"@twin.org/synchronised-storage-models": "0.0.1-next.3",
+		"@twin.org/synchronised-storage-models": "0.0.1-next.5",
 		"@twin.org/verifiable-storage-models": "next",
 		"@twin.org/web": "next"
 	},

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

@@ -1,18 +0,0 @@
-import type { ISynchronisedEntity, SyncChangeOperation } from "@twin.org/synchronised-storage-models";
-/**
- * The object definition for a sync change.
- */
-export interface ISyncChange<T extends ISynchronisedEntity = ISynchronisedEntity> {
-    /**
-     * Operation.
-     */
-    operation: SyncChangeOperation;
-    /**
-     * The item id.
-     */
-    id: string;
-    /**
-     * The entity to set.
-     */
-    entity?: T;
-}

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

@@ -1,36 +0,0 @@
-import type { IProof } from "@twin.org/standards-w3c-did";
-import type { ISynchronisedEntity } from "@twin.org/synchronised-storage-models";
-import type { ISyncChange } from "./ISyncChange";
-/**
- * The object definition for a sync change set.
- */
-export interface ISyncChangeSet<T extends ISynchronisedEntity = ISynchronisedEntity> {
-    /**
-     * The id of the snapshot.
-     */
-    id: string;
-    /**
-     * The date the change set was created.
-     */
-    dateCreated: string;
-    /**
-     * The storage key of the change set. This is used to identify the entities being synchronised.
-     */
-    storageKey: string;
-    /**
-     * 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.
-     */
-    proof?: IProof;
-}

package/docs/reference/interfaces/ISyncChange.md

@@ -1,33 +0,0 @@
-# Interface: ISyncChange\<T\>
-
-The object definition for a sync change.
-
-## Type Parameters
-
-### T
-
-`T` *extends* `ISynchronisedEntity` = `ISynchronisedEntity`
-
-## Properties
-
-### operation
-
-> **operation**: `SyncChangeOperation`
-
-Operation.
-
-***
-
-### id
-
-> **id**: `string`
-
-The item id.
-
-***
-
-### entity?
-
-> `optional` **entity**: `T`
-
-The entity to set.

package/docs/reference/interfaces/ISyncChangeSet.md

@@ -1,65 +0,0 @@
-# Interface: ISyncChangeSet\<T\>
-
-The object definition for a sync change set.
-
-## Type Parameters
-
-### T
-
-`T` *extends* `ISynchronisedEntity` = `ISynchronisedEntity`
-
-## Properties
-
-### id
-
-> **id**: `string`
-
-The id of the snapshot.
-
-***
-
-### dateCreated
-
-> **dateCreated**: `string`
-
-The date the change set was created.
-
-***
-
-### storageKey
-
-> **storageKey**: `string`
-
-The storage key of the change set. This is used to identify the entities being synchronised.
-
-***
-
-### dateModified?
-
-> `optional` **dateModified**: `string`
-
-The date the change set was last modified.
-
-***
-
-### changes
-
-> **changes**: [`ISyncChange`](ISyncChange.md)\<`T`\>[]
-
-The changes to apply after a snapshot.
-
-***
-
-### nodeIdentity
-
-> **nodeIdentity**: `string`
-
-The identity of the node that created the change set.
-
-***
-
-### proof?
-
-> `optional` **proof**: `IProof`
-
-The proof for the change set.