@liveblocks/core 1.2.0-internal3 → 1.2.0-internal5

package/dist/index.d.ts

@@ -703,16 +703,9 @@ declare type User<TPresence extends JsonObject, TUserMeta extends BaseUserMeta>
      */
     readonly presence: TPresence;
     /**
-     * @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.
+     * False if the user can modify the room storage, true otherwise.
      */
     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;
 };
 
 /**
@@ -1555,33 +1548,6 @@ 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.
  */
@@ -1656,10 +1622,9 @@ declare type UserJoinServerMsg<TUserMeta extends BaseUserMeta> = {
      */
     readonly info: TUserMeta["info"];
     /**
-     * Informs the client what Traits this (other) User has.
-     * @since v1.2 (WS API v7)
+     * Permissions that the user has in the Room.
      */
-    readonly traits: Traits;
+    readonly scopes: string[];
 };
 /**
  * Sent by the WebSocket server and broadcasted to all clients to announce that
@@ -1706,13 +1671,13 @@ declare type RoomStateServerMsg<TUserMeta extends BaseUserMeta> = {
      */
     readonly actor: number;
     /**
-     * Informs the client what Traits the current User (self) has.
+     * Informs the client what permissions the current User (self) has.
      * @since v1.2 (WS API v7)
      */
-    readonly traits: Traits;
+    readonly scopes: string[];
     readonly users: {
-        readonly [otherActor: number]: TUserMeta & {
-            traits: Traits;
+        readonly [actor: number]: TUserMeta & {
+            scopes: string[];
         };
     };
 };
@@ -1935,4 +1900,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, 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 };
+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 };