ObjectId is different from Type.ObjectId

Prerequisites

• I have written a descriptive issue title

Mongoose version

6.7.2

Node.js version

18.7.0

MongoDB version

6.0

Operating system

macOS

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

13.0.1

Issue

I want parse string to ObjectId, and Previous versions are OK

“@nestjs/common”: “^7.6.15” “mongoose”: “^5.11.12”

but there are some type errors when i upgrade version

“@nestjs/common”: “^9.2.0” “mongoose”: “^6.7.2”

code:

import { PipeTransform, Injectable, BadRequestException } from '@nestjs/common';
import { Types } from 'mongoose';

@Injectable()
export class ParseObjectIdPipe implements PipeTransform<any, Types.ObjectId> {
  transform(value: any): Types.ObjectId {
    const validObjectId: boolean = Types.ObjectId.isValid(value);
    if (!validObjectId) {
      throw new BadRequestException('Invalid ObjectId');
    }
    return Types.ObjectId.createFromHexString(value);
  }
}

error:

type "import("/***/node_modules/bson/bson").ObjectID" Missing attribute in "_id"，but type "import("mongoose").Types.ObjectId" is required in。

I have to use

import { PipeTransform, Injectable, BadRequestException } from '@nestjs/common';
import { Types } from 'mongoose';
import { ObjectId } from 'bson';

@Injectable()
export class ParseObjectIdPipe implements PipeTransform<any, ObjectId> {
  transform(value: any): ObjectId {
    const validObjectId: boolean = Types.ObjectId.isValid(value);
    if (!validObjectId) {
      throw new BadRequestException('Invalid ObjectId');
    }
    return Types.ObjectId.createFromHexString(value);
  }
}

to fix it Is that right？

I saw a problem like me

https://github.com/Automattic/mongoose/issues/12537

[vkarpov15]

I took a closer look and @hasezoey is right, this is due to the _id getter. Here’s a simpler repro script that doesn’t involve nestjs:

import { Types } from 'mongoose';
import { ObjectId } from 'bson';

function foo(value: any): Types.ObjectId {
  return ObjectId.createFromHexString(value);
}

Mongoose adds an _id getter to ObjectIds to make it more convenient to work with populated paths, so you can use .path._id to get the _id of the document regardless of whether it is populated. But there’s no good way for Mongoose to add additional properties to a MongoDB class in TypeScript, so Mongoose’s ObjectId type extends from MongoDB driver’s.

@hasezoey is right, no need to mix bson ObjectId and Mongoose ObjectId anyway. You can do new Types.ObjectId(). Or Types.ObjectId.createFromHexString() if you really want.

[DuJiming]

new Types.ObjectId(string)

yes new Types.ObjectId(string) is better , think you