Package Import Map Generation Tool
Manages version resolutions of modules against modules CDNs or even local node_modules via supported providers.
For an interactive UI for this tool running on JSPM.IO, see https://generator.jspm.io.
Node.js:
npm install @jspm/generator@jspm/generator only ships as an ES module, so to use it in Node.js add "type": "module" to your package.json file or write an .mjs to load it.
By default the generator generates import maps against the JSPM CDN by treating the defaultProvider: 'jspm' option. This can be configured to other CDNs or sources including local nodemodules, see the next section on how to achieve this.
generate.mjs
import { Generator } from '@jspm/generator';
const generator = new Generator({
mapUrl: import.meta.url,
defaultProvider: 'jspm', // this is the default defaultProvider
// Always ensure to define your target environment to get a working map
// it is advisable to pass the "module" condition as supported by Webpack
env: ['production', 'browser', 'module'],
});
// Install a new package into the import map
await generator.install('react-dom');
// Install a package version and subpath into the import map (installs lit/decorators.js)
await generator.install('lit@2/decorators.js');
// Install a package version to a custom alias
await generator.install({ alias: 'react16', target: 'react@16' });
// Install a specific subpath of a package
await generator.install({ target: 'lit@2', subpath: './html.js' });
// Install an export from a locally located package folder into the map
// The package.json is used to determine the exports and dependencies.
await generator.install({ alias: 'mypkg', target: './packages/local-pkg', subpath: './feature' });
console.log(JSON.stringify(generator.getMap(), null, 2));
/*
* Outputs the import map:
*
* {
* "imports": {
* "lit/decorators.js": "https://ga.jspm.io/npm:lit@2.0.0-rc.1/decorators.js",
* "lit/html.js": "https://ga.jspm.io/npm:lit@2.0.0-rc.1/html.js",
* "mypkg/feature": "./packages/local-pkg/feature.js",
* "react": "./local/react.js",
* "react16": "https://ga.jspm.io/npm:react@16.14.0/index.js",
* "react-dom": "https://ga.jspm.io/npm:react-dom@17.0.2/index.js"
* },
* "scopes": { ... }
* }
*/Instead of inputting modules and outputting an import map, the generator can directly trace
and inject into HTML using the htmlGenerate method.
All module scripts in the provided HTML string will be analyzed, traced, and the import map generated and then injected to replace the existing import map, or to add a new import map into the HTML provided.
generate.mjs
import { Generator } from '@jspm/generator';
const generator = new Generator({
mapUrl: import.meta.url,
env: ['production', 'browser', 'module'],
});
const outHtml = await generator.htmlGenerate(`
<!doctype html>
<script type="module">import 'react'</script>
`, { esModuleShims: true });
/*
* Outputs the HTML:
*
* <!doctype html>
* <script async src="https://ga.jspm.io/npm:es-module-shims@1.4.1/dist/es-module-shims.js"></script>
* <script type="importmap">
* {...}
* </script>
* <script type="module">import 'react'</script>
* The second HTML Generation options include:
preload: Boolean, injects <link rel="modulepreload"> preload tagswhitespace: Boolean, set to false to use minified JSON and preload injectionsesModuleShims: Boolean, set to a string to use a custom ES Module Shims path. Set to false to remove ES Module Shimsintegrity: Boolean, set to true to inject integrity attributes. Works with preload to inline integrity for static modules.To generate an import map for a local application linked against local node_modules (and provided that all packages are ES modules), this can be done via:
generate.mjs
import { Generator } from '@jspm/generator';
const generator = new Generator({
mapUrl: import.meta.url,
defaultProvider: 'nodemodules',
// custom user provided mappings, which are authoritative
inputMap: {
imports: {
'react': './local/react.js'
}
},
// Always ensure to define your target environment to get a working map
// it is advisable to pass the "module" condition as supported by Webpack
env: ['production', 'browser', 'module'],
});
// where "pkg" is already installed into node_modules and package.json "dependencies" by npm
await generator.install('pkg');
// output the full import map
console.log(JSON.stringify(generator.getMap(), null, 2));To execute the application, the import map needs to be included in the HTML directly using an inline tag:
<script type="importmap">
{
"imports": { ... },
"scopes": { ... }
}
</script>With the import map embedded in the page, all import statements will have access to the defined mappings
allowing direct import 'lit/html.js' style JS code in the browser.
For browsers without import maps, it is recommended to use the ES Module Shims import maps polyfill. This is a highly optimized polyfill supporting almost native speeds, see the performance benchmarks for more information.
Dynamically injecting <script type="importmap"> from JavaScript is supported as well but only if no
modules have yet executed on the page. For dynamic import map injection workflows, creating an IFrame
for each import map and injecting it into this frame can be used to get around this constraint for
in-page refreshing application workflows.
Instead of installing specific packages into the map, you can also just trace a local module directly and JSPM will generate the scoped mappings to support that modules execution:
generate.mjs
// all static and dynamic dependencies necessary to execute app will be traced and
// put into the map as necessary
await generator.traceInstall('./app.js');The import map object returned by the generator can be directly accessed via the importMap getter (instead of the getMap() function which returns JSON):
const map = generator.importMap;
console.log(map.resolve('lit/html.js'));
// -> https://ga.jspm.io/npm:lit@2.0.0-rc.1/html.jsThe API of this map is as defined in https://github.com/jspm/import-map.
The "scopes" field is populated with all necessary deep dependencies with versions deduped and shared as
possible within version ranges. Just like a file-system-based package manager, JSPM will handle dependency
version constraints in the import map to enable maximum code sharing with minimal duplication.
Multiple installs are supported via array inputs to install:
// Pass an array to install to install multiple packages at the same time
await generator.install([{ target: 'react' }, { target: 'lit' }]);Multiple subpaths can be supported via the subpaths install option:
await generator.install({ target: '@material-ui/core@4.11.4', subpaths: ['./AccordionDetails', './Accordion'] });The return value of the the install command contains the full dependency graph list via staticDeps and dynamicDeps:
const { staticDeps, dynamicDeps } = await generator.install('lit');These are arrays of full URLs to the loaded module, which can be used to construct module preloading tags:
let preloadHtml = '';
for (const dep of staticDeps) {
preloadHtml += `<link rel="modulepreload" href="${dep}"/>\n`;
}For batch install jobs, the dependencies include all installs. When using separate .install commands the lists are per-install.
Supported providers include "jspm", "jspm.system", "nodemodules", "skypack", "jsdelivr", "unpkg", with all except
"nodemodules" corresponding to their respective CDNs as the package source.
The "nodemodules" provider does a traditional node_modules path search from the current module URL (eg for a
file:/// URL when generating maps for local code). When running over other URL protocols such as from the browser, the
only requirement is that the protocol in use does not return an error code for directory listing requests to node_modules, as
many local dev servers support. The dependency package can then be located and the import map is constructed against these
node_modules lookups.
The "jspm.system" provider can be used to generate import maps for SystemJS, which behave identically to modules on "jspm"
but fully supporting older browsers due to the semantic equivalence with ES modules of the SystemJS module format.
Package exports configurations are taken from the package.json. When attempting to install or resolve a subpath of a package that does not exist in its exports, an error will be thrown.
To recover from errors like this, JSPM and Skypack have mechanisms for overriding package configurations:
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.
A logger is provided via generator.logStream:
const generator = new Generator();
(async () => {
for await (const { type, message } of generator.logStream()) {
console.log(`${type}: ${message}`);
}
})();Log events recorded include trace, resolve and install.
Note that the log messages are for debugging and not currently part of the semver contract of the project.
Type: URL | String Absolute URL | String URL relative to CWD
Default: pathTofileURL(process.cwd() + '/')
The URL of the import map itself, used to construct relative import map URLs.
The mapUrl is used in order to output relative URLs for modules located on the same
host as the import map.
E.g. for mapUrl: 'file:///path/to/project/map.importmap', installing local file packages
will be output as relative URLs to their file locations from the map location, since all URLs in an import
map are relative to the URL of the import map.
Type: URL | String Absolute URL | String URL relative to CWD
Default: Empty
The URL to treat as the root of the serving protocol of the import map, used to construct absolute import map URLs.
When set, rootUrl takes precendence over mapUrl and is used to normalize all import map URLs
as absolute paths against this URL.
E.g. for rootUrl: 'file:///path/to/project/public', any local module public/local/mod.js within the public folder
will be normalized to /local/mod.js in the output map.
Type: Object | undefined Default: {}
Custom dependency resolution overrides for all installs.
The resolutions option allows configuring a specific dependency version to always be used overriding all version resolution logic for that dependency for all nestings.
It is a map from package name to package version target just like the package.json "dependencies" map, but that applies and overrides universally.
For example to lock a specific package version:
const generator = new Generator({
resolutions: {
dep: '1.2.3'
}
});It is also useful for local monorepo patterns where all local packages should be located locally:
const pkgBaseUrl = new URL('./packages', import.meta.url).href;
const generator = new Generator({
resolutions: {
'@company/pkgA': `${pkgBaseUrl}/pkgA`,
'@company/pkgB': `${pkgBaseUrl}/pkgB`
'@company/pkgC': `${pkgBaseUrl}/pkgC`
}
})All subpath and main resolution logic will follow the package.json definitions of the resolved package, unlike inputMap
which only maps specific specifiers.
Type: Object | undefined
Default: {}
The import map to extend.
An initial import map to start with - can be from a previous install or provide custom mappings.
Type: string[] | undefined
Default: []
Allows ignoring certain module specifiers during the tracing process.
It can be useful, for example, when you provide an inputMap that contains a mapping that can't be traced in current context,
but you know it will work in the context where the generated map is going to be used.
const generator = new Generator({
inputMap: {
imports: {
"react": "./my/own/react.js",
}
},
ignore: ["react"]
});
// Even though `@react-three/fiber@7` depends upon `react`,
// `generator` will not try to trace and resolve `react`,
// so the mapping provided in `inputMap` will end up in the resulting import map.
await generator.install("@react-three/fiber@7")Type: String | String[]</br/> Default: ['/ip4/127.0.0.1/tcp/45005', '/ip4/127.0.0.1/tcp/5001']
When installing IPFS URLs, this configures the IPFS Node API multiaddress or list of fallback addresses to connect to.
Defaults to trying the Brave IPFS node then the local IPFS node. The API which can be enabled from brave://ipfs-internals/ in the Brave Browser.
Type: 'jspm' | 'jspm.system' | 'nodemodules' | 'skypack' | 'jsdelivr' | 'unpkg'
Default: 'jspm'
The default provider to use for a new install. Providers are responsible for resolution from abstract package names and version ranges to exact URL locations.
Providers resolve package names and semver ranges to exact CDN package URL paths using provider hooks.
These hooks include version resolution and converting package versions into URLs and back again.
See src/providers/[name].ts for how to define a custom provider.
New providers can be provided via the customProviders option. PRs to merge in providers are welcome as well.
Type: Object | undefined
Default: {}
A map of custom scoped providers.
The provider map allows setting custom providers for specific package names or package scopes.
For example, an organization with private packages with names like npmpackage and @orgscope/... can define the custom providers to reference these from a custom source:
providers: {
'npmpackage': 'nodemodules',
'@orgscope': 'nodemodules'
}Alternatively a custom provider can be referenced this way for eg private CDN / registry support.
Type: Object | undefined
Default: undefined Custom provider definitions.
When installing from a custom CDN it can be advisable to define a custom provider in order to be able to get version deduping against that CDN.
Custom provider definitions define a provider name, and the provider instance consisting of three main hooks:
pkgToUrl({ registry: string, name: string, version: string }, layer: string) -> String URL: Returns the URL for a given exact package registry, name and version to use for this provider. If the provider is using layers, the layer string can be used to determine the URL layer (where the defaultProvider: '[name].[layer]' form is used to determine the layer, eg minified v unminified etc). It is important that package URLs always end in /, because packages must be treated as folders not files. An error will be thrown for package URLs returned not ending in /.parsePkgUrl(url: string) -> { { registry: string, name: string, version: string }, layer: string } | undefined: Defines the converse operation to pkgToUrl, converting back from a string URL
into the exact package registry, name and version, as well as the layer. Should always return undefined for unknown URLs as the first matching provider is treated as authoritative when dealing with
multi-provider installations.resolveLatestTarget(target: { registry: string, name: string, range: SemverRange }, unstable: boolean, layer: string, parentUrl: string) -> Promise<{ registry: string, name: string, version: string } | null>: Resolve the latest version to use for a given package target. unstable indicates that prerelease versions can be matched. The definition of SemverRange is as per the sver package. Returning null corresponds to a package not found error.The use of pkgToUrl and parsePkgUrl is what allows the JSPM Generator to dedupe package versions internally based on their unique internal identifier [registry]:[name]@[version] regardless of what CDN location is used. URLs that do not support parsePkgUrl can still be installed and used fine, they just do not participate in version deduping operations.
For example, a custom unpkg provider can be defined as:
const unpkgUrl = 'https://unpkg.com/';
const exactPkgRegEx = /^((?:@[^/\\%@]+\/)?[^./\\%@][^/\\%@]*)@([^\/]+)(\/.*)?$/;
const generator = new Generator({
defaultProvider: 'custom',
customProviders: {
custom: {
pkgToUrl ({ registry, name, version }) {
return `${unpkgUrl}${name}@${version}/`;
},
parseUrlPkg (url) {
if (url.startsWith(unpkgUrl)) {
const [, name, version] = url.slice(unpkgUrl.length).match(exactPkgRegEx) || [];
return { registry: 'npm', name, version };
}
},
resolveLatestTarget ({ registry, name, range }, unstable, layer, parentUrl) {
return { registry, name, version: '3.6.0' };
}
}
}
});
await generator.install('custom:jquery');Type: String[]
Default: ['browser', 'development', 'module']
The conditional environment resolutions to apply.
The conditions passed to the env option are environment conditions, as supported by Node.js in the package exports field.
By default the "default", "require" and "import" conditions are always supported regardless of what env conditions are provided.
In addition the default conditions applied if no env option is set are "browser", "development" and "module".
Webpack and RollupJS support a custom "module" condition as a bundler-specific solution to the dual package hazard, which is by default included in the JSPM resolution as well although
can be turned off if needed.
Note when providing custom conditions like setting env: ["production"] that the "browser" and "module" conditions still need to be
applied as well via env: ["production", "browser", "module"]. Ordering does not matter though.
Any other custom condition strings can also be provided.
Type: Boolean | String
Default: true
Whether to use a local FS cache for fetched modules. Set to 'offline' to use the offline cache.
By default a global fetch cache is maintained between runs on the file system.
This caching can be disabled by setting cache: false.
When running offline, setting cache: 'offline' will only use the local cache and not touch the network at all,
making fully offline workflows possible provided the modules have been seen before.
The following utility functions are exported as additional exports of the generator:
Supports clearing the global fetch cache in Node.js.
Example:
import { clearCache } from '@jspm/generator';
clearCache();Use the internal fetch implementation, useful for hooking into the same shared local fetch cache.
import { fetch } from '@jspm/generator';
const res = await fetch(url);
console.log(await res.text());Use the { cache: 'no-store' } option to disable the cache, and the { cache: 'force-cache' } option to enforce the offline cache.
Get the package.json configuration for a specific URL or package.
import { getPackageConfig } from '@jspm/generator';
// Supports a resolved package
{
const packageJson = await getPackageConfig({ registry: 'npm', name: 'lit-element', version: '2.5.1' });
}
// Or alternatively provide any URL
{
const packageJson = await getPackageConfig('https://ga.jspm.io/npm:lit-element@2.5.1/lit-element.js');
}Get the baseURL for a given URL. Will either be the origin root or a URL ending in / that contains the package.json config file.
import { getPackageBase } from '@jspm/generator';
const pkgUrl = await getPackageBase('https://ga.jspm.io/npm:lit-element@2.5.1/lit-element.js');
// Returns: https://ga.jspm.io/npm:lit-element@2.5.1/Get the lookup resolution information for a specific install.
Example:
import { lookup } from '@jspm/generator';
await lookup('lit-element');
/*
{
install: {
target: { registry: 'npm', name: 'lit-element', range: '^2.0' },
subpath: '.',
alias: 'lit-element'
},
resolved: { registry: 'npm', name: 'lit-element', version: '2.5.1' }
}
*/
// The "resolved" property can also be passed directly to getPackageConfigAll pull requests welcome!
MIT