@types/mongoose create schema forces non-required properties at crate time

[tomyam1]

• I tried using the @types/mongoose package and had problems.
• I tried using the latest stable version of tsc. https://www.npmjs.com/package/typescript
• Mention the authors (see Definitions by: in index.d.ts) so they can respond.
  • Authors: @andreialecu

In the example below, addedInMiddleware is required on the document but not on the create schema since it's added in a middleware.

The schema added in 88a54a9 causes addedInMiddleware to be required at compile time, but it shouldn't be.

@andreialecu I'd appreciate if you can fix this.

import * as Mongoose from 'mongoose'

interface IDocument extends Mongoose.Document {
    addedInMiddleware: string
}

const schema = new Mongoose.Schema({
    addedInMiddleware: String,
})

schema.pre('validate', async function (this: IDocument) {
    if (!this.addedInMiddleware) this.addedInMiddleware = 'added';
});

const model = Mongoose.model<IDocument>('model', schema);

/*
TS2769: No overload matches this call.   
The last overload gave the following error.     
Argument of type '{}' is not assignable to parameter of type 'Pick<{ _id: any; addedInMiddleware: string; } & { _id: any; }, "addedInMiddleware"> & { _id?: any; }'.       
Property 'addedInMiddleware' is missing in type '{}' but required in type 'Pick<{ _id: any; addedInMiddleware: string; } & { _id: any; }, "addedInMiddleware">'.
 */
model.create({});

[andreialecu]

Proper usage here is:

type CreateDocument = Omit<IDocument, "addedInMiddleware">;
model.create<CreateDocument>({});

Or define your interface like:

interface IDocument extends Mongoose.Document {
    addedInMiddleware?: string
}

[tomyam1]

Sorry, neither of your suggestions are proper usage.

Proper usage here is:

type CreateDocument = Omit<IDocument, "addedInMiddleware">;
model.create<CreateDocument>({});

This will NOT work for nested objects.

Or define your interface like:

interface IDocument extends Mongoose.Document {
    addedInMiddleware?: string
}

This is just wrong. addedInMiddleware is not optional in the doucment.

[andreialecu]

interface IDocument extends Mongoose.Document {
    readonly addedInMiddleware: string
}

This will also work if it's read only, meaning addedInMiddleware will not be required during creation.

[andreialecu]

This will NOT work for nested objects.

Of course it will, you can override the type at any level in the schema.

Here's a helper type to help with that:
piotrwitek/utility-types#129

[orta]

Hi thread, we're moving DefinitelyTyped to use GitHub Discussions for conversations the @types modules in DefinitelyTyped.

To help with the transition, we're closing all issues which haven't had activity in the last 6 months, which includes this issue. If you think closing this issue is a mistake, please pop into the TypeScript Community Discord and mention the issue in the definitely-typed channel.