@depup/mongoose 9.1.3-depup.0

package/types/document.d.ts

@@ -0,0 +1,374 @@
+declare module 'mongoose' {
+  import mongodb = require('mongodb');
+
+  /** A list of paths to skip. If set, Mongoose will validate every modified path that is not in this list. */
+  type pathsToSkip = string[] | string;
+
+  interface DocumentSetOptions {
+    merge?: boolean;
+
+    [key: string]: any;
+  }
+
+  class ModifiedPathsSnapshot {}
+
+  /**
+   * Generic types for Document:
+   * *  T - the type of _id
+   * *  TQueryHelpers - Object with any helpers that should be mixed into the Query type
+   * *  DocType - the type of the actual Document created
+   */
+  class Document<T = Types.ObjectId, TQueryHelpers = any, DocType = any, TVirtuals = Record<string, any>, TSchemaOptions = {}> {
+    constructor(doc?: any);
+
+    /** This documents _id. */
+    _id: T;
+
+    /** Assert that a given path or paths is populated. Throws an error if not populated. */
+    $assertPopulated<Paths = {}>(path: string | string[], values?: Partial<Paths>): Omit<this, keyof Paths> & Paths;
+
+    /** Clear the document's modified paths. */
+    $clearModifiedPaths(): this;
+
+    /** Returns a deep clone of this document */
+    $clone(): this;
+
+    /**
+     * Creates a snapshot of this document's internal change tracking state. You can later
+     * reset this document's change tracking state using `$restoreModifiedPathsSnapshot()`.
+     */
+    $createModifiedPathsSnapshot(): ModifiedPathsSnapshot;
+
+    /* Get all subdocs (by bfs) */
+    $getAllSubdocs(): Document[];
+
+    /** Don't run validation on this path or persist changes to this path. */
+    $ignore(path: string): void;
+
+    /** Checks if a path is set to its default. If no path set, checks if any path is set to its default. */
+    $isDefault(path?: string): boolean;
+
+    /** Getter/setter, determines whether the document was removed or not. */
+    $isDeleted(val?: boolean): boolean;
+
+    /** Returns an array of all populated documents associated with the query */
+    $getPopulatedDocs(): Document[];
+
+    /**
+     * Increments the numeric value at `path` by the given `val`.
+     * When you call `save()` on this document, Mongoose will send a
+     * `$inc` as opposed to a `$set`.
+     */
+    $inc(path: string | string[], val?: number): this;
+
+    /**
+     * Returns true if the given path is nullish or only contains empty objects.
+     * Useful for determining whether this subdoc will get stripped out by the
+     * [minimize option](/docs/guide.html#minimize).
+     */
+    $isEmpty(path: string): boolean;
+
+    /** Checks if a path is invalid */
+    $isValid(path: string): boolean;
+
+    /**
+     * Empty object that you can use for storing properties on the document. This
+     * is handy for passing data to middleware without conflicting with Mongoose
+     * internals.
+     */
+    $locals: Record<string, unknown>;
+
+    /** Marks a path as valid, removing existing validation errors. */
+    $markValid(path: string): void;
+
+    /** Returns the model with the given name on this document's associated connection. */
+    $model<ModelType = Model<unknown>>(name: string): ModelType;
+    $model<ModelType = Model<DocType>>(): ModelType;
+
+    /**
+     * A string containing the current operation that Mongoose is executing
+     * on this document. Can be `null`, `'save'`, `'validate'`, or `'remove'`.
+     */
+    $op: 'save' | 'validate' | 'remove' | null;
+
+    /**
+     * Restore this document's change tracking state to the given snapshot.
+     * Note that `$restoreModifiedPathsSnapshot()` does **not** modify the document's
+     * properties, just resets the change tracking state.
+     */
+    $restoreModifiedPathsSnapshot(snapshot: ModifiedPathsSnapshot): this;
+
+    /**
+     * Getter/setter around the session associated with this document. Used to
+     * automatically set `session` if you `save()` a doc that you got from a
+     * query with an associated session.
+     */
+    $session(session?: ClientSession | null): ClientSession | null;
+
+    /** Alias for `set()`, used internally to avoid conflicts */
+    $set(path: string | Record<string, any>, val: any, type: any, options?: DocumentSetOptions): this;
+    $set(path: string | Record<string, any>, val: any, options?: DocumentSetOptions): this;
+    $set(value: string | Record<string, any>): this;
+
+    /** Set this property to add additional query filters when Mongoose saves this document and `isNew` is false. */
+    $where: Record<string, unknown>;
+
+    /** If this is a discriminator model, `baseModelName` is the name of the base model. */
+    baseModelName?: string;
+
+    /** Collection the model uses. */
+    collection: Collection;
+
+    /** Connection the model uses. */
+    db: Connection;
+
+    /** Removes this document from the db. */
+    deleteOne(options?: QueryOptions): QueryWithHelpers<
+      mongodb.DeleteResult,
+      this,
+      TQueryHelpers,
+      DocType,
+      'deleteOne'
+    >;
+
+    /**
+     * Takes a populated field and returns it to its unpopulated state. If called with
+     * no arguments, then all populated fields are returned to their unpopulated state.
+     */
+    depopulate<Paths = {}>(path?: string | string[]): MergeType<this, Paths>;
+
+    /**
+     * Returns the list of paths that have been directly modified. A direct
+     * modified path is a path that you explicitly set, whether via `doc.foo = 'bar'`,
+     * `Object.assign(doc, { foo: 'bar' })`, or `doc.set('foo', 'bar')`.
+     */
+    directModifiedPaths(): Array<string>;
+
+    /**
+     * Returns true if this document is equal to another document.
+     *
+     * Documents are considered equal when they have matching `_id`s, unless neither
+     * document has an `_id`, in which case this function falls back to using
+     * `deepEqual()`.
+     */
+    equals(doc: Document<T>): boolean;
+
+    /** Returns the current validation errors. */
+    errors?: Error.ValidationError;
+
+    /** Returns the value of a path. */
+    get<T extends keyof DocType>(path: T, type?: any, options?: any): DocType[T];
+    get(path: string, type?: any, options?: any): any;
+
+    /**
+     * Returns the changes that happened to the document
+     * in the format that will be sent to MongoDB.
+     */
+    getChanges(): UpdateQuery<this>;
+
+    /** Signal that we desire an increment of this documents version. */
+    increment(): this;
+
+    /**
+    * Initializes the document without setters or marking anything modified.
+    * Called internally after a document is returned from mongodb. Normally,
+    * you do **not** need to call this function on your own.
+    */
+    init(obj: AnyObject, opts?: AnyObject): this;
+
+    /** Marks a path as invalid, causing validation to fail. */
+    invalidate<T extends keyof DocType>(path: T, errorMsg: string | NativeError, value?: any, kind?: string): NativeError | null;
+    invalidate(path: string, errorMsg: string | NativeError, value?: any, kind?: string): NativeError | null;
+
+    /** Returns true if `path` was directly set and modified, else false. */
+    isDirectModified<T extends keyof DocType>(path: T | Array<T>): boolean;
+    isDirectModified(path: string | Array<string>): boolean;
+
+    /** Checks if `path` was explicitly selected. If no projection, always returns true. */
+    isDirectSelected<T extends keyof DocType>(path: T): boolean;
+    isDirectSelected(path: string): boolean;
+
+    /** Checks if `path` is in the `init` state, that is, it was set by `Document#init()` and not modified since. */
+    isInit<T extends keyof DocType>(path: T): boolean;
+    isInit(path: string): boolean;
+
+    /**
+     * Returns true if any of the given paths are modified, else false. If no arguments, returns `true` if any path
+     * in this document is modified.
+     */
+    isModified<T extends keyof DocType>(path?: T | Array<T>, options?: { ignoreAtomics?: boolean } | null): boolean;
+    isModified(path?: string | Array<string>, options?: { ignoreAtomics?: boolean } | null): boolean;
+
+    /** Boolean flag specifying if the document is new. */
+    isNew: boolean;
+
+    /** Checks if `path` was selected in the source query which initialized this document. */
+    isSelected<T extends keyof DocType>(path: T): boolean;
+    isSelected(path: string): boolean;
+
+    /** Marks the path as having pending changes to write to the db. */
+    markModified<T extends keyof DocType>(path: T, scope?: any): void;
+    markModified(path: string, scope?: any): void;
+
+    /** Returns the model with the given name on this document's associated connection. */
+    model<ModelType = Model<unknown>>(name: string): ModelType;
+    model<ModelType = Model<DocType>>(): ModelType;
+
+    /** Returns the list of paths that have been modified. */
+    modifiedPaths(options?: { includeChildren?: boolean }): Array<string>;
+
+    /**
+     * Overwrite all values in this document with the values of `obj`, except
+     * for immutable properties. Behaves similarly to `set()`, except for it
+     * unsets all properties that aren't in `obj`.
+     */
+    overwrite(obj: AnyObject): this;
+
+    /**
+     * If this document is a subdocument or populated document, returns the
+     * document's parent. Returns undefined otherwise.
+     */
+    $parent(): Document | undefined;
+
+    /** Populates document references. */
+    populate<Paths = {}>(path: string | PopulateOptions | (string | PopulateOptions)[]): Promise<MergeType<this, Paths>>;
+    populate<Paths = {}>(path: string, select?: string | AnyObject, model?: Model<any>, match?: AnyObject, options?: PopulateOptions): Promise<MergeType<this, Paths>>;
+
+    /** Gets _id(s) used during population of the given `path`. If the path was not populated, returns `undefined`. */
+    populated(path: string): any;
+
+    /** Sends a replaceOne command with this document `_id` as the query selector. */
+    replaceOne(replacement?: AnyObject, options?: QueryOptions | null): Query<any, this>;
+
+    /** Saves this document by inserting a new document into the database if [document.isNew](/docs/api/document.html#document_Document-isNew) is `true`, or sends an [updateOne](/docs/api/document.html#document_Document-updateOne) operation with just the modified paths if `isNew` is `false`. */
+    save(options?: SaveOptions): Promise<this>;
+
+    /** The document's schema. */
+    schema: Schema;
+
+    /** Sets the value of a path, or many paths. */
+    set<T extends keyof DocType>(path: T, val: DocType[T], type: any, options?: DocumentSetOptions): this;
+    set(path: string | Record<string, any>, val: any, type: any, options?: DocumentSetOptions): this;
+    set(path: string | Record<string, any>, val: any, options?: DocumentSetOptions): this;
+    set(value: string | Record<string, any>): this;
+
+    /** The return value of this method is used in calls to JSON.stringify(doc). */
+    // Consistently handle combinations of flattenMaps, flattenObjectIds, virtuals, and versionKey
+
+    // All combinations, including with and without TVirtuals when virtuals is true/false,
+    // and proper nesting/order: flattenMaps -> ObjectIdToString -> Omit<..., '__v'> when needed.
+
+    // flattenMaps: false (default) cases
+    toJSON(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: true, virtuals: true, versionKey: false }): ObjectIdToString<Omit<Require_id<DocType & TVirtuals>, '__v'>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: true, virtuals: true }): ObjectIdToString<Require_id<DocType & TVirtuals>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: false, virtuals: true, versionKey: false }): Omit<Require_id<DocType & TVirtuals>, '__v'>;
+    toJSON(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: false, virtuals: true }): Require_id<DocType & TVirtuals>;
+    toJSON(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: true, virtuals: false, versionKey: false }): ObjectIdToString<Omit<Require_id<DocType>, '__v'>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: true, virtuals: false }): ObjectIdToString<Require_id<DocType>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: false, virtuals: false, versionKey: false }): Omit<Require_id<DocType>, '__v'>;
+    toJSON(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: false, virtuals: false }): Require_id<DocType>;
+
+    // flattenMaps: true cases
+    toJSON(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: true, virtuals: true, versionKey: false }): ObjectIdToString<Omit<FlattenMaps<Require_id<DocType & TVirtuals>>, '__v'>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: true, virtuals: true }): ObjectIdToString<FlattenMaps<Require_id<DocType & TVirtuals>>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: false, virtuals: true, versionKey: false }): Omit<FlattenMaps<Require_id<DocType & TVirtuals>>, '__v'>;
+    toJSON(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: false, virtuals: true }): FlattenMaps<Require_id<DocType & TVirtuals>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: true, virtuals: false, versionKey: false }): ObjectIdToString<Omit<FlattenMaps<Require_id<DocType>>, '__v'>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: true, virtuals: false }): ObjectIdToString<FlattenMaps<Require_id<DocType>>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: false, virtuals: false, versionKey: false }): Omit<FlattenMaps<Require_id<DocType>>, '__v'>;
+    toJSON(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: false, virtuals: false }): FlattenMaps<Require_id<DocType>>;
+
+    // Handle "at least" short cross-combinations
+    // (Some permutations above will catch these, but make some explicit for clarity)
+    toJSON(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: true, virtuals: true }): ObjectIdToString<FlattenMaps<Require_id<DocType & TVirtuals>>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: true }): ObjectIdToString<FlattenMaps<Require_id<DocType>>>;
+    toJSON(options: ToObjectOptions & { flattenObjectIds: true, virtuals: true }): ObjectIdToString<Require_id<DocType & TVirtuals>>;
+    toJSON(options: ToObjectOptions & { flattenObjectIds: true }): ObjectIdToString<Require_id<DocType>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: true, virtuals: true }): FlattenMaps<Require_id<DocType & TVirtuals>>;
+    toJSON(options: ToObjectOptions & { flattenMaps: true }): FlattenMaps<Require_id<DocType>>;
+
+    // Handle versionKey: false (regardless of the others - most specific overloads should come first)
+    toJSON(options: ToObjectOptions & { versionKey: false, flattenMaps: true, flattenObjectIds: true, virtuals: true }): ObjectIdToString<Omit<FlattenMaps<Require_id<DocType & TVirtuals>>, '__v'>>;
+    toJSON(options: ToObjectOptions & { versionKey: false, flattenMaps: false, flattenObjectIds: true, virtuals: true }): ObjectIdToString<Omit<Require_id<DocType & TVirtuals>, '__v'>>;
+    toJSON(options: ToObjectOptions & { versionKey: false, flattenMaps: true, virtuals: true }): Omit<FlattenMaps<Require_id<DocType & TVirtuals>>, '__v'>;
+    toJSON(options: ToObjectOptions & { versionKey: false, flattenObjectIds: true, virtuals: true }): ObjectIdToString<Omit<Require_id<DocType & TVirtuals>, '__v'>>;
+    toJSON(options: ToObjectOptions & { versionKey: false, virtuals: true }): Omit<Require_id<DocType & TVirtuals>, '__v'>;
+    toJSON(options: ToObjectOptions & { versionKey: false, flattenMaps: true, flattenObjectIds: true }): ObjectIdToString<Omit<FlattenMaps<Require_id<DocType>>, '__v'>>;
+    toJSON(options: ToObjectOptions & { versionKey: false, flattenObjectIds: true }): ObjectIdToString<Omit<Require_id<DocType>, '__v'>>;
+    toJSON(options: ToObjectOptions & { versionKey: false, flattenMaps: true }): Omit<FlattenMaps<Require_id<DocType>>, '__v'>;
+    toJSON(options: ToObjectOptions & { versionKey: false }): Omit<Require_id<DocType>, '__v'>;
+
+    // Handle virtuals: true
+    toJSON(options: ToObjectOptions & { virtuals: true }): Require_id<DocType & TVirtuals>;
+
+    // Default - no special options
+    toJSON(options?: ToObjectOptions): Default__v<Require_id<DocType>, TSchemaOptions>;
+
+    toJSON<T>(options?: ToObjectOptions): Default__v<Require_id<T>, ResolveSchemaOptions<TSchemaOptions>>;
+
+    /** Converts this document into a plain-old JavaScript object ([POJO](https://masteringjs.io/tutorials/fundamentals/pojo)). */
+    // flattenMaps: false (default) cases
+    toObject(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: true, virtuals: true, versionKey: false }): ObjectIdToString<Omit<Require_id<DocType & TVirtuals>, '__v'>>;
+    toObject(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: true, virtuals: true }): ObjectIdToString<Require_id<DocType & TVirtuals>>;
+    toObject(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: false, virtuals: true, versionKey: false }): Omit<Require_id<DocType & TVirtuals>, '__v'>;
+    toObject(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: false, virtuals: true }): Require_id<DocType & TVirtuals>;
+    toObject(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: true, virtuals: false, versionKey: false }): ObjectIdToString<Omit<Require_id<DocType>, '__v'>>;
+    toObject(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: true, virtuals: false }): ObjectIdToString<Require_id<DocType>>;
+    toObject(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: false, virtuals: false, versionKey: false }): Omit<Require_id<DocType>, '__v'>;
+    toObject(options: ToObjectOptions & { flattenMaps: false, flattenObjectIds: false, virtuals: false }): Require_id<DocType>;
+
+    // flattenMaps: true cases
+    toObject(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: true, virtuals: true, versionKey: false }): ObjectIdToString<Omit<FlattenMaps<Require_id<DocType & TVirtuals>>, '__v'>>;
+    toObject(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: true, virtuals: true }): ObjectIdToString<FlattenMaps<Require_id<DocType & TVirtuals>>>;
+    toObject(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: false, virtuals: true, versionKey: false }): Omit<FlattenMaps<Require_id<DocType & TVirtuals>>, '__v'>;
+    toObject(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: false, virtuals: true }): FlattenMaps<Require_id<DocType & TVirtuals>>;
+    toObject(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: true, virtuals: false, versionKey: false }): ObjectIdToString<Omit<FlattenMaps<Require_id<DocType>>, '__v'>>;
+    toObject(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: true, virtuals: false }): ObjectIdToString<FlattenMaps<Require_id<DocType>>>;
+    toObject(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: false, virtuals: false, versionKey: false }): Omit<FlattenMaps<Require_id<DocType>>, '__v'>;
+    toObject(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: false, virtuals: false }): FlattenMaps<Require_id<DocType>>;
+
+    // Handle "at least" short cross-combinations
+    toObject(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: true, virtuals: true }): ObjectIdToString<FlattenMaps<Require_id<DocType & TVirtuals>>>;
+    toObject(options: ToObjectOptions & { flattenMaps: true, flattenObjectIds: true }): ObjectIdToString<FlattenMaps<Require_id<DocType>>>;
+    toObject(options: ToObjectOptions & { flattenObjectIds: true, virtuals: true }): ObjectIdToString<Require_id<DocType & TVirtuals>>;
+    toObject(options: ToObjectOptions & { flattenObjectIds: true }): ObjectIdToString<Require_id<DocType>>;
+    toObject(options: ToObjectOptions & { flattenMaps: true, virtuals: true }): FlattenMaps<Require_id<DocType & TVirtuals>>;
+    toObject(options: ToObjectOptions & { flattenMaps: true }): FlattenMaps<Require_id<DocType>>;
+
+    // Handle versionKey: false (regardless of the others - most specific overloads should come first)
+    toObject(options: ToObjectOptions & { versionKey: false, flattenMaps: true, flattenObjectIds: true, virtuals: true }): ObjectIdToString<Omit<FlattenMaps<Require_id<DocType & TVirtuals>>, '__v'>>;
+    toObject(options: ToObjectOptions & { versionKey: false, flattenMaps: false, flattenObjectIds: true, virtuals: true }): ObjectIdToString<Omit<Require_id<DocType & TVirtuals>, '__v'>>;
+    toObject(options: ToObjectOptions & { versionKey: false, flattenMaps: true, virtuals: true }): Omit<FlattenMaps<Require_id<DocType & TVirtuals>>, '__v'>;
+    toObject(options: ToObjectOptions & { versionKey: false, flattenObjectIds: true, virtuals: true }): ObjectIdToString<Omit<Require_id<DocType & TVirtuals>, '__v'>>;
+    toObject(options: ToObjectOptions & { versionKey: false, virtuals: true }): Omit<Require_id<DocType & TVirtuals>, '__v'>;
+    toObject(options: ToObjectOptions & { versionKey: false, flattenMaps: true, flattenObjectIds: true }): ObjectIdToString<Omit<FlattenMaps<Require_id<DocType>>, '__v'>>;
+    toObject(options: ToObjectOptions & { versionKey: false, flattenObjectIds: true }): ObjectIdToString<Omit<Require_id<DocType>, '__v'>>;
+    toObject(options: ToObjectOptions & { versionKey: false, flattenMaps: true }): Omit<FlattenMaps<Require_id<DocType>>, '__v'>;
+    toObject(options: ToObjectOptions & { versionKey: false }): Omit<Require_id<DocType>, '__v'>;
+
+    // Handle virtuals: true
+    toObject(options: ToObjectOptions & { virtuals: true }): Require_id<DocType & TVirtuals>;
+
+    // Default - no special options
+    toObject(options?: ToObjectOptions): Default__v<Require_id<DocType>, TSchemaOptions>;
+
+    toObject<T>(options?: ToObjectOptions): Default__v<Require_id<T>, ResolveSchemaOptions<TSchemaOptions>>;
+
+    /** Clears the modified state on the specified path. */
+    unmarkModified<T extends keyof DocType>(path: T): void;
+    unmarkModified(path: string): void;
+
+    /** Sends an updateOne command with this document `_id` as the query selector. */
+    updateOne(update?: UpdateQuery<this> | UpdateWithAggregationPipeline, options?: QueryOptions | null): Query<any, this>;
+
+    /** Executes registered validation rules for this document. */
+    validate<T extends keyof DocType>(pathsToValidate?: T | T[], options?: AnyObject): Promise<void>;
+    validate(pathsToValidate?: pathsToValidate, options?: AnyObject): Promise<void>;
+    validate(options: { pathsToSkip?: pathsToSkip }): Promise<void>;
+
+    /** Executes registered validation rules (skipping asynchronous validators) for this document. */
+    validateSync(options: { pathsToSkip?: pathsToSkip, [k: string]: any }): Error.ValidationError | null;
+    validateSync<T extends keyof DocType>(pathsToValidate?: T | T[], options?: AnyObject): Error.ValidationError | null;
+    validateSync(pathsToValidate?: pathsToValidate, options?: AnyObject): Error.ValidationError | null;
+  }
+}

package/types/error.d.ts

@@ -0,0 +1,143 @@
+declare class NativeError extends global.Error { }
+
+declare module 'mongoose' {
+  import mongodb = require('mongodb');
+
+  type CastError = Error.CastError;
+  type SyncIndexesError = Error.SyncIndexesError;
+
+  export class MongooseError extends global.Error {
+    constructor(msg: string);
+
+    /** The type of error. "MongooseError" for generic errors. */
+    name: string;
+
+    static messages: any;
+
+    static Messages: any;
+  }
+
+  class Error extends MongooseError { }
+
+  namespace Error {
+
+    export class CastError extends MongooseError {
+      name: 'CastError';
+      stringValue: string;
+      kind: string;
+      value: any;
+      path: string;
+      reason?: NativeError | null;
+
+      constructor(type: string, value: any, path: string, reason?: NativeError, schemaType?: SchemaType);
+    }
+    export class SyncIndexesError extends MongooseError {
+      name: 'SyncIndexesError';
+      errors?: Record<string, mongodb.MongoServerError>;
+
+      constructor(type: string, value: any, path: string, reason?: NativeError, schemaType?: SchemaType);
+    }
+
+    export class DivergentArrayError extends MongooseError {
+      name: 'DivergentArrayError';
+    }
+
+    export class MissingSchemaError extends MongooseError {
+      name: 'MissingSchemaError';
+    }
+
+    export class DocumentNotFoundError extends MongooseError {
+      name: 'DocumentNotFoundError';
+      result: any;
+      numAffected: number;
+      filter: any;
+      query: any;
+    }
+
+    export class ObjectExpectedError extends MongooseError {
+      name: 'ObjectExpectedError';
+      path: string;
+    }
+
+    export class ObjectParameterError extends MongooseError {
+      name: 'ObjectParameterError';
+    }
+
+    export class OverwriteModelError extends MongooseError {
+      name: 'OverwriteModelError';
+    }
+
+    export class ParallelSaveError extends MongooseError {
+      name: 'ParallelSaveError';
+    }
+
+    export class ParallelValidateError extends MongooseError {
+      name: 'ParallelValidateError';
+    }
+
+    export class MongooseServerSelectionError extends MongooseError {
+      name: 'MongooseServerSelectionError';
+    }
+
+    export class StrictModeError extends MongooseError {
+      name: 'StrictModeError';
+      isImmutableError: boolean;
+      path: string;
+    }
+
+    export class ValidationError extends MongooseError {
+      name: 'ValidationError';
+
+      errors: { [path: string]: ValidatorError | CastError };
+      addError: (path: string, error: ValidatorError | CastError) => void;
+
+      /** Index of the document in insertMany() that failed validation (only set for unordered insertMany) */
+      index?: number;
+
+      constructor(instance?: MongooseError);
+    }
+
+    export class ValidatorError extends MongooseError {
+      name: 'ValidatorError';
+      properties: {
+        message: string,
+        type?: string,
+        path?: string,
+        value?: any,
+        reason?: any
+      };
+      kind: string;
+      path: string;
+      value: any;
+      reason?: MongooseError | null;
+
+      constructor(properties: {
+        message?: string,
+        type?: string,
+        path?: string,
+        value?: any,
+        reason?: any
+      });
+    }
+
+    export class VersionError extends MongooseError {
+      name: 'VersionError';
+      version: number;
+      modifiedPaths: Array<string>;
+
+      constructor(doc: Document, currentVersion: number, modifiedPaths: Array<string>);
+    }
+
+    export class StrictPopulateError extends MongooseError {
+      name: 'StrictPopulateError';
+      path: string;
+    }
+
+    export class MongooseBulkSaveIncompleteError extends MongooseError {
+      name: 'MongooseBulkSaveIncompleteError';
+      modelName: string;
+      bulkWriteResult: mongodb.BulkWriteResult;
+      numDocumentsNotUpdated: number;
+    }
+  }
+}