@companion-module/base 2.1.0 → 2.1.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 +14 -0
- package/dist/module-api/action.d.ts +2 -6
- package/dist/module-api/action.d.ts.map +1 -1
- package/dist/module-api/input.d.ts +1 -0
- package/dist/module-api/input.d.ts.map +1 -1
- package/dist/module-api/upgrade.d.ts +24 -2
- package/dist/module-api/upgrade.d.ts.map +1 -1
- package/dist/module-api/upgrade.js +36 -0
- package/dist/module-api/upgrade.js.map +1 -1
- package/package.json +3 -4
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [2.1.2](https://github.com/bitfocus/companion-module-base/compare/companion-module-base-v2.1.1...companion-module-base-v2.1.2) (2026-07-13)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Bug Fixes
|
|
7
|
+
|
|
8
|
+
* handle secrets generics in CreateUseActionResultStoreUpgradeScript and other util ([5676104](https://github.com/bitfocus/companion-module-base/commit/5676104820035af9bc6ee84209f6c055ab4e395d))
|
|
9
|
+
|
|
10
|
+
## [2.1.1](https://github.com/bitfocus/companion-module-base/compare/companion-module-base-v2.1.0...companion-module-base-v2.1.1) (2026-06-27)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
### Bug Fixes
|
|
14
|
+
|
|
15
|
+
* allow upgrade scripts to convert setCustomVariable usages to new result flow ([d26c7c0](https://github.com/bitfocus/companion-module-base/commit/d26c7c090715e1df23d88b34a0412687bde789b8))
|
|
16
|
+
|
|
3
17
|
## [2.1.0](https://github.com/bitfocus/companion-module-base/compare/companion-module-base-v2.0.4...companion-module-base-v2.1.0) (2026-06-26)
|
|
4
18
|
|
|
5
19
|
|
|
@@ -46,11 +46,7 @@ export type CompanionActionSchema<TOptions extends CompanionOptionValues, TResul
|
|
|
46
46
|
*/
|
|
47
47
|
export interface CompanionActionContext extends CompanionCommonCallbackContext {
|
|
48
48
|
/**
|
|
49
|
-
* @deprecated Experimental: This method may change without notice.
|
|
50
|
-
* Set the value of a custom variable
|
|
51
|
-
* @param variableName
|
|
52
|
-
* @param value
|
|
53
|
-
* @returns Promise which resolves upon success, or rejects if the variable no longer exists
|
|
49
|
+
* @deprecated Experimental: This method may change without notice. Use the action result flow instead!
|
|
54
50
|
*/
|
|
55
51
|
setCustomVariableValue(variableName: string, value: CompanionVariableValue): void;
|
|
56
52
|
}
|
|
@@ -158,7 +154,7 @@ export type CompanionActionDefinitionNoSubscribeHooks = {
|
|
|
158
154
|
*
|
|
159
155
|
* * {@link CompanionActionDefinitionBase}: fields common to all actions
|
|
160
156
|
* * {@link CompanionActionDefinitionCallbackWithResult} or
|
|
161
|
-
* {@link
|
|
157
|
+
* {@link CompanionActionDefinitionCallbackWithoutResult}: fields defining the
|
|
162
158
|
* function to implement the action (and optionally return a result)
|
|
163
159
|
* * {@link CompanionActionDefinitionSubscribeHooks} or
|
|
164
160
|
* {@link CompanionActionDefinitionNoSubscribeHooks}: fields to optionally
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/module-api/action.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAC5C,OAAO,KAAK,EAAE,8BAA8B,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAA;AAChG,OAAO,KAAK,EACX,2BAA2B,EAC3B,wBAAwB,EACxB,iCAAiC,EACjC,2BAA2B,EAC3B,gCAAgC,EAChC,yBAAyB,EACzB,6BAA6B,EAC7B,4BAA4B,EAC5B,qBAAqB,EACrB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AAE3D,MAAM,MAAM,6BAA6B,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,IACnE,6BAA6B,CAAC,IAAI,CAAC,GACnC,wBAAwB,CAAC,IAAI,CAAC,GAC9B,4BAA4B,CAAC,IAAI,CAAC,GAClC,2BAA2B,CAAC,IAAI,CAAC,GACjC,gCAAgC,CAAC,IAAI,CAAC,GACtC,yBAAyB,CAAC,IAAI,CAAC,GAC/B,2BAA2B,CAAC,IAAI,CAAC,GACjC,iCAAiC,CAAC,IAAI,CAAC,CAAA;AAE1C,yDAAyD;AACzD,MAAM,WAAW,4BAA4B,CAAC,QAAQ,SAAS,qBAAqB;IACnF,yCAAyC;IACzC,OAAO,EAAE,QAAQ,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B,CAC/C,QAAQ,SAAS,qBAAqB,EACtC,OAAO,SAAS,SAAS,CACxB,SAAQ,4BAA4B,CAAC,QAAQ,CAAC;IAC/C;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAkC,CAClD,QAAQ,SAAS,qBAAqB,CACrC,SAAQ,4BAA4B,CAAC,QAAQ,CAAC;IAC/C;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAA;CACd;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,CAAC,QAAQ,SAAS,qBAAqB,EAAE,OAAO,SAAS,SAAS,GAAG,IAAI,IASzG;IAAC,OAAO;CAAC,SAAS,CAAC,SAAS,CAAC,GAC1B,+BAA+B,CAAC,QAAQ,EAAE,OAAO,CAAC,GAClD,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,GACvB,kCAAkC,CAAC,QAAQ,CAAC,GAC5C,KAAK,CAAA;AAMV;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,8BAA8B;IAC7E
|
|
1
|
+
{"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../src/module-api/action.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACxD,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AAC5C,OAAO,KAAK,EAAE,8BAA8B,EAAE,6BAA6B,EAAE,MAAM,aAAa,CAAA;AAChG,OAAO,KAAK,EACX,2BAA2B,EAC3B,wBAAwB,EACxB,iCAAiC,EACjC,2BAA2B,EAC3B,gCAAgC,EAChC,yBAAyB,EACzB,6BAA6B,EAC7B,4BAA4B,EAC5B,qBAAqB,EACrB,MAAM,YAAY,CAAA;AACnB,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAA;AAE3D,MAAM,MAAM,6BAA6B,CAAC,IAAI,SAAS,MAAM,GAAG,MAAM,IACnE,6BAA6B,CAAC,IAAI,CAAC,GACnC,wBAAwB,CAAC,IAAI,CAAC,GAC9B,4BAA4B,CAAC,IAAI,CAAC,GAClC,2BAA2B,CAAC,IAAI,CAAC,GACjC,gCAAgC,CAAC,IAAI,CAAC,GACtC,yBAAyB,CAAC,IAAI,CAAC,GAC/B,2BAA2B,CAAC,IAAI,CAAC,GACjC,iCAAiC,CAAC,IAAI,CAAC,CAAA;AAE1C,yDAAyD;AACzD,MAAM,WAAW,4BAA4B,CAAC,QAAQ,SAAS,qBAAqB;IACnF,yCAAyC;IACzC,OAAO,EAAE,QAAQ,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,+BAA+B,CAC/C,QAAQ,SAAS,qBAAqB,EACtC,OAAO,SAAS,SAAS,CACxB,SAAQ,4BAA4B,CAAC,QAAQ,CAAC;IAC/C;;;OAGG;IACH,MAAM,EAAE,OAAO,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,kCAAkC,CAClD,QAAQ,SAAS,qBAAqB,CACrC,SAAQ,4BAA4B,CAAC,QAAQ,CAAC;IAC/C;;;OAGG;IACH,MAAM,CAAC,EAAE,KAAK,CAAA;CACd;AAED;;;;;;;GAOG;AACH,MAAM,MAAM,qBAAqB,CAAC,QAAQ,SAAS,qBAAqB,EAAE,OAAO,SAAS,SAAS,GAAG,IAAI,IASzG;IAAC,OAAO;CAAC,SAAS,CAAC,SAAS,CAAC,GAC1B,+BAA+B,CAAC,QAAQ,EAAE,OAAO,CAAC,GAClD,CAAC,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,GACvB,kCAAkC,CAAC,QAAQ,CAAC,GAC5C,KAAK,CAAA;AAMV;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,8BAA8B;IAC7E;;OAEG;IACH,sBAAsB,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,sBAAsB,GAAG,IAAI,CAAA;CACjF;AAED,MAAM,MAAM,2BAA2B,GAAG,6BAA6B,CAAA;AAEvE;;GAEG;AACH,MAAM,WAAW,8BAA+B,SAAQ,sBAAsB;IAC7E;;;OAGG;IACH,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAA;CAC5B;AAED;;;;;GAKG;AACH,MAAM,WAAW,6BAA6B,CAAC,QAAQ,SAAS,qBAAqB;IACpF,uCAAuC;IACvC,IAAI,EAAE,MAAM,CAAA;IACZ;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,2CAA2C;IAC3C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,sCAAsC;IACtC,OAAO,EAAE,6BAA6B,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAA;IAE9D;;;OAGG;IACH,KAAK,CAAC,EAAE,CACP,MAAM,EAAE,oBAAoB,CAAC,QAAQ,CAAC,EACtC,OAAO,EAAE,2BAA2B,KAChC,OAAO,CAAC,QAAQ,CAAC,GAAG,SAAS,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,SAAS,CAAC,CAAA;IAE3E;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;GAGG;AACH,MAAM,MAAM,2CAA2C,CACtD,QAAQ,SAAS,qBAAqB,EACtC,OAAO,SAAS,SAAS,IACtB;IACH;;;OAGG;IACH,QAAQ,EAAE,CACT,MAAM,EAAE,oBAAoB,CAAC,QAAQ,CAAC,EACtC,OAAO,EAAE,8BAA8B,KACnC,OAAO,CAAC,OAAO,CAAC,GAAG,OAAO,CAAA;IAG/B,SAAS,EAAE,IAAI,CAAA;CACf,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,8CAA8C,CAAC,QAAQ,SAAS,qBAAqB,IAAI;IACpG;;;OAGG;IACH,QAAQ,EAAE,CAAC,MAAM,EAAE,oBAAoB,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,8BAA8B,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAGnH,SAAS,CAAC,EAAE,KAAK,CAAA;CACjB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,uCAAuC,CAAC,QAAQ,SAAS,qBAAqB,GAAG,qBAAqB,IAAI;IACrH;;;;OAIG;IACH,4BAA4B,EAAE,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAA;IAEpD;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAA;IAExC;;;OAGG;IACH,SAAS,EAAE,CAAC,MAAM,EAAE,mBAAmB,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,sBAAsB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;IAC3G;;;OAGG;IACH,WAAW,CAAC,EAAE,CAAC,MAAM,EAAE,mBAAmB,CAAC,QAAQ,CAAC,EAAE,OAAO,EAAE,sBAAsB,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAA;CAC9G,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,yCAAyC,GAAG;KACtD,CAAC,IAAI,MAAM,uCAAuC,CAAC,qBAAqB,CAAC,CAAC,CAAC,EAAE,KAAK;CACnF,CAAA;AAED;;;;;;;;;;GAUG;AACH,MAAM,MAAM,yBAAyB,CACpC,OAAO,SACJ,kCAAkC,CAAC,qBAAqB,CAAC,GACzD,+BAA+B,CAAC,qBAAqB,EAAE,SAAS,CAAC,GACjE,kCAAkC,CAAC,qBAAqB,CAAC,GACzD,+BAA+B,CAAC,qBAAqB,EAAE,SAAS,CAAC,IAEpE,OAAO,SAAS,+BAA+B,CAAC,MAAM,OAAO,EAAE,MAAM,MAAM,CAAC,GACzE,6BAA6B,CAAC,OAAO,CAAC,GACtC,CAAC,uCAAuC,CAAC,OAAO,CAAC,GAAG,yCAAyC,CAAC,GAC9F,2CAA2C,CAAC,OAAO,EAAE,MAAM,CAAC,GAC5D,OAAO,SAAS,kCAAkC,CAAC,MAAM,OAAO,CAAC,GAChE,6BAA6B,CAAC,OAAO,CAAC,GACtC,CAAC,uCAAuC,CAAC,OAAO,CAAC,GAAG,yCAAyC,CAAC,GAC9F,8CAA8C,CAAC,OAAO,CAAC,GACvD,KAAK,CAAA;AAYV;;;GAGG;AACH,MAAM,MAAM,0BAA0B,CACrC,QAAQ,SAAS,MAAM,CACtB,MAAM,EACJ,kCAAkC,CAAC,qBAAqB,CAAC,GACzD,+BAA+B,CAAC,qBAAqB,EAAE,SAAS,CAAC,CACnE,GAAG,MAAM,CACT,MAAM,EACJ,kCAAkC,CAAC,qBAAqB,CAAC,GACzD,+BAA+B,CAAC,qBAAqB,EAAE,SAAS,CAAC,CACnE,IACE;KACF,CAAC,IAAI,MAAM,QAAQ,GAAG,QAAQ,CAAC,CAAC,CAAC,SAAS,MAAM,MAAM,GACpD,MAAM,SAAS,+BAA+B,CAAC,MAAM,OAAO,EAAE,MAAM,MAAM,CAAC,GAExE,CAAC,6BAA6B,CAAC,OAAO,CAAC,GACvC,CAAC,uCAAuC,CAAC,OAAO,CAAC,GAAG,yCAAyC,CAAC,GAC9F,2CAA2C,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,GAC7D,KAAK,GACL,SAAS,GACX,MAAM,SAAS,kCAAkC,CAAC,MAAM,OAAO,CAAC,GAE7D,CAAC,6BAA6B,CAAC,OAAO,CAAC,GACvC,CAAC,uCAAuC,CAAC,OAAO,CAAC,GAAG,yCAAyC,CAAC,GAC9F,8CAA8C,CAAC,OAAO,CAAC,CAAC,GACxD,KAAK,GACL,SAAS,GACX,KAAK,GACP,KAAK;CACR,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,QAAQ,SAAS,qBAAqB,GAAG,qBAAqB;IAClG,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,QAAQ,CAAA;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB,CACpC,QAAQ,SAAS,qBAAqB,GAAG,qBAAqB,CAC7D,SAAQ,mBAAmB,CAAC,QAAQ,CAAC;IACtC,4DAA4D;IAC5D,QAAQ,CAAC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,+CAA+C;IAC/C,OAAO,EAAE,qBAAqB,CAAA;IAE9B;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACd"}
|
|
@@ -335,6 +335,7 @@ export interface CompanionInputFieldNumber<TKey extends string = string> extends
|
|
|
335
335
|
* label: 'Save result to variable',
|
|
336
336
|
* }
|
|
337
337
|
* ```
|
|
338
|
+
* @deprecated Use the action result flow instead of this
|
|
338
339
|
*/
|
|
339
340
|
export interface CompanionInputFieldCustomVariable<TKey extends string = string> extends CompanionInputFieldBase<TKey> {
|
|
340
341
|
type: 'custom-variable';
|
|
@@ -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,CAAC,CAAC,SAAS,qBAAqB,GAAG,qBAAqB,IAAI;KAC7F,CAAC,IAAI,MAAM,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS;CACnD,CAAA;AAED,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
|
|
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,CAAC,CAAC,SAAS,qBAAqB,GAAG,qBAAqB,IAAI;KAC7F,CAAC,IAAI,MAAM,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS;CACnD,CAAA;AAED,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;;;;;;;;;;;;;;GAcG;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"}
|
|
@@ -58,6 +58,16 @@ export type CompanionStaticUpgradeScript<TConfig extends JsonObject, TSecrets ex
|
|
|
58
58
|
export type CompanionMigrationOptionValues = {
|
|
59
59
|
[key: string]: ExpressionOrValue<JsonValue | undefined> | undefined;
|
|
60
60
|
};
|
|
61
|
+
/**
|
|
62
|
+
* Where an action's result should be stored.
|
|
63
|
+
* Used by upgrade scripts to convert from the old `setCustomVariableValue` pattern to the
|
|
64
|
+
* new action-result flow.
|
|
65
|
+
*/
|
|
66
|
+
export interface CompanionMigrationActionStoreResult {
|
|
67
|
+
type: 'custom-variable';
|
|
68
|
+
/** Name of the custom variable to write the action's result into */
|
|
69
|
+
variableName: ExpressionOrValue<string>;
|
|
70
|
+
}
|
|
61
71
|
/**
|
|
62
72
|
* An action that could be upgraded
|
|
63
73
|
*/
|
|
@@ -70,6 +80,11 @@ export interface CompanionMigrationAction {
|
|
|
70
80
|
actionId: string;
|
|
71
81
|
/** The user selected options for the action */
|
|
72
82
|
options: CompanionMigrationOptionValues;
|
|
83
|
+
/**
|
|
84
|
+
* If this action now returns a result (replacing an old `setCustomVariableValue` pattern),
|
|
85
|
+
* set where that result should be stored.
|
|
86
|
+
*/
|
|
87
|
+
storeResult?: CompanionMigrationActionStoreResult;
|
|
73
88
|
}
|
|
74
89
|
/**
|
|
75
90
|
* A feedback that could be upgraded
|
|
@@ -98,7 +113,7 @@ export interface CompanionMigrationFeedback {
|
|
|
98
113
|
* A helper upgrade script, which does nothing.
|
|
99
114
|
* Useful to replace a script which is no longer needed
|
|
100
115
|
*/
|
|
101
|
-
export declare const EmptyUpgradeScript: CompanionStaticUpgradeScript<any>;
|
|
116
|
+
export declare const EmptyUpgradeScript: CompanionStaticUpgradeScript<any, any>;
|
|
102
117
|
/**
|
|
103
118
|
* Definition of how to convert options to style properties for boolean feedbacks
|
|
104
119
|
*/
|
|
@@ -118,7 +133,14 @@ export declare function CreateConvertToBooleanFeedbackUpgradeScript<TConfig exte
|
|
|
118
133
|
* The feedback definitions must be updated manually, this can only help update existing usages of the feedback.
|
|
119
134
|
* @param upgradeMap The feedbacks to upgrade and the id of the option to convert
|
|
120
135
|
*/
|
|
121
|
-
export declare function CreateUseBuiltinInvertForFeedbacksUpgradeScript<TConfig extends JsonObject =
|
|
136
|
+
export declare function CreateUseBuiltinInvertForFeedbacksUpgradeScript<TConfig extends JsonObject, TSecrets extends JsonObject | undefined = undefined>(upgradeMap: Record<string, string>): CompanionStaticUpgradeScript<TConfig, TSecrets>;
|
|
137
|
+
/**
|
|
138
|
+
* A helper script to convert actions from the old pattern of storing their result in a custom variable
|
|
139
|
+
* (via a `custom-variable` option field and `context.setCustomVariableValue`) to the new action-result flow.
|
|
140
|
+
* The action definitions must be updated manually to return a result, this can only help update existing usages.
|
|
141
|
+
* @param upgradeMap Map of action id to the id of the `custom-variable` option to convert
|
|
142
|
+
*/
|
|
143
|
+
export declare function CreateUseActionResultStoreUpgradeScript<TConfig extends JsonObject, TSecrets extends JsonObject | undefined = undefined>(upgradeMap: Record<string, string>): CompanionStaticUpgradeScript<TConfig, TSecrets>;
|
|
122
144
|
/**
|
|
123
145
|
* Helper to fix up values which could be a number or a string of variables into the new expression format
|
|
124
146
|
* This has some logic to try to preserve the existing behaviour as much as possible, while also keeping the output user friendly
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"upgrade.d.ts","sourceRoot":"","sources":["../../src/module-api/upgrade.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACpE,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,eAAe,CAAA;AACvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEnD,+CAA+C;AAC/C,MAAM,WAAW,uBAAuB,CAAC,OAAO,SAAS,UAAU;IAClE;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B,CAAC,OAAO,SAAS,UAAU,EAAE,QAAQ,SAAS,UAAU,GAAG,SAAS;IAC/G;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,IAAI,CAAA;IACtB;;OAEG;IACH,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,OAAO,EAAE,wBAAwB,EAAE,CAAA;IACnC;;OAEG;IACH,SAAS,EAAE,0BAA0B,EAAE,CAAA;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B,CAAC,OAAO,SAAS,UAAU,EAAE,QAAQ,SAAS,UAAU,GAAG,SAAS;IAChH;;OAEG;IACH,aAAa,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,cAAc,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAA;IAChC;;OAEG;IACH,cAAc,EAAE,wBAAwB,EAAE,CAAA;IAC1C;;OAEG;IACH,gBAAgB,EAAE,0BAA0B,EAAE,CAAA;CAC9C;AAED;;GAEG;AACH,MAAM,MAAM,4BAA4B,CACvC,OAAO,SAAS,UAAU,EAC1B,QAAQ,SAAS,UAAU,GAAG,SAAS,GAAG,SAAS,IAChD,CACH,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC,EACzC,KAAK,EAAE,2BAA2B,CAAC,OAAO,EAAE,QAAQ,CAAC,KACjD,4BAA4B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;AAEpD,MAAM,MAAM,8BAA8B,GAAG;IAC5C,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,SAAS,CAAA;CACnE,CAAA;AAED;;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,+CAA+C;IAC/C,OAAO,EAAE,8BAA8B,CAAA;
|
|
1
|
+
{"version":3,"file":"upgrade.d.ts","sourceRoot":"","sources":["../../src/module-api/upgrade.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAA;AACpE,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,eAAe,CAAA;AACvE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAA;AAEnD,+CAA+C;AAC/C,MAAM,WAAW,uBAAuB,CAAC,OAAO,SAAS,UAAU;IAClE;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;CACzC;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B,CAAC,OAAO,SAAS,UAAU,EAAE,QAAQ,SAAS,UAAU,GAAG,SAAS;IAC/G;;OAEG;IACH,MAAM,EAAE,OAAO,GAAG,IAAI,CAAA;IACtB;;OAEG;IACH,OAAO,EAAE,QAAQ,GAAG,IAAI,CAAA;IACxB;;OAEG;IACH,OAAO,EAAE,wBAAwB,EAAE,CAAA;IACnC;;OAEG;IACH,SAAS,EAAE,0BAA0B,EAAE,CAAA;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B,CAAC,OAAO,SAAS,UAAU,EAAE,QAAQ,SAAS,UAAU,GAAG,SAAS;IAChH;;OAEG;IACH,aAAa,EAAE,OAAO,GAAG,IAAI,CAAA;IAC7B;;OAEG;IACH,cAAc,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAA;IAChC;;OAEG;IACH,cAAc,EAAE,wBAAwB,EAAE,CAAA;IAC1C;;OAEG;IACH,gBAAgB,EAAE,0BAA0B,EAAE,CAAA;CAC9C;AAED;;GAEG;AACH,MAAM,MAAM,4BAA4B,CACvC,OAAO,SAAS,UAAU,EAC1B,QAAQ,SAAS,UAAU,GAAG,SAAS,GAAG,SAAS,IAChD,CACH,OAAO,EAAE,uBAAuB,CAAC,OAAO,CAAC,EACzC,KAAK,EAAE,2BAA2B,CAAC,OAAO,EAAE,QAAQ,CAAC,KACjD,4BAA4B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAA;AAEpD,MAAM,MAAM,8BAA8B,GAAG;IAC5C,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,SAAS,CAAA;CACnE,CAAA;AAED;;;;GAIG;AACH,MAAM,WAAW,mCAAmC;IACnD,IAAI,EAAE,iBAAiB,CAAA;IACvB,oEAAoE;IACpE,YAAY,EAAE,iBAAiB,CAAC,MAAM,CAAC,CAAA;CACvC;AAED;;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,+CAA+C;IAC/C,OAAO,EAAE,8BAA8B,CAAA;IAEvC;;;OAGG;IACH,WAAW,CAAC,EAAE,mCAAmC,CAAA;CACjD;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,8BAA8B,CAAA;IAEvC;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC,kCAAkC,CAAC,CAAA;IAEnD;;;OAGG;IACH,UAAU,CAAC,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAA;CACvC;AAED;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,4BAA4B,CAAC,GAAG,EAAE,GAAG,CAKpE,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,SAAS,UAAU,GAAG,UAAU,EAClG,UAAU,EAAE,oCAAoC,GAC9C,4BAA4B,CAAC,OAAO,EAAE,GAAG,CAAC,CAyC5C;AAED;;;;GAIG;AACH,wBAAgB,+CAA+C,CAC9D,OAAO,SAAS,UAAU,EAC1B,QAAQ,SAAS,UAAU,GAAG,SAAS,GAAG,SAAS,EAClD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,4BAA4B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAmCrF;AAED;;;;;GAKG;AACH,wBAAgB,uCAAuC,CACtD,OAAO,SAAS,UAAU,EAC1B,QAAQ,SAAS,UAAU,GAAG,SAAS,GAAG,SAAS,EAClD,UAAU,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,4BAA4B,CAAC,OAAO,EAAE,QAAQ,CAAC,CAgCrF;AAED;;;;;GAKG;AACH,wBAAgB,yCAAyC,CACxD,KAAK,EAAE,iBAAiB,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,SAAS,GACzD,iBAAiB,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,SAAS,CAoCtD;AAED;;;;;;GAMG;AACH,wBAAgB,yCAAyC,CACxD,KAAK,EAAE,iBAAiB,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,SAAS,GACzD,iBAAiB,CAAC,SAAS,GAAG,SAAS,CAAC,GAAG,SAAS,CAgDtD"}
|
|
@@ -90,6 +90,42 @@ export function CreateUseBuiltinInvertForFeedbacksUpgradeScript(upgradeMap) {
|
|
|
90
90
|
};
|
|
91
91
|
};
|
|
92
92
|
}
|
|
93
|
+
/**
|
|
94
|
+
* A helper script to convert actions from the old pattern of storing their result in a custom variable
|
|
95
|
+
* (via a `custom-variable` option field and `context.setCustomVariableValue`) to the new action-result flow.
|
|
96
|
+
* The action definitions must be updated manually to return a result, this can only help update existing usages.
|
|
97
|
+
* @param upgradeMap Map of action id to the id of the `custom-variable` option to convert
|
|
98
|
+
*/
|
|
99
|
+
export function CreateUseActionResultStoreUpgradeScript(upgradeMap) {
|
|
100
|
+
// Warning: the unused parameters will often be null
|
|
101
|
+
return (_context, props) => {
|
|
102
|
+
const changedActions = [];
|
|
103
|
+
for (const action of props.actions) {
|
|
104
|
+
const optionKey = upgradeMap[action.actionId];
|
|
105
|
+
if (typeof optionKey !== 'string')
|
|
106
|
+
continue;
|
|
107
|
+
// Retrieve and delete the old custom-variable field value, which held the chosen variable name
|
|
108
|
+
const rawValue = action.options[optionKey];
|
|
109
|
+
if (rawValue === undefined)
|
|
110
|
+
continue;
|
|
111
|
+
delete action.options[optionKey];
|
|
112
|
+
action.storeResult = {
|
|
113
|
+
type: 'custom-variable',
|
|
114
|
+
variableName: rawValue.isExpression
|
|
115
|
+
? { isExpression: true, value: rawValue.value }
|
|
116
|
+
: // eslint-disable-next-line @typescript-eslint/no-base-to-string
|
|
117
|
+
{ isExpression: false, value: String(rawValue.value ?? '') },
|
|
118
|
+
};
|
|
119
|
+
changedActions.push(action);
|
|
120
|
+
}
|
|
121
|
+
return {
|
|
122
|
+
updatedConfig: null,
|
|
123
|
+
updatedSecrets: null,
|
|
124
|
+
updatedActions: changedActions,
|
|
125
|
+
updatedFeedbacks: [],
|
|
126
|
+
};
|
|
127
|
+
};
|
|
128
|
+
}
|
|
93
129
|
/**
|
|
94
130
|
* Helper to fix up values which could be a number or a string of variables into the new expression format
|
|
95
131
|
* This has some logic to try to preserve the existing behaviour as much as possible, while also keeping the output user friendly
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"upgrade.js","sourceRoot":"","sources":["../../src/module-api/upgrade.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"upgrade.js","sourceRoot":"","sources":["../../src/module-api/upgrade.ts"],"names":[],"mappings":"AAmIA;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAA2C,GAAG,EAAE,CAAC,CAAC;IAChF,aAAa,EAAE,IAAI;IACnB,cAAc,EAAE,IAAI;IACpB,cAAc,EAAE,EAAE;IAClB,gBAAgB,EAAE,EAAE;CACpB,CAAC,CAAA;AAeF;;;;GAIG;AACH,MAAM,UAAU,2CAA2C,CAC1D,UAAgD;IAEhD,oDAAoD;IACpD,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QAC1B,MAAM,gBAAgB,GAA+D,EAAE,CAAA;QAEvF,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACxC,IAAI,aAAa,GAAG,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YACnD,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;gBAC5B,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;YACF,CAAC;YAED,IAAI,aAAa,EAAE,CAAC;gBACnB,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,CAAC;oBACrE,MAAM,MAAM,GAAG,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;oBAC3C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;wBAC1B,QAAQ,CAAC,KAAK,CAAC,SAAS,CAAC,GAAG,MAAa,CAAA;wBACzC,OAAO,QAAQ,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;wBAEnC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;oBAChC,CAAC;gBACF,CAAC;YACF,CAAC;QACF,CAAC;QAED,OAAO;YACN,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,IAAI;YACpB,cAAc,EAAE,EAAE;YAClB,gBAAgB,EAAE,gBAAgB;SAClC,CAAA;IACF,CAAC,CAAA;AACF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,+CAA+C,CAG7D,UAAkC;IACnC,oDAAoD;IACpD,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QAC1B,MAAM,gBAAgB,GAAwE,EAAE,CAAA;QAEhG,KAAK,MAAM,QAAQ,IAAI,KAAK,CAAC,SAAS,EAAE,CAAC;YACxC,MAAM,YAAY,GAAG,UAAU,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAA;YACpD,IAAI,OAAO,YAAY,KAAK,QAAQ;gBAAE,SAAQ;YAE9C,oCAAoC;YACpC,MAAM,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;YAC/C,IAAI,QAAQ,KAAK,SAAS;gBAAE,SAAQ;YACpC,OAAO,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,CAAA;YAErC,8DAA8D;YAC9D,IAAI,CAAC,QAAQ,CAAC,YAAY,EAAE,CAAC;gBAC5B,QAAQ,CAAC,UAAU,GAAG;oBACrB,YAAY,EAAE,KAAK;oBACnB,KAAK,EAAE,QAAQ,CAAC,KAAK,KAAK,MAAM,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,IAAI,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC;iBAClG,CAAA;YACF,CAAC;iBAAM,CAAC;gBACP,kCAAkC;gBAClC,QAAQ,CAAC,UAAU,GAAG,QAAQ,CAAA;YAC/B,CAAC;YAED,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAChC,CAAC;QAED,OAAO;YACN,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,IAAI;YACpB,cAAc,EAAE,EAAE;YAClB,gBAAgB,EAAE,gBAAgB;SAClC,CAAA;IACF,CAAC,CAAA;AACF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,uCAAuC,CAGrD,UAAkC;IACnC,oDAAoD;IACpD,OAAO,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QAC1B,MAAM,cAAc,GAAsE,EAAE,CAAA;QAE5F,KAAK,MAAM,MAAM,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACpC,MAAM,SAAS,GAAG,UAAU,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YAC7C,IAAI,OAAO,SAAS,KAAK,QAAQ;gBAAE,SAAQ;YAE3C,+FAA+F;YAC/F,MAAM,QAAQ,GAAG,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;YAC1C,IAAI,QAAQ,KAAK,SAAS;gBAAE,SAAQ;YACpC,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;YAEhC,MAAM,CAAC,WAAW,GAAG;gBACpB,IAAI,EAAE,iBAAiB;gBACvB,YAAY,EAAE,QAAQ,CAAC,YAAY;oBAClC,CAAC,CAAC,EAAE,YAAY,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE;oBAC/C,CAAC,CAAC,gEAAgE;wBACjE,EAAE,YAAY,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,IAAI,EAAE,CAAC,EAAE;aAC9D,CAAA;YAED,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QAC5B,CAAC;QAED,OAAO;YACN,aAAa,EAAE,IAAI;YACnB,cAAc,EAAE,IAAI;YACpB,cAAc,EAAE,cAAc;YAC9B,gBAAgB,EAAE,EAAE;SACpB,CAAA;IACF,CAAC,CAAA;AACF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yCAAyC,CACxD,KAA2D;IAE3D,0CAA0C;IAC1C,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,YAAY;QAAE,OAAO,KAAK,CAAA;IAE9C,MAAM,SAAS,GAAG,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAA;IACrC,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAA;IAC7B,IACC,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ;QAC/B,CAAC,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,EAClF,CAAC;QACF,mDAAmD;QACnD,OAAO;YACN,YAAY,EAAE,KAAK;YACnB,KAAK,EAAE,SAAS;SAChB,CAAA;IACF,CAAC;SAAM,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAA;QACnC,mDAAmD;QACnD,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACpG,uDAAuD;YACvD,OAAO;gBACN,YAAY,EAAE,IAAI;gBAClB,KAAK,EAAE,SAAS;aAChB,CAAA;QACF,CAAC;aAAM,CAAC;YACP,8FAA8F;YAC9F,OAAO;gBACN,YAAY,EAAE,IAAI;gBAClB,KAAK,EAAE,mBAAmB,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI;aACnF,CAAA;QACF,CAAC;IACF,CAAC;SAAM,CAAC;QACP,+CAA+C;QAC/C,2BAA2B;QAC3B,OAAO,KAAK,CAAA;IACb,CAAC;AACF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,yCAAyC,CACxD,KAA2D;IAE3D,0CAA0C;IAC1C,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,YAAY;QAAE,OAAO,KAAK,CAAA;IAE9C,MAAM,SAAS,GAAG,KAAK,CAAC,KAAK,CAAA;IAE7B,IAAI,OAAO,SAAS,KAAK,SAAS,EAAE,CAAC;QACpC,mCAAmC;QACnC,OAAO,KAAK,CAAA;IACb,CAAC;SAAM,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC1C,2BAA2B;QAC3B,OAAO;YACN,YAAY,EAAE,KAAK;YACnB,KAAK,EAAE,SAAS,KAAK,CAAC;SACtB,CAAA;IACF,CAAC;SAAM,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAC1C,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,EAAE,CAAA;QACnC,MAAM,QAAQ,GAAG,UAAU,CAAC,WAAW,EAAE,CAAA;QAEzC,IAAI,QAAQ,KAAK,MAAM,IAAI,QAAQ,KAAK,OAAO,EAAE,CAAC;YACjD,mCAAmC;YACnC,OAAO;gBACN,YAAY,EAAE,KAAK;gBACnB,KAAK,EAAE,QAAQ,KAAK,MAAM;aAC1B,CAAA;QACF,CAAC;aAAM,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,IAAI,UAAU,KAAK,EAAE,EAAE,CAAC;YAC5D,mCAAmC;YACnC,OAAO;gBACN,YAAY,EAAE,KAAK;gBACnB,KAAK,EAAE,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC;aAC/B,CAAA;QACF,CAAC;aAAM,IAAI,UAAU,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3G,+DAA+D;YAC/D,OAAO;gBACN,YAAY,EAAE,IAAI;gBAClB,KAAK,EAAE,SAAS;aAChB,CAAA;QACF,CAAC;aAAM,CAAC;YACP,6EAA6E;YAC7E,OAAO;gBACN,YAAY,EAAE,IAAI;gBAClB,KAAK,EAAE,wBAAwB,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK;aACzF,CAAA;QACF,CAAC;IACF,CAAC;SAAM,CAAC;QACP,uDAAuD;QACvD,OAAO,KAAK,CAAA;IACb,CAAC;AACF,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@companion-module/base",
|
|
3
|
-
"version": "2.1.
|
|
3
|
+
"version": "2.1.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"sideEffects": false,
|
|
6
6
|
"license": "MIT",
|
|
@@ -27,7 +27,7 @@
|
|
|
27
27
|
"docs:html": "run -BT typedoc --tsconfig tsconfig.json --readme README-typedoc.md --entryPoints src/docs.ts --excludePrivate --theme default --out docs"
|
|
28
28
|
},
|
|
29
29
|
"engines": {
|
|
30
|
-
"node": "^22.20"
|
|
30
|
+
"node": "^22.20 || ^26.5"
|
|
31
31
|
},
|
|
32
32
|
"files": [
|
|
33
33
|
"README.md",
|
|
@@ -38,8 +38,7 @@
|
|
|
38
38
|
"lib"
|
|
39
39
|
],
|
|
40
40
|
"dependencies": {
|
|
41
|
-
"colord": "^2.9.3"
|
|
42
|
-
"tslib": "^2.8.1"
|
|
41
|
+
"colord": "^2.9.3"
|
|
43
42
|
},
|
|
44
43
|
"devDependencies": {
|
|
45
44
|
"ajv": "^8.20.0",
|