Create InferDocType utility.

Automattic · Jun 8, 2022 · ea16fd9 · ea16fd9
1 parent 1b21255
commit ea16fd9
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
diff --git a/test/types/schema.test.ts b/test/types/schema.test.ts
@@ -1,4 +1,4 @@
-import { Schema, Document, SchemaDefinition, Model, Types, InferSchemaType, SchemaType, Query, HydratedDocument } from 'mongoose';
+import { Schema, Document, SchemaDefinition, Model, Types, InferSchemaType, SchemaType, Query, HydratedDocument, InferDocType, FlatRecord } from 'mongoose';
 import { expectType, expectError, expectAssignable } from 'tsd';
 
 enum Genre {
@@ -507,6 +507,10 @@ export function autoTypedSchema() {
 
   expectError<AutoTypedSchemaType['schema'] & { doesNotExist: boolean; }>({} as InferredSchemaType);
 
+  type InferredDocType = InferDocType<typeof AutoTypedSchema>;
+
+  expectType<FlatRecord<AutoTypedSchemaType['schema'] & AutoTypedSchemaType['virtuals']>>({} as InferredDocType);
+
   return AutoTypedSchema;
 }
 

diff --git a/types/inferschematype.d.ts b/types/inferschematype.d.ts
@@ -23,7 +23,19 @@ declare module 'mongoose' {
    * // result
    * type UserType = {userName?: string}
    */
-  type InferSchemaType<SchemaType> = ObtainSchemaGeneric<SchemaType, 'DocType'> ;
+  type InferSchemaType<SchemaType> = ObtainSchemaGeneric<SchemaType, 'DocType'>;
+
+  /**
+   * @summary Obtains document plain doc type from Schema instance.
+   * @description Exactly like {@link InferSchemaType}, but it add virtual paths.
+   * @param {SchemaType} SchemaType A generic of schema type instance.
+   * @example
+   * const userSchema = new Schema({userName:String});
+   * type UserType = InferDocType<typeof userSchema>;
+   * // result
+   * type UserType = {userName?: string}
+   */
+  type InferDocType<SchemaType> = FlatRecord<InferSchemaType<SchemaType> & ObtainSchemaGeneric<SchemaType, 'TVirtuals'>>;
 
   /**
    * @summary Obtains schema Generic type by using generic alias.

diff --git a/types/utility.d.ts b/types/utility.d.ts
@@ -31,4 +31,12 @@ type IfEquals<T, U, Y = true, N = false> =
     (<G>() => G extends T ? 1 : 0) extends
     (<G>() => G extends U ? 1 : 0) ? Y : N;
 
+
+/**
+   * @summary Converts Unions to one record "object".
+   * @description It makes intellisense dialog box easier to read as a single object instead of showing that in multiple object unions.
+   * @param {T} T The type to be converted.
+   */
+   type FlatRecord<T> = { [K in keyof T]: T[K] };
+
 }