@companion-module/base 0.0.3

package/dist/internal/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/internal/base.ts"],"names":[],"mappings":";;;AAkBA,4FAA4F;AAC5F,SAAgB,cAAc,CAAmB,MAAgC,EAAE,QAA0B;IAC5G,8DAA8D;IAE9D,KAAK,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;QACxD,MAAM,CAAC,EAAE,CAAC,KAAY,EAAE,KAAK,EAAE,GAAQ,EAAE,EAAuB,EAAE,EAAE;YACnE,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;gBACpC,OAAO,CAAC,IAAI,CAAC,sCAAsC,KAAK,GAAG,CAAC,CAAA;gBAC5D,OAAM,CAAC,4CAA4C;aACnD;YACD,IAAI,EAAE,IAAI,OAAO,EAAE,KAAK,UAAU,EAAE;gBACnC,OAAO,CAAC,IAAI,CAAC,gCAAgC,KAAK,GAAG,CAAC,CAAA;gBACtD,OAAM,CAAC,4CAA4C;aACnD;YAED,IAAI;gBACH,SAAS;gBACT,MAAM,QAAQ,GAAG,OAA6C,CAAA;gBAC9D,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,GAAG,CAAC,CAAA;gBAElC,IAAI,EAAE;oBAAE,EAAE,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;aACxB;YAAC,OAAO,CAAM,EAAE;gBAChB,OAAO,CAAC,KAAK,CAAC,mBAAmB,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAA;gBAC9C,IAAI,EAAE;oBAAE,EAAE,CAAC,CAAC,EAAE,QAAQ,EAAE,IAAI,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,SAAS,CAAC,CAAA;aACzD;QACF,CAAC,CAAC,CAAA;KACF;AACF,CAAC;AA1BD,wCA0BC;AAED,SAAgB,oBAAoB,CAAoC,OAAY;IACnF,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,IAAI,WAAW,IAAI,MAAM,EAAE;YAC1B,IAAI,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU,EAAE;gBAC3C,OAAO;oBACN,GAAG,MAAM;oBACT,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE;oBACxC,SAAS,EAAE,SAAS;iBACpB,CAAA;aACD;SACD;QAED,4DAA4D;QAC5D,OAAO;YACN,GAAG,MAAM;YACT,WAAW,EAAE,SAAS;SACtB,CAAA;IACF,CAAC,CAAC,CAAA;AACH,CAAC;AAlBD,oDAkBC;AAQD,SAAgB,mBAAmB,CAAU,GAAY;IACxD,MAAM,IAAI,GAAG,GAAiC,CAAA;IAC9C,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAA;AAClG,CAAC;AAHD,kDAGC"}

package/dist/internal/feedback.d.ts

@@ -0,0 +1,5 @@
+import { CompanionFeedbackDefinition, CompanionFeedbackInfo } from '../module-api/feedback';
+import { FeedbackInstance } from '../host-api/api';
+export declare function convertFeedbackInstanceToEvent(type: 'boolean' | 'advanced', feedback: FeedbackInstance): CompanionFeedbackInfo;
+export declare function callFeedbackOnDefinition(definition: CompanionFeedbackDefinition, feedback: FeedbackInstance): boolean | import("../module-api/feedback").CompanionAdvancedFeedbackResult;
+//# 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,EAAE,2BAA2B,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAA;AAC3F,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAA;AAElD,wBAAgB,8BAA8B,CAC7C,IAAI,EAAE,SAAS,GAAG,UAAU,EAC5B,QAAQ,EAAE,gBAAgB,GACxB,qBAAqB,CAQvB;AAED,wBAAgB,wBAAwB,CAAC,UAAU,EAAE,2BAA2B,EAAE,QAAQ,EAAE,gBAAgB,8EAiB3G"}

package/dist/internal/feedback.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.callFeedbackOnDefinition = exports.convertFeedbackInstanceToEvent = void 0;
+function convertFeedbackInstanceToEvent(type, feedback) {
+    return {
+        type: type,
+        id: feedback.id,
+        feedbackId: feedback.feedbackId,
+        controlId: feedback.controlId,
+        options: feedback.options,
+    };
+}
+exports.convertFeedbackInstanceToEvent = convertFeedbackInstanceToEvent;
+function callFeedbackOnDefinition(definition, feedback) {
+    if (definition.type === 'boolean') {
+        return definition.callback({
+            ...convertFeedbackInstanceToEvent('boolean', feedback),
+            type: 'boolean',
+            _rawBank: feedback.rawBank,
+        });
+    }
+    else {
+        return definition.callback({
+            ...convertFeedbackInstanceToEvent('advanced', feedback),
+            type: 'advanced',
+            image: feedback.image,
+            _page: feedback.page,
+            _bank: feedback.bank,
+            _rawBank: feedback.rawBank,
+        });
+    }
+}
+exports.callFeedbackOnDefinition = callFeedbackOnDefinition;
+//# 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":";;;AAGA,SAAgB,8BAA8B,CAC7C,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;AAXD,wEAWC;AAED,SAAgB,wBAAwB,CAAC,UAAuC,EAAE,QAA0B;IAC3G,IAAI,UAAU,CAAC,IAAI,KAAK,SAAS,EAAE;QAClC,OAAO,UAAU,CAAC,QAAQ,CAAC;YAC1B,GAAG,8BAA8B,CAAC,SAAS,EAAE,QAAQ,CAAC;YACtD,IAAI,EAAE,SAAS;YACf,QAAQ,EAAE,QAAQ,CAAC,OAAO;SAC1B,CAAC,CAAA;KACF;SAAM;QACN,OAAO,UAAU,CAAC,QAAQ,CAAC;YAC1B,GAAG,8BAA8B,CAAC,UAAU,EAAE,QAAQ,CAAC;YACvD,IAAI,EAAE,UAAU;YAChB,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,KAAK,EAAE,QAAQ,CAAC,IAAI;YACpB,KAAK,EAAE,QAAQ,CAAC,IAAI;YACpB,QAAQ,EAAE,QAAQ,CAAC,OAAO;SAC1B,CAAC,CAAA;KACF;AACF,CAAC;AAjBD,4DAiBC"}

package/dist/internal/upgrade.d.ts

@@ -0,0 +1,18 @@
+import { CompanionStaticUpgradeScript } from '../module-api/upgrade.js';
+import { FeedbackInstance, ActionInstance } from '../host-api/api.js';
+export declare function runThroughUpgradeScripts(allActions: {
+    [id: string]: ActionInstance | undefined | null;
+}, allFeedbacks: {
+    [id: string]: FeedbackInstance | undefined | null;
+}, defaultUpgradeIndex: number | null, upgradeScripts: CompanionStaticUpgradeScript<any>[], config: unknown | undefined): {
+    updatedActions: {
+        [id: string]: import("../host-api/api.js").ActionInstanceBase | undefined;
+    };
+    updatedFeedbacks: {
+        [id: string]: (import("../host-api/api.js").FeedbackInstanceBase & {
+            style?: Partial<Partial<import("../module-api/style.js").CompanionRequiredStyleProps & import("../module-api/style.js").CompanionAdditionalStyleProps>> | undefined;
+        }) | undefined;
+    };
+    updatedConfig: unknown;
+};
+//# 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,EAAE,4BAA4B,EAAE,MAAM,0BAA0B,CAAA;AACvE,OAAO,EAAE,gBAAgB,EAAE,cAAc,EAA+B,MAAM,oBAAoB,CAAA;AAElG,wBAAgB,wBAAwB,CACvC,UAAU,EAAE;IAAE,CAAC,EAAE,EAAE,MAAM,GAAG,cAAc,GAAG,SAAS,GAAG,IAAI,CAAA;CAAE,EAC/D,YAAY,EAAE;IAAE,CAAC,EAAE,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS,GAAG,IAAI,CAAA;CAAE,EACnE,mBAAmB,EAAE,MAAM,GAAG,IAAI,EAClC,cAAc,EAAE,4BAA4B,CAAC,GAAG,CAAC,EAAE,EACnD,MAAM,EAAE,OAAO,GAAG,SAAS;;;;;;;;;;EA4I3B"}

package/dist/internal/upgrade.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.runThroughUpgradeScripts = void 0;
+function runThroughUpgradeScripts(allActions, allFeedbacks, defaultUpgradeIndex, upgradeScripts, config) {
+    // First we group all the actions and feedbacks by the version they currently are.
+    const pendingUpgradesGrouped = new Map();
+    const getPendingSpecialUpgrade = (i) => {
+        let v = pendingUpgradesGrouped.get(i);
+        if (!v) {
+            v = { actions: [], feedbacks: [] };
+            pendingUpgradesGrouped.set(i, v);
+        }
+        return v;
+    };
+    for (const action of Object.values(allActions)) {
+        const upgradeIndex = action?.upgradeIndex ?? defaultUpgradeIndex;
+        if (action && typeof upgradeIndex === 'number') {
+            const pending = getPendingSpecialUpgrade(upgradeIndex);
+            pending.actions.push(action.id);
+        }
+    }
+    for (const feedback of Object.values(allFeedbacks)) {
+        const upgradeIndex = feedback?.upgradeIndex ?? defaultUpgradeIndex;
+        if (feedback && typeof upgradeIndex === 'number') {
+            const pending = getPendingSpecialUpgrade(upgradeIndex);
+            pending.feedbacks.push(feedback.id);
+        }
+    }
+    let updatedFeedbacks = {};
+    let updatedActions = {};
+    if (pendingUpgradesGrouped.size > 0) {
+        const pendingUpgradeGroups = Array.from(pendingUpgradesGrouped.keys()).sort();
+        const firstUpgradeGroup = Math.min(...pendingUpgradeGroups, defaultUpgradeIndex ?? Number.POSITIVE_INFINITY);
+        // Start building arrays of the ids which we are upgrading as we go
+        const actionsIdsToUpgrade = [];
+        const feedbackIdsToUpgrade = [];
+        // Perform the upgrades. We start on the first batch/instance, and work our way up to the last
+        const targetCount = upgradeScripts.length;
+        for (let i = firstUpgradeGroup; i < targetCount; i++) {
+            const group = pendingUpgradesGrouped.get(i - 1);
+            if (group) {
+                // Update the list of objects that need upgrading
+                actionsIdsToUpgrade.push(...group.actions);
+                feedbackIdsToUpgrade.push(...group.feedbacks);
+            }
+            // Only upgrade the config, if we are past the last version we had for it
+            const upgradeConfig = config !== undefined && defaultUpgradeIndex !== null && i > defaultUpgradeIndex;
+            // We have an upgrade script that can be run
+            const fcn = upgradeScripts[i];
+            const res = fcn({}, {
+                config: upgradeConfig ? config : null,
+                // Only pass the actions & feedbacks which need upgrading from this version
+                actions: actionsIdsToUpgrade
+                    .map((id) => {
+                    const inst = allActions[id];
+                    if (inst) {
+                        return {
+                            id: inst.id,
+                            controlId: inst.controlId,
+                            actionId: inst.actionId,
+                            options: inst.options,
+                        };
+                    }
+                })
+                    .filter((v) => !!v),
+                feedbacks: feedbackIdsToUpgrade
+                    .map((id) => {
+                    const inst = allFeedbacks[id];
+                    if (inst) {
+                        return {
+                            id: inst.id,
+                            controlId: inst.controlId,
+                            feedbackId: inst.feedbackId,
+                            options: inst.options,
+                        };
+                    }
+                })
+                    .filter((v) => !!v),
+            });
+            // Apply changes
+            if (upgradeConfig && res.updatedConfig)
+                config = res.updatedConfig;
+            for (const [id, action] of Object.entries(res.updatedActions)) {
+                const instance = allActions[id];
+                if (instance) {
+                    instance.actionId = action.actionId;
+                    instance.options = action.options;
+                    // Mark it as changed
+                    updatedActions[id] = instance;
+                }
+            }
+            for (const [id, feedback] of Object.entries(res.updatedFeedbacks)) {
+                const instance = allFeedbacks[id];
+                if (instance) {
+                    instance.feedbackId = feedback.feedbackId;
+                    instance.options = feedback.options;
+                    // Mark it as changed
+                    updatedFeedbacks[id] = {
+                        ...instance,
+                        style: updatedFeedbacks[id]?.style ?? feedback.style,
+                    };
+                }
+            }
+        }
+        // Make sure that everything with a upgradeIndex set is sent back
+        for (const [id, action] of Object.entries(allActions)) {
+            if (!updatedActions[id] && typeof action?.upgradeIndex === 'number') {
+                // Send it back to acknowledge that it has been 'upgraded'
+                updatedActions[id] = action;
+            }
+        }
+        for (const [id, feedback] of Object.entries(allFeedbacks)) {
+            if (!updatedFeedbacks[id] && typeof feedback?.upgradeIndex === 'number') {
+                // Send it back to acknowledge that it has been 'upgraded'
+                updatedFeedbacks[id] = feedback;
+            }
+        }
+    }
+    return {
+        updatedActions,
+        updatedFeedbacks,
+        updatedConfig: config,
+    };
+}
+exports.runThroughUpgradeScripts = runThroughUpgradeScripts;
+//# sourceMappingURL=upgrade.js.map

package/dist/internal/upgrade.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade.js","sourceRoot":"","sources":["../../src/internal/upgrade.ts"],"names":[],"mappings":";;;AAGA,SAAgB,wBAAwB,CACvC,UAA+D,EAC/D,YAAmE,EACnE,mBAAkC,EAClC,cAAmD,EACnD,MAA2B;IAE3B,kFAAkF;IAClF,MAAM,sBAAsB,GAAG,IAAI,GAAG,EAAsD,CAAA;IAC5F,MAAM,wBAAwB,GAAG,CAAC,CAAS,EAAE,EAAE;QAC9C,IAAI,CAAC,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC,CAAC,CAAA;QACrC,IAAI,CAAC,CAAC,EAAE;YACP,CAAC,GAAG,EAAE,OAAO,EAAE,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,CAAA;YAClC,sBAAsB,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;SAChC;QACD,OAAO,CAAC,CAAA;IACT,CAAC,CAAA;IACD,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,EAAE;QAC/C,MAAM,YAAY,GAAG,MAAM,EAAE,YAAY,IAAI,mBAAmB,CAAA;QAChE,IAAI,MAAM,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;YAC/C,MAAM,OAAO,GAAG,wBAAwB,CAAC,YAAY,CAAC,CAAA;YACtD,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,CAAA;SAC/B;KACD;IACD,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,EAAE;QACnD,MAAM,YAAY,GAAG,QAAQ,EAAE,YAAY,IAAI,mBAAmB,CAAA;QAClE,IAAI,QAAQ,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE;YACjD,MAAM,OAAO,GAAG,wBAAwB,CAAC,YAAY,CAAC,CAAA;YACtD,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAA;SACnC;KACD;IAED,IAAI,gBAAgB,GAAoD,EAAE,CAAA;IAC1E,IAAI,cAAc,GAAkD,EAAE,CAAA;IAEtE,IAAI,sBAAsB,CAAC,IAAI,GAAG,CAAC,EAAE;QACpC,MAAM,oBAAoB,GAAG,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAA;QAC7E,MAAM,iBAAiB,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,oBAAoB,EAAE,mBAAmB,IAAI,MAAM,CAAC,iBAAiB,CAAC,CAAA;QAE5G,mEAAmE;QACnE,MAAM,mBAAmB,GAAa,EAAE,CAAA;QACxC,MAAM,oBAAoB,GAAa,EAAE,CAAA;QAEzC,8FAA8F;QAC9F,MAAM,WAAW,GAAG,cAAc,CAAC,MAAM,CAAA;QACzC,KAAK,IAAI,CAAC,GAAG,iBAAiB,EAAE,CAAC,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE;YACrD,MAAM,KAAK,GAAG,sBAAsB,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAA;YAC/C,IAAI,KAAK,EAAE;gBACV,iDAAiD;gBACjD,mBAAmB,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,OAAO,CAAC,CAAA;gBAC1C,oBAAoB,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,CAAA;aAC7C;YAED,yEAAyE;YACzE,MAAM,aAAa,GAAG,MAAM,KAAK,SAAS,IAAI,mBAAmB,KAAK,IAAI,IAAI,CAAC,GAAG,mBAAmB,CAAA;YAErG,4CAA4C;YAC5C,MAAM,GAAG,GAAG,cAAc,CAAC,CAAC,CAAC,CAAA;YAC7B,MAAM,GAAG,GAAG,GAAG,CACd,EAAE,EACF;gBACC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI;gBAErC,2EAA2E;gBAC3E,OAAO,EAAE,mBAAmB;qBAC1B,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;oBACX,MAAM,IAAI,GAAG,UAAU,CAAC,EAAE,CAAC,CAAA;oBAC3B,IAAI,IAAI,EAAE;wBACT,OAAO;4BACN,EAAE,EAAE,IAAI,CAAC,EAAE;4BACX,SAAS,EAAE,IAAI,CAAC,SAAS;4BAEzB,QAAQ,EAAE,IAAI,CAAC,QAAQ;4BACvB,OAAO,EAAE,IAAI,CAAC,OAAO;yBACrB,CAAA;qBACD;gBACF,CAAC,CAAC;qBACD,MAAM,CAAC,CAAC,CAAC,EAAuB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;gBAEzC,SAAS,EAAE,oBAAoB;qBAC7B,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE;oBACX,MAAM,IAAI,GAAG,YAAY,CAAC,EAAE,CAAC,CAAA;oBAC7B,IAAI,IAAI,EAAE;wBACT,OAAO;4BACN,EAAE,EAAE,IAAI,CAAC,EAAE;4BACX,SAAS,EAAE,IAAI,CAAC,SAAS;4BAEzB,UAAU,EAAE,IAAI,CAAC,UAAU;4BAC3B,OAAO,EAAE,IAAI,CAAC,OAAO;yBACrB,CAAA;qBACD;gBACF,CAAC,CAAC;qBACD,MAAM,CAAC,CAAC,CAAC,EAAyB,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;aAC3C,CACD,CAAA;YAED,gBAAgB;YAChB,IAAI,aAAa,IAAI,GAAG,CAAC,aAAa;gBAAE,MAAM,GAAG,GAAG,CAAC,aAAa,CAAA;YAElE,KAAK,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,EAAE;gBAC9D,MAAM,QAAQ,GAAG,UAAU,CAAC,EAAE,CAAC,CAAA;gBAC/B,IAAI,QAAQ,EAAE;oBACb,QAAQ,CAAC,QAAQ,GAAG,MAAM,CAAC,QAAQ,CAAA;oBACnC,QAAQ,CAAC,OAAO,GAAG,MAAM,CAAC,OAAO,CAAA;oBAEjC,qBAAqB;oBACrB,cAAc,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAA;iBAC7B;aACD;YAED,KAAK,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,EAAE;gBAClE,MAAM,QAAQ,GAAG,YAAY,CAAC,EAAE,CAAC,CAAA;gBACjC,IAAI,QAAQ,EAAE;oBACb,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAA;oBACzC,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,CAAA;oBAEnC,qBAAqB;oBACrB,gBAAgB,CAAC,EAAE,CAAC,GAAG;wBACtB,GAAG,QAAQ;wBACX,KAAK,EAAE,gBAAgB,CAAC,EAAE,CAAC,EAAE,KAAK,IAAI,QAAQ,CAAC,KAAK;qBACpD,CAAA;iBACD;aACD;SACD;QAED,iEAAiE;QACjE,KAAK,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YACtD,IAAI,CAAC,cAAc,CAAC,EAAE,CAAC,IAAI,OAAO,MAAM,EAAE,YAAY,KAAK,QAAQ,EAAE;gBACpE,0DAA0D;gBAC1D,cAAc,CAAC,EAAE,CAAC,GAAG,MAAM,CAAA;aAC3B;SACD;QACD,KAAK,MAAM,CAAC,EAAE,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,EAAE;YAC1D,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,IAAI,OAAO,QAAQ,EAAE,YAAY,KAAK,QAAQ,EAAE;gBACxE,0DAA0D;gBAC1D,gBAAgB,CAAC,EAAE,CAAC,GAAG,QAAQ,CAAA;aAC/B;SACD;KACD;IAED,OAAO;QACN,cAAc;QACd,gBAAgB;QAChB,aAAa,EAAE,MAAM;KACrB,CAAA;AACF,CAAC;AAjJD,4DAiJC"}

package/dist/manifest.d.ts

@@ -0,0 +1,42 @@
+export interface ModuleManifestMaintainer {
+    name: string;
+    email?: string;
+    github?: string;
+}
+export interface ModuleManifestRuntime {
+    /** Type of the module. Must be: node14 */
+    type: string;
+    /** Which host-api does it use. Must be socket.io */
+    api: string;
+    /** Entrypoint to pass to the runtime. eg index.js */
+    entrypoint: string;
+}
+export interface ModuleManifest {
+    /** Unique identifier for the module */
+    id: string;
+    /** Name of the module */
+    name: string;
+    shortname: string;
+    /** Description of the module */
+    description: string;
+    /** Current version of the module */
+    version: string;
+    /** License of the module */
+    license: string;
+    /** URL to the source repository */
+    repository: string;
+    /** URL to bug tracker */
+    bugs: string;
+    /** List of active maintiners */
+    maintainers: ModuleManifestMaintainer[];
+    /** If the module had a different unique identifier previously, then specify it here */
+    legacyIds?: string[];
+    /** Information on how to execute the module */
+    runtime: ModuleManifestRuntime;
+    manufacturer: string;
+    products: string[];
+    keywords: string[];
+}
+/** Validate that a manifest looks correctly populated */
+export declare function validateManifest(manifest: ModuleManifest): void;
+//# sourceMappingURL=manifest.d.ts.map

package/dist/manifest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.d.ts","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,wBAAwB;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,MAAM,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,qBAAqB;IACrC,0CAA0C;IAC1C,IAAI,EAAE,MAAM,CAAA;IACZ,oDAAoD;IACpD,GAAG,EAAE,MAAM,CAAA;IAEX,qDAAqD;IACrD,UAAU,EAAE,MAAM,CAAA;CAElB;AAED,MAAM,WAAW,cAAc;IAC9B,uCAAuC;IACvC,EAAE,EAAE,MAAM,CAAA;IACV,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAA;IAEZ,SAAS,EAAE,MAAM,CAAA;IACjB,gCAAgC;IAChC,WAAW,EAAE,MAAM,CAAA;IACnB,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,4BAA4B;IAC5B,OAAO,EAAE,MAAM,CAAA;IACf,mCAAmC;IACnC,UAAU,EAAE,MAAM,CAAA;IAClB,yBAAyB;IACzB,IAAI,EAAE,MAAM,CAAA;IACZ,gCAAgC;IAChC,WAAW,EAAE,wBAAwB,EAAE,CAAA;IACvC,uFAAuF;IACvF,SAAS,CAAC,EAAE,MAAM,EAAE,CAAA;IAEpB,+CAA+C;IAC/C,OAAO,EAAE,qBAAqB,CAAA;IAE9B,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,EAAE,MAAM,EAAE,CAAA;IAClB,QAAQ,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,yDAAyD;AACzD,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,cAAc,GAAG,IAAI,CAE/D"}

package/dist/manifest.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateManifest = void 0;
+/** Validate that a manifest looks correctly populated */
+function validateManifest(manifest) {
+    // TODO module-lib
+}
+exports.validateManifest = validateManifest;
+//# sourceMappingURL=manifest.js.map

package/dist/manifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest.js","sourceRoot":"","sources":["../src/manifest.ts"],"names":[],"mappings":";;;AA+CA,yDAAyD;AACzD,SAAgB,gBAAgB,CAAC,QAAwB;IACxD,kBAAkB;AACnB,CAAC;AAFD,4CAEC"}

package/dist/module-api/action.d.ts

@@ -0,0 +1,59 @@
+import { SomeCompanionInputField, CompanionOptionValues } from './input.js';
+/**
+ * The definition of an action
+ */
+export interface CompanionActionDefinition {
+    /** Name to show in the actions list */
+    name: string;
+    /** Additional description of the action */
+    description?: string;
+    /** The input fields for the action */
+    options: SomeCompanionInputField[];
+    /** Called to execute the action */
+    callback: (action: CompanionActionEvent) => Promise<void> | void;
+    /**
+     * Called to report the existence of an action
+     * Useful to ensure necessary data is loaded
+     */
+    subscribe?: (action: CompanionActionInfo) => Promise<void> | void;
+    /**
+     * Called to report an action has been edited/removed
+     * Useful to cleanup subscriptions setup in subscribe
+     */
+    unsubscribe?: (action: CompanionActionInfo) => Promise<void> | void;
+    /**
+     * The user requested to 'learn' the values for this action.
+     */
+    learn?: (action: CompanionActionEvent) => CompanionOptionValues | undefined | Promise<CompanionOptionValues | undefined>;
+}
+/**
+ * The definitions of a group of actions
+ */
+export interface CompanionActionDefinitions {
+    [actionId: string]: CompanionActionDefinition | undefined;
+}
+/**
+ * Basic information about an instance of an action
+ */
+export interface CompanionActionInfo {
+    /** The unique id for this action */
+    readonly id: string;
+    /** The unique id for the location of this action */
+    readonly controlId: string;
+    /** The id of the action definition */
+    readonly actionId: string;
+    /** The user selected options for the action */
+    readonly options: CompanionOptionValues;
+}
+/**
+ * Extended information for execution of an action
+ */
+export interface CompanionActionEvent extends CompanionActionInfo {
+    /** @deprecated */
+    readonly _deviceId: string | undefined;
+    /** @deprecated */
+    readonly _page: number;
+    /** @deprecated */
+    readonly _bank: number;
+}
+//# sourceMappingURL=action.d.ts.map

package/dist/module-api/action.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/module-api/action.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAE3E;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACzC,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,sCAAsC;IACtC,OAAO,EAAE,uBAAuB,EAAE,CAAA;IAClC,mCAAmC;IACnC,QAAQ,EAAE,CAAC,MAAM,EAAE,oBAAoB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAChE;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IACjE;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAEnE;;OAEG;IACH,KAAK,CAAC,EAAE,CACP,MAAM,EAAE,oBAAoB,KACxB,qBAAqB,GAAG,SAAS,GAAG,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC,CAAA;CACnF;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,CAAC,QAAQ,EAAE,MAAM,GAAG,yBAAyB,GAAG,SAAS,CAAA;CACzD;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,oCAAoC;IACpC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,oDAAoD;IACpD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,sCAAsC;IACtC,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAA;IACzB,+CAA+C;IAC/C,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAA;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAqB,SAAQ,mBAAmB;IAGhE,kBAAkB;IAClB,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IACtC,kBAAkB;IAClB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,kBAAkB;IAClB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;CACtB"}

package/dist/module-api/action.js

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

package/dist/module-api/action.js.map

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

package/dist/module-api/base.d.ts

@@ -0,0 +1,137 @@
+import { CompanionActionDefinitions } from './action.js';
+import { CompanionFeedbackDefinitions } from './feedback.js';
+import { CompanionPresetDefinitions } from './preset.js';
+import { InstanceStatus, LogLevel } from './enums.js';
+import { ActionInstance, FeedbackInstance } from '../host-api/api.js';
+import { InstanceBaseShared } from '../instance-base.js';
+import { CompanionVariableDefinition, CompanionVariableValue, CompanionVariableValues } from './variable.js';
+import { OSCSomeArguments } from '../common/osc.js';
+import { SomeCompanionConfigField } from './config.js';
+import { CompanionHTTPRequest, CompanionHTTPResponse } from './http.js';
+export declare abstract class InstanceBase<TConfig> implements InstanceBaseShared<TConfig> {
+    #private;
+    readonly id: string;
+    /**
+     * Create an instance of the module.
+     */
+    constructor(internal: unknown);
+    private _socketEmit;
+    private _handleInit;
+    private _handleDestroy;
+    private _handleConfigUpdate;
+    private _handleExecuteAction;
+    private _handleUpdateFeedbacks;
+    private _handleUpdateActions;
+    private _handleGetConfigFields;
+    private _handleHttpRequest;
+    private _handleLearnAction;
+    private _handleLearnFeedback;
+    /**
+     * Main initialization function called once the module
+     * is OK to start doing things.
+     */
+    abstract init(config: TConfig): Promise<void>;
+    /**
+     * Clean up the instance before it is destroyed.
+     */
+    abstract destroy(): Promise<void>;
+    /**
+     * Called when the configuration is updated.
+     * @param config The new config object
+     */
+    abstract configUpdated(config: TConfig): Promise<void>;
+    /**
+     * Save an updated configuration object
+     * @param newConfig The new config object
+     */
+    saveConfig(newConfig: TConfig): Promise<void>;
+    /**
+     * Creates the configuration fields for web config.
+     */
+    abstract getConfigFields(): SomeCompanionConfigField[];
+    /**
+     * Handle HTTP requests from Companion
+     * @param request partial request object from Express
+     */
+    handleHttpRequest?(request: CompanionHTTPRequest): CompanionHTTPResponse | Promise<CompanionHTTPResponse>;
+    /**
+     * Set the action definitions for this instance
+     * @param actions The action definitions
+     */
+    setActionDefinitions(actions: CompanionActionDefinitions): Promise<void>;
+    /**
+     * Set the feedback definitions for this instance
+     * @param feedbacks The feedback definitions
+     */
+    setFeedbackDefinitions(feedbacks: CompanionFeedbackDefinitions): Promise<void>;
+    /**
+     * Set the peset definitions for this instance
+     * @param presets The preset definitions
+     */
+    setPresetDefinitions(presets: CompanionPresetDefinitions): Promise<void>;
+    /**
+     * Set the variable definitions for this instance
+     * @param variables The variable definitions
+     */
+    setVariableDefinitions(variables: CompanionVariableDefinition[]): Promise<void>;
+    /**
+     * Set the values of some variables
+     * @param values The new values for the variables
+     */
+    setVariableValues(values: CompanionVariableValues): Promise<void>;
+    /**
+     * Get the last set value of a variable from this connection
+     * @param variableId id of the variable
+     * @returns The value
+     */
+    getVariableValue(variableId: string): CompanionVariableValue | undefined;
+    /**
+     * Parse and replace all the variables in a string
+     * @param text The text to parse
+     * @returns The string with variables replaced with their values
+     */
+    parseVariablesInString(text: string): Promise<string>;
+    /**
+     * Request all feedbacks of the specified types to be checked for changes
+     * @param feedbackTypes The feedback types to check
+     */
+    checkFeedbacks(...feedbackTypes: string[]): Promise<void>;
+    /**
+     * Request the specified feedback instances to be checked for changes
+     * @param feedbackIds The ids of the feedback instances to check
+     */
+    checkFeedbacksById(...feedbackIds: string[]): Promise<void>;
+    /** @deprecated ? */
+    _getAllActions(): ActionInstance[];
+    /** @deprecated ? */
+    _subscribeActions(actionId?: string): void;
+    /** @deprecated ? */
+    _unsubscribeActions(actionId?: string): void;
+    /** @deprecated ? */
+    _getAllFeedbacks(): FeedbackInstance[];
+    /** @deprecated ? */
+    _subscribeFeedbacks(feedbackId?: string): void;
+    /** @deprecated ? */
+    _unsubscribeFeedbacks(feedbackId?: string): void;
+    /**
+     * Send an osc message from the system osc sender
+     * @param host destination ip address
+     * @param port destination port number
+     * @param path message path
+     * @param args mesage arguments
+     */
+    oscSend(host: string, port: number, path: string, args: OSCSomeArguments): Promise<void>;
+    /**
+     * Update the status of this connection
+     * @param status The status level
+     * @param message Additional information about the status
+     */
+    updateStatus(status: InstanceStatus, message?: string | null): Promise<void>;
+    /**
+     * Write a line to the log
+     * @param level The level of the message
+     * @param message The message text to write
+     */
+    log(level: LogLevel, message: string): void;
+}
+//# sourceMappingURL=base.d.ts.map

package/dist/module-api/base.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/module-api/base.ts"],"names":[],"mappings":"AACA,OAAO,EAA6B,0BAA0B,EAAE,MAAM,aAAa,CAAA;AACnF,OAAO,EACN,4BAA4B,EAG5B,MAAM,eAAe,CAAA;AACtB,OAAO,EAAE,0BAA0B,EAAiC,MAAM,aAAa,CAAA;AACvF,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAA;AACrD,OAAO,EACN,cAAc,EAEd,gBAAgB,EAwBhB,MAAM,oBAAoB,CAAA;AAE3B,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAGxD,OAAO,EAAE,2BAA2B,EAAE,sBAAsB,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAA;AAC5G,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AACnD,OAAO,EAAE,wBAAwB,EAAE,MAAM,aAAa,CAAA;AAKtD,OAAO,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAA;AAEvE,8BAAsB,YAAY,CAAC,OAAO,CAAE,YAAW,kBAAkB,CAAC,OAAO,CAAC;;IAGjF,SAAgB,EAAE,EAAE,MAAM,CAAA;IAa1B;;OAEG;gBACS,QAAQ,EAAE,OAAO;YA2Bf,WAAW;YAgBX,WAAW;YAoDX,cAAc;YASd,mBAAmB;YAOnB,oBAAoB;YAepB,sBAAsB;YA+DtB,oBAAoB;YA2CpB,sBAAsB;YAMtB,kBAAkB;YAOlB,kBAAkB;YAwBlB,oBAAoB;IAsBlC;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAE7C;;OAEG;IACH,QAAQ,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAEjC;;;OAGG;IACH,QAAQ,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAEtD;;;OAGG;IACG,UAAU,CAAC,SAAS,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAInD;;OAEG;IACH,QAAQ,CAAC,eAAe,IAAI,wBAAwB,EAAE;IAEtD;;;OAGG;IACH,iBAAiB,CAAC,CAAC,OAAO,EAAE,oBAAoB,GAAG,qBAAqB,GAAG,OAAO,CAAC,qBAAqB,CAAC;IAEzG;;;OAGG;IACH,oBAAoB,CAAC,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAuBxE;;;OAGG;IACH,sBAAsB,CAAC,SAAS,EAAE,4BAA4B,GAAG,OAAO,CAAC,IAAI,CAAC;IAyB9E;;;OAGG;IACH,oBAAoB,CAAC,OAAO,EAAE,0BAA0B,GAAG,OAAO,CAAC,IAAI,CAAC;IAexE;;;OAGG;IACH,sBAAsB,CAAC,SAAS,EAAE,2BAA2B,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA8B/E;;;OAGG;IACH,iBAAiB,CAAC,MAAM,EAAE,uBAAuB,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBjE;;;;OAIG;IACH,gBAAgB,CAAC,UAAU,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS;IAIxE;;;;OAIG;IACG,sBAAsB,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAK3D;;;OAGG;IACG,cAAc,CAAC,GAAG,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAiC/D;;;OAGG;IACG,kBAAkB,CAAC,GAAG,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA4BjE,oBAAoB;IACpB,cAAc;IAGd,oBAAoB;IACpB,iBAAiB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IAgB1C,oBAAoB;IACpB,mBAAmB,CAAC,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI;IAiB5C,oBAAoB;IACpB,gBAAgB;IAGhB,oBAAoB;IACpB,mBAAmB,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI;IAiB9C,oBAAoB;IACpB,qBAAqB,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI;IAkBhD;;;;;;OAMG;IACG,OAAO,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC;IAY9F;;;;OAIG;IACG,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC;IAUlF;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI;CAW3C"}