@anfenn/dync 1.0.3 → 1.0.4

package/README.md

@@ -52,6 +52,7 @@ And see how Dync compares to the alternatives [below](#hasnt-this-already-been-d
             ...,
             {
                 // Only add an entry here for tables that should be synced
+                // Pseudocode here, see examples for working code
                 items: {
                     add: (item) => fetch('/api/items'),
                     update: (id, changes) => fetch(`/api/items/${id}`),
@@ -69,8 +70,21 @@ And see how Dync compares to the alternatives [below](#hasnt-this-already-been-d
             ...,
             {
                 syncTables: ['items'], // Only add tables to this array that should be synced
-                push: (changes) => fetch('/api/sync/push'),
-                pull: (since) => fetch(`/api/sync/pull?since=${since}`),
+                push: async (changes) => {
+                    const res = await fetch('/api/sync/push', {
+                        method: 'POST',
+                        headers: { 'Content-Type': 'application/json' },
+                        body: JSON.stringify(changes),
+                    });
+                    return res.json();
+                },
+                pull: async (since) => {
+                    const params = new URLSearchParams(
+                        Object.entries(since).map(([table, date]) => [table, date.toISOString()])
+                    );
+                    const res = await fetch(`/api/sync/pull?${params}`);
+                    return res.json();
+                },
             },
         );
         ```
@@ -81,8 +95,8 @@ And see how Dync compares to the alternatives [below](#hasnt-this-already-been-d
 
     ```ts
     const { syncState, db } = useDync();
-    syncState.conflicts; // Record<id, Conflict> Use to show user conflicts
-    db.sync.resolveConflict(id, true);
+    syncState.conflicts; // Record<localId, Conflict>
+    db.sync.resolveConflict(localId, true);
     ```
 
 - Optional first load data download before periodic sync is enabled
@@ -90,10 +104,14 @@ And see how Dync compares to the alternatives [below](#hasnt-this-already-been-d
 - Reactive updates when data changes via `useLiveQuery()` React hook:
 
     ```ts
-    useLiveQuery(async (db) => {
-        const items = await db.items.toArray();
-        setItems(items);
-    }, []);
+    useLiveQuery(
+        async (db) => {
+            const items = await db.items.toArray(); // toArray() executes the query
+            setTodos(items);
+        },
+        [], // Re-run when variables change
+        ['items'], // Re-run when tables change
+    );
     ```
 
 - Sqlite schema migration
@@ -159,11 +177,11 @@ Your server records **must** have these fields. If it does but they're named dif
 
 Dync auto-injects these fields into your local table schema:
 
-| Field        | Description                                                                                                                       |
-| ------------ | --------------------------------------------------------------------------------------------------------------------------------- |
-| `_localId`   | Stable local identifier, never sent to the server. Ideal for React keys. Generate with `createLocalId()` or use any unique value. |
-| `id`         | Unique identifier (any datatype). Can be assigned by client or server.                                                            |
-| `updated_at` | Assigned from the server's `updated_at` after sync. You may set it optimistically, but it's always overwritten on sync.           |
+| Field        | Description                                                                                                                                  |
+| ------------ | -------------------------------------------------------------------------------------------------------------------------------------------- |
+| `_localId`   | Stable local identifier, never sent to the server. Ideal for React keys. Auto-generated UUID, but can be set manually with any unique value. |
+| `id`         | Unique identifier (any datatype). Can be assigned by client or server.                                                                       |
+| `updated_at` | Assigned from the server's `updated_at` after sync. You may set it optimistically, but it's always overwritten on sync.                      |
 
 Note: `deleted` doesn't exist on the client, as it's removed during sync.
 

package/dist/{chunk-66PSQW4D.js → chunk-PCA4XM2N.js}

@@ -481,7 +481,7 @@ function enhanceSyncTable({ table, tableName, withTransaction, state, enhancedTa
     }
   };
   const wrappedBulkAdd = async (items) => {
-    if (items.length === 0) return;
+    if (items.length === 0) return [];
     const now = (/* @__PURE__ */ new Date()).toISOString();
     const syncedItems = items.map((item) => {
       const localId = item._localId || createLocalId();
@@ -509,7 +509,7 @@ function enhanceSyncTable({ table, tableName, withTransaction, state, enhancedTa
     return result;
   };
   const wrappedBulkPut = async (items) => {
-    if (items.length === 0) return;
+    if (items.length === 0) return [];
     const now = (/* @__PURE__ */ new Date()).toISOString();
     const syncedItems = items.map((item) => {
       const localId = item._localId || createLocalId();
@@ -2015,23 +2015,23 @@ var MemoryTable = class {
     return this.baseBulkAdd(items);
   }
   baseBulkAdd(items) {
-    let lastKey = void 0;
+    const keys = [];
     for (let index = 0; index < items.length; index += 1) {
       const item = items[index];
-      lastKey = this.baseAdd(item);
+      keys.push(this.baseAdd(item));
     }
-    return lastKey;
+    return keys;
   }
   async bulkPut(items) {
     return this.baseBulkPut(items);
   }
   baseBulkPut(items) {
-    let lastKey = void 0;
+    const keys = [];
     for (let index = 0; index < items.length; index += 1) {
       const item = items[index];
-      lastKey = this.basePut(item);
+      keys.push(this.basePut(item));
     }
-    return lastKey;
+    return keys;
   }
   async bulkGet(keys) {
     return Promise.all(keys.map((key) => this.get(key)));
@@ -3251,12 +3251,12 @@ var SQLiteTable = class {
     return this.baseBulkAdd(items);
   }
   async baseBulkAdd(items) {
-    if (!items.length) return void 0;
+    if (!items.length) return [];
     const columns = this.columnNames;
     const columnCount = columns.length;
     const maxParamsPerBatch = 500;
     const batchSize = Math.max(1, Math.floor(maxParamsPerBatch / columnCount));
-    let lastKey = void 0;
+    const allKeys = [];
     for (let i = 0; i < items.length; i += batchSize) {
       const batch = items.slice(i, i + batchSize);
       const records = batch.map((item) => this.prepareRecordForWrite(item));
@@ -3265,25 +3265,25 @@ var SQLiteTable = class {
       const values = [];
       for (const record of records) {
         values.push(...this.extractColumnValues(record));
+        allKeys.push(record[LOCAL_PK]);
       }
       await this.adapter.run(
         `INSERT INTO ${quoteIdentifier(this.name)} (${columns.map((c) => quoteIdentifier(c)).join(", ")}) VALUES ${placeholders}`,
         values
       );
-      lastKey = records[records.length - 1][LOCAL_PK];
     }
-    return lastKey;
+    return allKeys;
   }
   async bulkPut(items) {
     return this.baseBulkPut(items);
   }
   async baseBulkPut(items) {
-    if (!items.length) return void 0;
+    if (!items.length) return [];
     const columns = this.columnNames;
     const columnCount = columns.length;
     const maxParamsPerBatch = 500;
     const batchSize = Math.max(1, Math.floor(maxParamsPerBatch / columnCount));
-    let lastKey = void 0;
+    const allKeys = [];
     for (let i = 0; i < items.length; i += batchSize) {
       const batch = items.slice(i, i + batchSize);
       const records = batch.map((item) => this.prepareRecordForWrite(item));
@@ -3292,14 +3292,14 @@ var SQLiteTable = class {
       const values = [];
       for (const record of records) {
         values.push(...this.extractColumnValues(record));
+        allKeys.push(record[LOCAL_PK]);
       }
       await this.adapter.run(
         `INSERT OR REPLACE INTO ${quoteIdentifier(this.name)} (${columns.map((c) => quoteIdentifier(c)).join(", ")}) VALUES ${placeholders}`,
         values
       );
-      lastKey = records[records.length - 1][LOCAL_PK];
     }
-    return lastKey;
+    return allKeys;
   }
   async bulkGet(keys) {
     if (!keys.length) return [];
@@ -3881,4 +3881,4 @@ export {
   SqliteQueryContext,
   SQLiteAdapter2 as SQLiteAdapter
 };
-//# sourceMappingURL=chunk-66PSQW4D.js.map
+//# sourceMappingURL=chunk-PCA4XM2N.js.map