@companion-module/base 1.2.1 → 1.4.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 CHANGED
@@ -1,5 +1,19 @@
1
1
  # Changelog
2
2
 
3
+ ## [1.4.0](https://github.com/bitfocus/companion-module-base/compare/v1.3.0...v1.4.0) (2023-03-27)
4
+
5
+
6
+ ### Features
7
+
8
+ * add support for previewStyle parameter of CompanionButtonPresetDefinition class ([e63bfd8](https://github.com/bitfocus/companion-module-base/commit/e63bfd895367eecedfc05633231364a9a984bb34))
9
+
10
+ ## [1.3.0](https://github.com/bitfocus/companion-module-base/compare/v1.2.1...v1.3.0) (2023-03-06)
11
+
12
+
13
+ ### Features
14
+
15
+ * support specifying `runWhileHeld` from presets ([27663ae](https://github.com/bitfocus/companion-module-base/commit/27663ae9a43dcadb219713c90ebe3496b13b9be7))
16
+
3
17
  ## [1.2.1](https://github.com/bitfocus/companion-module-base/compare/v1.2.0...v1.2.1) (2023-02-22)
4
18
 
5
19
 
@@ -46,14 +46,23 @@ export interface CompanionButtonPresetDefinition {
46
46
  category: string;
47
47
  /** The name of this preset */
48
48
  name: string;
49
- /** The base style of this preset */
49
+ /** The base style of this preset, this will be copied to the button */
50
50
  style: CompanionButtonStyleProps;
51
+ /** Preview style for preset, will be used in GUI for preview */
52
+ previewStyle?: CompanionButtonStyleProps;
51
53
  /** Options for this preset */
52
54
  options?: CompanionButtonPresetOptions;
53
55
  /** The feedbacks on the button */
54
56
  feedbacks: CompanionPresetFeedback[];
55
57
  steps: CompanionButtonStepActions[];
56
58
  }
59
+ export interface CompanionPresetActionsWithOptions {
60
+ options?: CompanionActionSetOptions;
61
+ actions: CompanionPresetAction[];
62
+ }
63
+ export interface CompanionActionSetOptions {
64
+ runWhileHeld?: boolean;
65
+ }
57
66
  export interface CompanionButtonStepActions {
58
67
  /** The button down actions */
59
68
  down: CompanionPresetAction[];
@@ -61,6 +70,7 @@ export interface CompanionButtonStepActions {
61
70
  up: CompanionPresetAction[];
62
71
  rotate_left?: CompanionPresetAction[];
63
72
  rotate_right?: CompanionPresetAction[];
73
+ [delay: number]: CompanionPresetActionsWithOptions | CompanionPresetAction[];
64
74
  }
65
75
  /**
66
76
  * The definitions of a group of feedbacks
@@ -1 +1 @@
1
- {"version":3,"file":"preset.d.ts","sourceRoot":"","sources":["../../src/module-api/preset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kCAAkC,EAAE,MAAM,YAAY,CAAA;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAA;AAEnD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC5C,0EAA0E;IAC1E,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,gFAAgF;IAChF,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,8DAA8D;IAC9D,aAAa,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;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,+BAA+B;IAC/C,8BAA8B;IAC9B,IAAI,EAAE,QAAQ,CAAA;IACd,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAChB,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,oCAAoC;IACpC,KAAK,EAAE,yBAAyB,CAAA;IAChC,8BAA8B;IAC9B,OAAO,CAAC,EAAE,4BAA4B,CAAA;IACtC,kCAAkC;IAClC,SAAS,EAAE,uBAAuB,EAAE,CAAA;IACpC,KAAK,EAAE,0BAA0B,EAAE,CAAA;CACnC;AAED,MAAM,WAAW,0BAA0B;IAC1C,8BAA8B;IAC9B,IAAI,EAAE,qBAAqB,EAAE,CAAA;IAC7B,4BAA4B;IAC5B,EAAE,EAAE,qBAAqB,EAAE,CAAA;IAE3B,WAAW,CAAC,EAAE,qBAAqB,EAAE,CAAA;IACrC,YAAY,CAAC,EAAE,qBAAqB,EAAE,CAAA;CACtC;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,CAAC,EAAE,EAAE,MAAM,GAAG,+BAA+B,GAAG,SAAS,CAAA;CACzD"}
1
+ {"version":3,"file":"preset.d.ts","sourceRoot":"","sources":["../../src/module-api/preset.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kCAAkC,EAAE,MAAM,YAAY,CAAA;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,SAAS,CAAA;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAA;AAEnD;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC5C,0EAA0E;IAC1E,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,gFAAgF;IAChF,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAC1B,8DAA8D;IAC9D,aAAa,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;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,+BAA+B;IAC/C,8BAA8B;IAC9B,IAAI,EAAE,QAAQ,CAAA;IACd,gDAAgD;IAChD,QAAQ,EAAE,MAAM,CAAA;IAChB,8BAA8B;IAC9B,IAAI,EAAE,MAAM,CAAA;IACT,uEAAuE;IACvE,KAAK,EAAE,yBAAyB,CAAC;IACpC,gEAAgE;IAChE,YAAY,CAAC,EAAE,yBAAyB,CAAC;IACzC,8BAA8B;IAC9B,OAAO,CAAC,EAAE,4BAA4B,CAAA;IACtC,kCAAkC;IAClC,SAAS,EAAE,uBAAuB,EAAE,CAAA;IACpC,KAAK,EAAE,0BAA0B,EAAE,CAAA;CACnC;AAED,MAAM,WAAW,iCAAiC;IACjD,OAAO,CAAC,EAAE,yBAAyB,CAAA;IACnC,OAAO,EAAE,qBAAqB,EAAE,CAAA;CAChC;AACD,MAAM,WAAW,yBAAyB;IACzC,YAAY,CAAC,EAAE,OAAO,CAAA;CACtB;AACD,MAAM,WAAW,0BAA0B;IAC1C,8BAA8B;IAC9B,IAAI,EAAE,qBAAqB,EAAE,CAAA;IAC7B,4BAA4B;IAC5B,EAAE,EAAE,qBAAqB,EAAE,CAAA;IAE3B,WAAW,CAAC,EAAE,qBAAqB,EAAE,CAAA;IACrC,YAAY,CAAC,EAAE,qBAAqB,EAAE,CAAA;IAEtC,CAAC,KAAK,EAAE,MAAM,GAAG,iCAAiC,GAAG,qBAAqB,EAAE,CAAA;CAC5E;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IAC1C,CAAC,EAAE,EAAE,MAAM,GAAG,+BAA+B,GAAG,SAAS,CAAA;CACzD"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@companion-module/base",
3
- "version": "1.2.1",
3
+ "version": "1.4.0",
4
4
  "type": "commonjs",
5
5
  "main": "dist/index.js",
6
6
  "typings": "dist/index.d.ts",