mongoose 6.3.4 → 6.3.7

package/types/connection.d.ts

@@ -2,16 +2,36 @@ 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, callback: CallbackWithoutResult): void;
+  function connect(uri: string, callback: CallbackWithoutResult): void;
+  function connect(uri: string, options?: ConnectOptions): Promise<Mongoose>;
+
+  /** Creates a Connection instance. */
+  function createConnection(uri: string, options: ConnectOptions, callback: Callback<Connection>): void;
+  function createConnection(uri: string, callback: Callback<Connection>): void;
+  function createConnection(uri: string, options?: ConnectOptions): Connection;
+  function createConnection(): Connection;
+
+  function disconnect(callback: CallbackWithoutResult): void;
+  function disconnect(): Promise<void>;
+
   /**
-     * Connection ready state
-     *
-     * - 0 = disconnected
-     * - 1 = connected
-     * - 2 = connecting
-     * - 3 = disconnecting
-     * - 99 = uninitialized
-     */
-  export enum ConnectionStates {
+   * Connection ready state
+   *
+   * - 0 = disconnected
+   * - 1 = connected
+   * - 2 = connecting
+   * - 3 = disconnecting
+   * - 99 = uninitialized
+   */
+  enum ConnectionStates {
     disconnected = 0,
     connected = 1,
     connecting = 2,
@@ -20,7 +40,7 @@ declare module 'mongoose' {
   }
 
   /** Expose connection states for user-land */
-  export const STATES: typeof ConnectionStates;
+  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. */
@@ -37,7 +57,7 @@ declare module 'mongoose' {
     autoCreate?: boolean;
   }
 
-  class Connection extends events.EventEmitter {
+  class Connection extends events.EventEmitter implements SessionStarter {
     /** Returns a promise that resolves when this connection successfully connects to MongoDB */
     asPromise(): Promise<this>;
 
@@ -59,32 +79,32 @@ declare module 'mongoose' {
     readonly db: mongodb.Db;
 
     /**
-       * Helper for `createCollection()`. Will explicitly create the given collection
-       * with specified options. Used to create [capped collections](https://docs.mongodb.com/manual/core/capped-collections/)
-       * and [views](https://docs.mongodb.com/manual/core/views/) from mongoose.
-       */
+     * Helper for `createCollection()`. Will explicitly create the given collection
+     * with specified options. Used to create [capped collections](https://docs.mongodb.com/manual/core/capped-collections/)
+     * and [views](https://docs.mongodb.com/manual/core/views/) from mongoose.
+     */
     createCollection<T extends AnyObject = AnyObject>(name: string, options: mongodb.CreateCollectionOptions, callback: Callback<mongodb.Collection<T>>): void;
     createCollection<T extends AnyObject = AnyObject>(name: string, callback: Callback<mongodb.Collection<T>>): void;
     createCollection<T extends AnyObject = AnyObject>(name: string, options?: mongodb.CreateCollectionOptions): Promise<mongodb.Collection<T>>;
 
     /**
-       * 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.
-       */
+     * 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.
-       */
+     * Helper for `dropCollection()`. Will delete the given collection, including
+     * all documents and indexes.
+     */
     dropCollection(collection: string, callback: CallbackWithoutResult): void;
     dropCollection(collection: string): Promise<void>;
 
     /**
-       * Helper for `dropDatabase()`. Deletes the given database, including all
-       * collections, documents, and indexes.
-       */
+     * Helper for `dropDatabase()`. Deletes the given database, including all
+     * collections, documents, and indexes.
+     */
     dropDatabase(callback: CallbackWithoutResult): void;
     dropDatabase(): Promise<void>;
 
@@ -92,28 +112,28 @@ declare module 'mongoose' {
     get(key: string): any;
 
     /**
-       * Returns the [MongoDB driver `MongoClient`](http://mongodb.github.io/node-mongodb-native/3.5/api/MongoClient.html) instance
-       * that this connection uses to talk to MongoDB.
-       */
+     * Returns the [MongoDB driver `MongoClient`](http://mongodb.github.io/node-mongodb-native/3.5/api/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
-       */
+     * 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).
-       */
+     * A number identifier for this connection. Used for debugging when
+     * you have [multiple connections](/docs/connections.html#multiple_connections).
+     */
     readonly id: number;
 
     /**
-       * 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).
-       */
+     * 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. */
@@ -140,9 +160,9 @@ declare module 'mongoose' {
     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.
-       */
+     * 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()` */
@@ -152,51 +172,51 @@ declare module 'mongoose' {
     plugins: Array<any>;
 
     /**
-       * Connection ready state
-       *
-       * - 0 = disconnected
-       * - 1 = connected
-       * - 2 = connecting
-       * - 3 = disconnecting
-       * - 99 = uninitialized
-       */
+     * 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`](http://mongodb.github.io/node-mongodb-native/3.5/api/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.
-       */
+     * Set the [MongoDB driver `MongoClient`](http://mongodb.github.io/node-mongodb-native/3.5/api/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://docs.mongodb.com/manual/release-notes/3.6/#client-sessions)
-       * for benefits like causal consistency, [retryable writes](https://docs.mongodb.com/manual/core/retryable-writes/),
-       * and [transactions](http://thecodebarbarian.com/a-node-js-perspective-on-mongodb-4-transactions.html).
-       */
-    startSession(options: mongodb.ClientSessionOptions | undefined | null, callback: Callback<mongodb.ClientSession>): void;
-    startSession(callback: Callback<mongodb.ClientSession>): void;
-    startSession(options?: mongodb.ClientSessionOptions): Promise<mongodb.ClientSession>;
+     * _Requires MongoDB >= 3.6.0._ Starts a [MongoDB session](https://docs.mongodb.com/manual/release-notes/3.6/#client-sessions)
+     * for benefits like causal consistency, [retryable writes](https://docs.mongodb.com/manual/core/retryable-writes/),
+     * and [transactions](http://thecodebarbarian.com/a-node-js-perspective-on-mongodb-4-transactions.html).
+     */
+    startSession(options: ClientSessionOptions | undefined | null, callback: Callback<ClientSession>): void;
+    startSession(callback: Callback<ClientSession>): void;
+    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.
-       */
+     * 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 | undefined | null, callback: Callback<ConnectionSyncIndexesResult>): void;
     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(fn: (session: mongodb.ClientSession) => Promise<any>): Promise<void>;
+     * _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(fn: (session: mongodb.ClientSession) => Promise<any>, options?: mongodb.TransactionOptions): Promise<void>;
 
     /** Switches to a different database using the same connection pool. */
     useDb(name: string, options?: { useCache?: boolean, noListener?: boolean }): Connection;

package/types/document.d.ts

@@ -68,7 +68,7 @@ declare module 'mongoose' {
      * automatically set `session` if you `save()` a doc that you got from a
      * query with an associated session.
      */
-    $session(session?: mongodb.ClientSession | null): mongodb.ClientSession | null;
+    $session(session?: ClientSession | null): ClientSession | null;
 
     /** Alias for `set()`, used internally to avoid conflicts */
     $set(path: string, val: any, type: any, options?: any): this;

package/types/error.d.ts

@@ -3,7 +3,8 @@ declare class NativeError extends global.Error { }
 declare module 'mongoose' {
   import mongodb = require('mongodb');
 
-  type CallbackError = NativeError | null;
+  type CastError = Error.CastError;
+  type SyncIndexesError = Error.SyncIndexesError;
 
   class MongooseError extends global.Error {
     constructor(msg: string);
@@ -16,7 +17,10 @@ declare module 'mongoose' {
     static Messages: any;
   }
 
+  class Error extends MongooseError { }
+
   namespace Error {
+
     export class CastError extends MongooseError {
       name: 'CastError';
       stringValue: string;

package/types/helpers.d.ts

@@ -0,0 +1,32 @@
+declare module 'mongoose' {
+  import mongodb = require('mongodb');
+
+  /**
+   * Mongoose uses this function to get the current time when setting
+   * [timestamps](/docs/guide.html#timestamps). You may stub out this function
+   * using a tool like [Sinon](https://www.npmjs.com/package/sinon) for testing.
+   */
+  function now(): NativeDate;
+
+  /**
+   * Tells `sanitizeFilter()` to skip the given object when filtering out potential query selector injection attacks.
+   * Use this method when you have a known query selector that you want to use.
+   */
+  function trusted<T>(obj: T): T;
+
+  /**
+   * Returns true if the given value is a Mongoose ObjectId (using `instanceof`) or if the
+   * given value is a 24 character hex string, which is the most commonly used string representation
+   * of an ObjectId.
+   */
+  function isObjectIdOrHexString(v: mongodb.ObjectId): true;
+  function isObjectIdOrHexString(v: mongodb.ObjectId | string): boolean;
+  function isObjectIdOrHexString(v: any): false;
+
+  /**
+   * Returns true if Mongoose can cast the given value to an ObjectId, or
+   * false otherwise.
+   */
+  function isValidObjectId(v: mongodb.ObjectId | Types.ObjectId): true;
+  function isValidObjectId(v: any): boolean;
+}