feat(NODE-4877): Add support for useBigInt64

Author: W-A-James

src/bson.ts

@@ -66,6 +66,7 @@ export interface BSONSerializeOptions
 export function pluckBSONSerializeOptions(options: BSONSerializeOptions): BSONSerializeOptions {
   const {
     fieldsAsRaw,
+    useBigInt64,
     promoteValues,
     promoteBuffers,
     promoteLongs,
@@ -77,6 +78,7 @@ export function pluckBSONSerializeOptions(options: BSONSerializeOptions): BSONSe
   } = options;
   return {
     fieldsAsRaw,
+    useBigInt64,
     promoteValues,
     promoteBuffers,
     promoteLongs,
@@ -101,6 +103,7 @@ export function resolveBSONOptions(
   const parentOptions = parent?.bsonOptions;
   return {
     raw: options?.raw ?? parentOptions?.raw ?? false,
+    useBigInt64: options?.useBigInt64 ?? parentOptions?.useBigInt64 ?? false,
     promoteLongs: options?.promoteLongs ?? parentOptions?.promoteLongs ?? true,
     promoteValues: options?.promoteValues ?? parentOptions?.promoteValues ?? true,
     promoteBuffers: options?.promoteBuffers ?? parentOptions?.promoteBuffers ?? false,

src/operations/create_collection.ts

@@ -23,6 +23,7 @@ const ILLEGAL_COMMAND_FIELDS = new Set([
   'writeConcern',
   'raw',
   'fieldsAsRaw',
+  'useBigInt64',
   'promoteLongs',
   'promoteValues',
   'promoteBuffers',

test/types/bson.test-d.ts

@@ -7,6 +7,7 @@ const options: BSONSerializeOptions = {};
 expectType<boolean | undefined>(options.checkKeys);
 expectType<boolean | undefined>(options.serializeFunctions);
 expectType<boolean | undefined>(options.ignoreUndefined);
+expectType<boolean | undefined>(options.useBigInt64);
 expectType<boolean | undefined>(options.promoteLongs);
 expectType<boolean | undefined>(options.promoteBuffers);
 expectType<boolean | undefined>(options.promoteValues);
@@ -17,6 +18,7 @@ type PermittedBSONOptionKeys =
   | 'checkKeys'
   | 'serializeFunctions'
   | 'ignoreUndefined'
+  | 'useBigInt64'
   | 'promoteLongs'
   | 'promoteBuffers'
   | 'promoteValues'

test/unit/bson.test.ts

@@ -39,4 +39,12 @@ describe('When importing BSON', function () {
   }
 
   testTypes();
+
+  it('does not throw when passed bigints', function () {
+    expect(() => {
+      const doc = { a: 100n };
+      const ser = BSON.serialize(doc);
+      return BSON.deserialize(ser);
+    }).to.not.throw;
+  });
 });