@companion-surface/base 0.3.0 → 0.3.1

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,12 @@
1
1
  # Changelog
2
2
 
3
+ ## [0.3.1](https://github.com/bitfocus/companion-surface-api/compare/companion-surface-base-v0.3.0...companion-surface-base-v0.3.1) (2025-10-28)
4
+
5
+
6
+ ### Bug Fixes
7
+
8
+ * expose expression to check if remote connections match ([9071e5b](https://github.com/bitfocus/companion-surface-api/commit/9071e5b7082b4f47ffb21a9dfba893fb3d3681da))
9
+
3
10
  ## [0.3.0](https://github.com/bitfocus/companion-surface-api/compare/companion-surface-base-v0.2.0...companion-surface-base-v0.3.0) (2025-10-28)
4
11
 
5
12
 
@@ -22,9 +22,18 @@ export interface SurfacePluginRemote<TInfo> extends EventEmitter<SurfacePluginRe
22
22
  /**
23
23
  * Get any configuration fields needed for configuring a remote connection
24
24
  *
25
- * Note: This gets called once during plugin initialisation. Changes made after this will not be detected
25
+ * Note: This gets fetched once during plugin initialisation. Changes made after this will not be detected
26
26
  */
27
27
  readonly configFields: SomeCompanionInputField[];
28
+ /**
29
+ * An expression to use to check if two configs refer to the same remote surface connection.
30
+ * Often this should not include every field, as some affect behaviour rather than the identity of the connection
31
+ *
32
+ * This uses the companion expression syntax, one object can be accessed like $(objA:address) and the other like $(objB:address)
33
+ *
34
+ * Note: This gets fetched once during plugin initialisation. Changes made after this will not be detected
35
+ */
36
+ readonly checkConfigMatchesExpression: string | null;
28
37
  /**
29
38
  * Setup one or more connections to remote surfaces
30
39
  * @param connectionInfos Info about the connections to add
@@ -1 +1 @@
1
- {"version":3,"file":"remote.d.ts","sourceRoot":"","sources":["../../src/surface-api/remote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,aAAa,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AACxE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAA;AAC7D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAExD,MAAM,WAAW,yBAAyB,CAAC,KAAK;IAC/C,iBAAiB,EAAE,CAAC,YAAY,EAAE,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IAGjE;;;OAGG;IACH,gBAAgB,EAAE,CAAC,eAAe,EAAE,2BAA2B,EAAE,CAAC,CAAA;IAClE;;;OAGG;IACH,oBAAoB,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,CAAC,CAAA;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,KAAK,CAAE,SAAQ,YAAY,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;IACjG;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,uBAAuB,EAAE,CAAA;IAEhD;;;OAGG;IACH,gBAAgB,CAAC,eAAe,EAAE,2BAA2B,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/E;;;OAGG;IACH,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvD;;;;OAIG;IACH,aAAa,CAAC,WAAW,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;CAC9D;AAED,MAAM,WAAW,2BAA2B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAKnB;;;OAGG;IACH,MAAM,EAAE,aAAa,CAAA;CACrB"}
1
+ {"version":3,"file":"remote.d.ts","sourceRoot":"","sources":["../../src/surface-api/remote.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,YAAY,MAAM,aAAa,CAAA;AAC3C,OAAO,KAAK,EAAE,aAAa,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAA;AACxE,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAA;AAC7D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,aAAa,CAAA;AAExD,MAAM,WAAW,yBAAyB,CAAC,KAAK;IAC/C,iBAAiB,EAAE,CAAC,YAAY,EAAE,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC,CAAA;IAGjE;;;OAGG;IACH,gBAAgB,EAAE,CAAC,eAAe,EAAE,2BAA2B,EAAE,CAAC,CAAA;IAClE;;;OAGG;IACH,oBAAoB,EAAE,CAAC,aAAa,EAAE,MAAM,EAAE,CAAC,CAAA;CAC/C;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB,CAAC,KAAK,CAAE,SAAQ,YAAY,CAAC,yBAAyB,CAAC,KAAK,CAAC,CAAC;IACjG;;;;OAIG;IACH,QAAQ,CAAC,YAAY,EAAE,uBAAuB,EAAE,CAAA;IAEhD;;;;;;;OAOG;IACH,QAAQ,CAAC,4BAA4B,EAAE,MAAM,GAAG,IAAI,CAAA;IAEpD;;;OAGG;IACH,gBAAgB,CAAC,eAAe,EAAE,2BAA2B,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAE/E;;;OAGG;IACH,eAAe,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAEvD;;;;OAIG;IACH,aAAa,CAAC,WAAW,EAAE,qBAAqB,CAAC,KAAK,CAAC,GAAG,IAAI,CAAA;CAC9D;AAED,MAAM,WAAW,2BAA2B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAKnB;;;OAGG;IACH,MAAM,EAAE,aAAa,CAAA;CACrB"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@companion-surface/base",
3
- "version": "0.3.0",
3
+ "version": "0.3.1",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "repository": "https://github.com/bitfocus/companion-surface-api",