fix: Update exports to include CJS types#711
Merged
darrachequesne merged 2 commits intosocketio:mainfrom Nov 6, 2023
Merged
Conversation
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)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note: the
engine.io.jsfile is the generated output ofmake engine.io.js, and should not be manually modified.The kind of change this PR does introduce
Current behaviour
Building a TypeScript project with
module: node16ornodenextcauses 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
typesentries for theimportandrequirespecifiers, which enables TypeScript to find the types for both CJS and ESM usages.In my testing, using the ESM types in the
requireentry 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