mongodb 6.5.0 → 6.6.0

package/lib/cmap/wire_protocol/on_demand/document.js

@@ -0,0 +1,218 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OnDemandDocument = void 0;
+const bson_1 = require("../../../bson");
+/** @internal */
+class OnDemandDocument {
+    constructor(
+    /** BSON bytes, this document begins at offset */
+    bson, 
+    /** The start of the document */
+    offset = 0, 
+    /** If this is an embedded document, indicates if this was a BSON array */
+    isArray = false) {
+        this.bson = bson;
+        this.offset = offset;
+        this.isArray = isArray;
+        /**
+         * Maps JS strings to elements and jsValues for speeding up subsequent lookups.
+         * - If `false` then name does not exist in the BSON document
+         * - If `CachedBSONElement` instance name exists
+         * - If `cache[name].value == null` jsValue has not yet been parsed
+         *   - Null/Undefined values do not get cached because they are zero-length values.
+         */
+        this.cache = Object.create(null);
+        /** Caches the index of elements that have been named */
+        this.indexFound = Object.create(null);
+        this.elements = (0, bson_1.parseToElementsToArray)(this.bson, offset);
+    }
+    /** Only supports basic latin strings */
+    isElementName(name, element) {
+        const nameLength = element[2 /* BSONElementOffset.nameLength */];
+        const nameOffset = element[1 /* BSONElementOffset.nameOffset */];
+        if (name.length !== nameLength)
+            return false;
+        for (let i = 0; i < name.length; i++) {
+            if (this.bson[nameOffset + i] !== name.charCodeAt(i))
+                return false;
+        }
+        return true;
+    }
+    /**
+     * Seeks into the elements array for an element matching the given name.
+     *
+     * @remarks
+     * Caching:
+     * - Caches the existence of a property making subsequent look ups for non-existent properties return immediately
+     * - Caches names mapped to elements to avoid reiterating the array and comparing the name again
+     * - Caches the index at which an element has been found to prevent rechecking against elements already determined to belong to another name
+     *
+     * @param name - a basic latin string name of a BSON element
+     * @returns
+     */
+    getElement(name) {
+        const cachedElement = this.cache[name];
+        if (cachedElement === false)
+            return null;
+        if (cachedElement != null) {
+            return cachedElement;
+        }
+        if (typeof name === 'number') {
+            if (this.isArray) {
+                if (name < this.elements.length) {
+                    const element = this.elements[name];
+                    const cachedElement = { element, value: undefined };
+                    this.cache[name] = cachedElement;
+                    this.indexFound[name] = true;
+                    return cachedElement;
+                }
+                else {
+                    return null;
+                }
+            }
+            else {
+                return null;
+            }
+        }
+        for (let index = 0; index < this.elements.length; index++) {
+            const element = this.elements[index];
+            // skip this element if it has already been associated with a name
+            if (!this.indexFound[index] && this.isElementName(name, element)) {
+                const cachedElement = { element, value: undefined };
+                this.cache[name] = cachedElement;
+                this.indexFound[index] = true;
+                return cachedElement;
+            }
+        }
+        this.cache[name] = false;
+        return null;
+    }
+    toJSValue(element, as) {
+        const type = element[0 /* BSONElementOffset.type */];
+        const offset = element[3 /* BSONElementOffset.offset */];
+        const length = element[4 /* BSONElementOffset.length */];
+        if (as !== type) {
+            return null;
+        }
+        switch (as) {
+            case bson_1.BSONType.null:
+            case bson_1.BSONType.undefined:
+                return null;
+            case bson_1.BSONType.double:
+                return (0, bson_1.getFloat64LE)(this.bson, offset);
+            case bson_1.BSONType.int:
+                return (0, bson_1.getInt32LE)(this.bson, offset);
+            case bson_1.BSONType.long:
+                return (0, bson_1.getBigInt64LE)(this.bson, offset);
+            case bson_1.BSONType.bool:
+                return Boolean(this.bson[offset]);
+            case bson_1.BSONType.objectId:
+                return new bson_1.ObjectId(this.bson.subarray(offset, offset + 12));
+            case bson_1.BSONType.timestamp:
+                return new bson_1.Timestamp((0, bson_1.getBigInt64LE)(this.bson, offset));
+            case bson_1.BSONType.string:
+                return (0, bson_1.toUTF8)(this.bson, offset + 4, offset + length - 1, false);
+            case bson_1.BSONType.binData: {
+                const totalBinarySize = (0, bson_1.getInt32LE)(this.bson, offset);
+                const subType = this.bson[offset + 4];
+                if (subType === 2) {
+                    const subType2BinarySize = (0, bson_1.getInt32LE)(this.bson, offset + 1 + 4);
+                    if (subType2BinarySize < 0)
+                        throw new bson_1.BSONError('Negative binary type element size found for subtype 0x02');
+                    if (subType2BinarySize > totalBinarySize - 4)
+                        throw new bson_1.BSONError('Binary type with subtype 0x02 contains too long binary size');
+                    if (subType2BinarySize < totalBinarySize - 4)
+                        throw new bson_1.BSONError('Binary type with subtype 0x02 contains too short binary size');
+                    return new bson_1.Binary(this.bson.subarray(offset + 1 + 4 + 4, offset + 1 + 4 + 4 + subType2BinarySize), 2);
+                }
+                return new bson_1.Binary(this.bson.subarray(offset + 1 + 4, offset + 1 + 4 + totalBinarySize), subType);
+            }
+            case bson_1.BSONType.date:
+                // Pretend this is correct.
+                return new Date(Number((0, bson_1.getBigInt64LE)(this.bson, offset)));
+            case bson_1.BSONType.object:
+                return new OnDemandDocument(this.bson, offset);
+            case bson_1.BSONType.array:
+                return new OnDemandDocument(this.bson, offset, true);
+            default:
+                throw new bson_1.BSONError(`Unsupported BSON type: ${as}`);
+        }
+    }
+    /**
+     * Returns the number of elements in this BSON document
+     */
+    size() {
+        return this.elements.length;
+    }
+    /**
+     * Checks for the existence of an element by name.
+     *
+     * @remarks
+     * Uses `getElement` with the expectation that will populate caches such that a `has` call
+     * followed by a `getElement` call will not repeat the cost paid by the first look up.
+     *
+     * @param name - element name
+     */
+    has(name) {
+        const cachedElement = this.cache[name];
+        if (cachedElement === false)
+            return false;
+        if (cachedElement != null)
+            return true;
+        return this.getElement(name) != null;
+    }
+    get(name, as, required) {
+        const element = this.getElement(name);
+        if (element == null) {
+            if (required === true) {
+                throw new bson_1.BSONError(`BSON element "${name}" is missing`);
+            }
+            else {
+                return null;
+            }
+        }
+        if (element.value == null) {
+            const value = this.toJSValue(element.element, as);
+            if (value == null) {
+                if (required === true) {
+                    throw new bson_1.BSONError(`BSON element "${name}" is missing`);
+                }
+                else {
+                    return null;
+                }
+            }
+            // It is important to never store null
+            element.value = value;
+        }
+        return element.value;
+    }
+    getNumber(name, required) {
+        const maybeBool = this.get(name, bson_1.BSONType.bool);
+        const bool = maybeBool == null ? null : maybeBool ? 1 : 0;
+        const maybeLong = this.get(name, bson_1.BSONType.long);
+        const long = maybeLong == null ? null : Number(maybeLong);
+        const result = bool ?? long ?? this.get(name, bson_1.BSONType.int) ?? this.get(name, bson_1.BSONType.double);
+        if (required === true && result == null) {
+            throw new bson_1.BSONError(`BSON element "${name}" is missing`);
+        }
+        return result;
+    }
+    /**
+     * Deserialize this object, DOES NOT cache result so avoid multiple invocations
+     * @param options - BSON deserialization options
+     */
+    toObject(options) {
+        return bson_1.BSON.deserialize(this.bson, {
+            ...options,
+            index: this.offset,
+            allowObjectSmallerThanBufferSize: true
+        });
+    }
+    /** Returns this document's bytes only */
+    toBytes() {
+        const size = (0, bson_1.getInt32LE)(this.bson, this.offset);
+        return this.bson.subarray(this.offset, this.offset + size);
+    }
+}
+exports.OnDemandDocument = OnDemandDocument;
+//# sourceMappingURL=document.js.map

package/lib/cmap/wire_protocol/on_demand/document.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"document.js","sourceRoot":"","sources":["../../../../src/cmap/wire_protocol/on_demand/document.ts"],"names":[],"mappings":";;;AAAA,wCAcuB;AA+BvB,gBAAgB;AAChB,MAAa,gBAAgB;IAgB3B;IACE,iDAAiD;IAC9B,IAAgB;IACnC,gCAAgC;IACf,SAAS,CAAC;IAC3B,0EAA0E;IAC1D,UAAU,KAAK;QAJZ,SAAI,GAAJ,IAAI,CAAY;QAElB,WAAM,GAAN,MAAM,CAAI;QAEX,YAAO,GAAP,OAAO,CAAQ;QArBjC;;;;;;WAMG;QACc,UAAK,GACpB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACtB,wDAAwD;QACvC,eAAU,GAA4B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAazE,IAAI,CAAC,QAAQ,GAAG,IAAA,6BAAsB,EAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC5D,CAAC;IAED,wCAAwC;IAChC,aAAa,CAAC,IAAY,EAAE,OAAoB;QACtD,MAAM,UAAU,GAAG,OAAO,sCAA8B,CAAC;QACzD,MAAM,UAAU,GAAG,OAAO,sCAA8B,CAAC;QAEzD,IAAI,IAAI,CAAC,MAAM,KAAK,UAAU;YAAE,OAAO,KAAK,CAAC;QAE7C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YACpC,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,KAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC;gBAAE,OAAO,KAAK,CAAC;SACpE;QAED,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;;;;;;;OAWG;IACK,UAAU,CAAC,IAAqB;QACtC,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,aAAa,KAAK,KAAK;YAAE,OAAO,IAAI,CAAC;QAEzC,IAAI,aAAa,IAAI,IAAI,EAAE;YACzB,OAAO,aAAa,CAAC;SACtB;QAED,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE;YAC5B,IAAI,IAAI,CAAC,OAAO,EAAE;gBAChB,IAAI,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE;oBAC/B,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;oBACpC,MAAM,aAAa,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;oBACpD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC;oBACjC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;oBAC7B,OAAO,aAAa,CAAC;iBACtB;qBAAM;oBACL,OAAO,IAAI,CAAC;iBACb;aACF;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;SACF;QAED,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YACzD,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YAErC,kEAAkE;YAClE,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,OAAO,CAAC,EAAE;gBAChE,MAAM,aAAa,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;gBACpD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,aAAa,CAAC;gBACjC,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC;gBAC9B,OAAO,aAAa,CAAC;aACtB;SACF;QAED,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IAcO,SAAS,CAAC,OAAoB,EAAE,EAAkB;QACxD,MAAM,IAAI,GAAG,OAAO,gCAAwB,CAAC;QAC7C,MAAM,MAAM,GAAG,OAAO,kCAA0B,CAAC;QACjD,MAAM,MAAM,GAAG,OAAO,kCAA0B,CAAC;QAEjD,IAAI,EAAE,KAAK,IAAI,EAAE;YACf,OAAO,IAAI,CAAC;SACb;QAED,QAAQ,EAAE,EAAE;YACV,KAAK,eAAQ,CAAC,IAAI,CAAC;YACnB,KAAK,eAAQ,CAAC,SAAS;gBACrB,OAAO,IAAI,CAAC;YACd,KAAK,eAAQ,CAAC,MAAM;gBAClB,OAAO,IAAA,mBAAY,EAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACzC,KAAK,eAAQ,CAAC,GAAG;gBACf,OAAO,IAAA,iBAAU,EAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACvC,KAAK,eAAQ,CAAC,IAAI;gBAChB,OAAO,IAAA,oBAAa,EAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YAC1C,KAAK,eAAQ,CAAC,IAAI;gBAChB,OAAO,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;YACpC,KAAK,eAAQ,CAAC,QAAQ;gBACpB,OAAO,IAAI,eAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,GAAG,EAAE,CAAC,CAAC,CAAC;YAC/D,KAAK,eAAQ,CAAC,SAAS;gBACrB,OAAO,IAAI,gBAAS,CAAC,IAAA,oBAAa,EAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;YACzD,KAAK,eAAQ,CAAC,MAAM;gBAClB,OAAO,IAAA,aAAM,EAAC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;YACnE,KAAK,eAAQ,CAAC,OAAO,CAAC,CAAC;gBACrB,MAAM,eAAe,GAAG,IAAA,iBAAU,EAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBACtD,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;gBAEtC,IAAI,OAAO,KAAK,CAAC,EAAE;oBACjB,MAAM,kBAAkB,GAAG,IAAA,iBAAU,EAAC,IAAI,CAAC,IAAI,EAAE,MAAM,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;oBACjE,IAAI,kBAAkB,GAAG,CAAC;wBACxB,MAAM,IAAI,gBAAS,CAAC,0DAA0D,CAAC,CAAC;oBAClF,IAAI,kBAAkB,GAAG,eAAe,GAAG,CAAC;wBAC1C,MAAM,IAAI,gBAAS,CAAC,6DAA6D,CAAC,CAAC;oBACrF,IAAI,kBAAkB,GAAG,eAAe,GAAG,CAAC;wBAC1C,MAAM,IAAI,gBAAS,CAAC,8DAA8D,CAAC,CAAC;oBACtF,OAAO,IAAI,aAAM,CACf,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,kBAAkB,CAAC,EAC/E,CAAC,CACF,CAAC;iBACH;gBAED,OAAO,IAAI,aAAM,CACf,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,EACpE,OAAO,CACR,CAAC;aACH;YACD,KAAK,eAAQ,CAAC,IAAI;gBAChB,2BAA2B;gBAC3B,OAAO,IAAI,IAAI,CAAC,MAAM,CAAC,IAAA,oBAAa,EAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC;YAE5D,KAAK,eAAQ,CAAC,MAAM;gBAClB,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;YACjD,KAAK,eAAQ,CAAC,KAAK;gBACjB,OAAO,IAAI,gBAAgB,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;YAEvD;gBACE,MAAM,IAAI,gBAAS,CAAC,0BAA0B,EAAE,EAAE,CAAC,CAAC;SACvD;IACH,CAAC;IAED;;OAEG;IACI,IAAI;QACT,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED;;;;;;;;OAQG;IACI,GAAG,CAAC,IAAY;QACrB,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;QACvC,IAAI,aAAa,KAAK,KAAK;YAAE,OAAO,KAAK,CAAC;QAC1C,IAAI,aAAa,IAAI,IAAI;YAAE,OAAO,IAAI,CAAC;QACvC,OAAO,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC;IACvC,CAAC;IAuBM,GAAG,CACR,IAAqB,EACrB,EAAK,EACL,QAAkB;QAElB,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,OAAO,IAAI,IAAI,EAAE;YACnB,IAAI,QAAQ,KAAK,IAAI,EAAE;gBACrB,MAAM,IAAI,gBAAS,CAAC,iBAAiB,IAAI,cAAc,CAAC,CAAC;aAC1D;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;SACF;QAED,IAAI,OAAO,CAAC,KAAK,IAAI,IAAI,EAAE;YACzB,MAAM,KAAK,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAClD,IAAI,KAAK,IAAI,IAAI,EAAE;gBACjB,IAAI,QAAQ,KAAK,IAAI,EAAE;oBACrB,MAAM,IAAI,gBAAS,CAAC,iBAAiB,IAAI,cAAc,CAAC,CAAC;iBAC1D;qBAAM;oBACL,OAAO,IAAI,CAAC;iBACb;aACF;YACD,sCAAsC;YACtC,OAAO,CAAC,KAAK,GAAG,KAAK,CAAC;SACvB;QAED,OAAO,OAAO,CAAC,KAAK,CAAC;IACvB,CAAC;IAiBM,SAAS,CAAC,IAAY,EAAE,QAAiB;QAC9C,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,eAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,IAAI,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAE1D,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,eAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,IAAI,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAE1D,MAAM,MAAM,GAAG,IAAI,IAAI,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,eAAQ,CAAC,GAAG,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,eAAQ,CAAC,MAAM,CAAC,CAAC;QAE/F,IAAI,QAAQ,KAAK,IAAI,IAAI,MAAM,IAAI,IAAI,EAAE;YACvC,MAAM,IAAI,gBAAS,CAAC,iBAAiB,IAAI,cAAc,CAAC,CAAC;SAC1D;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;OAGG;IACI,QAAQ,CAAC,OAA8B;QAC5C,OAAO,WAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,EAAE;YACjC,GAAG,OAAO;YACV,KAAK,EAAE,IAAI,CAAC,MAAM;YAClB,gCAAgC,EAAE,IAAI;SACvC,CAAC,CAAC;IACL,CAAC;IAED,yCAAyC;IACzC,OAAO;QACL,MAAM,IAAI,GAAG,IAAA,iBAAU,EAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;QAChD,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAC7D,CAAC;CACF;AAnSD,4CAmSC"}

package/lib/cmap/wire_protocol/responses.js

@@ -0,0 +1,184 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CursorResponse = exports.MongoDBResponse = exports.isErrorResponse = void 0;
+const bson_1 = require("../../bson");
+const error_1 = require("../../error");
+const utils_1 = require("../../utils");
+const document_1 = require("./on_demand/document");
+/**
+ * Accepts a BSON payload and checks for na "ok: 0" element.
+ * This utility is intended to prevent calling response class constructors
+ * that expect the result to be a success and demand certain properties to exist.
+ *
+ * For example, a cursor response always expects a cursor embedded document.
+ * In order to write the class such that the properties reflect that assertion (non-null)
+ * we cannot invoke the subclass constructor if the BSON represents an error.
+ *
+ * @param bytes - BSON document returned from the server
+ */
+function isErrorResponse(bson) {
+    const elements = (0, bson_1.parseToElementsToArray)(bson, 0);
+    for (let eIdx = 0; eIdx < elements.length; eIdx++) {
+        const element = elements[eIdx];
+        if (element[2 /* BSONElementOffset.nameLength */] === 2) {
+            const nameOffset = element[1 /* BSONElementOffset.nameOffset */];
+            // 111 == "o", 107 == "k"
+            if (bson[nameOffset] === 111 && bson[nameOffset + 1] === 107) {
+                const valueOffset = element[3 /* BSONElementOffset.offset */];
+                const valueLength = element[4 /* BSONElementOffset.length */];
+                // If any byte in the length of the ok number (works for any type) is non zero,
+                // then it is considered "ok: 1"
+                for (let i = valueOffset; i < valueOffset + valueLength; i++) {
+                    if (bson[i] !== 0x00)
+                        return false;
+                }
+                return true;
+            }
+        }
+    }
+    return true;
+}
+exports.isErrorResponse = isErrorResponse;
+/** @internal */
+class MongoDBResponse extends document_1.OnDemandDocument {
+    static is(value) {
+        return value instanceof MongoDBResponse;
+    }
+    /** Indicates this document is a server error */
+    get isError() {
+        let isError = this.ok === 0;
+        isError ||= this.has('errmsg');
+        isError ||= this.has('code');
+        isError ||= this.has('$err'); // The '$err' field is used in OP_REPLY responses
+        return isError;
+    }
+    /**
+     * Drivers can safely assume that the `recoveryToken` field is always a BSON document but drivers MUST NOT modify the
+     * contents of the document.
+     */
+    get recoveryToken() {
+        return (this.get('recoveryToken', bson_1.BSONType.object)?.toObject({
+            promoteValues: false,
+            promoteLongs: false,
+            promoteBuffers: false
+        }) ?? null);
+    }
+    /**
+     * The server creates a cursor in response to a snapshot find/aggregate command and reports atClusterTime within the cursor field in the response.
+     * For the distinct command the server adds a top-level atClusterTime field to the response.
+     * The atClusterTime field represents the timestamp of the read and is guaranteed to be majority committed.
+     */
+    get atClusterTime() {
+        return (this.get('cursor', bson_1.BSONType.object)?.get('atClusterTime', bson_1.BSONType.timestamp) ??
+            this.get('atClusterTime', bson_1.BSONType.timestamp));
+    }
+    get operationTime() {
+        return this.get('operationTime', bson_1.BSONType.timestamp);
+    }
+    get ok() {
+        return this.getNumber('ok') ? 1 : 0;
+    }
+    get $err() {
+        return this.get('$err', bson_1.BSONType.string);
+    }
+    get errmsg() {
+        return this.get('errmsg', bson_1.BSONType.string);
+    }
+    get code() {
+        return this.getNumber('code');
+    }
+    get $clusterTime() {
+        if (!('clusterTime' in this)) {
+            const clusterTimeDoc = this.get('$clusterTime', bson_1.BSONType.object);
+            if (clusterTimeDoc == null) {
+                this.clusterTime = null;
+                return null;
+            }
+            const clusterTime = clusterTimeDoc.get('clusterTime', bson_1.BSONType.timestamp, true);
+            const signature = clusterTimeDoc.get('signature', bson_1.BSONType.object)?.toObject();
+            // @ts-expect-error: `signature` is incorrectly typed. It is public API.
+            this.clusterTime = { clusterTime, signature };
+        }
+        return this.clusterTime ?? null;
+    }
+    toObject(options) {
+        const exactBSONOptions = {
+            useBigInt64: options?.useBigInt64,
+            promoteLongs: options?.promoteLongs,
+            promoteValues: options?.promoteValues,
+            promoteBuffers: options?.promoteBuffers,
+            bsonRegExp: options?.bsonRegExp,
+            raw: options?.raw ?? false,
+            fieldsAsRaw: options?.fieldsAsRaw ?? {},
+            validation: this.parseBsonSerializationOptions(options)
+        };
+        return super.toObject(exactBSONOptions);
+    }
+    parseBsonSerializationOptions(options) {
+        const enableUtf8Validation = options?.enableUtf8Validation;
+        if (enableUtf8Validation === false) {
+            return { utf8: false };
+        }
+        return { utf8: { writeErrors: false } };
+    }
+}
+// {ok:1}
+MongoDBResponse.empty = new MongoDBResponse(new Uint8Array([13, 0, 0, 0, 16, 111, 107, 0, 1, 0, 0, 0, 0]));
+exports.MongoDBResponse = MongoDBResponse;
+/** @internal */
+class CursorResponse extends MongoDBResponse {
+    static is(value) {
+        return value instanceof CursorResponse || value === CursorResponse.emptyGetMore;
+    }
+    constructor(bytes, offset, isArray) {
+        super(bytes, offset, isArray);
+        this.ns = null;
+        this.batchSize = 0;
+        this.iterated = 0;
+        const cursor = this.get('cursor', bson_1.BSONType.object, true);
+        const id = cursor.get('id', bson_1.BSONType.long, true);
+        this.id = new bson_1.Long(Number(id & 0xffffffffn), Number((id >> 32n) & 0xffffffffn));
+        const namespace = cursor.get('ns', bson_1.BSONType.string);
+        if (namespace != null)
+            this.ns = (0, utils_1.ns)(namespace);
+        if (cursor.has('firstBatch'))
+            this.batch = cursor.get('firstBatch', bson_1.BSONType.array, true);
+        else if (cursor.has('nextBatch'))
+            this.batch = cursor.get('nextBatch', bson_1.BSONType.array, true);
+        else
+            throw new error_1.MongoUnexpectedServerResponseError('Cursor document did not contain a batch');
+        this.batchSize = this.batch.size();
+    }
+    get length() {
+        return Math.max(this.batchSize - this.iterated, 0);
+    }
+    shift(options) {
+        if (this.iterated >= this.batchSize) {
+            return null;
+        }
+        const result = this.batch.get(this.iterated, bson_1.BSONType.object, true) ?? null;
+        this.iterated += 1;
+        if (options?.raw) {
+            return result.toBytes();
+        }
+        else {
+            return result.toObject(options);
+        }
+    }
+    clear() {
+        this.iterated = this.batchSize;
+    }
+    pushMany() {
+        throw new Error('pushMany Unsupported method');
+    }
+    push() {
+        throw new Error('push Unsupported method');
+    }
+}
+/**
+ * This supports a feature of the FindCursor.
+ * It is an optimization to avoid an extra getMore when the limit has been reached
+ */
+CursorResponse.emptyGetMore = { id: new bson_1.Long(0), length: 0, shift: () => null };
+exports.CursorResponse = CursorResponse;
+//# sourceMappingURL=responses.js.map

package/lib/cmap/wire_protocol/responses.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"responses.js","sourceRoot":"","sources":["../../../src/cmap/wire_protocol/responses.ts"],"names":[],"mappings":";;;AAAA,qCAOoB;AACpB,uCAAiE;AAEjE,uCAAwD;AACxD,mDAAwD;AAUxD;;;;;;;;;;GAUG;AACH,SAAgB,eAAe,CAAC,IAAgB;IAC9C,MAAM,QAAQ,GAAG,IAAA,6BAAsB,EAAC,IAAI,EAAE,CAAC,CAAC,CAAC;IACjD,KAAK,IAAI,IAAI,GAAG,CAAC,EAAE,IAAI,GAAG,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,EAAE;QACjD,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;QAE/B,IAAI,OAAO,sCAA8B,KAAK,CAAC,EAAE;YAC/C,MAAM,UAAU,GAAG,OAAO,sCAA8B,CAAC;YAEzD,yBAAyB;YACzB,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,GAAG,IAAI,IAAI,CAAC,UAAU,GAAG,CAAC,CAAC,KAAK,GAAG,EAAE;gBAC5D,MAAM,WAAW,GAAG,OAAO,kCAA0B,CAAC;gBACtD,MAAM,WAAW,GAAG,OAAO,kCAA0B,CAAC;gBAEtD,+EAA+E;gBAC/E,gCAAgC;gBAChC,KAAK,IAAI,CAAC,GAAG,WAAW,EAAE,CAAC,GAAG,WAAW,GAAG,WAAW,EAAE,CAAC,EAAE,EAAE;oBAC5D,IAAI,IAAI,CAAC,CAAC,CAAC,KAAK,IAAI;wBAAE,OAAO,KAAK,CAAC;iBACpC;gBAED,OAAO,IAAI,CAAC;aACb;SACF;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAzBD,0CAyBC;AAOD,gBAAgB;AAChB,MAAa,eAAgB,SAAQ,2BAAgB;IACnD,MAAM,CAAC,EAAE,CAAC,KAAc;QACtB,OAAO,KAAK,YAAY,eAAe,CAAC;IAC1C,CAAC;IAKD,gDAAgD;IAChD,IAAW,OAAO;QAChB,IAAI,OAAO,GAAG,IAAI,CAAC,EAAE,KAAK,CAAC,CAAC;QAC5B,OAAO,KAAK,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;QAC/B,OAAO,KAAK,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;QAC7B,OAAO,KAAK,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,iDAAiD;QAC/E,OAAO,OAAO,CAAC;IACjB,CAAC;IAED;;;OAGG;IACH,IAAI,aAAa;QACf,OAAO,CACL,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,eAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,CAAC;YACnD,aAAa,EAAE,KAAK;YACpB,YAAY,EAAE,KAAK;YACnB,cAAc,EAAE,KAAK;SACtB,CAAC,IAAI,IAAI,CACX,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,IAAW,aAAa;QACtB,OAAO,CACL,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,eAAQ,CAAC,MAAM,CAAC,EAAE,GAAG,CAAC,eAAe,EAAE,eAAQ,CAAC,SAAS,CAAC;YAC7E,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,eAAQ,CAAC,SAAS,CAAC,CAC9C,CAAC;IACJ,CAAC;IAED,IAAW,aAAa;QACtB,OAAO,IAAI,CAAC,GAAG,CAAC,eAAe,EAAE,eAAQ,CAAC,SAAS,CAAC,CAAC;IACvD,CAAC;IAED,IAAW,EAAE;QACX,OAAO,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;IACtC,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,GAAG,CAAC,MAAM,EAAE,eAAQ,CAAC,MAAM,CAAC,CAAC;IAC3C,CAAC;IAED,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,eAAQ,CAAC,MAAM,CAAC,CAAC;IAC7C,CAAC;IAED,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAChC,CAAC;IAGD,IAAW,YAAY;QACrB,IAAI,CAAC,CAAC,aAAa,IAAI,IAAI,CAAC,EAAE;YAC5B,MAAM,cAAc,GAAG,IAAI,CAAC,GAAG,CAAC,cAAc,EAAE,eAAQ,CAAC,MAAM,CAAC,CAAC;YACjE,IAAI,cAAc,IAAI,IAAI,EAAE;gBAC1B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC;gBACxB,OAAO,IAAI,CAAC;aACb;YACD,MAAM,WAAW,GAAG,cAAc,CAAC,GAAG,CAAC,aAAa,EAAE,eAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;YAChF,MAAM,SAAS,GAAG,cAAc,CAAC,GAAG,CAAC,WAAW,EAAE,eAAQ,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;YAC/E,wEAAwE;YACxE,IAAI,CAAC,WAAW,GAAG,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;SAC/C;QACD,OAAO,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC;IAClC,CAAC;IAEe,QAAQ,CAAC,OAA8B;QACrD,MAAM,gBAAgB,GAAG;YACvB,WAAW,EAAE,OAAO,EAAE,WAAW;YACjC,YAAY,EAAE,OAAO,EAAE,YAAY;YACnC,aAAa,EAAE,OAAO,EAAE,aAAa;YACrC,cAAc,EAAE,OAAO,EAAE,cAAc;YACvC,UAAU,EAAE,OAAO,EAAE,UAAU;YAC/B,GAAG,EAAE,OAAO,EAAE,GAAG,IAAI,KAAK;YAC1B,WAAW,EAAE,OAAO,EAAE,WAAW,IAAI,EAAE;YACvC,UAAU,EAAE,IAAI,CAAC,6BAA6B,CAAC,OAAO,CAAC;SACxD,CAAC;QACF,OAAO,KAAK,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;IAC1C,CAAC;IAEO,6BAA6B,CAAC,OAA4C;QAGhF,MAAM,oBAAoB,GAAG,OAAO,EAAE,oBAAoB,CAAC;QAC3D,IAAI,oBAAoB,KAAK,KAAK,EAAE;YAClC,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;SACxB;QACD,OAAO,EAAE,IAAI,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,EAAE,CAAC;IAC1C,CAAC;;AAhGD,SAAS;AACF,qBAAK,GAAG,IAAI,eAAe,CAAC,IAAI,UAAU,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;AANvF,0CAAe;AAwG5B,gBAAgB;AAChB,MAAa,cAAe,SAAQ,eAAe;IAOjD,MAAM,CAAU,EAAE,CAAC,KAAc;QAC/B,OAAO,KAAK,YAAY,cAAc,IAAI,KAAK,KAAK,cAAc,CAAC,YAAY,CAAC;IAClF,CAAC;IASD,YAAY,KAAiB,EAAE,MAAe,EAAE,OAAiB;QAC/D,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QAPzB,OAAE,GAA4B,IAAI,CAAC;QACnC,cAAS,GAAG,CAAC,CAAC;QAGb,aAAQ,GAAG,CAAC,CAAC;QAKnB,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,eAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAEzD,MAAM,EAAE,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,eAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACjD,IAAI,CAAC,EAAE,GAAG,IAAI,WAAI,CAAC,MAAM,CAAC,EAAE,GAAG,WAAY,CAAC,EAAE,MAAM,CAAC,CAAC,EAAE,IAAI,GAAG,CAAC,GAAG,WAAY,CAAC,CAAC,CAAC;QAElF,MAAM,SAAS,GAAG,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,eAAQ,CAAC,MAAM,CAAC,CAAC;QACpD,IAAI,SAAS,IAAI,IAAI;YAAE,IAAI,CAAC,EAAE,GAAG,IAAA,UAAE,EAAC,SAAS,CAAC,CAAC;QAE/C,IAAI,MAAM,CAAC,GAAG,CAAC,YAAY,CAAC;YAAE,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,YAAY,EAAE,eAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;aACrF,IAAI,MAAM,CAAC,GAAG,CAAC,WAAW,CAAC;YAAE,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,WAAW,EAAE,eAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;;YACxF,MAAM,IAAI,0CAAkC,CAAC,yCAAyC,CAAC,CAAC;QAE7F,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC;IACrC,CAAC;IAED,IAAI,MAAM;QACR,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;IACrD,CAAC;IAED,KAAK,CAAC,OAA8B;QAClC,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,SAAS,EAAE;YACnC,OAAO,IAAI,CAAC;SACb;QAED,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,QAAQ,EAAE,eAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,IAAI,CAAC;QAC5E,IAAI,CAAC,QAAQ,IAAI,CAAC,CAAC;QAEnB,IAAI,OAAO,EAAE,GAAG,EAAE;YAChB,OAAO,MAAM,CAAC,OAAO,EAAE,CAAC;SACzB;aAAM;YACL,OAAO,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC;SACjC;IACH,CAAC;IAED,KAAK;QACH,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC;IACjC,CAAC;IAED,QAAQ;QACN,MAAM,IAAI,KAAK,CAAC,6BAA6B,CAAC,CAAC;IACjD,CAAC;IAED,IAAI;QACF,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAC7C,CAAC;;AAhED;;;GAGG;AACI,2BAAY,GAAG,EAAE,EAAE,EAAE,IAAI,WAAI,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,EAAE,AAApD,CAAqD;AAL7D,wCAAc"}