add timeoutMode to find, findOne, listIndexes, aggregate, listCollections

Author: W-A-James

src/cursor/abstract_cursor.ts

@@ -59,6 +59,13 @@ export interface CursorStreamOptions {
 /** @public */
 export type CursorFlag = (typeof CURSOR_FLAGS)[number];
 
+export const CursorTimeoutMode = Object.freeze({
+  ITERATION: 'iteration',
+  LIFETIME: 'lifetime'
+} as const);
+
+export type CursorTimeoutMode = (typeof CursorTimeoutMode)[keyof typeof CursorTimeoutMode];
+
 /** @public */
 export interface AbstractCursorOptions extends BSONSerializeOptions {
   session?: ClientSession;

src/operations/aggregate.ts

@@ -1,5 +1,6 @@
 import type { Document } from '../bson';
 import { CursorResponse, ExplainedCursorResponse } from '../cmap/wire_protocol/responses';
+import { type CursorTimeoutMode } from '../cursor/abstract_cursor';
 import { MongoInvalidArgumentError } from '../error';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
@@ -35,6 +36,9 @@ export interface AggregateOptions extends CommandOperationOptions {
   let?: Document;
 
   out?: string;
+
+  /** @internal */
+  timeoutMode?: CursorTimeoutMode;
 }
 
 /** @internal */

src/operations/find.ts

@@ -1,5 +1,6 @@
 import type { Document } from '../bson';
 import { CursorResponse, ExplainedCursorResponse } from '../cmap/wire_protocol/responses';
+import { type CursorTimeoutMode } from '../cursor/abstract_cursor';
 import { MongoInvalidArgumentError } from '../error';
 import { ReadConcern } from '../read_concern';
 import type { Server } from '../sdam/server';
@@ -64,6 +65,9 @@ export interface FindOptions<TSchema extends Document = Document>
    * @deprecated Starting from MongoDB 4.4 this flag is not needed and will be ignored.
    */
   oplogReplay?: boolean;
+
+  /** @internal*/
+  timeoutMode?: CursorTimeoutMode;
 }
 
 /** @internal */

src/operations/indexes.ts

@@ -1,7 +1,7 @@
 import type { Document } from '../bson';
 import { CursorResponse } from '../cmap/wire_protocol/responses';
 import type { Collection } from '../collection';
-import { type AbstractCursorOptions } from '../cursor/abstract_cursor';
+import { type AbstractCursorOptions, type CursorTimeoutMode } from '../cursor/abstract_cursor';
 import { MongoCompatibilityError } from '../error';
 import { type OneOrMore } from '../mongo_types';
 import type { Server } from '../sdam/server';
@@ -360,7 +360,9 @@ export class DropIndexOperation extends CommandOperation<Document> {
 }
 
 /** @public */
-export type ListIndexesOptions = AbstractCursorOptions;
+export type ListIndexesOptions = AbstractCursorOptions & {
+  timeoutMode?: CursorTimeoutMode;
+};
 
 /** @internal */
 export class ListIndexesOperation extends CommandOperation<CursorResponse> {

src/operations/list_collections.ts

@@ -1,5 +1,6 @@
 import type { Binary, Document } from '../bson';
 import { CursorResponse } from '../cmap/wire_protocol/responses';
+import { type CursorTimeoutMode } from '../cursor/abstract_cursor';
 import type { Db } from '../db';
 import type { Server } from '../sdam/server';
 import type { ClientSession } from '../sessions';
@@ -16,6 +17,8 @@ export interface ListCollectionsOptions extends Omit<CommandOperationOptions, 'w
   authorizedCollections?: boolean;
   /** The batchSize for the returned command cursor or if pre 2.8 the systems batch collection */
   batchSize?: number;
+  /** @internal */
+  timeoutMode?: CursorTimeoutMode;
 }
 
 /** @internal */