Breaking: Refactor ImportMap constructor parameters for improved clarity

Author: ije

README.md

@@ -15,7 +15,7 @@ npm i @esm.sh/import-map
 
 ## API
 
-### `new ImportMap(baseURL?: string, raw?: ImportMapRaw)`
+### `new ImportMap(init?: ImportMapRaw, baseURL?: string)`
 
 Create an import map instance:
 
@@ -28,7 +28,7 @@ const im = new ImportMap();
 You can also initialize from a raw object:
 
 ```ts
-const im = new ImportMap("https://example.com/app/", {
+const im = new ImportMap({
   config: { cdn: "https://esm.sh", target: "es2022" },
   imports: { react: "https://esm.sh/react@19.2.4/es2022/react.mjs" },
   scopes: {

src/importmap.test.ts

@@ -26,7 +26,7 @@ describe("ImportMap", () => {
         bad: 123,
       },
     } as unknown as ImportMapRaw;
-    const im = new ImportMap("file:///", init);
+    const im = new ImportMap(init, "file:///");
 
     expect(im.config).toEqual({
       cdn: "https://esm.sh",

src/importmap.ts

@@ -11,7 +11,7 @@ export class ImportMap {
   scopes: Record<string, Record<string, string>> = {};
   integrity: Record<string, string> = {};
 
-  constructor(baseURL?: string | URL, init?: ImportMapRaw) {
+  constructor(init?: ImportMapRaw, baseURL?: string | URL) {
     this.#baseURL = new URL(baseURL ?? globalThis.location?.href ?? "file:///");
     if (init) {
       this.config = sanitizeStringMap(init.config) as ImportMapConfig;

src/parse.ts

@@ -3,7 +3,7 @@ import { isObject, sanitizeScopes, sanitizeStringMap } from "./sanitize.ts";
 
 /** Parse the import map from a JSON string. */
 export function parseFromJson(json: string, baseURL?: string): ImportMap {
-  const im = new ImportMap(baseURL);
+  const im = new ImportMap({}, baseURL);
   const v = JSON.parse(json);
   if (isObject(v)) {
     const { config, imports, scopes, integrity } = v;
@@ -23,5 +23,5 @@ export function parseFromHtml(html: string, baseURL?: string): ImportMap {
   if (scriptEl) {
     return parseFromJson(scriptEl.textContent!, baseURL);
   }
-  return new ImportMap(baseURL);
+  return new ImportMap({}, baseURL);
 }

src/resolve.test.ts

@@ -63,7 +63,7 @@ describe("resolve", () => {
   });
 
   test("preserves query/hash and normalizes relative mapped urls", () => {
-    const im = new ImportMap("https://example.com/app/");
+    const im = new ImportMap({}, "https://example.com/app/");
     im.imports = {
       local: "./mod.ts",
     };
@@ -74,7 +74,7 @@ describe("resolve", () => {
   });
 
   test("normalizes root-relative mapped urls against base url", () => {
-    const im = new ImportMap("https://example.com/app/");
+    const im = new ImportMap({}, "https://example.com/app/");
     im.imports = {
       root: "/shared/mod.ts",
     };

types/index.d.ts

@@ -25,7 +25,7 @@ export interface ImportMapRaw {
 
 /** The import map class. */
 export class ImportMap {
-  constructor(baseURL?: string | URL, init?: Record<string, any>);
+  constructor(init?: Record<string, any>, baseURL?: string | URL);
 
   /** The config for generating the new import url from CDN. */
   config: ImportMapConfig;