@foxglove/extension 2.53.1 → 2.54.0

package/package.json

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

package/src/experimental.ts

@@ -20,35 +20,29 @@ import type {
  * @hidden
  */
 export namespace Experimental {
-  export type DataSourceId = string & { __brand: "DataSourceId" };
+  export type ComparisonSlot = string & { __brand: "ComparisonSlot" };
 
-  /**
-   * Requested start position for a source on the compare timeline.
-   * Manual values are in compare-time seconds and must be non-negative.
-   */
-  export type RequestedDataSourceTimeOffset = { mode: "auto" } | { mode: "manual"; offset: Time };
-
-  export type DataSourceInfo = {
-    /** ID of the data source (e.g. "A", "B", "C", ...) used to identify the data source. */
-    id: DataSourceId;
-    /** The name of the data source e.g. the name of the file or URL. */
+  export type ComparisonSource = {
+    /** The slot assigned to the comparison source (e.g. "A", "B", "C", ...). */
+    slot: ComparisonSlot;
+    /** The name of the comparison source e.g. the name of the file or URL. */
     name: string;
-    /** User-requested compare-time start configuration. */
-    requestedTimeOffset: RequestedDataSourceTimeOffset;
+    /** User-requested compare-time start, or undefined to align source start with t=0. */
+    requestedTimeOffset?: Time;
     /** Effective time offset applied to source timestamps. */
     timeOffset: Time;
   };
 
-  export type DataSourceMap = ReadonlyMap<DataSourceId, Immutable<DataSourceInfo>>;
+  export type ComparisonSources = ReadonlyMap<ComparisonSlot, Immutable<ComparisonSource>>;
 
   export type MessageEvent<T = unknown> = BaseMessageEvent<T> & {
-    /** The data source that the message stems from. */
-    dataSourceId?: DataSourceId;
+    /** The comparison slot that the message stems from. Only set in compare mode.*/
+    comparisonSlot?: ComparisonSlot;
   };
 
   export type Subscription = BaseSubscription & {
-    /** The data source that the subscription stems from. */
-    dataSourceId?: DataSourceId;
+    /** The comparison source that the subscription stems from. Only set in compare mode.*/
+    comparisonSlot?: ComparisonSlot;
   };
 
   /**
@@ -308,12 +302,8 @@ export namespace Experimental {
   export type MetadataRecord = {
     name: string;
     metadata: Record<string, string>;
-    /**
-     * Which source this came from in multiplexed playback; `undefined` for single-source.
-     * In merge mode all records share the same `dataSourceId` (the default source's id) —
-     * use `dataSources` to detect compare mode.
-     */
-    dataSourceId?: DataSourceId;
+    /** The comparison source that the record stems from. Only set in compare mode.*/
+    comparisonSlot?: ComparisonSlot;
   };
 
   /**
@@ -329,29 +319,21 @@ export namespace Experimental {
     logTime: Time;
     createTime: Time;
     sizeBytes: number;
-    /**
-     * Which source this came from in multiplexed playback; `undefined` for single-source.
-     * In merge mode all attachments share the same `dataSourceId` (the default source's id),
-     * distinct from the attachment's own `id` above — use `dataSources` to detect compare mode.
-     */
-    dataSourceId?: DataSourceId;
+    /** The comparison source that the attachment stems from. Only set in compare mode.*/
+    comparisonSlot?: ComparisonSlot;
   };
 
   export type RenderState = BaseRenderState & {
     /**
-     * Map of available individual data sources, keyed by their ID.
+     * Map of compare data sources. Only present when multiple data sources are loaded in compare mode.
      */
-    dataSources?: DataSourceMap;
+    comparisonSources?: ComparisonSources;
 
-    /**
-     * MCAP metadata records from all active sources. In compare mode use `dataSourceId`
-     * to distinguish per-source records.
-     */
+    /** MCAP metadata records from all active sources. */
     metadata?: MetadataRecord[];
 
     /**
      * MCAP attachment references from all active sources (name/size/timing only, no bytes).
-     * In compare mode use `dataSourceId` to distinguish per-source entries.
      * Call `context.fetchAttachment(id)` to load bytes.
      */
     attachments?: AttachmentInfo[];