@liveblocks/core 1.2.0-internal2 → 1.2.0-internal3

package/dist/index.d.ts

@@ -703,9 +703,16 @@ declare type User<TPresence extends JsonObject, TUserMeta extends BaseUserMeta>
      */
     readonly presence: TPresence;
     /**
-     * False if the user can modify the room storage, true otherwise.
+     * @deprecated Use `!user.canWrite` instead.
+     * False if the user can mutate the Room’s Storage and/or YDoc, true if they
+     * can only read but not mutate it.
      */
     readonly isReadOnly: boolean;
+    /**
+     * True if the user can mutate the Room’s Storage and/or YDoc, false if they
+     * can only read but not mutate it.
+     */
+    readonly canWrite: boolean;
 };
 
 /**
@@ -1548,6 +1555,33 @@ declare enum ServerMsgCode {
     REJECT_STORAGE_OP = 299,
     UPDATE_YDOC = 300
 }
+/**
+ * Traits are bitflags that are used at the protocol level to communicate what
+ * traits a given User has. Traits may or may not map to official permissions.
+ * Users cannot see each other's true permissions, but they can see each
+ * other's traits.
+ *
+ * Traits are not a security feature, but should only be used to optimize the
+ * app experience (e.g. to visually indicate that another connected user has no
+ * write access to the document).
+ */
+declare enum Traits {
+    None = 0,
+    /**
+     * Whether the user has write access to Storage™ + YDoc.
+     * Maps to the public `User.canWrite` property.
+     */
+    CanWriteDocument = 1,
+    /**
+     * Whether the user has access to Comments™.
+     * Maps to the public `User.canComment` property.
+     */
+    CanWriteComments = 2,
+    /**
+     * Convenience accessor only, where all the bitflags are enabled.
+     */
+    All = 3
+}
 /**
  * Messages that can be sent from the server to the client.
  */
@@ -1622,9 +1656,10 @@ declare type UserJoinServerMsg<TUserMeta extends BaseUserMeta> = {
      */
     readonly info: TUserMeta["info"];
     /**
-     * Permissions that the user has in the Room.
+     * Informs the client what Traits this (other) User has.
+     * @since v1.2 (WS API v7)
      */
-    readonly scopes: string[];
+    readonly traits: Traits;
 };
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
@@ -1665,9 +1700,19 @@ declare type BroadcastedEventServerMsg<TRoomEvent extends Json> = {
  */
 declare type RoomStateServerMsg<TUserMeta extends BaseUserMeta> = {
     readonly type: ServerMsgCode.ROOM_STATE;
+    /**
+     * Informs the client what their actor ID is going to be.
+     * @since v1.2 (WS API v7)
+     */
+    readonly actor: number;
+    /**
+     * Informs the client what Traits the current User (self) has.
+     * @since v1.2 (WS API v7)
+     */
+    readonly traits: Traits;
     readonly users: {
-        readonly [actor: number]: TUserMeta & {
-            scopes: string[];
+        readonly [otherActor: number]: TUserMeta & {
+            traits: Traits;
         };
     };
 };
@@ -1890,4 +1935,4 @@ declare type EnsureJson<T> = [
     [K in keyof T]: EnsureJson<T[K]>;
 };
 
-export { AckOp, BaseAuthResult, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, Delegates, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, FetchStorageClientMsg, FetchYDocClientMsg, History, IWebSocket, IWebSocketCloseEvent, IWebSocketEvent, IWebSocketInstance, IWebSocketMessageEvent, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LegacyConnectionStatus, LiveList, LiveListUpdate, LiveMap, LiveMapUpdate, LiveNode, LiveObject, LiveObjectUpdate, LiveStructure, LostConnectionEvent, Lson, LsonObject, NodeMap, Op, OpCode, Others, ParentToChildNodeMap, PlainLson, PlainLsonFields, PlainLsonList, PlainLsonMap, PlainLsonObject, RejectedStorageOpServerMsg, Resolve, Room, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, Status, StorageStatus, StorageUpdate, ToImmutable, ToJson, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UpdateYDocClientMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, asArrayWithLegacyMethods, asPos, assert, assertNever, b64decode, createClient, deprecate, deprecateIf, errorIf, freeze, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isPlainObject, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makePosition, nn, patchLiveObjectKey, shallow, throwUsageError, toPlainLson, tryParseJson, withTimeout };
+export { AckOp, BaseAuthResult, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, Delegates, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, FetchStorageClientMsg, FetchYDocClientMsg, History, IWebSocket, IWebSocketCloseEvent, IWebSocketEvent, IWebSocketInstance, IWebSocketMessageEvent, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonArray, JsonObject, JsonScalar, LegacyConnectionStatus, LiveList, LiveListUpdate, LiveMap, LiveMapUpdate, LiveNode, LiveObject, LiveObjectUpdate, LiveStructure, LostConnectionEvent, Lson, LsonObject, NodeMap, Op, OpCode, Others, ParentToChildNodeMap, PlainLson, PlainLsonFields, PlainLsonList, PlainLsonMap, PlainLsonObject, RejectedStorageOpServerMsg, Resolve, Room, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, Status, StorageStatus, StorageUpdate, ToImmutable, ToJson, Traits, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, UpdateYDocClientMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, asArrayWithLegacyMethods, asPos, assert, assertNever, b64decode, createClient, deprecate, deprecateIf, errorIf, freeze, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isPlainObject, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makePosition, nn, patchLiveObjectKey, shallow, throwUsageError, toPlainLson, tryParseJson, withTimeout };

package/dist/index.js

@@ -145,7 +145,7 @@ var onMessageFromPanel = eventSource.observable;
 // src/devtools/index.ts
 var VERSION = true ? (
   /* istanbul ignore next */
-  "1.2.0-internal2"
+  "1.2.0-internal3"
 ) : "dev";
 var _devtoolsSetupHasRun = false;
 function setupDevTools(getAllRooms) {
@@ -4025,7 +4025,19 @@ var ImmutableRef = class {
 
 // src/refs/OthersRef.ts
 function makeUser(conn, presence) {
-  return freeze(compactObject(__spreadProps(__spreadValues({}, conn), { presence })));
+  const { connectionId, id, info, traits } = conn;
+  const canWrite = (traits & 1 /* CanWriteDocument */) === 1 /* CanWriteDocument */;
+  return freeze(
+    compactObject({
+      connectionId,
+      id,
+      info,
+      canWrite,
+      isReadOnly: !canWrite,
+      // Deprecated, kept for backward-compatibility
+      presence
+    })
+  );
 }
 var OthersRef = class extends ImmutableRef {
   //
@@ -4084,12 +4096,12 @@ var OthersRef = class extends ImmutableRef {
    * Records a known connection. This records the connection ID and the
    * associated metadata.
    */
-  setConnection(connectionId, metaUserId, metaUserInfo, metaIsReadonly) {
+  setConnection(connectionId, traits, metaUserId, metaUserInfo) {
     this._connections[connectionId] = freeze({
-      connectionId,
       id: metaUserId,
       info: metaUserInfo,
-      isReadOnly: metaIsReadonly
+      connectionId,
+      traits
     });
     if (this._presences[connectionId] !== void 0) {
       this._invalidateUser(connectionId);
@@ -4236,8 +4248,9 @@ function createRoom(options, config) {
       messages: [],
       storageOperations: []
     },
-    sessionInfo: new ValueRef(null),
-    me: new PatchableRef(initialPresence),
+    staticSessionInfo: new ValueRef(null),
+    dynamicSessionInfo: new ValueRef(null),
+    myPresence: new PatchableRef(initialPresence),
     others: new OthersRef(),
     initialStorage,
     idFactory: null,
@@ -4261,12 +4274,9 @@ function createRoom(options, config) {
     var _a2;
     const token = (_a2 = managedSocket.token) == null ? void 0 : _a2.parsed;
     if (token !== void 0 && token !== lastToken) {
-      context.sessionInfo.set({
+      context.staticSessionInfo.set({
         userInfo: token.info,
-        userId: token.id,
-        // NOTE: In the future, these fields will get assigned in the connection phase
-        actor: token.actor,
-        isReadOnly: isStorageReadOnly(token.scopes)
+        userId: token.id
       });
       lastToken = token;
     }
@@ -4304,20 +4314,15 @@ function createRoom(options, config) {
     }
   }
   function onDidConnect() {
-    const sessionInfo = context.sessionInfo.current;
-    if (sessionInfo === null) {
-      throw new Error("Unexpected missing session info");
-    }
     context.buffer.me = {
       type: "full",
       data: (
         // Because context.me.current is a readonly object, we'll have to
         // make a copy here. Otherwise, type errors happen later when
         // "patching" my presence.
-        __spreadValues({}, context.me.current)
+        __spreadValues({}, context.myPresence.current)
       )
     };
-    context.idFactory = makeIdFactory(sessionInfo.actor);
     if (_getStorage$ !== null) {
       refreshStorage({ flush: false });
     }
@@ -4382,8 +4387,17 @@ function createRoom(options, config) {
       }
     },
     assertStorageIsWritable: () => {
-      var _a2;
-      if ((_a2 = context.sessionInfo.current) == null ? void 0 : _a2.isReadOnly) {
+      var _a2, _b2;
+      const traits = (_b2 = (_a2 = context.dynamicSessionInfo.current) == null ? void 0 : _a2.traits) != null ? _b2 : (
+        // XXX Double-check if this is the sane thing to do! Previously this is
+        // how the context.sessionInfo?.isReadOnly check worked too. If the
+        // isReadOnly property wasn't known yet, the client assumed write
+        // access. Not sure if this will break anything if we flip it to
+        // Traits.None.
+        3 /* All */
+      );
+      const canWrite = (traits & 1 /* CanWriteDocument */) === 1 /* CanWriteDocument */;
+      if (!canWrite) {
         throw new Error(
           "Cannot write to storage with a read only user, please ensure the user has write permissions"
         );
@@ -4430,16 +4444,24 @@ function createRoom(options, config) {
     managedSocket.send(message);
   }
   const self = new DerivedRef(
-    context.sessionInfo,
-    context.me,
-    (info, me) => {
-      return info !== null ? {
-        connectionId: info.actor,
-        id: info.userId,
-        info: info.userInfo,
-        presence: me,
-        isReadOnly: info.isReadOnly
-      } : null;
+    context.staticSessionInfo,
+    context.dynamicSessionInfo,
+    context.myPresence,
+    (staticSession, dynamicSession, myPresence) => {
+      if (staticSession === null || dynamicSession === null) {
+        return null;
+      } else {
+        const canWrite = (dynamicSession.traits & 1 /* CanWriteDocument */) === 1 /* CanWriteDocument */;
+        return {
+          connectionId: dynamicSession.actor,
+          id: staticSession.userId,
+          info: staticSession.userInfo,
+          presence: myPresence,
+          canWrite,
+          isReadOnly: !canWrite
+          // Deprecated, kept for backward-compatibility
+        };
+      }
     }
   );
   const selfAsTreeNode = new DerivedRef(
@@ -4500,7 +4522,7 @@ function createRoom(options, config) {
         }
       }
       if (presence) {
-        eventHub.me.notify(context.me.current);
+        eventHub.me.notify(context.myPresence.current);
       }
       if (storageUpdates.size > 0) {
         const updates = Array.from(storageUpdates.values());
@@ -4509,7 +4531,7 @@ function createRoom(options, config) {
     });
   }
   function getConnectionId() {
-    const info = context.sessionInfo.current;
+    const info = context.dynamicSessionInfo.current;
     if (info) {
       return info.actor;
     }
@@ -4538,9 +4560,9 @@ function createRoom(options, config) {
           data: {}
         };
         for (const key in op.data) {
-          reverse.data[key] = context.me.current[key];
+          reverse.data[key] = context.myPresence.current[key];
         }
-        context.me.patch(op.data);
+        context.myPresence.patch(op.data);
         if (context.buffer.me === null) {
           context.buffer.me = { type: "partial", data: op.data };
         } else {
@@ -4648,9 +4670,9 @@ function createRoom(options, config) {
         continue;
       }
       context.buffer.me.data[key] = overrideValue;
-      oldValues[key] = context.me.current[key];
+      oldValues[key] = context.myPresence.current[key];
     }
-    context.me.patch(patch);
+    context.myPresence.patch(patch);
     if (context.activeBatch) {
       if (options2 == null ? void 0 : options2.addToHistory) {
         context.activeBatch.reverseOps.unshift({
@@ -4672,9 +4694,6 @@ function createRoom(options, config) {
       });
     }
   }
-  function isStorageReadOnly(scopes) {
-    return scopes.includes("room:read" /* Read */) && scopes.includes("room:presence:write" /* PresenceWrite */) && !scopes.includes("room:write" /* Write */);
-  }
   function onUpdatePresenceMessage(message) {
     if (message.targetActor !== void 0) {
       const oldUser = context.others.getUser(message.actor);
@@ -4706,6 +4725,11 @@ function createRoom(options, config) {
     return null;
   }
   function onRoomStateMessage(message) {
+    context.dynamicSessionInfo.set({
+      actor: message.actor,
+      traits: message.traits
+    });
+    context.idFactory = makeIdFactory(message.actor);
     for (const connectionId in context.others._connections) {
       const user = message.users[connectionId];
       if (user === void 0) {
@@ -4717,9 +4741,9 @@ function createRoom(options, config) {
       const connectionId = Number(key);
       context.others.setConnection(
         connectionId,
+        user.traits,
         user.id,
-        user.info,
-        isStorageReadOnly(user.scopes)
+        user.info
       );
     }
     return { type: "reset" };
@@ -4738,13 +4762,13 @@ function createRoom(options, config) {
   function onUserJoinedMessage(message) {
     context.others.setConnection(
       message.actor,
+      message.traits,
       message.id,
-      message.info,
-      isStorageReadOnly(message.scopes)
+      message.info
     );
     context.buffer.messages.push({
       type: 100 /* UPDATE_PRESENCE */,
-      data: context.me.current,
+      data: context.myPresence.current,
       targetActor: message.actor
     });
     flushNowOrSoon();
@@ -5197,10 +5221,10 @@ ${Array.from(traces).join("\n\n")}`
     // Core
     getStatus: () => managedSocket.getStatus(),
     getConnectionState: () => managedSocket.getLegacyStatus(),
-    isSelfAware: () => context.sessionInfo.current !== null,
+    isSelfAware: () => context.staticSessionInfo.current !== null,
     getSelf: () => self.current,
     // Presence
-    getPresence: () => context.me.current,
+    getPresence: () => context.myPresence.current,
     getOthers: () => context.others.current
   };
 }
@@ -5305,7 +5329,7 @@ function makeCreateSocketDelegateForRoom(liveblocksServer, WebSocketPolyfill) {
       // @ts-ignore (__PACKAGE_VERSION__ will be injected by the build script)
       true ? (
         /* istanbul ignore next */
-        "1.2.0-internal2"
+        "1.2.0-internal3"
       ) : "dev"}`
     );
   };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@liveblocks/core",
-  "version": "1.2.0-internal2",
+  "version": "1.2.0-internal3",
   "description": "Shared code and foundational internals for Liveblocks",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",