bson 5.0.0-alpha.2 → 5.0.0-alpha.3

package/lib/bson.cjs

@@ -1,5 +1,59 @@
 'use strict';
 
+const BSON_MAJOR_VERSION = 5;
+const BSON_INT32_MAX = 0x7fffffff;
+const BSON_INT32_MIN = -0x80000000;
+const BSON_INT64_MAX = Math.pow(2, 63) - 1;
+const BSON_INT64_MIN = -Math.pow(2, 63);
+const JS_INT_MAX = Math.pow(2, 53);
+const JS_INT_MIN = -Math.pow(2, 53);
+const BSON_DATA_NUMBER = 1;
+const BSON_DATA_STRING = 2;
+const BSON_DATA_OBJECT = 3;
+const BSON_DATA_ARRAY = 4;
+const BSON_DATA_BINARY = 5;
+const BSON_DATA_UNDEFINED = 6;
+const BSON_DATA_OID = 7;
+const BSON_DATA_BOOLEAN = 8;
+const BSON_DATA_DATE = 9;
+const BSON_DATA_NULL = 10;
+const BSON_DATA_REGEXP = 11;
+const BSON_DATA_DBPOINTER = 12;
+const BSON_DATA_CODE = 13;
+const BSON_DATA_SYMBOL = 14;
+const BSON_DATA_CODE_W_SCOPE = 15;
+const BSON_DATA_INT = 16;
+const BSON_DATA_TIMESTAMP = 17;
+const BSON_DATA_LONG = 18;
+const BSON_DATA_DECIMAL128 = 19;
+const BSON_DATA_MIN_KEY = 0xff;
+const BSON_DATA_MAX_KEY = 0x7f;
+const BSON_BINARY_SUBTYPE_DEFAULT = 0;
+const BSON_BINARY_SUBTYPE_UUID_NEW = 4;
+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
+});
+
 class BSONError extends Error {
     get bsonError() {
         return true;
@@ -20,6 +74,14 @@ class BSONError extends Error {
             'stack' in value);
     }
 }
+class BSONVersionError extends BSONError {
+    get name() {
+        return 'BSONVersionError';
+    }
+    constructor() {
+        super(`Unsupported BSON version, bson types must be from bson ${BSON_MAJOR_VERSION}.0 or later`);
+    }
+}
 
 function nodejsMathRandomBytes(byteLength) {
     return nodeJsByteUtils.fromNumberArray(Array.from({ length: byteLength }, () => Math.floor(Math.random() * 256)));
@@ -250,68 +312,18 @@ function isDate(d) {
     return Object.prototype.toString.call(d) === '[object Date]';
 }
 
-const BSON_MAJOR_VERSION = 5;
-const BSON_INT32_MAX = 0x7fffffff;
-const BSON_INT32_MIN = -0x80000000;
-const BSON_INT64_MAX = Math.pow(2, 63) - 1;
-const BSON_INT64_MIN = -Math.pow(2, 63);
-const JS_INT_MAX = Math.pow(2, 53);
-const JS_INT_MIN = -Math.pow(2, 53);
-const BSON_DATA_NUMBER = 1;
-const BSON_DATA_STRING = 2;
-const BSON_DATA_OBJECT = 3;
-const BSON_DATA_ARRAY = 4;
-const BSON_DATA_BINARY = 5;
-const BSON_DATA_UNDEFINED = 6;
-const BSON_DATA_OID = 7;
-const BSON_DATA_BOOLEAN = 8;
-const BSON_DATA_DATE = 9;
-const BSON_DATA_NULL = 10;
-const BSON_DATA_REGEXP = 11;
-const BSON_DATA_DBPOINTER = 12;
-const BSON_DATA_CODE = 13;
-const BSON_DATA_SYMBOL = 14;
-const BSON_DATA_CODE_W_SCOPE = 15;
-const BSON_DATA_INT = 16;
-const BSON_DATA_TIMESTAMP = 17;
-const BSON_DATA_LONG = 18;
-const BSON_DATA_DECIMAL128 = 19;
-const BSON_DATA_MIN_KEY = 0xff;
-const BSON_DATA_MAX_KEY = 0x7f;
-const BSON_BINARY_SUBTYPE_DEFAULT = 0;
-const BSON_BINARY_SUBTYPE_UUID_NEW = 4;
-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
-});
+class BSONValue {
+    get [Symbol.for('@@mdb.bson.version')]() {
+        return BSON_MAJOR_VERSION;
+    }
+}
 
-class Binary {
+class Binary extends BSONValue {
     get _bsontype() {
         return 'Binary';
     }
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     constructor(buffer, subType) {
+        super();
         if (!(buffer == null) &&
             !(typeof buffer === 'string') &&
             !ArrayBuffer.isView(buffer) &&
@@ -482,9 +494,6 @@ Binary.SUBTYPE_COLUMN = 7;
 Binary.SUBTYPE_USER_DEFINED = 128;
 const UUID_BYTE_LENGTH = 16;
 class UUID extends Binary {
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     constructor(input) {
         let bytes;
         let hexStr;
@@ -589,14 +598,12 @@ class UUID extends Binary {
     }
 }
 
-class Code {
+class Code extends BSONValue {
     get _bsontype() {
         return 'Code';
     }
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     constructor(code, scope) {
+        super();
         this.code = code.toString();
         this.scope = scope ?? null;
     }
@@ -633,14 +640,12 @@ function isDBRefLike(value) {
         typeof value.$ref === 'string' &&
         (!('$db' in value) || ('$db' in value && typeof value.$db === 'string')));
 }
-class DBRef {
+class DBRef extends BSONValue {
     get _bsontype() {
         return 'DBRef';
     }
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     constructor(collection, oid, db, fields) {
+        super();
         const parts = collection.split('.');
         if (parts.length === 2) {
             db = parts.shift();
@@ -709,17 +714,17 @@ const TWO_PWR_64_DBL = TWO_PWR_32_DBL * TWO_PWR_32_DBL;
 const TWO_PWR_63_DBL = TWO_PWR_64_DBL / 2;
 const INT_CACHE = {};
 const UINT_CACHE = {};
-class Long {
+const MAX_INT64_STRING_LENGTH = 20;
+const DECIMAL_REG_EX = /^(\+?0|(\+|-)?[1-9][0-9]*)$/;
+class Long extends BSONValue {
     get _bsontype() {
         return 'Long';
     }
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     get __isLong__() {
         return true;
     }
     constructor(low = 0, high, unsigned) {
+        super();
         if (typeof low === 'bigint') {
             Object.assign(this, Long.fromBigInt(low, !!high));
         }
@@ -1302,8 +1307,22 @@ class Long {
         return { $numberLong: this.toString() };
     }
     static fromExtendedJSON(doc, options) {
-        const result = Long.fromString(doc.$numberLong);
-        return options && options.relaxed ? result.toNumber() : result;
+        const { useBigInt64 = false, relaxed = true } = { ...options };
+        if (doc.$numberLong.length > MAX_INT64_STRING_LENGTH) {
+            throw new BSONError('$numberLong string is too long');
+        }
+        if (!DECIMAL_REG_EX.test(doc.$numberLong)) {
+            throw new BSONError(`$numberLong string "${doc.$numberLong}" is in an invalid format`);
+        }
+        if (useBigInt64) {
+            const bigIntResult = BigInt(doc.$numberLong);
+            return BigInt.asIntN(64, bigIntResult);
+        }
+        const longResult = Long.fromString(doc.$numberLong);
+        if (relaxed) {
+            return longResult.toNumber();
+        }
+        return longResult;
     }
     [Symbol.for('nodejs.util.inspect.custom')]() {
         return this.inspect();
@@ -1397,14 +1416,12 @@ function lessThan(left, right) {
 function invalidErr(string, message) {
     throw new BSONError(`"${string}" is not a valid Decimal128 string - ${message}`);
 }
-class Decimal128 {
+class Decimal128 extends BSONValue {
     get _bsontype() {
         return 'Decimal128';
     }
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     constructor(bytes) {
+        super();
         if (typeof bytes === 'string') {
             this.bytes = Decimal128.fromString(bytes).bytes;
         }
@@ -1826,14 +1843,12 @@ class Decimal128 {
     }
 }
 
-class Double {
+class Double extends BSONValue {
     get _bsontype() {
         return 'Double';
     }
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     constructor(value) {
+        super();
         if (value instanceof Number) {
             value = value.valueOf();
         }
@@ -1872,14 +1887,12 @@ class Double {
     }
 }
 
-class Int32 {
+class Int32 extends BSONValue {
     get _bsontype() {
         return 'Int32';
     }
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     constructor(value) {
+        super();
         if (value instanceof Number) {
             value = value.valueOf();
         }
@@ -1910,13 +1923,10 @@ class Int32 {
     }
 }
 
-class MaxKey {
+class MaxKey extends BSONValue {
     get _bsontype() {
         return 'MaxKey';
     }
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     toExtendedJSON() {
         return { $maxKey: 1 };
     }
@@ -1931,13 +1941,10 @@ class MaxKey {
     }
 }
 
-class MinKey {
+class MinKey extends BSONValue {
     get _bsontype() {
         return 'MinKey';
     }
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     toExtendedJSON() {
         return { $minKey: 1 };
     }
@@ -1955,14 +1962,12 @@ class MinKey {
 const checkForHexRegExp = new RegExp('^[0-9a-fA-F]{24}$');
 let PROCESS_UNIQUE = null;
 const kId = Symbol('id');
-class ObjectId {
+class ObjectId extends BSONValue {
     get _bsontype() {
         return 'ObjectId';
     }
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     constructor(inputId) {
+        super();
         let workingId;
         if (typeof inputId === 'object' && inputId && 'id' in inputId) {
             if (typeof inputId.id !== 'string' && !ArrayBuffer.isView(inputId.id)) {
@@ -2184,14 +2189,12 @@ function calculateElement(name, value, serializeFunctions = false, isArray = fal
             if (value != null &&
                 typeof value._bsontype === 'string' &&
                 value[Symbol.for('@@mdb.bson.version')] !== BSON_MAJOR_VERSION) {
-                throw new BSONError('Unsupported BSON version, bson types must be from bson 5.0 or later');
+                throw new BSONVersionError();
             }
-            else if (value == null ||
-                value['_bsontype'] === 'MinKey' ||
-                value['_bsontype'] === 'MaxKey') {
+            else if (value == null || value._bsontype === 'MinKey' || value._bsontype === 'MaxKey') {
                 return (name != null ? ByteUtils.utf8ByteLength(name) + 1 : 0) + 1;
             }
-            else if (value['_bsontype'] === 'ObjectId') {
+            else if (value._bsontype === 'ObjectId') {
                 return (name != null ? ByteUtils.utf8ByteLength(name) + 1 : 0) + (12 + 1);
             }
             else if (value instanceof Date || isDate(value)) {
@@ -2202,15 +2205,15 @@ function calculateElement(name, value, serializeFunctions = false, isArray = fal
                 isAnyArrayBuffer(value)) {
                 return ((name != null ? ByteUtils.utf8ByteLength(name) + 1 : 0) + (1 + 4 + 1) + value.byteLength);
             }
-            else if (value['_bsontype'] === 'Long' ||
-                value['_bsontype'] === 'Double' ||
-                value['_bsontype'] === 'Timestamp') {
+            else if (value._bsontype === 'Long' ||
+                value._bsontype === 'Double' ||
+                value._bsontype === 'Timestamp') {
                 return (name != null ? ByteUtils.utf8ByteLength(name) + 1 : 0) + (8 + 1);
             }
-            else if (value['_bsontype'] === 'Decimal128') {
+            else if (value._bsontype === 'Decimal128') {
                 return (name != null ? ByteUtils.utf8ByteLength(name) + 1 : 0) + (16 + 1);
             }
-            else if (value['_bsontype'] === 'Code') {
+            else if (value._bsontype === 'Code') {
                 if (value.scope != null && Object.keys(value.scope).length > 0) {
                     return ((name != null ? ByteUtils.utf8ByteLength(name) + 1 : 0) +
                         1 +
@@ -2228,7 +2231,7 @@ function calculateElement(name, value, serializeFunctions = false, isArray = fal
                         1);
                 }
             }
-            else if (value['_bsontype'] === 'Binary') {
+            else if (value._bsontype === 'Binary') {
                 const binary = value;
                 if (binary.sub_type === Binary.SUBTYPE_BYTE_ARRAY) {
                     return ((name != null ? ByteUtils.utf8ByteLength(name) + 1 : 0) +
@@ -2238,14 +2241,14 @@ function calculateElement(name, value, serializeFunctions = false, isArray = fal
                     return ((name != null ? ByteUtils.utf8ByteLength(name) + 1 : 0) + (binary.position + 1 + 4 + 1));
                 }
             }
-            else if (value['_bsontype'] === 'Symbol') {
+            else if (value._bsontype === 'Symbol') {
                 return ((name != null ? ByteUtils.utf8ByteLength(name) + 1 : 0) +
                     ByteUtils.utf8ByteLength(value.value) +
                     4 +
                     1 +
                     1);
             }
-            else if (value['_bsontype'] === 'DBRef') {
+            else if (value._bsontype === 'DBRef') {
                 const ordered_values = Object.assign({
                     $ref: value.collection,
                     $id: value.oid
@@ -2267,7 +2270,7 @@ function calculateElement(name, value, serializeFunctions = false, isArray = fal
                     (value.multiline ? 1 : 0) +
                     1);
             }
-            else if (value['_bsontype'] === 'BSONRegExp') {
+            else if (value._bsontype === 'BSONRegExp') {
                 return ((name != null ? ByteUtils.utf8ByteLength(name) + 1 : 0) +
                     1 +
                     ByteUtils.utf8ByteLength(value.pattern) +
@@ -2295,14 +2298,12 @@ function calculateElement(name, value, serializeFunctions = false, isArray = fal
 function alphabetize(str) {
     return str.split('').sort().join('');
 }
-class BSONRegExp {
+class BSONRegExp extends BSONValue {
     get _bsontype() {
         return 'BSONRegExp';
     }
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     constructor(pattern, options) {
+        super();
         this.pattern = pattern;
         this.options = alphabetize(options ?? '');
         if (this.pattern.indexOf('\x00') !== -1) {
@@ -2356,14 +2357,12 @@ class BSONRegExp {
     }
 }
 
-class BSONSymbol {
+class BSONSymbol extends BSONValue {
     get _bsontype() {
         return 'BSONSymbol';
     }
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     constructor(value) {
+        super();
         this.value = value;
     }
     valueOf() {
@@ -2394,9 +2393,6 @@ class Timestamp extends LongWithoutOverridesClass {
     get _bsontype() {
         return 'Timestamp';
     }
-    get [Symbol.for('@@mdb.bson.version')]() {
-        return BSON_MAJOR_VERSION;
-    }
     constructor(low) {
         if (low == null) {
             super(0, 0, true);
@@ -3413,7 +3409,7 @@ function serializeInto(buffer, object, checkKeys, startingIndex, depth, serializ
             }
             else if (typeof value === 'object' &&
                 value[Symbol.for('@@mdb.bson.version')] !== BSON_MAJOR_VERSION) {
-                throw new BSONError('Unsupported BSON version, bson types must be from bson 5.0 or later');
+                throw new BSONVersionError();
             }
             else if (value._bsontype === 'ObjectId') {
                 index = serializeObjectId(buffer, key, value, index);
@@ -3512,7 +3508,7 @@ function serializeInto(buffer, object, checkKeys, startingIndex, depth, serializ
             }
             else if (typeof value === 'object' &&
                 value[Symbol.for('@@mdb.bson.version')] !== BSON_MAJOR_VERSION) {
-                throw new BSONError('Unsupported BSON version, bson types must be from bson 5.0 or later');
+                throw new BSONVersionError();
             }
             else if (value._bsontype === 'ObjectId') {
                 index = serializeObjectId(buffer, key, value, index);
@@ -3614,7 +3610,7 @@ function serializeInto(buffer, object, checkKeys, startingIndex, depth, serializ
             }
             else if (typeof value === 'object' &&
                 value[Symbol.for('@@mdb.bson.version')] !== BSON_MAJOR_VERSION) {
-                throw new BSONError('Unsupported BSON version, bson types must be from bson 5.0 or later');
+                throw new BSONVersionError();
             }
             else if (value._bsontype === 'ObjectId') {
                 index = serializeObjectId(buffer, key, value, index);
@@ -3690,14 +3686,19 @@ const keysToCodecs = {
 };
 function deserializeValue(value, options = {}) {
     if (typeof value === 'number') {
+        const in32BitRange = value <= BSON_INT32_MAX && value >= BSON_INT32_MIN;
+        const in64BitRange = value <= BSON_INT64_MAX && value >= BSON_INT64_MIN;
         if (options.relaxed || options.legacy) {
             return value;
         }
         if (Number.isInteger(value) && !Object.is(value, -0)) {
-            if (value >= BSON_INT32_MIN && value <= BSON_INT32_MAX) {
+            if (in32BitRange) {
                 return new Int32(value);
             }
-            if (value >= BSON_INT64_MIN && value <= BSON_INT64_MAX) {
+            if (in64BitRange) {
+                if (options.useBigInt64) {
+                    return BigInt(value);
+                }
                 return Long.fromNumber(value);
             }
         }
@@ -3819,6 +3820,12 @@ function serializeValue(value, options) {
         }
         return { $numberDouble: Object.is(value, -0) ? '-0.0' : value.toString() };
     }
+    if (typeof value === 'bigint') {
+        if (!options.relaxed) {
+            return { $numberLong: BigInt.asIntN(64, value).toString() };
+        }
+        return Number(BigInt.asIntN(64, value));
+    }
     if (value instanceof RegExp || isRegExp(value)) {
         let flags = value.flags;
         if (flags === undefined) {
@@ -3881,7 +3888,7 @@ function serializeDocument(doc, options) {
         typeof doc === 'object' &&
         typeof doc._bsontype === 'string' &&
         doc[Symbol.for('@@mdb.bson.version')] !== BSON_MAJOR_VERSION) {
-        throw new BSONError('Unsupported BSON version, bson types must be from bson 5.0 or later');
+        throw new BSONVersionError();
     }
     else if (isBSONType(doc)) {
         let outDoc = doc;
@@ -3905,11 +3912,16 @@ function serializeDocument(doc, options) {
     }
 }
 function parse(text, options) {
+    const ejsonOptions = {
+        useBigInt64: options?.useBigInt64 ?? false,
+        relaxed: options?.relaxed ?? true,
+        legacy: options?.legacy ?? false
+    };
     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, { relaxed: true, legacy: false, ...options });
+        return deserializeValue(value, ejsonOptions);
     });
 }
 function stringify(value, replacer, space, options) {
@@ -4019,7 +4031,9 @@ var bson = /*#__PURE__*/Object.freeze({
     deserialize: deserialize,
     calculateObjectSize: calculateObjectSize,
     deserializeStream: deserializeStream,
+    BSONValue: BSONValue,
     BSONError: BSONError,
+    BSONVersionError: BSONVersionError,
     BSONType: BSONType,
     EJSON: EJSON
 });
@@ -4029,6 +4043,8 @@ exports.BSONError = BSONError;
 exports.BSONRegExp = BSONRegExp;
 exports.BSONSymbol = BSONSymbol;
 exports.BSONType = BSONType;
+exports.BSONValue = BSONValue;
+exports.BSONVersionError = BSONVersionError;
 exports.Binary = Binary;
 exports.Code = Code;
 exports.DBRef = DBRef;