Add typesVersion with minimum TypeScript version

[elszczepano]

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

Node.js version

16.16.0

MongoDB server version

6.0.2 (not required)

Description

I've experienced an issue with mongoose above version 6.6.3. When I try to build a project that uses mongoose in version 6.6.4 or higher I receive:

When I switched to 6.6.3 the issue does not occur. My TS config:

{
  "compilerOptions": {
    "outDir": "./dist",
    "rootDir": "./src",
    "esModuleInterop": true,
    "lib": [
      "es2021",
      "dom"
    ],
    "module": "commonjs",
    "target": "es2021",
    "moduleResolution": "node",
    "allowJs": true,
    "noImplicitAny": true,
    "composite": true,
    "skipLibCheck": true,
    "sourceMap": true,
    "strictNullChecks": true,
    "experimentalDecorators": true,
    "forceConsistentCasingInFileNames": true,
    "include": [
        "src/**/*"
    ]
  }
}

As I briefly checked, the pointed places seem to be syntactically correct so the issue is a bit awkward for me. I'd be grateful for a hint if an issue is on my side.

Steps to Reproduce

Just run tsc --build for a project that uses mongoose.

Expected Behavior

The project is built correctly.

[vkarpov15]

@elszczepano what version of TypeScript? I'm able to run tsc --build with a slightly fixed version of your tsconfig.json with TypeScript 4.8.4.

Maybe because your tsconfig.json is invalid? You're missing a , after "esModuleInterop": true and include is not a valid compilerOptions property.

[ultrarunner]

I have a similar issue as @elszczepano with typescript 4.3.4, node 14.19. Just wanted to add some context. I am on mongoose@6.5.2 and was trying to upgrade to latest. Tried to downgrade to 6.6.3 without success. I cannot even upgrade to 6.5.3. Getting a compilation error as well there on a single line.
node_modules/mongoose/types/query.d.ts:619:29 - error TS2304: Cannot find name 'this'. 619 toConstructor(): typeof this; ~~~~ Found 1 error.
Looked at the differences between the 2 releases and noticed the query.d.ts file has a lot of updates. Hope this helps. Will keep trying to figure it out.

[elszczepano]

Maybe because your tsconfig.json is invalid? You're missing a , after "esModuleInterop": true and include is not a valid compilerOptions property.

Even after fixing the tsconfig the issue still occurs in my case. Regarding the TS version, I use 4.6.3.

EDIT:
I can confirm the issue does not occur on the latest TS version (4.8.4). Also 4.7.3 so the issue affects only TS in version 4.6 and below

[kYem]

I had exactly same problem with TS 4.6.4, had to upgrade to latest version and it went away.

[hasezoey]

Duplicate of #12512

[hasezoey]

@ultrarunner

node_modules/mongoose/types/query.d.ts:619:29 - error TS2304: Cannot find name 'this'. 619 toConstructor(): typeof this; ~~~~ Found 1 error.

this should be changed with #12522, which was included in mongoose 6.6.5

[ItsMorningstar]

mongoose@6.6.5
Typescript@4.8.4
node v18.9.0

Facing following query.d.ts errors.

Please help

[hasezoey]

@YooItsMaster did you already try clearing the node modules and re-installing? also are you sure you are using typescript 4.8 to compile?

[ItsMorningstar]

Oh although i had ts v4.8.4 installed it was still using v4.6.2 for compilation. That fixed it. Sry, Thank

[AlexRMU]

Dude...

[hasezoey]

@AlexRMU from what i can tell, the current types (typeof Query) is correct, because the function toConstructor is meant to return a Class (constructor) not a instance of a class, and because Query is a class, by default in typescript this means that the type is a instance of a class

mongoose/types/query.d.ts

Line 172 in 8ea0a44

class Query<ResultType, DocType, THelpers = {}, RawDocType = DocType> implements SessionOperation {

[hxtree]

Oh although i had ts v4.8.4 installed it was still using v4.6.2 for compilation. That fixed it. Sry, Thank

I ran into the same issue. I had Typescript 4.8.4 installed globally but in a monorepo package.json there was 4.6.2, which needed to change to.

  "devDependencies": {
    "typescript": "4.8.4"
  },

This is a really obscure requirement to find, Perhaps the Typescript minimum version could be placed README or similar to help distribute this info?

[hxtree]

It appears, if a typesVersions were added to mongoose / package.json, probably similar to:

  "typesVersions": {
    ">=4.8.4": { "*": "./types/index.d.ts"] }
  }

It would produce the following error using the package with a unsupported version. And the error message appears to be improvable.

"'package.json' does not have a 'typesVersions' entry that matches version '{0}'."

References:
https://www.typescriptlang.org/docs/handbook/declaration-files/publishing.html#version-selection-with-typesversions
microsoft/TypeScript#32166
https://github.com/search?q=%22%3E%3D4.8.4%22+filename%3Apackage.json+typesversions

[sikmakn]

I have the same problem. Typescript version 4.8.3

[Mankore]

Same issue

node: 'v16.15.1'
npm: 8.13.2
"mongoose": "^6.7.0"
"typescript": "^4.8.4"

using "skipLibCheck": true, in typescript config or upgrading to latest version of typescript doesn't work for me

[vkarpov15]

@sikmakn @Mankore please open a new issue and follow the issue template.

[vkarpov15]

@hxtree I'm not getting any error when running with a TypeScript version that isn't listed in typesVersion, for example with the following:

"types": "./types/index.d.ts",
  "typesVersions": {
    ">=4.2": { "*": ["./types/index.d.ts"] }
  },

A sample Mongoose script compiles just fine with TypeScript 4.1. This looks to be expected behavior from TypeScript. For example, look at the following highlighted section in the TS docs you linked to.