@twin.org/synchronised-storage-service 0.0.3-next.9 → 0.9.0

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

@@ -37,7 +37,7 @@ export declare class ChangeSetHelper {
     /**
      * Apply a sync changeset.
      * @param syncChangeset The sync changeset to apply.
-     * @returns Nothing.
+     * @returns A promise that resolves when all changes in the set have been published to the event bus.
      */
     applyChangeset(syncChangeset: ISyncChangeSet): Promise<void>;
     /**
@@ -58,8 +58,8 @@ export declare class ChangeSetHelper {
     /**
      * Reset the storage for a given storage key.
      * @param storageKey The key of the storage to reset.
-     * @param resetMode The reset mode, this will use the nodeId in the entities to determine which are local/remote.
-     * @returns Nothing.
+     * @param resetMode The reset mode, which uses the nodeId in the entities to determine which are local or remote.
+     * @returns A promise that resolves when the reset event is published to the event bus.
      */
     reset(storageKey: string, resetMode: SyncNodeIdMode): Promise<void>;
 }

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

@@ -24,7 +24,7 @@ export declare class LocalSyncStateHelper {
      * @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.
+     * @returns A promise that resolves when the change is recorded in the local snapshot.
      */
     addLocalChange(storageKey: string, operation: SyncChangeOperation, id: string): Promise<void>;
     /**
@@ -37,20 +37,20 @@ export declare class LocalSyncStateHelper {
     /**
      * Set the current local snapshot with changes for this node.
      * @param localChangeSnapshot The local change snapshot to set.
-     * @returns Nothing.
+     * @returns A promise that resolves when the snapshot is persisted to entity storage.
      */
     setLocalChangeSnapshot(localChangeSnapshot: SyncSnapshotEntry): Promise<void>;
     /**
-     * Get the current local snapshot with the changes for this node.
+     * Remove the local snapshot entry from storage.
      * @param localChangeSnapshot The local change snapshot to remove.
-     * @returns Nothing.
+     * @returns A promise that resolves when the snapshot is removed from entity storage.
      */
     removeLocalChangeSnapshot(localChangeSnapshot: SyncSnapshotEntry): Promise<void>;
     /**
      * Apply a sync state to the local node.
      * @param storageKey The storage key of the snapshot to sync with.
      * @param syncState The sync state to sync with.
-     * @returns Nothing.
+     * @returns A promise that resolves when all new and modified snapshots have been processed.
      */
     applySyncState(storageKey: string, syncState: ISyncState): Promise<void>;
 }

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

@@ -32,6 +32,7 @@ export declare class RemoteSyncStateHelper {
     setNodeId(nodeId: string): void;
     /**
      * Start the remote sync state helper.
+     * @returns A promise that resolves when all event bus subscriptions are registered.
      */
     start(): Promise<void>;
     /**
@@ -40,32 +41,32 @@ export declare class RemoteSyncStateHelper {
      */
     setSynchronisedStorageKey(synchronisedStorageKey: string): void;
     /**
-     * Build a changeset.
+     * Build a changeset and invoke the callback when complete.
      * @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.
+     * @param completeCallback The callback invoked when the changeset is created and stored.
+     * @returns A promise that resolves when item requests are dispatched or the changeset is finalised immediately.
      */
     buildChangeSet(storageKey: string, changes: ISyncChange[], completeCallback: (syncChangeSet?: ISyncChangeSet, id?: string) => Promise<void>): Promise<void>;
     /**
      * Finalise the full details for the sync change set.
      * @param storageKey The storage key of the change set.
-     * @param completeCallback The callback to call when the changeset is populated.
-     * @returns Nothing.
+     * @param completeCallback The callback invoked when the changeset is populated and optionally stored.
+     * @returns A promise that resolves when the changeset is built and the callback is invoked.
      */
     finaliseFullChanges(storageKey: string, completeCallback: (syncChangeSet?: ISyncChangeSet, 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 current state
-     * @returns Nothing.
+     * @param changeSetStorageId The id of the change set to add.
+     * @returns A promise that resolves when the sync state and verifiable sync pointer are updated.
      */
     addChangeSetToSyncState(storageKey: string, changeSetStorageId: string): Promise<void>;
     /**
      * Create a consolidated snapshot for the entire storage.
      * @param storageKey The storage key of the snapshot to create.
      * @param batchSize The batch size to use for consolidation.
-     * @returns Nothing.
+     * @returns A promise that resolves when the batch request is published to the event bus.
      */
     consolidationStart(storageKey: string, batchSize: number): Promise<void>;
     /**
@@ -76,7 +77,7 @@ export declare class RemoteSyncStateHelper {
     /**
      * Store the verifiable sync pointer in the verifiable storage.
      * @param syncPointerStore The sync pointer store to store.
-     * @returns Nothing.
+     * @returns A promise that resolves when the pointer store is persisted to verifiable storage.
      */
     storeVerifiableSyncPointerStore(syncPointerStore: ISyncPointerStore): Promise<void>;
     /**
@@ -91,14 +92,4 @@ export declare class RemoteSyncStateHelper {
      * @returns The remote sync state.
      */
     getSyncState(syncPointerId: string): Promise<ISyncState | undefined>;
-    /**
-     * Handle the batch response which is triggered from a consolidation request.
-     * @param response The batch response to handle.
-     */
-    private handleBatchResponse;
-    /**
-     * Handle the item response.
-     * @param response The item response to handle.
-     */
-    private handleLocalItemResponse;
 }

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

@@ -1,3 +1,12 @@
+/**
+ * Current schema version for sync state objects.
+ */
 export declare const SYNC_STATE_VERSION: string;
+/**
+ * Current schema version for sync pointer store objects.
+ */
 export declare const SYNC_POINTER_STORE_VERSION: string;
+/**
+ * Current schema version for sync snapshot entry objects.
+ */
 export declare const SYNC_SNAPSHOT_VERSION: string;

package/dist/types/restEntryPoints.d.ts

@@ -1,2 +1,5 @@
 import type { IRestRouteEntryPoint } from "@twin.org/api-models";
+/**
+ * REST entry points for the synchronised storage service.
+ */
 export declare const restEntryPoints: IRestRouteEntryPoint[];

package/dist/types/synchronisedStorageService.d.ts

@@ -21,13 +21,13 @@ export declare class SynchronisedStorageService implements ISynchronisedStorageC
     /**
      * The component needs to be started when the node is initialized.
      * @param nodeLoggingComponentType The node logging component type.
-     * @returns Nothing.
+     * @returns A promise that resolves when the service is started and all event bus subscriptions are active.
      */
     start(nodeLoggingComponentType?: string): Promise<void>;
     /**
      * The component needs to be stopped when the node is closed.
      * @param nodeLoggingComponentType The node logging component type.
-     * @returns Nothing.
+     * @returns A promise that resolves when all scheduled tasks are removed and storage keys are deactivated.
      */
     stop(nodeLoggingComponentType?: string): Promise<void>;
     /**
@@ -41,7 +41,7 @@ export declare class SynchronisedStorageService implements ISynchronisedStorageC
      * Synchronise a set of changes from an untrusted node, assumes this is a trusted node.
      * @param syncChangeSet The change set to synchronise.
      * @param trustPayload Trust payload to verify the requesters identity.
-     * @returns Nothing.
+     * @returns A promise that resolves when the change set has been applied and the sync state updated.
      */
     syncChangeSet(syncChangeSet: ISyncChangeSet, trustPayload: unknown): Promise<void>;
 }