@companion-module/base 1.4.1 → 1.4.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
+ ## [1.4.2](https://github.com/bitfocus/companion-module-base/compare/v1.4.1...v1.4.2) (2023-08-13)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * add `isVisibleData` parameter to `isVisible` functions ([ddb1b42](https://github.com/bitfocus/companion-module-base/commit/ddb1b427de4606e4417f79d83cf25d277480c427))
9
+ * Don't crash if action/feedback options are missing [#53](https://github.com/bitfocus/companion-module-base/issues/53) ([d4e271d](https://github.com/bitfocus/companion-module-base/commit/d4e271ded4b70d69641fc1655f2c14555c8865b0))
10
+
3
11
  ## [1.4.1](https://github.com/bitfocus/companion-module-base/compare/v1.4.0...v1.4.1) (2023-04-12)
4
12
 
5
13
 
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.isInstanceBaseProps = exports.serializeIsVisibleFn = void 0;
4
4
  function serializeIsVisibleFn(options) {
5
- return options.map((option) => {
5
+ return (options ?? []).map((option) => {
6
6
  if ('isVisible' in option) {
7
7
  if (typeof option.isVisible === 'function') {
8
8
  return {
@@ -1 +1 @@
1
- {"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/internal/base.ts"],"names":[],"mappings":";;;AAIA,SAAgB,oBAAoB,CAAoC,OAAY;IACnF,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QAC7B,IAAI,WAAW,IAAI,MAAM,EAAE;YAC1B,IAAI,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU,EAAE;gBAC3C,OAAO;oBACN,GAAG,MAAM;oBACT,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE;oBACxC,SAAS,EAAE,SAAS;iBACpB,CAAA;aACD;SACD;QAED,4DAA4D;QAC5D,OAAO;YACN,GAAG,MAAM;YACT,WAAW,EAAE,SAAS;SACtB,CAAA;IACF,CAAC,CAAC,CAAA;AACH,CAAC;AAlBD,oDAkBC;AAQD,SAAgB,mBAAmB,CAAU,GAAY;IACxD,MAAM,IAAI,GAAG,GAAiC,CAAA;IAC9C,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,IAAI,IAAI,CAAC,oBAAoB,KAAK,IAAI,CAAA;AACrG,CAAC;AAHD,kDAGC"}
1
+ {"version":3,"file":"base.js","sourceRoot":"","sources":["../../src/internal/base.ts"],"names":[],"mappings":";;;AAIA,SAAgB,oBAAoB,CAAoC,OAAY;IACnF,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE;QACrC,IAAI,WAAW,IAAI,MAAM,EAAE;YAC1B,IAAI,OAAO,MAAM,CAAC,SAAS,KAAK,UAAU,EAAE;gBAC3C,OAAO;oBACN,GAAG,MAAM;oBACT,WAAW,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE;oBACxC,SAAS,EAAE,SAAS;iBACpB,CAAA;aACD;SACD;QAED,4DAA4D;QAC5D,OAAO;YACN,GAAG,MAAM;YACT,WAAW,EAAE,SAAS;SACtB,CAAA;IACF,CAAC,CAAC,CAAA;AACH,CAAC;AAlBD,oDAkBC;AAQD,SAAgB,mBAAmB,CAAU,GAAY;IACxD,MAAM,IAAI,GAAG,GAAiC,CAAA;IAC9C,OAAO,OAAO,IAAI,KAAK,QAAQ,IAAI,OAAO,IAAI,CAAC,EAAE,KAAK,QAAQ,IAAI,IAAI,CAAC,oBAAoB,KAAK,IAAI,CAAA;AACrG,CAAC;AAHD,kDAGC"}
@@ -19,7 +19,11 @@ export interface CompanionInputFieldBase {
19
19
  *
20
20
  * Note: This function must not depend on anything outside of its scope. If it does it will fail to compile and will be skipped.
21
21
  */
22
- isVisible?: (options: CompanionOptionValues) => boolean;
22
+ isVisible?: (options: CompanionOptionValues, data: any | undefined) => boolean;
23
+ /**
24
+ * JSON serializable data to provide to `isVisible`
25
+ */
26
+ isVisibleData?: any;
23
27
  }
24
28
  /**
25
29
  * A static un-editable line of text
@@ -1 +1 @@
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;;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,CAAA;IACpB,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,qBAAqB,KAAK,OAAO,CAAA;CACvD;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC7E,IAAI,EAAE,aAAa,CAAA;IACnB,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAA;CACb;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB;IACxE,IAAI,EAAE,aAAa,CAAA;IACnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CACf;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;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;CACtB;AAED,oBAAY,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"}
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;;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,CAAA;IACpB,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAA;IACb,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;;OAIG;IACH,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,qBAAqB,EAAE,IAAI,EAAE,GAAG,GAAG,SAAS,KAAK,OAAO,CAAA;IAC9E;;OAEG;IACH,aAAa,CAAC,EAAE,GAAG,CAAA;CACnB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,6BAA8B,SAAQ,uBAAuB;IAC7E,IAAI,EAAE,aAAa,CAAA;IACnB,uBAAuB;IACvB,KAAK,EAAE,MAAM,CAAA;CACb;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,wBAAyB,SAAQ,uBAAuB;IACxE,IAAI,EAAE,aAAa,CAAA;IACnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;CACf;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;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;CACtB;AAED,oBAAY,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"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@companion-module/base",
3
- "version": "1.4.1",
3
+ "version": "1.4.2",
4
4
  "type": "commonjs",
5
5
  "main": "dist/index.js",
6
6
  "typings": "dist/index.d.ts",
@@ -27,8 +27,8 @@
27
27
  "assets"
28
28
  ],
29
29
  "dependencies": {
30
- "@sentry/node": "^7.36.0",
31
- "@sentry/tracing": "^7.36.0",
30
+ "@sentry/node": "^7.63.0",
31
+ "@sentry/tracing": "^7.63.0",
32
32
  "ajv": "^8.12.0",
33
33
  "debounce-fn": "github:julusian/debounce-fn#4.0.0-maxWaithack.0",
34
34
  "ejson": "^2.2.3",
@@ -36,20 +36,20 @@
36
36
  "nanoid": "^3.3.4",
37
37
  "p-queue": "^6.6.2",
38
38
  "p-timeout": "^4.1.0",
39
- "tslib": "^2.5.0"
39
+ "tslib": "^2.6.1"
40
40
  },
41
41
  "devDependencies": {
42
- "@companion-module/tools": "^0.5.2",
42
+ "@companion-module/tools": "^1.3.2",
43
43
  "@tsconfig/node18": "^1.0.1",
44
44
  "@types/ejson": "^2.2.0",
45
- "@types/jest": "^29.4.0",
46
- "@types/node": "^18.11.17",
45
+ "@types/jest": "^29.5.3",
46
+ "@types/node": "^18.17.5",
47
47
  "ajv-cli": "^5.0.0",
48
- "jest": "^29.4.1",
48
+ "jest": "^29.6.2",
49
49
  "json-schema-to-typescript": "^11.0.3",
50
- "prettier": "^2.8.3",
51
- "ts-jest": "^29.0.5",
52
- "typedoc": "^0.23.24",
50
+ "prettier": "^2.8.8",
51
+ "ts-jest": "^29.1.1",
52
+ "typedoc": "^0.24.8",
53
53
  "typescript": "~4.8.4"
54
54
  }
55
55
  }