typescript Model#findOne() return type is not as expected

[s4hubhamp]

Prerequisites

• I have written a descriptive issue title
• I have searched existing issues to ensure the bug has not already been reported

Mongoose version

6.10.1

Node.js version

16

MongoDB server version

4.2

Typescript version (if applicable)

4.6.3

Description

When I execute findOne method on model I am getting type annotations like below:

The problem above is typescript assumes that result will be always there.
So, If latestRowEntry is null I am getting error accessing nested props(latestRowEntry.time).

Ideally, Typescript should not allow the access of nested properties without checking latestRowEntry is null or not.

The annotation that's getting generated is not correct.

Below is my model and it's interface

import {model, Schema, Types} from 'mongoose'

export interface DeviceRawData {
  device_id: string
  date: string
  time: string
  createdAt?: Date | string
  updatedAt?: Date | string
}

export const DeviceRawDataSchema = new Schema(
  {
    device_id: {
      type: String,
      required: true,
    },
    date: {
      type: String,
      required: true,
    },
    time: {
      type: String,
      required: true,
    },
  },
  {
    timestamps: true,
  },
)

const DeviceRawDataModel = model<DeviceRawData>('DeviceRawData', DeviceRawDataSchema)
export default DeviceRawDataModel

Steps to Reproduce

Use below model code and try to query using method model#findOne.

import {model, Schema, Types} from 'mongoose'

export interface DeviceRawData {
  device_id: string
  date: string
  time: string
  createdAt?: Date | string
  updatedAt?: Date | string
}

export const DeviceRawDataSchema = new Schema(
  {
    device_id: {
      type: String,
      required: true,
    },
    date: {
      type: String,
      required: true,
    },
    time: {
      type: String,
      required: true,
    },
  },
  {
    timestamps: true,
  },
)

const DeviceRawDataModel = model<DeviceRawData>('DeviceRawData', DeviceRawDataSchema)
export default DeviceRawDataModel

Expected Behavior

The problem above is typescript assumes that result will be always there.
So, If latestRowEntry is null I am getting error accessing nested props(latestRowEntry.time).

Ideally, Typescript should not allow the access of nested properties without checking latestRowEntry is null or not.
The annotation that's getting generated is not correct.