@companion-module/host 0.1.0-0

package/dist/internal/actions.js

@@ -0,0 +1,212 @@
+import { createModuleLogger, } from '@companion-module/base';
+function convertActionInstanceToEvent(action) {
+    return {
+        id: action.id,
+        actionId: action.actionId,
+        controlId: action.controlId,
+        options: action.options,
+    };
+}
+export class ActionManager {
+    #logger = createModuleLogger('ActionManager');
+    #parseVariablesInString;
+    #setActionDefinitions;
+    #setCustomVariableValue;
+    #actionDefinitions = new Map();
+    #actionInstances = new Map();
+    constructor(parseVariablesInString, setActionDefinitions, setCustomVariableValue) {
+        this.#parseVariablesInString = parseVariablesInString;
+        this.#setActionDefinitions = setActionDefinitions;
+        this.#setCustomVariableValue = setCustomVariableValue;
+    }
+    async handleExecuteAction(action, surfaceId) {
+        const actionDefinition = this.#actionDefinitions.get(action.actionId);
+        if (!actionDefinition) {
+            return {
+                success: false,
+                errorMessage: `Action definition not found for: ${action.actionId}`,
+            };
+        }
+        const context = {
+            parseVariablesInString: async (text) => {
+                const res = await this.#parseVariablesInString(text, {
+                    controlId: action.controlId,
+                    actionInstanceId: action.id,
+                    feedbackInstanceId: undefined,
+                });
+                return res;
+            },
+            setCustomVariableValue: (variableName, value) => {
+                this.#setCustomVariableValue(action.controlId, variableName, value);
+            },
+        };
+        try {
+            await actionDefinition.callback({
+                id: action.id,
+                actionId: action.actionId,
+                controlId: action.controlId,
+                options: action.options,
+                surfaceId: surfaceId,
+            }, context);
+            return {
+                success: true,
+                errorMessage: undefined,
+            };
+        }
+        catch (e) {
+            return {
+                success: false,
+                errorMessage: e?.message ?? String(e),
+            };
+        }
+    }
+    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.#logger.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.#logger.error(`Action subscribe failed: ${JSON.stringify(action)} - ${e?.message ?? e} ${e?.stack}`);
+                    });
+                }
+            }
+        }
+    }
+    async handleLearnAction(action) {
+        const definition = this.#actionDefinitions.get(action.actionId);
+        if (definition && definition.learn) {
+            const context = {
+                parseVariablesInString: async (text) => {
+                    const res = await this.#parseVariablesInString(text, {
+                        controlId: action.controlId,
+                        actionInstanceId: action.id,
+                        feedbackInstanceId: undefined,
+                    });
+                    return res;
+                },
+                setCustomVariableValue: () => {
+                    throw new Error(`setCustomVariableValue is not available during learn`);
+                },
+            };
+            const newOptions = await definition.learn({
+                id: action.id,
+                actionId: action.actionId,
+                controlId: action.controlId,
+                options: 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: 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(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.#logger.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.#logger.error(`Action unsubscribe failed: ${JSON.stringify(act)} - ${e?.message ?? e} ${e?.stack}`);
+                });
+            }
+        }
+    }
+}
+//# 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":"AAAA,OAAO,EAON,kBAAkB,GAClB,MAAM,wBAAwB,CAAA;AAI/B,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,MAAM,OAAO,aAAa;IAChB,OAAO,GAAG,kBAAkB,CAAC,eAAe,CAAC,CAAA;IAE7C,uBAAuB,CAA6D;IACpF,qBAAqB,CAA2C;IAChE,uBAAuB,CAIvB;IAEA,kBAAkB,GAAG,IAAI,GAAG,EAAqC,CAAA;IACjE,gBAAgB,GAAG,IAAI,GAAG,EAA0B,CAAA;IAE7D,YACC,sBAAmF,EACnF,oBAA2D,EAC3D,sBAAkH;QAElH,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAA;QACrD,IAAI,CAAC,qBAAqB,GAAG,oBAAoB,CAAA;QACjD,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAA;IACtD,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC/B,MAAsB,EACtB,SAA6B;QAE7B,MAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QACrE,IAAI,CAAC,gBAAgB,EAAE,CAAC;YACvB,OAAO;gBACN,OAAO,EAAE,KAAK;gBACd,YAAY,EAAE,oCAAoC,MAAM,CAAC,QAAQ,EAAE;aACnE,CAAA;QACF,CAAC;QAED,MAAM,OAAO,GAA2B;YACvC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;gBAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE;oBACpD,SAAS,EAAE,MAAM,CAAC,SAAS;oBAC3B,gBAAgB,EAAE,MAAM,CAAC,EAAE;oBAC3B,kBAAkB,EAAE,SAAS;iBAC7B,CAAC,CAAA;gBAEF,OAAO,GAAG,CAAA;YACX,CAAC;YACD,sBAAsB,EAAE,CAAC,YAAoB,EAAE,KAA6B,EAAE,EAAE;gBAC/E,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,SAAS,EAAE,YAAY,EAAE,KAAK,CAAC,CAAA;YACpE,CAAC;SACD,CAAA;QAED,IAAI,CAAC;YACJ,MAAM,gBAAgB,CAAC,QAAQ,CAC9B;gBACC,EAAE,EAAE,MAAM,CAAC,EAAE;gBACb,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;gBAEvB,SAAS,EAAE,SAAS;aACpB,EACD,OAAO,CACP,CAAA;YAED,OAAO;gBACN,OAAO,EAAE,IAAI;gBACb,YAAY,EAAE,SAAS;aACvB,CAAA;QACF,CAAC;QAAC,OAAO,CAAM,EAAE,CAAC;YACjB,OAAO;gBACN,OAAO,EAAE,KAAK;gBACd,YAAY,EAAE,CAAC,EAAE,OAAO,IAAI,MAAM,CAAC,CAAC,CAAC;aACrC,CAAA;QACF,CAAC;IACF,CAAC;IAEM,mBAAmB,CAAC,OAA0D;QACpF,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,OAAO,CAAC,KAAK,CACjB,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,OAAO,CAAC,KAAK,CAAC,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,MAAsB;QACpD,MAAM,UAAU,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;QAC/D,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,IAAI,EAAE;wBACpD,SAAS,EAAE,MAAM,CAAC,SAAS;wBAC3B,gBAAgB,EAAE,MAAM,CAAC,EAAE;wBAC3B,kBAAkB,EAAE,SAAS;qBAC7B,CAAC,CAAA;oBAEF,OAAO,GAAG,CAAA;gBACX,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,MAAM,CAAC,EAAE;gBACb,QAAQ,EAAE,MAAM,CAAC,QAAQ;gBACzB,SAAS,EAAE,MAAM,CAAC,SAAS;gBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;gBAEvB,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,GAA2B,EAAE,CAAA;QAE9C,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,MAAM,CAAC,OAAO;oBACvB,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,WAAW,CAAC,CAAA;IACxC,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,OAAO,CAAC,KAAK,CAAC,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,OAAO,CAAC,KAAK,CAAC,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"}

package/dist/internal/base.d.ts

@@ -0,0 +1,4 @@
+import type { CompanionInputFieldBase } from '@companion-module/base';
+import type { EncodeIsVisible } from '../context.js';
+export declare function serializeIsVisibleFn<T extends CompanionInputFieldBase>(options: T[]): EncodeIsVisible<T>[];
+//# 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,uBAAuB,EAAE,MAAM,wBAAwB,CAAA;AACrE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,eAAe,CAAA;AAEpD,wBAAgB,oBAAoB,CAAC,CAAC,SAAS,uBAAuB,EAAE,OAAO,EAAE,CAAC,EAAE,GAAG,eAAe,CAAC,CAAC,CAAC,EAAE,CA6B1G"}

package/dist/internal/base.js

@@ -0,0 +1,31 @@
+export 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,
+        };
+    });
+}
+//# 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":"AAGA,MAAM,UAAU,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"}

package/dist/internal/feedback.d.ts

@@ -0,0 +1,19 @@
+import { type CompanionFeedbackDefinitions, type CompanionOptionValues } from '@companion-module/base';
+import type { FeedbackInstance, HostFeedbackDefinition, HostFeedbackValue, ParseVariablesInfo } from '../context.js';
+export declare class FeedbackManager {
+    #private;
+    get parseVariablesContext(): string | undefined;
+    constructor(parseVariablesInString: (text: string, info: ParseVariablesInfo) => Promise<string>, setFeedbackDefinitions: (feedbacks: HostFeedbackDefinition[]) => void, updateFeedbackValues: (values: HostFeedbackValue[]) => void);
+    getDefinitionIds(): string[];
+    getInstanceIds(): string[];
+    handleUpdateFeedbacks(feedbacks: Record<string, FeedbackInstance | null | undefined>): void;
+    handleLearnFeedback(feedback: FeedbackInstance): Promise<{
+        options: CompanionOptionValues | undefined;
+    }>;
+    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,EAIN,KAAK,4BAA4B,EAEjC,KAAK,qBAAqB,EAI1B,MAAM,wBAAwB,CAAA;AAE/B,OAAO,KAAK,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAA;AAoBpH,qBAAa,eAAe;;IAkB3B,IAAW,qBAAqB,IAAI,MAAM,GAAG,SAAS,CAErD;gBAGA,sBAAsB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,KAAK,OAAO,CAAC,MAAM,CAAC,EACnF,sBAAsB,EAAE,CAAC,SAAS,EAAE,sBAAsB,EAAE,KAAK,IAAI,EACrE,oBAAoB,EAAE,CAAC,MAAM,EAAE,iBAAiB,EAAE,KAAK,IAAI;IAOrD,gBAAgB,IAAI,MAAM,EAAE;IAG5B,cAAc,IAAI,MAAM,EAAE;IAI1B,qBAAqB,CAAC,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,GAAG,IAAI,GAAG,SAAS,CAAC,GAAG,IAAI;IA0DrF,mBAAmB,CAC/B,QAAQ,EAAE,gBAAgB,GACxB,OAAO,CAAC;QAAE,OAAO,EAAE,qBAAqB,GAAG,SAAS,CAAA;KAAE,CAAC;IAyK1D,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"}

package/dist/internal/feedback.js

@@ -0,0 +1,296 @@
+import { assertNever, createModuleLogger, } from '@companion-module/base';
+import debounceFn from 'debounce-fn';
+function convertFeedbackInstanceToEvent(type, feedback) {
+    return {
+        type: type,
+        id: feedback.id,
+        feedbackId: feedback.feedbackId,
+        controlId: feedback.controlId,
+        options: feedback.options,
+    };
+}
+export class FeedbackManager {
+    #logger = createModuleLogger('FeedbackManager');
+    #parseVariablesInString;
+    #setFeedbackDefinitions;
+    #updateFeedbackValues;
+    #feedbackDefinitions = new Map();
+    #feedbackInstances = new Map();
+    // Feedback values waiting to be sent
+    #pendingFeedbackValues = new Map();
+    // Feedbacks currently being checked
+    #feedbacksBeingChecked = new Map();
+    // while in a context which provides an alternate parseVariablesInString, we should log when the original is called
+    #parseVariablesContext;
+    get parseVariablesContext() {
+        return this.#parseVariablesContext;
+    }
+    constructor(parseVariablesInString, setFeedbackDefinitions, updateFeedbackValues) {
+        this.#parseVariablesInString = parseVariablesInString;
+        this.#setFeedbackDefinitions = setFeedbackDefinitions;
+        this.#updateFeedbackValues = updateFeedbackValues;
+    }
+    getDefinitionIds() {
+        return Array.from(this.#feedbackDefinitions.keys());
+    }
+    getInstanceIds() {
+        return Array.from(this.#feedbackInstances.keys());
+    }
+    handleUpdateFeedbacks(feedbacks) {
+        for (const [id, feedback] of Object.entries(feedbacks)) {
+            const existing = this.#feedbackInstances.get(id);
+            if (existing && !feedback) {
+                // Call unsubscribe
+                const definition = this.#feedbackDefinitions.get(existing.feedbackId);
+                if (definition?.unsubscribe) {
+                    const context = {
+                        parseVariablesInString: async (text) => {
+                            // No-op, any values parsed here will not be stable
+                            return text;
+                        },
+                    };
+                    Promise.resolve(definition.unsubscribe(convertFeedbackInstanceToEvent(definition.type, existing), context)).catch((e) => {
+                        this.#logger.error(`Feedback unsubscribe failed: ${JSON.stringify(existing)} - ${e?.message ?? e} ${e?.stack}`);
+                    });
+                }
+            }
+            if (!feedback || feedback.disabled) {
+                // Deleted
+                this.#feedbackInstances.delete(id);
+            }
+            else {
+                // TODO module-lib - deep freeze the feedback to avoid mutation?
+                this.#feedbackInstances.set(id, { ...feedback });
+                // Inserted
+                if (!existing) {
+                    const definition = this.#feedbackDefinitions.get(feedback.feedbackId);
+                    if (definition?.subscribe) {
+                        const context = {
+                            parseVariablesInString: async (text) => {
+                                // No-op, any values parsed here will not be stable
+                                return text;
+                            },
+                        };
+                        Promise.resolve(definition.subscribe(convertFeedbackInstanceToEvent(definition.type, feedback), context)).catch((e) => {
+                            this.#logger.error(`Feedback subscribe failed: ${JSON.stringify(feedback)} - ${e?.message ?? e} ${e?.stack}`);
+                        });
+                    }
+                }
+                // update the feedback value
+                this.#triggerCheckFeedback(id);
+            }
+        }
+    }
+    async handleLearnFeedback(feedback) {
+        const definition = this.#feedbackDefinitions.get(feedback.feedbackId);
+        if (definition && definition.learn) {
+            const context = {
+                parseVariablesInString: async (text) => {
+                    const res = await this.#parseVariablesInString(text, {
+                        controlId: feedback.controlId,
+                        actionInstanceId: undefined,
+                        feedbackInstanceId: feedback.id,
+                    });
+                    return res;
+                },
+            };
+            const newOptions = await definition.learn({
+                id: feedback.id,
+                feedbackId: feedback.feedbackId,
+                controlId: feedback.controlId,
+                options: feedback.options,
+                type: definition.type,
+            }, context);
+            return {
+                options: newOptions,
+            };
+        }
+        else {
+            // Not supported
+            return {
+                options: undefined,
+            };
+        }
+    }
+    #triggerCheckFeedback(id) {
+        const existingRecheck = this.#feedbacksBeingChecked.get(id);
+        if (existingRecheck) {
+            // Already being checked
+            existingRecheck.needsRecheck = true;
+            return;
+        }
+        const feedback0 = this.#feedbackInstances.get(id);
+        if (!feedback0)
+            return;
+        const feedback = feedback0;
+        const feedbackCheckStatus = {
+            needsRecheck: false,
+        };
+        // mark it as being checked
+        this.#feedbacksBeingChecked.set(id, feedbackCheckStatus);
+        Promise.resolve()
+            .then(async () => {
+            const definition = this.#feedbackDefinitions.get(feedback.feedbackId);
+            let value;
+            // Calculate the new value for the feedback
+            if (definition) {
+                // Set this while the promise starts executing
+                this.#parseVariablesContext = `Feedback ${feedback.feedbackId} (${id})`;
+                const context = {
+                    parseVariablesInString: async (text) => {
+                        const res = await this.#parseVariablesInString(text, {
+                            controlId: feedback.controlId,
+                            actionInstanceId: undefined,
+                            feedbackInstanceId: id,
+                        });
+                        return res;
+                    },
+                };
+                switch (definition.type) {
+                    case 'boolean':
+                        value = definition.callback({
+                            ...convertFeedbackInstanceToEvent('boolean', feedback),
+                            type: 'boolean',
+                        }, context);
+                        break;
+                    case 'value':
+                        value = definition.callback({
+                            ...convertFeedbackInstanceToEvent('value', feedback),
+                            type: 'value',
+                        }, context);
+                        break;
+                    case 'advanced':
+                        value = definition.callback({
+                            ...convertFeedbackInstanceToEvent('advanced', feedback),
+                            type: 'advanced',
+                            image: feedback.image,
+                        }, context);
+                        break;
+                    default:
+                        assertNever(definition);
+                        break;
+                }
+                this.#parseVariablesContext = undefined;
+            }
+            // Await the value before looking at this.#pendingFeedbackValues, to avoid race conditions
+            const resolvedValue = await value;
+            this.#pendingFeedbackValues.set(id, {
+                id: id,
+                controlId: feedback.controlId,
+                feedbackType: definition?.type,
+                value: resolvedValue,
+            });
+            this.#sendFeedbackValues();
+        })
+            .catch((e) => {
+            console.error(`Feedback check failed: ${JSON.stringify(feedback)} - ${e?.message ?? e} ${e?.stack}`);
+        })
+            .finally(() => {
+            // ensure this.#parseVariablesContext is cleared
+            this.#parseVariablesContext = undefined;
+            // it is no longer being checked
+            this.#feedbacksBeingChecked.delete(id);
+            // If queued, trigger a check
+            if (feedbackCheckStatus.needsRecheck) {
+                setImmediate(() => {
+                    this.#triggerCheckFeedback(id);
+                });
+            }
+        });
+    }
+    /**
+     * Send pending feedback values (from this.#pendingFeedbackValues) to companion, with a debounce
+     */
+    #sendFeedbackValues = debounceFn(() => {
+        const newValues = this.#pendingFeedbackValues;
+        this.#pendingFeedbackValues = new Map();
+        // Send the new values back
+        if (newValues.size > 0) {
+            this.#updateFeedbackValues(Array.from(newValues.values()));
+        }
+    }, {
+        wait: 5,
+        maxWait: 25,
+    });
+    setFeedbackDefinitions(feedbacks) {
+        const hostFeedbacks = [];
+        this.#feedbackDefinitions.clear();
+        for (const [feedbackId, feedback] of Object.entries(feedbacks)) {
+            if (feedback) {
+                hostFeedbacks.push({
+                    id: feedbackId,
+                    name: feedback.name,
+                    description: feedback.description,
+                    options: feedback.options,
+                    type: feedback.type,
+                    defaultStyle: feedback.type === 'boolean' ? feedback.defaultStyle : undefined,
+                    hasLearn: !!feedback.learn,
+                    learnTimeout: feedback.learnTimeout,
+                    showInvert: feedback.type === 'boolean' ? feedback.showInvert : false,
+                });
+                // Remember the definition locally
+                this.#feedbackDefinitions.set(feedbackId, feedback);
+            }
+        }
+        this.#setFeedbackDefinitions(hostFeedbacks);
+    }
+    checkFeedbacks(feedbackTypes) {
+        const types = new Set(feedbackTypes);
+        for (const [id, feedback] of this.#feedbackInstances.entries()) {
+            const definition = this.#feedbackDefinitions.get(feedback.feedbackId);
+            if (definition) {
+                if (types.size === 0 || types.has(feedback.feedbackId)) {
+                    // update the feedback value
+                    this.#triggerCheckFeedback(id);
+                }
+            }
+        }
+    }
+    checkFeedbacksById(feedbackIds) {
+        for (const id of feedbackIds) {
+            // update the feedback value
+            this.#triggerCheckFeedback(id);
+        }
+    }
+    subscribeFeedbacks(feedbackIds) {
+        let feedbacks = Array.from(this.#feedbackInstances.values());
+        const feedbackIdSet = new Set(feedbackIds);
+        if (feedbackIdSet.size)
+            feedbacks = feedbacks.filter((fb) => feedbackIdSet.has(fb.feedbackId));
+        for (const fb of feedbacks) {
+            const def = this.#feedbackDefinitions.get(fb.feedbackId);
+            if (def?.subscribe) {
+                const context = {
+                    parseVariablesInString: async (text) => {
+                        // No-op, any values parsed here will not be stable
+                        return text;
+                    },
+                };
+                Promise.resolve(def.subscribe(convertFeedbackInstanceToEvent(def.type, fb), context)).catch((e) => {
+                    this.#logger.error(`Feedback subscribe failed: ${JSON.stringify(fb)} - ${e?.message ?? e} ${e?.stack}`);
+                });
+            }
+        }
+    }
+    unsubscribeFeedbacks(feedbackIds) {
+        let feedbacks = Array.from(this.#feedbackInstances.values());
+        const feedbackIdSet = new Set(feedbackIds);
+        if (feedbackIdSet.size)
+            feedbacks = feedbacks.filter((fb) => feedbackIdSet.has(fb.feedbackId));
+        for (const fb of feedbacks) {
+            const def = this.#feedbackDefinitions.get(fb.feedbackId);
+            if (def && def.unsubscribe) {
+                const context = {
+                    parseVariablesInString: async (text) => {
+                        // No-op, any values parsed here will not be stable
+                        return text;
+                    },
+                };
+                Promise.resolve(def.unsubscribe(convertFeedbackInstanceToEvent(def.type, fb), context)).catch((e) => {
+                    this.#logger.error(`Feedback unsubscribe failed: ${JSON.stringify(fb)} - ${e?.message ?? e} ${e?.stack}`);
+                });
+            }
+        }
+    }
+}
+//# sourceMappingURL=feedback.js.map

package/dist/internal/feedback.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"feedback.js","sourceRoot":"","sources":["../../src/internal/feedback.ts"],"names":[],"mappings":"AAAA,OAAO,EAQN,WAAW,EACX,kBAAkB,GAClB,MAAM,wBAAwB,CAAA;AAC/B,OAAO,UAAU,MAAM,aAAa,CAAA;AAGpC,SAAS,8BAA8B,CACtC,IAAsC,EACtC,QAA0B;IAE1B,OAAO;QACN,IAAI,EAAE,IAAI;QACV,EAAE,EAAE,QAAQ,CAAC,EAAE;QACf,UAAU,EAAE,QAAQ,CAAC,UAAU;QAC/B,SAAS,EAAE,QAAQ,CAAC,SAAS;QAC7B,OAAO,EAAE,QAAQ,CAAC,OAAO;KACzB,CAAA;AACF,CAAC;AAOD,MAAM,OAAO,eAAe;IAClB,OAAO,GAAG,kBAAkB,CAAC,iBAAiB,CAAC,CAAA;IAE/C,uBAAuB,CAA6D;IACpF,uBAAuB,CAA+C;IACtE,qBAAqB,CAAuC;IAE5D,oBAAoB,GAAG,IAAI,GAAG,EAAuC,CAAA;IACrE,kBAAkB,GAAG,IAAI,GAAG,EAA4B,CAAA;IAEjE,qCAAqC;IACrC,sBAAsB,GAAG,IAAI,GAAG,EAA6B,CAAA;IAC7D,oCAAoC;IACpC,sBAAsB,GAAG,IAAI,GAAG,EAA+B,CAAA;IAE/D,mHAAmH;IACnH,sBAAsB,CAAoB;IAE1C,IAAW,qBAAqB;QAC/B,OAAO,IAAI,CAAC,sBAAsB,CAAA;IACnC,CAAC;IAED,YACC,sBAAmF,EACnF,sBAAqE,EACrE,oBAA2D;QAE3D,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAA;QACrD,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAA;QACrD,IAAI,CAAC,qBAAqB,GAAG,oBAAoB,CAAA;IAClD,CAAC;IAEM,gBAAgB;QACtB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC,IAAI,EAAE,CAAC,CAAA;IACpD,CAAC;IACM,cAAc;QACpB,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,CAAC,CAAA;IAClD,CAAC;IAEM,qBAAqB,CAAC,SAA8D;QAC1F,KAAK,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YACxD,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAChD,IAAI,QAAQ,IAAI,CAAC,QAAQ,EAAE,CAAC;gBAC3B,mBAAmB;gBACnB,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;gBACrE,IAAI,UAAU,EAAE,WAAW,EAAE,CAAC;oBAC7B,MAAM,OAAO,GAA6B;wBACzC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;4BAC/D,mDAAmD;4BACnD,OAAO,IAAI,CAAA;wBACZ,CAAC;qBACD,CAAA;oBAED,OAAO,CAAC,OAAO,CACd,UAAU,CAAC,WAAW,CAAC,8BAA8B,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,CAC1F,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;wBACb,IAAI,CAAC,OAAO,CAAC,KAAK,CACjB,gCAAgC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAC3F,CAAA;oBACF,CAAC,CAAC,CAAA;gBACH,CAAC;YACF,CAAC;YAED,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;gBACpC,UAAU;gBACV,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YACnC,CAAC;iBAAM,CAAC;gBACP,gEAAgE;gBAChE,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,GAAG,QAAQ,EAAE,CAAC,CAAA;gBAEhD,WAAW;gBACX,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACf,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;oBACrE,IAAI,UAAU,EAAE,SAAS,EAAE,CAAC;wBAC3B,MAAM,OAAO,GAA6B;4BACzC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;gCAC/D,mDAAmD;gCACnD,OAAO,IAAI,CAAA;4BACZ,CAAC;yBACD,CAAA;wBAED,OAAO,CAAC,OAAO,CACd,UAAU,CAAC,SAAS,CAAC,8BAA8B,CAAC,UAAU,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,OAAO,CAAC,CACxF,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;4BACb,IAAI,CAAC,OAAO,CAAC,KAAK,CACjB,8BAA8B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CACzF,CAAA;wBACF,CAAC,CAAC,CAAA;oBACH,CAAC;gBACF,CAAC;gBAED,4BAA4B;gBAC5B,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAA;YAC/B,CAAC;QACF,CAAC;IACF,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAC/B,QAA0B;QAE1B,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QACrE,IAAI,UAAU,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;YACpC,MAAM,OAAO,GAA6B;gBACzC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;oBAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE;wBACpD,SAAS,EAAE,QAAQ,CAAC,SAAS;wBAC7B,gBAAgB,EAAE,SAAS;wBAC3B,kBAAkB,EAAE,QAAQ,CAAC,EAAE;qBAC/B,CAAC,CAAA;oBAEF,OAAO,GAAG,CAAA;gBACX,CAAC;aACD,CAAA;YAED,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,KAAK,CACxC;gBACC,EAAE,EAAE,QAAQ,CAAC,EAAE;gBACf,UAAU,EAAE,QAAQ,CAAC,UAAU;gBAC/B,SAAS,EAAE,QAAQ,CAAC,SAAS;gBAC7B,OAAO,EAAE,QAAQ,CAAC,OAAO;gBACzB,IAAI,EAAE,UAAU,CAAC,IAAI;aACrB,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,qBAAqB,CAAC,EAAU;QAC/B,MAAM,eAAe,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QAC3D,IAAI,eAAe,EAAE,CAAC;YACrB,wBAAwB;YACxB,eAAe,CAAC,YAAY,GAAG,IAAI,CAAA;YACnC,OAAM;QACP,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QACjD,IAAI,CAAC,SAAS;YAAE,OAAM;QAEtB,MAAM,QAAQ,GAAG,SAAS,CAAA;QAE1B,MAAM,mBAAmB,GAAwB;YAChD,YAAY,EAAE,KAAK;SACnB,CAAA;QACD,2BAA2B;QAC3B,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,EAAE,mBAAmB,CAAC,CAAA;QAExD,OAAO,CAAC,OAAO,EAAE;aACf,IAAI,CAAC,KAAK,IAAI,EAAE;YAChB,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YAErE,IAAI,KAKQ,CAAA;YAEZ,2CAA2C;YAC3C,IAAI,UAAU,EAAE,CAAC;gBAChB,8CAA8C;gBAC9C,IAAI,CAAC,sBAAsB,GAAG,YAAY,QAAQ,CAAC,UAAU,KAAK,EAAE,GAAG,CAAA;gBAEvE,MAAM,OAAO,GAA6B;oBACzC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;wBAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE;4BACpD,SAAS,EAAE,QAAQ,CAAC,SAAS;4BAC7B,gBAAgB,EAAE,SAAS;4BAC3B,kBAAkB,EAAE,EAAE;yBACtB,CAAC,CAAA;wBAEF,OAAO,GAAG,CAAA;oBACX,CAAC;iBACD,CAAA;gBAED,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;oBACzB,KAAK,SAAS;wBACb,KAAK,GAAG,UAAU,CAAC,QAAQ,CAC1B;4BACC,GAAG,8BAA8B,CAAC,SAAS,EAAE,QAAQ,CAAC;4BACtD,IAAI,EAAE,SAAS;yBACf,EACD,OAAO,CACP,CAAA;wBACD,MAAK;oBACN,KAAK,OAAO;wBACX,KAAK,GAAG,UAAU,CAAC,QAAQ,CAC1B;4BACC,GAAG,8BAA8B,CAAC,OAAO,EAAE,QAAQ,CAAC;4BACpD,IAAI,EAAE,OAAO;yBACb,EACD,OAAO,CACP,CAAA;wBACD,MAAK;oBACN,KAAK,UAAU;wBACd,KAAK,GAAG,UAAU,CAAC,QAAQ,CAC1B;4BACC,GAAG,8BAA8B,CAAC,UAAU,EAAE,QAAQ,CAAC;4BACvD,IAAI,EAAE,UAAU;4BAChB,KAAK,EAAE,QAAQ,CAAC,KAAK;yBACrB,EACD,OAAO,CACP,CAAA;wBACD,MAAK;oBACN;wBACC,WAAW,CAAC,UAAU,CAAC,CAAA;wBACvB,MAAK;gBACP,CAAC;gBAED,IAAI,CAAC,sBAAsB,GAAG,SAAS,CAAA;YACxC,CAAC;YAED,0FAA0F;YAC1F,MAAM,aAAa,GAAG,MAAM,KAAK,CAAA;YACjC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,EAAE;gBACnC,EAAE,EAAE,EAAE;gBACN,SAAS,EAAE,QAAQ,CAAC,SAAS;gBAC7B,YAAY,EAAE,UAAU,EAAE,IAAI;gBAC9B,KAAK,EAAE,aAAa;aACpB,CAAC,CAAA;YACF,IAAI,CAAC,mBAAmB,EAAE,CAAA;QAC3B,CAAC,CAAC;aACD,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACZ,OAAO,CAAC,KAAK,CAAC,0BAA0B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;QACrG,CAAC,CAAC;aACD,OAAO,CAAC,GAAG,EAAE;YACb,gDAAgD;YAChD,IAAI,CAAC,sBAAsB,GAAG,SAAS,CAAA;YAEvC,gCAAgC;YAChC,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YAEtC,6BAA6B;YAC7B,IAAI,mBAAmB,CAAC,YAAY,EAAE,CAAC;gBACtC,YAAY,CAAC,GAAG,EAAE;oBACjB,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAA;gBAC/B,CAAC,CAAC,CAAA;YACH,CAAC;QACF,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,mBAAmB,GAAG,UAAU,CAC/B,GAAS,EAAE;QACV,MAAM,SAAS,GAAG,IAAI,CAAC,sBAAsB,CAAA;QAC7C,IAAI,CAAC,sBAAsB,GAAG,IAAI,GAAG,EAAE,CAAA;QAEvC,2BAA2B;QAC3B,IAAI,SAAS,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;YACxB,IAAI,CAAC,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,CAAA;QAC3D,CAAC;IACF,CAAC,EACD;QACC,IAAI,EAAE,CAAC;QACP,OAAO,EAAE,EAAE;KACX,CACD,CAAA;IAED,sBAAsB,CAAC,SAAuC;QAC7D,MAAM,aAAa,GAA6B,EAAE,CAAA;QAElD,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAA;QAEjC,KAAK,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAChE,IAAI,QAAQ,EAAE,CAAC;gBACd,aAAa,CAAC,IAAI,CAAC;oBAClB,EAAE,EAAE,UAAU;oBACd,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,WAAW,EAAE,QAAQ,CAAC,WAAW;oBACjC,OAAO,EAAE,QAAQ,CAAC,OAAO;oBACzB,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,YAAY,EAAE,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;oBAC7E,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK;oBAC1B,YAAY,EAAE,QAAQ,CAAC,YAAY;oBACnC,UAAU,EAAE,QAAQ,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK;iBACrE,CAAC,CAAA;gBAEF,kCAAkC;gBAClC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;YACpD,CAAC;QACF,CAAC;QAED,IAAI,CAAC,uBAAuB,CAAC,aAAa,CAAC,CAAA;IAC5C,CAAC;IAED,cAAc,CAAC,aAAuB;QACrC,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,aAAa,CAAC,CAAA;QACpC,KAAK,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,IAAI,IAAI,CAAC,kBAAkB,CAAC,OAAO,EAAE,EAAE,CAAC;YAChE,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YACrE,IAAI,UAAU,EAAE,CAAC;gBAChB,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;oBACxD,4BAA4B;oBAC5B,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAA;gBAC/B,CAAC;YACF,CAAC;QACF,CAAC;IACF,CAAC;IAED,kBAAkB,CAAC,WAAqB;QACvC,KAAK,MAAM,EAAE,IAAI,WAAW,EAAE,CAAC;YAC9B,4BAA4B;YAC5B,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAA;QAC/B,CAAC;IACF,CAAC;IAED,kBAAkB,CAAC,WAAqB;QACvC,IAAI,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,CAAA;QAE5D,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAA;QAC1C,IAAI,aAAa,CAAC,IAAI;YAAE,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAA;QAE9F,KAAK,MAAM,EAAE,IAAI,SAAS,EAAE,CAAC;YAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,CAAA;YACxD,IAAI,GAAG,EAAE,SAAS,EAAE,CAAC;gBACpB,MAAM,OAAO,GAA6B;oBACzC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;wBAC/D,mDAAmD;wBACnD,OAAO,IAAI,CAAA;oBACZ,CAAC;iBACD,CAAA;gBAED,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,8BAA8B,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;oBACjG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,8BAA8B,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;gBACxG,CAAC,CAAC,CAAA;YACH,CAAC;QACF,CAAC;IACF,CAAC;IAED,oBAAoB,CAAC,WAAqB;QACzC,IAAI,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,CAAA;QAE5D,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,WAAW,CAAC,CAAA;QAC1C,IAAI,aAAa,CAAC,IAAI;YAAE,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,CAAC,CAAA;QAE9F,KAAK,MAAM,EAAE,IAAI,SAAS,EAAE,CAAC;YAC5B,MAAM,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,CAAA;YACxD,IAAI,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE,CAAC;gBAC5B,MAAM,OAAO,GAA6B;oBACzC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;wBAC/D,mDAAmD;wBACnD,OAAO,IAAI,CAAA;oBACZ,CAAC;iBACD,CAAA;gBAED,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,8BAA8B,CAAC,GAAG,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;oBACnG,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,gCAAgC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;gBAC1G,CAAC,CAAC,CAAA;YACH,CAAC;QACF,CAAC;IACF,CAAC;CACD"}

package/dist/internal/upgrade.d.ts

@@ -0,0 +1,15 @@
+import { type CompanionStaticUpgradeScript } from '@companion-module/base';
+import type { UpgradeActionInstance, UpgradeFeedbackInstance, UpgradeActionAndFeedbackInstancesResponse } from '../context.js';
+/**
+ * Run through the upgrade scripts for the given data
+ * Note: this updates the inputs in place, but the result needs to be sent back to companion
+ * @param allActions Actions that may need upgrading
+ * @param allFeedbacks Feedbacks that may need upgrading
+ * @param defaultUpgradeIndex The lastUpgradeIndex of the connection, if known
+ * @param upgradeScripts The scripts that may be run
+ * @param config The current config of the module
+ * @param skipConfigAndSecretsUpgrade Whether to skip upgrading the config and secrets
+ * @returns The upgraded data that needs persisting
+ */
+export declare function runThroughUpgradeScripts(allActionsArray: UpgradeActionInstance[], allFeedbacksArray: UpgradeFeedbackInstance[], defaultUpgradeIndex: number | null, upgradeScripts: CompanionStaticUpgradeScript<any, any>[], config: unknown, secrets: unknown, skipConfigAndSecretsUpgrade: boolean): UpgradeActionAndFeedbackInstancesResponse;
+//# sourceMappingURL=upgrade.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade.d.ts","sourceRoot":"","sources":["../../src/internal/upgrade.ts"],"names":[],"mappings":"AAAA,OAAO,EAGN,KAAK,4BAA4B,EAGjC,MAAM,wBAAwB,CAAA;AAC/B,OAAO,KAAK,EACX,qBAAqB,EACrB,uBAAuB,EACvB,yCAAyC,EACzC,MAAM,eAAe,CAAA;AAEtB;;;;;;;;;;GAUG;AACH,wBAAgB,wBAAwB,CACvC,eAAe,EAAE,qBAAqB,EAAE,EACxC,iBAAiB,EAAE,uBAAuB,EAAE,EAC5C,mBAAmB,EAAE,MAAM,GAAG,IAAI,EAClC,cAAc,EAAE,4BAA4B,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,EACxD,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,OAAO,EAChB,2BAA2B,EAAE,OAAO,GAClC,yCAAyC,CAgL3C"}