Get Document type with QueryHelpers and InstanceMethods

[kot-shrodingera]

Prerequisites

• I have written a descriptive issue title

Mongoose version

6.5.2

Node.js version

17.3

MongoDB version

5.0

Operating system

Windows

Operating system version (i.e. 20.04, 11.3, 10)

11

Issue

How can I get infered Document type in typescript? So I could use it as argument type in DTO or enywhere else. For example I have this:

const projectSchema = new mongoose.Schema(
  {
    name: {
      type: String,
      required: true,
    },
  },
  {
    methods: {
      async doSomething() {
        // ...
      },
    },
  }
);

const ProjectModel = mongoose.model('Project', projectSchema);

Basically, I want a return type of await ProjectModel.findOne(). Closest I got is:

export type ProjectDocument = mongoose.HydratedDocument<
  mongoose.InferSchemaType<typeof projectSchema>,
  mongoose.ObtainSchemaGeneric<typeof projectSchema, 'TQueryHelpers'>,
  mongoose.ObtainSchemaGeneric<typeof projectSchema, 'TInstanceMethods'>
>;

But it looks bulky. Is there another way?

[github-actions]

This issue is stale because it has been open 14 days with no activity. Remove stale label or comment or this will be closed in 5 days

[github-actions]

This issue was closed because it has been inactive for 19 days since being marked as stale.

[kot-shrodingera]

I guess it's not quite right. Methods are infered, but virtuals aren't
Maybe it must be

  export type HydratedDocumentFromSchema<TSchema extends Schema> = HydratedDocument<
  InferSchemaType<TSchema>,
  ObtainSchemaGeneric<TSchema, 'TInstanceMethods'>,
  ObtainSchemaGeneric<TSchema, 'TVirtuals'>
  >;

?