@workadventure/room-api-client 1.0.0

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 WorkAdventu.re
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,79 @@
+
+# @workadventure/room-api-client
+
+Easily create a GRPC client to connect your service to the [Room API](https://github.com/thecodingmachine/workadventure/blob/master/docs/master/roomAPI.md) of a [WorkAdventure](https://workadventu.re) server.
+
+
+## Installation
+
+```bash
+  npm install @workadventure/room-api-client
+```
+
+## Usage/Examples
+
+```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-team/my-world";
+
+// Name of the variable with which you want to interact
+const variableName = "textField";
+
+async function init() {
+  // Save a variable
+  await client.saveVariable({
+    name: variableName,
+    room: roomUrl,
+    value: "Default Value",
+  });
+
+  console.log("Value saved: Default Value");
+
+  // Read a variable
+  const value = await client.readVariable({
+    name: variableName,
+    room: roomUrl,
+  });
+
+  console.log("Value read:", Value.unwrap(value));
+
+  // Save a variable in 5sec
+  setTimeout(async () => {
+    await client.saveVariable({
+      name: variableName,
+      room: roomUrl,
+      value: "New Value",
+    });
+
+    console.log("Value saved: New Value");
+  }, 5000);
+
+  // Listen a variable
+  const listenVariable = client.listenVariable({
+    name: variableName,
+    room: roomUrl,
+  });
+
+  for await (const value of listenVariable) {
+    console.log("Value listened:", Value.unwrap(value));
+    break;
+  }
+}
+
+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.

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

@@ -0,0 +1,28 @@
+import * as _m0 from "protobufjs/minimal";
+export declare const protobufPackage = "google.protobuf";
+/**
+ * A generic empty message that you can re-use to avoid defining duplicated
+ * empty messages in your APIs. A typical example is to use it as the request
+ * or the response type of an API method. For instance:
+ *
+ *     service Foo {
+ *       rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
+ *     }
+ *
+ * The JSON representation for `Empty` is empty JSON object `{}`.
+ */
+export interface Empty {
+}
+export declare const Empty: {
+    encode(_: Empty, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): Empty;
+    fromJSON(_: any): Empty;
+    toJSON(_: Empty): unknown;
+    create(base?: DeepPartial<Empty>): 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 {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+export {};

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

@@ -0,0 +1,66 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Empty = exports.protobufPackage = void 0;
+/* eslint-disable */
+const _m0 = __importStar(require("protobufjs/minimal"));
+exports.protobufPackage = "google.protobuf";
+function createBaseEmpty() {
+    return {};
+}
+exports.Empty = {
+    encode(_, writer = _m0.Writer.create()) {
+        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 = createBaseEmpty();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+            }
+            if ((tag & 7) == 4 || tag == 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(_) {
+        return {};
+    },
+    toJSON(_) {
+        const obj = {};
+        return obj;
+    },
+    create(base) {
+        return exports.Empty.fromPartial(base ?? {});
+    },
+    fromPartial(_) {
+        const message = createBaseEmpty();
+        return message;
+    },
+};

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

@@ -0,0 +1,115 @@
+import * as _m0 from "protobufjs/minimal";
+export declare const protobufPackage = "google.protobuf";
+/**
+ * `NullValue` is a singleton enumeration to represent the null value for the
+ * `Value` type union.
+ *
+ *  The JSON representation for `NullValue` is JSON `null`.
+ */
+export declare enum NullValue {
+    /** NULL_VALUE - Null value. */
+    NULL_VALUE = 0,
+    UNRECOGNIZED = -1
+}
+export declare function nullValueFromJSON(object: any): NullValue;
+export declare function nullValueToJSON(object: NullValue): string;
+/**
+ * `Struct` represents a structured data value, consisting of fields
+ * which map to dynamically typed values. In some languages, `Struct`
+ * might be supported by a native representation. For example, in
+ * scripting languages like JS a struct is represented as an
+ * object. The details of that representation are described together
+ * with the proto support for the language.
+ *
+ * The JSON representation for `Struct` is JSON object.
+ */
+export interface Struct {
+    /** Unordered map of dynamically typed values. */
+    fields: {
+        [key: string]: any | undefined;
+    };
+}
+export interface Struct_FieldsEntry {
+    key: string;
+    value: any | undefined;
+}
+/**
+ * `Value` represents a dynamically typed value which can be either
+ * null, a number, a string, a boolean, a recursive struct value, or a
+ * list of values. A producer of value is expected to set one of these
+ * variants. Absence of any variant indicates an error.
+ *
+ * The JSON representation for `Value` is JSON value.
+ */
+export interface Value {
+    /** Represents a null value. */
+    nullValue?: NullValue | undefined;
+    /** Represents a double value. */
+    numberValue?: number | undefined;
+    /** Represents a string value. */
+    stringValue?: string | undefined;
+    /** Represents a boolean value. */
+    boolValue?: boolean | undefined;
+    /** Represents a structured value. */
+    structValue?: {
+        [key: string]: any;
+    } | undefined;
+    /** Represents a repeated `Value`. */
+    listValue?: Array<any> | undefined;
+}
+/**
+ * `ListValue` is a wrapper around a repeated field of values.
+ *
+ * The JSON representation for `ListValue` is JSON array.
+ */
+export interface ListValue {
+    /** Repeated field of dynamically typed values. */
+    values: any[];
+}
+export declare const Struct: {
+    encode(message: Struct, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): Struct;
+    fromJSON(object: any): Struct;
+    toJSON(message: Struct): unknown;
+    create(base?: DeepPartial<Struct>): Struct;
+    fromPartial(object: DeepPartial<Struct>): Struct;
+    wrap(object: {
+        [key: string]: any;
+    } | undefined): Struct;
+    unwrap(message: Struct): {
+        [key: string]: any;
+    };
+};
+export declare const Struct_FieldsEntry: {
+    encode(message: Struct_FieldsEntry, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): Struct_FieldsEntry;
+    fromJSON(object: any): Struct_FieldsEntry;
+    toJSON(message: Struct_FieldsEntry): unknown;
+    create(base?: DeepPartial<Struct_FieldsEntry>): Struct_FieldsEntry;
+    fromPartial(object: DeepPartial<Struct_FieldsEntry>): Struct_FieldsEntry;
+};
+export declare const Value: {
+    encode(message: Value, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): Value;
+    fromJSON(object: any): Value;
+    toJSON(message: Value): unknown;
+    create(base?: DeepPartial<Value>): Value;
+    fromPartial(object: DeepPartial<Value>): Value;
+    wrap(value: any): Value;
+    unwrap(message: any): string | number | boolean | Object | null | Array<any> | undefined;
+};
+export declare const ListValue: {
+    encode(message: ListValue, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): ListValue;
+    fromJSON(object: any): ListValue;
+    toJSON(message: ListValue): unknown;
+    create(base?: DeepPartial<ListValue>): ListValue;
+    fromPartial(object: DeepPartial<ListValue>): ListValue;
+    wrap(array: Array<any> | undefined): 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 {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+export {};

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

@@ -0,0 +1,446 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ListValue = exports.Value = exports.Struct_FieldsEntry = exports.Struct = exports.nullValueToJSON = exports.nullValueFromJSON = exports.NullValue = exports.protobufPackage = void 0;
+/* eslint-disable */
+const _m0 = __importStar(require("protobufjs/minimal"));
+exports.protobufPackage = "google.protobuf";
+/**
+ * `NullValue` is a singleton enumeration to represent the null value for the
+ * `Value` type union.
+ *
+ *  The JSON representation for `NullValue` is JSON `null`.
+ */
+var NullValue;
+(function (NullValue) {
+    /** NULL_VALUE - Null value. */
+    NullValue[NullValue["NULL_VALUE"] = 0] = "NULL_VALUE";
+    NullValue[NullValue["UNRECOGNIZED"] = -1] = "UNRECOGNIZED";
+})(NullValue = exports.NullValue || (exports.NullValue = {}));
+function nullValueFromJSON(object) {
+    switch (object) {
+        case 0:
+        case "NULL_VALUE":
+            return NullValue.NULL_VALUE;
+        case -1:
+        case "UNRECOGNIZED":
+        default:
+            return NullValue.UNRECOGNIZED;
+    }
+}
+exports.nullValueFromJSON = nullValueFromJSON;
+function nullValueToJSON(object) {
+    switch (object) {
+        case NullValue.NULL_VALUE:
+            return "NULL_VALUE";
+        case NullValue.UNRECOGNIZED:
+        default:
+            return "UNRECOGNIZED";
+    }
+}
+exports.nullValueToJSON = nullValueToJSON;
+function createBaseStruct() {
+    return { fields: {} };
+}
+exports.Struct = {
+    encode(message, writer = _m0.Writer.create()) {
+        Object.entries(message.fields).forEach(([key, value]) => {
+            if (value !== undefined) {
+                exports.Struct_FieldsEntry.encode({ key: key, value }, writer.uint32(10).fork()).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 = createBaseStruct();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag != 10) {
+                        break;
+                    }
+                    const entry1 = exports.Struct_FieldsEntry.decode(reader, reader.uint32());
+                    if (entry1.value !== undefined) {
+                        message.fields[entry1.key] = entry1.value;
+                    }
+                    continue;
+            }
+            if ((tag & 7) == 4 || tag == 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            fields: isObject(object.fields)
+                ? Object.entries(object.fields).reduce((acc, [key, value]) => {
+                    acc[key] = value;
+                    return acc;
+                }, {})
+                : {},
+        };
+    },
+    toJSON(message) {
+        const obj = {};
+        obj.fields = {};
+        if (message.fields) {
+            Object.entries(message.fields).forEach(([k, v]) => {
+                obj.fields[k] = v;
+            });
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.Struct.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseStruct();
+        message.fields = Object.entries(object.fields ?? {}).reduce((acc, [key, value]) => {
+            if (value !== undefined) {
+                acc[key] = value;
+            }
+            return acc;
+        }, {});
+        return message;
+    },
+    wrap(object) {
+        const struct = createBaseStruct();
+        if (object !== undefined) {
+            Object.keys(object).forEach((key) => {
+                struct.fields[key] = object[key];
+            });
+        }
+        return struct;
+    },
+    unwrap(message) {
+        const object = {};
+        if (message.fields) {
+            Object.keys(message.fields).forEach((key) => {
+                object[key] = message.fields[key];
+            });
+        }
+        return object;
+    },
+};
+function createBaseStruct_FieldsEntry() {
+    return { key: "", value: undefined };
+}
+exports.Struct_FieldsEntry = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.key !== "") {
+            writer.uint32(10).string(message.key);
+        }
+        if (message.value !== undefined) {
+            exports.Value.encode(exports.Value.wrap(message.value), writer.uint32(18).fork()).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 = createBaseStruct_FieldsEntry();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag != 10) {
+                        break;
+                    }
+                    message.key = reader.string();
+                    continue;
+                case 2:
+                    if (tag != 18) {
+                        break;
+                    }
+                    message.value = exports.Value.unwrap(exports.Value.decode(reader, reader.uint32()));
+                    continue;
+            }
+            if ((tag & 7) == 4 || tag == 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return { key: isSet(object.key) ? 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);
+        return obj;
+    },
+    create(base) {
+        return exports.Struct_FieldsEntry.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseStruct_FieldsEntry();
+        message.key = object.key ?? "";
+        message.value = object.value ?? undefined;
+        return message;
+    },
+};
+function createBaseValue() {
+    return {
+        nullValue: undefined,
+        numberValue: undefined,
+        stringValue: undefined,
+        boolValue: undefined,
+        structValue: undefined,
+        listValue: undefined,
+    };
+}
+exports.Value = {
+    encode(message, writer = _m0.Writer.create()) {
+        if (message.nullValue !== undefined) {
+            writer.uint32(8).int32(message.nullValue);
+        }
+        if (message.numberValue !== undefined) {
+            writer.uint32(17).double(message.numberValue);
+        }
+        if (message.stringValue !== undefined) {
+            writer.uint32(26).string(message.stringValue);
+        }
+        if (message.boolValue !== undefined) {
+            writer.uint32(32).bool(message.boolValue);
+        }
+        if (message.structValue !== undefined) {
+            exports.Struct.encode(exports.Struct.wrap(message.structValue), writer.uint32(42).fork()).ldelim();
+        }
+        if (message.listValue !== undefined) {
+            exports.ListValue.encode(exports.ListValue.wrap(message.listValue), writer.uint32(50).fork()).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 = createBaseValue();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag != 8) {
+                        break;
+                    }
+                    message.nullValue = reader.int32();
+                    continue;
+                case 2:
+                    if (tag != 17) {
+                        break;
+                    }
+                    message.numberValue = reader.double();
+                    continue;
+                case 3:
+                    if (tag != 26) {
+                        break;
+                    }
+                    message.stringValue = reader.string();
+                    continue;
+                case 4:
+                    if (tag != 32) {
+                        break;
+                    }
+                    message.boolValue = reader.bool();
+                    continue;
+                case 5:
+                    if (tag != 42) {
+                        break;
+                    }
+                    message.structValue = exports.Struct.unwrap(exports.Struct.decode(reader, reader.uint32()));
+                    continue;
+                case 6:
+                    if (tag != 50) {
+                        break;
+                    }
+                    message.listValue = exports.ListValue.unwrap(exports.ListValue.decode(reader, reader.uint32()));
+                    continue;
+            }
+            if ((tag & 7) == 4 || tag == 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    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,
+            structValue: isObject(object.structValue) ? object.structValue : undefined,
+            listValue: 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);
+        return obj;
+    },
+    create(base) {
+        return exports.Value.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseValue();
+        message.nullValue = object.nullValue ?? undefined;
+        message.numberValue = object.numberValue ?? undefined;
+        message.stringValue = object.stringValue ?? undefined;
+        message.boolValue = object.boolValue ?? undefined;
+        message.structValue = object.structValue ?? undefined;
+        message.listValue = object.listValue ?? undefined;
+        return message;
+    },
+    wrap(value) {
+        const result = createBaseValue();
+        if (value === null) {
+            result.nullValue = NullValue.NULL_VALUE;
+        }
+        else if (typeof value === "boolean") {
+            result.boolValue = value;
+        }
+        else if (typeof value === "number") {
+            result.numberValue = value;
+        }
+        else if (typeof value === "string") {
+            result.stringValue = value;
+        }
+        else if (Array.isArray(value)) {
+            result.listValue = value;
+        }
+        else if (typeof value === "object") {
+            result.structValue = value;
+        }
+        else if (typeof value !== "undefined") {
+            throw new Error("Unsupported any value type: " + typeof value);
+        }
+        return result;
+    },
+    unwrap(message) {
+        if (message.stringValue !== undefined) {
+            return message.stringValue;
+        }
+        else if (message?.numberValue !== undefined) {
+            return message.numberValue;
+        }
+        else if (message?.boolValue !== undefined) {
+            return message.boolValue;
+        }
+        else if (message?.structValue !== undefined) {
+            return message.structValue;
+        }
+        else if (message?.listValue !== undefined) {
+            return message.listValue;
+        }
+        else if (message?.nullValue !== undefined) {
+            return null;
+        }
+        return undefined;
+    },
+};
+function createBaseListValue() {
+    return { values: [] };
+}
+exports.ListValue = {
+    encode(message, writer = _m0.Writer.create()) {
+        for (const v of message.values) {
+            exports.Value.encode(exports.Value.wrap(v), writer.uint32(10).fork()).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 = createBaseListValue();
+        while (reader.pos < end) {
+            const tag = reader.uint32();
+            switch (tag >>> 3) {
+                case 1:
+                    if (tag != 10) {
+                        break;
+                    }
+                    message.values.push(exports.Value.unwrap(exports.Value.decode(reader, reader.uint32())));
+                    continue;
+            }
+            if ((tag & 7) == 4 || tag == 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return { values: Array.isArray(object?.values) ? [...object.values] : [] };
+    },
+    toJSON(message) {
+        const obj = {};
+        if (message.values) {
+            obj.values = message.values.map((e) => e);
+        }
+        else {
+            obj.values = [];
+        }
+        return obj;
+    },
+    create(base) {
+        return exports.ListValue.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseListValue();
+        message.values = object.values?.map((e) => e) || [];
+        return message;
+    },
+    wrap(array) {
+        const result = createBaseListValue();
+        result.values = array ?? [];
+        return result;
+    },
+    unwrap(message) {
+        if (message?.hasOwnProperty("values") && Array.isArray(message.values)) {
+            return message.values;
+        }
+        else {
+            return message;
+        }
+    },
+};
+function isObject(value) {
+    return typeof value === "object" && value !== null;
+}
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

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

@@ -0,0 +1,170 @@
+import type { CallContext, CallOptions } from "nice-grpc-common";
+import * as _m0 from "protobufjs/minimal";
+import { Empty } from "./google/protobuf/empty";
+import { Value } from "./google/protobuf/struct";
+export declare const protobufPackage = "roomApi";
+export interface VariableRequest {
+    room: string;
+    name: string;
+}
+export interface SaveVariableRequest {
+    room: string;
+    name: string;
+    value: any | undefined;
+}
+export declare const VariableRequest: {
+    encode(message: VariableRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): VariableRequest;
+    fromJSON(object: any): VariableRequest;
+    toJSON(message: VariableRequest): unknown;
+    create(base?: DeepPartial<VariableRequest>): VariableRequest;
+    fromPartial(object: DeepPartial<VariableRequest>): VariableRequest;
+};
+export declare const SaveVariableRequest: {
+    encode(message: SaveVariableRequest, writer?: _m0.Writer): _m0.Writer;
+    decode(input: _m0.Reader | Uint8Array, length?: number): SaveVariableRequest;
+    fromJSON(object: any): SaveVariableRequest;
+    toJSON(message: SaveVariableRequest): unknown;
+    create(base?: DeepPartial<SaveVariableRequest>): SaveVariableRequest;
+    fromPartial(object: DeepPartial<SaveVariableRequest>): SaveVariableRequest;
+};
+export type RoomApiDefinition = typeof RoomApiDefinition;
+export declare const RoomApiDefinition: {
+    readonly name: "RoomApi";
+    readonly fullName: "roomApi.RoomApi";
+    readonly methods: {
+        /** Get the current value of the given variable */
+        readonly readVariable: {
+            readonly name: "readVariable";
+            readonly requestType: {
+                encode(message: VariableRequest, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): VariableRequest;
+                fromJSON(object: any): VariableRequest;
+                toJSON(message: VariableRequest): unknown;
+                create(base?: DeepPartial<VariableRequest>): VariableRequest;
+                fromPartial(object: DeepPartial<VariableRequest>): VariableRequest;
+            };
+            readonly requestStream: false;
+            readonly responseType: {
+                encode(message: Value, writer?: _m0.Writer): _m0.Writer;
+                decode(input: Uint8Array | _m0.Reader, length?: number | undefined): Value;
+                fromJSON(object: any): Value;
+                toJSON(message: Value): unknown;
+                create(base?: {
+                    nullValue?: import("./google/protobuf/struct").NullValue | undefined;
+                    numberValue?: number | undefined;
+                    stringValue?: string | undefined;
+                    boolValue?: boolean | undefined;
+                    structValue?: {
+                        [x: string]: any;
+                    } | undefined;
+                    listValue?: any[] | undefined;
+                } | undefined): Value;
+                fromPartial(object: {
+                    nullValue?: import("./google/protobuf/struct").NullValue | undefined;
+                    numberValue?: number | undefined;
+                    stringValue?: string | undefined;
+                    boolValue?: boolean | undefined;
+                    structValue?: {
+                        [x: string]: any;
+                    } | undefined;
+                    listValue?: any[] | undefined;
+                }): Value;
+                wrap(value: any): Value;
+                unwrap(message: any): string | number | boolean | Object | any[] | null | undefined;
+            };
+            readonly responseStream: false;
+            readonly options: {};
+        };
+        /** Listen to value updates for a given variable */
+        readonly listenVariable: {
+            readonly name: "listenVariable";
+            readonly requestType: {
+                encode(message: VariableRequest, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): VariableRequest;
+                fromJSON(object: any): VariableRequest;
+                toJSON(message: VariableRequest): unknown;
+                create(base?: DeepPartial<VariableRequest>): VariableRequest;
+                fromPartial(object: DeepPartial<VariableRequest>): VariableRequest;
+            };
+            readonly requestStream: false;
+            readonly responseType: {
+                encode(message: Value, writer?: _m0.Writer): _m0.Writer;
+                decode(input: Uint8Array | _m0.Reader, length?: number | undefined): Value;
+                fromJSON(object: any): Value;
+                toJSON(message: Value): unknown;
+                create(base?: {
+                    nullValue?: import("./google/protobuf/struct").NullValue | undefined;
+                    numberValue?: number | undefined;
+                    stringValue?: string | undefined;
+                    boolValue?: boolean | undefined;
+                    structValue?: {
+                        [x: string]: any;
+                    } | undefined;
+                    listValue?: any[] | undefined;
+                } | undefined): Value;
+                fromPartial(object: {
+                    nullValue?: import("./google/protobuf/struct").NullValue | undefined;
+                    numberValue?: number | undefined;
+                    stringValue?: string | undefined;
+                    boolValue?: boolean | undefined;
+                    structValue?: {
+                        [x: string]: any;
+                    } | undefined;
+                    listValue?: any[] | undefined;
+                }): Value;
+                wrap(value: any): Value;
+                unwrap(message: any): string | number | boolean | Object | any[] | null | undefined;
+            };
+            readonly responseStream: true;
+            readonly options: {};
+        };
+        /** Set the value of the given variable */
+        readonly saveVariable: {
+            readonly name: "saveVariable";
+            readonly requestType: {
+                encode(message: SaveVariableRequest, writer?: _m0.Writer): _m0.Writer;
+                decode(input: _m0.Reader | Uint8Array, length?: number): SaveVariableRequest;
+                fromJSON(object: any): SaveVariableRequest;
+                toJSON(message: SaveVariableRequest): unknown;
+                create(base?: DeepPartial<SaveVariableRequest>): SaveVariableRequest;
+                fromPartial(object: DeepPartial<SaveVariableRequest>): SaveVariableRequest;
+            };
+            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: {};
+        };
+    };
+};
+export interface RoomApiServiceImplementation<CallContextExt = {}> {
+    /** Get the current value of the given variable */
+    readVariable(request: VariableRequest, context: CallContext & CallContextExt): Promise<DeepPartial<Value>>;
+    /** Listen to value updates for a given variable */
+    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>>;
+}
+export interface RoomApiClient<CallOptionsExt = {}> {
+    /** Get the current value of the given variable */
+    readVariable(request: DeepPartial<VariableRequest>, options?: CallOptions & CallOptionsExt): Promise<Value>;
+    /** Listen to value updates for a given variable */
+    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>;
+}
+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 {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+export type ServerStreamingMethodResult<Response> = {
+    [Symbol.asyncIterator](): AsyncIterator<Response, void>;
+};
+export {};

package/dist/compiled_proto/room-api.js

@@ -0,0 +1,199 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoomApiDefinition = 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");
+exports.protobufPackage = "roomApi";
+function createBaseVariableRequest() {
+    return { room: "", name: "" };
+}
+exports.VariableRequest = {
+    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 = createBaseVariableRequest();
+        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) ? String(object.room) : "", name: isSet(object.name) ? String(object.name) : "" };
+    },
+    toJSON(message) {
+        const obj = {};
+        message.room !== undefined && (obj.room = message.room);
+        message.name !== undefined && (obj.name = message.name);
+        return obj;
+    },
+    create(base) {
+        return exports.VariableRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseVariableRequest();
+        message.room = object.room ?? "";
+        message.name = object.name ?? "";
+        return message;
+    },
+};
+function createBaseSaveVariableRequest() {
+    return { room: "", name: "", value: undefined };
+}
+exports.SaveVariableRequest = {
+    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.value !== undefined) {
+            struct_1.Value.encode(struct_1.Value.wrap(message.value), writer.uint32(26).fork()).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 = createBaseSaveVariableRequest();
+        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.value = struct_1.Value.unwrap(struct_1.Value.decode(reader, reader.uint32()));
+                    continue;
+            }
+            if ((tag & 7) == 4 || tag == 0) {
+                break;
+            }
+            reader.skipType(tag & 7);
+        }
+        return message;
+    },
+    fromJSON(object) {
+        return {
+            room: isSet(object.room) ? String(object.room) : "",
+            name: isSet(object.name) ? 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);
+        return obj;
+    },
+    create(base) {
+        return exports.SaveVariableRequest.fromPartial(base ?? {});
+    },
+    fromPartial(object) {
+        const message = createBaseSaveVariableRequest();
+        message.room = object.room ?? "";
+        message.name = object.name ?? "";
+        message.value = object.value ?? undefined;
+        return message;
+    },
+};
+exports.RoomApiDefinition = {
+    name: "RoomApi",
+    fullName: "roomApi.RoomApi",
+    methods: {
+        /** Get the current value of the given variable */
+        readVariable: {
+            name: "readVariable",
+            requestType: exports.VariableRequest,
+            requestStream: false,
+            responseType: struct_1.Value,
+            responseStream: false,
+            options: {},
+        },
+        /** Listen to value updates for a given variable */
+        listenVariable: {
+            name: "listenVariable",
+            requestType: exports.VariableRequest,
+            requestStream: false,
+            responseType: struct_1.Value,
+            responseStream: true,
+            options: {},
+        },
+        /** Set the value of the given variable */
+        saveVariable: {
+            name: "saveVariable",
+            requestType: exports.SaveVariableRequest,
+            requestStream: false,
+            responseType: empty_1.Empty,
+            responseStream: false,
+            options: {},
+        },
+    },
+};
+function isSet(value) {
+    return value !== null && value !== undefined;
+}

package/dist/example.d.ts

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

package/dist/example.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const struct_1 = require("./compiled_proto/google/protobuf/struct");
+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);
+const roomUrl = "http://play.workadventure.localhost/_/global/maps.workadventure.localhost/tests/Variables/shared_variables.json";
+const variableName = "textField";
+async function init() {
+    // Save a variable
+    await client.saveVariable({
+        name: variableName,
+        room: roomUrl,
+        value: "Default Value",
+    });
+    console.log("Value saved: Default Value");
+    // Read a variable
+    const value = await client.readVariable({
+        name: variableName,
+        room: roomUrl,
+    });
+    console.log("Value read:", struct_1.Value.unwrap(value));
+    // Save a variable in 5sec
+    setTimeout(async () => {
+        await client.saveVariable({
+            name: variableName,
+            room: roomUrl,
+            value: "New Value",
+        });
+        console.log("Value saved: New Value");
+    }, 5000);
+    // Listen a variable
+    const listenVariable = client.listenVariable({
+        name: variableName,
+        room: roomUrl,
+    });
+    for await (const value of listenVariable) {
+        console.log("Value listened:", struct_1.Value.unwrap(value));
+        break;
+    }
+}
+init();

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./compiled_proto/room-api";
+import { RoomApiClient } from "./compiled_proto/room-api";
+export declare const createRoomApiClient: (apiKey: string, host?: string, port?: number) => RoomApiClient<{}>;

package/dist/index.js

@@ -0,0 +1,30 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRoomApiClient = void 0;
+__exportStar(require("./compiled_proto/room-api"), exports);
+const nice_grpc_1 = require("nice-grpc");
+const room_api_1 = require("./compiled_proto/room-api");
+const createRoomApiClient = (apiKey, host = "room-api.workadventu.re", port = 443) => {
+    const channel = (0, nice_grpc_1.createChannel)(`${host}:${port}`, port === 443 || host.startsWith("https://") ? nice_grpc_1.ChannelCredentials.createSsl() : nice_grpc_1.ChannelCredentials.createInsecure());
+    const client = (0, nice_grpc_1.createClient)(room_api_1.RoomApiDefinition, channel, {
+        "*": {
+            metadata: new nice_grpc_1.Metadata({ "X-API-Key": apiKey }),
+        }
+    });
+    return client;
+};
+exports.createRoomApiClient = createRoomApiClient;

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@workadventure/room-api-client",
+  "version": "1.0.0",
+  "description": "Workadventure Room Api Client",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "/dist"
+  ],
+  "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": "ts-node ./src/example.ts",
+    "lint": "eslint --ext .js,.ts .",
+    "lint-fix": "eslint --fix --ext .js,.ts .",
+    "format": "prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\"",
+    "format-check": "prettier --ignore-path .gitignore \"**/*.+(js|ts|json)\"",
+    "precommit": "lint-staged"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/thecodingmachine/workadventure.git#master"
+  },
+  "keywords": [
+    "workadventure",
+    "room",
+    "api",
+    "grpc"
+  ],
+  "author": "WorkAdventure",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/thecodingmachine/workadventure/issues"
+  },
+  "homepage": "https://github.com/thecodingmachine/workadventure/tree/master/libs/room-api-clients/room-api-client-js#readme",
+  "dependencies": {
+    "long": "^5.2.1",
+    "nice-grpc": "^2.1.3",
+    "protobufjs": "^7.2.2"
+  },
+  "devDependencies": {
+    "@types/node": "^18.15.5",
+    "@typescript-eslint/eslint-plugin": "^5.56.0",
+    "@typescript-eslint/parser": "^5.56.0",
+    "eslint": "^8.36.0",
+    "eslint-config-prettier": "^8.8.0",
+    "grpc-tools": "^1.12.4",
+    "lint-staged": "^13.2.0",
+    "prettier": "^2.8.6",
+    "ts-node": "^10.9.1",
+    "ts-proto": "^1.143.0",
+    "typescript": "^5.0.2"
+  },
+  "lint-staged": {
+    "*.{js,ts}": [
+      "eslint --fix"
+    ],
+    "*.{js,ts,json}": [
+      "prettier --write"
+    ]
+  }
+}