@workadventure/room-api-client 1.17.6 → 1.18.0

package/README.md

@@ -10,7 +10,38 @@ Easily create a GRPC client to connect your service to the [Room API](https://gi
   npm install @workadventure/room-api-client
 ```
 
-## Usage/Examples
+## Instantiating the client
+
+Use the `createRoomApiClient` function to create a client.
+
+The client expects an API key as first parameter. See [the Authentication section of the Room API documentation](https://docs.workadventu.re/developer/room-api)
+to learn how to get your own API key.
+
+```typescript
+const client = createRoomApiClient("MY AWESOME KEY");
+```
+
+By default, the client targets the official WorkAdventure server. If you are using a self-hosted version, you 
+must in addition pass in parameter the domain name and port of your WorkAdventure RoomApi endpoint.
+
+```typescript
+const client = createRoomApiClient("My AWESOME KEY", "play.example.com", "5221");
+```
+
+## Setting / Reading / Tracking variables
+
+The Room API client allows you to set, read and track variables in a room using the following methods:
+
+- `client.saveVariable({ name: string, room: string, value: unknown }): Promise<void>`
+- `client.readVariable({ name: string, room: string }): Promise<Value>`
+- `client.listenVariable({ name: string, room: string }): AsyncIterable<Value>`
+
+> [!WARNING]
+> `readVariable` and `listenVariable` return a `Value` object. To get the underlying value, you must call the `Value.unwrap` function.
+> This is because the functions can return nothing due to an error, and the `Value` object allows you to check if the value is an error or not.
+
+
+### Example
 
 ```javascript
 import { createRoomApiClient } from "@workadventure/room-api-client";
@@ -24,7 +55,7 @@ import { createRoomApiClient } from "@workadventure/room-api-client";
 const client = createRoomApiClient("My AWESOME KEY");
 
 // URL of the room you wish to interact with
-const roomUrl = "https://play.workadventu.re/@/my-team/my-world";
+const roomUrl = "https://play.workadventu.re/@/my-organization/my-world/my-room";
 
 // Name of the variable with which you want to interact
 const variableName = "textField";
@@ -71,9 +102,60 @@ async function init() {
 }
 
 init();
-
 ```
 
-## Warning
 
-You can see in the example we are using the `Value.unwrap` function, this is because the variable functions return a `Value` object, which is a wrapper around the actual value. This is because the functions can return nothing due to an error, and the `Value` object allows you to check if the value is an error or not.
+## Sending events / listening to events
+
+The Room API client allows you to send and listen to events in a room using the following methods:
+
+- `client.broadcastEvent({ name: string, room: string, data: unknown }): Promise<void>`
+- `client.listenToEvent({ name: string, room: string }): AsyncIterable<any>`
+
+### Example
+
+```javascript
+import { createRoomApiClient } from "@workadventure/room-api-client";
+
+/**
+ * By default, the client targets the official WorkAdventure server,
+ * but you can also define customs domain and port.
+ * Example :
+ * const client = createRoomApiClient("My AWESOME KEY", "mydomain.net", "5221");
+ */
+const client = createRoomApiClient("My AWESOME KEY");
+
+// URL of the room you wish to interact with
+const roomUrl = "https://play.workadventu.re/@/my-organization/my-world/my-room";
+
+// Name of the event with which you want to interact
+const eventName = "my-event";
+
+async function init() {
+  // Send an event in 5 seconds
+  setTimeout(async () => {
+    await client.broadcastEvent({
+      name: eventName,
+      room: roomUrl,
+      data: "Default Value",
+    });
+
+    console.log("Event sent: Default Value");
+  }, 5000);
+
+  // Listen a event
+  const events = client.listenToEvent({
+    name: eventName,
+    room: roomUrl,
+  });
+
+  for await (const event of events) {
+    console.log("Event received:");
+    console.log("Sender:", event.senderId);
+    console.log("Value:", event.data);
+    break;
+  }
+}
+
+init();
+```

package/dist/compiled_proto/google/protobuf/empty.d.ts

@@ -22,7 +22,7 @@ export declare const Empty: {
     fromPartial(_: DeepPartial<Empty>): Empty;
 };
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
-export type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
     [K in keyof T]?: DeepPartial<T[K]>;
 } : Partial<T>;
 export {};

package/dist/compiled_proto/google/protobuf/empty.js

@@ -42,7 +42,7 @@ exports.Empty = {
             const tag = reader.uint32();
             switch (tag >>> 3) {
             }
-            if ((tag & 7) == 4 || tag == 0) {
+            if ((tag & 7) === 4 || tag === 0) {
                 break;
             }
             reader.skipType(tag & 7);

package/dist/compiled_proto/google/protobuf/struct.d.ts

@@ -109,7 +109,7 @@ export declare const ListValue: {
     unwrap(message: ListValue): Array<any>;
 };
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
-export type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
     [K in keyof T]?: DeepPartial<T[K]>;
 } : Partial<T>;
 export {};

package/dist/compiled_proto/google/protobuf/struct.js

@@ -81,7 +81,7 @@ exports.Struct = {
             const tag = reader.uint32();
             switch (tag >>> 3) {
                 case 1:
-                    if (tag != 10) {
+                    if (tag !== 10) {
                         break;
                     }
                     const entry1 = exports.Struct_FieldsEntry.decode(reader, reader.uint32());
@@ -90,7 +90,7 @@ exports.Struct = {
                     }
                     continue;
             }
-            if ((tag & 7) == 4 || tag == 0) {
+            if ((tag & 7) === 4 || tag === 0) {
                 break;
             }
             reader.skipType(tag & 7);
@@ -109,11 +109,14 @@ exports.Struct = {
     },
     toJSON(message) {
         const obj = {};
-        obj.fields = {};
         if (message.fields) {
-            Object.entries(message.fields).forEach(([k, v]) => {
-                obj.fields[k] = v;
-            });
+            const entries = Object.entries(message.fields);
+            if (entries.length > 0) {
+                obj.fields = {};
+                entries.forEach(([k, v]) => {
+                    obj.fields[k] = v;
+                });
+            }
         }
         return obj;
     },
@@ -170,19 +173,19 @@ exports.Struct_FieldsEntry = {
             const tag = reader.uint32();
             switch (tag >>> 3) {
                 case 1:
-                    if (tag != 10) {
+                    if (tag !== 10) {
                         break;
                     }
                     message.key = reader.string();
                     continue;
                 case 2:
-                    if (tag != 18) {
+                    if (tag !== 18) {
                         break;
                     }
                     message.value = exports.Value.unwrap(exports.Value.decode(reader, reader.uint32()));
                     continue;
             }
-            if ((tag & 7) == 4 || tag == 0) {
+            if ((tag & 7) === 4 || tag === 0) {
                 break;
             }
             reader.skipType(tag & 7);
@@ -190,12 +193,19 @@ exports.Struct_FieldsEntry = {
         return message;
     },
     fromJSON(object) {
-        return { key: isSet(object.key) ? String(object.key) : "", value: isSet(object?.value) ? object.value : undefined };
+        return {
+            key: isSet(object.key) ? globalThis.String(object.key) : "",
+            value: isSet(object?.value) ? object.value : undefined,
+        };
     },
     toJSON(message) {
         const obj = {};
-        message.key !== undefined && (obj.key = message.key);
-        message.value !== undefined && (obj.value = message.value);
+        if (message.key !== "") {
+            obj.key = message.key;
+        }
+        if (message.value !== undefined) {
+            obj.value = message.value;
+        }
         return obj;
     },
     create(base) {
@@ -248,43 +258,43 @@ exports.Value = {
             const tag = reader.uint32();
             switch (tag >>> 3) {
                 case 1:
-                    if (tag != 8) {
+                    if (tag !== 8) {
                         break;
                     }
                     message.nullValue = reader.int32();
                     continue;
                 case 2:
-                    if (tag != 17) {
+                    if (tag !== 17) {
                         break;
                     }
                     message.numberValue = reader.double();
                     continue;
                 case 3:
-                    if (tag != 26) {
+                    if (tag !== 26) {
                         break;
                     }
                     message.stringValue = reader.string();
                     continue;
                 case 4:
-                    if (tag != 32) {
+                    if (tag !== 32) {
                         break;
                     }
                     message.boolValue = reader.bool();
                     continue;
                 case 5:
-                    if (tag != 42) {
+                    if (tag !== 42) {
                         break;
                     }
                     message.structValue = exports.Struct.unwrap(exports.Struct.decode(reader, reader.uint32()));
                     continue;
                 case 6:
-                    if (tag != 50) {
+                    if (tag !== 50) {
                         break;
                     }
                     message.listValue = exports.ListValue.unwrap(exports.ListValue.decode(reader, reader.uint32()));
                     continue;
             }
-            if ((tag & 7) == 4 || tag == 0) {
+            if ((tag & 7) === 4 || tag === 0) {
                 break;
             }
             reader.skipType(tag & 7);
@@ -294,22 +304,33 @@ exports.Value = {
     fromJSON(object) {
         return {
             nullValue: isSet(object.nullValue) ? nullValueFromJSON(object.nullValue) : undefined,
-            numberValue: isSet(object.numberValue) ? Number(object.numberValue) : undefined,
-            stringValue: isSet(object.stringValue) ? String(object.stringValue) : undefined,
-            boolValue: isSet(object.boolValue) ? Boolean(object.boolValue) : undefined,
+            numberValue: isSet(object.numberValue) ? globalThis.Number(object.numberValue) : undefined,
+            stringValue: isSet(object.stringValue) ? globalThis.String(object.stringValue) : undefined,
+            boolValue: isSet(object.boolValue) ? globalThis.Boolean(object.boolValue) : undefined,
             structValue: isObject(object.structValue) ? object.structValue : undefined,
-            listValue: Array.isArray(object.listValue) ? [...object.listValue] : undefined,
+            listValue: globalThis.Array.isArray(object.listValue) ? [...object.listValue] : undefined,
         };
     },
     toJSON(message) {
         const obj = {};
-        message.nullValue !== undefined &&
-            (obj.nullValue = message.nullValue !== undefined ? nullValueToJSON(message.nullValue) : undefined);
-        message.numberValue !== undefined && (obj.numberValue = message.numberValue);
-        message.stringValue !== undefined && (obj.stringValue = message.stringValue);
-        message.boolValue !== undefined && (obj.boolValue = message.boolValue);
-        message.structValue !== undefined && (obj.structValue = message.structValue);
-        message.listValue !== undefined && (obj.listValue = message.listValue);
+        if (message.nullValue !== undefined) {
+            obj.nullValue = nullValueToJSON(message.nullValue);
+        }
+        if (message.numberValue !== undefined) {
+            obj.numberValue = message.numberValue;
+        }
+        if (message.stringValue !== undefined) {
+            obj.stringValue = message.stringValue;
+        }
+        if (message.boolValue !== undefined) {
+            obj.boolValue = message.boolValue;
+        }
+        if (message.structValue !== undefined) {
+            obj.structValue = message.structValue;
+        }
+        if (message.listValue !== undefined) {
+            obj.listValue = message.listValue;
+        }
         return obj;
     },
     create(base) {
@@ -339,7 +360,7 @@ exports.Value = {
         else if (typeof value === "string") {
             result.stringValue = value;
         }
-        else if (Array.isArray(value)) {
+        else if (globalThis.Array.isArray(value)) {
             result.listValue = value;
         }
         else if (typeof value === "object") {
@@ -390,13 +411,13 @@ exports.ListValue = {
             const tag = reader.uint32();
             switch (tag >>> 3) {
                 case 1:
-                    if (tag != 10) {
+                    if (tag !== 10) {
                         break;
                     }
                     message.values.push(exports.Value.unwrap(exports.Value.decode(reader, reader.uint32())));
                     continue;
             }
-            if ((tag & 7) == 4 || tag == 0) {
+            if ((tag & 7) === 4 || tag === 0) {
                 break;
             }
             reader.skipType(tag & 7);
@@ -404,15 +425,12 @@ exports.ListValue = {
         return message;
     },
     fromJSON(object) {
-        return { values: Array.isArray(object?.values) ? [...object.values] : [] };
+        return { values: globalThis.Array.isArray(object?.values) ? [...object.values] : [] };
     },
     toJSON(message) {
         const obj = {};
-        if (message.values) {
-            obj.values = message.values.map((e) => e);
-        }
-        else {
-            obj.values = [];
+        if (message.values?.length) {
+            obj.values = message.values;
         }
         return obj;
     },
@@ -430,7 +448,7 @@ exports.ListValue = {
         return result;
     },
     unwrap(message) {
-        if (message?.hasOwnProperty("values") && Array.isArray(message.values)) {
+        if (message?.hasOwnProperty("values") && globalThis.Array.isArray(message.values)) {
             return message.values;
         }
         else {

package/dist/compiled_proto/room-api.d.ts

@@ -12,6 +12,20 @@ export interface SaveVariableRequest {
     name: string;
     value: any | undefined;
 }
+export interface EventRequest {
+    room: string;
+    name: string;
+}
+export interface EventResponse {
+    data: any | undefined;
+    senderId?: number | undefined;
+}
+export interface DispatchEventRequest {
+    room: string;
+    name: string;
+    data: any | undefined;
+    targetUserIds: number[];
+}
 export declare const VariableRequest: {
     encode(message: VariableRequest, writer?: _m0.Writer): _m0.Writer;
     decode(input: _m0.Reader | Uint8Array, length?: number): VariableRequest;
@@ -28,6 +42,30 @@ export declare const SaveVariableRequest: {
     create(base?: DeepPartial<SaveVariableRequest>): SaveVariableRequest;
     fromPartial(object: DeepPartial<SaveVariableRequest>): SaveVariableRequest;
 };
+export declare const EventRequest: {
+    encode(message: EventRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): EventRequest;
+    fromJSON(object: any): EventRequest;
+    toJSON(message: EventRequest): unknown;
+    create(base?: DeepPartial<EventRequest>): EventRequest;
+    fromPartial(object: DeepPartial<EventRequest>): EventRequest;
+};
+export declare const EventResponse: {
+    encode(message: EventResponse, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): EventResponse;
+    fromJSON(object: any): EventResponse;
+    toJSON(message: EventResponse): unknown;
+    create(base?: DeepPartial<EventResponse>): EventResponse;
+    fromPartial(object: DeepPartial<EventResponse>): EventResponse;
+};
+export declare const DispatchEventRequest: {
+    encode(message: DispatchEventRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): DispatchEventRequest;
+    fromJSON(object: any): DispatchEventRequest;
+    toJSON(message: DispatchEventRequest): unknown;
+    create(base?: DeepPartial<DispatchEventRequest>): DispatchEventRequest;
+    fromPartial(object: DeepPartial<DispatchEventRequest>): DispatchEventRequest;
+};
 export type RoomApiDefinition = typeof RoomApiDefinition;
 export declare const RoomApiDefinition: {
     readonly name: "RoomApi";
@@ -142,6 +180,52 @@ export declare const RoomApiDefinition: {
             readonly responseStream: false;
             readonly options: {};
         };
+        /** Dispatch an event to all users in the room */
+        readonly broadcastEvent: {
+            readonly name: "broadcastEvent";
+            readonly requestType: {
+                encode(message: DispatchEventRequest, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): DispatchEventRequest;
+                fromJSON(object: any): DispatchEventRequest;
+                toJSON(message: DispatchEventRequest): unknown;
+                create(base?: DeepPartial<DispatchEventRequest>): DispatchEventRequest;
+                fromPartial(object: DeepPartial<DispatchEventRequest>): DispatchEventRequest;
+            };
+            readonly requestStream: false;
+            readonly responseType: {
+                encode(_: Empty, writer?: _m0.Writer): _m0.Writer;
+                decode(input: Uint8Array | _m0.Reader, length?: number | undefined): Empty;
+                fromJSON(_: any): Empty;
+                toJSON(_: Empty): unknown;
+                create(base?: {} | undefined): Empty;
+                fromPartial(_: {}): Empty;
+            };
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /** Listen to events dispatched in the room */
+        readonly listenToEvent: {
+            readonly name: "listenToEvent";
+            readonly requestType: {
+                encode(message: EventRequest, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): EventRequest;
+                fromJSON(object: any): EventRequest;
+                toJSON(message: EventRequest): unknown;
+                create(base?: DeepPartial<EventRequest>): EventRequest;
+                fromPartial(object: DeepPartial<EventRequest>): EventRequest;
+            };
+            readonly requestStream: false;
+            readonly responseType: {
+                encode(message: EventResponse, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): EventResponse;
+                fromJSON(object: any): EventResponse;
+                toJSON(message: EventResponse): unknown;
+                create(base?: DeepPartial<EventResponse>): EventResponse;
+                fromPartial(object: DeepPartial<EventResponse>): EventResponse;
+            };
+            readonly responseStream: true;
+            readonly options: {};
+        };
     };
 };
 export interface RoomApiServiceImplementation<CallContextExt = {}> {
@@ -151,6 +235,10 @@ export interface RoomApiServiceImplementation<CallContextExt = {}> {
     listenVariable(request: VariableRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<Value>>;
     /** Set the value of the given variable */
     saveVariable(request: SaveVariableRequest, context: CallContext & CallContextExt): Promise<DeepPartial<Empty>>;
+    /** Dispatch an event to all users in the room */
+    broadcastEvent(request: DispatchEventRequest, context: CallContext & CallContextExt): Promise<DeepPartial<Empty>>;
+    /** Listen to events dispatched in the room */
+    listenToEvent(request: EventRequest, context: CallContext & CallContextExt): ServerStreamingMethodResult<DeepPartial<EventResponse>>;
 }
 export interface RoomApiClient<CallOptionsExt = {}> {
     /** Get the current value of the given variable */
@@ -159,9 +247,13 @@ export interface RoomApiClient<CallOptionsExt = {}> {
     listenVariable(request: DeepPartial<VariableRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<Value>;
     /** Set the value of the given variable */
     saveVariable(request: DeepPartial<SaveVariableRequest>, options?: CallOptions & CallOptionsExt): Promise<Empty>;
+    /** Dispatch an event to all users in the room */
+    broadcastEvent(request: DeepPartial<DispatchEventRequest>, options?: CallOptions & CallOptionsExt): Promise<Empty>;
+    /** Listen to events dispatched in the room */
+    listenToEvent(request: DeepPartial<EventRequest>, options?: CallOptions & CallOptionsExt): AsyncIterable<EventResponse>;
 }
 type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
-export type DeepPartial<T> = T extends Builtin ? T : T extends Array<infer U> ? Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
+export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
     [K in keyof T]?: DeepPartial<T[K]>;
 } : Partial<T>;
 export type ServerStreamingMethodResult<Response> = {

package/dist/compiled_proto/room-api.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RoomApiDefinition = exports.SaveVariableRequest = exports.VariableRequest = exports.protobufPackage = void 0;
+exports.RoomApiDefinition = exports.DispatchEventRequest = exports.EventResponse = exports.EventRequest = exports.SaveVariableRequest = exports.VariableRequest = exports.protobufPackage = void 0;
 const _m0 = __importStar(require("protobufjs/minimal"));
 const empty_1 = require("./google/protobuf/empty");
 const struct_1 = require("./google/protobuf/struct");
@@ -49,19 +49,19 @@ exports.VariableRequest = {
             const tag = reader.uint32();
             switch (tag >>> 3) {
                 case 1:
-                    if (tag != 10) {
+                    if (tag !== 10) {
                         break;
                     }
                     message.room = reader.string();
                     continue;
                 case 2:
-                    if (tag != 18) {
+                    if (tag !== 18) {
                         break;
                     }
                     message.name = reader.string();
                     continue;
             }
-            if ((tag & 7) == 4 || tag == 0) {
+            if ((tag & 7) === 4 || tag === 0) {
                 break;
             }
             reader.skipType(tag & 7);
@@ -69,12 +69,19 @@ exports.VariableRequest = {
         return message;
     },
     fromJSON(object) {
-        return { room: isSet(object.room) ? String(object.room) : "", name: isSet(object.name) ? String(object.name) : "" };
+        return {
+            room: isSet(object.room) ? globalThis.String(object.room) : "",
+            name: isSet(object.name) ? globalThis.String(object.name) : "",
+        };
     },
     toJSON(message) {
         const obj = {};
-        message.room !== undefined && (obj.room = message.room);
-        message.name !== undefined && (obj.name = message.name);
+        if (message.room !== "") {
+            obj.room = message.room;
+        }
+        if (message.name !== "") {
+            obj.name = message.name;
+        }
         return obj;
     },
     create(base) {
@@ -111,25 +118,25 @@ exports.SaveVariableRequest = {
             const tag = reader.uint32();
             switch (tag >>> 3) {
                 case 1:
-                    if (tag != 10) {
+                    if (tag !== 10) {
                         break;
                     }
                     message.room = reader.string();
                     continue;
                 case 2:
-                    if (tag != 18) {
+                    if (tag !== 18) {
                         break;
                     }
                     message.name = reader.string();
                     continue;
                 case 3:
-                    if (tag != 26) {
+                    if (tag !== 26) {
                         break;
                     }
                     message.value = struct_1.Value.unwrap(struct_1.Value.decode(reader, reader.uint32()));
                     continue;
             }
-            if ((tag & 7) == 4 || tag == 0) {
+            if ((tag & 7) === 4 || tag === 0) {
                 break;
             }
             reader.skipType(tag & 7);
@@ -138,16 +145,22 @@ exports.SaveVariableRequest = {
     },
     fromJSON(object) {
         return {
-            room: isSet(object.room) ? String(object.room) : "",
-            name: isSet(object.name) ? String(object.name) : "",
+            room: isSet(object.room) ? globalThis.String(object.room) : "",
+            name: isSet(object.name) ? globalThis.String(object.name) : "",
             value: isSet(object?.value) ? object.value : undefined,
         };
     },
     toJSON(message) {
         const obj = {};
-        message.room !== undefined && (obj.room = message.room);
-        message.name !== undefined && (obj.name = message.name);
-        message.value !== undefined && (obj.value = message.value);
+        if (message.room !== "") {
+            obj.room = message.room;
+        }
+        if (message.name !== "") {
+            obj.name = message.name;
+        }
+        if (message.value !== undefined) {
+            obj.value = message.value;
+        }
         return obj;
     },
     create(base) {
@@ -161,6 +174,243 @@ exports.SaveVariableRequest = {
         return message;
     },
 };
+function createBaseEventRequest() {
+    return { room: "", name: "" };
+}
+exports.EventRequest = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.room !== "") {
+            writer.uint32(10).string(message.room);
+        }
+        if (message.name !== "") {
+            writer.uint32(18).string(message.name);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseEventRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.room = reader.string();
+                    continue;
+                case 2:
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.name = reader.string();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            room: isSet(object.room) ? globalThis.String(object.room) : "",
+            name: isSet(object.name) ? globalThis.String(object.name) : "",
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.room !== "") {
+            obj.room = message.room;
+        }
+        if (message.name !== "") {
+            obj.name = message.name;
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.EventRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseEventRequest();
+        message.room = object.room ?? "";
+        message.name = object.name ?? "";
+        return message;
+    },
+};
+function createBaseEventResponse() {
+    return { data: undefined, senderId: undefined };
+}
+exports.EventResponse = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.data !== undefined) {
+            struct_1.Value.encode(struct_1.Value.wrap(message.data), writer.uint32(10).fork()).ldelim();
+        }
+        if (message.senderId !== undefined) {
+            writer.uint32(16).int32(message.senderId);
+        }
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseEventResponse();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.data = struct_1.Value.unwrap(struct_1.Value.decode(reader, reader.uint32()));
+                    continue;
+                case 2:
+                    if (tag !== 16) {
+                        break;
+                    }
+                    message.senderId = reader.int32();
+                    continue;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            data: isSet(object?.data) ? object.data : undefined,
+            senderId: isSet(object.senderId) ? globalThis.Number(object.senderId) : undefined,
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.data !== undefined) {
+            obj.data = message.data;
+        }
+        if (message.senderId !== undefined) {
+            obj.senderId = Math.round(message.senderId);
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.EventResponse.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseEventResponse();
+        message.data = object.data ?? undefined;
+        message.senderId = object.senderId ?? undefined;
+        return message;
+    },
+};
+function createBaseDispatchEventRequest() {
+    return { room: "", name: "", data: undefined, targetUserIds: [] };
+}
+exports.DispatchEventRequest = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.room !== "") {
+            writer.uint32(10).string(message.room);
+        }
+        if (message.name !== "") {
+            writer.uint32(18).string(message.name);
+        }
+        if (message.data !== undefined) {
+            struct_1.Value.encode(struct_1.Value.wrap(message.data), writer.uint32(26).fork()).ldelim();
+        }
+        writer.uint32(34).fork();
+        for (const v of message.targetUserIds) {
+            writer.int32(v);
+        }
+        writer.ldelim();
+        return writer;
+    },
+    decode(input, length) {
+        const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
+        let end = length === undefined ? reader.len : reader.pos + length;
+        const message = createBaseDispatchEventRequest();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag !== 10) {
+                        break;
+                    }
+                    message.room = reader.string();
+                    continue;
+                case 2:
+                    if (tag !== 18) {
+                        break;
+                    }
+                    message.name = reader.string();
+                    continue;
+                case 3:
+                    if (tag !== 26) {
+                        break;
+                    }
+                    message.data = struct_1.Value.unwrap(struct_1.Value.decode(reader, reader.uint32()));
+                    continue;
+                case 4:
+                    if (tag === 32) {
+                        message.targetUserIds.push(reader.int32());
+                        continue;
+                    }
+                    if (tag === 34) {
+                        const end2 = reader.uint32() + reader.pos;
+                        while (reader.pos < end2) {
+                            message.targetUserIds.push(reader.int32());
+                        }
+                        continue;
+                    }
+                    break;
+            }
+            if ((tag & 7) === 4 || tag === 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            room: isSet(object.room) ? globalThis.String(object.room) : "",
+            name: isSet(object.name) ? globalThis.String(object.name) : "",
+            data: isSet(object?.data) ? object.data : undefined,
+            targetUserIds: globalThis.Array.isArray(object?.targetUserIds)
+                ? object.targetUserIds.map((e) => globalThis.Number(e))
+                : [],
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.room !== "") {
+            obj.room = message.room;
+        }
+        if (message.name !== "") {
+            obj.name = message.name;
+        }
+        if (message.data !== undefined) {
+            obj.data = message.data;
+        }
+        if (message.targetUserIds?.length) {
+            obj.targetUserIds = message.targetUserIds.map((e) => Math.round(e));
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.DispatchEventRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseDispatchEventRequest();
+        message.room = object.room ?? "";
+        message.name = object.name ?? "";
+        message.data = object.data ?? undefined;
+        message.targetUserIds = object.targetUserIds?.map((e) => e) || [];
+        return message;
+    },
+};
 exports.RoomApiDefinition = {
     name: "RoomApi",
     fullName: "roomApi.RoomApi",
@@ -192,6 +442,24 @@ exports.RoomApiDefinition = {
             responseStream: false,
             options: {},
         },
+        /** Dispatch an event to all users in the room */
+        broadcastEvent: {
+            name: "broadcastEvent",
+            requestType: exports.DispatchEventRequest,
+            requestStream: false,
+            responseType: empty_1.Empty,
+            responseStream: false,
+            options: {},
+        },
+        /** Listen to events dispatched in the room */
+        listenToEvent: {
+            name: "listenToEvent",
+            requestType: exports.EventRequest,
+            requestStream: false,
+            responseType: exports.EventResponse,
+            responseStream: true,
+            options: {},
+        },
     },
 };
 function isSet(value) {

package/dist/example_events.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+const apiKey = process.env.ROOM_API_SECRET_KEY;
+if (!apiKey) {
+    throw new Error("No ROOM_API_SECRET_KEY defined on environment variables!");
+}
+const client = (0, index_1.createRoomApiClient)(apiKey, "room-api.workadventure.localhost", 80);
+// URL of the room you wish to interact with
+const roomUrl = "http://play.workadventure.localhost/_/global/maps.workadventure.localhost/tests/Variables/shared_variables.json";
+// Name of the event with which you want to interact
+const eventName = "my-event";
+async function init() {
+    // Send an event in 5 seconds
+    setTimeout(async () => {
+        console.log("Sending event: { foo: \"Default Value\" }");
+        await client.broadcastEvent({
+            name: eventName,
+            room: roomUrl,
+            data: { foo: "Default Value" },
+        });
+        console.log("Event sent: { foo: \"Default Value\" }");
+    }, 1000);
+    // Listen a event
+    const events = client.listenToEvent({
+        name: eventName,
+        room: roomUrl,
+    });
+    for await (const event of events) {
+        console.log("Event", event);
+        console.log("Sender:", event.senderId);
+        console.log("Value:", event.data);
+        break;
+    }
+}
+init();

package/dist/example_variables.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/{example.js → example_variables.js}

@@ -22,6 +22,7 @@ async function init() {
         name: variableName,
         room: roomUrl,
     });
+    console.log("Value read plain:", value);
     console.log("Value read:", struct_1.Value.unwrap(value));
     // Save a variable in 5sec
     setTimeout(async () => {
@@ -38,6 +39,7 @@ async function init() {
         room: roomUrl,
     });
     for await (const value of listenVariable) {
+        console.log("Value listened plain:", value);
         console.log("Value listened:", struct_1.Value.unwrap(value));
         break;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workadventure/room-api-client",
-  "version": "v1.17.6",
+  "version": "v1.18.0",
   "description": "Workadventure Room Api Client",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -10,7 +10,8 @@
   "scripts": {
     "ts-proto": "grpc_tools_node_protoc --plugin=./node_modules/.bin/protoc-gen-ts_proto --ts_proto_out=./src/compiled_proto --ts_proto_opt=\"outputServices=nice-grpc,outputServices=generic-definitions,useExactTypes=false\" --proto_path=../../../messages/protos ../../../messages/protos/room-api.proto",
     "build": "tsc --build",
-    "example": "tsx ./src/example.ts",
+    "example-variables": "tsx ./src/example_variables.ts",
+    "example-events": "tsx ./src/example_events.ts",
     "lint": "eslint --ext .js,.ts .",
     "lint-fix": "eslint --fix --ext .js,.ts .",
     "format": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\"",
@@ -44,10 +45,11 @@
     "@typescript-eslint/parser": "^5.56.0",
     "eslint": "^8.36.0",
     "eslint-config-prettier": "^8.8.0",
+    "eslint-plugin-rxjs": "^5.0.3",
     "grpc-tools": "^1.12.4",
     "lint-staged": "^13.2.0",
     "prettier": "^2.8.6",
-    "ts-proto": "^1.143.0",
+    "ts-proto": "^1.164.1",
     "tsx": "^3.12.10",
     "typescript": "^5.0.2"
   },