@sveltebase/sync 1.1.0 → 1.1.2

package/README.md

@@ -130,6 +130,18 @@ Use it in your Svelte 5 components (using your preferred Dexie reactivity hook,
 {/each}
 ```
 
+### Synced Database Operations
+
+Under the hood, `@sveltebase/sync` intercepts native Dexie table writes to capture and propagate mutations to the backend. The following methods automatically sync with the server:
+
+* **`.add(row)`**: Triggers a `"create"` sync mutation.
+* **`.put(row)` or `.put(id, changes)`**: Computes a diff of changed properties (for updates) or initiates a `"create"` mutation (for new rows) and sends it to the server.
+* **`.update(id, changes)`**: Performs a local partial update and propagates the changes to the server as an `"update"` mutation.
+* **`.delete(id)`**: Locally deletes the row and propagates a `"delete"` mutation to the server.
+
+> [!NOTE]
+> **Bulk methods** (such as `.bulkAdd()`, `.bulkPut()`, and `.bulkDelete()`) bypass backend syncing entirely. They write directly to IndexedDB, which is useful for performing offline seeding or local-only updates.
+
 ---
 
 ### Step 2: Define Sync Handlers (Server)

package/dist/client/index.d.ts

@@ -16,7 +16,7 @@ declare class SyncClientClass<TSchema extends Record<string, any> = Record<strin
     private pingInterval;
     private closedByClient;
     private activeChannels;
-    private _status;
+    private _statusState;
     private pendingMutations;
     private mutationQueue;
     constructor(options: {
@@ -41,6 +41,8 @@ declare class SyncClientClass<TSchema extends Record<string, any> = Record<strin
 }
 export type SyncClient<TSchema extends Record<string, any> = Record<string, any>> = SyncClientClass<TSchema> & {
     [K in keyof TSchema]: Table<TSchema[K]>;
+} & {
+    [tableName: string]: Table<any>;
 };
 export declare const SyncClient: new <TSchema extends Record<string, any> = Record<string, any>>(options: {
     name: string;

package/dist/client/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,KAAK,KAAK,EAAwB,MAAM,OAAO,CAAC;AAGhE,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;CACrC,CAAC;AAaF,cAAM,eAAe,CACnB,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CACzD,SAAQ,KAAK;IACb,OAAO,CAAC,KAAK,CAA4C;IACzD,OAAO,CAAC,MAAM,CAAwB;IACtC,OAAO,CAAC,YAAY,CAA8B;IAClD,OAAO,CAAC,cAAc,CAA4C;IAClE,OAAO,CAAC,YAAY,CAA6C;IACjE,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,cAAc,CAAqB;IAG3C,OAAO,CAAC,OAAO,CAAqE;IAGpF,OAAO,CAAC,gBAAgB,CAAsC;IAE9D,OAAO,CAAC,aAAa,CAMb;gBAEI,OAAO,EAAE;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/C,MAAM,EAAE,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,EAAE,WAAW,CAAC,CAAC;KACrD;IAoBD,IAAW,MAAM,gDAEhB;IAED,OAAO,CAAC,cAAc;YAiJR,OAAO;IAuFd,SAAS;IAgBhB,OAAO,CAAC,cAAc;IAStB,OAAO,CAAC,aAAa;YAOP,kBAAkB;IAoBhC,OAAO,CAAC,kBAAkB;YAkBZ,UAAU;YAiBV,aAAa;YAqBb,mBAAmB;IAwEjC,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,eAAe;IAqChB,UAAU;CAelB;AAED,MAAM,MAAM,UAAU,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC,GAAG;KAC5G,CAAC,IAAI,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;CACxC,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,KACvB,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACzD,OAAO,EAAE;IACT,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/C,MAAM,EAAE,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,EAAE,WAAW,CAAC,CAAC;CACrD,KAAK,UAAU,CAAC,OAAO,CAA0B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/client/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,KAAK,KAAK,EAAwB,MAAM,OAAO,CAAC;AAIhE,MAAM,MAAM,WAAW,GAAG;IACxB,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,MAAM,MAAM,iBAAiB,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/C,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;CACrC,CAAC;AAaF,cAAM,eAAe,CACnB,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CACzD,SAAQ,KAAK;IACb,OAAO,CAAC,KAAK,CAA4C;IACzD,OAAO,CAAC,MAAM,CAAwB;IACtC,OAAO,CAAC,YAAY,CAA8B;IAClD,OAAO,CAAC,cAAc,CAA4C;IAClE,OAAO,CAAC,YAAY,CAA6C;IACjE,OAAO,CAAC,cAAc,CAAS;IAC/B,OAAO,CAAC,cAAc,CAAqB;IAG3C,OAAO,CAAC,YAAY,CAA0B;IAG9C,OAAO,CAAC,gBAAgB,CAAsC;IAE9D,OAAO,CAAC,aAAa,CAMb;gBAEI,OAAO,EAAE;QACnB,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;QAC/C,MAAM,EAAE,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,EAAE,WAAW,CAAC,CAAC;KACrD;IAoBD,IAAW,MAAM,gDAEhB;IAED,OAAO,CAAC,cAAc;YAiJR,OAAO;IAuFd,SAAS;IAgBhB,OAAO,CAAC,cAAc;IAStB,OAAO,CAAC,aAAa;YAOP,kBAAkB;IAoBhC,OAAO,CAAC,kBAAkB;YAkBZ,UAAU;YAiBV,aAAa;YAqBb,mBAAmB;IAwEjC,OAAO,CAAC,kBAAkB;IAQ1B,OAAO,CAAC,eAAe;IAqChB,UAAU;CAelB;AAED,MAAM,MAAM,UAAU,CAAC,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,IAAI,eAAe,CAAC,OAAO,CAAC,GAAG;KAC5G,CAAC,IAAI,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;CACxC,GAAG;IACF,CAAC,SAAS,EAAE,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC;CACjC,CAAC;AAEF,eAAO,MAAM,UAAU,EAAE,KACvB,OAAO,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EACzD,OAAO,EAAE;IACT,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,GAAG,CAAC,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/C,MAAM,EAAE,MAAM,CAAC,MAAM,OAAO,GAAG,MAAM,EAAE,WAAW,CAAC,CAAC;CACrD,KAAK,UAAU,CAAC,OAAO,CAA0B,CAAC"}

package/dist/client/index.js

@@ -1,5 +1,6 @@
 import Dexie, {} from "dexie";
 import { parseSyncMessage } from "../protocol.js";
+import { ConnectionStatus } from "./status.svelte.js";
 class SyncClientClass extends Dexie {
     wsUrl;
     socket;
@@ -8,8 +9,8 @@ class SyncClientClass extends Dexie {
     pingInterval;
     closedByClient = false;
     activeChannels = new Set();
-    // Reactive connection status
-    _status = $state("connecting");
+    // Reactive connection status delegated to status.svelte.ts
+    _statusState = new ConnectionStatus();
     // Mutations waiting for ack/reject from server
     pendingMutations = new Map();
     // Mutations queued to be sent when connection is established
@@ -31,7 +32,7 @@ class SyncClientClass extends Dexie {
         }
     }
     get status() {
-        return this._status;
+        return this._statusState.value;
     }
     decorateTables() {
         for (const [tableName, config] of Object.entries(this.tableConfigs)) {
@@ -126,7 +127,7 @@ class SyncClientClass extends Dexie {
     async connect() {
         if (this.closedByClient)
             return;
-        this._status = "connecting";
+        this._statusState.value = "connecting";
         const protocol = window.location.protocol === "https:" ? "wss:" : "ws:";
         const host = window.location.host;
         let resolvedUrl;
@@ -135,7 +136,7 @@ class SyncClientClass extends Dexie {
         }
         catch (err) {
             console.error("SyncClient: Failed to resolve wsUrl", err);
-            this._status = "disconnected";
+            this._statusState.value = "disconnected";
             if (!this.closedByClient) {
                 this.reconnectTimer = setTimeout(() => this.connect(), 2000);
             }
@@ -150,7 +151,7 @@ class SyncClientClass extends Dexie {
             if (this.socket !== socket)
                 return;
             console.log("SyncClient: WebSocket connected");
-            this._status = "connected";
+            this._statusState.value = "connected";
             this.activeChannels.clear();
             this.startHeartbeat();
             // Re-subscribe to all tables (delta-sync aware)
@@ -186,7 +187,7 @@ class SyncClientClass extends Dexie {
         socket.addEventListener("close", () => {
             if (this.socket === socket) {
                 this.socket = undefined;
-                this._status = "disconnected";
+                this._statusState.value = "disconnected";
                 this.stopHeartbeat();
                 if (!this.closedByClient) {
                     this.reconnectTimer = setTimeout(() => this.connect(), 2000);
@@ -211,7 +212,7 @@ class SyncClientClass extends Dexie {
             }
             catch { }
             this.socket = undefined;
-            this._status = "disconnected";
+            this._statusState.value = "disconnected";
         }
         this.connect();
     }
@@ -403,7 +404,7 @@ class SyncClientClass extends Dexie {
     }
     disconnect() {
         this.closedByClient = true;
-        this._status = "disconnected";
+        this._statusState.value = "disconnected";
         this.stopHeartbeat();
         if (this.reconnectTimer) {
             clearTimeout(this.reconnectTimer);

package/dist/client/status.svelte.d.ts

@@ -0,0 +1,6 @@
+export declare class ConnectionStatus {
+    private _value;
+    get value(): "connecting" | "connected" | "disconnected";
+    set value(newValue: "connecting" | "connected" | "disconnected");
+}
+//# sourceMappingURL=status.svelte.d.ts.map

package/dist/client/status.svelte.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"status.svelte.d.ts","sourceRoot":"","sources":["../../src/client/status.svelte.ts"],"names":[],"mappings":"AAAA,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,MAAM,CAAqE;IAEnF,IAAI,KAAK,IAIW,YAAY,GAAG,WAAW,GAAG,cAAc,CAF9D;IAED,IAAI,KAAK,CAAC,QAAQ,EAAE,YAAY,GAAG,WAAW,GAAG,cAAc,EAE9D;CACF"}

package/dist/client/status.svelte.js

@@ -0,0 +1,9 @@
+export class ConnectionStatus {
+    _value = $state("connecting");
+    get value() {
+        return this._value;
+    }
+    set value(newValue) {
+        this._value = newValue;
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sveltebase/sync",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "type": "module",
   "publishConfig": {
     "access": "public"