Importing @streamparser/json results in error when using tsc or jest relying on tsc

[tegefaulkes]

Specification

As part of #249 we're using a JSON stream parser to parse the JSONRPC messages. There seems to be a problem with this library specifically where we can't import it with the import keyword. So far a work around has been to import it with const jsonStreamParsers = require('@streamparser/json');.

We need to import it with import { JSONParser } from '@streamparser/json';. but currently doing so results in a TS2307: Cannot find module '@streamparser/json' or its corresponding type declarations. error.

So far I haven't been able to determine why the usual import isn't working. From what I can tell it's using conditional exports within it's package.json file for specifying the exports. This may be related?

Additional context

• Related Client RPC migration #509

Tasks

1. determine the cause of the import error.
2. find a fix to import the stream parser using the import keyword.

[tegefaulkes]

Created an upstream issue at juanjoDiaz/streamparser-json#25.

[CMCDragonkai]

This works fine in a prototyping script:

import { JSONParser } from '@streamparser/json';

async function main() {
  console.log(JSONParser);
}

main();

It's only the IDE that complains. Running npm run ts-node -- ./test.ts works.

> [email protected] ts-node
> ts-node "./test.ts"

[class JSONParser]

[CMCDragonkai]

Are you getting that error when running JEST tests? If not, then ignore the IDE, and just proceed. It's just an IDE configuration issue.

[CMCDragonkai]

I see... it fails in jest, but works in ts-node.

[CMCDragonkai]

Note that our ts-node is in fact using swc, whereas jest is not currently using swc.

[CMCDragonkai]

I think this is related to: MatrixAI/TypeScript-Demo-Lib#32. The package appears to be module type. But it must be breaking on resolution somehow.

[CMCDragonkai]

Here you can see the issue:

tsc ./test.ts

test.ts:1:28 - error TS2307: Cannot find module '@streamparser/json' or its corresponding type declarations.

But if I use swc it ends up keeping it as regular imports.

I think this is because our tsconfig.json specifies CommonJS modules. Perhaps upstream package isn't well tested with commonjs tsconfigs.

[CMCDragonkai]

This should be done with the merge of #513.