@liveblocks/redux 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/redux
+```
+
+## Documentation
+
+- Start with the [React-Redux guide](https://liveblocks.io/docs/get-started/react-redux).
+- Explore the [API Reference](https://liveblocks.io/docs/api-reference/liveblocks-redux).
+
+## 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/redux middleware config.";
 function missingClient() {
@@ -39,6 +39,7 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+const { patchImmutableObject, patchLiveObjectKey, liveNodeToJson } = internals;
 const ACTION_TYPES = {
   ENTER: "@@LIVEBLOCKS/ENTER",
   LEAVE: "@@LIVEBLOCKS/LEAVE",
@@ -48,7 +49,7 @@ const ACTION_TYPES = {
   UPDATE_CONNECTION: "@@LIVEBLOCKS/UPDATE_CONNECTION",
   UPDATE_OTHERS: "@@LIVEBLOCKS/UPDATE_OTHERS"
 };
-const internalPlugin = (options) => {
+const internalEnhancer = (options) => {
   if (process.env.NODE_ENV !== "production" && options.client == null) {
     throw missingClient();
   }
@@ -192,6 +193,10 @@ const internalPlugin = (options) => {
     });
   };
 };
+const actions = {
+  enterRoom,
+  leaveRoom
+};
 function enterRoom(roomId, initialState) {
   return {
     type: ACTION_TYPES.ENTER,
@@ -205,7 +210,7 @@ function leaveRoom(roomId) {
     roomId
   };
 }
-const enhancer = internalPlugin;
+const enhancer = internalEnhancer;
 function patchLiveblocksStorage(root, oldState, newState, mapping) {
   for (const key in mapping) {
     if (process.env.NODE_ENV !== "production" && typeof newState[key] === "function") {
@@ -274,4 +279,4 @@ function validateMapping(mapping, mappingType) {
   return result;
 }
 
-export { enhancer, enterRoom, leaveRoom };
+export { actions, enhancer };

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/redux middleware config.";
 function missingClient() {
@@ -39,6 +39,7 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+const { patchImmutableObject, patchLiveObjectKey, liveNodeToJson } = internals;
 const ACTION_TYPES = {
   ENTER: "@@LIVEBLOCKS/ENTER",
   LEAVE: "@@LIVEBLOCKS/LEAVE",
@@ -48,7 +49,7 @@ const ACTION_TYPES = {
   UPDATE_CONNECTION: "@@LIVEBLOCKS/UPDATE_CONNECTION",
   UPDATE_OTHERS: "@@LIVEBLOCKS/UPDATE_OTHERS"
 };
-const internalPlugin = (options) => {
+const internalEnhancer = (options) => {
   if (process.env.NODE_ENV !== "production" && options.client == null) {
     throw missingClient();
   }
@@ -192,6 +193,10 @@ const internalPlugin = (options) => {
     });
   };
 };
+const actions = {
+  enterRoom,
+  leaveRoom
+};
 function enterRoom(roomId, initialState) {
   return {
     type: ACTION_TYPES.ENTER,
@@ -205,7 +210,7 @@ function leaveRoom(roomId) {
     roomId
   };
 }
-const enhancer = internalPlugin;
+const enhancer = internalEnhancer;
 function patchLiveblocksStorage(root, oldState, newState, mapping) {
   for (const key in mapping) {
     if (process.env.NODE_ENV !== "production" && typeof newState[key] === "function") {
@@ -274,4 +279,4 @@ function validateMapping(mapping, mappingType) {
   return result;
 }
 
-export { enhancer, enterRoom, leaveRoom };
+export { actions, enhancer };

package/lib/index.d.ts

@@ -5,7 +5,7 @@ export declare type Mapping<T> = Partial<{
 }>;
 export declare type LiveblocksState<TState, TPresence = any> = TState & {
     /**
-     * Liveblocks extra state attached by the middleware
+     * Liveblocks extra state attached by the enhancer
      */
     readonly liveblocks: {
         /**
@@ -22,12 +22,28 @@ export declare type LiveblocksState<TState, TPresence = any> = TState & {
         readonly connection: "closed" | "authenticating" | "unavailable" | "failed" | "open" | "connecting";
     };
 };
-export declare function enterRoom(roomId: string, initialState?: any): {
+/**
+ * Actions used to interact with Liveblocks
+ */
+export declare const actions: {
+    /**
+     * Enters a room and starts sync it with zustand state
+     * @param roomId The id of the room
+     * @param initialState The initial state of the room storage. If a key does not exist if your room storage root, initialState[key] will be used.
+     */
+    enterRoom: typeof enterRoom;
+    /**
+     * Leaves a room and stops sync it with zustand state.
+     * @param roomId The id of the room
+     */
+    leaveRoom: typeof leaveRoom;
+};
+declare function enterRoom(roomId: string, initialState?: any): {
     type: string;
     roomId: string;
     initialState: any;
 };
-export declare function leaveRoom(roomId: string): {
+declare function leaveRoom(roomId: string): {
     type: string;
     roomId: string;
 };
@@ -36,3 +52,4 @@ export declare const enhancer: <T>(options: {
     storageMapping: Partial<{ [Property in keyof T]: boolean; }>;
     presenceMapping?: Partial<{ [Property in keyof T]: boolean; }> | undefined;
 }) => StoreEnhancer;
+export {};

package/lib/index.js

@@ -80,6 +80,9 @@ function mappingToFunctionIsNotAllowed(key) {
   return new Error(ERROR_PREFIX + " mapping." + key + " is invalid. Mapping to a function is not allowed.");
 }
 
+var patchImmutableObject = client.internals.patchImmutableObject,
+    patchLiveObjectKey = client.internals.patchLiveObjectKey,
+    liveNodeToJson = client.internals.liveNodeToJson;
 var ACTION_TYPES = {
   ENTER: "@@LIVEBLOCKS/ENTER",
   LEAVE: "@@LIVEBLOCKS/LEAVE",
@@ -90,12 +93,12 @@ var ACTION_TYPES = {
   UPDATE_OTHERS: "@@LIVEBLOCKS/UPDATE_OTHERS"
 };
 
-var internalPlugin = function internalPlugin(options) {
+var internalEnhancer = function internalEnhancer(options) {
   if (process.env.NODE_ENV !== "production" && options.client == null) {
     throw missingClient();
   }
 
-  var client$1 = options.client;
+  var client = options.client;
   var mapping = validateMapping(options.storageMapping, "storageMapping");
   var presenceMapping = validateMapping(options.presenceMapping || {}, "presenceMapping");
 
@@ -188,7 +191,7 @@ var internalPlugin = function internalPlugin(options) {
           return;
         }
 
-        room = client$1.enter(roomId);
+        room = client.enter(roomId);
         broadcastInitialPresence(room, reduxState, presenceMapping);
         unsubscribeCallbacks.push(room.subscribe("connection", function () {
           store.dispatch({
@@ -209,14 +212,14 @@ var internalPlugin = function internalPlugin(options) {
           var root = _ref.root;
           var updates = {};
           room.batch(function () {
-            for (var key in mapping) {
-              var liveblocksStatePart = root.get(key);
+            for (var _key in mapping) {
+              var liveblocksStatePart = root.get(_key);
 
               if (liveblocksStatePart == null) {
-                updates[key] = storageInitialState[key];
-                client.patchLiveObjectKey(root, key, undefined, storageInitialState[key]);
+                updates[_key] = storageInitialState[_key];
+                patchLiveObjectKey(root, _key, undefined, storageInitialState[_key]);
               } else {
-                updates[key] = client.liveNodeToJson(liveblocksStatePart);
+                updates[_key] = liveNodeToJson(liveblocksStatePart);
               }
             }
           });
@@ -248,7 +251,7 @@ var internalPlugin = function internalPlugin(options) {
         room = null;
         isPatching = false;
         unsubscribeCallbacks = [];
-        client$1.leave(roomId);
+        client.leave(roomId);
       }
 
       function newDispatch(action, state) {
@@ -268,6 +271,11 @@ var internalPlugin = function internalPlugin(options) {
   };
 };
 
+var actions = {
+  enterRoom: enterRoom,
+  leaveRoom: leaveRoom
+};
+
 function enterRoom(roomId, initialState) {
   return {
     type: ACTION_TYPES.ENTER,
@@ -275,44 +283,46 @@ function enterRoom(roomId, initialState) {
     initialState: initialState
   };
 }
+
 function leaveRoom(roomId) {
   return {
     type: ACTION_TYPES.LEAVE,
     roomId: roomId
   };
 }
-var enhancer = internalPlugin;
+
+var enhancer = internalEnhancer;
 
 function patchLiveblocksStorage(root, oldState, newState, mapping) {
-  for (var key in mapping) {
-    if (process.env.NODE_ENV !== "production" && typeof newState[key] === "function") {
+  for (var _key2 in mapping) {
+    if (process.env.NODE_ENV !== "production" && typeof newState[_key2] === "function") {
       throw mappingToFunctionIsNotAllowed("value");
     }
 
-    if (oldState[key] !== newState[key]) {
-      client.patchLiveObjectKey(root, key, oldState[key], newState[key]);
+    if (oldState[_key2] !== newState[_key2]) {
+      patchLiveObjectKey(root, _key2, oldState[_key2], newState[_key2]);
     }
   }
 }
 
 function broadcastInitialPresence(room, state, mapping) {
-  for (var key in mapping) {
+  for (var _key3 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[_key3] = state[_key3], _room$updatePresence));
   }
 }
 
 function updatePresence(room, oldState, newState, presenceMapping) {
-  for (var key in presenceMapping) {
-    if (typeof newState[key] === "function") {
+  for (var _key4 in presenceMapping) {
+    if (typeof newState[_key4] === "function") {
       throw mappingToFunctionIsNotAllowed("value");
     }
 
-    if (oldState[key] !== newState[key]) {
+    if (oldState[_key4] !== newState[_key4]) {
       var _room$updatePresence2;
 
-      room.updatePresence((_room$updatePresence2 = {}, _room$updatePresence2[key] = newState[key], _room$updatePresence2));
+      room.updatePresence((_room$updatePresence2 = {}, _room$updatePresence2[_key4] = newState[_key4], _room$updatePresence2));
     }
   }
 }
@@ -322,9 +332,9 @@ function isObject(value) {
 }
 
 function validateNoDuplicateKeys(storageMapping, presenceMapping) {
-  for (var key in storageMapping) {
-    if (presenceMapping[key] !== undefined) {
-      throw mappingShouldNotHaveTheSameKeys(key);
+  for (var _key5 in storageMapping) {
+    if (presenceMapping[_key5] !== undefined) {
+      throw mappingShouldNotHaveTheSameKeys(_key5);
     }
   }
 }
@@ -332,15 +342,15 @@ function validateNoDuplicateKeys(storageMapping, presenceMapping) {
 function patchState(state, updates, mapping) {
   var partialState = {};
 
-  for (var key in mapping) {
-    partialState[key] = state[key];
+  for (var _key6 in mapping) {
+    partialState[_key6] = state[_key6];
   }
 
-  var patched = client.patchImmutableObject(partialState, updates);
+  var patched = patchImmutableObject(partialState, updates);
   var result = {};
 
-  for (var _key in mapping) {
-    result[_key] = patched[_key];
+  for (var _key7 in mapping) {
+    result[_key7] = patched[_key7];
   }
 
   return result;
@@ -359,19 +369,18 @@ 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;
     }
   }
 
   return result;
 }
 
+exports.actions = actions;
 exports.enhancer = enhancer;
-exports.enterRoom = enterRoom;
-exports.leaveRoom = leaveRoom;

package/package.json

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