@signaldb/sync 2.0.0-beta.0 → 2.0.0-beta.2

package/dist/SyncManager.d.ts

@@ -1,4 +1,4 @@
-import type { BaseItem, StorageAdapter, ReactivityAdapter, Changeset } from '@signaldb/core';
+import type { BaseItem, DataAdapter, ReactivityAdapter, Changeset } from '@signaldb/core';
 import { Collection } from '@signaldb/core';
 import PromiseQueue from './utils/PromiseQueue';
 import type { Change, LoadResponse, Snapshot, SyncOperation } from './types';
@@ -19,7 +19,7 @@ interface Options<CollectionOptions extends Record<string, any>, ItemType extend
     }) => Promise<void>;
     registerRemoteChange?: (collectionOptions: SyncOptions<CollectionOptions>, onChange: (data?: LoadResponse<ItemType>) => Promise<void>) => CleanupFunction | Promise<CleanupFunction>;
     id?: string;
-    storageAdapter?: (id: string, registerErrorHandler: (handler: (error: Error) => void) => void) => StorageAdapter<any, any>;
+    dataAdapter?: DataAdapter;
     reactivity?: ReactivityAdapter;
     onError?: (collectionOptions: SyncOptions<CollectionOptions>, error: Error) => void;
     autostart?: boolean;
@@ -66,7 +66,7 @@ export default class SyncManager<CollectionOptions extends Record<string, any>,
     protected scheduledPushes: Set<string>;
     protected remoteChanges: Omit<Change, 'id' | 'time'>[];
     protected syncQueues: Map<string, PromiseQueue>;
-    protected persistenceReady: Promise<void>;
+    protected collectionsReady: Promise<void>;
     protected isDisposed: boolean;
     protected instanceId: string;
     protected id: string;
@@ -84,10 +84,6 @@ export default class SyncManager<CollectionOptions extends Record<string, any>,
      * @param [options.debounceTime] The time in milliseconds to debounce push operations.
      */
     constructor(options: Options<CollectionOptions, ItemType, IdType>);
-    protected createStorageAdapter(name: string): {
-        adapter: StorageAdapter<any, any>;
-        handler: (error: Error) => void;
-    } | undefined;
     protected getSyncQueue(name: string): PromiseQueue;
     /**
      * Clears all internal data structures
@@ -97,14 +93,14 @@ export default class SyncManager<CollectionOptions extends Record<string, any>,
      * 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
+     * @throws {Error} 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, 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
+     * @throws {Error} Will throw an error if the name wasn't found
      * @returns An object of all properties of the collection
      */
     getCollectionProperties(name: string): {
@@ -120,7 +116,7 @@ export default class SyncManager<CollectionOptions extends Record<string, any>,
      * @param options Options for the collection. The object needs at least a `name` property.
      * @param options.name Unique name of the collection
      */
-    addCollection(collection: Collection<ItemType, IdType, any>, options: SyncOptions<CollectionOptions>): void;
+    addCollection<CollectionItem extends ItemType = ItemType>(collection: Collection<CollectionItem, IdType, any>, options: SyncOptions<CollectionOptions>): void;
     protected flushScheduledPushes(): void;
     protected schedulePush(name: string): void;
     /**
@@ -154,9 +150,10 @@ export default class SyncManager<CollectionOptions extends Record<string, any>,
     /**
      * Checks if a collection is currently beeing synced
      * @param [name] Name of the collection. If not provided, it will check if any collection is currently beeing synced.
-     * @returns True if the collection is currently beeing synced, false otherwise.
+     * @param [async] If true, it will check for active syncs in the database. This is useful if you have multiple instances of the application running.
+     * @returns True if the collection is currently beeing synced, false otherwise. If async is true, it will return a promise that resolves to true or false.
      */
-    isSyncing(name?: string): boolean;
+    isSyncing<Async extends boolean = false>(name?: string, async?: Async): Async extends true ? Promise<boolean> : boolean;
     /**
      * Checks if the sync manager is ready to sync.
      * @returns A promise that resolves when the sync manager is ready to sync.