@foxglove/extension 2.59.0 → 3.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@foxglove/extension",
-  "version": "2.59.0",
+  "version": "3.1.0",
   "homepage": "https://foxglove.dev/",
   "license": "MIT",
   "author": {

package/src/experimental.ts

@@ -340,9 +340,26 @@ export namespace Experimental {
 
     /**
      * Map of compare data sources. Only present when multiple data sources are loaded in compare mode.
+     *
+     * When set, player times on this render state (`currentTime`, `startTime`, `endTime`) and
+     * remapped message `receiveTime` / `publishTime` values live on the shared compare clock
+     * (origin t=0), not wall-clock epoch. Prefer elapsed / seconds formatting for those values.
+     * Recover a source-local absolute time with `sourceTime = currentTime - timeOffset` using the
+     * matching entry's `timeOffset`.
+     *
+     * Reordering sources reassigns which source occupies each slot. The occupant of the primary
+     * slot is also on {@link RenderState.primaryComparisonSource}.
      */
     comparisonSources?: ComparisonSources;
 
+    /**
+     * The comparison source that occupies the primary slot. Only set in compare mode.
+     * Reordering sources may update this field to a different source in the primary slot;
+     * this field then updates. Watch {@link RenderState.comparisonSources} when you need every
+     * source, not only the primary.
+     */
+    primaryComparisonSource?: ComparisonSource;
+
     /** MCAP metadata records from all active sources. */
     metadata?: MetadataRecord[];
 
@@ -359,8 +376,9 @@ export namespace Experimental {
      * this field changes.
      *
      * Use `context.watch` to indicate which fields in {@link RenderState} (e.g. `currentFrame`,
-     * `currentTime`, `previewTime`, `parameters`, `topics`, `metadata`, `attachments`) should
-     * trigger panel re-renders when their contained values change.
+     * `currentTime`, `previewTime`, `parameters`, `topics`, `metadata`, `attachments`,
+     * `comparisonSources`, `primaryComparisonSource`) should trigger panel re-renders when their
+     * contained values change.
      *
      * ```ts
      * context.watch("topics");
@@ -376,7 +394,8 @@ export namespace Experimental {
     /**
      * Process render events for the panel. Each render event receives a render state and a done
      * callback. This override surfaces the experimental {@link RenderState} fields
-     * (`dataSources`, `metadata`, `attachments`) so panels can read them after calling `watch`.
+     * (`comparisonSources`, `primaryComparisonSource`, `metadata`, `attachments`) so panels can read
+     * them after calling `watch`.
      */
     onRender?: (renderState: Immutable<RenderState>, done: () => void) => void;
 

package/src/stable.ts

@@ -1555,6 +1555,11 @@ export type SettingsTreeNodeActionItem = {
    * Whether this action is disabled or not. Defaults to false.
    */
   disabled?: boolean;
+
+  /**
+   * Optional explanatory tooltip for the action.
+   */
+  tooltip?: string;
 };
 
 /**