@liveblocks/redux 0.18.4 → 0.19.0-beta0

package/dist/index.d.ts

@@ -1,57 +1,72 @@
-import { JsonObject, BaseUserMeta, User, Client } from '@liveblocks/client';
+import { JsonObject, BaseUserMeta, Client, User } from '@liveblocks/client';
 import { StoreEnhancer } from 'redux';
 
 declare type Mapping<T> = {
     [K in keyof T]?: boolean;
 };
-declare type LiveblocksState<TState, TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = TState & {
+declare type LiveblocksContext<TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = {
     /**
-     * Liveblocks extra state attached by the enhancer
+     * Other users in the room. Empty no room is currently synced
      */
-    readonly liveblocks: {
-        /**
-         * Other users in the room. Empty no room is currently synced
-         */
-        readonly others: Array<User<TPresence, TUserMeta>>;
-        /**
-         * 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";
-    };
+    readonly others: Array<User<TPresence, TUserMeta>>;
+    /**
+     * 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";
+};
+/**
+ * @deprecated Please rename to WithLiveblocks<...>
+ */
+declare type LiveblocksState<TState, TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = WithLiveblocks<TState, TPresence, TUserMeta>;
+/**
+ * Adds the `liveblocks` property to your custom Redux state.
+ */
+declare type WithLiveblocks<TState, TPresence extends JsonObject, TUserMeta extends BaseUserMeta> = TState & {
+    readonly liveblocks: LiveblocksContext<TPresence, TUserMeta>;
 };
 /**
  * Actions used to interact with Liveblocks
  */
 declare const actions: {
     /**
-     * Enters a room and starts sync it with zustand state
+     * Enters a room and starts sync it with Redux 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.
+     * Leaves a room and stops sync it with Redux state.
      * @param roomId The id of the room
      */
     leaveRoom: typeof leaveRoom;
 };
-declare function enterRoom<T>(roomId: string, initialState?: T): {
+declare function enterRoom(roomId: string): {
     type: string;
     roomId: string;
-    initialState?: T;
 };
 declare function leaveRoom(roomId: string): {
     type: string;
     roomId: string;
 };
+/**
+ * Redux store enhancer that will make the `liveblocks` key available on your
+ * Redux store.
+ */
+declare const liveblocksEnhancer: <T>(options: {
+    client: Client;
+    storageMapping?: Mapping<T> | undefined;
+    presenceMapping?: Mapping<T> | undefined;
+}) => StoreEnhancer;
+/**
+ * @deprecated Renamed to `liveblocksEnhancer`.
+ */
 declare const enhancer: <T>(options: {
     client: Client;
     storageMapping?: Mapping<T> | undefined;
     presenceMapping?: Mapping<T> | undefined;
 }) => StoreEnhancer;
 
-export { LiveblocksState, Mapping, actions, enhancer };
+export { LiveblocksState, Mapping, WithLiveblocks, actions, enhancer, liveblocksEnhancer };

package/dist/index.js

@@ -143,12 +143,15 @@ var internalEnhancer = (options) => {
       }
     };
     const store = createStore(newReducer, initialState, enhancer2);
-    function enterRoom2(roomId, storageInitialState = {}, reduxState) {
+    function enterRoom2(roomId) {
       if (storageRoot) {
         return;
       }
-      room = client.enter(roomId, { initialPresence: {} });
-      broadcastInitialPresence(room, reduxState, presenceMapping);
+      const initialPresence = selectFields(
+        store.getState(),
+        presenceMapping
+      );
+      room = client.enter(roomId, { initialPresence });
       unsubscribeCallbacks.push(
         room.events.connection.subscribe(() => {
           store.dispatch({
@@ -170,7 +173,7 @@ var internalEnhancer = (options) => {
           if (isPatching === false) {
             store.dispatch({
               type: ACTION_TYPES.PATCH_REDUX_STATE,
-              state: patchPresenceState(
+              state: selectFields(
                 room.getPresence(),
                 presenceMapping
               )
@@ -187,13 +190,8 @@ var internalEnhancer = (options) => {
           for (const key in mapping) {
             const liveblocksStatePart = root.get(key);
             if (liveblocksStatePart == null) {
-              updates[key] = storageInitialState[key];
-              _core.patchLiveObjectKey.call(void 0, 
-                root,
-                key,
-                void 0,
-                storageInitialState[key]
-              );
+              updates[key] = store.getState()[key];
+              _core.patchLiveObjectKey.call(void 0, root, key, void 0, store.getState()[key]);
             } else {
               updates[key] = _core.lsonToJson.call(void 0, liveblocksStatePart);
             }
@@ -236,7 +234,7 @@ var internalEnhancer = (options) => {
     }
     function newDispatch(action, state) {
       if (action.type === ACTION_TYPES.ENTER) {
-        enterRoom2(action.roomId, action.initialState, store.getState());
+        enterRoom2(action.roomId);
       } else if (action.type === ACTION_TYPES.LEAVE) {
         leaveRoom2(action.roomId);
       } else {
@@ -252,11 +250,10 @@ var actions = {
   enterRoom,
   leaveRoom
 };
-function enterRoom(roomId, initialState) {
+function enterRoom(roomId) {
   return {
     type: ACTION_TYPES.ENTER,
-    roomId,
-    initialState
+    roomId
   };
 }
 function leaveRoom(roomId) {
@@ -265,22 +262,20 @@ function leaveRoom(roomId) {
     roomId
   };
 }
-var enhancer = internalEnhancer;
+var liveblocksEnhancer = internalEnhancer;
+var enhancer = liveblocksEnhancer;
 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]) {
-      _core.patchLiveObjectKey.call(void 0, root, key, oldState[key], newState[key]);
+      const oldVal = oldState[key];
+      const newVal = newState[key];
+      _core.patchLiveObjectKey.call(void 0, root, key, oldVal, newVal);
     }
   }
 }
-function broadcastInitialPresence(room, state, mapping) {
-  for (const key in mapping) {
-    room == null ? void 0 : room.updatePresence({ [key]: state[key] });
-  }
-}
 function updatePresence(room, oldState, newState, presenceMapping) {
   for (const key in presenceMapping) {
     if (typeof newState[key] === "function") {
@@ -301,7 +296,7 @@ function validateNoDuplicateKeys(storageMapping, presenceMapping) {
     }
   }
 }
-function patchPresenceState(presence, mapping) {
+function selectFields(presence, mapping) {
   const partialState = {};
   for (const key in mapping) {
     partialState[key] = presence[key];
@@ -340,4 +335,5 @@ function validateMapping(mapping, mappingType) {
 
 
 
-exports.actions = actions; exports.enhancer = enhancer;
+
+exports.actions = actions; exports.enhancer = enhancer; exports.liveblocksEnhancer = liveblocksEnhancer;

package/dist/index.mjs

@@ -3,3 +3,4 @@ import mod from "./index.js";
 export default mod;
 export const actions = mod.actions;
 export const enhancer = mod.enhancer;
+export const liveblocksEnhancer = mod.liveblocksEnhancer;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/redux",
-  "version": "0.18.4",
+  "version": "0.19.0-beta0",
   "description": "A store enhancer to integrate Liveblocks into Redux stores.",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -18,12 +18,12 @@
     "collaborative"
   ],
   "scripts": {
+    "dev": "tsup --watch --onSuccess ../../scripts/build.sh",
     "build": "tsup && ../../scripts/build.sh",
     "format": "eslint --fix src/ && prettier --write src/",
     "lint": "eslint src/",
-    "test": "jest --watch --silent --verbose",
-    "test-ci": "jest --silent --verbose",
-    "dtslint": "dtslint --localTs node_modules/typescript/lib --expectOnly types"
+    "test": "jest --silent --verbose",
+    "test:watch": "jest --silent --verbose --watch"
   },
   "license": "Apache-2.0",
   "repository": {
@@ -32,31 +32,19 @@
     "directory": "packages/liveblocks-redux"
   },
   "dependencies": {
-    "@liveblocks/core": "0.18.4",
-    "@liveblocks/client": "0.18.4"
+    "@liveblocks/client": "0.19.0-beta0",
+    "@liveblocks/core": "0.19.0-beta0"
   },
   "peerDependencies": {
     "redux": "^4"
   },
   "devDependencies": {
-    "@definitelytyped/dtslint": "^0.0.103",
+    "@liveblocks/eslint-config": "*",
+    "@liveblocks/jest-config": "*",
     "@reduxjs/toolkit": "^1.7.2",
     "@testing-library/jest-dom": "^5.16.5",
-    "@types/jest": "^29.1.2",
-    "@typescript-eslint/eslint-plugin": "^5.26.0",
-    "@typescript-eslint/parser": "^5.26.0",
-    "eslint": "^8.12.0",
-    "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-simple-import-sort": "^7.0.0",
-    "jest": "^29.1.2",
-    "jest-environment-jsdom": "^29.1.2",
     "msw": "^0.36.4",
-    "prettier": "^2.7.1",
-    "redux": "^4.1.2",
-    "ts-jest": "^29.0.3",
-    "tsup": "^6.2.2",
-    "typescript": "^4.7.2",
-    "whatwg-fetch": "^3.6.2"
+    "redux": "^4.1.2"
   },
   "sideEffects": false
 }

package/dist/.built-by-link-script

@@ -1 +0,0 @@
-db5ed9af49cb3b74907a11800c64d721bda1fd95