Extending Base but optional _id?

[theDanielJLewis]

I'm really confused and frustrated and I hope you can help!

If I extend Base, I can easily call _id or id, but any time I create a new document, TypeScript complains that _id is required!

If I try to make _id optional, I get the error Interface 'MyClass' incorrectly extends interface 'Base<ObjectId>'.

But if I don't use Base and instead add the following to MyClass:

	@prop()
	public _id?: Types.ObjectId;

	@prop()
	public id?: string;

Then the id value is always empty.

But if I remove the id part, then I get errors that it doesn't exist when I try to use it instead of _id.toString()!

GAH!

Please help!

Thanks in advance!

[hasezoey]

But if I don't use Base and instead add the following to MyClass:
@prop()

read I need to set _id manually, how to do it properly?

Then the id value is always empty.

that is either because _id is always empty (because of the above) and / or that you are setting a custom path which would nromally be a automatic virtual

If I extend Base, I can easily call _id or id, but any time I create a new document, TypeScript complains that _id is required!

if you do it like in the documentation, then it should not give you a error, you can also do the implements route, which also does not cause errors

Code used:

// NodeJS: 19.9.0
// MongoDB: 5.0 (Docker)
// Typescript 4.9.5
import { getModelForClass, prop } from '@typegoose/typegoose'; // @typegoose/typegoose@11.2.0
import { Base } from '@typegoose/typegoose/lib/defaultClasses';
import * as mongoose from 'mongoose'; // mongoose@7.2.1

// Example from the documentation via the dual interface & class way
// eslint-disable-next-line @typescript-eslint/no-empty-interface
// interface User extends Base {}
// class User {
//   @prop()
//   public username?: string;
// }

// Example via the "implements" way
class User implements Base {
  _id!: mongoose.Types.ObjectId;
  id!: string;
  @prop()
  public username?: string;
}

const UserModel = getModelForClass(User);

async function main() {
  await mongoose.connect(`mongodb://localhost:27017/`, {
    dbName: 'verifyMASTER',
  });

  await UserModel.create({ username: 'hello' });

  const doc = new UserModel({ username: 'user1' });

  console.log(doc);

  await mongoose.disconnect();
}

main();

(with the configs from typegoose-testing)

[theDanielJLewis]

FACEPALM!

Typegoose 11.2 is apparently not compatible with Mongoose 7.3! I downgraded to 7.2 and I no longer get the MongooseError above.

So backing up then. What is the right and optimized way to implement Base? Is seemingly redundant code just necessary?

[theDanielJLewis]

Sorry, no. I still get problems with _id being required. And the above method won't let me switch it to _id?.

[hasezoey]

Typegoose 11.2 is apparently not compatible with Mongoose 7.3! I downgraded to 7.2 and I no longer get the MongooseError above.

typegoose 11.2 (currently latest) does not support mongoose as in the version range, but if explicitly installed it should work (see Automattic/mongoose#13499 (review)), though i will release a new version soon

Sorry, no. I still get problems with _id being required. And the above method won't let me switch it to _id?.

i can also reproduce the error when changing to ?, but can you provide a example of how you try to use the model where you get a _id required error? (also is that error a types error or a runtime error?)

[theDanielJLewis]

I looked deeper into my code and found the "problem," but I still have a preference for how it should work.

When declaring the object for Podcast.create(), I was making it use PodcastClass to help with ensuring I properly formatted the object before sending to the DB. But adding the PodcastClass type would result in the error telling me that _id was required. It's that error that I've been fighting over with using Base but still getting typing while creating my objects.

When I removed that type assignment from the unsaved object, that TS error went away.

But I would really like the ability to assign a class from Typegoose to help format the unsaved object correctly. But you can see the battle I've had with the Base class over this.

[hasezoey]

But adding the PodcastClass type would result in the error telling me that _id was required. It's that error that I've been fighting over with using Base but still getting typing while creating my objects.

for that use-case you likely will need to use Omit with the paths that are already existing, sadly this cannot be done (to my knowledge) at the same time simply