@liveblocks/zustand 0.15.0-alpha.3 → 0.15.1

package/README.md

@@ -0,0 +1,40 @@
+<p align="center">
+  <a href="https://liveblocks.io">
+    <img src="https://liveblocks.io/images/blog/introducing-liveblocks.png">
+  </a>
+</p>
+
+# Liveblocks · [![Twitter Follow](https://shields.io/twitter/follow/liveblocks?label=Follow)](https://twitter.com/liveblocks)
+
+**At [Liveblocks](https://liveblocks.io), we’re building tools to help companies create world-class collaborative products that attract, engage and retain users.** This repository is a set of open-source packages for building performant and reliable multiplayer experiences.
+
+## Installation
+
+```
+npm install @liveblocks/client @liveblocks/zustand
+```
+
+## Documentation
+
+- Start with the [React-Zustand guide](https://liveblocks.io/docs/get-started/react-zustand).
+- Explore the [API Reference](https://liveblocks.io/docs/api-reference/liveblocks-zustand).
+
+## Examples
+
+- Browse our gallery of collaborative UI patterns. [View examples gallery](https://liveblocks.io/examples)
+- Explore and clone any of our open-source examples. [View code examples](https://github.com/liveblocks/liveblocks/tree/main/examples)
+
+## Releases
+
+For changelog, visit [https://github.com/liveblocks/liveblocks/releases](https://github.com/liveblocks/liveblocks/releases).
+
+## Community
+
+- [Discord](https://discord.gg/X4YWJuH9VY) - To get involved with the Liveblocks community, ask questions and share tips.
+- [Twitter](https://twitter.com/liveblocks) - To receive updates, announcements, blog posts, and general Liveblocks tips.
+
+## License
+
+Licensed under the Apache License 2.0, Copyright © 2021-present [Liveblocks](https://liveblocks.io).
+
+See [LICENSE](../../LICENSE) for more information.

package/lib/esm/index.js

@@ -1,4 +1,4 @@
-import { patchLiveObjectKey, liveNodeToJson, patchImmutableObject } from '@liveblocks/client';
+import { internals } from '@liveblocks/client';
 
 const ERROR_PREFIX = "Invalid @liveblocks/zustand middleware config.";
 function missingClient() {
@@ -39,15 +39,16 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+const { patchLiveObjectKey, patchImmutableObject, liveNodeToJson } = internals;
 function middleware(config, options) {
   if (process.env.NODE_ENV !== "production" && options.client == null) {
     throw missingClient();
   }
   const client = options.client;
-  const mapping = validateMapping(options.storageMapping, "storageMapping");
+  const storageMapping = validateMapping(options.storageMapping || {}, "storageMapping");
   const presenceMapping = validateMapping(options.presenceMapping || {}, "presenceMapping");
   if (process.env.NODE_ENV !== "production") {
-    validateNoDuplicateKeys(mapping, presenceMapping);
+    validateNoDuplicateKeys(storageMapping, presenceMapping);
   }
   return (set, get, api) => {
     const typedSet = set;
@@ -64,7 +65,7 @@ function middleware(config, options) {
         updatePresence(room, oldState, newState, presenceMapping);
         room.batch(() => {
           if (storageRoot) {
-            patchLiveblocksStorage(storageRoot, oldState, newState, mapping);
+            patchLiveblocksStorage(storageRoot, oldState, newState, storageMapping);
           }
         });
         isPatching = false;
@@ -89,7 +90,7 @@ function middleware(config, options) {
       room.getStorage().then(({ root }) => {
         const updates = {};
         room.batch(() => {
-          for (const key in mapping) {
+          for (const key in storageMapping) {
             const liveblocksStatePart = root.get(key);
             if (liveblocksStatePart == null) {
               updates[key] = initialState[key];
@@ -103,7 +104,7 @@ function middleware(config, options) {
         storageRoot = root;
         unsubscribeCallbacks.push(room.subscribe(root, (updates2) => {
           if (isPatching === false) {
-            set(patchState(get(), updates2, mapping));
+            set(patchState(get(), updates2, storageMapping));
           }
         }, { isDeep: true }));
         updateZustandLiveblocksState(set, { isStorageLoading: false });

package/lib/esm/index.mjs

@@ -1,4 +1,4 @@
-import { patchLiveObjectKey, liveNodeToJson, patchImmutableObject } from '@liveblocks/client';
+import { internals } from '@liveblocks/client';
 
 const ERROR_PREFIX = "Invalid @liveblocks/zustand middleware config.";
 function missingClient() {
@@ -39,15 +39,16 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+const { patchLiveObjectKey, patchImmutableObject, liveNodeToJson } = internals;
 function middleware(config, options) {
   if (process.env.NODE_ENV !== "production" && options.client == null) {
     throw missingClient();
   }
   const client = options.client;
-  const mapping = validateMapping(options.storageMapping, "storageMapping");
+  const storageMapping = validateMapping(options.storageMapping || {}, "storageMapping");
   const presenceMapping = validateMapping(options.presenceMapping || {}, "presenceMapping");
   if (process.env.NODE_ENV !== "production") {
-    validateNoDuplicateKeys(mapping, presenceMapping);
+    validateNoDuplicateKeys(storageMapping, presenceMapping);
   }
   return (set, get, api) => {
     const typedSet = set;
@@ -64,7 +65,7 @@ function middleware(config, options) {
         updatePresence(room, oldState, newState, presenceMapping);
         room.batch(() => {
           if (storageRoot) {
-            patchLiveblocksStorage(storageRoot, oldState, newState, mapping);
+            patchLiveblocksStorage(storageRoot, oldState, newState, storageMapping);
           }
         });
         isPatching = false;
@@ -89,7 +90,7 @@ function middleware(config, options) {
       room.getStorage().then(({ root }) => {
         const updates = {};
         room.batch(() => {
-          for (const key in mapping) {
+          for (const key in storageMapping) {
             const liveblocksStatePart = root.get(key);
             if (liveblocksStatePart == null) {
               updates[key] = initialState[key];
@@ -103,7 +104,7 @@ function middleware(config, options) {
         storageRoot = root;
         unsubscribeCallbacks.push(room.subscribe(root, (updates2) => {
           if (isPatching === false) {
-            set(patchState(get(), updates2, mapping));
+            set(patchState(get(), updates2, storageMapping));
           }
         }, { isDeep: true }));
         updateZustandLiveblocksState(set, { isStorageLoading: false });

package/lib/index.d.ts

@@ -45,7 +45,7 @@ declare type Options<T> = {
     /**
      * Mapping used to synchronize a part of your zustand state with one Liveblocks Room storage.
      */
-    storageMapping: Mapping<T>;
+    storageMapping?: Mapping<T>;
     /**
      * Mapping used to synchronize a part of your zustand state with one Liveblocks Room presence.
      */

package/lib/index.js

@@ -80,17 +80,20 @@ function mappingToFunctionIsNotAllowed(key) {
   return new Error(ERROR_PREFIX + " mapping." + key + " is invalid. Mapping to a function is not allowed.");
 }
 
+var patchLiveObjectKey = client.internals.patchLiveObjectKey,
+    patchImmutableObject = client.internals.patchImmutableObject,
+    liveNodeToJson = client.internals.liveNodeToJson;
 function middleware(config, options) {
   if (process.env.NODE_ENV !== "production" && options.client == null) {
     throw missingClient();
   }
 
-  var client$1 = options.client;
-  var mapping = validateMapping(options.storageMapping, "storageMapping");
+  var client = options.client;
+  var storageMapping = validateMapping(options.storageMapping || {}, "storageMapping");
   var presenceMapping = validateMapping(options.presenceMapping || {}, "presenceMapping");
 
   if (process.env.NODE_ENV !== "production") {
-    validateNoDuplicateKeys(mapping, presenceMapping);
+    validateNoDuplicateKeys(storageMapping, presenceMapping);
   }
 
   return function (set, get, api) {
@@ -109,7 +112,7 @@ function middleware(config, options) {
         updatePresence(room, oldState, newState, presenceMapping);
         room.batch(function () {
           if (storageRoot) {
-            patchLiveblocksStorage(storageRoot, oldState, newState, mapping);
+            patchLiveblocksStorage(storageRoot, oldState, newState, storageMapping);
           }
         });
         isPatching = false;
@@ -121,7 +124,7 @@ function middleware(config, options) {
         return;
       }
 
-      room = client$1.enter(roomId);
+      room = client.enter(roomId);
       updateZustandLiveblocksState(set, {
         isStorageLoading: true,
         room: room
@@ -142,14 +145,14 @@ function middleware(config, options) {
         var root = _ref.root;
         var updates = {};
         room.batch(function () {
-          for (var key in mapping) {
-            var liveblocksStatePart = root.get(key);
+          for (var _key in storageMapping) {
+            var liveblocksStatePart = root.get(_key);
 
             if (liveblocksStatePart == null) {
-              updates[key] = initialState[key];
-              client.patchLiveObjectKey(root, key, undefined, initialState[key]);
+              updates[_key] = initialState[_key];
+              patchLiveObjectKey(root, _key, undefined, initialState[_key]);
             } else {
-              updates[key] = client.liveNodeToJson(liveblocksStatePart);
+              updates[_key] = liveNodeToJson(liveblocksStatePart);
             }
           }
         });
@@ -157,7 +160,7 @@ function middleware(config, options) {
         storageRoot = root;
         unsubscribeCallbacks.push(room.subscribe(root, function (updates) {
           if (isPatching === false) {
-            set(patchState(get(), updates, mapping));
+            set(patchState(get(), updates, storageMapping));
           }
         }, {
           isDeep: true
@@ -178,7 +181,7 @@ function middleware(config, options) {
       room = null;
       isPatching = false;
       unsubscribeCallbacks = [];
-      client$1.leave(roomId);
+      client.leave(roomId);
       updateZustandLiveblocksState(set, {
         others: [],
         connection: "closed",
@@ -203,15 +206,15 @@ function middleware(config, options) {
 function patchState(state, updates, mapping) {
   var partialState = {};
 
-  for (var key in mapping) {
-    partialState[key] = state[key];
+  for (var _key2 in mapping) {
+    partialState[_key2] = state[_key2];
   }
 
-  var patched = client.patchImmutableObject(partialState, updates);
+  var patched = patchImmutableObject(partialState, updates);
   var result = {};
 
-  for (var _key in mapping) {
-    result[_key] = patched[_key];
+  for (var _key3 in mapping) {
+    result[_key3] = patched[_key3];
   }
 
   return result;
@@ -226,35 +229,35 @@ function updateZustandLiveblocksState(set, partial) {
 }
 
 function broadcastInitialPresence(room, state, mapping) {
-  for (var key in mapping) {
+  for (var _key4 in mapping) {
     var _room$updatePresence;
 
-    room == null ? void 0 : room.updatePresence((_room$updatePresence = {}, _room$updatePresence[key] = state[key], _room$updatePresence));
+    room == null ? void 0 : room.updatePresence((_room$updatePresence = {}, _room$updatePresence[_key4] = state[_key4], _room$updatePresence));
   }
 }
 
 function updatePresence(room, oldState, newState, presenceMapping) {
-  for (var key in presenceMapping) {
-    if (typeof newState[key] === "function") {
+  for (var _key5 in presenceMapping) {
+    if (typeof newState[_key5] === "function") {
       throw mappingToFunctionIsNotAllowed("value");
     }
 
-    if (oldState[key] !== newState[key]) {
+    if (oldState[_key5] !== newState[_key5]) {
       var _room$updatePresence2;
 
-      room.updatePresence((_room$updatePresence2 = {}, _room$updatePresence2[key] = newState[key], _room$updatePresence2));
+      room.updatePresence((_room$updatePresence2 = {}, _room$updatePresence2[_key5] = newState[_key5], _room$updatePresence2));
     }
   }
 }
 
 function patchLiveblocksStorage(root, oldState, newState, mapping) {
-  for (var key in mapping) {
-    if (process.env.NODE_ENV !== "production" && typeof newState[key] === "function") {
+  for (var _key6 in mapping) {
+    if (process.env.NODE_ENV !== "production" && typeof newState[_key6] === "function") {
       throw mappingToFunctionIsNotAllowed("value");
     }
 
-    if (oldState[key] !== newState[key]) {
-      client.patchLiveObjectKey(root, key, oldState[key], newState[key]);
+    if (oldState[_key6] !== newState[_key6]) {
+      patchLiveObjectKey(root, _key6, oldState[_key6], newState[_key6]);
     }
   }
 }
@@ -264,9 +267,9 @@ function isObject(value) {
 }
 
 function validateNoDuplicateKeys(storageMapping, presenceMapping) {
-  for (var key in storageMapping) {
-    if (presenceMapping[key] !== undefined) {
-      throw mappingShouldNotHaveTheSameKeys(key);
+  for (var _key7 in storageMapping) {
+    if (presenceMapping[_key7] !== undefined) {
+      throw mappingShouldNotHaveTheSameKeys(_key7);
     }
   }
 }
@@ -284,13 +287,13 @@ function validateMapping(mapping, mappingType) {
 
   var result = {};
 
-  for (var key in mapping) {
-    if (process.env.NODE_ENV !== "production" && typeof mapping[key] !== "boolean") {
-      throw mappingValueShouldBeABoolean(mappingType, key);
+  for (var _key8 in mapping) {
+    if (process.env.NODE_ENV !== "production" && typeof mapping[_key8] !== "boolean") {
+      throw mappingValueShouldBeABoolean(mappingType, _key8);
     }
 
-    if (mapping[key] === true) {
-      result[key] = true;
+    if (mapping[_key8] === true) {
+      result[_key8] = true;
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/zustand",
-  "version": "0.15.0-alpha.3",
+  "version": "0.15.1",
   "sideEffects": false,
   "description": "",
   "main": "./lib/index.js",
@@ -36,7 +36,7 @@
     "directory": "packages/liveblocks-zustand"
   },
   "peerDependencies": {
-    "@liveblocks/client": "0.15.0-alpha.3",
+    "@liveblocks/client": "0.15.1",
     "zustand": "^3"
   },
   "devDependencies": {
@@ -59,4 +59,4 @@
     "whatwg-fetch": "^3.6.2",
     "zustand": "^3.6.9"
   }
-}
+}