Skip to content

Add exports field for granular imports#1523

Open
jbuckner wants to merge 1 commit intomasterfrom
fix/package-exports
Open

Add exports field for granular imports#1523
jbuckner wants to merge 1 commit intomasterfrom
fix/package-exports

Conversation

@jbuckner
Copy link
Copy Markdown
Contributor

Summary

Add an exports field to package.json enabling consumers to import specific parts of BookReader:

import '@internetarchive/bookreader'               // full shell (unchanged)
import '@internetarchive/bookreader/core'           // BookReader class only
import '@internetarchive/bookreader/jquery'          // jQuery wrapper
import '@internetarchive/bookreader/plugins/search/plugin.search.js'  // individual plugin
import '@internetarchive/bookreader/styles'          // BookReader.css

Problem

Currently, the only entry point is the full ia-bookreader shell. Consumers who want to use BookReader core with a custom shell, or who need to import jQuery/plugins separately for loading order control, have to use deep path imports that aren't guaranteed by the package contract.

Test plan

  • Verify import '@internetarchive/bookreader' still works (default entry)
  • Verify import '@internetarchive/bookreader/core' imports BookReader class
  • Verify import '@internetarchive/bookreader/jquery' sets up jQuery globals

🤖 Generated with Claude Code

@codecov
Copy link
Copy Markdown

codecov Bot commented Mar 19, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.98%. Comparing base (2908b1e) to head (281a85a).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1523   +/-   ##
=======================================
  Coverage   68.98%   68.98%           
=======================================
  Files          65       65           
  Lines        5556     5556           
  Branches     1229     1229           
=======================================
  Hits         3833     3833           
  Misses       1689     1689           
  Partials       34       34           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Allow consumers to import specific parts of BookReader without
pulling in the full ia-bookreader shell:

  import '@internetarchive/bookreader'           // full shell
  import '@internetarchive/bookreader/core'      // BookReader class
  import '@internetarchive/bookreader/jquery'     // jQuery wrapper
  import '@internetarchive/bookreader/plugins/...' // individual plugins
  import '@internetarchive/bookreader/styles'     // BookReader.css

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@jbuckner jbuckner force-pushed the fix/package-exports branch from bd51d01 to 281a85a Compare April 20, 2026 22:54
@jbuckner
Copy link
Copy Markdown
Contributor Author

Rebased onto current master (offshoot WEBDEV-8245 shipped today and is now using this patch stack downstream — re-ready for review when someone has a moment 🙏).

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.

1 participant