First commit

node_modules/mongodb/src/cursor/abstract_cursor.ts

@@ -0,0 +1,928 @@
+import { Readable, Transform } from 'stream';
+import { promisify } from 'util';
+
+import { BSONSerializeOptions, Document, Long, pluckBSONSerializeOptions } from '../bson';
+import {
+  AnyError,
+  MongoAPIError,
+  MongoCursorExhaustedError,
+  MongoCursorInUseError,
+  MongoInvalidArgumentError,
+  MongoNetworkError,
+  MongoRuntimeError,
+  MongoTailableCursorError
+} from '../error';
+import type { MongoClient } from '../mongo_client';
+import { TODO_NODE_3286, TypedEventEmitter } from '../mongo_types';
+import { executeOperation, ExecutionResult } from '../operations/execute_operation';
+import { GetMoreOperation } from '../operations/get_more';
+import { KillCursorsOperation } from '../operations/kill_cursors';
+import { ReadConcern, ReadConcernLike } from '../read_concern';
+import { ReadPreference, ReadPreferenceLike } from '../read_preference';
+import type { Server } from '../sdam/server';
+import { ClientSession, maybeClearPinnedConnection } from '../sessions';
+import { Callback, List, MongoDBNamespace, ns } from '../utils';
+
+/** @internal */
+const kId = Symbol('id');
+/** @internal */
+const kDocuments = Symbol('documents');
+/** @internal */
+const kServer = Symbol('server');
+/** @internal */
+const kNamespace = Symbol('namespace');
+/** @internal */
+const kClient = Symbol('client');
+/** @internal */
+const kSession = Symbol('session');
+/** @internal */
+const kOptions = Symbol('options');
+/** @internal */
+const kTransform = Symbol('transform');
+/** @internal */
+const kInitialized = Symbol('initialized');
+/** @internal */
+const kClosed = Symbol('closed');
+/** @internal */
+const kKilled = Symbol('killed');
+/** @internal */
+const kInit = Symbol('kInit');
+
+/** @public */
+export const CURSOR_FLAGS = [
+  'tailable',
+  'oplogReplay',
+  'noCursorTimeout',
+  'awaitData',
+  'exhaust',
+  'partial'
+] as const;
+
+/** @public */
+export interface CursorStreamOptions {
+  /** A transformation method applied to each document emitted by the stream */
+  transform?(this: void, doc: Document): Document;
+}
+
+/** @public */
+export type CursorFlag = (typeof CURSOR_FLAGS)[number];
+
+/** @public */
+export interface AbstractCursorOptions extends BSONSerializeOptions {
+  session?: ClientSession;
+  readPreference?: ReadPreferenceLike;
+  readConcern?: ReadConcernLike;
+  /**
+   * Specifies the number of documents to return in each response from MongoDB
+   */
+  batchSize?: number;
+  /**
+   * When applicable `maxTimeMS` controls the amount of time the initial command
+   * that constructs a cursor should take. (ex. find, aggregate, listCollections)
+   */
+  maxTimeMS?: number;
+  /**
+   * When applicable `maxAwaitTimeMS` controls the amount of time subsequent getMores
+   * that a cursor uses to fetch more data should take. (ex. cursor.next())
+   */
+  maxAwaitTimeMS?: number;
+  /**
+   * Comment to apply to the operation.
+   *
+   * In server versions pre-4.4, 'comment' must be string.  A server
+   * error will be thrown if any other type is provided.
+   *
+   * In server versions 4.4 and above, 'comment' can be any valid BSON type.
+   */
+  comment?: unknown;
+  /**
+   * By default, MongoDB will automatically close a cursor when the
+   * client has exhausted all results in the cursor. However, for [capped collections](https://www.mongodb.com/docs/manual/core/capped-collections)
+   * you may use a Tailable Cursor that remains open after the client exhausts
+   * the results in the initial cursor.
+   */
+  tailable?: boolean;
+  /**
+   * If awaitData is set to true, when the cursor reaches the end of the capped collection,
+   * MongoDB blocks the query thread for a period of time waiting for new data to arrive.
+   * When new data is inserted into the capped collection, the blocked thread is signaled
+   * to wake up and return the next batch to the client.
+   */
+  awaitData?: boolean;
+  noCursorTimeout?: boolean;
+}
+
+/** @internal */
+export type InternalAbstractCursorOptions = Omit<AbstractCursorOptions, 'readPreference'> & {
+  // resolved
+  readPreference: ReadPreference;
+  readConcern?: ReadConcern;
+
+  // cursor flags, some are deprecated
+  oplogReplay?: boolean;
+  exhaust?: boolean;
+  partial?: boolean;
+};
+
+/** @public */
+export type AbstractCursorEvents = {
+  [AbstractCursor.CLOSE](): void;
+};
+
+/** @public */
+export abstract class AbstractCursor<
+  TSchema = any,
+  CursorEvents extends AbstractCursorEvents = AbstractCursorEvents
+> extends TypedEventEmitter<CursorEvents> {
+  /** @internal */
+  [kId]: Long | null;
+  /** @internal */
+  [kSession]: ClientSession;
+  /** @internal */
+  [kServer]?: Server;
+  /** @internal */
+  [kNamespace]: MongoDBNamespace;
+  /** @internal */
+  [kDocuments]: List<TSchema>;
+  /** @internal */
+  [kClient]: MongoClient;
+  /** @internal */
+  [kTransform]?: (doc: TSchema) => any;
+  /** @internal */
+  [kInitialized]: boolean;
+  /** @internal */
+  [kClosed]: boolean;
+  /** @internal */
+  [kKilled]: boolean;
+  /** @internal */
+  [kOptions]: InternalAbstractCursorOptions;
+
+  /** @event */
+  static readonly CLOSE = 'close' as const;
+
+  /** @internal */
+  constructor(
+    client: MongoClient,
+    namespace: MongoDBNamespace,
+    options: AbstractCursorOptions = {}
+  ) {
+    super();
+
+    if (!client.s.isMongoClient) {
+      throw new MongoRuntimeError('Cursor must be constructed with MongoClient');
+    }
+    this[kClient] = client;
+    this[kNamespace] = namespace;
+    this[kId] = null;
+    this[kDocuments] = new List();
+    this[kInitialized] = false;
+    this[kClosed] = false;
+    this[kKilled] = false;
+    this[kOptions] = {
+      readPreference:
+        options.readPreference && options.readPreference instanceof ReadPreference
+          ? options.readPreference
+          : ReadPreference.primary,
+      ...pluckBSONSerializeOptions(options)
+    };
+
+    const readConcern = ReadConcern.fromOptions(options);
+    if (readConcern) {
+      this[kOptions].readConcern = readConcern;
+    }
+
+    if (typeof options.batchSize === 'number') {
+      this[kOptions].batchSize = options.batchSize;
+    }
+
+    // we check for undefined specifically here to allow falsy values
+    // eslint-disable-next-line no-restricted-syntax
+    if (options.comment !== undefined) {
+      this[kOptions].comment = options.comment;
+    }
+
+    if (typeof options.maxTimeMS === 'number') {
+      this[kOptions].maxTimeMS = options.maxTimeMS;
+    }
+
+    if (typeof options.maxAwaitTimeMS === 'number') {
+      this[kOptions].maxAwaitTimeMS = options.maxAwaitTimeMS;
+    }
+
+    if (options.session instanceof ClientSession) {
+      this[kSession] = options.session;
+    } else {
+      this[kSession] = this[kClient].startSession({ owner: this, explicit: false });
+    }
+  }
+
+  get id(): Long | undefined {
+    return this[kId] ?? undefined;
+  }
+
+  /** @internal */
+  get client(): MongoClient {
+    return this[kClient];
+  }
+
+  /** @internal */
+  get server(): Server | undefined {
+    return this[kServer];
+  }
+
+  get namespace(): MongoDBNamespace {
+    return this[kNamespace];
+  }
+
+  get readPreference(): ReadPreference {
+    return this[kOptions].readPreference;
+  }
+
+  get readConcern(): ReadConcern | undefined {
+    return this[kOptions].readConcern;
+  }
+
+  /** @internal */
+  get session(): ClientSession {
+    return this[kSession];
+  }
+
+  set session(clientSession: ClientSession) {
+    this[kSession] = clientSession;
+  }
+
+  /** @internal */
+  get cursorOptions(): InternalAbstractCursorOptions {
+    return this[kOptions];
+  }
+
+  get closed(): boolean {
+    return this[kClosed];
+  }
+
+  get killed(): boolean {
+    return this[kKilled];
+  }
+
+  get loadBalanced(): boolean {
+    return !!this[kClient].topology?.loadBalanced;
+  }
+
+  /** Returns current buffered documents length */
+  bufferedCount(): number {
+    return this[kDocuments].length;
+  }
+
+  /** Returns current buffered documents */
+  readBufferedDocuments(number?: number): TSchema[] {
+    const bufferedDocs: TSchema[] = [];
+    const documentsToRead = Math.min(number ?? this[kDocuments].length, this[kDocuments].length);
+
+    for (let count = 0; count < documentsToRead; count++) {
+      const document = this[kDocuments].shift();
+      if (document != null) {
+        bufferedDocs.push(document);
+      }
+    }
+
+    return bufferedDocs;
+  }
+
+  async *[Symbol.asyncIterator](): AsyncGenerator<TSchema, void, void> {
+    if (this.closed) {
+      return;
+    }
+
+    try {
+      while (true) {
+        const document = await this.next();
+
+        // Intentional strict null check, because users can map cursors to falsey values.
+        // We allow mapping to all values except for null.
+        // eslint-disable-next-line no-restricted-syntax
+        if (document === null) {
+          if (!this.closed) {
+            const message =
+              'Cursor returned a `null` document, but the cursor is not exhausted.  Mapping documents to `null` is not supported in the cursor transform.';
+
+            await cleanupCursorAsync(this, { needsToEmitClosed: true }).catch(() => null);
+
+            throw new MongoAPIError(message);
+          }
+          break;
+        }
+
+        yield document;
+
+        if (this[kId] === Long.ZERO) {
+          // Cursor exhausted
+          break;
+        }
+      }
+    } finally {
+      // Only close the cursor if it has not already been closed. This finally clause handles
+      // the case when a user would break out of a for await of loop early.
+      if (!this.closed) {
+        await this.close().catch(() => null);
+      }
+    }
+  }
+
+  stream(options?: CursorStreamOptions): Readable & AsyncIterable<TSchema> {
+    if (options?.transform) {
+      const transform = options.transform;
+      const readable = new ReadableCursorStream(this);
+
+      return readable.pipe(
+        new Transform({
+          objectMode: true,
+          highWaterMark: 1,
+          transform(chunk, _, callback) {
+            try {
+              const transformed = transform(chunk);
+              callback(undefined, transformed);
+            } catch (err) {
+              callback(err);
+            }
+          }
+        })
+      );
+    }
+
+    return new ReadableCursorStream(this);
+  }
+
+  async hasNext(): Promise<boolean> {
+    if (this[kId] === Long.ZERO) {
+      return false;
+    }
+
+    if (this[kDocuments].length !== 0) {
+      return true;
+    }
+
+    const doc = await nextAsync<TSchema>(this, true);
+
+    if (doc) {
+      this[kDocuments].unshift(doc);
+      return true;
+    }
+
+    return false;
+  }
+
+  /** Get the next available document from the cursor, returns null if no more documents are available. */
+  async next(): Promise<TSchema | null> {
+    if (this[kId] === Long.ZERO) {
+      throw new MongoCursorExhaustedError();
+    }
+
+    return nextAsync(this, true);
+  }
+
+  /**
+   * Try to get the next available document from the cursor or `null` if an empty batch is returned
+   */
+  async tryNext(): Promise<TSchema | null> {
+    if (this[kId] === Long.ZERO) {
+      throw new MongoCursorExhaustedError();
+    }
+
+    return nextAsync(this, false);
+  }
+
+  /**
+   * Iterates over all the documents for this cursor using the iterator, callback pattern.
+   *
+   * If the iterator returns `false`, iteration will stop.
+   *
+   * @param iterator - The iteration callback.
+   * @deprecated - Will be removed in a future release. Use for await...of instead.
+   */
+  async forEach(iterator: (doc: TSchema) => boolean | void): Promise<void> {
+    if (typeof iterator !== 'function') {
+      throw new MongoInvalidArgumentError('Argument "iterator" must be a function');
+    }
+    for await (const document of this) {
+      const result = iterator(document);
+      if (result === false) {
+        break;
+      }
+    }
+  }
+
+  async close(): Promise<void> {
+    const needsToEmitClosed = !this[kClosed];
+    this[kClosed] = true;
+    await cleanupCursorAsync(this, { needsToEmitClosed });
+  }
+
+  /**
+   * Returns an array of documents. The caller is responsible for making sure that there
+   * is enough memory to store the results. Note that the array only contains partial
+   * results when this cursor had been previously accessed. In that case,
+   * cursor.rewind() can be used to reset the cursor.
+   */
+  async toArray(): Promise<TSchema[]> {
+    const array = [];
+    for await (const document of this) {
+      array.push(document);
+    }
+    return array;
+  }
+
+  /**
+   * Add a cursor flag to the cursor
+   *
+   * @param flag - The flag to set, must be one of following ['tailable', 'oplogReplay', 'noCursorTimeout', 'awaitData', 'partial' -.
+   * @param value - The flag boolean value.
+   */
+  addCursorFlag(flag: CursorFlag, value: boolean): this {
+    assertUninitialized(this);
+    if (!CURSOR_FLAGS.includes(flag)) {
+      throw new MongoInvalidArgumentError(`Flag ${flag} is not one of ${CURSOR_FLAGS}`);
+    }
+
+    if (typeof value !== 'boolean') {
+      throw new MongoInvalidArgumentError(`Flag ${flag} must be a boolean value`);
+    }
+
+    this[kOptions][flag] = value;
+    return this;
+  }
+
+  /**
+   * Map all documents using the provided function
+   * If there is a transform set on the cursor, that will be called first and the result passed to
+   * this function's transform.
+   *
+   * @remarks
+   *
+   * **Note** Cursors use `null` internally to indicate that there are no more documents in the cursor. Providing a mapping
+   * function that maps values to `null` will result in the cursor closing itself before it has finished iterating
+   * all documents.  This will **not** result in a memory leak, just surprising behavior.  For example:
+   *
+   * ```typescript
+   * const cursor = collection.find({});
+   * cursor.map(() => null);
+   *
+   * const documents = await cursor.toArray();
+   * // documents is always [], regardless of how many documents are in the collection.
+   * ```
+   *
+   * Other falsey values are allowed:
+   *
+   * ```typescript
+   * const cursor = collection.find({});
+   * cursor.map(() => '');
+   *
+   * const documents = await cursor.toArray();
+   * // documents is now an array of empty strings
+   * ```
+   *
+   * **Note for Typescript Users:** adding a transform changes the return type of the iteration of this cursor,
+   * it **does not** return a new instance of a cursor. This means when calling map,
+   * you should always assign the result to a new variable in order to get a correctly typed cursor variable.
+   * Take note of the following example:
+   *
+   * @example
+   * ```typescript
+   * const cursor: FindCursor<Document> = coll.find();
+   * const mappedCursor: FindCursor<number> = cursor.map(doc => Object.keys(doc).length);
+   * const keyCounts: number[] = await mappedCursor.toArray(); // cursor.toArray() still returns Document[]
+   * ```
+   * @param transform - The mapping transformation method.
+   */
+  map<T = any>(transform: (doc: TSchema) => T): AbstractCursor<T> {
+    assertUninitialized(this);
+    const oldTransform = this[kTransform] as (doc: TSchema) => TSchema; // TODO(NODE-3283): Improve transform typing
+    if (oldTransform) {
+      this[kTransform] = doc => {
+        return transform(oldTransform(doc));
+      };
+    } else {
+      this[kTransform] = transform;
+    }
+
+    return this as unknown as AbstractCursor<T>;
+  }
+
+  /**
+   * Set the ReadPreference for the cursor.
+   *
+   * @param readPreference - The new read preference for the cursor.
+   */
+  withReadPreference(readPreference: ReadPreferenceLike): this {
+    assertUninitialized(this);
+    if (readPreference instanceof ReadPreference) {
+      this[kOptions].readPreference = readPreference;
+    } else if (typeof readPreference === 'string') {
+      this[kOptions].readPreference = ReadPreference.fromString(readPreference);
+    } else {
+      throw new MongoInvalidArgumentError(`Invalid read preference: ${readPreference}`);
+    }
+
+    return this;
+  }
+
+  /**
+   * Set the ReadPreference for the cursor.
+   *
+   * @param readPreference - The new read preference for the cursor.
+   */
+  withReadConcern(readConcern: ReadConcernLike): this {
+    assertUninitialized(this);
+    const resolvedReadConcern = ReadConcern.fromOptions({ readConcern });
+    if (resolvedReadConcern) {
+      this[kOptions].readConcern = resolvedReadConcern;
+    }
+
+    return this;
+  }
+
+  /**
+   * Set a maxTimeMS on the cursor query, allowing for hard timeout limits on queries (Only supported on MongoDB 2.6 or higher)
+   *
+   * @param value - Number of milliseconds to wait before aborting the query.
+   */
+  maxTimeMS(value: number): this {
+    assertUninitialized(this);
+    if (typeof value !== 'number') {
+      throw new MongoInvalidArgumentError('Argument for maxTimeMS must be a number');
+    }
+
+    this[kOptions].maxTimeMS = value;
+    return this;
+  }
+
+  /**
+   * Set the batch size for the cursor.
+   *
+   * @param value - The number of documents to return per batch. See {@link https://www.mongodb.com/docs/manual/reference/command/find/|find command documentation}.
+   */
+  batchSize(value: number): this {
+    assertUninitialized(this);
+    if (this[kOptions].tailable) {
+      throw new MongoTailableCursorError('Tailable cursor does not support batchSize');
+    }
+
+    if (typeof value !== 'number') {
+      throw new MongoInvalidArgumentError('Operation "batchSize" requires an integer');
+    }
+
+    this[kOptions].batchSize = value;
+    return this;
+  }
+
+  /**
+   * Rewind this cursor to its uninitialized state. Any options that are present on the cursor will
+   * remain in effect. Iterating this cursor will cause new queries to be sent to the server, even
+   * if the resultant data has already been retrieved by this cursor.
+   */
+  rewind(): void {
+    if (!this[kInitialized]) {
+      return;
+    }
+
+    this[kId] = null;
+    this[kDocuments].clear();
+    this[kClosed] = false;
+    this[kKilled] = false;
+    this[kInitialized] = false;
+
+    const session = this[kSession];
+    if (session) {
+      // We only want to end this session if we created it, and it hasn't ended yet
+      if (session.explicit === false) {
+        if (!session.hasEnded) {
+          session.endSession().catch(() => null);
+        }
+        this[kSession] = this.client.startSession({ owner: this, explicit: false });
+      }
+    }
+  }
+
+  /**
+   * Returns a new uninitialized copy of this cursor, with options matching those that have been set on the current instance
+   */
+  abstract clone(): AbstractCursor<TSchema>;
+
+  /** @internal */
+  protected abstract _initialize(
+    session: ClientSession | undefined,
+    callback: Callback<ExecutionResult>
+  ): void;
+
+  /** @internal */
+  _getMore(batchSize: number, callback: Callback<Document>): void {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const getMoreOperation = new GetMoreOperation(this[kNamespace], this[kId]!, this[kServer]!, {
+      ...this[kOptions],
+      session: this[kSession],
+      batchSize
+    });
+
+    executeOperation(this[kClient], getMoreOperation, callback);
+  }
+
+  /**
+   * @internal
+   *
+   * This function is exposed for the unified test runner's createChangeStream
+   * operation.  We cannot refactor to use the abstract _initialize method without
+   * a significant refactor.
+   */
+  [kInit](callback: Callback<TSchema | null>): void {
+    this._initialize(this[kSession], (error, state) => {
+      if (state) {
+        const response = state.response;
+        this[kServer] = state.server;
+
+        if (response.cursor) {
+          // TODO(NODE-2674): Preserve int64 sent from MongoDB
+          this[kId] =
+            typeof response.cursor.id === 'number'
+              ? Long.fromNumber(response.cursor.id)
+              : typeof response.cursor.id === 'bigint'
+              ? Long.fromBigInt(response.cursor.id)
+              : response.cursor.id;
+
+          if (response.cursor.ns) {
+            this[kNamespace] = ns(response.cursor.ns);
+          }
+
+          this[kDocuments].pushMany(response.cursor.firstBatch);
+        }
+
+        // When server responses return without a cursor document, we close this cursor
+        // and return the raw server response. This is often the case for explain commands
+        // for example
+        if (this[kId] == null) {
+          this[kId] = Long.ZERO;
+          // TODO(NODE-3286): ExecutionResult needs to accept a generic parameter
+          this[kDocuments].push(state.response as TODO_NODE_3286);
+        }
+      }
+
+      // the cursor is now initialized, even if an error occurred or it is dead
+      this[kInitialized] = true;
+
+      if (error) {
+        return cleanupCursor(this, { error }, () => callback(error, undefined));
+      }
+
+      if (cursorIsDead(this)) {
+        return cleanupCursor(this, undefined, () => callback());
+      }
+
+      callback();
+    });
+  }
+}
+
+function nextDocument<T>(cursor: AbstractCursor<T>): T | null {
+  const doc = cursor[kDocuments].shift();
+
+  if (doc && cursor[kTransform]) {
+    return cursor[kTransform](doc) as T;
+  }
+
+  return doc;
+}
+
+const nextAsync = promisify(
+  next as <T>(
+    cursor: AbstractCursor<T>,
+    blocking: boolean,
+    callback: (e: Error, r: T | null) => void
+  ) => void
+);
+
+/**
+ * @param cursor - the cursor on which to call `next`
+ * @param blocking - a boolean indicating whether or not the cursor should `block` until data
+ *     is available.  Generally, this flag is set to `false` because if the getMore returns no documents,
+ *     the cursor has been exhausted.  In certain scenarios (ChangeStreams, tailable await cursors and
+ *     `tryNext`, for example) blocking is necessary because a getMore returning no documents does
+ *     not indicate the end of the cursor.
+ * @param callback - callback to return the result to the caller
+ * @returns
+ */
+export function next<T>(
+  cursor: AbstractCursor<T>,
+  blocking: boolean,
+  callback: Callback<T | null>
+): void {
+  const cursorId = cursor[kId];
+  if (cursor.closed) {
+    return callback(undefined, null);
+  }
+
+  if (cursor[kDocuments].length !== 0) {
+    callback(undefined, nextDocument<T>(cursor));
+    return;
+  }
+
+  if (cursorId == null) {
+    // All cursors must operate within a session, one must be made implicitly if not explicitly provided
+    cursor[kInit](err => {
+      if (err) return callback(err);
+      return next(cursor, blocking, callback);
+    });
+
+    return;
+  }
+
+  if (cursorIsDead(cursor)) {
+    return cleanupCursor(cursor, undefined, () => callback(undefined, null));
+  }
+
+  // otherwise need to call getMore
+  const batchSize = cursor[kOptions].batchSize || 1000;
+  cursor._getMore(batchSize, (error, response) => {
+    if (response) {
+      const cursorId =
+        typeof response.cursor.id === 'number'
+          ? Long.fromNumber(response.cursor.id)
+          : typeof response.cursor.id === 'bigint'
+          ? Long.fromBigInt(response.cursor.id)
+          : response.cursor.id;
+
+      cursor[kDocuments].pushMany(response.cursor.nextBatch);
+      cursor[kId] = cursorId;
+    }
+
+    if (error || cursorIsDead(cursor)) {
+      return cleanupCursor(cursor, { error }, () => callback(error, nextDocument<T>(cursor)));
+    }
+
+    if (cursor[kDocuments].length === 0 && blocking === false) {
+      return callback(undefined, null);
+    }
+
+    next(cursor, blocking, callback);
+  });
+}
+
+function cursorIsDead(cursor: AbstractCursor): boolean {
+  const cursorId = cursor[kId];
+  return !!cursorId && cursorId.isZero();
+}
+
+const cleanupCursorAsync = promisify(cleanupCursor);
+
+function cleanupCursor(
+  cursor: AbstractCursor,
+  options: { error?: AnyError | undefined; needsToEmitClosed?: boolean } | undefined,
+  callback: Callback
+): void {
+  const cursorId = cursor[kId];
+  const cursorNs = cursor[kNamespace];
+  const server = cursor[kServer];
+  const session = cursor[kSession];
+  const error = options?.error;
+  const needsToEmitClosed = options?.needsToEmitClosed ?? cursor[kDocuments].length === 0;
+
+  if (error) {
+    if (cursor.loadBalanced && error instanceof MongoNetworkError) {
+      return completeCleanup();
+    }
+  }
+
+  if (cursorId == null || server == null || cursorId.isZero() || cursorNs == null) {
+    if (needsToEmitClosed) {
+      cursor[kClosed] = true;
+      cursor[kId] = Long.ZERO;
+      cursor.emit(AbstractCursor.CLOSE);
+    }
+
+    if (session) {
+      if (session.owner === cursor) {
+        session.endSession({ error }).finally(() => {
+          callback();
+        });
+        return;
+      }
+
+      if (!session.inTransaction()) {
+        maybeClearPinnedConnection(session, { error });
+      }
+    }
+
+    return callback();
+  }
+
+  function completeCleanup() {
+    if (session) {
+      if (session.owner === cursor) {
+        session.endSession({ error }).finally(() => {
+          cursor.emit(AbstractCursor.CLOSE);
+          callback();
+        });
+        return;
+      }
+
+      if (!session.inTransaction()) {
+        maybeClearPinnedConnection(session, { error });
+      }
+    }
+
+    cursor.emit(AbstractCursor.CLOSE);
+    return callback();
+  }
+
+  cursor[kKilled] = true;
+
+  if (session.hasEnded) {
+    return completeCleanup();
+  }
+
+  executeOperation(
+    cursor[kClient],
+    new KillCursorsOperation(cursorId, cursorNs, server, { session })
+  )
+    .catch(() => null)
+    .finally(completeCleanup);
+}
+
+/** @internal */
+export function assertUninitialized(cursor: AbstractCursor): void {
+  if (cursor[kInitialized]) {
+    throw new MongoCursorInUseError();
+  }
+}
+
+class ReadableCursorStream extends Readable {
+  private _cursor: AbstractCursor;
+  private _readInProgress = false;
+
+  constructor(cursor: AbstractCursor) {
+    super({
+      objectMode: true,
+      autoDestroy: false,
+      highWaterMark: 1
+    });
+    this._cursor = cursor;
+  }
+
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  override _read(size: number): void {
+    if (!this._readInProgress) {
+      this._readInProgress = true;
+      this._readNext();
+    }
+  }
+
+  override _destroy(error: Error | null, callback: (error?: Error | null) => void): void {
+    this._cursor.close().then(
+      () => callback(error),
+      closeError => callback(closeError)
+    );
+  }
+
+  private _readNext() {
+    next(this._cursor, true, (err, result) => {
+      if (err) {
+        // NOTE: This is questionable, but we have a test backing the behavior. It seems the
+        //       desired behavior is that a stream ends cleanly when a user explicitly closes
+        //       a client during iteration. Alternatively, we could do the "right" thing and
+        //       propagate the error message by removing this special case.
+        if (err.message.match(/server is closed/)) {
+          this._cursor.close().catch(() => null);
+          return this.push(null);
+        }
+
+        // NOTE: This is also perhaps questionable. The rationale here is that these errors tend
+        //       to be "operation was interrupted", where a cursor has been closed but there is an
+        //       active getMore in-flight. This used to check if the cursor was killed but once
+        //       that changed to happen in cleanup legitimate errors would not destroy the
+        //       stream. There are change streams test specifically test these cases.
+        if (err.message.match(/operation was interrupted/)) {
+          return this.push(null);
+        }
+
+        // NOTE: The two above checks on the message of the error will cause a null to be pushed
+        //       to the stream, thus closing the stream before the destroy call happens. This means
+        //       that either of those error messages on a change stream will not get a proper
+        //       'error' event to be emitted (the error passed to destroy). Change stream resumability
+        //       relies on that error event to be emitted to create its new cursor and thus was not
+        //       working on 4.4 servers because the error emitted on failover was "interrupted at
+        //       shutdown" while on 5.0+ it is "The server is in quiesce mode and will shut down".
+        //       See NODE-4475.
+        return this.destroy(err);
+      }
+
+      if (result == null) {
+        this.push(null);
+      } else if (this.destroyed) {
+        this._cursor.close().catch(() => null);
+      } else {
+        if (this.push(result)) {
+          return this._readNext();
+        }
+
+        this._readInProgress = false;
+      }
+    });
+  }
+}

node_modules/mongodb/src/cursor/aggregation_cursor.ts

@@ -0,0 +1,208 @@
+import type { Document } from '../bson';
+import type { ExplainVerbosityLike } from '../explain';
+import type { MongoClient } from '../mongo_client';
+import { AggregateOperation, AggregateOptions } from '../operations/aggregate';
+import { executeOperation, ExecutionResult } from '../operations/execute_operation';
+import type { ClientSession } from '../sessions';
+import type { Sort } from '../sort';
+import type { Callback, MongoDBNamespace } from '../utils';
+import { mergeOptions } from '../utils';
+import type { AbstractCursorOptions } from './abstract_cursor';
+import { AbstractCursor, assertUninitialized } from './abstract_cursor';
+
+/** @public */
+export interface AggregationCursorOptions extends AbstractCursorOptions, AggregateOptions {}
+
+/** @internal */
+const kPipeline = Symbol('pipeline');
+/** @internal */
+const kOptions = Symbol('options');
+
+/**
+ * The **AggregationCursor** class is an internal class that embodies an aggregation cursor on MongoDB
+ * allowing for iteration over the results returned from the underlying query. It supports
+ * one by one document iteration, conversion to an array or can be iterated as a Node 4.X
+ * or higher stream
+ * @public
+ */
+export class AggregationCursor<TSchema = any> extends AbstractCursor<TSchema> {
+  /** @internal */
+  [kPipeline]: Document[];
+  /** @internal */
+  [kOptions]: AggregateOptions;
+
+  /** @internal */
+  constructor(
+    client: MongoClient,
+    namespace: MongoDBNamespace,
+    pipeline: Document[] = [],
+    options: AggregateOptions = {}
+  ) {
+    super(client, namespace, options);
+
+    this[kPipeline] = pipeline;
+    this[kOptions] = options;
+  }
+
+  get pipeline(): Document[] {
+    return this[kPipeline];
+  }
+
+  clone(): AggregationCursor<TSchema> {
+    const clonedOptions = mergeOptions({}, this[kOptions]);
+    delete clonedOptions.session;
+    return new AggregationCursor(this.client, this.namespace, this[kPipeline], {
+      ...clonedOptions
+    });
+  }
+
+  override map<T>(transform: (doc: TSchema) => T): AggregationCursor<T> {
+    return super.map(transform) as AggregationCursor<T>;
+  }
+
+  /** @internal */
+  _initialize(session: ClientSession, callback: Callback<ExecutionResult>): void {
+    const aggregateOperation = new AggregateOperation(this.namespace, this[kPipeline], {
+      ...this[kOptions],
+      ...this.cursorOptions,
+      session
+    });
+
+    executeOperation(this.client, aggregateOperation, (err, response) => {
+      if (err || response == null) return callback(err);
+
+      // TODO: NODE-2882
+      callback(undefined, { server: aggregateOperation.server, session, response });
+    });
+  }
+
+  /** Execute the explain for the cursor */
+  async explain(verbosity?: ExplainVerbosityLike): Promise<Document> {
+    return executeOperation(
+      this.client,
+      new AggregateOperation(this.namespace, this[kPipeline], {
+        ...this[kOptions], // NOTE: order matters here, we may need to refine this
+        ...this.cursorOptions,
+        explain: verbosity ?? true
+      })
+    );
+  }
+
+  /** Add a group stage to the aggregation pipeline */
+  group<T = TSchema>($group: Document): AggregationCursor<T>;
+  group($group: Document): this {
+    assertUninitialized(this);
+    this[kPipeline].push({ $group });
+    return this;
+  }
+
+  /** Add a limit stage to the aggregation pipeline */
+  limit($limit: number): this {
+    assertUninitialized(this);
+    this[kPipeline].push({ $limit });
+    return this;
+  }
+
+  /** Add a match stage to the aggregation pipeline */
+  match($match: Document): this {
+    assertUninitialized(this);
+    this[kPipeline].push({ $match });
+    return this;
+  }
+
+  /** Add an out stage to the aggregation pipeline */
+  out($out: { db: string; coll: string } | string): this {
+    assertUninitialized(this);
+    this[kPipeline].push({ $out });
+    return this;
+  }
+
+  /**
+   * Add a project stage to the aggregation pipeline
+   *
+   * @remarks
+   * In order to strictly type this function you must provide an interface
+   * that represents the effect of your projection on the result documents.
+   *
+   * By default chaining a projection to your cursor changes the returned type to the generic {@link Document} type.
+   * You should specify a parameterized type to have assertions on your final results.
+   *
+   * @example
+   * ```typescript
+   * // Best way
+   * const docs: AggregationCursor<{ a: number }> = cursor.project<{ a: number }>({ _id: 0, a: true });
+   * // Flexible way
+   * const docs: AggregationCursor<Document> = cursor.project({ _id: 0, a: true });
+   * ```
+   *
+   * @remarks
+   * In order to strictly type this function you must provide an interface
+   * that represents the effect of your projection on the result documents.
+   *
+   * **Note for Typescript Users:** adding a transform changes the return type of the iteration of this cursor,
+   * it **does not** return a new instance of a cursor. This means when calling project,
+   * you should always assign the result to a new variable in order to get a correctly typed cursor variable.
+   * Take note of the following example:
+   *
+   * @example
+   * ```typescript
+   * const cursor: AggregationCursor<{ a: number; b: string }> = coll.aggregate([]);
+   * const projectCursor = cursor.project<{ a: number }>({ _id: 0, a: true });
+   * const aPropOnlyArray: {a: number}[] = await projectCursor.toArray();
+   *
+   * // or always use chaining and save the final cursor
+   *
+   * const cursor = coll.aggregate().project<{ a: string }>({
+   *   _id: 0,
+   *   a: { $convert: { input: '$a', to: 'string' }
+   * }});
+   * ```
+   */
+  project<T extends Document = Document>($project: Document): AggregationCursor<T> {
+    assertUninitialized(this);
+    this[kPipeline].push({ $project });
+    return this as unknown as AggregationCursor<T>;
+  }
+
+  /** Add a lookup stage to the aggregation pipeline */
+  lookup($lookup: Document): this {
+    assertUninitialized(this);
+    this[kPipeline].push({ $lookup });
+    return this;
+  }
+
+  /** Add a redact stage to the aggregation pipeline */
+  redact($redact: Document): this {
+    assertUninitialized(this);
+    this[kPipeline].push({ $redact });
+    return this;
+  }
+
+  /** Add a skip stage to the aggregation pipeline */
+  skip($skip: number): this {
+    assertUninitialized(this);
+    this[kPipeline].push({ $skip });
+    return this;
+  }
+
+  /** Add a sort stage to the aggregation pipeline */
+  sort($sort: Sort): this {
+    assertUninitialized(this);
+    this[kPipeline].push({ $sort });
+    return this;
+  }
+
+  /** Add a unwind stage to the aggregation pipeline */
+  unwind($unwind: Document | string): this {
+    assertUninitialized(this);
+    this[kPipeline].push({ $unwind });
+    return this;
+  }
+
+  /** Add a geoNear stage to the aggregation pipeline */
+  geoNear($geoNear: Document): this {
+    assertUninitialized(this);
+    this[kPipeline].push({ $geoNear });
+    return this;
+  }
+}

node_modules/mongodb/src/cursor/change_stream_cursor.ts

@@ -0,0 +1,194 @@
+import type { Document, Long, Timestamp } from '../bson';
+import {
+  ChangeStream,
+  type ChangeStreamDocument,
+  type ChangeStreamEvents,
+  type OperationTime,
+  type ResumeToken
+} from '../change_stream';
+import { INIT, RESPONSE } from '../constants';
+import type { MongoClient } from '../mongo_client';
+import type { TODO_NODE_3286 } from '../mongo_types';
+import { AggregateOperation } from '../operations/aggregate';
+import type { CollationOptions } from '../operations/command';
+import { executeOperation, type ExecutionResult } from '../operations/execute_operation';
+import type { ClientSession } from '../sessions';
+import { type Callback, maxWireVersion, type MongoDBNamespace } from '../utils';
+import { AbstractCursor, type AbstractCursorOptions } from './abstract_cursor';
+
+/** @internal */
+export interface ChangeStreamCursorOptions extends AbstractCursorOptions {
+  startAtOperationTime?: OperationTime;
+  resumeAfter?: ResumeToken;
+  startAfter?: ResumeToken;
+  maxAwaitTimeMS?: number;
+  collation?: CollationOptions;
+  fullDocument?: string;
+}
+
+/** @internal */
+export type ChangeStreamAggregateRawResult<TChange> = {
+  $clusterTime: { clusterTime: Timestamp };
+  cursor: {
+    postBatchResumeToken: ResumeToken;
+    ns: string;
+    id: number | Long;
+  } & ({ firstBatch: TChange[] } | { nextBatch: TChange[] });
+  ok: 1;
+  operationTime: Timestamp;
+};
+
+/** @internal */
+export class ChangeStreamCursor<
+  TSchema extends Document = Document,
+  TChange extends Document = ChangeStreamDocument<TSchema>
+> extends AbstractCursor<TChange, ChangeStreamEvents> {
+  _resumeToken: ResumeToken;
+  startAtOperationTime?: OperationTime;
+  hasReceived?: boolean;
+  resumeAfter: ResumeToken;
+  startAfter: ResumeToken;
+  options: ChangeStreamCursorOptions;
+
+  postBatchResumeToken?: ResumeToken;
+  pipeline: Document[];
+
+  /**
+   * @internal
+   *
+   * used to determine change stream resumability
+   */
+  maxWireVersion: number | undefined;
+
+  constructor(
+    client: MongoClient,
+    namespace: MongoDBNamespace,
+    pipeline: Document[] = [],
+    options: ChangeStreamCursorOptions = {}
+  ) {
+    super(client, namespace, options);
+
+    this.pipeline = pipeline;
+    this.options = options;
+    this._resumeToken = null;
+    this.startAtOperationTime = options.startAtOperationTime;
+
+    if (options.startAfter) {
+      this.resumeToken = options.startAfter;
+    } else if (options.resumeAfter) {
+      this.resumeToken = options.resumeAfter;
+    }
+  }
+
+  set resumeToken(token: ResumeToken) {
+    this._resumeToken = token;
+    this.emit(ChangeStream.RESUME_TOKEN_CHANGED, token);
+  }
+
+  get resumeToken(): ResumeToken {
+    return this._resumeToken;
+  }
+
+  get resumeOptions(): ChangeStreamCursorOptions {
+    const options: ChangeStreamCursorOptions = {
+      ...this.options
+    };
+
+    for (const key of ['resumeAfter', 'startAfter', 'startAtOperationTime'] as const) {
+      delete options[key];
+    }
+
+    if (this.resumeToken != null) {
+      if (this.options.startAfter && !this.hasReceived) {
+        options.startAfter = this.resumeToken;
+      } else {
+        options.resumeAfter = this.resumeToken;
+      }
+    } else if (this.startAtOperationTime != null && maxWireVersion(this.server) >= 7) {
+      options.startAtOperationTime = this.startAtOperationTime;
+    }
+
+    return options;
+  }
+
+  cacheResumeToken(resumeToken: ResumeToken): void {
+    if (this.bufferedCount() === 0 && this.postBatchResumeToken) {
+      this.resumeToken = this.postBatchResumeToken;
+    } else {
+      this.resumeToken = resumeToken;
+    }
+    this.hasReceived = true;
+  }
+
+  _processBatch(response: ChangeStreamAggregateRawResult<TChange>): void {
+    const cursor = response.cursor;
+    if (cursor.postBatchResumeToken) {
+      this.postBatchResumeToken = response.cursor.postBatchResumeToken;
+
+      const batch =
+        'firstBatch' in response.cursor ? response.cursor.firstBatch : response.cursor.nextBatch;
+      if (batch.length === 0) {
+        this.resumeToken = cursor.postBatchResumeToken;
+      }
+    }
+  }
+
+  clone(): AbstractCursor<TChange> {
+    return new ChangeStreamCursor(this.client, this.namespace, this.pipeline, {
+      ...this.cursorOptions
+    });
+  }
+
+  _initialize(session: ClientSession, callback: Callback<ExecutionResult>): void {
+    const aggregateOperation = new AggregateOperation(this.namespace, this.pipeline, {
+      ...this.cursorOptions,
+      ...this.options,
+      session
+    });
+
+    executeOperation<TODO_NODE_3286, ChangeStreamAggregateRawResult<TChange>>(
+      session.client,
+      aggregateOperation,
+      (err, response) => {
+        if (err || response == null) {
+          return callback(err);
+        }
+
+        const server = aggregateOperation.server;
+        this.maxWireVersion = maxWireVersion(server);
+
+        if (
+          this.startAtOperationTime == null &&
+          this.resumeAfter == null &&
+          this.startAfter == null &&
+          this.maxWireVersion >= 7
+        ) {
+          this.startAtOperationTime = response.operationTime;
+        }
+
+        this._processBatch(response);
+
+        this.emit(INIT, response);
+        this.emit(RESPONSE);
+
+        // TODO: NODE-2882
+        callback(undefined, { server, session, response });
+      }
+    );
+  }
+
+  override _getMore(batchSize: number, callback: Callback): void {
+    super._getMore(batchSize, (err, response) => {
+      if (err) {
+        return callback(err);
+      }
+
+      this.maxWireVersion = maxWireVersion(this.server);
+      this._processBatch(response as TODO_NODE_3286 as ChangeStreamAggregateRawResult<TChange>);
+
+      this.emit(ChangeStream.MORE, response);
+      this.emit(ChangeStream.RESPONSE);
+      callback(err, response);
+    });
+  }
+}

node_modules/mongodb/src/cursor/find_cursor.ts

@@ -0,0 +1,456 @@
+import type { Document } from '../bson';
+import { MongoInvalidArgumentError, MongoTailableCursorError } from '../error';
+import type { ExplainVerbosityLike } from '../explain';
+import type { MongoClient } from '../mongo_client';
+import type { CollationOptions } from '../operations/command';
+import { CountOperation, CountOptions } from '../operations/count';
+import { executeOperation, ExecutionResult } from '../operations/execute_operation';
+import { FindOperation, FindOptions } from '../operations/find';
+import type { Hint } from '../operations/operation';
+import type { ClientSession } from '../sessions';
+import { formatSort, Sort, SortDirection } from '../sort';
+import { Callback, emitWarningOnce, mergeOptions, MongoDBNamespace } from '../utils';
+import { AbstractCursor, assertUninitialized } from './abstract_cursor';
+
+/** @internal */
+const kFilter = Symbol('filter');
+/** @internal */
+const kNumReturned = Symbol('numReturned');
+/** @internal */
+const kBuiltOptions = Symbol('builtOptions');
+
+/** @public Flags allowed for cursor */
+export const FLAGS = [
+  'tailable',
+  'oplogReplay',
+  'noCursorTimeout',
+  'awaitData',
+  'exhaust',
+  'partial'
+] as const;
+
+/** @public */
+export class FindCursor<TSchema = any> extends AbstractCursor<TSchema> {
+  /** @internal */
+  [kFilter]: Document;
+  /** @internal */
+  [kNumReturned]?: number;
+  /** @internal */
+  [kBuiltOptions]: FindOptions;
+
+  /** @internal */
+  constructor(
+    client: MongoClient,
+    namespace: MongoDBNamespace,
+    filter: Document = {},
+    options: FindOptions = {}
+  ) {
+    super(client, namespace, options);
+
+    this[kFilter] = filter;
+    this[kBuiltOptions] = options;
+
+    if (options.sort != null) {
+      this[kBuiltOptions].sort = formatSort(options.sort);
+    }
+  }
+
+  clone(): FindCursor<TSchema> {
+    const clonedOptions = mergeOptions({}, this[kBuiltOptions]);
+    delete clonedOptions.session;
+    return new FindCursor(this.client, this.namespace, this[kFilter], {
+      ...clonedOptions
+    });
+  }
+
+  override map<T>(transform: (doc: TSchema) => T): FindCursor<T> {
+    return super.map(transform) as FindCursor<T>;
+  }
+
+  /** @internal */
+  _initialize(session: ClientSession, callback: Callback<ExecutionResult>): void {
+    const findOperation = new FindOperation(undefined, this.namespace, this[kFilter], {
+      ...this[kBuiltOptions], // NOTE: order matters here, we may need to refine this
+      ...this.cursorOptions,
+      session
+    });
+
+    executeOperation(this.client, findOperation, (err, response) => {
+      if (err || response == null) return callback(err);
+
+      // TODO: We only need this for legacy queries that do not support `limit`, maybe
+      //       the value should only be saved in those cases.
+      if (response.cursor) {
+        this[kNumReturned] = response.cursor.firstBatch.length;
+      } else {
+        this[kNumReturned] = response.documents ? response.documents.length : 0;
+      }
+
+      // TODO: NODE-2882
+      callback(undefined, { server: findOperation.server, session, response });
+    });
+  }
+
+  /** @internal */
+  override _getMore(batchSize: number, callback: Callback<Document>): void {
+    // NOTE: this is to support client provided limits in pre-command servers
+    const numReturned = this[kNumReturned];
+    if (numReturned) {
+      const limit = this[kBuiltOptions].limit;
+      batchSize =
+        limit && limit > 0 && numReturned + batchSize > limit ? limit - numReturned : batchSize;
+
+      if (batchSize <= 0) {
+        this.close().finally(() => callback());
+        return;
+      }
+    }
+
+    super._getMore(batchSize, (err, response) => {
+      if (err) return callback(err);
+
+      // TODO: wrap this in some logic to prevent it from happening if we don't need this support
+      if (response) {
+        this[kNumReturned] = this[kNumReturned] + response.cursor.nextBatch.length;
+      }
+
+      callback(undefined, response);
+    });
+  }
+
+  /**
+   * Get the count of documents for this cursor
+   * @deprecated Use `collection.estimatedDocumentCount` or `collection.countDocuments` instead
+   */
+  async count(options?: CountOptions): Promise<number> {
+    emitWarningOnce(
+      'cursor.count is deprecated and will be removed in the next major version, please use `collection.estimatedDocumentCount` or `collection.countDocuments` instead '
+    );
+    if (typeof options === 'boolean') {
+      throw new MongoInvalidArgumentError('Invalid first parameter to count');
+    }
+    return executeOperation(
+      this.client,
+      new CountOperation(this.namespace, this[kFilter], {
+        ...this[kBuiltOptions], // NOTE: order matters here, we may need to refine this
+        ...this.cursorOptions,
+        ...options
+      })
+    );
+  }
+
+  /** Execute the explain for the cursor */
+  async explain(verbosity?: ExplainVerbosityLike): Promise<Document> {
+    return executeOperation(
+      this.client,
+      new FindOperation(undefined, this.namespace, this[kFilter], {
+        ...this[kBuiltOptions], // NOTE: order matters here, we may need to refine this
+        ...this.cursorOptions,
+        explain: verbosity ?? true
+      })
+    );
+  }
+
+  /** Set the cursor query */
+  filter(filter: Document): this {
+    assertUninitialized(this);
+    this[kFilter] = filter;
+    return this;
+  }
+
+  /**
+   * Set the cursor hint
+   *
+   * @param hint - If specified, then the query system will only consider plans using the hinted index.
+   */
+  hint(hint: Hint): this {
+    assertUninitialized(this);
+    this[kBuiltOptions].hint = hint;
+    return this;
+  }
+
+  /**
+   * Set the cursor min
+   *
+   * @param min - Specify a $min value to specify the inclusive lower bound for a specific index in order to constrain the results of find(). The $min specifies the lower bound for all keys of a specific index in order.
+   */
+  min(min: Document): this {
+    assertUninitialized(this);
+    this[kBuiltOptions].min = min;
+    return this;
+  }
+
+  /**
+   * Set the cursor max
+   *
+   * @param max - Specify a $max value to specify the exclusive upper bound for a specific index in order to constrain the results of find(). The $max specifies the upper bound for all keys of a specific index in order.
+   */
+  max(max: Document): this {
+    assertUninitialized(this);
+    this[kBuiltOptions].max = max;
+    return this;
+  }
+
+  /**
+   * Set the cursor returnKey.
+   * If set to true, modifies the cursor to only return the index field or fields for the results of the query, rather than documents.
+   * If set to true and the query does not use an index to perform the read operation, the returned documents will not contain any fields.
+   *
+   * @param value - the returnKey value.
+   */
+  returnKey(value: boolean): this {
+    assertUninitialized(this);
+    this[kBuiltOptions].returnKey = value;
+    return this;
+  }
+
+  /**
+   * Modifies the output of a query by adding a field $recordId to matching documents. $recordId is the internal key which uniquely identifies a document in a collection.
+   *
+   * @param value - The $showDiskLoc option has now been deprecated and replaced with the showRecordId field. $showDiskLoc will still be accepted for OP_QUERY stye find.
+   */
+  showRecordId(value: boolean): this {
+    assertUninitialized(this);
+    this[kBuiltOptions].showRecordId = value;
+    return this;
+  }
+
+  /**
+   * Add a query modifier to the cursor query
+   *
+   * @param name - The query modifier (must start with $, such as $orderby etc)
+   * @param value - The modifier value.
+   */
+  addQueryModifier(name: string, value: string | boolean | number | Document): this {
+    assertUninitialized(this);
+    if (name[0] !== '$') {
+      throw new MongoInvalidArgumentError(`${name} is not a valid query modifier`);
+    }
+
+    // Strip of the $
+    const field = name.substr(1);
+
+    // NOTE: consider some TS magic for this
+    switch (field) {
+      case 'comment':
+        this[kBuiltOptions].comment = value as string | Document;
+        break;
+
+      case 'explain':
+        this[kBuiltOptions].explain = value as boolean;
+        break;
+
+      case 'hint':
+        this[kBuiltOptions].hint = value as string | Document;
+        break;
+
+      case 'max':
+        this[kBuiltOptions].max = value as Document;
+        break;
+
+      case 'maxTimeMS':
+        this[kBuiltOptions].maxTimeMS = value as number;
+        break;
+
+      case 'min':
+        this[kBuiltOptions].min = value as Document;
+        break;
+
+      case 'orderby':
+        this[kBuiltOptions].sort = formatSort(value as string | Document);
+        break;
+
+      case 'query':
+        this[kFilter] = value as Document;
+        break;
+
+      case 'returnKey':
+        this[kBuiltOptions].returnKey = value as boolean;
+        break;
+
+      case 'showDiskLoc':
+        this[kBuiltOptions].showRecordId = value as boolean;
+        break;
+
+      default:
+        throw new MongoInvalidArgumentError(`Invalid query modifier: ${name}`);
+    }
+
+    return this;
+  }
+
+  /**
+   * Add a comment to the cursor query allowing for tracking the comment in the log.
+   *
+   * @param value - The comment attached to this query.
+   */
+  comment(value: string): this {
+    assertUninitialized(this);
+    this[kBuiltOptions].comment = value;
+    return this;
+  }
+
+  /**
+   * Set a maxAwaitTimeMS on a tailing cursor query to allow to customize the timeout value for the option awaitData (Only supported on MongoDB 3.2 or higher, ignored otherwise)
+   *
+   * @param value - Number of milliseconds to wait before aborting the tailed query.
+   */
+  maxAwaitTimeMS(value: number): this {
+    assertUninitialized(this);
+    if (typeof value !== 'number') {
+      throw new MongoInvalidArgumentError('Argument for maxAwaitTimeMS must be a number');
+    }
+
+    this[kBuiltOptions].maxAwaitTimeMS = value;
+    return this;
+  }
+
+  /**
+   * Set a maxTimeMS on the cursor query, allowing for hard timeout limits on queries (Only supported on MongoDB 2.6 or higher)
+   *
+   * @param value - Number of milliseconds to wait before aborting the query.
+   */
+  override maxTimeMS(value: number): this {
+    assertUninitialized(this);
+    if (typeof value !== 'number') {
+      throw new MongoInvalidArgumentError('Argument for maxTimeMS must be a number');
+    }
+
+    this[kBuiltOptions].maxTimeMS = value;
+    return this;
+  }
+
+  /**
+   * Add a project stage to the aggregation pipeline
+   *
+   * @remarks
+   * In order to strictly type this function you must provide an interface
+   * that represents the effect of your projection on the result documents.
+   *
+   * By default chaining a projection to your cursor changes the returned type to the generic
+   * {@link Document} type.
+   * You should specify a parameterized type to have assertions on your final results.
+   *
+   * @example
+   * ```typescript
+   * // Best way
+   * const docs: FindCursor<{ a: number }> = cursor.project<{ a: number }>({ _id: 0, a: true });
+   * // Flexible way
+   * const docs: FindCursor<Document> = cursor.project({ _id: 0, a: true });
+   * ```
+   *
+   * @remarks
+   *
+   * **Note for Typescript Users:** adding a transform changes the return type of the iteration of this cursor,
+   * it **does not** return a new instance of a cursor. This means when calling project,
+   * you should always assign the result to a new variable in order to get a correctly typed cursor variable.
+   * Take note of the following example:
+   *
+   * @example
+   * ```typescript
+   * const cursor: FindCursor<{ a: number; b: string }> = coll.find();
+   * const projectCursor = cursor.project<{ a: number }>({ _id: 0, a: true });
+   * const aPropOnlyArray: {a: number}[] = await projectCursor.toArray();
+   *
+   * // or always use chaining and save the final cursor
+   *
+   * const cursor = coll.find().project<{ a: string }>({
+   *   _id: 0,
+   *   a: { $convert: { input: '$a', to: 'string' }
+   * }});
+   * ```
+   */
+  project<T extends Document = Document>(value: Document): FindCursor<T> {
+    assertUninitialized(this);
+    this[kBuiltOptions].projection = value;
+    return this as unknown as FindCursor<T>;
+  }
+
+  /**
+   * Sets the sort order of the cursor query.
+   *
+   * @param sort - The key or keys set for the sort.
+   * @param direction - The direction of the sorting (1 or -1).
+   */
+  sort(sort: Sort | string, direction?: SortDirection): this {
+    assertUninitialized(this);
+    if (this[kBuiltOptions].tailable) {
+      throw new MongoTailableCursorError('Tailable cursor does not support sorting');
+    }
+
+    this[kBuiltOptions].sort = formatSort(sort, direction);
+    return this;
+  }
+
+  /**
+   * Allows disk use for blocking sort operations exceeding 100MB memory. (MongoDB 3.2 or higher)
+   *
+   * @remarks
+   * {@link https://www.mongodb.com/docs/manual/reference/command/find/#find-cmd-allowdiskuse | find command allowDiskUse documentation}
+   */
+  allowDiskUse(allow = true): this {
+    assertUninitialized(this);
+
+    if (!this[kBuiltOptions].sort) {
+      throw new MongoInvalidArgumentError('Option "allowDiskUse" requires a sort specification');
+    }
+
+    // As of 6.0 the default is true. This allows users to get back to the old behavior.
+    if (!allow) {
+      this[kBuiltOptions].allowDiskUse = false;
+      return this;
+    }
+
+    this[kBuiltOptions].allowDiskUse = true;
+    return this;
+  }
+
+  /**
+   * Set the collation options for the cursor.
+   *
+   * @param value - The cursor collation options (MongoDB 3.4 or higher) settings for update operation (see 3.4 documentation for available fields).
+   */
+  collation(value: CollationOptions): this {
+    assertUninitialized(this);
+    this[kBuiltOptions].collation = value;
+    return this;
+  }
+
+  /**
+   * Set the limit for the cursor.
+   *
+   * @param value - The limit for the cursor query.
+   */
+  limit(value: number): this {
+    assertUninitialized(this);
+    if (this[kBuiltOptions].tailable) {
+      throw new MongoTailableCursorError('Tailable cursor does not support limit');
+    }
+
+    if (typeof value !== 'number') {
+      throw new MongoInvalidArgumentError('Operation "limit" requires an integer');
+    }
+
+    this[kBuiltOptions].limit = value;
+    return this;
+  }
+
+  /**
+   * Set the skip for the cursor.
+   *
+   * @param value - The skip for the cursor query.
+   */
+  skip(value: number): this {
+    assertUninitialized(this);
+    if (this[kBuiltOptions].tailable) {
+      throw new MongoTailableCursorError('Tailable cursor does not support skip');
+    }
+
+    if (typeof value !== 'number') {
+      throw new MongoInvalidArgumentError('Operation "skip" requires an integer');
+    }
+
+    this[kBuiltOptions].skip = value;
+    return this;
+  }
+}

node_modules/mongodb/src/cursor/list_collections_cursor.ts

@@ -0,0 +1,52 @@
+import type { Document } from '../bson';
+import type { Db } from '../db';
+import { executeOperation, ExecutionResult } from '../operations/execute_operation';
+import {
+  CollectionInfo,
+  ListCollectionsOperation,
+  ListCollectionsOptions
+} from '../operations/list_collections';
+import type { ClientSession } from '../sessions';
+import type { Callback } from '../utils';
+import { AbstractCursor } from './abstract_cursor';
+
+/** @public */
+export class ListCollectionsCursor<
+  T extends Pick<CollectionInfo, 'name' | 'type'> | CollectionInfo =
+    | Pick<CollectionInfo, 'name' | 'type'>
+    | CollectionInfo
+> extends AbstractCursor<T> {
+  parent: Db;
+  filter: Document;
+  options?: ListCollectionsOptions;
+
+  constructor(db: Db, filter: Document, options?: ListCollectionsOptions) {
+    super(db.client, db.s.namespace, options);
+    this.parent = db;
+    this.filter = filter;
+    this.options = options;
+  }
+
+  clone(): ListCollectionsCursor<T> {
+    return new ListCollectionsCursor(this.parent, this.filter, {
+      ...this.options,
+      ...this.cursorOptions
+    });
+  }
+
+  /** @internal */
+  _initialize(session: ClientSession | undefined, callback: Callback<ExecutionResult>): void {
+    const operation = new ListCollectionsOperation(this.parent, this.filter, {
+      ...this.cursorOptions,
+      ...this.options,
+      session
+    });
+
+    executeOperation(this.parent.client, operation, (err, response) => {
+      if (err || response == null) return callback(err);
+
+      // TODO: NODE-2882
+      callback(undefined, { server: operation.server, session, response });
+    });
+  }
+}

node_modules/mongodb/src/cursor/list_indexes_cursor.ts

@@ -0,0 +1,41 @@
+import type { Collection } from '../collection';
+import { executeOperation, ExecutionResult } from '../operations/execute_operation';
+import { ListIndexesOperation, ListIndexesOptions } from '../operations/indexes';
+import type { ClientSession } from '../sessions';
+import type { Callback } from '../utils';
+import { AbstractCursor } from './abstract_cursor';
+
+/** @public */
+export class ListIndexesCursor extends AbstractCursor {
+  parent: Collection;
+  options?: ListIndexesOptions;
+
+  constructor(collection: Collection, options?: ListIndexesOptions) {
+    super(collection.client, collection.s.namespace, options);
+    this.parent = collection;
+    this.options = options;
+  }
+
+  clone(): ListIndexesCursor {
+    return new ListIndexesCursor(this.parent, {
+      ...this.options,
+      ...this.cursorOptions
+    });
+  }
+
+  /** @internal */
+  _initialize(session: ClientSession | undefined, callback: Callback<ExecutionResult>): void {
+    const operation = new ListIndexesOperation(this.parent, {
+      ...this.cursorOptions,
+      ...this.options,
+      session
+    });
+
+    executeOperation(this.parent.client, operation, (err, response) => {
+      if (err || response == null) return callback(err);
+
+      // TODO: NODE-2882
+      callback(undefined, { server: operation.server, session, response });
+    });
+  }
+}

node_modules/mongodb/src/cursor/list_search_indexes_cursor.ts

@@ -0,0 +1,20 @@
+import type { Collection } from '../collection';
+import type { AggregateOptions } from '../operations/aggregate';
+import { AggregationCursor } from './aggregation_cursor';
+
+/** @internal */
+export type ListSearchIndexesOptions = AggregateOptions;
+
+/** @internal */
+export class ListSearchIndexesCursor extends AggregationCursor<{ name: string }> {
+  /** @internal */
+  constructor(
+    { fullNamespace: ns, client }: Collection,
+    name: string | null,
+    options: ListSearchIndexesOptions = {}
+  ) {
+    const pipeline =
+      name == null ? [{ $listSearchIndexes: {} }] : [{ $listSearchIndexes: { name } }];
+    super(client, ns, pipeline, options);
+  }
+}

node_modules/mongodb/src/cursor/run_command_cursor.ts

@@ -0,0 +1,140 @@
+import type { BSONSerializeOptions, Document, Long } from '../bson';
+import type { Db } from '../db';
+import { MongoAPIError, MongoUnexpectedServerResponseError } from '../error';
+import { executeOperation, ExecutionResult } from '../operations/execute_operation';
+import { GetMoreOperation } from '../operations/get_more';
+import { RunCommandOperation } from '../operations/run_command';
+import type { ReadConcernLike } from '../read_concern';
+import type { ReadPreferenceLike } from '../read_preference';
+import type { ClientSession } from '../sessions';
+import { Callback, ns } from '../utils';
+import { AbstractCursor } from './abstract_cursor';
+
+/** @public */
+export type RunCursorCommandOptions = {
+  readPreference?: ReadPreferenceLike;
+  session?: ClientSession;
+} & BSONSerializeOptions;
+
+/** @internal */
+type RunCursorCommandResponse = {
+  cursor: { id: bigint | Long | number; ns: string; firstBatch: Document[] };
+  ok: 1;
+};
+
+/** @public */
+export class RunCommandCursor extends AbstractCursor {
+  public readonly command: Readonly<Record<string, any>>;
+  public readonly getMoreOptions: {
+    comment?: any;
+    maxAwaitTimeMS?: number;
+    batchSize?: number;
+  } = {};
+
+  /**
+   * Controls the `getMore.comment` field
+   * @param comment - any BSON value
+   */
+  public setComment(comment: any): this {
+    this.getMoreOptions.comment = comment;
+    return this;
+  }
+
+  /**
+   * Controls the `getMore.maxTimeMS` field. Only valid when cursor is tailable await
+   * @param maxTimeMS - the number of milliseconds to wait for new data
+   */
+  public setMaxTimeMS(maxTimeMS: number): this {
+    this.getMoreOptions.maxAwaitTimeMS = maxTimeMS;
+    return this;
+  }
+
+  /**
+   * Controls the `getMore.batchSize` field
+   * @param maxTimeMS - the number documents to return in the `nextBatch`
+   */
+  public setBatchSize(batchSize: number): this {
+    this.getMoreOptions.batchSize = batchSize;
+    return this;
+  }
+
+  /** Unsupported for RunCommandCursor */
+  public override clone(): never {
+    throw new MongoAPIError('Clone not supported, create a new cursor with db.runCursorCommand');
+  }
+
+  /** Unsupported for RunCommandCursor: readConcern must be configured directly on command document */
+  public override withReadConcern(_: ReadConcernLike): never {
+    throw new MongoAPIError(
+      'RunCommandCursor does not support readConcern it must be attached to the command being run'
+    );
+  }
+
+  /** Unsupported for RunCommandCursor: various cursor flags must be configured directly on command document */
+  public override addCursorFlag(_: string, __: boolean): never {
+    throw new MongoAPIError(
+      'RunCommandCursor does not support cursor flags, they must be attached to the command being run'
+    );
+  }
+
+  /** Unsupported for RunCommandCursor: maxTimeMS must be configured directly on command document */
+  public override maxTimeMS(_: number): never {
+    throw new MongoAPIError(
+      'maxTimeMS must be configured on the command document directly, to configure getMore.maxTimeMS use cursor.setMaxTimeMS()'
+    );
+  }
+
+  /** Unsupported for RunCommandCursor: batchSize must be configured directly on command document */
+  public override batchSize(_: number): never {
+    throw new MongoAPIError(
+      'batchSize must be configured on the command document directly, to configure getMore.batchSize use cursor.setBatchSize()'
+    );
+  }
+
+  /** @internal */
+  private db: Db;
+
+  /** @internal */
+  constructor(db: Db, command: Document, options: RunCursorCommandOptions = {}) {
+    super(db.client, ns(db.namespace), options);
+    this.db = db;
+    this.command = Object.freeze({ ...command });
+  }
+
+  /** @internal */
+  protected _initialize(session: ClientSession, callback: Callback<ExecutionResult>) {
+    const operation = new RunCommandOperation<RunCursorCommandResponse>(this.db, this.command, {
+      ...this.cursorOptions,
+      session: session,
+      readPreference: this.cursorOptions.readPreference
+    });
+    executeOperation(this.client, operation).then(
+      response => {
+        if (response.cursor == null) {
+          callback(
+            new MongoUnexpectedServerResponseError('Expected server to respond with cursor')
+          );
+          return;
+        }
+        callback(undefined, {
+          server: operation.server,
+          session,
+          response
+        });
+      },
+      err => callback(err)
+    );
+  }
+
+  /** @internal */
+  override _getMore(_batchSize: number, callback: Callback<Document>) {
+    // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+    const getMoreOperation = new GetMoreOperation(this.namespace, this.id!, this.server!, {
+      ...this.cursorOptions,
+      session: this.session,
+      ...this.getMoreOptions
+    });
+
+    executeOperation(this.client, getMoreOperation, callback);
+  }
+}