TypeScript: timestamps not inferred from schema

[janickvwcotiss]

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.4.0

Node.js version

18.2.0

MongoDB server version

5.0.9

Description

Hi there, my issue is to do with typescript.

The issue I am having is that when creating a document schema with timestamps enabled the inferred document type doesn't have the corresponding createdAt and updatedAt fields present.

This means that when querying documents through the schema typescript will throw the property doesn't exist on type issue for the createdAt and updatedAt fields.

Hope this is pretty simple to understand, I've done my best to proved a good code example to best explain the issue I am having.

I realised mongoose has just recently migrated to typescript and isn't fully feature complete yet so appreciate any help.

P.s. I realise I haven't manually typed the interface for the schema e.g. new Schema<IDocument> and export const Document = model<IDocument>('Document', DocumentSchema); this is because we are migrating our whole code base to typescript and would ideally like to save some time by using InferSchemaType. But obviously open to any ideas even if it'll end up requiring typing the interfaces manually.

Thanks.

Steps to Reproduce

import { Schema, model, Model, InferSchemaType } from 'mongoose';

const DocumentSchema = new Schema(
  {
    url: { type: String, required: true, unique: true },
    fileSize: { type: Number, required: true },
    mimeType: { type: String, required: true },
    fileName: { type: String, required: true },
  },
  {
    timestamps: true,
  }
);

// Document comes out as
// const Document: Model<{
//   url: string;
//   fileSize: number;
//   mimeType: string;
//   fileName: string;
// }, {}, {}, {}, any>
export const Document: Model<InferSchemaType<typeof DocumentSchema>> = model(
  'Document',
  DocumentSchema
);

async function findDocument(id: string) {
  // Document without timestamp in query
  const doc1 = await Document.findById(id);
  if (doc1) {
    console.log(doc1.createdAt); // Error: "Property 'createdAt' does not exist on type 'Document...'"
    console.log(doc1.updatedAt);// Error: "Property 'updatedAt' does not exist on type 'Document...'"
  }

  // With timestamp in query
  const doc2 = await Document.findById(id, undefined, { timestamps: true });
  if (doc2) {
    console.log(doc2.createdAt); // Error: "Property 'createdAt' does not exist on type 'Document...'"
    console.log(doc2.updatedAt); // Error: "Property 'updatedAt' does not exist on type 'Document...'"
  }
}

Expected Behavior

Expect the Document to have the timestamp fields present on the returned type.

[jamesholcomb]

I am also converting a project to TS and experiencing this, however, an explicit interface seems to cause the same issue.

import { model, Schema } from "mongoose"

interface IPost {
  title: string
}

const postSchema = new Schema(
  {
    title: {
      type: String,
      required: true,
    },
  },
  {
    timestamps: true,
  }
)

const Post = model<IPost>("Post", postSchema)

Post.create({ title: "foo" }).then((post) => {
  console.log(post._id)
  console.log(post.createdAt) // property 'createdAt' does not exist on type 'Document<unknown, any, IPost> & IPost & { _id: ObjectId; }'.
})

Being a bit of TS noob, is there a workaround that does not require @ts-expect-error everywhere? It is reproducible in every 6.x release I tried.

[janickvwcotiss]

I am also converting a project to TS and experiencing this, however, an explicit interface seems to cause the same issue.

import { model, Schema } from "mongoose"

interface IPost {
  title: string
}

const postSchema = new Schema(
  {
    title: {
      type: String,
      required: true,
    },
  },
  {
    timestamps: true,
  }
)

const Post = model<IPost>("Post", postSchema)

Post.create({ title: "foo" }).then((post) => {
  console.log(post._id)
  console.log(post.createdAt) // property 'createdAt' does not exist on type 'Document<unknown, any, IPost> & IPost & { _id: ObjectId; }'.
})

Being a bit of TS noob, is there a workaround that does not require @ts-expect-error everywhere? It is reproducible in every 6.x release I tried.

I know this isn't ideal but might help with your typescript errors until this is fixed in the next milestone?

interface IPost {
  title: string
  createdAt: Date;
  updateAt: Date;
}

const postSchema = new Schema<IPost>(
  {
    title: {
      type: String,
      required: true,
    },
  },
  {
    timestamps: true,
  }
)

const Post = model<IPost>("Post", postSchema)

Post.create({ title: "foo" }).then((post) => {
  console.log(post._id)
  console.log(post.createdAt) // (property) IPost.createdAt: Date
})

[Uzlopak]

@mohammad0-0ahmad

[mohammad0-0ahmad]

Thanks for mention @Uzlopak !
All changes that are related to schema options will be covered soon, but I am waiting for merging the PR related to virtuals paths, then I will start to cover schema options as I told.

[shoeferlin]

Experiencing the same issue. Looking forward to a fix!

[neocameback]

Could you try to access with following
post['createdAt']
instead of
post.createdAt

[janickvwcotiss]

Could you try to access with following post['createdAt'] instead of post.createdAt

Doesn't make a difference

[Adizbek]

@janickvwcotiss @neocameback
For quick fix, you can try to use SchemaTimestampsConfig