bson 5.3.0 → 5.5.0

package/README.md

@@ -188,23 +188,16 @@ try {
 
 ## React Native
 
-BSON requires that `TextEncoder`, `TextDecoder`, `atob`, `btoa`, and `crypto.getRandomValues` are available globally.  These are present in most Javascript runtimes but require polyfilling in React Native.  Polyfills for the missing functionality can be installed with the following command:
+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:
+
 ```sh
-npm install --save react-native-get-random-values text-encoding-polyfill base-64
+npm install --save react-native-get-random-values
 ```
 
 The following snippet should be placed at the top of the entrypoint (by default this is the root `index.js` file) for React Native projects using the BSON library.  These lines must be placed for any code that imports `BSON`.
 
 ```typescript
 // Required Polyfills For ReactNative
-import {encode, decode} from 'base-64';
-if (global.btoa == null) {
-  global.btoa = encode;
-}
-if (global.atob == null) {
-  global.atob = decode;
-}
-import 'text-encoding-polyfill';
 import 'react-native-get-random-values';
 ```
 
@@ -214,7 +207,7 @@ Finally, import the `BSON` library like so:
 import { BSON, EJSON } from 'bson';
 ```
 
-This will cause React Native to import the `node_modules/bson/lib/bson.cjs` bundle (see the `"react-native"` setting we have in the `"exports"` section of our [package.json](./package.json).)
+This will cause React Native to import the `node_modules/bson/lib/bson.rn.cjs` bundle (see the `"react-native"` setting we have in the `"exports"` section of our [package.json](./package.json).)
 
 ### Technical Note about React Native module import
 

package/bson.d.ts

@@ -392,6 +392,26 @@ export declare class Decimal128 extends BSONValue {
      * @param representation - a numeric string representation.
      */
     static fromString(representation: string): Decimal128;
+    /**
+     * Create a Decimal128 instance from a string representation, allowing for rounding to 34
+     * significant digits
+     *
+     * @example Example of a number that will be rounded
+     * ```ts
+     * > let d = Decimal128.fromString('37.499999999999999196428571428571375')
+     * Uncaught:
+     * BSONError: "37.499999999999999196428571428571375" is not a valid Decimal128 string - inexact rounding
+     * at invalidErr (/home/wajames/js-bson/lib/bson.cjs:1402:11)
+     * at Decimal128.fromStringInternal (/home/wajames/js-bson/lib/bson.cjs:1633:25)
+     * at Decimal128.fromString (/home/wajames/js-bson/lib/bson.cjs:1424:27)
+     *
+     * > d = Decimal128.fromStringWithRounding('37.499999999999999196428571428571375')
+     * new Decimal128("37.49999999999999919642857142857138")
+     * ```
+     * @param representation - a numeric string representation.
+     */
+    static fromStringWithRounding(representation: string): Decimal128;
+    private static _fromString;
     /** Create a string representation of the raw Decimal128 value */
     toString(): string;
     toJSON(): Decimal128Extended;

package/lib/bson.bundle.js

@@ -166,8 +166,8 @@ const nodeJsByteUtils = {
     fromUTF8(text) {
         return Buffer.from(text, 'utf8');
     },
-    toUTF8(buffer) {
-        return nodeJsByteUtils.toLocalBufferType(buffer).toString('utf8');
+    toUTF8(buffer, start, end) {
+        return nodeJsByteUtils.toLocalBufferType(buffer).toString('utf8', start, end);
     },
     utf8ByteLength(input) {
         return Buffer.byteLength(input, 'utf8');
@@ -277,8 +277,8 @@ const webByteUtils = {
     fromUTF8(text) {
         return new TextEncoder().encode(text);
     },
-    toUTF8(uint8array) {
-        return new TextDecoder('utf8', { fatal: false }).decode(uint8array);
+    toUTF8(uint8array, start, end) {
+        return new TextDecoder('utf8', { fatal: false }).decode(uint8array.slice(start, end));
     },
     utf8ByteLength(input) {
         return webByteUtils.fromUTF8(input).byteLength;
@@ -410,8 +410,8 @@ class Binary extends BSONValue {
         if (encoding === 'base64')
             return ByteUtils.toBase64(this.buffer);
         if (encoding === 'utf8' || encoding === 'utf-8')
-            return ByteUtils.toUTF8(this.buffer);
-        return ByteUtils.toUTF8(this.buffer);
+            return ByteUtils.toUTF8(this.buffer, 0, this.buffer.byteLength);
+        return ByteUtils.toUTF8(this.buffer, 0, this.buffer.byteLength);
     }
     toExtendedJSON(options) {
         options = options || {};
@@ -1437,7 +1437,14 @@ class Decimal128 extends BSONValue {
         }
     }
     static fromString(representation) {
+        return Decimal128._fromString(representation, { allowRounding: false });
+    }
+    static fromStringWithRounding(representation) {
+        return Decimal128._fromString(representation, { allowRounding: true });
+    }
+    static _fromString(representation, options) {
         let isNegative = false;
+        let sawSign = false;
         let sawRadix = false;
         let foundNonZero = false;
         let significantDigits = 0;
@@ -1448,10 +1455,8 @@ class Decimal128 extends BSONValue {
         const digits = [0];
         let nDigitsStored = 0;
         let digitsInsert = 0;
-        let firstDigit = 0;
         let lastDigit = 0;
         let exponent = 0;
-        let i = 0;
         let significandHigh = new Long(0, 0);
         let significandLow = new Long(0, 0);
         let biasedExponent = 0;
@@ -1479,6 +1484,7 @@ class Decimal128 extends BSONValue {
             }
         }
         if (representation[index] === '+' || representation[index] === '-') {
+            sawSign = true;
             isNegative = representation[index++] === '-';
         }
         if (!isDigit(representation[index]) && representation[index] !== '.') {
@@ -1497,7 +1503,7 @@ class Decimal128 extends BSONValue {
                 index = index + 1;
                 continue;
             }
-            if (nDigitsStored < 34) {
+            if (nDigitsStored < MAX_DIGITS) {
                 if (representation[index] !== '0' || foundNonZero) {
                     if (!foundNonZero) {
                         firstNonZero = nDigitsRead;
@@ -1525,10 +1531,7 @@ class Decimal128 extends BSONValue {
         }
         if (representation[index])
             return new Decimal128(NAN_BUFFER);
-        firstDigit = 0;
         if (!nDigitsStored) {
-            firstDigit = 0;
-            lastDigit = 0;
             digits[0] = 0;
             nDigits = 1;
             nDigitsStored = 1;
@@ -1538,12 +1541,12 @@ class Decimal128 extends BSONValue {
             lastDigit = nDigitsStored - 1;
             significantDigits = nDigits;
             if (significantDigits !== 1) {
-                while (digits[firstNonZero + significantDigits - 1] === 0) {
+                while (representation[firstNonZero + significantDigits - 1 + Number(sawSign) + Number(sawRadix)] === '0') {
                     significantDigits = significantDigits - 1;
                 }
             }
         }
-        if (exponent <= radixPosition && radixPosition - exponent > 1 << 14) {
+        if (exponent <= radixPosition && radixPosition > exponent + (1 << 14)) {
             exponent = EXPONENT_MIN;
         }
         else {
@@ -1551,9 +1554,8 @@ class Decimal128 extends BSONValue {
         }
         while (exponent > EXPONENT_MAX) {
             lastDigit = lastDigit + 1;
-            if (lastDigit - firstDigit > MAX_DIGITS) {
-                const digitsString = digits.join('');
-                if (digitsString.match(/^0+$/)) {
+            if (lastDigit >= MAX_DIGITS) {
+                if (significantDigits === 0) {
                     exponent = EXPONENT_MAX;
                     break;
                 }
@@ -1561,69 +1563,116 @@ class Decimal128 extends BSONValue {
             }
             exponent = exponent - 1;
         }
-        while (exponent < EXPONENT_MIN || nDigitsStored < nDigits) {
-            if (lastDigit === 0 && significantDigits < nDigitsStored) {
-                exponent = EXPONENT_MIN;
-                significantDigits = 0;
-                break;
-            }
-            if (nDigitsStored < nDigits) {
-                nDigits = nDigits - 1;
-            }
-            else {
-                lastDigit = lastDigit - 1;
-            }
-            if (exponent < EXPONENT_MAX) {
-                exponent = exponent + 1;
-            }
-            else {
-                const digitsString = digits.join('');
-                if (digitsString.match(/^0+$/)) {
-                    exponent = EXPONENT_MAX;
+        if (options.allowRounding) {
+            while (exponent < EXPONENT_MIN || nDigitsStored < nDigits) {
+                if (lastDigit === 0 && significantDigits < nDigitsStored) {
+                    exponent = EXPONENT_MIN;
+                    significantDigits = 0;
                     break;
                 }
-                invalidErr(representation, 'overflow');
-            }
-        }
-        if (lastDigit - firstDigit + 1 < significantDigits) {
-            let endOfString = nDigitsRead;
-            if (sawRadix) {
-                firstNonZero = firstNonZero + 1;
-                endOfString = endOfString + 1;
-            }
-            if (isNegative) {
-                firstNonZero = firstNonZero + 1;
-                endOfString = endOfString + 1;
-            }
-            const roundDigit = parseInt(representation[firstNonZero + lastDigit + 1], 10);
-            let roundBit = 0;
-            if (roundDigit >= 5) {
-                roundBit = 1;
-                if (roundDigit === 5) {
-                    roundBit = digits[lastDigit] % 2 === 1 ? 1 : 0;
-                    for (i = firstNonZero + lastDigit + 2; i < endOfString; i++) {
-                        if (parseInt(representation[i], 10)) {
-                            roundBit = 1;
-                            break;
-                        }
+                if (nDigitsStored < nDigits) {
+                    nDigits = nDigits - 1;
+                }
+                else {
+                    lastDigit = lastDigit - 1;
+                }
+                if (exponent < EXPONENT_MAX) {
+                    exponent = exponent + 1;
+                }
+                else {
+                    const digitsString = digits.join('');
+                    if (digitsString.match(/^0+$/)) {
+                        exponent = EXPONENT_MAX;
+                        break;
                     }
+                    invalidErr(representation, 'overflow');
                 }
             }
-            if (roundBit) {
-                let dIdx = lastDigit;
-                for (; dIdx >= 0; dIdx--) {
-                    if (++digits[dIdx] > 9) {
-                        digits[dIdx] = 0;
-                        if (dIdx === 0) {
-                            if (exponent < EXPONENT_MAX) {
-                                exponent = exponent + 1;
-                                digits[dIdx] = 1;
+            if (lastDigit + 1 < significantDigits) {
+                let endOfString = nDigitsRead;
+                if (sawRadix) {
+                    firstNonZero = firstNonZero + 1;
+                    endOfString = endOfString + 1;
+                }
+                if (sawSign) {
+                    firstNonZero = firstNonZero + 1;
+                    endOfString = endOfString + 1;
+                }
+                const roundDigit = parseInt(representation[firstNonZero + lastDigit + 1], 10);
+                let roundBit = 0;
+                if (roundDigit >= 5) {
+                    roundBit = 1;
+                    if (roundDigit === 5) {
+                        roundBit = digits[lastDigit] % 2 === 1 ? 1 : 0;
+                        for (let i = firstNonZero + lastDigit + 2; i < endOfString; i++) {
+                            if (parseInt(representation[i], 10)) {
+                                roundBit = 1;
+                                break;
                             }
-                            else {
-                                return new Decimal128(isNegative ? INF_NEGATIVE_BUFFER : INF_POSITIVE_BUFFER);
+                        }
+                    }
+                }
+                if (roundBit) {
+                    let dIdx = lastDigit;
+                    for (; dIdx >= 0; dIdx--) {
+                        if (++digits[dIdx] > 9) {
+                            digits[dIdx] = 0;
+                            if (dIdx === 0) {
+                                if (exponent < EXPONENT_MAX) {
+                                    exponent = exponent + 1;
+                                    digits[dIdx] = 1;
+                                }
+                                else {
+                                    return new Decimal128(isNegative ? INF_NEGATIVE_BUFFER : INF_POSITIVE_BUFFER);
+                                }
                             }
                         }
+                        else {
+                            break;
+                        }
+                    }
+                }
+            }
+        }
+        else {
+            while (exponent < EXPONENT_MIN || nDigitsStored < nDigits) {
+                if (lastDigit === 0) {
+                    if (significantDigits === 0) {
+                        exponent = EXPONENT_MIN;
+                        break;
                     }
+                    invalidErr(representation, 'exponent underflow');
+                }
+                if (nDigitsStored < nDigits) {
+                    if (representation[nDigits - 1 + Number(sawSign) + Number(sawRadix)] !== '0' &&
+                        significantDigits !== 0) {
+                        invalidErr(representation, 'inexact rounding');
+                    }
+                    nDigits = nDigits - 1;
+                }
+                else {
+                    if (digits[lastDigit] !== 0) {
+                        invalidErr(representation, 'inexact rounding');
+                    }
+                    lastDigit = lastDigit - 1;
+                }
+                if (exponent < EXPONENT_MAX) {
+                    exponent = exponent + 1;
+                }
+                else {
+                    invalidErr(representation, 'overflow');
+                }
+            }
+            if (lastDigit + 1 < significantDigits) {
+                if (sawRadix) {
+                    firstNonZero = firstNonZero + 1;
+                }
+                if (sawSign) {
+                    firstNonZero = firstNonZero + 1;
+                }
+                const roundDigit = parseInt(representation[firstNonZero + lastDigit + 1], 10);
+                if (roundDigit !== 0) {
+                    invalidErr(representation, 'inexact rounding');
                 }
             }
         }
@@ -1633,8 +1682,8 @@ class Decimal128 extends BSONValue {
             significandHigh = Long.fromNumber(0);
             significandLow = Long.fromNumber(0);
         }
-        else if (lastDigit - firstDigit < 17) {
-            let dIdx = firstDigit;
+        else if (lastDigit < 17) {
+            let dIdx = 0;
             significandLow = Long.fromNumber(digits[dIdx++]);
             significandHigh = new Long(0, 0);
             for (; dIdx <= lastDigit; dIdx++) {
@@ -1643,7 +1692,7 @@ class Decimal128 extends BSONValue {
             }
         }
         else {
-            let dIdx = firstDigit;
+            let dIdx = 0;
             significandHigh = Long.fromNumber(digits[dIdx++]);
             for (; dIdx <= lastDigit - 17; dIdx++) {
                 significandHigh = significandHigh.multiply(Long.fromNumber(10));
@@ -2417,19 +2466,21 @@ class Timestamp extends LongWithoutOverridesClass {
             if (typeof low.i !== 'number' && (typeof low.i !== 'object' || low.i._bsontype !== 'Int32')) {
                 throw new BSONError('Timestamp constructed from { t, i } must provide i as a number');
             }
-            if (low.t < 0) {
+            const t = Number(low.t);
+            const i = Number(low.i);
+            if (t < 0 || Number.isNaN(t)) {
                 throw new BSONError('Timestamp constructed from { t, i } must provide a positive t');
             }
-            if (low.i < 0) {
+            if (i < 0 || Number.isNaN(i)) {
                 throw new BSONError('Timestamp constructed from { t, i } must provide a positive i');
             }
-            if (low.t > 4294967295) {
+            if (t > 4294967295) {
                 throw new BSONError('Timestamp constructed from { t, i } must provide t equal or less than uint32 max');
             }
-            if (low.i > 4294967295) {
+            if (i > 4294967295) {
                 throw new BSONError('Timestamp constructed from { t, i } must provide i equal or less than uint32 max');
             }
-            super(low.i.valueOf(), low.t.valueOf(), true);
+            super(i, t, true);
         }
         else {
             throw new BSONError('A Timestamp can only be constructed with: bigint, Long, or { t: number; i: number }');
@@ -2601,7 +2652,7 @@ function deserializeObject(buffer, index, options, isArray = false) {
         }
         if (i >= buffer.byteLength)
             throw new BSONError('Bad BSON Document: illegal CString');
-        const name = isArray ? arrayIndex++ : ByteUtils.toUTF8(buffer.subarray(index, i));
+        const name = isArray ? arrayIndex++ : ByteUtils.toUTF8(buffer, index, i);
         let shouldValidateKey = true;
         if (globalUTFValidation || utf8KeysSet.has(name)) {
             shouldValidateKey = validationSetting;
@@ -2816,7 +2867,7 @@ function deserializeObject(buffer, index, options, isArray = false) {
             }
             if (i >= buffer.length)
                 throw new BSONError('Bad BSON Document: illegal CString');
-            const source = ByteUtils.toUTF8(buffer.subarray(index, i));
+            const source = ByteUtils.toUTF8(buffer, index, i);
             index = i + 1;
             i = index;
             while (buffer[i] !== 0x00 && i < buffer.length) {
@@ -2824,7 +2875,7 @@ function deserializeObject(buffer, index, options, isArray = false) {
             }
             if (i >= buffer.length)
                 throw new BSONError('Bad BSON Document: illegal CString');
-            const regExpOptions = ByteUtils.toUTF8(buffer.subarray(index, i));
+            const regExpOptions = ByteUtils.toUTF8(buffer, index, i);
             index = i + 1;
             const optionsArray = new Array(regExpOptions.length);
             for (i = 0; i < regExpOptions.length; i++) {
@@ -2849,7 +2900,7 @@ function deserializeObject(buffer, index, options, isArray = false) {
             }
             if (i >= buffer.length)
                 throw new BSONError('Bad BSON Document: illegal CString');
-            const source = ByteUtils.toUTF8(buffer.subarray(index, i));
+            const source = ByteUtils.toUTF8(buffer, index, i);
             index = i + 1;
             i = index;
             while (buffer[i] !== 0x00 && i < buffer.length) {
@@ -2857,7 +2908,7 @@ function deserializeObject(buffer, index, options, isArray = false) {
             }
             if (i >= buffer.length)
                 throw new BSONError('Bad BSON Document: illegal CString');
-            const regExpOptions = ByteUtils.toUTF8(buffer.subarray(index, i));
+            const regExpOptions = ByteUtils.toUTF8(buffer, index, i);
             index = i + 1;
             value = new BSONRegExp(source, regExpOptions);
         }
@@ -2954,7 +3005,7 @@ function deserializeObject(buffer, index, options, isArray = false) {
                     throw new BSONError('Invalid UTF-8 string in BSON document');
                 }
             }
-            const namespace = ByteUtils.toUTF8(buffer.subarray(index, index + stringSize - 1));
+            const namespace = ByteUtils.toUTF8(buffer, index, index + stringSize - 1);
             index = index + stringSize;
             const oidBuffer = ByteUtils.allocate(12);
             oidBuffer.set(buffer.subarray(index, index + 12), 0);
@@ -2994,7 +3045,7 @@ function deserializeObject(buffer, index, options, isArray = false) {
     return object;
 }
 function getValidatedString(buffer, start, end, shouldValidateUtf8) {
-    const value = ByteUtils.toUTF8(buffer.subarray(start, end));
+    const value = ByteUtils.toUTF8(buffer, start, end);
     if (shouldValidateUtf8) {
         for (let i = 0; i < value.length; i++) {
             if (value.charCodeAt(i) === 0xfffd) {