Fix source map resolution for bundlers #63
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
Changed module entry point from root to dist/node/ where source maps have correct relative paths. Previously, the prepack script copied files to root, breaking source map paths that expected to be two directories deep (../../src/). Changes: - Set main/module/types to dist/node/web-eid.js - Add exports field for clean subpath imports - Include src/**/* and dist/node/**/* in package files - Update README import examples - Remove npm link "Cons" section (exports field fixes this) The prepack/postpack scripts are kept for backwards compatibility with direct file imports like '@web-eid/web-eid-library/web-eid'.
There was a problem hiding this comment.
Pull request overview
This PR fixes source map resolution warnings when using the library with modern bundlers like webpack. The fix restructures the package.json module entry points to use the dist/node/ directory, adds comprehensive subpath exports, and includes source files in the published package for proper source map resolution.
- Updated
main,module, andtypesfields to point todist/node/web-eid.jsinstead of root-level files - Added
exportsfield with wildcard patterns for clean subpath imports of models, errors, services, and utilities - Included
src/**/*in the files array to enable source map resolution by bundlers
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| package.json | Restructured module entry points to use dist/node/, added exports field for subpath imports, and included source files for source map support |
| README.md | Updated import examples to use the new simplified import paths (direct package import instead of /web-eid subpath) and removed outdated npm link documentation about longer import paths |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…claration - Add "type": "module" to clarify ES module intent - Change "main" to point to UMD build for CommonJS consumers - Add "require" condition to exports for CommonJS support
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Rename UMD bundle outputs from .js to .cjs extension - Update main and exports to reference .cjs files - Add exports for dist bundles (es, umd, iife) for direct imports This ensures Node.js correctly parses UMD as CommonJS while the package is declared as ESM.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Fixes "Failed to parse source map" warnings when using the library with bundlers like webpack that use source-map-loader.
The root cause was that the
modulefield pointed toweb-eid.jsat package root, where source map paths (../../src/) were invalid after being copied fromdist/node/by the prepack script.Changes
main,module, andtypestodist/node/web-eid.jsexportsfield for clean subpath imports (e.g.,@web-eid/web-eid-library/models/ActionOptions)src/**/*for source map resolution anddist/node/**/*for the entry pointsBackwards Compatibility
Direct file imports like
@web-eid/web-eid-library/web-eidstill work because prepack copies files to root.Test Plan
npm run buildsucceedsnpm packcreates valid packageimport { authenticate } from '@web-eid/web-eid-library'import ActionOptions from '@web-eid/web-eid-library/models/ActionOptions'Signed-off-by: Erko Risthein erko@risthein.ee