@companion-module/base 0.0.3

package/dist/module-api/upgrade.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CreateConvertToBooleanFeedbackUpgradeScript = exports.EmptyUpgradeScript = void 0;
+/**
+ * A helper upgrade script, which does nothing.
+ * Useful to replace a script which is no longer needed
+ */
+const EmptyUpgradeScript = () => ({
+    updatedConfig: null,
+    updatedActions: [],
+    updatedFeedbacks: [],
+});
+exports.EmptyUpgradeScript = EmptyUpgradeScript;
+/**
+ * A helper script to automate the bulk of the process to upgrade feedbacks from 'advanced' to 'boolean'.
+ * There are some built in rules for properties names based on the most common cases
+ * @param upgradeMap The feedbacks to upgrade and the properties to convert
+ */
+function CreateConvertToBooleanFeedbackUpgradeScript(upgradeMap) {
+    // Warning: the unused parameters will often be null
+    return (_context, props) => {
+        const changedFeedbacks = [];
+        for (const feedback of props.feedbacks) {
+            let upgrade_rules = upgradeMap[feedback.feedbackId];
+            if (upgrade_rules === true) {
+                // These are some automated built in rules. They can help make it easier to migrate
+                upgrade_rules = {
+                    bg: 'bgcolor',
+                    bgcolor: 'bgcolor',
+                    fg: 'color',
+                    color: 'color',
+                    png64: 'png64',
+                    png: 'png64',
+                };
+            }
+            if (upgrade_rules) {
+                if (!feedback.style)
+                    feedback.style = {};
+                for (const [option_key, style_key] of Object.entries(upgrade_rules)) {
+                    if (feedback.options[option_key] !== undefined) {
+                        feedback.style[style_key] = feedback.options[option_key];
+                        delete feedback.options[option_key];
+                        changedFeedbacks.push(feedback);
+                    }
+                }
+            }
+        }
+        return {
+            updatedConfig: null,
+            updatedActions: [],
+            updatedFeedbacks: changedFeedbacks,
+        };
+    };
+}
+exports.CreateConvertToBooleanFeedbackUpgradeScript = CreateConvertToBooleanFeedbackUpgradeScript;
+//# sourceMappingURL=upgrade.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade.js","sourceRoot":"","sources":["../../src/module-api/upgrade.ts"],"names":[],"mappings":";;;AAwFA;;;GAGG;AACI,MAAM,kBAAkB,GAAsC,GAAG,EAAE,CAAC,CAAC;IAC3E,aAAa,EAAE,IAAI;IACnB,cAAc,EAAE,EAAE;IAClB,gBAAgB,EAAE,EAAE;CACpB,CAAC,CAAA;AAJW,QAAA,kBAAkB,sBAI7B;AAeF;;;;GAIG;AACH,SAAgB,2CAA2C,CAC1D,UAAgD;IAEhD,oDAAoD;IACpD,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QAC1B,MAAM,gBAAgB,GAA8D,EAAE,CAAA;QAEtF,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,SAAS,EAAE;YACvC,IAAI,aAAa,GAAG,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YACnD,IAAI,aAAa,KAAK,IAAI,EAAE;gBAC3B,mFAAmF;gBACnF,aAAa,GAAG;oBACf,EAAE,EAAE,SAAS;oBACb,OAAO,EAAE,SAAS;oBAClB,EAAE,EAAE,OAAO;oBACX,KAAK,EAAE,OAAO;oBACd,KAAK,EAAE,OAAO;oBACd,GAAG,EAAE,OAAO;iBACZ,CAAA;aACD;YAED,IAAI,aAAa,EAAE;gBAClB,IAAI,CAAC,QAAQ,CAAC,KAAK;oBAAE,QAAQ,CAAC,KAAK,GAAG,EAAE,CAAA;gBAExC,KAAK,MAAM,CAAC,UAAU,EAAE,SAAS,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,EAAE;oBACpE,IAAI,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,SAAS,EAAE;wBAC/C,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAQ,CAAA;wBAC/D,OAAO,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;wBAEnC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;qBAC/B;iBACD;aACD;SACD;QAED,OAAO;YACN,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,EAAE;YAClB,gBAAgB,EAAE,gBAAgB;SAClC,CAAA;IACF,CAAC,CAAA;AACF,CAAC;AAzCD,kGAyCC"}

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

@@ -0,0 +1,18 @@
+/**
+ * The definition of a variable
+ */
+export interface CompanionVariableDefinition {
+    variableId: string;
+    name: string;
+}
+/**
+ * A set of values of some variables
+ */
+export interface CompanionVariableValues {
+    [variableId: string]: CompanionVariableValue | undefined;
+}
+/**
+ * The value of a variable
+ */
+export declare type CompanionVariableValue = string | number | boolean;
+//# sourceMappingURL=variable.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"variable.d.ts","sourceRoot":"","sources":["../../src/module-api/variable.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC3C,UAAU,EAAE,MAAM,CAAA;IAClB,IAAI,EAAE,MAAM,CAAA;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,CAAC,UAAU,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS,CAAA;CACxD;AAED;;GAEG;AACH,oBAAY,sBAAsB,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA"}

package/dist/module-api/variable.js

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

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

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

package/dist/util.d.ts

@@ -0,0 +1,12 @@
+export declare function literal<T>(v: T): T;
+/** Type assert that a value is never */
+export declare function assertNever(_val: never): void;
+export interface RgbComponents {
+    r: number;
+    g: number;
+    b: number;
+}
+export declare function combineRgb(r: number, g: number, b: number): number;
+export declare function splitRgb(dec: number): RgbComponents;
+export declare function from15to32Keys(key: number): number;
+//# sourceMappingURL=util.d.ts.map

package/dist/util.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.d.ts","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":"AAAA,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,GAAG,CAAC,CAElC;AAED,wCAAwC;AACxC,wBAAgB,WAAW,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI,CAE7C;AAED,MAAM,WAAW,aAAa;IAC7B,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;IACT,CAAC,EAAE,MAAM,CAAA;CACT;AAED,wBAAgB,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAElE;AAED,wBAAgB,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa,CAMnD;AAED,wBAAgB,cAAc,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAYlD"}

package/dist/util.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.from15to32Keys = exports.splitRgb = exports.combineRgb = exports.assertNever = exports.literal = void 0;
+function literal(v) {
+    return v;
+}
+exports.literal = literal;
+/** Type assert that a value is never */
+function assertNever(_val) {
+    // Nothing to do
+}
+exports.assertNever = assertNever;
+function combineRgb(r, g, b) {
+    return ((r & 0xff) << 16) | ((g & 0xff) << 8) | (b & 0xff);
+}
+exports.combineRgb = combineRgb;
+function splitRgb(dec) {
+    return {
+        r: (dec & 0xff0000) >> 16,
+        g: (dec & 0x00ff00) >> 8,
+        b: dec & 0x0000ff,
+    };
+}
+exports.splitRgb = splitRgb;
+function from15to32Keys(key) {
+    key = key - 1;
+    let rows = Math.floor(key / 5);
+    let col = (key % 5) + 1;
+    let res = rows * 8 + col;
+    if (res >= 32) {
+        //debug('from15to32: assert: old config had bigger pages than expected')
+        return 31;
+    }
+    return res;
+}
+exports.from15to32Keys = from15to32Keys;
+//# sourceMappingURL=util.js.map

package/dist/util.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"util.js","sourceRoot":"","sources":["../src/util.ts"],"names":[],"mappings":";;;AAAA,SAAgB,OAAO,CAAI,CAAI;IAC9B,OAAO,CAAC,CAAA;AACT,CAAC;AAFD,0BAEC;AAED,wCAAwC;AACxC,SAAgB,WAAW,CAAC,IAAW;IACtC,gBAAgB;AACjB,CAAC;AAFD,kCAEC;AAQD,SAAgB,UAAU,CAAC,CAAS,EAAE,CAAS,EAAE,CAAS;IACzD,OAAO,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,IAAI,CAAC,CAAA;AAC3D,CAAC;AAFD,gCAEC;AAED,SAAgB,QAAQ,CAAC,GAAW;IACnC,OAAO;QACN,CAAC,EAAE,CAAC,GAAG,GAAG,QAAQ,CAAC,IAAI,EAAE;QACzB,CAAC,EAAE,CAAC,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC;QACxB,CAAC,EAAE,GAAG,GAAG,QAAQ;KACjB,CAAA;AACF,CAAC;AAND,4BAMC;AAED,SAAgB,cAAc,CAAC,GAAW;IACzC,GAAG,GAAG,GAAG,GAAG,CAAC,CAAA;IAEb,IAAI,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAA;IAC9B,IAAI,GAAG,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC,CAAA;IACvB,IAAI,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,GAAG,CAAA;IAExB,IAAI,GAAG,IAAI,EAAE,EAAE;QACd,wEAAwE;QACxE,OAAO,EAAE,CAAA;KACT;IACD,OAAO,GAAG,CAAA;AACX,CAAC;AAZD,wCAYC"}

package/package.json

@@ -0,0 +1,32 @@
+{
+	"name": "@companion-module/base",
+	"version": "0.0.3",
+	"type": "commonjs",
+	"main": "dist/index.js",
+	"typings": "dist/index.d.ts",
+	"license": "MIT",
+	"scripts": {
+		"build": "tsc -p tsconfig.build.json",
+		"docs:html": "typedoc --tsconfig tsconfig.build.json --entryPoints src/index.ts --excludePrivate --theme default --out docs"
+	},
+	"files": [
+		"README.md",
+		"CHANGELOG.md",
+		"dist"
+	],
+	"dependencies": {
+		"@sentry/node": "^7.5.1",
+		"@sentry/tracing": "^7.5.1",
+		"p-queue": "^6.6.2",
+		"p-timeout": "^4.1.0",
+		"socket.io-client": "^4.5.1",
+		"tslib": "^2.4.0"
+	},
+	"devDependencies": {
+		"@tsconfig/node14": "^1.0.3",
+		"@types/node": "^14",
+		"prettier": "^2.7.1",
+		"typedoc": "^0.23.7",
+		"typescript": "~4.7.4"
+	}
+}