@liveblocks/client - npm Package Compare versions

Comparing version 0.5.0 to 0.6.0-beta

lib/cjs/live.d.ts

 import { Presence } from "./types";
-export declare type ServerMessage = UpdatePresenceMessage | UserJoinMessage | UserLeftMessage | InitialDocumentStateMessage | UpdateStorageMessage;
+export declare type ServerMessage = UpdatePresenceMessage | UserJoinMessage | UserLeftMessage | EventMessage | InitialDocumentStateMessage | UpdateStorageMessage;
 export declare enum ServerMessageType {
@@ -7,2 +7,3 @@ UpdatePresence = 100,
     UserLeft = 102,
+    Event = 103,
     InitialDocumentState = 200,
@@ -24,2 +25,7 @@ UpdateStorage = 201
 };
+export declare type EventMessage = {
+    type: ServerMessageType.Event;
+    actor: number;
+    event: any;
+};
 export declare type InitialDocumentStateMessage = {
@@ -33,8 +39,13 @@ type: ServerMessageType.InitialDocumentState;
 };
-export declare type ClientMessage = UpdatePresenceClientMessage | UpdateStorageClientMessage | FetchStorageClientMessage;
+export declare type ClientMessage = ClientEventMessage | UpdatePresenceClientMessage | UpdateStorageClientMessage | FetchStorageClientMessage;
 export declare enum ClientMessageType {
     UpdatePresence = 100,
+    ClientEvent = 103,
     FetchStorage = 200,
     UpdateStorage = 201
 }
+export declare type ClientEventMessage = {
+    type: ClientMessageType.ClientEvent;
+    event: any;
+};
 export declare type UpdatePresenceClientMessage = {
@@ -41,0 +52,0 @@ type: ClientMessageType.UpdatePresence;

lib/cjs/live.js

@@ -9,2 +9,3 @@ "use strict";
     ServerMessageType[ServerMessageType["UserLeft"] = 102] = "UserLeft";
+    ServerMessageType[ServerMessageType["Event"] = 103] = "Event";
     ServerMessageType[ServerMessageType["InitialDocumentState"] = 200] = "InitialDocumentState";
@@ -16,2 +17,3 @@ ServerMessageType[ServerMessageType["UpdateStorage"] = 201] = "UpdateStorage";
     ClientMessageType[ClientMessageType["UpdatePresence"] = 100] = "UpdatePresence";
+    ClientMessageType[ClientMessageType["ClientEvent"] = 103] = "ClientEvent";
     ClientMessageType[ClientMessageType["FetchStorage"] = 200] = "FetchStorage";
@@ -18,0 +20,0 @@ ClientMessageType[ClientMessageType["UpdateStorage"] = 201] = "UpdateStorage";

lib/cjs/room.js

@@ -67,2 +67,3 @@ "use strict";
         value === "others-presence" ||
+        value === "event" ||
         value === "close");
@@ -80,2 +81,3 @@ }
         storage: [],
+        event: [],
         "others-presence": [],
@@ -221,2 +223,7 @@ "my-presence": [],
     }
+    function onEvent(message) {
+        for (const listener of _listeners.event) {
+            listener({ actor: message.actor, event: message.event });
+        }
+    }
     function onMessage(event) {
@@ -248,2 +255,6 @@ const message = JSON.parse(event.data);
             }
+            case live_1.ServerMessageType.Event: {
+                onEvent(message);
+                break;
+            }
             case live_1.ServerMessageType.UserLeft: {
@@ -312,2 +323,3 @@ const userLeftMessage = message;
         _listeners["others-presence"] = [];
+        _listeners.event = [];
         _listeners.storage = [];
@@ -358,2 +370,7 @@ _listeners.close = [];
     }
+    function broadcastEvent(event) {
+        if (state === types_1.RoomState.Connected) {
+            send({ type: live_1.ClientMessageType.ClientEvent, event });
+        }
+    }
     function addEventListener(type, listener) {
@@ -382,3 +399,4 @@ if (!isValidRoomEventType(type)) {
                 _listeners.storage.length +
-                _listeners.close.length);
+                _listeners.close.length +
+                _listeners.event.length);
         },
@@ -415,4 +433,5 @@ getState() {
         getOthers,
+        broadcastEvent,
     };
 }
 exports.createRoom = createRoom;

lib/cjs/types.d.ts

@@ -41,2 +41,3 @@ import { RecordData, Record, List } from "./doc";
         <T extends Presence>(type: "others-presence", listener: OthersPresenceEventCallback<T>): void;
+        (type: "event", listener: EventEventCallback): void;
         <T extends RecordData>(type: "storage", listener: StorageEventCallback<T>): void;
@@ -49,2 +50,3 @@ (type: "open", listener: OpenEventCallback): void;
         <T extends Presence>(type: "others-presence", listener: OthersPresenceEventCallback<T>): void;
+        (type: "event", listener: EventEventCallback): void;
         <T extends RecordData>(type: "storage", listener: StorageEventCallback<T>): void;
@@ -65,2 +67,3 @@ (type: "open", listener: OpenEventCallback): void;
     updatePresence: <T extends Presence>(overrides: Partial<T>) => void;
+    broadcastEvent: (event: any) => void;
 };
@@ -70,2 +73,6 @@ export declare type StorageEventCallback<T extends RecordData = RecordData> = (storage: LiveStorage<T>) => void;
 export declare type OthersPresenceEventCallback<T extends Presence = Presence> = (others: Others<T>) => void;
+export declare type EventEventCallback = ({ actor, event, }: {
+    actor: number;
+    event: any;
+}) => void;
 export declare type OpenEventCallback = () => void;
@@ -72,0 +79,0 @@ export declare type CloseEventCallback = () => void;

lib/esm/live.d.ts

 import { Presence } from "./types";
-export declare type ServerMessage = UpdatePresenceMessage | UserJoinMessage | UserLeftMessage | InitialDocumentStateMessage | UpdateStorageMessage;
+export declare type ServerMessage = UpdatePresenceMessage | UserJoinMessage | UserLeftMessage | EventMessage | InitialDocumentStateMessage | UpdateStorageMessage;
 export declare enum ServerMessageType {
@@ -7,2 +7,3 @@ UpdatePresence = 100,
     UserLeft = 102,
+    Event = 103,
     InitialDocumentState = 200,
@@ -24,2 +25,7 @@ UpdateStorage = 201
 };
+export declare type EventMessage = {
+    type: ServerMessageType.Event;
+    actor: number;
+    event: any;
+};
 export declare type InitialDocumentStateMessage = {
@@ -33,8 +39,13 @@ type: ServerMessageType.InitialDocumentState;
 };
-export declare type ClientMessage = UpdatePresenceClientMessage | UpdateStorageClientMessage | FetchStorageClientMessage;
+export declare type ClientMessage = ClientEventMessage | UpdatePresenceClientMessage | UpdateStorageClientMessage | FetchStorageClientMessage;
 export declare enum ClientMessageType {
     UpdatePresence = 100,
+    ClientEvent = 103,
     FetchStorage = 200,
     UpdateStorage = 201
 }
+export declare type ClientEventMessage = {
+    type: ClientMessageType.ClientEvent;
+    event: any;
+};
 export declare type UpdatePresenceClientMessage = {
@@ -41,0 +52,0 @@ type: ClientMessageType.UpdatePresence;

lib/esm/live.js

@@ -6,2 +6,3 @@ export var ServerMessageType;
     ServerMessageType[ServerMessageType["UserLeft"] = 102] = "UserLeft";
+    ServerMessageType[ServerMessageType["Event"] = 103] = "Event";
     ServerMessageType[ServerMessageType["InitialDocumentState"] = 200] = "InitialDocumentState";
@@ -13,2 +14,3 @@ ServerMessageType[ServerMessageType["UpdateStorage"] = 201] = "UpdateStorage";
     ClientMessageType[ClientMessageType["UpdatePresence"] = 100] = "UpdatePresence";
+    ClientMessageType[ClientMessageType["ClientEvent"] = 103] = "ClientEvent";
     ClientMessageType[ClientMessageType["FetchStorage"] = 200] = "FetchStorage";
@@ -15,0 +17,0 @@ ClientMessageType[ClientMessageType["UpdateStorage"] = 201] = "UpdateStorage";

lib/esm/room.js

@@ -45,2 +45,3 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
         value === "others-presence" ||
+        value === "event" ||
         value === "close");
@@ -58,2 +59,3 @@ }
         storage: [],
+        event: [],
         "others-presence": [],
@@ -199,2 +201,7 @@ "my-presence": [],
     }
+    function onEvent(message) {
+        for (const listener of _listeners.event) {
+            listener({ actor: message.actor, event: message.event });
+        }
+    }
     function onMessage(event) {
@@ -226,2 +233,6 @@ const message = JSON.parse(event.data);
             }
+            case ServerMessageType.Event: {
+                onEvent(message);
+                break;
+            }
             case ServerMessageType.UserLeft: {
@@ -290,2 +301,3 @@ const userLeftMessage = message;
         _listeners["others-presence"] = [];
+        _listeners.event = [];
         _listeners.storage = [];
@@ -336,2 +348,7 @@ _listeners.close = [];
     }
+    function broadcastEvent(event) {
+        if (state === RoomState.Connected) {
+            send({ type: ClientMessageType.ClientEvent, event });
+        }
+    }
     function addEventListener(type, listener) {
@@ -360,3 +377,4 @@ if (!isValidRoomEventType(type)) {
                 _listeners.storage.length +
-                _listeners.close.length);
+                _listeners.close.length +
+                _listeners.event.length);
         },
@@ -393,3 +411,4 @@ getState() {
         getOthers,
+        broadcastEvent,
     };
 }

lib/esm/types.d.ts

@@ -41,2 +41,3 @@ import { RecordData, Record, List } from "./doc";
         <T extends Presence>(type: "others-presence", listener: OthersPresenceEventCallback<T>): void;
+        (type: "event", listener: EventEventCallback): void;
         <T extends RecordData>(type: "storage", listener: StorageEventCallback<T>): void;
@@ -49,2 +50,3 @@ (type: "open", listener: OpenEventCallback): void;
         <T extends Presence>(type: "others-presence", listener: OthersPresenceEventCallback<T>): void;
+        (type: "event", listener: EventEventCallback): void;
         <T extends RecordData>(type: "storage", listener: StorageEventCallback<T>): void;
@@ -65,2 +67,3 @@ (type: "open", listener: OpenEventCallback): void;
     updatePresence: <T extends Presence>(overrides: Partial<T>) => void;
+    broadcastEvent: (event: any) => void;
 };
@@ -70,2 +73,6 @@ export declare type StorageEventCallback<T extends RecordData = RecordData> = (storage: LiveStorage<T>) => void;
 export declare type OthersPresenceEventCallback<T extends Presence = Presence> = (others: Others<T>) => void;
+export declare type EventEventCallback = ({ actor, event, }: {
+    actor: number;
+    event: any;
+}) => void;
 export declare type OpenEventCallback = () => void;
@@ -72,0 +79,0 @@ export declare type CloseEventCallback = () => void;

package.json

 {
   "name": "@liveblocks/client",
-  "version": "0.5.0",
+  "version": "0.6.0-beta",
   "description": "",
@@ -5,0 +5,0 @@ "main": "./lib/cjs/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

98255

increased by2.75%

Lines of code

2820

increased by2.84%

No dependency changes