bare-module-traverse 1.3.3 → 1.4.1

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

@@ -16,10 +16,6 @@ module.exports = exports = function traverse(
     opts = {}
   }
 
-  if (typeof listPrefix !== 'function') {
-    listPrefix = defaultListPrefix
-  }
-
   return {
     *[Symbol.iterator]() {
       const artifacts = { addons: [], assets: [] }
@@ -39,8 +35,14 @@ module.exports = exports = function traverse(
           } else if (value.prefix) {
             const result = []
 
-            for (const url of listPrefix(value.prefix)) {
-              result.push(url)
+            if (typeof listPrefix === 'function') {
+              for (const url of listPrefix(value.prefix)) {
+                result.push(url)
+              }
+            } else {
+              if (readModule(value.prefix) !== null) {
+                result.push(value.prefix)
+              }
             }
 
             next = generator.next(result)
@@ -74,8 +76,14 @@ module.exports = exports = function traverse(
           } else if (value.prefix) {
             const result = []
 
-            for await (const url of listPrefix(value.prefix)) {
-              result.push(url)
+            if (typeof listPrefix === 'function') {
+              for await (const url of listPrefix(value.prefix)) {
+                result.push(url)
+              }
+            } else {
+              if ((await readModule(value.prefix)) !== null) {
+                result.push(value.prefix)
+              }
             }
 
             next = generator.next(result)
@@ -93,8 +101,6 @@ module.exports = exports = function traverse(
   }
 }
 
-function* defaultListPrefix() {}
-
 exports.resolve = resolve
 
 exports.module = function* (url, source, artifacts, visited, opts = {}) {
@@ -229,6 +235,7 @@ exports.imports = function* (
     resolve = exports.resolve.default,
     builtinProtocol = 'builtin:',
     linkedProtocol = 'linked:',
+    deferredProtocol = 'deferred:',
     matchedConditions = []
   } = opts
 
@@ -264,11 +271,28 @@ exports.imports = function* (
 
         if (
           url.protocol === builtinProtocol ||
-          url.protocol === linkedProtocol
+          url.protocol === linkedProtocol ||
+          url.protocol === deferredProtocol
         ) {
           addResolution(imports, specifier, matchedConditions, url)
 
           resolved = yielded = true
+        } else if (condition === 'asset') {
+          const prefix = yield { prefix: url }
+
+          if (prefix.length !== 0) {
+            addResolution(imports, specifier, matchedConditions, url)
+
+            for (const url of prefix) {
+              yield {
+                children: exports.module(url, null, artifacts, visited, opts)
+              }
+
+              addURL(artifacts.assets, url)
+            }
+
+            resolved = yielded = true
+          }
         } else {
           const source = yield { module: url }
 
@@ -285,7 +309,6 @@ exports.imports = function* (
 
         if (resolved) {
           if (condition === 'addon') addURL(artifacts.addons, url)
-          else if (condition === 'asset') addURL(artifacts.assets, url)
 
           resolutions++
         }

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.3.3",
+  "version": "1.4.1",
   "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": {
@@ -42,8 +58,22 @@
     "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
+    }
   }
 }