bson 6.10.4 → 7.0.0-alpha

package/README.md

@@ -230,7 +230,17 @@ try {
 
 ## React Native
 
-BSON vendors the required polyfills for `TextEncoder`, `TextDecoder`, `atob`, `btoa` imported from React Native and therefore doesn't expect users to polyfill these. One additional polyfill, `crypto.getRandomValues` is recommended and can be installed with the following command:
+js-bson requires the `atob`, `btoa` and `TextEncoder` globals.  Older versions of React Native did not support these global objects, and so 
+[js-bson v5.4.0](https://github.com/mongodb/js-bson/releases/tag/v5.4.0) added support for bundled polyfills for these globals.  Newer versions
+of Hermes includes these globals, and so the polyfills for are no longer needed in the js-bson package.
+
+If you find yourself on a version of React Native that does not have these globals, either:
+
+1. polyfill them yourself
+2. upgrade to a later version of hermes
+3. use a version of js-bson `>=5.4.0` and `<7.0.0`
+
+One additional polyfill, `crypto.getRandomValues` is recommended and can be installed with the following command:
 
 ```sh
 npm install --save react-native-get-random-values

package/bson.d.ts

@@ -12,7 +12,10 @@ export declare class Binary extends BSONValue {
     static readonly SUBTYPE_DEFAULT = 0;
     /** Function BSON type */
     static readonly SUBTYPE_FUNCTION = 1;
-    /** Byte Array BSON type */
+    /**
+     * Legacy default BSON Binary type
+     * @deprecated BSON Binary subtype 2 is deprecated in the BSON specification
+     */
     static readonly SUBTYPE_BYTE_ARRAY = 2;
     /** Deprecated UUID BSON type @deprecated Please use SUBTYPE_UUID */
     static readonly SUBTYPE_UUID_OLD = 3;
@@ -234,6 +237,8 @@ declare namespace BSON {
         BSONRegExp,
         Decimal128,
         BSONValue,
+        bsonType,
+        BSONTypeTag,
         BSONError,
         BSONVersionError,
         BSONRuntimeError,
@@ -408,10 +413,17 @@ export declare const BSONType: Readonly<{
 /** @public */
 export declare type BSONType = (typeof BSONType)[keyof typeof BSONType];
 
+/** @public */
+export declare const bsonType: unique symbol;
+
+/** @public */
+export declare type BSONTypeTag = 'BSONRegExp' | 'BSONSymbol' | 'ObjectId' | 'Binary' | 'Decimal128' | 'Double' | 'Int32' | 'Long' | 'MaxKey' | 'MinKey' | 'Timestamp' | 'Code' | 'DBRef';
+
 /** @public */
 export declare abstract class BSONValue {
     /** @public */
-    abstract get _bsontype(): string;
+    abstract get _bsontype(): BSONTypeTag;
+    get [bsonType](): this['_bsontype'];
     /* Excluded from this release type: [BSON_VERSION_SYMBOL] */
     /**
      * @public
@@ -1341,17 +1353,13 @@ declare const NumberUtils: NumberUtils;
  * @category BSONType
  */
 export declare class ObjectId extends BSONValue {
+    #private;
     get _bsontype(): 'ObjectId';
     /* Excluded from this release type: index */
     static cacheHexString: boolean;
     /* Excluded from this release type: buffer */
-    /**
-     * Create ObjectId from a number.
-     *
-     * @param inputId - A number.
-     * @deprecated Instead, use `static createFromTime()` to set a numeric value for the new ObjectId.
-     */
-    constructor(inputId: number);
+    /** To generate a new ObjectId, use ObjectId() with no argument. */
+    constructor();
     /**
      * Create ObjectId from a 24 character hex string.
      *
@@ -1376,14 +1384,12 @@ export declare class ObjectId extends BSONValue {
      * @param inputId - A 12 byte binary Buffer.
      */
     constructor(inputId: Uint8Array);
-    /** To generate a new ObjectId, use ObjectId() with no argument. */
-    constructor();
     /**
      * Implementation overload.
      *
      * @param inputId - All input types that are used in the constructor implementation.
      */
-    constructor(inputId?: string | number | ObjectId | ObjectIdLike | Uint8Array);
+    constructor(inputId?: string | ObjectId | ObjectIdLike | Uint8Array);
     /**
      * The ObjectId bytes
      * @readonly
@@ -1436,7 +1442,7 @@ export declare class ObjectId extends BSONValue {
      * Checks if a value can be used to create a valid bson ObjectId
      * @param id - any JS value
      */
-    static isValid(id: string | number | ObjectId | ObjectIdLike | Uint8Array): boolean;
+    static isValid(id: string | ObjectId | ObjectIdLike | Uint8Array): boolean;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
     /* Excluded from this release type: isCached */
@@ -1584,6 +1590,7 @@ declare function stringify(value: any, replacer?: (number | string)[] | ((this:
  */
 export declare class Timestamp extends LongWithoutOverridesClass {
     get _bsontype(): 'Timestamp';
+    get [bsonType](): 'Timestamp';
     static readonly MAX_VALUE: Long;
     /**
      * An incrementing ordinal for operations within a given second.
@@ -1643,7 +1650,7 @@ export declare interface TimestampExtended {
 }
 
 /** @public */
-export declare type TimestampOverrides = '_bsontype' | 'toExtendedJSON' | 'fromExtendedJSON' | 'inspect';
+export declare type TimestampOverrides = '_bsontype' | 'toExtendedJSON' | 'fromExtendedJSON' | 'inspect' | typeof bsonType;
 
 /**
  * A class representation of the BSON UUID type.

package/lib/bson.bundle.js

@@ -143,6 +143,7 @@ class BSONOffsetError extends BSONError {
     get name() {
         return 'BSONOffsetError';
     }
+    offset;
     constructor(message, offset, options) {
         super(`${message}. offset: ${offset}`, options);
         this.offset = offset;
@@ -219,11 +220,15 @@ function tryWriteBasicLatin(destination, source, offset) {
 function nodejsMathRandomBytes(byteLength) {
     return nodeJsByteUtils.fromNumberArray(Array.from({ length: byteLength }, () => Math.floor(Math.random() * 256)));
 }
+function nodejsSecureRandomBytes(byteLength) {
+    return crypto.getRandomValues(nodeJsByteUtils.allocate(byteLength));
+}
 const nodejsRandomBytes = (() => {
-    try {
-        return require('crypto').randomBytes;
+    const { crypto } = globalThis;
+    if (crypto != null && typeof crypto.getRandomValues === 'function') {
+        return nodejsSecureRandomBytes;
     }
-    catch {
+    else {
         return nodejsMathRandomBytes;
     }
 })();
@@ -442,7 +447,11 @@ const webByteUtils = {
 const hasGlobalBuffer = typeof Buffer === 'function' && Buffer.prototype?._isBuffer !== true;
 const ByteUtils = hasGlobalBuffer ? nodeJsByteUtils : webByteUtils;
 
+const bsonType = Symbol.for('@@mdb.bson.type');
 class BSONValue {
+    get [bsonType]() {
+        return this._bsontype;
+    }
     get [BSON_VERSION_SYMBOL]() {
         return BSON_MAJOR_VERSION;
     }
@@ -493,7 +502,7 @@ const NumberUtils = {
             source[offset + 1] * 256 +
             source[offset + 2] * 65536 +
             source[offset + 3] * 16777216);
-        return (hi << BigInt(32)) + lo;
+        return (hi << 32n) + lo;
     },
     getFloat64LE: isBigEndian
         ? (source, offset) => {
@@ -539,7 +548,7 @@ const NumberUtils = {
         return 4;
     },
     setBigInt64LE(destination, offset, value) {
-        const mask32bits = BigInt(0xffff_ffff);
+        const mask32bits = 0xffffffffn;
         let lo = Number(value & mask32bits);
         destination[offset] = lo;
         lo >>= 8;
@@ -548,7 +557,7 @@ const NumberUtils = {
         destination[offset + 2] = lo;
         lo >>= 8;
         destination[offset + 3] = lo;
-        let hi = Number((value >> BigInt(32)) & mask32bits);
+        let hi = Number((value >> 32n) & mask32bits);
         destination[offset + 4] = hi;
         hi >>= 8;
         destination[offset + 5] = hi;
@@ -589,6 +598,27 @@ class Binary extends BSONValue {
     get _bsontype() {
         return 'Binary';
     }
+    static BSON_BINARY_SUBTYPE_DEFAULT = 0;
+    static BUFFER_SIZE = 256;
+    static SUBTYPE_DEFAULT = 0;
+    static SUBTYPE_FUNCTION = 1;
+    static SUBTYPE_BYTE_ARRAY = 2;
+    static SUBTYPE_UUID_OLD = 3;
+    static SUBTYPE_UUID = 4;
+    static SUBTYPE_MD5 = 5;
+    static SUBTYPE_ENCRYPTED = 6;
+    static SUBTYPE_COLUMN = 7;
+    static SUBTYPE_SENSITIVE = 8;
+    static SUBTYPE_VECTOR = 9;
+    static SUBTYPE_USER_DEFINED = 128;
+    static VECTOR_TYPE = Object.freeze({
+        Int8: 0x03,
+        Float32: 0x27,
+        PackedBit: 0x10
+    });
+    buffer;
+    sub_type;
+    position;
     constructor(buffer, subType) {
         super();
         if (!(buffer == null) &&
@@ -848,24 +878,6 @@ class Binary extends BSONValue {
         return new this(bytes, Binary.SUBTYPE_VECTOR);
     }
 }
-Binary.BSON_BINARY_SUBTYPE_DEFAULT = 0;
-Binary.BUFFER_SIZE = 256;
-Binary.SUBTYPE_DEFAULT = 0;
-Binary.SUBTYPE_FUNCTION = 1;
-Binary.SUBTYPE_BYTE_ARRAY = 2;
-Binary.SUBTYPE_UUID_OLD = 3;
-Binary.SUBTYPE_UUID = 4;
-Binary.SUBTYPE_MD5 = 5;
-Binary.SUBTYPE_ENCRYPTED = 6;
-Binary.SUBTYPE_COLUMN = 7;
-Binary.SUBTYPE_SENSITIVE = 8;
-Binary.SUBTYPE_VECTOR = 9;
-Binary.SUBTYPE_USER_DEFINED = 128;
-Binary.VECTOR_TYPE = Object.freeze({
-    Int8: 0x03,
-    Float32: 0x27,
-    PackedBit: 0x10
-});
 function validateBinaryVector(vector) {
     if (vector.sub_type !== Binary.SUBTYPE_VECTOR)
         return;
@@ -1002,6 +1014,8 @@ class Code extends BSONValue {
     get _bsontype() {
         return 'Code';
     }
+    code;
+    scope;
     constructor(code, scope) {
         super();
         this.code = code.toString();
@@ -1047,6 +1061,10 @@ class DBRef extends BSONValue {
     get _bsontype() {
         return 'DBRef';
     }
+    collection;
+    oid;
+    db;
+    fields;
     constructor(collection, oid, db, fields) {
         super();
         const parts = collection.split('.');
@@ -1156,6 +1174,9 @@ class Long extends BSONValue {
     get __isLong__() {
         return true;
     }
+    high;
+    low;
+    unsigned;
     constructor(lowOrValue = 0, highOrUnsigned, unsigned) {
         super();
         const unsignedBool = typeof highOrUnsigned === 'boolean' ? highOrUnsigned : Boolean(unsigned);
@@ -1169,6 +1190,15 @@ class Long extends BSONValue {
         this.high = res.high;
         this.unsigned = res.unsigned;
     }
+    static TWO_PWR_24 = Long.fromInt(TWO_PWR_24_DBL);
+    static MAX_UNSIGNED_VALUE = Long.fromBits(0xffffffff | 0, 0xffffffff | 0, true);
+    static ZERO = Long.fromInt(0);
+    static UZERO = Long.fromInt(0, true);
+    static ONE = Long.fromInt(1);
+    static UONE = Long.fromInt(1, true);
+    static NEG_ONE = Long.fromInt(-1);
+    static MAX_VALUE = Long.fromBits(0xffffffff | 0, 0x7fffffff | 0, false);
+    static MIN_VALUE = Long.fromBits(0, 0x80000000 | 0, false);
     static fromBits(lowBits, highBits, unsigned) {
         return new Long(lowBits, highBits, unsigned);
     }
@@ -1209,7 +1239,7 @@ class Long extends BSONValue {
                 return Long.MAX_UNSIGNED_VALUE;
         }
         else {
-            if (value <= -9223372036854776e3)
+            if (value <= -TWO_PWR_63_DBL)
                 return Long.MIN_VALUE;
             if (value + 1 >= TWO_PWR_63_DBL)
                 return Long.MAX_VALUE;
@@ -1219,8 +1249,8 @@ class Long extends BSONValue {
         return Long.fromBits(value % TWO_PWR_32_DBL | 0, (value / TWO_PWR_32_DBL) | 0, unsigned);
     }
     static fromBigInt(value, unsigned) {
-        const FROM_BIGINT_BIT_MASK = BigInt(0xffffffff);
-        const FROM_BIGINT_BIT_SHIFT = BigInt(32);
+        const FROM_BIGINT_BIT_MASK = 0xffffffffn;
+        const FROM_BIGINT_BIT_SHIFT = 32n;
         return new Long(Number(value & FROM_BIGINT_BIT_MASK), Number((value >> FROM_BIGINT_BIT_SHIFT) & FROM_BIGINT_BIT_MASK), unsigned);
     }
     static _fromString(str, unsigned, radix) {
@@ -1253,7 +1283,7 @@ class Long extends BSONValue {
     static fromStringStrict(str, unsignedOrRadix, radix) {
         let unsigned = false;
         if (typeof unsignedOrRadix === 'number') {
-            (radix = unsignedOrRadix), (unsignedOrRadix = false);
+            ((radix = unsignedOrRadix), (unsignedOrRadix = false));
         }
         else {
             unsigned = !!unsignedOrRadix;
@@ -1275,7 +1305,7 @@ class Long extends BSONValue {
     static fromString(str, unsignedOrRadix, radix) {
         let unsigned = false;
         if (typeof unsignedOrRadix === 'number') {
-            (radix = unsignedOrRadix), (unsignedOrRadix = false);
+            ((radix = unsignedOrRadix), (unsignedOrRadix = false));
         }
         else {
             unsigned = !!unsignedOrRadix;
@@ -1795,15 +1825,6 @@ class Long extends BSONValue {
         return `new Long(${longVal}${unsignedVal})`;
     }
 }
-Long.TWO_PWR_24 = Long.fromInt(TWO_PWR_24_DBL);
-Long.MAX_UNSIGNED_VALUE = Long.fromBits(0xffffffff | 0, 0xffffffff | 0, true);
-Long.ZERO = Long.fromInt(0);
-Long.UZERO = Long.fromInt(0, true);
-Long.ONE = Long.fromInt(1);
-Long.UONE = Long.fromInt(1, true);
-Long.NEG_ONE = Long.fromInt(-1);
-Long.MAX_VALUE = Long.fromBits(0xffffffff | 0, 0x7fffffff | 0, false);
-Long.MIN_VALUE = Long.fromBits(0, 0x80000000 | 0, false);
 
 const PARSE_STRING_REGEXP = /^(\+|-)?(\d+|(\d*\.\d*))?(E|e)?([-+])?(\d+)?$/;
 const PARSE_INF_REGEXP = /^(\+|-)?(Infinity|inf)$/i;
@@ -1884,6 +1905,7 @@ class Decimal128 extends BSONValue {
     get _bsontype() {
         return 'Decimal128';
     }
+    bytes;
     constructor(bytes) {
         super();
         if (typeof bytes === 'string') {
@@ -2359,6 +2381,7 @@ class Double extends BSONValue {
     get _bsontype() {
         return 'Double';
     }
+    value;
     constructor(value) {
         super();
         if (value instanceof Number) {
@@ -2422,6 +2445,7 @@ class Int32 extends BSONValue {
     get _bsontype() {
         return 'Int32';
     }
+    value;
     constructor(value) {
         super();
         if (value instanceof Number) {
@@ -2500,11 +2524,14 @@ class MinKey extends BSONValue {
 }
 
 let PROCESS_UNIQUE = null;
-const __idCache = new WeakMap();
 class ObjectId extends BSONValue {
     get _bsontype() {
         return 'ObjectId';
     }
+    static index = Math.floor(Math.random() * 0xffffff);
+    static cacheHexString = false;
+    buffer;
+    #cachedHexString = null;
     constructor(inputId) {
         super();
         let workingId;
@@ -2522,8 +2549,8 @@ class ObjectId extends BSONValue {
         else {
             workingId = inputId;
         }
-        if (workingId == null || typeof workingId === 'number') {
-            this.buffer = ObjectId.generate(typeof workingId === 'number' ? workingId : undefined);
+        if (workingId == null) {
+            this.buffer = ObjectId.generate();
         }
         else if (ArrayBuffer.isView(workingId) && workingId.byteLength === 12) {
             this.buffer = ByteUtils.toLocalBufferType(workingId);
@@ -2532,7 +2559,7 @@ class ObjectId extends BSONValue {
             if (ObjectId.validateHexString(workingId)) {
                 this.buffer = ByteUtils.fromHex(workingId);
                 if (ObjectId.cacheHexString) {
-                    __idCache.set(this, workingId);
+                    this.#cachedHexString = workingId;
                 }
             }
             else {
@@ -2549,7 +2576,7 @@ class ObjectId extends BSONValue {
     set id(value) {
         this.buffer = value;
         if (ObjectId.cacheHexString) {
-            __idCache.set(this, ByteUtils.toHex(value));
+            this.#cachedHexString = ByteUtils.toHex(value);
         }
     }
     static validateHexString(string) {
@@ -2567,14 +2594,11 @@ class ObjectId extends BSONValue {
         return true;
     }
     toHexString() {
-        if (ObjectId.cacheHexString) {
-            const __id = __idCache.get(this);
-            if (__id)
-                return __id;
-        }
+        if (this.#cachedHexString)
+            return this.#cachedHexString.toLowerCase();
         const hexString = ByteUtils.toHex(this.id);
         if (ObjectId.cacheHexString) {
-            __idCache.set(this, hexString);
+            this.#cachedHexString = hexString;
         }
         return hexString;
     }
@@ -2699,14 +2723,13 @@ class ObjectId extends BSONValue {
         return new ObjectId(doc.$oid);
     }
     isCached() {
-        return ObjectId.cacheHexString && __idCache.has(this);
+        return ObjectId.cacheHexString && this.#cachedHexString != null;
     }
     inspect(depth, options, inspect) {
         inspect ??= defaultInspect;
         return `new ObjectId(${inspect(this.toHexString(), options)})`;
     }
 }
-ObjectId.index = Math.floor(Math.random() * 0xffffff);
 
 function internalCalculateObjectSize(object, serializeFunctions, ignoreUndefined) {
     let totalLength = 4 + 1;
@@ -2875,6 +2898,8 @@ class BSONRegExp extends BSONValue {
     get _bsontype() {
         return 'BSONRegExp';
     }
+    pattern;
+    options;
     constructor(pattern, options) {
         super();
         this.pattern = pattern;
@@ -2935,6 +2960,7 @@ class BSONSymbol extends BSONValue {
     get _bsontype() {
         return 'BSONSymbol';
     }
+    value;
     constructor(value) {
         super();
         this.value = value;
@@ -2965,6 +2991,10 @@ class Timestamp extends LongWithoutOverridesClass {
     get _bsontype() {
         return 'Timestamp';
     }
+    get [bsonType]() {
+        return 'Timestamp';
+    }
+    static MAX_VALUE = Long.MAX_UNSIGNED_VALUE;
     get i() {
         return this.low >>> 0;
     }
@@ -3044,7 +3074,6 @@ class Timestamp extends LongWithoutOverridesClass {
         return `new Timestamp({ t: ${t}, i: ${i} })`;
     }
 }
-Timestamp.MAX_VALUE = Long.MAX_UNSIGNED_VALUE;
 
 const JS_INT_MAX_LONG = Long.fromNumber(JS_INT_MAX);
 const JS_INT_MIN_LONG = Long.fromNumber(JS_INT_MIN);
@@ -4596,6 +4625,7 @@ MinKey: MinKey,
 ObjectId: ObjectId,
 Timestamp: Timestamp,
 UUID: UUID,
+bsonType: bsonType,
 calculateObjectSize: calculateObjectSize,
 deserialize: deserialize,
 deserializeStream: deserializeStream,
@@ -4627,6 +4657,7 @@ exports.MinKey = MinKey;
 exports.ObjectId = ObjectId;
 exports.Timestamp = Timestamp;
 exports.UUID = UUID;
+exports.bsonType = bsonType;
 exports.calculateObjectSize = calculateObjectSize;
 exports.deserialize = deserialize;
 exports.deserializeStream = deserializeStream;