Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Update exports to include CJS types #711

Merged
merged 2 commits into from
Nov 6, 2023

Conversation

tylerbutler
Copy link
Contributor

Note: the engine.io.js file is the generated output of make engine.io.js, and should not be manually modified.

The kind of change this PR does introduce

  • a bug fix
  • a new feature
  • an update to the documentation
  • a code change that improves performance
  • other

Current behaviour

Building a TypeScript project with module: node16 or nodenext causes a compile error because of missing types. See socketio/socket.io-client#1589 for more details.

New behaviour

With the changes in this PR, the package.json exports field includes types entries for the import and require specifiers, which enables TypeScript to find the types for both CJS and ESM usages.

In my testing, using the ESM types in the require entry did not work. It's possible I did something wrong, but because of this test result, I enabled declaration output for the CJS build so that the types are produced. This seemed simplest.

Other information (e.g. related issues)

Similar PR for socket.io-client: socketio/socket.io-client#1595

@darrachequesne darrachequesne merged commit 46ef851 into socketio:main Nov 6, 2023
1 check passed
tylerbutler added a commit to microsoft/FluidFramework that referenced this pull request Nov 6, 2023
This PR patches socket.io-client and engine.io-client, applying the
changes from socketio/socket.io-client#1595 and
socketio/engine.io-client#711, respectively.

I think this is a safe change because we are using only types from the
package, and the .d.ts/exported API still refers to the real
socket.io-client package, so consumers should see no difference - they
might still hit the same bug we're hitting, but only when using node16
moduleResolution.


[AB#6140](https://dev.azure.com/fluidframework/235294da-091d-4c29-84fc-cdfc3d90890b/_workitems/edit/6140)
@tylerbutler tylerbutler deleted the fix-exports branch November 8, 2023 06:03
@darrachequesne darrachequesne added this to the 6.5.3 milestone Nov 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants