@companion-module/base 1.14.0-0-nightly-main-20251113-203236-30c5c0c → 1.99.0-0-nightly-feat-split-api-20251221-153951-fa12995

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [1.14.0](https://github.com/bitfocus/companion-module-base/compare/v1.13.4...v1.14.0) (2025-12-09)
+
+
+### Features
+
+* add disableNewConfigLayout option ([36da934](https://github.com/bitfocus/companion-module-base/commit/36da9346c9b02d0040ddd13ac4cfba7cbf6258ff))
+* add return value to `executeAction`, to let the host application identify action failure from other errors ([#160](https://github.com/bitfocus/companion-module-base/issues/160)) ([c67b18c](https://github.com/bitfocus/companion-module-base/commit/c67b18c350f910e1be3052942f9941986f2afe75))
+
+
+### Bug Fixes
+
+* secrets not updating in configUpdated ([623a575](https://github.com/bitfocus/companion-module-base/commit/623a5754b53f69a8b9b493020437495e0766a8b8))
+
+## [1.13.5](https://github.com/bitfocus/companion-module-base/compare/v1.13.4...v1.13.5) (2025-11-29)
+
+
+### Bug Fixes
+
+* secrets not updating in configUpdated ([8d867a2](https://github.com/bitfocus/companion-module-base/commit/8d867a2c0b9b8d83a3481237a9fc558c91328db7))
+
 ## [1.13.4](https://github.com/bitfocus/companion-module-base/compare/v1.13.3...v1.13.4) (2025-10-18)
 
 

package/README.md

@@ -8,17 +8,18 @@ In the future it will be possible to write modules in other languages, but it is
 
 Each version of Companion supports a limited range of versions of this library listed below. Any patch version (the third number) are not relevant for the compatibility check, so are not listed here
 
-| Companion | Module-base               |
-| --------- | ------------------------- |
-| v3.0      | v1.0 - v1.4               |
-| v3.1      | v1.0 - v1.5               |
-| v3.2      | v1.0 - v1.7               |
-| v3.3      | v1.0 - v1.8               |
-| v3.4      | v1.0 - v1.10              |
-| v3.5      | v1.0 - v1.11              |
-| v4.0      | v1.0 - v1.12              |
-| v4.1      | v1.0 - v1.13              |
-| v4.2      | v1.0 - v1.13 (unconfirmed) |
+| Companion | Module-base                |
+| --------- | -------------------------- |
+| v3.0      | v1.0 - v1.4                |
+| v3.1      | v1.0 - v1.5                |
+| v3.2      | v1.0 - v1.7                |
+| v3.3      | v1.0 - v1.8                |
+| v3.4      | v1.0 - v1.10               |
+| v3.5      | v1.0 - v1.11               |
+| v4.0      | v1.0 - v1.12               |
+| v4.1      | v1.0 - v1.13               |
+| v4.2      | v1.0 - v1.14               |
+| v4.3      | v1.0 - v1.15 (unconfirmed) |
 
 ## Getting started with a new module
 

package/dist/__mocks__/net.d.ts

@@ -0,0 +1,30 @@
+import { EventEmitter } from 'events';
+export declare class Socket extends EventEmitter {
+    onWrite: ((buff: Buffer, encoding: string) => void) | undefined;
+    onConnect: ((port: number, host: string) => void) | undefined;
+    onClose: (() => void) | undefined;
+    private _connected;
+    destroyed: boolean;
+    configOps: Array<any[]>;
+    constructor();
+    static mockSockets(): Socket[];
+    static mockClearSockets(): void;
+    static mockOnNextSocket(cb: (s: Socket) => void): void;
+    connect(port: number, host?: string, cb?: () => void): void;
+    write(buf: Buffer, cb?: () => void): void;
+    write(buf: Buffer, encoding?: BufferEncoding, cb?: () => void): void;
+    end(): void;
+    mockClose(): void;
+    mockData(data: string): void;
+    setNoDelay(noDelay?: boolean): void;
+    setEncoding(encoding?: BufferEncoding): void;
+    setKeepAlive(enable?: boolean, initialDelay?: number): void;
+    destroy(): void;
+    private setConnected;
+    private setClosed;
+    private setEnd;
+}
+declare const _default: {
+    Socket: typeof Socket;
+};
+export default _default;

package/dist/__mocks__/net.js

@@ -0,0 +1,108 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Socket = void 0;
+const events_1 = require("events");
+const sockets = [];
+const onNextSocket = [];
+const orgSetImmediate = setImmediate;
+class Socket extends events_1.EventEmitter {
+    onWrite;
+    onConnect;
+    onClose;
+    // private _port: number
+    // private _host: string
+    _connected = false;
+    destroyed = false;
+    configOps = [];
+    constructor() {
+        super();
+        const cb = onNextSocket.shift();
+        if (cb) {
+            cb(this);
+        }
+        sockets.push(this);
+    }
+    static mockSockets() {
+        return sockets;
+    }
+    static mockClearSockets() {
+        sockets.length = 0;
+    }
+    static mockOnNextSocket(cb) {
+        onNextSocket.push(cb);
+    }
+    // this.emit('connect')
+    // this.emit('close')
+    // this.emit('end')
+    connect(port, host = 'localhost', cb) {
+        // this._port = port
+        // this._host = host
+        if (this.onConnect)
+            this.onConnect(port, host);
+        orgSetImmediate(() => {
+            if (cb) {
+                cb();
+            }
+            this.setConnected();
+        });
+    }
+    write(buf, encodingOrCb, cb) {
+        const DEFAULT_ENCODING = 'utf-8';
+        cb = typeof encodingOrCb === 'function' ? encodingOrCb : cb;
+        const encoding = typeof encodingOrCb === 'function' ? DEFAULT_ENCODING : encodingOrCb;
+        if (this.onWrite) {
+            this.onWrite(buf, encoding ?? DEFAULT_ENCODING);
+        }
+        if (cb)
+            cb();
+    }
+    end() {
+        this.setEnd();
+        this.setClosed();
+    }
+    mockClose() {
+        this.setClosed();
+    }
+    mockData(data) {
+        this.emit('data', data);
+    }
+    setNoDelay(noDelay) {
+        // noop
+        this.configOps.push(['setNoDelay', noDelay]);
+    }
+    setEncoding(encoding) {
+        // noop
+        this.configOps.push(['setEncoding', encoding]);
+    }
+    setKeepAlive(enable, initialDelay) {
+        // noop
+        this.configOps.push(['setKeepAlive', enable, initialDelay]);
+    }
+    destroy() {
+        this.destroyed = true;
+    }
+    setConnected() {
+        if (this._connected !== true) {
+            this._connected = true;
+        }
+        this.emit('connect');
+    }
+    setClosed() {
+        if (this._connected !== false) {
+            this._connected = false;
+        }
+        this.destroyed = true;
+        this.emit('close');
+        if (this.onClose)
+            this.onClose();
+    }
+    setEnd() {
+        if (this._connected !== false) {
+            this._connected = false;
+        }
+        this.emit('end');
+    }
+}
+exports.Socket = Socket;
+exports.default = { Socket };
+//# sourceMappingURL=net.js.map

package/dist/__mocks__/net.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"net.js","sourceRoot":"","sources":["../../src/__mocks__/net.ts"],"names":[],"mappings":";;;AAAA,mCAAqC;AACrC,MAAM,OAAO,GAAkB,EAAE,CAAA;AACjC,MAAM,YAAY,GAA+B,EAAE,CAAA;AAEnD,MAAM,eAAe,GAAG,YAAY,CAAA;AAEpC,MAAa,MAAO,SAAQ,qBAAY;IAChC,OAAO,CAAwD;IAC/D,SAAS,CAAoD;IAC7D,OAAO,CAA0B;IAExC,wBAAwB;IACxB,wBAAwB;IAChB,UAAU,GAAG,KAAK,CAAA;IAEnB,SAAS,GAAG,KAAK,CAAA;IAEjB,SAAS,GAAiB,EAAE,CAAA;IAEnC;QACC,KAAK,EAAE,CAAA;QAEP,MAAM,EAAE,GAAG,YAAY,CAAC,KAAK,EAAE,CAAA;QAC/B,IAAI,EAAE,EAAE,CAAC;YACR,EAAE,CAAC,IAAI,CAAC,CAAA;QACT,CAAC;QAED,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACnB,CAAC;IAEM,MAAM,CAAC,WAAW;QACxB,OAAO,OAAO,CAAA;IACf,CAAC;IACM,MAAM,CAAC,gBAAgB;QAC7B,OAAO,CAAC,MAAM,GAAG,CAAC,CAAA;IACnB,CAAC;IACM,MAAM,CAAC,gBAAgB,CAAC,EAAuB;QACrD,YAAY,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;IACtB,CAAC;IACD,uBAAuB;IACvB,qBAAqB;IACrB,mBAAmB;IAEZ,OAAO,CAAC,IAAY,EAAE,IAAI,GAAG,WAAW,EAAE,EAAe;QAC/D,oBAAoB;QACpB,oBAAoB;QAEpB,IAAI,IAAI,CAAC,SAAS;YAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,IAAI,CAAC,CAAA;QAC9C,eAAe,CAAC,GAAG,EAAE;YACpB,IAAI,EAAE,EAAE,CAAC;gBACR,EAAE,EAAE,CAAA;YACL,CAAC;YACD,IAAI,CAAC,YAAY,EAAE,CAAA;QACpB,CAAC,CAAC,CAAA;IACH,CAAC;IAGM,KAAK,CAAC,GAAW,EAAE,YAA4C,EAAE,EAAe;QACtF,MAAM,gBAAgB,GAAG,OAAO,CAAA;QAChC,EAAE,GAAG,OAAO,YAAY,KAAK,UAAU,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,EAAE,CAAA;QAC3D,MAAM,QAAQ,GAAG,OAAO,YAAY,KAAK,UAAU,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,CAAC,YAAY,CAAA;QACrF,IAAI,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,QAAQ,IAAI,gBAAgB,CAAC,CAAA;QAChD,CAAC;QACD,IAAI,EAAE;YAAE,EAAE,EAAE,CAAA;IACb,CAAC;IACM,GAAG;QACT,IAAI,CAAC,MAAM,EAAE,CAAA;QACb,IAAI,CAAC,SAAS,EAAE,CAAA;IACjB,CAAC;IAEM,SAAS;QACf,IAAI,CAAC,SAAS,EAAE,CAAA;IACjB,CAAC;IACM,QAAQ,CAAC,IAAY;QAC3B,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,CAAA;IACxB,CAAC;IAEM,UAAU,CAAC,OAAiB;QAClC,OAAO;QACP,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC,CAAA;IAC7C,CAAC;IAEM,WAAW,CAAC,QAAyB;QAC3C,OAAO;QACP,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,aAAa,EAAE,QAAQ,CAAC,CAAC,CAAA;IAC/C,CAAC;IAEM,YAAY,CAAC,MAAgB,EAAE,YAAqB;QAC1D,OAAO;QACP,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,cAAc,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC,CAAA;IAC5D,CAAC;IAEM,OAAO;QACb,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;IACtB,CAAC;IAEO,YAAY;QACnB,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE,CAAC;YAC9B,IAAI,CAAC,UAAU,GAAG,IAAI,CAAA;QACvB,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;IACrB,CAAC;IACO,SAAS;QAChB,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QACxB,CAAC;QACD,IAAI,CAAC,SAAS,GAAG,IAAI,CAAA;QACrB,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QAClB,IAAI,IAAI,CAAC,OAAO;YAAE,IAAI,CAAC,OAAO,EAAE,CAAA;IACjC,CAAC;IACO,MAAM;QACb,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,EAAE,CAAC;YAC/B,IAAI,CAAC,UAAU,GAAG,KAAK,CAAA;QACxB,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;IACjB,CAAC;CACD;AA/GD,wBA+GC;AAED,kBAAe,EAAE,MAAM,EAAE,CAAA"}

package/dist/__mocks__/util.d.ts

@@ -0,0 +1,8 @@
+export declare function runAllTimers(): Promise<void>;
+export declare function runTimersUntilNow(): Promise<void>;
+export interface ManualPromise<T> extends Promise<T> {
+    isResolved: boolean;
+    manualResolve(res: T): void;
+    manualReject(e: Error): void;
+}
+export declare function createManualPromise<T>(): ManualPromise<T>;

package/dist/__mocks__/util.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runAllTimers = runAllTimers;
+exports.runTimersUntilNow = runTimersUntilNow;
+exports.createManualPromise = createManualPromise;
+const vitest_1 = require("vitest");
+const orgSetTimeout = setTimeout;
+async function runAllTimers() {
+    // Run all timers, and wait, multiple times.
+    // This is to allow timers AND internal promises to resolve in inner functions
+    for (let i = 0; i < 50; i++) {
+        vitest_1.vi.runOnlyPendingTimers();
+        await new Promise((resolve) => orgSetTimeout(resolve, 0));
+    }
+}
+async function runTimersUntilNow() {
+    // Run all timers, and wait, multiple times.
+    // This is to allow timers AND internal promises to resolve in inner functions
+    for (let i = 0; i < 50; i++) {
+        vitest_1.vi.advanceTimersByTime(0);
+        await new Promise((resolve) => orgSetTimeout(resolve, 0));
+    }
+}
+// eslint-disable-next-line @typescript-eslint/promise-function-async
+function createManualPromise() {
+    let resolve = () => null;
+    let reject = () => null;
+    const promise = new Promise((resolve0, reject0) => {
+        resolve = resolve0;
+        reject = reject0;
+    });
+    const manualPromise = promise;
+    manualPromise.isResolved = false;
+    manualPromise.manualReject = (err) => {
+        manualPromise.isResolved = true;
+        return reject(err);
+    };
+    manualPromise.manualResolve = (val) => {
+        manualPromise.isResolved = true;
+        return resolve(val);
+    };
+    return manualPromise;
+}
+//# sourceMappingURL=util.js.map

package/dist/__mocks__/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../../src/__mocks__/util.ts"],"names":[],"mappings":";;AAGA,oCAOC;AAED,8CAOC;AAQD,kDAoBC;AA/CD,mCAA2B;AAE3B,MAAM,aAAa,GAAG,UAAU,CAAA;AACzB,KAAK,UAAU,YAAY;IACjC,4CAA4C;IAC5C,8EAA8E;IAC9E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7B,WAAE,CAAC,oBAAoB,EAAE,CAAA;QACzB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAC1D,CAAC;AACF,CAAC;AAEM,KAAK,UAAU,iBAAiB;IACtC,4CAA4C;IAC5C,8EAA8E;IAC9E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC;QAC7B,WAAE,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAA;QACzB,MAAM,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,CAAA;IAC1D,CAAC;AACF,CAAC;AAOD,qEAAqE;AACrE,SAAgB,mBAAmB;IAClC,IAAI,OAAO,GAAqB,GAAG,EAAE,CAAC,IAAI,CAAA;IAC1C,IAAI,MAAM,GAAyB,GAAG,EAAE,CAAC,IAAI,CAAA;IAC7C,MAAM,OAAO,GAAG,IAAI,OAAO,CAAI,CAAC,QAAQ,EAAE,OAAO,EAAE,EAAE;QACpD,OAAO,GAAG,QAAQ,CAAA;QAClB,MAAM,GAAG,OAAO,CAAA;IACjB,CAAC,CAAC,CAAA;IAEF,MAAM,aAAa,GAAqB,OAAc,CAAA;IACtD,aAAa,CAAC,UAAU,GAAG,KAAK,CAAA;IAChC,aAAa,CAAC,YAAY,GAAG,CAAC,GAAG,EAAE,EAAE;QACpC,aAAa,CAAC,UAAU,GAAG,IAAI,CAAA;QAC/B,OAAO,MAAM,CAAC,GAAG,CAAC,CAAA;IACnB,CAAC,CAAA;IACD,aAAa,CAAC,aAAa,GAAG,CAAC,GAAG,EAAE,EAAE;QACrC,aAAa,CAAC,UAAU,GAAG,IAAI,CAAA;QAC/B,OAAO,OAAO,CAAC,GAAG,CAAC,CAAA;IACpB,CAAC,CAAA;IAED,OAAO,aAAa,CAAA;AACrB,CAAC"}

package/dist/common/json-value.d.ts

@@ -30,4 +30,3 @@ Matches any valid JSON value.
 @category JSON
 */
 export type JsonValue = JsonPrimitive | JsonObject | JsonArray;
-//# sourceMappingURL=json-value.d.ts.map

package/dist/common/osc.d.ts

@@ -14,4 +14,3 @@ export type OSCMetaArgument = {
     value: Uint8Array;
 };
 export type OSCSomeArguments = OSCArgument | Array<OSCArgument> | OSCMetaArgument | Array<OSCMetaArgument>;
-//# sourceMappingURL=osc.d.ts.map

package/dist/entrypoint.d.ts

@@ -1,5 +1,14 @@
 import type { CompanionStaticUpgradeScript } from './module-api/upgrade.js';
 import type { InstanceBase } from './module-api/base.js';
+declare global {
+    /**
+     * INTERNAL USE ONLY
+     */
+    var COMPANION_ENTRYPOINT_INFO: {
+        factory: InstanceConstructor<any, any>;
+        upgradeScripts: CompanionStaticUpgradeScript<any, any>[];
+    } | undefined;
+}
 export type InstanceConstructor<TConfig, TSecrets> = new (internal: unknown) => InstanceBase<TConfig, TSecrets>;
 /**
  * Setup the module for execution
@@ -8,4 +17,3 @@ export type InstanceConstructor<TConfig, TSecrets> = new (internal: unknown) =>
  * @param upgradeScripts Upgrade scripts
  */
 export declare function runEntrypoint<TConfig, TSecrets>(factory: InstanceConstructor<TConfig, TSecrets>, upgradeScripts: CompanionStaticUpgradeScript<TConfig, TSecrets>[]): void;
-//# sourceMappingURL=entrypoint.d.ts.map

package/dist/entrypoint.js

@@ -1,27 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runEntrypoint = runEntrypoint;
-const tslib_1 = require("tslib");
-/* eslint-disable n/no-process-exit */
-const versions_js_1 = require("./host-api/versions.js");
-const promises_1 = tslib_1.__importDefault(require("fs/promises"));
-const util_js_1 = require("./util.js");
-const ipc_wrapper_js_1 = require("./host-api/ipc-wrapper.js");
-const path_1 = tslib_1.__importDefault(require("path"));
-let hasEntrypoint = false;
-// eslint-disable-next-line @typescript-eslint/no-unused-vars
-let moduleInstance;
-// async function readFileUrl(url: URL): Promise<string> {
-// 	// Hack to make json files be loadable after being inlined by webpack
-// 	const prefix = 'application/json;base64,'
-// 	if (url.pathname.startsWith(prefix)) {
-// 		const base64 = url.pathname.substring(prefix.length)
-// 		return Buffer.from(base64, 'base64').toString()
-// 	}
-// 	// Fallback to reading from disk
-// 	const buf = await fs.readFile(url)
-// 	return buf.toString()
-// }
 /**
  * Setup the module for execution
  * This should be called once per-module, to register the class that should be executed
@@ -29,106 +8,9 @@ let moduleInstance;
  * @param upgradeScripts Upgrade scripts
  */
 function runEntrypoint(factory, upgradeScripts) {
-    Promise.resolve()
-        .then(async () => {
-        // const pkgJsonStr = (await fs.readFile(path.join(__dirname, '../package.json'))).toString()
-        // const pkgJson = JSON.parse(pkgJsonStr)
-        // if (!pkgJson || pkgJson.name !== '@companion-module/base')
-        // 	throw new Error('Failed to find the package.json for @companion-module/base')
-        // if (!pkgJson.version) throw new Error('Missing version field in the package.json for @companion-module/base')
-        // Ensure only called once per module
-        if (hasEntrypoint)
-            throw new Error(`runEntrypoint can only be called once`);
-        hasEntrypoint = true;
-        // Validate that the upgrade scripts look sane
-        if (!upgradeScripts)
-            upgradeScripts = [];
-        if (!Array.isArray(upgradeScripts))
-            throw new Error('upgradeScripts must be an array');
-        for (const upgradeScript of upgradeScripts) {
-            if (typeof upgradeScript !== 'function')
-                throw new Error('upgradeScripts must be an array of functions');
-        }
-        const manifestPath = process.env.MODULE_MANIFEST;
-        if (!manifestPath)
-            throw new Error('Module initialise is missing MODULE_MANIFEST');
-        // check manifest api field against apiVersion
-        const manifestBlob = await promises_1.default.readFile(manifestPath);
-        const manifestJson = JSON.parse(manifestBlob.toString());
-        if (manifestJson.runtime?.api !== versions_js_1.HostApiNodeJsIpc)
-            throw new Error(`Module manifest 'api' mismatch`);
-        if (!manifestJson.runtime.apiVersion)
-            throw new Error(`Module manifest 'apiVersion' missing`);
-        let apiVersion = manifestJson.runtime.apiVersion;
-        if (apiVersion === '0.0.0') {
-            // It looks like the module is in dev mode. lets attempt to load the package.json from this module instead
-            try {
-                const baseJsonStr = await promises_1.default.readFile(path_1.default.join(__dirname, '../package.json'));
-                const baseJson = JSON.parse(baseJsonStr.toString());
-                if (baseJson.name === '@companion-module/base') {
-                    apiVersion = baseJson.version;
-                }
-            }
-            catch (_e) {
-                throw new Error('Failed to determine module api version');
-            }
-        }
-        if (!process.send)
-            throw new Error('Module is not being run with ipc');
-        console.log(`Starting up module class: ${factory.name}`);
-        const connectionId = process.env.CONNECTION_ID;
-        if (typeof connectionId !== 'string' || !connectionId)
-            throw new Error('Module initialise is missing CONNECTION_ID');
-        const verificationToken = process.env.VERIFICATION_TOKEN;
-        if (typeof verificationToken !== 'string' || !verificationToken)
-            throw new Error('Module initialise is missing VERIFICATION_TOKEN');
-        // Allow the DSN to be provided as an env variable
-        // const sentryDsn = process.env.SENTRY_DSN
-        // const sentryUserId = process.env.SENTRY_USERID
-        // const sentryCompanionVersion = process.env.SENTRY_COMPANION_VERSION
-        // if (sentryDsn && sentryUserId && sentryDsn.substring(0, 8) == 'https://') {
-        // 	console.log('Sentry enabled')
-        // 	init({
-        // 		dsn: sentryDsn,
-        // 		release: `${manifestJson.name}@${manifestJson.version}`,
-        // 		beforeSend(event) {
-        // 			if (event.exception) {
-        // 				console.log('sentry', 'error', event.exception)
-        // 			}
-        // 			return event
-        // 		},
-        // 	})
-        // 	{
-        // 		const scope = getCurrentScope()
-        // 		scope.setUser({ id: sentryUserId })
-        // 		scope.setTag('companion', sentryCompanionVersion)
-        // 	}
-        // } else {
-        // 	console.log('Sentry disabled')
-        // }
-        const ipcWrapper = new ipc_wrapper_js_1.IpcWrapper({}, (msg) => {
-            process.send(msg);
-        }, 5000);
-        process.once('message', (msg) => {
-            ipcWrapper.receivedMessage(msg);
-        });
-        moduleInstance = new factory((0, util_js_1.literal)({
-            id: connectionId,
-            upgradeScripts,
-            _isInstanceBaseProps: true,
-        }));
-        ipcWrapper.sendWithCb('register', { apiVersion, connectionId, verificationToken }).then(() => {
-            console.log(`Module-host accepted registration`);
-        }, (err) => {
-            console.error('Module registration failed', err);
-            // Kill the process
-            process.exit(11);
-        });
-    })
-        .catch((e) => {
-        console.error(`Failed to startup module:`);
-        console.error(e.stack || e.message);
-        process.exit(1);
-    });
+    if (global.COMPANION_ENTRYPOINT_INFO)
+        throw new Error(`runEntrypoint can only be called once`);
+    // Future: In v2.0 of the api, this method should be removed and replaced with the module exporting a default class
+    global.COMPANION_ENTRYPOINT_INFO = { factory, upgradeScripts };
 }
 //# sourceMappingURL=entrypoint.js.map

package/dist/entrypoint.js.map

@@ -1 +1 @@
-{"version":3,"file":"entrypoint.js","sourceRoot":"","sources":["../src/entrypoint.ts"],"names":[],"mappings":";;AAoCA,sCA0HC;;AA9JD,sCAAsC;AACtC,wDAAyG;AACzG,mEAA4B;AAI5B,uCAAmC;AAEnC,8DAAsD;AACtD,wDAAuB;AAEvB,IAAI,aAAa,GAAG,KAAK,CAAA;AACzB,6DAA6D;AAC7D,IAAI,cAAkD,CAAA;AAItD,0DAA0D;AAC1D,yEAAyE;AACzE,6CAA6C;AAC7C,0CAA0C;AAC1C,yDAAyD;AACzD,oDAAoD;AACpD,KAAK;AAEL,oCAAoC;AACpC,sCAAsC;AACtC,yBAAyB;AACzB,IAAI;AAEJ;;;;;GAKG;AACH,SAAgB,aAAa,CAC5B,OAA+C,EAC/C,cAAiE;IAEjE,OAAO,CAAC,OAAO,EAAE;SACf,IAAI,CAAC,KAAK,IAAI,EAAE;QAChB,6FAA6F;QAC7F,yCAAyC;QACzC,6DAA6D;QAC7D,iFAAiF;QACjF,gHAAgH;QAEhH,qCAAqC;QACrC,IAAI,aAAa;YAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;QAC3E,aAAa,GAAG,IAAI,CAAA;QAEpB,8CAA8C;QAC9C,IAAI,CAAC,cAAc;YAAE,cAAc,GAAG,EAAE,CAAA;QACxC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;QACtF,KAAK,MAAM,aAAa,IAAI,cAAc,EAAE,CAAC;YAC5C,IAAI,OAAO,aAAa,KAAK,UAAU;gBAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;QACzG,CAAC;QAED,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAA;QAChD,IAAI,CAAC,YAAY;YAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;QAElF,8CAA8C;QAC9C,MAAM,YAAY,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;QACpD,MAAM,YAAY,GAA4B,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAA;QAEjF,IAAI,YAAY,CAAC,OAAO,EAAE,GAAG,KAAK,8BAAgB;YAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;QACrG,IAAI,CAAC,YAAY,CAAC,OAAO,CAAC,UAAU;YAAE,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAA;QAC7F,IAAI,UAAU,GAAG,YAAY,CAAC,OAAO,CAAC,UAAU,CAAA;QAEhD,IAAI,UAAU,KAAK,OAAO,EAAE,CAAC;YAC5B,0GAA0G;YAC1G,IAAI,CAAC;gBACJ,MAAM,WAAW,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,iBAAiB,CAAC,CAAC,CAAA;gBAC9E,MAAM,QAAQ,GAAG,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,QAAQ,EAAE,CAAC,CAAA;gBACnD,IAAI,QAAQ,CAAC,IAAI,KAAK,wBAAwB,EAAE,CAAC;oBAChD,UAAU,GAAG,QAAQ,CAAC,OAAO,CAAA;gBAC9B,CAAC;YACF,CAAC;YAAC,OAAO,EAAE,EAAE,CAAC;gBACb,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;YAC1D,CAAC;QACF,CAAC;QAED,IAAI,CAAC,OAAO,CAAC,IAAI;YAAE,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;QAEtE,OAAO,CAAC,GAAG,CAAC,6BAA6B,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;QAExD,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAA;QAC9C,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,CAAC,YAAY;YACpD,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;QAE9D,MAAM,iBAAiB,GAAG,OAAO,CAAC,GAAG,CAAC,kBAAkB,CAAA;QACxD,IAAI,OAAO,iBAAiB,KAAK,QAAQ,IAAI,CAAC,iBAAiB;YAC9D,MAAM,IAAI,KAAK,CAAC,iDAAiD,CAAC,CAAA;QAEnE,kDAAkD;QAClD,2CAA2C;QAC3C,iDAAiD;QACjD,sEAAsE;QACtE,8EAA8E;QAC9E,iCAAiC;QAEjC,UAAU;QACV,oBAAoB;QACpB,6DAA6D;QAC7D,wBAAwB;QACxB,4BAA4B;QAC5B,sDAAsD;QACtD,OAAO;QACP,kBAAkB;QAClB,OAAO;QACP,MAAM;QAEN,KAAK;QACL,oCAAoC;QACpC,wCAAwC;QACxC,sDAAsD;QACtD,KAAK;QACL,WAAW;QACX,kCAAkC;QAClC,IAAI;QAEJ,MAAM,UAAU,GAAG,IAAI,2BAAU,CAChC,EAAE,EACF,CAAC,GAAG,EAAE,EAAE;YACP,OAAO,CAAC,IAAK,CAAC,GAAG,CAAC,CAAA;QACnB,CAAC,EACD,IAAI,CACJ,CAAA;QACD,OAAO,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC,GAAQ,EAAE,EAAE;YACpC,UAAU,CAAC,eAAe,CAAC,GAAG,CAAC,CAAA;QAChC,CAAC,CAAC,CAAA;QAEF,cAAc,GAAG,IAAI,OAAO,CAC3B,IAAA,iBAAO,EAAuC;YAC7C,EAAE,EAAE,YAAY;YAChB,cAAc;YACd,oBAAoB,EAAE,IAAI;SAC1B,CAAC,CACF,CAAA;QAED,UAAU,CAAC,UAAU,CAAC,UAAU,EAAE,EAAE,UAAU,EAAE,YAAY,EAAE,iBAAiB,EAAE,CAAC,CAAC,IAAI,CACtF,GAAG,EAAE;YACJ,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAA;QACjD,CAAC,EACD,CAAC,GAAG,EAAE,EAAE;YACP,OAAO,CAAC,KAAK,CAAC,4BAA4B,EAAE,GAAG,CAAC,CAAA;YAEhD,mBAAmB;YACnB,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;QACjB,CAAC,CACD,CAAA;IACF,CAAC,CAAC;SACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;QACZ,OAAO,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAA;QAC1C,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,CAAA;QACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;IAChB,CAAC,CAAC,CAAA;AACJ,CAAC"}
+{"version":3,"file":"entrypoint.js","sourceRoot":"","sources":["../src/entrypoint.ts"],"names":[],"mappings":";;AAuBA,sCAQC;AAdD;;;;;GAKG;AACH,SAAgB,aAAa,CAC5B,OAA+C,EAC/C,cAAiE;IAEjE,IAAI,MAAM,CAAC,yBAAyB;QAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;IAE9F,mHAAmH;IACnH,MAAM,CAAC,yBAAyB,GAAG,EAAE,OAAO,EAAE,cAAc,EAAE,CAAA;AAC/D,CAAC"}

package/dist/helpers/__tests__/tcp.spec.d.ts

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

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

@@ -0,0 +1,210 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const tcp_js_1 = require("../tcp.js");
+const net_1 = require("net");
+const MockSocket = net_1.Socket;
+vitest_1.vi.mock('net', async () => Promise.resolve().then(() => __importStar(require('../../__mocks__/net.js'))));
+// async function sleepImmediate() {
+// 	return new Promise((resolve) => setImmediate(resolve))
+// }
+(0, vitest_1.describe)('TCP', () => {
+    // beforeEach(() => {
+    // 	createSocketMock.mockClear()
+    // })
+    (0, vitest_1.afterEach)(() => {
+        MockSocket.mockClearSockets();
+    });
+    // it('call fail before open', () => {
+    // 	const { mockIpcWrapper, moduleTcpSockets } = createDeps()
+    // 	const socket = new TCPHelper(mockIpcWrapper, moduleTcpSockets, { type: 'tcp4' })
+    // 	expect(() => socket.destroy()).toThrow(/Socket is not open/)
+    // 	expect(() => socket.send('', 12, '')).toThrow(/Socket is not open/)
+    // })
+    (0, vitest_1.describe)('construct', () => {
+        (0, vitest_1.it)('ok', () => {
+            const socket = new tcp_js_1.TCPHelper('1.2.3.4', 852);
+            try {
+                (0, vitest_1.expect)(socket).toBeTruthy();
+                (0, vitest_1.expect)(MockSocket.mockSockets()).toHaveLength(1);
+                const rawSocket = MockSocket.mockSockets()[0];
+                (0, vitest_1.expect)(rawSocket.configOps).toHaveLength(2);
+                (0, vitest_1.expect)(rawSocket.configOps).toEqual([
+                    ['setKeepAlive', true, undefined],
+                    ['setNoDelay', true],
+                ]);
+            }
+            finally {
+                socket.destroy();
+            }
+        });
+        // it('bad bind', async () => {
+        // 	const rawSocket = new MinimalSocket()
+        // 	createSocketMock.mockReturnValueOnce(rawSocket as any)
+        // 	expect(() => new TCPHelper('1.2.3.4', 852)).toThrow('Unable to bind')
+        // 	expect(createSocketMock).toHaveBeenCalledTimes(1)
+        // 	expect(rawSocket.bind).toHaveBeenCalledTimes(1)
+        // 	expect(rawSocket.bind).toHaveBeenCalledWith(0, undefined)
+        // })
+        // it('ok', async () => {
+        // 	const rawSocket = new MinimalSocket()
+        // 	createSocketMock.mockReturnValueOnce(rawSocket as any)
+        // 	rawSocket.bind.mockImplementationOnce(() => {
+        // 		// No op
+        // 		return rawSocket as any
+        // 	})
+        // 	const socket = new TCPHelper('1.2.3.4', 852)
+        // 	try {
+        // 		expect(socket).toBeTruthy()
+        // 		expect(createSocketMock).toHaveBeenCalledTimes(1)
+        // 		expect(rawSocket.bind).toHaveBeenCalledTimes(1)
+        // 		expect(rawSocket.bind).toHaveBeenCalledWith(0, undefined)
+        // 	} finally {
+        // 		socket.destroy()
+        // 	}
+        // })
+        // TODO - options
+    });
+    // it('error propogation', async () => {
+    // 	const rawSocket = new MinimalSocket()
+    // 	createSocketMock.mockReturnValueOnce(rawSocket as any)
+    // 	rawSocket.bind.mockImplementationOnce(() => rawSocket as any)
+    // 	const socket = new TCPHelper('1.2.3.4', 852)
+    // 	try {
+    // 		expect(socket).toBeTruthy()
+    // 		const errorHandler = vi.fn(() => {})
+    // 		const statusHandler = vi.fn(() => {})
+    // 		socket.on('error', errorHandler)
+    // 		socket.on('status_change', statusHandler)
+    // 		expect(createSocketMock).toHaveBeenCalledTimes(1)
+    // 		rawSocket.emit('error', new Error('My fake error'))
+    // 		expect(errorHandler).toHaveBeenCalledTimes(1)
+    // 		expect(errorHandler).toHaveBeenCalledWith(new Error('My fake error'))
+    // 		expect(statusHandler).toHaveBeenCalledTimes(1)
+    // 		expect(statusHandler).toHaveBeenCalledWith(InstanceStatus.UnknownError, 'My fake error')
+    // 	} finally {
+    // 		socket.destroy()
+    // 	}
+    // })
+    // describe('listening', () => {
+    // 	it('ok', async () => {
+    // 		const rawSocket = new MinimalSocket()
+    // 		createSocketMock.mockReturnValueOnce(rawSocket as any)
+    // 		rawSocket.bind.mockImplementationOnce(() => rawSocket as any)
+    // 		const socket = new TCPHelper('1.2.3.4', 852)
+    // 		try {
+    // 			expect(socket).toBeTruthy()
+    // 			const listeningHandler = vi.fn(() => {})
+    // 			const statusHandler = vi.fn(() => {})
+    // 			socket.on('connect', listeningHandler)
+    // 			socket.on('status_change', statusHandler)
+    // 			expect(createSocketMock).toHaveBeenCalledTimes(1)
+    // 			rawSocket.emit('listening')
+    // 			expect(listeningHandler).toHaveBeenCalledTimes(1)
+    // 			expect(statusHandler).toHaveBeenCalledTimes(1)
+    // 			expect(statusHandler).toHaveBeenCalledWith(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)
+    // })
+    // describe('send', () => {
+    // 	const rawSocket = new MinimalSocket()
+    // 	rawSocket.bind.mockImplementation(() => rawSocket as any)
+    // 	let socket: TCPHelper
+    // 	beforeAll(() => {
+    // 		createSocketMock.mockReturnValueOnce(rawSocket as any)
+    // 		socket = new TCPHelper('1.2.3.4', 852)
+    // 		expect(socket).toBeTruthy()
+    // 	})
+    // 	beforeEach(() => {
+    // 		rawSocket.close.mockClear()
+    // 		rawSocket.send.mockClear()
+    // 	})
+    // 	afterAll(() => {
+    // 		if (socket) socket.destroy()
+    // 	})
+    // 	it('destroyed', async () => {
+    // 		createSocketMock.mockReturnValueOnce(rawSocket as any)
+    // 		const mySocket = new TCPHelper('1.2.3.4', 852)
+    // 		expect(mySocket).toBeTruthy()
+    // 		mySocket.destroy()
+    // 		expect(rawSocket.close).toHaveBeenCalledTimes(1)
+    // 		await expect(mySocket.send('test')).rejects.toThrow('Cannot write to destroyed socket')
+    // 	})
+    // 	it('no message', async () => {
+    // 		await expect(socket.send(undefined as any)).rejects.toThrow('No message to send')
+    // 		expect(rawSocket.send).toHaveBeenCalledTimes(0)
+    // 	})
+    // 	it('ok: string', async () => {
+    // 		rawSocket.send.mockImplementation((msg, offset, length, cb) => {
+    // 			if (!cb) return
+    // 			cb(null, length)
+    // 		})
+    // 		await expect(socket.send('test 123')).resolves.toBeUndefined()
+    // 		expect(rawSocket.send).toHaveBeenCalledTimes(1)
+    // 		expect(rawSocket.send).toHaveBeenCalledWith('test 123', 852, '1.2.3.4', expect.any(Function))
+    // 	})
+    // 	it('ok: buffer', async () => {
+    // 		rawSocket.send.mockImplementation((msg, offset, length, cb) => {
+    // 			if (!cb) return
+    // 			cb(null, length)
+    // 		})
+    // 		const msg = Buffer.from('test 123')
+    // 		await expect(socket.send(msg)).resolves.toBeUndefined()
+    // 		expect(rawSocket.send).toHaveBeenCalledTimes(1)
+    // 		expect(rawSocket.send).toHaveBeenCalledWith(msg, 852, '1.2.3.4', expect.any(Function))
+    // 	})
+    // 	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 expect(socket.send(msg)).rejects.toThrow('buffer overflow')
+    // 		expect(rawSocket.send).toHaveBeenCalledTimes(1)
+    // 		expect(rawSocket.send).toHaveBeenCalledWith(msg, 852, '1.2.3.4', expect.any(Function))
+    // 	})
+    // })
+});
+//# sourceMappingURL=tcp.spec.js.map