@companion-module/base 1.14.1 → 1.99.0-1-nightly-feat-2-0-20260118-141645-897e0fe

package/dist/logging.d.ts

@@ -0,0 +1,21 @@
+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;
+//# sourceMappingURL=logging.d.ts.map

package/dist/logging.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"logging.d.ts","sourceRoot":"","sources":["../src/logging.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,cAAc,EAAE,WAAW,GAAG,SAAS,CAAA;CAC3C;AAED,MAAM,MAAM,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAA;AAE1D,MAAM,WAAW,YAAY;IAC5B,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;IAChC,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;IAC/B,IAAI,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;IAC/B,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;CAChC;AAED,MAAM,MAAM,WAAW,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,EAAE,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI,CAAA;AAYhG;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,MAAM,CAAC,EAAE,MAAM,GAAG,YAAY,CAOhE"}

package/dist/logging.js

@@ -0,0 +1,22 @@
+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
+ */
+export 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":"AAkBA,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,MAAM,UAAU,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,9 @@
+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';
+//# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,wBAAwB,CAAA;AACtC,cAAc,WAAW,CAAA;AACzB,cAAc,oBAAoB,CAAA;AAElC,OAAO,EAAE,aAAa,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAA"}

package/dist/{index.d.ts → main.js}

@@ -1,8 +1,9 @@
+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 { literal, combineRgb, splitRgb, splitHsl, splitHsv, splitHex, RgbComponents, assertNever, parseEscapeCharacters, substituteEscapeCharacters, OptionsObject, } from './util.js';
+export * from './util.js';
 export * from './helpers/index.js';
 export { runEntrypoint } from './entrypoint.js';
-//# sourceMappingURL=index.d.ts.map
+//# 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,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA;AAC7B,cAAc,uBAAuB,CAAA;AACrC,cAAc,iBAAiB,CAAA;AAC/B,cAAc,wBAAwB,CAAA;AACtC,cAAc,WAAW,CAAA;AACzB,cAAc,oBAAoB,CAAA;AAElC,OAAO,EAAE,aAAa,EAAuB,MAAM,iBAAiB,CAAA"}

package/dist/manifest.js

@@ -1,12 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateManifest = validateManifest;
-const tslib_1 = require("tslib");
 // @ts-expect-error no typings
 // eslint-disable-next-line n/no-missing-import
-const validate_manifest_js_1 = tslib_1.__importDefault(require("../generated/validate_manifest.js"));
+import validateManifestSchema from '../generated/validate_manifest.js';
 /** Validate that a manifest looks correctly populated */
-function validateManifest(manifest, looseChecks) {
+export function validateManifest(manifest, looseChecks) {
     if (!looseChecks) {
         const manifestStr = JSON.stringify(manifest);
         if (manifestStr.includes('companion-module-your-module-name'))
@@ -27,8 +23,8 @@ function validateManifest(manifest, looseChecks) {
     if (manifest.legacyIds.includes(manifest.id)) {
         throw new Error(`Manifest contains itself '${manifest.id}' in legacyIds`);
     }
-    if (!(0, validate_manifest_js_1.default)(manifest)) {
-        const errors = validate_manifest_js_1.default.errors;
+    if (!validateManifestSchema(manifest)) {
+        const errors = validateManifestSchema.errors;
         if (!errors)
             throw new Error(`Manifest failed validation with unknown reason`);
         throw new Error(`Manifest validation failed: ${JSON.stringify(errors)}`);

package/dist/manifest.js.map

@@ -1 +1 @@
-{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":";;AAaA,4CAmCC;;AA1CD,8BAA8B;AAC9B,+CAA+C;AAC/C,qGAAsE;AAItE,yDAAyD;AACzD,SAAgB,gBAAgB,CAAC,QAAwB,EAAE,WAAoB;IAC9E,IAAI,CAAC,WAAW,EAAE,CAAC;QAClB,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;QAC5C,IAAI,WAAW,CAAC,QAAQ,CAAC,mCAAmC,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,qFAAqF,CAAC,CAAA;QAEvG,IAAI,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAA;QAEtF,IAAI,WAAW,CAAC,QAAQ,CAAC,6CAA6C,CAAC;YACtE,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAA;QAEjH,IAAI,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAA;QAE/E,IAAI,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;QAEhF,IAAI,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;QAElF,IAAI,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;IACnF,CAAC;IAED,IAAI,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,6BAA6B,QAAQ,CAAC,EAAE,gBAAgB,CAAC,CAAA;IAC1E,CAAC;IAED,IAAI,CAAC,IAAA,8BAAsB,EAAC,QAAQ,CAAC,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,8BAAsB,CAAC,MAAM,CAAA;QAC5C,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;QAE9E,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IACzE,CAAC;AACF,CAAC"}
+{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":"AAMA,8BAA8B;AAC9B,+CAA+C;AAC/C,OAAO,sBAAsB,MAAM,mCAAmC,CAAA;AAItE,yDAAyD;AACzD,MAAM,UAAU,gBAAgB,CAAC,QAAwB,EAAE,WAAoB;IAC9E,IAAI,CAAC,WAAW,EAAE,CAAC;QAClB,MAAM,WAAW,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAA;QAC5C,IAAI,WAAW,CAAC,QAAQ,CAAC,mCAAmC,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,qFAAqF,CAAC,CAAA;QAEvG,IAAI,WAAW,CAAC,QAAQ,CAAC,kBAAkB,CAAC;YAC3C,MAAM,IAAI,KAAK,CAAC,oEAAoE,CAAC,CAAA;QAEtF,IAAI,WAAW,CAAC,QAAQ,CAAC,6CAA6C,CAAC;YACtE,MAAM,IAAI,KAAK,CAAC,+FAA+F,CAAC,CAAA;QAEjH,IAAI,WAAW,CAAC,QAAQ,CAAC,WAAW,CAAC;YACpC,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAA;QAE/E,IAAI,WAAW,CAAC,QAAQ,CAAC,YAAY,CAAC;YACrC,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAA;QAEhF,IAAI,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;QAElF,IAAI,WAAW,CAAC,QAAQ,CAAC,cAAc,CAAC;YACvC,MAAM,IAAI,KAAK,CAAC,gEAAgE,CAAC,CAAA;IACnF,CAAC;IAED,IAAI,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,EAAE,CAAC;QAC9C,MAAM,IAAI,KAAK,CAAC,6BAA6B,QAAQ,CAAC,EAAE,gBAAgB,CAAC,CAAA;IAC1E,CAAC;IAED,IAAI,CAAC,sBAAsB,CAAC,QAAQ,CAAC,EAAE,CAAC;QACvC,MAAM,MAAM,GAAG,sBAAsB,CAAC,MAAM,CAAA;QAC5C,IAAI,CAAC,MAAM;YAAE,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;QAE9E,MAAM,IAAI,KAAK,CAAC,+BAA+B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;IACzE,CAAC;AACF,CAAC"}

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

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=shared-udp-socket.spec.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"shared-udp-socket.spec.d.ts","sourceRoot":"","sources":["../../../src/module-api/__tests__/shared-udp-socket.spec.ts"],"names":[],"mappings":""}

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

@@ -0,0 +1,270 @@
+import { describe, it, expect, vi } from 'vitest';
+import { nanoid } from 'nanoid';
+import { SharedUdpSocketImpl } from '../shared-udp-socket.js';
+import { createManualPromise } from '../../__mocks__/util.js';
+async function sleepImmediate() {
+    return new Promise((resolve) => setImmediate(resolve));
+}
+describe('Shared UDP', () => {
+    function createContext() {
+        return {
+            sharedUdpSocketHandlers: new Map(),
+            sharedUdpSocketJoin: vi.fn(() => {
+                throw new Error('Not implemented');
+            }),
+            sharedUdpSocketLeave: vi.fn(() => {
+                throw new Error('Not implemented');
+            }),
+            sharedUdpSocketSend: vi.fn(() => {
+                throw new Error('Not implemented');
+            }),
+        };
+    }
+    it('call fail before open', () => {
+        const ctx = createContext();
+        const socket = new SharedUdpSocketImpl(ctx, { type: 'udp4' });
+        expect(() => socket.close()).toThrow(/Socket is not open/);
+        expect(() => socket.send('', 12, '')).toThrow(/Socket is not open/);
+    });
+    describe('bind', () => {
+        it('ok', async () => {
+            const ctx = createContext();
+            const socket = new SharedUdpSocketImpl(ctx, { type: 'udp4' });
+            expect(socket.eventNames()).toHaveLength(0);
+            const sendPromises = [];
+            ctx.sharedUdpSocketJoin.mockImplementationOnce(async () => {
+                const sendPromise = createManualPromise();
+                sendPromises.push(sendPromise);
+                return sendPromise;
+            });
+            const bindCb = vi.fn();
+            socket.bind(5678, '1.2.3.4', bindCb);
+            // Opening a second time should fail
+            expect(() => socket.bind(5678, '1.2.3.4', bindCb)).toThrow(/Socket is already/);
+            await sleepImmediate();
+            expect(bindCb).toHaveBeenCalledTimes(0);
+            // Check now a listener
+            expect(socket.eventNames()).toHaveLength(1);
+            expect(socket.listenerCount('listening')).toBe(1);
+            // Check call was made
+            expect(ctx.sharedUdpSocketJoin).toHaveBeenCalledTimes(1);
+            expect(ctx.sharedUdpSocketLeave).toHaveBeenCalledTimes(0);
+            expect(ctx.sharedUdpSocketSend).toHaveBeenCalledTimes(0);
+            expect(sendPromises).toHaveLength(1);
+            expect(ctx.sharedUdpSocketJoin).toHaveBeenCalledWith({
+                family: 'udp4',
+                portNumber: 5678,
+            });
+            // Mock receive a response
+            const handleId = nanoid();
+            sendPromises[0].manualResolve(handleId);
+            // Verify that opened successfully
+            await sleepImmediate();
+            expect(bindCb).toHaveBeenCalledTimes(1);
+            // Should be tracked now
+            expect(ctx.sharedUdpSocketHandlers.get(handleId)).toBe(socket);
+        });
+        it('error', async () => {
+            const ctx = createContext();
+            const socket = new SharedUdpSocketImpl(ctx, { type: 'udp4' });
+            expect(socket.eventNames()).toHaveLength(0);
+            const sendPromises = [];
+            ctx.sharedUdpSocketJoin.mockImplementationOnce(async () => {
+                const sendPromise = createManualPromise();
+                sendPromises.push(sendPromise);
+                return sendPromise;
+            });
+            const bindCb = vi.fn();
+            socket.bind(5678, '1.2.3.4', bindCb);
+            await sleepImmediate();
+            expect(bindCb).toHaveBeenCalledTimes(0);
+            // setup an error listener
+            const errorCb = vi.fn();
+            socket.on('error', errorCb);
+            // Check call was made
+            expect(ctx.sharedUdpSocketJoin).toHaveBeenCalledTimes(1);
+            expect(ctx.sharedUdpSocketLeave).toHaveBeenCalledTimes(0);
+            expect(ctx.sharedUdpSocketSend).toHaveBeenCalledTimes(0);
+            expect(sendPromises).toHaveLength(1);
+            // Mock receive a response
+            const err = new Error('Some backend failure');
+            sendPromises[0].manualReject(err);
+            // Verify that opening failed
+            await sleepImmediate();
+            expect(bindCb).toHaveBeenCalledTimes(0);
+            expect(ctx.sharedUdpSocketHandlers.size).toBe(0);
+            // Error should have propogated
+            expect(errorCb).toHaveBeenCalledTimes(1);
+            expect(errorCb).toHaveBeenCalledWith(err);
+        });
+    });
+    async function createAndOpenSocket(ctx) {
+        const socket = new SharedUdpSocketImpl(ctx, { type: 'udp4' });
+        expect(socket.eventNames()).toHaveLength(0);
+        const sendPromises = [];
+        ctx.sharedUdpSocketJoin.mockImplementationOnce(async () => {
+            const sendPromise = createManualPromise();
+            sendPromises.push(sendPromise);
+            return sendPromise;
+        });
+        const bindCb = vi.fn();
+        socket.bind(5678, '1.2.3.4', bindCb);
+        // Mock receive a response
+        expect(ctx.sharedUdpSocketJoin).toHaveBeenCalledTimes(1);
+        expect(ctx.sharedUdpSocketLeave).toHaveBeenCalledTimes(0);
+        expect(ctx.sharedUdpSocketSend).toHaveBeenCalledTimes(0);
+        expect(sendPromises).toHaveLength(1);
+        const handleId = nanoid();
+        sendPromises[0].manualResolve(handleId);
+        // Verify that opened successfully
+        await sleepImmediate();
+        expect(bindCb).toHaveBeenCalledTimes(1);
+        // Should be tracked now
+        expect(ctx.sharedUdpSocketHandlers.get(handleId)).toBe(socket);
+        ctx.sharedUdpSocketJoin.mockClear();
+        return { socket, handleId };
+    }
+    describe('send', () => {
+        it('ok', async () => {
+            const ctx = createContext();
+            const { socket, handleId } = await createAndOpenSocket(ctx);
+            const sendPromises = [];
+            ctx.sharedUdpSocketSend.mockImplementationOnce(async () => {
+                const sendPromise = createManualPromise();
+                sendPromises.push(sendPromise);
+                return sendPromise;
+            });
+            // Do send
+            const sendCb = vi.fn();
+            const message = Buffer.from('my fake message');
+            socket.send(message, 4789, '4.5.6.7', sendCb);
+            // Check callbacks
+            await sleepImmediate();
+            expect(sendCb).toHaveBeenCalledTimes(0);
+            // Check call was made
+            expect(ctx.sharedUdpSocketSend).toHaveBeenCalledTimes(1);
+            expect(ctx.sharedUdpSocketLeave).toHaveBeenCalledTimes(0);
+            expect(ctx.sharedUdpSocketJoin).toHaveBeenCalledTimes(0);
+            expect(sendPromises).toHaveLength(1);
+            expect(ctx.sharedUdpSocketSend).toHaveBeenCalledWith({
+                handleId,
+                message,
+                address: '4.5.6.7',
+                port: 4789,
+            });
+            // Mock receive a response
+            sendPromises[0].manualResolve(null);
+            // Verify the calback
+            await sleepImmediate();
+            expect(sendCb).toHaveBeenCalledTimes(1);
+            expect(ctx.sharedUdpSocketHandlers.has(handleId)).toBeTruthy();
+        });
+        it('error', async () => {
+            const ctx = createContext();
+            const { socket, handleId } = await createAndOpenSocket(ctx);
+            const sendPromises = [];
+            ctx.sharedUdpSocketSend.mockImplementationOnce(async () => {
+                const sendPromise = createManualPromise();
+                sendPromises.push(sendPromise);
+                return sendPromise;
+            });
+            // Do send
+            const sendCb = vi.fn();
+            const message = Buffer.from('my fake message');
+            socket.send(message, 4789, '4.5.6.7', sendCb);
+            const errorCb = vi.fn();
+            socket.on('error', errorCb);
+            // Check callbacks
+            await sleepImmediate();
+            expect(sendCb).toHaveBeenCalledTimes(0);
+            // Check call was made
+            expect(ctx.sharedUdpSocketSend).toHaveBeenCalledTimes(1);
+            expect(ctx.sharedUdpSocketLeave).toHaveBeenCalledTimes(0);
+            expect(ctx.sharedUdpSocketJoin).toHaveBeenCalledTimes(0);
+            expect(sendPromises).toHaveLength(1);
+            expect(ctx.sharedUdpSocketSend).toHaveBeenCalledWith({
+                handleId,
+                message,
+                address: '4.5.6.7',
+                port: 4789,
+            });
+            // Mock receive a response
+            const err = new Error('Some backend failure');
+            sendPromises[0].manualReject(err);
+            // Verify the calback
+            await sleepImmediate();
+            expect(sendCb).toHaveBeenCalledTimes(0);
+            expect(errorCb).toHaveBeenCalledTimes(1);
+            expect(errorCb).toHaveBeenCalledWith(err);
+            expect(ctx.sharedUdpSocketHandlers.has(handleId)).toBeTruthy();
+        });
+    });
+    describe('close', () => {
+        it('ok', async () => {
+            const ctx = createContext();
+            const { socket, handleId } = await createAndOpenSocket(ctx);
+            const sendPromises = [];
+            ctx.sharedUdpSocketLeave.mockImplementationOnce(async () => {
+                const sendPromise = createManualPromise();
+                sendPromises.push(sendPromise);
+                return sendPromise;
+            });
+            // Do send
+            const closeCb = vi.fn();
+            socket.close(closeCb);
+            // Check callbacks
+            await sleepImmediate();
+            expect(closeCb).toHaveBeenCalledTimes(0);
+            // Check call was made
+            expect(ctx.sharedUdpSocketLeave).toHaveBeenCalledTimes(1);
+            expect(ctx.sharedUdpSocketSend).toHaveBeenCalledTimes(0);
+            expect(ctx.sharedUdpSocketJoin).toHaveBeenCalledTimes(0);
+            expect(sendPromises).toHaveLength(1);
+            expect(ctx.sharedUdpSocketLeave).toHaveBeenCalledWith({
+                handleId,
+            });
+            // Mock receive a response
+            sendPromises[0].manualResolve(null);
+            // Verify the calback
+            await sleepImmediate();
+            expect(closeCb).toHaveBeenCalledTimes(1);
+            expect(ctx.sharedUdpSocketHandlers.has(handleId)).toBeFalsy();
+        });
+        it('error', async () => {
+            const ctx = createContext();
+            const { socket, handleId } = await createAndOpenSocket(ctx);
+            const sendPromises = [];
+            ctx.sharedUdpSocketLeave.mockImplementationOnce(async () => {
+                const sendPromise = createManualPromise();
+                sendPromises.push(sendPromise);
+                return sendPromise;
+            });
+            // Do send
+            const closeCb = vi.fn();
+            socket.close(closeCb);
+            const errorCb = vi.fn();
+            socket.on('error', errorCb);
+            // Check callbacks
+            await sleepImmediate();
+            expect(closeCb).toHaveBeenCalledTimes(0);
+            // Check call was made
+            expect(ctx.sharedUdpSocketLeave).toHaveBeenCalledTimes(1);
+            expect(ctx.sharedUdpSocketSend).toHaveBeenCalledTimes(0);
+            expect(ctx.sharedUdpSocketJoin).toHaveBeenCalledTimes(0);
+            expect(sendPromises).toHaveLength(1);
+            expect(ctx.sharedUdpSocketLeave).toHaveBeenCalledWith({
+                handleId,
+            });
+            // Mock receive a response
+            const err = new Error('Some backend failure');
+            sendPromises[0].manualReject(err);
+            // Verify the calback
+            await sleepImmediate();
+            expect(closeCb).toHaveBeenCalledTimes(0);
+            expect(errorCb).toHaveBeenCalledTimes(1);
+            expect(errorCb).toHaveBeenCalledWith(err);
+            expect(ctx.sharedUdpSocketHandlers.has(handleId)).toBeFalsy();
+        });
+    });
+});
+//# sourceMappingURL=shared-udp-socket.spec.js.map

package/dist/module-api/__tests__/shared-udp-socket.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared-udp-socket.spec.js","sourceRoot":"","sources":["../../../src/module-api/__tests__/shared-udp-socket.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAA;AACjD,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAC/B,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAC7D,OAAO,EAAiB,mBAAmB,EAAE,MAAM,yBAAyB,CAAA;AAQ5E,KAAK,UAAU,cAAc;IAC5B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,YAAY,CAAC,OAAO,CAAC,CAAC,CAAA;AACvD,CAAC;AAED,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC3B,SAAS,aAAa;QACrB,OAAO;YACN,uBAAuB,EAAE,IAAI,GAAG,EAA+B;YAC/D,mBAAmB,EAAE,EAAE,CAAC,EAAE,CAAwD,GAAG,EAAE;gBACtF,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;YACnC,CAAC,CAAC;YACF,oBAAoB,EAAE,EAAE,CAAC,EAAE,CAAyD,GAAG,EAAE;gBACxF,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;YACnC,CAAC,CAAC;YACF,mBAAmB,EAAE,EAAE,CAAC,EAAE,CAAwD,GAAG,EAAE;gBACtF,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;YACnC,CAAC,CAAC;SACF,CAAA;IACF,CAAC;IAED,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAChC,MAAM,GAAG,GAAG,aAAa,EAAE,CAAA;QAC3B,MAAM,MAAM,GAAG,IAAI,mBAAmB,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;QAE7D,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAA;QAC1D,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC,CAAA;IACpE,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;QACrB,EAAE,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE;YACnB,MAAM,GAAG,GAAG,aAAa,EAAE,CAAA;YAC3B,MAAM,MAAM,GAAG,IAAI,mBAAmB,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;YAC7D,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;YAE3C,MAAM,YAAY,GAAyB,EAAE,CAAA;YAC7C,GAAG,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,KAAK,IAAI,EAAE;gBACzD,MAAM,WAAW,GAAG,mBAAmB,EAAO,CAAA;gBAC9C,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAC9B,OAAO,WAAW,CAAA;YACnB,CAAC,CAAC,CAAA;YAEF,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;YACtB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAA;YAEpC,oCAAoC;YACpC,MAAM,CAAC,GAAG,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAA;YAE/E,MAAM,cAAc,EAAE,CAAA;YACtB,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAEvC,uBAAuB;YACvB,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;YAC3C,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YAEjD,sBAAsB;YACtB,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxD,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACzD,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxD,MAAM,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;YACpC,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,oBAAoB,CAAC;gBACpD,MAAM,EAAE,MAAM;gBACd,UAAU,EAAE,IAAI;aACqB,CAAC,CAAA;YAEvC,0BAA0B;YAC1B,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAA;YACzB,YAAY,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;YAEvC,kCAAkC;YAClC,MAAM,cAAc,EAAE,CAAA;YACtB,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAEvC,wBAAwB;YACxB,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC/D,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YACtB,MAAM,GAAG,GAAG,aAAa,EAAE,CAAA;YAC3B,MAAM,MAAM,GAAG,IAAI,mBAAmB,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;YAC7D,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;YAE3C,MAAM,YAAY,GAAyB,EAAE,CAAA;YAC7C,GAAG,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,KAAK,IAAI,EAAE;gBACzD,MAAM,WAAW,GAAG,mBAAmB,EAAO,CAAA;gBAC9C,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAC9B,OAAO,WAAW,CAAA;YACnB,CAAC,CAAC,CAAA;YAEF,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;YACtB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAA;YAEpC,MAAM,cAAc,EAAE,CAAA;YACtB,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAEvC,0BAA0B;YAC1B,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;YACvB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAE3B,sBAAsB;YACtB,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxD,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACzD,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxD,MAAM,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;YAEpC,0BAA0B;YAC1B,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;YAC7C,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;YAEjC,6BAA6B;YAC7B,MAAM,cAAc,EAAE,CAAA;YACtB,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACvC,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;YAEhD,+BAA+B;YAC/B,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxC,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,KAAK,UAAU,mBAAmB,CAAC,GAAqC;QACvE,MAAM,MAAM,GAAG,IAAI,mBAAmB,CAAC,GAAG,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAA;QAC7D,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QAE3C,MAAM,YAAY,GAAyB,EAAE,CAAA;QAC7C,GAAG,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,KAAK,IAAI,EAAE;YACzD,MAAM,WAAW,GAAG,mBAAmB,EAAO,CAAA;YAC9C,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;YAC9B,OAAO,WAAW,CAAA;QACnB,CAAC,CAAC,CAAA;QAEF,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;QACtB,MAAM,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAA;QAEpC,0BAA0B;QAC1B,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;QACxD,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;QACzD,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;QACxD,MAAM,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;QACpC,MAAM,QAAQ,GAAG,MAAM,EAAE,CAAA;QACzB,YAAY,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAA;QAEvC,kCAAkC;QAClC,MAAM,cAAc,EAAE,CAAA;QACtB,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;QAEvC,wBAAwB;QACxB,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC9D,GAAG,CAAC,mBAAmB,CAAC,SAAS,EAAE,CAAA;QAEnC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAA;IAC5B,CAAC;IAED,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;QACrB,EAAE,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE;YACnB,MAAM,GAAG,GAAG,aAAa,EAAE,CAAA;YAE3B,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,mBAAmB,CAAC,GAAG,CAAC,CAAA;YAE3D,MAAM,YAAY,GAAyB,EAAE,CAAA;YAC7C,GAAG,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,KAAK,IAAI,EAAE;gBACzD,MAAM,WAAW,GAAG,mBAAmB,EAAO,CAAA;gBAC9C,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAC9B,OAAO,WAAW,CAAA;YACnB,CAAC,CAAC,CAAA;YAEF,UAAU;YACV,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;YACtB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;YAC9C,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAA;YAE7C,kBAAkB;YAClB,MAAM,cAAc,EAAE,CAAA;YACtB,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAEvC,sBAAsB;YACtB,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxD,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACzD,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxD,MAAM,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;YACpC,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,oBAAoB,CAAC;gBACpD,QAAQ;gBACR,OAAO;gBACP,OAAO,EAAE,SAAS;gBAClB,IAAI,EAAE,IAAI;aAC2B,CAAC,CAAA;YAEvC,0BAA0B;YAC1B,YAAY,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;YAEnC,qBAAqB;YACrB,MAAM,cAAc,EAAE,CAAA;YACtB,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAEvC,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,EAAE,CAAA;QAC/D,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YACtB,MAAM,GAAG,GAAG,aAAa,EAAE,CAAA;YAE3B,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,mBAAmB,CAAC,GAAG,CAAC,CAAA;YAE3D,MAAM,YAAY,GAAyB,EAAE,CAAA;YAC7C,GAAG,CAAC,mBAAmB,CAAC,sBAAsB,CAAC,KAAK,IAAI,EAAE;gBACzD,MAAM,WAAW,GAAG,mBAAmB,EAAO,CAAA;gBAC9C,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAC9B,OAAO,WAAW,CAAA;YACnB,CAAC,CAAC,CAAA;YAEF,UAAU;YACV,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;YACtB,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;YAC9C,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,CAAC,CAAA;YAE7C,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;YACvB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAE3B,kBAAkB;YAClB,MAAM,cAAc,EAAE,CAAA;YACtB,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAEvC,sBAAsB;YACtB,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxD,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACzD,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxD,MAAM,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;YACpC,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,oBAAoB,CAAC;gBACpD,QAAQ;gBACR,OAAO;gBACP,OAAO,EAAE,SAAS;gBAClB,IAAI,EAAE,IAAI;aAC2B,CAAC,CAAA;YAEvC,0BAA0B;YAC1B,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;YAC7C,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;YAEjC,qBAAqB;YACrB,MAAM,cAAc,EAAE,CAAA;YACtB,MAAM,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACvC,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxC,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAA;YAEzC,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,UAAU,EAAE,CAAA;QAC/D,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,OAAO,EAAE,GAAG,EAAE;QACtB,EAAE,CAAC,IAAI,EAAE,KAAK,IAAI,EAAE;YACnB,MAAM,GAAG,GAAG,aAAa,EAAE,CAAA;YAE3B,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,mBAAmB,CAAC,GAAG,CAAC,CAAA;YAE3D,MAAM,YAAY,GAAyB,EAAE,CAAA;YAC7C,GAAG,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,KAAK,IAAI,EAAE;gBAC1D,MAAM,WAAW,GAAG,mBAAmB,EAAO,CAAA;gBAC9C,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAC9B,OAAO,WAAW,CAAA;YACnB,CAAC,CAAC,CAAA;YAEF,UAAU;YACV,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;YACvB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YAErB,kBAAkB;YAClB,MAAM,cAAc,EAAE,CAAA;YACtB,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAExC,sBAAsB;YACtB,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACzD,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxD,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxD,MAAM,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;YACpC,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,oBAAoB,CAAC;gBACrD,QAAQ;aAC8B,CAAC,CAAA;YAExC,0BAA0B;YAC1B,YAAY,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;YAEnC,qBAAqB;YACrB,MAAM,cAAc,EAAE,CAAA;YACtB,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAExC,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,EAAE,CAAA;QAC9D,CAAC,CAAC,CAAA;QAEF,EAAE,CAAC,OAAO,EAAE,KAAK,IAAI,EAAE;YACtB,MAAM,GAAG,GAAG,aAAa,EAAE,CAAA;YAE3B,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,GAAG,MAAM,mBAAmB,CAAC,GAAG,CAAC,CAAA;YAE3D,MAAM,YAAY,GAAyB,EAAE,CAAA;YAC7C,GAAG,CAAC,oBAAoB,CAAC,sBAAsB,CAAC,KAAK,IAAI,EAAE;gBAC1D,MAAM,WAAW,GAAG,mBAAmB,EAAO,CAAA;gBAC9C,YAAY,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAC9B,OAAO,WAAW,CAAA;YACnB,CAAC,CAAC,CAAA;YAEF,UAAU;YACV,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;YACvB,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;YAErB,MAAM,OAAO,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;YACvB,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,OAAO,CAAC,CAAA;YAE3B,kBAAkB;YAClB,MAAM,cAAc,EAAE,CAAA;YACtB,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAExC,sBAAsB;YACtB,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACzD,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxD,MAAM,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxD,MAAM,CAAC,YAAY,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAA;YACpC,MAAM,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC,oBAAoB,CAAC;gBACrD,QAAQ;aAC8B,CAAC,CAAA;YAExC,0BAA0B;YAC1B,MAAM,GAAG,GAAG,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;YAC7C,YAAY,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,GAAG,CAAC,CAAA;YAEjC,qBAAqB;YACrB,MAAM,cAAc,EAAE,CAAA;YACtB,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxC,MAAM,CAAC,OAAO,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YACxC,MAAM,CAAC,OAAO,CAAC,CAAC,oBAAoB,CAAC,GAAG,CAAC,CAAA;YAEzC,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS,EAAE,CAAA;QAC9D,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;AACH,CAAC,CAAC,CAAA"}

package/dist/module-api/action.js

@@ -1,3 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};
 //# sourceMappingURL=action.js.map

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

@@ -1,7 +1,8 @@
 import type { CompanionActionDefinitions, CompanionRecordedAction } from './action.js';
 import type { CompanionFeedbackDefinitions } from './feedback.js';
 import type { CompanionPresetDefinitions } from './preset.js';
-import type { InstanceStatus, LogLevel } from './enums.js';
+import type { InstanceStatus } from './enums.js';
+import { type LogLevel } from '../logging.js';
 import type { InstanceBaseShared } from '../instance-base.js';
 import type { CompanionVariableDefinition, CompanionVariableValue, CompanionVariableValues } from './variable.js';
 import type { OSCSomeArguments } from '../common/osc.js';
@@ -26,7 +27,7 @@ export interface InstanceBaseOptions {
 }
 export declare abstract class InstanceBase<TConfig, TSecrets = undefined> implements InstanceBaseShared<TConfig, TSecrets> {
     #private;
-    readonly id: string;
+    get id(): string;
     get instanceOptions(): InstanceBaseOptions;
     /**
      * The user chosen name for this instance.
@@ -37,20 +38,6 @@ export declare abstract class InstanceBase<TConfig, TSecrets = undefined> implem
      * Create an instance of the module
      */
     constructor(internal: unknown);
-    private _handleInit;
-    private _handleDestroy;
-    private _handleConfigUpdateAndLabel;
-    private _handleExecuteAction;
-    private _handleUpdateFeedbacks;
-    private _handleUpdateActions;
-    private _handleUpgradeActionsAndFeedbacks;
-    private _handleGetConfigFields;
-    private _handleHttpRequest;
-    private _handleLearnAction;
-    private _handleLearnFeedback;
-    private _handleStartStopRecordActions;
-    private _handleSharedUdpSocketMessage;
-    private _handleSharedUdpSocketError;
     /**
      * Main initialization function called
      * once the module is OK to start doing things.
@@ -123,8 +110,6 @@ export declare abstract class InstanceBase<TConfig, TSecrets = undefined> implem
      *
      * Parse and replace all the variables in a string
      * Note: You must not use this for feedbacks, as your feedback will not update when the variable changes.
-     * There is an alternate version of this supplied to each of the action/feedback callbacks that tracks
-     * usages properly and will retrigger the feedback when the variables change.
      * @param text The text to parse
      * @returns The string with variables replaced with their values
      */

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

@@ -1 +1 @@
-{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/module-api/base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AACtF,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,eAAe,CAAA;AACjE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AAkC1D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAE7D,OAAO,KAAK,EAAE,2BAA2B,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAA;AACjH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACxD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAK3D,OAAO,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AAG5E,OAAO,EACN,eAAe,EAEf,8BAA8B,EAC9B,sBAAsB,EACtB,MAAM,wBAAwB,CAAA;AAE/B,MAAM,WAAW,mBAAmB;IACnC;;;OAGG;IACH,yBAAyB,EAAE,OAAO,CAAA;IAElC;;;;;;;OAOG;IACH,sBAAsB,EAAE,OAAO,CAAA;CAC/B;AAED,8BAAsB,YAAY,CAAC,OAAO,EAAE,QAAQ,GAAG,SAAS,CAAE,YAAW,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC;;IAGjH,SAAgB,EAAE,EAAE,MAAM,CAAA;IAoB1B,IAAW,eAAe,IAAI,mBAAmB,CAEhD;IAED;;;OAGG;IACH,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED;;OAEG;gBACS,QAAQ,EAAE,OAAO;YAyEf,WAAW;YAkEX,cAAc;YASd,2BAA2B;YAY3B,oBAAoB;YAIpB,sBAAsB;YAGtB,oBAAoB;YAGpB,iCAAiC;YAcjC,sBAAsB;YAMtB,kBAAkB;YAOlB,kBAAkB;YAGlB,oBAAoB;YAGpB,6BAA6B;YAuB7B,6BAA6B;YAO7B,2BAA2B;IAQzC;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAEtF;;OAEG;IACH,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAEjC;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAEzE;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,SAAS,EAAE,OAAO,GAAG,SAAS,EAAE,UAAU,CAAC,EAAE,SAAS,GAAG,IAAI;IAChH,UAAU,CACT,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,EACrC,SAAS,EAAE,OAAO,GAAG,SAAS,EAC9B,UAAU,EAAE,QAAQ,GAAG,SAAS,GAC9B,IAAI;IAOP;;OAEG;IACH,QAAQ,CAAC,eAAe,IAAI,wBAAwB,EAAE;IAEtD;;;OAGG;IACH,iBAAiB,CAAC,CAAC,OAAO,EAAE,oBAAoB,GAAG,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAEzG;;;OAGG;IACH,4BAA4B,CAAC,CAAC,WAAW,EAAE,OAAO,GAAG,IAAI;IAEzD;;;OAGG;IACH,oBAAoB,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI;IAI/D;;;OAGG;IACH,sBAAsB,CAAC,SAAS,EAAE,4BAA4B,GAAG,IAAI;IAIrE;;;OAGG;IACH,oBAAoB,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI;IAe/D;;;OAGG;IACH,sBAAsB,CAAC,SAAS,EAAE,2BAA2B,EAAE,GAAG,IAAI;IAyCtE;;;OAGG;IACH,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,IAAI;IAoCxD;;;;OAIG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS;IAIxE;;;;;;;;;OASG;IACG,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAqB3D;;;OAGG;IACH,cAAc,CAAC,GAAG,aAAa,EAAE,MAAM,EAAE,GAAG,IAAI;IAIhD;;;OAGG;IACH,kBAAkB,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI;IAIlD;;;;OAIG;IACH,gBAAgB,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI;IAG9C;;;;OAIG;IACH,kBAAkB,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI;IAIhD;;;;OAIG;IACH,kBAAkB,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI;IAGlD;;;;OAIG;IACH,oBAAoB,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI;IAIpD;;;;OAIG;IACH,YAAY,CAAC,MAAM,EAAE,uBAAuB,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI;IAW1E;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAY/E;;;;;;;;;OASG;IACH,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAUnE;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAU3C;;;;;;;OAOG;IACH,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,8BAA8B,GAAG,eAAe;IACxG,qBAAqB,CAAC,OAAO,EAAE,sBAAsB,EAAE,QAAQ,CAAC,EAAE,8BAA8B,GAAG,eAAe;CAYlH"}
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/module-api/base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AACtF,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,eAAe,CAAA;AACjE,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,aAAa,CAAA;AAC7D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,YAAY,CAAA;AAChD,OAAO,EAAsB,KAAK,QAAQ,EAAqB,MAAM,eAAe,CAAA;AAEpF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAC7D,OAAO,KAAK,EAAE,2BAA2B,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAA;AACjH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACxD,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAC3D,OAAO,KAAK,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AAC5E,OAAO,EACN,eAAe,EAEf,8BAA8B,EAC9B,sBAAsB,EACtB,MAAM,wBAAwB,CAAA;AAG/B,MAAM,WAAW,mBAAmB;IACnC;;;OAGG;IACH,yBAAyB,EAAE,OAAO,CAAA;IAElC;;;;;;;OAOG;IACH,sBAAsB,EAAE,OAAO,CAAA;CAC/B;AAED,8BAAsB,YAAY,CAAC,OAAO,EAAE,QAAQ,GAAG,SAAS,CAAE,YAAW,kBAAkB,CAAC,OAAO,EAAE,QAAQ,CAAC;;IAMjH,IAAW,EAAE,IAAI,MAAM,CAEtB;IAED,IAAW,eAAe,IAAI,mBAAmB,CAEhD;IAED;;;OAGG;IACH,IAAW,KAAK,IAAI,MAAM,CAEzB;IAED;;OAEG;gBACS,QAAQ,EAAE,OAAO;IAoB7B;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAEtF;;OAEG;IACH,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAEjC;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,IAAI,CAAC;IAEzE;;;;;OAKG;IACH,UAAU,CAAC,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,SAAS,EAAE,OAAO,GAAG,SAAS,EAAE,UAAU,CAAC,EAAE,SAAS,GAAG,IAAI;IAChH,UAAU,CACT,IAAI,EAAE,YAAY,CAAC,OAAO,EAAE,QAAQ,CAAC,EACrC,SAAS,EAAE,OAAO,GAAG,SAAS,EAC9B,UAAU,EAAE,QAAQ,GAAG,SAAS,GAC9B,IAAI;IAKP;;OAEG;IACH,QAAQ,CAAC,eAAe,IAAI,wBAAwB,EAAE;IAEtD;;;OAGG;IACH,iBAAiB,CAAC,CAAC,OAAO,EAAE,oBAAoB,GAAG,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAEzG;;;OAGG;IACH,4BAA4B,CAAC,CAAC,WAAW,EAAE,OAAO,GAAG,IAAI;IAEzD;;;OAGG;IACH,oBAAoB,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI;IAI/D;;;OAGG;IACH,sBAAsB,CAAC,SAAS,EAAE,4BAA4B,GAAG,IAAI;IAIrE;;;OAGG;IACH,oBAAoB,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI;IAI/D;;;OAGG;IACH,sBAAsB,CAAC,SAAS,EAAE,2BAA2B,EAAE,GAAG,IAAI;IAItE;;;OAGG;IACH,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,IAAI;IAIxD;;;;OAIG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS;IAIxE;;;;;;;OAOG;IACG,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAI3D;;;OAGG;IACH,cAAc,CAAC,GAAG,aAAa,EAAE,MAAM,EAAE,GAAG,IAAI;IAIhD;;;OAGG;IACH,kBAAkB,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI;IAIlD;;;;OAIG;IACH,gBAAgB,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI;IAG9C;;;;OAIG;IACH,kBAAkB,CAAC,GAAG,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI;IAIhD;;;;OAIG;IACH,kBAAkB,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI;IAGlD;;;;OAIG;IACH,oBAAoB,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI;IAIpD;;;;OAIG;IACH,YAAY,CAAC,MAAM,EAAE,uBAAuB,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI;IAI1E;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,IAAI;IAI/E;;;;;;;;;OASG;IACH,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI;IAInE;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;IAqB3C;;;;;;;OAOG;IACH,qBAAqB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,CAAC,EAAE,8BAA8B,GAAG,eAAe;IACxG,qBAAqB,CAAC,OAAO,EAAE,sBAAsB,EAAE,QAAQ,CAAC,EAAE,8BAA8B,GAAG,eAAe;CAYlH"}