@companion-module/base 2.0.1 → 2.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [2.0.2](https://github.com/bitfocus/companion-module-base/compare/companion-module-base-v2.0.1...companion-module-base-v2.0.2) (2026-03-10)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* add sortSelection property for multidropdown fields ([5bc117d](https://github.com/bitfocus/companion-module-base/commit/5bc117da621b436dcc1cd656274985442e23f7af))
|
|
9
|
+
* respect optional properties in CompanionVariableDefinitions ([957bfc5](https://github.com/bitfocus/companion-module-base/commit/957bfc58c96d2837bdd736ca2ae1438bec376b43))
|
|
10
|
+
|
|
3
11
|
## [2.0.1](https://github.com/bitfocus/companion-module-base/compare/companion-module-base-v2.0.0...companion-module-base-v2.0.1) (2026-03-07)
|
|
4
12
|
|
|
5
13
|
|
|
@@ -252,6 +252,11 @@ export interface CompanionInputFieldMultiDropdown<TKey extends string = string,
|
|
|
252
252
|
minSelection?: number;
|
|
253
253
|
/** The maximum number of selected values */
|
|
254
254
|
maxSelection?: number;
|
|
255
|
+
/**
|
|
256
|
+
* If true, the ui should sort the selected values by the order they appear in the choices array
|
|
257
|
+
* Any custom values will be sorted alphabetically at the end of the list
|
|
258
|
+
*/
|
|
259
|
+
sortSelection?: boolean;
|
|
255
260
|
}
|
|
256
261
|
/**
|
|
257
262
|
* A checkbox input field
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/module-api/input.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;IAAE,KAAK,EAAE,CAAC,CAAC;IAAC,YAAY,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,IAAI,CAAA;CAAE,CAAA;AAE5G,MAAM,MAAM,uBAAuB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,SAAS,CAAA;CAAE,CAAA;AAE7G,MAAM,MAAM,qBAAqB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAA;CAAE,CAAA;AAE5E;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM;IACpE,+DAA+D;IAC/D,EAAE,EAAE,IAAI,CAAA;IACR,mCAAmC;IACnC,IAAI,EACD,aAAa,GACb,WAAW,GACX,UAAU,GACV,eAAe,GACf,aAAa,GACb,QAAQ,GACR,UAAU,GACV,iBAAiB,GACjB,gBAAgB,GAChB,aAAa,CAAA;IAChB,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,sHAAsH;IACtH,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAE9B;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAE/B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC5B;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,6BAA6B,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IACjH,IAAI,EAAE,aAAa,CAAA;IACnB,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAA;CACb;AAED,MAAM,MAAM,yBAAyB,GAAG,MAAM,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAEjF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,WAAW,wBAAwB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IAC5G,IAAI,EAAE,aAAa,CAAA;IACnB;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAA;IAChC;;;OAGG;IACH,YAAY,CAAC,EAAE,yBAAyB,EAAE,CAAA;CAC1C;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,4BAA4B,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IAChH,IAAI,EAAE,WAAW,CAAA;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB,sCAAsC;IACtC,SAAS,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,cAAc,CAAC,GAAG,SAAS,SAAS,GAAG,MAAM,GAAG,MAAM;IACtE,0BAA0B;IAC1B,EAAE,EAAE,GAAG,CAAA;IACP,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAA;CACb;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,2BAA2B,CAC3C,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,SAAS,SAAS,SAAS,GAAG,MAAM,GAAG,MAAM,CAC5C,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IACtC,IAAI,EAAE,UAAU,CAAA;IAEhB,2BAA2B;IAC3B,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,EAAE,CAAA;IACpC,iCAAiC;IACjC,OAAO,EAAE,SAAS,CAAA;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,gCAAgC,CAChD,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,SAAS,SAAS,SAAS,GAAG,MAAM,GAAG,MAAM,CAC5C,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IACtC,IAAI,EAAE,eAAe,CAAA;IAErB,2BAA2B;IAC3B,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,EAAE,CAAA;IACpC,kCAAkC;IAClC,OAAO,EAAE,SAAS,EAAE,CAAA;IAEpB,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,CAAA;
|
|
1
|
+
{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/module-api/input.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD,MAAM,MAAM,iBAAiB,CAAC,CAAC,IAAI;IAAE,KAAK,EAAE,CAAC,CAAC;IAAC,YAAY,EAAE,KAAK,CAAA;CAAE,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,YAAY,EAAE,IAAI,CAAA;CAAE,CAAA;AAE5G,MAAM,MAAM,uBAAuB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,SAAS,CAAA;CAAE,CAAA;AAE7G,MAAM,MAAM,qBAAqB,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,SAAS,CAAA;CAAE,CAAA;AAE5E;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM;IACpE,+DAA+D;IAC/D,EAAE,EAAE,IAAI,CAAA;IACR,mCAAmC;IACnC,IAAI,EACD,aAAa,GACb,WAAW,GACX,UAAU,GACV,eAAe,GACf,aAAa,GACb,QAAQ,GACR,UAAU,GACV,iBAAiB,GACjB,gBAAgB,GAChB,aAAa,CAAA;IAChB,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,wDAAwD;IACxD,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,sHAAsH;IACtH,qBAAqB,CAAC,EAAE,MAAM,CAAA;IAE9B;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAA;IAE/B;;;;;OAKG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAA;CAC5B;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,6BAA6B,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IACjH,IAAI,EAAE,aAAa,CAAA;IACnB,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAA;CACb;AAED,MAAM,MAAM,yBAAyB,GAAG,MAAM,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAA;AAEjF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AACH,MAAM,WAAW,wBAAwB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IAC5G,IAAI,EAAE,aAAa,CAAA;IACnB;;;;;;;;;;;;;;;;;OAiBG;IACH,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB;;;OAGG;IACH,UAAU,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAA;IAChC;;;OAGG;IACH,YAAY,CAAC,EAAE,yBAAyB,EAAE,CAAA;CAC1C;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,4BAA4B,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IAChH,IAAI,EAAE,WAAW,CAAA;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB,sCAAsC;IACtC,SAAS,CAAC,EAAE,OAAO,CAAA;CACnB;AAED,MAAM,WAAW,cAAc,CAAC,GAAG,SAAS,SAAS,GAAG,MAAM,GAAG,MAAM;IACtE,0BAA0B;IAC1B,EAAE,EAAE,GAAG,CAAA;IACP,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAA;CACb;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,2BAA2B,CAC3C,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,SAAS,SAAS,SAAS,GAAG,MAAM,GAAG,MAAM,CAC5C,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IACtC,IAAI,EAAE,UAAU,CAAA;IAEhB,2BAA2B;IAC3B,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,EAAE,CAAA;IACpC,iCAAiC;IACjC,OAAO,EAAE,SAAS,CAAA;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,uCAAuC;IACvC,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,gCAAgC,CAChD,IAAI,SAAS,MAAM,GAAG,MAAM,EAC5B,SAAS,SAAS,SAAS,GAAG,MAAM,GAAG,MAAM,CAC5C,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IACtC,IAAI,EAAE,eAAe,CAAA;IAErB,2BAA2B;IAC3B,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,EAAE,CAAA;IACpC,kCAAkC;IAClC,OAAO,EAAE,SAAS,EAAE,CAAA;IAEpB,sFAAsF;IACtF,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,4CAA4C;IAC5C,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,2BAA2B,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IAC/G,IAAI,EAAE,UAAU,CAAA;IAChB,wBAAwB;IACxB,OAAO,EAAE,OAAO,CAAA;CAChB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,yBAAyB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IAC7G,IAAI,EAAE,QAAQ,CAAA;IAEd,wBAAwB;IACxB,OAAO,EAAE,MAAM,CAAA;IAEf;;;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;IAEf,qEAAqE;IACrE,yBAAyB,CAAC,EAAE,OAAO,CAAA;IACnC,oEAAoE;IACpE,yBAAyB,CAAC,EAAE,OAAO,CAAA;IAEnC,qGAAqG;IACrG,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,2CAA2C;IAC3C,SAAS,CAAC,EAAE,OAAO,CAAA;CACnB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,iCAAiC,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IACrH,IAAI,EAAE,iBAAiB,CAAA;CACvB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,gCAAgC,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IACpH,IAAI,EAAE,gBAAgB,CAAA;CACtB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,yBAAyB,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,CAAE,SAAQ,uBAAuB,CAAC,IAAI,CAAC;IAC7G,IAAI,EAAE,aAAa,CAAA;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACd"}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
import type { StringKeys } from '../util.js';
|
|
2
1
|
import type { JsonValue } from '../common/json-value.js';
|
|
3
2
|
/**
|
|
4
3
|
* The definition of a variable
|
|
@@ -10,7 +9,7 @@ export interface CompanionVariableDefinition<_TManifest extends CompanionVariabl
|
|
|
10
9
|
* The definition of a variable
|
|
11
10
|
*/
|
|
12
11
|
export type CompanionVariableDefinitions<TManifest extends CompanionVariableValues = CompanionVariableValues> = {
|
|
13
|
-
[variableId in
|
|
12
|
+
[variableId in keyof TManifest as variableId extends string ? variableId : never]: CompanionVariableDefinition<TManifest>;
|
|
14
13
|
};
|
|
15
14
|
/**
|
|
16
15
|
* A set of values of some variables
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"variable.d.ts","sourceRoot":"","sources":["../../src/module-api/variable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"variable.d.ts","sourceRoot":"","sources":["../../src/module-api/variable.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AAExD;;GAEG;AACH,MAAM,WAAW,2BAA2B,CAAC,UAAU,SAAS,uBAAuB,GAAG,uBAAuB;IAEhH,IAAI,EAAE,MAAM,CAAA;CACZ;AACD;;GAEG;AACH,MAAM,MAAM,4BAA4B,CAAC,SAAS,SAAS,uBAAuB,GAAG,uBAAuB,IAAI;KAC9G,UAAU,IAAI,MAAM,SAAS,IAAI,UAAU,SAAS,MAAM,GACxD,UAAU,GACV,KAAK,GAAG,2BAA2B,CAAC,SAAS,CAAC;CACjD,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,CAAC,UAAU,EAAE,MAAM,GAAG,sBAAsB,GAAG,SAAS,CAAA;CACxD;AAED;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,SAAS,GAAG,SAAS,CAAA"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@companion-module/base",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "MIT",
|
|
@@ -24,7 +24,7 @@
|
|
|
24
24
|
}
|
|
25
25
|
},
|
|
26
26
|
"scripts": {
|
|
27
|
-
"docs:html": "run -BT typedoc --tsconfig tsconfig.json --entryPoints src/main.ts --excludePrivate --theme default --out docs"
|
|
27
|
+
"docs:html": "run -BT typedoc --tsconfig tsconfig.json --readme README-typedoc.md --entryPoints src/main.ts --excludePrivate --theme default --out docs"
|
|
28
28
|
},
|
|
29
29
|
"engines": {
|
|
30
30
|
"node": "^22.20"
|