bson 4.6.5 → 5.0.0-alpha.0

package/src/extended_json.ts

@@ -1,6 +1,7 @@
 import { Binary } from './binary';
 import type { Document } from './bson';
 import { Code } from './code';
+import { BSON_INT32_MAX, BSON_INT32_MIN, BSON_INT64_MAX, BSON_INT64_MIN } from './constants';
 import { DBRef, isDBRefLike } from './db_ref';
 import { Decimal128 } from './decimal128';
 import { Double } from './double';
@@ -10,13 +11,18 @@ import { Long } from './long';
 import { MaxKey } from './max_key';
 import { MinKey } from './min_key';
 import { ObjectId } from './objectid';
-import { isDate, isObjectLike, isRegExp } from './parser/utils';
+import { isDate, isRegExp } from './parser/utils';
 import { BSONRegExp } from './regexp';
 import { BSONSymbol } from './symbol';
 import { Timestamp } from './timestamp';
 
 /** @public */
-export type EJSONOptions = EJSON.Options;
+export type EJSONOptions = {
+  /** Output using the Extended JSON v1 spec */
+  legacy?: boolean;
+  /** Enable Extended JSON's `relaxed` mode, which attempts to return native JS types where possible, rather than BSON types */
+  relaxed?: boolean;
+};
 
 /** @internal */
 type BSONType =
@@ -34,20 +40,15 @@ type BSONType =
   | BSONSymbol
   | Timestamp;
 
-export function isBSONType(value: unknown): value is BSONType {
+function isBSONType(value: unknown): value is BSONType {
   return (
-    isObjectLike(value) && Reflect.has(value, '_bsontype') && typeof value._bsontype === 'string'
+    value != null &&
+    typeof value === 'object' &&
+    '_bsontype' in value &&
+    typeof value._bsontype === 'string'
   );
 }
 
-// INT32 boundaries
-const BSON_INT32_MAX = 0x7fffffff;
-const BSON_INT32_MIN = -0x80000000;
-// INT64 boundaries
-// const BSON_INT64_MAX = 0x7fffffffffffffff; // TODO(NODE-4377): This number cannot be precisely represented in JS
-const BSON_INT64_MAX = 0x8000000000000000;
-const BSON_INT64_MIN = -0x8000000000000000;
-
 // all the types where we don't need to do any special processing and can just pass the EJSON
 //straight to type.fromExtendedJSON
 const keysToCodecs = {
@@ -67,17 +68,21 @@ const keysToCodecs = {
 } as const;
 
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-function deserializeValue(value: any, options: EJSON.Options = {}) {
+function deserializeValue(value: any, options: EJSONOptions = {}) {
   if (typeof value === 'number') {
     if (options.relaxed || options.legacy) {
       return value;
     }
 
-    // if it's an integer, should interpret as smallest BSON integer
-    // that can represent it exactly. (if out of range, interpret as double.)
-    if (Math.floor(value) === value) {
-      if (value >= BSON_INT32_MIN && value <= BSON_INT32_MAX) return new Int32(value);
-      if (value >= BSON_INT64_MIN && value <= BSON_INT64_MAX) return Long.fromNumber(value);
+    if (Number.isInteger(value) && !Object.is(value, -0)) {
+      // interpret as being of the smallest BSON integer type that can represent the number exactly
+      if (value >= BSON_INT32_MIN && value <= BSON_INT32_MAX) {
+        return new Int32(value);
+      }
+      if (value >= BSON_INT64_MIN && value <= BSON_INT64_MAX) {
+        // TODO(NODE-4377): EJSON js number handling diverges from BSON
+        return Long.fromNumber(value);
+      }
     }
 
     // If the number is a non-integer or out of integer range, should interpret as BSON Double.
@@ -142,7 +147,7 @@ function deserializeValue(value: any, options: EJSON.Options = {}) {
   return value;
 }
 
-type EJSONSerializeOptions = EJSON.Options & {
+type EJSONSerializeOptions = EJSONOptions & {
   seenObjects: { obj: unknown; propertyName: string }[];
 };
 
@@ -216,16 +221,17 @@ function serializeValue(value: any, options: EJSONSerializeOptions): any {
   }
 
   if (typeof value === 'number' && (!options.relaxed || !isFinite(value))) {
-    // it's an integer
-    if (Math.floor(value) === value) {
-      const int32Range = value >= BSON_INT32_MIN && value <= BSON_INT32_MAX,
-        int64Range = value >= BSON_INT64_MIN && value <= BSON_INT64_MAX;
-
+    if (Number.isInteger(value) && !Object.is(value, -0)) {
       // interpret as being of the smallest BSON integer type that can represent the number exactly
-      if (int32Range) return { $numberInt: value.toString() };
-      if (int64Range) return { $numberLong: value.toString() };
+      if (value >= BSON_INT32_MIN && value <= BSON_INT32_MAX) {
+        return { $numberInt: value.toString() };
+      }
+      if (value >= BSON_INT64_MIN && value <= BSON_INT64_MAX) {
+        // TODO(NODE-4377): EJSON js number handling diverges from BSON
+        return { $numberLong: value.toString() };
+      }
     }
-    return { $numberDouble: value.toString() };
+    return { $numberDouble: Object.is(value, -0) ? '-0.0' : value.toString() };
   }
 
   if (value instanceof RegExp || isRegExp(value)) {
@@ -267,10 +273,9 @@ const BSON_TYPE_MAPPINGS = {
     ),
   MaxKey: () => new MaxKey(),
   MinKey: () => new MinKey(),
-  ObjectID: (o: ObjectId) => new ObjectId(o),
-  ObjectId: (o: ObjectId) => new ObjectId(o), // support 4.0.0/4.0.1 before _bsontype was reverted back to ObjectID
+  ObjectId: (o: ObjectId) => new ObjectId(o),
   BSONRegExp: (o: BSONRegExp) => new BSONRegExp(o.pattern, o.options),
-  Symbol: (o: BSONSymbol) => new BSONSymbol(o.value),
+  BSONSymbol: (o: BSONSymbol) => new BSONSymbol(o.value),
   Timestamp: (o: Timestamp) => Timestamp.fromBits(o.low, o.high)
 } as const;
 
@@ -282,7 +287,7 @@ function serializeDocument(doc: any, options: EJSONSerializeOptions) {
   if (typeof bsontype === 'undefined') {
     // It's a regular object. Recursively serialize its property values.
     const _doc: Document = {};
-    for (const name in doc) {
+    for (const name of Object.keys(doc)) {
       options.seenObjects.push({ propertyName: name, obj: null });
       try {
         const value = serializeValue(doc[name], options);
@@ -301,6 +306,13 @@ function serializeDocument(doc: any, options: EJSONSerializeOptions) {
       }
     }
     return _doc;
+  } else if (
+    doc != null &&
+    typeof doc === 'object' &&
+    typeof doc._bsontype === 'string' &&
+    doc[Symbol.for('@@mdb.bson.version')] == null
+  ) {
+    throw new BSONError('Unsupported BSON version, bson types must be from bson 5.0 or later');
   } else if (isBSONType(doc)) {
     // the "document" is really just a BSON type object
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -336,127 +348,115 @@ function serializeDocument(doc: any, options: EJSONSerializeOptions) {
 }
 
 /**
- * EJSON parse / stringify API
- * @public
+ * Parse an Extended JSON string, constructing the JavaScript value or object described by that
+ * string.
+ *
+ * @example
+ * ```js
+ * const { EJSON } = require('bson');
+ * const text = '{ "int32": { "$numberInt": "10" } }';
+ *
+ * // prints { int32: { [String: '10'] _bsontype: 'Int32', value: '10' } }
+ * console.log(EJSON.parse(text, { relaxed: false }));
+ *
+ * // prints { int32: 10 }
+ * console.log(EJSON.parse(text));
+ * ```
  */
-// the namespace here is used to emulate `export * as EJSON from '...'`
-// which as of now (sept 2020) api-extractor does not support
-// eslint-disable-next-line @typescript-eslint/no-namespace
-export namespace EJSON {
-  export interface Options {
-    /** Output using the Extended JSON v1 spec */
-    legacy?: boolean;
-    /** Enable Extended JSON's `relaxed` mode, which attempts to return native JS types where possible, rather than BSON types */
-    relaxed?: boolean;
-    /**
-     * Disable Extended JSON's `relaxed` mode, which attempts to return BSON types where possible, rather than native JS types
-     * @deprecated Please use the relaxed property instead
-     */
-    strict?: boolean;
-  }
-
-  /**
-   * Parse an Extended JSON string, constructing the JavaScript value or object described by that
-   * string.
-   *
-   * @example
-   * ```js
-   * const { EJSON } = require('bson');
-   * const text = '{ "int32": { "$numberInt": "10" } }';
-   *
-   * // prints { int32: { [String: '10'] _bsontype: 'Int32', value: '10' } }
-   * console.log(EJSON.parse(text, { relaxed: false }));
-   *
-   * // prints { int32: 10 }
-   * console.log(EJSON.parse(text));
-   * ```
-   */
-  export function parse(text: string, options?: EJSON.Options): SerializableTypes {
-    const finalOptions = Object.assign({}, { relaxed: true, legacy: false }, options);
-
-    // relaxed implies not strict
-    if (typeof finalOptions.relaxed === 'boolean') finalOptions.strict = !finalOptions.relaxed;
-    if (typeof finalOptions.strict === 'boolean') finalOptions.relaxed = !finalOptions.strict;
-
-    return JSON.parse(text, (key, value) => {
-      if (key.indexOf('\x00') !== -1) {
-        throw new BSONError(
-          `BSON Document field names cannot contain null bytes, found: ${JSON.stringify(key)}`
-        );
-      }
-      return deserializeValue(value, finalOptions);
-    });
-  }
-
-  export type JSONPrimitive = string | number | boolean | null;
-  export type SerializableTypes = Document | Array<JSONPrimitive | Document> | JSONPrimitive;
-
-  /**
-   * Converts a BSON document to an Extended JSON string, optionally replacing values if a replacer
-   * function is specified or optionally including only the specified properties if a replacer array
-   * is specified.
-   *
-   * @param value - The value to convert to extended JSON
-   * @param replacer - A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a whitelist for selecting/filtering the properties of the value object to be included in the JSON string. If this value is null or not provided, all properties of the object are included in the resulting JSON string
-   * @param space - A String or Number object that's used to insert white space into the output JSON string for readability purposes.
-   * @param options - Optional settings
-   *
-   * @example
-   * ```js
-   * const { EJSON } = require('bson');
-   * const Int32 = require('mongodb').Int32;
-   * const doc = { int32: new Int32(10) };
-   *
-   * // prints '{"int32":{"$numberInt":"10"}}'
-   * console.log(EJSON.stringify(doc, { relaxed: false }));
-   *
-   * // prints '{"int32":10}'
-   * console.log(EJSON.stringify(doc));
-   * ```
-   */
-  export function stringify(
-    value: SerializableTypes,
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    replacer?: (number | string)[] | ((this: any, key: string, value: any) => any) | EJSON.Options,
-    space?: string | number,
-    options?: EJSON.Options
-  ): string {
-    if (space != null && typeof space === 'object') {
-      options = space;
-      space = 0;
-    }
-    if (replacer != null && typeof replacer === 'object' && !Array.isArray(replacer)) {
-      options = replacer;
-      replacer = undefined;
-      space = 0;
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function parse(text: string, options?: EJSONOptions): any {
+  return JSON.parse(text, (key, value) => {
+    if (key.indexOf('\x00') !== -1) {
+      throw new BSONError(
+        `BSON Document field names cannot contain null bytes, found: ${JSON.stringify(key)}`
+      );
     }
-    const serializeOptions = Object.assign({ relaxed: true, legacy: false }, options, {
-      seenObjects: [{ propertyName: '(root)', obj: null }]
-    });
+    return deserializeValue(value, { relaxed: true, legacy: false, ...options });
+  });
+}
 
-    const doc = serializeValue(value, serializeOptions);
-    return JSON.stringify(doc, replacer as Parameters<JSON['stringify']>[1], space);
+/**
+ * Converts a BSON document to an Extended JSON string, optionally replacing values if a replacer
+ * function is specified or optionally including only the specified properties if a replacer array
+ * is specified.
+ *
+ * @param value - The value to convert to extended JSON
+ * @param replacer - A function that alters the behavior of the stringification process, or an array of String and Number objects that serve as a whitelist for selecting/filtering the properties of the value object to be included in the JSON string. If this value is null or not provided, all properties of the object are included in the resulting JSON string
+ * @param space - A String or Number object that's used to insert white space into the output JSON string for readability purposes.
+ * @param options - Optional settings
+ *
+ * @example
+ * ```js
+ * const { EJSON } = require('bson');
+ * const Int32 = require('mongodb').Int32;
+ * const doc = { int32: new Int32(10) };
+ *
+ * // prints '{"int32":{"$numberInt":"10"}}'
+ * console.log(EJSON.stringify(doc, { relaxed: false }));
+ *
+ * // prints '{"int32":10}'
+ * console.log(EJSON.stringify(doc));
+ * ```
+ */
+function stringify(
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  value: any,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  replacer?: (number | string)[] | ((this: any, key: string, value: any) => any) | EJSONOptions,
+  space?: string | number,
+  options?: EJSONOptions
+): string {
+  if (space != null && typeof space === 'object') {
+    options = space;
+    space = 0;
   }
-
-  /**
-   * Serializes an object to an Extended JSON string, and reparse it as a JavaScript object.
-   *
-   * @param value - The object to serialize
-   * @param options - Optional settings passed to the `stringify` function
-   */
-  export function serialize(value: SerializableTypes, options?: EJSON.Options): Document {
-    options = options || {};
-    return JSON.parse(stringify(value, options));
+  if (replacer != null && typeof replacer === 'object' && !Array.isArray(replacer)) {
+    options = replacer;
+    replacer = undefined;
+    space = 0;
   }
+  const serializeOptions = Object.assign({ relaxed: true, legacy: false }, options, {
+    seenObjects: [{ propertyName: '(root)', obj: null }]
+  });
 
-  /**
-   * Deserializes an Extended JSON object into a plain JavaScript object with native/BSON types
-   *
-   * @param ejson - The Extended JSON object to deserialize
-   * @param options - Optional settings passed to the parse method
-   */
-  export function deserialize(ejson: Document, options?: EJSON.Options): SerializableTypes {
-    options = options || {};
-    return parse(JSON.stringify(ejson), options);
-  }
+  const doc = serializeValue(value, serializeOptions);
+  return JSON.stringify(doc, replacer as Parameters<JSON['stringify']>[1], space);
 }
+
+/**
+ * Serializes an object to an Extended JSON string, and reparse it as a JavaScript object.
+ *
+ * @param value - The object to serialize
+ * @param options - Optional settings passed to the `stringify` function
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function EJSONserialize(value: any, options?: EJSONOptions): Document {
+  options = options || {};
+  return JSON.parse(stringify(value, options));
+}
+
+/**
+ * Deserializes an Extended JSON object into a plain JavaScript object with native/BSON types
+ *
+ * @param ejson - The Extended JSON object to deserialize
+ * @param options - Optional settings passed to the parse method
+ */
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+function EJSONdeserialize(ejson: Document, options?: EJSONOptions): any {
+  options = options || {};
+  return parse(JSON.stringify(ejson), options);
+}
+
+/** @public */
+const EJSON: {
+  parse: typeof parse;
+  stringify: typeof stringify;
+  serialize: typeof EJSONserialize;
+  deserialize: typeof EJSONdeserialize;
+} = Object.create(null);
+EJSON.parse = parse;
+EJSON.stringify = stringify;
+EJSON.serialize = EJSONserialize;
+EJSON.deserialize = EJSONdeserialize;
+Object.freeze(EJSON);
+export { EJSON };

package/src/index.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');

package/src/int_32.ts

@@ -11,7 +11,13 @@ export interface Int32Extended {
  * @category BSONType
  */
 export class Int32 {
-  _bsontype!: 'Int32';
+  get _bsontype(): 'Int32' {
+    return 'Int32';
+  }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
+  }
 
   value!: number;
   /**
@@ -20,8 +26,6 @@ export class Int32 {
    * @param value - the number we want to represent as an int32.
    */
   constructor(value: number | string) {
-    if (!(this instanceof Int32)) return new Int32(value);
-
     if ((value as unknown) instanceof Number) {
       value = value.valueOf();
     }
@@ -66,5 +70,3 @@ export class Int32 {
     return `new Int32(${this.valueOf()})`;
   }
 }
-
-Object.defineProperty(Int32.prototype, '_bsontype', { value: 'Int32' });

package/src/long.ts

@@ -1,5 +1,4 @@
 import type { EJSONOptions } from './extended_json';
-import { isObjectLike } from './parser/utils';
 import type { Timestamp } from './timestamp';
 
 interface LongWASMHelpers {
@@ -100,10 +99,18 @@ export interface LongExtended {
  * Common constant values ZERO, ONE, NEG_ONE, etc. are found as static properties on this class.
  */
 export class Long {
-  _bsontype!: 'Long';
+  get _bsontype(): 'Long' {
+    return 'Long';
+  }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
+  }
 
   /** An indicator used to reliably determine if an object is a Long or not. */
-  __isLong__!: true;
+  get __isLong__(): boolean {
+    return true;
+  }
 
   /**
    * The high 32 bits as a signed value.
@@ -134,8 +141,6 @@ export class Long {
    * @param unsigned - Whether unsigned or not, defaults to signed
    */
   constructor(low: number | bigint | string = 0, high?: number | boolean, unsigned?: boolean) {
-    if (!(this instanceof Long)) return new Long(low, high, unsigned);
-
     if (typeof low === 'bigint') {
       Object.assign(this, Long.fromBigInt(low, !!high));
     } else if (typeof low === 'string') {
@@ -145,13 +150,6 @@ export class Long {
       this.high = (high as number) | 0;
       this.unsigned = !!unsigned;
     }
-
-    Object.defineProperty(this, '__isLong__', {
-      value: true,
-      configurable: false,
-      writable: false,
-      enumerable: false
-    });
   }
 
   static TWO_PWR_24 = Long.fromInt(TWO_PWR_24_DBL);
@@ -332,7 +330,12 @@ export class Long {
    * Tests if the specified object is a Long.
    */
   static isLong(value: unknown): value is Long {
-    return isObjectLike(value) && value['__isLong__'] === true;
+    return (
+      value != null &&
+      typeof value === 'object' &&
+      '__isLong__' in value &&
+      value.__isLong__ === true
+    );
   }
 
   /**
@@ -1035,6 +1038,3 @@ export class Long {
     return `new Long("${this.toString()}"${this.unsigned ? ', true' : ''})`;
   }
 }
-
-Object.defineProperty(Long.prototype, '__isLong__', { value: true });
-Object.defineProperty(Long.prototype, '_bsontype', { value: 'Long' });

package/src/max_key.ts

@@ -9,10 +9,12 @@ export interface MaxKeyExtended {
  * @category BSONType
  */
 export class MaxKey {
-  _bsontype!: 'MaxKey';
-
-  constructor() {
-    if (!(this instanceof MaxKey)) return new MaxKey();
+  get _bsontype(): 'MaxKey' {
+    return 'MaxKey';
+  }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
   }
 
   /** @internal */
@@ -34,5 +36,3 @@ export class MaxKey {
     return 'new MaxKey()';
   }
 }
-
-Object.defineProperty(MaxKey.prototype, '_bsontype', { value: 'MaxKey' });

package/src/min_key.ts

@@ -9,10 +9,12 @@ export interface MinKeyExtended {
  * @category BSONType
  */
 export class MinKey {
-  _bsontype!: 'MinKey';
-
-  constructor() {
-    if (!(this instanceof MinKey)) return new MinKey();
+  get _bsontype(): 'MinKey' {
+    return 'MinKey';
+  }
+  /** @internal */
+  get [Symbol.for('@@mdb.bson.version')](): 5 {
+    return 5;
   }
 
   /** @internal */
@@ -34,5 +36,3 @@ export class MinKey {
     return 'new MinKey()';
   }
 }
-
-Object.defineProperty(MinKey.prototype, '_bsontype', { value: 'MinKey' });