@liveblocks/zustand 0.15.0-alpha.2 → 0.15.0-alpha.3

package/lib/esm/{index.js.js → index.js}

@@ -1,5 +1,25 @@
 import { patchLiveObjectKey, liveNodeToJson, patchImmutableObject } from '@liveblocks/client';
 
+const ERROR_PREFIX = "Invalid @liveblocks/zustand 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.`);
+}
+function mappingValueShouldBeABoolean(mappingType, key) {
+  return new Error(`${ERROR_PREFIX} ${mappingType}.${key} value should be a boolean`);
+}
+function mappingShouldNotHaveTheSameKeys(key) {
+  return new Error(`${ERROR_PREFIX} "${key}" is mapped on presenceMapping and storageMapping. A key shouldn't exist on both mapping.`);
+}
+function mappingToFunctionIsNotAllowed(key) {
+  return new Error(`${ERROR_PREFIX} mapping.${key} is invalid. Mapping to a function is not allowed.`);
+}
+
 var __defProp = Object.defineProperty;
 var __defProps = Object.defineProperties;
 var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
@@ -19,17 +39,16 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-const middleware = (config, {
-  client,
-  storageMapping: unvalidatedMapping,
-  presenceMapping: unvalidatedPresenceMapping = {}
-}) => {
-  if (client == null) {
-    throw new Error(`${ERROR_PREFIX} client is missing`);
+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 presenceMapping = validateMapping(options.presenceMapping || {}, "presenceMapping");
+  if (process.env.NODE_ENV !== "production") {
+    validateNoDuplicateKeys(mapping, presenceMapping);
   }
-  const mapping = validateMapping(unvalidatedMapping, "storageMapping");
-  const presenceMapping = validateMapping(unvalidatedPresenceMapping, "presenceMapping");
-  validateNoDuplicateKeys(mapping, presenceMapping);
   return (set, get, api) => {
     const typedSet = set;
     let room = null;
@@ -117,7 +136,7 @@ const middleware = (config, {
       }
     });
   };
-};
+}
 function patchState(state, updates, mapping) {
   const partialState = {};
   for (const key in mapping) {
@@ -140,6 +159,9 @@ function broadcastInitialPresence(room, state, mapping) {
 }
 function updatePresence(room, oldState, newState, presenceMapping) {
   for (const key in presenceMapping) {
+    if (typeof newState[key] === "function") {
+      throw mappingToFunctionIsNotAllowed("value");
+    }
     if (oldState[key] !== newState[key]) {
       room.updatePresence({ [key]: newState[key] });
     }
@@ -147,6 +169,9 @@ function updatePresence(room, oldState, newState, presenceMapping) {
 }
 function patchLiveblocksStorage(root, oldState, newState, mapping) {
   for (const key in mapping) {
+    if (process.env.NODE_ENV !== "production" && typeof newState[key] === "function") {
+      throw mappingToFunctionIsNotAllowed("value");
+    }
     if (oldState[key] !== newState[key]) {
       patchLiveObjectKey(root, key, oldState[key], newState[key]);
     }
@@ -158,21 +183,23 @@ function isObject(value) {
 function validateNoDuplicateKeys(storageMapping, presenceMapping) {
   for (const key in storageMapping) {
     if (presenceMapping[key] !== void 0) {
-      throw new Error(`${ERROR_PREFIX} "${key}" is mapped on presenceMapping and storageMapping. A key shouldn't exist on both mapping.`);
+      throw mappingShouldNotHaveTheSameKeys(key);
     }
   }
 }
 function validateMapping(mapping, mappingType) {
-  if (mapping == null) {
-    throw new Error(`${ERROR_PREFIX} ${mappingType} is missing.`);
-  }
-  if (!isObject(mapping)) {
-    throw new Error(`${ERROR_PREFIX} ${mappingType} should be an object where the values are boolean.`);
+  if (process.env.NODE_ENV !== "production") {
+    if (mapping == null) {
+      throw missingMapping(mappingType);
+    }
+    if (!isObject(mapping)) {
+      throw mappingShouldBeAnObject(mappingType);
+    }
   }
   const result = {};
   for (const key in mapping) {
-    if (typeof mapping[key] !== "boolean") {
-      throw new Error(`${ERROR_PREFIX} ${mappingType}.${key} value should be a boolean`);
+    if (process.env.NODE_ENV !== "production" && typeof mapping[key] !== "boolean") {
+      throw mappingValueShouldBeABoolean(mappingType, key);
     }
     if (mapping[key] === true) {
       result[key] = true;
@@ -180,6 +207,5 @@ function validateMapping(mapping, mappingType) {
   }
   return result;
 }
-const ERROR_PREFIX = "Invalid @liveblocks/zustand middleware config.";
 
 export { middleware };

package/lib/esm/{index.js.mjs → index.mjs}

@@ -1,5 +1,25 @@
 import { patchLiveObjectKey, liveNodeToJson, patchImmutableObject } from '@liveblocks/client';
 
+const ERROR_PREFIX = "Invalid @liveblocks/zustand 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.`);
+}
+function mappingValueShouldBeABoolean(mappingType, key) {
+  return new Error(`${ERROR_PREFIX} ${mappingType}.${key} value should be a boolean`);
+}
+function mappingShouldNotHaveTheSameKeys(key) {
+  return new Error(`${ERROR_PREFIX} "${key}" is mapped on presenceMapping and storageMapping. A key shouldn't exist on both mapping.`);
+}
+function mappingToFunctionIsNotAllowed(key) {
+  return new Error(`${ERROR_PREFIX} mapping.${key} is invalid. Mapping to a function is not allowed.`);
+}
+
 var __defProp = Object.defineProperty;
 var __defProps = Object.defineProperties;
 var __getOwnPropDescs = Object.getOwnPropertyDescriptors;
@@ -19,17 +39,16 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
-const middleware = (config, {
-  client,
-  storageMapping: unvalidatedMapping,
-  presenceMapping: unvalidatedPresenceMapping = {}
-}) => {
-  if (client == null) {
-    throw new Error(`${ERROR_PREFIX} client is missing`);
+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 presenceMapping = validateMapping(options.presenceMapping || {}, "presenceMapping");
+  if (process.env.NODE_ENV !== "production") {
+    validateNoDuplicateKeys(mapping, presenceMapping);
   }
-  const mapping = validateMapping(unvalidatedMapping, "storageMapping");
-  const presenceMapping = validateMapping(unvalidatedPresenceMapping, "presenceMapping");
-  validateNoDuplicateKeys(mapping, presenceMapping);
   return (set, get, api) => {
     const typedSet = set;
     let room = null;
@@ -117,7 +136,7 @@ const middleware = (config, {
       }
     });
   };
-};
+}
 function patchState(state, updates, mapping) {
   const partialState = {};
   for (const key in mapping) {
@@ -140,6 +159,9 @@ function broadcastInitialPresence(room, state, mapping) {
 }
 function updatePresence(room, oldState, newState, presenceMapping) {
   for (const key in presenceMapping) {
+    if (typeof newState[key] === "function") {
+      throw mappingToFunctionIsNotAllowed("value");
+    }
     if (oldState[key] !== newState[key]) {
       room.updatePresence({ [key]: newState[key] });
     }
@@ -147,6 +169,9 @@ function updatePresence(room, oldState, newState, presenceMapping) {
 }
 function patchLiveblocksStorage(root, oldState, newState, mapping) {
   for (const key in mapping) {
+    if (process.env.NODE_ENV !== "production" && typeof newState[key] === "function") {
+      throw mappingToFunctionIsNotAllowed("value");
+    }
     if (oldState[key] !== newState[key]) {
       patchLiveObjectKey(root, key, oldState[key], newState[key]);
     }
@@ -158,21 +183,23 @@ function isObject(value) {
 function validateNoDuplicateKeys(storageMapping, presenceMapping) {
   for (const key in storageMapping) {
     if (presenceMapping[key] !== void 0) {
-      throw new Error(`${ERROR_PREFIX} "${key}" is mapped on presenceMapping and storageMapping. A key shouldn't exist on both mapping.`);
+      throw mappingShouldNotHaveTheSameKeys(key);
     }
   }
 }
 function validateMapping(mapping, mappingType) {
-  if (mapping == null) {
-    throw new Error(`${ERROR_PREFIX} ${mappingType} is missing.`);
-  }
-  if (!isObject(mapping)) {
-    throw new Error(`${ERROR_PREFIX} ${mappingType} should be an object where the values are boolean.`);
+  if (process.env.NODE_ENV !== "production") {
+    if (mapping == null) {
+      throw missingMapping(mappingType);
+    }
+    if (!isObject(mapping)) {
+      throw mappingShouldBeAnObject(mappingType);
+    }
   }
   const result = {};
   for (const key in mapping) {
-    if (typeof mapping[key] !== "boolean") {
-      throw new Error(`${ERROR_PREFIX} ${mappingType}.${key} value should be a boolean`);
+    if (process.env.NODE_ENV !== "production" && typeof mapping[key] !== "boolean") {
+      throw mappingValueShouldBeABoolean(mappingType, key);
     }
     if (mapping[key] === true) {
       result[key] = true;
@@ -180,6 +207,5 @@ function validateMapping(mapping, mappingType) {
   }
   return result;
 }
-const ERROR_PREFIX = "Invalid @liveblocks/zustand middleware config.";
 
 export { middleware };

package/lib/index.d.ts

@@ -1,20 +1,55 @@
 import { StateCreator, SetState, GetState, StoreApi } from "zustand";
 import { Client, User, Room } from "@liveblocks/client";
 export declare type LiveblocksState<TState, TPresence = any> = TState & {
+    /**
+     * Liveblocks extra state attached by the middleware
+     */
     readonly liveblocks: {
-        readonly enterRoom: (room: string, initialState: Partial<TState>) => void;
-        readonly leaveRoom: (room: string) => void;
+        /**
+         * 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.
+         */
+        readonly enterRoom: (roomId: string, initialState: Partial<TState>) => void;
+        /**
+         * Leaves a room and stops sync it with zustand state.
+         * @param roomId The id of the room
+         */
+        readonly leaveRoom: (roomId: string) => void;
+        /**
+         * The room currently synced to your zustand state.
+         */
         readonly room: Room | null;
+        /**
+         * Other users in the room. Empty no room is currently synced
+         */
         readonly others: Array<User<TPresence>>;
+        /**
+         * Whether or not the room storage is currently loading
+         */
         readonly isStorageLoading: boolean;
+        /**
+         * Connection state of the room
+         */
         readonly connection: "closed" | "authenticating" | "unavailable" | "failed" | "open" | "connecting";
     };
 };
 export declare type Mapping<T> = Partial<{
     [Property in keyof T]: boolean;
 }>;
-export declare const middleware: <T extends Object, TPresence extends Object = any>(config: StateCreator<T, SetState<T>, GetState<LiveblocksState<T>>, StoreApi<T>>, options: {
+declare type Options<T> = {
+    /**
+     * Liveblocks client created by @liveblocks/client createClient
+     */
     client: Client;
+    /**
+     * Mapping used to synchronize a part of your zustand state with one Liveblocks Room storage.
+     */
     storageMapping: Mapping<T>;
+    /**
+     * Mapping used to synchronize a part of your zustand state with one Liveblocks Room presence.
+     */
     presenceMapping?: Mapping<T>;
-}) => StateCreator<LiveblocksState<T, TPresence>, SetState<LiveblocksState<T, TPresence>>, GetState<LiveblocksState<T, TPresence>>, StoreApi<LiveblocksState<T, TPresence>>>;
+};
+export declare function middleware<T extends Object, TPresence extends Object = any>(config: StateCreator<T, SetState<T>, GetState<LiveblocksState<T>>, StoreApi<T>>, options: Options<T>): StateCreator<LiveblocksState<T, TPresence>, SetState<LiveblocksState<T, TPresence>>, GetState<LiveblocksState<T, TPresence>>, StoreApi<LiveblocksState<T, TPresence>>>;
+export {};

package/lib/index.js

@@ -60,19 +60,39 @@ function _createForOfIteratorHelperLoose(o, allowArrayLike) {
   throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
 }
 
-var middleware = function middleware(config, _ref) {
-  var client$1 = _ref.client,
-      unvalidatedMapping = _ref.storageMapping,
-      _ref$presenceMapping = _ref.presenceMapping,
-      unvalidatedPresenceMapping = _ref$presenceMapping === void 0 ? {} : _ref$presenceMapping;
-
-  if (client$1 == null) {
-    throw new Error(ERROR_PREFIX + " client is missing");
+var ERROR_PREFIX = "Invalid @liveblocks/zustand 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.");
+}
+function mappingValueShouldBeABoolean(mappingType, key) {
+  return new Error(ERROR_PREFIX + " " + mappingType + "." + key + " value should be a boolean");
+}
+function mappingShouldNotHaveTheSameKeys(key) {
+  return new Error(ERROR_PREFIX + " \"" + key + "\" is mapped on presenceMapping and storageMapping. A key shouldn't exist on both mapping.");
+}
+function mappingToFunctionIsNotAllowed(key) {
+  return new Error(ERROR_PREFIX + " mapping." + key + " is invalid. Mapping to a function is not allowed.");
+}
+
+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 presenceMapping = validateMapping(options.presenceMapping || {}, "presenceMapping");
+
+  if (process.env.NODE_ENV !== "production") {
+    validateNoDuplicateKeys(mapping, presenceMapping);
   }
 
-  var mapping = validateMapping(unvalidatedMapping, "storageMapping");
-  var presenceMapping = validateMapping(unvalidatedPresenceMapping, "presenceMapping");
-  validateNoDuplicateKeys(mapping, presenceMapping);
   return function (set, get, api) {
     var typedSet = set;
     var room = null;
@@ -118,8 +138,8 @@ var middleware = function middleware(config, _ref) {
           connection: room.getConnectionState()
         });
       }));
-      room.getStorage().then(function (_ref2) {
-        var root = _ref2.root;
+      room.getStorage().then(function (_ref) {
+        var root = _ref.root;
         var updates = {};
         room.batch(function () {
           for (var key in mapping) {
@@ -178,7 +198,7 @@ var middleware = function middleware(config, _ref) {
       }
     });
   };
-};
+}
 
 function patchState(state, updates, mapping) {
   var partialState = {};
@@ -215,6 +235,10 @@ function broadcastInitialPresence(room, state, mapping) {
 
 function updatePresence(room, oldState, newState, presenceMapping) {
   for (var key in presenceMapping) {
+    if (typeof newState[key] === "function") {
+      throw mappingToFunctionIsNotAllowed("value");
+    }
+
     if (oldState[key] !== newState[key]) {
       var _room$updatePresence2;
 
@@ -225,6 +249,10 @@ function updatePresence(room, oldState, newState, presenceMapping) {
 
 function patchLiveblocksStorage(root, oldState, newState, mapping) {
   for (var key in mapping) {
+    if (process.env.NODE_ENV !== "production" && typeof newState[key] === "function") {
+      throw mappingToFunctionIsNotAllowed("value");
+    }
+
     if (oldState[key] !== newState[key]) {
       client.patchLiveObjectKey(root, key, oldState[key], newState[key]);
     }
@@ -238,25 +266,27 @@ function isObject(value) {
 function validateNoDuplicateKeys(storageMapping, presenceMapping) {
   for (var key in storageMapping) {
     if (presenceMapping[key] !== undefined) {
-      throw new Error(ERROR_PREFIX + " \"" + key + "\" is mapped on presenceMapping and storageMapping. A key shouldn't exist on both mapping.");
+      throw mappingShouldNotHaveTheSameKeys(key);
     }
   }
 }
 
 function validateMapping(mapping, mappingType) {
-  if (mapping == null) {
-    throw new Error(ERROR_PREFIX + " " + mappingType + " is missing.");
-  }
+  if (process.env.NODE_ENV !== "production") {
+    if (mapping == null) {
+      throw missingMapping(mappingType);
+    }
 
-  if (!isObject(mapping)) {
-    throw new Error(ERROR_PREFIX + " " + mappingType + " should be an object where the values are boolean.");
+    if (!isObject(mapping)) {
+      throw mappingShouldBeAnObject(mappingType);
+    }
   }
 
   var result = {};
 
   for (var key in mapping) {
-    if (typeof mapping[key] !== "boolean") {
-      throw new Error(ERROR_PREFIX + " " + mappingType + "." + key + " value should be a boolean");
+    if (process.env.NODE_ENV !== "production" && typeof mapping[key] !== "boolean") {
+      throw mappingValueShouldBeABoolean(mappingType, key);
     }
 
     if (mapping[key] === true) {
@@ -267,6 +297,4 @@ function validateMapping(mapping, mappingType) {
   return result;
 }
 
-var ERROR_PREFIX = "Invalid @liveblocks/zustand middleware config.";
-
 exports.middleware = middleware;

package/package.json

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