@foxglove/schemas 0.1.2

package/dist/esm/scripts/updateGeneratedFiles.js

@@ -0,0 +1,74 @@
+import { program } from "commander";
+import fs from "fs/promises";
+import path from "path";
+import rimraf from "rimraf";
+import { promisify } from "util";
+import { generateRosMsg, generateRosMsgDefinition } from "../src";
+import { generateJsonSchema } from "../src/generateJsonSchema";
+import { generateProto } from "../src/generateProto";
+import { generateTypeScript, DURATION_TS, TIME_TS } from "../src/generateTypeScript";
+import { foxgloveEnumSchemas, foxgloveMessageSchemas } from "../src/schemas";
+async function logProgress(message, body) {
+    process.stderr.write(`${message}... `);
+    await body();
+    process.stderr.write("done\n");
+}
+async function main({ outDir }) {
+    await logProgress("Removing any existing output directory", async () => {
+        await promisify(rimraf)(outDir);
+    });
+    await logProgress("Generating JSONSchema definitions", async () => {
+        await fs.mkdir(path.join(outDir, "jsonschema"), { recursive: true });
+        for (const schema of Object.values(foxgloveMessageSchemas)) {
+            await fs.writeFile(path.join(outDir, "jsonschema", `${schema.name}.json`), JSON.stringify(generateJsonSchema(schema), undefined, 2) + "\n");
+        }
+    });
+    await logProgress("Generating ROS 1 msg files", async () => {
+        await fs.mkdir(path.join(outDir, "ros1"), { recursive: true });
+        for (const schema of Object.values(foxgloveMessageSchemas)) {
+            if (schema.rosEquivalent != undefined) {
+                continue;
+            }
+            await fs.writeFile(path.join(outDir, "ros1", `${schema.name}.msg`), generateRosMsg(generateRosMsgDefinition(schema, { rosVersion: 1 })));
+        }
+    });
+    await logProgress("Generating ROS 2 msg files", async () => {
+        await fs.mkdir(path.join(outDir, "ros2"), { recursive: true });
+        for (const schema of Object.values(foxgloveMessageSchemas)) {
+            if (schema.rosEquivalent != undefined) {
+                continue;
+            }
+            await fs.writeFile(path.join(outDir, "ros2", `${schema.name}.msg`), generateRosMsg(generateRosMsgDefinition(schema, { rosVersion: 2 })));
+        }
+    });
+    await logProgress("Generating Protobuf definitions", async () => {
+        await fs.mkdir(path.join(outDir, "proto", "foxglove"), { recursive: true });
+        for (const schema of Object.values(foxgloveMessageSchemas)) {
+            const enums = Object.values(foxgloveEnumSchemas).filter((enumSchema) => enumSchema.protobufParentMessageName === schema.name);
+            await fs.writeFile(path.join(outDir, "proto", "foxglove", `${schema.name}.proto`), generateProto(schema, enums));
+        }
+    });
+    await logProgress("Generating TypeScript definitions", async () => {
+        await fs.mkdir(path.join(outDir, "typescript"), { recursive: true });
+        await fs.writeFile(path.join(outDir, "typescript", "Time.ts"), TIME_TS);
+        await fs.writeFile(path.join(outDir, "typescript", "Duration.ts"), DURATION_TS);
+        for (const schema of Object.values(foxgloveMessageSchemas)) {
+            await fs.writeFile(path.join(outDir, "typescript", `${schema.name}.ts`), generateTypeScript(schema));
+        }
+        for (const schema of Object.values(foxgloveEnumSchemas)) {
+            await fs.writeFile(path.join(outDir, "typescript", `${schema.name}.ts`), generateTypeScript(schema));
+        }
+        const allSchemaNames = [
+            ...Object.values(foxgloveMessageSchemas),
+            ...Object.values(foxgloveEnumSchemas),
+        ].sort((a, b) => a.name.localeCompare(b.name));
+        let indexTS = "";
+        for (const schema of allSchemaNames) {
+            indexTS += `export * from "./${schema.name}";\n`;
+        }
+        await fs.writeFile(path.join(outDir, "typescript", `index.ts`), indexTS);
+    });
+}
+program.requiredOption("-o, --out-dir <dir>", "output directory").action(main);
+program.parseAsync().catch(console.error);
+//# sourceMappingURL=updateGeneratedFiles.js.map

package/dist/esm/scripts/updateGeneratedFiles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"updateGeneratedFiles.js","sourceRoot":"","sources":["../../../scripts/updateGeneratedFiles.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AACpC,OAAO,EAAE,MAAM,aAAa,CAAC;AAC7B,OAAO,IAAI,MAAM,MAAM,CAAC;AACxB,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAEjC,OAAO,EAAE,cAAc,EAAE,wBAAwB,EAAE,MAAM,QAAQ,CAAC;AAClE,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAC;AACrF,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAE7E,KAAK,UAAU,WAAW,CAAC,OAAe,EAAE,IAAyB;IACnE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,OAAO,MAAM,CAAC,CAAC;IACvC,MAAM,IAAI,EAAE,CAAC;IACb,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;AACjC,CAAC;AAED,KAAK,UAAU,IAAI,CAAC,EAAE,MAAM,EAAsB;IAChD,MAAM,WAAW,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;QACrE,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,EAAE;YAC1D,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC,IAAI,OAAO,CAAC,EACtD,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC,GAAG,IAAI,CAChE,CAAC;SACH;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/D,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,EAAE;YAC1D,IAAI,MAAM,CAAC,aAAa,IAAI,SAAS,EAAE;gBACrC,SAAS;aACV;YACD,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,MAAM,CAAC,EAC/C,cAAc,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC,CACpE,CAAC;SACH;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,CAAC,4BAA4B,EAAE,KAAK,IAAI,EAAE;QACzD,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC/D,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,EAAE;YAC1D,IAAI,MAAM,CAAC,aAAa,IAAI,SAAS,EAAE;gBACrC,SAAS;aACV;YACD,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,CAAC,IAAI,MAAM,CAAC,EAC/C,cAAc,CAAC,wBAAwB,CAAC,MAAM,EAAE,EAAE,UAAU,EAAE,CAAC,EAAE,CAAC,CAAC,CACpE,CAAC;SACH;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;QAC9D,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QAC5E,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,EAAE;YAC1D,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAAC,MAAM,CACrD,CAAC,UAAU,EAAE,EAAE,CAAC,UAAU,CAAC,yBAAyB,KAAK,MAAM,CAAC,IAAI,CACrE,CAAC;YACF,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC,IAAI,QAAQ,CAAC,EAC9D,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAC7B,CAAC;SACH;IACH,CAAC,CAAC,CAAC;IAEH,MAAM,WAAW,CAAC,mCAAmC,EAAE,KAAK,IAAI,EAAE;QAChE,MAAM,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACrE,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,OAAO,CAAC,CAAC;QACxE,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,aAAa,CAAC,EAAE,WAAW,CAAC,CAAC;QAChF,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,EAAE;YAC1D,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC,IAAI,KAAK,CAAC,EACpD,kBAAkB,CAAC,MAAM,CAAC,CAC3B,CAAC;SACH;QACD,KAAK,MAAM,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC,EAAE;YACvD,MAAM,EAAE,CAAC,SAAS,CAChB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,GAAG,MAAM,CAAC,IAAI,KAAK,CAAC,EACpD,kBAAkB,CAAC,MAAM,CAAC,CAC3B,CAAC;SACH;QACD,MAAM,cAAc,GAAG;YACrB,GAAG,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC;YACxC,GAAG,MAAM,CAAC,MAAM,CAAC,mBAAmB,CAAC;SACtC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;QAC/C,IAAI,OAAO,GAAG,EAAE,CAAC;QACjB,KAAK,MAAM,MAAM,IAAI,cAAc,EAAE;YACnC,OAAO,IAAI,oBAAoB,MAAM,CAAC,IAAI,MAAM,CAAC;SAClD;QACD,MAAM,EAAE,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,YAAY,EAAE,UAAU,CAAC,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;AACL,CAAC;AAED,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,kBAAkB,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;AAE/E,OAAO,CAAC,UAAU,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC"}

package/dist/esm/src/generateJsonSchema.d.ts

@@ -0,0 +1,3 @@
+import { FoxgloveMessageSchema } from "./types";
+export declare function generateJsonSchema(schema: FoxgloveMessageSchema): Record<string, unknown>;
+//# sourceMappingURL=generateJsonSchema.d.ts.map

package/dist/esm/src/generateJsonSchema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateJsonSchema.d.ts","sourceRoot":"","sources":["../../../src/generateJsonSchema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAqB,MAAM,SAAS,CAAC;AAiCnE,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,qBAAqB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAgDzF"}

package/dist/esm/src/generateJsonSchema.js

@@ -0,0 +1,81 @@
+function primitiveToJsonSchema(type) {
+    switch (type) {
+        case "string":
+            return { type: "string" };
+        case "boolean":
+            return { type: "boolean" };
+        case "float64":
+            return { type: "number" };
+        case "uint32":
+            return { type: "integer", minimum: 0 };
+        case "time":
+            return {
+                type: "object",
+                title: "time",
+                properties: {
+                    sec: { type: "integer", minimum: 0 },
+                    nsec: { type: "integer", minimum: 0, maximum: 999999999 },
+                },
+            };
+        case "duration":
+            return {
+                type: "object",
+                title: "duration",
+                properties: {
+                    sec: { type: "integer" },
+                    nsec: { type: "integer", minimum: 0, maximum: 999999999 },
+                },
+            };
+    }
+}
+export function generateJsonSchema(schema) {
+    const properties = {};
+    for (const field of schema.fields) {
+        let fieldType;
+        switch (field.type.type) {
+            case "primitive":
+                if (field.type.name === "bytes") {
+                    fieldType = { type: "string", contentEncoding: "base64" };
+                }
+                else {
+                    fieldType = primitiveToJsonSchema(field.type.name);
+                }
+                break;
+            case "nested":
+                fieldType = generateJsonSchema(field.type.schema);
+                break;
+            case "enum":
+                fieldType = {
+                    title: `${field.type.enum.name}: ${field.type.enum.description}`,
+                    description: field.description,
+                    oneOf: field.type.enum.values.map(({ name, value, description }) => ({
+                        title: name,
+                        const: value,
+                        description,
+                    })),
+                };
+                break;
+        }
+        if (typeof field.array === "number") {
+            fieldType = {
+                type: "array",
+                items: fieldType,
+                minItems: field.array,
+                maxItems: field.array,
+            };
+        }
+        else if (field.array === true) {
+            fieldType = { type: "array", items: fieldType };
+        }
+        fieldType.description = field.description;
+        properties[field.name] = fieldType;
+    }
+    return {
+        $comment: `Generated from ${schema.name} by @foxglove/schemas`,
+        title: schema.name,
+        description: schema.description,
+        type: "object",
+        properties,
+    };
+}
+//# sourceMappingURL=generateJsonSchema.js.map

package/dist/esm/src/generateJsonSchema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateJsonSchema.js","sourceRoot":"","sources":["../../../src/generateJsonSchema.ts"],"names":[],"mappings":"AAEA,SAAS,qBAAqB,CAAC,IAAyC;IACtE,QAAQ,IAAI,EAAE;QACZ,KAAK,QAAQ;YACX,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC5B,KAAK,SAAS;YACZ,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAC;QAC7B,KAAK,SAAS;YACZ,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;QAC5B,KAAK,QAAQ;YACX,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QACzC,KAAK,MAAM;YACT,OAAO;gBACL,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,MAAM;gBACb,UAAU,EAAE;oBACV,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE;oBACpC,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,SAAW,EAAE;iBAC5D;aACF,CAAC;QACJ,KAAK,UAAU;YACb,OAAO;gBACL,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,UAAU;gBACjB,UAAU,EAAE;oBACV,GAAG,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;oBACxB,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,SAAW,EAAE;iBAC5D;aACF,CAAC;KACL;AACH,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,MAA6B;IAC9D,MAAM,UAAU,GAA4B,EAAE,CAAC;IAC/C,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,MAAM,EAAE;QACjC,IAAI,SAAkC,CAAC;QACvC,QAAQ,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE;YACvB,KAAK,WAAW;gBACd,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,OAAO,EAAE;oBAC/B,SAAS,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,eAAe,EAAE,QAAQ,EAAE,CAAC;iBAC3D;qBAAM;oBACL,SAAS,GAAG,qBAAqB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;iBACpD;gBACD,MAAM;YACR,KAAK,QAAQ;gBACX,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAClD,MAAM;YACR,KAAK,MAAM;gBACT,SAAS,GAAG;oBACV,KAAK,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;oBAChE,WAAW,EAAE,KAAK,CAAC,WAAW;oBAC9B,KAAK,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;wBACnE,KAAK,EAAE,IAAI;wBACX,KAAK,EAAE,KAAK;wBACZ,WAAW;qBACZ,CAAC,CAAC;iBACJ,CAAC;gBACF,MAAM;SACT;QACD,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE;YACnC,SAAS,GAAG;gBACV,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,SAAS;gBAChB,QAAQ,EAAE,KAAK,CAAC,KAAK;gBACrB,QAAQ,EAAE,KAAK,CAAC,KAAK;aACtB,CAAC;SACH;aAAM,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,EAAE;YAC/B,SAAS,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;SACjD;QACD,SAAS,CAAC,WAAW,GAAG,KAAK,CAAC,WAAW,CAAC;QAC1C,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,SAAS,CAAC;KACpC;IAED,OAAO;QACL,QAAQ,EAAE,kBAAkB,MAAM,CAAC,IAAI,uBAAuB;QAC9D,KAAK,EAAE,MAAM,CAAC,IAAI;QAClB,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,IAAI,EAAE,QAAQ;QACd,UAAU;KACX,CAAC;AACJ,CAAC"}

package/dist/esm/src/generateJsonSchema.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=generateJsonSchema.test.d.ts.map

package/dist/esm/src/generateJsonSchema.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateJsonSchema.test.d.ts","sourceRoot":"","sources":["../../../src/generateJsonSchema.test.ts"],"names":[],"mappings":""}

package/dist/esm/src/generateJsonSchema.test.js

@@ -0,0 +1,309 @@
+import Ajv from "ajv";
+import { generateJsonSchema } from "./generateJsonSchema";
+import { foxgloveMessageSchemas } from "./schemas";
+import { exampleMessage } from "./testFixtures";
+describe("generateJsonSchema", () => {
+    it("generates expected JSON Schema", () => {
+        expect(generateJsonSchema(exampleMessage)).toMatchInlineSnapshot(`
+      Object {
+        "$comment": "Generated from ExampleMessage by @foxglove/schemas",
+        "description": "An example type",
+        "properties": Object {
+          "field_boolean": Object {
+            "description": "boolean field",
+            "type": "boolean",
+          },
+          "field_boolean_array": Object {
+            "description": "boolean array field",
+            "items": Object {
+              "type": "boolean",
+            },
+            "type": "array",
+          },
+          "field_boolean_fixed_array": Object {
+            "description": "boolean fixed-length array field",
+            "items": Object {
+              "type": "boolean",
+            },
+            "maxItems": 3,
+            "minItems": 3,
+            "type": "array",
+          },
+          "field_bytes": Object {
+            "contentEncoding": "base64",
+            "description": "bytes field",
+            "type": "string",
+          },
+          "field_bytes_array": Object {
+            "description": "bytes array field",
+            "items": Object {
+              "contentEncoding": "base64",
+              "type": "string",
+            },
+            "type": "array",
+          },
+          "field_bytes_fixed_array": Object {
+            "description": "bytes fixed-length array field",
+            "items": Object {
+              "contentEncoding": "base64",
+              "type": "string",
+            },
+            "maxItems": 3,
+            "minItems": 3,
+            "type": "array",
+          },
+          "field_duration": Object {
+            "description": "duration field",
+            "properties": Object {
+              "nsec": Object {
+                "maximum": 999999999,
+                "minimum": 0,
+                "type": "integer",
+              },
+              "sec": Object {
+                "type": "integer",
+              },
+            },
+            "title": "duration",
+            "type": "object",
+          },
+          "field_duration_array": Object {
+            "description": "duration array field",
+            "items": Object {
+              "properties": Object {
+                "nsec": Object {
+                  "maximum": 999999999,
+                  "minimum": 0,
+                  "type": "integer",
+                },
+                "sec": Object {
+                  "type": "integer",
+                },
+              },
+              "title": "duration",
+              "type": "object",
+            },
+            "type": "array",
+          },
+          "field_duration_fixed_array": Object {
+            "description": "duration fixed-length array field",
+            "items": Object {
+              "properties": Object {
+                "nsec": Object {
+                  "maximum": 999999999,
+                  "minimum": 0,
+                  "type": "integer",
+                },
+                "sec": Object {
+                  "type": "integer",
+                },
+              },
+              "title": "duration",
+              "type": "object",
+            },
+            "maxItems": 3,
+            "minItems": 3,
+            "type": "array",
+          },
+          "field_enum": Object {
+            "description": "An enum field",
+            "oneOf": Array [
+              Object {
+                "const": 1,
+                "description": "Value A",
+                "title": "A",
+              },
+              Object {
+                "const": 2,
+                "description": "Value B",
+                "title": "B",
+              },
+            ],
+            "title": "ExampleEnum: An example enum",
+          },
+          "field_enum_array": Object {
+            "description": "An enum array field",
+            "items": Object {
+              "description": "An enum array field",
+              "oneOf": Array [
+                Object {
+                  "const": 1,
+                  "description": "Value A",
+                  "title": "A",
+                },
+                Object {
+                  "const": 2,
+                  "description": "Value B",
+                  "title": "B",
+                },
+              ],
+              "title": "ExampleEnum: An example enum",
+            },
+            "type": "array",
+          },
+          "field_float64": Object {
+            "description": "float64 field",
+            "type": "number",
+          },
+          "field_float64_array": Object {
+            "description": "float64 array field",
+            "items": Object {
+              "type": "number",
+            },
+            "type": "array",
+          },
+          "field_float64_fixed_array": Object {
+            "description": "float64 fixed-length array field",
+            "items": Object {
+              "type": "number",
+            },
+            "maxItems": 3,
+            "minItems": 3,
+            "type": "array",
+          },
+          "field_nested": Object {
+            "$comment": "Generated from NestedMessage by @foxglove/schemas",
+            "description": "A nested field",
+            "properties": Object {
+              "field_enum": Object {
+                "description": "An enum field",
+                "minimum": 0,
+                "type": "integer",
+              },
+            },
+            "title": "NestedMessage",
+            "type": "object",
+          },
+          "field_nested_array": Object {
+            "description": "A nested array field
+      With
+      a
+      very
+      long
+      description",
+            "items": Object {
+              "$comment": "Generated from NestedMessage by @foxglove/schemas",
+              "description": "An example nested message",
+              "properties": Object {
+                "field_enum": Object {
+                  "description": "An enum field",
+                  "minimum": 0,
+                  "type": "integer",
+                },
+              },
+              "title": "NestedMessage",
+              "type": "object",
+            },
+            "type": "array",
+          },
+          "field_string": Object {
+            "description": "string field",
+            "type": "string",
+          },
+          "field_string_array": Object {
+            "description": "string array field",
+            "items": Object {
+              "type": "string",
+            },
+            "type": "array",
+          },
+          "field_string_fixed_array": Object {
+            "description": "string fixed-length array field",
+            "items": Object {
+              "type": "string",
+            },
+            "maxItems": 3,
+            "minItems": 3,
+            "type": "array",
+          },
+          "field_time": Object {
+            "description": "time field",
+            "properties": Object {
+              "nsec": Object {
+                "maximum": 999999999,
+                "minimum": 0,
+                "type": "integer",
+              },
+              "sec": Object {
+                "minimum": 0,
+                "type": "integer",
+              },
+            },
+            "title": "time",
+            "type": "object",
+          },
+          "field_time_array": Object {
+            "description": "time array field",
+            "items": Object {
+              "properties": Object {
+                "nsec": Object {
+                  "maximum": 999999999,
+                  "minimum": 0,
+                  "type": "integer",
+                },
+                "sec": Object {
+                  "minimum": 0,
+                  "type": "integer",
+                },
+              },
+              "title": "time",
+              "type": "object",
+            },
+            "type": "array",
+          },
+          "field_time_fixed_array": Object {
+            "description": "time fixed-length array field",
+            "items": Object {
+              "properties": Object {
+                "nsec": Object {
+                  "maximum": 999999999,
+                  "minimum": 0,
+                  "type": "integer",
+                },
+                "sec": Object {
+                  "minimum": 0,
+                  "type": "integer",
+                },
+              },
+              "title": "time",
+              "type": "object",
+            },
+            "maxItems": 3,
+            "minItems": 3,
+            "type": "array",
+          },
+          "field_uint32": Object {
+            "description": "uint32 field",
+            "minimum": 0,
+            "type": "integer",
+          },
+          "field_uint32_array": Object {
+            "description": "uint32 array field",
+            "items": Object {
+              "minimum": 0,
+              "type": "integer",
+            },
+            "type": "array",
+          },
+          "field_uint32_fixed_array": Object {
+            "description": "uint32 fixed-length array field",
+            "items": Object {
+              "minimum": 0,
+              "type": "integer",
+            },
+            "maxItems": 3,
+            "minItems": 3,
+            "type": "array",
+          },
+        },
+        "title": "ExampleMessage",
+        "type": "object",
+      }
+    `);
+    });
+    it.each(Object.values(foxgloveMessageSchemas))("generates parseable JSON Schema for $name", (schema) => {
+        const ajv = new Ajv();
+        expect(() => ajv.compile(generateJsonSchema(schema))).not.toThrow();
+    });
+});
+//# sourceMappingURL=generateJsonSchema.test.js.map

package/dist/esm/src/generateJsonSchema.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateJsonSchema.test.js","sourceRoot":"","sources":["../../../src/generateJsonSchema.test.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,KAAK,CAAC;AAEtB,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,sBAAsB,EAAE,MAAM,WAAW,CAAC;AACnD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAEhD,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,CAAC,kBAAkB,CAAC,cAAc,CAAC,CAAC,CAAC,qBAAqB,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;KAuShE,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,sBAAsB,CAAC,CAAC,CAC5C,2CAA2C,EAC3C,CAAC,MAAM,EAAE,EAAE;QACT,MAAM,GAAG,GAAG,IAAI,GAAG,EAAE,CAAC;QACtB,MAAM,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;IACtE,CAAC,CACF,CAAC;AACJ,CAAC,CAAC,CAAC"}

package/dist/esm/src/generateProto.d.ts

@@ -0,0 +1,3 @@
+import { FoxgloveEnumSchema, FoxgloveMessageSchema } from "./types";
+export declare function generateProto(schema: FoxgloveMessageSchema, nestedEnums: FoxgloveEnumSchema[]): string;
+//# sourceMappingURL=generateProto.d.ts.map

package/dist/esm/src/generateProto.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateProto.d.ts","sourceRoot":"","sources":["../../../src/generateProto.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,qBAAqB,EAAqB,MAAM,SAAS,CAAC;AAiBvF,wBAAgB,aAAa,CAC3B,MAAM,EAAE,qBAAqB,EAC7B,WAAW,EAAE,kBAAkB,EAAE,GAChC,MAAM,CA4ER"}

package/dist/esm/src/generateProto.js

@@ -0,0 +1,80 @@
+function primitiveToProto(type) {
+    switch (type) {
+        case "uint32":
+            return "fixed32";
+        case "bytes":
+            return "bytes";
+        case "string":
+            return "string";
+        case "boolean":
+            return "bool";
+        case "float64":
+            return "double";
+    }
+}
+export function generateProto(schema, nestedEnums) {
+    const enumDefinitions = [];
+    for (const enumSchema of nestedEnums) {
+        const fields = enumSchema.values.map(({ name, value, description }) => {
+            if (description != undefined) {
+                return `// ${description}\n    ${name} = ${value};`;
+            }
+            else {
+                return `${name} = ${value};`;
+            }
+        });
+        enumDefinitions.push(`  // ${enumSchema.description}\n  enum ${enumSchema.protobufEnumName} {\n    ${fields.join("\n\n    ")}\n  }\n`);
+    }
+    let fieldNumber = 1;
+    const imports = new Set();
+    const fields = schema.fields.map((field) => {
+        const lineComments = [];
+        const qualifiers = [];
+        if (field.array != undefined) {
+            qualifiers.push("repeated");
+        }
+        if (typeof field.array === "number") {
+            lineComments.push(`length ${field.array}`);
+        }
+        switch (field.type.type) {
+            case "enum":
+                qualifiers.push(field.type.enum.protobufEnumName);
+                break;
+            case "nested":
+                qualifiers.push(`foxglove.${field.type.schema.name}`);
+                imports.add(`foxglove/${field.type.schema.name}`);
+                break;
+            case "primitive":
+                if (field.type.name === "time") {
+                    qualifiers.push("google.protobuf.Timestamp");
+                    imports.add(`google/protobuf/timestamp`);
+                }
+                else if (field.type.name === "duration") {
+                    qualifiers.push("google.protobuf.Duration");
+                    imports.add(`google/protobuf/duration`);
+                }
+                else {
+                    qualifiers.push(primitiveToProto(field.type.name));
+                }
+                break;
+        }
+        return `${field.description
+            .trim()
+            .split("\n")
+            .map((line) => `  // ${line}\n`)
+            .join("")}  ${qualifiers.join(" ")} ${field.name} = ${fieldNumber++};${lineComments.length > 0 ? " // " + lineComments.join(", ") : ""}`;
+    });
+    const definition = `// ${schema.description}\nmessage ${schema.name} {\n${enumDefinitions.join("\n\n")}${fields.join("\n\n")}\n}`;
+    const outputSections = [
+        `// Generated from ${schema.name} by @foxglove/schemas`,
+        'syntax = "proto3";',
+        Array.from(imports)
+            .sort()
+            .map((name) => `import "${name}.proto";`)
+            .join("\n"),
+        `package foxglove;`,
+        definition,
+    ].filter(Boolean);
+    return outputSections.join("\n\n") + "\n";
+}
+//# sourceMappingURL=generateProto.js.map

package/dist/esm/src/generateProto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateProto.js","sourceRoot":"","sources":["../../../src/generateProto.ts"],"names":[],"mappings":"AAEA,SAAS,gBAAgB,CAAC,IAAqD;IAC7E,QAAQ,IAAI,EAAE;QACZ,KAAK,QAAQ;YACX,OAAO,SAAS,CAAC;QACnB,KAAK,OAAO;YACV,OAAO,OAAO,CAAC;QACjB,KAAK,QAAQ;YACX,OAAO,QAAQ,CAAC;QAClB,KAAK,SAAS;YACZ,OAAO,MAAM,CAAC;QAChB,KAAK,SAAS;YACZ,OAAO,QAAQ,CAAC;KACnB;AACH,CAAC;AAED,MAAM,UAAU,aAAa,CAC3B,MAA6B,EAC7B,WAAiC;IAEjC,MAAM,eAAe,GAAa,EAAE,CAAC;IACrC,KAAK,MAAM,UAAU,IAAI,WAAW,EAAE;QACpC,MAAM,MAAM,GAAG,UAAU,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,WAAW,EAAE,EAAE,EAAE;YACpE,IAAI,WAAW,IAAI,SAAS,EAAE;gBAC5B,OAAO,MAAM,WAAW,SAAS,IAAI,MAAM,KAAK,GAAG,CAAC;aACrD;iBAAM;gBACL,OAAO,GAAG,IAAI,MAAM,KAAK,GAAG,CAAC;aAC9B;QACH,CAAC,CAAC,CAAC;QACH,eAAe,CAAC,IAAI,CAClB,QAAQ,UAAU,CAAC,WAAW,YAAY,UAAU,CAAC,gBAAgB,WAAW,MAAM,CAAC,IAAI,CACzF,UAAU,CACX,SAAS,CACX,CAAC;KACH;IAED,IAAI,WAAW,GAAG,CAAC,CAAC;IACpB,MAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;IAClC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;QACzC,MAAM,YAAY,GAAa,EAAE,CAAC;QAClC,MAAM,UAAU,GAAa,EAAE,CAAC;QAChC,IAAI,KAAK,CAAC,KAAK,IAAI,SAAS,EAAE;YAC5B,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;SAC7B;QACD,IAAI,OAAO,KAAK,CAAC,KAAK,KAAK,QAAQ,EAAE;YACnC,YAAY,CAAC,IAAI,CAAC,UAAU,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC;SAC5C;QACD,QAAQ,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE;YACvB,KAAK,MAAM;gBACT,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;gBAClD,MAAM;YACR,KAAK,QAAQ;gBACX,UAAU,CAAC,IAAI,CAAC,YAAY,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;gBACtD,OAAO,CAAC,GAAG,CAAC,YAAY,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;gBAClD,MAAM;YACR,KAAK,WAAW;gBACd,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,MAAM,EAAE;oBAC9B,UAAU,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;oBAC7C,OAAO,CAAC,GAAG,CAAC,2BAA2B,CAAC,CAAC;iBAC1C;qBAAM,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,KAAK,UAAU,EAAE;oBACzC,UAAU,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;oBAC5C,OAAO,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;iBACzC;qBAAM;oBACL,UAAU,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;iBACpD;gBACD,MAAM;SACT;QACD,OAAO,GAAG,KAAK,CAAC,WAAW;aACxB,IAAI,EAAE;aACN,KAAK,CAAC,IAAI,CAAC;aACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,IAAI,IAAI,CAAC;aAC/B,IAAI,CAAC,EAAE,CAAC,KAAK,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,CAAC,IAAI,MAAM,WAAW,EAAE,IACnE,YAAY,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAC/D,EAAE,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,WAAW,aAAa,MAAM,CAAC,IAAI,OAAO,eAAe,CAAC,IAAI,CAC5F,MAAM,CACP,GAAG,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC;IAE7B,MAAM,cAAc,GAAG;QACrB,qBAAqB,MAAM,CAAC,IAAI,uBAAuB;QACvD,oBAAoB;QAEpB,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC;aAChB,IAAI,EAAE;aACN,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,WAAW,IAAI,UAAU,CAAC;aACxC,IAAI,CAAC,IAAI,CAAC;QAEb,mBAAmB;QAEnB,UAAU;KACX,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAElB,OAAO,cAAc,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;AAC5C,CAAC"}

package/dist/esm/src/generateProto.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=generateProto.test.d.ts.map

package/dist/esm/src/generateProto.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"generateProto.test.d.ts","sourceRoot":"","sources":["../../../src/generateProto.test.ts"],"names":[],"mappings":""}