bson 4.2.2 → 4.4.1

package/HISTORY.md

@@ -2,6 +2,50 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [4.4.1](https://github.com/mongodb/js-bson/compare/v4.4.0...v4.4.1) (2021-07-06)
+
+
+### Bug Fixes
+
+* **NODE-3247:** DBRef special handling ([#443](https://github.com/mongodb/js-bson/issues/443)) ([f5d984d](https://github.com/mongodb/js-bson/commit/f5d984d88b2e20310ec5cc3a39b91b0fd1e0b3c9))
+* **NODE-3282:** BSONRegExp options not alphabetized ([#441](https://github.com/mongodb/js-bson/issues/441)) ([18c3512](https://github.com/mongodb/js-bson/commit/18c3512befe54908e4b816056dbde0d1b998d81b))
+* **NODE-3376:** use standard JS methods for copying Buffers ([#444](https://github.com/mongodb/js-bson/issues/444)) ([804050d](https://github.com/mongodb/js-bson/commit/804050d40b03a02116995e63671e05ffa033dc45))
+* **NODE-3390:** serialize non-finite doubles correctly in EJSON ([#445](https://github.com/mongodb/js-bson/issues/445)) ([7eb7998](https://github.com/mongodb/js-bson/commit/7eb79981e16d73a391c567b7f9748943997a424d))
+
+## [4.4.0](https://github.com/mongodb/js-bson/compare/v4.3.0...v4.4.0) (2021-05-18)
+
+
+### Features
+
+* **NODE-3264:** allow Decimal128(string), Long(string), Long(bigint) ([#437](https://github.com/mongodb/js-bson/issues/437)) ([392c1bc](https://github.com/mongodb/js-bson/commit/392c1bcbe003b185f38d64a8a24bc21a6661cb26))
+* make circular input errors for EJSON expressive ([#433](https://github.com/mongodb/js-bson/issues/433)) ([7b351cc](https://github.com/mongodb/js-bson/commit/7b351cc217786e5ee992f0fb64588f9c3fddd828))
+
+
+### Bug Fixes
+
+* make Long inspect result evaluable ([3a2eff1](https://github.com/mongodb/js-bson/commit/3a2eff127175c7f94c9ccc940074537b7ad972f1))
+* **NODE-3153:** correctly deserialize `__proto__` properties ([#431](https://github.com/mongodb/js-bson/issues/431)) ([f34cabc](https://github.com/mongodb/js-bson/commit/f34cabc31e66bc809d8e3cc6b0d203739f40aa41))
+* accept Uint8Array where Buffer is accepted ([#432](https://github.com/mongodb/js-bson/issues/432)) ([4613763](https://github.com/mongodb/js-bson/commit/46137636ac8e59010ba3bfdd317d5d13d9d3066d))
+* clean up instanceof usage ([9b6d52a](https://github.com/mongodb/js-bson/commit/9b6d52a84a20641b22732355e56c3bae3fe857f1))
+* improve ArrayBuffer brand check in ensureBuffer ([#429](https://github.com/mongodb/js-bson/issues/429)) ([99722f6](https://github.com/mongodb/js-bson/commit/99722f66d9f5eeb0ab57e74bab26049a425fa3e8))
+
+## [4.3.0](https://github.com/mongodb/js-bson/compare/v4.2.3...v4.3.0) (2021-04-06)
+
+
+### Features
+
+* UUID convenience class ([#425](https://github.com/mongodb/js-bson/issues/425)) ([76e1826](https://github.com/mongodb/js-bson/commit/76e1826eed852d4cca9fafabbcf826af1367c9af))
+
+### [4.2.3](https://github.com/mongodb/js-bson/compare/v4.2.2...v4.2.3) (2021-03-02)
+
+
+### Bug Fixes
+
+* allow library to be loaded in web workeds ([#423](https://github.com/mongodb/js-bson/issues/423)) ([023f57e](https://github.com/mongodb/js-bson/commit/5ae057d3c6dd87e1407dcdc7b8d9da668023f57e))
+
+* make inspection result of BSON types evaluable ([#416](https://github.com/mongodb/js-bson/issues/416)) ([616665f](https://github.com/mongodb/js-bson/commit/616665f5e6f7dd06a88de450aaccaa203fa6c652))
+* permit BSON types to be created without new ([#424](https://github.com/mongodb/js-bson/issues/424)) ([d2bc284](https://github.com/mongodb/js-bson/commit/d2bc284943649ac27116701a4ed91ff731a4bdf7))
+
 ### [4.2.2](https://github.com/mongodb/js-bson/compare/v4.2.1...v4.2.2) (2020-12-01)
 
 

package/bower.json

@@ -22,5 +22,5 @@
     "test",
     "tools"
   ],
-  "version": "4.2.2"
+  "version": "4.4.1"
 }

package/bson.d.ts

@@ -62,6 +62,7 @@ export declare class Binary {
     /* Excluded from this release type: toJSON */
     /* Excluded from this release type: toString */
     /* Excluded from this release type: toExtendedJSON */
+    /* Excluded from this release type: toUUID */
     /* Excluded from this release type: fromExtendedJSON */
     inspect(): string;
 }
@@ -95,6 +96,7 @@ declare const BSON: {
     Double: typeof Double;
     Int32: typeof Int32;
     Long: typeof Long;
+    UUID: typeof UUID;
     Map: MapConstructor;
     MaxKey: typeof MaxKey;
     MinKey: typeof MinKey;
@@ -258,8 +260,11 @@ export declare interface DBRefLike {
 export declare class Decimal128 {
     _bsontype: 'Decimal128';
     readonly bytes: Buffer;
-    /** @param bytes - a buffer containing the raw Decimal128 bytes in little endian order */
-    constructor(bytes: Buffer);
+    /**
+     * @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);
     /**
      * Create a Decimal128 instance from a string representation
      *
@@ -463,6 +468,7 @@ export declare interface Int32Extended {
     $numberInt: string;
 }
 declare const kId: unique symbol;
+declare const kId_2: unique symbol;
 /**
  * A class representing a 64-bit integer
  * @public
@@ -500,11 +506,17 @@ export declare class Long {
     /**
      * Constructs a 64 bit two's-complement integer, given its low and high 32 bit values as *signed* integers.
      *  See the from* functions below for more convenient ways of constructing Longs.
+     *
+     * Acceptable signatures are:
+     * - Long(low, high, unsigned?)
+     * - Long(bigint, unsigned?)
+     * - Long(string, unsigned?)
+     *
      * @param low - The low (signed) 32 bits of the long
      * @param high - The high (signed) 32 bits of the long
      * @param unsigned - Whether unsigned or not, defaults to signed
      */
-    constructor(low?: number, high?: number, unsigned?: boolean);
+    constructor(low?: number | bigint | string, high?: number | boolean, unsigned?: boolean);
     static TWO_PWR_24: Long;
     /** Maximum unsigned value. */
     static MAX_UNSIGNED_VALUE: Long;
@@ -790,6 +802,7 @@ export { Map_2 as Map };
  */
 export declare class MaxKey {
     _bsontype: 'MaxKey';
+    constructor();
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
     inspect(): string;
@@ -804,6 +817,7 @@ export declare interface MaxKeyExtended {
  */
 export declare class MinKey {
     _bsontype: 'MinKey';
+    constructor();
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
     inspect(): string;
@@ -875,7 +889,7 @@ declare class ObjectId {
      *
      * @param id - ObjectId instance to validate.
      */
-    static isValid(id: number | string | ObjectId | Buffer | ObjectIdLike): boolean;
+    static isValid(id: number | string | ObjectId | Uint8Array | ObjectIdLike): boolean;
     /* Excluded from this release type: toExtendedJSON */
     /* Excluded from this release type: fromExtendedJSON */
     inspect(): string;
@@ -941,6 +955,7 @@ export declare class Timestamp extends LongWithoutOverridesClass {
      * @param low - the low (signed) 32 bits of the Timestamp.
      * @param high - the high (signed) 32 bits of the Timestamp.
      */
+    constructor(low: Long);
     constructor(low: number, high: number);
     toJSON(): {
         $timestamp: string;
@@ -976,8 +991,64 @@ export declare interface TimestampExtended {
 }
 /** @public */
 export declare type TimestampOverrides = '_bsontype' | 'toExtendedJSON' | 'fromExtendedJSON' | 'inspect';
+/**
+ * A class representation of the BSON UUID type.
+ * @public
+ */
+export declare class UUID {
+    _bsontype: 'UUID';
+    static cacheHexString: boolean;
+    /* Excluded from this release type: [kId] */
+    /* Excluded from this release type: __id */
+    /**
+     * Create an UUID type
+     *
+     * @param input - Can be a 32 or 36 character hex string (dashes excluded/included) or a 16 byte binary Buffer.
+     */
+    constructor(input?: string | Buffer | UUID);
+    /*
+    * The UUID bytes
+    * @readonly
+    */
+    id: Buffer;
+    /**
+     * 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.
+     * */
+    toHexString(includeDashes?: boolean): string;
+    /* Excluded from this release type: toString */
+    /* Excluded from this release type: toJSON */
+    /**
+     * Compares the equality of this UUID with `otherID`.
+     *
+     * @param otherId - UUID instance to compare against.
+     */
+    equals(otherId: string | Buffer | UUID): boolean;
+    /**
+     * Creates a Binary instance from the current UUID.
+     */
+    toBinary(): Binary;
+    /**
+     * Generates a populated buffer containing a v4 uuid
+     */
+    static generate(): Buffer;
+    /**
+     * Checks if a value is a valid bson UUID
+     * @param input - UUID, string or Buffer to validate.
+     */
+    static isValid(input: string | Buffer | UUID): boolean;
+    /**
+     * Creates an UUID from a hex string representation of an UUID.
+     * @param hexString - 32 or 36 character hex string (dashes excluded/included).
+     */
+    static createFromHexString(hexString: string): UUID;
+    inspect(): string;
+}
 /** @public */
-export declare interface UUIDExtended {
+export declare type UUIDExtended = {
     $uuid: string;
-}
+};
 export {};