@foxglove/extension 2.50.0 → 2.51.0

package/package.json

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

package/src/experimental.ts

@@ -3,6 +3,7 @@ import type { Immutable } from "./immutable";
 import type {
   ExtensionContext as BaseExtensionContext,
   PanelExtensionContext as BasePanelExtensionContext,
+  RenderState as BaseRenderState,
 } from "./stable";
 
 /**
@@ -16,6 +17,17 @@ import type {
  * @hidden
  */
 export namespace Experimental {
+  export type DataSourceId = string & { __brand: "DataSourceId" };
+
+  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. */
+    name: string;
+  };
+
+  export type DataSourceMap = ReadonlyMap<DataSourceId, Immutable<DataSourceInfo>>;
+
   /**
    * This type represents the arguments you pass to {@link ExtensionContext.registerDataLoader}
    * when you want to register a data loader.
@@ -269,7 +281,31 @@ export namespace Experimental {
    */
   export type PanelToolbarItem = PanelToolbarButton | PanelToolbarLink | PanelToolbarDivider;
 
+  export type RenderState = BaseRenderState & {
+    /**
+     * Map of available individual data sources, keyed by their ID.
+     */
+    dataSources?: DataSourceMap;
+  };
+
   export interface PanelExtensionContext extends BasePanelExtensionContext {
+    /**
+     * Subscribe to updates on this field within the render state. Render will only be invoked when
+     * this field changes.
+     *
+     * Use `context.watch` to indicate which fields in {@link RenderState} (e.g. `currentFrame`,
+     * `currentTime`, `previewTime`, `parameters`, `topics`) should trigger panel re-renders when
+     * their contained values change.
+     *
+     * ```ts
+     * context.watch("topics");
+     * context.watch("currentFrame");
+     * context.watch("parameters");
+     * context.watch("currentTime");
+     * ```
+     */
+    watch(field: keyof RenderState): void;
+
     /**
      * Set the items in the panel toolbar.
      */