@companion-module/base 0.0.3

package/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## [0.0.3](https://github.com/bitfocus/companion-module-base/compare/v0.0.2...v0.0.3) (2022-07-10)
+
+
+### Bug Fixes
+
+* another attempt at npm ([3d7738b](https://github.com/bitfocus/companion-module-base/commit/3d7738b77bdf6ced282cd043428e3ccde66851ef))
+
+## [0.0.2](https://github.com/bitfocus/companion-module-base/compare/v0.0.1...v0.0.2) (2022-07-10)
+
+
+### Bug Fixes
+
+* npm-publish workflow ([0147cd2](https://github.com/bitfocus/companion-module-base/commit/0147cd2f8c30b22edf287dba2f3038f88b522c34))
+
+## 0.0.1 (2022-07-10)
+
+
+### Bug Fixes
+
+* test ([8319a36](https://github.com/bitfocus/companion-module-base/commit/8319a362248d93c42e027c7ca431ddf10b1ca931))
+
+
+### Miscellaneous Chores
+
+* add warning to readme ([dd30e25](https://github.com/bitfocus/companion-module-base/commit/dd30e25ffa4c9a5c63c5be8184cf7e1efad63932))

package/README.md

@@ -0,0 +1,14 @@
+# @companion-module/base
+
+If you have found this without being directed here, then this is not for you.
+Companion 3.0 is not ready for users yet, so you should not be targetting a module to it yet. We will make some announcements when we are ready
+
+This module provides the base class and framework needed to write a module for [Companion 3.0](https://github.com/bitfocus/companion) and later in NodeJS.
+
+In the future it will be possible to write modules in other languages, but it is not recommended as it will reduce the change of gettings other in the community to contribute features and fixes. If you interested in doing this then reach out and we can work together on creating an alternate framework for the language you are using.
+
+## Getting started with a new module
+
+To get started with creating a new module, you should start with one of the following templates. These should be kept up to date, but you should make sure all the dependencies are up to date before you begin.
+
+- TODO

package/dist/common/osc.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Warning: these types are used in various stable apis.
+ * BE VERY CAREFUL WHEN MAKING CHANGES
+ */
+export declare type OSCArgument = number | string | Uint8Array;
+export declare type OSCMetaArgument = {
+    type: 'i' | 'f';
+    value: number;
+} | {
+    type: 's';
+    value: string;
+} | {
+    type: 'b';
+    value: Uint8Array;
+};
+export declare type OSCSomeArguments = OSCArgument | Array<OSCArgument> | OSCMetaArgument | Array<OSCMetaArgument>;
+//# sourceMappingURL=osc.d.ts.map

package/dist/common/osc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"osc.d.ts","sourceRoot":"","sources":["../../src/common/osc.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,oBAAY,WAAW,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAA;AACtD,oBAAY,eAAe,GACxB;IAAE,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAClC;IAAE,IAAI,EAAE,GAAG,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,GAC5B;IAAE,IAAI,EAAE,GAAG,CAAC;IAAC,KAAK,EAAE,UAAU,CAAA;CAAE,CAAA;AACnC,oBAAY,gBAAgB,GAAG,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC,GAAG,eAAe,GAAG,KAAK,CAAC,eAAe,CAAC,CAAA"}

package/dist/common/osc.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * Warning: these types are used in various stable apis.
+ * BE VERY CAREFUL WHEN MAKING CHANGES
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=osc.js.map

package/dist/common/osc.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"osc.js","sourceRoot":"","sources":["../../src/common/osc.ts"],"names":[],"mappings":";AAAA;;;GAGG"}

package/dist/entrypoint.d.ts

@@ -0,0 +1,12 @@
+import { CompanionStaticUpgradeScript } from './module-api/upgrade.js';
+import { InstanceBase } from './module-api/base.js';
+import '@sentry/tracing';
+export declare type InstanceConstructor<TConfig> = new (internal: unknown) => InstanceBase<TConfig>;
+/**
+ * Setup the module for execution
+ * This should be called once per-module, to register the class that should be executed
+ * @param factory The class for the module
+ * @param upgradeScripts Upgrade scripts
+ */
+export declare function runEntrypoint<TConfig>(factory: InstanceConstructor<TConfig>, upgradeScripts: CompanionStaticUpgradeScript<TConfig>[]): void;
+//# sourceMappingURL=entrypoint.d.ts.map

package/dist/entrypoint.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entrypoint.d.ts","sourceRoot":"","sources":["../src/entrypoint.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAA;AACtE,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAA;AAInD,OAAO,iBAAiB,CAAA;AAIxB,oBAAY,mBAAmB,CAAC,OAAO,IAAI,KAAK,QAAQ,EAAE,OAAO,KAAK,YAAY,CAAC,OAAO,CAAC,CAAA;AAe3F;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,OAAO,EACpC,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC,EACrC,cAAc,EAAE,4BAA4B,CAAC,OAAO,CAAC,EAAE,GACrD,IAAI,CAiHN"}

package/dist/entrypoint.js

@@ -0,0 +1,131 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runEntrypoint = void 0;
+const tslib_1 = require("tslib");
+const SocketIOClient = tslib_1.__importStar(require("socket.io-client"));
+const p_timeout_1 = tslib_1.__importDefault(require("p-timeout"));
+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 node_1 = require("@sentry/node");
+require("@sentry/tracing");
+let hasEntrypoint = false;
+// 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
+ * @param factory The class for the module
+ * @param upgradeScripts Upgrade scripts
+ */
+function runEntrypoint(factory, upgradeScripts) {
+    Promise.resolve().then(async () => {
+        try {
+            const pkgJsonStr = (await promises_1.default.readFile('../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;
+            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.HostApiSocketIo)
+                throw new Error(`Module manifest 'api' mismatch`);
+            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 socketIoUrl = process.env.SOCKETIO_URL;
+            if (typeof socketIoUrl !== 'string' || !socketIoUrl)
+                throw new Error('Module initialise is missing SOCKETIO_URL');
+            const socketIoToken = process.env.SOCKETIO_TOKEN;
+            if (typeof socketIoToken !== 'string' || !socketIoToken)
+                throw new Error('Module initialise is missing SOCKETIO_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');
+                (0, node_1.init)({
+                    dsn: sentryDsn,
+                    release: `${pkgJson.name}@${pkgJson.version}`,
+                    beforeSend(event) {
+                        if (event.exception) {
+                            console.log('sentry', 'error', event.exception);
+                        }
+                        return event;
+                    },
+                });
+                (0, node_1.configureScope)((scope) => {
+                    scope.setUser({ id: sentryUserId });
+                    scope.setTag('companion', sentryCompanionVersion);
+                });
+            }
+            else {
+                console.log('Sentry disabled');
+            }
+            let module;
+            const socket = SocketIOClient.io(socketIoUrl, {
+                reconnection: false,
+                timeout: 5000,
+                transports: ['websocket'],
+            });
+            socket.on('connect', () => {
+                console.log(`Connected to module-host: ${socket.id}`);
+                socket.emit('register', pkgJson.version, connectionId, socketIoToken, () => {
+                    console.log(`Module-host accepted registration`);
+                    module = new factory((0, util_js_1.literal)({
+                        id: connectionId,
+                        socket,
+                        upgradeScripts,
+                    }));
+                });
+            });
+            socket.on('connect_error', (e) => {
+                console.log(`connection failed to module-host: ${socket.id}`, e.toString());
+                process.exit(12);
+            });
+            socket.on('disconnect', async () => {
+                console.log(`Disconnected from module-host: ${socket.id}`);
+                if (module) {
+                    // Try and de-init the module before killing it
+                    try {
+                        const p = module.destroy();
+                        if (p)
+                            await (0, p_timeout_1.default)(p, 5000);
+                    }
+                    catch (e) {
+                        // Ignore
+                    }
+                }
+                // Kill the process
+                process.exit(11);
+            });
+        }
+        catch (e) {
+            console.error(`Failed to startup module:`);
+            console.error(e.stack || e.message);
+            process.exit(1);
+        }
+    });
+}
+exports.runEntrypoint = runEntrypoint;
+//# sourceMappingURL=entrypoint.js.map

package/dist/entrypoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entrypoint.js","sourceRoot":"","sources":["../src/entrypoint.ts"],"names":[],"mappings":";;;;AAAA,yEAAkD;AAClD,kEAAgC;AAChC,wDAAwG;AACxG,mEAA4B;AAI5B,uCAAmC;AAEnC,uCAAmD;AACnD,2BAAwB;AAExB,IAAI,aAAa,GAAG,KAAK,CAAA;AAIzB,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,OAAqC,EACrC,cAAuD;IAEvD,OAAO,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,KAAK,IAAI,EAAE;QACjC,IAAI;YACH,MAAM,UAAU,GAAG,CAAC,MAAM,kBAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAA;YACpE,MAAM,OAAO,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAA;YACtC,IAAI,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,KAAK,wBAAwB;gBACxD,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAA;YAC9E,IAAI,CAAC,OAAO,CAAC,OAAO;gBAAE,MAAM,IAAI,KAAK,CAAC,sEAAsE,CAAC,CAAA;YAE7G,qCAAqC;YACrC,IAAI,aAAa;gBAAE,MAAM,IAAI,KAAK,CAAC,uCAAuC,CAAC,CAAA;YAC3E,aAAa,GAAG,IAAI,CAAA;YAEpB,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,eAAe,CAAA;YAChD,IAAI,CAAC,YAAY;gBAAE,MAAM,IAAI,KAAK,CAAC,8CAA8C,CAAC,CAAA;YAElF,8CAA8C;YAC9C,MAAM,YAAY,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAA;YACpD,MAAM,YAAY,GAA4B,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAA;YAEjF,IAAI,YAAY,CAAC,OAAO,EAAE,GAAG,KAAK,6BAAe;gBAAE,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAA;YAEpG,OAAO,CAAC,GAAG,CAAC,6BAA6B,OAAO,CAAC,IAAI,EAAE,CAAC,CAAA;YAExD,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAA;YAC9C,IAAI,OAAO,YAAY,KAAK,QAAQ,IAAI,CAAC,YAAY;gBACpD,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;YAE9D,MAAM,WAAW,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAA;YAC5C,IAAI,OAAO,WAAW,KAAK,QAAQ,IAAI,CAAC,WAAW;gBAAE,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAA;YAEjH,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,CAAC,cAAc,CAAA;YAChD,IAAI,OAAO,aAAa,KAAK,QAAQ,IAAI,CAAC,aAAa;gBACtD,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;YAE/D,kDAAkD;YAClD,MAAM,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,UAAU,CAAA;YACxC,MAAM,YAAY,GAAG,OAAO,CAAC,GAAG,CAAC,aAAa,CAAA;YAC9C,MAAM,sBAAsB,GAAG,OAAO,CAAC,GAAG,CAAC,wBAAwB,CAAA;YACnE,IAAI,SAAS,IAAI,YAAY,IAAI,SAAS,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,UAAU,EAAE;gBACzE,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,CAAA;gBAE7B,IAAA,WAAI,EAAC;oBACJ,GAAG,EAAE,SAAS;oBACd,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,OAAO,EAAE;oBAC7C,UAAU,CAAC,KAAK;wBACf,IAAI,KAAK,CAAC,SAAS,EAAE;4BACpB,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,CAAA;yBAC/C;wBACD,OAAO,KAAK,CAAA;oBACb,CAAC;iBACD,CAAC,CAAA;gBAEF,IAAA,qBAAc,EAAC,CAAC,KAAK,EAAE,EAAE;oBACxB,KAAK,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,YAAY,EAAE,CAAC,CAAA;oBACnC,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,sBAAsB,CAAC,CAAA;gBAClD,CAAC,CAAC,CAAA;aACF;iBAAM;gBACN,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;aAC9B;YAED,IAAI,MAAqC,CAAA;YAEzC,MAAM,MAAM,GAA0E,cAAc,CAAC,EAAE,CACtG,WAAW,EACX;gBACC,YAAY,EAAE,KAAK;gBACnB,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,CAAC,WAAW,CAAC;aACzB,CACD,CAAA;YACD,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;gBACzB,OAAO,CAAC,GAAG,CAAC,6BAA6B,MAAM,CAAC,EAAE,EAAE,CAAC,CAAA;gBAErD,MAAM,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,OAAO,EAAE,YAAY,EAAE,aAAa,EAAE,GAAG,EAAE;oBAC1E,OAAO,CAAC,GAAG,CAAC,mCAAmC,CAAC,CAAA;oBAEhD,MAAM,GAAG,IAAI,OAAO,CACnB,IAAA,iBAAO,EAA6B;wBACnC,EAAE,EAAE,YAAY;wBAChB,MAAM;wBACN,cAAc;qBACd,CAAC,CACF,CAAA;gBACF,CAAC,CAAC,CAAA;YACH,CAAC,CAAC,CAAA;YACF,MAAM,CAAC,EAAE,CAAC,eAAe,EAAE,CAAC,CAAM,EAAE,EAAE;gBACrC,OAAO,CAAC,GAAG,CAAC,qCAAqC,MAAM,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;gBAE3E,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACjB,CAAC,CAAC,CAAA;YACF,MAAM,CAAC,EAAE,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE;gBAClC,OAAO,CAAC,GAAG,CAAC,kCAAkC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAA;gBAE1D,IAAI,MAAM,EAAE;oBACX,+CAA+C;oBAC/C,IAAI;wBACH,MAAM,CAAC,GAAG,MAAM,CAAC,OAAO,EAAE,CAAA;wBAC1B,IAAI,CAAC;4BAAE,MAAM,IAAA,mBAAQ,EAAC,CAAC,EAAE,IAAI,CAAC,CAAA;qBAC9B;oBAAC,OAAO,CAAC,EAAE;wBACX,SAAS;qBACT;iBACD;gBAED,mBAAmB;gBACnB,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAA;YACjB,CAAC,CAAC,CAAA;SACF;QAAC,OAAO,CAAM,EAAE;YAChB,OAAO,CAAC,KAAK,CAAC,2BAA2B,CAAC,CAAA;YAC1C,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC,OAAO,CAAC,CAAA;YACnC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;SACf;IACF,CAAC,CAAC,CAAA;AACH,CAAC;AApHD,sCAoHC"}

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

@@ -0,0 +1,212 @@
+/**
+ * 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 { CompanionFeedbackButtonStyleResult } from '../module-api/feedback.js';
+import { OSCSomeArguments } from '../common/osc.js';
+import { SomeCompanionConfigField } from '../module-api/config.js';
+import { LogLevel, InstanceStatus } from '../module-api/enums.js';
+import { SomeCompanionInputField, InputValue, CompanionOptionValues } from '../module-api/input.js';
+import { SomeCompanionPresetDefinition } from '../module-api/preset.js';
+import { CompanionHTTPRequest, CompanionHTTPResponse } from '../module-api/http.js';
+export interface ModuleToHostEventsV0 {
+    'log-message': (msg: LogMessageMessage) => void;
+    'set-status': (msg: SetStatusMessage) => void;
+    setActionDefinitions: (msg: SetActionDefinitionsMessage) => void;
+    setFeedbackDefinitions: (msg: SetFeedbackDefinitionsMessage) => void;
+    setVariableDefinitions: (msg: SetVariableDefinitionsMessage) => void;
+    setPresetDefinitions: (msg: SetPresetDefinitionsMessage) => void;
+    setVariableValues: (msg: SetVariableValuesMessage) => void;
+    updateFeedbackValues: (msg: UpdateFeedbackValuesMessage) => void;
+    saveConfig: (msg: SaveConfigMessage) => void;
+    'send-osc': (msg: SendOscMessage) => void;
+    parseVariablesInString: (msg: ParseVariablesInStringMessage) => ParseVariablesInStringResponseMessage;
+    upgradedItems: (msg: UpgradedDataResponseMessage) => void;
+}
+export interface HostToModuleEventsV0 {
+    init: (msg: InitMessage) => InitResponseMessage;
+    destroy: (msg: Record<string, never>) => void;
+    updateConfig: (config: unknown) => void;
+    updateFeedbacks: (msg: UpdateFeedbackInstancesMessage) => void;
+    updateActions: (msg: UpdateActionInstancesMessage) => void;
+    executeAction: (msg: ExecuteActionMessage) => void;
+    getConfigFields: (msg: GetConfigFieldsMessage) => GetConfigFieldsResponseMessage;
+    handleHttpRequest: (msg: HandleHttpRequestMessage) => HandleHttpRequestResponseMessage;
+    learnAction: (msg: LearnActionMessage) => LearnActionResponseMessage;
+    learnFeedback: (msg: LearnFeedbackMessage) => LearnFeedbackResponseMessage;
+}
+export declare type EncodeIsVisible<T extends SomeCompanionInputField> = Omit<T, 'isVisible'> & {
+    isVisibleFn?: string;
+};
+export interface InitMessage {
+    label: string;
+    config: unknown;
+    lastUpgradeIndex: number;
+    feedbacks: {
+        [id: string]: FeedbackInstance | undefined;
+    };
+    actions: {
+        [id: string]: ActionInstance | undefined;
+    };
+}
+export interface InitResponseMessage {
+    hasHttpHandler: boolean;
+    newUpgradeIndex: number;
+    updatedConfig: unknown | undefined;
+}
+export interface UpgradedDataResponseMessage {
+    updatedFeedbacks: {
+        [id: string]: (FeedbackInstanceBase & {
+            style?: Partial<CompanionFeedbackButtonStyleResult>;
+        }) | undefined;
+    };
+    updatedActions: {
+        [id: string]: ActionInstanceBase | undefined;
+    };
+}
+export declare type GetConfigFieldsMessage = Record<string, never>;
+export declare 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 declare type SomeEncodedCompanionInputField = EncodeIsVisible<SomeCompanionInputField>;
+export interface SetActionDefinitionsMessage {
+    actions: Array<{
+        id: string;
+        name: string;
+        description?: string;
+        options: SomeEncodedCompanionInputField[];
+        hasLearn: boolean;
+    }>;
+}
+export interface SetFeedbackDefinitionsMessage {
+    feedbacks: Array<{
+        id: string;
+        name: string;
+        description?: string;
+        options: SomeEncodedCompanionInputField[];
+        type: 'boolean' | 'advanced';
+        defaultStyle?: Partial<CompanionFeedbackButtonStyleResult>;
+        hasLearn: boolean;
+    }>;
+}
+export interface SetVariableDefinitionsMessage {
+    variables: Array<{
+        id: string;
+        name: string;
+    }>;
+}
+export interface SetPresetDefinitionsMessage {
+    presets: Array<SomeCompanionPresetDefinition & {
+        id: string;
+    }>;
+}
+export interface SetVariableValuesMessage {
+    newValues: Array<{
+        id: string;
+        value: string | number | boolean | undefined;
+    }>;
+}
+export interface ExecuteActionMessage {
+    action: ActionInstance;
+    /** @deprecated */
+    deviceId: string | undefined;
+}
+export interface UpdateFeedbackValuesMessage {
+    values: Array<{
+        id: string;
+        controlId: string;
+        value: boolean | Partial<CompanionFeedbackButtonStyleResult> | undefined;
+    }>;
+}
+export interface FeedbackInstanceBase {
+    id: string;
+    upgradeIndex: number | null;
+    feedbackId: string;
+    options: {
+        [key: string]: InputValue | undefined;
+    };
+}
+export interface FeedbackInstance extends FeedbackInstanceBase {
+    controlId: string;
+    /** If control supports an imageBuffer, the dimensions the buffer must be */
+    image?: {
+        width: number;
+        height: number;
+    };
+    /** @deprecated */
+    page: number;
+    /** @deprecated */
+    bank: number;
+    /** @deprecated */
+    rawBank: any;
+}
+export interface UpdateFeedbackInstancesMessage {
+    feedbacks: {
+        [id: string]: FeedbackInstance | null | undefined;
+    };
+}
+export interface ActionInstanceBase {
+    id: string;
+    upgradeIndex: number | null;
+    actionId: string;
+    options: {
+        [key: string]: InputValue | undefined;
+    };
+}
+export interface ActionInstance extends ActionInstanceBase {
+    controlId: string;
+    /** @deprecated */
+    page: number;
+    /** @deprecated */
+    bank: number;
+}
+export interface UpdateActionInstancesMessage {
+    actions: {
+        [id: string]: ActionInstance | null | undefined;
+    };
+}
+export interface SaveConfigMessage {
+    config: unknown;
+}
+export interface SendOscMessage {
+    host: string;
+    port: number;
+    path: string;
+    args: OSCSomeArguments;
+}
+export interface ParseVariablesInStringMessage {
+    text: string;
+}
+export interface ParseVariablesInStringResponseMessage {
+    text: string;
+}
+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;
+}
+//# sourceMappingURL=api.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/host-api/api.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,kCAAkC,EAAE,MAAM,2BAA2B,CAAA;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAA;AAClE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AACjE,OAAO,EAAE,uBAAuB,EAAE,UAAU,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAA;AACnG,OAAO,EAAE,6BAA6B,EAAE,MAAM,yBAAyB,CAAA;AACvE,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,uBAAuB,CAAA;AAEnF,MAAM,WAAW,oBAAoB;IACpC,aAAa,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,IAAI,CAAA;IAC/C,YAAY,EAAE,CAAC,GAAG,EAAE,gBAAgB,KAAK,IAAI,CAAA;IAC7C,oBAAoB,EAAE,CAAC,GAAG,EAAE,2BAA2B,KAAK,IAAI,CAAA;IAChE,sBAAsB,EAAE,CAAC,GAAG,EAAE,6BAA6B,KAAK,IAAI,CAAA;IACpE,sBAAsB,EAAE,CAAC,GAAG,EAAE,6BAA6B,KAAK,IAAI,CAAA;IACpE,oBAAoB,EAAE,CAAC,GAAG,EAAE,2BAA2B,KAAK,IAAI,CAAA;IAChE,iBAAiB,EAAE,CAAC,GAAG,EAAE,wBAAwB,KAAK,IAAI,CAAA;IAC1D,oBAAoB,EAAE,CAAC,GAAG,EAAE,2BAA2B,KAAK,IAAI,CAAA;IAChE,UAAU,EAAE,CAAC,GAAG,EAAE,iBAAiB,KAAK,IAAI,CAAA;IAC5C,UAAU,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,IAAI,CAAA;IACzC,sBAAsB,EAAE,CAAC,GAAG,EAAE,6BAA6B,KAAK,qCAAqC,CAAA;IACrG,aAAa,EAAE,CAAC,GAAG,EAAE,2BAA2B,KAAK,IAAI,CAAA;CACzD;AAED,MAAM,WAAW,oBAAoB;IACpC,IAAI,EAAE,CAAC,GAAG,EAAE,WAAW,KAAK,mBAAmB,CAAA;IAC/C,OAAO,EAAE,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,KAAK,IAAI,CAAA;IAC7C,YAAY,EAAE,CAAC,MAAM,EAAE,OAAO,KAAK,IAAI,CAAA;IACvC,eAAe,EAAE,CAAC,GAAG,EAAE,8BAA8B,KAAK,IAAI,CAAA;IAC9D,aAAa,EAAE,CAAC,GAAG,EAAE,4BAA4B,KAAK,IAAI,CAAA;IAC1D,aAAa,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,IAAI,CAAA;IAClD,eAAe,EAAE,CAAC,GAAG,EAAE,sBAAsB,KAAK,8BAA8B,CAAA;IAChF,iBAAiB,EAAE,CAAC,GAAG,EAAE,wBAAwB,KAAK,gCAAgC,CAAA;IACtF,WAAW,EAAE,CAAC,GAAG,EAAE,kBAAkB,KAAK,0BAA0B,CAAA;IACpE,aAAa,EAAE,CAAC,GAAG,EAAE,oBAAoB,KAAK,4BAA4B,CAAA;CAC1E;AAED,oBAAY,eAAe,CAAC,CAAC,SAAS,uBAAuB,IAAI,IAAI,CAAC,CAAC,EAAE,WAAW,CAAC,GAAG;IACvF,WAAW,CAAC,EAAE,MAAM,CAAA;CACpB,CAAA;AAED,MAAM,WAAW,WAAW;IAC3B,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,OAAO,CAAA;IAEf,gBAAgB,EAAE,MAAM,CAAA;IAExB,SAAS,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,CAAA;KAAE,CAAA;IACzD,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,CAAA;KAAE,CAAA;CACrD;AACD,MAAM,WAAW,mBAAmB;IACnC,cAAc,EAAE,OAAO,CAAA;IACvB,eAAe,EAAE,MAAM,CAAA;IAEvB,aAAa,EAAE,OAAO,GAAG,SAAS,CAAA;CAClC;AAED,MAAM,WAAW,2BAA2B;IAC3C,gBAAgB,EAAE;QACjB,CAAC,EAAE,EAAE,MAAM,GAAG,CAAC,oBAAoB,GAAG;YAAE,KAAK,CAAC,EAAE,OAAO,CAAC,kCAAkC,CAAC,CAAA;SAAE,CAAC,GAAG,SAAS,CAAA;KAC1G,CAAA;IACD,cAAc,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,kBAAkB,GAAG,SAAS,CAAA;KAAE,CAAA;CAChE;AAED,oBAAY,sBAAsB,GAAG,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;AAC1D,oBAAY,+BAA+B,GAAG,eAAe,CAAC,wBAAwB,CAAC,CAAA;AACvF,MAAM,WAAW,8BAA8B;IAC9C,MAAM,EAAE,+BAA+B,EAAE,CAAA;CACzC;AACD,MAAM,WAAW,iBAAiB;IACjC,KAAK,EAAE,QAAQ,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,gBAAgB;IAChC,MAAM,EAAE,cAAc,CAAA;IACtB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;CACtB;AAED,oBAAY,8BAA8B,GAAG,eAAe,CAAC,uBAAuB,CAAC,CAAA;AAErF,MAAM,WAAW,2BAA2B;IAC3C,OAAO,EAAE,KAAK,CAAC;QACd,EAAE,EAAE,MAAM,CAAA;QACV,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,OAAO,EAAE,8BAA8B,EAAE,CAAA;QACzC,QAAQ,EAAE,OAAO,CAAA;KACjB,CAAC,CAAA;CACF;AAED,MAAM,WAAW,6BAA6B;IAC7C,SAAS,EAAE,KAAK,CAAC;QAChB,EAAE,EAAE,MAAM,CAAA;QACV,IAAI,EAAE,MAAM,CAAA;QACZ,WAAW,CAAC,EAAE,MAAM,CAAA;QACpB,OAAO,EAAE,8BAA8B,EAAE,CAAA;QACzC,IAAI,EAAE,SAAS,GAAG,UAAU,CAAA;QAC5B,YAAY,CAAC,EAAE,OAAO,CAAC,kCAAkC,CAAC,CAAA;QAC1D,QAAQ,EAAE,OAAO,CAAA;KACjB,CAAC,CAAA;CACF;AAED,MAAM,WAAW,6BAA6B;IAC7C,SAAS,EAAE,KAAK,CAAC;QAChB,EAAE,EAAE,MAAM,CAAA;QACV,IAAI,EAAE,MAAM,CAAA;KACZ,CAAC,CAAA;CACF;AAED,MAAM,WAAW,2BAA2B;IAC3C,OAAO,EAAE,KAAK,CACb,6BAA6B,GAAG;QAC/B,EAAE,EAAE,MAAM,CAAA;KASV,CACD,CAAA;CACD;AAED,MAAM,WAAW,wBAAwB;IACxC,SAAS,EAAE,KAAK,CAAC;QAChB,EAAE,EAAE,MAAM,CAAA;QACV,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,CAAA;KAC5C,CAAC,CAAA;CACF;AAED,MAAM,WAAW,oBAAoB;IACpC,MAAM,EAAE,cAAc,CAAA;IAEtB,kBAAkB;IAClB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAA;CAC5B;AAED,MAAM,WAAW,2BAA2B;IAC3C,MAAM,EAAE,KAAK,CAAC;QACb,EAAE,EAAE,MAAM,CAAA;QACV,SAAS,EAAE,MAAM,CAAA;QACjB,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,kCAAkC,CAAC,GAAG,SAAS,CAAA;KACxE,CAAC,CAAA;CACF;AAED,MAAM,WAAW,oBAAoB;IACpC,EAAE,EAAE,MAAM,CAAA;IAGV,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B,UAAU,EAAE,MAAM,CAAA;IAClB,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA;KAAE,CAAA;CAClD;AAED,MAAM,WAAW,gBAAiB,SAAQ,oBAAoB;IAC7D,SAAS,EAAE,MAAM,CAAA;IAEjB,4EAA4E;IAC5E,KAAK,CAAC,EAAE;QACP,KAAK,EAAE,MAAM,CAAA;QACb,MAAM,EAAE,MAAM,CAAA;KACd,CAAA;IAED,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAA;IAEZ,kBAAkB;IAClB,OAAO,EAAE,GAAG,CAAA;CACZ;AAED,MAAM,WAAW,8BAA8B;IAC9C,SAAS,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,gBAAgB,GAAG,IAAI,GAAG,SAAS,CAAA;KAAE,CAAA;CAChE;AAED,MAAM,WAAW,kBAAkB;IAClC,EAAE,EAAE,MAAM,CAAA;IAGV,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAE3B,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA;KAAE,CAAA;CAClD;AACD,MAAM,WAAW,cAAe,SAAQ,kBAAkB;IACzD,SAAS,EAAE,MAAM,CAAA;IAEjB,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAA;IACZ,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,4BAA4B;IAC5C,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,IAAI,GAAG,SAAS,CAAA;KAAE,CAAA;CAC5D;AAED,MAAM,WAAW,iBAAiB;IACjC,MAAM,EAAE,OAAO,CAAA;CACf;AAED,MAAM,WAAW,cAAc;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,gBAAgB,CAAA;CACtB;AAED,MAAM,WAAW,6BAA6B;IAC7C,IAAI,EAAE,MAAM,CAAA;CACZ;AACD,MAAM,WAAW,qCAAqC;IACrD,IAAI,EAAE,MAAM,CAAA;CACZ;AAED,MAAM,WAAW,wBAAwB;IACxC,OAAO,EAAE,oBAAoB,CAAA;CAC7B;AACD,MAAM,WAAW,gCAAgC;IAChD,QAAQ,EAAE,qBAAqB,CAAA;CAC/B;AAED,MAAM,WAAW,kBAAkB;IAClC,MAAM,EAAE,cAAc,CAAA;CACtB;AACD,MAAM,WAAW,0BAA0B;IAC1C,OAAO,EAAE,qBAAqB,GAAG,SAAS,CAAA;CAC1C;AAED,MAAM,WAAW,oBAAoB;IACpC,QAAQ,EAAE,gBAAgB,CAAA;CAC1B;AACD,MAAM,WAAW,4BAA4B;IAC5C,OAAO,EAAE,qBAAqB,GAAG,SAAS,CAAA;CAC1C"}

package/dist/host-api/api.js

@@ -0,0 +1,9 @@
+"use strict";
+/**
+ * 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
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"api.js","sourceRoot":"","sources":["../../src/host-api/api.ts"],"names":[],"mappings":";AAAA;;;;;GAKG"}

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

@@ -0,0 +1,7 @@
+export declare const HostApiSocketIo = "socket.io";
+export declare type ResultCallback<T> = (err: any, res: T) => void;
+export interface ModuleToHostEventsInit {
+    register: (apiVersion: string, connectionId: string, socketIoToken: string, cb: () => void) => void;
+}
+export declare type HostToModuleEventsInit = Record<never, never>;
+//# sourceMappingURL=versions.d.ts.map

package/dist/host-api/versions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"versions.d.ts","sourceRoot":"","sources":["../../src/host-api/versions.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,eAAe,cAAc,CAAA;AAE1C,oBAAY,cAAc,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,KAAK,IAAI,CAAA;AAE1D,MAAM,WAAW,sBAAsB;IACtC,QAAQ,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,IAAI,KAAK,IAAI,CAAA;CACnG;AACD,oBAAY,sBAAsB,GAAG,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,CAAA"}

package/dist/host-api/versions.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HostApiSocketIo = void 0;
+exports.HostApiSocketIo = 'socket.io';
+//# sourceMappingURL=versions.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"versions.js","sourceRoot":"","sources":["../../src/host-api/versions.ts"],"names":[],"mappings":";;;AAAa,QAAA,eAAe,GAAG,WAAW,CAAA"}

package/dist/index.d.ts

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

package/dist/index.d.ts.map

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

package/dist/index.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runEntrypoint = exports.assertNever = exports.splitRgb = exports.combineRgb = exports.literal = void 0;
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./manifest.js"), exports);
+tslib_1.__exportStar(require("./module-api/index.js"), exports);
+tslib_1.__exportStar(require("./common/osc.js"), exports);
+var util_js_1 = require("./util.js");
+Object.defineProperty(exports, "literal", { enumerable: true, get: function () { return util_js_1.literal; } });
+Object.defineProperty(exports, "combineRgb", { enumerable: true, get: function () { return util_js_1.combineRgb; } });
+Object.defineProperty(exports, "splitRgb", { enumerable: true, get: function () { return util_js_1.splitRgb; } });
+Object.defineProperty(exports, "assertNever", { enumerable: true, get: function () { return util_js_1.assertNever; } });
+var entrypoint_js_1 = require("./entrypoint.js");
+Object.defineProperty(exports, "runEntrypoint", { enumerable: true, get: function () { return entrypoint_js_1.runEntrypoint; } });
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

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

package/dist/instance-base.d.ts

@@ -0,0 +1,12 @@
+export interface InstanceBaseShared<TConfig> {
+    /**
+     * Main initialization function called once the module
+     * is OK to start doing things.
+     */
+    init(config: TConfig): void | Promise<void>;
+    /**
+     * Clean up the instance before it is destroyed.
+     */
+    destroy(): void | Promise<void>;
+}
+//# sourceMappingURL=instance-base.d.ts.map

package/dist/instance-base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"instance-base.d.ts","sourceRoot":"","sources":["../src/instance-base.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,kBAAkB,CAAC,OAAO;IAC1C;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,OAAO,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE3C;;OAEG;IACH,OAAO,IAAI,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC/B"}

package/dist/instance-base.js

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

package/dist/instance-base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"instance-base.js","sourceRoot":"","sources":["../src/instance-base.ts"],"names":[],"mappings":""}

package/dist/internal/base.d.ts

@@ -0,0 +1,24 @@
+import * as SocketIOClient from 'socket.io-client';
+import { CompanionStaticUpgradeScript } from '../module-api/upgrade';
+import { EncodeIsVisible } from '../host-api/api.js';
+import { SomeCompanionInputField } from '../module-api/input';
+/**
+ * Signature for the handler functions
+ */
+declare type HandlerFunction<T extends (...args: any) => any> = (data: Parameters<T>[0]) => Promise<ReturnType<T>>;
+declare type HandlerFunctionOrNever<T> = T extends (...args: any) => any ? HandlerFunction<T> : never;
+/** Map of handler functions */
+export declare type EventHandlers<T extends object> = {
+    [K in keyof T]: HandlerFunctionOrNever<T[K]>;
+};
+/** Subscribe to all the events defined in the handlers, and wrap with safety and logging */
+export declare function listenToEvents<T extends object>(socket: SocketIOClient.Socket<T>, handlers: EventHandlers<T>): void;
+export declare function serializeIsVisibleFn<T extends SomeCompanionInputField>(options: T[]): EncodeIsVisible<T>[];
+export interface InstanceBaseProps<TConfig> {
+    id: string;
+    socket: SocketIOClient.Socket;
+    upgradeScripts: CompanionStaticUpgradeScript<TConfig>[];
+}
+export declare function isInstanceBaseProps<TConfig>(obj: unknown): obj is InstanceBaseProps<TConfig>;
+export {};
+//# sourceMappingURL=base.d.ts.map

package/dist/internal/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/internal/base.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,cAAc,MAAM,kBAAkB,CAAA;AAClD,OAAO,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAA;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAEpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,qBAAqB,CAAA;AAE7D;;GAEG;AACH,aAAK,eAAe,CAAC,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAA;AAE1G,aAAK,sBAAsB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,EAAE,GAAG,KAAK,GAAG,GAAG,eAAe,CAAC,CAAC,CAAC,GAAG,KAAK,CAAA;AAE7F,+BAA+B;AAC/B,oBAAY,aAAa,CAAC,CAAC,SAAS,MAAM,IAAI;KAC5C,CAAC,IAAI,MAAM,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC5C,CAAA;AAED,4FAA4F;AAC5F,wBAAgB,cAAc,CAAC,CAAC,SAAS,MAAM,EAAE,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,IAAI,CA0BnH;AAED,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,uBAAuB,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC,EAAE,CAkB1G;AAED,MAAM,WAAW,iBAAiB,CAAC,OAAO;IACzC,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,cAAc,CAAC,MAAM,CAAA;IAC7B,cAAc,EAAE,4BAA4B,CAAC,OAAO,CAAC,EAAE,CAAA;CACvD;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,iBAAiB,CAAC,OAAO,CAAC,CAG5F"}

package/dist/internal/base.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isInstanceBaseProps = exports.serializeIsVisibleFn = exports.listenToEvents = void 0;
+/** Subscribe to all the events defined in the handlers, and wrap with safety and logging */
+function listenToEvents(socket, handlers) {
+    // const logger = createChildLogger(`module/${connectionId}`);
+    for (const [event, handler] of Object.entries(handlers)) {
+        socket.on(event, async (msg, cb) => {
+            if (!msg || typeof msg !== 'object') {
+                console.warn(`Received malformed message object "${event}"`);
+                return; // Ignore messages without correct structure
+            }
+            if (cb && typeof cb !== 'function') {
+                console.warn(`Received malformed callback "${event}"`);
+                return; // Ignore messages without correct structure
+            }
+            try {
+                // Run it
+                const handler2 = handler;
+                const result = await handler2(msg);
+                if (cb)
+                    cb(null, result);
+            }
+            catch (e) {
+                console.error(`Command failed: ${e}`, e.stack);
+                if (cb)
+                    cb(e?.toString() ?? JSON.stringify(e), undefined);
+            }
+        });
+    }
+}
+exports.listenToEvents = listenToEvents;
+function serializeIsVisibleFn(options) {
+    return options.map((option) => {
+        if ('isVisible' in option) {
+            if (typeof option.isVisible === 'function') {
+                return {
+                    ...option,
+                    isVisibleFn: option.isVisible.toString(),
+                    isVisible: undefined,
+                };
+            }
+        }
+        // ignore any existing `isVisibleFn` to avoid code injection
+        return {
+            ...option,
+            isVisibleFn: undefined,
+        };
+    });
+}
+exports.serializeIsVisibleFn = serializeIsVisibleFn;
+function isInstanceBaseProps(obj) {
+    const obj2 = obj;
+    return typeof obj2 === 'object' && typeof obj2.id === 'string' && typeof obj2.socket === 'object';
+}
+exports.isInstanceBaseProps = isInstanceBaseProps;
+//# sourceMappingURL=base.js.map