bson 4.2.2 → 4.4.1

package/lib/uuid.js

@@ -1,48 +1,179 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseUUID = void 0;
+exports.UUID = void 0;
+var buffer_1 = require("buffer");
+var ensure_buffer_1 = require("./ensure_buffer");
+var binary_1 = require("./binary");
+var uuid_utils_1 = require("./uuid_utils");
+var utils_1 = require("./parser/utils");
+var BYTE_LENGTH = 16;
+var kId = Symbol('id');
 /**
- * UUID regular expression pattern copied from `uuid` npm module.
- * @see https://github.com/uuidjs/uuid/blob/master/src/regex.js
+ * A class representation of the BSON UUID type.
+ * @public
  */
-const UUID_RX = /^(?:[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}|00000000-0000-0000-0000-000000000000)$/i;
-/**
- * Parser function copied from `uuid` npm module.
- * @see https://github.com/uuidjs/uuid/blob/master/src/parse.js
- * @internal
- */
-function parseUUID(uuid) {
-    if (typeof uuid !== 'string') {
-        throw new TypeError('Invalid type for UUID, expected string but got ' + typeof uuid);
-    }
-    if (!UUID_RX.test(uuid)) {
-        throw new TypeError('Invalid format for UUID: ' + uuid);
+var UUID = /** @class */ (function () {
+    /**
+     * Create an UUID type
+     *
+     * @param input - Can be a 32 or 36 character hex string (dashes excluded/included) or a 16 byte binary Buffer.
+     */
+    function UUID(input) {
+        if (typeof input === 'undefined') {
+            // The most common use case (blank id, new UUID() instance)
+            this.id = UUID.generate();
+        }
+        else if (input instanceof UUID) {
+            this[kId] = buffer_1.Buffer.from(input.id);
+            this.__id = input.__id;
+        }
+        else if (ArrayBuffer.isView(input) && input.byteLength === BYTE_LENGTH) {
+            this.id = ensure_buffer_1.ensureBuffer(input);
+        }
+        else if (typeof input === 'string') {
+            this.id = uuid_utils_1.uuidHexStringToBuffer(input);
+        }
+        else {
+            throw new TypeError('Argument passed in UUID constructor must be a UUID, a 16 byte Buffer or a 32/36 character hex string (dashes excluded/included, format: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).');
+        }
     }
-    let v;
-    const arr = new Uint8Array(16);
-    // Parse ########-....-....-....-............
-    arr[0] = (v = parseInt(uuid.slice(0, 8), 16)) >>> 24;
-    arr[1] = (v >>> 16) & 0xff;
-    arr[2] = (v >>> 8) & 0xff;
-    arr[3] = v & 0xff;
-    // Parse ........-####-....-....-............
-    arr[4] = (v = parseInt(uuid.slice(9, 13), 16)) >>> 8;
-    arr[5] = v & 0xff;
-    // Parse ........-....-####-....-............
-    arr[6] = (v = parseInt(uuid.slice(14, 18), 16)) >>> 8;
-    arr[7] = v & 0xff;
-    // Parse ........-....-....-####-............
-    arr[8] = (v = parseInt(uuid.slice(19, 23), 16)) >>> 8;
-    arr[9] = v & 0xff;
-    // Parse ........-....-....-....-############
-    // (Use "/" to avoid 32-bit truncation when bit-shifting high-order bytes)
-    arr[10] = ((v = parseInt(uuid.slice(24, 36), 16)) / 0x10000000000) & 0xff;
-    arr[11] = (v / 0x100000000) & 0xff;
-    arr[12] = (v >>> 24) & 0xff;
-    arr[13] = (v >>> 16) & 0xff;
-    arr[14] = (v >>> 8) & 0xff;
-    arr[15] = v & 0xff;
-    return arr;
-}
-exports.parseUUID = parseUUID;
+    Object.defineProperty(UUID.prototype, "id", {
+        /**
+         * The UUID bytes
+         * @readonly
+         */
+        get: function () {
+            return this[kId];
+        },
+        set: function (value) {
+            this[kId] = value;
+            if (UUID.cacheHexString) {
+                this.__id = uuid_utils_1.bufferToUuidHexString(value);
+            }
+        },
+        enumerable: false,
+        configurable: true
+    });
+    /**
+     * Generate a 16 byte uuid v4 buffer used in UUIDs
+     */
+    /**
+     * Returns the UUID id as a 32 or 36 character hex string representation, excluding/including dashes (defaults to 36 character dash separated)
+     * @param includeDashes - should the string exclude dash-separators.
+     * */
+    UUID.prototype.toHexString = function (includeDashes) {
+        if (includeDashes === void 0) { includeDashes = true; }
+        if (UUID.cacheHexString && this.__id) {
+            return this.__id;
+        }
+        var uuidHexString = uuid_utils_1.bufferToUuidHexString(this.id, includeDashes);
+        if (UUID.cacheHexString) {
+            this.__id = uuidHexString;
+        }
+        return uuidHexString;
+    };
+    /**
+     * Converts the id into a 36 character (dashes included) hex string, unless a encoding is specified.
+     * @internal
+     */
+    UUID.prototype.toString = function (encoding) {
+        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
+     */
+    UUID.prototype.toJSON = function () {
+        return this.toHexString();
+    };
+    /**
+     * Compares the equality of this UUID with `otherID`.
+     *
+     * @param otherId - UUID instance to compare against.
+     */
+    UUID.prototype.equals = function (otherId) {
+        if (!otherId) {
+            return false;
+        }
+        if (otherId instanceof UUID) {
+            return otherId.id.equals(this.id);
+        }
+        try {
+            return new UUID(otherId).id.equals(this.id);
+        }
+        catch (_a) {
+            return false;
+        }
+    };
+    /**
+     * Creates a Binary instance from the current UUID.
+     */
+    UUID.prototype.toBinary = function () {
+        return new binary_1.Binary(this.id, binary_1.Binary.SUBTYPE_UUID);
+    };
+    /**
+     * Generates a populated buffer containing a v4 uuid
+     */
+    UUID.generate = function () {
+        var bytes = utils_1.randomBytes(BYTE_LENGTH);
+        // Per 4.4, set bits for version and `clock_seq_hi_and_reserved`
+        // Kindly borrowed from https://github.com/uuidjs/uuid/blob/master/src/v4.js
+        bytes[6] = (bytes[6] & 0x0f) | 0x40;
+        bytes[8] = (bytes[8] & 0x3f) | 0x80;
+        return buffer_1.Buffer.from(bytes);
+    };
+    /**
+     * Checks if a value is a valid bson UUID
+     * @param input - UUID, string or Buffer to validate.
+     */
+    UUID.isValid = function (input) {
+        if (!input) {
+            return false;
+        }
+        if (input instanceof UUID) {
+            return true;
+        }
+        if (typeof input === 'string') {
+            return uuid_utils_1.uuidValidateString(input);
+        }
+        if (utils_1.isUint8Array(input)) {
+            // check for length & uuid version (https://tools.ietf.org/html/rfc4122#section-4.1.3)
+            if (input.length !== BYTE_LENGTH) {
+                return false;
+            }
+            try {
+                // get this byte as hex:             xxxxxxxx-xxxx-XXxx-xxxx-xxxxxxxxxxxx
+                // check first part as uuid version: xxxxxxxx-xxxx-Xxxx-xxxx-xxxxxxxxxxxx
+                return parseInt(input[6].toString(16)[0], 10) === binary_1.Binary.SUBTYPE_UUID;
+            }
+            catch (_a) {
+                return false;
+            }
+        }
+        return false;
+    };
+    /**
+     * Creates an UUID from a hex string representation of an UUID.
+     * @param hexString - 32 or 36 character hex string (dashes excluded/included).
+     */
+    UUID.createFromHexString = function (hexString) {
+        var buffer = uuid_utils_1.uuidHexStringToBuffer(hexString);
+        return new UUID(buffer);
+    };
+    /**
+     * Converts to a string representation of this Id.
+     *
+     * @returns return the 36 character hex string representation.
+     * @internal
+     */
+    UUID.prototype[Symbol.for('nodejs.util.inspect.custom')] = function () {
+        return this.inspect();
+    };
+    UUID.prototype.inspect = function () {
+        return "new UUID(\"" + this.toHexString() + "\")";
+    };
+    return UUID;
+}());
+exports.UUID = UUID;
+Object.defineProperty(UUID.prototype, '_bsontype', { value: 'UUID' });
 //# sourceMappingURL=uuid.js.map

package/lib/uuid.js.map

@@ -1 +1 @@
-{"version":3,"file":"uuid.js","sourceRoot":"","sources":["../src/uuid.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,MAAM,OAAO,GAAG,qHAAqH,CAAC;AAOtI;;;;GAIG;AACH,SAAgB,SAAS,CAAC,IAAY;IACpC,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;QAC5B,MAAM,IAAI,SAAS,CAAC,iDAAiD,GAAG,OAAO,IAAI,CAAC,CAAC;KACtF;IAED,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACvB,MAAM,IAAI,SAAS,CAAC,2BAA2B,GAAG,IAAI,CAAC,CAAC;KACzD;IAED,IAAI,CAAC,CAAC;IACN,MAAM,GAAG,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAC;IAE/B,6CAA6C;IAC7C,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,CAAC;IACrD,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAC3B,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAC1B,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAElB,6CAA6C;IAC7C,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IACrD,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAElB,6CAA6C;IAC7C,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IACtD,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAElB,6CAA6C;IAC7C,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;IACtD,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAElB,6CAA6C;IAC7C,0EAA0E;IAC1E,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,aAAa,CAAC,GAAG,IAAI,CAAC;IAC1E,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,GAAG,WAAW,CAAC,GAAG,IAAI,CAAC;IACnC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAC5B,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;IAC5B,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,GAAG,IAAI,CAAC;IAC3B,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC;IAEnB,OAAO,GAAG,CAAC;AACb,CAAC;AAxCD,8BAwCC"}
+{"version":3,"file":"uuid.js","sourceRoot":"","sources":["../src/uuid.ts"],"names":[],"mappings":";;;AAAA,iCAAgC;AAChC,iDAA+C;AAC/C,mCAAkC;AAClC,2CAAgG;AAChG,wCAA2D;AAO3D,IAAM,WAAW,GAAG,EAAE,CAAC;AAEvB,IAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;AAEzB;;;GAGG;AACH;IAWE;;;;OAIG;IACH,cAAY,KAA8B;QACxC,IAAI,OAAO,KAAK,KAAK,WAAW,EAAE;YAChC,2DAA2D;YAC3D,IAAI,CAAC,EAAE,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;SAC3B;aAAM,IAAI,KAAK,YAAY,IAAI,EAAE;YAChC,IAAI,CAAC,GAAG,CAAC,GAAG,eAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;YAClC,IAAI,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;SACxB;aAAM,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,KAAK,CAAC,UAAU,KAAK,WAAW,EAAE;YACxE,IAAI,CAAC,EAAE,GAAG,4BAAY,CAAC,KAAK,CAAC,CAAC;SAC/B;aAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YACpC,IAAI,CAAC,EAAE,GAAG,kCAAqB,CAAC,KAAK,CAAC,CAAC;SACxC;aAAM;YACL,MAAM,IAAI,SAAS,CACjB,gLAAgL,CACjL,CAAC;SACH;IACH,CAAC;IAMD,sBAAI,oBAAE;QAJN;;;WAGG;aACH;YACE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC;QACnB,CAAC;aAED,UAAO,KAAa;YAClB,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;YAElB,IAAI,IAAI,CAAC,cAAc,EAAE;gBACvB,IAAI,CAAC,IAAI,GAAG,kCAAqB,CAAC,KAAK,CAAC,CAAC;aAC1C;QACH,CAAC;;;OARA;IAUD;;OAEG;IAEH;;;SAGK;IACL,0BAAW,GAAX,UAAY,aAAoB;QAApB,8BAAA,EAAA,oBAAoB;QAC9B,IAAI,IAAI,CAAC,cAAc,IAAI,IAAI,CAAC,IAAI,EAAE;YACpC,OAAO,IAAI,CAAC,IAAI,CAAC;SAClB;QAED,IAAM,aAAa,GAAG,kCAAqB,CAAC,IAAI,CAAC,EAAE,EAAE,aAAa,CAAC,CAAC;QAEpE,IAAI,IAAI,CAAC,cAAc,EAAE;YACvB,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;SAC3B;QAED,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;OAGG;IACH,uBAAQ,GAAR,UAAS,QAAiB;QACxB,OAAO,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC;IACpE,CAAC;IAED;;;OAGG;IACH,qBAAM,GAAN;QACE,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;IAC5B,CAAC;IAED;;;;OAIG;IACH,qBAAM,GAAN,UAAO,OAA+B;QACpC,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,KAAK,CAAC;SACd;QAED,IAAI,OAAO,YAAY,IAAI,EAAE;YAC3B,OAAO,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SACnC;QAED,IAAI;YACF,OAAO,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;SAC7C;QAAC,WAAM;YACN,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAED;;OAEG;IACH,uBAAQ,GAAR;QACE,OAAO,IAAI,eAAM,CAAC,IAAI,CAAC,EAAE,EAAE,eAAM,CAAC,YAAY,CAAC,CAAC;IAClD,CAAC;IAED;;OAEG;IACI,aAAQ,GAAf;QACE,IAAM,KAAK,GAAG,mBAAW,CAAC,WAAW,CAAC,CAAC;QAEvC,gEAAgE;QAChE,4EAA4E;QAC5E,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QACpC,KAAK,CAAC,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAEpC,OAAO,eAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC5B,CAAC;IAED;;;OAGG;IACI,YAAO,GAAd,UAAe,KAA6B;QAC1C,IAAI,CAAC,KAAK,EAAE;YACV,OAAO,KAAK,CAAC;SACd;QAED,IAAI,KAAK,YAAY,IAAI,EAAE;YACzB,OAAO,IAAI,CAAC;SACb;QAED,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;YAC7B,OAAO,+BAAkB,CAAC,KAAK,CAAC,CAAC;SAClC;QAED,IAAI,oBAAY,CAAC,KAAK,CAAC,EAAE;YACvB,sFAAsF;YACtF,IAAI,KAAK,CAAC,MAAM,KAAK,WAAW,EAAE;gBAChC,OAAO,KAAK,CAAC;aACd;YAED,IAAI;gBACF,yEAAyE;gBACzE,yEAAyE;gBACzE,OAAO,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,KAAK,eAAM,CAAC,YAAY,CAAC;aACvE;YAAC,WAAM;gBACN,OAAO,KAAK,CAAC;aACd;SACF;QAED,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;;OAGG;IACI,wBAAmB,GAA1B,UAA2B,SAAiB;QAC1C,IAAM,MAAM,GAAG,kCAAqB,CAAC,SAAS,CAAC,CAAC;QAChD,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;IAED;;;;;OAKG;IACH,eAAC,MAAM,CAAC,GAAG,CAAC,4BAA4B,CAAC,CAAC,GAA1C;QACE,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IAED,sBAAO,GAAP;QACE,OAAO,gBAAa,IAAI,CAAC,WAAW,EAAE,QAAI,CAAC;IAC7C,CAAC;IACH,WAAC;AAAD,CAAC,AA3LD,IA2LC;AA3LY,oBAAI;AA6LjB,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC"}

package/lib/uuid_utils.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.bufferToUuidHexString = exports.uuidHexStringToBuffer = exports.uuidValidateString = void 0;
+var buffer_1 = require("buffer");
+// Validation regex for v4 uuid (validates with or without dashes)
+var 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;
+var uuidValidateString = function (str) {
+    return typeof str === 'string' && VALIDATION_REGEX.test(str);
+};
+exports.uuidValidateString = uuidValidateString;
+var uuidHexStringToBuffer = function (hexString) {
+    if (!exports.uuidValidateString(hexString)) {
+        throw new TypeError('UUID string representations must be a 32 or 36 character hex string (dashes excluded/included). Format: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" or "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx".');
+    }
+    var sanitizedHexString = hexString.replace(/-/g, '');
+    return buffer_1.Buffer.from(sanitizedHexString, 'hex');
+};
+exports.uuidHexStringToBuffer = uuidHexStringToBuffer;
+var bufferToUuidHexString = function (buffer, includeDashes) {
+    if (includeDashes === void 0) { includeDashes = true; }
+    return includeDashes
+        ? buffer.toString('hex', 0, 4) +
+            '-' +
+            buffer.toString('hex', 4, 6) +
+            '-' +
+            buffer.toString('hex', 6, 8) +
+            '-' +
+            buffer.toString('hex', 8, 10) +
+            '-' +
+            buffer.toString('hex', 10, 16)
+        : buffer.toString('hex');
+};
+exports.bufferToUuidHexString = bufferToUuidHexString;
+//# sourceMappingURL=uuid_utils.js.map

package/lib/uuid_utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uuid_utils.js","sourceRoot":"","sources":["../src/uuid_utils.ts"],"names":[],"mappings":";;;AAAA,iCAAgC;AAEhC,kEAAkE;AAClE,IAAM,gBAAgB,GAAG,uHAAuH,CAAC;AAE1I,IAAM,kBAAkB,GAAG,UAAC,GAAW;IAC5C,OAAA,OAAO,GAAG,KAAK,QAAQ,IAAI,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC;AAArD,CAAqD,CAAC;AAD3C,QAAA,kBAAkB,sBACyB;AAEjD,IAAM,qBAAqB,GAAG,UAAC,SAAiB;IACrD,IAAI,CAAC,0BAAkB,CAAC,SAAS,CAAC,EAAE;QAClC,MAAM,IAAI,SAAS,CACjB,uLAAuL,CACxL,CAAC;KACH;IAED,IAAM,kBAAkB,GAAG,SAAS,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACvD,OAAO,eAAM,CAAC,IAAI,CAAC,kBAAkB,EAAE,KAAK,CAAC,CAAC;AAChD,CAAC,CAAC;AATW,QAAA,qBAAqB,yBAShC;AAEK,IAAM,qBAAqB,GAAG,UAAC,MAAc,EAAE,aAAoB;IAApB,8BAAA,EAAA,oBAAoB;IACxE,OAAA,aAAa;QACX,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YAC5B,GAAG;YACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YAC5B,GAAG;YACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YAC5B,GAAG;YACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,CAAC;YAC7B,GAAG;YACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,EAAE,EAAE,EAAE,CAAC;QAChC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;AAV1B,CAU0B,CAAC;AAXhB,QAAA,qBAAqB,yBAWL"}

package/lib/validate_utf8.js

@@ -1,15 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.validateUtf8 = void 0;
-const FIRST_BIT = 0x80;
-const FIRST_TWO_BITS = 0xc0;
-const FIRST_THREE_BITS = 0xe0;
-const FIRST_FOUR_BITS = 0xf0;
-const FIRST_FIVE_BITS = 0xf8;
-const TWO_BIT_CHAR = 0xc0;
-const THREE_BIT_CHAR = 0xe0;
-const FOUR_BIT_CHAR = 0xf0;
-const CONTINUING_CHAR = 0x80;
+var FIRST_BIT = 0x80;
+var FIRST_TWO_BITS = 0xc0;
+var FIRST_THREE_BITS = 0xe0;
+var FIRST_FOUR_BITS = 0xf0;
+var FIRST_FIVE_BITS = 0xf8;
+var TWO_BIT_CHAR = 0xc0;
+var THREE_BIT_CHAR = 0xe0;
+var FOUR_BIT_CHAR = 0xf0;
+var CONTINUING_CHAR = 0x80;
 /**
  * Determines if the passed in bytes are valid utf8
  * @param bytes - An array of 8-bit bytes. Must be indexable and have length property
@@ -17,9 +17,9 @@ const CONTINUING_CHAR = 0x80;
  * @param end - The index to end validating
  */
 function validateUtf8(bytes, start, end) {
-    let continuation = 0;
-    for (let i = start; i < end; i += 1) {
-        const byte = bytes[i];
+    var continuation = 0;
+    for (var i = start; i < end; i += 1) {
+        var byte = bytes[i];
         if (continuation) {
             if ((byte & FIRST_TWO_BITS) !== CONTINUING_CHAR) {
                 return false;

package/lib/validate_utf8.js.map

@@ -1 +1 @@
-{"version":3,"file":"validate_utf8.js","sourceRoot":"","sources":["../src/validate_utf8.ts"],"names":[],"mappings":";;;AAAA,MAAM,SAAS,GAAG,IAAI,CAAC;AACvB,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,MAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,MAAM,eAAe,GAAG,IAAI,CAAC;AAC7B,MAAM,eAAe,GAAG,IAAI,CAAC;AAE7B,MAAM,YAAY,GAAG,IAAI,CAAC;AAC1B,MAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,MAAM,aAAa,GAAG,IAAI,CAAC;AAC3B,MAAM,eAAe,GAAG,IAAI,CAAC;AAE7B;;;;;GAKG;AACH,SAAgB,YAAY,CAC1B,KAAkC,EAClC,KAAa,EACb,GAAW;IAEX,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE;QACnC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAEtB,IAAI,YAAY,EAAE;YAChB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,eAAe,EAAE;gBAC/C,OAAO,KAAK,CAAC;aACd;YACD,YAAY,IAAI,CAAC,CAAC;SACnB;aAAM,IAAI,IAAI,GAAG,SAAS,EAAE;YAC3B,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC,KAAK,YAAY,EAAE;gBAC9C,YAAY,GAAG,CAAC,CAAC;aAClB;iBAAM,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,KAAK,cAAc,EAAE;gBACtD,YAAY,GAAG,CAAC,CAAC;aAClB;iBAAM,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,KAAK,aAAa,EAAE;gBACrD,YAAY,GAAG,CAAC,CAAC;aAClB;iBAAM;gBACL,OAAO,KAAK,CAAC;aACd;SACF;KACF;IAED,OAAO,CAAC,YAAY,CAAC;AACvB,CAAC;AA7BD,oCA6BC"}
+{"version":3,"file":"validate_utf8.js","sourceRoot":"","sources":["../src/validate_utf8.ts"],"names":[],"mappings":";;;AAAA,IAAM,SAAS,GAAG,IAAI,CAAC;AACvB,IAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,IAAM,gBAAgB,GAAG,IAAI,CAAC;AAC9B,IAAM,eAAe,GAAG,IAAI,CAAC;AAC7B,IAAM,eAAe,GAAG,IAAI,CAAC;AAE7B,IAAM,YAAY,GAAG,IAAI,CAAC;AAC1B,IAAM,cAAc,GAAG,IAAI,CAAC;AAC5B,IAAM,aAAa,GAAG,IAAI,CAAC;AAC3B,IAAM,eAAe,GAAG,IAAI,CAAC;AAE7B;;;;;GAKG;AACH,SAAgB,YAAY,CAC1B,KAAkC,EAClC,KAAa,EACb,GAAW;IAEX,IAAI,YAAY,GAAG,CAAC,CAAC;IAErB,KAAK,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,EAAE;QACnC,IAAM,IAAI,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;QAEtB,IAAI,YAAY,EAAE;YAChB,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,KAAK,eAAe,EAAE;gBAC/C,OAAO,KAAK,CAAC;aACd;YACD,YAAY,IAAI,CAAC,CAAC;SACnB;aAAM,IAAI,IAAI,GAAG,SAAS,EAAE;YAC3B,IAAI,CAAC,IAAI,GAAG,gBAAgB,CAAC,KAAK,YAAY,EAAE;gBAC9C,YAAY,GAAG,CAAC,CAAC;aAClB;iBAAM,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,KAAK,cAAc,EAAE;gBACtD,YAAY,GAAG,CAAC,CAAC;aAClB;iBAAM,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC,KAAK,aAAa,EAAE;gBACrD,YAAY,GAAG,CAAC,CAAC;aAClB;iBAAM;gBACL,OAAO,KAAK,CAAC;aACd;SACF;KACF;IAED,OAAO,CAAC,YAAY,CAAC;AACvB,CAAC;AA7BD,oCA6BC"}

package/package.json

@@ -15,7 +15,7 @@
     "bower.json"
   ],
   "types": "bson.d.ts",
-  "version": "4.2.2",
+  "version": "4.4.1",
   "author": "Christian Amor Kvalheim <christkv@gmail.com>",
   "license": "Apache-2.0",
   "contributors": [],
@@ -59,11 +59,12 @@
     "rollup-plugin-node-builtins": "^2.1.2",
     "rollup-plugin-node-globals": "^1.4.0",
     "rollup-plugin-node-polyfills": "^0.2.1",
-    "standard-version": "^8.0.1",
+    "standard-version": "^9.3.0",
     "ts-node": "^9.0.0",
-    "typedoc": "^0.18.0",
+    "typedoc": "^0.21.2",
     "typescript": "^4.0.2",
-    "typescript-cached-transpile": "0.0.6"
+    "typescript-cached-transpile": "0.0.6",
+    "uuid": "^8.3.2"
   },
   "config": {
     "native": false

package/src/binary.ts

@@ -1,7 +1,8 @@
 import { Buffer } from 'buffer';
 import { ensureBuffer } from './ensure_buffer';
+import { uuidHexStringToBuffer } from './uuid_utils';
+import { UUID, UUIDExtended } from './uuid';
 import type { EJSONOptions } from './extended_json';
-import { parseUUID, UUIDExtended } from './uuid';
 
 /** @public */
 export type BinarySequence = Uint8Array | Buffer | number[];
@@ -50,15 +51,17 @@ export class Binary {
   /** User BSON type */
   static readonly SUBTYPE_USER_DEFINED = 128;
 
-  buffer: Buffer;
-  sub_type: number;
-  position: number;
+  buffer!: Buffer;
+  sub_type!: number;
+  position!: number;
 
   /**
    * @param buffer - a buffer object containing the binary data.
    * @param subType - the option binary type.
    */
   constructor(buffer?: string | BinarySequence, subType?: number) {
+    if (!(this instanceof Binary)) return new Binary(buffer, subType);
+
     if (
       !(buffer == null) &&
       !(typeof buffer === 'string') &&
@@ -228,6 +231,17 @@ export class Binary {
     };
   }
 
+  /** @internal */
+  toUUID(): UUID {
+    if (this.sub_type === Binary.SUBTYPE_UUID) {
+      return new UUID(this.buffer.slice(0, this.position));
+    }
+
+    throw new Error(
+      `Binary sub_type "${this.sub_type}" is not supported for converting to UUID. Only "${Binary.SUBTYPE_UUID}" is currently supported.`
+    );
+  }
+
   /** @internal */
   static fromExtendedJSON(
     doc: BinaryExtendedLegacy | BinaryExtended | UUIDExtended,
@@ -248,7 +262,7 @@ export class Binary {
       }
     } else if ('$uuid' in doc) {
       type = 4;
-      data = Buffer.from(parseUUID(doc.$uuid));
+      data = uuidHexStringToBuffer(doc.$uuid);
     }
     if (!data) {
       throw new TypeError(`Unexpected Binary Extended JSON format ${JSON.stringify(doc)}`);
@@ -263,7 +277,7 @@ export class Binary {
 
   inspect(): string {
     const asBuffer = this.value(true);
-    return `Binary("${asBuffer.toString('hex')}", ${this.sub_type})`;
+    return `new Binary(Buffer.from("${asBuffer.toString('hex')}", "hex"), ${this.sub_type})`;
   }
 }
 

package/src/bson.ts

@@ -19,6 +19,7 @@ import { serializeInto as internalSerialize, SerializeOptions } from './parser/s
 import { BSONRegExp } from './regexp';
 import { BSONSymbol } from './symbol';
 import { Timestamp } from './timestamp';
+import { UUID } from './uuid';
 export { BinaryExtended, BinaryExtendedLegacy, BinarySequence } from './binary';
 export { CodeExtended } from './code';
 export {
@@ -81,6 +82,7 @@ export {
   DBRef,
   Binary,
   ObjectId,
+  UUID,
   Long,
   Timestamp,
   Double,
@@ -307,6 +309,7 @@ const BSON = {
   Double,
   Int32,
   Long,
+  UUID,
   Map,
   MaxKey,
   MinKey,

package/src/code.ts

@@ -13,13 +13,15 @@ export interface CodeExtended {
 export class Code {
   _bsontype!: 'Code';
 
-  code: string | Function;
+  code!: string | Function;
   scope?: Document;
   /**
    * @param code - a string or function.
    * @param scope - an optional scope for the function.
    */
   constructor(code: string | Function, scope?: Document) {
+    if (!(this instanceof Code)) return new Code(code, scope);
+
     this.code = code;
     this.scope = scope;
   }
@@ -50,7 +52,9 @@ export class Code {
 
   inspect(): string {
     const codeJson = this.toJSON();
-    return `Code("${codeJson.code}"${codeJson.scope ? `, ${JSON.stringify(codeJson.scope)}` : ''})`;
+    return `new Code("${codeJson.code}"${
+      codeJson.scope ? `, ${JSON.stringify(codeJson.scope)}` : ''
+    })`;
   }
 }
 

package/src/db_ref.ts

@@ -12,7 +12,12 @@ export interface DBRefLike {
 
 /** @internal */
 export function isDBRefLike(value: unknown): value is DBRefLike {
-  return isObjectLike(value) && value['$id'] != null && value['$ref'] != null;
+  return (
+    isObjectLike(value) &&
+    value.$id != null &&
+    typeof value.$ref === 'string' &&
+    (value.$db == null || typeof value.$db === 'string')
+  );
 }
 
 /**
@@ -22,10 +27,10 @@ export function isDBRefLike(value: unknown): value is DBRefLike {
 export class DBRef {
   _bsontype!: 'DBRef';
 
-  collection: string;
-  oid: ObjectId;
+  collection!: string;
+  oid!: ObjectId;
   db?: string;
-  fields: Document;
+  fields!: Document;
 
   /**
    * @param collection - the collection name.
@@ -33,6 +38,8 @@ export class DBRef {
    * @param db - optional db name, if omitted the reference is local to the current db.
    */
   constructor(collection: string, oid: ObjectId, db?: string, fields?: Document) {
+    if (!(this instanceof DBRef)) return new DBRef(collection, oid, db, fields);
+
     // check if namespace has been provided
     const parts = collection.split('.');
     if (parts.length === 2) {
@@ -108,7 +115,9 @@ export class DBRef {
     // NOTE: if OID is an ObjectId class it will just print the oid string.
     const oid =
       this.oid === undefined || this.oid.toString === undefined ? this.oid : this.oid.toString();
-    return `DBRef("${this.namespace}", "${oid}"${this.db ? `, "${this.db}"` : ''})`;
+    return `new DBRef("${this.namespace}", new ObjectId("${oid}")${
+      this.db ? `, "${this.db}"` : ''
+    })`;
   }
 }
 

package/src/decimal128.ts

@@ -165,11 +165,20 @@ export interface Decimal128Extended {
 export class Decimal128 {
   _bsontype!: 'Decimal128';
 
-  readonly bytes: Buffer;
+  readonly bytes!: Buffer;
 
-  /** @param bytes - a buffer containing the raw Decimal128 bytes in little endian order */
-  constructor(bytes: Buffer) {
-    this.bytes = bytes;
+  /**
+   * @param bytes - a buffer containing the raw Decimal128 bytes in little endian order,
+   *                or a string representation as returned by .toString()
+   */
+  constructor(bytes: Buffer | string) {
+    if (!(this instanceof Decimal128)) return new Decimal128(bytes);
+
+    if (typeof bytes === 'string') {
+      this.bytes = Decimal128.fromString(bytes).bytes;
+    } else {
+      this.bytes = bytes;
+    }
   }
 
   /**
@@ -794,7 +803,7 @@ export class Decimal128 {
   }
 
   inspect(): string {
-    return `Decimal128("${this.toString()}")`;
+    return `new Decimal128("${this.toString()}")`;
   }
 }
 

package/src/double.ts

@@ -12,13 +12,15 @@ export interface DoubleExtended {
 export class Double {
   _bsontype!: 'Double';
 
-  value: number;
+  value!: number;
   /**
    * Create a Double type
    *
    * @param value - the number we want to represent as a double.
    */
   constructor(value: number) {
+    if (!(this instanceof Double)) return new Double(value);
+
     if ((value as unknown) instanceof Number) {
       value = value.valueOf();
     }
@@ -78,7 +80,7 @@ export class Double {
 
   inspect(): string {
     const eJSON = this.toExtendedJSON() as DoubleExtended;
-    return `Double(${eJSON.$numberDouble})`;
+    return `new Double(${eJSON.$numberDouble})`;
   }
 }
 

package/src/ensure_buffer.ts

@@ -1,5 +1,5 @@
 import { Buffer } from 'buffer';
-import { isBuffer } from './parser/utils';
+import { isAnyArrayBuffer } from './parser/utils';
 
 /**
  * Makes sure that, if a Uint8Array is passed in, it is wrapped in a Buffer.
@@ -10,15 +10,15 @@ import { isBuffer } from './parser/utils';
  * @throws TypeError If anything other than a Buffer or Uint8Array is passed in
  */
 export function ensureBuffer(potentialBuffer: Buffer | ArrayBufferView | ArrayBuffer): Buffer {
-  if (isBuffer(potentialBuffer)) {
-    return potentialBuffer;
-  }
-
   if (ArrayBuffer.isView(potentialBuffer)) {
-    return Buffer.from(potentialBuffer.buffer);
+    return Buffer.from(
+      potentialBuffer.buffer,
+      potentialBuffer.byteOffset,
+      potentialBuffer.byteLength
+    );
   }
 
-  if (potentialBuffer instanceof ArrayBuffer) {
+  if (isAnyArrayBuffer(potentialBuffer)) {
     return Buffer.from(potentialBuffer);
   }