mongoose 6.3.2 → 6.3.5

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;
@@ -221,11 +221,11 @@ declare module 'mongoose' {
     set(value: any): this;
 
     /** The return value of this method is used in calls to JSON.stringify(doc). */
-    toJSON<T = DocType>(options?: ToObjectOptions & { flattenMaps?: true }): FlattenMaps<LeanDocument<T>>;
-    toJSON<T = DocType>(options: ToObjectOptions & { flattenMaps: false }): LeanDocument<T>;
+    toJSON<T = LeanDocument<DocType>>(options?: ToObjectOptions & { flattenMaps?: true }): FlattenMaps<T>;
+    toJSON<T = LeanDocument<DocType>>(options: ToObjectOptions & { flattenMaps: false }): T;
 
     /** Converts this document into a plain-old JavaScript object ([POJO](https://masteringjs.io/tutorials/fundamentals/pojo)). */
-    toObject<T = DocType>(options?: ToObjectOptions): LeanDocument<T>;
+    toObject<T = LeanDocument<DocType>>(options?: ToObjectOptions): Require_id<T>;
 
     /** Clears the modified state on the specified path. */
     unmarkModified(path: string): void;
@@ -247,4 +247,4 @@ declare module 'mongoose' {
     validateSync(options: { pathsToSkip?: pathsToSkip, [k: string]: any }): Error.ValidationError | null;
     validateSync(pathsToValidate?: pathsToValidate, options?: AnyObject): Error.ValidationError | null;
   }
-}
+}

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,33 @@
+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: 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): true;
+  function isValidObjectId(v: Types.ObjectId): true;
+  function isValidObjectId(v: any): boolean;
+}