@antora/assembler 1.0.0-beta.19 → 1.0.0-beta.20

package/lib/assemble-content.js

@@ -40,7 +40,7 @@ async function assembleContent (playbook, contentCatalog, converter, { configSou
   const { loadAsciiDoc = require('@antora/asciidoc-loader') } = generatorFunctions
   const { assembly: assemblyConfig, build: buildConfig } = assemblerConfig
   assemblyConfig.embedReferenceStyle = embedReferenceStyle
-  const { profile = targetBackend } = assemblyConfig
+  const profile = (assemblyConfig.profile ??= targetBackend)
   const intrinsicAttributes = { 'loader-assembler': '' }
   buildConfig.cwd ??= process.cwd()
   if (profile) {
@@ -131,56 +131,72 @@ async function assembleContent (playbook, contentCatalog, converter, { configSou
  * the keys from the profile as well as any inherited shared keys, builds the navigation for the assembly, and
  * returns the initialized assembly model. The assembly model is further populated after the call to this function.
  */
-function generateSelectAssemblyProfile (context, contentCatalog, base, intrinsicAttributes, navigationCatalog) {
+function generateSelectAssemblyProfile (context, contentCatalog, baseModel, intrinsicAttributes, navigationCatalog) {
   const logger = context.getLogger?.(PACKAGE_NAME)
   const { assemblerProfiles } = context.getVariables()
   if (!assemblerProfiles) {
     return (componentVersion) => {
       const navigation =
         navigationCatalog?.getNavigation(componentVersion.name, componentVersion.version) ?? componentVersion.navigation
-      return Object.assign({}, base, { attributes: Object.assign({}, base.attributes), navigation, logger })
+      return Object.assign({}, baseModel, { attributes: Object.assign({}, baseModel.attributes), navigation, logger })
     }
   }
   const boundSendToLog = sendToLog.bind(logger)
-  const { buildNavigation = require('@antora/navigation-builder') } = context.getFunctions()
+  const {
+    buildNavigation = require('@antora/navigation-builder'),
+    buildAlternateNavigation = buildNavigation.buildAlternateNavigation ??
+      buildAlternateNavigationShim.bind(null, buildNavigation),
+  } = context.getFunctions()
   return (componentVersion) => {
-    const attributes = Object.assign({}, base.attributes)
+    const attributes = Object.assign({}, baseModel.attributes)
     const componentVersionProfiles = assemblerProfiles.get(componentVersion.version + '@' + componentVersion.name)
-    const overrides =
-      componentVersionProfiles?.get(intrinsicAttributes['assembler-profile']) ?? componentVersionProfiles?.get() ?? {}
+    const overrides = componentVersionProfiles?.get(baseModel.profile) ?? componentVersionProfiles?.get() ?? {}
     const { navFiles, messages } = overrides
-    Object.entries(overrides.attributes ?? {}).forEach(([name, val]) => {
-      attributes[name] = val
-    })
-    const model = Object.assign({}, base, overrides, { attributes, logger })
+    Object.entries(overrides.attributes ?? {}).forEach(([name, val]) => (attributes[name] = val))
+    const model = Object.assign({}, baseModel, overrides, { attributes, logger })
     delete model.navFiles
     delete model.messages
     const navigationOverride = navigationCatalog?.getNavigation(componentVersion.name, componentVersion.version)
     if (navigationOverride) return Object.assign(model, { navigation: navigationOverride })
     messages?.forEach(boundSendToLog)
-    model.navigation = componentVersion.navigation
-    if (!navFiles) return model
+    if (!navFiles) return Object.assign(model, { navigation: componentVersion.navigation })
     if (!navFiles.length) return Object.assign(model, { navigation: [] })
-    const navigation_ = model.navigation
-    const asciidoc_ = componentVersion.asciidoc
-    componentVersion.asciidoc = Object.assign({}, asciidoc_, {
-      attributes: Object.assign({}, asciidoc_.attributes, intrinsicAttributes),
+    model.navigation = buildAlternateNavigation(contentCatalog, componentVersion, navFiles, {
+      attributes: intrinsicAttributes,
     })
-    buildNavigation(
-      new Proxy(contentCatalog, {
-        get (target, property) {
-          const method = target[property]
-          if (property !== 'findBy') return method
-          return (criteria) => (toJSON(criteria) === '{"family":"nav"}' ? navFiles : method.call(target, criteria))
-        },
-      })
-    )
-    model.navigation = componentVersion.navigation
-    Object.assign(componentVersion, { asciidoc: asciidoc_, navigation: navigation_ })
     return model
   }
 }
 
+function buildAlternateNavigationShim (
+  buildNavigation,
+  contentCatalog,
+  componentVersion,
+  navFiles,
+  asciidocConfigOverrides
+) {
+  const { asciidoc: asciidoc_, navigation: navigation_ } = componentVersion
+  const asciidocConfig = (componentVersion.asciidoc = Object.assign({}, asciidoc_))
+  if (asciidocConfigOverrides) {
+    const attributesOverrides =
+      'attributes' in asciidocConfigOverrides
+        ? { attributes: Object.assign({}, asciidocConfig.attributes, asciidocConfigOverrides.attributes) }
+        : undefined
+    Object.assign(asciidocConfig, asciidocConfigOverrides, attributesOverrides)
+  }
+  const contentCatalogProxy = new Proxy(contentCatalog, {
+    get (target, property) {
+      const method = target[property]
+      if (property !== 'findBy') return method
+      return (criteria) => (toJSON(criteria) === '{"family":"nav"}' ? navFiles : method.call(target, criteria))
+    },
+  })
+  buildNavigation(contentCatalogProxy)
+  const navigation = componentVersion.navigation
+  Object.assign(componentVersion, { asciidoc: asciidoc_, navigation: navigation_ })
+  return navigation
+}
+
 function prepareConvertAttributes (doc, targetExtname, relativeToOutput, assemblerConfig) {
   const {
     asciidoc: { attributes: docAttributes } = { attributes: {} },
@@ -193,14 +209,13 @@ function prepareConvertAttributes (doc, targetExtname, relativeToOutput, assembl
   const docfile = ospath.join(dir, reldocfile)
   const outdir = ospath.dirname(docfile)
   const docdir = relativeToOutput ? dir : outdir
-  const imagesdir = ''
   const outfile = docfile.slice(0, docfile.length - docfilesuffix.length) + targetExtname
   const attributes = Object.assign({ revdate: `${assemblerConfig.assembly.revdate}@` }, docAttributes, {
     docdir,
     docfile,
     docfilesuffix,
     'docname@': docname,
-    imagesdir,
+    imagesdir: '',
     outdir,
     outfile,
     outfilesuffix: targetExtname,

package/lib/configure.js

@@ -44,7 +44,8 @@ function getAssemblerProfiles (contentCatalog, assemblerProfiles = new Map()) {
   contentCatalog.getComponents().forEach((component) => {
     component.versions.forEach((componentVersion) => {
       const source =
-        componentVersion.nav?.origin ?? componentVersion.origins?.find((it) => it.descriptor?.ext?.assembler)
+        componentVersion.nav?.origin ??
+        [...(componentVersion.origins ?? [])].find((it) => it.descriptor?.ext?.assembler)
       const assemblerConfig = getAssemblerConfigFromDescriptor(source?.descriptor)
       if (!assemblerConfig) return
       const componentVersionRef = `${componentVersion.version}@${componentVersion.name}`

package/lib/filter-component-versions.js

@@ -36,12 +36,13 @@ function compilePatterns (patterns) {
   })
 }
 
-function filterComponentVersions (components, patterns) {
+function filterComponentVersions (components, { names: patterns, prereleases = true }) {
   if (!patterns.length) return []
   const rxs = compilePatterns(patterns)
   return components.reduce((accum, { latest, versions }) => {
     accum.push(
       ...versions.filter((version) => {
+        if (!prereleases && version.prerelease && version !== latest) return false
         let matched
         for (const rx of rxs) {
           let voteIfMatched

package/lib/produce-assembly-file.js

@@ -22,6 +22,7 @@ const DISCARD_ATTRIBUTE_NAMES = [
   'leveloffset',
   'assembly-header-attributes',
   'assembly-navtitle',
+  'assembly-slug',
   'assembly-style',
   'underscore',
 ]
@@ -76,8 +77,8 @@ function produceAssemblyFile (
     mutableAttributes,
     assemblyModel
   )
-  const stem = rootLevel === 0 ? 'index' : generateSlug(buffer.navtitle)
-  const downloadStem = [component, version, rootLevel === 0 ? '' : stem].filter((it) => it).join('-')
+  const stem = buffer.slug ? sanitizeSlug(buffer.slug) : generateSlug(rootLevel === 0 ? 'index' : buffer.navtitle)
+  const downloadStem = [component, version, stem === 'index' ? '' : stem].filter((it) => it).join('-')
   return createAsciiDocFile(contentCatalog, {
     asciidoc: asciidocConfig,
     assembler: { assembled: pagesInOutline.assembled, downloadStem, rootLevel },
@@ -204,6 +205,7 @@ function mergeAsciiDoc (
         })
       : doc.getLogger()
     doc.source_header_attributes ??= doc.parent.$to_h()
+    if (isRootPage && doc.hasAttribute('assembly-slug')) buffer.slug = doc.getAttribute('assembly-slug')
     if (doc.hasAttribute('assembly-navtitle')) {
       navtitleAsciiDoc = doc.getAttribute('assembly-navtitle')
       navtitlePlain = sanitize((navtitle = doc.$apply_reftext_subs(navtitleAsciiDoc)))
@@ -731,8 +733,9 @@ function processDocumentHeader (doc, lines, ignoreLines, isRootPage) {
   return entries
 }
 
-function generateSlug (title) {
-  return title
+function generateSlug (string) {
+  if (string === 'index') return string
+  return string
     .toLowerCase()
     .replace(/<[^>]+>/g, '')
     .replace(CHAR_REF_RX, (_, name, dec, hex) => {
@@ -744,6 +747,10 @@ function generateSlug (title) {
     .replace(/^-+|-+$|(-)-+/g, '$1')
 }
 
+function sanitizeSlug (slug) {
+  return slug.replace(/ /g, '-').replace(/[^\p{Alpha}0-9_.-]/gu, '-')
+}
+
 function fixSectionLevels (sections, expectedLevel) {
   sections.forEach((sect) => {
     const forceLevel = expectedLevel ?? Math.min(1, sect.getLevel())

package/lib/produce-assembly-files.js

@@ -28,7 +28,7 @@ function produceAssemblyFiles (loadAsciiDoc, contentCatalog, assemblerConfig, se
   const publishableFiles = contentCatalog.getFiles().filter((file) => file.out)
   let siteRoot
   const configMdc = assemblerConfig.file ? { file: { path: assemblerConfig.file } } : {}
-  return filterComponentVersions(contentCatalog.getComponents(), assemblerConfig.componentVersionFilter.names).reduce(
+  return filterComponentVersions(contentCatalog.getComponents(), assemblerConfig.componentVersionFilter).reduce(
     (accum, componentVersion) => {
       const assemblyModel = selectAssemblyProfile(componentVersion)
       const { attributes: assemblyAttributes, logger, navigation, rootLevel } = assemblyModel

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/assembler",
-  "version": "1.0.0-beta.19",
+  "version": "1.0.0-beta.20",
   "description": "A JavaScript library that merges AsciiDoc content from multiple pages in an Antora site into assembly files and delegates to an exporter to convert those files to another format, such as PDF.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",