@companion-module/base 1.7.0 → 1.7.1

package/dist/internal/feedback.mjs

@@ -0,0 +1,377 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FeedbackManager = void 0;
+const tslib_1 = require("tslib");
+const base_mjs_1 = require("./base.mjs");
+const debounce_fn_1 = tslib_1.__importDefault(require("debounce-fn"));
+function convertFeedbackInstanceToEvent(type, feedback) {
+    return {
+        type: type,
+        id: feedback.id,
+        feedbackId: feedback.feedbackId,
+        controlId: feedback.controlId,
+        options: feedback.options,
+    };
+}
+class FeedbackManager {
+    #parseVariablesInString;
+    #updateFeedbackValues;
+    #setFeedbackDefinitions;
+    #log;
+    #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, updateFeedbackValues, setFeedbackDefinitions, log) {
+        this.#parseVariablesInString = parseVariablesInString;
+        this.#updateFeedbackValues = updateFeedbackValues;
+        this.#setFeedbackDefinitions = setFeedbackDefinitions;
+        this.#log = log;
+    }
+    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) {
+                // Call unsubscribe
+                const definition = this.#feedbackDefinitions.get(existing.feedbackId);
+                if (definition?.unsubscribe) {
+                    const context = {
+                        parseVariablesInString: async (text) => {
+                            const res = await this.#parseVariablesInString({
+                                text: text,
+                                controlId: existing.controlId,
+                                actionInstanceId: undefined,
+                                feedbackInstanceId: existing.id,
+                            });
+                            return res.text;
+                        },
+                    };
+                    Promise.resolve(definition.unsubscribe(convertFeedbackInstanceToEvent(definition.type, existing), context)).catch((e) => {
+                        this.#log('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,
+                    referencedVariables: null,
+                });
+                // Inserted or updated
+                const definition = this.#feedbackDefinitions.get(feedback.feedbackId);
+                if (definition?.subscribe) {
+                    const context = {
+                        parseVariablesInString: async (text) => {
+                            const res = await this.#parseVariablesInString({
+                                text: text,
+                                controlId: feedback.controlId,
+                                actionInstanceId: undefined,
+                                feedbackInstanceId: feedback.id,
+                            });
+                            return res.text;
+                        },
+                    };
+                    Promise.resolve(definition.subscribe(convertFeedbackInstanceToEvent(definition.type, feedback), context)).catch((e) => {
+                        this.#log('error', `Feedback subscribe failed: ${JSON.stringify(feedback)} - ${e?.message ?? e} ${e?.stack}`);
+                    });
+                }
+                // update the feedback value
+                this.#triggerCheckFeedback(id);
+            }
+        }
+    }
+    async handleLearnFeedback(msg) {
+        const definition = this.#feedbackDefinitions.get(msg.feedback.feedbackId);
+        if (definition && definition.learn) {
+            const context = {
+                parseVariablesInString: async (text) => {
+                    const res = await this.#parseVariablesInString({
+                        text: text,
+                        controlId: msg.feedback.controlId,
+                        actionInstanceId: undefined,
+                        feedbackInstanceId: msg.feedback.id,
+                    });
+                    return res.text;
+                },
+            };
+            const newOptions = await definition.learn({
+                id: msg.feedback.id,
+                feedbackId: msg.feedback.feedbackId,
+                controlId: msg.feedback.controlId,
+                options: msg.feedback.options,
+                type: definition.type,
+            }, context);
+            return {
+                options: newOptions,
+            };
+        }
+        else {
+            // Not supported
+            return {
+                options: undefined,
+            };
+        }
+    }
+    handleVariablesChanged(msg) {
+        if (!msg.variablesIds.length)
+            return;
+        const changedFeedbackIds = new Set(msg.variablesIds);
+        // Any feedbacks being checked should be made aware
+        for (const feedbackStatus of this.#feedbacksBeingChecked.values()) {
+            for (const id of msg.variablesIds) {
+                feedbackStatus.changedVariables.add(id);
+            }
+        }
+        // Determine the feedbacks that need checking
+        const feedbackIds = new Set();
+        for (const feedback of this.#feedbackInstances.values()) {
+            // if feedback is currently being checked, it will be handled differently
+            if (this.#feedbacksBeingChecked.has(feedback.id))
+                continue;
+            if (feedback.referencedVariables) {
+                for (const id of feedback.referencedVariables) {
+                    if (changedFeedbackIds.has(id)) {
+                        feedbackIds.add(feedback.id);
+                        break;
+                    }
+                }
+            }
+        }
+        // Trigger all the feedbacks to be rechecked
+        for (const id of feedbackIds) {
+            setImmediate(() => {
+                this.#triggerCheckFeedback(id);
+            });
+        }
+    }
+    #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,
+            changedVariables: new Set(),
+        };
+        // mark it as being checked
+        this.#feedbacksBeingChecked.set(id, feedbackCheckStatus);
+        Promise.resolve()
+            .then(async () => {
+            const definition = this.#feedbackDefinitions.get(feedback.feedbackId);
+            let value;
+            const newReferencedVariables = new Set();
+            // 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: text,
+                            controlId: feedback.controlId,
+                            actionInstanceId: undefined,
+                            feedbackInstanceId: id,
+                        });
+                        // Track which variables were referenced
+                        if (res.variableIds && res.variableIds.length) {
+                            for (const id of res.variableIds) {
+                                newReferencedVariables.add(id);
+                            }
+                        }
+                        return res.text;
+                    },
+                };
+                if (definition.type === 'boolean') {
+                    value = definition.callback({
+                        ...convertFeedbackInstanceToEvent('boolean', feedback),
+                        type: 'boolean',
+                        _rawBank: feedback.rawBank,
+                    }, context);
+                }
+                else {
+                    value = definition.callback({
+                        ...convertFeedbackInstanceToEvent('advanced', feedback),
+                        type: 'advanced',
+                        image: feedback.image,
+                        _page: feedback.page,
+                        _bank: feedback.bank,
+                        _rawBank: feedback.rawBank,
+                    }, context);
+                }
+                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,
+                value: resolvedValue,
+            });
+            this.#sendFeedbackValues();
+            feedback.referencedVariables = newReferencedVariables.size > 0 ? Array.from(newReferencedVariables) : null;
+        })
+            .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);
+            // Check if any variables changed that should cause an immediate recheck
+            let recheckForVariableChanged = false;
+            if (feedback.referencedVariables) {
+                for (const id of feedback.referencedVariables) {
+                    if (feedbackCheckStatus.changedVariables.has(id)) {
+                        recheckForVariableChanged = true;
+                        break;
+                    }
+                }
+            }
+            // If queued, trigger a check
+            if (recheckForVariableChanged || feedbackCheckStatus.needsRecheck) {
+                setImmediate(() => {
+                    this.#triggerCheckFeedback(id);
+                });
+            }
+        });
+    }
+    /**
+     * Send pending feedback values (from this.#pendingFeedbackValues) to companion, with a debounce
+     */
+    #sendFeedbackValues = (0, debounce_fn_1.default)(() => {
+        const newValues = this.#pendingFeedbackValues;
+        this.#pendingFeedbackValues = new Map();
+        // Send the new values back
+        if (newValues.size > 0) {
+            this.#updateFeedbackValues({
+                values: 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: (0, base_mjs_1.serializeIsVisibleFn)(feedback.options),
+                    type: feedback.type,
+                    defaultStyle: 'defaultStyle' in feedback ? feedback.defaultStyle : undefined,
+                    hasLearn: !!feedback.learn,
+                });
+                // Remember the definition locally
+                this.#feedbackDefinitions.set(feedbackId, feedback);
+            }
+        }
+        this.#setFeedbackDefinitions({ feedbacks: 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);
+        }
+    }
+    /** @deprecated */
+    _getAllFeedbacks() {
+        return Array.from(this.#feedbackInstances.values()).map((fb) => ({
+            id: fb.id,
+            feedbackId: fb.feedbackId,
+            controlId: fb.controlId,
+            options: fb.options,
+        }));
+    }
+    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) => {
+                        const res = await this.#parseVariablesInString({
+                            text: text,
+                            controlId: fb.controlId,
+                            actionInstanceId: undefined,
+                            feedbackInstanceId: fb.id,
+                        });
+                        return res.text;
+                    },
+                };
+                Promise.resolve(def.subscribe(convertFeedbackInstanceToEvent(def.type, fb), context)).catch((e) => {
+                    this.#log('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) => {
+                        const res = await this.#parseVariablesInString({
+                            text: text,
+                            controlId: fb.controlId,
+                            actionInstanceId: undefined,
+                            feedbackInstanceId: fb.id,
+                        });
+                        return res.text;
+                    },
+                };
+                Promise.resolve(def.unsubscribe(convertFeedbackInstanceToEvent(def.type, fb), context)).catch((e) => {
+                    this.#log('error', `Feedback unsubscribe failed: ${JSON.stringify(fb)} - ${e?.message ?? e} ${e?.stack}`);
+                });
+            }
+        }
+    }
+}
+exports.FeedbackManager = FeedbackManager;
+//# sourceMappingURL=feedback.mjs.map

package/dist/internal/feedback.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"feedback.mjs","sourceRoot":"","sources":["../../src/internal/feedback.mts"],"names":[],"mappings":";;;;AAiBA,yCAAiD;AACjD,sEAAoC;AAGpC,SAAS,8BAA8B,CACtC,IAA4B,EAC5B,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;AAcD,MAAa,eAAe;IAClB,uBAAuB,CAEmB;IAC1C,qBAAqB,CAA4C;IACjE,uBAAuB,CAA8C;IACrE,IAAI,CAA4C;IAEhD,oBAAoB,GAAG,IAAI,GAAG,EAAuC,CAAA;IACrE,kBAAkB,GAAG,IAAI,GAAG,EAA+B,CAAA;IAEpE,qCAAqC;IACrC,sBAAsB,GAAG,IAAI,GAAG,EAAoD,CAAA;IACpF,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,sBAA8G,EAC9G,oBAAgE,EAChE,sBAAoE,EACpE,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,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,SAAgE;QAC5F,KAAK,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YACvD,MAAM,QAAQ,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAChD,IAAI,QAAQ,EAAE;gBACb,mBAAmB;gBACnB,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;gBACrE,IAAI,UAAU,EAAE,WAAW,EAAE;oBAC5B,MAAM,OAAO,GAA6B;wBACzC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;4BAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC;gCAC9C,IAAI,EAAE,IAAI;gCACV,SAAS,EAAE,QAAQ,CAAC,SAAS;gCAC7B,gBAAgB,EAAE,SAAS;gCAC3B,kBAAkB,EAAE,QAAQ,CAAC,EAAE;6BAC/B,CAAC,CAAA;4BAEF,OAAO,GAAG,CAAC,IAAI,CAAA;wBAChB,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,IAAI,CACR,OAAO,EACP,gCAAgC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAC3F,CAAA;oBACF,CAAC,CAAC,CAAA;iBACF;aACD;YAED,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,QAAQ,EAAE;gBACnC,UAAU;gBACV,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;aAClC;iBAAM;gBACN,gEAAgE;gBAChE,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,EAAE,EAAE;oBAC/B,GAAG,QAAQ;oBACX,mBAAmB,EAAE,IAAI;iBACzB,CAAC,CAAA;gBAEF,sBAAsB;gBACtB,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;gBACrE,IAAI,UAAU,EAAE,SAAS,EAAE;oBAC1B,MAAM,OAAO,GAA6B;wBACzC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;4BAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC;gCAC9C,IAAI,EAAE,IAAI;gCACV,SAAS,EAAE,QAAQ,CAAC,SAAS;gCAC7B,gBAAgB,EAAE,SAAS;gCAC3B,kBAAkB,EAAE,QAAQ,CAAC,EAAE;6BAC/B,CAAC,CAAA;4BAEF,OAAO,GAAG,CAAC,IAAI,CAAA;wBAChB,CAAC;qBACD,CAAA;oBAED,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;wBACb,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;iBACF;gBAED,4BAA4B;gBAC5B,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAA;aAC9B;SACD;IACF,CAAC;IAEM,KAAK,CAAC,mBAAmB,CAAC,GAAyB;QACzD,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;QACzE,IAAI,UAAU,IAAI,UAAU,CAAC,KAAK,EAAE;YACnC,MAAM,OAAO,GAA6B;gBACzC,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,QAAQ,CAAC,SAAS;wBACjC,gBAAgB,EAAE,SAAS;wBAC3B,kBAAkB,EAAE,GAAG,CAAC,QAAQ,CAAC,EAAE;qBACnC,CAAC,CAAA;oBAEF,OAAO,GAAG,CAAC,IAAI,CAAA;gBAChB,CAAC;aACD,CAAA;YAED,MAAM,UAAU,GAAG,MAAM,UAAU,CAAC,KAAK,CACxC;gBACC,EAAE,EAAE,GAAG,CAAC,QAAQ,CAAC,EAAE;gBACnB,UAAU,EAAE,GAAG,CAAC,QAAQ,CAAC,UAAU;gBACnC,SAAS,EAAE,GAAG,CAAC,QAAQ,CAAC,SAAS;gBACjC,OAAO,EAAE,GAAG,CAAC,QAAQ,CAAC,OAAO;gBAC7B,IAAI,EAAE,UAAU,CAAC,IAAI;aACrB,EACD,OAAO,CACP,CAAA;YAED,OAAO;gBACN,OAAO,EAAE,UAAU;aACnB,CAAA;SACD;aAAM;YACN,gBAAgB;YAChB,OAAO;gBACN,OAAO,EAAE,SAAS;aAClB,CAAA;SACD;IACF,CAAC;IAEM,sBAAsB,CAAC,GAA4B;QACzD,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,MAAM;YAAE,OAAM;QAEpC,MAAM,kBAAkB,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,YAAY,CAAC,CAAA;QAEpD,mDAAmD;QACnD,KAAK,MAAM,cAAc,IAAI,IAAI,CAAC,sBAAsB,CAAC,MAAM,EAAE,EAAE;YAClE,KAAK,MAAM,EAAE,IAAI,GAAG,CAAC,YAAY,EAAE;gBAClC,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;aACvC;SACD;QAED,6CAA6C;QAC7C,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAA;QACrC,KAAK,MAAM,QAAQ,IAAI,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,EAAE;YACxD,yEAAyE;YACzE,IAAI,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAAE,SAAQ;YAE1D,IAAI,QAAQ,CAAC,mBAAmB,EAAE;gBACjC,KAAK,MAAM,EAAE,IAAI,QAAQ,CAAC,mBAAmB,EAAE;oBAC9C,IAAI,kBAAkB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;wBAC/B,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;wBAC5B,MAAK;qBACL;iBACD;aACD;SACD;QAED,4CAA4C;QAC5C,KAAK,MAAM,EAAE,IAAI,WAAW,EAAE;YAC7B,YAAY,CAAC,GAAG,EAAE;gBACjB,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAA;YAC/B,CAAC,CAAC,CAAA;SACF;IACF,CAAC;IAED,qBAAqB,CAAC,EAAU;QAC/B,MAAM,eAAe,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QAC3D,IAAI,eAAe,EAAE;YACpB,wBAAwB;YACxB,eAAe,CAAC,YAAY,GAAG,IAAI,CAAA;YACnC,OAAM;SACN;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;YACnB,gBAAgB,EAAE,IAAI,GAAG,EAAE;SAC3B,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;YACZ,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAU,CAAA;YAEhD,2CAA2C;YAC3C,IAAI,UAAU,EAAE;gBACf,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;4BAC9C,IAAI,EAAE,IAAI;4BACV,SAAS,EAAE,QAAQ,CAAC,SAAS;4BAC7B,gBAAgB,EAAE,SAAS;4BAC3B,kBAAkB,EAAE,EAAE;yBACtB,CAAC,CAAA;wBAEF,wCAAwC;wBACxC,IAAI,GAAG,CAAC,WAAW,IAAI,GAAG,CAAC,WAAW,CAAC,MAAM,EAAE;4BAC9C,KAAK,MAAM,EAAE,IAAI,GAAG,CAAC,WAAW,EAAE;gCACjC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;6BAC9B;yBACD;wBAED,OAAO,GAAG,CAAC,IAAI,CAAA;oBAChB,CAAC;iBACD,CAAA;gBACD,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,EAAE;oBAClC,KAAK,GAAG,UAAU,CAAC,QAAQ,CAC1B;wBACC,GAAG,8BAA8B,CAAC,SAAS,EAAE,QAAQ,CAAC;wBACtD,IAAI,EAAE,SAAS;wBACf,QAAQ,EAAE,QAAQ,CAAC,OAAO;qBAC1B,EACD,OAAO,CACP,CAAA;iBACD;qBAAM;oBACN,KAAK,GAAG,UAAU,CAAC,QAAQ,CAC1B;wBACC,GAAG,8BAA8B,CAAC,UAAU,EAAE,QAAQ,CAAC;wBACvD,IAAI,EAAE,UAAU;wBAChB,KAAK,EAAE,QAAQ,CAAC,KAAK;wBACrB,KAAK,EAAE,QAAQ,CAAC,IAAI;wBACpB,KAAK,EAAE,QAAQ,CAAC,IAAI;wBACpB,QAAQ,EAAE,QAAQ,CAAC,OAAO;qBAC1B,EACD,OAAO,CACP,CAAA;iBACD;gBAED,IAAI,CAAC,sBAAsB,GAAG,SAAS,CAAA;aACvC;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,KAAK,EAAE,aAAa;aACpB,CAAC,CAAA;YACF,IAAI,CAAC,mBAAmB,EAAE,CAAA;YAE1B,QAAQ,CAAC,mBAAmB,GAAG,sBAAsB,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;QAC3G,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,wEAAwE;YACxE,IAAI,yBAAyB,GAAG,KAAK,CAAA;YACrC,IAAI,QAAQ,CAAC,mBAAmB,EAAE;gBACjC,KAAK,MAAM,EAAE,IAAI,QAAQ,CAAC,mBAAmB,EAAE;oBAC9C,IAAI,mBAAmB,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE;wBACjD,yBAAyB,GAAG,IAAI,CAAA;wBAChC,MAAK;qBACL;iBACD;aACD;YAED,6BAA6B;YAC7B,IAAI,yBAAyB,IAAI,mBAAmB,CAAC,YAAY,EAAE;gBAClE,YAAY,CAAC,GAAG,EAAE;oBACjB,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAA;gBAC/B,CAAC,CAAC,CAAA;aACF;QACF,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,mBAAmB,GAAG,IAAA,qBAAU,EAC/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;YACvB,IAAI,CAAC,qBAAqB,CAAC;gBAC1B,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;aACtC,CAAC,CAAA;SACF;IACF,CAAC,EACD;QACC,IAAI,EAAE,CAAC;QACP,OAAO,EAAE,EAAE;KACX,CACD,CAAA;IAED,sBAAsB,CAAC,SAAuC;QAC7D,MAAM,aAAa,GAA+C,EAAE,CAAA;QAEpE,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAA;QAEjC,KAAK,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YAC/D,IAAI,QAAQ,EAAE;gBACb,aAAa,CAAC,IAAI,CAAC;oBAClB,EAAE,EAAE,UAAU;oBACd,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,WAAW,EAAE,QAAQ,CAAC,WAAW;oBACjC,OAAO,EAAE,IAAA,+BAAoB,EAAC,QAAQ,CAAC,OAAO,CAAC;oBAC/C,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,YAAY,EAAE,cAAc,IAAI,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS;oBAC5E,QAAQ,EAAE,CAAC,CAAC,QAAQ,CAAC,KAAK;iBAC1B,CAAC,CAAA;gBAEF,kCAAkC;gBAClC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;aACnD;SACD;QAED,IAAI,CAAC,uBAAuB,CAAC,EAAE,SAAS,EAAE,aAAa,EAAE,CAAC,CAAA;IAC3D,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;YAC/D,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YACrE,IAAI,UAAU,EAAE;gBACf,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,KAAK,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;oBACvD,4BAA4B;oBAC5B,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAA;iBAC9B;aACD;SACD;IACF,CAAC;IAED,kBAAkB,CAAC,WAAqB;QACvC,KAAK,MAAM,EAAE,IAAI,WAAW,EAAE;YAC7B,4BAA4B;YAC5B,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAA;SAC9B;IACF,CAAC;IAED,kBAAkB;IAClB,gBAAgB;QACf,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,MAAM,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;YAChE,EAAE,EAAE,EAAE,CAAC,EAAE;YACT,UAAU,EAAE,EAAE,CAAC,UAAU;YACzB,SAAS,EAAE,EAAE,CAAC,SAAS;YACvB,OAAO,EAAE,EAAE,CAAC,OAAO;SACnB,CAAC,CAAC,CAAA;IACJ,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;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,CAAA;YACxD,IAAI,GAAG,EAAE,SAAS,EAAE;gBACnB,MAAM,OAAO,GAA6B;oBACzC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;wBAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC;4BAC9C,IAAI,EAAE,IAAI;4BACV,SAAS,EAAE,EAAE,CAAC,SAAS;4BACvB,gBAAgB,EAAE,SAAS;4BAC3B,kBAAkB,EAAE,EAAE,CAAC,EAAE;yBACzB,CAAC,CAAA;wBAEF,OAAO,GAAG,CAAC,IAAI,CAAA;oBAChB,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,IAAI,CAAC,OAAO,EAAE,8BAA8B,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;gBACxG,CAAC,CAAC,CAAA;aACF;SACD;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;YAC3B,MAAM,GAAG,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,UAAU,CAAC,CAAA;YACxD,IAAI,GAAG,IAAI,GAAG,CAAC,WAAW,EAAE;gBAC3B,MAAM,OAAO,GAA6B;oBACzC,sBAAsB,EAAE,KAAK,EAAE,IAAY,EAAmB,EAAE;wBAC/D,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC;4BAC9C,IAAI,EAAE,IAAI;4BACV,SAAS,EAAE,EAAE,CAAC,SAAS;4BACvB,gBAAgB,EAAE,SAAS;4BAC3B,kBAAkB,EAAE,EAAE,CAAC,EAAE;yBACzB,CAAC,CAAA;wBAEF,OAAO,GAAG,CAAC,IAAI,CAAA;oBAChB,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,IAAI,CAAC,OAAO,EAAE,gCAAgC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;gBAC1G,CAAC,CAAC,CAAA;aACF;SACD;IACF,CAAC;CACD;AA7bD,0CA6bC"}

package/dist/internal/legacy.d.ts

@@ -0,0 +1,24 @@
+import { InputValue } from '../module-api';
+/**
+ * @deprecated
+ */
+export interface LegacyAction {
+    id: string;
+    actionId: string;
+    controlId: string;
+    options: {
+        [key: string]: InputValue | undefined;
+    };
+}
+/**
+ * @deprecated
+ */
+export interface LegacyFeedback {
+    id: string;
+    feedbackId: string;
+    controlId: string;
+    options: {
+        [key: string]: InputValue | undefined;
+    };
+}
+//# sourceMappingURL=legacy.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"legacy.d.ts","sourceRoot":"","sources":["../../src/internal/legacy.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAE1C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA;KAAE,CAAA;CAClD;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,UAAU,EAAE,MAAM,CAAA;IAClB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA;KAAE,CAAA;CAClD"}

package/dist/internal/legacy.js

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

package/dist/internal/legacy.js.map

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

package/dist/internal/newapi.d.ts

@@ -0,0 +1,48 @@
+import type { OSCSomeArguments } from '../common/osc';
+import type { CompanionActionDefinitions, CompanionActionInfo, CompanionFeedbackDefinitions, CompanionPresetDefinitions, CompanionVariableDefinition, CompanionVariableValue, CompanionVariableValues, InstanceBase, InstanceStatus, LogLevel } from '../module-api';
+import { LegacyAction, LegacyFeedback } from './legacy';
+export interface IActionManager {
+    setActionDefinitions(actions: CompanionActionDefinitions): void;
+    /** @deprecated */
+    _getAllActions(): LegacyAction[];
+    subscribeActions(actionIds: string[]): void;
+    unsubscribeActions(actionIds: string[]): void;
+}
+export interface IFeedbackManager {
+    parseVariablesContext: string | undefined;
+    getDefinitionIds(): string[];
+    getInstanceIds(): string[];
+    setFeedbackDefinitions(feedbacks: CompanionFeedbackDefinitions): void;
+    checkFeedbacks(feedbackTypes: string[]): void;
+    checkFeedbacksById(feedbackIds: string[]): void;
+    /** @deprecated */
+    _getAllFeedbacks(): LegacyFeedback[];
+    subscribeFeedbacks(feedbackIds: string[]): void;
+    unsubscribeFeedbacks(feedbackIds: string[]): void;
+}
+export interface InstanceBaseOptions {
+    /**
+     * Disable enforcement of variables requiring a definition.
+     * It is not recommended to set this, unless you know what you are doing.
+     */
+    disableVariableValidation: boolean;
+}
+export interface CompanionInstanceApi<TConfig> {
+    readonly connectionId: string;
+    readonly actionManager: IActionManager;
+    readonly feedbackManager: IFeedbackManager;
+    readonly instanceOptions: InstanceBaseOptions;
+    setInstance(instance: InstanceBase<TConfig>): void;
+    saveConfig(newConfig: TConfig): void;
+    setPresetDefinitions(presets: CompanionPresetDefinitions): void;
+    setVariableDefinitions(variables: CompanionVariableDefinition[]): void;
+    setVariableValues(values: CompanionVariableValues): void;
+    getVariableValue(variableId: string): CompanionVariableValue | undefined;
+    parseVariablesInString(text: string): Promise<string>;
+    recordAction(action: Omit<CompanionActionInfo, 'id' | 'controlId'>, uniquenessId?: string): void;
+    setCustomVariableValue(variableName: string, value: CompanionVariableValue): void;
+    oscSend(host: string, port: number, path: string, args: OSCSomeArguments): void;
+    updateStatus(status: InstanceStatus, message?: string | null): void;
+    log(level: LogLevel, message: string): void;
+}
+//# sourceMappingURL=newapi.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"newapi.d.ts","sourceRoot":"","sources":["../../src/internal/newapi.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AACrD,OAAO,KAAK,EACX,0BAA0B,EAC1B,mBAAmB,EACnB,4BAA4B,EAC5B,0BAA0B,EAC1B,2BAA2B,EAC3B,sBAAsB,EACtB,uBAAuB,EACvB,YAAY,EACZ,cAAc,EACd,QAAQ,EACR,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,UAAU,CAAA;AAEvD,MAAM,WAAW,cAAc;IAC9B,oBAAoB,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI,CAAA;IAE/D,kBAAkB;IAClB,cAAc,IAAI,YAAY,EAAE,CAAA;IAEhC,gBAAgB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAE3C,kBAAkB,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;CAC7C;AAED,MAAM,WAAW,gBAAgB;IAChC,qBAAqB,EAAE,MAAM,GAAG,SAAS,CAAA;IAEzC,gBAAgB,IAAI,MAAM,EAAE,CAAA;IAC5B,cAAc,IAAI,MAAM,EAAE,CAAA;IAE1B,sBAAsB,CAAC,SAAS,EAAE,4BAA4B,GAAG,IAAI,CAAA;IAErE,cAAc,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAE7C,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAE/C,kBAAkB;IAClB,gBAAgB,IAAI,cAAc,EAAE,CAAA;IAEpC,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;IAE/C,oBAAoB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,IAAI,CAAA;CACjD;AAED,MAAM,WAAW,mBAAmB;IACnC;;;OAGG;IACH,yBAAyB,EAAE,OAAO,CAAA;CAClC;AAED,MAAM,WAAW,oBAAoB,CAAC,OAAO;IAC5C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAA;IAE7B,QAAQ,CAAC,aAAa,EAAE,cAAc,CAAA;IACtC,QAAQ,CAAC,eAAe,EAAE,gBAAgB,CAAA;IAE1C,QAAQ,CAAC,eAAe,EAAE,mBAAmB,CAAA;IAE7C,WAAW,CAAC,QAAQ,EAAE,YAAY,CAAC,OAAO,CAAC,GAAG,IAAI,CAAA;IAElD,UAAU,CAAC,SAAS,EAAE,OAAO,GAAG,IAAI,CAAA;IAEpC,oBAAoB,CAAC,OAAO,EAAE,0BAA0B,GAAG,IAAI,CAAA;IAE/D,sBAAsB,CAAC,SAAS,EAAE,2BAA2B,EAAE,GAAG,IAAI,CAAA;IAEtE,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,IAAI,CAAA;IAExD,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS,CAAA;IAExE,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAErD,YAAY,CAAC,MAAM,EAAE,IAAI,CAAC,mBAAmB,EAAE,IAAI,GAAG,WAAW,CAAC,EAAE,YAAY,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAEhG,sBAAsB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,sBAAsB,GAAG,IAAI,CAAA;IAEjF,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,IAAI,CAAA;IAE/E,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;IAEnE,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;CAC3C"}

package/dist/internal/newapi.js

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

package/dist/internal/newapi.js.map

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

package/dist/internal/properties.d.ts

@@ -0,0 +1,11 @@
+import { CompanionPropertyDefinitions } from '../module-api/properties';
+import { PropertySetMessage, SetPropertyDefinitionsMessage, UpdatePropertyValuesMessage } from '../host-api/api';
+import { DropdownChoiceId, LogLevel } from '../module-api';
+export declare class PropertyManager {
+    #private;
+    constructor(updatePropertyValues: (msg: UpdatePropertyValuesMessage) => void, setPropertyDefinitions: (msg: SetPropertyDefinitionsMessage) => void, log: (level: LogLevel, message: string) => void);
+    propertySet(msg: PropertySetMessage): Promise<void>;
+    setPropertyDefinitions(properties: CompanionPropertyDefinitions): void;
+    notifyPropertiesChanged(changes: Record<string, DropdownChoiceId[] | null>): void;
+}
+//# sourceMappingURL=properties.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"properties.d.ts","sourceRoot":"","sources":["../../src/internal/properties.ts"],"names":[],"mappings":"AAAA,OAAO,EAGN,4BAA4B,EAE5B,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,kBAAkB,EAAE,6BAA6B,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAA;AAChH,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAA;AAO1D,qBAAa,eAAe;;gBAa1B,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;IAO1C,WAAW,CAAC,GAAG,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IAqFzD,sBAAsB,CAAC,UAAU,EAAE,4BAA4B,GAAG,IAAI;IA6CtE,uBAAuB,CAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,gBAAgB,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI;CAKjF"}

package/dist/internal/properties.js

@@ -0,0 +1,130 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PropertyManager = void 0;
+const tslib_1 = require("tslib");
+const debounce_fn_1 = tslib_1.__importDefault(require("debounce-fn"));
+class PropertyManager {
+    #updatePropertyValues;
+    #setPropertyDefinitions;
+    #log;
+    #propertyDefinitions = new Map();
+    // Property values waiting to be sent
+    #pendingPropertyValues = new Map();
+    // Properties currently being checked
+    #propertiesBeingChecked = new Map();
+    constructor(updatePropertyValues, setPropertyDefinitions, log) {
+        this.#updatePropertyValues = updatePropertyValues;
+        this.#setPropertyDefinitions = setPropertyDefinitions;
+        this.#log = log;
+    }
+    async propertySet(msg) {
+        const propertyDefinition = this.#propertyDefinitions.get(msg.property.propertyId);
+        if (!propertyDefinition)
+            throw new Error(`Unknown property: ${msg.property.propertyId}`);
+        if (!propertyDefinition.setValue)
+            throw new Error(`Property is readonly: ${msg.property.propertyId}`);
+        // TODO - type safety?
+        await propertyDefinition.setValue(msg.property.instanceId, msg.property.value, null);
+    }
+    #triggerCheckProperty(id) {
+        const existingRecheck = this.#propertiesBeingChecked.get(id);
+        if (existingRecheck) {
+            // Already being checked
+            existingRecheck.needsRecheck = true;
+            return;
+        }
+        const propertyCheckStatus = {
+            needsRecheck: false,
+        };
+        // mark it as being checked
+        this.#propertiesBeingChecked.set(id, propertyCheckStatus);
+        Promise.resolve()
+            .then(async () => {
+            const definition = this.#propertyDefinitions.get(id);
+            let values = Promise.resolve(undefined);
+            // Calculate the new value for the feedback
+            if (definition && definition.getValues) {
+                values = definition.getValues(null);
+            }
+            // Await the value before looking at this.#pendingFeedbackValues, to avoid race conditions
+            const resolvedValues = await values;
+            this.#pendingPropertyValues.set(id, {
+                id: id,
+                isSingleValue: !definition?.instanceIds,
+                values: resolvedValues,
+            });
+            this.#sendPropertyValues();
+        })
+            .catch((e) => {
+            console.error(`Property check failed: ${JSON.stringify({})} - ${e?.message ?? e} ${e?.stack}`);
+        })
+            .finally(() => {
+            // it is no longer being checked
+            this.#propertiesBeingChecked.delete(id);
+            // If queued, trigger a check
+            if (propertyCheckStatus.needsRecheck) {
+                setImmediate(() => {
+                    this.#triggerCheckProperty(id);
+                });
+            }
+        });
+    }
+    /**
+     * Send pending feedback values (from this.#pendingFeedbackValues) to companion, with a debounce
+     */
+    #sendPropertyValues = (0, debounce_fn_1.default)(() => {
+        const newValues = this.#pendingPropertyValues;
+        this.#pendingPropertyValues = new Map();
+        // Send the new values back
+        if (newValues.size > 0) {
+            this.#updatePropertyValues({
+                values: Array.from(newValues.values()),
+            });
+        }
+    }, {
+        wait: 5,
+        maxWait: 25,
+    });
+    setPropertyDefinitions(properties) {
+        const hostProperties = [];
+        this.#propertyDefinitions.clear();
+        const propertyIds = new Set();
+        for (const [propertyId, property] of Object.entries(properties)) {
+            if (property) {
+                const newProperty = {
+                    id: propertyId,
+                    name: property.name,
+                    description: property.description,
+                    type: property.type,
+                    instanceIds: property.instanceIds ?? null,
+                    hasGetter: !!property.getValues,
+                    hasSetter: !!property.setValue,
+                    // type specific fields
+                    // TODO - type these better
+                    choices: property.choices,
+                    allowCustom: property.allowCustom,
+                    regex: property.regex,
+                    min: property.min,
+                    max: property.max,
+                    step: property.step,
+                    range: property.range,
+                };
+                hostProperties.push(newProperty);
+                // Remember the definition locally
+                this.#propertyDefinitions.set(propertyId, property);
+                propertyIds.add(propertyId);
+            }
+        }
+        this.#setPropertyDefinitions({ properties: hostProperties });
+        for (const propertyId of propertyIds) {
+            this.#triggerCheckProperty(propertyId);
+        }
+    }
+    notifyPropertiesChanged(changes) {
+        for (const id of Object.keys(changes)) {
+            this.#triggerCheckProperty(id);
+        }
+    }
+}
+exports.PropertyManager = PropertyManager;
+//# sourceMappingURL=properties.js.map

package/dist/internal/properties.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"properties.js","sourceRoot":"","sources":["../../src/internal/properties.ts"],"names":[],"mappings":";;;;AAQA,sEAAoC;AAMpC,MAAa,eAAe;IAClB,qBAAqB,CAA4C;IACjE,uBAAuB,CAA8C;IACrE,IAAI,CAA4C;IAEhD,oBAAoB,GAAG,IAAI,GAAG,EAAuC,CAAA;IAE9E,qCAAqC;IACrC,sBAAsB,GAAG,IAAI,GAAG,EAAoD,CAAA;IACpF,qCAAqC;IACrC,uBAAuB,GAAG,IAAI,GAAG,EAA+B,CAAA;IAEhE,YACC,oBAAgE,EAChE,sBAAoE,EACpE,GAA+C;QAE/C,IAAI,CAAC,qBAAqB,GAAG,oBAAoB,CAAA;QACjD,IAAI,CAAC,uBAAuB,GAAG,sBAAsB,CAAA;QACrD,IAAI,CAAC,IAAI,GAAG,GAAG,CAAA;IAChB,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,GAAuB;QACxC,MAAM,kBAAkB,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAEpE,CAAA;QAEZ,IAAI,CAAC,kBAAkB;YAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,GAAG,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAA;QACxF,IAAI,CAAC,kBAAkB,CAAC,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,yBAAyB,GAAG,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAA;QAErG,sBAAsB;QAEtB,MAAM,kBAAkB,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAA;IACrF,CAAC;IAED,qBAAqB,CAAC,EAAU;QAC/B,MAAM,eAAe,GAAG,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;QAC5D,IAAI,eAAe,EAAE;YACpB,wBAAwB;YACxB,eAAe,CAAC,YAAY,GAAG,IAAI,CAAA;YACnC,OAAM;SACN;QAED,MAAM,mBAAmB,GAAwB;YAChD,YAAY,EAAE,KAAK;SACnB,CAAA;QACD,2BAA2B;QAC3B,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,EAAE,EAAE,mBAAmB,CAAC,CAAA;QAEzD,OAAO,CAAC,OAAO,EAAE;aACf,IAAI,CAAC,KAAK,IAAI,EAAE;YAChB,MAAM,UAAU,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,EAAE,CAAC,CAAA;YAEpD,IAAI,MAAM,GACT,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;YAE3B,2CAA2C;YAC3C,IAAI,UAAU,IAAI,UAAU,CAAC,SAAS,EAAE;gBACvC,MAAM,GAAG,UAAU,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;aACnC;YAED,0FAA0F;YAC1F,MAAM,cAAc,GAAG,MAAM,MAAM,CAAA;YACnC,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,EAAE;gBACnC,EAAE,EAAE,EAAE;gBACN,aAAa,EAAE,CAAC,UAAU,EAAE,WAAW;gBACvC,MAAM,EAAE,cAAc;aACtB,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,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,IAAI,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAA;QAC/F,CAAC,CAAC;aACD,OAAO,CAAC,GAAG,EAAE;YACb,gCAAgC;YAChC,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;YAEvC,6BAA6B;YAC7B,IAAI,mBAAmB,CAAC,YAAY,EAAE;gBACrC,YAAY,CAAC,GAAG,EAAE;oBACjB,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAA;gBAC/B,CAAC,CAAC,CAAA;aACF;QACF,CAAC,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACH,mBAAmB,GAAG,IAAA,qBAAU,EAC/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;YACvB,IAAI,CAAC,qBAAqB,CAAC;gBAC1B,MAAM,EAAE,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,CAAC;aACtC,CAAC,CAAA;SACF;IACF,CAAC,EACD;QACC,IAAI,EAAE,CAAC;QACP,OAAO,EAAE,EAAE;KACX,CACD,CAAA;IAED,sBAAsB,CAAC,UAAwC;QAC9D,MAAM,cAAc,GAAgD,EAAE,CAAA;QAEtE,IAAI,CAAC,oBAAoB,CAAC,KAAK,EAAE,CAAA;QAEjC,MAAM,WAAW,GAAG,IAAI,GAAG,EAAU,CAAA;QACrC,KAAK,MAAM,CAAC,UAAU,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAChE,IAAI,QAAQ,EAAE;gBACb,MAAM,WAAW,GAA+B;oBAC/C,EAAE,EAAE,UAAU;oBACd,IAAI,EAAE,QAAQ,CAAC,IAAI;oBACnB,WAAW,EAAE,QAAQ,CAAC,WAAW;oBACjC,IAAI,EAAE,QAAQ,CAAC,IAAI;oBAEnB,WAAW,EAAE,QAAQ,CAAC,WAAW,IAAI,IAAI;oBAEzC,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,SAAS;oBAC/B,SAAS,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ;oBAE9B,uBAAuB;oBACvB,2BAA2B;oBAC3B,OAAO,EAAG,QAAgB,CAAC,OAAO;oBAClC,WAAW,EAAG,QAAgB,CAAC,WAAW;oBAC1C,KAAK,EAAG,QAAgB,CAAC,KAAK;oBAC9B,GAAG,EAAG,QAAgB,CAAC,GAAG;oBAC1B,GAAG,EAAG,QAAgB,CAAC,GAAG;oBAC1B,IAAI,EAAG,QAAgB,CAAC,IAAI;oBAC5B,KAAK,EAAG,QAAgB,CAAC,KAAK;iBAC9B,CAAA;gBAED,cAAc,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;gBAEhC,kCAAkC;gBAClC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAA;gBACnD,WAAW,CAAC,GAAG,CAAC,UAAU,CAAC,CAAA;aAC3B;SACD;QAED,IAAI,CAAC,uBAAuB,CAAC,EAAE,UAAU,EAAE,cAAc,EAAE,CAAC,CAAA;QAE5D,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;YACrC,IAAI,CAAC,qBAAqB,CAAC,UAAU,CAAC,CAAA;SACtC;IACF,CAAC;IAED,uBAAuB,CAAC,OAAkD;QACzE,KAAK,MAAM,EAAE,IAAI,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE;YACtC,IAAI,CAAC,qBAAqB,CAAC,EAAE,CAAC,CAAA;SAC9B;IACF,CAAC;CACD;AA7JD,0CA6JC"}