@jsenv/import-map

import-map

Helpers to implement importmaps.

Table of contents

• Presentation
• Installation
• Documentation
  • composeTwoImportMaps
  • normalizeImportMap
  • resolveImport

Presentation

@jsenv/import-map can be used to implement the behaviour of importMap as described in the specification. It is written using es modules and is compatible with Node.js.

— see importMap spec

Installation

npm install --save-dev @jsenv/import-map@6.7.2

Documentation

@jsenv/import-map exports are documented in this section.

composeTwoImportMaps

composeTwoImportMaps takes two importMap and return a single importMap being the composition of the two.

import { composeTwoImportMaps } from "@jsenv/import-map"

const importMap = composeTwoImportMaps(
  {
    imports: {
      foo: "bar",
    },
  },
  {
    imports: {
      foo: "whatever",
    },
  },
)

console.log(JSON.stringify(importMap, null, "  "))

{
  "imports": {
    "foo": "whatever"
  }
}

— source code at src/composeTwoImportMaps.js.

normalizeImportMap

normalizeImportMap returns an importMap resolved against an url and sorted.

import { normalizeImportMap } from "@jsenv/import-map"

const importMap = normalizeImportMap(
  {
    imports: {
      foo: "./bar",
      "./ding.js": "./dong.js"
    },
  },
  "http://your-domain.com",
)

console.log(JSON.stringify(importMap, null, '  ')

{
  "imports": {
    "foo": "http://your-domain.com/bar",
    "http://your-domain.com/ding.js": "http://your-domain.com/dong.js"
  }
}

— source code at src/normalizeImportMap.js.

resolveImport

resolveImport returns an import url applying an importMap to specifier and importer. The provided importMap must be resolved and sorted to work as expected. You can use normalizeImportMap to do that.

import { resolveImport } from "@jsenv/import-map"

const importUrl = resolveImport({
  specifier: "../index.js",
  importer: "http://domain.com/folder/file.js",
  importMap: {
    imports: {
      "http://domain.com/index.js": "http://domain.com/main.js",
    },
  },
})

console.log(importUrl)

http://domain.com/main.js

— source code at src/resolveImport.js.