@companion-module/base 0.0.3

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

@@ -0,0 +1,21 @@
+/**
+ * All the possible status levels that an instance can use.
+ * Note: When adding more, companion needs to be updated to know how they should be displayed
+ */
+export declare type InstanceStatus = 'ok' | 'connecting' | 'disconnected' | 'connection_failure' | 'bad_config' | 'unknown_error' | 'unknown_warning';
+export declare type LogLevel = 'info' | 'warn' | 'error' | 'debug';
+export declare namespace Regex {
+    const IP = "/^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/";
+    const HOSTNAME = "/^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$/";
+    const BOOLEAN = "/^(true|false|0|1)$/i";
+    const PORT = "/^([1-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-8][0-9]{3}|9[0-8][0-9]{2}|99[0-8][0-9]|999[0-9]|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-4])$/";
+    const PERCENT = "/^(100|[0-9]|[0-9][0-9])$/";
+    const FLOAT = "/^([0-9]*\\.)?[0-9]+$/";
+    const SIGNED_FLOAT = "/^[+-]?([0-9]*\\.)?[0-9]+$/";
+    const FLOAT_OR_INT = "/^([0-9]+)(\\.[0-9]+)?$/";
+    const NUMBER = "/^\\d+$/";
+    const SIGNED_NUMBER = "/^[+-]?\\d+$/";
+    const SOMETHING = "/^.+$/";
+    const TIMECODE = "/^(0*[0-9]|1[0-9]|2[0-4]):(0*[0-9]|[1-5][0-9]|60):(0*[0-9]|[1-5][0-9]|60):(0*[0-9]|[12][0-9]|30)$/";
+}
+//# sourceMappingURL=enums.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"enums.d.ts","sourceRoot":"","sources":["../../src/module-api/enums.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,oBAAY,cAAc,GACvB,IAAI,GACJ,YAAY,GACZ,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,eAAe,GACf,iBAAiB,CAAA;AAEpB,oBAAY,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,CAAA;AAE1D,yBAAiB,KAAK,CAAC;IAEf,MAAM,EAAE,mGAAmG,CAAA;IAC3G,MAAM,QAAQ,iHAC0F,CAAA;IACxG,MAAM,OAAO,0BAA0B,CAAA;IACvC,MAAM,IAAI,4LACyK,CAAA;IACnL,MAAM,OAAO,+BAA+B,CAAA;IAC5C,MAAM,KAAK,2BAA2B,CAAA;IACtC,MAAM,YAAY,gCAAgC,CAAA;IAClD,MAAM,YAAY,6BAA6B,CAAA;IAC/C,MAAM,MAAM,aAAa,CAAA;IACzB,MAAM,aAAa,kBAAkB,CAAA;IACrC,MAAM,SAAS,WAAW,CAAA;IAC1B,MAAM,QAAQ,uGACgF,CAAA;CACrG"}

package/dist/module-api/enums.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Regex = void 0;
+var Regex;
+(function (Regex) {
+    // TODO - are all of these needed?
+    Regex.IP = '/^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$/';
+    Regex.HOSTNAME = '/^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9-]*[a-zA-Z0-9])\\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9-]*[A-Za-z0-9])$/';
+    Regex.BOOLEAN = '/^(true|false|0|1)$/i';
+    Regex.PORT = '/^([1-9]|[1-8][0-9]|9[0-9]|[1-8][0-9]{2}|9[0-8][0-9]|99[0-9]|[1-8][0-9]{3}|9[0-8][0-9]{2}|99[0-8][0-9]|999[0-9]|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-4])$/';
+    Regex.PERCENT = '/^(100|[0-9]|[0-9][0-9])$/';
+    Regex.FLOAT = '/^([0-9]*\\.)?[0-9]+$/';
+    Regex.SIGNED_FLOAT = '/^[+-]?([0-9]*\\.)?[0-9]+$/';
+    Regex.FLOAT_OR_INT = '/^([0-9]+)(\\.[0-9]+)?$/';
+    Regex.NUMBER = '/^\\d+$/';
+    Regex.SIGNED_NUMBER = '/^[+-]?\\d+$/';
+    Regex.SOMETHING = '/^.+$/';
+    Regex.TIMECODE = '/^(0*[0-9]|1[0-9]|2[0-4]):(0*[0-9]|[1-5][0-9]|60):(0*[0-9]|[1-5][0-9]|60):(0*[0-9]|[12][0-9]|30)$/';
+})(Regex = exports.Regex || (exports.Regex = {}));
+//# sourceMappingURL=enums.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"enums.js","sourceRoot":"","sources":["../../src/module-api/enums.ts"],"names":[],"mappings":";;;AAeA,IAAiB,KAAK,CAiBrB;AAjBD,WAAiB,KAAK;IACrB,kCAAkC;IACrB,QAAE,GAAG,gGAAgG,CAAA;IACrG,cAAQ,GACpB,8GAA8G,CAAA;IAClG,aAAO,GAAG,uBAAuB,CAAA;IACjC,UAAI,GAChB,yLAAyL,CAAA;IAC7K,aAAO,GAAG,4BAA4B,CAAA;IACtC,WAAK,GAAG,wBAAwB,CAAA;IAChC,kBAAY,GAAG,6BAA6B,CAAA;IAC5C,kBAAY,GAAG,0BAA0B,CAAA;IACzC,YAAM,GAAG,UAAU,CAAA;IACnB,mBAAa,GAAG,eAAe,CAAA;IAC/B,eAAS,GAAG,QAAQ,CAAA;IACpB,cAAQ,GACpB,oGAAoG,CAAA;AACtG,CAAC,EAjBgB,KAAK,GAAL,aAAK,KAAL,aAAK,QAiBrB"}

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

@@ -0,0 +1,106 @@
+/// <reference types="node" />
+import { SomeCompanionInputField, CompanionOptionValues } from './input.js';
+import { CompanionAdditionalStyleProps, CompanionRequiredStyleProps } from './style.js';
+/**
+ * Basic information about an instance of an feedback
+ */
+export interface CompanionFeedbackInfo {
+    /** The type of the feedback */
+    readonly type: 'boolean' | 'advanced';
+    /** The unique id for this feedback */
+    readonly id: string;
+    /** The unique id for the location of this feedback */
+    readonly controlId: string;
+    /** The id of the feedback definition */
+    readonly feedbackId: string;
+    /** The user selected options for the feedback */
+    readonly options: CompanionOptionValues;
+}
+/**
+ * Extended information for execution of a boolean feedback
+ */
+export interface CompanionFeedbackBooleanEvent extends CompanionFeedbackInfo {
+    /** @deprecated */
+    readonly _rawBank: any;
+}
+/**
+ * Extended information for execution of an advanced feedback
+ */
+export interface CompanionFeedbackAdvancedEvent extends CompanionFeedbackInfo {
+    /** If control supports an imageBuffer, the dimensions the buffer must be */
+    readonly image?: {
+        readonly width: number;
+        readonly height: number;
+    };
+    /** @deprecated */
+    readonly _page: number;
+    /** @deprecated */
+    readonly _bank: number;
+    /** @deprecated */
+    readonly _rawBank: any;
+}
+/**
+ * The resulting style of a boolean feedback
+ */
+export declare type CompanionFeedbackButtonStyleResult = Partial<CompanionRequiredStyleProps & CompanionAdditionalStyleProps>;
+/** The resulting style of an advanced feedback */
+export interface CompanionAdvancedFeedbackResult extends CompanionFeedbackButtonStyleResult {
+    imageBuffer?: Buffer;
+}
+/**
+ * The common definition of a feedback
+ */
+export interface CompanionFeedbackDefinitionBase {
+    type: 'boolean' | 'advanced';
+    /** Name to show in the feedbacks list */
+    name: string;
+    /** Additional description of the feedback */
+    description?: string;
+    /** The input fields for the feedback */
+    options: SomeCompanionInputField[];
+    /**
+     * Called to report the existence of an feedback
+     * Useful to ensure necessary data is loaded
+     */
+    subscribe?: (feedback: CompanionFeedbackInfo) => void;
+    /**
+     * Called to report an feedback has been edited/removed
+     * Useful to cleanup subscriptions setup in subscribe
+     */
+    unsubscribe?: (feedback: CompanionFeedbackInfo) => void;
+    /**
+     * The user requested to 'learn' the values for this feedback.
+     */
+    learn?: (action: CompanionFeedbackInfo) => CompanionOptionValues | undefined | Promise<CompanionOptionValues | undefined>;
+}
+/**
+ * The definition of a boolean feedback
+ */
+export interface CompanionBooleanFeedbackDefinition extends CompanionFeedbackDefinitionBase {
+    /** The type of the feedback */
+    type: 'boolean';
+    /** The default style properties for this feedback */
+    defaultStyle: Partial<CompanionFeedbackButtonStyleResult>;
+    /** Called to get the feedback value */
+    callback: (feedback: CompanionFeedbackBooleanEvent) => boolean;
+}
+/**
+ * The definition of an advanced feedback
+ */
+export interface CompanionAdvancedFeedbackDefinition extends CompanionFeedbackDefinitionBase {
+    /** The type of the feedback */
+    type: 'advanced';
+    /** Called to get the feedback value */
+    callback: (feedback: CompanionFeedbackAdvancedEvent) => CompanionAdvancedFeedbackResult;
+}
+/**
+ * The definition of some feedback
+ */
+export declare type CompanionFeedbackDefinition = CompanionBooleanFeedbackDefinition | CompanionAdvancedFeedbackDefinition;
+/**
+ * The definitions of a group of feedbacks
+ */
+export interface CompanionFeedbackDefinitions {
+    [id: string]: CompanionFeedbackDefinition | undefined;
+}
+//# sourceMappingURL=feedback.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"feedback.d.ts","sourceRoot":"","sources":["../../src/module-api/feedback.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,uBAAuB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAC3E,OAAO,EAAE,6BAA6B,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAA;AAEvF;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,+BAA+B;IAC/B,QAAQ,CAAC,IAAI,EAAE,SAAS,GAAG,UAAU,CAAA;IACrC,sCAAsC;IACtC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,sDAAsD;IACtD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAA;IAC3B,iDAAiD;IACjD,QAAQ,CAAC,OAAO,EAAE,qBAAqB,CAAA;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,qBAAqB;IAG3E,kBAAkB;IAClB,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,qBAAqB;IAG5E,4EAA4E;IAC5E,QAAQ,CAAC,KAAK,CAAC,EAAE;QAChB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;QACtB,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAA;KACvB,CAAA;IAED,kBAAkB;IAClB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,kBAAkB;IAClB,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IAEtB,kBAAkB;IAClB,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAA;CACtB;AAED;;GAEG;AACH,oBAAY,kCAAkC,GAAG,OAAO,CAAC,2BAA2B,GAAG,6BAA6B,CAAC,CAAA;AAErH,kDAAkD;AAClD,MAAM,WAAW,+BAAgC,SAAQ,kCAAkC;IAC1F,WAAW,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B;IAC/C,IAAI,EAAE,SAAS,GAAG,UAAU,CAAA;IAC5B,yCAAyC;IACzC,IAAI,EAAE,MAAM,CAAA;IACZ,6CAA6C;IAC7C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,wCAAwC;IACxC,OAAO,EAAE,uBAAuB,EAAE,CAAA;IAClC;;;OAGG;IACH,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,qBAAqB,KAAK,IAAI,CAAA;IACrD;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,QAAQ,EAAE,qBAAqB,KAAK,IAAI,CAAA;IAEvD;;OAEG;IACH,KAAK,CAAC,EAAE,CACP,MAAM,EAAE,qBAAqB,KACzB,qBAAqB,GAAG,SAAS,GAAG,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC,CAAA;CACnF;AAED;;GAEG;AACH,MAAM,WAAW,kCAAmC,SAAQ,+BAA+B;IAC1F,+BAA+B;IAC/B,IAAI,EAAE,SAAS,CAAA;IACf,qDAAqD;IACrD,YAAY,EAAE,OAAO,CAAC,kCAAkC,CAAC,CAAA;IACzD,uCAAuC;IACvC,QAAQ,EAAE,CAAC,QAAQ,EAAE,6BAA6B,KAAK,OAAO,CAAA;CAC9D;AAED;;GAEG;AACH,MAAM,WAAW,mCAAoC,SAAQ,+BAA+B;IAC3F,+BAA+B;IAC/B,IAAI,EAAE,UAAU,CAAA;IAChB,uCAAuC;IACvC,QAAQ,EAAE,CAAC,QAAQ,EAAE,8BAA8B,KAAK,+BAA+B,CAAA;CACvF;AAED;;GAEG;AACH,oBAAY,2BAA2B,GAAG,kCAAkC,GAAG,mCAAmC,CAAA;AAElH;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC5C,CAAC,EAAE,EAAE,MAAM,GAAG,2BAA2B,GAAG,SAAS,CAAA;CACrD"}

package/dist/module-api/feedback.js

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

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

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

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

@@ -0,0 +1,17 @@
+export interface CompanionHTTPRequest {
+    baseUrl: string;
+    body?: string;
+    headers: Record<string, string>;
+    hostname: string;
+    ip: string;
+    method: string;
+    originalUrl: string;
+    path: string;
+    query: Record<string, string>;
+}
+export interface CompanionHTTPResponse {
+    status?: number;
+    headers?: Record<string, any>;
+    body?: string;
+}
+//# sourceMappingURL=http.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../src/module-api/http.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,oBAAoB;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,QAAQ,EAAE,MAAM,CAAA;IAChB,EAAE,EAAE,MAAM,CAAA;IACV,MAAM,EAAE,MAAM,CAAA;IACd,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC7B;AAED,MAAM,WAAW,qBAAqB;IACrC,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC7B,IAAI,CAAC,EAAE,MAAM,CAAA;CACb"}

package/dist/module-api/http.js

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

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

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

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

@@ -0,0 +1,10 @@
+export * from './action.js';
+export * from './base.js';
+export * from './config.js';
+export * from './enums.js';
+export * from './feedback.js';
+export * from './input.js';
+export * from './preset.js';
+export * from './upgrade.js';
+export * from './variable.js';
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/module-api/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA;AACzB,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA;AAC1B,cAAc,aAAa,CAAA;AAC3B,cAAc,cAAc,CAAA;AAC5B,cAAc,eAAe,CAAA"}

package/dist/module-api/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./action.js"), exports);
+tslib_1.__exportStar(require("./base.js"), exports);
+tslib_1.__exportStar(require("./config.js"), exports);
+tslib_1.__exportStar(require("./enums.js"), exports);
+tslib_1.__exportStar(require("./feedback.js"), exports);
+tslib_1.__exportStar(require("./input.js"), exports);
+tslib_1.__exportStar(require("./preset.js"), exports);
+tslib_1.__exportStar(require("./upgrade.js"), exports);
+tslib_1.__exportStar(require("./variable.js"), exports);
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/module-api/index.ts"],"names":[],"mappings":";;;AAAA,sDAA2B;AAC3B,oDAAyB;AACzB,sDAA2B;AAC3B,qDAA0B;AAC1B,wDAA6B;AAC7B,qDAA0B;AAC1B,sDAA2B;AAC3B,uDAA4B;AAC5B,wDAA6B"}

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

@@ -0,0 +1,136 @@
+export declare type InputValue = number | string | boolean | Array<string | number>;
+export interface CompanionOptionValues {
+    [key: string]: InputValue | undefined;
+}
+export declare type SomeCompanionInputField = CompanionInputFieldStaticText | CompanionInputFieldColor | CompanionInputFieldTextInput | CompanionInputFieldDropdown | CompanionInputFieldMultiDropdown | CompanionInputFieldNumber | CompanionInputFieldCheckbox;
+/**
+ * The common properties for an input field
+ */
+export interface CompanionInputFieldBase {
+    /** The unique id of this input field */
+    id: string;
+    /** The type of this input field */
+    type: 'static-text' | 'textinput' | 'dropdown' | 'multidropdown' | 'colorpicker' | 'number' | 'checkbox';
+    /** The label of the field */
+    label: string;
+    /** A hover tooltop for this field */
+    tooltip?: string;
+    /** A function called to check whether this input should be visible, based on the current options selections */
+    isVisible?: (options: any) => boolean;
+}
+/**
+ * A static un-editable line of text
+ */
+export interface CompanionInputFieldStaticText extends CompanionInputFieldBase {
+    type: 'static-text';
+    /** The text to show */
+    value: string;
+}
+/**
+ * A colour picker input
+ */
+export interface CompanionInputFieldColor extends CompanionInputFieldBase {
+    type: 'colorpicker';
+    /**
+     * The default color value
+     */
+    default: number;
+}
+/**
+ * A basic text input field
+ */
+export interface CompanionInputFieldTextInput extends CompanionInputFieldBase {
+    type: 'textinput';
+    /**
+     * The default text value
+     */
+    default?: string;
+    /**
+     * Whether a value is required
+     * Note: values may not conform to this, it is a visual hint only
+     */
+    required?: boolean;
+    /**
+     * A regex to use to inform the user if the current input is valid.
+     * Note: values may not conform to this, it is a visual hint only
+     */
+    regex?: string;
+}
+export declare type DropdownChoiceId = string | number;
+/**
+ * An option for a dropdown input
+ */
+export interface DropdownChoice {
+    /** Value of the option */
+    id: DropdownChoiceId;
+    /** Label to show to users */
+    label: string;
+}
+/**
+ * A dropdown input field
+ */
+export interface CompanionInputFieldDropdown extends CompanionInputFieldBase {
+    type: 'dropdown';
+    /** The possible choices */
+    choices: DropdownChoice[];
+    /** The default selected value */
+    default: DropdownChoiceId;
+    /** Allow custom values to be defined */
+    allowCustom?: boolean;
+    /** Check custom value against regex */
+    regex?: string;
+    /** The minimum number of entries the dropdown must have before it allows searching */
+    minChoicesForSearch?: number;
+}
+/**
+ * A multi-select dropdown input field
+ */
+export interface CompanionInputFieldMultiDropdown extends CompanionInputFieldBase {
+    type: 'multidropdown';
+    /** The possible choices */
+    choices: DropdownChoice[];
+    /** The default selected values */
+    default: DropdownChoiceId[];
+    /** The minimum number of entries the dropdown must have before it allows searching */
+    minChoicesForSearch?: number;
+    /** The minimum number of selected values */
+    minSelection?: number;
+    /** The maximum number of selected values */
+    maximumSelectionLength?: number;
+}
+/**
+ * A checkbox input field
+ */
+export interface CompanionInputFieldCheckbox extends CompanionInputFieldBase {
+    type: 'checkbox';
+    /** The default value */
+    default: boolean;
+}
+/**
+ * A number input field
+ */
+export interface CompanionInputFieldNumber extends CompanionInputFieldBase {
+    type: 'number';
+    /** The default value */
+    default: number;
+    /**
+     * Whether a value is required
+     * Note: values may not conform to this, it is a visual hint only
+     */
+    required?: boolean;
+    /**
+     * The minimum value to allow
+     * Note: values may not conform to this, it is a visual hint only
+     */
+    min: number;
+    /**
+     * The maximum value to allow
+     * Note: values may not conform to this, it is a visual hint only
+     */
+    max: number;
+    /** The stepping of the arrows */
+    step?: number;
+    /** Whether to show a slider for the input */
+    range?: boolean;
+}
+//# sourceMappingURL=input.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/module-api/input.ts"],"names":[],"mappings":"AAAA,oBAAY,UAAU,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAA;AAE3E,MAAM,WAAW,qBAAqB;IACrC,CAAC,GAAG,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS,CAAA;CACrC;AAED,oBAAY,uBAAuB,GAChC,6BAA6B,GAC7B,wBAAwB,GACxB,4BAA4B,GAC5B,2BAA2B,GAC3B,gCAAgC,GAChC,yBAAyB,GACzB,2BAA2B,CAAA;AAE9B;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,wCAAwC;IACxC,EAAE,EAAE,MAAM,CAAA;IACV,mCAAmC;IACnC,IAAI,EAAE,aAAa,GAAG,WAAW,GAAG,UAAU,GAAG,eAAe,GAAG,aAAa,GAAG,QAAQ,GAAG,UAAU,CAAA;IACxG,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,+GAA+G;IAC/G,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,KAAuD,OAAO,CAAA;CACvF;AAED;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC7E,IAAI,EAAE,aAAa,CAAA;IACnB,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB;IACxE,IAAI,EAAE,aAAa,CAAA;IACnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,4BAA6B,SAAQ,uBAAuB;IAC5E,IAAI,EAAE,WAAW,CAAA;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CAOd;AAED,oBAAY,gBAAgB,GAAG,MAAM,GAAG,MAAM,CAAA;AAC9C;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,0BAA0B;IAC1B,EAAE,EAAE,gBAAgB,CAAA;IACpB,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,uBAAuB;IAC3E,IAAI,EAAE,UAAU,CAAA;IAEhB,2BAA2B;IAC3B,OAAO,EAAE,cAAc,EAAE,CAAA;IAEzB,iCAAiC;IACjC,OAAO,EAAE,gBAAgB,CAAA;IAEzB,wCAAwC;IACxC,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;GAEG;AACH,MAAM,WAAW,gCAAiC,SAAQ,uBAAuB;IAChF,IAAI,EAAE,eAAe,CAAA;IAErB,2BAA2B;IAC3B,OAAO,EAAE,cAAc,EAAE,CAAA;IAEzB,kCAAkC;IAClC,OAAO,EAAE,gBAAgB,EAAE,CAAA;IAE3B,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,4CAA4C;IAC5C,sBAAsB,CAAC,EAAE,MAAM,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,2BAA4B,SAAQ,uBAAuB;IAC3E,IAAI,EAAE,UAAU,CAAA;IAChB,wBAAwB;IACxB,OAAO,EAAE,OAAO,CAAA;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IACzE,IAAI,EAAE,QAAQ,CAAA;IAEd,wBAAwB;IACxB,OAAO,EAAE,MAAM,CAAA;IAEf;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAA;IACX;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAA;IAEX,iCAAiC;IACjC,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,6CAA6C;IAC7C,KAAK,CAAC,EAAE,OAAO,CAAA;CACf"}

package/dist/module-api/input.js

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

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

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

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

@@ -0,0 +1,102 @@
+import { CompanionFeedbackButtonStyleResult } from './feedback.js';
+import { CompanionOptionValues } from './input.js';
+import { CompanionAdditionalStyleProps, CompanionRequiredStyleProps } from './style.js';
+/**
+ * The base options for a preset
+ */
+export interface CompanionPresetOptions {
+    relativeDelay?: boolean;
+}
+/**
+ * The options for a press button preset
+ */
+export declare type CompanionPressPresetOptions = CompanionPresetOptions;
+/**
+ * The options for a stepped button preset
+ */
+export interface CompanionSteppedPresetOptions extends CompanionPresetOptions {
+    stepAutoProgress?: boolean;
+}
+/**
+ * The style properties for a preset
+ */
+export declare type CompanionPresetStyle = CompanionRequiredStyleProps & Partial<CompanionAdditionalStyleProps>;
+/**
+ * The configuration of an feedback in a preset
+ */
+export interface CompanionPresetFeedback {
+    /** The id of the feedback definition */
+    feedbackId: string;
+    /** The option values for the action */
+    options: CompanionOptionValues;
+    /**
+     * If a boolean feedback, the style effect of the feedback
+     */
+    style?: CompanionFeedbackButtonStyleResult;
+}
+/**
+ * The configuration of an action in a preset
+ */
+export interface CompanionPresetAction {
+    /** The id of the action definition */
+    actionId: string;
+    /** The execution delay of the action */
+    delay?: number;
+    /** The option values for the action */
+    options: CompanionOptionValues;
+}
+/**
+ * The definition of a press button preset
+ */
+export interface CompanionPressButtonPresetDefinition {
+    /** The type of this preset */
+    type: 'press';
+    /** The category of this preset, for grouping */
+    category: string;
+    /** The name of this preset */
+    name: string;
+    /** The base style of this preset */
+    style: CompanionPresetStyle;
+    /** Options for this preset */
+    options?: CompanionPressPresetOptions;
+    /** The feedbacks on the button */
+    feedbacks: CompanionPresetFeedback[];
+    actions: {
+        /** The button down actions */
+        down: CompanionPresetAction[];
+        /** The button up actions */
+        up: CompanionPresetAction[];
+    };
+}
+/**
+ * The definition of a stepped button preset
+ */
+export interface CompanionSteppedButtonPresetDefinition {
+    /** The type of this preset */
+    type: 'step';
+    /** The category of this preset, for grouping */
+    category: string;
+    /** The name of this preset */
+    name: string;
+    /** The base style of this preset */
+    style: CompanionPresetStyle;
+    /** Options for this preset */
+    options?: CompanionSteppedPresetOptions;
+    /** The feedbacks on the button */
+    feedbacks: CompanionPresetFeedback[];
+    /** The steps of this button, and their actions */
+    actions: {
+        [step: number]: CompanionPresetAction[];
+    };
+}
+/**
+ * The definition of some preset
+ */
+export declare type SomeCompanionPresetDefinition = CompanionSteppedButtonPresetDefinition | CompanionPressButtonPresetDefinition;
+/**
+ * The definitions of a group of feedbacks
+ */
+export interface CompanionPresetDefinitions {
+    [id: string]: SomeCompanionPresetDefinition | undefined;
+}
+//# sourceMappingURL=preset.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"preset.d.ts","sourceRoot":"","sources":["../../src/module-api/preset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kCAAkC,EAAE,MAAM,eAAe,CAAA;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAClD,OAAO,EAAE,6BAA6B,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAA;AAEvF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACtC,aAAa,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;GAEG;AACH,oBAAY,2BAA2B,GAAG,sBAAsB,CAAA;AAEhE;;GAEG;AACH,MAAM,WAAW,6BAA8B,SAAQ,sBAAsB;IAC5E,gBAAgB,CAAC,EAAE,OAAO,CAAA;CAC1B;AAED;;GAEG;AACH,oBAAY,oBAAoB,GAAG,2BAA2B,GAAG,OAAO,CAAC,6BAA6B,CAAC,CAAA;AAEvG;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAA;IAClB,uCAAuC;IACvC,OAAO,EAAE,qBAAqB,CAAA;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,kCAAkC,CAAA;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,uCAAuC;IACvC,OAAO,EAAE,qBAAqB,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACpD,8BAA8B;IAC9B,IAAI,EAAE,OAAO,CAAA;IACb,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAChB,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,oCAAoC;IACpC,KAAK,EAAE,oBAAoB,CAAA;IAC3B,8BAA8B;IAC9B,OAAO,CAAC,EAAE,2BAA2B,CAAA;IACrC,kCAAkC;IAClC,SAAS,EAAE,uBAAuB,EAAE,CAAA;IACpC,OAAO,EAAE;QACR,8BAA8B;QAC9B,IAAI,EAAE,qBAAqB,EAAE,CAAA;QAC7B,4BAA4B;QAC5B,EAAE,EAAE,qBAAqB,EAAE,CAAA;KAC3B,CAAA;CACD;AAED;;GAEG;AACH,MAAM,WAAW,sCAAsC;IACtD,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAChB,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,oCAAoC;IACpC,KAAK,EAAE,oBAAoB,CAAA;IAC3B,8BAA8B;IAC9B,OAAO,CAAC,EAAE,6BAA6B,CAAA;IACvC,kCAAkC;IAClC,SAAS,EAAE,uBAAuB,EAAE,CAAA;IACpC,kDAAkD;IAClD,OAAO,EAAE;QACR,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,EAAE,CAAA;KACvC,CAAA;CACD;AAED;;GAEG;AACH,oBAAY,6BAA6B,GACtC,sCAAsC,GACtC,oCAAoC,CAAA;AAEvC;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,CAAC,EAAE,EAAE,MAAM,GAAG,6BAA6B,GAAG,SAAS,CAAA;CACvD"}

package/dist/module-api/preset.js

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

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

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

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

@@ -0,0 +1,20 @@
+export declare type CompanionAlignment = 'left:top' | 'center:top' | 'right:top' | 'left:center' | 'center:center' | 'right:center' | 'left:bottom' | 'center:bottom' | 'right:bottom';
+export declare type CompanionTextSize = 'auto' | '7' | '14' | '18' | '24' | '30' | '44';
+/**
+ * The basic style properties for a button
+ */
+export interface CompanionRequiredStyleProps {
+    text: string;
+    size: CompanionTextSize;
+    color: number;
+    bgcolor: number;
+}
+/**
+ * The additional style properties for a button
+ */
+export interface CompanionAdditionalStyleProps {
+    alignment: CompanionAlignment;
+    pngalignment: CompanionAlignment;
+    png64?: string;
+}
+//# sourceMappingURL=style.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"style.d.ts","sourceRoot":"","sources":["../../src/module-api/style.ts"],"names":[],"mappings":"AAAA,oBAAY,kBAAkB,GAC3B,UAAU,GACV,YAAY,GACZ,WAAW,GACX,aAAa,GACb,eAAe,GACf,cAAc,GACd,aAAa,GACb,eAAe,GACf,cAAc,CAAA;AAEjB,oBAAY,iBAAiB,GAAG,MAAM,GAAG,GAAG,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAE/E;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC3C,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,EAAE,iBAAiB,CAAA;IACvB,KAAK,EAAE,MAAM,CAAA;IACb,OAAO,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,6BAA6B;IAC7C,SAAS,EAAE,kBAAkB,CAAA;IAC7B,YAAY,EAAE,kBAAkB,CAAA;IAChC,KAAK,CAAC,EAAE,MAAM,CAAA;CACd"}

package/dist/module-api/style.js

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

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

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

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

@@ -0,0 +1,95 @@
+import { CompanionFeedbackButtonStyleResult } from './feedback.js';
+import { CompanionOptionValues } from './input.js';
+/** For future use */
+export declare type CompanionUpgradeContext = unknown;
+/**
+ * The items for an upgrade script to upgrade
+ */
+export interface CompanionStaticUpgradeProps<TConfig> {
+    /**
+     * The module config to upgrade, if any
+     */
+    config: TConfig | null;
+    /**
+     * The actions to upgrade
+     */
+    actions: CompanionMigrationAction[];
+    /**
+     * The feedbacks to upgrade
+     */
+    feedbacks: CompanionMigrationFeedback[];
+}
+/**
+ * The result of an upgrade script
+ */
+export interface CompanionStaticUpgradeResult<TConfig> {
+    /**
+     * The updated config, if any changes were made
+     */
+    updatedConfig: TConfig | null;
+    /**
+     * Any changed actions
+     */
+    updatedActions: CompanionMigrationAction[];
+    /**
+     * Any changed feedbacks
+     */
+    updatedFeedbacks: CompanionMigrationFeedback[];
+}
+/**
+ * The definition of an upgrade script function
+ */
+export declare type CompanionStaticUpgradeScript<TConfig> = (context: CompanionUpgradeContext, props: CompanionStaticUpgradeProps<TConfig>) => CompanionStaticUpgradeResult<TConfig>;
+/**
+ * An action that could be upgraded
+ */
+export interface CompanionMigrationAction {
+    /** 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 */
+    actionId: string;
+    /** The execution delay of the action */
+    delay?: number;
+    /** The user selected options for the action */
+    options: CompanionOptionValues;
+}
+/**
+ * A feedback that could be upgraded
+ */
+export interface CompanionMigrationFeedback {
+    /** The unique id for this feedback */
+    readonly id: string;
+    /** The unique id for the location of this feedback */
+    readonly controlId: string;
+    /** The id of the feedback definition */
+    feedbackId: string;
+    /** The user selected options for the feedback */
+    options: CompanionOptionValues;
+    /**
+     * If the feedback is being converted to a boolean feedback, the style can be set here.
+     * If it is already a booelan feedback or is a different type of feedback, this will be ignored
+     */
+    style?: Partial<CompanionFeedbackButtonStyleResult>;
+}
+/**
+ * A helper upgrade script, which does nothing.
+ * Useful to replace a script which is no longer needed
+ */
+export declare const EmptyUpgradeScript: CompanionStaticUpgradeScript<any>;
+/**
+ * Definition of how to convert options to style properties for boolean feedbacks
+ */
+export interface CompanionUpgradeToBooleanFeedbackMap {
+    [feedback_id: string]: true | {
+        [option_key: string]: 'text' | 'size' | 'color' | 'bgcolor' | 'alignment' | 'pngalignment' | 'png64';
+    } | undefined;
+}
+/**
+ * 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
+ */
+export declare function CreateConvertToBooleanFeedbackUpgradeScript<TConfig = unknown>(upgradeMap: CompanionUpgradeToBooleanFeedbackMap): CompanionStaticUpgradeScript<TConfig>;
+//# sourceMappingURL=upgrade.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"upgrade.d.ts","sourceRoot":"","sources":["../../src/module-api/upgrade.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kCAAkC,EAAE,MAAM,eAAe,CAAA;AAClE,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAElD,qBAAqB;AACrB,oBAAY,uBAAuB,GAAG,OAAO,CAAA;AAE7C;;GAEG;AACH,MAAM,WAAW,2BAA2B,CAAC,OAAO;IACnD;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,IAAI,CAAA;IACtB;;OAEG;IACH,OAAO,EAAE,wBAAwB,EAAE,CAAA;IACnC;;OAEG;IACH,SAAS,EAAE,0BAA0B,EAAE,CAAA;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B,CAAC,OAAO;IACpD;;OAEG;IACH,aAAa,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,cAAc,EAAE,wBAAwB,EAAE,CAAA;IAC1C;;OAEG;IACH,gBAAgB,EAAE,0BAA0B,EAAE,CAAA;CAC9C;AAED;;GAEG;AACH,oBAAY,4BAA4B,CAAC,OAAO,IAAI,CACnD,OAAO,EAAE,uBAAuB,EAChC,KAAK,EAAE,2BAA2B,CAAC,OAAO,CAAC,KACvC,4BAA4B,CAAC,OAAO,CAAC,CAAA;AAE1C;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACxC,oCAAoC;IACpC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,oDAAoD;IACpD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,wCAAwC;IACxC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+CAA+C;IAC/C,OAAO,EAAE,qBAAqB,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,sCAAsC;IACtC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAA;IACnB,sDAAsD;IACtD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAE1B,wCAAwC;IACxC,UAAU,EAAE,MAAM,CAAA;IAClB,iDAAiD;IACjD,OAAO,EAAE,qBAAqB,CAAA;IAE9B;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC,kCAAkC,CAAC,CAAA;CACnD;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,4BAA4B,CAAC,GAAG,CAI/D,CAAA;AAEF;;GAEG;AACH,MAAM,WAAW,oCAAoC;IACpD,CAAC,WAAW,EAAE,MAAM,GACjB,IAAI,GACJ;QAEA,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,SAAS,GAAG,WAAW,GAAG,cAAc,GAAG,OAAO,CAAA;KACnG,GACD,SAAS,CAAA;CACZ;AAED;;;;GAIG;AACH,wBAAgB,2CAA2C,CAAC,OAAO,GAAG,OAAO,EAC5E,UAAU,EAAE,oCAAoC,GAC9C,4BAA4B,CAAC,OAAO,CAAC,CAuCvC"}