@depup/mongoose 9.1.3-depup.0

package/lib/validOptions.js

@@ -0,0 +1,42 @@
+
+/*!
+ * Valid mongoose options
+ */
+
+'use strict';
+
+const VALID_OPTIONS = Object.freeze([
+  'allowDiskUse',
+  'applyPluginsToChildSchemas',
+  'applyPluginsToDiscriminators',
+  'autoCreate',
+  'autoIndex',
+  'autoSearchIndex',
+  'bufferCommands',
+  'bufferTimeoutMS',
+  'cloneSchemas',
+  'createInitialConnection',
+  'debug',
+  'forceRepopulate',
+  'id',
+  'maxTimeMS',
+  'objectIdGetter',
+  'overwriteModels',
+  'returnOriginal',
+  'runValidators',
+  'sanitizeFilter',
+  'sanitizeProjection',
+  'selectPopulatedPaths',
+  'setDefaultsOnInsert',
+  'strict',
+  'strictPopulate',
+  'strictQuery',
+  'timestamps.createdAt.immutable',
+  'toJSON',
+  'toObject',
+  'transactionAsyncLocalStorage',
+  'translateAliases',
+  'updatePipeline'
+]);
+
+module.exports = VALID_OPTIONS;

package/lib/virtualType.js

@@ -0,0 +1,204 @@
+'use strict';
+
+const modelNamesFromRefPath = require('./helpers/populate/modelNamesFromRefPath');
+const utils = require('./utils');
+
+const modelSymbol = require('./helpers/symbols').modelSymbol;
+
+/**
+ * VirtualType constructor
+ *
+ * This is what mongoose uses to define virtual attributes via `Schema.prototype.virtual`.
+ *
+ * #### Example:
+ *
+ *     const fullname = schema.virtual('fullname');
+ *     fullname instanceof mongoose.VirtualType // true
+ *
+ * @param {Object} options
+ * @param {String|Function} [options.ref] if `ref` is not nullish, this becomes a [populated virtual](https://mongoosejs.com/docs/populate.html#populate-virtuals)
+ * @param {String|Function} [options.localField] the local field to populate on if this is a populated virtual.
+ * @param {String|Function} [options.foreignField] the foreign field to populate on if this is a populated virtual.
+ * @param {Boolean} [options.justOne=false] by default, a populated virtual is an array. If you set `justOne`, the populated virtual will be a single doc or `null`.
+ * @param {Boolean} [options.getters=false] if you set this to `true`, Mongoose will call any custom getters you defined on this virtual
+ * @param {Boolean} [options.count=false] if you set this to `true`, `populate()` will set this virtual to the number of populated documents, as opposed to the documents themselves, using [`Query#countDocuments()`](https://mongoosejs.com/docs/api/query.html#Query.prototype.countDocuments())
+ * @param {Object|Function} [options.match=null] add an extra match condition to `populate()`
+ * @param {Number} [options.limit=null] add a default `limit` to the `populate()` query
+ * @param {Number} [options.skip=null] add a default `skip` to the `populate()` query
+ * @param {Number} [options.perDocumentLimit=null] For legacy reasons, `limit` with `populate()` may give incorrect results because it only executes a single query for every document being populated. If you set `perDocumentLimit`, Mongoose will ensure correct `limit` per document by executing a separate query for each document to `populate()`. For example, `.find().populate({ path: 'test', perDocumentLimit: 2 })` will execute 2 additional queries if `.find()` returns 2 documents.
+ * @param {Object} [options.options=null] Additional options like `limit` and `lean`.
+ * @param {String} name
+ * @api public
+ */
+
+function VirtualType(options, name) {
+  this.path = name;
+  this.getters = [];
+  this.setters = [];
+  this.options = Object.assign({}, options);
+}
+
+/**
+ * If no getters/setters, add a default
+ *
+ * @api private
+ */
+
+VirtualType.prototype._applyDefaultGetters = function() {
+  if (this.getters.length > 0 || this.setters.length > 0) {
+    return;
+  }
+
+  const path = this.path;
+  const internalProperty = '$' + path;
+  this.getters.push(function() {
+    return this.$locals[internalProperty];
+  });
+  this.setters.push(function(v) {
+    this.$locals[internalProperty] = v;
+  });
+};
+
+/*!
+ * ignore
+ */
+
+VirtualType.prototype.clone = function() {
+  const clone = new VirtualType(this.options, this.path);
+  clone.getters = [].concat(this.getters);
+  clone.setters = [].concat(this.setters);
+  return clone;
+};
+
+/**
+ * Adds a custom getter to this virtual.
+ *
+ * Mongoose calls the getter function with the below 3 parameters.
+ *
+ * - `value`: the value returned by the previous getter. If there is only one getter, `value` will be `undefined`.
+ * - `virtual`: the virtual object you called `.get()` on.
+ * - `doc`: the document this virtual is attached to. Equivalent to `this`.
+ *
+ * #### Example:
+ *
+ *     const virtual = schema.virtual('fullname');
+ *     virtual.get(function(value, virtual, doc) {
+ *       return this.name.first + ' ' + this.name.last;
+ *     });
+ *
+ * @param {Function} fn
+ * @return {VirtualType} this
+ * @api public
+ */
+
+VirtualType.prototype.get = function(fn) {
+  this.getters.push(fn);
+  return this;
+};
+
+/**
+ * Adds a custom setter to this virtual.
+ *
+ * Mongoose calls the setter function with the below 3 parameters.
+ *
+ * - `value`: the value being set.
+ * - `virtual`: the virtual object you're calling `.set()` on.
+ * - `doc`: the document this virtual is attached to. Equivalent to `this`.
+ *
+ * #### Example:
+ *
+ *     const virtual = schema.virtual('fullname');
+ *     virtual.set(function(value, virtual, doc) {
+ *       const parts = value.split(' ');
+ *       this.name.first = parts[0];
+ *       this.name.last = parts[1];
+ *     });
+ *
+ *     const Model = mongoose.model('Test', schema);
+ *     const doc = new Model();
+ *     // Calls the setter with `value = 'Jean-Luc Picard'`
+ *     doc.fullname = 'Jean-Luc Picard';
+ *     doc.name.first; // 'Jean-Luc'
+ *     doc.name.last; // 'Picard'
+ *
+ * @param {Function} fn
+ * @return {VirtualType} this
+ * @api public
+ */
+
+VirtualType.prototype.set = function(fn) {
+  this.setters.push(fn);
+  return this;
+};
+
+/**
+ * Applies getters to `value`.
+ *
+ * @param {Object} value
+ * @param {Document} doc The document this virtual is attached to
+ * @return {Any} the value after applying all getters
+ * @api public
+ */
+
+VirtualType.prototype.applyGetters = function(value, doc) {
+  if (utils.hasUserDefinedProperty(this.options, ['ref', 'refPath']) &&
+      doc.$$populatedVirtuals &&
+      Object.hasOwn(doc.$$populatedVirtuals, this.path)) {
+    value = doc.$$populatedVirtuals[this.path];
+  }
+
+  let v = value;
+  for (const getter of this.getters) {
+    v = getter.call(doc, v, this, doc);
+  }
+  return v;
+};
+
+/**
+ * Applies setters to `value`.
+ *
+ * @param {Object} value
+ * @param {Document} doc
+ * @return {Any} the value after applying all setters
+ * @api public
+ */
+
+VirtualType.prototype.applySetters = function(value, doc) {
+  let v = value;
+  for (const setter of this.setters) {
+    v = setter.call(doc, v, this, doc);
+  }
+  return v;
+};
+
+/**
+ * Get the names of models used to populate this model given a doc
+ *
+ * @param {Document} doc
+ * @return {Array<string> | null}
+ * @api private
+ */
+
+VirtualType.prototype._getModelNamesForPopulate = function _getModelNamesForPopulate(doc) {
+  if (this.options.refPath) {
+    return modelNamesFromRefPath(this.options.refPath, doc, this.path);
+  }
+
+  let normalizedRef = null;
+  if (typeof this.options.ref === 'function' && !this.options.ref[modelSymbol]) {
+    normalizedRef = this.options.ref.call(doc, doc);
+  } else {
+    normalizedRef = this.options.ref;
+  }
+  if (normalizedRef != null && !Array.isArray(normalizedRef)) {
+    return [normalizedRef];
+  }
+
+  return normalizedRef;
+};
+
+/*!
+ * exports
+ */
+
+module.exports = VirtualType;

package/package.json

@@ -0,0 +1,148 @@
+{
+  "name": "@depup/mongoose",
+  "description": "Mongoose MongoDB ODM",
+  "version": "9.1.3-depup.0",
+  "author": "Guillermo Rauch <guillermo@learnboost.com>",
+  "keywords": [
+    "mongodb",
+    "document",
+    "model",
+    "schema",
+    "database",
+    "odm",
+    "data",
+    "datastore",
+    "query",
+    "nosql",
+    "orm",
+    "db"
+  ],
+  "type": "commonjs",
+  "license": "MIT",
+  "dependencies": {
+    "kareem": "^3.1.0",
+    "mongodb": "~7.0",
+    "mpath": "0.9.0",
+    "mquery": "6.0.0",
+    "ms": "2.1.3",
+    "sift": "17.1.3"
+  },
+  "devDependencies": {
+    "@ark/attest": "0.56.0",
+    "@mongodb-js/mongodb-downloader": "^1.1.4",
+    "acquit": "1.4.0",
+    "acquit-ignore": "^0.2.2",
+    "acquit-require": "0.1.1",
+    "ajv": "8.17.1",
+    "broken-link-checker": "^0.7.8",
+    "cheerio": "1.1.2",
+    "dox": "1.0.0",
+    "eslint": "9.39.2",
+    "eslint-plugin-markdown": "^5.1.0",
+    "eslint-plugin-mocha-no-only": "1.2.0",
+    "express": "^5.2.1",
+    "fs-extra": "^11.3.3",
+    "highlight.js": "11.11.1",
+    "lodash.isequal": "4.5.0",
+    "lodash.isequalwith": "4.4.0",
+    "markdownlint-cli2": "^0.20.0",
+    "marked": "15.x",
+    "mkdirp": "^3.0.1",
+    "mocha": "11.7.5",
+    "moment": "2.30.1",
+    "mongodb-memory-server": "11.0.1",
+    "mongodb-runner": "^6.5.2",
+    "mongodb-client-encryption": "~7.0",
+    "ncp": "^2.0.0",
+    "nyc": "^17.1.0",
+    "pug": "3.0.3",
+    "sinon": "21.0.1",
+    "tsd": "0.33.0",
+    "typescript": "5.9.3",
+    "typescript-eslint": "^8.53.0",
+    "uuid": "^13.0.0"
+  },
+  "directories": {
+    "lib": "./lib/mongoose"
+  },
+  "scripts": {
+    "docs:clean": "npm run docs:clean:stable",
+    "docs:clean:stable": "rimraf index.html && rimraf -rf ./docs/*.html  && rimraf -rf ./docs/api && rimraf -rf ./docs/tutorials/*.html && rimraf -rf ./docs/typescript/*.html && rimraf -rf ./docs/*.html && rimraf -rf ./docs/source/_docs && rimraf -rf ./tmp",
+    "docs:clean:5x": "rimraf index.html && rimraf -rf ./docs/5.x && rimraf -rf ./docs/source/_docs && rimraf -rf ./tmp",
+    "docs:clean:6x": "rimraf index.html && rimraf -rf ./docs/6.x && rimraf -rf ./docs/source/_docs && rimraf -rf ./tmp",
+    "docs:copy:tmp": "mkdirp ./tmp/docs/css && mkdirp ./tmp/docs/js && mkdirp ./tmp/docs/images && mkdirp ./tmp/docs/tutorials && mkdirp ./tmp/docs/typescript && mkdirp ./tmp/docs/api && ncp ./docs/css ./tmp/docs/css --filter=.css$ && ncp ./docs/js ./tmp/docs/js --filter=.js$ && ncp ./docs/images ./tmp/docs/images && ncp ./docs/tutorials ./tmp/docs/tutorials && ncp ./docs/typescript ./tmp/docs/typescript && ncp ./docs/api ./tmp/docs/api && cp index.html ./tmp && cp docs/*.html ./tmp/docs/",
+    "docs:copy:tmp:5x": "rimraf ./docs/5.x && ncp ./tmp ./docs/5.x",
+    "docs:copy:tmp:6x": "rimraf ./docs/6.x && ncp ./tmp ./docs/6.x",
+    "docs:generate": "node ./scripts/website.js",
+    "docs:generate:sponsorData": "node ./scripts/loadSponsorData.js",
+    "docs:test": "npm run docs:generate",
+    "docs:view": "node ./scripts/static.js",
+    "docs:prepare:publish:stable": "git checkout gh-pages && git merge master && npm run docs:generate",
+    "docs:prepare:publish:5x": "git checkout 5.x && git merge 5.x && npm run docs:clean:stable && npm run docs:generate && npm run docs:copy:tmp && git checkout gh-pages && npm run docs:copy:tmp:5x",
+    "docs:prepare:publish:6x": "git checkout 6.x && git merge 6.x && npm run docs:clean:stable && env DOCS_DEPLOY=true npm run docs:generate && mv ./docs/6.x ./tmp && git checkout gh-pages && npm run docs:copy:tmp:6x",
+    "docs:prepare:publish:7x": "env DOCS_DEPLOY=true npm run docs:generate && git checkout gh-pages && rimraf ./docs/7.x && mv ./tmp ./docs/7.x",
+    "docs:prepare:publish:8x": "env DOCS_DEPLOY=true npm run docs:generate && git checkout gh-pages && rimraf ./docs/8.x && mv ./tmp ./docs/8.x",
+    "docs:check-links": "blc http://127.0.0.1:8089 -ro",
+    "lint": "eslint .",
+    "lint-js": "eslint . --ext .js --ext .cjs",
+    "lint-ts": "eslint . --ext .ts",
+    "lint-md": "markdownlint-cli2 \"**/*.md\" \"#node_modules\" \"#benchmarks\"",
+    "release": "git pull && git push origin master --tags && npm publish",
+    "release-5x": "git pull origin 5.x && git push origin 5.x && git push origin 5.x --tags && npm publish --tag 5x",
+    "release-6x": "git pull origin 6.x && git push origin 6.x && git push origin 6.x --tags && npm publish --tag 6x",
+    "mongo": "node ./tools/repl.js",
+    "publish-7x": "npm publish --tag 7x",
+    "create-separate-require-instance": "rm -rf ./node_modules/mongoose-separate-require-instance && node ./scripts/create-tarball && tar -xzf mongoose.tgz -C ./node_modules && mv ./node_modules/package ./node_modules/mongoose-separate-require-instance",
+    "test": "mocha --exit ./test/*.test.js",
+    "test:ci": "npm run test -- --reporter min",
+    "test-deno": "deno run --allow-env --allow-read --allow-net --allow-run --allow-sys --allow-write ./test/deno.mjs",
+    "test-deno:ci": "npm run test-deno -- --reporter min",
+    "test-rs": "START_REPLICA_SET=1 mocha --timeout 30000 --exit ./test/*.test.js",
+    "test-rs:ci": "npm run test-rs -- --reporter min",
+    "test-tsd": "node ./test/types/check-types-filename && tsd --full",
+    "setup-test-encryption": "node scripts/setup-encryption-tests.js",
+    "test-encryption": "mocha --exit ./test/encryption/*.test.js",
+    "test-encryption:ci": "npm run test-encryption -- --reporter min",
+    "tdd": "mocha --watch --inspect --recursive ./test/*.test.js --watch-files lib/**/*.js test/**/*.js",
+    "test-coverage": "nyc --reporter=html --reporter=text npm test",
+    "test-coverage:ci": "nyc --reporter=html --reporter=text npm run test:ci",
+    "ts-benchmark": "cd ./benchmarks/typescript/simple && npm install && npm run benchmark | node ../../../scripts/tsc-diagnostics-check",
+    "ts-benchmark:local": "node ./scripts/create-tarball && cd ./benchmarks/typescript/simple && rm -rf ./node_modules && npm install && npm run benchmark | node ../../../scripts/tsc-diagnostics-check",
+    "attest-benchmark": "node ./benchmarks/typescript/infer.bench.mts"
+  },
+  "main": "./index.js",
+  "types": "./types/index.d.ts",
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "bugs": {
+    "url": "https://github.com/Automattic/mongoose/issues/new"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/Automattic/mongoose.git"
+  },
+  "homepage": "https://mongoosejs.com",
+  "config": {
+    "mongodbMemoryServer": {
+      "disablePostinstall": true
+    }
+  },
+  "funding": {
+    "type": "opencollective",
+    "url": "https://opencollective.com/mongoose"
+  },
+  "tsd": {
+    "directory": "test/types",
+    "compilerOptions": {
+      "esModuleInterop": false,
+      "strict": true,
+      "allowSyntheticDefaultImports": true,
+      "strictPropertyInitialization": false,
+      "noImplicitAny": false,
+      "strictNullChecks": true,
+      "module": "commonjs",
+      "target": "ES2022"
+    }
+  }
+}

package/types/aggregate.d.ts

@@ -0,0 +1,180 @@
+declare module 'mongoose' {
+  import mongodb = require('mongodb');
+
+  /** Extract generic type from Aggregate class */
+  type AggregateExtract<P> = P extends Aggregate<infer T> ? T : never;
+
+  interface AggregateOptions extends Omit<mongodb.AggregateOptions & mongodb.Abortable, 'session'>, SessionOption {
+    [key: string]: any;
+  }
+
+  class Aggregate<ResultType> implements SessionOperation {
+    /**
+     * Returns an asyncIterator for use with [`for/await/of` loops](https://thecodebarbarian.com/getting-started-with-async-iterators-in-node-js)
+     * You do not need to call this function explicitly, the JavaScript runtime
+     * will call it for you.
+     */
+    [Symbol.asyncIterator](): AsyncIterableIterator<Unpacked<ResultType>>;
+
+    // Returns a string representation of this aggregation.
+    [Symbol.toStringTag]: string;
+
+    options: AggregateOptions;
+
+    /**
+     * Sets an option on this aggregation. This function will be deprecated in a
+     * future release.
+     *
+     * @deprecated
+     */
+    addCursorFlag(flag: CursorFlag, value: boolean): this;
+
+    /**
+     * Appends a new $addFields operator to this aggregate pipeline.
+     * Requires MongoDB v3.4+ to work
+     */
+    addFields(arg: PipelineStage.AddFields['$addFields']): this;
+
+    /** Sets the allowDiskUse option for the aggregation query */
+    allowDiskUse(value: boolean): this;
+
+    /** Appends new operators to this aggregate pipeline */
+    append(...args: PipelineStage[]): this;
+
+    /**
+     * Executes the query returning a `Promise` which will be
+     * resolved with either the doc(s) or rejected with the error.
+     * Like [`.then()`](#query_Query-then), but only takes a rejection handler.
+     */
+    catch: Promise<ResultType>['catch'];
+
+    /** Set the collation. */
+    collation(options: mongodb.CollationOptions): this;
+
+    /** Appends a new $count operator to this aggregate pipeline. */
+    count(fieldName: PipelineStage.Count['$count']): this;
+
+    /** Appends a new $densify operator to this aggregate pipeline */
+    densify(arg: PipelineStage.Densify['$densify']): this;
+
+    /**
+     * Sets the cursor option for the aggregation query
+     */
+    cursor<DocType = any>(options?: Record<string, unknown>): Cursor<DocType>;
+
+
+    /** Executes the aggregate pipeline on the currently bound Model. */
+    exec(): Promise<ResultType>;
+
+    /** Execute the aggregation with explain */
+    explain(verbosity: mongodb.ExplainVerbosityLike): Promise<AnyObject>;
+    explain(): Promise<AnyObject>;
+
+    /** Combines multiple aggregation pipelines. */
+    facet(options: PipelineStage.Facet['$facet']): this;
+
+    /** Appends a new $fill operator to this aggregate pipeline */
+    fill(arg: PipelineStage.Fill['$fill']): this;
+
+    /**
+     * Executes the aggregation returning a `Promise` which will be
+     * resolved with `.finally()` chained.
+     */
+    finally: Promise<ResultType>['finally'];
+
+    /** Appends new custom $graphLookup operator(s) to this aggregate pipeline, performing a recursive search on a collection. */
+    graphLookup(options: PipelineStage.GraphLookup['$graphLookup']): this;
+
+    /** Appends new custom $group operator to this aggregate pipeline. */
+    group(arg: PipelineStage.Group['$group']): this;
+
+    /** Sets the hint option for the aggregation query */
+    hint(value: Record<string, unknown> | string): this;
+
+    /**
+     * Appends a new $limit operator to this aggregate pipeline.
+     * @param num maximum number of records to pass to the next stage
+     */
+    limit(num: PipelineStage.Limit['$limit']): this;
+
+    /** Appends new custom $lookup operator to this aggregate pipeline. */
+    lookup(options: PipelineStage.Lookup['$lookup']): this;
+
+    /**
+     * Appends a new custom $match operator to this aggregate pipeline.
+     * @param arg $match operator contents
+     */
+    match(arg: PipelineStage.Match['$match']): this;
+
+    /**
+     * Binds this aggregate to a model.
+     * @param model the model to which the aggregate is to be bound
+     */
+    model(model: Model<any>): this;
+
+    /**
+     * Returns the current model bound to this aggregate object
+     */
+    model(): Model<any>;
+
+    /** Appends a new $geoNear operator to this aggregate pipeline. */
+    near(arg: PipelineStage.GeoNear['$geoNear']): this;
+
+    /** Returns the current pipeline */
+    pipeline(): PipelineStage[];
+
+    /** Appends a new $project operator to this aggregate pipeline. */
+    project(arg: PipelineStage.Project['$project'] | string): this;
+
+    /** Sets the readPreference option for the aggregation query. */
+    read(pref: mongodb.ReadPreferenceLike): this;
+
+    /** Sets the readConcern level for the aggregation query. */
+    readConcern(level: string): this;
+
+    /** Appends a new $redact operator to this aggregate pipeline. */
+    redact(expression: PipelineStage.Redact['$redact'], thenExpr: '$$DESCEND' | '$$PRUNE' | '$$KEEP' | AnyObject, elseExpr: '$$DESCEND' | '$$PRUNE' | '$$KEEP' | AnyObject): this;
+
+    /** Appends a new $replaceRoot operator to this aggregate pipeline. */
+    replaceRoot(newRoot: PipelineStage.ReplaceRoot['$replaceRoot']['newRoot'] | string): this;
+
+    /**
+     * Helper for [Atlas Text Search](https://www.mongodb.com/docs/atlas/atlas-search/tutorial/)'s
+     * `$search` stage.
+     */
+    search(options: PipelineStage.Search['$search']): this;
+
+    /** Lets you set arbitrary options, for middlewares or plugins. */
+    option(value: AggregateOptions): this;
+
+    /** Appends new custom $sample operator to this aggregate pipeline. */
+    sample(arg: PipelineStage.Sample['$sample']['size']): this;
+
+    /** Sets the session for this aggregation. Useful for [transactions](/docs/transactions.html). */
+    session(session: mongodb.ClientSession | null): this;
+
+    /**
+     * Appends a new $skip operator to this aggregate pipeline.
+     * @param num number of records to skip before next stage
+     */
+    skip(num: PipelineStage.Skip['$skip']): this;
+
+    /** Appends a new $sort operator to this aggregate pipeline. */
+    sort(arg: string | Record<string, SortValues> | PipelineStage.Sort['$sort']): this;
+
+    /** Provides promise for aggregate. */
+    then: Promise<ResultType>['then'];
+
+    /**
+     * Appends a new $sortByCount operator to this aggregate pipeline. Accepts either a string field name
+     * or a pipeline object.
+     */
+    sortByCount(arg: string | PipelineStage.SortByCount['$sortByCount']): this;
+
+    /** Appends new $unionWith operator to this aggregate pipeline. */
+    unionWith(options: PipelineStage.UnionWith['$unionWith']): this;
+
+    /** Appends new custom $unwind operator(s) to this aggregate pipeline. */
+    unwind(...args: PipelineStage.Unwind['$unwind'][]): this;
+  }
+}

package/types/augmentations.d.ts

@@ -0,0 +1,9 @@
+// this import is required so that types get merged instead of completely overwritten
+import 'bson';
+
+declare module 'bson' {
+  interface ObjectId {
+    /** Mongoose automatically adds a conveniency "_id" getter on the base ObjectId class */
+    _id: this;
+  }
+}

package/types/callback.d.ts

@@ -0,0 +1,8 @@
+declare module 'mongoose' {
+  type CallbackError = NativeError | null;
+
+  type Callback<T = any> = (error: CallbackError, result: T) => void;
+
+  type CallbackWithoutResult = (error: CallbackError) => void;
+  type CallbackWithoutResultAndOptionalError = (error?: CallbackError) => void;
+}

package/types/collection.d.ts

@@ -0,0 +1,49 @@
+declare module 'mongoose' {
+  import mongodb = require('mongodb');
+
+  export class BaseCollection<T extends mongodb.Document> extends mongodb.Collection<T> {
+    /**
+     * Collection constructor
+     * @param name name of the collection
+     * @param conn A MongooseConnection instance
+     * @param opts optional collection options
+     */
+    constructor(name: string, conn: Connection, opts?: any);
+
+    /*
+    * Abstract methods. Some of these are already defined on the
+    * mongodb.Collection interface so they've been commented out.
+    */
+    ensureIndex(...args: any[]): any;
+    findAndModify(...args: any[]): any;
+    getIndexes(...args: any[]): any;
+
+    /** Formatter for debug print args */
+    $format(arg: any, color?: boolean, shell?: boolean): string;
+    /** Debug print helper */
+    $print(name: string, i: string | number, args: any[], color?: boolean, shell?: boolean): void;
+
+    /** The collection name */
+    get collectionName(): string;
+    /** The Connection instance */
+    conn: Connection;
+    /** The collection name */
+    name: string;
+  }
+
+  /*
+   * section drivers/node-mongodb-native/collection.js
+   */
+  class Collection<T extends mongodb.Document = mongodb.Document> extends BaseCollection<T> {
+    /**
+     * Collection constructor
+     * @param name name of the collection
+     * @param conn A MongooseConnection instance
+     * @param opts optional collection options
+     */
+    constructor(name: string, conn: Connection, opts?: any);
+
+    /** Retrieves information about this collections indexes. */
+    getIndexes(): ReturnType<mongodb.Collection<T>['indexInformation']>;
+  }
+}