es-module-shims 2.3.1 → 2.4.0

package/README.md

@@ -30,7 +30,7 @@ Because we are still using the native module loader the edge cases work out comp
 Include ES Module Shims with a `async` attribute on the script, then include an import map and module scripts normally:
 
 ```html
-<script async src="https://ga.jspm.io/npm:es-module-shims@2.3.1/dist/es-module-shims.js"></script>
+<script async src="https://ga.jspm.io/npm:es-module-shims@2.4.0/dist/es-module-shims.js"></script>
 
 <!-- https://generator.jspm.io/#U2NhYGBkDM0rySzJSU1hKEpNTC5xMLTQM9Az0C1K1jMAAKFS5w0gAA -->
 <script type="importmap">
@@ -701,6 +701,7 @@ Provide a `esmsInitOptions` on the global scope before `es-module-shims` is load
 * [revokeBlobURLs](#revoke-blob-urls)
 * [shimMode](#shim-mode-option)
 * [skip](#skip)
+* [version](#version)
 
 ```html
 <script>
@@ -739,6 +740,8 @@ window.esmsInitOptions = {
   meta: (meta, url) => void // default is noop
   // Hook top-level imports
   onimport: (url, options, parentUrl, source) => void // default is noop
+  // Ensure only the exact provided version of es-module-shims registered
+  version: '2.4.0' // default is empty
 }
 </script>
 <script async src="es-module-shims.js"></script>
@@ -888,6 +891,14 @@ When passing an array, relative URLs or paths ending in `/` can be provided:
 <script async src="es-module-shims.js"></script>
 ```
 
+### Version
+
+When there is a risk of multiple versions of ES Module Shims on the same page, deconflicting is managed by logic that will opt-out of initializing ES Module Shims if it has already been initialized. In addition, ES Module Shims itself is frozen and locked from further mutations.
+
+To better support cooporative multi-version cases, as of version 2.4.0, we support a `version` option, which when set will skip initialization if the current version of ES Module Shims does not match this exact expected version.
+
+This way, any other old versions after version 2.4.0 running on the page can effectively be turned off, ensuring only the defined version of the polyfill initiates the polyfill.
+
 ### Revoke Blob URLs
 
 When polyfilling the missing features `es-module-shims` would create in-memory blobs using `URL.createObjectURL()` for each processed module.

package/dist/es-module-shims.debug.js

@@ -1,4 +1,4 @@
-/** ES Module Shims 2.3.1 */
+/** ES Module Shims @version 2.4.0 */
 (function (exports) {
 
   let invalidate;
@@ -162,13 +162,6 @@
     ];
   };
 
-  if (self.importShim) {
-    console.info(
-        `es-module-shims: skipping initialization as importShim was already registered by another polyfill instance`
-      );
-    return;
-  }
-
   const hasDocument = typeof document !== 'undefined';
 
   const noop = () => {};
@@ -181,11 +174,22 @@
 
   const dynamicImport = (u, errUrl) => import(u);
 
+  const defineValue = (obj, prop, value) =>
+    Object.defineProperty(obj, prop, { writable: false, configurable: false, value });
+
   const optionsScript = hasDocument ? document.querySelector('script[type=esms-options]') : undefined;
 
   const esmsInitOptions = optionsScript ? JSON.parse(optionsScript.innerHTML) : {};
   Object.assign(esmsInitOptions, self.esmsInitOptions || {});
 
+  const r$1 = esmsInitOptions.version;
+  if (self.importShim || (r$1 && r$1 !== "2.4.0")) {
+    console.info(
+        `es-module-shims: skipping initialization as ${r$1 ? `configured for ${r$1}` : 'another instance has already registered'}`
+      );
+    return;
+  }
+
   // shim mode is determined on initialization, no late shim mode
   const shimMode =
     esmsInitOptions.shimMode ||
@@ -276,198 +280,198 @@
 
   const fromParent = parent => (parent ? ` imported from ${parent}` : '');
 
-  const backslashRegEx = /\\/g;
-
-  const asURL = url => {
-    try {
-      if (url.indexOf(':') !== -1) return new URL(url).href;
-    } catch (_) {}
-  };
-
-  const resolveUrl = (relUrl, parentUrl) =>
-    resolveIfNotPlainOrUrl(relUrl, parentUrl) || asURL(relUrl) || resolveIfNotPlainOrUrl('./' + relUrl, parentUrl);
-
-  const resolveIfNotPlainOrUrl = (relUrl, parentUrl) => {
-    const hIdx = parentUrl.indexOf('#'),
-      qIdx = parentUrl.indexOf('?');
-    if (hIdx + qIdx > -2)
-      parentUrl = parentUrl.slice(
-        0,
-        hIdx === -1 ? qIdx
-        : qIdx === -1 || qIdx > hIdx ? hIdx
-        : qIdx
-      );
-    if (relUrl.indexOf('\\') !== -1) relUrl = relUrl.replace(backslashRegEx, '/');
-    // protocol-relative
-    if (relUrl[0] === '/' && relUrl[1] === '/') {
-      return parentUrl.slice(0, parentUrl.indexOf(':') + 1) + relUrl;
-    }
-    // relative-url
-    else if (
-      (relUrl[0] === '.' &&
-        (relUrl[1] === '/' ||
-          (relUrl[1] === '.' && (relUrl[2] === '/' || (relUrl.length === 2 && (relUrl += '/')))) ||
-          (relUrl.length === 1 && (relUrl += '/')))) ||
-      relUrl[0] === '/'
-    ) {
-      const parentProtocol = parentUrl.slice(0, parentUrl.indexOf(':') + 1);
-      if (parentProtocol === 'blob:') {
-        throw new TypeError(
-          `Failed to resolve module specifier "${relUrl}". Invalid relative url or base scheme isn't hierarchical.`
-        );
-      }
-      // Disabled, but these cases will give inconsistent results for deep backtracking
-      //if (parentUrl[parentProtocol.length] !== '/')
-      //  throw new Error('Cannot resolve');
-      // read pathname from parent URL
-      // pathname taken to be part after leading "/"
-      let pathname;
-      if (parentUrl[parentProtocol.length + 1] === '/') {
-        // resolving to a :// so we need to read out the auth and host
-        if (parentProtocol !== 'file:') {
-          pathname = parentUrl.slice(parentProtocol.length + 2);
-          pathname = pathname.slice(pathname.indexOf('/') + 1);
-        } else {
-          pathname = parentUrl.slice(8);
-        }
-      } else {
-        // resolving to :/ so pathname is the /... part
-        pathname = parentUrl.slice(parentProtocol.length + (parentUrl[parentProtocol.length] === '/'));
-      }
-
-      if (relUrl[0] === '/') return parentUrl.slice(0, parentUrl.length - pathname.length - 1) + relUrl;
-
-      // join together and split for removal of .. and . segments
-      // looping the string instead of anything fancy for perf reasons
-      // '../../../../../z' resolved to 'x/y' is just 'z'
-      const segmented = pathname.slice(0, pathname.lastIndexOf('/') + 1) + relUrl;
-
-      const output = [];
-      let segmentIndex = -1;
-      for (let i = 0; i < segmented.length; i++) {
-        // busy reading a segment - only terminate on '/'
-        if (segmentIndex !== -1) {
-          if (segmented[i] === '/') {
-            output.push(segmented.slice(segmentIndex, i + 1));
-            segmentIndex = -1;
-          }
-          continue;
-        }
-        // new segment - check if it is relative
-        else if (segmented[i] === '.') {
-          // ../ segment
-          if (segmented[i + 1] === '.' && (segmented[i + 2] === '/' || i + 2 === segmented.length)) {
-            output.pop();
-            i += 2;
-            continue;
-          }
-          // ./ segment
-          else if (segmented[i + 1] === '/' || i + 1 === segmented.length) {
-            i += 1;
-            continue;
-          }
-        }
-        // it is the start of a new segment
-        while (segmented[i] === '/') i++;
-        segmentIndex = i;
-      }
-      // finish reading out the last segment
-      if (segmentIndex !== -1) output.push(segmented.slice(segmentIndex));
-      return parentUrl.slice(0, parentUrl.length - pathname.length) + output.join('');
-    }
-  };
-
-  const resolveAndComposeImportMap = (json, baseUrl, parentMap) => {
-    const outMap = {
-      imports: Object.assign({}, parentMap.imports),
-      scopes: Object.assign({}, parentMap.scopes),
-      integrity: Object.assign({}, parentMap.integrity)
-    };
-
-    if (json.imports) resolveAndComposePackages(json.imports, outMap.imports, baseUrl, parentMap);
-
-    if (json.scopes)
-      for (let s in json.scopes) {
-        const resolvedScope = resolveUrl(s, baseUrl);
-        resolveAndComposePackages(
-          json.scopes[s],
-          outMap.scopes[resolvedScope] || (outMap.scopes[resolvedScope] = {}),
-          baseUrl,
-          parentMap
-        );
-      }
-
-    if (json.integrity) resolveAndComposeIntegrity(json.integrity, outMap.integrity, baseUrl);
-
-    return outMap;
-  };
-
-  const getMatch = (path, matchObj) => {
-    if (matchObj[path]) return path;
-    let sepIndex = path.length;
-    do {
-      const segment = path.slice(0, sepIndex + 1);
-      if (segment in matchObj) return segment;
-    } while ((sepIndex = path.lastIndexOf('/', sepIndex - 1)) !== -1);
-  };
-
-  const applyPackages = (id, packages) => {
-    const pkgName = getMatch(id, packages);
-    if (pkgName) {
-      const pkg = packages[pkgName];
-      if (pkg === null) return;
-      return pkg + id.slice(pkgName.length);
-    }
-  };
-
-  const resolveImportMap = (importMap, resolvedOrPlain, parentUrl) => {
-    let scopeUrl = parentUrl && getMatch(parentUrl, importMap.scopes);
-    while (scopeUrl) {
-      const packageResolution = applyPackages(resolvedOrPlain, importMap.scopes[scopeUrl]);
-      if (packageResolution) return packageResolution;
-      scopeUrl = getMatch(scopeUrl.slice(0, scopeUrl.lastIndexOf('/')), importMap.scopes);
-    }
-    return applyPackages(resolvedOrPlain, importMap.imports) || (resolvedOrPlain.indexOf(':') !== -1 && resolvedOrPlain);
-  };
-
-  const resolveAndComposePackages = (packages, outPackages, baseUrl, parentMap) => {
-    for (let p in packages) {
-      const resolvedLhs = resolveIfNotPlainOrUrl(p, baseUrl) || p;
-      if (
-        (!shimMode || !mapOverrides) &&
-        outPackages[resolvedLhs] &&
-        outPackages[resolvedLhs] !== packages[resolvedLhs]
-      ) {
-        console.warn(
-          `es-module-shims: Rejected map override "${resolvedLhs}" from ${outPackages[resolvedLhs]} to ${packages[resolvedLhs]}.`
-        );
-        continue;
-      }
-      let target = packages[p];
-      if (typeof target !== 'string') continue;
-      const mapped = resolveImportMap(parentMap, resolveIfNotPlainOrUrl(target, baseUrl) || target, baseUrl);
-      if (mapped) {
-        outPackages[resolvedLhs] = mapped;
-        continue;
-      }
-      console.warn(`es-module-shims: Mapping "${p}" -> "${packages[p]}" does not resolve`);
-    }
-  };
-
-  const resolveAndComposeIntegrity = (integrity, outIntegrity, baseUrl) => {
-    for (let p in integrity) {
-      const resolvedLhs = resolveIfNotPlainOrUrl(p, baseUrl) || p;
-      if (
-        (!shimMode || !mapOverrides) &&
-        outIntegrity[resolvedLhs] &&
-        outIntegrity[resolvedLhs] !== integrity[resolvedLhs]
-      ) {
-        console.warn(
-          `es-module-shims: Rejected map integrity override "${resolvedLhs}" from ${outIntegrity[resolvedLhs]} to ${integrity[resolvedLhs]}.`
-        );
-      }
-      outIntegrity[resolvedLhs] = integrity[p];
-    }
+  const backslashRegEx = /\\/g;
+
+  const asURL = url => {
+    try {
+      if (url.indexOf(':') !== -1) return new URL(url).href;
+    } catch (_) {}
+  };
+
+  const resolveUrl = (relUrl, parentUrl) =>
+    resolveIfNotPlainOrUrl(relUrl, parentUrl) || asURL(relUrl) || resolveIfNotPlainOrUrl('./' + relUrl, parentUrl);
+
+  const resolveIfNotPlainOrUrl = (relUrl, parentUrl) => {
+    const hIdx = parentUrl.indexOf('#'),
+      qIdx = parentUrl.indexOf('?');
+    if (hIdx + qIdx > -2)
+      parentUrl = parentUrl.slice(
+        0,
+        hIdx === -1 ? qIdx
+        : qIdx === -1 || qIdx > hIdx ? hIdx
+        : qIdx
+      );
+    if (relUrl.indexOf('\\') !== -1) relUrl = relUrl.replace(backslashRegEx, '/');
+    // protocol-relative
+    if (relUrl[0] === '/' && relUrl[1] === '/') {
+      return parentUrl.slice(0, parentUrl.indexOf(':') + 1) + relUrl;
+    }
+    // relative-url
+    else if (
+      (relUrl[0] === '.' &&
+        (relUrl[1] === '/' ||
+          (relUrl[1] === '.' && (relUrl[2] === '/' || (relUrl.length === 2 && (relUrl += '/')))) ||
+          (relUrl.length === 1 && (relUrl += '/')))) ||
+      relUrl[0] === '/'
+    ) {
+      const parentProtocol = parentUrl.slice(0, parentUrl.indexOf(':') + 1);
+      if (parentProtocol === 'blob:') {
+        throw new TypeError(
+          `Failed to resolve module specifier "${relUrl}". Invalid relative url or base scheme isn't hierarchical.`
+        );
+      }
+      // Disabled, but these cases will give inconsistent results for deep backtracking
+      //if (parentUrl[parentProtocol.length] !== '/')
+      //  throw new Error('Cannot resolve');
+      // read pathname from parent URL
+      // pathname taken to be part after leading "/"
+      let pathname;
+      if (parentUrl[parentProtocol.length + 1] === '/') {
+        // resolving to a :// so we need to read out the auth and host
+        if (parentProtocol !== 'file:') {
+          pathname = parentUrl.slice(parentProtocol.length + 2);
+          pathname = pathname.slice(pathname.indexOf('/') + 1);
+        } else {
+          pathname = parentUrl.slice(8);
+        }
+      } else {
+        // resolving to :/ so pathname is the /... part
+        pathname = parentUrl.slice(parentProtocol.length + (parentUrl[parentProtocol.length] === '/'));
+      }
+
+      if (relUrl[0] === '/') return parentUrl.slice(0, parentUrl.length - pathname.length - 1) + relUrl;
+
+      // join together and split for removal of .. and . segments
+      // looping the string instead of anything fancy for perf reasons
+      // '../../../../../z' resolved to 'x/y' is just 'z'
+      const segmented = pathname.slice(0, pathname.lastIndexOf('/') + 1) + relUrl;
+
+      const output = [];
+      let segmentIndex = -1;
+      for (let i = 0; i < segmented.length; i++) {
+        // busy reading a segment - only terminate on '/'
+        if (segmentIndex !== -1) {
+          if (segmented[i] === '/') {
+            output.push(segmented.slice(segmentIndex, i + 1));
+            segmentIndex = -1;
+          }
+          continue;
+        }
+        // new segment - check if it is relative
+        else if (segmented[i] === '.') {
+          // ../ segment
+          if (segmented[i + 1] === '.' && (segmented[i + 2] === '/' || i + 2 === segmented.length)) {
+            output.pop();
+            i += 2;
+            continue;
+          }
+          // ./ segment
+          else if (segmented[i + 1] === '/' || i + 1 === segmented.length) {
+            i += 1;
+            continue;
+          }
+        }
+        // it is the start of a new segment
+        while (segmented[i] === '/') i++;
+        segmentIndex = i;
+      }
+      // finish reading out the last segment
+      if (segmentIndex !== -1) output.push(segmented.slice(segmentIndex));
+      return parentUrl.slice(0, parentUrl.length - pathname.length) + output.join('');
+    }
+  };
+
+  const resolveAndComposeImportMap = (json, baseUrl, parentMap) => {
+    const outMap = {
+      imports: { ...parentMap.imports },
+      scopes: { ...parentMap.scopes },
+      integrity: { ...parentMap.integrity }
+    };
+
+    if (json.imports) resolveAndComposePackages(json.imports, outMap.imports, baseUrl, parentMap);
+
+    if (json.scopes)
+      for (let s in json.scopes) {
+        const resolvedScope = resolveUrl(s, baseUrl);
+        resolveAndComposePackages(
+          json.scopes[s],
+          outMap.scopes[resolvedScope] || (outMap.scopes[resolvedScope] = {}),
+          baseUrl,
+          parentMap
+        );
+      }
+
+    if (json.integrity) resolveAndComposeIntegrity(json.integrity, outMap.integrity, baseUrl);
+
+    return outMap;
+  };
+
+  const getMatch = (path, matchObj) => {
+    if (matchObj[path]) return path;
+    let sepIndex = path.length;
+    do {
+      const segment = path.slice(0, sepIndex + 1);
+      if (segment in matchObj) return segment;
+    } while ((sepIndex = path.lastIndexOf('/', sepIndex - 1)) !== -1);
+  };
+
+  const applyPackages = (id, packages) => {
+    const pkgName = getMatch(id, packages);
+    if (pkgName) {
+      const pkg = packages[pkgName];
+      if (pkg === null) return;
+      return pkg + id.slice(pkgName.length);
+    }
+  };
+
+  const resolveImportMap = (importMap, resolvedOrPlain, parentUrl) => {
+    let scopeUrl = parentUrl && getMatch(parentUrl, importMap.scopes);
+    while (scopeUrl) {
+      const packageResolution = applyPackages(resolvedOrPlain, importMap.scopes[scopeUrl]);
+      if (packageResolution) return packageResolution;
+      scopeUrl = getMatch(scopeUrl.slice(0, scopeUrl.lastIndexOf('/')), importMap.scopes);
+    }
+    return applyPackages(resolvedOrPlain, importMap.imports) || (resolvedOrPlain.indexOf(':') !== -1 && resolvedOrPlain);
+  };
+
+  const resolveAndComposePackages = (packages, outPackages, baseUrl, parentMap) => {
+    for (let p in packages) {
+      const resolvedLhs = resolveIfNotPlainOrUrl(p, baseUrl) || p;
+      if (
+        (!shimMode || !mapOverrides) &&
+        outPackages[resolvedLhs] &&
+        outPackages[resolvedLhs] !== packages[resolvedLhs]
+      ) {
+        console.warn(
+          `es-module-shims: Rejected map override "${resolvedLhs}" from ${outPackages[resolvedLhs]} to ${packages[resolvedLhs]}.`
+        );
+        continue;
+      }
+      let target = packages[p];
+      if (typeof target !== 'string') continue;
+      const mapped = resolveImportMap(parentMap, resolveIfNotPlainOrUrl(target, baseUrl) || target, baseUrl);
+      if (mapped) {
+        outPackages[resolvedLhs] = mapped;
+        continue;
+      }
+      console.warn(`es-module-shims: Mapping "${p}" -> "${packages[p]}" does not resolve`);
+    }
+  };
+
+  const resolveAndComposeIntegrity = (integrity, outIntegrity, baseUrl) => {
+    for (let p in integrity) {
+      const resolvedLhs = resolveIfNotPlainOrUrl(p, baseUrl) || p;
+      if (
+        (!shimMode || !mapOverrides) &&
+        outIntegrity[resolvedLhs] &&
+        outIntegrity[resolvedLhs] !== integrity[resolvedLhs]
+      ) {
+        console.warn(
+          `es-module-shims: Rejected map integrity override "${resolvedLhs}" from ${outIntegrity[resolvedLhs]} to ${integrity[resolvedLhs]}.`
+        );
+      }
+      outIntegrity[resolvedLhs] = integrity[p];
+    }
   };
 
   // support browsers without dynamic import support (eg Firefox 6x)
@@ -673,8 +677,6 @@
 
   if (hotReload) importShim$1.hotReload = hotReload$1;
 
-  self.importShim = importShim$1;
-
   const defaultResolve = (id, parentUrl) => {
     return (
       resolveImportMap(composedImportMap, resolveIfNotPlainOrUrl(id, parentUrl) || id, parentUrl) ||
@@ -702,6 +704,13 @@
   const sourceCache = (importShim$1._s = {});
   (importShim$1._i = new WeakMap());
 
+  // Ensure this version is the only version
+  defineValue(self, 'importShim', Object.freeze(importShim$1));
+  const shimModeOptions = { ...esmsInitOptions, shimMode: true };
+  if (optionsScript) optionsScript.innerHTML = JSON.stringify(shimModeOptions);
+  self.esmsInitOptions = shimModeOptions;
+  defineValue(self, '_d', undefined);
+
   const loadAll = async (load, seen) => {
     seen[load.u] = 1;
     await load.L;
@@ -735,8 +744,7 @@
     if (!shimMode && typeof WebAssembly !== 'undefined') {
       if (wasmSourcePhaseEnabled && !Object.getPrototypeOf(WebAssembly.Module).name) {
         const s = Symbol();
-        const brand = m =>
-          Object.defineProperty(m, s, { writable: false, configurable: false, value: 'WebAssembly.Module' });
+        const brand = m => defineValue(m, s, 'WebAssembly.Module');
         class AbstractModuleSource {
           get [Symbol.toStringTag]() {
             if (this[s]) return this[s];
@@ -1098,7 +1106,7 @@
     const mapIntegrity = composedImportMap.integrity[url];
     const res = await doFetch(
       url,
-      mapIntegrity && !fetchOpts.integrity ? Object.assign({}, fetchOpts, { integrity: mapIntegrity }) : fetchOpts,
+      mapIntegrity && !fetchOpts.integrity ? { ...fetchOpts, integrity: mapIntegrity } : fetchOpts,
       parent
     );
     const r = res.url;
@@ -1253,7 +1261,7 @@
           if (d >= 0 || resolved.N) load.N = true;
           if (d !== -1) return;
           if (skip && skip(resolved.r) && !sourcePhase) return { l: { b: resolved.r }, s: false };
-          if (childFetchOpts.integrity) childFetchOpts = Object.assign({}, childFetchOpts, { integrity: undefined });
+          if (childFetchOpts.integrity) childFetchOpts = { ...childFetchOpts, integrity: undefined };
           const child = { l: getOrCreateLoad(resolved.r, childFetchOpts, load.r, source), s: sourcePhase };
           // assertion case -> inline the CSS / JSON URL directly
           if (source === '') child.l.b = child.l.u;