InterSchemaType does not properly infer "required" field for Schema.Types.ObjectId type

[darwin403]

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

Node.js version

16.13.1

MongoDB server version

6.x

Description

A schema field with {type: Schema.Types.ObjectId, required: true} cause faulty inference of Schema type. But, {type: Schema.Types.ObjectId, required: false} , {type: String, required: true} seem to work

Steps to Reproduce

The following works:

const campaignSchema = new Schema(
  {
    client: {
      type: Schema.Types.ObjectId,
      trim: true,
      ref: "User",
      required: false,
    },
  },
  { timestamps: true }
);

type ICampaign = InterSchemaType<ICampaignSchema>; // {client?: Types.ObjectId | undefined }

The following doesn't work:

const campaignSchema = new Schema(
  {
    client: {
      type: Schema.Types.ObjectId, // works when the type is changed to "String"
      trim: true,
      ref: "User",
      required: true, // fails to interpret schema
    },
  },
  { timestamps: true }
);

type ICampaign = InterSchemaType<ICampaignSchema>; // DOES NOT return {client:  Types.ObjectId }

Expected Behavior

type ICampaign = InterSchemaType<ICampaignSchema>;  // {client:  Types.ObjectId }

[IslandRhythms]

What is inferModelType suppose to be?

[darwin403]

@IslandRhythms Sorry it was a typo. I meant InterSchemaType, just updated the issue. The inferModelType is just my custom type and can be ignored. The problem I'm highlighting only concerns InterSchemaType

[IslandRhythms]

Cannot find name 'InterSchemaType'

[Uzlopak]

@mohammad0-0ahmad

[mohammad0-0ahmad]

@darwin403 has meant the following:

const campaignSchema = new Schema(
  {
    client: {
      type: Schema.Types.ObjectId,
      trim: true,
      ref: 'User',
      required: true
    }
  },
  { timestamps: true }
);

type ICampaign = InferSchemaType<typeof campaignSchema>;

[mohammad0-0ahmad]

Yes, it returns a wrong result.
It related to #12168, I think.
@vkarpov15 would you like to reopen it, so @iammola can fix it, or what do you think ?

[ryaposov]

I can see the issue is in progress already, but just to confirm I have a similar issue even without specifying required.

...
type: {
    type: String,
    enum: ['income', 'expence', 'write-off'],
    required: true
  },
  procurementOrderId: {
    type: Schema.Types.ObjectId,
    ref: 'procurementOrders',
  },

Produces the following (notice type field resulting in unknown):

Removing procurementOrderId field from schema makes types work again perfectly.