@foxglove/extension 2.25.1 → 2.27.0

package/package.json

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

package/src/experimental.ts

@@ -7,6 +7,48 @@ import {
   MessageEvent,
 } from "./stable";
 
+export type MessageSchemaField = "string" | "number" | "bool" | "byte";
+
+/**
+ * Describes the structure of a message with field names and their types.
+ *
+ * @example
+ * ```typescript
+ * {
+ *   // Primitive fields
+ *   position: "number",
+ *   name: "string",
+ *   active: "bool",
+ *   singleByte: "byte",
+ *
+ *   // Arrays of primitive types
+ *   coordinates: ["number"],
+ *   labels: ["string"],
+ *   flags: ["bool"],
+ *   rawData: ["byte"],
+ *
+ *   // Nested objects
+ *   metadata: {
+ *     timestamp: "number",
+ *     source: "string"
+ *   },
+ *
+ *   // Arrays of objects
+ *   points: [{
+ *     x: "number",
+ *     y: "number",
+ *     z: "number"
+ *   }]
+ * }
+ * ```
+ */
+export type MessageSchemaDescription = {
+  [key: string]:
+    | MessageSchemaField
+    | MessageSchemaDescription
+    | [MessageSchemaField | MessageSchemaDescription];
+};
+
 /**
  * The experimental namespace contains experimental APIs that are not yet stable and WILL change or
  * be REMOVED at any time.
@@ -31,6 +73,52 @@ export namespace Experimental {
     inputTopics: string[];
     outputTopic: string;
     schemaName: string;
+    /**
+     * Describes the structure of the output messages produced by this converter.
+     *
+     * This optional field allows Foxglove to understand the structure of your messages, enabling
+     * features like autocompletion for message path selection.
+     *
+     * The schema can include:
+     * - Primitive types: "string", "number", "bool", "byte"
+     * - Arrays of primitives: ["string"], ["number"], ["bool"], ["byte"]
+     * - Nested objects with their own field definitions
+     * - Arrays of objects (each element having the same structure)
+     *
+     * @example
+     * ```
+     * schemaDescription: {
+     *   // Simple fields
+     *   timestamp: "number",
+     *   label: "string",
+     *   enabled: "bool",
+     *   flags: "byte",
+     *
+     *   // Array of primitives
+     *   values: ["number"],
+     *   names: ["string"],
+     *   options: ["bool"],
+     *   data: ["byte"],
+     *
+     *   // Nested object
+     *   position: {
+     *     x: "number",
+     *     y: "number",
+     *     z: "number"
+     *   },
+     *
+     *   // Array of objects
+     *   landmarks: [{
+     *     id: "string",
+     *     position: {
+     *       x: "number",
+     *       y: "number"
+     *     }
+     *   }]
+     * }
+     * ```
+     */
+    schemaDescription?: MessageSchemaDescription;
     create: () => TopicConverterReturnType;
   };
 

package/src/stable.ts

@@ -1209,6 +1209,12 @@ export type SettingsTreeField = SettingsTreeFieldValue & {
    * Optional message indicating any error state for the field.
    */
   error?: string;
+
+  /**
+   * Optional message indicating any warning state for the field.
+   * This message is not displayed when an error message is present.
+   */
+  warning?: string;
 };
 
 /**
@@ -1290,6 +1296,12 @@ export type SettingsTreeNode = {
    */
   error?: string;
 
+  /**
+   * Optional message indicating any warning state for the node.
+   * This message is not displayed when an error message is present.
+   */
+  warning?: string;
+
   /**
    * Field inputs attached directly to this node.
    */