@antora/ui-loader 3.0.3 → 3.1.0

package/lib/load-ui.js

@@ -1,7 +1,6 @@
 'use strict'
 
 const { compile: bracesToGroup } = require('braces')
-const camelCaseKeys = require('camelcase-keys')
 const { createHash } = require('crypto')
 const expandPath = require('@antora/expand-path-helper')
 const { File, MemoryFile, ReadableFile } = require('./file')
@@ -112,12 +111,12 @@ async function loadUi (playbook) {
             .on('error', reject)
             .pipe(collectFiles(resolve))
       ).catch((err) => {
-        const wrapped = new Error(
+        const errWrapper = new Error(
           `Failed to read UI ${bundleFile.isDirectory() ? 'directory' : 'bundle'}: ` +
             (bundleUrl === bundleFile.path ? bundleUrl : `${bundleFile.path} (resolved from url: ${bundleUrl})`)
         )
-        wrapped.stack += '\nCaused by: ' + (err.stack || 'unknown')
-        throw wrapped
+        errWrapper.stack += `\nCaused by: ${err.stack || 'unknown'}`
+        throw errWrapper
       })
     ),
     srcSupplementalFiles(supplementalFilesSpec, startDir),
@@ -194,9 +193,9 @@ function downloadBundle (url, to, agent) {
         )
     })
   }).catch((err) => {
-    const wrapped = new Error(`${err.summary || 'Failed to download UI bundle'}: ${url}`)
-    wrapped.stack += '\nCaused by: ' + (err.stack || 'unknown')
-    throw wrapped
+    const errWrapper = new Error(`${err.summary || 'Failed to download UI bundle'}: ${url}`)
+    errWrapper.stack += `\nCaused by: ${err.stack || 'unknown'}`
+    throw errWrapper
   })
 }
 
@@ -257,40 +256,44 @@ function collectFiles (resolve, files = new Map()) {
 }
 
 function srcSupplementalFiles (filesSpec, startDir) {
-  if (!filesSpec) {
-    return new Map()
-  } else if (Array.isArray(filesSpec)) {
-    return Promise.all(
-      filesSpec.reduce((accum, { path: path_, contents: contents_ }) => {
-        if (!path_) {
-          return accum
-        } else if (contents_) {
-          if (~contents_.indexOf('\n') || !EXT_RX.test(contents_)) {
-            accum.push(new MemoryFile({ path: path_, contents: Buffer.from(contents_) }))
+  if (!filesSpec) return new Map()
+  let cwd
+  return (
+    Array.isArray(filesSpec)
+      ? Promise.all(
+        filesSpec.reduce((accum, { path: path_, contents: contents_ }) => {
+          if (!path_) {
+            return accum
+          } else if (contents_) {
+            if (~contents_.indexOf('\n') || !EXT_RX.test(contents_)) {
+              accum.push(new MemoryFile({ path: path_, contents: Buffer.from(contents_) }))
+            } else {
+              contents_ = expandPath(contents_, { dot: startDir })
+              accum.push(
+                fsp
+                  .stat(contents_)
+                  .then((stat) =>
+                    fsp.readFile(contents_).then((contents) => new File({ path: path_, contents, stat }))
+                  )
+              )
+            }
           } else {
-            contents_ = expandPath(contents_, { dot: startDir })
-            accum.push(
-              fsp
-                .stat(contents_)
-                .then((stat) => fsp.readFile(contents_).then((contents) => new File({ path: path_, contents, stat })))
-            )
+            accum.push(new MemoryFile({ path: path_ }))
           }
-        } else {
-          accum.push(new MemoryFile({ path: path_ }))
-        }
-        return accum
-      }, [])
-    ).then((files) => files.reduce((accum, file) => accum.set(file.path, file) && accum, new Map()))
-  } else {
-    const cwd = expandPath(filesSpec, { dot: startDir })
-    return fsp.access(cwd).then(
-      () => srcFs(cwd),
-      (err) => {
-        // Q: should we skip unreadable files?
-        throw Object.assign(err, { message: `problem encountered while reading ui.supplemental_files: ${err.message}` })
-      }
-    )
-  }
+          return accum
+        }, [])
+      ).then((files) => files.reduce((accum, file) => accum.set(file.path, file) && accum, new Map()))
+      : fsp.access((cwd = expandPath(filesSpec, { dot: startDir }))).then(() => srcFs(cwd))
+  ).catch((err) => {
+    const dir = cwd ? filesSpec + (filesSpec === cwd ? '' : ` (resolved to ${cwd})`) : undefined
+    if (err.code === 'ENOENT' && err.path === cwd) {
+      throw new Error(`Specified ui.supplemental_files directory does not exist: ${dir}`)
+    } else {
+      const errWrapper = new Error(`Failed to read ui.supplemental_files ${cwd ? `directory: ${dir}` : 'entry'}`)
+      errWrapper.stack += `\nCaused by: ${err.stack || 'unknown'}`
+      throw errWrapper
+    }
+  })
 }
 
 function mergeFiles (files, supplementalFiles) {
@@ -302,7 +305,7 @@ function loadConfig (files, outputDir) {
   const configFile = files.get(UI_DESC_FILENAME)
   if (configFile) {
     files.delete(UI_DESC_FILENAME)
-    const config = camelCaseKeys(yaml.load(configFile.contents.toString()), { deep: true })
+    const config = camelCaseKeys(yaml.load(configFile.contents.toString()))
     const staticFiles = config.staticFiles
     if (staticFiles && staticFiles.length) config.isStaticFile = picomatch(staticFiles, STATIC_FILE_MATCHER_OPTS)
     if (outputDir !== undefined) config.outputDir = outputDir
@@ -312,6 +315,16 @@ function loadConfig (files, outputDir) {
   }
 }
 
+function camelCaseKeys (o) {
+  if (Array.isArray(o)) return o.map(camelCaseKeys)
+  if (o == null || o.constructor !== Object) return o
+  const accum = {}
+  for (const [k, v] of Object.entries(o)) {
+    accum[k.toLowerCase().replace(/[_-]([a-z0-9])/g, (_, l, idx) => (idx ? l.toUpperCase() : l))] = camelCaseKeys(v)
+  }
+  return accum
+}
+
 function classifyFile (file, config) {
   if (config.isStaticFile && config.isStaticFile(file.path)) {
     file.type = 'static'
@@ -363,15 +376,14 @@ function srcFs (cwd) {
             )
           },
           (statErr) => {
-            if (statErr.symlink) {
-              statErr.message =
-                statErr.code === 'ELOOP'
-                  ? `Symbolic link cycle detected at ${relpath}`
-                  : `Broken symbolic link detected at ${relpath}`
-            } else {
-              statErr.message = statErr.message.replace(`'${abspath}'`, relpath)
-            }
-            done(statErr)
+            done(
+              Object.assign(statErr, {
+                message: statErr.symlink
+                  ? (statErr.code === 'ELOOP' ? 'ELOOP: symbolic link cycle, ' : 'ENOENT: broken symbolic link, ') +
+                    `${relpath} -> ${statErr.symlink}`
+                  : statErr.message.replace(`'${abspath}'`, relpath),
+              })
+            )
           }
         )
       }),
@@ -383,9 +395,14 @@ function srcFs (cwd) {
 function symlinkAwareStat (path_) {
   return fsp.lstat(path_).then((lstat) => {
     if (!lstat.isSymbolicLink()) return lstat
-    return fsp.stat(path_).catch((statErr) => {
-      throw Object.assign(statErr, { symlink: true })
-    })
+    return fsp.stat(path_).catch((statErr) =>
+      fsp
+        .readlink(path_)
+        .catch(() => undefined)
+        .then((symlink) => {
+          throw Object.assign(statErr, { symlink })
+        })
+    )
   })
 }
 

package/lib/ui-catalog.js

@@ -26,6 +26,11 @@ class UiCatalog {
     return file
   }
 
+  removeFile (file) {
+    const filesForType = this[$files].get(file.type)
+    return filesForType ? filesForType.delete(file.path) : false
+  }
+
   findByType (type) {
     const filesForType = this[$files].get(type)
     return filesForType ? [...filesForType.values()] : []

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/ui-loader",
-  "version": "3.0.3",
+  "version": "3.1.0",
   "description": "Downloads a UI bundle, if necessary, and loads the files into a UI catalog for use in an Antora documentation pipeline.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -16,14 +16,21 @@
     "url": "https://gitlab.com/antora/antora/issues"
   },
   "main": "lib/index.js",
+  "exports": {
+    ".": "./lib/index.js",
+    "./ui-catalog": "./lib/ui-catalog.js",
+    "./package.json": "./package.json"
+  },
+  "imports": {
+    "#constants": "./lib/constants.js"
+  },
   "dependencies": {
     "@antora/expand-path-helper": "~2.0",
     "braces": "~3.0",
     "cache-directory": "~2.0",
-    "camelcase-keys": "~7.0",
     "glob-stream": "~7.0",
     "gulp-vinyl-zip": "~2.5",
-    "hpagent": "~0.1.0",
+    "hpagent": "~1.0",
     "js-yaml": "~4.1",
     "picomatch": "~2.3",
     "should-proxy": "~1.0",
@@ -31,7 +38,7 @@
     "vinyl": "~2.2"
   },
   "engines": {
-    "node": ">=12.21.0"
+    "node": ">=16.0.0"
   },
   "files": [
     "lib/"