@liveblocks/redux 0.15.0 → 0.15.4

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

@@ -4,9 +4,6 @@ const ERROR_PREFIX = "Invalid @liveblocks/redux middleware config.";
 function missingClient() {
   return new Error(`${ERROR_PREFIX} client is missing`);
 }
-function missingMapping(mappingType) {
-  return new Error(`${ERROR_PREFIX} ${mappingType} is missing.`);
-}
 function mappingShouldBeAnObject(mappingType) {
   return new Error(`${ERROR_PREFIX} ${mappingType} should be an object where the values are boolean.`);
 }
@@ -45,7 +42,7 @@ const ACTION_TYPES = {
   LEAVE: "@@LIVEBLOCKS/LEAVE",
   START_LOADING_STORAGE: "@@LIVEBLOCKS/START_LOADING_STORAGE",
   INIT_STORAGE: "@@LIVEBLOCKS/INIT_STORAGE",
-  PATCH_STORAGE: "@@LIVEBLOCKS/PATCH_STORAGE",
+  PATCH_REDUX_STATE: "@@LIVEBLOCKS/PATCH_REDUX_STATE",
   UPDATE_CONNECTION: "@@LIVEBLOCKS/UPDATE_CONNECTION",
   UPDATE_OTHERS: "@@LIVEBLOCKS/UPDATE_OTHERS"
 };
@@ -54,7 +51,7 @@ const internalEnhancer = (options) => {
     throw missingClient();
   }
   const client = options.client;
-  const mapping = validateMapping(options.storageMapping, "storageMapping");
+  const mapping = validateMapping(options.storageMapping || {}, "storageMapping");
   const presenceMapping = validateMapping(options.presenceMapping || {}, "presenceMapping");
   if (process.env.NODE_ENV !== "production") {
     validateNoDuplicateKeys(mapping, presenceMapping);
@@ -66,7 +63,7 @@ const internalEnhancer = (options) => {
     let unsubscribeCallbacks = [];
     const newReducer = (state, action) => {
       switch (action.type) {
-        case ACTION_TYPES.PATCH_STORAGE:
+        case ACTION_TYPES.PATCH_REDUX_STATE:
           return __spreadValues(__spreadValues({}, state), action.state);
         case ACTION_TYPES.INIT_STORAGE:
           return __spreadProps(__spreadValues(__spreadValues({}, state), action.state), {
@@ -138,6 +135,14 @@ const internalEnhancer = (options) => {
           others: others.toArray()
         });
       }));
+      unsubscribeCallbacks.push(room.subscribe("my-presence", () => {
+        if (isPatching === false) {
+          store.dispatch({
+            type: ACTION_TYPES.PATCH_REDUX_STATE,
+            state: patchPresenceState(room.getPresence(), presenceMapping)
+          });
+        }
+      }));
       store.dispatch({
         type: ACTION_TYPES.START_LOADING_STORAGE
       });
@@ -162,7 +167,7 @@ const internalEnhancer = (options) => {
         unsubscribeCallbacks.push(room.subscribe(root, (updates2) => {
           if (isPatching === false) {
             store.dispatch({
-              type: ACTION_TYPES.PATCH_STORAGE,
+              type: ACTION_TYPES.PATCH_REDUX_STATE,
               state: patchState(store.getState(), updates2, mapping)
             });
           }
@@ -246,6 +251,13 @@ function validateNoDuplicateKeys(storageMapping, presenceMapping) {
     }
   }
 }
+function patchPresenceState(presence, mapping) {
+  const partialState = {};
+  for (const key in mapping) {
+    partialState[key] = presence[key];
+  }
+  return partialState;
+}
 function patchState(state, updates, mapping) {
   const partialState = {};
   for (const key in mapping) {
@@ -260,9 +272,6 @@ function patchState(state, updates, mapping) {
 }
 function validateMapping(mapping, mappingType) {
   if (process.env.NODE_ENV !== "production") {
-    if (mapping == null) {
-      throw missingMapping(mappingType);
-    }
     if (!isObject(mapping)) {
       throw mappingShouldBeAnObject(mappingType);
     }

package/lib/esm/index.mjs

@@ -4,9 +4,6 @@ const ERROR_PREFIX = "Invalid @liveblocks/redux middleware config.";
 function missingClient() {
   return new Error(`${ERROR_PREFIX} client is missing`);
 }
-function missingMapping(mappingType) {
-  return new Error(`${ERROR_PREFIX} ${mappingType} is missing.`);
-}
 function mappingShouldBeAnObject(mappingType) {
   return new Error(`${ERROR_PREFIX} ${mappingType} should be an object where the values are boolean.`);
 }
@@ -45,7 +42,7 @@ const ACTION_TYPES = {
   LEAVE: "@@LIVEBLOCKS/LEAVE",
   START_LOADING_STORAGE: "@@LIVEBLOCKS/START_LOADING_STORAGE",
   INIT_STORAGE: "@@LIVEBLOCKS/INIT_STORAGE",
-  PATCH_STORAGE: "@@LIVEBLOCKS/PATCH_STORAGE",
+  PATCH_REDUX_STATE: "@@LIVEBLOCKS/PATCH_REDUX_STATE",
   UPDATE_CONNECTION: "@@LIVEBLOCKS/UPDATE_CONNECTION",
   UPDATE_OTHERS: "@@LIVEBLOCKS/UPDATE_OTHERS"
 };
@@ -54,7 +51,7 @@ const internalEnhancer = (options) => {
     throw missingClient();
   }
   const client = options.client;
-  const mapping = validateMapping(options.storageMapping, "storageMapping");
+  const mapping = validateMapping(options.storageMapping || {}, "storageMapping");
   const presenceMapping = validateMapping(options.presenceMapping || {}, "presenceMapping");
   if (process.env.NODE_ENV !== "production") {
     validateNoDuplicateKeys(mapping, presenceMapping);
@@ -66,7 +63,7 @@ const internalEnhancer = (options) => {
     let unsubscribeCallbacks = [];
     const newReducer = (state, action) => {
       switch (action.type) {
-        case ACTION_TYPES.PATCH_STORAGE:
+        case ACTION_TYPES.PATCH_REDUX_STATE:
           return __spreadValues(__spreadValues({}, state), action.state);
         case ACTION_TYPES.INIT_STORAGE:
           return __spreadProps(__spreadValues(__spreadValues({}, state), action.state), {
@@ -138,6 +135,14 @@ const internalEnhancer = (options) => {
           others: others.toArray()
         });
       }));
+      unsubscribeCallbacks.push(room.subscribe("my-presence", () => {
+        if (isPatching === false) {
+          store.dispatch({
+            type: ACTION_TYPES.PATCH_REDUX_STATE,
+            state: patchPresenceState(room.getPresence(), presenceMapping)
+          });
+        }
+      }));
       store.dispatch({
         type: ACTION_TYPES.START_LOADING_STORAGE
       });
@@ -162,7 +167,7 @@ const internalEnhancer = (options) => {
         unsubscribeCallbacks.push(room.subscribe(root, (updates2) => {
           if (isPatching === false) {
             store.dispatch({
-              type: ACTION_TYPES.PATCH_STORAGE,
+              type: ACTION_TYPES.PATCH_REDUX_STATE,
               state: patchState(store.getState(), updates2, mapping)
             });
           }
@@ -246,6 +251,13 @@ function validateNoDuplicateKeys(storageMapping, presenceMapping) {
     }
   }
 }
+function patchPresenceState(presence, mapping) {
+  const partialState = {};
+  for (const key in mapping) {
+    partialState[key] = presence[key];
+  }
+  return partialState;
+}
 function patchState(state, updates, mapping) {
   const partialState = {};
   for (const key in mapping) {
@@ -260,9 +272,6 @@ function patchState(state, updates, mapping) {
 }
 function validateMapping(mapping, mappingType) {
   if (process.env.NODE_ENV !== "production") {
-    if (mapping == null) {
-      throw missingMapping(mappingType);
-    }
     if (!isObject(mapping)) {
       throw mappingShouldBeAnObject(mappingType);
     }

package/lib/index.d.ts

@@ -49,7 +49,7 @@ declare function leaveRoom(roomId: string): {
 };
 export declare const enhancer: <T>(options: {
     client: Client;
-    storageMapping: Partial<{ [Property in keyof T]: boolean; }>;
+    storageMapping?: Partial<{ [Property in keyof T]: boolean; }> | undefined;
     presenceMapping?: Partial<{ [Property in keyof T]: boolean; }> | undefined;
 }) => StoreEnhancer;
 export {};

package/lib/index.js

@@ -64,9 +64,6 @@ var ERROR_PREFIX = "Invalid @liveblocks/redux middleware config.";
 function missingClient() {
   return new Error(ERROR_PREFIX + " client is missing");
 }
-function missingMapping(mappingType) {
-  return new Error(ERROR_PREFIX + " " + mappingType + " is missing.");
-}
 function mappingShouldBeAnObject(mappingType) {
   return new Error(ERROR_PREFIX + " " + mappingType + " should be an object where the values are boolean.");
 }
@@ -88,7 +85,7 @@ var ACTION_TYPES = {
   LEAVE: "@@LIVEBLOCKS/LEAVE",
   START_LOADING_STORAGE: "@@LIVEBLOCKS/START_LOADING_STORAGE",
   INIT_STORAGE: "@@LIVEBLOCKS/INIT_STORAGE",
-  PATCH_STORAGE: "@@LIVEBLOCKS/PATCH_STORAGE",
+  PATCH_REDUX_STATE: "@@LIVEBLOCKS/PATCH_REDUX_STATE",
   UPDATE_CONNECTION: "@@LIVEBLOCKS/UPDATE_CONNECTION",
   UPDATE_OTHERS: "@@LIVEBLOCKS/UPDATE_OTHERS"
 };
@@ -99,7 +96,7 @@ var internalEnhancer = function internalEnhancer(options) {
   }
 
   var client = options.client;
-  var mapping = validateMapping(options.storageMapping, "storageMapping");
+  var mapping = validateMapping(options.storageMapping || {}, "storageMapping");
   var presenceMapping = validateMapping(options.presenceMapping || {}, "presenceMapping");
 
   if (process.env.NODE_ENV !== "production") {
@@ -115,7 +112,7 @@ var internalEnhancer = function internalEnhancer(options) {
 
       var newReducer = function newReducer(state, action) {
         switch (action.type) {
-          case ACTION_TYPES.PATCH_STORAGE:
+          case ACTION_TYPES.PATCH_REDUX_STATE:
             return _extends({}, state, action.state);
 
           case ACTION_TYPES.INIT_STORAGE:
@@ -205,6 +202,14 @@ var internalEnhancer = function internalEnhancer(options) {
             others: others.toArray()
           });
         }));
+        unsubscribeCallbacks.push(room.subscribe("my-presence", function () {
+          if (isPatching === false) {
+            store.dispatch({
+              type: ACTION_TYPES.PATCH_REDUX_STATE,
+              state: patchPresenceState(room.getPresence(), presenceMapping)
+            });
+          }
+        }));
         store.dispatch({
           type: ACTION_TYPES.START_LOADING_STORAGE
         });
@@ -231,7 +236,7 @@ var internalEnhancer = function internalEnhancer(options) {
           unsubscribeCallbacks.push(room.subscribe(root, function (updates) {
             if (isPatching === false) {
               store.dispatch({
-                type: ACTION_TYPES.PATCH_STORAGE,
+                type: ACTION_TYPES.PATCH_REDUX_STATE,
                 state: patchState(store.getState(), updates, mapping)
               });
             }
@@ -339,18 +344,28 @@ function validateNoDuplicateKeys(storageMapping, presenceMapping) {
   }
 }
 
-function patchState(state, updates, mapping) {
+function patchPresenceState(presence, mapping) {
   var partialState = {};
 
   for (var _key6 in mapping) {
-    partialState[_key6] = state[_key6];
+    partialState[_key6] = presence[_key6];
+  }
+
+  return partialState;
+}
+
+function patchState(state, updates, mapping) {
+  var partialState = {};
+
+  for (var _key7 in mapping) {
+    partialState[_key7] = state[_key7];
   }
 
   var patched = patchImmutableObject(partialState, updates);
   var result = {};
 
-  for (var _key7 in mapping) {
-    result[_key7] = patched[_key7];
+  for (var _key8 in mapping) {
+    result[_key8] = patched[_key8];
   }
 
   return result;
@@ -358,10 +373,6 @@ function patchState(state, updates, mapping) {
 
 function validateMapping(mapping, mappingType) {
   if (process.env.NODE_ENV !== "production") {
-    if (mapping == null) {
-      throw missingMapping(mappingType);
-    }
-
     if (!isObject(mapping)) {
       throw mappingShouldBeAnObject(mappingType);
     }
@@ -369,13 +380,13 @@ function validateMapping(mapping, mappingType) {
 
   var result = {};
 
-  for (var _key8 in mapping) {
-    if (process.env.NODE_ENV !== "production" && typeof mapping[_key8] !== "boolean") {
-      throw mappingValueShouldBeABoolean(mappingType, _key8);
+  for (var _key9 in mapping) {
+    if (process.env.NODE_ENV !== "production" && typeof mapping[_key9] !== "boolean") {
+      throw mappingValueShouldBeABoolean(mappingType, _key9);
     }
 
-    if (mapping[_key8] === true) {
-      result[_key8] = true;
+    if (mapping[_key9] === true) {
+      result[_key9] = true;
     }
   }
 

package/package.json

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