fix: do not package LinearWebhooks in UMD module
#701
Merged
Conversation
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
🦋 Changeset detectedLatest commit: 64872cc The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
There was a problem hiding this comment.
The refactor effectively isolates LinearWebhooks from the UMD bundle, but the duplicated export lists in index.ts and index_umd.ts could lead to maintenance drift. Extracting shared exports into a common module would simplify future updates.
Additional notes (1)
- Maintainability |
packages/sdk/src/index_umd.ts:1-8
There’s significant duplication betweenindex.tsandindex_umd.ts: they both list out the same core exports (minuswebhooks). This can lead to drift and extra maintenance whenever you add or remove an export. Consider centralizing the shared exports in a newexports_base.tsand then re-exporting from it. This reduces duplication and makes it easier to keep both entrypoints in sync.
Summary of changes
Summary of Changes
- Added a changeset (
.changeset/cuddly-nights-leave.md) to document the patch release. - Modified
rollup.config.jsto switch the UMD build entry point fromsrc/index.tsto a newsrc/index_umd.tsfor both minified and non-minified outputs. - Updated
src/index.tsto re-export everything fromindex_umd.tsand the./webhooksmodule, removing the former flat export list. - Introduced a new
src/index_umd.tsfile that exports all core SDK componentsexcept LinearWebhooks(so that the UMD bundle has no dependency on Node’scrypto).
suevalov
approved these changes
May 13, 2025
pekala
approved these changes
May 13, 2025
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.
The UMD module currently cannot be used in a browser directly as it imports nodejs's
cryptomodule. This is used byLinearWebhooksto decode webhooks headers signatures when used in a nodejs context.We could work with
crypto-browserifyandnode-browserifypolyfills to provide browser compatible version, but I'm not sure it's really worth it? TheLinearWebhooksis meant to be used as an Express middleware, not in a browser environment. This PR provides a second entrypoint for rollup to build the UMD module without theLinearWebhooksexport.