bson 6.3.0 → 6.5.0

package/bson.d.ts

@@ -24,6 +24,8 @@ export declare class Binary extends BSONValue {
     static readonly SUBTYPE_ENCRYPTED = 6;
     /** Column BSON type */
     static readonly SUBTYPE_COLUMN = 7;
+    /** Sensitive BSON type */
+    static readonly SUBTYPE_SENSITIVE = 8;
     /** User BSON type */
     static readonly SUBTYPE_USER_DEFINED = 128;
     buffer: Uint8Array;
@@ -140,12 +142,25 @@ declare namespace BSON {
         BSONRuntimeError,
         BSONType,
         EJSON,
+        onDemand,
         Document,
         CalculateObjectSizeOptions
     }
 }
 export { BSON }
 
+/**
+ * @public
+ * @experimental
+ */
+declare type BSONElement = [
+type: number,
+nameOffset: number,
+nameLength: number,
+offset: number,
+length: number
+];
+
 /**
  * @public
  * @category Error
@@ -172,6 +187,21 @@ export declare class BSONError extends Error {
     static isBSONError(value: unknown): value is BSONError;
 }
 
+/**
+ * @public
+ * @category Error
+ *
+ * @experimental
+ *
+ * An error generated when BSON bytes are invalid.
+ * Reports the offset the parser was able to reach before encountering the error.
+ */
+declare class BSONOffsetError extends BSONError {
+    get name(): 'BSONOffsetError';
+    offset: number;
+    constructor(message: string, offset: number);
+}
+
 /**
  * A class representation of the BSON RegExp type.
  * @public
@@ -619,8 +649,6 @@ export declare interface Int32Extended {
     $numberInt: string;
 }
 
-declare const kId: unique symbol;
-
 /**
  * A class representing a 64-bit integer
  * @public
@@ -993,7 +1021,7 @@ export declare class ObjectId extends BSONValue {
     get _bsontype(): 'ObjectId';
     /* Excluded from this release type: index */
     static cacheHexString: boolean;
-    /* Excluded from this release type: [kId] */
+    /* Excluded from this release type: buffer */
     /* Excluded from this release type: __id */
     /**
      * Create ObjectId from a number.
@@ -1066,6 +1094,7 @@ export declare class ObjectId extends BSONValue {
     /** Returns the generation date (accurate up to the second) that this ID was generated. */
     getTimestamp(): Date;
     /* Excluded from this release type: createPk */
+    /* Excluded from this release type: serializeInto */
     /**
      * Creates an ObjectId from a second based number, with the rest of the ObjectId zeroed out. Used for comparisons or sorting the ObjectId.
      *
@@ -1107,6 +1136,26 @@ export declare interface ObjectIdLike {
     toHexString(): string;
 }
 
+/**
+ * @experimental
+ * @public
+ *
+ * A new set of BSON APIs that are currently experimental and not intended for production use.
+ */
+declare type OnDemand = {
+    BSONOffsetError: {
+        new (message: string, offset: number): BSONOffsetError;
+        isBSONError(value: unknown): value is BSONError;
+    };
+    parseToElements: (this: void, bytes: Uint8Array, startOffset?: number) => Iterable<BSONElement>;
+};
+
+/**
+ * @experimental
+ * @public
+ */
+export declare const onDemand: OnDemand;
+
 /**
  * Parse an Extended JSON string, constructing the JavaScript value or object described by that
  * string.