BREAKING CHANGE: consolidate RootQuerySelector, Condition, etc. types with MongoDB driver's

[vkarpov15]

Summary

QuerySelector, RootQuerySelector, and Condition are almost exactly duplicates of types the MongoDB Node driver exports. With a little work, we can make it so that Mongoose uses the MongoDB driver's types rather than maintaining its own (which may be out of date).

Examples

[hasezoey]

On the surface this looks like a good change, but in its current state it causes some errors like the 2 below in typegoose:

src/typeguards.ts:21:12 - error TS2677: A type predicate's type must be assignable to its parameter's type.
  Type 'Array<DocumentType<NonNullable<T>>>' is not assignable to type 'Array<Ref<T, S>>'.
    Type 'DocumentType<NonNullable<T>>' is not assignable to type 'Ref<T, S>'.
      Type 'DocumentType<NonNullable<T>>' is not assignable to type 'DocumentType<T, BeAnObject>'.
        Type 'DocumentType<NonNullable<T>>' is not assignable to type 'Document<unknown, BeAnObject, T, DefaultIdVirtual, {}>'.

21 ): docs is mongoose.Types.Array<DocumentType<NonNullable<T>>>;

(this one at least can be solved by removing the NonNullable<>, though i dont know why it wouldnt be compatible)

test/tests/ref.test.ts:93:3 - error TS2322: Type 'Document<unknown, BeAnObject, RefTestString, DefaultIdVirtual, {}> & Omit<RefTestString & Required<{ _id: string; }> & { ...; }, "id" | "typegooseName"> & DefaultIdVirtual & IObjectWithTypegooseFunction' is not assignable to type 'Ref<RefTestStringOptional> | undefined'.
  Type 'Document<unknown, BeAnObject, RefTestString, DefaultIdVirtual, {}> & Omit<RefTestString & Required<{ _id: string; }> & { ...; }, "id" | "typegooseName"> & DefaultIdVirtual & IObjectWithTypegooseFunction' is not assignable to type 'DocumentType<RefTestStringOptional, BeAnObject>'.
    Type 'Document<unknown, BeAnObject, RefTestString, DefaultIdVirtual, {}> & Omit<RefTestString & Required<{ _id: string; }> & { ...; }, "id" | "typegooseName"> & DefaultIdVirtual & IObjectWithTypegooseFunction' is not assignable to type 'Document<unknown, BeAnObject, RefTestStringOptional, DefaultIdVirtual, {}>'.
      The types returned by 'deleteOne(...)' are incompatible between these types.
        Type 'QueryWithHelpers<DeleteResult, Document<unknown, BeAnObject, RefTestString, DefaultIdVirtual, {}> & Omit<RefTestString & Required<...> & { ...; }, "id" | "typegooseName"> & DefaultIdVirtual & IObjectWithTypegooseFunction, BeAnObject, RefTestString, "deleteOne", Record<...>>' is not assignable to type 'QueryWithHelpers<DeleteResult, Document<unknown, BeAnObject, RefTestStringOptional, DefaultIdVirtual, {}>, BeAnObject, RefTestStringOptional, "deleteOne", Record<...>>'.
          Type 'QueryWithHelpers<DeleteResult, Document<unknown, BeAnObject, RefTestString, DefaultIdVirtual, {}> & Omit<RefTestString & Required<...> & { ...; }, "id" | "typegooseName"> & DefaultIdVirtual & IObjectWithTypegooseFunction, BeAnObject, RefTestString, "deleteOne", Record<...>>' is not assignable to type 'Query<DeleteResult, Document<unknown, BeAnObject, RefTestStringOptional, DefaultIdVirtual, {}>, BeAnObject, RefTestStringOptional, "deleteOne", Record<...>>'.
            The types returned by '$where(...)' are incompatible between these types.
              Type 'QueryWithHelpers<(Document<unknown, BeAnObject, RefTestString, DefaultIdVirtual, {}> & Omit<RefTestString & Required<{ _id: string; }> & { ...; }, "id" | "typegooseName"> & DefaultIdVirtual & IObjectWithTypegooseFunction)[], ... 4 more ..., Record<...>>' is not assignable to type 'QueryWithHelpers<Document<unknown, BeAnObject, RefTestStringOptional, DefaultIdVirtual, {}>[], Document<unknown, BeAnObject, RefTestStringOptional, DefaultIdVirtual, {}>, BeAnObject, RefTestStringOptional, "deleteOne", Record<...>>'.
                Type 'QueryWithHelpers<(Document<unknown, BeAnObject, RefTestString, DefaultIdVirtual, {}> & Omit<RefTestString & Required<{ _id: string; }> & { ...; }, "id" | "typegooseName"> & DefaultIdVirtual & IObjectWithTypegooseFunction)[], ... 4 more ..., Record<...>>' is not assignable to type 'Query<Document<unknown, BeAnObject, RefTestStringOptional, DefaultIdVirtual, {}>[], Document<unknown, BeAnObject, RefTestStringOptional, DefaultIdVirtual, {}>, BeAnObject, RefTestStringOptional, "deleteOne", Record<...>>'.
                  Types of property 'and' are incompatible.
                    Type '(array: FilterQuery<RefTestString>[]) => QueryWithHelpers<(Document<unknown, BeAnObject, RefTestString, DefaultIdVirtual, {}> & Omit<...> & DefaultIdVirtual & IObjectWithTypegooseFunction)[], ... 4 more ..., Record<...>>' is not assignable to type '(array: FilterQuery<RefTestStringOptional>[]) => Query<Document<unknown, BeAnObject, RefTestStringOptional, DefaultIdVirtual, {}>[], ... 4 more ..., Record<...>>'.
                      Types of parameters 'array' and 'array' are incompatible.
                        Type 'FilterQuery<RefTestStringOptional>[]' is not assignable to type 'FilterQuery<RefTestString>[]'.
                          Type 'FilterQuery<RefTestStringOptional>' is not assignable to type 'FilterQuery<RefTestString>'.
                            Type '{ _id?: Condition<ApplyBasicQueryCasting<StringQueryTypeCasting | undefined>>; } & RootFilterOperators<{ _id?: ApplyBasicQueryCasting<StringQueryTypeCasting | undefined>; }>' is not assignable to type 'FilterQuery<RefTestString>'.
                              Type '{ _id?: Condition<ApplyBasicQueryCasting<StringQueryTypeCasting | undefined>>; } & RootFilterOperators<{ _id?: ApplyBasicQueryCasting<StringQueryTypeCasting | undefined>; }>' is missing the following properties from type 'Query<any, any, {}, unknown, "find", Record<string, never>>': _mongooseOptions, exec, all, allowDiskUse, and 93 more.

93   refTypeTest.refFieldStringOptional = new RefTestStringModel();
     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Note that this error seemingly only happens to classes which have _id?: Type (or _id: Type | undefined). (which is i think used to make it optional for defaulting)

[Copilot]

Pull Request Overview

This PR consolidates type definitions by replacing Mongoose's custom Condition, RootQuerySelector, and QuerySelector types with equivalent types from the MongoDB Node driver to reduce duplication and ensure consistency.

• Removes Mongoose-specific type imports and replaces them with MongoDB driver types
• Updates type annotations to use mongodb.Condition<T> instead of Mongoose's Condition<T>
• Simplifies type definitions by leveraging the MongoDB driver's existing type system

Reviewed Changes

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

File	Description
test/types/queries.test.ts	Removes Condition and QuerySelector imports, adds mongodb import, updates type annotations to use mongodb.Condition<T>
test/types/populate.test.ts	Simplifies function parameter types and updates toObject generic type usage

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[vkarpov15]

@hasezoey can you please take another look and see if you still get the same error with typegoose?

[vkarpov15]

I checked and you're right, removing the NonNullable<> in the following fixes typegoose tests.

export function isDocumentArray<T, S extends RefType>(
  docs: mongoose.Types.Array<Ref<T, S>> | null | undefined
): docs is mongoose.Types.Array<DocumentType<NonNullable<T>>>;

I'll take a look as to why.

[vkarpov15]

@hasezoey can you please take another look? Typegoose tests seem to pass on latest feature/13.0 branch and this latest PR

I also ended up stripping out a bunch of unnecessary generics to shave off some instantiations for performance. Will need to make some changelog notes for that.

[hasezoey]

Looks good to me now in its current state. Though the generics removal should arguably be a separate PR.

[hasezoey]

Why remove the ability for updateOne to specify / overwrite the result type?

Edit: in case github still shows this later, somehow in the PR-thread interface it show the completely wrong lines, but shows it correctly in the PR-files interface.

[vkarpov15]

Better tsc performance due to fewer instantiations is the primary driver.

I also don't see updateOne<ResultType> being especially useful because updateOne() always returns UpdateOneResult, the generic parameter doesn't update the ResultType virtual. Also, updateOne not having a generic is more consistent with deleteOne, which similarly always returns DeleteOneResult.