Fix knex d.ts to work with Node16 module mode

[patrickshipe]

Currently, the knex type declarations use export default as if it were an ES module. This has not mattered up until recently with Node's increased ESM support and TypeScript's node16 module setting, which is the TypeScript's team recommended setting for Node users.

Bear with me - this is a bit convoluted. Node's behavior when importing CJS from an ES module is to make module.exports the default export. TypeScript adheres to this, which leads to some weird quirks when we look at knex's type declarations. TS properly detects knex as a CJS module, and when it sees a default export in the declarations, it assumes that the knex function is set to module.exports.default (which it also is) but not to module.exports. So to TS, under node16 module mode, the default export from knex is simply an object with a default property. It cannot be called as a function, even though this is perfectly legal at runtime.

What's the fix here? It's quite simple. Use export = syntax to describe the CJS export, and declare the circular references set in knex.js. This works perfectly in both the new world and old, since we are explicitly telling TS the shape of the proper CJS export rather than having it make assumptions.

[patrickshipe]

@OlivierCavadenti - would really appreciate a look at this one. The TypeScript team is really pushing Node users to move to module node16 and the current typings make this very difficult. Let me know what else I can do to help!

[patrickshipe]

https://arethetypeswrong.github.io/?p=knex%402.5.1

[kibertoad]

Thanks! Is it possible to add additional tests which would have been failing under old setup?

[coveralls]

coverage: 92.823%. remained the same when pulling 31cedc2 on patrickshipe:knex-fix-types into 6142d98 on knex:master.

[patrickshipe]

@kibertoad I have not found a way to configure the type definition testing tool to test using module node16/nodenext in addition to the current settings. The tool seems to only allow for one tsconfig configuration in the package.json. If someone has a way to do this I am happy to give it a shot.

[valtlai]

Is there plans to release a new patch version soon that includes this fix?

[kibertoad]

@valtlai sure, I can publish it tonight

[patrickshipe]

@kibertoad will this be published this week? Thank you :)

[Jiralite]

Does this not resolve #5358?

[patrickshipe]

It does @Jiralite ! We need a new version published with this code though.

[Jiralite]

Awesome. Yeah, I was more pointing out that issue should ideally be closed then.

[kibertoad]

Sorry for the delay. 3.0.0 is now out! Please let me know if it works as expected.

[valtlai]

@kibertoad Thank you, it’s now working as expected. Edit: this bug is resolved, yeah, but there is now a entirely different bug: #5706.