bson 4.4.0 → 4.5.2

package/src/extended_json.ts

@@ -1,7 +1,7 @@
 import { Binary } from './binary';
 import type { Document } from './bson';
 import { Code } from './code';
-import { DBRef } from './db_ref';
+import { DBRef, isDBRefLike } from './db_ref';
 import { Decimal128 } from './decimal128';
 import { Double } from './double';
 import { Int32 } from './int_32';
@@ -120,7 +120,7 @@ function deserializeValue(value: any, options: EJSON.Options = {}) {
     return Code.fromExtendedJSON(value);
   }
 
-  if (value.$ref != null || value.$dbPointer != null) {
+  if (isDBRefLike(value) || value.$dbPointer) {
     const v = value.$ref ? value : value.$dbPointer;
 
     // we run into this in a "degenerate EJSON" case (with $id and $ref order flipped)
@@ -213,7 +213,7 @@ function serializeValue(value: any, options: EJSONSerializeOptions): any {
       : { $date: { $numberLong: value.getTime().toString() } };
   }
 
-  if (typeof value === 'number' && !options.relaxed) {
+  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,
@@ -310,10 +310,10 @@ function serializeDocument(doc: any, options: EJSONSerializeOptions) {
       outDoc = new Code(outDoc.code, serializeValue(outDoc.scope, options));
     } else if (bsontype === 'DBRef' && outDoc.oid) {
       outDoc = new DBRef(
-        outDoc.collection,
+        serializeValue(outDoc.collection, options),
         serializeValue(outDoc.oid, options),
-        outDoc.db,
-        outDoc.fields
+        serializeValue(outDoc.db, options),
+        serializeValue(outDoc.fields, options)
       );
     }
 

package/src/int_32.ts

@@ -37,7 +37,10 @@ export class Int32 {
     return this.value;
   }
 
-  /** @internal */
+  toString(radix?: number): string {
+    return this.value.toString(radix);
+  }
+
   toJSON(): number {
     return this.value;
   }

package/src/long.ts

@@ -27,13 +27,13 @@ let wasm: LongWASMHelpers | undefined = undefined;
 declare const WebAssembly: any;
 
 try {
-  wasm = (new WebAssembly.Instance(
+  wasm = new WebAssembly.Instance(
     new WebAssembly.Module(
       // prettier-ignore
       new Uint8Array([0, 97, 115, 109, 1, 0, 0, 0, 1, 13, 2, 96, 0, 1, 127, 96, 4, 127, 127, 127, 127, 1, 127, 3, 7, 6, 0, 1, 1, 1, 1, 1, 6, 6, 1, 127, 1, 65, 0, 11, 7, 50, 6, 3, 109, 117, 108, 0, 1, 5, 100, 105, 118, 95, 115, 0, 2, 5, 100, 105, 118, 95, 117, 0, 3, 5, 114, 101, 109, 95, 115, 0, 4, 5, 114, 101, 109, 95, 117, 0, 5, 8, 103, 101, 116, 95, 104, 105, 103, 104, 0, 0, 10, 191, 1, 6, 4, 0, 35, 0, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 126, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 127, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 128, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 129, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11, 36, 1, 1, 126, 32, 0, 173, 32, 1, 173, 66, 32, 134, 132, 32, 2, 173, 32, 3, 173, 66, 32, 134, 132, 130, 34, 4, 66, 32, 135, 167, 36, 0, 32, 4, 167, 11])
     ),
     {}
-  ).exports as unknown) as LongWASMHelpers;
+  ).exports as unknown as LongWASMHelpers;
 } catch {
   // no wasm support
 }

package/src/map.ts

@@ -1,37 +1,17 @@
 /* eslint-disable @typescript-eslint/no-explicit-any */
 // We have an ES6 Map available, return the native instance
 
-/* We do not want to have to include DOM types just for this check */
-declare const window: unknown;
-declare const self: unknown;
-declare const global: unknown;
+import { getGlobal } from './utils/global';
 
 /** @public */
 let bsonMap: MapConstructor;
 
-const check = function (potentialGlobal: any) {
-  // eslint-disable-next-line eqeqeq
-  return potentialGlobal && potentialGlobal.Math == Math && potentialGlobal;
-};
-
-// https://github.com/zloirock/core-js/issues/86#issuecomment-115759028
-function getGlobal() {
-  // eslint-disable-next-line no-undef
-  return (
-    check(typeof globalThis === 'object' && globalThis) ||
-    check(typeof window === 'object' && window) ||
-    check(typeof self === 'object' && self) ||
-    check(typeof global === 'object' && global) ||
-    Function('return this')()
-  );
-}
-
-const bsonGlobal = getGlobal();
-if (Object.prototype.hasOwnProperty.call(bsonGlobal, 'Map')) {
+const bsonGlobal = getGlobal<{ Map?: MapConstructor }>();
+if (bsonGlobal.Map) {
   bsonMap = bsonGlobal.Map;
 } else {
   // We will return a polyfill
-  bsonMap = (class Map {
+  bsonMap = class Map {
     private _keys: string[];
     private _values: Record<string, any>;
     constructor(array: [string, any][] = []) {
@@ -133,7 +113,7 @@ if (Object.prototype.hasOwnProperty.call(bsonGlobal, 'Map')) {
     get size() {
       return this._keys.length;
     }
-  } as unknown) as MapConstructor;
+  } as unknown as MapConstructor;
 }
 
 export { bsonMap as Map };

package/src/objectid.ts

@@ -188,7 +188,6 @@ export class ObjectId {
    * Converts the id into a 24 character hex string for printing
    *
    * @param format - The Buffer toString format parameter.
-   * @internal
    */
   toString(format?: string): string {
     // Is the id a buffer then use the buffer toString method to return the format
@@ -196,10 +195,7 @@ export class ObjectId {
     return this.toHexString();
   }
 
-  /**
-   * Converts to its JSON the 24 character hex string representation.
-   * @internal
-   */
+  /** Converts to its JSON the 24 character hex string representation. */
   toJSON(): string {
     return this.toHexString();
   }

package/src/parser/deserializer.ts

@@ -93,6 +93,8 @@ export function deserialize(
   return deserializeObject(buffer, index, options, isArray);
 }
 
+const allowedDBRefKeys = /^\$ref$|^\$id$|^\$db$/;
+
 function deserializeObject(
   buffer: Buffer,
   index: number,
@@ -134,6 +136,8 @@ function deserializeObject(
   let arrayIndex = 0;
   const done = false;
 
+  let isPossibleDBRef = isArray ? false : null;
+
   // While we have more left data left keep parsing
   while (!done) {
     // Read the type
@@ -152,6 +156,9 @@ function deserializeObject(
     // If are at the end of the buffer there is a problem with the document
     if (i >= buffer.byteLength) throw new Error('Bad BSON Document: illegal CString');
     const name = isArray ? arrayIndex++ : buffer.toString('utf8', index, i);
+    if (isPossibleDBRef !== false && (name as string)[0] === '$') {
+      isPossibleDBRef = allowedDBRefKeys.test(name as string);
+    }
     let value;
 
     index = i + 1;
@@ -169,12 +176,17 @@ function deserializeObject(
       )
         throw new Error('bad string length in bson');
 
-      if (!validateUtf8(buffer, index, index + stringSize - 1)) {
-        throw new Error('Invalid UTF-8 string in BSON document');
-      }
-
       value = buffer.toString('utf8', index, index + stringSize - 1);
 
+      for (let i = 0; i < value.length; i++) {
+        if (value.charCodeAt(i) === 0xfffd) {
+          if (!validateUtf8(buffer, index, index + stringSize - 1)) {
+            throw new Error('Invalid UTF-8 string in BSON document');
+          }
+          break;
+        }
+      }
+
       index = index + stringSize;
     } else if (elementType === constants.BSON_DATA_OID) {
       const oid = Buffer.alloc(12);
@@ -246,9 +258,11 @@ function deserializeObject(
       if (fieldsAsRaw && fieldsAsRaw[name]) {
         arrayOptions = {};
         for (const n in options) {
-          (arrayOptions as {
-            [key: string]: DeserializeOptions[keyof DeserializeOptions];
-          })[n] = options[n as keyof DeserializeOptions];
+          (
+            arrayOptions as {
+              [key: string]: DeserializeOptions[keyof DeserializeOptions];
+            }
+          )[n] = options[n as keyof DeserializeOptions];
         }
         arrayOptions['raw'] = true;
       }
@@ -623,15 +637,8 @@ function deserializeObject(
     throw new Error('corrupt object bson');
   }
 
-  // check if object's $ keys are those of a DBRef
-  const dollarKeys = Object.keys(object).filter(k => k.startsWith('$'));
-  let valid = true;
-  dollarKeys.forEach(k => {
-    if (['$ref', '$id', '$db'].indexOf(k) === -1) valid = false;
-  });
-
-  // if a $key not in "$ref", "$id", "$db", don't make a DBRef
-  if (!valid) return object;
+  // if we did not find "$ref", "$id", "$db", or found an extraneous $key, don't make a DBRef
+  if (!isPossibleDBRef) return object;
 
   if (isDBRefLike(object)) {
     const copy = Object.assign({}, object) as Partial<DBRefLike>;

package/src/parser/serializer.ts

@@ -306,8 +306,10 @@ function serializeObjectId(
   // Write the objectId into the shared buffer
   if (typeof value.id === 'string') {
     buffer.write(value.id, index, undefined, 'binary');
-  } else if (value.id && value.id.copy) {
-    value.id.copy(buffer, index, 0, 12);
+  } else if (isUint8Array(value.id)) {
+    // Use the standard JS methods here because buffer.copy() is buggy with the
+    // browser polyfill
+    buffer.set(value.id.subarray(0, 12), index);
   } else {
     throw new TypeError('object [' + JSON.stringify(value) + '] is not a valid ObjectId');
   }
@@ -406,7 +408,9 @@ function serializeDecimal128(
   index = index + numberOfWrittenBytes;
   buffer[index++] = 0;
   // Write the data from the value
-  value.bytes.copy(buffer, index, 0, 16);
+  // Prefer the standard JS methods because their typechecking is not buggy,
+  // unlike the `buffer` polyfill's.
+  buffer.set(value.bytes.subarray(0, 16), index);
   return index + 16;
 }
 

package/src/parser/utils.ts

@@ -1,4 +1,5 @@
 import { Buffer } from 'buffer';
+import { getGlobal } from '../utils/global';
 
 type RandomBytesFunction = (size: number) => Uint8Array;
 
@@ -10,14 +11,15 @@ export function normalizedFunctionString(fn: Function): string {
   return fn.toString().replace('function(', 'function (');
 }
 
-const isReactNative =
-  typeof global.navigator === 'object' && global.navigator.product === 'ReactNative';
-
-const insecureWarning = isReactNative
-  ? 'BSON: For React Native please polyfill crypto.getRandomValues, e.g. using: https://www.npmjs.com/package/react-native-get-random-values.'
-  : 'BSON: No cryptographic implementation for random bytes present, falling back to a less secure implementation.';
+function isReactNative() {
+  const g = getGlobal<{ navigator?: { product?: string } }>();
+  return typeof g.navigator === 'object' && g.navigator.product === 'ReactNative';
+}
 
 const insecureRandomBytes: RandomBytesFunction = function insecureRandomBytes(size: number) {
+  const insecureWarning = isReactNative()
+    ? 'BSON: For React Native please polyfill crypto.getRandomValues, e.g. using: https://www.npmjs.com/package/react-native-get-random-values.'
+    : 'BSON: No cryptographic implementation for random bytes present, falling back to a less secure implementation.';
   console.warn(insecureWarning);
 
   const result = Buffer.alloc(size);
@@ -109,10 +111,6 @@ export function isObjectLike(candidate: unknown): candidate is Record<string, un
 
 declare let console: { warn(...message: unknown[]): void };
 export function deprecate<T extends Function>(fn: T, message: string): T {
-  if (typeof window === 'undefined' && typeof self === 'undefined') {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    return require('util').deprecate(fn, message);
-  }
   let warned = false;
   function deprecated(this: unknown, ...args: unknown[]) {
     if (!warned) {
@@ -121,5 +119,5 @@ export function deprecate<T extends Function>(fn: T, message: string): T {
     }
     return fn.apply(this, args);
   }
-  return (deprecated as unknown) as T;
+  return deprecated as unknown as T;
 }

package/src/regexp.ts

@@ -35,9 +35,7 @@ export class BSONRegExp {
     if (!(this instanceof BSONRegExp)) return new BSONRegExp(pattern, options);
 
     this.pattern = pattern;
-    this.options = options ?? '';
-    // Execute
-    alphabetize(this.options);
+    this.options = alphabetize(options ?? '');
 
     // Validate options
     for (let i = 0; i < this.options.length; i++) {
@@ -75,7 +73,7 @@ export class BSONRegExp {
       if (typeof doc.$regex !== 'string') {
         // This is for $regex query operators that have extended json values.
         if (doc.$regex._bsontype === 'BSONRegExp') {
-          return (doc as unknown) as BSONRegExp;
+          return doc as unknown as BSONRegExp;
         }
       } else {
         return new BSONRegExp(doc.$regex, BSONRegExp.parseOptions(doc.$options));

package/src/symbol.ts

@@ -25,7 +25,6 @@ export class BSONSymbol {
     return this.value;
   }
 
-  /** @internal */
   toString(): string {
     return this.value;
   }
@@ -35,7 +34,6 @@ export class BSONSymbol {
     return `new BSONSymbol("${this.value}")`;
   }
 
-  /** @internal */
   toJSON(): string {
     return this.value;
   }

package/src/timestamp.ts

@@ -1,13 +1,15 @@
 import { Long } from './long';
+import { isObjectLike } from './parser/utils';
 
 /** @public */
 export type TimestampOverrides = '_bsontype' | 'toExtendedJSON' | 'fromExtendedJSON' | 'inspect';
 /** @public */
-export type LongWithoutOverrides = new (low: number | Long, high?: number, unsigned?: boolean) => {
+export type LongWithoutOverrides = new (low: unknown, high?: number, unsigned?: boolean) => {
   [P in Exclude<keyof Long, TimestampOverrides>]: Long[P];
 };
 /** @public */
-export const LongWithoutOverridesClass: LongWithoutOverrides = (Long as unknown) as LongWithoutOverrides;
+export const LongWithoutOverridesClass: LongWithoutOverrides =
+  Long as unknown as LongWithoutOverrides;
 
 /** @public */
 export interface TimestampExtended {
@@ -26,20 +28,26 @@ export class Timestamp extends LongWithoutOverridesClass {
   /**
    * @param low - A 64-bit Long representing the Timestamp.
    */
-  constructor(low: Long);
+  constructor(long: Long);
+  /**
+   * @param value - A pair of two values indicating timestamp and increment.
+   */
+  constructor(value: { t: number; i: number });
   /**
    * @param low - the low (signed) 32 bits of the Timestamp.
    * @param high - the high (signed) 32 bits of the Timestamp.
+   * @deprecated Please use `Timestamp({ t: high, i: low })` or `Timestamp(Long(low, high))` instead.
    */
-  constructor(low: Long);
   constructor(low: number, high: number);
-  constructor(low: number | Long, high?: number) {
+  constructor(low: number | Long | { t: number; i: number }, high?: number) {
     // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     ///@ts-expect-error
     if (!(this instanceof Timestamp)) return new Timestamp(low, high);
 
     if (Long.isLong(low)) {
       super(low.low, low.high, true);
+    } else if (isObjectLike(low) && typeof low.t !== 'undefined' && typeof low.i !== 'undefined') {
+      super(low.i, low.t, true);
     } else {
       super(low, high, true);
     }
@@ -94,7 +102,7 @@ export class Timestamp extends LongWithoutOverridesClass {
 
   /** @internal */
   static fromExtendedJSON(doc: TimestampExtended): Timestamp {
-    return new Timestamp(doc.$timestamp.i, doc.$timestamp.t);
+    return new Timestamp(doc.$timestamp);
   }
 
   /** @internal */
@@ -103,6 +111,6 @@ export class Timestamp extends LongWithoutOverridesClass {
   }
 
   inspect(): string {
-    return `new Timestamp(${this.getLowBits().toString()}, ${this.getHighBits().toString()})`;
+    return `new Timestamp({ t: ${this.getHighBits()}, i: ${this.getLowBits()} })`;
   }
 }

package/src/utils/global.ts

@@ -0,0 +1,22 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+/* We do not want to have to include DOM types just for this check */
+declare const window: unknown;
+declare const self: unknown;
+declare const global: unknown;
+
+function checkForMath(potentialGlobal: any) {
+  // eslint-disable-next-line eqeqeq
+  return potentialGlobal && potentialGlobal.Math == Math && potentialGlobal;
+}
+
+// https://github.com/zloirock/core-js/issues/86#issuecomment-115759028
+export function getGlobal<T = Record<string, unknown>>(): T {
+  // eslint-disable-next-line no-undef
+  return (
+    checkForMath(typeof globalThis === 'object' && globalThis) ||
+    checkForMath(typeof window === 'object' && window) ||
+    checkForMath(typeof self === 'object' && self) ||
+    checkForMath(typeof global === 'object' && global) ||
+    Function('return this')()
+  );
+}

package/src/uuid.ts

@@ -91,15 +91,14 @@ export class UUID {
 
   /**
    * Converts the id into a 36 character (dashes included) hex string, unless a encoding is specified.
-   * @internal
    */
   toString(encoding?: string): string {
     return encoding ? this.id.toString(encoding) : this.toHexString();
   }
 
   /**
-   * Converts the id into its JSON string representation. A 36 character (dashes included) hex string in the format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
-   * @internal
+   * Converts the id into its JSON string representation.
+   * A 36 character (dashes included) hex string in the format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
    */
   toJSON(): string {
     return this.toHexString();

package/src/uuid_utils.ts

@@ -1,7 +1,8 @@
 import { Buffer } from 'buffer';
 
 // Validation regex for v4 uuid (validates with or without dashes)
-const VALIDATION_REGEX = /^(?:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9a-f]{12}4[0-9a-f]{3}[89ab][0-9a-f]{15})$/i;
+const VALIDATION_REGEX =
+  /^(?:[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|[0-9a-f]{12}4[0-9a-f]{3}[89ab][0-9a-f]{15})$/i;
 
 export const uuidValidateString = (str: string): boolean =>
   typeof str === 'string' && VALIDATION_REGEX.test(str);