@foxglove/extension 2.40.1 → 2.41.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxglove/extension",
-  "version": "2.40.1",
+  "version": "2.41.0",
   "license": "MIT",
   "author": {
     "name": "Foxglove Technologies",

package/src/stable.ts

@@ -1007,16 +1007,28 @@ export type RegisterMessageConverterArgsTopic = {
   /** @deprecated use `outputSchemaDescription` instead */
   schemaDescription?: MessageSchemaDescription;
 
+  /**
+   * Optional list of global variable names that this converter depends on. When any of these
+   * variables change, the converter will be recreated with the updated global variable values. If
+   * watchVariables is an empty list or undefined, the converter will not be recreated when variables
+   * change.
+   */
+  watchVariables?: string[];
+
   /**
    *
    * The create function initializes the converter. It is called by the app to create the converter
-   * when some panel subscribes to the output topic.
+   * when some panel subscribes to the output topic. This receive the global variables as an optional
+   * first argument. When a watched variable changes, the converter will be recreated with the updated
+   * global variable values.
+   * Global variables do not cause re-processing of current frame data.
    *
    * ```
-   * create: () => {
+   * create: (globalVariables) => {
+   *   const threshold = globalVariables.threshold ?? 0;
    *   return (msgEvent: MessageEvent) => {
    *     const msg = msgEvent.message as MySignal;
-   *     return { value: Math.abs(msg.acceleration) };
+   *     return { value: Math.abs(msg.acceleration), aboveThreshold: Math.abs(msg.acceleration) > threshold };
    *   };
    * },
    * ```
@@ -1025,7 +1037,7 @@ export type RegisterMessageConverterArgsTopic = {
    * computation and returns a new message(s) matching the schema description. The function can
    * optionally return undefined to skip producing message(s) for the given input.
    */
-  create: () => TopicConverterReturnType;
+  create: (globalVariables: Readonly<Record<string, VariableValue>>) => TopicConverterReturnType;
 };
 
 type TopicConverterReturnType = (