fixups

Author: nbbeeken

docs/upgrade-to-v5.md

@@ -79,8 +79,11 @@ We have set our typescript compilation target to `es2020` which aligns with our
 > **TL;DR**: TODO
 
 TODO(NODE-4771): serializeFunctions bug fix makes function names outside the ascii range get serialized correctly
-> This will preserve newer ECMAScript 2020 features like optional chaining, nullish coalescing, export * as ns, and dynamic import(...) syntax. It also means bigint literals now have a stable target below esnext.
 
 ### Remove `Map` export
 
 This library no longer polyfills [ES Map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Map) and the export "Map" was removed. Users should migrate to using the global Map constructor available in all supported JS environments.
+
+### Remove default export and internal constants
+
+The BSON default export has been removed, it was out of sync with the commonjs and aggregate (`* as`) imports and we now have a way of keeping it consistent. There is now a `BSON` namespace export. We removed the internal constants, but provided the BSONType enum from the driver as a migration for these constants. ... etc TODO...

src/bson.ts

@@ -54,6 +54,8 @@ export {
 };
 export { BSONError, BSONTypeError } from './error';
 
+export { BSONType } from './constants';
+
 /** @public */
 export interface Document {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any

src/constants.ts

@@ -108,3 +108,31 @@ export const BSON_BINARY_SUBTYPE_COLUMN = 7;
 
 /** Binary User Defined Type @internal */
 export const BSON_BINARY_SUBTYPE_USER_DEFINED = 128;
+
+/** @public */
+export const BSONType = Object.freeze({
+  double: 1,
+  string: 2,
+  object: 3,
+  array: 4,
+  binData: 5,
+  undefined: 6,
+  objectId: 7,
+  bool: 8,
+  date: 9,
+  null: 10,
+  regex: 11,
+  dbPointer: 12,
+  javascript: 13,
+  symbol: 14,
+  javascriptWithScope: 15,
+  int: 16,
+  timestamp: 17,
+  long: 18,
+  decimal: 19,
+  minKey: -1,
+  maxKey: 127
+} as const);
+
+/** @public */
+export type BSONType = typeof BSONType[keyof typeof BSONType];

test/node/check_constants.js renamed to test/node/constants.test.ts

@@ -1,7 +1,5 @@
-'use strict';
-
-const constants = require('../../src/constants');
-const BSON = require('../register-bson');
+import * as constants from '../../src/constants';
+import * as BSON from '../register-bson';
 
 describe('BSON Constants', () => {
   context('Binary Subtype', () => {
@@ -140,4 +138,42 @@ describe('BSON Constants', () => {
       expect(constants.BSON_DATA_MAX_KEY).to.equal(0x7f);
     });
   });
+
+  describe('BSONType enum', () => {
+    it('double equals 1', () => expect(constants.BSONType.double).to.equal(1));
+    it('string equals 2', () => expect(constants.BSONType.string).to.equal(2));
+    it('object equals 3', () => expect(constants.BSONType.object).to.equal(3));
+    it('array equals 4', () => expect(constants.BSONType.array).to.equal(4));
+    it('binData equals 5', () => expect(constants.BSONType.binData).to.equal(5));
+    it('undefined equals 6', () => expect(constants.BSONType.undefined).to.equal(6));
+    it('objectId equals 7', () => expect(constants.BSONType.objectId).to.equal(7));
+    it('bool equals 8', () => expect(constants.BSONType.bool).to.equal(8));
+    it('date equals 9', () => expect(constants.BSONType.date).to.equal(9));
+    it('null equals 10', () => expect(constants.BSONType.null).to.equal(10));
+    it('regex equals 11', () => expect(constants.BSONType.regex).to.equal(11));
+    it('dbPointer equals 12', () => expect(constants.BSONType.dbPointer).to.equal(12));
+    it('javascript equals 13', () => expect(constants.BSONType.javascript).to.equal(13));
+    it('symbol equals 14', () => expect(constants.BSONType.symbol).to.equal(14));
+    it('javascriptWithScope equals 15', () =>
+      expect(constants.BSONType.javascriptWithScope).to.equal(15));
+    it('int equals 16', () => expect(constants.BSONType.int).to.equal(16));
+    it('timestamp equals 17', () => expect(constants.BSONType.timestamp).to.equal(17));
+    it('long equals 18', () => expect(constants.BSONType.long).to.equal(18));
+    it('decimal equals 19', () => expect(constants.BSONType.decimal).to.equal(19));
+    it('minKey equals -1', () => expect(constants.BSONType.minKey).to.equal(-1));
+    it('maxKey equals  27', () => expect(constants.BSONType.maxKey).to.equal(127));
+
+    it('minKey equals 255 when used in Uint8Array', () => {
+      const byte = new Uint8Array(1);
+      byte[0] = constants.BSONType.minKey;
+      expect(byte[0]).to.equal(255);
+    });
+
+    it('minKey equals 255 when used in DataView in unsigned way', () => {
+      const dv = new DataView(new ArrayBuffer(1));
+      dv.setUint8(0, constants.BSONType.minKey);
+      expect(dv.getUint8(0)).to.equal(255);
+      expect(new Uint8Array(dv.buffer, 0, 1)[0]).to.equal(255);
+    });
+  });
 });

test/node/exports.test.ts

@@ -22,6 +22,7 @@ const EXPECTED_EXPORTS = [
   'Decimal128',
   'ObjectID',
   'BSONError',
+  'BSONType',
   'BSONTypeError',
   'setInternalBufferSize',
   'serialize',