Adding support for types

src/compile.test.ts

@@ -140,6 +140,10 @@ describe("compileBSON", () => {
           description: "Number",
           bsonType: "number",
         },
+        double: {
+          description: "Double",
+          bsonType: "double",
+        },
         boolean: {
           description: "Boolean",
           bsonType: "bool",
@@ -204,6 +208,65 @@ describe("compileBSON", () => {
       getExpected("bson-types-with-imports-2")
     );
   });
+
+  test(`BSON types ObjectId`, async () => {
+    const schema = {
+      title: "UserDoc",
+      description: "User object",
+      bsonType: "object",
+      additionalProperties: false,
+      required: [],
+      properties: {
+        _id: {
+          bsonType: "objectId",
+        },
+      },
+    };
+
+    expect(await compileBSON(schema)).toBe(getExpected("bson-types-object-id"));
+  });
+
+  test(`BSON types geo-json`, async () => {
+    const schema = {
+      title: "UserDoc",
+      description: "User object",
+      bsonType: "object",
+      additionalProperties: false,
+      required: [],
+      properties: {
+        // https://www.leighhalliday.com/mongodb-geojson-schema-validation
+        location: {
+          bsonType: "object",
+          required: ["type", "coordinates"],
+          properties: {
+            type: {
+              bsonType: "string",
+              enum: ["Point"],
+            },
+            coordinates: {
+              bsonType: ["array"],
+              minItems: 2,
+              maxItems: 2,
+              items: [
+                {
+                  bsonType: "double",
+                  minimum: -180,
+                  maximum: 180,
+                },
+                {
+                  bsonType: "double",
+                  minimum: -90,
+                  maximum: 90,
+                },
+              ],
+            },
+          },
+        },
+      },
+    };
+
+    expect(await compileBSON(schema)).toBe(getExpected("bson-types-geo-json"));
+  });
 });
 
 describe("compileBSON with banner comments", () => {

src/compile.ts

@@ -26,13 +26,13 @@ function format(text: string, options?: prettier.Options): string {
  * https://docs.mongodb.com/manual/reference/operator/query/type/#document-type-available-types
  *
  * [X] number
- * [ ] double
+ * [x] double
  * [X] string
  * [ ] object
  * [ ] array
  * [ ] binData
  * [ ] undefined  -- Deprecated
- * [ ] objectId
+ * [x] objectId
  * [X] bool
  * [X] date
  * [X] null
@@ -55,9 +55,11 @@ const bsonToTs = new Map([
   ["string", "string"],
   ["bool", "boolean"],
   ["date", "Date"],
+  ["double", "number"],
   ["null", "null"],
   ["int", "number"],
   ["decimal", "Decimal128"],
+  ["objectId", "ObjectId"],
 ]);
 
 /**
@@ -111,22 +113,22 @@ function setTsType(schema: JsonValue): JsonValue {
 /**
  * Recursively checks if a schema relies on the Decimal128 BSON type anywhere
  */
-function hasDecimal128(schema: JsonValue): boolean {
+function hasType(schema: JsonValue, typeName: string): boolean {
   if (schema === null || typeof schema !== "object") {
     return false;
   }
 
   if (Array.isArray(schema)) {
-    return schema.some(hasDecimal128);
+    return schema.some((schema) => hasType(schema, typeName));
   }
 
   return Object.entries(schema).some(([key, value]) => {
     if (key === "bsonType") {
-      if (value === "decimal") return true;
-      if (Array.isArray(value)) return value.includes("decimal");
+      if (value === typeName) return true;
+      if (Array.isArray(value)) return value.includes(typeName);
     }
 
-    if (typeof value === "object") return hasDecimal128(value);
+    if (typeof value === "object") return hasType(value, typeName);
 
     return false;
   });
@@ -148,10 +150,15 @@ export async function compileBSON(
   const baseBanner = options?.bannerComment || defaultOptions.bannerComment;
 
   // Import Decimal128 if the type annotations use it
-  const bannerComment = (hasDecimal128(schema)
-    ? [...baseBanner, `import { Decimal128 } from "mongodb";`]
-    : baseBanner
-  ).join("\n");
+  let comments = [...baseBanner];
+  if (hasType(schema, "decimal")) {
+    comments.push('import { Decimal128 } from "mongodb";');
+  }
+  // Import ObjectId if the type annotations use it
+  if (hasType(schema, "objectId")) {
+    comments.push('import { ObjectId } from "mongodb";');
+  }
+  const bannerComment = comments.join("\n");
 
   const compileJSONOptions: Partial<CompileJSONOptions> = {
     bannerComment,

src/expected/bson-types-geo-json.ts

@@ -0,0 +1,20 @@
+/* eslint-disable */
+
+/**
+ * This file was automatically generated by bson-schema-to-typescript.
+ * https://www.npmjs.com/package/bson-schema-to-typescript
+ *
+ * Do not modify it by hand. Instead, modify the MongoDB $jsonSchema validator,
+ * and run bson2ts to regenerate this file.
+ */
+
+/**
+ * User object
+ */
+export interface UserDoc {
+  location?: {
+    type: "Point";
+    coordinates: [number, number];
+    [k: string]: unknown;
+  };
+}

src/expected/bson-types-object-id.ts

@@ -0,0 +1,17 @@
+/* eslint-disable */
+
+/**
+ * This file was automatically generated by bson-schema-to-typescript.
+ * https://www.npmjs.com/package/bson-schema-to-typescript
+ *
+ * Do not modify it by hand. Instead, modify the MongoDB $jsonSchema validator,
+ * and run bson2ts to regenerate this file.
+ */
+import { ObjectId } from "mongodb";
+
+/**
+ * User object
+ */
+export interface UserDoc {
+  _id?: ObjectId;
+}

src/expected/bson-types-with-imports-1.ts

@@ -21,6 +21,10 @@ export interface UserDoc {
    * Number
    */
   number?: number;
+  /**
+   * Double
+   */
+  double?: number;
   /**
    * Boolean
    */