@companion-module/host 0.1.0-0

package/README.md

@@ -0,0 +1,19 @@
+# @companion-module/host
+
+Host-side wrapper library for Companion Module(Connection) plugins.
+
+This package provides the host-side API that wraps the modules written with the `@companion-module/base` API with additional logic that runs in-process. It is designed to support multiple versions of the base API and provide a uniform interface back to the host application.
+
+## Installation
+
+```bash
+npm install @companion-module/host
+```
+
+## Usage
+
+For example usage, check [Companion](https://github.com/bitfocus/companion/) for an example implementation
+
+## Development
+
+This package is part of a monorepo. See the root README for development instructions.

package/dist/__tests__/ipc-wrapper.spec.d.ts

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

package/dist/__tests__/ipc-wrapper.spec.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipc-wrapper.spec.d.ts","sourceRoot":"","sources":["../../src/__tests__/ipc-wrapper.spec.ts"],"names":[],"mappings":""}

package/dist/__tests__/ipc-wrapper.spec.js

@@ -0,0 +1,272 @@
+import { describe, test, expect, beforeEach, vi, beforeAll } from 'vitest';
+import { IpcWrapper } from '../ipc-wrapper.js';
+function stringifyError(err) {
+    return JSON.stringify(err, Object.getOwnPropertyNames(err));
+}
+describe('IpcWrapper', () => {
+    const sendMessageFn = vi.fn();
+    const testRecv1Fn = vi.fn();
+    const testRecv2Fn = vi.fn();
+    let ipc;
+    beforeAll(() => {
+        vi.useFakeTimers();
+    });
+    beforeEach(() => {
+        sendMessageFn.mockClear();
+        testRecv1Fn.mockClear();
+        testRecv2Fn.mockClear();
+        ipc = new IpcWrapper({
+            recvTest1: testRecv1Fn,
+            recvTest2: testRecv2Fn,
+        }, sendMessageFn, 100);
+    });
+    test('send without callback', () => {
+        ipc.sendWithNoCb('sendTest2', 1);
+        expect(sendMessageFn).toHaveBeenCalledTimes(1);
+        expect(sendMessageFn).toHaveBeenCalledWith({
+            direction: 'call',
+            name: 'sendTest2',
+            payload: '1',
+            callbackId: undefined,
+        });
+    });
+    describe('send with callback', () => {
+        test('timeout', async () => {
+            const result = ipc.sendWithCb('sendTest1', 23);
+            result.catch(() => null); // suppress unhandled promise rejection warning
+            expect(result).toBeTruthy(); // should be a promise
+            expect(sendMessageFn).toHaveBeenCalledTimes(1);
+            expect(sendMessageFn).toHaveBeenCalledWith({
+                direction: 'call',
+                name: 'sendTest1',
+                payload: '23',
+                callbackId: 1,
+            });
+            vi.advanceTimersByTime(101);
+            await expect(result).rejects.toThrow('Call timed out');
+        });
+        test('returns success', async () => {
+            const result = ipc.sendWithCb('sendTest1', 23);
+            result.catch(() => null); // suppress unhandled promise rejection warning
+            expect(result).toBeTruthy(); // should be a promise
+            expect(sendMessageFn).toHaveBeenCalledTimes(1);
+            expect(sendMessageFn).toHaveBeenCalledWith({
+                direction: 'call',
+                name: 'sendTest1',
+                payload: '23',
+                callbackId: 1,
+            });
+            ipc.receivedMessage({
+                direction: 'response',
+                callbackId: 1,
+                success: true,
+                payload: '42',
+            });
+            await expect(result).resolves.toEqual(42);
+        });
+        test('returns object', async () => {
+            const result = ipc.sendWithCb('sendTest1', 23);
+            result.catch(() => null); // suppress unhandled promise rejection warning
+            expect(result).toBeTruthy(); // should be a promise
+            expect(sendMessageFn).toHaveBeenCalledTimes(1);
+            expect(sendMessageFn).toHaveBeenCalledWith({
+                direction: 'call',
+                name: 'sendTest1',
+                payload: '23',
+                callbackId: 1,
+            });
+            ipc.receivedMessage({
+                direction: 'response',
+                callbackId: 1,
+                success: true,
+                payload: JSON.stringify({ value: 42 }),
+            });
+            await expect(result).resolves.toEqual({ value: 42 });
+        });
+        test('throw error', async () => {
+            const result = ipc.sendWithCb('sendTest1', 23);
+            result.catch(() => null); // suppress unhandled promise rejection warning
+            expect(result).toBeTruthy(); // should be a promise
+            expect(sendMessageFn).toHaveBeenCalledTimes(1);
+            expect(sendMessageFn).toHaveBeenCalledWith({
+                direction: 'call',
+                name: 'sendTest1',
+                payload: '23',
+                callbackId: 1,
+            });
+            ipc.receivedMessage({
+                direction: 'response',
+                callbackId: 1,
+                success: false,
+                payload: stringifyError(new Error('my error')),
+            });
+            await expect(result).rejects.toThrow(`my error`);
+        });
+        test('throw error as string', async () => {
+            const result = ipc.sendWithCb('sendTest1', 23);
+            result.catch(() => null); // suppress unhandled promise rejection warning
+            expect(result).toBeTruthy(); // should be a promise
+            expect(sendMessageFn).toHaveBeenCalledTimes(1);
+            expect(sendMessageFn).toHaveBeenCalledWith({
+                direction: 'call',
+                name: 'sendTest1',
+                payload: '23',
+                callbackId: 1,
+            });
+            ipc.receivedMessage({
+                direction: 'response',
+                callbackId: 1,
+                success: false,
+                payload: '"error as string"',
+            });
+            await expect(result).rejects.toEqual('error as string');
+        });
+        test('throw null', async () => {
+            const result = ipc.sendWithCb('sendTest1', 23);
+            result.catch(() => null); // suppress unhandled promise rejection warning
+            expect(result).toBeTruthy(); // should be a promise
+            expect(sendMessageFn).toHaveBeenCalledTimes(1);
+            expect(sendMessageFn).toHaveBeenCalledWith({
+                direction: 'call',
+                name: 'sendTest1',
+                payload: '23',
+                callbackId: 1,
+            });
+            ipc.receivedMessage({
+                direction: 'response',
+                callbackId: 1,
+                success: false,
+                payload: JSON.stringify(null),
+            });
+            await expect(result).rejects.toEqual(null);
+        });
+    });
+    test('receive without callback', () => {
+        testRecv1Fn.mockImplementation(async () => {
+            return 67;
+        });
+        ipc.receivedMessage({
+            direction: 'call',
+            name: 'recvTest1',
+            payload: '42',
+            callbackId: undefined,
+        });
+        expect(testRecv1Fn).toHaveBeenCalledTimes(1);
+        expect(testRecv1Fn).toHaveBeenCalledWith(42);
+        vi.advanceTimersByTime(101);
+        expect(sendMessageFn).toHaveBeenCalledTimes(0);
+    });
+    describe('receive with callback', () => {
+        test('returns success', async () => {
+            testRecv2Fn.mockImplementation(async () => {
+                return 67;
+            });
+            ipc.receivedMessage({
+                direction: 'call',
+                name: 'recvTest2',
+                payload: '42',
+                callbackId: 456,
+            });
+            expect(testRecv2Fn).toHaveBeenCalledTimes(1);
+            expect(testRecv2Fn).toHaveBeenCalledWith(42);
+            await vi.advanceTimersByTimeAsync(201);
+            expect(sendMessageFn).toHaveBeenCalledTimes(1);
+            expect(sendMessageFn).toHaveBeenCalledWith({
+                direction: 'response',
+                success: true,
+                payload: '67',
+                callbackId: 456,
+            });
+        });
+        test('returns object', async () => {
+            testRecv2Fn.mockImplementation(async () => {
+                return { value: 88 };
+            });
+            ipc.receivedMessage({
+                direction: 'call',
+                name: 'recvTest2',
+                payload: '42',
+                callbackId: 456,
+            });
+            expect(testRecv2Fn).toHaveBeenCalledTimes(1);
+            expect(testRecv2Fn).toHaveBeenCalledWith(42);
+            await vi.advanceTimersByTimeAsync(201);
+            expect(sendMessageFn).toHaveBeenCalledTimes(1);
+            expect(sendMessageFn).toHaveBeenCalledWith({
+                direction: 'response',
+                success: true,
+                payload: JSON.stringify({ value: 88 }),
+                callbackId: 456,
+            });
+        });
+        test('throw error', async () => {
+            let error;
+            testRecv2Fn.mockImplementation(async () => {
+                error = new Error('my error');
+                throw error;
+            });
+            ipc.receivedMessage({
+                direction: 'call',
+                name: 'recvTest2',
+                payload: '42',
+                callbackId: 456,
+            });
+            expect(testRecv2Fn).toHaveBeenCalledTimes(1);
+            expect(testRecv2Fn).toHaveBeenCalledWith(42);
+            expect(error).toBeTruthy();
+            await vi.advanceTimersByTimeAsync(201);
+            expect(sendMessageFn).toHaveBeenCalledTimes(1);
+            expect(sendMessageFn).toHaveBeenCalledWith({
+                direction: 'response',
+                success: false,
+                payload: stringifyError(error),
+                callbackId: 456,
+            });
+        });
+        test('throw error as string', async () => {
+            testRecv2Fn.mockImplementation(async () => {
+                // eslint-disable-next-line @typescript-eslint/only-throw-error
+                throw 'my error message';
+            });
+            ipc.receivedMessage({
+                direction: 'call',
+                name: 'recvTest2',
+                payload: '42',
+                callbackId: 456,
+            });
+            expect(testRecv2Fn).toHaveBeenCalledTimes(1);
+            expect(testRecv2Fn).toHaveBeenCalledWith(42);
+            await vi.advanceTimersByTimeAsync(201);
+            expect(sendMessageFn).toHaveBeenCalledTimes(1);
+            expect(sendMessageFn).toHaveBeenCalledWith({
+                direction: 'response',
+                success: false,
+                payload: '"my error message"',
+                callbackId: 456,
+            });
+        });
+        test('throw null', async () => {
+            testRecv2Fn.mockImplementation(async () => {
+                // eslint-disable-next-line @typescript-eslint/only-throw-error
+                throw null;
+            });
+            ipc.receivedMessage({
+                direction: 'call',
+                name: 'recvTest2',
+                payload: '42',
+                callbackId: 456,
+            });
+            expect(testRecv2Fn).toHaveBeenCalledTimes(1);
+            expect(testRecv2Fn).toHaveBeenCalledWith(42);
+            await vi.advanceTimersByTimeAsync(201);
+            expect(sendMessageFn).toHaveBeenCalledTimes(1);
+            expect(sendMessageFn).toHaveBeenCalledWith({
+                direction: 'response',
+                success: false,
+                payload: 'null',
+                callbackId: 456,
+            });
+        });
+    });
+});
+//# sourceMappingURL=ipc-wrapper.spec.js.map

package/dist/__tests__/ipc-wrapper.spec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ipc-wrapper.spec.js","sourceRoot":"","sources":["../../src/__tests__/ipc-wrapper.spec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAA;AAC1E,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAW9C,SAAS,cAAc,CAAC,GAAU;IACjC,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAA;AAC5D,CAAC;AAED,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC3B,MAAM,aAAa,GAAG,EAAE,CAAC,EAAE,EAAE,CAAA;IAE7B,MAAM,WAAW,GAAG,EAAE,CAAC,EAAE,EAAuB,CAAA;IAChD,MAAM,WAAW,GAAG,EAAE,CAAC,EAAE,EAAuB,CAAA;IAChD,IAAI,GAA4C,CAAA;IAEhD,SAAS,CAAC,GAAG,EAAE;QACd,EAAE,CAAC,aAAa,EAAE,CAAA;IACnB,CAAC,CAAC,CAAA;IAEF,UAAU,CAAC,GAAG,EAAE;QACf,aAAa,CAAC,SAAS,EAAE,CAAA;QACzB,WAAW,CAAC,SAAS,EAAE,CAAA;QACvB,WAAW,CAAC,SAAS,EAAE,CAAA;QAEvB,GAAG,GAAG,IAAI,UAAU,CACnB;YACC,SAAS,EAAE,WAAW;YACtB,SAAS,EAAE,WAAW;SACtB,EACD,aAAa,EACb,GAAG,CACH,CAAA;IACF,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAClC,GAAG,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,CAAC,CAAA;QAEhC,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;QAC9C,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC;YAC1C,SAAS,EAAE,MAAM;YACjB,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE,GAAG;YACZ,UAAU,EAAE,SAAS;SACrB,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QACnC,IAAI,CAAC,SAAS,EAAE,KAAK,IAAI,EAAE;YAC1B,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;YAC9C,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA,CAAC,+CAA+C;YAExE,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA,CAAC,sBAAsB;YAElD,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC9C,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC;gBAC1C,SAAS,EAAE,MAAM;gBACjB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,CAAC;aACb,CAAC,CAAA;YAEF,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAA;YAE3B,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAA;QACvD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;YAClC,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;YAC9C,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA,CAAC,+CAA+C;YAExE,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA,CAAC,sBAAsB;YAElD,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC9C,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC;gBAC1C,SAAS,EAAE,MAAM;gBACjB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,CAAC;aACb,CAAC,CAAA;YAEF,GAAG,CAAC,eAAe,CAAC;gBACnB,SAAS,EAAE,UAAU;gBACrB,UAAU,EAAE,CAAC;gBACb,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,IAAI;aACb,CAAC,CAAA;YAEF,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC,CAAA;QAC1C,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;YACjC,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;YAC9C,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA,CAAC,+CAA+C;YAExE,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA,CAAC,sBAAsB;YAElD,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC9C,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC;gBAC1C,SAAS,EAAE,MAAM;gBACjB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,CAAC;aACb,CAAC,CAAA;YAEF,GAAG,CAAC,eAAe,CAAC;gBACnB,SAAS,EAAE,UAAU;gBACrB,UAAU,EAAE,CAAC;gBACb,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;aACtC,CAAC,CAAA;YAEF,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC,CAAA;QACrD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE;YAC9B,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;YAC9C,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA,CAAC,+CAA+C;YAExE,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA,CAAC,sBAAsB;YAElD,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC9C,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC;gBAC1C,SAAS,EAAE,MAAM;gBACjB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,CAAC;aACb,CAAC,CAAA;YAEF,GAAG,CAAC,eAAe,CAAC;gBACnB,SAAS,EAAE,UAAU;gBACrB,UAAU,EAAE,CAAC;gBACb,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,cAAc,CAAC,IAAI,KAAK,CAAC,UAAU,CAAC,CAAC;aAC9C,CAAC,CAAA;YAEF,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QACjD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;YACxC,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;YAC9C,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA,CAAC,+CAA+C;YAExE,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA,CAAC,sBAAsB;YAElD,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC9C,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC;gBAC1C,SAAS,EAAE,MAAM;gBACjB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,CAAC;aACb,CAAC,CAAA;YAEF,GAAG,CAAC,eAAe,CAAC;gBACnB,SAAS,EAAE,UAAU;gBACrB,UAAU,EAAE,CAAC;gBACb,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,mBAAmB;aAC5B,CAAC,CAAA;YAEF,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;QACxD,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE;YAC7B,MAAM,MAAM,GAAG,GAAG,CAAC,UAAU,CAAC,WAAW,EAAE,EAAE,CAAC,CAAA;YAC9C,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAA,CAAC,+CAA+C;YAExE,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAA,CAAC,sBAAsB;YAElD,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC9C,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC;gBAC1C,SAAS,EAAE,MAAM;gBACjB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,CAAC;aACb,CAAC,CAAA;YAEF,GAAG,CAAC,eAAe,CAAC;gBACnB,SAAS,EAAE,UAAU;gBACrB,UAAU,EAAE,CAAC;gBACb,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;aAC7B,CAAC,CAAA;YAEF,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;QAC3C,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,0BAA0B,EAAE,GAAG,EAAE;QACrC,WAAW,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;YACzC,OAAO,EAAS,CAAA;QACjB,CAAC,CAAC,CAAA;QAEF,GAAG,CAAC,eAAe,CAAC;YACnB,SAAS,EAAE,MAAM;YACjB,IAAI,EAAE,WAAW;YACjB,OAAO,EAAE,IAAI;YACb,UAAU,EAAE,SAAS;SACrB,CAAC,CAAA;QAEF,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;QAC5C,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAA;QAE5C,EAAE,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAA;QAC3B,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;IAC/C,CAAC,CAAC,CAAA;IAEF,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACtC,IAAI,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;YAClC,WAAW,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;gBACzC,OAAO,EAAS,CAAA;YACjB,CAAC,CAAC,CAAA;YAEF,GAAG,CAAC,eAAe,CAAC;gBACnB,SAAS,EAAE,MAAM;gBACjB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,GAAG;aACf,CAAC,CAAA;YAEF,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC5C,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAA;YAE5C,MAAM,EAAE,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAA;YAEtC,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC9C,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC;gBAC1C,SAAS,EAAE,UAAU;gBACrB,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,GAAG;aACf,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,gBAAgB,EAAE,KAAK,IAAI,EAAE;YACjC,WAAW,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;gBACzC,OAAO,EAAE,KAAK,EAAE,EAAE,EAAS,CAAA;YAC5B,CAAC,CAAC,CAAA;YAEF,GAAG,CAAC,eAAe,CAAC;gBACnB,SAAS,EAAE,MAAM;gBACjB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,GAAG;aACf,CAAC,CAAA;YAEF,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC5C,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAA;YAE5C,MAAM,EAAE,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAA;YAEtC,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC9C,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC;gBAC1C,SAAS,EAAE,UAAU;gBACrB,OAAO,EAAE,IAAI;gBACb,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;gBACtC,UAAU,EAAE,GAAG;aACf,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE;YAC9B,IAAI,KAAwB,CAAA;YAC5B,WAAW,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;gBACzC,KAAK,GAAG,IAAI,KAAK,CAAC,UAAU,CAAC,CAAA;gBAC7B,MAAM,KAAK,CAAA;YACZ,CAAC,CAAC,CAAA;YAEF,GAAG,CAAC,eAAe,CAAC;gBACnB,SAAS,EAAE,MAAM;gBACjB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,GAAG;aACf,CAAC,CAAA;YAEF,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC5C,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAA;YAC5C,MAAM,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,CAAA;YAE1B,MAAM,EAAE,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAA;YAEtC,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC9C,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC;gBAC1C,SAAS,EAAE,UAAU;gBACrB,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,cAAc,CAAC,KAAM,CAAC;gBAC/B,UAAU,EAAE,GAAG;aACf,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;YACxC,WAAW,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;gBACzC,+DAA+D;gBAC/D,MAAM,kBAAkB,CAAA;YACzB,CAAC,CAAC,CAAA;YAEF,GAAG,CAAC,eAAe,CAAC;gBACnB,SAAS,EAAE,MAAM;gBACjB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,GAAG;aACf,CAAC,CAAA;YAEF,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC5C,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAA;YAE5C,MAAM,EAAE,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAA;YAEtC,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC9C,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC;gBAC1C,SAAS,EAAE,UAAU;gBACrB,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,oBAAoB;gBAC7B,UAAU,EAAE,GAAG;aACf,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE;YAC7B,WAAW,CAAC,kBAAkB,CAAC,KAAK,IAAI,EAAE;gBACzC,+DAA+D;gBAC/D,MAAM,IAAI,CAAA;YACX,CAAC,CAAC,CAAA;YAEF,GAAG,CAAC,eAAe,CAAC;gBACnB,SAAS,EAAE,MAAM;gBACjB,IAAI,EAAE,WAAW;gBACjB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,GAAG;aACf,CAAC,CAAA;YAEF,MAAM,CAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC5C,MAAM,CAAC,WAAW,CAAC,CAAC,oBAAoB,CAAC,EAAE,CAAC,CAAA;YAE5C,MAAM,EAAE,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAA;YAEtC,MAAM,CAAC,aAAa,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAA;YAC9C,MAAM,CAAC,aAAa,CAAC,CAAC,oBAAoB,CAAC;gBAC1C,SAAS,EAAE,UAAU;gBACrB,OAAO,EAAE,KAAK;gBACd,OAAO,EAAE,MAAM;gBACf,UAAU,EAAE,GAAG;aACf,CAAC,CAAA;QACH,CAAC,CAAC,CAAA;IACH,CAAC,CAAC,CAAA;AACH,CAAC,CAAC,CAAA"}

package/dist/api.d.ts

@@ -0,0 +1,360 @@
+/**
+ * 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 { CompanionFeedbackButtonStyleResult, OSCSomeArguments, SomeCompanionConfigField, SomeCompanionFeedbackInputField, InstanceStatus, LogLevel, CompanionOptionValues, CompanionInputFieldBase, CompanionButtonPresetDefinition, CompanionTextPresetDefinition, CompanionHTTPRequest, CompanionHTTPResponse, SomeCompanionActionInputField, CompanionVariableValue, OptionsObject, JsonValue } from '@companion-module/base';
+import type { SharedUdpSocketMessage, SharedUdpSocketMessageJoin, SharedUdpSocketMessageLeave, SharedUdpSocketMessageSend } from '@companion-module/base/dist/host-api/context.js';
+export interface ModuleToHostEventsV0 extends ModuleToHostEventsV0SharedSocket {
+    /** The connection has a message for the Companion log */
+    'log-message': (msg: LogMessageMessage) => never;
+    /** The connection status has changed */
+    'set-status': (msg: SetStatusMessage) => never;
+    /** The actions available in the connection have changed */
+    setActionDefinitions: (msg: SetActionDefinitionsMessage) => never;
+    /** The feedbacks available in the connection have changed */
+    setFeedbackDefinitions: (msg: SetFeedbackDefinitionsMessage) => never;
+    /** The varaibles available in the connection have changed */
+    setVariableDefinitions: (msg: SetVariableDefinitionsMessage) => never;
+    /** The presets provided by the connection have changed */
+    setPresetDefinitions: (msg: SetPresetDefinitionsMessage) => never;
+    /** The connection has some new values for variables */
+    setVariableValues: (msg: SetVariableValuesMessage) => never;
+    /** The connection has some new values for feedbacks it is running */
+    updateFeedbackValues: (msg: UpdateFeedbackValuesMessage) => never;
+    /** The connection has updated its config, which should be persisted */
+    saveConfig: (msg: SaveConfigMessage) => never;
+    /** Send an OSC message from the default osc listener in companion */
+    'send-osc': (msg: SendOscMessage) => never;
+    /**
+     * Parse the variables in a string of text.
+     * This has been semi depricated in favor of the companion parsing the options before the module.
+     */
+    parseVariablesInString: (msg: ParseVariablesInStringMessage) => ParseVariablesInStringResponseMessage;
+    /**
+     * @deprecated Replaced with explicit upgrade call in 1.13.0
+     * The connection has upgraded some actions/feedbacks it has been informed about to a new version of its definitions
+     */
+    upgradedItems: (msg: UpgradedDataResponseMessage) => void;
+    /** When the action-recorder is running, the module has recorded an action to add to the recorded stack */
+    recordAction: (msg: RecordActionMessage) => never;
+    /**
+     * The connection has a new value for a custom variable
+     * Note: This should only be used by a few internal modules, it is not intended for general use
+     */
+    setCustomVariable: (msg: SetCustomVariableMessage) => never;
+}
+export interface ModuleToHostEventsV0SharedSocket {
+    sharedUdpSocketJoin: (msg: SharedUdpSocketMessageJoin) => string;
+    sharedUdpSocketLeave: (msg: SharedUdpSocketMessageLeave) => void;
+    sharedUdpSocketSend: (msg: SharedUdpSocketMessageSend) => void;
+}
+export interface HostToModuleEventsV0 extends HostToModuleEventsV0SharedSocket {
+    /** Initialise the connection with the given config and label */
+    init: (msg: InitMessage) => InitResponseMessage;
+    /** Cleanup the connection in preparation for the thread/process to be terminated */
+    destroy: (msg: Record<string, never>) => void;
+    /**
+     * @deprecated Replaced with updateConfigAndLabel in 1.2.0
+     * This is the same as `updateConfigAndLabel` but without the label
+     */
+    updateConfig: (config: unknown) => void;
+    /** The connection config or label has been updated by the user */
+    updateConfigAndLabel: (msg: UpdateConfigAndLabelMessage) => void;
+    /**
+     * Some feedbacks for this connection have been created/updated/removed. This will start them being executed, watching for state changes in the connection and any referenced variables
+     * Since 1.13.0, the options will have variables pre-parsed. Subscribe/unsubscribe would be called as needed, and the feedbacks would start to be executed
+     * Prior to 1.13.0, this would also run upgrade scripts on the feedbacks
+     */
+    updateFeedbacks: (msg: UpdateFeedbackInstancesMessage) => void;
+    /**
+     * Some actions for this connection have been created/updated/removed
+     * Since 1.13.0, the options will have variables pre-parsed. Subscribe/unsubscribe would be called as needed
+     * Prior to 1.13.0, this would also run upgrade scripts on the actions
+     */
+    updateActions: (msg: UpdateActionInstancesMessage) => void;
+    /**
+     * Run the upgrade scripts for the provided actions and feedbacks
+     * Available since 1.13.0. Prior to this, the upgrade scripts would be run as part of the `updateActions` and `updateFeedbacks` calls
+     * The options objects provided here are in their 'raw' form, and can contain expressions
+     */
+    upgradeActionsAndFeedbacks: (msg: UpgradeActionAndFeedbackInstancesMessage) => UpgradeActionAndFeedbackInstancesResponse;
+    /** Execute an action */
+    executeAction: (msg: ExecuteActionMessage) => ExecuteActionResponseMessage | undefined;
+    /** Get the config fields for this connection */
+    getConfigFields: (msg: GetConfigFieldsMessage) => GetConfigFieldsResponseMessage;
+    /** Handle an incoming HTTP request */
+    handleHttpRequest: (msg: HandleHttpRequestMessage) => HandleHttpRequestResponseMessage;
+    /**
+     * Learn the options for an action
+     * This allows the module to update the options for an action based on the current state of the device
+     */
+    learnAction: (msg: LearnActionMessage) => LearnActionResponseMessage;
+    /**
+     * Learn the options for an feedback
+     * This allows the module to update the options for an feedback based on the current state of the device
+     */
+    learnFeedback: (msg: LearnFeedbackMessage) => LearnFeedbackResponseMessage;
+    /**
+     * Start or stop the action-recorder.
+     * When running, this lets the connection emit `recordAction` events when the state of the device changes.
+     * This allows users to record macros of actions for their device by changing properties on the device itself.
+     */
+    startStopRecordActions: (msg: StartStopRecordActionsMessage) => void;
+    /**
+     * @deprecated Replaced by companion parsing the options before the module in 1.13.0
+     * Prior to 1.13.0, this would notify the module that a variable it had parsed during a feedback had changed and let it re-run the feedback
+     */
+    variablesChanged: (msg: VariablesChangedMessage) => never;
+}
+export interface HostToModuleEventsV0SharedSocket {
+    sharedUdpSocketMessage: (msg: SharedUdpSocketMessage) => never;
+    sharedUdpSocketError: (msg: SharedUdpSocketError) => never;
+}
+export type EncodeIsVisible<T extends CompanionInputFieldBase> = Omit<T, 'isVisible' | 'isVisibleExpression'> & {
+    isVisibleFn?: string;
+    isVisibleFnType?: 'function' | 'expression';
+};
+export interface InitMessage {
+    label: string;
+    isFirstInit: boolean;
+    config: unknown;
+    secrets: unknown;
+    lastUpgradeIndex: number;
+    /** @deprecated not populated/used since 1.13.0 */
+    feedbacks: {
+        [id: string]: FeedbackInstance | undefined;
+    };
+    /** @deprecated not populated/used since 1.13.0 */
+    actions: {
+        [id: string]: ActionInstance | undefined;
+    };
+}
+export interface InitResponseMessage {
+    hasHttpHandler: boolean;
+    hasRecordActionsHandler: boolean;
+    newUpgradeIndex: number;
+    disableNewConfigLayout: boolean;
+    updatedConfig: unknown | undefined;
+    updatedSecrets: unknown | undefined;
+}
+export interface UpgradedDataResponseMessage {
+    updatedFeedbacks: {
+        [id: string]: (FeedbackInstanceBase & {
+            controlId: string;
+            style?: Partial<CompanionFeedbackButtonStyleResult>;
+            isInverted: boolean;
+        }) | undefined;
+    };
+    updatedActions: {
+        [id: string]: (ActionInstanceBase & {
+            controlId: string;
+        }) | undefined;
+    };
+}
+export type GetConfigFieldsMessage = Record<string, never>;
+export type SomeEncodedCompanionConfigField = EncodeIsVisible<SomeCompanionConfigField>;
+export interface GetConfigFieldsResponseMessage {
+    fields: SomeEncodedCompanionConfigField[];
+}
+export interface LogMessageMessage {
+    level: LogLevel;
+    message: string;
+}
+export interface SetStatusMessage {
+    status: InstanceStatus;
+    message: string | null;
+}
+export interface SetActionDefinitionsMessage {
+    actions: Array<{
+        id: string;
+        name: string;
+        description: string | undefined;
+        options: EncodeIsVisible<SomeCompanionActionInputField>[];
+        optionsToIgnoreForSubscribe: string[] | undefined;
+        hasLearn: boolean;
+        learnTimeout: number | undefined;
+        hasLifecycleFunctions: boolean;
+    }>;
+}
+export interface SetFeedbackDefinitionsMessage {
+    feedbacks: Array<{
+        id: string;
+        name: string;
+        description: string | undefined;
+        options: EncodeIsVisible<SomeCompanionFeedbackInputField>[];
+        type: 'boolean' | 'value' | 'advanced';
+        defaultStyle?: CompanionFeedbackButtonStyleResult;
+        hasLearn: boolean;
+        showInvert: boolean | undefined;
+        learnTimeout: number | undefined;
+    }>;
+}
+export interface SetVariableDefinitionsMessage {
+    variables: Array<{
+        id: string;
+        name: string;
+    }>;
+    /** New in v1.7, optionally set values for variables at the same tiem */
+    newValues?: Array<{
+        id: string;
+        value: string | number | boolean | undefined;
+    }>;
+}
+export interface SetPresetDefinitionsMessage {
+    presets: Array<(CompanionButtonPresetDefinition | CompanionTextPresetDefinition) & {
+        id: string;
+    }>;
+}
+export interface SetVariableValuesMessage {
+    newValues: Array<{
+        id: string;
+        value: string | number | boolean | undefined;
+    }>;
+}
+export interface ExecuteActionMessage {
+    action: ActionInstance;
+    /** Identifier of the surface which triggered this action */
+    surfaceId: string | undefined;
+}
+export interface ExecuteActionResponseMessage {
+    success: boolean;
+    /** If success=false, a reason for the failure */
+    errorMessage: string | undefined;
+}
+export interface UpdateFeedbackValuesMessage {
+    values: Array<{
+        id: string;
+        controlId: string;
+        value: JsonValue | Partial<CompanionFeedbackButtonStyleResult> | undefined;
+    }>;
+}
+export interface FeedbackInstanceBase {
+    id: string;
+    upgradeIndex: number | null;
+    disabled: boolean;
+    feedbackId: string;
+    options: OptionsObject;
+}
+export interface FeedbackInstance extends FeedbackInstanceBase {
+    controlId: string;
+    isInverted: boolean;
+    /** If control supports an imageBuffer, the dimensions the buffer must be */
+    image?: {
+        width: number;
+        height: number;
+    };
+}
+export interface UpdateConfigAndLabelMessage {
+    label: string;
+    config: unknown | undefined;
+    secrets: unknown | undefined;
+}
+export interface UpdateFeedbackInstancesMessage {
+    feedbacks: {
+        [id: string]: FeedbackInstance | null | undefined;
+    };
+}
+export interface ActionInstanceBase {
+    id: string;
+    upgradeIndex: number | null;
+    disabled: boolean;
+    actionId: string;
+    options: OptionsObject;
+}
+export interface ActionInstance extends ActionInstanceBase {
+    controlId: string;
+}
+export interface UpdateActionInstancesMessage {
+    actions: {
+        [id: string]: ActionInstance | null | undefined;
+    };
+}
+export interface UpgradeActionInstance extends Omit<ActionInstanceBase, 'options'> {
+    options: OptionsObject;
+    controlId: string;
+}
+export interface UpgradeFeedbackInstance extends Omit<FeedbackInstanceBase, 'options'> {
+    options: OptionsObject;
+    isInverted: boolean;
+    /**
+     * Only used as an output from the module, when the feedback is being converted to a boolean feedback
+     */
+    style?: Partial<CompanionFeedbackButtonStyleResult>;
+    controlId: string;
+}
+export interface UpgradeActionAndFeedbackInstancesMessage {
+    actions: UpgradeActionInstance[];
+    feedbacks: UpgradeFeedbackInstance[];
+    defaultUpgradeIndex: number | null;
+}
+export interface UpgradeActionAndFeedbackInstancesResponse {
+    updatedConfig: unknown;
+    updatedSecrets: unknown;
+    updatedActions: UpgradeActionInstance[];
+    updatedFeedbacks: UpgradeFeedbackInstance[];
+    latestUpgradeIndex: number;
+}
+export interface SaveConfigMessage {
+    config: unknown | undefined;
+    secrets: unknown | undefined;
+}
+export interface SendOscMessage {
+    host: string;
+    port: number;
+    path: string;
+    args: OSCSomeArguments;
+}
+export interface ParseVariablesInStringMessage {
+    text: string;
+    controlId: string | undefined;
+    feedbackInstanceId: string | undefined;
+    actionInstanceId: string | undefined;
+}
+export interface ParseVariablesInStringResponseMessage {
+    text: string;
+    variableIds: string[] | undefined;
+}
+export interface HandleHttpRequestMessage {
+    request: CompanionHTTPRequest;
+}
+export interface HandleHttpRequestResponseMessage {
+    response: CompanionHTTPResponse;
+}
+export interface LearnActionMessage {
+    action: ActionInstance;
+}
+export interface LearnActionResponseMessage {
+    options: CompanionOptionValues | undefined;
+}
+export interface LearnFeedbackMessage {
+    feedback: FeedbackInstance;
+}
+export interface LearnFeedbackResponseMessage {
+    options: CompanionOptionValues | undefined;
+}
+export interface StartStopRecordActionsMessage {
+    recording: boolean;
+}
+export interface RecordActionMessage {
+    uniquenessId: string | null;
+    actionId: string;
+    options: CompanionOptionValues;
+    delay: number | undefined;
+}
+export interface SetCustomVariableMessage {
+    customVariableId: string;
+    value: CompanionVariableValue;
+    /** Control the variable was set from. This should always be defined, but did not exist in older versions */
+    controlId: string | undefined;
+}
+export interface VariablesChangedMessage {
+    variablesIds: string[];
+}
+export interface SharedUdpSocketError {
+    handleId: string;
+    portNumber: number;
+    error: Error;
+}
+//# sourceMappingURL=api.d.ts.map