Cannot find name 'TransformStream' after updating to v5.2.0

[Julien-Marcou]

Since I updated socket.io from the v4.7.1 to the v4.7.2 (and so engine.io-parser from the v5.1.0 to the v5.2.1), I'm getting the following errors while building my projects:

node_modules/engine.io-parser/build/cjs/index.d.ts:6:54 - error TS2304: Cannot find name 'TransformStream'.
6 export declare function createPacketEncoderStream(): TransformStream<Packet, any>;
                                                       ~~~~~~~~~~~~~~~
node_modules/engine.io-parser/build/cjs/index.d.ts:7:96 - error TS2304: Cannot find name 'TransformStream'.
7 export declare function createPacketDecoderStream(maxPayload: number, binaryType: BinaryType): TransformStream<Uint8Array, any>;
                                                                                                 ~~~~~~~~~~~~~~~

Found 2 errors in the same file, starting at: node_modules/engine.io-parser/build/cjs/index.d.ts:6

Funnily, I'm only getting this error when compiling using tsc but not when compiling using esbuild.

npx tsc -> error
npx esbuild src/index.ts --platform=node -> ok

Here is my tsconfig.json:

{
  "compileOnSave": false,
  "compilerOptions": {
    "baseUrl": "./",
    "outDir": "./dist",
    "strict": true,
    "sourceMap": true,
    "declaration": false,
    "downlevelIteration": true,
    "experimentalDecorators": true,
    "moduleResolution": "node16",
    "importHelpers": true,
    "target": "es2022",
    "module": "node16",
    "lib": [
      "es2022"
    ]
  },
  "include": [
    "src/**/*.ts"
  ]
}

Reading nodejs's documentation, when using TransformStream, it looks like they are importing it with

import { TransformStream } from 'node:stream/web';

which is not the case for engine.io-parser, so maybe that's the problem.

[Granjow]

I can confirm that adding import { TransformStream } from "node:stream/web"; in node_modules/engine.io-parser/build/esm/index.d.ts fixes the TS error.

[darrachequesne]

It seems TransformStream is now exposed on the global object starting from version 18.0.0.

Reference: https://nodejs.org/api/webstreams.html#class-transformstream

As a workaround, could you please try to update the @types/node version?

[micalevisk]

@darrachequesne @types/node v18.17.15 here. The latest one of v18 (I'm using nodejs 18)

[Julien-Marcou]

I'm using Nodejs v18.17.1, and the @types/node package is currently set to ^18.17.11

[darrachequesne]

Argh, it seems the types from @types/node are out of date, TransformStream is now available as a global object.

We could add import { TransformStream } from "node:stream/web";, but this would break users with a Node.js version inferior to 16.5.0 (at runtime).

Let me check.

See DefinitelyTyped/DefinitelyTyped#66710

[g-popovic]

Any updates/workarounds found for this? Am still having this issue on node v18.17.0, socket.io: v4.7.2

[alanpurple]

why is this still not updated? even there is a simple solution(import)

[darrachequesne]

@alanpurple the problem is that adding import { TransformStream } from 'node:stream/web'; would throw an exception for versions of Node.js lower than 16.5.0, which we are currently supporting.

The problem here is that the types provided by @types/node are out of date...

[alanpurple]

@darrachequesne
isn't versions 18+ are prior to 16-?

even node 20.0 is LTS now

node 16 is now end of list September 2023

[darrachequesne]

@alanpurple I'd rather not have a new major version because the types provided by @types/node are currently wrong (TransformStream should be exposed on the global object).

[darrachequesne]

I think I have found a workaround, which does not break older Node.js versions: socketio/engine.io-parser@0305b4a

Could you please check?

Fiddle: https://github.com/socketio/socket.io-fiddle/tree/typescript-node16