@companion-module/base 1.14.0 → 1.99.0-0-nightly-feat-split-api-20251221-153951-fa12995

package/dist/helpers/__tests__/udp.spec.js

@@ -0,0 +1,200 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const vitest_1 = require("vitest");
+const udp_js_1 = require("../udp.js");
+const events_1 = tslib_1.__importDefault(require("events"));
+const enums_js_1 = require("../../module-api/enums.js");
+const createSocketMock = vitest_1.vi.fn(() => {
+    throw new Error('Not implemented');
+});
+vitest_1.vi.mock('dgram', () => {
+    return {
+        default: {
+            createSocket: (...args) => createSocketMock(...args),
+        },
+    };
+});
+class MinimalSocket extends events_1.default {
+    isOpen = false;
+    constructor() {
+        super();
+    }
+    async emitMessage(address, port, msg) {
+        const rinfo = {
+            address: address,
+            port: port,
+            family: 'IPv4',
+            size: msg.length,
+        };
+        this.emit('message', msg, rinfo);
+        await vitest_1.vi.runAllTimersAsync();
+    }
+    bind = vitest_1.vi.fn(() => {
+        throw new Error('Not implemented');
+    });
+    send = vitest_1.vi.fn(() => {
+        throw new Error('Not implemented');
+    });
+    close = vitest_1.vi.fn(() => {
+        return this;
+    });
+}
+(0, vitest_1.describe)('UDP', () => {
+    (0, vitest_1.beforeEach)(() => {
+        createSocketMock.mockClear();
+    });
+    (0, vitest_1.describe)('construct', () => {
+        // beforeEach(() => {
+        // 	vi.useFakeTimers()
+        // })
+        (0, vitest_1.it)('no socket', () => {
+            createSocketMock.mockImplementationOnce(() => {
+                throw new Error('No sockets!');
+            });
+            (0, vitest_1.expect)(() => new udp_js_1.UDPHelper('1.2.3.4', 852)).toThrow('No sockets!');
+        });
+        (0, vitest_1.it)('bad bind', async () => {
+            const rawSocket = new MinimalSocket();
+            createSocketMock.mockReturnValueOnce(rawSocket);
+            (0, vitest_1.expect)(() => new udp_js_1.UDPHelper('1.2.3.4', 852)).toThrow('Unable to bind');
+            (0, vitest_1.expect)(createSocketMock).toHaveBeenCalledTimes(1);
+            (0, vitest_1.expect)(rawSocket.bind).toHaveBeenCalledTimes(1);
+            (0, vitest_1.expect)(rawSocket.bind).toHaveBeenCalledWith(0, undefined);
+        });
+        (0, vitest_1.it)('ok', async () => {
+            const rawSocket = new MinimalSocket();
+            createSocketMock.mockReturnValueOnce(rawSocket);
+            rawSocket.bind.mockImplementationOnce(() => {
+                // No op
+                return rawSocket;
+            });
+            const socket = new udp_js_1.UDPHelper('1.2.3.4', 852);
+            try {
+                (0, vitest_1.expect)(socket).toBeTruthy();
+                (0, vitest_1.expect)(createSocketMock).toHaveBeenCalledTimes(1);
+                (0, vitest_1.expect)(rawSocket.bind).toHaveBeenCalledTimes(1);
+                (0, vitest_1.expect)(rawSocket.bind).toHaveBeenCalledWith(0, undefined);
+            }
+            finally {
+                socket.destroy();
+            }
+        });
+        // TODO - options
+    });
+    (0, vitest_1.it)('error propogation', async () => {
+        const rawSocket = new MinimalSocket();
+        createSocketMock.mockReturnValueOnce(rawSocket);
+        rawSocket.bind.mockImplementationOnce(() => rawSocket);
+        const socket = new udp_js_1.UDPHelper('1.2.3.4', 852);
+        try {
+            (0, vitest_1.expect)(socket).toBeTruthy();
+            const errorHandler = vitest_1.vi.fn(() => null);
+            const statusHandler = vitest_1.vi.fn(() => null);
+            socket.on('error', errorHandler);
+            socket.on('status_change', statusHandler);
+            (0, vitest_1.expect)(createSocketMock).toHaveBeenCalledTimes(1);
+            rawSocket.emit('error', new Error('My fake error'));
+            (0, vitest_1.expect)(errorHandler).toHaveBeenCalledTimes(1);
+            (0, vitest_1.expect)(errorHandler).toHaveBeenCalledWith(new Error('My fake error'));
+            (0, vitest_1.expect)(statusHandler).toHaveBeenCalledTimes(1);
+            (0, vitest_1.expect)(statusHandler).toHaveBeenCalledWith(enums_js_1.InstanceStatus.UnknownError, 'My fake error');
+        }
+        finally {
+            socket.destroy();
+        }
+    });
+    (0, vitest_1.describe)('listening', () => {
+        (0, vitest_1.it)('ok', async () => {
+            const rawSocket = new MinimalSocket();
+            createSocketMock.mockReturnValueOnce(rawSocket);
+            rawSocket.bind.mockImplementationOnce(() => rawSocket);
+            const socket = new udp_js_1.UDPHelper('1.2.3.4', 852);
+            try {
+                (0, vitest_1.expect)(socket).toBeTruthy();
+                const listeningHandler = vitest_1.vi.fn(() => null);
+                const statusHandler = vitest_1.vi.fn(() => null);
+                socket.on('listening', listeningHandler);
+                socket.on('status_change', statusHandler);
+                (0, vitest_1.expect)(createSocketMock).toHaveBeenCalledTimes(1);
+                rawSocket.emit('listening');
+                (0, vitest_1.expect)(listeningHandler).toHaveBeenCalledTimes(1);
+                (0, vitest_1.expect)(statusHandler).toHaveBeenCalledTimes(1);
+                (0, vitest_1.expect)(statusHandler).toHaveBeenCalledWith(enums_js_1.InstanceStatus.Ok, undefined);
+            }
+            finally {
+                socket.destroy();
+            }
+        });
+        // TODO - options
+    });
+    // it('no error handler timeout', () => {
+    // 	const rawSocket = new MinimalSocket()
+    // 	createSocketMock.mockReturnValueOnce(rawSocket as any)
+    // 	rawSocket.bind.mockImplementationOnce(() => rawSocket as any)
+    // 	vi.advanceTimersByTimeAsync(10000)
+    // })
+    (0, vitest_1.describe)('send', () => {
+        const rawSocket = new MinimalSocket();
+        rawSocket.bind.mockImplementation(() => rawSocket);
+        let socket;
+        (0, vitest_1.beforeAll)(() => {
+            createSocketMock.mockReturnValueOnce(rawSocket);
+            socket = new udp_js_1.UDPHelper('1.2.3.4', 852);
+            (0, vitest_1.expect)(socket).toBeTruthy();
+        });
+        (0, vitest_1.beforeEach)(() => {
+            rawSocket.close.mockClear();
+            rawSocket.send.mockClear();
+        });
+        (0, vitest_1.afterAll)(() => {
+            if (socket)
+                socket.destroy();
+        });
+        (0, vitest_1.it)('destroyed', async () => {
+            createSocketMock.mockReturnValueOnce(rawSocket);
+            const mySocket = new udp_js_1.UDPHelper('1.2.3.4', 852);
+            (0, vitest_1.expect)(mySocket).toBeTruthy();
+            mySocket.destroy();
+            (0, vitest_1.expect)(rawSocket.close).toHaveBeenCalledTimes(1);
+            await (0, vitest_1.expect)(mySocket.send('test')).rejects.toThrow('Cannot write to destroyed socket');
+        });
+        (0, vitest_1.it)('no message', async () => {
+            await (0, vitest_1.expect)(socket.send(undefined)).rejects.toThrow('No message to send');
+            (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledTimes(0);
+        });
+        (0, vitest_1.it)('ok: string', async () => {
+            rawSocket.send.mockImplementation((msg, offset, length, cb) => {
+                if (!cb)
+                    return;
+                cb(null, length);
+            });
+            await (0, vitest_1.expect)(socket.send('test 123')).resolves.toBeUndefined();
+            (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledTimes(1);
+            (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledWith('test 123', 852, '1.2.3.4', vitest_1.expect.any(Function));
+        });
+        (0, vitest_1.it)('ok: buffer', async () => {
+            rawSocket.send.mockImplementation((msg, offset, length, cb) => {
+                if (!cb)
+                    return;
+                cb(null, length);
+            });
+            const msg = Buffer.from('test 123');
+            await (0, vitest_1.expect)(socket.send(msg)).resolves.toBeUndefined();
+            (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledTimes(1);
+            (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledWith(msg, 852, '1.2.3.4', vitest_1.expect.any(Function));
+        });
+        (0, vitest_1.it)('send error', async () => {
+            rawSocket.send.mockImplementation((msg, offset, length, cb) => {
+                if (!cb)
+                    return;
+                cb(new Error('buffer overflow'), 0);
+            });
+            const msg = Buffer.from('test 123');
+            await (0, vitest_1.expect)(socket.send(msg)).rejects.toThrow('buffer overflow');
+            (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledTimes(1);
+            (0, vitest_1.expect)(rawSocket.send).toHaveBeenCalledWith(msg, 852, '1.2.3.4', vitest_1.expect.any(Function));
+        });
+    });
+});
+//# sourceMappingURL=udp.spec.js.map

package/dist/helpers/__tests__/udp.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"udp.spec.js","sourceRoot":"","sources":["../../../src/helpers/__tests__/udp.spec.ts"],"names":[],"mappings":";;;AAAA,mCAAkF;AAElF,sCAAqC;AACrC,4DAAiC;AAEjC,wDAA0D;AAE1D,MAAM,gBAAgB,GAAG,WAAE,CAAC,EAAE,CAAsB,GAAG,EAAE;IACxD,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;AACnC,CAAC,CAAC,CAAA;AACF,WAAE,CAAC,IAAI,CAAC,OAAO,EAAE,GAAG,EAAE;IACrB,OAAO;QACN,OAAO,EAAE;YACR,YAAY,EAAE,CAAC,GAAG,IAAqC,EAAE,EAAE,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;SACrF;KACD,CAAA;AACF,CAAC,CAAC,CAAA;AAEF,MAAM,aAAc,SAAQ,gBAAY;IAChC,MAAM,GAAG,KAAK,CAAA;IAErB;QACC,KAAK,EAAE,CAAA;IACR,CAAC;IAEM,KAAK,CAAC,WAAW,CAAC,OAAe,EAAE,IAAY,EAAE,GAAW;QAClE,MAAM,KAAK,GAAe;YACzB,OAAO,EAAE,OAAO;YAChB,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,GAAG,CAAC,MAAM;SAChB,CAAA;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,GAAG,EAAE,KAAK,CAAC,CAAA;QAEhC,MAAM,WAAE,CAAC,iBAAiB,EAAE,CAAA;IAC7B,CAAC;IAEM,IAAI,GAAG,WAAE,CAAC,EAAE,CAAiB,GAAG,EAAE;QACxC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEK,IAAI,GAAG,WAAE,CAAC,EAAE,CAAiB,GAAG,EAAE;QACxC,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;IACnC,CAAC,CAAC,CAAA;IAEK,KAAK,GAAG,WAAE,CAAC,EAAE,CAAkB,GAAG,EAAE;QAC1C,OAAO,IAAW,CAAA;IACnB,CAAC,CAAC,CAAA;CACF;AAED,IAAA,iBAAQ,EAAC,KAAK,EAAE,GAAG,EAAE;IACpB,IAAA,mBAAU,EAAC,GAAG,EAAE;QACf,gBAAgB,CAAC,SAAS,EAAE,CAAA;IAC7B,CAAC,CAAC,CAAA;IAEF,IAAA,iBAAQ,EAAC,WAAW,EAAE,GAAG,EAAE;QAC1B,qBAAqB;QACrB,sBAAsB;QACtB,KAAK;QACL,IAAA,WAAE,EAAC,WAAW,EAAE,GAAG,EAAE;YACpB,gBAAgB,CAAC,sBAAsB,CAAC,GAAG,EAAE;gBAC5C,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAA;YAC/B,CAAC,CAAC,CAAA;YAEF,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAA;QACnE,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,UAAU,EAAE,KAAK,IAAI,EAAE;YACzB,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAA;YACrC,gBAAgB,CAAC,mBAAmB,CAAC,SAAgB,CAAC,CAAA;YAEtD,IAAA,eAAM,EAAC,GAAG,EAAE,CAAC,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;YACrE,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAEjD,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC/C,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAA;QAC1D,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,IAAI,EAAE,KAAK,IAAI,EAAE;YACnB,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAA;YACrC,gBAAgB,CAAC,mBAAmB,CAAC,SAAgB,CAAC,CAAA;YAEtD,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE;gBAC1C,QAAQ;gBACR,OAAO,SAAgB,CAAA;YACxB,CAAC,CAAC,CAAA;YAEF,MAAM,MAAM,GAAG,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;YAC5C,IAAI,CAAC;gBACJ,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA;gBAC3B,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;gBAEjD,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;gBAC/C,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,CAAC,EAAE,SAAS,CAAC,CAAA;YAC1D,CAAC;oBAAS,CAAC;gBACV,MAAM,CAAC,OAAO,EAAE,CAAA;YACjB,CAAC;QACF,CAAC,CAAC,CAAA;QAEF,iBAAiB;IAClB,CAAC,CAAC,CAAA;IAEF,IAAA,WAAE,EAAC,mBAAmB,EAAE,KAAK,IAAI,EAAE;QAClC,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAA;QACrC,gBAAgB,CAAC,mBAAmB,CAAC,SAAgB,CAAC,CAAA;QAEtD,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,SAAgB,CAAC,CAAA;QAE7D,MAAM,MAAM,GAAG,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;QAC5C,IAAI,CAAC;YACJ,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA;YAE3B,MAAM,YAAY,GAAG,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;YACtC,MAAM,aAAa,GAAG,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;YACvC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,YAAY,CAAC,CAAA;YAChC,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,aAAa,CAAC,CAAA;YAEzC,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAEjD,SAAS,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,CAAA;YAEnD,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC7C,IAAA,eAAM,EAAC,YAAY,CAAC,CAAC,oBAAoB,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,CAAA;YACrE,IAAA,eAAM,EAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC9C,IAAA,eAAM,EAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC,yBAAc,CAAC,YAAY,EAAE,eAAe,CAAC,CAAA;QACzF,CAAC;gBAAS,CAAC;YACV,MAAM,CAAC,OAAO,EAAE,CAAA;QACjB,CAAC;IACF,CAAC,CAAC,CAAA;IAEF,IAAA,iBAAQ,EAAC,WAAW,EAAE,GAAG,EAAE;QAC1B,IAAA,WAAE,EAAC,IAAI,EAAE,KAAK,IAAI,EAAE;YACnB,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAA;YACrC,gBAAgB,CAAC,mBAAmB,CAAC,SAAgB,CAAC,CAAA;YAEtD,SAAS,CAAC,IAAI,CAAC,sBAAsB,CAAC,GAAG,EAAE,CAAC,SAAgB,CAAC,CAAA;YAE7D,MAAM,MAAM,GAAG,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;YAC5C,IAAI,CAAC;gBACJ,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA;gBAE3B,MAAM,gBAAgB,GAAG,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;gBAC1C,MAAM,aAAa,GAAG,WAAE,CAAC,EAAE,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA;gBACvC,MAAM,CAAC,EAAE,CAAC,WAAW,EAAE,gBAAgB,CAAC,CAAA;gBACxC,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,aAAa,CAAC,CAAA;gBAEzC,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;gBAEjD,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAE3B,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;gBACjD,IAAA,eAAM,EAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;gBAC9C,IAAA,eAAM,EAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC,yBAAc,CAAC,EAAE,EAAE,SAAS,CAAC,CAAA;YACzE,CAAC;oBAAS,CAAC;gBACV,MAAM,CAAC,OAAO,EAAE,CAAA;YACjB,CAAC;QACF,CAAC,CAAC,CAAA;QAEF,iBAAiB;IAClB,CAAC,CAAC,CAAA;IAEF,yCAAyC;IACzC,yCAAyC;IACzC,0DAA0D;IAE1D,iEAAiE;IAEjE,sCAAsC;IACtC,KAAK;IAEL,IAAA,iBAAQ,EAAC,MAAM,EAAE,GAAG,EAAE;QACrB,MAAM,SAAS,GAAG,IAAI,aAAa,EAAE,CAAA;QACrC,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,GAAG,EAAE,CAAC,SAAgB,CAAC,CAAA;QACzD,IAAI,MAAiB,CAAA;QAErB,IAAA,kBAAS,EAAC,GAAG,EAAE;YACd,gBAAgB,CAAC,mBAAmB,CAAC,SAAgB,CAAC,CAAA;YAEtD,MAAM,GAAG,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;YACtC,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA;QAC5B,CAAC,CAAC,CAAA;QAEF,IAAA,mBAAU,EAAC,GAAG,EAAE;YACf,SAAS,CAAC,KAAK,CAAC,SAAS,EAAE,CAAA;YAC3B,SAAS,CAAC,IAAI,CAAC,SAAS,EAAE,CAAA;QAC3B,CAAC,CAAC,CAAA;QAEF,IAAA,iBAAQ,EAAC,GAAG,EAAE;YACb,IAAI,MAAM;gBAAE,MAAM,CAAC,OAAO,EAAE,CAAA;QAC7B,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,WAAW,EAAE,KAAK,IAAI,EAAE;YAC1B,gBAAgB,CAAC,mBAAmB,CAAC,SAAgB,CAAC,CAAA;YAEtD,MAAM,QAAQ,GAAG,IAAI,kBAAS,CAAC,SAAS,EAAE,GAAG,CAAC,CAAA;YAC9C,IAAA,eAAM,EAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,CAAA;YAE7B,QAAQ,CAAC,OAAO,EAAE,CAAA;YAClB,IAAA,eAAM,EAAC,SAAS,CAAC,KAAK,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAEhD,MAAM,IAAA,eAAM,EAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAA;QACxF,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,YAAY,EAAE,KAAK,IAAI,EAAE;YAC3B,MAAM,IAAA,eAAM,EAAC,MAAM,CAAC,IAAI,CAAC,SAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAA;YAEjF,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;QAChD,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,YAAY,EAAE,KAAK,IAAI,EAAE;YAC3B,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE;gBAC7D,IAAI,CAAC,EAAE;oBAAE,OAAM;gBAEf,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YACjB,CAAC,CAAC,CAAA;YAEF,MAAM,IAAA,eAAM,EAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAA;YAE9D,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC/C,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,UAAU,EAAE,GAAG,EAAE,SAAS,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAA;QAC9F,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,YAAY,EAAE,KAAK,IAAI,EAAE;YAC3B,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE;gBAC7D,IAAI,CAAC,EAAE;oBAAE,OAAM;gBAEf,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YACjB,CAAC,CAAC,CAAA;YAEF,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACnC,MAAM,IAAA,eAAM,EAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,aAAa,EAAE,CAAA;YAEvD,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC/C,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAA;QACvF,CAAC,CAAC,CAAA;QAEF,IAAA,WAAE,EAAC,YAAY,EAAE,KAAK,IAAI,EAAE;YAC3B,SAAS,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE;gBAC7D,IAAI,CAAC,EAAE;oBAAE,OAAM;gBAEf,EAAE,CAAC,IAAI,KAAK,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAA;YACpC,CAAC,CAAC,CAAA;YAEF,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAA;YACnC,MAAM,IAAA,eAAM,EAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;YAEjE,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC/C,IAAA,eAAM,EAAC,SAAS,CAAC,IAAI,CAAC,CAAC,oBAAoB,CAAC,GAAG,EAAE,GAAG,EAAE,SAAS,EAAE,eAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAA;QACvF,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;AACH,CAAC,CAAC,CAAA"}

package/dist/helpers/index.d.ts

@@ -1,4 +1,3 @@
 export * from './tcp.js';
 export * from './telnet.js';
 export * from './udp.js';
-//# sourceMappingURL=index.d.ts.map

package/dist/helpers/tcp.d.ts

@@ -27,4 +27,3 @@ export declare class TCPHelper extends EventEmitter<TCPHelperEvents> {
     send(message: string | Buffer): Promise<boolean>;
     destroy(): void;
 }
-//# sourceMappingURL=tcp.d.ts.map

package/dist/helpers/telnet.d.ts

@@ -15,4 +15,3 @@ export declare class TelnetHelper extends EventEmitter<TelnetHelperEvents> {
     send(message: string | Buffer): Promise<boolean>;
     destroy(): void;
 }
-//# sourceMappingURL=telnet.d.ts.map

package/dist/helpers/udp.d.ts

@@ -29,4 +29,3 @@ export declare class UDPHelper extends EventEmitter<UDPHelperEvents> {
     send(message: string | Buffer): Promise<void>;
     destroy(): void;
 }
-//# sourceMappingURL=udp.d.ts.map

package/dist/host-api/context.d.ts

@@ -0,0 +1,59 @@
+/**
+ * Warning: these types are intentionally semi-isolated from the module-api folder.
+ * While it causes a lot of duplicate typings and requires us to do translation of types,
+ * it allows for us to be selective as to whether a change impacts the module api or the host api.
+ * This will allow for cleaner and more stable apis which can both evolve at different rates
+ */
+import type { RemoteInfo } from 'dgram';
+import type { CompanionActionDefinitions, CompanionFeedbackDefinitions, CompanionPresetDefinitions, CompanionRecordedAction, CompanionStaticUpgradeScript, CompanionVariableDefinition, CompanionVariableValue, CompanionVariableValues, InstanceStatus } from '../module-api/index.js';
+import type { OSCSomeArguments } from '../common/osc.js';
+import type { SharedUdpSocketImpl } from '../module-api/shared-udp-socket.js';
+export declare function isInstanceContext<TConfig, TSecrets>(obj: unknown): obj is InstanceContext<TConfig, TSecrets>;
+export interface InstanceContext<TConfig, TSecrets> extends InstanceSharedUdpSocketContext {
+    readonly _isInstanceContext: true;
+    readonly id: string;
+    label: string;
+    readonly upgradeScripts: CompanionStaticUpgradeScript<TConfig, TSecrets>[];
+    saveConfig: (config: TConfig | undefined, secrets: TSecrets | undefined) => void;
+    updateStatus(status: InstanceStatus, message: string | null): void;
+    oscSend(host: string, port: number, path: string, args: OSCSomeArguments): void;
+    parseVariablesInString(text: string): Promise<string>;
+    recordAction(action: CompanionRecordedAction, uniquenessId?: string): void;
+    setActionDefinitions: (actions: CompanionActionDefinitions) => void;
+    subscribeActions: (actionIds: string[]) => void;
+    unsubscribeActions: (actionIds: string[]) => void;
+    setFeedbackDefinitions: (feedbacks: CompanionFeedbackDefinitions) => void;
+    subscribeFeedbacks: (feedbackIds: string[]) => void;
+    unsubscribeFeedbacks: (feedbackIds: string[]) => void;
+    checkFeedbacks: (feedbackTypes: string[]) => void;
+    checkFeedbacksById: (feedbackIds: string[]) => void;
+    setPresetDefinitions: (presets: CompanionPresetDefinitions) => void;
+    setVariableDefinitions: (variables: CompanionVariableDefinition[]) => void;
+    setVariableValues: (values: CompanionVariableValues) => void;
+    getVariableValue: (variableId: string) => CompanionVariableValue | undefined;
+}
+export interface InstanceSharedUdpSocketContext {
+    readonly sharedUdpSocketHandlers: Map<string, SharedUdpSocketImpl>;
+    sharedUdpSocketJoin: (msg: SharedUdpSocketMessageJoin) => Promise<string>;
+    sharedUdpSocketLeave: (msg: SharedUdpSocketMessageLeave) => Promise<void>;
+    sharedUdpSocketSend: (msg: SharedUdpSocketMessageSend) => Promise<void>;
+}
+export interface SharedUdpSocketMessageJoin {
+    family: 'udp4' | 'udp6';
+    portNumber: number;
+}
+export interface SharedUdpSocketMessageLeave {
+    handleId: string;
+}
+export interface SharedUdpSocketMessageSend {
+    handleId: string;
+    message: Buffer;
+    address: string;
+    port: number;
+}
+export interface SharedUdpSocketMessage {
+    handleId: string;
+    portNumber: number;
+    message: Buffer;
+    source: RemoteInfo;
+}

package/dist/host-api/{api.js → context.js}

@@ -6,4 +6,9 @@
  * This will allow for cleaner and more stable apis which can both evolve at different rates
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=api.js.map
+exports.isInstanceContext = isInstanceContext;
+function isInstanceContext(obj) {
+    const obj2 = obj;
+    return typeof obj2 === 'object' && typeof obj2.id === 'string' && obj2._isInstanceContext === true;
+}
+//# sourceMappingURL=context.js.map

package/dist/host-api/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../src/host-api/context.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;AAiBH,8CAGC;AAHD,SAAgB,iBAAiB,CAAoB,GAAY;IAChE,MAAM,IAAI,GAAG,GAAyC,CAAA;IACtD,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,IAAI,IAAI,CAAC,kBAAkB,KAAK,IAAI,CAAA;AACnG,CAAC"}

package/dist/instance-base.d.ts

@@ -9,4 +9,3 @@ export interface InstanceBaseShared<TConfig, TSecrets = undefined> {
      */
     destroy(): void | Promise<void>;
 }
-//# sourceMappingURL=instance-base.d.ts.map

package/dist/logging.d.ts

@@ -0,0 +1,20 @@
+declare global {
+    /**
+     * INTERNAL USE ONLY
+     */
+    var SURFACE_LOGGER: LoggingSink | undefined;
+}
+export type LogLevel = 'info' | 'warn' | 'error' | 'debug';
+export interface ModuleLogger {
+    debug: (message: string) => void;
+    info: (message: string) => void;
+    warn: (message: string) => void;
+    error: (message: string) => void;
+}
+export type LoggingSink = (source: string | undefined, level: LogLevel, message: string) => void;
+/**
+ * Create a logger instance
+ * @param source The source path to use for the logger
+ * @returns A logger instance
+ */
+export declare function createModuleLogger(source?: string): ModuleLogger;

package/dist/logging.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createModuleLogger = createModuleLogger;
+const defaultLoggingSink = (source, level, message) => {
+    // Default logging implementation for unit testing purposes, this should be replaced by the host application
+    console.log(`[${level.toUpperCase()}]${source ? ` [${source}]` : ''} ${message}`);
+};
+function logToSink(source, level, message) {
+    const sink = typeof global.SURFACE_LOGGER === 'function' ? global.SURFACE_LOGGER : defaultLoggingSink;
+    sink(source, level, message);
+}
+/**
+ * Create a logger instance
+ * @param source The source path to use for the logger
+ * @returns A logger instance
+ */
+function createModuleLogger(source) {
+    return {
+        debug: (message) => logToSink(source, 'debug', message),
+        info: (message) => logToSink(source, 'info', message),
+        warn: (message) => logToSink(source, 'warn', message),
+        error: (message) => logToSink(source, 'error', message),
+    };
+}
+//# sourceMappingURL=logging.js.map

package/dist/logging.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.js","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":";;AAiCA,gDAOC;AAtBD,MAAM,kBAAkB,GAAgB,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,EAAE;IAClE,4GAA4G;IAC5G,OAAO,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,WAAW,EAAE,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,OAAO,EAAE,CAAC,CAAA;AAClF,CAAC,CAAA;AAED,SAAS,SAAS,CAAC,MAA0B,EAAE,KAAe,EAAE,OAAe;IAC9E,MAAM,IAAI,GAAG,OAAO,MAAM,CAAC,cAAc,KAAK,UAAU,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,kBAAkB,CAAA;IACrG,IAAI,CAAC,MAAM,EAAE,KAAK,EAAE,OAAO,CAAC,CAAA;AAC7B,CAAC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CAAC,MAAe;IACjD,OAAO;QACN,KAAK,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;QAC/D,IAAI,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;QAC7D,IAAI,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,CAAC;QAC7D,KAAK,EAAE,CAAC,OAAe,EAAE,EAAE,CAAC,SAAS,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,CAAC;KAC/D,CAAA;AACF,CAAC"}

package/dist/main.d.ts

@@ -0,0 +1,8 @@
+export * from './logging.js';
+export * from './manifest.js';
+export * from './module-api/index.js';
+export * from './common/osc.js';
+export * from './common/json-value.js';
+export * from './util.js';
+export * from './helpers/index.js';
+export { runEntrypoint, InstanceConstructor } from './entrypoint.js';

package/dist/main.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runEntrypoint = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./logging.js"), exports);
+tslib_1.__exportStar(require("./manifest.js"), exports);
+tslib_1.__exportStar(require("./module-api/index.js"), exports);
+tslib_1.__exportStar(require("./common/osc.js"), exports);
+tslib_1.__exportStar(require("./common/json-value.js"), exports);
+tslib_1.__exportStar(require("./util.js"), exports);
+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=main.js.map

package/dist/main.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;AAAA,uDAA4B;AAC5B,wDAA6B;AAC7B,gEAAqC;AACrC,0DAA+B;AAC/B,iEAAsC;AACtC,oDAAyB;AACzB,6DAAkC;AAElC,iDAAoE;AAA3D,8GAAA,aAAa,OAAA"}

package/dist/manifest.d.ts

@@ -2,4 +2,3 @@ import type { ModuleManifest, ModuleManifestMaintainer, ModuleManifestRuntime, M
 export { ModuleManifest, ModuleManifestMaintainer, ModuleManifestRuntime, ModuleBonjourQuery };
 /** Validate that a manifest looks correctly populated */
 export declare function validateManifest(manifest: ModuleManifest, looseChecks: boolean): void;
-//# sourceMappingURL=manifest.d.ts.map

package/dist/module-api/__tests__/shared-udp-socket.spec.d.ts

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