@antora/assembler 1.0.0-rc.11 → 1.0.0-rc.12

package/lib/produce-assembly-file.js

@@ -232,15 +232,20 @@ function mergeAsciiDoc (
     return builder
   }
   const assembled = pagesInOutline.assembled
+  const atStartOfBody = !builder.body?.length
+  const isRootEntry = atStartOfBody && !level
   // FIXME: ideally, resource ID would be stored in navigation so we can look up the page more efficiently
   const page = urlType === 'internal' && !unresolved ? pagesInOutline.get(pathname) : undefined
-  let navtitle = outlineEntry.navtitle ?? (page && hash ? page.asciidoc.navtitle : outlineEntry.content)
+  let navtitle = outlineEntry.content
+  if (isRootEntry && 'navtitle' in outlineEntry) {
+    navtitle = outlineEntry.navtitle
+  } else if (page && hash) {
+    navtitle = page.asciidoc.navtitle
+  }
   let navtitleAsciiDoc = unconvertInlineAsciiDoc(navtitle)
   let navtitlePlain = sanitize(navtitle)
   const { doctype, filetype, linkReferenceStyle, pubRoot, siteRoot, logger, rootLevel, rootPageStyle } = assemblyModel
   let sectionMergeStrategy = assemblyModel.sectionMergeStrategy
-  const atStartOfBody = !builder.body?.length
-  const isRootEntry = atStartOfBody && !level
   let atBookRoot = isRootEntry && doctype === 'book' && (supportsParts = true)
   const hasItems = items.length > 0
   if (page && !assembled.pages.has(page)) {
@@ -386,13 +391,22 @@ function mergeAsciiDoc (
     }
     buffer.push(`:page-module: ${module_}`)
     buffer.push(`:page-relative-src-path: ${relative}`)
-    buffer.push(`:page-origin-url: ${origin.url}`)
-    buffer.push(`:page-origin-start-path:${origin.startPath && ' '}${origin.startPath}`)
-    buffer.push(`:page-origin-refname: ${origin.branch || origin.tag}`)
-    buffer.push(`:page-origin-reftype: ${origin.branch ? 'branch' : 'tag'}`)
-    buffer.push(`:page-origin-refhash: ${origin.worktree ? '(worktree)' : origin.refhash}`)
+    if (origin) {
+      buffer.push(`:page-origin-url: ${origin.url}`)
+      buffer.push(`:page-origin-start-path:${origin.startPath && ' '}${origin.startPath}`)
+      buffer.push(`:page-origin-refname: ${origin.branch || origin.tag}`)
+      buffer.push(`:page-origin-reftype: ${origin.branch ? 'branch' : 'tag'}`)
+      buffer.push(`:page-origin-refhash: ${origin.worktree ? '(worktree)' : origin.refhash}`)
+    } else {
+      buffer.push(':!page-origin-url:')
+      buffer.push(':!page-origin-start-path:')
+      buffer.push(':!page-origin-refname:')
+      buffer.push(':!page-origin-reftype:')
+      buffer.push(':!page-origin-refhash:')
+    }
+    buffer.push(`:page-url: ${page.pub.url}`)
     let heading
-    if (pageStyle != null && isRootPage) {
+    if (isRootPage && pageStyle != null) {
       let htitleAsciiDoc, htitleOverride
       if (pageStyle === 'preface') {
         const hasPrefaceTitleAttr =
@@ -459,26 +473,24 @@ function mergeAsciiDoc (
       heading = { title: navtitleAsciiDoc, hlevel: level-- } // NOTE: level will always come in at 1
       nextSectionLevel = pageStyle === 'part' ? 1 : 2
     } else if (level) {
-      if (atStartOfBody && !pageStyle && builder.matchesDoctitle(navtitlePlain)) {
+      if (atStartOfBody && pageStyle == null && !headerHasBlockAttrs && builder.matchesDoctitle(navtitlePlain)) {
         level--
-        if (headerHasBlockAttrs) heading = { title: '', hlevel: ++level + 1 }
-      } else {
-        heading = { title: navtitleAsciiDoc, hlevel: level + 1 }
+      } else if ((heading = { title: navtitleAsciiDoc, hlevel: level + 1 }).hlevel > 6) {
+        Object.assign(heading, { hlevel: 6, style: `discrete.h${heading.hlevel}` })
       }
     }
     if (heading) {
-      if (heading.hlevel > 6) Object.assign(heading, { hlevel: 6, style: `discrete.h${heading.hlevel}` })
       const rolesAttr = pageRoles.reduce((str, it) => str + '.' + it, '')
       const notitle = (heading.title ||= '{empty}') === '{empty}'
       // remove conditional if we always want to promote ID of root page to docid
-      if (notitle && atStartOfBody) {
+      if (atStartOfBody && notitle) {
         builder.setDocid(pageId)
         pageFragment = '#' + idSeparators.generateIdFromTitle('', idSeparators, pageIdLeader)
       }
       const style = heading.style ?? (pageStyle === 'part' || pageStyle === 'section' ? '' : (pageStyle ?? ''))
       buffer.push(`[${style}${pageFragment}${rolesAttr}${notitle ? '%notitle' : ''}]`)
       buffer.push(`${'='.repeat(heading.hlevel)} ${heading.title}`)
-      if (notitle || !supportsSections) sectionMergeStrategy = 'discrete'
+      if ((notitle && pageStyle != null) || !supportsSections) sectionMergeStrategy = 'discrete'
     } else if (atStartOfBody) {
       builder.setDocid(pageId)
     }

package/lib/produce-assembly-files.js

@@ -39,7 +39,7 @@ function produceAssemblyFiles (
     const { attributes: assemblyAttributes, logger, navigation, rootLevel } = assemblyModel
     if (!navigation) return accum
     const contextualLogger = logger ? { warn: logger.warn.bind(logger, configMdc) } : undefined
-    const { name: componentName, version, title } = componentVersion
+    const { name: componentName, version } = componentVersion
     const asciidocConfig = getAsciiDocConfigWithAsciidoctorReducerExtension(componentVersion, reducerExtension)
     let sourceHighlighter
     if ('source-highlighter' in assemblyAttributes) {
@@ -83,10 +83,9 @@ function produceAssemblyFiles (
     } else if (!(assemblyModel.filetype === 'pdf' && assemblyModel.linkReferenceStyle === 'relative')) {
       assemblyModel.linkReferenceStyle = 'absolute'
     }
-    const outlineRoot = { content: title }
-    const startPage = resolveStartPage(contentCatalog, componentVersion, assemblyModel.insertStartPage, outlineRoot)
+    const [startPage, outlineRoot] = resolveStartPage(contentCatalog, componentVersion, assemblyModel.insertStartPage)
     const mutableAttributes = identifyMutableAttributes(loadAsciiDoc, contentCatalog, startPage, mergedAsciiDocConfig)
-    prepareOutlines(navigation, outlineRoot, rootLevel).reduce((any, outline) => {
+    prepareOutlines(navigation, outlineRoot, rootLevel).forEach((outline) => {
       const assemblyFile = produceAssemblyFile(
         loadAsciiDoc,
         contentCatalog,
@@ -97,15 +96,15 @@ function produceAssemblyFiles (
         mutableAttributes,
         assemblyModel
       )
-      if (!assemblyFile) return any
+      if (!assemblyFile) return
       // NOTE restore source highlighter for conversion if defined in Assembler config
       if (sourceHighlighter !== undefined) {
         assemblyFile.asciidoc.attributes['source-highlighter'] = sourceHighlighter
       } else if (assemblyModel.filetype !== 'html') {
         delete assemblyFile.asciidoc.attributes['source-highlighter']
       }
-      return !!accum.push(assemblyFile)
-    }, false)
+      accum.push(assemblyFile)
+    })
     return accum
   }, [])
 }
@@ -129,53 +128,67 @@ function includedInNav (items, url) {
   return items.find((it) => it.url === url || includedInNav(it.items || [], url))
 }
 
-function resolveStartPage (contentCatalog, componentVersion, insertStartPage, outlineRoot) {
-  const { name: componentName, version } = componentVersion
-  const startPage =
+function resolveStartPage (contentCatalog, componentVersion, insertStartPage) {
+  const { name: componentName, version, title } = componentVersion
+  const outlineRoot = { content: title }
+  let startPage =
     'startPage' in componentVersion
       ? componentVersion.startPage
       : contentCatalog.resolvePage('index.adoc', { component: componentName, version })
   if (startPage && startPage.src.component === componentName && startPage.src.version === version) {
-    if (insertStartPage) {
-      const navtitle = startPage.asciidoc?.navtitle || outlineRoot.content
-      Object.assign(outlineRoot, { navtitle, url: startPage.pub.url, urlType: 'internal', roles: ['page'] })
-    }
-    return startPage
+    const navtitle = startPage.asciidoc?.navtitle ?? outlineRoot.content
+    Object.defineProperty(outlineRoot, 'startPageEntry', {
+      value: { navtitle, url: startPage.pub.url, urlType: 'internal', roles: ['page'] },
+    })
+    if (insertStartPage) Object.defineProperty(outlineRoot.startPageEntry, 'insert', { value: true })
+  } else {
+    startPage = contentCatalog.createFile({
+      src: {
+        component: componentName,
+        version,
+        componentVersion,
+        module: 'ROOT',
+        family: 'page',
+        relative: 'index.adoc',
+        origin: componentVersion.origins?.values().next().value,
+      },
+    })
   }
-  return contentCatalog.createFile({
-    src: {
-      component: componentName,
-      version,
-      componentVersion,
-      module: 'ROOT',
-      family: 'page',
-      relative: 'index.adoc',
-      origin: componentVersion.origins?.values().next().value,
-    },
-  })
+  return [startPage, outlineRoot]
 }
 
 function prepareOutlines (navigation, rootEntry, rootLevel) {
-  const singleEntry = navigation.length === 1
+  const startPageEntry = rootEntry.startPageEntry
+  const singleListWithTitle = navigation.length === 1 && 'content' in navigation[0] ? navigation[0] : undefined
+  if (singleListWithTitle) {
+    const { content, url, urlType } = singleListWithTitle
+    if (urlType === 'internal') {
+      if (startPageEntry && url === startPageEntry.url) {
+        if (!startPageEntry.insert) Object.defineProperty(startPageEntry, 'insert', { value: true })
+        //if (!(content === startPageEntry.content || content === startPageEntry.navtitle)) {
+        //  startPageEntry.content = content
+        //}
+        startPageEntry.roles = singleListWithTitle.roles
+        navigation = [{ items: singleListWithTitle.items }]
+      }
+    } else if (content === rootEntry.content) {
+      delete Object.assign(rootEntry, singleListWithTitle).items
+      navigation = [{ items: singleListWithTitle.items }]
+    }
+  }
   const items = navigation.reduce((accum, it) => {
-    if (!it.content || (singleEntry && it.url ? it.url === rootEntry.url : it.content === rootEntry.content)) {
-      it.items && accum.push(...it.items)
-    } else {
+    if ('content' in it) {
       accum.push(it)
+    } else if (it.items) {
+      accum.push(...it.items)
     }
     return accum
   }, [])
-  if (rootLevel === 0) {
-    if (rootEntry.url && includedInNav(items, rootEntry.url)) {
-      for (const p of ['roles', 'url', 'urlType']) delete rootEntry[p]
-    }
-    return [Object.assign(rootEntry, { index: true, items })]
-  }
-  if (rootEntry.url && !includedInNav(items, rootEntry.url)) {
-    rootEntry.content = singleEntry && rootEntry.url === navigation[0].url ? navigation[0].content : rootEntry.navtitle
-    items.unshift(rootEntry)
+  if (startPageEntry?.insert && !includedInNav(items, startPageEntry.url)) {
+    Object.assign(rootEntry, startPageEntry)
+    if (rootLevel !== 0) items.unshift(Object.assign(rootEntry, { content: rootEntry.navtitle }))
   }
-  return items
+  return rootLevel === 0 ? [Object.assign(rootEntry, { items })] : items
 }
 
 function extractUrlPath (url) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/assembler",
-  "version": "1.0.0-rc.11",
+  "version": "1.0.0-rc.12",
   "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)",
@@ -39,12 +39,12 @@
     "@antora/expand-path-helper": "~3.0",
     "@antora/run-command-helper": "~1.1",
     "@asciidoctor/reducer": "~1.1",
-    "js-yaml": "~5.3"
+    "js-yaml": "~5.4"
   },
   "devDependencies": {
-    "@antora/asciidoc-loader": "3.2.0-rc.3",
-    "@antora/navigation-builder": "3.2.0-rc.3",
-    "@antora/site-publisher": "3.2.0-rc.3"
+    "@antora/asciidoc-loader": "~3.2",
+    "@antora/navigation-builder": "~3.2",
+    "@antora/site-publisher": "~3.2"
   },
   "engines": {
     "node": ">=20.0.0"