@companion-module/base 1.13.0-2 → 1.13.0
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 +19 -0
- package/README.md +2 -1
- package/dist/module-api/input.d.ts +2 -0
- package/dist/module-api/input.d.ts.map +1 -1
- package/package.json +8 -9
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,24 @@
|
|
|
1
1
|
# Changelog
|
|
2
2
|
|
|
3
|
+
## [1.13.0](https://github.com/bitfocus/companion-module-base/compare/v1.12.1...v1.13.0) (2025-09-04)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* add desciption line below input fields ([d86300c](https://github.com/bitfocus/companion-module-base/commit/d86300ca0e777ef55fe869e2d7b24926172e46b8))
|
|
9
|
+
* add option to actions to skip unsubscribe being called when options change. ([3c4430d](https://github.com/bitfocus/companion-module-base/commit/3c4430d08c33311b9fae54f503518273704eb9f2))
|
|
10
|
+
* add value feedback type ([2e48256](https://github.com/bitfocus/companion-module-base/commit/2e482565bdd1545a74150695e94dfeaad6eaf8ee))
|
|
11
|
+
* allow actions to mark options to not treat reactively for subscription callbacks ([d959218](https://github.com/bitfocus/companion-module-base/commit/d95921803d342640a84cf638db286ebbb2e00515))
|
|
12
|
+
* connection secrets config ([d030871](https://github.com/bitfocus/companion-module-base/commit/d0308713fecf9b7307facdbf32c8c3c60a10bd92))
|
|
13
|
+
* split host api methods to separate out upgrade-script calls ([#118](https://github.com/bitfocus/companion-module-base/issues/118)) ([cfa561c](https://github.com/bitfocus/companion-module-base/commit/cfa561c05ebabbc058e1e83dfbffd65e44de5706))
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
### Bug Fixes
|
|
17
|
+
|
|
18
|
+
* make context.parseVariablesInString a no-op in subscribe/unsubscribe callbacks ([fbbb8a2](https://github.com/bitfocus/companion-module-base/commit/fbbb8a2b0af04453dd639c7fe1db858be0366684))
|
|
19
|
+
* only call feedback subscribe/unsubscribe when the feedback is added/removed, not for every update. ([56ba76a](https://github.com/bitfocus/companion-module-base/commit/56ba76a24c3b48dce9e42d64b93a9f53cc823848))
|
|
20
|
+
* upgrade index tracking in new flow ([27f71f5](https://github.com/bitfocus/companion-module-base/commit/27f71f5ffc65a79d711907e1e31ae1bd16d57809))
|
|
21
|
+
|
|
3
22
|
## [1.12.1](https://github.com/bitfocus/companion-module-base/compare/v1.12.0...v1.12.1) (2025-05-31)
|
|
4
23
|
|
|
5
24
|
|
package/README.md
CHANGED
|
@@ -16,7 +16,8 @@ Each version of Companion supports a limited range of versions of this library l
|
|
|
16
16
|
| v3.3 | v1.0 - v1.8 |
|
|
17
17
|
| v3.4 | v1.0 - v1.10 |
|
|
18
18
|
| v3.5 | v1.0 - v1.11 |
|
|
19
|
-
| v4.0 | v1.0 - v1.12
|
|
19
|
+
| v4.0 | v1.0 - v1.12 |
|
|
20
|
+
| v4.1 | v1.0 - v1.13 (unconfirmed) |
|
|
20
21
|
|
|
21
22
|
## Getting started with a new module
|
|
22
23
|
|
|
@@ -14,6 +14,8 @@ export interface CompanionInputFieldBase {
|
|
|
14
14
|
label: string;
|
|
15
15
|
/** A hover tooltip for this field */
|
|
16
16
|
tooltip?: string;
|
|
17
|
+
/** A longer description/summary/notes for this field */
|
|
18
|
+
description?: string;
|
|
17
19
|
/**
|
|
18
20
|
* @deprecated This will be removed in 2.0.0 of this api. Use `isVisibleExpression` instead.
|
|
19
21
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/module-api/input.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,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;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,+DAA+D;IAC/D,EAAE,EAAE,MAAM,CAAA;IACV,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;
|
|
1
|
+
{"version":3,"file":"input.d.ts","sourceRoot":"","sources":["../../src/module-api/input.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,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;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACvC,+DAA+D;IAC/D,EAAE,EAAE,MAAM,CAAA;IACV,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;IAEpB;;;;;;;;OAQG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,EAAE,GAAG,GAAG,SAAS,KAAK,OAAO,CAAA;IAE9E;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CACnC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC7E,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,wBAAyB,SAAQ,uBAAuB;IACxE,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,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;IACd;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,8BAA8B,CAAA;CACvD;AAED,MAAM,WAAW,8BAA8B;IAC9C,yCAAyC;IACzC,KAAK,CAAC,EAAE,OAAO,CAAA;CACf;AAED,MAAM,MAAM,gBAAgB,GAAG,MAAM,GAAG,MAAM,CAAA;AAC9C;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC9B,0BAA0B;IAC1B,EAAE,EAAE,gBAAgB,CAAA;IACpB,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAA;CACb;AAED;;;;;;;;;;;;;;;;;;GAkBG;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,oDAAoD;IACpD,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,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,YAAY,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,2BAA4B,SAAQ,uBAAuB;IAC3E,IAAI,EAAE,UAAU,CAAA;IAChB,wBAAwB;IACxB,OAAO,EAAE,OAAO,CAAA;CAChB;AAED;;;;;;;;;;;;;;;;GAgBG;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;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,iCAAkC,SAAQ,uBAAuB;IACjF,IAAI,EAAE,iBAAiB,CAAA;CACvB;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,gCAAiC,SAAQ,uBAAuB;IAChF,IAAI,EAAE,gBAAgB,CAAA;CACtB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,yBAA0B,SAAQ,uBAAuB;IACzE,IAAI,EAAE,aAAa,CAAA;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;CAClB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@companion-module/base",
|
|
3
|
-
"version": "1.13.0
|
|
3
|
+
"version": "1.13.0",
|
|
4
4
|
"type": "commonjs",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"typings": "dist/index.d.ts",
|
|
@@ -43,18 +43,17 @@
|
|
|
43
43
|
"@companion-module/tools": "^2.3.0",
|
|
44
44
|
"@tsconfig/node18": "^18.2.4",
|
|
45
45
|
"@types/ejson": "^2.2.2",
|
|
46
|
-
"@types/lodash-es": "^4",
|
|
47
|
-
"@types/node": "^18.19.
|
|
48
|
-
"eslint": "^9.
|
|
46
|
+
"@types/lodash-es": "^4.17.12",
|
|
47
|
+
"@types/node": "^18.19.123",
|
|
48
|
+
"eslint": "^9.34.0",
|
|
49
49
|
"json-schema-to-typescript": "^15.0.4",
|
|
50
50
|
"lodash-es": "^4.17.21",
|
|
51
|
-
"prettier": "^3.
|
|
51
|
+
"prettier": "^3.6.2",
|
|
52
52
|
"typedoc": "^0.27.9",
|
|
53
53
|
"typescript": "~5.7.3",
|
|
54
|
-
"typescript-eslint": "^8.
|
|
55
|
-
"vitest": "^3.
|
|
54
|
+
"typescript-eslint": "^8.42.0",
|
|
55
|
+
"vitest": "^3.2.4",
|
|
56
56
|
"vitest-mock-extended": "^3.1.0"
|
|
57
57
|
},
|
|
58
|
-
"packageManager": "yarn@4.9.1"
|
|
59
|
-
"stableVersion": "1.12.1"
|
|
58
|
+
"packageManager": "yarn@4.9.1"
|
|
60
59
|
}
|