bare-module-traverse 2.5.1 → 2.5.3

package/index.d.ts

@@ -34,7 +34,19 @@ type AliasableExtension =
   | '.txt'
 
 interface TraverseOptions extends ResolveOptions {
+  /**
+   * The type assumed for a module that names none of its own, such as an
+   * ambiguous extension or a `data:` URL that no import reaches. See
+   * `constants` for possible values.
+   */
   defaultType?: number
+  /**
+   * The type of the import that names the entry. A `data:` URL of JavaScript
+   * takes its type from this: `REQUIRE` names a script and `IMPORT` a module,
+   * while `IMPORT | DYNAMIC` names either and so must carry a `type` attribute.
+   */
+  importType?: number
+  artifacts?: boolean
   aliases?: Record<string, AliasableExtension>
   /**
    * @param entry - The import to resolve, as produced by `bare-module-lexer`.
@@ -83,7 +95,7 @@ declare function traverse(
 declare function traverse(
   entry: URL,
   readModule: (url: URL) => Promise<Buffer | string | null>,
-  listPrefix?: (url: URL) => AsyncIterable<URL>,
+  listPrefix?: (url: URL, expand: boolean) => AsyncIterable<URL>,
   probeModule?: (url: URL) => Promise<boolean | undefined>,
   resolveModule?: (url: URL) => Promise<URL>
 ): AsyncIterable<Dependency>
@@ -92,7 +104,7 @@ declare function traverse(
   entry: URL,
   opts: TraverseOptions,
   readModule: (url: URL) => Buffer | string | null,
-  listPrefix?: (url: URL) => Iterable<URL>,
+  listPrefix?: (url: URL, expand: true) => Iterable<URL>,
   probeModule?: (url: URL) => boolean | undefined,
   resolveModule?: (url: URL) => URL
 ): Iterable<Dependency>
@@ -101,7 +113,7 @@ declare function traverse(
   entry: URL,
   opts: TraverseOptions,
   readModule: (url: URL) => Promise<Buffer | string | null>,
-  listPrefix?: (url: URL) => AsyncIterable<URL>,
+  listPrefix?: (url: URL, expand: true) => AsyncIterable<URL>,
   probeModule?: (url: URL) => Promise<boolean | undefined>,
   resolveModule?: (url: URL) => Promise<URL>
 ): AsyncIterable<Dependency>

package/index.js

@@ -43,7 +43,7 @@ module.exports = exports = function traverse(
 
   return {
     *[Symbol.iterator]() {
-      const artifacts = { addons: [], assets: [] }
+      const artifacts = opts.artifacts === false ? null : { addons: [], assets: [] }
 
       const visited = opts.visited || new Set()
 
@@ -66,9 +66,13 @@ module.exports = exports = function traverse(
             const result = []
 
             if (typeof listPrefix === 'function') {
-              for (const url of listPrefix(value.prefix)) {
+              const listed = listPrefix(value.prefix, value.expand)
+
+              for (const url of listed) {
                 result.push(url)
               }
+
+              result.resolved = listed.resolved === true
             } else {
               if (readModule(value.prefix) !== null) {
                 result.push(value.prefix)
@@ -101,7 +105,7 @@ module.exports = exports = function traverse(
     },
 
     async *[Symbol.asyncIterator]() {
-      const artifacts = { addons: [], assets: [] }
+      const artifacts = opts.artifacts === false ? null : { addons: [], assets: [] }
 
       const visited = opts.visited || new Set()
 
@@ -124,9 +128,13 @@ module.exports = exports = function traverse(
             const result = []
 
             if (typeof listPrefix === 'function') {
-              for await (const url of listPrefix(value.prefix)) {
+              const listed = listPrefix(value.prefix, value.expand)
+
+              for await (const url of listed) {
                 result.push(url)
               }
+
+              result.resolved = listed.resolved === true
             } else {
               if ((await readModule(value.prefix)) !== null) {
                 result.push(value.prefix)
@@ -192,6 +200,9 @@ exports.module = function* (url, source, attributes, artifacts, visited, opts =
 
   if (probed !== undefined) opts = { ...opts, probed: undefined }
 
+  if (opts.packages === undefined) opts = { ...opts, packages: new Map() }
+  if (opts.prefixes === undefined) opts = { ...opts, prefixes: new Map() }
+
   attributes = attributes || {}
 
   const artifact = asset === true || moduleType(url, attributes, null, opts) === constants.ADDON
@@ -225,20 +236,16 @@ exports.module = function* (url, source, attributes, artifacts, visited, opts =
   let info = null
 
   if (url.protocol !== 'data:') {
-    for (const packageURL of lookupPackageScope(url, opts)) {
-      const source = yield { module: packageURL, artifact: false }
-
-      if (source !== null) {
-        info = JSON.parse(source)
+    const scope = yield* lookupPackage(url, opts)
 
-        imports['#package'] = packageURL.href
+    if (scope !== null) {
+      info = scope.info
 
-        yield {
-          children: exports.package(packageURL, source, artifacts, visited, opts),
-          deferred: false
-        }
+      imports['#package'] = scope.url.href
 
-        break
+      yield {
+        children: exports.package(scope.url, scope.source, artifacts, visited, opts),
+        deferred: false
       }
     }
   }
@@ -264,9 +271,9 @@ exports.module = function* (url, source, attributes, artifacts, visited, opts =
     if (type === constants.SCRIPT || type === constants.MODULE) {
       yield* exports.imports(url, source, imports, artifacts, lexer, visited, {
         ...opts,
-        referrerType: type
+        importType: 0
       })
-    } else if (type === constants.ADDON) {
+    } else if (type === constants.ADDON && artifacts !== null) {
       yield* exports.addons(url, artifacts, visited, opts)
     }
   }
@@ -308,7 +315,7 @@ exports.package = function* (url, source, artifacts, visited, opts = {}) {
       }
     }
 
-    if (info.assets) {
+    if (info.assets && artifacts !== null) {
       yield {
         children: exports.assets(info.assets, url, artifacts, visited, opts),
         deferred: false
@@ -349,15 +356,17 @@ exports.preresolved = function* (url, source, resolutions, artifacts, visited, o
             deferred: false
           }
         } else if (asset) {
-          addURL(artifacts.assets, url)
-
-          yield {
-            children: exports.module(url, null, {}, artifacts, visited, {
-              ...opts,
-              asset: true,
-              referrerType: type
-            }),
-            deferred: true
+          if (artifacts !== null) {
+            addURL(artifacts.assets, url)
+
+            yield {
+              children: exports.module(url, null, {}, artifacts, visited, {
+                ...opts,
+                asset: true,
+                importType: 0
+              }),
+              deferred: true
+            }
           }
         } else if (
           url.protocol !== builtinProtocol &&
@@ -367,7 +376,7 @@ exports.preresolved = function* (url, source, resolutions, artifacts, visited, o
           yield {
             children: exports.module(url, null, {}, artifacts, visited, {
               ...opts,
-              referrerType: type
+              importType: 0
             }),
             deferred: false
           }
@@ -465,7 +474,8 @@ function* resolveImport(entry, specifier, condition, parentURL, imports, artifac
     builtinProtocol = 'builtin:',
     linkedProtocol = 'linked:',
     deferredProtocol = 'deferred:',
-    deferUnresolved = false
+    deferUnresolved = false,
+    prefixes = new Map()
   } = opts
 
   const matchedConditions = []
@@ -503,31 +513,55 @@ function* resolveImport(entry, specifier, condition, parentURL, imports, artifac
         resolved = true
       } else if (condition === 'asset') {
         const prefix = url
+        const expand = artifacts !== null
 
-        let prefixResolution = null
+        let expanded = prefixes.get(prefix.href)
 
-        for (const url of yield { prefix }) {
-          const resolution = yield* postresolve(url)
+        if (expanded === undefined) {
+          const listed = yield { prefix, expand }
 
-          if (url.href === prefix.href) prefixResolution = resolution
+          const urls = []
 
-          yield {
-            children: exports.module(resolution, null, {}, artifacts, visited, {
-              ...opts,
-              asset: true
-            }),
-            deferred: true
+          let prefixResolution = null
+          let found = false
+
+          for (const url of listed) {
+            found = true
+
+            if (expand === false) break
+
+            const resolution = listed.resolved === true ? url : yield* postresolve(url)
+
+            if (url.href === prefix.href) prefixResolution = resolution
+
+            yield {
+              children: exports.module(resolution, null, {}, artifacts, visited, {
+                ...opts,
+                asset: true
+              }),
+              deferred: true
+            }
+
+            urls.push(resolution)
           }
 
-          addURL(artifacts.assets, resolution)
+          if (found) {
+            expanded = { resolution: prefixResolution || (yield* postresolve(prefix)), urls }
 
-          resolved = true
+            prefixes.set(prefix.href, expanded)
+          }
         }
 
-        if (resolved) {
-          resolution = prefixResolution || (yield* postresolve(prefix))
+        if (expanded !== undefined) {
+          if (expand) {
+            for (const url of expanded.urls) addURL(artifacts.assets, url)
+          }
+
+          resolution = expanded.resolution
 
           addResolution(imports, specifier, matchedConditions, resolution)
+
+          resolved = true
         }
       } else if (
         condition === 'addon' ||
@@ -577,7 +611,10 @@ function* resolveImport(entry, specifier, condition, parentURL, imports, artifac
           }
 
           yield {
-            children: exports.module(resolution, source, attributes, artifacts, visited, opts),
+            children: exports.module(resolution, source, attributes, artifacts, visited, {
+              ...opts,
+              importType: entry.type
+            }),
             deferred: false
           }
 
@@ -586,7 +623,7 @@ function* resolveImport(entry, specifier, condition, parentURL, imports, artifac
       }
 
       if (resolved) {
-        if (condition === 'addon') addURL(artifacts.addons, resolution)
+        if (condition === 'addon' && artifacts !== null) addURL(artifacts.addons, resolution)
 
         resolutions++
       }
@@ -632,8 +669,10 @@ exports.addons = function* (parentURL, artifacts, visited, opts = {}) {
 
     prefix.pathname = prefix.pathname.replace(ADDON_EXTENSION, '') + '/'
 
-    for (const url of yield { prefix }) {
-      const resolution = yield* postresolve(url)
+    const listed = yield { prefix, expand: true }
+
+    for (const url of listed) {
+      const resolution = listed.resolved === true ? url : yield* postresolve(url)
 
       yield {
         children: exports.module(resolution, null, {}, artifacts, visited, opts),
@@ -698,7 +737,7 @@ exports.patternMatches = function* patternMatches(pattern, parentURL, matches, o
 
     const prefix = new URL(patternBase, parentURL)
 
-    for (const url of yield { prefix }) {
+    for (const url of yield { prefix, expand: true }) {
       if (patternIndex === -1) {
         if (patternNegate) removeURL(matches, url)
         else addURL(matches, url)
@@ -735,6 +774,38 @@ exports.patternMatches = function* patternMatches(pattern, parentURL, matches, o
   return matches
 }
 
+function* lookupPackage(url, opts) {
+  const { packages = new Map() } = opts
+
+  const pending = []
+
+  for (const packageURL of lookupPackageScope(url, opts)) {
+    const scope = packages.get(packageURL.href)
+
+    if (scope !== undefined) {
+      for (const href of pending) packages.set(href, scope)
+
+      return scope
+    }
+
+    pending.push(packageURL.href)
+
+    const source = yield { module: packageURL, artifact: false }
+
+    if (source !== null) {
+      const scope = { url: packageURL, source, info: JSON.parse(source) }
+
+      for (const href of pending) packages.set(href, scope)
+
+      return scope
+    }
+  }
+
+  for (const href of pending) packages.set(href, null)
+
+  return null
+}
+
 function* postresolve(url) {
   return (yield { resolution: url }) || url
 }
@@ -808,22 +879,22 @@ function typeForAttribute(type) {
 }
 
 function dataURLModuleType(url, attributes, opts = {}) {
-  const { defaultType = constants.SCRIPT, referrerType } = opts
-
   const { mime } = parseDataURL(url)
 
+  if (mime === null) {
+    throw errors.UNKNOWN_DATA_URL_MEDIA_TYPE(`Data URL '${url.href}' does not declare a media type`)
+  }
+
   const asserted = typeof attributes.type === 'string' ? typeForAttribute(attributes.type) : null
 
-  if (mime === null || mime.subtype === 'javascript') {
+  if (mime.subtype === 'javascript') {
     if (asserted === constants.SCRIPT || asserted === constants.MODULE) return asserted
 
     if (asserted !== null) {
       throw errors.TYPE_INCOMPATIBLE(`Module '${url.href}' is not of type '${attributes.type}'`)
     }
 
-    if (referrerType) return referrerType
-
-    return defaultType === constants.MODULE ? constants.MODULE : constants.SCRIPT
+    return javaScriptDataURLModuleType(url, opts)
   }
 
   let type
@@ -847,6 +918,27 @@ function dataURLModuleType(url, attributes, opts = {}) {
   return type
 }
 
+// A data URL carries no extension and 'text/javascript' spans both module
+// systems, so the type follows how the module was named: `require()` names a
+// script and `import` a module. A dynamic `import()` names either and so must
+// say which, as must a caller naming a data URL with no import to read, who
+// answers with `defaultType`.
+function javaScriptDataURLModuleType(url, opts) {
+  const { defaultType = constants.SCRIPT, importType = 0 } = opts
+
+  if (importType & lex.constants.REQUIRE) return constants.SCRIPT
+
+  if (importType & lex.constants.IMPORT) {
+    if ((importType & lex.constants.DYNAMIC) === 0) return constants.MODULE
+
+    throw errors.AMBIGUOUS_MODULE_TYPE(
+      `Module '${url.href}' must declare whether it is of type 'script' or 'module'`
+    )
+  }
+
+  return defaultType === constants.MODULE ? constants.MODULE : constants.SCRIPT
+}
+
 function parseDataURL(url) {
   const { pathname } = url
 

package/lib/errors.js

@@ -49,6 +49,14 @@ module.exports = class ModuleTraverseError extends Error {
     return new ModuleTraverseError(msg, ModuleTraverseError.TYPE_INCOMPATIBLE)
   }
 
+  static AMBIGUOUS_MODULE_TYPE(msg) {
+    return new ModuleTraverseError(msg, ModuleTraverseError.AMBIGUOUS_MODULE_TYPE)
+  }
+
+  static UNKNOWN_DATA_URL_MEDIA_TYPE(msg) {
+    return new ModuleTraverseError(msg, ModuleTraverseError.UNKNOWN_DATA_URL_MEDIA_TYPE)
+  }
+
   static UNKNOWN_DATA_URL_CHARSET(msg, charset) {
     const err = new ModuleTraverseError(msg, ModuleTraverseError.UNKNOWN_DATA_URL_CHARSET)
 

package/lib/resolve/bare.js

@@ -5,6 +5,7 @@ const runtime = require('../runtime')
 module.exports = function (entry, parentURL, opts = {}) {
   const { linked = false, host = runtime.host, hosts = [host] } = opts
 
+  let directories = false
   let extensions
   let conditions = hosts.map((host) => ['bare', 'node', ...host.split('-')])
 
@@ -23,6 +24,7 @@ module.exports = function (entry, parentURL, opts = {}) {
 
   if (entry.type & lex.constants.ASSET) {
     conditions = conditions.map((conditions) => ['asset', ...conditions])
+    directories = true
   } else {
     extensions = ['.js', '.cjs', '.mjs', '.ts', '.cts', '.mts', '.json', '.bare', '.node']
 
@@ -36,6 +38,7 @@ module.exports = function (entry, parentURL, opts = {}) {
   return resolve.module(entry.specifier, parentURL, {
     ...opts,
     extensions,
-    conditions
+    conditions,
+    directories
   })
 }

package/lib/resolve/node.js

@@ -5,6 +5,7 @@ const runtime = require('../runtime')
 module.exports = function (entry, parentURL, opts = {}) {
   const { host = runtime.host, hosts = [host] } = opts
 
+  let directories = false
   let extensions
   let conditions = hosts.map((host) => ['node', ...host.split('-')])
 
@@ -22,6 +23,7 @@ module.exports = function (entry, parentURL, opts = {}) {
 
   if (entry.type & lex.constants.ASSET) {
     conditions = conditions.map((conditions) => ['asset', ...conditions])
+    directories = true
   } else if (entry.type & lex.constants.REQUIRE) {
     extensions = ['.js', '.json', '.node']
     conditions = conditions.map((conditions) => ['require', ...conditions])
@@ -32,6 +34,7 @@ module.exports = function (entry, parentURL, opts = {}) {
   return resolve.module(entry.specifier, parentURL, {
     ...opts,
     extensions,
-    conditions
+    conditions,
+    directories
   })
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-module-traverse",
-  "version": "2.5.1",
+  "version": "2.5.3",
   "description": "Low-level module graph traversal for Bare",
   "exports": {
     ".": {