Downgrade to using nanoid@3 to support its use in CJS module bundle #307
Conversation
This file contains 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
Starting from nanoid v4, it only works with ESM projects. We need to
support both CJS and ESM bundles for the `spaces` SDK, so we have the
following options to use the nanoid package:
1. Replace `require('nanoid')` imports with async `await import('nanoid')`.
This solution is not suitable as the methods we currently use nanoid
in are not async, and changing them to async will create cascading
effects for a bunch of other methods and change the public API for
users.
2. Replace the nanoid package with an in-project utility function to
generate ids. This may be undesired since nanoid uses different
`crypto` packages for its browser and Node.js bundles with some other
platform-specific optimizations. Including them locally would not be
a trivial change.
3. Downgrade to using nanoid v3, which supports both CJS and ESM and is
still being supported by the developers [1]. This is the option
implemented in this commit.
Resolves #306
[1] https://github.com/ai/nanoid?tab=readme-ov-file#install
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Resolves #306
Starting from nanoid v4, it only works with ESM projects. We need to support both CJS and ESM bundles for the
spacesSDK, so we have the following options to use the nanoid package:require('nanoid')imports with asyncawait import('nanoid'). This solution is not suitable as the methods we currently use nanoid in are not async, and changing them to async will create cascading effects for a bunch of other methods and change the public API for users.cryptopackages for its browser and Node.js bundles with some other platform-specific optimizations. Including them locally would not be a trivial change.This PR also disables major version updates for
nanoidpackage by GitHub dependabot.