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

package/dist/types/entities/syncSnapshotEntry.d.ts

@@ -9,9 +9,9 @@ export declare class SyncSnapshotEntry<T extends ISynchronisedEntity = ISynchron
      */
     id: string;
     /**
-     * The schema type for the snapshot i.e. which entity is being synchronized.
+     * The storage key for the snapshot i.e. which entity is being synchronized.
      */
-    schemaType: string;
+    storageKey: string;
     /**
      * The date the snapshot was created.
      */
@@ -31,5 +31,5 @@ export declare class SyncSnapshotEntry<T extends ISynchronisedEntity = ISynchron
     /**
      * The changes that were made in this snapshot, if this is a local snapshot.
      */
-    localChanges?: ISyncChange<T>[];
+    changes?: ISyncChange<T>[];
 }

package/dist/types/helpers/changeSetHelper.d.ts

@@ -31,9 +31,9 @@ export declare class ChangeSetHelper<T extends ISynchronisedEntity = ISynchronis
     /**
      * Apply a sync changeset.
      * @param changeSetStorageId The id of the sync changeset to apply.
-     * @returns True if the change was applied.
+     * @returns The changeset if it existed.
      */
-    getAndApplyChangeset(changeSetStorageId: string): Promise<boolean>;
+    getAndApplyChangeset(changeSetStorageId: string): Promise<ISyncChangeSet<T> | undefined>;
     /**
      * Apply a sync changeset.
      * @param syncChangeset The sync changeset to apply.
@@ -43,9 +43,10 @@ export declare class ChangeSetHelper<T extends ISynchronisedEntity = ISynchronis
     /**
      * Store the changeset.
      * @param syncChangeSet The sync change set to store.
+     * @param nodeIdentity The node identity to use for the changeset.
      * @returns The id of the change set.
      */
-    storeChangeSet(syncChangeSet: ISyncChangeSet): Promise<string>;
+    storeChangeSet(syncChangeSet: ISyncChangeSet, nodeIdentity: string): Promise<string>;
     /**
      * Verify the proof of a sync changeset.
      * @param syncChangeset The sync changeset to verify.

package/dist/types/helpers/localSyncStateHelper.d.ts

@@ -21,18 +21,18 @@ export declare class LocalSyncStateHelper<T extends ISynchronisedEntity = ISynch
     constructor(logging: ILoggingConnector | undefined, localSyncSnapshotEntryEntityStorage: IEntityStorageConnector<SyncSnapshotEntry<T>>, changeSetHelper: ChangeSetHelper<T>);
     /**
      * Add a new change to the local snapshot.
-     * @param schemaType The schema type of the snapshot to add the change for.
+     * @param storageKey The storage key of the snapshot to add the change for.
      * @param operation The operation to perform.
      * @param id The id of the entity to add the change for.
      * @returns Nothing.
      */
-    addLocalChange(schemaType: string, operation: SyncChangeOperation, id: string): Promise<void>;
+    addLocalChange(storageKey: string, operation: SyncChangeOperation, id: string): Promise<void>;
     /**
      * Get the current local snapshot.
-     * @param schemaType The schema type of the snapshot to get.
+     * @param storageKey The storage key of the snapshot to get.
      * @returns The local snapshot entry.
      */
-    getLocalChangeSnapshot(schemaType: string): Promise<SyncSnapshotEntry<T>>;
+    getLocalChangeSnapshot(storageKey: string): Promise<SyncSnapshotEntry<T>>;
     /**
      * Set the current local snapshot.
      * @param localChangeSnapshot The local change snapshot to set.
@@ -47,11 +47,11 @@ export declare class LocalSyncStateHelper<T extends ISynchronisedEntity = ISynch
     removeLocalChangeSnapshot(localChangeSnapshot: SyncSnapshotEntry<T>): Promise<void>;
     /**
      * Sync local data using a remote sync state.
-     * @param schemaType The schema type of the snapshot to sync with.
+     * @param storageKey The storage key of the snapshot to sync with.
      * @param remoteSyncState The sync state to sync with.
      * @returns Nothing.
      */
-    syncFromRemote(schemaType: string, remoteSyncState: ISyncState): Promise<void>;
+    syncFromRemote(storageKey: string, remoteSyncState: ISyncState): Promise<void>;
     /**
      * Process the modified snapshots and store them in the local storage.
      * @param modifiedSnapshots The modified snapshots to process.

package/dist/types/helpers/remoteSyncStateHelper.d.ts

@@ -5,7 +5,7 @@ import { type ISynchronisedEntity } from "@twin.org/synchronised-storage-models"
 import type { IVerifiableStorageConnector } from "@twin.org/verifiable-storage-models";
 import type { ChangeSetHelper } from "./changeSetHelper";
 import type { ISyncChange } from "../models/ISyncChange";
-import type { ISyncPointer } from "../models/ISyncPointer";
+import type { ISyncPointerStore } from "../models/ISyncPointerStore";
 import type { ISyncState } from "../models/ISyncState";
 /**
  * Class for performing entity storage operations in decentralised storage.
@@ -32,43 +32,44 @@ export declare class RemoteSyncStateHelper<T extends ISynchronisedEntity = ISync
     setNodeIdentity(nodeIdentity: string): void;
     /**
      * Create and store a change set.
-     * @param schemaType The schema type of the change set.
+     * @param storageKey The storage key of the change set.
      * @param changes The changes to apply.
      * @param completeCallback The callback to call when the changeset is created and stored.
      * @returns The storage id of the change set if created.
      */
-    createAndStoreChangeSet(schemaType: string, changes: ISyncChange<T>[] | undefined, completeCallback: (id?: string) => Promise<void>): Promise<void>;
+    createAndStoreChangeSet(storageKey: string, changes: ISyncChange<T>[], completeCallback: (id?: string) => Promise<void>): Promise<void>;
     /**
      * Finalise the full details for the sync change set.
-     * @param schemaType The schema type of the change set.
+     * @param storageKey The storage key of the change set.
      * @param completeCallback The callback to call when the changeset is populated.
      * @returns Nothing.
      */
-    finaliseFullChanges(schemaType: string, completeCallback: (id?: string) => Promise<void>): Promise<void>;
+    finaliseFullChanges(storageKey: string, completeCallback: (id?: string) => Promise<void>): Promise<void>;
     /**
      * Add a new changeset into the sync state.
+     * @param storageKey The storage key of the change set to add.
      * @param changeSetStorageId The id of the change set to add the the current state
      * @returns Nothing.
      */
-    addChangeSetToSyncState(changeSetStorageId: string): Promise<void>;
+    addChangeSetToSyncState(storageKey: string, changeSetStorageId: string): Promise<void>;
     /**
      * Create a consolidated snapshot for the entire storage.
-     * @param schemaType The schema type of the snapshot to create.
+     * @param storageKey The storage key of the snapshot to create.
      * @param batchSize The batch size to use for consolidation.
      * @returns Nothing.
      */
-    consolidateFromLocal(schemaType: string, batchSize: number): Promise<void>;
+    consolidateFromLocal(storageKey: string, batchSize: number): Promise<void>;
     /**
-     * Get the sync pointer.
-     * @returns The sync pointer.
+     * Get the sync pointer store.
+     * @returns The sync pointer store.
      */
-    getVerifiableSyncPointer(): Promise<ISyncPointer | undefined>;
+    getVerifiableSyncPointerStore(): Promise<ISyncPointerStore>;
     /**
      * Store the verifiable sync pointer in the verifiable storage.
-     * @param syncStateId The id of the sync state to store.
+     * @param syncPointerStore The sync pointer store to store.
      * @returns Nothing.
      */
-    storeVerifiableSyncPointer(syncStateId: string): Promise<ISyncPointer>;
+    storeVerifiableSyncPointerStore(syncPointerStore: ISyncPointerStore): Promise<void>;
     /**
      * Store the remote sync state.
      * @param syncState The sync state to store.

package/dist/types/index.d.ts

@@ -1,8 +1,12 @@
 export * from "./entities/syncSnapshotEntry";
 export * from "./models/ISyncChange";
+export * from "./models/ISyncChangeSet";
 export * from "./models/ISynchronisedStorageServiceConfig";
 export * from "./models/ISynchronisedStorageServiceConstructorOptions";
+export * from "./models/ISyncPointerStore";
+export * from "./models/ISyncSnapshot";
+export * from "./models/ISyncState";
 export * from "./restEntryPoints";
 export * from "./schema";
-export * from "./synchronisedStorageService";
 export * from "./synchronisedStorageRoutes";
+export * from "./synchronisedStorageService";

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

@@ -14,9 +14,9 @@ export interface ISyncChangeSet<T extends ISynchronisedEntity = ISynchronisedEnt
      */
     dateCreated: string;
     /**
-     * The schema type of the change set. This is used to identify the type of entity being synchronised.
+     * The storage key of the change set. This is used to identify the entities being synchronised.
      */
-    schemaType: string;
+    storageKey: string;
     /**
      * The date the change set was last modified.
      */

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

@@ -0,0 +1,11 @@
+/**
+ * The object definition for the sync pointer store.
+ */
+export interface ISyncPointerStore {
+    /**
+     * The mapping from storage keys to sync pointers.
+     */
+    syncPointers: {
+        [key: string]: string;
+    };
+}

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

@@ -13,10 +13,10 @@ export interface ISynchronisedStorageServiceConfig {
      */
     synchronisedStorageMethodId?: string;
     /**
-     * How often to check for entity updates in milliseconds.
-     * @default 300000 (5 minutes)
+     * How often to check for entity updates in minutes.
+     * @default 5
      */
-    entityUpdateIntervalMs?: number;
+    entityUpdateIntervalMinutes?: number;
     /**
      * Is this a node that has permission to write to the verifiable storage?
      * @default false
@@ -24,9 +24,9 @@ export interface ISynchronisedStorageServiceConfig {
     isTrustedNode?: boolean;
     /**
      * Interval to perform consolidation of changesets, only used if isTrustedNode is set.
-     * @default 300000 (5 minutes)
+     * @default 60
      */
-    consolidationIntervalMs?: number;
+    consolidationIntervalMinutes?: number;
     /**
      * The number of entities to process in a single consolidation batch.
      * @default 1000

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

@@ -31,6 +31,11 @@ export interface ISynchronisedStorageServiceConstructorOptions {
      * @default identity
      */
     identityConnectorType?: string;
+    /**
+     * The task scheduler component.
+     * @default task-scheduler
+     */
+    taskSchedulerComponentType?: string;
     /**
      * The synchronised entity storage component type to use if this node is not trusted.
      */

package/docs/changelog.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [0.0.1-next.3](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-service-v0.0.1-next.2...synchronised-storage-service-v0.0.1-next.3) (2025-07-25)
+
+
+### Features
+
+* sync testing ([#5](https://github.com/twinfoundation/synchronised-storage/issues/5)) ([f78d5ac](https://github.com/twinfoundation/synchronised-storage/commit/f78d5ac661b891f9912e0a81d028453f909a64b4))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/synchronised-storage-models bumped from 0.0.1-next.2 to 0.0.1-next.3
+
 ## [0.0.1-next.2](https://github.com/twinfoundation/synchronised-storage/compare/synchronised-storage-service-v0.0.1-next.1...synchronised-storage-service-v0.0.1-next.2) (2025-07-22)
 
 

package/docs/reference/classes/SyncSnapshotEntry.md

@@ -28,11 +28,11 @@ The id for the snapshot.
 
 ***
 
-### schemaType
+### storageKey
 
-> **schemaType**: `string`
+> **storageKey**: `string`
 
-The schema type for the snapshot i.e. which entity is being synchronized.
+The storage key for the snapshot i.e. which entity is being synchronized.
 
 ***
 
@@ -68,8 +68,8 @@ The ids of the storage for the change sets in the snapshot, if this is not a loc
 
 ***
 
-### localChanges?
+### changes?
 
-> `optional` **localChanges**: [`ISyncChange`](../interfaces/ISyncChange.md)\<`T`\>[]
+> `optional` **changes**: [`ISyncChange`](../interfaces/ISyncChange.md)\<`T`\>[]
 
 The changes that were made in this snapshot, if this is a local snapshot.

package/docs/reference/index.md

@@ -8,6 +8,10 @@
 ## Interfaces
 
 - [ISyncChange](interfaces/ISyncChange.md)
+- [ISyncChangeSet](interfaces/ISyncChangeSet.md)
+- [ISyncPointerStore](interfaces/ISyncPointerStore.md)
+- [ISyncSnapshot](interfaces/ISyncSnapshot.md)
+- [ISyncState](interfaces/ISyncState.md)
 - [ISynchronisedStorageServiceConfig](interfaces/ISynchronisedStorageServiceConfig.md)
 - [ISynchronisedStorageServiceConstructorOptions](interfaces/ISynchronisedStorageServiceConstructorOptions.md)
 

package/docs/reference/interfaces/ISyncChangeSet.md

@@ -0,0 +1,65 @@
+# 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.

package/docs/reference/interfaces/ISyncPointerStore.md

@@ -0,0 +1,15 @@
+# Interface: ISyncPointerStore
+
+The object definition for the sync pointer store.
+
+## Properties
+
+### syncPointers
+
+> **syncPointers**: `object`
+
+The mapping from storage keys to sync pointers.
+
+#### Index Signature
+
+\[`key`: `string`\]: `string`

package/docs/reference/interfaces/ISyncSnapshot.md

@@ -0,0 +1,35 @@
+# Interface: ISyncSnapshot
+
+The object definition for a sync snapshot.
+
+## Properties
+
+### id
+
+> **id**: `string`
+
+The id of the snapshot.
+
+***
+
+### dateCreated
+
+> **dateCreated**: `string`
+
+The date the snapshot was created.
+
+***
+
+### dateModified?
+
+> `optional` **dateModified**: `string`
+
+The date the snapshot was last modified.
+
+***
+
+### changeSetStorageIds
+
+> **changeSetStorageIds**: `string`[]
+
+The ids of the storage for the change sets in the snapshot.

package/docs/reference/interfaces/ISyncState.md

@@ -0,0 +1,11 @@
+# Interface: ISyncState
+
+The object definition for a sync state.
+
+## Properties
+
+### snapshots
+
+> **snapshots**: [`ISyncSnapshot`](ISyncSnapshot.md)[]
+
+The snapshots.

package/docs/reference/interfaces/ISynchronisedStorageServiceConfig.md

@@ -27,16 +27,16 @@ synchronised-storage-assertion
 
 ***
 
-### entityUpdateIntervalMs?
+### entityUpdateIntervalMinutes?
 
-> `optional` **entityUpdateIntervalMs**: `number`
+> `optional` **entityUpdateIntervalMinutes**: `number`
 
-How often to check for entity updates in milliseconds.
+How often to check for entity updates in minutes.
 
 #### Default
 
 ```ts
-300000 (5 minutes)
+5
 ```
 
 ***
@@ -55,16 +55,16 @@ false
 
 ***
 
-### consolidationIntervalMs?
+### consolidationIntervalMinutes?
 
-> `optional` **consolidationIntervalMs**: `number`
+> `optional` **consolidationIntervalMinutes**: `number`
 
 Interval to perform consolidation of changesets, only used if isTrustedNode is set.
 
 #### Default
 
 ```ts
-300000 (5 minutes)
+60
 ```
 
 ***

package/docs/reference/interfaces/ISynchronisedStorageServiceConstructorOptions.md

@@ -76,6 +76,20 @@ identity
 
 ***
 
+### taskSchedulerComponentType?
+
+> `optional` **taskSchedulerComponentType**: `string`
+
+The task scheduler component.
+
+#### Default
+
+```ts
+task-scheduler
+```
+
+***
+
 ### trustedSynchronisedStorageComponentType?
 
 > `optional` **trustedSynchronisedStorageComponentType**: `string`

package/locales/en.json

@@ -9,26 +9,43 @@
 			"createdChangeSetProof": "Created change proof for change set with id \"{id}\", proof value is \"{proofValue}\""
 		},
 		"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}\"",
-			"removeLocalChangeSnapshot": "Removing local change snapshot with id \"{snapshotId}\""
+			"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}\""
 		},
 		"remoteSyncStateHelper": {
-			"verifiableSyncPointerRetrieving": "Retrieving verifiable sync pointer for key \"{key}\"",
-			"verifiableSyncPointerNotFound": "No verifiable sync pointer found for key \"{key}\"",
-			"verifiableSyncPointerRetrieved": "Retrieved verifiable sync pointer for key \"{key}\" with value \"{syncPointerId}\"",
-			"verifiableSyncPointerStoring": "Storing verifiable sync pointer for key \"{key}\" with value \"{syncPointerId}\"",
+			"verifiableSyncPointerStoreRetrieving": "Retrieving verifiable sync pointer for key \"{key}\"",
+			"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}\"",
 			"consolidationStarting": "Starting consolidation of remote sync state",
-			"consolidationCompleted": "Consolidation of remote sync state completed"
+			"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",
+			"finalisingSyncChanges": "Finalising sync changes for storage key \"{storageKey}\""
 		},
 		"synchronisedStorageService": {
-			"registerType": "Registering synchronised storage type \"{schemaType}\""
+			"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}\""
 		}
 	},
 	"error": {
@@ -40,6 +57,9 @@
 			"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"
+		},
+		"remoteSyncStateHelper": {
+			"finalisingSyncChangesFailed": "Failed to finalise sync changes for storage key \"{storageKey}\""
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/synchronised-storage-service",
-	"version": "0.0.1-next.2",
+	"version": "0.0.1-next.3",
 	"description": "Synchronised storage contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -15,6 +15,7 @@
 	},
 	"dependencies": {
 		"@twin.org/api-models": "next",
+		"@twin.org/background-task-models": "next",
 		"@twin.org/blob-storage-models": "next",
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
@@ -24,7 +25,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.2",
+		"@twin.org/synchronised-storage-models": "0.0.1-next.3",
 		"@twin.org/verifiable-storage-models": "next",
 		"@twin.org/web": "next"
 	},

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

@@ -1,9 +0,0 @@
-/**
- * The object definition for the sync pointer.
- */
-export interface ISyncPointer {
-    /**
-     * The pointer to where the sync data resides.
-     */
-    syncPointerId: string;
-}