Merge pull request #12464 from Automattic/vkarpov15/gh-12319

fix(types): add HydratedDocumentFromSchema to make it easier to pull inferred hydrated doc type
Automattic · Sep 26, 2022 · 88ba7a1 · 88ba7a1
2 parents 55112dc + b59cbed
commit 88ba7a1
Show file tree

Hide file tree

Showing 3 changed files with 33 additions and 0 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -25,6 +25,7 @@
       "rules": {
         "@typescript-eslint/triple-slash-reference": "off",
         "@typescript-eslint/no-non-null-assertion": "off",
+        "@typescript-eslint/no-empty-function": "off",
         "spaced-comment": [
           "error",
           "always",

diff --git a/test/types/models.test.ts b/test/types/models.test.ts
@@ -9,6 +9,7 @@ import {
   UpdateQuery,
   CallbackError,
   HydratedDocument,
+  HydratedDocumentFromSchema,
   LeanDocument,
   Query,
   UpdateWriteOpResult
@@ -494,3 +495,28 @@ async function gh12347() {
   const replaceOneResult = await User.replaceOne({}, {});
   expectType<UpdateWriteOpResult>(replaceOneResult);
 }
+
+async function gh12319() {
+  const projectSchema = new Schema(
+    {
+      name: {
+        type: String,
+        required: true
+      }
+    },
+    {
+      methods: {
+        async doSomething() {
+        }
+      }
+    }
+  );
+
+  const ProjectModel = model('Project', projectSchema);
+
+  type ProjectModelHydratedDoc = HydratedDocumentFromSchema<
+    typeof projectSchema
+  >;
+
+  expectType<ProjectModelHydratedDoc>(await ProjectModel.findOne().orFail());
+}
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -124,6 +124,12 @@ declare module 'mongoose' {
 
   export type HydratedDocument<DocType, TMethodsAndOverrides = {}, TVirtuals = {}> = DocType extends Document ? Require_id<DocType> : (Document<unknown, any, DocType> & Require_id<DocType> & TVirtuals & TMethodsAndOverrides);
 
+  export type HydratedDocumentFromSchema<TSchema extends Schema> = HydratedDocument<
+  InferSchemaType<TSchema>,
+  ObtainSchemaGeneric<TSchema, 'TQueryHelpers'>,
+  ObtainSchemaGeneric<TSchema, 'TInstanceMethods'>
+  >;
+
   export interface TagSet {
     [k: string]: string;
   }