feat: add types

[Phillip9587]

This PR adds type definitions to finalhandler. It includes the following changes:

• moving types from @types/finalhandler into the repository (https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/finalhandler)
• adding type, main and types field to package.json
• adding a tsconfig.json which extends @tsconfig/node18 from https://github.com/tsconfig/bases
• adding type tests with @arethetypeswrong/cli and tsd

Ref: expressjs/typescript-wg#1

cc @RobinTail @hichemfantar

[socket-security]

New dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@arethetypeswrong/[email protected]	Transitive: environment, filesystem, network, shell, unsafe	+52	31.7 MB	andrewbranch
npm/@tsconfig/[email protected]	None	0	2.36 kB	typescript-deploys
npm/@types/[email protected]	None	+1	83.3 kB
npm/[email protected]	None	0	0 B
npm/[email protected]	None	0	22.9 MB	typescript-bot

View full report↗︎

[RobinTail]

👍🏽

[Phillip9587]

Hey @RobinTail, can you review again please? I implemented your suggestions.

[RobinTail]

LGTM, @Phillip9587

[RobinTail]

🏅

[Phillip9587]

Can we release this as a minor and recommend users to migrate away from @types/finalhandler to the built-in types, or would this require a major release?

[bjohansebas]

Nope, this should be released in a major version, mainly because it could break TypeScript users, whether they use it with Express or not. Besides, it's not natural to add TypeScript support in a non-major version.

[Phillip9587]

How about merging this into the master branch without publishing it for now?
That way, we can continue iterating and improving the types.
Once we're ready to release v3, we can add index.d.ts to the files and types fields in package.json.

[Phillip9587]

Suggested change

"types": "index.d.ts",

[RobinTail]

I believe types would be resolved automatically even without this entry.
Just because of the index.* naming

[RobinTail]

At least in my PR attw resolves them without types in package.json

[Phillip9587]

Suggested change

	"index.js",
	"index.d.ts"
	"index.js"

[bjohansebas]

Just to say, it's normal to release this in a minor version. Also, this is blocked until the types are officially accepted in the repositories.