@companion-module/base 0.1.2 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [0.2.0](https://github.com/bitfocus/companion-module-base/compare/v0.1.2...v0.2.0) (2022-09-04)
+
+
+### Features
+
+* convert InstanceStatus into proper enum ([73213ab](https://github.com/bitfocus/companion-module-base/commit/73213ab4976168c5e7241ef0c8ea906464cef297))
+* initial refactored socket helpers ([603b806](https://github.com/bitfocus/companion-module-base/commit/603b80655cf85a5577b28ae06c32e109f23b8755))
+
 ## [0.1.2](https://github.com/bitfocus/companion-module-base/compare/v0.1.1...v0.1.2) (2022-07-21)
 
 

package/dist/helpers/index.d.ts

@@ -0,0 +1,4 @@
+export { TCPHelper, TCPHelperEvents, TCPHelperOptions } from './tcp';
+export { TelnetHelper, TelnetHelperEvents, TelnetHelperOptions } from './telnet';
+export { UDPHelper, UDPHelperEvents, UDPHelperOptions } from './udp';
+//# sourceMappingURL=index.d.ts.map

package/dist/helpers/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAA;AACpE,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAA;AAChF,OAAO,EAAE,SAAS,EAAE,eAAe,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAA"}

package/dist/helpers/index.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UDPHelper = exports.TelnetHelper = exports.TCPHelper = void 0;
+var tcp_1 = require("./tcp");
+Object.defineProperty(exports, "TCPHelper", { enumerable: true, get: function () { return tcp_1.TCPHelper; } });
+var telnet_1 = require("./telnet");
+Object.defineProperty(exports, "TelnetHelper", { enumerable: true, get: function () { return telnet_1.TelnetHelper; } });
+var udp_1 = require("./udp");
+Object.defineProperty(exports, "UDPHelper", { enumerable: true, get: function () { return udp_1.UDPHelper; } });
+//# sourceMappingURL=index.js.map

package/dist/helpers/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/helpers/index.ts"],"names":[],"mappings":";;;AAAA,6BAAoE;AAA3D,gGAAA,SAAS,OAAA;AAClB,mCAAgF;AAAvE,sGAAA,YAAY,OAAA;AACrB,6BAAoE;AAA3D,gGAAA,SAAS,OAAA"}

package/dist/helpers/tcp.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import net from 'net';
+import { EventEmitter } from 'eventemitter3';
+import { InstanceStatus } from '../module-api/enums';
+declare type TCPStatuses = InstanceStatus.Ok | InstanceStatus.Connecting | InstanceStatus.Disconnected | InstanceStatus.UnknownError;
+export interface TCPHelperEvents {
+    error: [err: Error];
+    data: [msg: Buffer];
+    connect: [];
+    end: [];
+    drain: [];
+    status_change: [status: TCPStatuses, message: string | undefined];
+}
+export interface TCPHelperOptions {
+    /** default 2000 */
+    reconnect_interval?: number;
+    /** default true */
+    reconnect?: boolean;
+}
+export declare class TCPHelper extends EventEmitter<TCPHelperEvents> {
+    #private;
+    readonly _socket: net.Socket;
+    get isConnected(): boolean;
+    get isConnecting(): boolean;
+    get isDestroyed(): boolean;
+    constructor(host: string, port: number, options?: TCPHelperOptions);
+    connect(): boolean;
+    send(message: string | Buffer): Promise<boolean>;
+    destroy(): void;
+}
+export {};
+//# sourceMappingURL=tcp.d.ts.map

package/dist/helpers/tcp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tcp.d.ts","sourceRoot":"","sources":["../../src/helpers/tcp.ts"],"names":[],"mappings":";;AAiBA,OAAO,GAAG,MAAM,KAAK,CAAA;AACrB,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEpD,aAAK,WAAW,GACb,cAAc,CAAC,EAAE,GACjB,cAAc,CAAC,UAAU,GACzB,cAAc,CAAC,YAAY,GAC3B,cAAc,CAAC,YAAY,CAAA;AAE9B,MAAM,WAAW,eAAe;IAE/B,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAEnB,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;IAGnB,OAAO,EAAE,EAAE,CAAA;IAEX,GAAG,EAAE,EAAE,CAAA;IAEP,KAAK,EAAE,EAAE,CAAA;IAGT,aAAa,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;CACjE;AAED,MAAM,WAAW,gBAAgB;IAChC,mBAAmB;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAA;IAC3B,mBAAmB;IACnB,SAAS,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,qBAAa,SAAU,SAAQ,YAAY,CAAC,eAAe,CAAC;;IAG3D,QAAQ,CAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAA;IAS5B,IAAI,WAAW,IAAI,OAAO,CAEzB;IACD,IAAI,YAAY,IAAI,OAAO,CAE1B;IACD,IAAI,WAAW,IAAI,OAAO,CAEzB;gBAEW,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB;IA4DlE,OAAO,IAAI,OAAO;IAQZ,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IA+BtD,OAAO,IAAI,IAAI;CAiCf"}

package/dist/helpers/tcp.js

@@ -0,0 +1,153 @@
+"use strict";
+/*
+ * This file is part of the Companion project
+ * Copyright (c) 2018 Bitfocus AS
+ * Authors: William Viker <william@bitfocus.io>, Håkon Nessjøen <haakon@bitfocus.io>
+ *
+ * This program is free software.
+ * You should have received a copy of the MIT licence as well as the Bitfocus
+ * Individual Contributor License Agreement for companion along with
+ * this program.
+ *
+ * You can be released from the requirements of the license by purchasing
+ * a commercial license. Buying such a license is mandatory as soon as you
+ * develop commercial activities involving the Companion software without
+ * disclosing the source code of your own applications.
+ *
+ */
+var _TCPHelper_instances, _TCPHelper_host, _TCPHelper_port, _TCPHelper_options, _TCPHelper_connected, _TCPHelper_connecting, _TCPHelper_destroyed, _TCPHelper_lastStatus, _TCPHelper_reconnectTimer, _TCPHelper_queueReconnect, _TCPHelper_new_status;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TCPHelper = void 0;
+const tslib_1 = require("tslib");
+const net_1 = tslib_1.__importDefault(require("net"));
+const eventemitter3_1 = require("eventemitter3");
+const enums_1 = require("../module-api/enums");
+class TCPHelper extends eventemitter3_1.EventEmitter {
+    constructor(host, port, options) {
+        super();
+        _TCPHelper_instances.add(this);
+        _TCPHelper_host.set(this, void 0);
+        _TCPHelper_port.set(this, void 0);
+        _TCPHelper_options.set(this, void 0);
+        _TCPHelper_connected.set(this, false);
+        _TCPHelper_connecting.set(this, false);
+        _TCPHelper_destroyed.set(this, false);
+        _TCPHelper_lastStatus.set(this, void 0);
+        _TCPHelper_reconnectTimer.set(this, void 0);
+        tslib_1.__classPrivateFieldSet(this, _TCPHelper_host, host, "f");
+        tslib_1.__classPrivateFieldSet(this, _TCPHelper_port, port, "f");
+        tslib_1.__classPrivateFieldSet(this, _TCPHelper_options, {
+            reconnect_interval: 2000,
+            reconnect: true,
+            ...options,
+        }, "f");
+        this._socket = new net_1.default.Socket();
+        this._socket.setKeepAlive(true);
+        this._socket.setNoDelay(true);
+        this._socket.on('error', (err) => {
+            tslib_1.__classPrivateFieldSet(this, _TCPHelper_connecting, false, "f");
+            tslib_1.__classPrivateFieldSet(this, _TCPHelper_connected, false, "f");
+            if (tslib_1.__classPrivateFieldGet(this, _TCPHelper_options, "f").reconnect) {
+                tslib_1.__classPrivateFieldGet(this, _TCPHelper_instances, "m", _TCPHelper_queueReconnect).call(this);
+            }
+            tslib_1.__classPrivateFieldGet(this, _TCPHelper_instances, "m", _TCPHelper_new_status).call(this, enums_1.InstanceStatus.UnknownError, err.message);
+            this.emit('error', err);
+        });
+        this._socket.on('ready', () => {
+            tslib_1.__classPrivateFieldSet(this, _TCPHelper_connected, true, "f");
+            tslib_1.__classPrivateFieldSet(this, _TCPHelper_connecting, false, "f");
+            tslib_1.__classPrivateFieldGet(this, _TCPHelper_instances, "m", _TCPHelper_new_status).call(this, enums_1.InstanceStatus.Ok);
+            this.emit('connect');
+        });
+        this._socket.on('end', () => {
+            tslib_1.__classPrivateFieldSet(this, _TCPHelper_connected, false, "f");
+            tslib_1.__classPrivateFieldGet(this, _TCPHelper_instances, "m", _TCPHelper_new_status).call(this, enums_1.InstanceStatus.Disconnected);
+            if (!tslib_1.__classPrivateFieldGet(this, _TCPHelper_connecting, "f") && tslib_1.__classPrivateFieldGet(this, _TCPHelper_options, "f").reconnect) {
+                tslib_1.__classPrivateFieldGet(this, _TCPHelper_instances, "m", _TCPHelper_queueReconnect).call(this);
+            }
+            this.emit('end');
+        });
+        this._socket.on('data', (data) => this.emit('data', data));
+        this._socket.on('drain', () => this.emit('drain'));
+        // Let caller install event handlers first
+        setImmediate(() => this.connect());
+        setTimeout(() => {
+            if (!tslib_1.__classPrivateFieldGet(this, _TCPHelper_destroyed, "f") && !this.listenerCount('error')) {
+                // The socket is active and has no listeners. Log an error for the module devs!
+                console.error(`Danger: TCP client for ${tslib_1.__classPrivateFieldGet(this, _TCPHelper_host, "f")}:${tslib_1.__classPrivateFieldGet(this, _TCPHelper_port, "f")} is missing an error handler!`);
+            }
+        }, 5000);
+    }
+    get isConnected() {
+        return tslib_1.__classPrivateFieldGet(this, _TCPHelper_connected, "f");
+    }
+    get isConnecting() {
+        return tslib_1.__classPrivateFieldGet(this, _TCPHelper_connecting, "f");
+    }
+    get isDestroyed() {
+        return tslib_1.__classPrivateFieldGet(this, _TCPHelper_destroyed, "f");
+    }
+    connect() {
+        if (tslib_1.__classPrivateFieldGet(this, _TCPHelper_destroyed, "f"))
+            throw new Error('Cannot connect destroyed socket');
+        if (tslib_1.__classPrivateFieldGet(this, _TCPHelper_connecting, "f"))
+            return false;
+        tslib_1.__classPrivateFieldSet(this, _TCPHelper_connecting, true, "f");
+        this._socket.connect(tslib_1.__classPrivateFieldGet(this, _TCPHelper_port, "f"), tslib_1.__classPrivateFieldGet(this, _TCPHelper_host, "f"));
+        return true;
+    }
+    async send(message) {
+        if (tslib_1.__classPrivateFieldGet(this, _TCPHelper_destroyed, "f") || this._socket.destroyed)
+            throw new Error('Cannot write to destroyed socket');
+        if (!message || !message.length)
+            throw new Error('No message to send');
+        if (!tslib_1.__classPrivateFieldGet(this, _TCPHelper_connected, "f")) {
+            return false;
+        }
+        try {
+            return new Promise((resolve, reject) => {
+                this._socket.write(message, (error) => {
+                    if (error) {
+                        reject(error);
+                        return;
+                    }
+                    resolve(true);
+                });
+            });
+        }
+        catch (error) {
+            tslib_1.__classPrivateFieldSet(this, _TCPHelper_connected, false, "f");
+            const error2 = error instanceof Error ? error : new Error(`${error}`);
+            // Unhandeled socket error
+            tslib_1.__classPrivateFieldGet(this, _TCPHelper_instances, "m", _TCPHelper_new_status).call(this, enums_1.InstanceStatus.UnknownError, error2.message);
+            this.emit('error', error2);
+            throw error2;
+        }
+    }
+    destroy() {
+        tslib_1.__classPrivateFieldSet(this, _TCPHelper_destroyed, true, "f");
+        if (tslib_1.__classPrivateFieldGet(this, _TCPHelper_reconnectTimer, "f") !== undefined) {
+            clearTimeout(tslib_1.__classPrivateFieldGet(this, _TCPHelper_reconnectTimer, "f"));
+        }
+        this._socket.removeAllListeners();
+        this.removeAllListeners();
+        this._socket.destroy();
+    }
+}
+exports.TCPHelper = TCPHelper;
+_TCPHelper_host = new WeakMap(), _TCPHelper_port = new WeakMap(), _TCPHelper_options = new WeakMap(), _TCPHelper_connected = new WeakMap(), _TCPHelper_connecting = new WeakMap(), _TCPHelper_destroyed = new WeakMap(), _TCPHelper_lastStatus = new WeakMap(), _TCPHelper_reconnectTimer = new WeakMap(), _TCPHelper_instances = new WeakSet(), _TCPHelper_queueReconnect = function _TCPHelper_queueReconnect() {
+    if (tslib_1.__classPrivateFieldGet(this, _TCPHelper_reconnectTimer, "f") !== undefined) {
+        clearTimeout(tslib_1.__classPrivateFieldGet(this, _TCPHelper_reconnectTimer, "f"));
+    }
+    tslib_1.__classPrivateFieldSet(this, _TCPHelper_reconnectTimer, setTimeout(() => {
+        tslib_1.__classPrivateFieldSet(this, _TCPHelper_reconnectTimer, undefined, "f");
+        tslib_1.__classPrivateFieldGet(this, _TCPHelper_instances, "m", _TCPHelper_new_status).call(this, enums_1.InstanceStatus.Connecting);
+        this.connect();
+    }, tslib_1.__classPrivateFieldGet(this, _TCPHelper_options, "f").reconnect_interval), "f");
+}, _TCPHelper_new_status = function _TCPHelper_new_status(status, message) {
+    if (tslib_1.__classPrivateFieldGet(this, _TCPHelper_lastStatus, "f") != status) {
+        tslib_1.__classPrivateFieldSet(this, _TCPHelper_lastStatus, status, "f");
+        this.emit('status_change', status, message);
+    }
+};
+//# sourceMappingURL=tcp.js.map

package/dist/helpers/tcp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tcp.js","sourceRoot":"","sources":["../../src/helpers/tcp.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;;AAEH,sDAAqB;AACrB,iDAA4C;AAC5C,+CAAoD;AAgCpD,MAAa,SAAU,SAAQ,4BAA6B;IAsB3D,YAAY,IAAY,EAAE,IAAY,EAAE,OAA0B;QACjE,KAAK,EAAE,CAAA;;QAtBR,kCAAsB;QACtB,kCAAsB;QAEtB,qCAA6C;QAE7C,+BAAa,KAAK,EAAA;QAClB,gCAAc,KAAK,EAAA;QACnB,+BAAa,KAAK,EAAA;QAClB,wCAAuC;QACvC,4CAAyC;QAexC,+BAAA,IAAI,mBAAS,IAAI,MAAA,CAAA;QACjB,+BAAA,IAAI,mBAAS,IAAI,MAAA,CAAA;QACjB,+BAAA,IAAI,sBAAY;YACf,kBAAkB,EAAE,IAAI;YACxB,SAAS,EAAE,IAAI;YACf,GAAG,OAAO;SACV,MAAA,CAAA;QAED,IAAI,CAAC,OAAO,GAAG,IAAI,aAAG,CAAC,MAAM,EAAE,CAAA;QAC/B,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;QAC/B,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAA;QAE7B,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YAChC,+BAAA,IAAI,yBAAe,KAAK,MAAA,CAAA;YACxB,+BAAA,IAAI,wBAAc,KAAK,MAAA,CAAA;YAEvB,IAAI,+BAAA,IAAI,0BAAS,CAAC,SAAS,EAAE;gBAC5B,+BAAA,IAAI,uDAAgB,MAApB,IAAI,CAAkB,CAAA;aACtB;YAED,+BAAA,IAAI,mDAAY,MAAhB,IAAI,EAAa,sBAAc,CAAC,YAAY,EAAE,GAAG,CAAC,OAAO,CAAC,CAAA;YAC1D,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,CAAC,CAAA;QACxB,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;YAC7B,+BAAA,IAAI,wBAAc,IAAI,MAAA,CAAA;YACtB,+BAAA,IAAI,yBAAe,KAAK,MAAA,CAAA;YAExB,+BAAA,IAAI,mDAAY,MAAhB,IAAI,EAAa,sBAAc,CAAC,EAAE,CAAC,CAAA;YACnC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACrB,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;YAC3B,+BAAA,IAAI,wBAAc,KAAK,MAAA,CAAA;YACvB,+BAAA,IAAI,mDAAY,MAAhB,IAAI,EAAa,sBAAc,CAAC,YAAY,CAAC,CAAA;YAE7C,IAAI,CAAC,+BAAA,IAAI,6BAAY,IAAI,+BAAA,IAAI,0BAAS,CAAC,SAAS,EAAE;gBACjD,+BAAA,IAAI,uDAAgB,MAApB,IAAI,CAAkB,CAAA;aACtB;YAED,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;QACjB,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAA;QAC1D,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;QAElD,0CAA0C;QAC1C,YAAY,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;QAElC,UAAU,CAAC,GAAG,EAAE;YACf,IAAI,CAAC,+BAAA,IAAI,4BAAW,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;gBACrD,+EAA+E;gBAC/E,OAAO,CAAC,KAAK,CAAC,0BAA0B,+BAAA,IAAI,uBAAM,IAAI,+BAAA,IAAI,uBAAM,+BAA+B,CAAC,CAAA;aAChG;QACF,CAAC,EAAE,IAAI,CAAC,CAAA;IACT,CAAC;IApED,IAAI,WAAW;QACd,OAAO,+BAAA,IAAI,4BAAW,CAAA;IACvB,CAAC;IACD,IAAI,YAAY;QACf,OAAO,+BAAA,IAAI,6BAAY,CAAA;IACxB,CAAC;IACD,IAAI,WAAW;QACd,OAAO,+BAAA,IAAI,4BAAW,CAAA;IACvB,CAAC;IA8DD,OAAO;QACN,IAAI,+BAAA,IAAI,4BAAW;YAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;QACvE,IAAI,+BAAA,IAAI,6BAAY;YAAE,OAAO,KAAK,CAAA;QAElC,+BAAA,IAAI,yBAAe,IAAI,MAAA,CAAA;QACvB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,+BAAA,IAAI,uBAAM,EAAE,+BAAA,IAAI,uBAAM,CAAC,CAAA;QAC5C,OAAO,IAAI,CAAA;IACZ,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,OAAwB;QAClC,IAAI,+BAAA,IAAI,4BAAW,IAAI,IAAI,CAAC,OAAO,CAAC,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;QAClG,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAA;QAEtE,IAAI,CAAC,+BAAA,IAAI,4BAAW,EAAE;YACrB,OAAO,KAAK,CAAA;SACZ;QAED,IAAI;YACH,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBACtC,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;oBACrC,IAAI,KAAK,EAAE;wBACV,MAAM,CAAC,KAAK,CAAC,CAAA;wBACb,OAAM;qBACN;oBAED,OAAO,CAAC,IAAI,CAAC,CAAA;gBACd,CAAC,CAAC,CAAA;YACH,CAAC,CAAC,CAAA;SACF;QAAC,OAAO,KAAK,EAAE;YACf,+BAAA,IAAI,wBAAc,KAAK,MAAA,CAAA;YAEvB,MAAM,MAAM,GAAU,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC,GAAG,KAAK,EAAE,CAAC,CAAA;YAE5E,0BAA0B;YAC1B,+BAAA,IAAI,mDAAY,MAAhB,IAAI,EAAa,sBAAc,CAAC,YAAY,EAAE,MAAM,CAAC,OAAO,CAAC,CAAA;YAC7D,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,MAAM,CAAC,CAAA;YAE1B,MAAM,MAAM,CAAA;SACZ;IACF,CAAC;IACD,OAAO;QACN,+BAAA,IAAI,wBAAc,IAAI,MAAA,CAAA;QAEtB,IAAI,+BAAA,IAAI,iCAAgB,KAAK,SAAS,EAAE;YACvC,YAAY,CAAC,+BAAA,IAAI,iCAAgB,CAAC,CAAA;SAClC;QAED,IAAI,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAA;QACjC,IAAI,CAAC,kBAAkB,EAAE,CAAA;QACzB,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAA;IACvB,CAAC;CAuBD;AA1JD,8BA0JC;;IApBC,IAAI,+BAAA,IAAI,iCAAgB,KAAK,SAAS,EAAE;QACvC,YAAY,CAAC,+BAAA,IAAI,iCAAgB,CAAC,CAAA;KAClC;IAED,+BAAA,IAAI,6BAAmB,UAAU,CAAC,GAAG,EAAE;QACtC,+BAAA,IAAI,6BAAmB,SAAS,MAAA,CAAA;QAEhC,+BAAA,IAAI,mDAAY,MAAhB,IAAI,EAAa,sBAAc,CAAC,UAAU,CAAC,CAAA;QAE3C,IAAI,CAAC,OAAO,EAAE,CAAA;IACf,CAAC,EAAE,+BAAA,IAAI,0BAAS,CAAC,kBAAkB,CAAC,MAAA,CAAA;AACrC,CAAC,yDAGW,MAAmB,EAAE,OAAgB;IAChD,IAAI,+BAAA,IAAI,6BAAY,IAAI,MAAM,EAAE;QAC/B,+BAAA,IAAI,yBAAe,MAAM,MAAA,CAAA;QACzB,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;KAC3C;AACF,CAAC"}

package/dist/helpers/telnet.d.ts

@@ -0,0 +1,19 @@
+/// <reference types="node" />
+import EventEmitter from 'eventemitter3';
+import { TCPHelperEvents, TCPHelperOptions } from './tcp';
+export interface TelnetHelperEvents extends TCPHelperEvents {
+    sb: [Buffer];
+    iac: [string, number];
+}
+export declare type TelnetHelperOptions = TCPHelperOptions;
+export declare class TelnetHelper extends EventEmitter<TelnetHelperEvents> {
+    #private;
+    get isConnected(): boolean;
+    get isConnecting(): boolean;
+    get isDestroyed(): boolean;
+    constructor(host: string, port: number, options?: TelnetHelperOptions);
+    connect(): boolean;
+    send(message: string | Buffer): Promise<boolean>;
+    destroy(): void;
+}
+//# sourceMappingURL=telnet.d.ts.map

package/dist/helpers/telnet.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"telnet.d.ts","sourceRoot":"","sources":["../../src/helpers/telnet.ts"],"names":[],"mappings":";AAiBA,OAAO,YAAY,MAAM,eAAe,CAAA;AAExC,OAAO,EAAa,eAAe,EAAE,gBAAgB,EAAE,MAAM,OAAO,CAAA;AAYpE,MAAM,WAAW,kBAAmB,SAAQ,eAAe;IAC1D,EAAE,EAAE,CAAC,MAAM,CAAC,CAAA;IACZ,GAAG,EAAE,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACrB;AACD,oBAAY,mBAAmB,GAAG,gBAAgB,CAAA;AAElD,qBAAa,YAAa,SAAQ,YAAY,CAAC,kBAAkB,CAAC;;IAIjE,IAAI,WAAW,IAAI,OAAO,CAEzB;IACD,IAAI,YAAY,IAAI,OAAO,CAE1B;IACD,IAAI,WAAW,IAAI,OAAO,CAEzB;gBAEW,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB;IA2BrE,OAAO,IAAI,OAAO;IAGlB,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAIhD,OAAO,IAAI,IAAI;CAMf"}

package/dist/helpers/telnet.js

@@ -0,0 +1,165 @@
+"use strict";
+/*
+ * This file is part of the Companion project
+ * Copyright (c) 2018 Bitfocus AS
+ * Authors: William Viker <william@bitfocus.io>, Håkon Nessjøen <haakon@bitfocus.io>
+ *
+ * This program is free software.
+ * You should have received a copy of the MIT licence as well as the Bitfocus
+ * Individual Contributor License Agreement for companion along with
+ * this program.
+ *
+ * You can be released from the requirements of the license by purchasing
+ * a commercial license. Buying such a license is mandatory as soon as you
+ * develop commercial activities involving the Companion software without
+ * disclosing the source code of your own applications.
+ *
+ */
+var _TelnetHelper_tcp, _TelnetHelper_stream, _TelnetStream_instances, _TelnetStream_buffer, _TelnetStream_subbuffer, _TelnetStream_state, _TelnetStream_handleByte, _TelnetStream_getData;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TelnetHelper = void 0;
+const tslib_1 = require("tslib");
+const eventemitter3_1 = tslib_1.__importDefault(require("eventemitter3"));
+const stream_1 = require("stream");
+const tcp_1 = require("./tcp");
+const NULL = 0;
+const DATA = 0;
+const SE = 240;
+const SB = 250;
+const WILL = 251;
+const WONT = 252;
+const DO = 253;
+const DONT = 254;
+const IAC = 255;
+class TelnetHelper extends eventemitter3_1.default {
+    constructor(host, port, options) {
+        super();
+        _TelnetHelper_tcp.set(this, void 0);
+        _TelnetHelper_stream.set(this, void 0);
+        tslib_1.__classPrivateFieldSet(this, _TelnetHelper_tcp, new tcp_1.TCPHelper(host, port, options), "f");
+        tslib_1.__classPrivateFieldSet(this, _TelnetHelper_stream, new TelnetStream(), "f");
+        tslib_1.__classPrivateFieldGet(this, _TelnetHelper_tcp, "f")._socket.pipe(tslib_1.__classPrivateFieldGet(this, _TelnetHelper_stream, "f"));
+        tslib_1.__classPrivateFieldGet(this, _TelnetHelper_tcp, "f").on('connect', () => this.emit('connect'));
+        tslib_1.__classPrivateFieldGet(this, _TelnetHelper_tcp, "f").on('end', () => this.emit('end'));
+        tslib_1.__classPrivateFieldGet(this, _TelnetHelper_tcp, "f").on('error', (error) => this.emit('error', error));
+        tslib_1.__classPrivateFieldGet(this, _TelnetHelper_tcp, "f").on('status_change', (status, message) => this.emit('status_change', status, message));
+        // Ignore drain and data, they go via the stream
+        tslib_1.__classPrivateFieldGet(this, _TelnetHelper_stream, "f").on('iac', (a, b) => this.emit('iac', a, b));
+        tslib_1.__classPrivateFieldGet(this, _TelnetHelper_stream, "f").on('sb', (buffer) => this.emit('sb', buffer));
+        tslib_1.__classPrivateFieldGet(this, _TelnetHelper_stream, "f").on('data', (data) => this.emit('data', data));
+        tslib_1.__classPrivateFieldGet(this, _TelnetHelper_stream, "f").on('drain', () => this.emit('drain'));
+        setTimeout(() => {
+            if (!this.isDestroyed && !this.listenerCount('error')) {
+                // The socket is active and has no listeners. Log an error for the module devs!
+                console.error(`Danger: Telnet client for ${host}:${port} is missing an error handler!`);
+            }
+        }, 5000);
+    }
+    get isConnected() {
+        return tslib_1.__classPrivateFieldGet(this, _TelnetHelper_tcp, "f").isConnected;
+    }
+    get isConnecting() {
+        return tslib_1.__classPrivateFieldGet(this, _TelnetHelper_tcp, "f").isConnecting;
+    }
+    get isDestroyed() {
+        return tslib_1.__classPrivateFieldGet(this, _TelnetHelper_tcp, "f").isDestroyed;
+    }
+    connect() {
+        return tslib_1.__classPrivateFieldGet(this, _TelnetHelper_tcp, "f").connect();
+    }
+    send(message) {
+        return tslib_1.__classPrivateFieldGet(this, _TelnetHelper_tcp, "f").send(message);
+    }
+    destroy() {
+        tslib_1.__classPrivateFieldGet(this, _TelnetHelper_tcp, "f").destroy();
+        tslib_1.__classPrivateFieldGet(this, _TelnetHelper_stream, "f").removeAllListeners();
+        tslib_1.__classPrivateFieldGet(this, _TelnetHelper_stream, "f").destroy();
+    }
+}
+exports.TelnetHelper = TelnetHelper;
+_TelnetHelper_tcp = new WeakMap(), _TelnetHelper_stream = new WeakMap();
+/*
+ * TelnetStream
+ */
+class TelnetStream extends stream_1.Transform {
+    constructor(options) {
+        super(options);
+        _TelnetStream_instances.add(this);
+        _TelnetStream_buffer.set(this, void 0);
+        _TelnetStream_subbuffer.set(this, void 0);
+        _TelnetStream_state.set(this, void 0);
+        tslib_1.__classPrivateFieldSet(this, _TelnetStream_buffer, Buffer.alloc(0), "f");
+        tslib_1.__classPrivateFieldSet(this, _TelnetStream_subbuffer, Buffer.alloc(0), "f");
+        tslib_1.__classPrivateFieldSet(this, _TelnetStream_state, DATA, "f");
+    }
+    _transform(obj, _encoding, callback) {
+        for (let i = 0; i < obj.length; ++i) {
+            tslib_1.__classPrivateFieldGet(this, _TelnetStream_instances, "m", _TelnetStream_handleByte).call(this, obj[i]);
+        }
+        const data = tslib_1.__classPrivateFieldGet(this, _TelnetStream_instances, "m", _TelnetStream_getData).call(this);
+        if (data.length) {
+            this.push(data);
+        }
+        callback();
+    }
+}
+_TelnetStream_buffer = new WeakMap(), _TelnetStream_subbuffer = new WeakMap(), _TelnetStream_state = new WeakMap(), _TelnetStream_instances = new WeakSet(), _TelnetStream_handleByte = function _TelnetStream_handleByte(byte) {
+    if (tslib_1.__classPrivateFieldGet(this, _TelnetStream_state, "f") === DATA) {
+        if (byte === IAC) {
+            tslib_1.__classPrivateFieldSet(this, _TelnetStream_state, IAC, "f");
+            return;
+        }
+        tslib_1.__classPrivateFieldSet(this, _TelnetStream_buffer, Buffer.concat([tslib_1.__classPrivateFieldGet(this, _TelnetStream_buffer, "f"), Buffer.from([byte])]), "f");
+    }
+    else if (tslib_1.__classPrivateFieldGet(this, _TelnetStream_state, "f") === IAC) {
+        switch (byte) {
+            case SB:
+            case WILL:
+            case WONT:
+            case DO:
+            case DONT:
+                tslib_1.__classPrivateFieldSet(this, _TelnetStream_state, byte, "f");
+                break;
+            default:
+                tslib_1.__classPrivateFieldSet(this, _TelnetStream_state, DATA, "f");
+                break;
+        }
+    }
+    else if (tslib_1.__classPrivateFieldGet(this, _TelnetStream_state, "f") >= WILL && tslib_1.__classPrivateFieldGet(this, _TelnetStream_state, "f") <= DONT) {
+        let iac = undefined;
+        switch (tslib_1.__classPrivateFieldGet(this, _TelnetStream_state, "f")) {
+            case WILL:
+                iac = 'WILL';
+                break;
+            case WONT:
+                iac = 'WONT';
+                break;
+            case DO:
+                iac = 'DO';
+                break;
+            case DONT:
+                iac = 'DONT';
+                break;
+            default:
+                // never hit
+                return;
+        }
+        this.emit('iac', iac, byte);
+        tslib_1.__classPrivateFieldSet(this, _TelnetStream_state, DATA, "f");
+        return;
+    }
+    else if (tslib_1.__classPrivateFieldGet(this, _TelnetStream_state, "f") === SB) {
+        if (byte === SE) {
+            this.emit('sb', tslib_1.__classPrivateFieldGet(this, _TelnetStream_subbuffer, "f"));
+            tslib_1.__classPrivateFieldSet(this, _TelnetStream_state, DATA, "f");
+            tslib_1.__classPrivateFieldSet(this, _TelnetStream_subbuffer, Buffer.alloc(0), "f");
+            return;
+        }
+        tslib_1.__classPrivateFieldSet(this, _TelnetStream_subbuffer, Buffer.concat([tslib_1.__classPrivateFieldGet(this, _TelnetStream_subbuffer, "f"), Buffer.from([byte])]), "f");
+    }
+}, _TelnetStream_getData = function _TelnetStream_getData() {
+    const buff = tslib_1.__classPrivateFieldGet(this, _TelnetStream_buffer, "f");
+    tslib_1.__classPrivateFieldSet(this, _TelnetStream_buffer, Buffer.alloc(0), "f");
+    return buff;
+};
+//# sourceMappingURL=telnet.js.map

package/dist/helpers/telnet.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"telnet.js","sourceRoot":"","sources":["../../src/helpers/telnet.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;;AAEH,0EAAwC;AACxC,mCAAuE;AACvE,+BAAoE;AAEpE,MAAM,IAAI,GAAG,CAAC,CAAA;AACd,MAAM,IAAI,GAAG,CAAC,CAAA;AACd,MAAM,EAAE,GAAG,GAAG,CAAA;AACd,MAAM,EAAE,GAAG,GAAG,CAAA;AACd,MAAM,IAAI,GAAG,GAAG,CAAA;AAChB,MAAM,IAAI,GAAG,GAAG,CAAA;AAChB,MAAM,EAAE,GAAG,GAAG,CAAA;AACd,MAAM,IAAI,GAAG,GAAG,CAAA;AAChB,MAAM,GAAG,GAAG,GAAG,CAAA;AAQf,MAAa,YAAa,SAAQ,uBAAgC;IAcjE,YAAY,IAAY,EAAE,IAAY,EAAE,OAA6B;QACpE,KAAK,EAAE,CAAA;QAdR,oCAAwB;QACxB,uCAA8B;QAe7B,+BAAA,IAAI,qBAAQ,IAAI,eAAS,CAAC,IAAI,EAAE,IAAI,EAAE,OAAO,CAAC,MAAA,CAAA;QAC9C,+BAAA,IAAI,wBAAW,IAAI,YAAY,EAAE,MAAA,CAAA;QAEjC,+BAAA,IAAI,yBAAK,CAAC,OAAO,CAAC,IAAI,CAAC,+BAAA,IAAI,4BAAQ,CAAC,CAAA;QAEpC,+BAAA,IAAI,yBAAK,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAA;QACnD,+BAAA,IAAI,yBAAK,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAA;QAC3C,+BAAA,IAAI,yBAAK,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAA;QAC3D,+BAAA,IAAI,yBAAK,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,MAAM,EAAE,OAAO,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;QAC/F,gDAAgD;QAEhD,+BAAA,IAAI,4BAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAA;QACxD,+BAAA,IAAI,4BAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,CAAC,MAAM,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;QAC1D,+BAAA,IAAI,4BAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAA;QAC1D,+BAAA,IAAI,4BAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAA;QAElD,UAAU,CAAC,GAAG,EAAE;YACf,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;gBACtD,+EAA+E;gBAC/E,OAAO,CAAC,KAAK,CAAC,6BAA6B,IAAI,IAAI,IAAI,+BAA+B,CAAC,CAAA;aACvF;QACF,CAAC,EAAE,IAAI,CAAC,CAAA;IACT,CAAC;IAnCD,IAAI,WAAW;QACd,OAAO,+BAAA,IAAI,yBAAK,CAAC,WAAW,CAAA;IAC7B,CAAC;IACD,IAAI,YAAY;QACf,OAAO,+BAAA,IAAI,yBAAK,CAAC,YAAY,CAAA;IAC9B,CAAC;IACD,IAAI,WAAW;QACd,OAAO,+BAAA,IAAI,yBAAK,CAAC,WAAW,CAAA;IAC7B,CAAC;IA6BD,OAAO;QACN,OAAO,+BAAA,IAAI,yBAAK,CAAC,OAAO,EAAE,CAAA;IAC3B,CAAC;IACD,IAAI,CAAC,OAAwB;QAC5B,OAAO,+BAAA,IAAI,yBAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAC/B,CAAC;IAED,OAAO;QACN,+BAAA,IAAI,yBAAK,CAAC,OAAO,EAAE,CAAA;QAEnB,+BAAA,IAAI,4BAAQ,CAAC,kBAAkB,EAAE,CAAA;QACjC,+BAAA,IAAI,4BAAQ,CAAC,OAAO,EAAE,CAAA;IACvB,CAAC;CACD;AAtDD,oCAsDC;;AAED;;GAEG;AACH,MAAM,YAAa,SAAQ,kBAAS;IAMnC,YAAY,OAA0B;QACrC,KAAK,CAAC,OAAO,CAAC,CAAA;;QANf,uCAAe;QACf,0CAAkB;QAElB,sCAAc;QAKb,+BAAA,IAAI,wBAAW,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAA,CAAA;QAC9B,+BAAA,IAAI,2BAAc,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAA,CAAA;QACjC,+BAAA,IAAI,uBAAU,IAAI,MAAA,CAAA;IACnB,CAAC;IACD,UAAU,CAAC,GAAW,EAAE,SAAyB,EAAE,QAA2B;QAC7E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,GAAG,CAAC,MAAM,EAAE,EAAE,CAAC,EAAE;YACpC,+BAAA,IAAI,yDAAY,MAAhB,IAAI,EAAa,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;SACxB;QAED,MAAM,IAAI,GAAG,+BAAA,IAAI,sDAAS,MAAb,IAAI,CAAW,CAAA;QAC5B,IAAI,IAAI,CAAC,MAAM,EAAE;YAChB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;SACf;QAED,QAAQ,EAAE,CAAA;IACX,CAAC;CAgED;0NA/DY,IAAY;IACvB,IAAI,+BAAA,IAAI,2BAAO,KAAK,IAAI,EAAE;QACzB,IAAI,IAAI,KAAK,GAAG,EAAE;YACjB,+BAAA,IAAI,uBAAU,GAAG,MAAA,CAAA;YACjB,OAAM;SACN;QAED,+BAAA,IAAI,wBAAW,MAAM,CAAC,MAAM,CAAC,CAAC,+BAAA,IAAI,4BAAQ,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAA,CAAA;KACjE;SAAM,IAAI,+BAAA,IAAI,2BAAO,KAAK,GAAG,EAAE;QAC/B,QAAQ,IAAI,EAAE;YACb,KAAK,EAAE,CAAC;YACR,KAAK,IAAI,CAAC;YACV,KAAK,IAAI,CAAC;YACV,KAAK,EAAE,CAAC;YACR,KAAK,IAAI;gBACR,+BAAA,IAAI,uBAAU,IAAI,MAAA,CAAA;gBAClB,MAAK;YAEN;gBACC,+BAAA,IAAI,uBAAU,IAAI,MAAA,CAAA;gBAClB,MAAK;SACN;KACD;SAAM,IAAI,+BAAA,IAAI,2BAAO,IAAI,IAAI,IAAI,+BAAA,IAAI,2BAAO,IAAI,IAAI,EAAE;QACtD,IAAI,GAAG,GAAuB,SAAS,CAAA;QACvC,QAAQ,+BAAA,IAAI,2BAAO,EAAE;YACpB,KAAK,IAAI;gBACR,GAAG,GAAG,MAAM,CAAA;gBACZ,MAAK;YACN,KAAK,IAAI;gBACR,GAAG,GAAG,MAAM,CAAA;gBACZ,MAAK;YACN,KAAK,EAAE;gBACN,GAAG,GAAG,IAAI,CAAA;gBACV,MAAK;YACN,KAAK,IAAI;gBACR,GAAG,GAAG,MAAM,CAAA;gBACZ,MAAK;YACN;gBACC,YAAY;gBACZ,OAAM;SACP;QACD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,CAAA;QAE3B,+BAAA,IAAI,uBAAU,IAAI,MAAA,CAAA;QAClB,OAAM;KACN;SAAM,IAAI,+BAAA,IAAI,2BAAO,KAAK,EAAE,EAAE;QAC9B,IAAI,IAAI,KAAK,EAAE,EAAE;YAChB,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,+BAAA,IAAI,+BAAW,CAAC,CAAA;YAChC,+BAAA,IAAI,uBAAU,IAAI,MAAA,CAAA;YAClB,+BAAA,IAAI,2BAAc,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAA,CAAA;YACjC,OAAM;SACN;QAED,+BAAA,IAAI,2BAAc,MAAM,CAAC,MAAM,CAAC,CAAC,+BAAA,IAAI,+BAAW,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,MAAA,CAAA;KACvE;AACF,CAAC;IAEA,MAAM,IAAI,GAAG,+BAAA,IAAI,4BAAQ,CAAA;IAEzB,+BAAA,IAAI,wBAAW,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAA,CAAA;IAE9B,OAAO,IAAI,CAAA;AACZ,CAAC"}

package/dist/helpers/udp.d.ts

@@ -0,0 +1,33 @@
+/// <reference types="node" />
+import { EventEmitter } from 'eventemitter3';
+import { InstanceStatus } from '../module-api/enums';
+declare type UDPStatuses = InstanceStatus.Ok | InstanceStatus.UnknownError;
+export interface UDPHelperEvents {
+    error: [err: Error];
+    listening: [];
+    data: [msg: Buffer];
+    status_change: [status: UDPStatuses, message: string | undefined];
+}
+export interface UDPHelperOptions {
+    /** default: 0 */
+    bind_port?: number;
+    /** default: 0.0.0.0 */
+    bind_ip?: string;
+    /** default false */
+    broadcast?: boolean;
+    /** default 64 */
+    ttl?: number;
+    /** default 1 */
+    multicast_ttl?: number;
+    /** default undefined */
+    multicast_interface?: string;
+}
+export declare class UDPHelper extends EventEmitter<UDPHelperEvents> {
+    #private;
+    get isDestroyed(): boolean;
+    constructor(host: string, port: number, options?: UDPHelperOptions);
+    send(message: string | Buffer): Promise<void>;
+    destroy(): void;
+}
+export {};
+//# sourceMappingURL=udp.d.ts.map

package/dist/helpers/udp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"udp.d.ts","sourceRoot":"","sources":["../../src/helpers/udp.ts"],"names":[],"mappings":";AAkBA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAC5C,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAA;AAEpD,aAAK,WAAW,GAAG,cAAc,CAAC,EAAE,GAAG,cAAc,CAAC,YAAY,CAAA;AAElE,MAAM,WAAW,eAAe;IAE/B,KAAK,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAEnB,SAAS,EAAE,EAAE,CAAA;IAEb,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;IAGnB,aAAa,EAAE,CAAC,MAAM,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC,CAAA;CACjE;AAED,MAAM,WAAW,gBAAgB;IAChC,iBAAiB;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,uBAAuB;IACvB,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB,oBAAoB;IACpB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,iBAAiB;IACjB,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,gBAAgB;IAChB,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,wBAAwB;IACxB,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,qBAAa,SAAU,SAAQ,YAAY,CAAC,eAAe,CAAC;;IAS3D,IAAI,WAAW,IAAI,OAAO,CAEzB;gBAEW,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,gBAAgB;IAgElE,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAsB7C,OAAO,IAAI,IAAI;CAef"}

package/dist/helpers/udp.js

@@ -0,0 +1,122 @@
+"use strict";
+/*
+ * This file is part of the Companion project
+ * Copyright (c) 2018 Bitfocus AS
+ * Authors: William Viker <william@bitfocus.io>, Håkon Nessjøen <haakon@bitfocus.io>
+ *
+ * This program is free software.
+ * You should have received a copy of the MIT licence as well as the Bitfocus
+ * Individual Contributor License Agreement for companion along with
+ * this program.
+ *
+ * You can be released from the requirements of the license by purchasing
+ * a commercial license. Buying such a license is mandatory as soon as you
+ * develop commercial activities involving the Companion software without
+ * disclosing the source code of your own applications.
+ *
+ */
+var _UDPHelper_instances, _UDPHelper_host, _UDPHelper_port, _UDPHelper_socket, _UDPHelper_options, _UDPHelper_destroyed, _UDPHelper_lastStatus, _UDPHelper_new_status;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UDPHelper = void 0;
+const tslib_1 = require("tslib");
+const dgram_1 = tslib_1.__importDefault(require("dgram"));
+const eventemitter3_1 = require("eventemitter3");
+const enums_1 = require("../module-api/enums");
+class UDPHelper extends eventemitter3_1.EventEmitter {
+    constructor(host, port, options) {
+        super();
+        _UDPHelper_instances.add(this);
+        _UDPHelper_host.set(this, void 0);
+        _UDPHelper_port.set(this, void 0);
+        _UDPHelper_socket.set(this, void 0);
+        _UDPHelper_options.set(this, void 0);
+        _UDPHelper_destroyed.set(this, false);
+        _UDPHelper_lastStatus.set(this, void 0);
+        tslib_1.__classPrivateFieldSet(this, _UDPHelper_host, host, "f");
+        tslib_1.__classPrivateFieldSet(this, _UDPHelper_port, port, "f");
+        tslib_1.__classPrivateFieldSet(this, _UDPHelper_options, { ...options }, "f");
+        // this.bound = false
+        // this.pending_memberships = []
+        tslib_1.__classPrivateFieldSet(this, _UDPHelper_socket, dgram_1.default.createSocket('udp4'), "f");
+        if (tslib_1.__classPrivateFieldGet(this, _UDPHelper_options, "f").bind_port || tslib_1.__classPrivateFieldGet(this, _UDPHelper_options, "f").bind_ip) {
+            try {
+                tslib_1.__classPrivateFieldGet(this, _UDPHelper_socket, "f").bind(tslib_1.__classPrivateFieldGet(this, _UDPHelper_options, "f").bind_port || 0, tslib_1.__classPrivateFieldGet(this, _UDPHelper_options, "f").bind_ip);
+            }
+            catch (e) {
+                throw new Error(`Unable to bind to ip/port: ${tslib_1.__classPrivateFieldGet(this, _UDPHelper_options, "f").bind_ip}:${tslib_1.__classPrivateFieldGet(this, _UDPHelper_options, "f").bind_port}`);
+            }
+        }
+        if (tslib_1.__classPrivateFieldGet(this, _UDPHelper_options, "f").broadcast) {
+            tslib_1.__classPrivateFieldGet(this, _UDPHelper_socket, "f").setBroadcast(true);
+        }
+        if (tslib_1.__classPrivateFieldGet(this, _UDPHelper_options, "f").ttl !== undefined) {
+            tslib_1.__classPrivateFieldGet(this, _UDPHelper_socket, "f").setTTL(tslib_1.__classPrivateFieldGet(this, _UDPHelper_options, "f").ttl);
+        }
+        if (tslib_1.__classPrivateFieldGet(this, _UDPHelper_options, "f").multicast_ttl !== undefined) {
+            tslib_1.__classPrivateFieldGet(this, _UDPHelper_socket, "f").setMulticastTTL(tslib_1.__classPrivateFieldGet(this, _UDPHelper_options, "f").multicast_ttl);
+        }
+        tslib_1.__classPrivateFieldGet(this, _UDPHelper_socket, "f").on('error', (error) => {
+            tslib_1.__classPrivateFieldGet(this, _UDPHelper_instances, "m", _UDPHelper_new_status).call(this, enums_1.InstanceStatus.UnknownError, error.message);
+            this.emit('error', error);
+        });
+        tslib_1.__classPrivateFieldGet(this, _UDPHelper_socket, "f").on('listening', () => {
+            // this.bound = true
+            // if (this.pending_memberships.length) {
+            // 	while (this.pending_memberships.length > 0) {
+            // 		this.socket.addMembership(member.shift())
+            // 	}
+            // }
+            if (tslib_1.__classPrivateFieldGet(this, _UDPHelper_options, "f").multicast_interface) {
+                tslib_1.__classPrivateFieldGet(this, _UDPHelper_socket, "f").setMulticastInterface(tslib_1.__classPrivateFieldGet(this, _UDPHelper_options, "f").multicast_interface);
+            }
+            tslib_1.__classPrivateFieldGet(this, _UDPHelper_instances, "m", _UDPHelper_new_status).call(this, enums_1.InstanceStatus.Ok);
+            this.emit('listening');
+        });
+        tslib_1.__classPrivateFieldGet(this, _UDPHelper_socket, "f").on('message', (data) => this.emit('data', data));
+        setTimeout(() => {
+            if (!tslib_1.__classPrivateFieldGet(this, _UDPHelper_destroyed, "f") && !this.listenerCount('error')) {
+                // The socket is active and has no listeners. Log an error for the module devs!
+                console.error(`Danger: UDP socket for ${tslib_1.__classPrivateFieldGet(this, _UDPHelper_host, "f")}:${tslib_1.__classPrivateFieldGet(this, _UDPHelper_port, "f")} is missing an error handler!`);
+            }
+        }, 5000);
+    }
+    get isDestroyed() {
+        return tslib_1.__classPrivateFieldGet(this, _UDPHelper_destroyed, "f");
+    }
+    send(message) {
+        if (tslib_1.__classPrivateFieldGet(this, _UDPHelper_destroyed, "f"))
+            throw new Error('Cannot write to destroyed socket');
+        if (!message || !message.length)
+            throw new Error('No message to send');
+        return new Promise((resolve, reject) => {
+            tslib_1.__classPrivateFieldGet(this, _UDPHelper_socket, "f").send(message, tslib_1.__classPrivateFieldGet(this, _UDPHelper_port, "f"), tslib_1.__classPrivateFieldGet(this, _UDPHelper_host, "f"), (error) => {
+                if (error) {
+                    reject(error);
+                    return;
+                }
+                resolve();
+            });
+        });
+    }
+    // addMembership(member) {
+    // 	if (!this.bound) {
+    // 		this.pending_memberships.push(member)
+    // 	} else {
+    // 		this.socket.addMembership(member)
+    // 	}
+    // }
+    destroy() {
+        tslib_1.__classPrivateFieldSet(this, _UDPHelper_destroyed, true, "f");
+        tslib_1.__classPrivateFieldGet(this, _UDPHelper_socket, "f").removeAllListeners();
+        tslib_1.__classPrivateFieldGet(this, _UDPHelper_socket, "f").close();
+        this.removeAllListeners();
+    }
+}
+exports.UDPHelper = UDPHelper;
+_UDPHelper_host = new WeakMap(), _UDPHelper_port = new WeakMap(), _UDPHelper_socket = new WeakMap(), _UDPHelper_options = new WeakMap(), _UDPHelper_destroyed = new WeakMap(), _UDPHelper_lastStatus = new WeakMap(), _UDPHelper_instances = new WeakSet(), _UDPHelper_new_status = function _UDPHelper_new_status(status, message) {
+    if (tslib_1.__classPrivateFieldGet(this, _UDPHelper_lastStatus, "f") != status) {
+        tslib_1.__classPrivateFieldSet(this, _UDPHelper_lastStatus, status, "f");
+        this.emit('status_change', status, message);
+    }
+};
+//# sourceMappingURL=udp.js.map

package/dist/helpers/udp.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"udp.js","sourceRoot":"","sources":["../../src/helpers/udp.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;GAeG;;;;;AAEH,0DAAyB;AACzB,iDAA4C;AAC5C,+CAAoD;AAiCpD,MAAa,SAAU,SAAQ,4BAA6B;IAa3D,YAAY,IAAY,EAAE,IAAY,EAAE,OAA0B;QACjE,KAAK,EAAE,CAAA;;QAbR,kCAAsB;QACtB,kCAAsB;QACtB,oCAA8B;QAC9B,qCAAmC;QAEnC,+BAAa,KAAK,EAAA;QAClB,wCAAuC;QAStC,+BAAA,IAAI,mBAAS,IAAI,MAAA,CAAA;QACjB,+BAAA,IAAI,mBAAS,IAAI,MAAA,CAAA;QACjB,+BAAA,IAAI,sBAAY,EAAE,GAAG,OAAO,EAAE,MAAA,CAAA;QAE9B,qBAAqB;QACrB,gCAAgC;QAEhC,+BAAA,IAAI,qBAAW,eAAK,CAAC,YAAY,CAAC,MAAM,CAAC,MAAA,CAAA;QAEzC,IAAI,+BAAA,IAAI,0BAAS,CAAC,SAAS,IAAI,+BAAA,IAAI,0BAAS,CAAC,OAAO,EAAE;YACrD,IAAI;gBACH,+BAAA,IAAI,yBAAQ,CAAC,IAAI,CAAC,+BAAA,IAAI,0BAAS,CAAC,SAAS,IAAI,CAAC,EAAE,+BAAA,IAAI,0BAAS,CAAC,OAAO,CAAC,CAAA;aACtE;YAAC,OAAO,CAAC,EAAE;gBACX,MAAM,IAAI,KAAK,CAAC,8BAA8B,+BAAA,IAAI,0BAAS,CAAC,OAAO,IAAI,+BAAA,IAAI,0BAAS,CAAC,SAAS,EAAE,CAAC,CAAA;aACjG;SACD;QAED,IAAI,+BAAA,IAAI,0BAAS,CAAC,SAAS,EAAE;YAC5B,+BAAA,IAAI,yBAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;SAC/B;QAED,IAAI,+BAAA,IAAI,0BAAS,CAAC,GAAG,KAAK,SAAS,EAAE;YACpC,+BAAA,IAAI,yBAAQ,CAAC,MAAM,CAAC,+BAAA,IAAI,0BAAS,CAAC,GAAG,CAAC,CAAA;SACtC;QAED,IAAI,+BAAA,IAAI,0BAAS,CAAC,aAAa,KAAK,SAAS,EAAE;YAC9C,+BAAA,IAAI,yBAAQ,CAAC,eAAe,CAAC,+BAAA,IAAI,0BAAS,CAAC,aAAa,CAAC,CAAA;SACzD;QAED,+BAAA,IAAI,yBAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;YAClC,+BAAA,IAAI,mDAAY,MAAhB,IAAI,EAAa,sBAAc,CAAC,YAAY,EAAE,KAAK,CAAC,OAAO,CAAC,CAAA;YAC5D,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAA;QAC1B,CAAC,CAAC,CAAA;QAEF,+BAAA,IAAI,yBAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE;YACjC,oBAAoB;YAEpB,yCAAyC;YACzC,iDAAiD;YACjD,8CAA8C;YAC9C,KAAK;YACL,IAAI;YAEJ,IAAI,+BAAA,IAAI,0BAAS,CAAC,mBAAmB,EAAE;gBACtC,+BAAA,IAAI,yBAAQ,CAAC,qBAAqB,CAAC,+BAAA,IAAI,0BAAS,CAAC,mBAAmB,CAAC,CAAA;aACrE;YAED,+BAAA,IAAI,mDAAY,MAAhB,IAAI,EAAa,sBAAc,CAAC,EAAE,CAAC,CAAA;YACnC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;QAEF,+BAAA,IAAI,yBAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,CAAA;QAE7D,UAAU,CAAC,GAAG,EAAE;YACf,IAAI,CAAC,+BAAA,IAAI,4BAAW,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,EAAE;gBACrD,+EAA+E;gBAC/E,OAAO,CAAC,KAAK,CAAC,0BAA0B,+BAAA,IAAI,uBAAM,IAAI,+BAAA,IAAI,uBAAM,+BAA+B,CAAC,CAAA;aAChG;QACF,CAAC,EAAE,IAAI,CAAC,CAAA;IACT,CAAC;IAlED,IAAI,WAAW;QACd,OAAO,+BAAA,IAAI,4BAAW,CAAA;IACvB,CAAC;IAkED,IAAI,CAAC,OAAwB;QAC5B,IAAI,+BAAA,IAAI,4BAAW;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;QACxE,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAA;QAEtE,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtC,+BAAA,IAAI,yBAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,+BAAA,IAAI,uBAAM,EAAE,+BAAA,IAAI,uBAAM,EAAE,CAAC,KAAK,EAAE,EAAE;gBAC5D,IAAI,KAAK,EAAE;oBACV,MAAM,CAAC,KAAK,CAAC,CAAA;oBACb,OAAM;iBACN;gBAED,OAAO,EAAE,CAAA;YACV,CAAC,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;IACH,CAAC;IACD,0BAA0B;IAC1B,sBAAsB;IACtB,0CAA0C;IAC1C,YAAY;IACZ,sCAAsC;IACtC,KAAK;IACL,IAAI;IACJ,OAAO;QACN,+BAAA,IAAI,wBAAc,IAAI,MAAA,CAAA;QAEtB,+BAAA,IAAI,yBAAQ,CAAC,kBAAkB,EAAE,CAAA;QACjC,+BAAA,IAAI,yBAAQ,CAAC,KAAK,EAAE,CAAA;QACpB,IAAI,CAAC,kBAAkB,EAAE,CAAA;IAC1B,CAAC;CASD;AAlHD,8BAkHC;mTANY,MAAmB,EAAE,OAAgB;IAChD,IAAI,+BAAA,IAAI,6BAAY,IAAI,MAAM,EAAE;QAC/B,+BAAA,IAAI,yBAAe,MAAM,MAAA,CAAA;QACzB,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,MAAM,EAAE,OAAO,CAAC,CAAA;KAC3C;AACF,CAAC"}

package/dist/index.d.ts

@@ -2,5 +2,6 @@ export * from './manifest.js';
 export * from './module-api/index.js';
 export * from './common/osc.js';
 export { literal, combineRgb, splitRgb, RgbComponents, assertNever } from './util.js';
+export * from './helpers/index.js';
 export { runEntrypoint } from './entrypoint.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,iBAAiB,CAAA;AAC/B,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAErF,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,iBAAiB,CAAA;AAC/B,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AACrF,cAAc,oBAAoB,CAAA;AAElC,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAA"}

package/dist/index.js

@@ -10,6 +10,7 @@ Object.defineProperty(exports, "literal", { enumerable: true, get: function () {
 Object.defineProperty(exports, "combineRgb", { enumerable: true, get: function () { return util_js_1.combineRgb; } });
 Object.defineProperty(exports, "splitRgb", { enumerable: true, get: function () { return util_js_1.splitRgb; } });
 Object.defineProperty(exports, "assertNever", { enumerable: true, get: function () { return util_js_1.assertNever; } });
+tslib_1.__exportStar(require("./helpers/index.js"), exports);
 var entrypoint_js_1 = require("./entrypoint.js");
 Object.defineProperty(exports, "runEntrypoint", { enumerable: true, get: function () { return entrypoint_js_1.runEntrypoint; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,wDAA6B;AAC7B,gEAAqC;AACrC,0DAA+B;AAC/B,qCAAqF;AAA5E,kGAAA,OAAO,OAAA;AAAE,qGAAA,UAAU,OAAA;AAAE,mGAAA,QAAQ,OAAA;AAAiB,sGAAA,WAAW,OAAA;AAElE,iDAA+C;AAAtC,8GAAA,aAAa,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,wDAA6B;AAC7B,gEAAqC;AACrC,0DAA+B;AAC/B,qCAAqF;AAA5E,kGAAA,OAAO,OAAA;AAAE,qGAAA,UAAU,OAAA;AAAE,mGAAA,QAAQ,OAAA;AAAiB,sGAAA,WAAW,OAAA;AAClE,6DAAkC;AAElC,iDAA+C;AAAtC,8GAAA,aAAa,OAAA"}

package/dist/module-api/enums.d.ts

@@ -2,7 +2,15 @@
  * All the possible status levels that an instance can use.
  * Note: When adding more, companion needs to be updated to know how they should be displayed
  */
-export declare type InstanceStatus = 'ok' | 'connecting' | 'disconnected' | 'connection_failure' | 'bad_config' | 'unknown_error' | 'unknown_warning';
+export declare enum InstanceStatus {
+    Ok = "ok",
+    Connecting = "connecting",
+    Disconnected = "disconnected",
+    ConnectionFailure = "connection_failure",
+    BadConfig = "bad_config",
+    UnknownError = "unknown_error",
+    UnknwownWarning = "unknown_warning"
+}
 export declare type LogLevel = 'info' | 'warn' | 'error' | 'debug';
 export declare namespace Regex {
     const IP = "/^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/";

package/dist/module-api/enums.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/module-api/enums.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,cAAc,GACvB,IAAI,GACJ,YAAY,GACZ,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,eAAe,GACf,iBAAiB,CAAA;AAEpB,oBAAY,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAA;AAE1D,yBAAiB,KAAK,CAAC;IAEf,MAAM,EAAE,mGAAmG,CAAA;IAC3G,MAAM,QAAQ,iHAC0F,CAAA;IACxG,MAAM,OAAO,0BAA0B,CAAA;IACvC,MAAM,IAAI,4LACyK,CAAA;IACnL,MAAM,OAAO,+BAA+B,CAAA;IAC5C,MAAM,KAAK,2BAA2B,CAAA;IACtC,MAAM,YAAY,gCAAgC,CAAA;IAClD,MAAM,YAAY,6BAA6B,CAAA;IAC/C,MAAM,MAAM,aAAa,CAAA;IACzB,MAAM,aAAa,kBAAkB,CAAA;IACrC,MAAM,SAAS,WAAW,CAAA;IAC1B,MAAM,QAAQ,uGACgF,CAAA;CACrG"}
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/module-api/enums.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,cAAc;IACzB,EAAE,OAAO;IACT,UAAU,eAAe;IACzB,YAAY,iBAAiB;IAC7B,iBAAiB,uBAAuB;IACxC,SAAS,eAAe;IACxB,YAAY,kBAAkB;IAC9B,eAAe,oBAAoB;CACnC;AAED,oBAAY,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAA;AAE1D,yBAAiB,KAAK,CAAC;IAEf,MAAM,EAAE,mGAAmG,CAAA;IAC3G,MAAM,QAAQ,iHAC0F,CAAA;IACxG,MAAM,OAAO,0BAA0B,CAAA;IACvC,MAAM,IAAI,4LACyK,CAAA;IACnL,MAAM,OAAO,+BAA+B,CAAA;IAC5C,MAAM,KAAK,2BAA2B,CAAA;IACtC,MAAM,YAAY,gCAAgC,CAAA;IAClD,MAAM,YAAY,6BAA6B,CAAA;IAC/C,MAAM,MAAM,aAAa,CAAA;IACzB,MAAM,aAAa,kBAAkB,CAAA;IACrC,MAAM,SAAS,WAAW,CAAA;IAC1B,MAAM,QAAQ,uGACgF,CAAA;CACrG"}

package/dist/module-api/enums.js

@@ -1,6 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Regex = void 0;
+exports.Regex = exports.InstanceStatus = void 0;
+/**
+ * All the possible status levels that an instance can use.
+ * Note: When adding more, companion needs to be updated to know how they should be displayed
+ */
+var InstanceStatus;
+(function (InstanceStatus) {
+    InstanceStatus["Ok"] = "ok";
+    InstanceStatus["Connecting"] = "connecting";
+    InstanceStatus["Disconnected"] = "disconnected";
+    InstanceStatus["ConnectionFailure"] = "connection_failure";
+    InstanceStatus["BadConfig"] = "bad_config";
+    InstanceStatus["UnknownError"] = "unknown_error";
+    InstanceStatus["UnknwownWarning"] = "unknown_warning";
+})(InstanceStatus = exports.InstanceStatus || (exports.InstanceStatus = {}));
 var Regex;
 (function (Regex) {
     // TODO - are all of these needed?

package/dist/module-api/enums.js.map

@@ -1 +1 @@
-{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../src/module-api/enums.ts"],"names":[],"mappings":";;;AAeA,IAAiB,KAAK,CAiBrB;AAjBD,WAAiB,KAAK;IACrB,kCAAkC;IACrB,QAAE,GAAG,gGAAgG,CAAA;IACrG,cAAQ,GACpB,8GAA8G,CAAA;IAClG,aAAO,GAAG,uBAAuB,CAAA;IACjC,UAAI,GAChB,yLAAyL,CAAA;IAC7K,aAAO,GAAG,4BAA4B,CAAA;IACtC,WAAK,GAAG,wBAAwB,CAAA;IAChC,kBAAY,GAAG,6BAA6B,CAAA;IAC5C,kBAAY,GAAG,0BAA0B,CAAA;IACzC,YAAM,GAAG,UAAU,CAAA;IACnB,mBAAa,GAAG,eAAe,CAAA;IAC/B,eAAS,GAAG,QAAQ,CAAA;IACpB,cAAQ,GACpB,oGAAoG,CAAA;AACtG,CAAC,EAjBgB,KAAK,GAAL,aAAK,KAAL,aAAK,QAiBrB"}
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../src/module-api/enums.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,IAAY,cAQX;AARD,WAAY,cAAc;IACzB,2BAAS,CAAA;IACT,2CAAyB,CAAA;IACzB,+CAA6B,CAAA;IAC7B,0DAAwC,CAAA;IACxC,0CAAwB,CAAA;IACxB,gDAA8B,CAAA;IAC9B,qDAAmC,CAAA;AACpC,CAAC,EARW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAQzB;AAID,IAAiB,KAAK,CAiBrB;AAjBD,WAAiB,KAAK;IACrB,kCAAkC;IACrB,QAAE,GAAG,gGAAgG,CAAA;IACrG,cAAQ,GACpB,8GAA8G,CAAA;IAClG,aAAO,GAAG,uBAAuB,CAAA;IACjC,UAAI,GAChB,yLAAyL,CAAA;IAC7K,aAAO,GAAG,4BAA4B,CAAA;IACtC,WAAK,GAAG,wBAAwB,CAAA;IAChC,kBAAY,GAAG,6BAA6B,CAAA;IAC5C,kBAAY,GAAG,0BAA0B,CAAA;IACzC,YAAM,GAAG,UAAU,CAAA;IACnB,mBAAa,GAAG,eAAe,CAAA;IAC/B,eAAS,GAAG,QAAQ,CAAA;IACpB,cAAQ,GACpB,oGAAoG,CAAA;AACtG,CAAC,EAjBgB,KAAK,GAAL,aAAK,KAAL,aAAK,QAiBrB"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@companion-module/base",
-	"version": "0.1.2",
+	"version": "0.2.0",
 	"type": "commonjs",
 	"main": "dist/index.js",
 	"typings": "dist/index.d.ts",
@@ -15,18 +15,19 @@
 		"dist"
 	],
 	"dependencies": {
-		"@sentry/node": "^7.5.1",
-		"@sentry/tracing": "^7.5.1",
+		"@sentry/node": "^7.12.1",
+		"@sentry/tracing": "^7.12.1",
+		"eventemitter3": "^4.0.7",
 		"p-queue": "^6.6.2",
 		"p-timeout": "^4.1.0",
-		"socket.io-client": "^4.5.1",
+		"socket.io-client": "^4.5.2",
 		"tslib": "^2.4.0"
 	},
 	"devDependencies": {
 		"@tsconfig/node14": "^1.0.3",
-		"@types/node": "^14",
+		"@types/node": "^14.18.26",
 		"prettier": "^2.7.1",
-		"typedoc": "^0.23.7",
-		"typescript": "~4.7.4"
+		"typedoc": "^0.23.14",
+		"typescript": "~4.8.2"
 	}
 }