Import Maps CDN
jspm.io is a CDN built to support import maps with maximum performance featuring:
- Comprehensive package optimization and minification with source maps.
- Universal URLs with far-future expires for all resources.
- The ability to configure all environment conditions for a package, compatible with Node.js exports conditions and WinterCG runtime keys (eg
"deno"package entry point variants).
- High performance CDN, with redundant storage and caching layers and 99.99% historical uptime.
Packages on the
jspm.io CDN are processed to be import maps and browser-compatible based on standard module semantics that have emerged between Node.js and browsers. Imports on the CDN are based on using exact file extensions when loading relative paths, and using import maps for bare specifier resolutions.
The Node.js ES Modules conventions in Node.js are fully supported, alongside the Node.js package definitions.
This includes support for the package exports field, package imports field, self-reference resolution, conditional exports definitions, as well as the conversion of CommonJS modules into ES modules.
jspm.io CDN is fully versioned. The current version is version gamma:
This versioning scheme allows immutable caching with far-future expires while still being able to ship major CDN releases over time.
Packages are located at their exact registry and version URL known as the canonical package path:
Within the package, all files are served at their original file name locations as per the package published on npm - but instead of the original module files, optimized module files are served instead.
All packages contain a
package.json file, which is the processed package.json by JSPM including the enumerated exports and file listing. The
package.json is all that is needed to enumerate the exports of a package and resolve their URLs in the package, and is also a processed version of the
package.json created by the CDN.
When the JSPM CLI or Generator links a package, it uses this
package.json file for resolution rules.
Because all modules are optimized into their existing file locations, conditional resolutions are fully supported and optimized.
All custom condition names are supported, beyond the standard
Some build tools like Webpack and RollupJS support the custom
"module" condition in exports. This condition is supported by JSPM as if it were a
"module" entry in the exports field for the main entry point.
All packages on JSPM are optimized served with a RollupJS code splitting build.
Packages with only a main entry point will be built as a single module.
For packages with multiple entry points or subpaths, each of those package subpaths are optimized, with private non-public internal modules combined into chunks to minimize the number of dependencies loaded.
Source maps are included to map back to the unoptimized file structure.
To control which entry points are exposed in this way, the
"exports" field can be used to define what is optimized by JSPM.
Packages without an
"exports" field get their exports inferred by a statistical analysis approach. Whenever possible the
"exports" field is the preferred way to define subpaths for published packages.
Any module which is not an ECMAScript module is treated as CommonJS. ECMAScript modules are detected as files ending in
.js files in a
"type": "module" package.json boundary, or any
.js file with
The following CommonJS compatibility features are provided by the conversion process:
- All CommonJS modules are effectively converted into
export default module.exportsas an ECMAScript module. That is, they should always be imported as
import cjs from 'cjs', the default import sugar.
- Named exports for CommonJS modules are detected based on applying CJS Module Lexer. This uses a static analysis approach to determine the named exports of a CommonJS module. The
defaultexport will always remain the
module.exportsinstance, even with this named exports assignment process.
- CommonJS modules in a cycle get a function-wrapper-based transform that ensures that the cycle references work out according to the CommonJS semantics.
- Comprehensive strict-mode conversion is applied to all CommonJS modules.
processglobals are updated to reference the Browserify libraries for these.
- Any reference to
globalis rewritten to the actual environment global.
__dirnamereferences are rewritten using a
new URL('.', import.meta.url)style expression.
require.resolverewriting is not currently supported.
"browser"field is supported for defining entry points, but only when the
"exports"field is not set.
"exports"field targets still run through
"browser"field remappings for Webpack compatibility.
CommonJS should work the same as it does in Webpack and other JS bundlers. Any bugs can be reported to the main project issue tracker.
Since CommonJS package optimization is based on statistically detecting their subpaths in JSPM, sometimes CommonJS packages won't support expected subpaths. There may also be sublte configuration errors in older packages.
To recover from errors like this, JSPM provides a package overrides repo.
Entries made here override the package.json configuration for packages matching a given package name and version range, and enforce the
In addition a custom
"cjsNamedExports" field is defined for JSPM specifically allowing specifying the expected CommonJS named exports for packages, bypassing the Node.js cjs-module-lexer analysis.
Creating a PR to add custom exports overrides allows for fixing any package issues on the CDNs.
For more information on the package exports field see the Node.js documentation.
JSPM will serve the readme, license and typing files as assets.
"exports" field which will then make them availabile on the CDN, although assets do not support versioned redirects like JS modules so the exact version reference needs to be used (
Wildcard exports (exports entries containing
*) also support asset inclusion.
SystemJS is a legacy module loader used by older applications without ES modules support by converting ES modules into the System module format.
A SystemJS layer of the
jspm.io CDN is available at
https://ga.system.jspm.io. The URL scheme and modules provided is exactly identical to the
https://ga.jspm.io variant but with the exception that all ES modules are converted into SystemJS modules.
This enables turning any native ES module import map against
https://ga.jspm.io into a SystemJS import map against
https://ga.system.jspm.io and being able to load dependencies with the exact same execution semantics in all older browsers without modules support, the primary feature of the SystemJS project.
Import maps for SystemJS can also be constructed with JSPM Generator setting
defaultProvider: 'jspm.io#system' both online and via the API.
For questions or further discussion about JSPM, join JSPM on Discord.