refactor!(NODE-4701): remove default export and add named namespace export

Author: nbbeeken

.gitignore

@@ -22,6 +22,7 @@ lib
 .nyc_output/
 coverage/
 *.d.ts
+!test/register-bson.d.ts
 *.tgz
 docs/public
 

.nycrc.json

@@ -10,6 +10,6 @@
   ],
   "statements": 81,
   "branches": 73,
-  "functions": 74,
+  "functions": 71,
   "lines": 83
 }

api-extractor.json

@@ -1,6 +1,6 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "mainEntryPointFilePath": "<projectFolder>/lib/bson.d.ts",
+  "mainEntryPointFilePath": "<projectFolder>/lib/index.d.ts",
   "apiReport": {
     "enabled": false
   },

bower.json

@@ -165,3 +165,8 @@ new Timestamp({ t: -2, i: 1 });
 new Timestamp({ t: 2, i: 0xFFFF_FFFF + 1 });
 // Will throw, both fields need to be less than or equal to the unsigned int32 max value
 ```
+### The BSON default export has been removed.
+
+* If you import BSON commonjs style `const BSON = require('bson')` then the `BSON.default` property is no longer present.
+* If you import BSON esmodule style `import BSON from 'bson'` then this code will crash upon loading. **TODO: This is not the case right now but it will be after NODE-4713.**
+  * This error will throw: `SyntaxError: The requested module 'bson' does not provide an export named 'default'`.

docs/upgrade-to-v5.md

@@ -59,7 +59,7 @@ export async function getLibs() {
       const hash = stdout.trim();
       return {
         name: 'local',
-        lib: await import('../../lib/bson.js'),
+        lib: await import('../../lib/index.js'),
         version: hash
       };
     })(),

etc/benchmarks/lib_runner.mjs

@@ -80,10 +80,10 @@
   "config": {
     "native": false
   },
-  "main": "lib/bson.js",
+  "main": "lib/index.js",
   "module": "dist/bson.esm.js",
   "browser": {
-    "./lib/bson.js": "./dist/bson.browser.umd.js",
+    "./lib/index.js": "./dist/bson.browser.umd.js",
     "./dist/bson.esm.js": "./dist/bson.browser.esm.js"
   },
   "engines": {

package.json

@@ -32,7 +32,7 @@ const tsConfig = {
   tsconfig: false,
   include: ['src/**/*']
 };
-const input = 'src/bson.ts';
+const input = 'src/index.ts';
 
 const plugins = (options = { browser: false }) => {
   return [

rollup.config.mjs

@@ -247,39 +247,3 @@ export function deserializeStream(
   // Return object containing end index of parsing and list of documents
   return index;
 }
-
-/**
- * BSON default export
- * @deprecated Please use named exports
- * @privateRemarks
- * We want to someday deprecate the default export,
- * so none of the new TS types are being exported on the default
- * @public
- */
-const BSON = {
-  Binary,
-  Code,
-  DBRef,
-  Decimal128,
-  Double,
-  Int32,
-  Long,
-  UUID,
-  Map,
-  MaxKey,
-  MinKey,
-  ObjectId,
-  BSONRegExp,
-  BSONSymbol,
-  Timestamp,
-  EJSON,
-  setInternalBufferSize,
-  serialize,
-  serializeWithBufferAndIndex,
-  deserialize,
-  calculateObjectSize,
-  deserializeStream,
-  BSONError,
-  BSONTypeError
-};
-export default BSON;

src/bson.ts

@@ -0,0 +1,19 @@
+import * as BSON from './bson';
+
+// Export all named properties from BSON to support
+// import { ObjectId, serialize } from 'bson';
+// const { ObjectId, serialize } = require('bson');
+export * from './bson';
+
+// Export BSON as a namespace to support:
+// import { BSON } from 'bson';
+// const { BSON } = require('bson');
+export { BSON };
+
+// BSON does **NOT** have a default export
+
+// The following will crash in es module environments
+// import BSON from 'bson';
+
+// The following will work as expected, BSON as a namespace of all the APIs (BSON.ObjectId, BSON.serialize)
+// const BSON = require('bson');