@foxglove/schemas 0.1.2 → 0.4.0

package/src/generateRos.ts

@@ -9,7 +9,10 @@ type RosMsgFieldWithDescription = RosMsgField & {
 type RosMsgDefinitionWithDescription = {
   originalName: string;
   description?: string;
-  qualifiedRosName: string;
+  /** The name of this message type as used in .msg files (foo_msgs/Bar) */
+  rosMsgInterfaceName: string;
+  /** The name used to refer to this message type in ROS (foo_msgs/Bar for ROS 1, foo_msgs/msg/Bar for ROS 2) */
+  rosFullInterfaceName: string;
   fields: RosMsgFieldWithDescription[];
 };
 
@@ -33,10 +36,12 @@ function primitiveToRos(
 
 export function generateRosMsg(def: RosMsgDefinitionWithDescription): string {
   let source = "";
-  source += `# Generated from ${def.originalName} by @foxglove/schemas\n`;
+  source += `# ${def.rosFullInterfaceName}\n`;
   if (def.description != undefined) {
     source += `# ${def.description}\n`;
   }
+  source += `\n# Generated by https://github.com/foxglove/schemas\n`;
+
   let prevFieldHadComment = true; // start true because of top-of-file comment
   for (const field of def.fields) {
     if (prevFieldHadComment || field.description != undefined) {
@@ -181,7 +186,10 @@ export function generateRosMsgDefinition(
 
   return {
     originalName: schema.name,
-    qualifiedRosName: `foxglove_msgs/${schema.name}`,
+    rosMsgInterfaceName: `foxglove_msgs/${schema.name}`,
+    rosFullInterfaceName:
+      rosVersion === 2 ? `foxglove_msgs/msg/${schema.name}` : `foxglove_msgs/${schema.name}`,
+    description: schema.description,
     fields,
   };
 }
@@ -205,12 +213,13 @@ export function generateRosMsgMergedSchema(
       name = dep.name;
       source = generateRosMsg({
         originalName: dep.name,
-        qualifiedRosName: dep.name,
+        rosMsgInterfaceName: dep.name,
+        rosFullInterfaceName: dep.name,
         fields: rosCommonDefs[dep.name].definitions,
       });
     } else {
       const definition = generateRosMsgDefinition(dep.schema, { rosVersion });
-      name = definition.qualifiedRosName;
+      name = definition.rosMsgInterfaceName;
       source = generateRosMsg(definition);
     }
     result += `================================================================================\nMSG: ${name}\n${source}`;

package/src/generateTypeScript.test.ts

@@ -4,7 +4,7 @@ import { exampleEnum, exampleMessage } from "./testFixtures";
 describe("generateTypeScript", () => {
   it("generates .d.ts files", () => {
     expect(generateTypeScript(exampleEnum)).toMatchInlineSnapshot(`
-      "// Generated from ExampleEnum by @foxglove/schemas
+      "// Generated by https://github.com/foxglove/schemas
 
       /** An example enum */
       export enum ExampleEnum {
@@ -17,7 +17,7 @@ describe("generateTypeScript", () => {
       "
     `);
     expect(generateTypeScript(exampleMessage)).toMatchInlineSnapshot(`
-      "// Generated from ExampleMessage by @foxglove/schemas
+      "// Generated by https://github.com/foxglove/schemas
 
       import { Duration } from \\"./Duration\\";
       import { ExampleEnum } from \\"./ExampleEnum\\";

package/src/generateTypeScript.ts

@@ -92,7 +92,7 @@ export function generateTypeScript(schema: FoxgloveSchema): string {
   }
 
   const outputSections = [
-    `// Generated from ${schema.name} by @foxglove/schemas`,
+    `// Generated by https://github.com/foxglove/schemas`,
 
     Array.from(imports)
       .sort()

package/src/schemas.ts

@@ -160,7 +160,7 @@ const foxglove_Pose: FoxgloveMessageSchema = {
   ],
 };
 
-export const foxglove_CameraCalibration: FoxgloveMessageSchema = {
+const foxglove_CameraCalibration: FoxgloveMessageSchema = {
   type: "message",
   name: "CameraCalibration",
   description: "Camera calibration parameters",
@@ -311,29 +311,6 @@ const foxglove_RawImage: FoxgloveMessageSchema = {
   ],
 };
 
-const foxglove_Transform: FoxgloveMessageSchema = {
-  type: "message",
-  name: "Transform",
-  description: "A transform in 3D space",
-  fields: [
-    {
-      name: "timestamp",
-      type: { type: "primitive", name: "time" },
-      description: "Transform time",
-    },
-    {
-      name: "translation",
-      type: { type: "nested", schema: foxglove_Vector3 },
-      description: "Translation component of the transform",
-    },
-    {
-      name: "rotation",
-      type: { type: "nested", schema: foxglove_Quaternion },
-      description: "Rotation component of the transform",
-    },
-  ],
-};
-
 const foxglove_FrameTransform: FoxgloveMessageSchema = {
   type: "message",
   name: "FrameTransform",
@@ -355,9 +332,14 @@ const foxglove_FrameTransform: FoxgloveMessageSchema = {
       description: "Name of the child frame",
     },
     {
-      name: "transform",
-      type: { type: "nested", schema: foxglove_Transform },
-      description: "Transform from parent frame to child frame",
+      name: "translation",
+      type: { type: "nested", schema: foxglove_Vector3 },
+      description: "Translation component of the transform",
+    },
+    {
+      name: "rotation",
+      type: { type: "nested", schema: foxglove_Quaternion },
+      description: "Rotation component of the transform",
     },
   ],
 };
@@ -444,7 +426,7 @@ const foxglove_NumericType: FoxgloveEnumSchema = {
 const foxglove_PackedElementField: FoxgloveMessageSchema = {
   type: "message",
   name: "PackedElementField",
-  description: "List of fields for every element in a byte array",
+  description: "A field present within each element in a byte array of packed elements.",
   fields: [
     {
       name: "name",
@@ -593,10 +575,16 @@ const foxglove_PointsAnnotation: FoxgloveMessageSchema = {
       description: "Points in 2D image coordinates",
       array: true,
     },
+    {
+      name: "outline_color",
+      type: { type: "nested", schema: foxglove_Color },
+      description: "Outline color",
+    },
     {
       name: "outline_colors",
       type: { type: "nested", schema: foxglove_Color },
-      description: "Outline colors",
+      description:
+        "Per-point colors, if `type` is `POINTS`, or per-segment stroke colors, if `type` is `LINE_LIST`.",
       array: true,
     },
     {
@@ -604,6 +592,11 @@ const foxglove_PointsAnnotation: FoxgloveMessageSchema = {
       type: { type: "nested", schema: foxglove_Color },
       description: "Fill color",
     },
+    {
+      name: "thickness",
+      type: { type: "primitive", name: "float64" },
+      description: "Stroke thickness",
+    },
   ],
 };
 
@@ -840,7 +833,6 @@ export const foxgloveMessageSchemas = {
   PosesInFrame: foxglove_PosesInFrame,
   Quaternion: foxglove_Quaternion,
   RawImage: foxglove_RawImage,
-  Transform: foxglove_Transform,
   Vector2: foxglove_Vector2,
   Vector3: foxglove_Vector3,
 };

package/dist/cjs/schemas/typescript/Transform.d.ts

@@ -1,13 +0,0 @@
-import { Quaternion } from "./Quaternion";
-import { Time } from "./Time";
-import { Vector3 } from "./Vector3";
-/** A transform in 3D space */
-export declare type Transform = {
-    /** Transform time */
-    timestamp: Time;
-    /** Translation component of the transform */
-    translation: Vector3;
-    /** Rotation component of the transform */
-    rotation: Quaternion;
-};
-//# sourceMappingURL=Transform.d.ts.map

package/dist/cjs/schemas/typescript/Transform.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Transform.d.ts","sourceRoot":"","sources":["../../../../schemas/typescript/Transform.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,8BAA8B;AAC9B,oBAAY,SAAS,GAAG;IACtB,qBAAqB;IACrB,SAAS,EAAE,IAAI,CAAC;IAEhB,6CAA6C;IAC7C,WAAW,EAAE,OAAO,CAAC;IAErB,0CAA0C;IAC1C,QAAQ,EAAE,UAAU,CAAC;CACtB,CAAC"}

package/dist/cjs/schemas/typescript/Transform.js

@@ -1,4 +0,0 @@
-"use strict";
-// Generated from Transform by @foxglove/schemas
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=Transform.js.map

package/dist/cjs/schemas/typescript/Transform.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Transform.js","sourceRoot":"","sources":["../../../../schemas/typescript/Transform.ts"],"names":[],"mappings":";AAAA,gDAAgD"}

package/dist/esm/schemas/typescript/Transform.d.ts

@@ -1,13 +0,0 @@
-import { Quaternion } from "./Quaternion";
-import { Time } from "./Time";
-import { Vector3 } from "./Vector3";
-/** A transform in 3D space */
-export declare type Transform = {
-    /** Transform time */
-    timestamp: Time;
-    /** Translation component of the transform */
-    translation: Vector3;
-    /** Rotation component of the transform */
-    rotation: Quaternion;
-};
-//# sourceMappingURL=Transform.d.ts.map

package/dist/esm/schemas/typescript/Transform.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Transform.d.ts","sourceRoot":"","sources":["../../../../schemas/typescript/Transform.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAC9B,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,8BAA8B;AAC9B,oBAAY,SAAS,GAAG;IACtB,qBAAqB;IACrB,SAAS,EAAE,IAAI,CAAC;IAEhB,6CAA6C;IAC7C,WAAW,EAAE,OAAO,CAAC;IAErB,0CAA0C;IAC1C,QAAQ,EAAE,UAAU,CAAC;CACtB,CAAC"}

package/dist/esm/schemas/typescript/Transform.js

@@ -1,3 +0,0 @@
-// Generated from Transform by @foxglove/schemas
-export {};
-//# sourceMappingURL=Transform.js.map

package/dist/esm/schemas/typescript/Transform.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Transform.js","sourceRoot":"","sources":["../../../../schemas/typescript/Transform.ts"],"names":[],"mappings":"AAAA,gDAAgD"}

package/schemas/jsonschema/Transform.json

@@ -1,68 +0,0 @@
-{
-  "$comment": "Generated from Transform by @foxglove/schemas",
-  "title": "Transform",
-  "description": "A transform in 3D space",
-  "type": "object",
-  "properties": {
-    "timestamp": {
-      "type": "object",
-      "title": "time",
-      "properties": {
-        "sec": {
-          "type": "integer",
-          "minimum": 0
-        },
-        "nsec": {
-          "type": "integer",
-          "minimum": 0,
-          "maximum": 999999999
-        }
-      },
-      "description": "Transform time"
-    },
-    "translation": {
-      "$comment": "Generated from Vector3 by @foxglove/schemas",
-      "title": "Vector3",
-      "description": "Translation component of the transform",
-      "type": "object",
-      "properties": {
-        "x": {
-          "type": "number",
-          "description": "x coordinate length"
-        },
-        "y": {
-          "type": "number",
-          "description": "y coordinate length"
-        },
-        "z": {
-          "type": "number",
-          "description": "z coordinate length"
-        }
-      }
-    },
-    "rotation": {
-      "$comment": "Generated from Quaternion by @foxglove/schemas",
-      "title": "Quaternion",
-      "description": "Rotation component of the transform",
-      "type": "object",
-      "properties": {
-        "x": {
-          "type": "number",
-          "description": "x value"
-        },
-        "y": {
-          "type": "number",
-          "description": "y value"
-        },
-        "z": {
-          "type": "number",
-          "description": "z value"
-        },
-        "w": {
-          "type": "number",
-          "description": "w value"
-        }
-      }
-    }
-  }
-}

package/schemas/proto/foxglove/Transform.proto

@@ -1,21 +0,0 @@
-// Generated from Transform by @foxglove/schemas
-
-syntax = "proto3";
-
-import "foxglove/Quaternion.proto";
-import "foxglove/Vector3.proto";
-import "google/protobuf/timestamp.proto";
-
-package foxglove;
-
-// A transform in 3D space
-message Transform {
-  // Transform time
-  google.protobuf.Timestamp timestamp = 1;
-
-  // Translation component of the transform
-  foxglove.Vector3 translation = 2;
-
-  // Rotation component of the transform
-  foxglove.Quaternion rotation = 3;
-}

package/schemas/ros1/Transform.msg

@@ -1,10 +0,0 @@
-# Generated from Transform by @foxglove/schemas
-
-# Transform time
-time timestamp
-
-# Translation component of the transform
-geometry_msgs/Vector3 translation
-
-# Rotation component of the transform
-geometry_msgs/Quaternion rotation

package/schemas/ros2/Transform.msg

@@ -1,10 +0,0 @@
-# Generated from Transform by @foxglove/schemas
-
-# Transform time
-builtin_interfaces/Time timestamp
-
-# Translation component of the transform
-geometry_msgs/Vector3 translation
-
-# Rotation component of the transform
-geometry_msgs/Quaternion rotation

package/schemas/typescript/Transform.ts

@@ -1,17 +0,0 @@
-// Generated from Transform by @foxglove/schemas
-
-import { Quaternion } from "./Quaternion";
-import { Time } from "./Time";
-import { Vector3 } from "./Vector3";
-
-/** A transform in 3D space */
-export type Transform = {
-  /** Transform time */
-  timestamp: Time;
-
-  /** Translation component of the transform */
-  translation: Vector3;
-
-  /** Rotation component of the transform */
-  rotation: Quaternion;
-};