bson 6.4.1 → 6.5.1

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
@@ -1106,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.

package/lib/bson.bundle.js

@@ -127,6 +127,15 @@ class BSONRuntimeError extends BSONError {
         super(message);
     }
 }
+class BSONOffsetError extends BSONError {
+    get name() {
+        return 'BSONOffsetError';
+    }
+    constructor(message, offset) {
+        super(`${message}. offset: ${offset}`);
+        this.offset = offset;
+    }
+}
 
 const FIRST_BIT = 0x80;
 const FIRST_TWO_BITS = 0xc0;
@@ -608,6 +617,7 @@ Binary.SUBTYPE_UUID = 4;
 Binary.SUBTYPE_MD5 = 5;
 Binary.SUBTYPE_ENCRYPTED = 6;
 Binary.SUBTYPE_COLUMN = 7;
+Binary.SUBTYPE_SENSITIVE = 8;
 Binary.SUBTYPE_USER_DEFINED = 128;
 const UUID_BYTE_LENGTH = 16;
 const UUID_WITHOUT_DASHES = /^[0-9A-F]{32}$/i;
@@ -4123,6 +4133,104 @@ EJSON.serialize = EJSONserialize;
 EJSON.deserialize = EJSONdeserialize;
 Object.freeze(EJSON);
 
+function getSize(source, offset) {
+    if (source[offset + 3] > 127) {
+        throw new BSONOffsetError('BSON size cannot be negative', offset);
+    }
+    return (source[offset] |
+        (source[offset + 1] << 8) |
+        (source[offset + 2] << 16) |
+        (source[offset + 3] << 24));
+}
+function findNull(bytes, offset) {
+    let nullTerminatorOffset = offset;
+    for (; bytes[nullTerminatorOffset] !== 0x00; nullTerminatorOffset++)
+        ;
+    if (nullTerminatorOffset === bytes.length - 1) {
+        throw new BSONOffsetError('Null terminator not found', offset);
+    }
+    return nullTerminatorOffset;
+}
+function parseToElements(bytes, startOffset = 0) {
+    if (bytes.length < 5) {
+        throw new BSONOffsetError(`Input must be at least 5 bytes, got ${bytes.length} bytes`, startOffset);
+    }
+    const documentSize = getSize(bytes, startOffset);
+    if (documentSize > bytes.length - startOffset) {
+        throw new BSONOffsetError(`Parsed documentSize (${documentSize} bytes) does not match input length (${bytes.length} bytes)`, startOffset);
+    }
+    if (bytes[startOffset + documentSize - 1] !== 0x00) {
+        throw new BSONOffsetError('BSON documents must end in 0x00', startOffset + documentSize);
+    }
+    const elements = [];
+    let offset = startOffset + 4;
+    while (offset <= documentSize + startOffset) {
+        const type = bytes[offset];
+        offset += 1;
+        if (type === 0) {
+            if (offset - startOffset !== documentSize) {
+                throw new BSONOffsetError(`Invalid 0x00 type byte`, offset);
+            }
+            break;
+        }
+        const nameOffset = offset;
+        const nameLength = findNull(bytes, offset) - nameOffset;
+        offset += nameLength + 1;
+        let length;
+        if (type === 1 || type === 18 || type === 9 || type === 17) {
+            length = 8;
+        }
+        else if (type === 16) {
+            length = 4;
+        }
+        else if (type === 7) {
+            length = 12;
+        }
+        else if (type === 19) {
+            length = 16;
+        }
+        else if (type === 8) {
+            length = 1;
+        }
+        else if (type === 10 || type === 6 || type === 127 || type === 255) {
+            length = 0;
+        }
+        else if (type === 11) {
+            length = findNull(bytes, findNull(bytes, offset) + 1) + 1 - offset;
+        }
+        else if (type === 3 || type === 4 || type === 15) {
+            length = getSize(bytes, offset);
+        }
+        else if (type === 2 ||
+            type === 5 ||
+            type === 12 ||
+            type === 13 ||
+            type === 14) {
+            length = getSize(bytes, offset) + 4;
+            if (type === 5) {
+                length += 1;
+            }
+            if (type === 12) {
+                length += 12;
+            }
+        }
+        else {
+            throw new BSONOffsetError(`Invalid 0x${type.toString(16).padStart(2, '0')} type byte`, offset);
+        }
+        if (length > documentSize) {
+            throw new BSONOffsetError('value reports length larger than document', offset);
+        }
+        elements.push([type, nameOffset, nameLength, offset, length]);
+        offset += length;
+    }
+    return elements;
+}
+
+const onDemand = Object.create(null);
+onDemand.parseToElements = parseToElements;
+onDemand.BSONOffsetError = BSONOffsetError;
+Object.freeze(onDemand);
+
 const MAXSIZE = 1024 * 1024 * 17;
 let buffer = ByteUtils.allocate(MAXSIZE);
 function setInternalBufferSize(size) {
@@ -4199,6 +4307,7 @@ UUID: UUID,
 calculateObjectSize: calculateObjectSize,
 deserialize: deserialize,
 deserializeStream: deserializeStream,
+onDemand: onDemand,
 serialize: serialize,
 serializeWithBufferAndIndex: serializeWithBufferAndIndex,
 setInternalBufferSize: setInternalBufferSize
@@ -4228,6 +4337,7 @@ exports.UUID = UUID;
 exports.calculateObjectSize = calculateObjectSize;
 exports.deserialize = deserialize;
 exports.deserializeStream = deserializeStream;
+exports.onDemand = onDemand;
 exports.serialize = serialize;
 exports.serializeWithBufferAndIndex = serializeWithBufferAndIndex;
 exports.setInternalBufferSize = setInternalBufferSize;