@foxglove/schemas 0.3.0 → 0.6.0

package/src/testFixtures.ts

@@ -78,6 +78,7 @@ export const exampleMessage: FoxgloveMessageSchema = {
       description: "A nested array field\nWith\na\nvery\nlong\ndescription",
       type: { type: "nested", schema: exampleNestedMessage },
       array: true,
+      protobufFieldNumber: 4,
     },
   ],
 };

package/src/types.ts

@@ -20,21 +20,24 @@ export type FoxgloveEnumSchema = {
   }>;
 };
 
+export type FoxgloveMessageField = {
+  name: string;
+  type:
+    | { type: "primitive"; name: FoxglovePrimitive }
+    | { type: "nested"; schema: FoxgloveMessageSchema }
+    | { type: "enum"; enum: FoxgloveEnumSchema };
+  array?: true | number;
+  required?: true;
+  description: string;
+  protobufFieldNumber?: number;
+};
+
 export type FoxgloveMessageSchema = {
   type: "message";
   name: string;
   description: string;
   rosEquivalent?: keyof typeof import("@foxglove/rosmsg-msgs-common").definitions;
-  fields: ReadonlyArray<{
-    name: string;
-    type:
-      | { type: "primitive"; name: FoxglovePrimitive }
-      | { type: "nested"; schema: FoxgloveMessageSchema }
-      | { type: "enum"; enum: FoxgloveEnumSchema };
-    array?: true | number;
-    required?: true;
-    description: string;
-  }>;
+  fields: ReadonlyArray<FoxgloveMessageField>;
 };
 
 export type FoxgloveSchema = FoxgloveMessageSchema | FoxgloveEnumSchema;