@companion-module/base 1.0.2 → 1.1.0

package/dist/module-api/base.js

@@ -2,12 +2,13 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InstanceBase = void 0;
 const tslib_1 = require("tslib");
-const util_js_1 = require("../util.js");
+const util_1 = require("../util");
 const p_queue_1 = tslib_1.__importDefault(require("p-queue"));
-const base_js_1 = require("../internal/base.js");
-const upgrade_js_1 = require("../internal/upgrade.js");
-const feedback_js_1 = require("../internal/feedback.js");
-const ipc_wrapper_js_1 = require("../host-api/ipc-wrapper.js");
+const base_1 = require("../internal/base");
+const upgrade_1 = require("../internal/upgrade");
+const feedback_1 = require("../internal/feedback");
+const ipc_wrapper_1 = require("../host-api/ipc-wrapper");
+const actions_1 = require("../internal/actions");
 class InstanceBase {
     #ipcWrapper;
     #upgradeScripts;
@@ -15,11 +16,9 @@ class InstanceBase {
     #lifecycleQueue = new p_queue_1.default({ concurrency: 1 });
     #initialized = false;
     #recordingActions = false;
-    #actionDefinitions = new Map();
-    #feedbackDefinitions = new Map();
+    #actionManager;
+    #feedbackManager;
     #variableDefinitions = new Map();
-    #feedbackInstances = new Map();
-    #actionInstances = new Map();
     #variableValues = new Map();
     #options;
     get instanceOptions() {
@@ -29,12 +28,12 @@ class InstanceBase {
      * Create an instance of the module
      */
     constructor(internal) {
-        if (!(0, base_js_1.isInstanceBaseProps)(internal) || !internal._isInstanceBaseProps)
+        if (!(0, base_1.isInstanceBaseProps)(internal) || !internal._isInstanceBaseProps)
             throw new Error(`Module instance is being constructed incorrectly. Make sure you aren't trying to do this manually`);
         this.#options = {
             disableVariableValidation: false,
         };
-        this.#ipcWrapper = new ipc_wrapper_js_1.IpcWrapper({
+        this.#ipcWrapper = new ipc_wrapper_1.IpcWrapper({
             init: this._handleInit.bind(this),
             destroy: this._handleDestroy.bind(this),
             updateConfig: this._handleConfigUpdate.bind(this),
@@ -46,12 +45,15 @@ class InstanceBase {
             learnAction: this._handleLearnAction.bind(this),
             learnFeedback: this._handleLearnFeedback.bind(this),
             startStopRecordActions: this._handleStartStopRecordActions.bind(this),
+            variablesChanged: this._handleVariablesChanged.bind(this),
         }, (msg) => {
             process.send(msg);
         }, 5000);
         process.on('message', (msg) => {
             this.#ipcWrapper.receivedMessage(msg);
         });
+        this.#actionManager = new actions_1.ActionManager(async (msg) => this.#ipcWrapper.sendWithCb('parseVariablesInString', msg), (msg) => this.#ipcWrapper.sendWithNoCb('setActionDefinitions', msg), this.log.bind(this));
+        this.#feedbackManager = new feedback_1.FeedbackManager(async (msg) => this.#ipcWrapper.sendWithCb('parseVariablesInString', msg), (msg) => this.#ipcWrapper.sendWithNoCb('updateFeedbackValues', msg), (msg) => this.#ipcWrapper.sendWithNoCb('setFeedbackDefinitions', msg), this.log.bind(this));
         this.#upgradeScripts = internal.upgradeScripts;
         this.id = internal.id;
         this.log('debug', 'Initializing');
@@ -79,7 +81,7 @@ class InstanceBase {
              * Performing upgrades during init requires a fair chunk of work.
              * Some actions/feedbacks will be using the upgradeIndex of the instance, but some may have their own upgradeIndex on themselves if they are from an import.
              */
-            const { updatedActions, updatedFeedbacks, updatedConfig } = (0, upgrade_js_1.runThroughUpgradeScripts)(actions, feedbacks, msg.lastUpgradeIndex, this.#upgradeScripts, config);
+            const { updatedActions, updatedFeedbacks, updatedConfig } = (0, upgrade_1.runThroughUpgradeScripts)(actions, feedbacks, msg.lastUpgradeIndex, this.#upgradeScripts, config);
             config = updatedConfig ?? config;
             // Send the upgraded data back to companion now. Just so that if the init crashes, this doesnt have to be repeated
             const pSendUpgrade = this.#ipcWrapper.sendWithCb('upgradedItems', {
@@ -101,8 +103,12 @@ class InstanceBase {
             }
             setImmediate(() => {
                 // Subscribe all of the actions and feedbacks
-                this._handleUpdateActions({ actions }, true);
-                this._handleUpdateFeedbacks({ feedbacks }, true);
+                this._handleUpdateActions({ actions }, true).catch((e) => {
+                    this.log('error', `Receive actions failed: ${e}`);
+                });
+                this._handleUpdateFeedbacks({ feedbacks }, true).catch((e) => {
+                    this.log('error', `Receive feedbacks failed: ${e}`);
+                });
             });
             return {
                 hasHttpHandler: typeof this.handleHttpRequest === 'function',
@@ -128,130 +134,41 @@ class InstanceBase {
         });
     }
     async _handleExecuteAction(msg) {
-        const actionDefinition = this.#actionDefinitions.get(msg.action.actionId);
-        if (!actionDefinition)
-            throw new Error(`Unknown action: ${msg.action.actionId}`);
-        await actionDefinition.callback({
-            id: msg.action.id,
-            actionId: msg.action.actionId,
-            controlId: msg.action.controlId,
-            options: msg.action.options,
-            _deviceId: msg.deviceId,
-            _page: msg.action.page,
-            _bank: msg.action.bank,
-        });
+        return this.#actionManager.handleExecuteAction(msg);
     }
     async _handleUpdateFeedbacks(msg, skipUpgrades) {
-        const newValues = [];
         // Run through upgrade scripts if needed
         if (!skipUpgrades) {
-            (0, upgrade_js_1.runThroughUpgradeScripts)({}, msg.feedbacks, null, this.#upgradeScripts, undefined);
-        }
-        for (const [id, feedback] of Object.entries(msg.feedbacks)) {
-            const existing = this.#feedbackInstances.get(id);
-            if (existing) {
-                // Call unsubscribe
-                const definition = this.#feedbackDefinitions.get(existing.feedbackId);
-                if (definition?.unsubscribe) {
-                    try {
-                        definition.unsubscribe((0, feedback_js_1.convertFeedbackInstanceToEvent)(definition.type, existing));
-                    }
-                    catch (e) {
-                        console.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 or updated
-                const definition = this.#feedbackDefinitions.get(feedback.feedbackId);
-                if (definition?.subscribe) {
-                    try {
-                        definition.subscribe((0, feedback_js_1.convertFeedbackInstanceToEvent)(definition.type, feedback));
-                    }
-                    catch (e) {
-                        console.error(`Feedback subscribe failed: ${JSON.stringify(feedback)} - ${e?.message ?? e} ${e?.stack}`);
-                    }
-                }
-                // Calculate the new value for the feedback
-                if (definition) {
-                    let value;
-                    try {
-                        value = (0, feedback_js_1.callFeedbackOnDefinition)(definition, feedback);
-                    }
-                    catch (e) {
-                        console.error(`Feedback check failed: ${JSON.stringify(feedback)} - ${e?.message ?? e} ${e?.stack}`);
-                    }
-                    if (value instanceof Promise) {
-                        value = undefined;
-                        console.error(`Feedback check returned Promise, this is not allowed: ${JSON.stringify(feedback)}`);
-                    }
-                    newValues.push({
-                        id: id,
-                        controlId: feedback.controlId,
-                        value: value,
-                    });
-                }
-            }
-        }
-        // Send the new values back
-        if (Object.keys(newValues).length > 0) {
-            this.#ipcWrapper.sendWithNoCb('updateFeedbackValues', {
-                values: newValues,
+            const res = (0, upgrade_1.runThroughUpgradeScripts)({}, msg.feedbacks, null, this.#upgradeScripts, undefined);
+            this.#ipcWrapper
+                .sendWithCb('upgradedItems', {
+                updatedActions: res.updatedActions,
+                updatedFeedbacks: res.updatedFeedbacks,
+            })
+                .catch((e) => {
+                this.log('error', `Failed to save upgraded feedbacks: ${e}`);
             });
         }
+        this.#feedbackManager.handleUpdateFeedbacks(msg.feedbacks);
     }
     async _handleUpdateActions(msg, skipUpgrades) {
         // Run through upgrade scripts if needed
         if (!skipUpgrades) {
-            // const pendingUpgrades = Object.values(msg.actions).filter((act) => typeof act?.upgradeIndex === 'number')
-            // if (pendingUpgrades.length > 0) {
-            // 	//
-            // }
-            (0, upgrade_js_1.runThroughUpgradeScripts)(msg.actions, {}, null, this.#upgradeScripts, undefined);
-        }
-        for (const [id, action] of Object.entries(msg.actions)) {
-            const existing = this.#actionInstances.get(id);
-            if (existing) {
-                // Call unsubscribe
-                const definition = this.#actionDefinitions.get(existing.actionId);
-                if (definition?.unsubscribe) {
-                    try {
-                        definition.unsubscribe(existing);
-                    }
-                    catch (e) {
-                        console.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) {
-                    try {
-                        definition.subscribe(action);
-                    }
-                    catch (e) {
-                        console.error(`Action subscribe failed: ${JSON.stringify(action)} - ${e?.message ?? e} ${e?.stack}`);
-                    }
-                }
-            }
+            const res = (0, upgrade_1.runThroughUpgradeScripts)(msg.actions, {}, null, this.#upgradeScripts, undefined);
+            this.#ipcWrapper
+                .sendWithCb('upgradedItems', {
+                updatedActions: res.updatedActions,
+                updatedFeedbacks: res.updatedFeedbacks,
+            })
+                .catch((e) => {
+                this.log('error', `Failed to save upgraded actions: ${e}`);
+            });
         }
+        this.#actionManager.handleUpdateActions(msg.actions);
     }
     async _handleGetConfigFields(_msg) {
         return {
-            fields: (0, base_js_1.serializeIsVisibleFn)(this.getConfigFields()),
+            fields: (0, base_1.serializeIsVisibleFn)(this.getConfigFields()),
         };
     }
     async _handleHttpRequest(msg) {
@@ -261,48 +178,10 @@ class InstanceBase {
         return { response: res };
     }
     async _handleLearnAction(msg) {
-        const definition = this.#actionDefinitions.get(msg.action.actionId);
-        if (definition && definition.learn) {
-            const newOptions = await definition.learn({
-                id: msg.action.id,
-                actionId: msg.action.actionId,
-                controlId: msg.action.controlId,
-                options: msg.action.options,
-                _deviceId: undefined,
-                _page: msg.action.page,
-                _bank: msg.action.bank,
-            });
-            return {
-                options: newOptions,
-            };
-        }
-        else {
-            // Not supported
-            return {
-                options: undefined,
-            };
-        }
+        return this.#actionManager.handleLearnAction(msg);
     }
     async _handleLearnFeedback(msg) {
-        const definition = this.#feedbackDefinitions.get(msg.feedback.feedbackId);
-        if (definition && definition.learn) {
-            const newOptions = await definition.learn({
-                id: msg.feedback.id,
-                feedbackId: msg.feedback.feedbackId,
-                controlId: msg.feedback.controlId,
-                options: msg.feedback.options,
-                type: definition.type,
-            });
-            return {
-                options: newOptions,
-            };
-        }
-        else {
-            // Not supported
-            return {
-                options: undefined,
-            };
-        }
+        return this.#feedbackManager.handleLearnFeedback(msg);
     }
     async _handleStartStopRecordActions(msg) {
         if (!msg.recording) {
@@ -324,6 +203,9 @@ class InstanceBase {
         this.#recordingActions = msg.recording;
         this.handleStartStopRecordActions(this.#recordingActions);
     }
+    async _handleVariablesChanged(msg) {
+        this.#feedbackManager.handleVariablesChanged(msg);
+    }
     /**
      * Save an updated configuration object
      * @param newConfig The new config object
@@ -336,46 +218,14 @@ class InstanceBase {
      * @param actions The action definitions
      */
     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),
-                    hasLearn: !!action.learn,
-                });
-                // Remember the definition locally
-                this.#actionDefinitions.set(actionId, action);
-            }
-        }
-        this.#ipcWrapper.sendWithNoCb('setActionDefinitions', { actions: hostActions });
+        this.#actionManager.setActionDefinitions(actions);
     }
     /**
      * Set the feedback definitions for this instance
      * @param feedbacks The feedback definitions
      */
     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_js_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.#ipcWrapper.sendWithNoCb('setFeedbackDefinitions', { feedbacks: hostFeedbacks });
+        this.#feedbackManager.setFeedbackDefinitions(feedbacks);
     }
     /**
      * Set the peset definitions for this instance
@@ -471,11 +321,23 @@ class InstanceBase {
     }
     /**
      * Parse and replace all the variables in a string
+     * Note: You must not use this for feedbacks, as your feedback will not update when the variable changes.
+     * There is an alternate version of this supplied to each of the action/feedback callbacks that tracks
+     * usages properly and will retrigger the feedback when the variables change.
      * @param text The text to parse
      * @returns The string with variables replaced with their values
      */
     async parseVariablesInString(text) {
-        const res = await this.#ipcWrapper.sendWithCb('parseVariablesInString', { text: text });
+        const currentContext = this.#feedbackManager.parseVariablesContext;
+        if (currentContext) {
+            this.log('debug', `parseVariablesInString called while in: ${currentContext}. You should use the parseVariablesInString provided to the callback instead`);
+        }
+        const res = await this.#ipcWrapper.sendWithCb('parseVariablesInString', {
+            text: text,
+            controlId: undefined,
+            actionInstanceId: undefined,
+            feedbackInstanceId: undefined,
+        });
         return res.text;
     }
     /**
@@ -483,84 +345,18 @@ class InstanceBase {
      * @param feedbackTypes The feedback types to check
      */
     checkFeedbacks(...feedbackTypes) {
-        const newValues = [];
-        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)) {
-                    // Not to be considered
-                    continue;
-                }
-                try {
-                    // Calculate the new value for the feedback
-                    let value = (0, feedback_js_1.callFeedbackOnDefinition)(definition, feedback);
-                    if (value instanceof Promise) {
-                        value = undefined;
-                        console.error(`Feedback check returned Promise, this is not allowed: ${JSON.stringify(feedback)}`);
-                    }
-                    newValues.push({
-                        id: id,
-                        controlId: feedback.controlId,
-                        value: value,
-                    });
-                }
-                catch (e) {
-                    console.error(`Feedback check failed: ${JSON.stringify(feedback)} - ${e?.message ?? e} ${e?.stack}`);
-                }
-            }
-        }
-        // Send the new values back
-        if (Object.keys(newValues).length > 0) {
-            this.#ipcWrapper.sendWithNoCb('updateFeedbackValues', {
-                values: newValues,
-            });
-        }
+        this.#feedbackManager.checkFeedbacks(feedbackTypes);
     }
     /**
      * Request the specified feedback instances to be checked for changes
      * @param feedbackIds The ids of the feedback instances to check
      */
     checkFeedbacksById(...feedbackIds) {
-        const newValues = [];
-        for (const id of feedbackIds) {
-            const feedback = this.#feedbackInstances.get(id);
-            const definition = feedback && this.#feedbackDefinitions.get(feedback.feedbackId);
-            if (feedback && definition) {
-                try {
-                    // Calculate the new value for the feedback
-                    let value = (0, feedback_js_1.callFeedbackOnDefinition)(definition, feedback);
-                    if (value instanceof Promise) {
-                        value = undefined;
-                        console.error(`Feedback check returned Promise, this is not allowed: ${JSON.stringify(feedback)}`);
-                    }
-                    // Calculate the new value for the feedback
-                    newValues.push({
-                        id: id,
-                        controlId: feedback.controlId,
-                        value: value,
-                    });
-                }
-                catch (e) {
-                    console.error(`Feedback check failed: ${JSON.stringify(feedback)} - ${e?.message ?? e} ${e?.stack}`);
-                }
-            }
-        }
-        // Send the new values back
-        if (Object.keys(newValues).length > 0) {
-            this.#ipcWrapper.sendWithNoCb('updateFeedbackValues', {
-                values: newValues,
-            });
-        }
+        this.#feedbackManager.checkFeedbacksById(feedbackIds);
     }
     /** @deprecated */
     _getAllActions() {
-        return Array.from(this.#actionInstances.values()).map((act) => ({
-            id: act.id,
-            actionId: act.actionId,
-            controlId: act.controlId,
-            options: act.options,
-        }));
+        return this.#actionManager._getAllActions();
     }
     /**
      * Call subscribe on all currently known placed actions.
@@ -568,21 +364,7 @@ class InstanceBase {
      * @param actionIds The actionIds to call subscribe for. If no values are provided, then all are called.
      */
     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) {
-                def.subscribe({
-                    id: act.id,
-                    actionId: act.actionId,
-                    controlId: act.controlId,
-                    options: act.options,
-                });
-            }
-        }
+        this.#actionManager.subscribeActions(actionIds);
     }
     /**
      * Call unsubscribe on all currently known placed actions.
@@ -590,30 +372,11 @@ class InstanceBase {
      * @param actionIds The actionIds to call subscribe for. If no values are provided, then all are called.
      */
     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) {
-                def.unsubscribe({
-                    id: act.id,
-                    actionId: act.actionId,
-                    controlId: act.controlId,
-                    options: act.options,
-                });
-            }
-        }
+        this.#actionManager.unsubscribeActions(actionIds);
     }
     /** @deprecated */
     _getAllFeedbacks() {
-        return Array.from(this.#feedbackInstances.values()).map((fb) => ({
-            id: fb.id,
-            feedbackId: fb.feedbackId,
-            controlId: fb.controlId,
-            options: fb.options,
-        }));
+        return this.#feedbackManager._getAllFeedbacks();
     }
     /**
      * Call subscribe on all currently known placed feedbacks.
@@ -621,22 +384,7 @@ class InstanceBase {
      * @param feedbackIds The feedbackIds to call subscribe for. If no values are provided, then all are called.
      */
     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) {
-                def.subscribe({
-                    type: def.type,
-                    id: fb.id,
-                    feedbackId: fb.feedbackId,
-                    controlId: fb.controlId,
-                    options: fb.options,
-                });
-            }
-        }
+        this.#feedbackManager.subscribeFeedbacks(feedbackIds);
     }
     /**
      * Call unsubscribe on all currently known placed feedbacks.
@@ -644,22 +392,7 @@ class InstanceBase {
      * @param feedbackIds The feedbackIds to call subscribe for. If no values are provided, then all are called.
      */
     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) {
-                def.unsubscribe({
-                    type: def.type,
-                    id: fb.id,
-                    feedbackId: fb.feedbackId,
-                    controlId: fb.controlId,
-                    options: fb.options,
-                });
-            }
-        }
+        this.#feedbackManager.unsubscribeFeedbacks(feedbackIds);
     }
     /**
      * Add an action to the current recording session
@@ -678,13 +411,13 @@ class InstanceBase {
     /**
      * Experimental: This method may change without notice. Do not use!
      * Set the value of a custom variable
-     * @param variableId
+     * @param variableName
      * @param value
      * @returns Promise which resolves upon success, or rejects if the variable no longer exists
      */
-    setCustomVariableValue(variableId, value) {
+    setCustomVariableValue(variableName, value) {
         this.#ipcWrapper.sendWithNoCb('setCustomVariable', {
-            customVariableId: variableId,
+            customVariableId: variableName,
             value,
         });
     }
@@ -696,7 +429,7 @@ class InstanceBase {
      * @param args mesage arguments
      */
     oscSend(host, port, path, args) {
-        this.#ipcWrapper.sendWithNoCb('send-osc', (0, util_js_1.literal)({
+        this.#ipcWrapper.sendWithNoCb('send-osc', (0, util_1.literal)({
             host,
             port,
             path,
@@ -714,7 +447,7 @@ class InstanceBase {
      * ```
      */
     updateStatus(status, message) {
-        this.#ipcWrapper.sendWithNoCb('set-status', (0, util_js_1.literal)({
+        this.#ipcWrapper.sendWithNoCb('set-status', (0, util_1.literal)({
             status,
             message: message ?? null,
         }));
@@ -725,7 +458,7 @@ class InstanceBase {
      * @param message The message text to write
      */
     log(level, message) {
-        this.#ipcWrapper.sendWithNoCb('log-message', (0, util_js_1.literal)({
+        this.#ipcWrapper.sendWithNoCb('log-message', (0, util_1.literal)({
             level,
             message,
         }));