feat: types for `express` 5 by RobinTail · Pull Request #70563 · DefinitelyTyped/DefinitelyTyped

RobinTail · 2024-09-14T08:37:10Z

Alternative to #69846 (comment) — the author is sick and can not continue.

The primary goal of this PR is to release the types for express version 5 — the main difference is allowing Promise<void> along with void on RequestHandler.

Challenge: void was technically compatible with anything actually returned, but void | Promise<void> is not.

Tracked in: expressjs/express#5944

Please fill in this template.

Use a meaningful title for the pull request. Include the name of the package modified.
Test the change in your own code. (Compile and run.)
Add or edit tests to reflect the change.
Follow the advice from the readme.
Avoid common mistakes.
Run pnpm test <package to test>.

Select one of these and delete the others:

If adding a new definition:

The package does not already provide its own types, or cannot have its .d.ts files generated via --declaration
If this is for an npm package, match the name. If not, do not conflict with the name of an npm package.
Create it with dts-gen --dt, not by basing it on an existing project.
Represents shape of module/library correctly
tsconfig.json should have noImplicitAny, noImplicitThis, strictNullChecks, and strictFunctionTypes set to true.

If changing an existing definition:

Provide a URL to documentation or source code which provides context for the suggested changes: https://expressjs.com/en/guide/migrating-5.html#rejected-promises
If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the package.json.

If removing a declaration:

If a package was never on Definitely Typed, you don't need to do anything. (If you wrote a package and provided types, you don't need to register it with us.)
Delete the package's directory.
Add it to notNeededPackages.json.

RobinTail · 2024-09-14T11:14:50Z

✅ All tests pass now.

some packages have mistakes is tests
some packages have wrong types
some packages have discrepancies in the declared dependencies
some declare express compatibility as * which is probably not true, and really implies ^4, but...

I'm requesting comments and I'm open for advises and suggestions on how this important change could be made even better and released faster.

typescript-bot · 2024-09-14T11:15:40Z

@RobinTail Thank you for submitting this PR!

This is a live comment that I will keep updated.

This PR touches some part of DefinitelyTyped infrastructure, so a DT maintainer will need to review it. This is rare — did you mean to do this?

16 packages in this PR (and infra files)

absolute-url — on npm, on unpkg
architect__functions — on npm, on unpkg
create-test-server — on npm, on unpkg
express-brute — on npm, on unpkg
express-oauth-server — on npm, on unpkg
express-serve-static-core — on npm, on unpkg
- Config files to check:
  - express-serve-static-core/v4/.eslintrc.json: edited
express-ua-middleware — on npm, on unpkg
express — on npm, on unpkg
- Config files to check:
  - express/v4/.eslintrc.json: edited
feathersjs__express — on npm, on unpkg
forest-express-mongoose — on npm, on unpkg
forest-express-sequelize — on npm, on unpkg
fusebit__oauth-connector — on npm, on unpkg
logfmt — on npm, on unpkg
mock-req-res — on npm, on unpkg
mongoose-aggregate-paginate-v2 — on npm, on unpkg
swaggerize-express — on npm, on unpkg
Infra files
- attw.json

Code Reviews

Because this is a widely-used package, a DT maintainer will need to review it before it can be merged.

You can test the changes of this PR in the Playground.

Status

✅ No merge conflicts
✅ Continuous integration tests have passed
✅ A DT maintainer needs to approve changes that affect DT infrastructure (attw.json)

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 70563,
  "author": "RobinTail",
  "headCommitOid": "8f3a52d98bbbe1539d19bda7cc63581c241d4d9b",
  "mergeBaseOid": "b0208c9d870b7bfa747d7ed9c7c108c95207cc97",
  "lastPushDate": "2024-09-14T08:37:10.000Z",
  "lastActivityDate": "2024-09-25T19:08:01.000Z",
  "mergeOfferDate": "2024-09-25T17:37:04.000Z",
  "mergeRequestDate": "2024-09-25T19:08:01.000Z",
  "mergeRequestUser": "RobinTail",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": null,
      "kind": "edit",
      "files": [
        {
          "path": "attw.json",
          "kind": "infrastructure"
        }
      ],
      "owners": [],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical",
      "isSafeInfrastructureEdit": false
    },
    {
      "name": "absolute-url",
      "kind": "edit",
      "files": [
        {
          "path": "types/absolute-url/package.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "tpluscode",
        "ludovicm67"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "architect__functions",
      "kind": "edit",
      "files": [
        {
          "path": "types/architect__functions/test/http-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "activescott",
        "ryanblock",
        "reconbot"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "create-test-server",
      "kind": "edit",
      "files": [
        {
          "path": "types/create-test-server/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "midgleyc"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "express-brute",
      "kind": "edit",
      "files": [
        {
          "path": "types/express-brute/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "cyrilschumacher"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "express-oauth-server",
      "kind": "edit",
      "files": [
        {
          "path": "types/express-oauth-server/express-oauth-server-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/express-oauth-server/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "atd-schubert"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "express-serve-static-core",
      "kind": "edit",
      "files": [
        {
          "path": "types/express-serve-static-core/.npmignore",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/express-serve-static-core/express-serve-static-core-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/express-serve-static-core/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/express-serve-static-core/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/express-serve-static-core/v4/.eslintrc.json",
          "kind": "package-meta",
          "suspect": "edited"
        },
        {
          "path": "types/express-serve-static-core/v4/.npmignore",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/express-serve-static-core/v4/express-serve-static-core-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/express-serve-static-core/v4/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/express-serve-static-core/v4/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/express-serve-static-core/v4/tsconfig.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "borisyankov",
        "micksatana",
        "JoseLion",
        "dwrss",
        "andoshin11"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    },
    {
      "name": "express-ua-middleware",
      "kind": "edit",
      "files": [
        {
          "path": "types/express-ua-middleware/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "peterblazejewicz"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "express",
      "kind": "edit",
      "files": [
        {
          "path": "types/express/.npmignore",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/express/express-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/express/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/express/v4/.eslintrc.json",
          "kind": "package-meta",
          "suspect": "edited"
        },
        {
          "path": "types/express/v4/.npmignore",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/express/v4/express-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/express/v4/index.d.ts",
          "kind": "definition"
        },
        {
          "path": "types/express/v4/package.json",
          "kind": "package-meta-ok"
        },
        {
          "path": "types/express/v4/tsconfig.json",
          "kind": "package-meta-ok"
        }
      ],
      "owners": [
        "borisyankov",
        "CMUH",
        "puneetar",
        "dfrankland"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    },
    {
      "name": "feathersjs__express",
      "kind": "edit",
      "files": [
        {
          "path": "types/feathersjs__express/feathersjs__express-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "j2L4e",
        "DadUndead"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "forest-express-mongoose",
      "kind": "edit",
      "files": [
        {
          "path": "types/forest-express-mongoose/forest-express-mongoose-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "SteveBunlon",
        "ghusse"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "forest-express-sequelize",
      "kind": "edit",
      "files": [
        {
          "path": "types/forest-express-sequelize/forest-express-sequelize-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "SteveBunlon",
        "ghusse"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "fusebit__oauth-connector",
      "kind": "edit",
      "files": [
        {
          "path": "types/fusebit__oauth-connector/fusebit__oauth-connector-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "andrewrmiller",
        "hashiphoto",
        "andydam"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "logfmt",
      "kind": "edit",
      "files": [
        {
          "path": "types/logfmt/logfmt-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "ebroder"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "mock-req-res",
      "kind": "edit",
      "files": [
        {
          "path": "types/mock-req-res/mock-req-res-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "sandorTuranszky"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "mongoose-aggregate-paginate-v2",
      "kind": "edit",
      "files": [
        {
          "path": "types/mongoose-aggregate-paginate-v2/mongoose-aggregate-paginate-v2-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "acrilex1"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    },
    {
      "name": "swaggerize-express",
      "kind": "edit",
      "files": [
        {
          "path": "types/swaggerize-express/swaggerize-express-tests.ts",
          "kind": "test"
        }
      ],
      "owners": [
        "mugeso",
        "nickmorton"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Well-liked by everyone"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "jakebailey",
      "date": "2024-09-25T17:36:23.000Z",
      "isMaintainer": true
    },
    {
      "type": "stale",
      "reviewer": "ludovicm67",
      "date": "2024-09-23T11:46:42.000Z",
      "abbrOid": "635727b"
    },
    {
      "type": "stale",
      "reviewer": "midgleyc",
      "date": "2024-09-23T10:44:45.000Z",
      "abbrOid": "635727b"
    },
    {
      "type": "stale",
      "reviewer": "tpluscode",
      "date": "2024-09-16T12:34:58.000Z",
      "abbrOid": "635727b"
    }
  ],
  "mainBotCommentID": 2350955911,
  "ciResult": "pass"
}

typescript-bot · 2024-09-14T11:15:41Z

🔔 @tpluscode @ludovicm67 @activescott @ryanblock @reconbot @midgleyc @cyrilschumacher @atd-schubert @borisyankov @micksatana @JoseLion @dwrss @andoshin11 @peterblazejewicz @CMUH @puneetar @dfrankland @j2L4e @DadUndead @SteveBunlon @ghusse @andrewrmiller @Hashiphoto @andydam @ebroder @sandorTuranszky @acrilex1 @MugeSo @nickmorton — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

…ormat.

AviVahl · 2024-09-26T13:01:38Z

the rule is only included in configs.recommendedTypeChecked, which also requires one to specify additional settings (such as projectService or project, etc.)

I realize I can disable lint for that line/file, cast the type, or disable rule. The thing is... I believe the rule is correct. The express handler possibly returns a Promise (according to the type), and node http handler doesn't handle promises. Just an FYI, since it might be a common use-case to use the app itself as handler for a native http server.

Not sure I want to tackle this on my own. I'll probably just workaround in user-end.

davps · 2024-10-23T20:15:18Z

There seems to be a version management discrepancy. While @types/express has already moved to v5 (via #70563), npm outdated still considers Express 4.21.1 as the "latest" version:

Current package.json:

{
  "dependencies": {
    "express": "^5.0.1"
  },
  "devDependencies": {
    "@types/express": "^5.0.0"
  }
}

Running npm outdated shows:

Package   Current  Wanted  Latest   Location              Depended by
express   5.0.1    5.0.1   4.21.1  node_modules/express  [project-name]

This creates potential confusion since:

The types have officially moved to v5
Users running npm outdated might think they need to downgrade to 4.21.1. This is my case, I ran into this in my CI/CD.

jakebailey · 2024-10-23T20:18:01Z

That was an intentional choice made by the express maintainers; v5 is not marked as latest over there.

DefinitelyTyped has no mechanism to model this somewhat unusual situation.

davps · 2024-10-23T21:34:24Z

I see, thanks for the clarification @jakebailey

I'll just disable npm outdated for now in my CI/CD since this mismatch happens in both directions - whether using Express v4 with types v4, or Express v5 with types v5, npm outdated always shows version conflicts. I'm sure it will sort itself out as v5 adoption grows. Thanks.

…nTail

…nTail Co-authored-by: Jake Bailey <[email protected]>

binarykitchen · 2025-02-22T23:46:05Z

Not sure I want to tackle this on my own. I'll probably just workaround in user-end.

@AviVahl Have you figured out a workaround yet?

(Experiencing the same issue here)

AviVahl · 2025-02-23T08:23:54Z

Not sure I want to tackle this on my own. I'll probably just workaround in user-end.

@AviVahl Have you figured out a workaround yet?

(Experiencing the same issue here)

use a cast:

import { createServer, type RequestListener } from "node:http";
import express from "express";

const app = express();
const httpServer = createServer(app as RequestListener);

or use @types/[email protected] (latest 4.x types; npm info @types/express versions), if you're still using express@4.

binarykitchen · 2025-02-24T06:57:53Z

Thanks, @AviVahl, I'll do this for now, temporarily. Using express@5 here.

Although, force casting should be avoided. Wondering if this has every been raised upstream before and will ever be fixed?

glasser · 2025-05-08T22:18:56Z

I ran into the same issue with ESLint configs.recommendedTypeChecked and createServer(app) as @AviVahl. I'll try the as RequestListener workaround, but it is an interesting point that if the app can return a Promise and http.createServer doesn't handle that, it could be a problem? The official Express docs do still teach http.createServer(app) as a reasonable thing to do.

Charset is sent in the content-type (expressjs/express@a0276c6). @types/express now accepts promises (DefinitelyTyped/DefinitelyTyped#70563). New `dotfiles` options for serve-static. See <https://github.com/expressjs/serve-static/releases/tag/v2.0.0-beta.1>.

robertomiramon50-stack

__

Charset is sent in the content-type (expressjs/express@a0276c6). @types/express now accepts promises (DefinitelyTyped/DefinitelyTyped#70563). New `dotfiles` options for serve-static. See <https://github.com/expressjs/serve-static/releases/tag/v2.0.0-beta.1>.

RobinTail added 7 commits September 14, 2024 10:30

feat: async types for express 5 and its express-serve-static-core.

91642fa

Fixing tests for architect__functions.

3841cdd

Fixing tests for forest-express-sequelize.

c7fcb05

Fixing tests for mock-req-res.

a08e9c6

Fixing tests for create-test-server.

c4380b1

Fixing dependency discrepancy for absolute-url.

0be241f

Correcting the type for express-brute.

8f63f0f

RobinTail mentioned this pull request Sep 14, 2024

Express v4 -> v5 Migration expressjs/express#5944

Closed

Correcting types for express-ua-middleware.

93ef618