bare-module-traverse 1.4.0 → 1.5.0

package/README.md

@@ -211,7 +211,7 @@ Options are the same as `traverse()` for all functions.
 > [!WARNING]
 > These functions are currently subject to change between minor releases. If using them directly, make sure to specify a tilde range (`~1.2.3`) when declaring the module dependency.
 
-#### `const generator = traverse.module(url, source, artifacts, visited[, options])`
+#### `const generator = traverse.module(url, source, attributes, artifacts, visited[, options])`
 
 #### `const generator = traverse.package(url, source, artifacts, visited[, options])`
 

package/index.d.ts

@@ -0,0 +1,111 @@
+import URL from 'bare-url'
+import Buffer from 'bare-buffer'
+import {
+  type ConditionalSpecifier,
+  type ImportsMap,
+  type ResolutionsMap
+} from 'bare-module-resolve'
+import { type ResolveOptions, type Resolver } from 'bare-addon-resolve'
+import { type Import } from 'bare-module-lexer'
+
+interface Dependency {
+  url: URL
+  source: string | Buffer
+  imports: ImportsMap
+}
+
+interface TraverseOptions extends ResolveOptions {
+  resolve?: (entry: Import, parentURL: URL, opts?: ResolveOptions) => Resolver
+}
+
+declare function traverse(
+  entry: URL,
+  readModule: (url: URL) => Buffer | string | null,
+  listPrefix?: (url: URL) => Iterable<URL>
+): Iterable<Dependency>
+
+declare function traverse(
+  entry: URL,
+  readModule: (url: URL) => Promise<Buffer | string | null>,
+  listPrefix?: (url: URL) => AsyncIterable<URL>
+): AsyncIterable<Dependency>
+
+declare function traverse(
+  entry: URL,
+  opts: TraverseOptions,
+  readModule: (url: URL) => Buffer | string | null,
+  listPrefix?: (url: URL) => Iterable<URL>
+): Iterable<Dependency>
+
+declare function traverse(
+  entry: URL,
+  opts: TraverseOptions,
+  readModule: (url: URL) => Promise<Buffer | string | null>,
+  listPrefix?: (url: URL) => AsyncIterable<URL>
+): AsyncIterable<Dependency>
+
+declare namespace traverse {
+  export { type TraverseOptions }
+
+  export type Traversal = Generator<
+    { module: URL } | { prefix: URL } | { children: URL } | { dependency: URL },
+    boolean,
+    void | URL[] | Buffer | string | null
+  >
+
+  export interface Artifacts {
+    addons: URL[]
+    assets: URL[]
+  }
+
+  export function module(
+    url: URL,
+    source: string | Buffer,
+    artifacts: Artifacts,
+    visited: Set<string>,
+    opts?: TraverseOptions
+  ): Traversal
+
+  export function package(
+    url: URL,
+    source: string | Buffer,
+    artifacts: Artifacts,
+    visited: Set<string>,
+    opts?: TraverseOptions
+  ): Traversal
+
+  export function preresolved(
+    url: URL,
+    source: string | Buffer,
+    resolution: ResolutionsMap,
+    artifacts: Artifacts,
+    visited: Set<string>,
+    opts?: TraverseOptions
+  ): Traversal
+
+  export function imports(
+    parentURL: URL,
+    source: string | Buffer,
+    imports: ImportsMap,
+    artifacts: Artifacts,
+    visited: Set<string>,
+    opts?: TraverseOptions
+  ): Traversal
+
+  export function prebuilds(
+    packageURL: URL,
+    artifacts: Artifacts,
+    visited: Set<string>,
+    opts?: TraverseOptions
+  ): Traversal
+
+  export function assets(
+    patterns: ConditionalSpecifier,
+    packageURL: URL,
+    artifacts: Artifacts,
+    visited: Set<string>,
+    opts?: TraverseOptions
+  ): Traversal
+}
+
+export = traverse

package/index.js

@@ -20,7 +20,9 @@ module.exports = exports = function traverse(
     *[Symbol.iterator]() {
       const artifacts = { addons: [], assets: [] }
 
-      const queue = [exports.module(entry, null, artifacts, new Set(), opts)]
+      const queue = [
+        exports.module(entry, null, {}, artifacts, new Set(), opts)
+      ]
 
       while (queue.length > 0) {
         const generator = queue.pop()
@@ -61,7 +63,9 @@ module.exports = exports = function traverse(
     async *[Symbol.asyncIterator]() {
       const artifacts = { addons: [], assets: [] }
 
-      const queue = [exports.module(entry, null, artifacts, new Set(), opts)]
+      const queue = [
+        exports.module(entry, null, {}, artifacts, new Set(), opts)
+      ]
 
       while (queue.length > 0) {
         const generator = queue.pop()
@@ -103,7 +107,14 @@ module.exports = exports = function traverse(
 
 exports.resolve = resolve
 
-exports.module = function* (url, source, artifacts, visited, opts = {}) {
+exports.module = function* (
+  url,
+  source,
+  attributes,
+  artifacts,
+  visited,
+  opts = {}
+) {
   const { resolutions = null } = opts
 
   if (visited.has(url.href)) return false
@@ -149,6 +160,23 @@ exports.module = function* (url, source, artifacts, visited, opts = {}) {
     }
   }
 
+  if (
+    typeof attributes === 'object' &&
+    attributes !== null &&
+    typeof attributes.imports === 'string'
+  ) {
+    const url = new URL(attributes.imports)
+
+    const source = yield { module: url }
+
+    if (source !== null) {
+      opts = {
+        ...opts,
+        imports: mixinImports(opts.imports, JSON.parse(source), url)
+      }
+    }
+  }
+
   yield* exports.imports(url, source, imports, artifacts, visited, opts)
 
   yield { dependency: { url, source, imports: compressImportsMap(imports) } }
@@ -209,7 +237,7 @@ exports.preresolved = function* (
           }
         } else {
           yield {
-            children: exports.module(url, null, artifacts, visited, opts)
+            children: exports.module(url, null, {}, artifacts, visited, opts)
           }
         }
       } else {
@@ -235,11 +263,14 @@ exports.imports = function* (
     resolve = exports.resolve.default,
     builtinProtocol = 'builtin:',
     linkedProtocol = 'linked:',
+    deferredProtocol = 'deferred:',
     matchedConditions = []
   } = opts
 
   let yielded = false
 
+  const queue = []
+
   for (const entry of lex(source).imports) {
     let specifier = entry.specifier
     let condition = 'default'
@@ -251,6 +282,28 @@ exports.imports = function* (
       condition = 'asset'
     }
 
+    if (entry.attributes.imports) {
+      const specifier = entry.attributes.imports
+
+      queue.push({
+        entry: {
+          type: 0,
+          specifier,
+          names: [],
+          attributes: {},
+          position: [0, 0, 0]
+        },
+        specifier,
+        condition: 'default'
+      })
+    }
+
+    queue.push({ entry, specifier, condition })
+  }
+
+  while (queue.length > 0) {
+    const { entry, specifier, condition } = queue.shift()
+
     matchedConditions.push(condition)
 
     const resolver = resolve(entry, parentURL, { ...opts, matchedConditions })
@@ -270,7 +323,8 @@ exports.imports = function* (
 
         if (
           url.protocol === builtinProtocol ||
-          url.protocol === linkedProtocol
+          url.protocol === linkedProtocol ||
+          url.protocol === deferredProtocol
         ) {
           addResolution(imports, specifier, matchedConditions, url)
 
@@ -283,7 +337,14 @@ exports.imports = function* (
 
             for (const url of prefix) {
               yield {
-                children: exports.module(url, null, artifacts, visited, opts)
+                children: exports.module(
+                  url,
+                  null,
+                  {},
+                  artifacts,
+                  visited,
+                  opts
+                )
               }
 
               addURL(artifacts.assets, url)
@@ -297,8 +358,21 @@ exports.imports = function* (
           if (source !== null) {
             addResolution(imports, specifier, matchedConditions, url)
 
+            const attributes = entry.attributes
+
+            if (attributes.imports) {
+              attributes.imports = imports[attributes.imports].default
+            }
+
             yield {
-              children: exports.module(url, source, artifacts, visited, opts)
+              children: exports.module(
+                url,
+                source,
+                attributes,
+                artifacts,
+                visited,
+                opts
+              )
             }
 
             resolved = yielded = true
@@ -365,7 +439,7 @@ exports.prebuilds = function* (packageURL, artifacts, visited, opts = {}) {
         addURL(artifacts.addons, url)
 
         yield {
-          children: exports.module(url, source, artifacts, visited, opts)
+          children: exports.module(url, source, {}, artifacts, visited, opts)
         }
 
         yielded = true
@@ -395,7 +469,9 @@ exports.assets = function* (
     if (source !== null) {
       addURL(artifacts.assets, url)
 
-      yield { children: exports.module(url, source, artifacts, visited, opts) }
+      yield {
+        children: exports.module(url, source, {}, artifacts, visited, opts)
+      }
 
       yielded = true
     }
@@ -580,3 +656,17 @@ function compressImportsMapEntry(resolved) {
 
   return Object.fromEntries(entries)
 }
+
+function mixinImports(target, imports, url) {
+  if (typeof imports === 'object' && imports !== null && 'imports' in imports) {
+    imports = imports.imports
+  }
+
+  if (typeof imports !== 'object' || imports === null) {
+    throw errors.INVALID_IMPORTS_MAP(
+      `Imports map at '${url.href}' is not valid`
+    )
+  }
+
+  return { ...target, ...imports }
+}

package/lib/errors.js

@@ -35,4 +35,12 @@ module.exports = class ModuleTraverseError extends Error {
       ModuleTraverseError.ASSET_NOT_FOUND
     )
   }
+
+  static INVALID_IMPORTS_MAP(msg) {
+    return new ModuleTraverseError(
+      msg,
+      'INVALID_IMPORTS_MAP',
+      ModuleTraverseError.INVALID_IMPORTS_MAP
+    )
+  }
 }

package/lib/resolve/bare.d.ts

@@ -0,0 +1,21 @@
+import { type Import } from 'bare-module-lexer'
+import { type ResolveOptions, type Resolver } from 'bare-addon-resolve'
+
+interface BareResolveOptions extends ResolveOptions {
+  platform?: string
+  arch?: string
+  simulator?: boolean
+  target?: string[]
+}
+
+declare function resolve(
+  entry: Import,
+  parentURL: URL,
+  opts?: BareResolveOptions
+): Resolver
+
+declare namespace resolve {
+  export { type BareResolveOptions }
+}
+
+export = resolve

package/lib/resolve/bare.js

@@ -1,14 +1,13 @@
 const lex = require('bare-module-lexer')
 const resolve = require('../resolve')
+const runtime = require('../runtime')
 
 module.exports = function (entry, parentURL, opts = {}) {
-  const runtime = require('#runtime')
-
   const {
     linked = false,
     platform = runtime.platform,
     arch = runtime.arch,
-    simulator = false,
+    simulator = runtime.simulator,
     host = `${platform}-${arch}${simulator ? '-simulator' : ''}`,
     target = [host]
   } = opts

package/lib/resolve/default.d.ts

@@ -0,0 +1,10 @@
+import { type Import } from 'bare-module-lexer'
+import { type ResolveOptions, type Resolver } from 'bare-addon-resolve'
+
+declare function resolve(
+  entry: Import,
+  parentURL: URL,
+  opts?: ResolveOptions
+): Resolver
+
+export = resolve

package/lib/resolve/node.d.ts

@@ -0,0 +1,21 @@
+import { type Import } from 'bare-module-lexer'
+import { type ResolveOptions, type Resolver } from 'bare-addon-resolve'
+
+interface NodeResolveOptions extends ResolveOptions {
+  platform?: string
+  arch?: string
+  simulator?: boolean
+  target?: string[]
+}
+
+declare function resolve(
+  entry: Import,
+  parentURL: URL,
+  opts?: NodeResolveOptions
+): Resolver
+
+declare namespace resolve {
+  export { type NodeResolveOptions }
+}
+
+export = resolve

package/lib/resolve/node.js

@@ -1,13 +1,12 @@
 const lex = require('bare-module-lexer')
 const resolve = require('../resolve')
+const runtime = require('../runtime')
 
 module.exports = function (entry, parentURL, opts = {}) {
-  const runtime = require('#runtime')
-
   const {
     platform = runtime.platform,
     arch = runtime.arch,
-    simulator = false,
+    simulator = runtime.simulator,
     host = `${platform}-${arch}${simulator ? '-simulator' : ''}`,
     target = [host]
   } = opts

package/lib/resolve.d.ts

@@ -0,0 +1,8 @@
+import { module } from 'bare-module-resolve'
+import { addon } from 'bare-addon-resolve'
+
+import defaultResolve from './resolve/default'
+import bare from './resolve/bare'
+import node from './resolve/node'
+
+export { module, addon, defaultResolve as default, bare, node }

package/lib/runtime/bare.js

@@ -1,3 +1,3 @@
-/* global Bare */
 exports.platform = Bare.platform
 exports.arch = Bare.arch
+exports.simulator = Bare.simulator

package/lib/runtime/node.js

@@ -1,2 +1,3 @@
 exports.platform = process.platform
 exports.arch = process.arch
+exports.simulator = false

package/lib/runtime.js

@@ -0,0 +1 @@
+module.exports = require('#runtime')

package/package.json

@@ -1,17 +1,33 @@
 {
   "name": "bare-module-traverse",
-  "version": "1.4.0",
+  "version": "1.5.0",
   "description": "Low-level module graph traversal for Bare",
   "exports": {
-    ".": "./index.js",
-    "./package": "./package.json",
-    "./resolve": "./lib/resolve.js",
-    "./resolve/default": "./lib/resolve/default.js",
-    "./resolve/bare": "./lib/resolve/bare.js",
-    "./resolve/node": "./lib/resolve/node.js"
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
+    "./resolve": {
+      "types": "./lib/resolve.d.ts",
+      "default": "./lib/resolve.js"
+    },
+    "./resolve/default": {
+      "types": "./lib/resolve/default.d.ts",
+      "default": "./lib/resolve/default.js"
+    },
+    "./resolve/bare": {
+      "types": "./lib/resolve/bare.d.ts",
+      "default": "./lib/resolve/bare.js"
+    },
+    "./resolve/node": {
+      "types": "./lib/resolve/node.d.ts",
+      "default": "./lib/resolve/node.js"
+    },
+    "./package": "./package.json"
   },
   "files": [
     "index.js",
+    "index.d.ts",
     "lib"
   ],
   "imports": {
@@ -38,12 +54,26 @@
   "homepage": "https://github.com/holepunchto/bare-module-traverse#readme",
   "dependencies": {
     "bare-addon-resolve": "^1.5.0",
-    "bare-module-lexer": "^1.0.0",
+    "bare-module-lexer": "^1.4.0",
     "bare-module-resolve": "^1.7.0"
   },
   "devDependencies": {
+    "bare-buffer": "^3.0.2",
+    "bare-url": "^2.1.3",
     "brittle": "^3.2.1",
     "prettier": "^3.4.2",
     "prettier-config-standard": "^7.0.0"
+  },
+  "peerDependencies": {
+    "bare-buffer": "*",
+    "bare-url": "*"
+  },
+  "peerDependenciesMeta": {
+    "bare-buffer": {
+      "optional": true
+    },
+    "bare-url": {
+      "optional": true
+    }
   }
 }