@depup/mongoose 9.1.3-depup.0

package/types/connection.d.ts

@@ -0,0 +1,297 @@
+declare module 'mongoose' {
+  import mongodb = require('mongodb');
+  import events = require('events');
+
+  /** The Mongoose module's default connection. Equivalent to `mongoose.connections[0]`, see [`connections`](#mongoose_Mongoose-connections). */
+  const connection: Connection;
+
+  /** An array containing all connections associated with this Mongoose instance. */
+  const connections: Connection[];
+
+  /** Opens Mongoose's default connection to MongoDB, see [connections docs](https://mongoosejs.com/docs/connections.html) */
+  function connect(uri: string, options?: ConnectOptions): Promise<Mongoose>;
+
+  /** Creates a Connection instance. */
+  function createConnection(uri: string, options?: ConnectOptions): Connection;
+  function createConnection(): Connection;
+
+  function disconnect(): Promise<void>;
+
+  /**
+   * Connection ready state
+   *
+   * - 0 = disconnected
+   * - 1 = connected
+   * - 2 = connecting
+   * - 3 = disconnecting
+   * - 99 = uninitialized
+   */
+  enum ConnectionStates {
+    disconnected = 0,
+    connected = 1,
+    connecting = 2,
+    disconnecting = 3,
+    uninitialized = 99,
+  }
+
+  /** Expose connection states for user-land */
+  const STATES: typeof ConnectionStates;
+
+  interface ConnectOptions extends mongodb.MongoClientOptions {
+    /** Set to false to [disable buffering](http://mongoosejs.com/docs/faq.html#callback_never_executes) on all models associated with this connection. */
+    bufferCommands?: boolean;
+    /** The name of the database you want to use. If not provided, Mongoose uses the database name from connection string. */
+    dbName?: string;
+    /** username for authentication, equivalent to `options.auth.user`. Maintained for backwards compatibility. */
+    user?: string;
+    /** password for authentication, equivalent to `options.auth.password`. Maintained for backwards compatibility. */
+    pass?: string;
+    /** Set to false to disable automatic index creation for all models associated with this connection. */
+    autoIndex?: boolean;
+    /** Set to `false` to disable Mongoose automatically calling `createCollection()` on every model created on this connection. */
+    autoCreate?: boolean;
+    /**
+     * Sanitizes query filters against [query selector injection attacks](
+     * https://thecodebarbarian.com/2014/09/04/defending-against-query-selector-injection-attacks.html
+     * ) by wrapping any nested objects that have a property whose name starts with $ in a $eq.
+     */
+    sanitizeFilter?: boolean;
+  }
+
+  export type AnyConnectionBulkWriteModel<TSchema extends AnyObject> = Omit<mongodb.ClientInsertOneModel<TSchema>, 'namespace'>
+    | Omit<mongodb.ClientReplaceOneModel<TSchema>, 'namespace'>
+    | Omit<mongodb.ClientUpdateOneModel<TSchema>, 'namespace'>
+    | Omit<mongodb.ClientUpdateManyModel<TSchema>, 'namespace'>
+    | Omit<mongodb.ClientDeleteOneModel<TSchema>, 'namespace'>
+    | Omit<mongodb.ClientDeleteManyModel<TSchema>, 'namespace'>;
+
+  export type ConnectionBulkWriteModel<SchemaMap extends Record<string, AnyObject> = Record<string, AnyObject>> = {
+      [ModelName in keyof SchemaMap]: AnyConnectionBulkWriteModel<SchemaMap[ModelName]> & {
+          model: ModelName;
+      };
+  }[keyof SchemaMap];
+
+  class Connection extends events.EventEmitter implements SessionStarter {
+    /** Runs a [db-level aggregate()](https://www.mongodb.com/docs/manual/reference/method/db.aggregate/) on this connection's underlying `db` */
+    aggregate<ResultType = unknown>(pipeline?: PipelineStage[] | null, options?: AggregateOptions): Aggregate<Array<ResultType>>;
+
+    /** Returns a promise that resolves when this connection successfully connects to MongoDB */
+    asPromise(): Promise<this>;
+
+    /** The Mongoose instance this connection is associated with */
+    base: Mongoose;
+
+    bulkWrite<TSchemaMap extends Record<string, AnyObject>>(
+      ops: Array<ConnectionBulkWriteModel<TSchemaMap>>,
+      options: mongodb.ClientBulkWriteOptions & { ordered: false }
+    ): Promise<mongodb.ClientBulkWriteResult & { mongoose?: { validationErrors: Error[], results: Array<Error | mongodb.WriteError | null> } }>;
+    bulkWrite<TSchemaMap extends Record<string, AnyObject>>(
+      ops: Array<ConnectionBulkWriteModel<TSchemaMap>>,
+      options?: mongodb.ClientBulkWriteOptions
+    ): Promise<mongodb.ClientBulkWriteResult>;
+
+    /** Closes the connection */
+    close(force?: boolean): Promise<void>;
+
+    /** Closes and destroys the connection. Connection once destroyed cannot be reopened */
+    destroy(force?: boolean): Promise<void>;
+
+    /** Retrieves a collection, creating it if not cached. */
+    collection<T extends AnyObject = AnyObject>(name: string, options?: mongodb.CreateCollectionOptions): Collection<T>;
+
+    /** A hash of the collections associated with this connection */
+    readonly collections: { [index: string]: Collection };
+
+    /** A hash of the global options that are associated with this connection */
+    readonly config: any;
+
+    /** The mongodb.Db instance, set when the connection is opened */
+    readonly db: mongodb.Db | undefined;
+
+    /**
+     * Helper for `createCollection()`. Will explicitly create the given collection
+     * with specified options. Used to create [capped collections](https://www.mongodb.com/docs/manual/core/capped-collections/)
+     * and [views](https://www.mongodb.com/docs/manual/core/views/) from mongoose.
+     */
+    createCollection<T extends AnyObject = AnyObject>(name: string, options?: mongodb.CreateCollectionOptions): Promise<mongodb.Collection<T>>;
+
+    /**
+     * https://mongoosejs.com/docs/api/connection.html#Connection.prototype.createCollections()
+     */
+    createCollections(continueOnError?: boolean): Promise<Record<string, Error | mongodb.Collection<any>>>;
+
+    /**
+     * Removes the model named `name` from this connection, if it exists. You can
+     * use this function to clean up any models you created in your tests to
+     * prevent OverwriteModelErrors.
+     */
+    deleteModel(name: string | RegExp): this;
+
+    /**
+     * Helper for `dropCollection()`. Will delete the given collection, including
+     * all documents and indexes.
+     */
+    dropCollection(collection: string): Promise<void>;
+
+    /**
+     * Helper for `dropDatabase()`. Deletes the given database, including all
+     * collections, documents, and indexes.
+     */
+    dropDatabase(): Promise<void>;
+
+    /** Gets the value of the option `key`. */
+    get(key: string): any;
+
+    /**
+     * Returns the [MongoDB driver `MongoClient`](https://mongodb.github.io/node-mongodb-native/4.9/classes/MongoClient.html) instance
+     * that this connection uses to talk to MongoDB.
+     */
+    getClient(): mongodb.MongoClient;
+
+    /**
+     * The host name portion of the URI. If multiple hosts, such as a replica set,
+     * this will contain the first host name in the URI
+     */
+    readonly host: string;
+
+    /**
+     * A number identifier for this connection. Used for debugging when
+     * you have [multiple connections](/docs/connections.html#multiple_connections).
+     */
+    readonly id: number;
+
+    /**
+     * Helper for MongoDB Node driver's `listCollections()`.
+     * Returns an array of collection names.
+     */
+    listCollections(): Promise<Pick<mongodb.CollectionInfo, 'name' | 'type'>[]>;
+
+    /**
+     * Helper for MongoDB Node driver's `listDatabases()`.
+     * Returns an array of database names.
+     */
+    listDatabases(): Promise<mongodb.ListDatabasesResult>;
+
+    /**
+     * A [POJO](https://masteringjs.io/tutorials/fundamentals/pojo) containing
+     * a map from model names to models. Contains all models that have been
+     * added to this connection using [`Connection#model()`](/docs/api/connection.html#connection_Connection-model).
+     */
+    readonly models: Readonly<{ [index: string]: Model<any> }>;
+
+    /** Defines or retrieves a model. */
+    model<TSchema extends Schema = any>(
+      name: string,
+      schema?: TSchema,
+      collection?: string,
+      options?: CompileModelOptions
+    ): Model<
+      InferSchemaType<TSchema>,
+      ObtainSchemaGeneric<TSchema, 'TQueryHelpers'>,
+      ObtainSchemaGeneric<TSchema, 'TInstanceMethods'>,
+      ObtainSchemaGeneric<TSchema, 'TVirtuals'>,
+      // If first schema generic param is set, that means we have an explicit raw doc type,
+      // so user should also specify a hydrated doc type if the auto inferred one isn't correct.
+      IsItRecordAndNotAny<ObtainSchemaGeneric<TSchema, 'EnforcedDocType'>> extends true
+        ? ObtainSchemaGeneric<TSchema, 'THydratedDocumentType'>
+        : HydratedDocument<
+          InferSchemaType<TSchema>,
+          ObtainSchemaGeneric<TSchema, 'TVirtuals'> & ObtainSchemaGeneric<TSchema, 'TInstanceMethods'>,
+          ObtainSchemaGeneric<TSchema, 'TQueryHelpers'>,
+          ObtainSchemaGeneric<TSchema, 'TVirtuals'>,
+          InferSchemaType<TSchema>,
+          ObtainSchemaGeneric<TSchema, 'TSchemaOptions'>
+        >,
+      TSchema,
+      ObtainSchemaGeneric<TSchema, 'TLeanResultType'>
+    > & ObtainSchemaGeneric<TSchema, 'TStaticMethods'>;
+    model<T, U, TQueryHelpers = {}>(
+      name: string,
+      schema?: Schema<T, any, any, TQueryHelpers, any, any, any>,
+      collection?: string,
+      options?: CompileModelOptions
+    ): U;
+    model<T>(name: string, schema?: Schema<T, any, any>, collection?: string, options?: CompileModelOptions): Model<T>;
+
+    /** Returns an array of model names created on this connection. */
+    modelNames(): Array<string>;
+
+    /** The name of the database this connection points to. */
+    readonly name: string;
+
+    /** Opens the connection with a URI using `MongoClient.connect()`. */
+    openUri(uri: string, options?: ConnectOptions): Promise<Connection>;
+
+    /** The password specified in the URI */
+    readonly pass: string;
+
+    /**
+     * The port portion of the URI. If multiple hosts, such as a replica set,
+     * this will contain the port from the first host name in the URI.
+     */
+    readonly port: number;
+
+    /** Declares a plugin executed on all schemas you pass to `conn.model()` */
+    plugin<S extends Schema = Schema, O = AnyObject>(fn: (schema: S, opts?: any) => void, opts?: O): Connection;
+
+    /** The plugins that will be applied to all models created on this connection. */
+    plugins: Array<any>;
+
+    /**
+     * Connection ready state
+     *
+     * - 0 = disconnected
+     * - 1 = connected
+     * - 2 = connecting
+     * - 3 = disconnecting
+     * - 99 = uninitialized
+     */
+    readonly readyState: ConnectionStates;
+
+    /** Sets the value of the option `key`. */
+    set(key: string, value: any): any;
+
+    /**
+     * Set the [MongoDB driver `MongoClient`](https://mongodb.github.io/node-mongodb-native/4.9/classes/MongoClient.html) instance
+     * that this connection uses to talk to MongoDB. This is useful if you already have a MongoClient instance, and want to
+     * reuse it.
+     */
+    setClient(client: mongodb.MongoClient): this;
+
+    /**
+     * _Requires MongoDB >= 3.6.0._ Starts a [MongoDB session](https://www.mongodb.com/docs/manual/release-notes/3.6/#client-sessions)
+     * for benefits like causal consistency, [retryable writes](https://www.mongodb.com/docs/manual/core/retryable-writes/),
+     * and [transactions](http://thecodebarbarian.com/a-node-js-perspective-on-mongodb-4-transactions.html).
+     */
+    startSession(options?: ClientSessionOptions): Promise<ClientSession>;
+
+    /**
+     * Makes the indexes in MongoDB match the indexes defined in every model's
+     * schema. This function will drop any indexes that are not defined in
+     * the model's schema except the `_id` index, and build any indexes that
+     * are in your schema but not in MongoDB.
+     */
+    syncIndexes(options?: SyncIndexesOptions): Promise<ConnectionSyncIndexesResult>;
+
+    /**
+     * _Requires MongoDB >= 3.6.0._ Executes the wrapped async function
+     * in a transaction. Mongoose will commit the transaction if the
+     * async function executes successfully and attempt to retry if
+     * there was a retryable error.
+     */
+    transaction<ReturnType = unknown>(fn: (session: mongodb.ClientSession) => Promise<ReturnType>, options?: mongodb.TransactionOptions): Promise<ReturnType>;
+
+    /** Switches to a different database using the same connection pool. */
+    useDb(name: string, options?: { useCache?: boolean }): Connection;
+
+    /** The username specified in the URI */
+    readonly user: string;
+
+    /** Watches the entire underlying database for changes. Similar to [`Model.watch()`](/docs/api/model.html#model_Model-watch). */
+    watch<ResultType extends mongodb.Document = any>(pipeline?: Array<any>, options?: mongodb.ChangeStreamOptions): mongodb.ChangeStream<ResultType>;
+
+    withSession<T = any>(executor: (session: ClientSession) => Promise<T>): Promise<T>;
+  }
+
+  export class BaseConnection extends Connection {}
+}

package/types/cursor.d.ts

@@ -0,0 +1,67 @@
+declare module 'mongoose' {
+
+  import stream = require('stream');
+
+  type CursorFlag = 'tailable' | 'oplogReplay' | 'noCursorTimeout' | 'awaitData' | 'partial';
+
+  interface EachAsyncOptions {
+    parallel?: number;
+    batchSize?: number;
+    continueOnError?: boolean;
+    signal?: AbortSignal;
+  }
+
+  class Cursor<DocType = any, Options = never, NextResultType = DocType | null> extends stream.Readable {
+    [Symbol.asyncIterator](): Cursor<IteratorResult<DocType>, Options, IteratorResult<DocType>>;
+
+    [Symbol.asyncDispose](): Promise<void>;
+
+    /**
+     * Adds a [cursor flag](https://mongodb.github.io/node-mongodb-native/4.9/classes/FindCursor.html#addCursorFlag).
+     * Useful for setting the `noCursorTimeout` and `tailable` flags.
+     */
+    addCursorFlag(flag: CursorFlag, value: boolean): this;
+
+    /**
+     * Marks this cursor as closed. Will stop streaming and subsequent calls to
+     * `next()` will error.
+     */
+    close(): Promise<void>;
+
+    /**
+     * Destroy this cursor, closing the underlying cursor. Will stop streaming
+     * and subsequent calls to `next()` will error.
+     */
+    destroy(): 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(): this;
+
+    /**
+     * Execute `fn` for every document(s) in the cursor. If batchSize is provided
+     * `fn` will be executed for each batch of documents. If `fn` returns a promise,
+     * will wait for the promise to resolve before iterating on to the next one.
+     * Returns a promise that resolves when done.
+     */
+    eachAsync(fn: (doc: DocType[], i: number) => any, options: EachAsyncOptions & { batchSize: number }): Promise<void>;
+    eachAsync(fn: (doc: DocType, i: number) => any, options?: EachAsyncOptions): Promise<void>;
+
+    /**
+     * Registers a transform function which subsequently maps documents retrieved
+     * via the streams interface or `.next()`
+     */
+    map<ResultType>(fn: (res: DocType) => ResultType): Cursor<ResultType, Options>;
+
+    /**
+     * Get the next document from this cursor. Will return `null` when there are
+     * no documents left.
+     */
+    next(): Promise<NextResultType>;
+
+    options: Options;
+  }
+}