@liveblocks/core 0.18.3 → 0.18.5

package/{index.d.ts → dist/index.d.ts}

@@ -357,6 +357,9 @@ declare class LiveList<TItem extends Lson> extends AbstractCrdt {
     toImmutable(): readonly ToImmutable<TItem>[];
 }
 
+/**
+ * This type is used by clients to define the metadata for a user.
+ */
 declare type BaseUserMeta = {
     /**
      * The id of the user that has been set in the authentication endpoint.
@@ -639,6 +642,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
@@ -672,7 +679,9 @@ declare type BroadcastedEventServerMsg<TRoomEvent extends Json> = {
 declare type RoomStateServerMsg<TUserMeta extends BaseUserMeta> = {
     type: ServerMsgCode.ROOM_STATE;
     users: {
-        [actor: number]: TUserMeta;
+        [actor: number]: TUserMeta & {
+            scopes: string[];
+        };
     };
 };
 /**
@@ -858,6 +867,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 +912,13 @@ declare type Connection = {
     id: number;
     userId?: string;
     userInfo?: Json;
+    isReadOnly: boolean;
 } | {
     state: "open";
     id: number;
     userId?: string;
     userInfo?: Json;
+    isReadOnly: boolean;
 } | {
     state: "unavailable";
 } | {
@@ -1255,6 +1270,33 @@ declare function isAppOnlyAuthToken(data: JsonObject): data is AppOnlyAuthToken;
 declare function isRoomAuthToken(data: JsonObject): data is RoomAuthToken;
 declare function isAuthToken(data: JsonObject): data is AuthToken;
 
+/**
+ * Create a client that will be responsible to communicate with liveblocks servers.
+ *
+ * @example
+ * const client = createClient({
+ *   authEndpoint: "/api/auth"
+ * });
+ *
+ * // It's also possible to use a function to call your authentication endpoint.
+ * // Useful to add additional headers or use an API wrapper (like Firebase functions)
+ * const client = createClient({
+ *   authEndpoint: async (room) => {
+ *     const response = await fetch("/api/auth", {
+ *       method: "POST",
+ *       headers: {
+ *          Authentication: "token",
+ *          "Content-Type": "application/json"
+ *       },
+ *       body: JSON.stringify({ room })
+ *     });
+ *
+ *     return await response.json(); // should be: { token: "..." }
+ *   }
+ * });
+ */
+declare function createClient(options: ClientOptions): Client;
+
 /**
  * Displays a deprecation warning in the dev console. Only in dev mode, and
  * only once per message/key. In production, this is a no-op.
@@ -1288,6 +1330,17 @@ declare function legacy_patchImmutableObject<S extends JsonObject>(state: S, upd
 declare function makePosition(before?: string, after?: string): string;
 declare function comparePosition(posA: string, posB: string): number;
 
+/**
+ * Shallowly compares two given values.
+ *
+ * - Two simple values are considered equal if they're strictly equal
+ * - Two arrays are considered equal if their members are strictly equal
+ * - Two objects are considered equal if their values are strictly equal
+ *
+ * Testing goes one level deep.
+ */
+declare function shallow(a: unknown, b: unknown): boolean;
+
 /**
  * Freezes the given argument, but only in development builds. In production
  * builds, this is a no-op for performance reasons.
@@ -1306,44 +1359,6 @@ declare function tryParseJson(rawMessage: string): Json | undefined;
  */
 declare function b64decode(b64value: string): string;
 
-/**
- * Create a client that will be responsible to communicate with liveblocks servers.
- *
- * @example
- * const client = createClient({
- *   authEndpoint: "/api/auth"
- * });
- *
- * // It's also possible to use a function to call your authentication endpoint.
- * // Useful to add additional headers or use an API wrapper (like Firebase functions)
- * const client = createClient({
- *   authEndpoint: async (room) => {
- *     const response = await fetch("/api/auth", {
- *       method: "POST",
- *       headers: {
- *          Authentication: "token",
- *          "Content-Type": "application/json"
- *       },
- *       body: JSON.stringify({ room })
- *     });
- *
- *     return await response.json(); // should be: { token: "..." }
- *   }
- * });
- */
-declare function createClient(options: ClientOptions): Client;
-
-/**
- * Shallowly compares two given values.
- *
- * - Two simple values are considered equal if they're strictly equal
- * - Two arrays are considered equal if their members are strictly equal
- * - Two objects are considered equal if their values are strictly equal
- *
- * Testing goes one level deep.
- */
-declare function shallow(a: unknown, b: unknown): boolean;
-
 /**
  * PRIVATE / INTERNAL APIS
  * -----------------------