@foxglove/schemas 0.1.2

package/src/testFixtures.ts

@@ -0,0 +1,90 @@
+import { FoxgloveEnumSchema, FoxgloveMessageSchema, FoxglovePrimitive } from "./types";
+
+const allPrimitives: FoxglovePrimitive[] = [
+  "duration",
+  "time",
+  "boolean",
+  "bytes",
+  "float64",
+  "uint32",
+  "string",
+];
+
+export const exampleEnum: FoxgloveEnumSchema = {
+  type: "enum",
+  name: "ExampleEnum",
+  protobufEnumName: "ExampleProtoEnum",
+  protobufParentMessageName: "ExampleMessage",
+  description: "An example enum",
+  values: [
+    { name: "A", value: 1, description: "Value A" },
+    { name: "B", value: 2, description: "Value B" },
+  ],
+};
+
+const exampleNestedMessage: FoxgloveMessageSchema = {
+  type: "message",
+  name: "NestedMessage",
+  description: "An example nested message",
+  fields: [
+    {
+      name: "field_enum",
+      description: "An enum field",
+      type: { type: "primitive", name: "uint32" },
+    },
+  ],
+};
+
+export const exampleMessage: FoxgloveMessageSchema = {
+  type: "message",
+  name: "ExampleMessage",
+  description: "An example type",
+  fields: [
+    ...allPrimitives.map((name): FoxgloveMessageSchema["fields"][0] => ({
+      name: `field_${name}`,
+      description: `${name} field`,
+      type: { type: "primitive", name },
+    })),
+    ...allPrimitives.map((name): FoxgloveMessageSchema["fields"][0] => ({
+      name: `field_${name}_array`,
+      description: `${name} array field`,
+      type: { type: "primitive", name },
+      array: true,
+    })),
+    ...allPrimitives.map((name): FoxgloveMessageSchema["fields"][0] => ({
+      name: `field_${name}_fixed_array`,
+      description: `${name} fixed-length array field`,
+      type: { type: "primitive", name },
+      array: 3,
+    })),
+    {
+      name: "field_enum",
+      description: "An enum field",
+      type: { type: "enum", enum: exampleEnum },
+    },
+    {
+      name: "field_enum_array",
+      description: "An enum array field",
+      type: { type: "enum", enum: exampleEnum },
+      array: true,
+    },
+    {
+      name: "field_nested",
+      description: "A nested field",
+      type: { type: "nested", schema: exampleNestedMessage },
+    },
+    {
+      name: "field_nested_array",
+      description: "A nested array field\nWith\na\nvery\nlong\ndescription",
+      type: { type: "nested", schema: exampleNestedMessage },
+      array: true,
+    },
+  ],
+};
+
+export const exampleMessageWithoutArrayOfBytes: FoxgloveMessageSchema = {
+  ...exampleMessage,
+  fields: exampleMessage.fields.filter(
+    ({ name }) => name !== "field_bytes_array" && name !== "field_bytes_fixed_array",
+  ),
+};

package/src/types.ts

@@ -0,0 +1,40 @@
+export type FoxglovePrimitive =
+  | "string"
+  | "float64"
+  | "uint32"
+  | "boolean"
+  | "bytes"
+  | "time"
+  | "duration";
+
+export type FoxgloveEnumSchema = {
+  type: "enum";
+  name: string;
+  description: string;
+  protobufParentMessageName: string;
+  protobufEnumName: string;
+  values: ReadonlyArray<{
+    value: number;
+    name: string;
+    description?: string;
+  }>;
+};
+
+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;
+  }>;
+};
+
+export type FoxgloveSchema = FoxgloveMessageSchema | FoxgloveEnumSchema;

package/tsconfig.cjs.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "outDir": "./dist/cjs",
+    "module": "commonjs"
+  }
+}

package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@foxglove/tsconfig/base",
+  "include": ["./**/*"],
+  "compilerOptions": {
+    "rootDir": ".",
+    "outDir": "./dist/esm",
+    "lib": ["es2020", "dom"]
+  }
+}