fix: Make Denque types more acurate and break out constructor types.

Author: nbbeeken

src/change_stream.ts

@@ -1,5 +1,5 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const Denque = require('denque') as DenqueLike;
+const Denque = require('denque') as DenqueConstructor;
 import { MongoError, AnyError, isResumableError } from './error';
 import { AggregateOperation, AggregateOptions } from './operations/aggregate';
 import {
@@ -27,7 +27,13 @@ import {
 } from './cursor/abstract_cursor';
 import type { ClientSession } from './sessions';
 import { executeOperation, ExecutionResult } from './operations/execute_operation';
-import { DenqueLike, InferIdType, Nullable, TypedEventEmitter } from './mongo_types';
+import {
+  DenqueConstructor,
+  DenqueLike,
+  InferIdType,
+  Nullable,
+  TypedEventEmitter
+} from './mongo_types';
 
 /** @internal */
 const kResumeQueue = Symbol('resumeQueue');

src/cmap/connection_pool.ts

@@ -1,5 +1,5 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const Denque = require('denque') as DenqueLike;
+const Denque = require('denque') as DenqueConstructor;
 import { Logger } from '../logger';
 import { APM_EVENTS, Connection, ConnectionEvents, ConnectionOptions } from './connection';
 import { connect } from './connect';
@@ -18,7 +18,12 @@ import {
   ConnectionCheckedInEvent,
   ConnectionPoolClearedEvent
 } from './connection_pool_events';
-import { CancellationToken, DenqueLike, TypedEventEmitter } from '../mongo_types';
+import {
+  CancellationToken,
+  DenqueConstructor,
+  DenqueLike,
+  TypedEventEmitter
+} from '../mongo_types';
 
 /** @internal */
 const kLogger = Symbol('logger');

src/index.ts

@@ -366,5 +366,6 @@ export type {
   ProjectionOperators,
   MetaProjectionOperators,
   MetaSortOperators,
-  DenqueLike
+  DenqueLike,
+  DenqueConstructor
 } from './mongo_types';

src/mongo_types.ts

@@ -179,14 +179,30 @@ export class TypedEventEmitter<Events extends EventsDescription> extends EventEm
 /** @public */
 export class CancellationToken extends TypedEventEmitter<{ cancel(): void }> {}
 
+/** @internal */
+export type DenqueConstructor = {
+  new <T = any>(): DenqueLike<T>;
+  new <T = any>(array: T[]): DenqueLike<T>;
+  new <T = any>(array: T[], options: { capacity?: number }): DenqueLike<T>;
+};
+
 /** @internal */
 export type DenqueLike<T = any> = {
-  new (): DenqueLike<T>;
+  push(item: T): number;
+  unshift(item: T): number;
+  pop(): T | undefined;
+  removeBack(): T | undefined;
   shift(): T | undefined;
-  push(item: T): void;
-  pop(): T;
-  peekFront(): T;
-  toArray(): T[];
+  peekBack(): T | undefined;
+  peekFront(): T | undefined;
+  peekAt(index: number): T | undefined;
+  get(index: number): T | undefined;
+  remove(index: number, count: number): T[];
+  removeOne(index: number): T | undefined;
+  splice(index: number, count: number, ...item: T[]): T[] | undefined;
+  isEmpty(): boolean;
   clear(): void;
+  toString(): string;
+  toArray(): T[];
   readonly length: number;
 };

src/sdam/topology.ts

@@ -1,5 +1,5 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
-const Denque = require('denque') as DenqueLike;
+const Denque = require('denque') as DenqueConstructor;
 import { ReadPreference, ReadPreferenceLike } from '../read_preference';
 import { compareTopologyVersion, ServerDescription } from './server_description';
 import { TopologyDescription } from './topology_description';
@@ -53,7 +53,7 @@ import { DestroyOptions, Connection, ConnectionEvents } from '../cmap/connection
 import type { MongoOptions, ServerApi } from '../mongo_client';
 import { DEFAULT_OPTIONS } from '../connection_string';
 import { serialize, deserialize } from '../bson';
-import { DenqueLike, TypedEventEmitter } from '../mongo_types';
+import { DenqueConstructor, DenqueLike, TypedEventEmitter } from '../mongo_types';
 
 // Global state
 let globalTopologyCounter = 0;