remote-state-sync 1.0.1 → 1.0.3

package/dist/index.d.ts

@@ -1,29 +1,33 @@
+import { SuperJSONResult } from 'superjson';
 import Nanobus from 'nanobus';
 import { Ref, ShallowRef } from '@vue/reactivity';
 
 type PatchOperation = 'set' | 'delete' | 'clear' | 'add';
 interface Patch {
     op: PatchOperation;
+    key: string;
     path: (string | number)[];
     value?: unknown;
 }
 interface SyncOptions {
-    snapshotGetter: (namespace: string) => Promise<Record<string, unknown>>;
+    snapshotGetter: (namespace: string) => Promise<SyncSnapshot>;
 }
 type SyncUpdater<T> = (state: T) => T | void;
 type SyncBusDefinition = {
     update: (namespace: string, patches: Patch[]) => void;
+    register: (namespace: string) => void;
 };
 type ReceiverItemBusDefinition<T> = {
     update: (newValue: T, oldValue: T, patches: Patch[]) => void;
 };
+type SyncSnapshot = SuperJSONResult;
 
 declare class SyncProvider {
     private namespaces;
-    bus: Nanobus<SyncBusDefinition>;
+    readonly bus: Nanobus<SyncBusDefinition>;
     constructor();
     register(namespace: string): SyncNamespaceProvider;
-    getStateSnapshot(namespace: string): Promise<Record<string, unknown>>;
+    getStateSnapshot(namespace: string): SyncSnapshot;
 }
 declare class SyncNamespaceProvider {
     readonly namespace: string;
@@ -33,7 +37,7 @@ declare class SyncNamespaceProvider {
     private emitTimeout;
     constructor(namespace: string, bus: Nanobus<SyncBusDefinition>);
     sync<T>(key: string, initialValue?: T): SyncItemProvider<T>;
-    getSnapshot(): Record<string, unknown>;
+    getSnapshot(): SyncSnapshot;
     private queuePatch;
     private emitPatches;
 }
@@ -58,7 +62,7 @@ declare class SyncNamespaceReceiver {
     readonly namespace: string;
     private snapshot;
     private items;
-    constructor(namespace: string, snapshot: Record<string, unknown>);
+    constructor(namespace: string, snapshot: SyncSnapshot);
     sync<T>(key: string): SyncItemReceiver<T>;
     applyPatches(patches: Patch[]): void;
     private applyPatchToObject;
@@ -68,7 +72,7 @@ declare class SyncItemReceiver<T> {
     private value;
     private _ref;
     private _shallowRef;
-    bus: Nanobus<ReceiverItemBusDefinition<T>>;
+    readonly bus: Nanobus<ReceiverItemBusDefinition<T>>;
     constructor(key: string, initialValue: T);
     on(event: 'update', cb: (newValue: T, oldValue: T, patches: Patch[]) => void): void;
     toValue(): T;
@@ -79,4 +83,4 @@ declare class SyncItemReceiver<T> {
     dispose(): void;
 }
 
-export { type Patch, type PatchOperation, type ReceiverItemBusDefinition, type SyncBusDefinition, SyncItemProvider, SyncItemReceiver, SyncNamespaceProvider, SyncNamespaceReceiver, type SyncOptions, SyncProvider, SyncReceiver, type SyncUpdater };
+export { type Patch, type PatchOperation, type ReceiverItemBusDefinition, type SyncBusDefinition, SyncItemProvider, SyncItemReceiver, SyncNamespaceProvider, SyncNamespaceReceiver, type SyncOptions, SyncProvider, SyncReceiver, type SyncSnapshot, type SyncUpdater };

package/dist/index.js

@@ -1,5 +1,6 @@
 // src/provider.ts
 import Nanobus from "nanobus";
+import SuperJSON from "superjson";
 
 // src/utils.ts
 function isObject(val) {
@@ -53,19 +54,19 @@ function clearValue(current) {
 }
 
 // src/proxy.ts
-function createDeepProxy(target, path, onPatch) {
+function createDeepProxy(target, rootKey, path, onPatch) {
   if (!shouldProxy(target)) {
     return target;
   }
   if (target instanceof Map) {
-    return createMapProxy(target, path, onPatch);
+    return createMapProxy(target, rootKey, path, onPatch);
   }
   if (target instanceof Set) {
-    return createSetProxy(target, path, onPatch);
+    return createSetProxy(target, rootKey, path, onPatch);
   }
-  return createObjectProxy(target, path, onPatch);
+  return createObjectProxy(target, rootKey, path, onPatch);
 }
-function createObjectProxy(target, path, onPatch) {
+function createObjectProxy(target, rootKey, path, onPatch) {
   const handler = {
     get(obj, prop, receiver) {
       const value = Reflect.get(obj, prop, receiver);
@@ -73,7 +74,7 @@ function createObjectProxy(target, path, onPatch) {
         return value;
       }
       if (shouldProxy(value)) {
-        return createDeepProxy(value, [...path, prop], onPatch);
+        return createDeepProxy(value, rootKey, [...path, prop], onPatch);
       }
       return value;
     },
@@ -85,6 +86,7 @@ function createObjectProxy(target, path, onPatch) {
       if (success) {
         onPatch({
           op: "set",
+          key: rootKey,
           path: [...path, prop],
           value
         });
@@ -99,6 +101,7 @@ function createObjectProxy(target, path, onPatch) {
       if (success) {
         onPatch({
           op: "delete",
+          key: rootKey,
           path: [...path, prop]
         });
       }
@@ -107,7 +110,7 @@ function createObjectProxy(target, path, onPatch) {
   };
   return new Proxy(target, handler);
 }
-function createMapProxy(target, path, onPatch) {
+function createMapProxy(target, rootKey, path, onPatch) {
   const handler = {
     get(obj, prop) {
       const value = Reflect.get(obj, prop);
@@ -120,6 +123,7 @@ function createMapProxy(target, path, onPatch) {
             const result = obj.set(key, val);
             onPatch({
               op: "set",
+              key: rootKey,
               path: [...path, key],
               value: val
             });
@@ -133,6 +137,7 @@ function createMapProxy(target, path, onPatch) {
             if (hasKey) {
               onPatch({
                 op: "delete",
+                key: rootKey,
                 path: [...path, key]
               });
             }
@@ -145,6 +150,7 @@ function createMapProxy(target, path, onPatch) {
               const result = obj.clear();
               onPatch({
                 op: "clear",
+                key: rootKey,
                 path
               });
               return result;
@@ -155,7 +161,7 @@ function createMapProxy(target, path, onPatch) {
           return function(key) {
             const getVal = obj.get(key);
             if (shouldProxy(getVal)) {
-              return createDeepProxy(getVal, [...path, key], onPatch);
+              return createDeepProxy(getVal, rootKey, [...path, key], onPatch);
             }
             return getVal;
           };
@@ -167,7 +173,7 @@ function createMapProxy(target, path, onPatch) {
   };
   return new Proxy(target, handler);
 }
-function createSetProxy(target, path, onPatch) {
+function createSetProxy(target, rootKey, path, onPatch) {
   const handler = {
     get(obj, prop) {
       const value = Reflect.get(obj, prop);
@@ -182,6 +188,7 @@ function createSetProxy(target, path, onPatch) {
             if (!hasVal) {
               onPatch({
                 op: "add",
+                key: rootKey,
                 // For set, we don't have a key to navigate, but we can pass the value
                 // In a true Sync scenario, Set diffing is tricky. Path is just the Set itself.
                 path,
@@ -198,6 +205,7 @@ function createSetProxy(target, path, onPatch) {
             if (hasVal) {
               onPatch({
                 op: "delete",
+                key: rootKey,
                 path,
                 // Similarly, deleting from set happens at Set boundary
                 value: val
@@ -213,6 +221,7 @@ function createSetProxy(target, path, onPatch) {
               const result = obj.clear();
               onPatch({
                 op: "clear",
+                key: rootKey,
                 path
               });
               return result;
@@ -239,9 +248,10 @@ var SyncProvider = class {
     }
     const ns = new SyncNamespaceProvider(namespace, this.bus);
     this.namespaces.set(namespace, ns);
+    this.bus.emit("register", namespace);
     return ns;
   }
-  async getStateSnapshot(namespace) {
+  getStateSnapshot(namespace) {
     const ns = this.namespaces.get(namespace);
     if (!ns) {
       throw new Error(`Namespace ${namespace} not found`);
@@ -272,7 +282,7 @@ var SyncNamespaceProvider = class {
     for (const [key, item] of this.items.entries()) {
       snapshot[key] = item.toValue();
     }
-    return snapshot;
+    return SuperJSON.serialize(snapshot);
   }
   queuePatch(patch) {
     this.queuedPatches.push(patch);
@@ -316,16 +326,18 @@ var SyncItemProvider = class {
   setValue(newVal) {
     this.onPatch({
       op: "set",
-      path: [this.key],
+      key: this.key,
+      path: [],
       value: newVal
     });
-    this.value = createDeepProxy(newVal, [this.key], this.onPatch);
+    this.value = createDeepProxy(newVal, this.key, [], this.onPatch);
   }
 };
 
 // src/receiver.ts
 import Nanobus2 from "nanobus";
 import { shallowRef, ref, triggerRef } from "@vue/reactivity";
+import SuperJSON2 from "superjson";
 var SyncReceiver = class {
   constructor(options) {
     this.options = options;
@@ -357,7 +369,8 @@ var SyncNamespaceReceiver = class {
     if (this.items.has(key)) {
       return this.items.get(key);
     }
-    const val = this.snapshot[key];
+    const snapshot = SuperJSON2.deserialize(this.snapshot);
+    const val = snapshot[key];
     const item = new SyncItemReceiver(key, val);
     this.items.set(key, item);
     return item;
@@ -365,8 +378,7 @@ var SyncNamespaceReceiver = class {
   applyPatches(patches) {
     const affectedItems = /* @__PURE__ */ new Map();
     for (const patch of patches) {
-      if (patch.path.length === 0) continue;
-      const key = patch.path[0];
+      const key = patch.key;
       const item = this.items.get(key);
       if (item) {
         if (!affectedItems.has(item)) {
@@ -384,9 +396,9 @@ var SyncNamespaceReceiver = class {
     }
   }
   applyPatchToObject(obj, patch) {
-    if (patch.path.length === 0) return;
+    const fullPath = [patch.key, ...patch.path];
     if (patch.op === "clear" || patch.op === "add") {
-      const target = navigatePath(obj, patch.path, 0, patch.path.length);
+      const target = navigatePath(obj, fullPath, 0, fullPath.length);
       if (patch.op === "clear") {
         clearValue(target);
       } else {
@@ -394,8 +406,8 @@ var SyncNamespaceReceiver = class {
       }
       return;
     }
-    const current = navigatePath(obj, patch.path, 0, patch.path.length - 1);
-    const lastKey = patch.path[patch.path.length - 1];
+    const current = navigatePath(obj, fullPath, 0, fullPath.length - 1);
+    const lastKey = fullPath[fullPath.length - 1];
     if (patch.op === "set") {
       setValueAtPath(current, lastKey, patch.value);
     } else if (patch.op === "delete") {
@@ -431,7 +443,7 @@ var SyncItemReceiver = class {
     return this._shallowRef;
   }
   applyPatch(patch) {
-    if (patch.path.length === 1) {
+    if (patch.path.length === 0) {
       if (patch.op === "set") {
         this.value = patch.value;
         if (this._ref) this._ref.value = patch.value;
@@ -441,41 +453,41 @@ var SyncItemReceiver = class {
     }
     const lastKey = patch.path[patch.path.length - 1];
     if (patch.op === "set") {
-      const current = navigatePath(this.value, patch.path, 1, patch.path.length - 1);
+      const current = navigatePath(this.value, patch.path, 0, patch.path.length - 1);
       const refCurrent = navigatePath(
         this._ref ? this._ref.value : null,
         patch.path,
-        1,
+        0,
         patch.path.length - 1
       );
       setValueAtPath(current, lastKey, patch.value);
       setValueAtPath(refCurrent, lastKey, patch.value);
     } else if (patch.op === "delete") {
-      const current = navigatePath(this.value, patch.path, 1, patch.path.length - 1);
+      const current = navigatePath(this.value, patch.path, 0, patch.path.length - 1);
       const refCurrent = navigatePath(
         this._ref ? this._ref.value : null,
         patch.path,
-        1,
+        0,
         patch.path.length - 1
       );
       deleteValueAtPath(current, lastKey);
       deleteValueAtPath(refCurrent, lastKey);
     } else if (patch.op === "add") {
-      const target = navigatePath(this.value, patch.path, 1, patch.path.length);
+      const target = navigatePath(this.value, patch.path, 0, patch.path.length);
       const refTarget = navigatePath(
         this._ref ? this._ref.value : null,
         patch.path,
-        1,
+        0,
         patch.path.length
       );
       addValueToSet(target, patch.value);
       addValueToSet(refTarget, patch.value);
     } else if (patch.op === "clear") {
-      const target = navigatePath(this.value, patch.path, 1, patch.path.length);
+      const target = navigatePath(this.value, patch.path, 0, patch.path.length);
       const refTarget = navigatePath(
         this._ref ? this._ref.value : null,
         patch.path,
-        1,
+        0,
         patch.path.length
       );
       clearValue(target);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "remote-state-sync",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A lightweight, fully type-safe unidirectional remote state synchronization library.",
   "type": "module",
   "repository": {
@@ -26,9 +26,11 @@
   "types": "./dist/index.d.ts",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
-    }
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "dist"
@@ -66,6 +68,7 @@
   },
   "dependencies": {
     "@vue/reactivity": "^3.5.28",
-    "nanobus": "^4.5.0"
+    "nanobus": "^4.5.0",
+    "superjson": "^2.2.6"
   }
-}
+}