Types are not installed

[Bazhan4ik]

Describe the bug
Types for socket.io-parser and engine.io-parser are not installed

To Reproduce
Socket.IO server version: 4.5.4

When compile with typescript it throws these errors:

TS7016: Could not find a declaration file for module 'engine.io-parser'. '.../node_modules/engine.io-parser/build/cjs/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/engine.io-parser` if it exists or add a new declaration (.d.ts) file containing `declare module 'engine.io-parser';`

3 import * as parser from "engine.io-parser";
                          ~~~~~~~~~~~~~~~~~~

TS7016: Could not find a declaration file for module 'engine.io-parser'. '.../node_modules/engine.io-parser/build/cjs/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/engine.io-parser` if it exists or add a new declaration (.d.ts) file containing `declare module 'engine.io-parser';`

4 import { Packet } from "engine.io-parser";
                         ~~~~~~~~~~~~~~~~~~

TS7016: Could not find a declaration file for module 'socket.io-parser'. '.../node_modules/socket.io-parser/build/cjs/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/socket.io-parser` if it exists or add a new declaration (.d.ts) file containing `declare module 'socket.io-parser';`

2 import { Packet } from "socket.io-parser";
                         ~~~~~~~~~~~~~~~~~~

TS7016: Could not find a declaration file for module 'socket.io-parser'. '.../node_modules/socket.io-parser/build/cjs/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/socket.io-parser` if it exists or add a new declaration (.d.ts) file containing `declare module 'socket.io-parser';`

10 import * as parser from "socket.io-parser";
                           ~~~~~~~~~~~~~~~~~~

TS7016: Could not find a declaration file for module 'socket.io-parser'. '.../node_modules/socket.io-parser/build/cjs/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/socket.io-parser` if it exists or add a new declaration (.d.ts) file containing `declare module 'socket.io-parser';`

11 import type { Encoder } from "socket.io-parser";
                                ~~~~~~~~~~~~~~~~~~

TS7016: Could not find a declaration file for module 'socket.io-parser'. '.../node_modules/socket.io-parser/build/cjs/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/socket.io-parser` if it exists or add a new declaration (.d.ts) file containing `declare module 'socket.io-parser';`

3 import { Packet } from "socket.io-parser";
                         ~~~~~~~~~~~~~~~~~~

Did I do something wrong?
Do I have to install the types manually?

[darrachequesne]

Hi! That's weird, the types should be included in the package.

Which OS are you using? Which version of typescript?

[Bazhan4ik]

Hi

I'm on Windows 11, and I'm using verion ^4.9.4 of typescript

[darrachequesne]

That's really weird. The types are declared there:

• https://github.com/socketio/socket.io-parser/blob/0841bd562351c3d45a5288e2adf9707cc8a3131d/package.json#L14
• https://github.com/socketio/engine.io-parser/blob/214182b4f0616a44c18251d9f418a7ca5595dbe4/package.json#L12

And are included in the package:

• https://www.npmjs.com/package/socket.io-parser?activeTab=explore
• https://www.npmjs.com/package/engine.io-parser?activeTab=explore

Not sure what's going wrong here.

[Bazhan4ik]

This is probably because of typescript. This is my tsconfig.json, and I set module: NodeNext which I never used before.

{
  "compilerOptions": {
    "target": "ES2020",
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
    "forceConsistentCasingInFileNames": true,
    "strict": true,
  },
  "exclude": [
    "node_modules",
    "web/node_modules",
  ]
}

I tried to set module to commonjs and I get no errors.

[algnor]

I'm running into the same issue, using commonjs fixes the problem, however a few of the packages i need are pure esm only, so changing to commonjs isn't an alternative.
Here is the log.

#0 0.436 > tsc -p api/tsconfig.json && cp -r ./api/src/resources/ ./dist/api/resources/
node_modules/engine.io/build/engine.io.d.ts:3:25 - error TS7016: Could not find a declaration file for module 'engine.io-parser'. '/home/algnor/Fourcorner/4corner/node_modules/engine.io-parser/build/cjs/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/engine.io-parser` if it exists or add a new declaration (.d.ts) file containing `declare module 'engine.io-parser';`

3 import * as parser from "engine.io-parser";
                          ~~~~~~~~~~~~~~~~~~

node_modules/engine.io/build/transport.d.ts:4:24 - error TS7016: Could not find a declaration file for module 'engine.io-parser'. '/home/algnor/Fourcorner/4corner/node_modules/engine.io-parser/build/cjs/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/engine.io-parser` if it exists or add a new declaration (.d.ts) file containing `declare module 'engine.io-parser';`

4 import { Packet } from "engine.io-parser";
                         ~~~~~~~~~~~~~~~~~~

node_modules/socket.io/dist/client.d.ts:2:24 - error TS7016: Could not find a declaration file for module 'socket.io-parser'. '/home/algnor/Fourcorner/4corner/node_modules/socket.io-parser/build/cjs/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/socket.io-parser` if it exists or add a new declaration (.d.ts) file containing `declare module 'socket.io-parser';`

2 import { Packet } from "socket.io-parser";
                         ~~~~~~~~~~~~~~~~~~

node_modules/socket.io/dist/index.d.ts:10:25 - error TS7016: Could not find a declaration file for module 'socket.io-parser'. '/home/algnor/Fourcorner/4corner/node_modules/socket.io-parser/build/cjs/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/socket.io-parser` if it exists or add a new declaration (.d.ts) file containing `declare module 'socket.io-parser';`

10 import * as parser from "socket.io-parser";
                           ~~~~~~~~~~~~~~~~~~

node_modules/socket.io/dist/index.d.ts:11:30 - error TS7016: Could not find a declaration file for module 'socket.io-parser'. '/home/algnor/Fourcorner/4corner/node_modules/socket.io-parser/build/cjs/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/socket.io-parser` if it exists or add a new declaration (.d.ts) file containing `declare module 'socket.io-parser';`

11 import type { Encoder } from "socket.io-parser";
                                ~~~~~~~~~~~~~~~~~~

node_modules/socket.io/dist/socket.d.ts:3:24 - error TS7016: Could not find a declaration file for module 'socket.io-parser'. '/home/algnor/Fourcorner/4corner/node_modules/socket.io-parser/build/cjs/index.js' implicitly has an 'any' type.
  Try `npm i --save-dev @types/socket.io-parser` if it exists or add a new declaration (.d.ts) file containing `declare module 'socket.io-parser';`

3 import { Packet } from "socket.io-parser";
                         ~~~~~~~~~~~~~~~~~~


Found 6 errors in 5 files.

Errors  Files
     1  node_modules/engine.io/build/engine.io.d.ts:3
     1  node_modules/engine.io/build/transport.d.ts:4
     1  node_modules/socket.io/dist/client.d.ts:2
     2  node_modules/socket.io/dist/index.d.ts:10
     1  node_modules/socket.io/dist/socket.d.ts:3

and tsconfig.json

{
  "compilerOptions": {
    "outDir": "../dist/api/",
    "noImplicitAny": true,
    "module": "NodeNext",
    "target": "ES2020",
    "allowJs": true,
    "moduleResolution": "NodeNext",
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true,
    "sourceMap": true
  }
}

[darrachequesne]

The types are present though (in types": "./build/esm/index.d.ts"), but it seems the nodeNext module resolution does not find them. Not sure about what we could do here... 👀

[jcjp]

I am on the latest socket.io and @socket.io/cluster-adapter is this error related? When passing createAdapter from @socket.io/cluster-adapter to socket.io server.adapter? This is the error:

Argument of type '(nsp: any) => ClusterAdapter' is not assignable to parameter of type 'AdapterConstructor'.
Type '(nsp: any) => ClusterAdapter' is not assignable to type '(nsp: Namespace<DefaultEventsMap, DefaultEventsMap, DefaultEventsMap, any>) => Adapter'.
Type 'ClusterAdapter' is missing the following properties from type 'Adapter': _encode, persistSession, restoreSession

Seems like this bug has re-occur: #3796.

[igorls]

Just submitted PRs to fix this on socket.io and engine.io

Tested with the following config:

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "module": "NodeNext",
    "moduleResolution": "NodeNext",
    "target": "ESNext",
    "sourceMap": true,
    "outDir": "dist",
    "allowSyntheticDefaultImports": true,
    "esModuleInterop": true
  },
  "include": [
    "src/**/*"
  ],
  "exclude": [
    "node_modules"
  ]
}

[javaarchive]

I was able to downgrade to 4.5.4 to solve the issue temporarily since I was unable to install the above PR since installing from github excludes the built "dist" directory.