@liveblocks/core 0.18.3-test2 → 0.18.4

package/dist/index.d.ts

@@ -367,6 +367,10 @@ declare type BaseUserMeta = {
      * Additional user information that has been set in the authentication endpoint.
      */
     info?: Json;
+    /**
+     * Permissions that the user has in the room.
+     */
+    scopes: string[];
 };
 
 declare enum OpCode {
@@ -639,6 +643,10 @@ declare type UserJoinServerMsg<TUserMeta extends BaseUserMeta> = {
      * endpoint.
      */
     info: TUserMeta["info"];
+    /**
+     * Permissions that the user has in the Room.
+     */
+    scopes: string[];
 };
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
@@ -858,6 +866,10 @@ declare type User<TPresence extends JsonObject, TUserMeta extends BaseUserMeta>
      * The user presence.
      */
     readonly presence: TPresence;
+    /**
+     * False if the user can modify the room storage, true otherwise.
+     */
+    readonly isReadOnly: boolean;
 };
 declare type AuthEndpointCallback = (room: string) => Promise<{
     token: string;
@@ -899,11 +911,13 @@ declare type Connection = {
     id: number;
     userId?: string;
     userInfo?: Json;
+    isReadOnly: boolean;
 } | {
     state: "open";
     id: number;
     userId?: string;
     userInfo?: Json;
+    isReadOnly: boolean;
 } | {
     state: "unavailable";
 } | {

package/dist/index.js

@@ -997,9 +997,13 @@ var LiveList = class extends AbstractCrdt {
     return this._items.length;
   }
   push(element) {
+    var _a;
+    (_a = this._pool) == null ? void 0 : _a.assertStorageIsWritable();
     return this.insert(element, this.length);
   }
   insert(element, index) {
+    var _a;
+    (_a = this._pool) == null ? void 0 : _a.assertStorageIsWritable();
     if (index < 0 || index > this._items.length) {
       throw new Error(
         `Cannot insert list item at index "${index}". index should be between 0 and ${this._items.length}`
@@ -1024,6 +1028,8 @@ var LiveList = class extends AbstractCrdt {
     }
   }
   move(index, targetIndex) {
+    var _a;
+    (_a = this._pool) == null ? void 0 : _a.assertStorageIsWritable();
     if (targetIndex < 0) {
       throw new Error("targetIndex cannot be less than 0");
     }
@@ -1077,6 +1083,8 @@ var LiveList = class extends AbstractCrdt {
     }
   }
   delete(index) {
+    var _a;
+    (_a = this._pool) == null ? void 0 : _a.assertStorageIsWritable();
     if (index < 0 || index >= this._items.length) {
       throw new Error(
         `Cannot delete list item at index "${index}". index should be between 0 and ${this._items.length - 1}`
@@ -1109,6 +1117,8 @@ var LiveList = class extends AbstractCrdt {
     }
   }
   clear() {
+    var _a;
+    (_a = this._pool) == null ? void 0 : _a.assertStorageIsWritable();
     if (this._pool) {
       const ops = [];
       const reverseOps = [];
@@ -1142,6 +1152,8 @@ var LiveList = class extends AbstractCrdt {
     }
   }
   set(index, item) {
+    var _a;
+    (_a = this._pool) == null ? void 0 : _a.assertStorageIsWritable();
     if (index < 0 || index >= this._items.length) {
       throw new Error(
         `Cannot set list item at index "${index}". index should be between 0 and ${this._items.length - 1}`
@@ -1446,6 +1458,8 @@ var LiveMap = class extends AbstractCrdt {
     return liveNodeToLson(value);
   }
   set(key, value) {
+    var _a;
+    (_a = this._pool) == null ? void 0 : _a.assertStorageIsWritable();
     const oldValue = this._map.get(key);
     if (oldValue) {
       oldValue._detach();
@@ -1479,6 +1493,8 @@ var LiveMap = class extends AbstractCrdt {
     return this._map.has(key);
   }
   delete(key) {
+    var _a;
+    (_a = this._pool) == null ? void 0 : _a.assertStorageIsWritable();
     const item = this._map.get(key);
     if (item === void 0) {
       return false;
@@ -1849,12 +1865,16 @@ var LiveObject = class extends AbstractCrdt {
     return fromEntries(this._map);
   }
   set(key, value) {
+    var _a;
+    (_a = this._pool) == null ? void 0 : _a.assertStorageIsWritable();
     this.update({ [key]: value });
   }
   get(key) {
     return this._map.get(key);
   }
   delete(key) {
+    var _a;
+    (_a = this._pool) == null ? void 0 : _a.assertStorageIsWritable();
     const keyAsString = key;
     const oldValue = this._map.get(keyAsString);
     if (oldValue === void 0) {
@@ -1903,6 +1923,8 @@ var LiveObject = class extends AbstractCrdt {
     );
   }
   update(patch) {
+    var _a;
+    (_a = this._pool) == null ? void 0 : _a.assertStorageIsWritable();
     if (this._pool === void 0 || this._id === void 0) {
       for (const key in patch) {
         const newValue = patch[key];
@@ -2545,11 +2567,12 @@ var OthersRef = class extends ImmutableRef {
     }
     this.invalidate();
   }
-  setConnection(connectionId, metaUserId, metaUserInfo) {
+  setConnection(connectionId, metaUserId, metaUserInfo, metaIsReadonly) {
     this._connections[connectionId] = freeze({
       connectionId,
       id: metaUserId,
-      info: metaUserInfo
+      info: metaUserInfo,
+      isReadOnly: metaIsReadonly
     });
     if (this._presences[connectionId] !== void 0) {
       this._invalidateUser(connectionId);
@@ -2666,6 +2689,13 @@ function makeStateMachine(state, config, mockedEffects) {
           notify({ storageUpdates }, doNotBatchUpdates);
         });
       }
+    },
+    assertStorageIsWritable: () => {
+      if (isConnectionSelfAware(state.connection.current) && state.connection.current.isReadOnly) {
+        throw new Error(
+          "Cannot write to storage with a read only user, please ensure the user has write permissions"
+        );
+      }
     }
   };
   const eventHub = {
@@ -2727,7 +2757,8 @@ function makeStateMachine(state, config, mockedEffects) {
       connectionId: conn.id,
       id: conn.userId,
       info: conn.userInfo,
-      presence: me
+      presence: me,
+      isReadOnly: conn.isReadOnly
     } : null
   );
   function createOrUpdateRootFromMessage(message, batchedUpdatesWrapper) {
@@ -3060,6 +3091,9 @@ function makeStateMachine(state, config, mockedEffects) {
       });
     }
   }
+  function isReadOnly(scopes) {
+    return scopes.includes("room:read" /* Read */) && scopes.includes("room:presence:write" /* PresenceWrite */) && !scopes.includes("room:write" /* Write */);
+  }
   function authenticationSuccess(token, socket) {
     socket.addEventListener("message", onMessage);
     socket.addEventListener("open", onOpen);
@@ -3070,7 +3104,8 @@ function makeStateMachine(state, config, mockedEffects) {
         state: "connecting",
         id: token.actor,
         userInfo: token.info,
-        userId: token.id
+        userId: token.id,
+        isReadOnly: isReadOnly(token.scopes)
       },
       batchUpdates
     );
@@ -3126,7 +3161,12 @@ function makeStateMachine(state, config, mockedEffects) {
     for (const key in message.users) {
       const user = message.users[key];
       const connectionId = Number(key);
-      state.others.setConnection(connectionId, user.id, user.info);
+      state.others.setConnection(
+        connectionId,
+        user.id,
+        user.info,
+        isReadOnly(user.scopes)
+      );
     }
     return { type: "reset" };
   }
@@ -3142,7 +3182,12 @@ function makeStateMachine(state, config, mockedEffects) {
     });
   }
   function onUserJoinedMessage(message) {
-    state.others.setConnection(message.actor, message.id, message.info);
+    state.others.setConnection(
+      message.actor,
+      message.id,
+      message.info,
+      isReadOnly(message.scopes)
+    );
     state.buffer.messages.push({
       type: 100 /* UPDATE_PRESENCE */,
       data: state.me.current,
@@ -3556,7 +3601,7 @@ function makeStateMachine(state, config, mockedEffects) {
     if (state.activeBatch) {
       return callback();
     }
-    let rv = void 0;
+    let returnValue = void 0;
     batchUpdates(() => {
       state.activeBatch = {
         ops: [],
@@ -3568,7 +3613,7 @@ function makeStateMachine(state, config, mockedEffects) {
         reverseOps: []
       };
       try {
-        rv = callback();
+        returnValue = callback();
       } finally {
         const currentBatch = state.activeBatch;
         state.activeBatch = null;
@@ -3585,7 +3630,7 @@ function makeStateMachine(state, config, mockedEffects) {
         tryFlushing();
       }
     });
-    return rv;
+    return returnValue;
   }
   function pauseHistory() {
     state.pausedHistory = [];
@@ -3748,7 +3793,7 @@ function prepareCreateWebSocket(liveblocksServer, WebSocketPolyfill) {
   const ws = WebSocketPolyfill || WebSocket;
   return (token) => {
     return new ws(
-      `${liveblocksServer}/?token=${token}&version=${true ? "0.18.3-test2" : "dev"}`
+      `${liveblocksServer}/?token=${token}&version=${true ? "0.18.4" : "dev"}`
     );
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/core",
-  "version": "0.18.3-test2",
+  "version": "0.18.4",
   "description": "Shared code and foundational internals for Liveblocks",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -19,23 +19,35 @@
     "url": "https://github.com/liveblocks/liveblocks/issues"
   },
   "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 --silent --verbose",
-    "test:watch": "jest --silent --verbose --watch",
+    "test": "jest --watch --silent --verbose --config=./jest.config.js",
+    "test-ci": "jest --silent --verbose",
     "test-e2e": "jest --silent --verbose --config=./jest.config.e2e.js"
   },
   "license": "Apache-2.0",
   "devDependencies": {
-    "@liveblocks/eslint-config": "*",
-    "@liveblocks/jest-config": "*",
+    "@types/jest": "^29.1.2",
+    "@types/node-fetch": "^2.6.1",
     "@types/ws": "^8.5.3",
+    "@typescript-eslint/eslint-plugin": "^5.26.0",
+    "@typescript-eslint/parser": "^5.26.0",
     "dotenv": "^16.0.3",
+    "eslint": "^8.12.0",
+    "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-rulesdir": "^0.2.1",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
     "fast-check": "^3.0.1",
-    "msw": "^0.47.4",
+    "jest": "^29.1.2",
+    "jest-environment-jsdom": "^29.1.2",
+    "msw": "^0.39.1",
+    "node-fetch": "2.6.7",
+    "prettier": "^2.7.1",
+    "ts-jest": "^29.0.3",
+    "tsup": "^6.2.2",
+    "typescript": "^4.7.2",
+    "whatwg-fetch": "^3.6.2",
     "ws": "^8.5.0"
   },
   "repository": {