async-storage-sync 1.0.5 → 1.0.7

package/README.md

@@ -61,10 +61,12 @@ console.log(`${pending.length} forms waiting to sync`);
 
 - `autoSync: true` (default): when the app starts, the package checks connectivity and attempts sync if online.
 - `autoSync: true` also listens for reconnect events and retries pending items automatically.
+- `autoSyncCollections` (optional): when set, auto-sync on reconnect targets only those collections.
 - `autoSync: false`: no automatic syncing; call sync methods manually when you choose.
 - Manual methods:
   - `store.flushWithResult()` → sync all pending and return summary counts
-  - `store.sync(collection)` → sync one collection
+  - `store.syncWithResult(collection)` → sync one collection and return summary counts
+  - `store.syncManyWithResult(collections)` → sync only selected collections and return merged summary counts
   - `store.syncById(collection, id)` → sync one record
 - Sync destination is controlled by your config: `serverUrl + endpoint`.
 
@@ -88,7 +90,8 @@ console.log(`${pending.length} forms waiting to sync`);
 | `store.deleteById(collection, id)` | Delete one record by internal `_id` |
 | `store.deleteCollection(collection)` | Delete all records in one collection |
 | `store.flushWithResult()` | Sync all pending and return detailed summary (`attempted`, `synced`, `failed`, `retried`, `remainingPending`, `items`) |
-| `store.sync(collection)` | Sync pending items for one collection only |
+| `store.syncWithResult(collection)` | Sync collection and return detailed summary (same format as `flushWithResult()`) |
+| `store.syncManyWithResult(collections)` | Sync selected collections and return one merged summary (same format as `flushWithResult()`) |
 | `store.syncById(collection, id)` | Sync one specific record by internal `_id` |
 | `store.requeueFailed()` | Move `failed` records back to pending queue for retry |
 | `store.onSynced(callback)` | Event callback for successful sync of each item |
@@ -176,6 +179,7 @@ initSyncQueue({
   credentials: Record<string, string>, // (required) merged into request headers
   endpoint?: '/submit',             // route to POST data
   autoSync?: false,                 // auto-sync on reconnect
+  autoSyncCollections?: ['invoices', 'payments'], // optional: only these collections auto-sync on reconnect
   onSyncSuccess?: 'keep',           // after sync: keep|delete|ttl
   ttl?: 7 * 24 * 60 * 60 * 1000,   // if ttl mode, keep duration
   duplicateStrategy?: 'append',     // append or overwrite

package/dist/index.d.mts

@@ -13,6 +13,7 @@ interface InitConfig {
      */
     payloadTransformer?: (record: Record<string, unknown>) => Record<string, unknown>;
     autoSync?: boolean;
+    autoSyncCollections?: string[];
     endpoint?: string;
     onSyncSuccess?: OnSyncSuccess;
     ttl?: number;
@@ -80,7 +81,8 @@ declare class AsyncStorageSync {
     getById<T extends Record<string, unknown>>(name: string, id: string): Promise<StoredRecord<T> | null>;
     deleteById(name: string, id: string): Promise<void>;
     deleteCollection(name: string): Promise<void>;
-    sync(name: string): Promise<void>;
+    syncWithResult(name: string): Promise<FlushResult>;
+    syncManyWithResult(names: string[]): Promise<FlushResult>;
     syncById(_name: string, id: string): Promise<void>;
     flushWithResult(): Promise<FlushResult>;
     /**

package/dist/index.d.ts

@@ -13,6 +13,7 @@ interface InitConfig {
      */
     payloadTransformer?: (record: Record<string, unknown>) => Record<string, unknown>;
     autoSync?: boolean;
+    autoSyncCollections?: string[];
     endpoint?: string;
     onSyncSuccess?: OnSyncSuccess;
     ttl?: number;
@@ -80,7 +81,8 @@ declare class AsyncStorageSync {
     getById<T extends Record<string, unknown>>(name: string, id: string): Promise<StoredRecord<T> | null>;
     deleteById(name: string, id: string): Promise<void>;
     deleteCollection(name: string): Promise<void>;
-    sync(name: string): Promise<void>;
+    syncWithResult(name: string): Promise<FlushResult>;
+    syncManyWithResult(names: string[]): Promise<FlushResult>;
     syncById(_name: string, id: string): Promise<void>;
     flushWithResult(): Promise<FlushResult>;
     /**

package/dist/index.js

@@ -221,9 +221,49 @@ var SyncEngine = class {
       clearTimeout(this.debounceTimer);
     }
     this.debounceTimer = setTimeout(() => {
-      void this.flushWithResult();
+      void this.flushAutoSyncTargetWithResult();
     }, DEBOUNCE_MS);
   }
+  async flushAutoSyncTargetWithResult() {
+    const configuredCollections = this.config.autoSyncCollections?.map((name) => name.trim()).filter((name) => name.length > 0);
+    if (!configuredCollections || configuredCollections.length === 0) {
+      return this.flushWithResult();
+    }
+    return this.flushCollectionsWithResult(configuredCollections);
+  }
+  createEmptyResult() {
+    return {
+      attempted: 0,
+      synced: 0,
+      failed: 0,
+      retried: 0,
+      deferred: 0,
+      networkErrors: 0,
+      remainingPending: 0,
+      skippedAlreadyFlushing: false,
+      items: []
+    };
+  }
+  mergeResult(target, source) {
+    target.attempted += source.attempted;
+    target.synced += source.synced;
+    target.failed += source.failed;
+    target.retried += source.retried;
+    target.deferred += source.deferred;
+    target.networkErrors += source.networkErrors;
+    target.items.push(...source.items);
+    target.remainingPending = source.remainingPending;
+    target.skippedAlreadyFlushing = target.skippedAlreadyFlushing || source.skippedAlreadyFlushing;
+  }
+  async flushCollectionsWithResult(collectionNames) {
+    const result = this.createEmptyResult();
+    for (const collectionName of collectionNames) {
+      const collectionResult = await this.flushCollectionWithResult(collectionName);
+      this.mergeResult(result, collectionResult);
+    }
+    result.remainingPending = this.queue.getPending().length;
+    return result;
+  }
   async flushWithResult() {
     if (this.isFlushing) {
       console.log("[SyncEngine] flush() skipped \u2014 already flushing");
@@ -240,17 +280,7 @@ var SyncEngine = class {
       };
     }
     this.isFlushing = true;
-    const result = {
-      attempted: 0,
-      synced: 0,
-      failed: 0,
-      retried: 0,
-      deferred: 0,
-      networkErrors: 0,
-      remainingPending: 0,
-      skippedAlreadyFlushing: false,
-      items: []
-    };
+    const result = this.createEmptyResult();
     try {
       const pending = this.queue.getPending();
       console.log("[SyncEngine] flush() \u2014 pending items:", pending.length);
@@ -281,10 +311,48 @@ var SyncEngine = class {
       this.isFlushing = false;
     }
   }
-  async flushCollection(collectionName) {
-    const pending = this.queue.getPendingForCollection(collectionName);
-    for (const item of pending) {
-      await this.syncItem(item);
+  async flushCollectionWithResult(collectionName) {
+    if (this.isFlushing) {
+      return {
+        attempted: 0,
+        synced: 0,
+        failed: 0,
+        retried: 0,
+        deferred: 0,
+        networkErrors: 0,
+        remainingPending: this.queue.getPendingForCollection(collectionName).length,
+        skippedAlreadyFlushing: true,
+        items: []
+      };
+    }
+    this.isFlushing = true;
+    const result = this.createEmptyResult();
+    try {
+      const pending = this.queue.getPendingForCollection(collectionName);
+      if (pending.length === 0) {
+        result.remainingPending = this.queue.getPendingForCollection(collectionName).length;
+        return result;
+      }
+      for (const item of pending) {
+        result.attempted += 1;
+        const itemResult = await this.syncItem(item);
+        result.items.push(itemResult);
+        if (itemResult.status === "synced") {
+          result.synced += 1;
+        } else if (itemResult.status === "failed") {
+          result.failed += 1;
+        } else if (itemResult.status === "retried") {
+          result.retried += 1;
+        } else if (itemResult.status === "deferred-backoff") {
+          result.deferred += 1;
+        } else if (itemResult.status === "network-error") {
+          result.networkErrors += 1;
+        }
+      }
+      result.remainingPending = this.queue.getPendingForCollection(collectionName).length;
+      return result;
+    } finally {
+      this.isFlushing = false;
     }
   }
   async flushRecord(recordId) {
@@ -471,7 +539,7 @@ var _AsyncStorageSync = class _AsyncStorageSync {
       console.log("[AsyncStorageSync] autoSync enabled \u2014 starting sync engine");
       instance.engine.start();
     } else {
-      console.log("[AsyncStorageSync] autoSync disabled \u2014 call flush() manually");
+      console.log("[AsyncStorageSync] autoSync disabled \u2014 call flushWithResult() or syncWithResult(collection) manually");
     }
     _AsyncStorageSync.instance = instance;
     return instance;
@@ -556,8 +624,11 @@ var _AsyncStorageSync = class _AsyncStorageSync {
   async deleteCollection(name) {
     await this.driver.remove(collectionKey(name));
   }
-  async sync(name) {
-    await this.engine.flushCollection(name);
+  async syncWithResult(name) {
+    return this.engine.flushCollectionWithResult(name);
+  }
+  async syncManyWithResult(names) {
+    return this.engine.flushCollectionsWithResult(names);
   }
   async syncById(_name, id) {
     await this.engine.flushRecord(id);

package/dist/index.mjs

@@ -199,9 +199,49 @@ var SyncEngine = class {
       clearTimeout(this.debounceTimer);
     }
     this.debounceTimer = setTimeout(() => {
-      void this.flushWithResult();
+      void this.flushAutoSyncTargetWithResult();
     }, DEBOUNCE_MS);
   }
+  async flushAutoSyncTargetWithResult() {
+    const configuredCollections = this.config.autoSyncCollections?.map((name) => name.trim()).filter((name) => name.length > 0);
+    if (!configuredCollections || configuredCollections.length === 0) {
+      return this.flushWithResult();
+    }
+    return this.flushCollectionsWithResult(configuredCollections);
+  }
+  createEmptyResult() {
+    return {
+      attempted: 0,
+      synced: 0,
+      failed: 0,
+      retried: 0,
+      deferred: 0,
+      networkErrors: 0,
+      remainingPending: 0,
+      skippedAlreadyFlushing: false,
+      items: []
+    };
+  }
+  mergeResult(target, source) {
+    target.attempted += source.attempted;
+    target.synced += source.synced;
+    target.failed += source.failed;
+    target.retried += source.retried;
+    target.deferred += source.deferred;
+    target.networkErrors += source.networkErrors;
+    target.items.push(...source.items);
+    target.remainingPending = source.remainingPending;
+    target.skippedAlreadyFlushing = target.skippedAlreadyFlushing || source.skippedAlreadyFlushing;
+  }
+  async flushCollectionsWithResult(collectionNames) {
+    const result = this.createEmptyResult();
+    for (const collectionName of collectionNames) {
+      const collectionResult = await this.flushCollectionWithResult(collectionName);
+      this.mergeResult(result, collectionResult);
+    }
+    result.remainingPending = this.queue.getPending().length;
+    return result;
+  }
   async flushWithResult() {
     if (this.isFlushing) {
       console.log("[SyncEngine] flush() skipped \u2014 already flushing");
@@ -218,17 +258,7 @@ var SyncEngine = class {
       };
     }
     this.isFlushing = true;
-    const result = {
-      attempted: 0,
-      synced: 0,
-      failed: 0,
-      retried: 0,
-      deferred: 0,
-      networkErrors: 0,
-      remainingPending: 0,
-      skippedAlreadyFlushing: false,
-      items: []
-    };
+    const result = this.createEmptyResult();
     try {
       const pending = this.queue.getPending();
       console.log("[SyncEngine] flush() \u2014 pending items:", pending.length);
@@ -259,10 +289,48 @@ var SyncEngine = class {
       this.isFlushing = false;
     }
   }
-  async flushCollection(collectionName) {
-    const pending = this.queue.getPendingForCollection(collectionName);
-    for (const item of pending) {
-      await this.syncItem(item);
+  async flushCollectionWithResult(collectionName) {
+    if (this.isFlushing) {
+      return {
+        attempted: 0,
+        synced: 0,
+        failed: 0,
+        retried: 0,
+        deferred: 0,
+        networkErrors: 0,
+        remainingPending: this.queue.getPendingForCollection(collectionName).length,
+        skippedAlreadyFlushing: true,
+        items: []
+      };
+    }
+    this.isFlushing = true;
+    const result = this.createEmptyResult();
+    try {
+      const pending = this.queue.getPendingForCollection(collectionName);
+      if (pending.length === 0) {
+        result.remainingPending = this.queue.getPendingForCollection(collectionName).length;
+        return result;
+      }
+      for (const item of pending) {
+        result.attempted += 1;
+        const itemResult = await this.syncItem(item);
+        result.items.push(itemResult);
+        if (itemResult.status === "synced") {
+          result.synced += 1;
+        } else if (itemResult.status === "failed") {
+          result.failed += 1;
+        } else if (itemResult.status === "retried") {
+          result.retried += 1;
+        } else if (itemResult.status === "deferred-backoff") {
+          result.deferred += 1;
+        } else if (itemResult.status === "network-error") {
+          result.networkErrors += 1;
+        }
+      }
+      result.remainingPending = this.queue.getPendingForCollection(collectionName).length;
+      return result;
+    } finally {
+      this.isFlushing = false;
     }
   }
   async flushRecord(recordId) {
@@ -449,7 +517,7 @@ var _AsyncStorageSync = class _AsyncStorageSync {
       console.log("[AsyncStorageSync] autoSync enabled \u2014 starting sync engine");
       instance.engine.start();
     } else {
-      console.log("[AsyncStorageSync] autoSync disabled \u2014 call flush() manually");
+      console.log("[AsyncStorageSync] autoSync disabled \u2014 call flushWithResult() or syncWithResult(collection) manually");
     }
     _AsyncStorageSync.instance = instance;
     return instance;
@@ -534,8 +602,11 @@ var _AsyncStorageSync = class _AsyncStorageSync {
   async deleteCollection(name) {
     await this.driver.remove(collectionKey(name));
   }
-  async sync(name) {
-    await this.engine.flushCollection(name);
+  async syncWithResult(name) {
+    return this.engine.flushCollectionWithResult(name);
+  }
+  async syncManyWithResult(names) {
+    return this.engine.flushCollectionsWithResult(names);
   }
   async syncById(_name, id) {
     await this.engine.flushRecord(id);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "async-storage-sync",
-  "version": "1.0.5",
+  "version": "1.0.7",
   "description": "Offline-first data layer for React Native with local-first storage and automatic sync",
   "main": "dist/index.js",
   "module": "dist/index.mjs",