bson 4.2.3 → 4.5.0

package/bower.json

@@ -22,5 +22,5 @@
     "test",
     "tools"
   ],
-  "version": "4.2.3"
+  "version": "4.5.0"
 }

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;
@@ -776,7 +788,7 @@ export declare interface LongExtended {
     $numberLong: string;
 }
 /** @public */
-export declare type LongWithoutOverrides = new (low: number | Long, high?: number, unsigned?: boolean) => {
+export declare type LongWithoutOverrides = new (low: unknown, high?: number, unsigned?: boolean) => {
     [P in Exclude<keyof Long, TimestampOverrides>]: Long[P];
 };
 /** @public */
@@ -877,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;
@@ -938,12 +950,19 @@ export declare class Timestamp extends LongWithoutOverridesClass {
     /**
      * @param low - A 64-bit Long representing the Timestamp.
      */
-    constructor(low: Long);
+    constructor(long: Long);
+    /**
+     * @param value - A pair of two values indicating timestamp and increment.
+     */
+    constructor(value: {
+        t: number;
+        i: number;
+    });
     /**
      * @param low - the low (signed) 32 bits of the Timestamp.
      * @param high - the high (signed) 32 bits of the Timestamp.
+     * @deprecated Please use `Timestamp({ t: high, i: low })` or `Timestamp(Long(low, high))` instead.
      */
-    constructor(low: Long);
     constructor(low: number, high: number);
     toJSON(): {
         $timestamp: string;
@@ -979,8 +998,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 {};