@liveblocks/core - npm Package Compare versions

Comparing version 0.19.3-beta5 to 0.19.3

dist/index.d.ts

@@ -636,2 +636,44 @@ /**
 
+declare type JsonTreeNode = {
+    readonly type: "Json";
+    readonly id: string;
+    readonly key: string;
+    readonly payload: Json;
+};
+declare type LiveTreeNode<TName extends `Live${string}` = `Live${string}`> = {
+    readonly type: TName;
+    readonly id: string;
+    readonly key: string;
+    readonly payload: LsonTreeNode[];
+};
+declare type LsonTreeNode = LiveTreeNode | JsonTreeNode;
+declare type UserTreeNode = {
+    readonly type: "User";
+    readonly id: string;
+    readonly key: string;
+    readonly payload: {
+        readonly connectionId: number;
+        readonly id?: string;
+        readonly info?: Json;
+        readonly presence: JsonObject;
+        readonly isReadOnly: boolean;
+    };
+};
+declare type TreeNode = LsonTreeNode | UserTreeNode;
+
+type DevToolsTreeNode_JsonTreeNode = JsonTreeNode;
+type DevToolsTreeNode_LiveTreeNode<TName extends `Live${string}` = `Live${string}`> = LiveTreeNode<TName>;
+type DevToolsTreeNode_LsonTreeNode = LsonTreeNode;
+type DevToolsTreeNode_UserTreeNode = UserTreeNode;
+type DevToolsTreeNode_TreeNode = TreeNode;
+declare namespace DevToolsTreeNode {
+  export {
+    DevToolsTreeNode_JsonTreeNode as JsonTreeNode,
+    DevToolsTreeNode_LiveTreeNode as LiveTreeNode,
+    DevToolsTreeNode_LsonTreeNode as LsonTreeNode,
+    DevToolsTreeNode_UserTreeNode as UserTreeNode,
+    DevToolsTreeNode_TreeNode as TreeNode,
+  };
+}
+
 declare type CustomEvent<TRoomEvent extends Json> = {
@@ -867,3 +909,12 @@ connectionId: number;
          *   switch(status) {
-         *      case
+         *      case "not-loaded":
+         *        break;
+         *      case "loading":
+         *        break;
+         *      case "synchronizing":
+         *        break;
+         *      case "synchronized":
+         *        break;
+         *      default:
+         *        break;
          *   }
@@ -988,2 +1039,7 @@ * });
      * Get the storage status.
+     *
+     * - `not-loaded`: Initial state when entering the room.
+     * - `loading`: Once the storage has been requested via room.getStorage().
+     * - `synchronizing`: When some local updates have not been acknowledged by Liveblocks servers.
+     * - `synchronized`: Storage is in sync with Liveblocks servers.
      */
@@ -1399,2 +1455,111 @@ getStorageStatus(): StorageStatus;
 /**
+ * Definition of all messages the Panel can send to the Client.
+ */
+declare type PanelToClientMessage = 
+/**
+ * Initial message from the panel to the client, used for two purposes.
+ * 1. First, it’s eavesdropped by the background script, which uses this
+ *    message to register a "port", which sets up a channel for two-way
+ *    communication between panel and client for the remainder of the time.
+ * 2. It signifies to the client that the devpanel is listening.
+ */
+{
+    msg: "connect";
+}
+/**
+ * Expresses to the client that the devtool is interested in
+ * receiving the "sync stream" for the room. The sync stream
+ * that follows is an initial "full sync", followed by many
+ * "partial" syncs, happening for every update.
+ */
+ | {
+    msg: "room::subscribe";
+    roomId: string;
+}
+/**
+ * Expresses to the client that the devtool no longer is
+ * interested in the "sync stream" for a room, for example,
+ * because the devtools panel is closed, or if it switched to
+ * a different room.
+ */
+ | {
+    msg: "room::unsubscribe";
+    roomId: string;
+};
+/**
+ * Definition of all messages the Client can send to the Panel.
+ */
+declare type ClientToPanelMessage = 
+/**
+ * Initial message sent by the client to test if a dev panel is listening.
+ * This is necessary in cases where the dev panel is already opened and
+ * listened, before the client is loaded. If the panel receives this message,
+ * it will replay its initial "connect" message, which triggers the loading
+ * of the two-way connection.
+ */
+{
+    msg: "wake-up-devtools";
+}
+/**
+ * Sent when a new room is available for the dev panel to track and watch.
+ * Sent by the client as soon as the room is attempted to be entered. This
+ * happens _before_ the actual connection to the room server is established,
+ * meaning the room is visible to the devtools even while it is connecting.
+ */
+ | {
+    msg: "room::available";
+    roomId: string;
+    clientVersion: string;
+}
+/**
+ * Sent when a room is left and the client loses track of the room instance.
+ */
+ | {
+    msg: "room::unavailable";
+    roomId: string;
+}
+/**
+ * Sent initially, to synchronize the entire current state of the room.
+ */
+ | {
+    msg: "room::sync::full";
+    roomId: string;
+    status: ConnectionState;
+    storage: readonly LsonTreeNode[] | null;
+    me: UserTreeNode | null;
+    others: readonly UserTreeNode[];
+}
+/**
+ * Sent whenever something about the internals of a room changes.
+ */
+ | {
+    msg: "room::sync::partial";
+    roomId: string;
+    status?: ConnectionState;
+    storage?: readonly LsonTreeNode[];
+    me?: UserTreeNode;
+    others?: readonly UserTreeNode[];
+};
+declare type FullPanelToClientMessage = PanelToClientMessage & {
+    source: "liveblocks-devtools-panel";
+    tabId: number;
+};
+declare type FullClientToPanelMessage = ClientToPanelMessage & {
+    source: "liveblocks-devtools-client";
+};
+
+type protocol_PanelToClientMessage = PanelToClientMessage;
+type protocol_ClientToPanelMessage = ClientToPanelMessage;
+type protocol_FullPanelToClientMessage = FullPanelToClientMessage;
+type protocol_FullClientToPanelMessage = FullClientToPanelMessage;
+declare namespace protocol {
+  export {
+    protocol_PanelToClientMessage as PanelToClientMessage,
+    protocol_ClientToPanelMessage as ClientToPanelMessage,
+    protocol_FullPanelToClientMessage as FullPanelToClientMessage,
+    protocol_FullClientToPanelMessage as FullClientToPanelMessage,
+  };
+}
+
+/**
  * PRIVATE / INTERNAL APIS
@@ -1424,2 +1589,2 @@ * -----------------------
 
-export { AppOnlyAuthToken, AuthToken, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, DeleteCrdtOp, DeleteObjectKeyOp, EnsureJson, FetchStorageClientMsg, History, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonObject, LiveList, LiveMap, LiveNode, LiveObject, LiveStructure, Lson, LsonObject, NodeMap, Op, OpCode, Others, ParentToChildNodeMap, Resolve, Room, RoomAuthToken, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, StorageUpdate, ToImmutable, ToJson, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, asArrayWithLegacyMethods, assertNever, b64decode, comparePosition, createClient, deprecate, deprecateIf, errorIf, freeze, isAppOnlyAuthToken, isAuthToken, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isPlainObject, isRoomAuthToken, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makePosition, nn, patchLiveObjectKey, shallow, throwUsageError, tryParseJson };
+export { AppOnlyAuthToken, AuthToken, BaseUserMeta, BroadcastEventClientMsg, BroadcastOptions, BroadcastedEventServerMsg, Client, ClientMsg, ClientMsgCode, ConnectionState, CrdtType, CreateChildOp, CreateListOp, CreateMapOp, CreateObjectOp, CreateOp, CreateRegisterOp, CreateRootObjectOp, DeleteCrdtOp, DeleteObjectKeyOp, DevToolsTreeNode as DevTools, protocol as DevToolsMsg, EnsureJson, FetchStorageClientMsg, History, IdTuple, Immutable, InitialDocumentStateServerMsg, Json, JsonObject, LiveList, LiveMap, LiveNode, LiveObject, LiveStructure, Lson, LsonObject, NodeMap, Op, OpCode, Others, ParentToChildNodeMap, Resolve, Room, RoomAuthToken, RoomInitializers, RoomStateServerMsg, SerializedChild, SerializedCrdt, SerializedList, SerializedMap, SerializedObject, SerializedRegister, SerializedRootObject, ServerMsg, ServerMsgCode, SetParentKeyOp, StorageUpdate, ToImmutable, ToJson, UpdateObjectOp, UpdatePresenceClientMsg, UpdatePresenceServerMsg, UpdateStorageClientMsg, UpdateStorageServerMsg, User, UserJoinServerMsg, UserLeftServerMsg, WebsocketCloseCodes, asArrayWithLegacyMethods, assertNever, b64decode, comparePosition, createClient, deprecate, deprecateIf, errorIf, freeze, isAppOnlyAuthToken, isAuthToken, isChildCrdt, isJsonArray, isJsonObject, isJsonScalar, isPlainObject, isRoomAuthToken, isRootCrdt, legacy_patchImmutableObject, lsonToJson, makePosition, nn, patchLiveObjectKey, shallow, throwUsageError, tryParseJson };

package.json

 {
   "name": "@liveblocks/core",
-  "version": "0.19.3-beta5",
+  "version": "0.19.3",
   "description": "Shared code and foundational internals for Liveblocks",
@@ -5,0 +5,0 @@ "main": "./dist/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

199890

increased by6.68%

Lines of code

6205

increased by7.28%

No dependency changes