mongoose 8.20.0 → 9.0.0-rc0

package/types/inferrawdoctype.d.ts

@@ -1,27 +1,36 @@
 import {
   IsSchemaTypeFromBuiltinClass,
   PathEnumOrString,
-  type OptionalPathKeys,
-  type RequiredPathKeys
+  OptionalPaths,
+  RequiredPaths,
+  IsPathRequired
 } from './inferschematype';
+import { Binary, UUID } from 'mongodb';
 
 declare module 'mongoose' {
-  export type InferRawDocType<DocDefinition, TSchemaOptions extends Record<any, any> = DefaultSchemaOptions> = Show<
-    ApplySchemaOptions<
-      {
-        [K in RequiredPathKeys<DocDefinition, TSchemaOptions['typeKey']>]: ObtainRawDocumentPathType<
-          DocDefinition[K],
-          TSchemaOptions['typeKey']
-        >;
-      } & {
-        [K in OptionalPathKeys<DocDefinition, TSchemaOptions['typeKey']>]?: ObtainRawDocumentPathType<
-          DocDefinition[K],
-          TSchemaOptions['typeKey']
-        > | null;
-      },
-      TSchemaOptions
-    >
-  >;
+  export type InferRawDocTypeFromSchema<TSchema extends Schema<any>> = IsItRecordAndNotAny<ObtainSchemaGeneric<TSchema, 'EnforcedDocType'>> extends true
+    ? ObtainSchemaGeneric<TSchema, 'EnforcedDocType'>
+    : FlattenMaps<SubdocsToPOJOs<ObtainSchemaGeneric<TSchema, 'DocType'>>>;
+
+  export type InferRawDocType<
+    SchemaDefinition,
+    TSchemaOptions extends Record<any, any> = DefaultSchemaOptions,
+    TTransformOptions = { bufferToBinary: false }
+  > = Require_id<ApplySchemaOptions<{
+    [
+    K in keyof (RequiredPaths<SchemaDefinition, TSchemaOptions['typeKey']> &
+    OptionalPaths<SchemaDefinition, TSchemaOptions['typeKey']>)
+    ]: IsPathRequired<SchemaDefinition[K], TSchemaOptions['typeKey']> extends true
+      ? ObtainRawDocumentPathType<SchemaDefinition[K], TSchemaOptions['typeKey'], TTransformOptions>
+      : ObtainRawDocumentPathType<SchemaDefinition[K], TSchemaOptions['typeKey'], TTransformOptions> | null;
+  }, TSchemaOptions>>;
+
+  /**
+   * @summary Allows users to optionally choose their own type for a schema field for stronger typing.
+   * Make sure to check for `any` because `T extends { __rawDocTypeHint: infer U }` will infer `unknown` if T is `any`.
+   */
+  type RawDocTypeHint<T> = IsAny<T> extends true ? never
+    : T extends { __rawDocTypeHint: infer U } ? U: never;
 
   /**
    * @summary Obtains schema Path type.
@@ -29,14 +38,26 @@ declare module 'mongoose' {
    * @param {PathValueType} PathValueType Document definition path type.
    * @param {TypeKey} TypeKey A generic refers to document definition.
    */
-  type ObtainRawDocumentPathType<PathValueType, TypeKey extends string = DefaultTypeKey> =
-    TypeKey extends keyof PathValueType ?
-      ResolveRawPathType<PathValueType[TypeKey], Omit<PathValueType, TypeKey>, TypeKey>
-    : ResolveRawPathType<PathValueType, {}, TypeKey>;
+   type ObtainRawDocumentPathType<
+     PathValueType,
+     TypeKey extends string = DefaultTypeKey,
+     TTransformOptions = { bufferToBinary: false }
+   > = ResolveRawPathType<
+     TypeKey extends keyof PathValueType ?
+       TypeKey extends keyof PathValueType[TypeKey] ?
+         PathValueType
+       : PathValueType[TypeKey]
+     : PathValueType,
+     TypeKey extends keyof PathValueType ?
+       TypeKey extends keyof PathValueType[TypeKey] ?
+         {}
+       : Omit<PathValueType, TypeKey>
+     : {},
+     TypeKey,
+     TTransformOptions,
+     RawDocTypeHint<PathValueType>
+   >;
 
-  // can be efficiently checked like:
-  // `[T] extends [neverOrAny] ? T : ...`
-  // to avoid edge cases
   type neverOrAny = ' ~neverOrAny~';
 
   /**
@@ -52,54 +73,57 @@ declare module 'mongoose' {
    * @param {TypeKey} TypeKey A generic of literal string type."Refers to the property used for path type definition".
    * @returns Number, "Number" or "number" will be resolved to number type.
    */
-  type ResolveRawPathType<
-    PathValueType,
-    Options extends SchemaTypeOptions<PathValueType> = {},
-    TypeKey extends string = DefaultSchemaOptions['typeKey']
-  > =
-    [PathValueType] extends [neverOrAny] ? PathValueType
-    : PathValueType extends Schema ? InferSchemaType<PathValueType>
-    : PathValueType extends ReadonlyArray<infer Item> ?
-      [Item] extends [never] ? any[]
-      : Item extends Schema ?
-        // If Item is a schema, infer its type.
-        Array<InferSchemaType<Item>>
-      : TypeKey extends keyof Item ?
-        Item[TypeKey] extends Function | String ?
-          // If Item has a type key that's a string or a callable, it must be a scalar,
-          // so we can directly obtain its path type.
-          ObtainRawDocumentPathType<Item, TypeKey>[]
-        : // If the type key isn't callable, then this is an array of objects, in which case
-          // we need to call InferRawDocType to correctly infer its type.
-          Array<InferRawDocType<Item>>
-      : IsSchemaTypeFromBuiltinClass<Item> extends true ? ResolveRawPathType<Item, { enum: Options['enum'] }, TypeKey>[]
-      : IsItRecordAndNotAny<Item> extends true ?
-        Item extends Record<string, never> ?
-          ObtainRawDocumentPathType<Item, TypeKey>[]
-        : Array<InferRawDocType<Item>>
-      : ObtainRawDocumentPathType<Item, TypeKey>[]
-    : PathValueType extends StringSchemaDefinition ? PathEnumOrString<Options['enum']>
-    : IfEquals<PathValueType, String> extends true ? PathEnumOrString<Options['enum']>
-    : PathValueType extends NumberSchemaDefinition ?
-      Options['enum'] extends ReadonlyArray<any> ?
-        Options['enum'][number]
-      : number
-    : PathValueType extends DateSchemaDefinition ? NativeDate
-    : PathValueType extends BufferSchemaDefinition ? Buffer
-    : PathValueType extends BooleanSchemaDefinition ? boolean
-    : PathValueType extends ObjectIdSchemaDefinition ? Types.ObjectId
-    : PathValueType extends Decimal128SchemaDefinition ? Types.Decimal128
-    : PathValueType extends BigintSchemaDefinition ? bigint
-    : PathValueType extends UuidSchemaDefinition ? Buffer
-    : PathValueType extends DoubleSchemaDefinition ? Types.Double
-    : PathValueType extends MapSchemaDefinition ? Map<string, ObtainRawDocumentPathType<Options['of']>>
-    : PathValueType extends UnionSchemaDefinition ?
-      ResolveRawPathType<Options['of'] extends ReadonlyArray<infer Item> ? Item : never>
-    : PathValueType extends ArrayConstructor ? any[]
-    : PathValueType extends typeof Schema.Types.Mixed ? any
-    : IfEquals<PathValueType, ObjectConstructor> extends true ? any
-    : IfEquals<PathValueType, {}> extends true ? any
-    : PathValueType extends typeof SchemaType ? PathValueType['prototype']
-    : PathValueType extends Record<string, any> ? InferRawDocType<PathValueType>
-    : unknown;
+   type ResolveRawPathType<
+       PathValueType,
+       Options extends SchemaTypeOptions<PathValueType> = {},
+       TypeKey extends string = DefaultSchemaOptions['typeKey'],
+       TTransformOptions = { bufferToBinary: false },
+       TypeHint = never
+     > =
+       IsNotNever<TypeHint> extends true ? TypeHint
+       : [PathValueType] extends [neverOrAny] ? PathValueType
+       : PathValueType extends Schema<infer RawDocType, any, any, any, any, any, any, any, any, infer TSchemaDefinition> ? IsItRecordAndNotAny<RawDocType> extends true ? RawDocType : InferRawDocType<TSchemaDefinition, DefaultSchemaOptions, TTransformOptions>
+       : PathValueType extends ReadonlyArray<infer Item> ?
+         IfEquals<Item, never> extends true ? any[]
+         : Item extends Schema<infer RawDocType, any, any, any, any, any, any, any, any, infer TSchemaDefinition> ?
+           // If Item is a schema, infer its type.
+           Array<IsItRecordAndNotAny<RawDocType> extends true ? RawDocType : InferRawDocType<TSchemaDefinition, DefaultSchemaOptions, TTransformOptions>>
+         : TypeKey extends keyof Item ?
+           Item[TypeKey] extends Function | String ?
+             // If Item has a type key that's a string or a callable, it must be a scalar,
+             // so we can directly obtain its path type.
+             ObtainRawDocumentPathType<Item, TypeKey, TTransformOptions>[]
+           : // If the type key isn't callable, then this is an array of objects, in which case
+             // we need to call InferRawDocType to correctly infer its type.
+             Array<InferRawDocType<Item, DefaultSchemaOptions, TTransformOptions>>
+         : IsSchemaTypeFromBuiltinClass<Item> extends true ? ResolveRawPathType<Item, { enum: Options['enum'] }, TypeKey, TTransformOptions>[]
+         : IsItRecordAndNotAny<Item> extends true ?
+           Item extends Record<string, never> ?
+             ObtainRawDocumentPathType<Item, TypeKey, TTransformOptions>[]
+           : Array<InferRawDocType<Item, DefaultSchemaOptions, TTransformOptions>>
+         : ObtainRawDocumentPathType<Item, TypeKey, TTransformOptions>[]
+       : PathValueType extends StringSchemaDefinition ? PathEnumOrString<Options['enum']>
+       : IfEquals<PathValueType, String> extends true ? PathEnumOrString<Options['enum']>
+       : PathValueType extends NumberSchemaDefinition ?
+         Options['enum'] extends ReadonlyArray<any> ?
+           Options['enum'][number]
+         : number
+       : PathValueType extends DateSchemaDefinition ? NativeDate
+       : PathValueType extends BufferSchemaDefinition ? (TTransformOptions extends { bufferToBinary: true } ? Binary : Buffer)
+       : PathValueType extends BooleanSchemaDefinition ? boolean
+       : PathValueType extends ObjectIdSchemaDefinition ? Types.ObjectId
+       : PathValueType extends Decimal128SchemaDefinition ? Types.Decimal128
+       : PathValueType extends BigintSchemaDefinition ? bigint
+       : PathValueType extends UuidSchemaDefinition ? Types.UUID
+       : PathValueType extends MapSchemaDefinition ? Record<string, ObtainRawDocumentPathType<Options['of'], TypeKey, TTransformOptions>>
+       : PathValueType extends DoubleSchemaDefinition ? Types.Double
+       : PathValueType extends UnionSchemaDefinition ?
+         ResolveRawPathType<Options['of'] extends ReadonlyArray<infer Item> ? Item : never>
+       : PathValueType extends ArrayConstructor ? any[]
+       : PathValueType extends typeof Schema.Types.Mixed ? any
+       : IfEquals<PathValueType, ObjectConstructor> extends true ? any
+       : IfEquals<PathValueType, {}> extends true ? any
+       : PathValueType extends typeof SchemaType ? PathValueType['prototype']
+       : PathValueType extends Record<string, any> ? InferRawDocType<PathValueType>
+       : unknown;
 }

package/types/inferschematype.d.ts

@@ -59,6 +59,9 @@ declare module 'mongoose' {
    */
   export type InferSchemaType<TSchema> = IfAny<TSchema, any, ObtainSchemaGeneric<TSchema, 'DocType'>>;
 
+  export type DefaultIdVirtual = { id: string };
+  export type AddDefaultId<DocType, TVirtuals, TSchemaOptions> = (DocType extends { id: any } ? TVirtuals : TSchemaOptions extends { id: false } ? TVirtuals : TVirtuals & { id: string });
+
   /**
    * @summary Obtains schema Generic type by using generic alias.
    * @param {TSchema} TSchema A generic of schema type instance.
@@ -76,6 +79,8 @@ declare module 'mongoose' {
       | 'TSchemaOptions'
       | 'DocType'
       | 'THydratedDocumentType'
+      | 'TSchemaDefinition'
+      | 'TLeanResultType'
   > =
     TSchema extends (
       Schema<
@@ -87,7 +92,9 @@ declare module 'mongoose' {
         infer TStaticMethods,
         infer TSchemaOptions,
         infer DocType,
-        infer THydratedDocumentType
+        infer THydratedDocumentType,
+        infer TSchemaDefinition,
+        infer TLeanResultType
       >
     ) ?
       {
@@ -95,11 +102,13 @@ declare module 'mongoose' {
         M: M;
         TInstanceMethods: TInstanceMethods;
         TQueryHelpers: TQueryHelpers;
-        TVirtuals: TVirtuals;
+        TVirtuals: AddDefaultId<DocType, TVirtuals, TSchemaOptions>;
         TStaticMethods: TStaticMethods;
         TSchemaOptions: TSchemaOptions;
         DocType: DocType;
         THydratedDocumentType: THydratedDocumentType;
+        TSchemaDefinition: TSchemaDefinition;
+        TLeanResultType: TLeanResultType;
       }[alias]
     : unknown;
 
@@ -236,6 +245,10 @@ type PathEnumOrString<T extends SchemaTypeOptions<string>['enum']> =
   : T extends Record<string, infer V> ? V
   : string;
 
+type UnionToType<T extends readonly any[]> = T[number] extends infer U
+  ? ResolvePathType<U>
+  : never;
+
 type IsSchemaTypeFromBuiltinClass<T> =
   T extends typeof String ? true
   : T extends typeof Number ? true
@@ -254,6 +267,7 @@ type IsSchemaTypeFromBuiltinClass<T> =
   : T extends Types.Decimal128 ? true
   : T extends NativeDate ? true
   : T extends typeof Schema.Types.Mixed ? true
+  : T extends Types.UUID ? true
   : unknown extends Buffer ? false
   : T extends Buffer ? true
   : false;
@@ -301,12 +315,12 @@ type ResolvePathType<
       Options['enum'][number]
     : number
   : PathValueType extends DateSchemaDefinition ? NativeDate
+  : PathValueType extends UuidSchemaDefinition ? Types.UUID
   : PathValueType extends BufferSchemaDefinition ? Buffer
   : PathValueType extends BooleanSchemaDefinition ? boolean
   : PathValueType extends ObjectIdSchemaDefinition ? Types.ObjectId
   : PathValueType extends Decimal128SchemaDefinition ? Types.Decimal128
   : PathValueType extends BigintSchemaDefinition ? bigint
-  : PathValueType extends UuidSchemaDefinition ? Buffer
   : PathValueType extends DoubleSchemaDefinition ? Types.Double
   : PathValueType extends MapSchemaDefinition ? Map<string, ObtainDocumentPathType<Options['of']>>
   : PathValueType extends UnionSchemaDefinition ?

package/types/middlewares.d.ts

@@ -36,12 +36,10 @@ declare module 'mongoose' {
 
   type PreMiddlewareFunction<ThisType = any> = (
     this: ThisType,
-    next: CallbackWithoutResultAndOptionalError,
     opts?: Record<string, any>
   ) => void | Promise<void> | Kareem.SkipWrappedFunction;
   type PreSaveMiddlewareFunction<ThisType = any> = (
     this: ThisType,
-    next: CallbackWithoutResultAndOptionalError,
     opts: SaveOptions
   ) => void | Promise<void> | Kareem.SkipWrappedFunction;
   type PostMiddlewareFunction<ThisType = any, ResType = any> = (this: ThisType, res: ResType, next: CallbackWithoutResultAndOptionalError) => void | Promise<void> | Kareem.OverwriteMiddlewareResult;