@signaldb/sync 1.0.1 → 1.1.0

package/dist/SyncManager.d.ts

@@ -5,6 +5,7 @@ import type { Change, Snapshot, SyncOperation } from './types';
 type SyncOptions<T extends Record<string, any>> = {
     name: string;
 } & T;
+type CleanupFunction = (() => void | Promise<void>) | void;
 interface Options<CollectionOptions extends Record<string, any>, ItemType extends BaseItem<IdType> = BaseItem, IdType = any> {
     pull: (collectionOptions: SyncOptions<CollectionOptions>, pullParameters: {
         lastFinishedSyncStart?: number;
@@ -13,11 +14,12 @@ interface Options<CollectionOptions extends Record<string, any>, ItemType extend
     push: (collectionOptions: SyncOptions<CollectionOptions>, pushParameters: {
         changes: Changeset<ItemType>;
     }) => Promise<void>;
-    registerRemoteChange?: (collectionOptions: SyncOptions<CollectionOptions>, onChange: (data?: LoadResponse<ItemType>) => Promise<void>) => void;
+    registerRemoteChange?: (collectionOptions: SyncOptions<CollectionOptions>, onChange: (data?: LoadResponse<ItemType>) => Promise<void>) => CleanupFunction | Promise<CleanupFunction>;
     id?: string;
     persistenceAdapter?: (id: string, registerErrorHandler: (handler: (error: Error) => void) => void) => PersistenceAdapter<any, any>;
     reactivity?: ReactivityAdapter;
     onError?: (collectionOptions: SyncOptions<CollectionOptions>, error: Error) => void;
+    autostart?: boolean;
 }
 /**
  * Class to manage syncing of collections.
@@ -47,10 +49,13 @@ interface Options<CollectionOptions extends Record<string, any>, ItemType extend
  */
 export default class SyncManager<CollectionOptions extends Record<string, any>, ItemType extends BaseItem<IdType> = BaseItem, IdType = any> {
     protected options: Options<CollectionOptions, ItemType, IdType>;
-    protected collections: Map<string, [
-        Collection<ItemType, IdType, any>,
-        SyncOptions<CollectionOptions>
-    ]>;
+    protected collections: Map<string, {
+        collection: Collection<ItemType, IdType, any>;
+        options: SyncOptions<CollectionOptions>;
+        readyPromise: Promise<void>;
+        syncPaused: boolean;
+        cleanupFunction?: CleanupFunction;
+    }>;
     protected changes: Collection<Change<ItemType>, string>;
     protected snapshots: Collection<Snapshot<ItemType>, string>;
     protected syncOperations: Collection<SyncOperation, string>;
@@ -82,11 +87,25 @@ export default class SyncManager<CollectionOptions extends Record<string, any>,
     dispose(): Promise<void>;
     /**
      * Gets a collection with it's options by name
+     * @deprecated Use getCollectionProperties instead.
      * @param name Name of the collection
      * @throws Will throw an error if the name wasn't found
      * @returns Tuple of collection and options
      */
-    getCollection(name: string): [Collection<ItemType, IdType, any>, SyncOptions<CollectionOptions>];
+    getCollection(name: string): (Collection<ItemType, IdType, any> | SyncOptions<CollectionOptions>)[];
+    /**
+     * Gets collection options by name
+     * @param name Name of the collection
+     * @throws Will throw an error if the name wasn't found
+     * @returns An object of all properties of the collection
+     */
+    getCollectionProperties(name: string): {
+        collection: Collection<ItemType, IdType, any>;
+        options: SyncOptions<CollectionOptions>;
+        readyPromise: Promise<void>;
+        syncPaused: boolean;
+        cleanupFunction?: CleanupFunction | undefined;
+    };
     /**
      * Adds a collection to the sync manager.
      * @param collection Collection to add
@@ -96,6 +115,30 @@ export default class SyncManager<CollectionOptions extends Record<string, any>,
     addCollection(collection: Collection<ItemType, IdType, any>, options: SyncOptions<CollectionOptions>): void;
     protected deboucedPush: (name: string) => void;
     protected schedulePush(name: string): void;
+    /**
+     * Setup all collections to be synced with remote changes
+     * and enable automatic pushing changes to the remote source.
+     */
+    startAll(): Promise<void>;
+    /**
+     * Setup a collection to be synced with remote changes
+     * and enable automatic pushing changes to the remote source.
+     * @param name Name of the collection
+     */
+    startSync(name: string): Promise<void>;
+    /**
+     * Pauses the sync process for all collections.
+     * This means that the collections will not be synced with remote changes
+     * and changes will not automatically be pushed to the remote source.
+     */
+    pauseAll(): Promise<void>;
+    /**
+     * Pauses the sync process for a collection.
+     * This means that the collection will not be synced with remote changes
+     * and changes will not automatically be pushed to the remote source.
+     * @param name Name of the collection
+     */
+    pauseSync(name: string): Promise<void>;
     /**
      * Starts the sync process for all collections
      */