@foxglove/extension 2.58.0 → 3.0.0

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@foxglove/extension",
3
- "version": "2.58.0",
3
+ "version": "3.0.0",
4
4
  "homepage": "https://foxglove.dev/",
5
5
  "license": "MIT",
6
6
  "author": {
@@ -340,6 +340,12 @@ export namespace Experimental {
340
340
 
341
341
  /**
342
342
  * Map of compare data sources. Only present when multiple data sources are loaded in compare mode.
343
+ *
344
+ * When set, player times on this render state (`currentTime`, `startTime`, `endTime`) and
345
+ * remapped message `receiveTime` / `publishTime` values live on the shared compare clock
346
+ * (origin t=0), not wall-clock epoch. Prefer elapsed / seconds formatting for those values.
347
+ * Recover a source-local absolute time with `sourceTime = currentTime - timeOffset` using the
348
+ * matching entry's `timeOffset`.
343
349
  */
344
350
  comparisonSources?: ComparisonSources;
345
351
 
package/src/stable.ts CHANGED
@@ -974,7 +974,7 @@ export type RegisterMessageConverterArgsTopic = {
974
974
  * Describes the structure of the output messages produced by this converter.
975
975
  *
976
976
  * This optional field allows Foxglove to understand the structure of your messages, enabling
977
- * features like autocompletion for message path selection.
977
+ * features like autocompletion for expression selection.
978
978
  *
979
979
  * The schema can include:
980
980
  * - Primitive types: "string", "number", "bool", "byte"
@@ -1221,7 +1221,7 @@ export interface ExtensionContext {
1221
1221
  *
1222
1222
  * Your alias function runs whenever there are changes to the data source topics or variables. Any
1223
1223
  * aliases it returns are added to the data source topics (replacing any previously returned
1224
- * aliases) and available for subscribing or use within message paths as if they were real topics.
1224
+ * aliases) and available for subscribing or use within expressions as if they were real topics.
1225
1225
  */
1226
1226
  registerTopicAliases(aliasFunction: TopicAliasFunction): void;
1227
1227
  }
@@ -1380,13 +1380,13 @@ export type SettingsTreeFieldValue =
1380
1380
  validTypes?: string[];
1381
1381
  /** Only include paths from these topics in autocomplete suggestions */
1382
1382
  validTopics?: string[];
1383
- /** True if the input should allow message path functions like "@abs" */
1383
+ /** True if the input should allow functions like "@abs" */
1384
1384
  supportsMessagePathFunctions?: boolean;
1385
1385
  /** Whether the input should allow Plot-only time-series functions like "@delta". Defaults to true. */
1386
1386
  supportsTimeSeriesMessagePathFunctions?: boolean;
1387
1387
  /**
1388
1388
  * @deprecated Use `supportsMessagePathFunctions` instead.
1389
- * True if the input should allow message path functions like "@abs".
1389
+ * True if the input should allow functions like "@abs".
1390
1390
  */
1391
1391
  supportsMathModifiers?: boolean;
1392
1392
  }
@@ -1571,7 +1571,7 @@ export type SettingsTreeNodeAction = SettingsTreeNodeActionItem | SettingsTreeNo
1571
1571
 
1572
1572
  /**
1573
1573
  * Drag-and-drop metadata for a settings tree node. Allows the node to be
1574
- * dragged onto panels that accept topics or message paths.
1574
+ * dragged onto panels that accept topics or expressions.
1575
1575
  *
1576
1576
  * @category Custom panels
1577
1577
  */
@@ -1583,7 +1583,7 @@ export type SettingsTreeNodeDrag =
1583
1583
  }
1584
1584
  | {
1585
1585
  type: "message-path";
1586
- /** Full message path, e.g. `/my_topic.field` or `"/topic with spaces".field`. */
1586
+ /** Full expression, e.g. `/my_topic.field` or `"/topic with spaces".field`. */
1587
1587
  value: string;
1588
1588
  /** True if the path points to a primitive value. Required by panels like Plot. */
1589
1589
  isLeaf?: boolean;