@companion-module/base 1.13.3 → 1.13.4

package/dist/index.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runEntrypoint = exports.substituteEscapeCharacters = exports.parseEscapeCharacters = exports.assertNever = exports.splitHex = exports.splitHsv = exports.splitHsl = 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);
+tslib_1.__exportStar(require("./common/json-value.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, "splitHsl", { enumerable: true, get: function () { return util_js_1.splitHsl; } });
+Object.defineProperty(exports, "splitHsv", { enumerable: true, get: function () { return util_js_1.splitHsv; } });
+Object.defineProperty(exports, "splitHex", { enumerable: true, get: function () { return util_js_1.splitHex; } });
+Object.defineProperty(exports, "assertNever", { enumerable: true, get: function () { return util_js_1.assertNever; } });
+Object.defineProperty(exports, "parseEscapeCharacters", { enumerable: true, get: function () { return util_js_1.parseEscapeCharacters; } });
+Object.defineProperty(exports, "substituteEscapeCharacters", { enumerable: true, get: function () { return util_js_1.substituteEscapeCharacters; } });
+tslib_1.__exportStar(require("./helpers/index.js"), exports);
+var entrypoint_js_1 = require("./entrypoint.js");
+Object.defineProperty(exports, "runEntrypoint", { enumerable: true, get: function () { return entrypoint_js_1.runEntrypoint; } });
+//# sourceMappingURL=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,iEAAsC;AACtC,qCAWkB;AAVjB,kGAAA,OAAO,OAAA;AACP,qGAAA,UAAU,OAAA;AACV,mGAAA,QAAQ,OAAA;AACR,mGAAA,QAAQ,OAAA;AACR,mGAAA,QAAQ,OAAA;AACR,mGAAA,QAAQ,OAAA;AAER,sGAAA,WAAW,OAAA;AACX,gHAAA,qBAAqB,OAAA;AACrB,qHAAA,0BAA0B,OAAA;AAE3B,6DAAkC;AAElC,iDAA+C;AAAtC,8GAAA,aAAa,OAAA"}

package/dist/instance-base.d.ts

@@ -0,0 +1,12 @@
+export interface InstanceBaseShared<TConfig, TSecrets = undefined> {
+    /**
+     * Main initialization function called
+     * once the module is OK to start doing things.
+     */
+    init(config: TConfig, isFirstInit: boolean, secrets: TSecrets): 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,EAAE,QAAQ,GAAG,SAAS;IAChE;;;OAGG;IACH,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,OAAO,EAAE,QAAQ,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEpF;;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/actions.d.ts

@@ -0,0 +1,16 @@
+import type { LogLevel } from '../module-api/enums.js';
+import type { ParseVariablesInStringMessage, ParseVariablesInStringResponseMessage, SetActionDefinitionsMessage, ActionInstance, ExecuteActionMessage, LearnActionMessage, LearnActionResponseMessage, SetCustomVariableMessage } from '../host-api/api.js';
+import type { CompanionActionDefinitions } from '../module-api/action.js';
+export declare class ActionManager {
+    #private;
+    constructor(parseVariablesInString: (msg: ParseVariablesInStringMessage) => Promise<ParseVariablesInStringResponseMessage>, setActionDefinitions: (msg: SetActionDefinitionsMessage) => void, setCustomVariableValue: (msg: SetCustomVariableMessage) => void, log: (level: LogLevel, message: string) => void);
+    handleExecuteAction(msg: ExecuteActionMessage): Promise<void>;
+    handleUpdateActions(actions: {
+        [id: string]: ActionInstance | null | undefined;
+    }): void;
+    handleLearnAction(msg: LearnActionMessage): Promise<LearnActionResponseMessage>;
+    setActionDefinitions(actions: CompanionActionDefinitions): void;
+    subscribeActions(actionIds: string[]): void;
+    unsubscribeActions(actionIds: string[]): void;
+}
+//# sourceMappingURL=actions.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../src/internal/actions.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AACtD,OAAO,KAAK,EACX,6BAA6B,EAC7B,qCAAqC,EACrC,2BAA2B,EAC3B,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,0BAA0B,EAC1B,wBAAwB,EACxB,MAAM,oBAAoB,CAAA;AAC3B,OAAO,KAAK,EAGX,0BAA0B,EAE1B,MAAM,yBAAyB,CAAA;AAahC,qBAAa,aAAa;;gBAYxB,sBAAsB,EAAE,CAAC,GAAG,EAAE,6BAA6B,KAAK,OAAO,CAAC,qCAAqC,CAAC,EAC9G,oBAAoB,EAAE,CAAC,GAAG,EAAE,2BAA2B,KAAK,IAAI,EAChE,sBAAsB,EAAE,CAAC,GAAG,EAAE,wBAAwB,KAAK,IAAI,EAC/D,GAAG,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI;IAQnC,mBAAmB,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqCnE,mBAAmB,CAAC,OAAO,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,IAAI,GAAG,SAAS,CAAA;KAAE,GAAG,IAAI;IAsDjF,iBAAiB,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,0BAA0B,CAAC;IA0C5F,oBAAoB,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI;IA0B/D,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI;IA0B3C,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI;CAyB7C"}

package/dist/internal/actions.js

@@ -0,0 +1,207 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ActionManager = void 0;
+const base_js_1 = require("./base.js");
+function convertActionInstanceToEvent(action) {
+    return {
+        id: action.id,
+        actionId: action.actionId,
+        controlId: action.controlId,
+        options: action.options,
+    };
+}
+class ActionManager {
+    #parseVariablesInString;
+    #setActionDefinitions;
+    #setCustomVariableValue;
+    #log;
+    #actionDefinitions = new Map();
+    #actionInstances = new Map();
+    constructor(parseVariablesInString, setActionDefinitions, setCustomVariableValue, log) {
+        this.#parseVariablesInString = parseVariablesInString;
+        this.#setActionDefinitions = setActionDefinitions;
+        this.#setCustomVariableValue = setCustomVariableValue;
+        this.#log = log;
+    }
+    async handleExecuteAction(msg) {
+        const actionDefinition = this.#actionDefinitions.get(msg.action.actionId);
+        if (!actionDefinition)
+            throw new Error(`Unknown action: ${msg.action.actionId}`);
+        const context = {
+            parseVariablesInString: async (text) => {
+                const res = await this.#parseVariablesInString({
+                    text: text,
+                    controlId: msg.action.controlId,
+                    actionInstanceId: msg.action.id,
+                    feedbackInstanceId: undefined,
+                });
+                return res.text;
+            },
+            setCustomVariableValue: (variableName, value) => {
+                this.#setCustomVariableValue({
+                    customVariableId: variableName,
+                    value,
+                    controlId: msg.action.controlId,
+                });
+            },
+        };
+        await actionDefinition.callback({
+            id: msg.action.id,
+            actionId: msg.action.actionId,
+            controlId: msg.action.controlId,
+            options: msg.action.options,
+            surfaceId: msg.surfaceId,
+        }, context);
+    }
+    handleUpdateActions(actions) {
+        for (const [id, action] of Object.entries(actions)) {
+            const existing = this.#actionInstances.get(id);
+            if (existing) {
+                // Call unsubscribe
+                const definition = this.#actionDefinitions.get(existing.actionId);
+                if (definition?.unsubscribe && !definition.skipUnsubscribeOnOptionsChange) {
+                    const context = {
+                        parseVariablesInString: async (text) => {
+                            // No-op, any values parsed here will not be stable
+                            return text;
+                        },
+                        setCustomVariableValue: () => {
+                            throw new Error(`setCustomVariableValue is not available during unsubscribe`);
+                        },
+                    };
+                    Promise.resolve(definition.unsubscribe(convertActionInstanceToEvent(existing), context)).catch((e) => {
+                        this.#log('error', `Action unsubscribe failed: ${JSON.stringify(existing)} - ${e?.message ?? e} ${e?.stack}`);
+                    });
+                }
+            }
+            if (!action || action.disabled) {
+                // Deleted
+                this.#actionInstances.delete(id);
+            }
+            else {
+                // TODO module-lib - deep freeze the action to avoid mutation?
+                this.#actionInstances.set(id, action);
+                // Inserted or updated
+                const definition = this.#actionDefinitions.get(action.actionId);
+                if (definition?.subscribe) {
+                    const context = {
+                        parseVariablesInString: async (text) => {
+                            // No-op, any values parsed here will not be stable
+                            return text;
+                        },
+                        setCustomVariableValue: () => {
+                            throw new Error(`setCustomVariableValue is not available during subscribe`);
+                        },
+                    };
+                    Promise.resolve(definition.subscribe(convertActionInstanceToEvent(action), context)).catch((e) => {
+                        this.#log('error', `Action subscribe failed: ${JSON.stringify(action)} - ${e?.message ?? e} ${e?.stack}`);
+                    });
+                }
+            }
+        }
+    }
+    async handleLearnAction(msg) {
+        const definition = this.#actionDefinitions.get(msg.action.actionId);
+        if (definition && definition.learn) {
+            const context = {
+                parseVariablesInString: async (text) => {
+                    const res = await this.#parseVariablesInString({
+                        text: text,
+                        controlId: msg.action.controlId,
+                        actionInstanceId: msg.action.id,
+                        feedbackInstanceId: undefined,
+                    });
+                    return res.text;
+                },
+                setCustomVariableValue: () => {
+                    throw new Error(`setCustomVariableValue is not available during learn`);
+                },
+            };
+            const newOptions = await definition.learn({
+                id: msg.action.id,
+                actionId: msg.action.actionId,
+                controlId: msg.action.controlId,
+                options: msg.action.options,
+                surfaceId: undefined,
+            }, context);
+            return {
+                options: newOptions,
+            };
+        }
+        else {
+            // Not supported
+            return {
+                options: undefined,
+            };
+        }
+    }
+    setActionDefinitions(actions) {
+        const hostActions = [];
+        this.#actionDefinitions.clear();
+        for (const [actionId, action] of Object.entries(actions)) {
+            if (action) {
+                hostActions.push({
+                    id: actionId,
+                    name: action.name,
+                    description: action.description,
+                    options: (0, base_js_1.serializeIsVisibleFn)(action.options),
+                    optionsToIgnoreForSubscribe: action.optionsToIgnoreForSubscribe,
+                    hasLearn: !!action.learn,
+                    learnTimeout: action.learnTimeout,
+                    hasLifecycleFunctions: !!action.subscribe || !!action.unsubscribe,
+                });
+                // Remember the definition locally
+                this.#actionDefinitions.set(actionId, action);
+            }
+        }
+        this.#setActionDefinitions({ actions: hostActions });
+    }
+    subscribeActions(actionIds) {
+        let actions = Array.from(this.#actionInstances.values());
+        const actionIdSet = new Set(actionIds);
+        if (actionIdSet.size)
+            actions = actions.filter((fb) => actionIdSet.has(fb.actionId));
+        for (const act of actions) {
+            const def = this.#actionDefinitions.get(act.actionId);
+            if (def?.subscribe) {
+                const context = {
+                    parseVariablesInString: async (text) => {
+                        // No-op, any values parsed here will not be stable
+                        return text;
+                    },
+                    setCustomVariableValue: () => {
+                        throw new Error(`setCustomVariableValue is not available during subscribe`);
+                    },
+                };
+                Promise.resolve(def.subscribe(convertActionInstanceToEvent(act), context)).catch((e) => {
+                    this.#log('error', `Action subscribe failed: ${JSON.stringify(act)} - ${e?.message ?? e} ${e?.stack}`);
+                });
+            }
+        }
+    }
+    unsubscribeActions(actionIds) {
+        let actions = Array.from(this.#actionInstances.values());
+        const actionIdSet = new Set(actionIds);
+        if (actionIdSet.size)
+            actions = actions.filter((fb) => actionIdSet.has(fb.actionId));
+        for (const act of actions) {
+            const def = this.#actionDefinitions.get(act.actionId);
+            if (def && def.unsubscribe) {
+                const context = {
+                    parseVariablesInString: async (text) => {
+                        // No-op, any values parsed here will not be stable
+                        return text;
+                    },
+                    setCustomVariableValue: () => {
+                        throw new Error(`setCustomVariableValue is not available during unsubscribe`);
+                    },
+                };
+                Promise.resolve(def.unsubscribe(convertActionInstanceToEvent(act), context)).catch((e) => {
+                    this.#log('error', `Action unsubscribe failed: ${JSON.stringify(act)} - ${e?.message ?? e} ${e?.stack}`);
+                });
+            }
+        }
+    }
+}
+exports.ActionManager = ActionManager;
+//# sourceMappingURL=actions.js.map

package/dist/internal/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../src/internal/actions.ts"],"names":[],"mappings":";;;AAiBA,uCAAgD;AAGhD,SAAS,4BAA4B,CAAC,MAAsB;IAC3D,OAAO;QACN,EAAE,EAAE,MAAM,CAAC,EAAE;QACb,QAAQ,EAAE,MAAM,CAAC,QAAQ;QACzB,SAAS,EAAE,MAAM,CAAC,SAAS;QAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;KACvB,CAAA;AACF,CAAC;AAED,MAAa,aAAa;IAChB,uBAAuB,CAEmB;IAC1C,qBAAqB,CAA4C;IACjE,uBAAuB,CAAyC;IAChE,IAAI,CAA4C;IAEhD,kBAAkB,GAAG,IAAI,GAAG,EAAqC,CAAA;IACjE,gBAAgB,GAAG,IAAI,GAAG,EAA0B,CAAA;IAE7D,YACC,sBAA8G,EAC9G,oBAAgE,EAChE,sBAA+D,EAC/D,GAA+C;QAE/C,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAA;QACrD,IAAI,CAAC,qBAAqB,GAAG,oBAAoB,CAAA;QACjD,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAA;QACrD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAA;IAChB,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,GAAyB;QACzD,MAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QACzE,IAAI,CAAC,gBAAgB;YAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,GAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,CAAA;QAEhF,MAAM,OAAO,GAA2B;YACvC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;gBAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC;oBAC9C,IAAI,EAAE,IAAI;oBACV,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS;oBAC/B,gBAAgB,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE;oBAC/B,kBAAkB,EAAE,SAAS;iBAC7B,CAAC,CAAA;gBAEF,OAAO,GAAG,CAAC,IAAI,CAAA;YAChB,CAAC;YACD,sBAAsB,EAAE,CAAC,YAAoB,EAAE,KAA6B,EAAE,EAAE;gBAC/E,IAAI,CAAC,uBAAuB,CAAC;oBAC5B,gBAAgB,EAAE,YAAY;oBAC9B,KAAK;oBACL,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS;iBAC/B,CAAC,CAAA;YACH,CAAC;SACD,CAAA;QAED,MAAM,gBAAgB,CAAC,QAAQ,CAC9B;YACC,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE;YACjB,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,QAAQ;YAC7B,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS;YAC/B,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,OAAO;YAE3B,SAAS,EAAE,GAAG,CAAC,SAAS;SACxB,EACD,OAAO,CACP,CAAA;IACF,CAAC;IAEM,mBAAmB,CAAC,OAA4D;QACtF,KAAK,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAC9C,IAAI,QAAQ,EAAE,CAAC;gBACd,mBAAmB;gBACnB,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;gBACjE,IAAI,UAAU,EAAE,WAAW,IAAI,CAAC,UAAU,CAAC,8BAA8B,EAAE,CAAC;oBAC3E,MAAM,OAAO,GAA2B;wBACvC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;4BAC/D,mDAAmD;4BACnD,OAAO,IAAI,CAAA;wBACZ,CAAC;wBACD,sBAAsB,EAAE,GAAG,EAAE;4BAC5B,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAA;wBAC9E,CAAC;qBACD,CAAA;oBAED,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,WAAW,CAAC,4BAA4B,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;wBACpG,IAAI,CAAC,IAAI,CACR,OAAO,EACP,8BAA8B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CACzF,CAAA;oBACF,CAAC,CAAC,CAAA;gBACH,CAAC;YACF,CAAC;YAED,IAAI,CAAC,MAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gBAChC,UAAU;gBACV,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YACjC,CAAC;iBAAM,CAAC;gBACP,8DAA8D;gBAC9D,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,EAAE,MAAM,CAAC,CAAA;gBAErC,sBAAsB;gBACtB,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;gBAC/D,IAAI,UAAU,EAAE,SAAS,EAAE,CAAC;oBAC3B,MAAM,OAAO,GAA2B;wBACvC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;4BAC/D,mDAAmD;4BACnD,OAAO,IAAI,CAAA;wBACZ,CAAC;wBACD,sBAAsB,EAAE,GAAG,EAAE;4BAC5B,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAA;wBAC5E,CAAC;qBACD,CAAA;oBAED,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,4BAA4B,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;wBAChG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,4BAA4B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;oBAC1G,CAAC,CAAC,CAAA;gBACH,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAEM,KAAK,CAAC,iBAAiB,CAAC,GAAuB;QACrD,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QACnE,IAAI,UAAU,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;YACpC,MAAM,OAAO,GAA2B;gBACvC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;oBAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC;wBAC9C,IAAI,EAAE,IAAI;wBACV,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS;wBAC/B,gBAAgB,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE;wBAC/B,kBAAkB,EAAE,SAAS;qBAC7B,CAAC,CAAA;oBAEF,OAAO,GAAG,CAAC,IAAI,CAAA;gBAChB,CAAC;gBACD,sBAAsB,EAAE,GAAG,EAAE;oBAC5B,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;gBACxE,CAAC;aACD,CAAA;YAED,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,KAAK,CACxC;gBACC,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,EAAE;gBACjB,QAAQ,EAAE,GAAG,CAAC,MAAM,CAAC,QAAQ;gBAC7B,SAAS,EAAE,GAAG,CAAC,MAAM,CAAC,SAAS;gBAC/B,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,OAAO;gBAE3B,SAAS,EAAE,SAAS;aACpB,EACD,OAAO,CACP,CAAA;YAED,OAAO;gBACN,OAAO,EAAE,UAAU;aACnB,CAAA;QACF,CAAC;aAAM,CAAC;YACP,gBAAgB;YAChB,OAAO;gBACN,OAAO,EAAE,SAAS;aAClB,CAAA;QACF,CAAC;IACF,CAAC;IAED,oBAAoB,CAAC,OAAmC;QACvD,MAAM,WAAW,GAA2C,EAAE,CAAA;QAE9D,IAAI,CAAC,kBAAkB,CAAC,KAAK,EAAE,CAAA;QAE/B,KAAK,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1D,IAAI,MAAM,EAAE,CAAC;gBACZ,WAAW,CAAC,IAAI,CAAC;oBAChB,EAAE,EAAE,QAAQ;oBACZ,IAAI,EAAE,MAAM,CAAC,IAAI;oBACjB,WAAW,EAAE,MAAM,CAAC,WAAW;oBAC/B,OAAO,EAAE,IAAA,8BAAoB,EAAC,MAAM,CAAC,OAAO,CAAC;oBAC7C,2BAA2B,EAAE,MAAM,CAAC,2BAA2B;oBAC/D,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,KAAK;oBACxB,YAAY,EAAE,MAAM,CAAC,YAAY;oBACjC,qBAAqB,EAAE,CAAC,CAAC,MAAM,CAAC,SAAS,IAAI,CAAC,CAAC,MAAM,CAAC,WAAW;iBACjE,CAAC,CAAA;gBAEF,kCAAkC;gBAClC,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAA;YAC9C,CAAC;QACF,CAAC;QAED,IAAI,CAAC,qBAAqB,CAAC,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC,CAAA;IACrD,CAAC;IAED,gBAAgB,CAAC,SAAmB;QACnC,IAAI,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,CAAA;QAExD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAA;QACtC,IAAI,WAAW,CAAC,IAAI;YAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAA;QAEpF,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;YACrD,IAAI,GAAG,EAAE,SAAS,EAAE,CAAC;gBACpB,MAAM,OAAO,GAA2B;oBACvC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;wBAC/D,mDAAmD;wBACnD,OAAO,IAAI,CAAA;oBACZ,CAAC;oBACD,sBAAsB,EAAE,GAAG,EAAE;wBAC5B,MAAM,IAAI,KAAK,CAAC,0DAA0D,CAAC,CAAA;oBAC5E,CAAC;iBACD,CAAA;gBAED,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,4BAA4B,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;oBACtF,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,4BAA4B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;gBACvG,CAAC,CAAC,CAAA;YACH,CAAC;QACF,CAAC;IACF,CAAC;IAED,kBAAkB,CAAC,SAAmB;QACrC,IAAI,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,MAAM,EAAE,CAAC,CAAA;QAExD,MAAM,WAAW,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAA;QACtC,IAAI,WAAW,CAAC,IAAI;YAAE,OAAO,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAA;QAEpF,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;YACrD,IAAI,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;gBAC5B,MAAM,OAAO,GAA2B;oBACvC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;wBAC/D,mDAAmD;wBACnD,OAAO,IAAI,CAAA;oBACZ,CAAC;oBACD,sBAAsB,EAAE,GAAG,EAAE;wBAC5B,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAA;oBAC9E,CAAC;iBACD,CAAA;gBAED,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,4BAA4B,CAAC,GAAG,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;oBACxF,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,8BAA8B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;gBACzG,CAAC,CAAC,CAAA;YACH,CAAC;QACF,CAAC;IACF,CAAC;CACD;AAzOD,sCAyOC"}

package/dist/internal/base.d.ts

@@ -0,0 +1,11 @@
+import type { CompanionStaticUpgradeScript } from '../module-api/upgrade.js';
+import type { EncodeIsVisible } from '../host-api/api.js';
+import type { CompanionInputFieldBase } from '../module-api/input.js';
+export declare function serializeIsVisibleFn<T extends CompanionInputFieldBase>(options: T[]): EncodeIsVisible<T>[];
+export interface InstanceBaseProps<TConfig, TSecrets> {
+    id: string;
+    upgradeScripts: CompanionStaticUpgradeScript<TConfig, TSecrets>[];
+    _isInstanceBaseProps: boolean;
+}
+export declare function isInstanceBaseProps<TConfig, TSecrets>(obj: unknown): obj is InstanceBaseProps<TConfig, TSecrets>;
+//# 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,EAAE,4BAA4B,EAAE,MAAM,0BAA0B,CAAA;AAC5E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AACzD,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAA;AAErE,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,uBAAuB,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC,EAAE,CA6B1G;AAED,MAAM,WAAW,iBAAiB,CAAC,OAAO,EAAE,QAAQ;IACnD,EAAE,EAAE,MAAM,CAAA;IACV,cAAc,EAAE,4BAA4B,CAAC,OAAO,EAAE,QAAQ,CAAC,EAAE,CAAA;IACjE,oBAAoB,EAAE,OAAO,CAAA;CAC7B;AAED,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,iBAAiB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAGhH"}

package/dist/internal/base.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.serializeIsVisibleFn = serializeIsVisibleFn;
+exports.isInstanceBaseProps = isInstanceBaseProps;
+function serializeIsVisibleFn(options) {
+    return (options ?? []).map((option) => {
+        if ('isVisibleExpression' in option && typeof option.isVisibleExpression === 'string') {
+            return {
+                ...option,
+                isVisibleFnType: 'expression',
+                isVisibleFn: option.isVisibleExpression,
+                isVisible: undefined,
+                isVisibleExpression: undefined,
+            };
+        }
+        else if ('isVisible' in option && typeof option.isVisible === 'function') {
+            return {
+                ...option,
+                isVisibleFn: option.isVisible.toString(),
+                isVisibleFnType: 'function',
+                isVisible: undefined,
+                isVisibleExpression: undefined,
+            };
+        }
+        // ignore any existing `isVisibleFn` to avoid code injection
+        return {
+            ...option,
+            isVisible: undefined,
+            isVisibleFn: undefined,
+            isVisibleFnType: undefined,
+            isVisibleExpression: undefined,
+        };
+    });
+}
+function isInstanceBaseProps(obj) {
+    const obj2 = obj;
+    return typeof obj2 === 'object' && typeof obj2.id === 'string' && obj2._isInstanceBaseProps === true;
+}
+//# sourceMappingURL=base.js.map

package/dist/internal/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/internal/base.ts"],"names":[],"mappings":";;AAIA,oDA6BC;AAQD,kDAGC;AAxCD,SAAgB,oBAAoB,CAAoC,OAAY;IACnF,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QACrC,IAAI,qBAAqB,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,mBAAmB,KAAK,QAAQ,EAAE,CAAC;YACvF,OAAO;gBACN,GAAG,MAAM;gBACT,eAAe,EAAE,YAAY;gBAC7B,WAAW,EAAE,MAAM,CAAC,mBAAmB;gBACvC,SAAS,EAAE,SAAS;gBACpB,mBAAmB,EAAE,SAAS;aAC9B,CAAA;QACF,CAAC;aAAM,IAAI,WAAW,IAAI,MAAM,IAAI,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;YAC5E,OAAO;gBACN,GAAG,MAAM;gBACT,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE;gBACxC,eAAe,EAAE,UAAU;gBAC3B,SAAS,EAAE,SAAS;gBACpB,mBAAmB,EAAE,SAAS;aAC9B,CAAA;QACF,CAAC;QAED,4DAA4D;QAC5D,OAAO;YACN,GAAG,MAAM;YACT,SAAS,EAAE,SAAS;YACpB,WAAW,EAAE,SAAS;YACtB,eAAe,EAAE,SAAS;YAC1B,mBAAmB,EAAE,SAAS;SAC9B,CAAA;IACF,CAAC,CAAC,CAAA;AACH,CAAC;AAQD,SAAgB,mBAAmB,CAAoB,GAAY;IAClE,MAAM,IAAI,GAAG,GAA2C,CAAA;IACxD,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,IAAI,IAAI,CAAC,oBAAoB,KAAK,IAAI,CAAA;AACrG,CAAC"}

package/dist/internal/feedback.d.ts

@@ -0,0 +1,20 @@
+import type { CompanionFeedbackDefinitions } from '../module-api/feedback.js';
+import type { FeedbackInstance, LearnFeedbackMessage, LearnFeedbackResponseMessage, ParseVariablesInStringMessage, ParseVariablesInStringResponseMessage, SetFeedbackDefinitionsMessage, UpdateFeedbackValuesMessage } from '../host-api/api.js';
+import type { LogLevel } from '../module-api/enums.js';
+export declare class FeedbackManager {
+    #private;
+    get parseVariablesContext(): string | undefined;
+    constructor(parseVariablesInString: (msg: ParseVariablesInStringMessage) => Promise<ParseVariablesInStringResponseMessage>, updateFeedbackValues: (msg: UpdateFeedbackValuesMessage) => void, setFeedbackDefinitions: (msg: SetFeedbackDefinitionsMessage) => void, log: (level: LogLevel, message: string) => void);
+    getDefinitionIds(): string[];
+    getInstanceIds(): string[];
+    handleUpdateFeedbacks(feedbacks: {
+        [id: string]: FeedbackInstance | null | undefined;
+    }): void;
+    handleLearnFeedback(msg: LearnFeedbackMessage): Promise<LearnFeedbackResponseMessage>;
+    setFeedbackDefinitions(feedbacks: CompanionFeedbackDefinitions): void;
+    checkFeedbacks(feedbackTypes: string[]): void;
+    checkFeedbacksById(feedbackIds: string[]): void;
+    subscribeFeedbacks(feedbackIds: string[]): void;
+    unsubscribeFeedbacks(feedbackIds: string[]): void;
+}
+//# sourceMappingURL=feedback.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"feedback.d.ts","sourceRoot":"","sources":["../../src/internal/feedback.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAIX,4BAA4B,EAE5B,MAAM,2BAA2B,CAAA;AAClC,OAAO,KAAK,EACX,gBAAgB,EAChB,oBAAoB,EACpB,4BAA4B,EAC5B,6BAA6B,EAC7B,qCAAqC,EACrC,6BAA6B,EAC7B,2BAA2B,EAC3B,MAAM,oBAAoB,CAAA;AAI3B,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAA;AAsBtD,qBAAa,eAAe;;IAmB3B,IAAW,qBAAqB,IAAI,MAAM,GAAG,SAAS,CAErD;gBAGA,sBAAsB,EAAE,CAAC,GAAG,EAAE,6BAA6B,KAAK,OAAO,CAAC,qCAAqC,CAAC,EAC9G,oBAAoB,EAAE,CAAC,GAAG,EAAE,2BAA2B,KAAK,IAAI,EAChE,sBAAsB,EAAE,CAAC,GAAG,EAAE,6BAA6B,KAAK,IAAI,EACpE,GAAG,EAAE,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,KAAK,IAAI;IAQzC,gBAAgB,IAAI,MAAM,EAAE;IAG5B,cAAc,IAAI,MAAM,EAAE;IAI1B,qBAAqB,CAAC,SAAS,EAAE;QAAE,CAAC,EAAE,EAAE,MAAM,GAAG,gBAAgB,GAAG,IAAI,GAAG,SAAS,CAAA;KAAE,GAAG,IAAI;IA4DvF,mBAAmB,CAAC,GAAG,EAAE,oBAAoB,GAAG,OAAO,CAAC,4BAA4B,CAAC;IA4KlG,sBAAsB,CAAC,SAAS,EAAE,4BAA4B,GAAG,IAAI;IA2BrE,cAAc,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,IAAI;IAa7C,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI;IAO/C,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI;IAuB/C,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI;CAsBjD"}