@antora/content-classifier 3.1.1 → 3.2.0-alpha.1

package/lib/classify-content.js

@@ -21,10 +21,9 @@ function classifyContent (playbook, aggregate, siteAsciiDocConfig = {}) {
   const contentCatalog = new ContentCatalog(playbook)
   aggregate
     .reduce((accum, componentVersionData) => {
-      const { name, version } = componentVersionData
-      // drop startPage to defer registration of start page
       // drop files since they aren't needed to register component version
-      const { files, startPage, ...descriptor } = Object.assign({}, componentVersionData, {
+      // drop startPage to defer registration of start page
+      const { name, version, files, startPage, ...descriptor } = Object.assign({}, componentVersionData, {
         asciidoc: resolveAsciiDocConfig(siteAsciiDocConfig, componentVersionData),
       })
       return new Map(accum).set(
@@ -36,7 +35,7 @@ function classifyContent (playbook, aggregate, siteAsciiDocConfig = {}) {
       const { name, version } = componentVersion
       const { files, nav, startPage } = componentVersionData
       componentVersionData.files = undefined // clean up memory
-      files.forEach((file) => allocateSrc(file, name, version, nav) && contentCatalog.addFile(file))
+      files.forEach((file) => allocateSrc(file, name, version, nav) && contentCatalog.addFile(file, componentVersion))
       contentCatalog.registerComponentVersionStartPage(name, componentVersion, startPage)
     })
   contentCatalog.registerSiteStartPage(playbook.site.startPage)

package/lib/content-catalog.js

@@ -23,17 +23,17 @@ class ContentCatalog {
     const urls = playbook.urls || {}
     this.htmlUrlExtensionStyle = urls.htmlExtensionStyle || 'default'
     this.urlRedirectFacility = urls.redirectFacility || 'static'
-    this.latestVersionUrlSegment = urls.latestVersionSegment
-    this.latestPrereleaseVersionUrlSegment = urls.latestPrereleaseVersionSegment
-    if (this.latestVersionUrlSegment == null && this.latestPrereleaseVersionUrlSegment == null) {
-      this.latestVersionUrlSegmentStrategy = undefined
+    this.latestVersionSegment = urls.latestVersionSegment
+    this.latestPrereleaseVersionSegment = urls.latestPrereleaseVersionSegment
+    if (this.latestVersionSegment == null && this.latestPrereleaseVersionSegment == null) {
+      this.latestVersionSegmentStrategy = undefined
     } else {
-      this.latestVersionUrlSegmentStrategy = urls.latestVersionSegmentStrategy || 'replace'
-      if (this.latestVersionUrlSegmentStrategy === 'redirect:from') {
-        if (!this.latestVersionUrlSegment) this.latestVersionUrlSegment = undefined
-        if (!this.latestPrereleaseVersionUrlSegment) {
-          this.latestPrereleaseVersionUrlSegment = undefined
-          if (!this.latestVersionUrlSegment) this.latestVersionUrlSegmentStrategy = undefined
+      this.latestVersionSegmentStrategy = urls.latestVersionSegmentStrategy || 'replace'
+      if (this.latestVersionSegmentStrategy === 'redirect:from') {
+        if (!this.latestVersionSegment) this.latestVersionSegment = undefined
+        if (!this.latestPrereleaseVersionSegment) {
+          this.latestPrereleaseVersionSegment = undefined
+          if (!this.latestVersionSegment) this.latestVersionSegmentStrategy = undefined
         }
       }
     }
@@ -54,10 +54,13 @@ class ContentCatalog {
    * component version. A true value is a special case to tell this method to register the default start page and is
    * intended for testing.
    * @param {String} [descriptor.title=name] - The title for this component version.
+   *
+   * @returns {Object} The constructed component version object.
    */
   registerComponentVersion (name, version, descriptor = {}) {
-    const { asciidoc, displayVersion, prerelease, startPage: startPageSpec, title } = descriptor
+    const { asciidoc, displayVersion, prerelease, startPage: startPageSpec, title, versionSegment } = descriptor
     const componentVersion = { displayVersion: displayVersion || version || 'default', title: title || name, version }
+    if (versionSegment != null) componentVersion.versionSegment = versionSegment
     Object.defineProperty(componentVersion, 'name', { value: name, enumerable: true })
     if (prerelease) {
       componentVersion.prerelease = prerelease
@@ -125,14 +128,15 @@ class ContentCatalog {
       )
     }
     if (startPageSpec) {
+      // @deprecated use separate call to register start page for component version
       this.registerComponentVersionStartPage(name, componentVersion, startPageSpec === true ? undefined : startPageSpec)
     }
     return componentVersion
   }
 
-  addFile (file) {
+  addFile (file, componentVersion) {
     const src = file.src
-    let family = src.family
+    let { component, version, family } = src
     let filesForFamily = this[$files].get(family)
     if (!filesForFamily) this[$files].set(family, (filesForFamily = new Map()))
     const key = generateKey(src)
@@ -144,7 +148,7 @@ class ContentCatalog {
           .map((it, idx) => `${idx + 1}: ${getFileLocation(it)}`)
           .join(LOG_WRAP)
         if (family === 'nav') {
-          throw new Error(`Duplicate nav in ${src.version}@${src.component}: ${file.path}${LOG_WRAP}${details}`)
+          throw new Error(`Duplicate nav in ${version}@${component}: ${file.path}${LOG_WRAP}${details}`)
         } else {
           throw new Error(`Duplicate ${family}: ${generateResourceSpec(src)}${LOG_WRAP}${details}`)
         }
@@ -160,16 +164,18 @@ class ContentCatalog {
       file = new File(file)
     }
     if (family === 'alias') {
-      src.mediaType = 'text/asciidoc'
       file.mediaType = 'text/html'
       // NOTE: an alias masquerades as the target file
       family = file.rel.src.family
-      // QUESTION: should we preserve the mediaType property on file if already defined?
+      // NOTE: short circuit in case of splat alias (alias -> alias)
+      if (family === 'alias' && (file.pub || {}).splat) return filesForFamily.set(key, file) && file
+      src.mediaType = 'text/asciidoc'
     } else if (!(file.mediaType = src.mediaType) && !('mediaType' in src)) {
+      // QUESTION: should we preserve the mediaType property on file if already defined?
       file.mediaType = src.mediaType = resolveMimeType(src.extname) || (family === 'page' ? 'text/asciidoc' : undefined)
     }
     let publishable
-    let versionSegment
+    let activeVersionSegment
     if (file.out) {
       publishable = true
     } else if ('out' in file) {
@@ -179,15 +185,18 @@ class ContentCatalog {
       ('/' + src.relative).indexOf('/_') < 0
     ) {
       publishable = true
-      versionSegment = computeVersionSegment.call(this, src.component, src.version)
-      file.out = computeOut(src, family, versionSegment, this.htmlUrlExtensionStyle)
+      if (componentVersion == null) componentVersion = this.getComponentVersion(component, version) || { version }
+      activeVersionSegment = computeVersionSegment.call(this, componentVersion)
+      file.out = computeOut(src, family, activeVersionSegment, this.htmlUrlExtensionStyle)
     }
     if (!file.pub && (publishable || family === 'nav')) {
-      if (versionSegment == null) versionSegment = computeVersionSegment.call(this, src.component, src.version)
-      file.pub = computePub(src, file.out, family, versionSegment, this.htmlUrlExtensionStyle)
+      if (activeVersionSegment == null) {
+        if (componentVersion == null) componentVersion = this.getComponentVersion(component, version) || { version }
+        activeVersionSegment = computeVersionSegment.call(this, componentVersion)
+      }
+      file.pub = computePub(src, file.out, family, activeVersionSegment, this.htmlUrlExtensionStyle)
     }
-    filesForFamily.set(key, file)
-    return file
+    return filesForFamily.set(key, file) && file
   }
 
   removeFile (file) {
@@ -269,34 +278,36 @@ class ContentCatalog {
   }
 
   registerComponentVersionStartPage (name, componentVersion, startPageSpec = undefined) {
+    const component = name
     let version = componentVersion.version
     if (version == null) {
       // QUESTION: should we warn or throw error if component version cannot be found?
-      if (!(componentVersion = this.getComponentVersion(name, componentVersion))) return
+      if (!(componentVersion = this.getComponentVersion(component, componentVersion))) return
       version = componentVersion.version
     }
+    const activeVersionSegment = computeVersionSegment.call(this, componentVersion)
     let startPage
     let startPageSrc
-    const indexPageId = Object.assign({}, ROOT_INDEX_PAGE_ID, { component: name, version })
+    const indexPageId = Object.assign({}, ROOT_INDEX_PAGE_ID, { component, version })
     if (startPageSpec) {
       if (
         (startPage = this.resolvePage(startPageSpec, indexPageId)) &&
-        (startPageSrc = startPage.src).component === name &&
+        (startPageSrc = startPage.src).component === component &&
         startPageSrc.version === version
       ) {
         if (!this.getById(indexPageId)) {
-          const indexAliasId = Object.assign({}, ROOT_INDEX_ALIAS_ID, { component: name, version })
+          const indexAliasId = Object.assign({}, ROOT_INDEX_ALIAS_ID, { component, version })
           const indexAlias = this.getById(indexAliasId)
           indexAlias
             ? indexAlias.synthetic && Object.assign(indexAlias, { rel: startPage })
-            : this.addFile({ src: indexAliasId, rel: startPage, synthetic: true })
+            : this.addFile({ src: indexAliasId, rel: startPage, synthetic: true }, componentVersion)
         }
       } else {
         // TODO pass componentVersion as logObject
         logger.warn(
           'Start page specified for %s@%s %s: %s',
           version,
-          name,
+          component,
           startPage === false ? 'has invalid syntax' : 'not found',
           startPageSpec
         )
@@ -309,23 +320,29 @@ class ContentCatalog {
       componentVersion.url = startPage.pub.url
     } else {
       // QUESTION: should we warn if the default start page cannot be found?
-      const versionSegment = computeVersionSegment.call(this, name, version)
       componentVersion.url = computePub(
         (startPageSrc = prepareSrc(Object.assign({}, indexPageId, { family: 'page' }))),
-        computeOut(startPageSrc, startPageSrc.family, versionSegment, this.htmlUrlExtensionStyle),
+        computeOut(startPageSrc, startPageSrc.family, activeVersionSegment, this.htmlUrlExtensionStyle),
         startPageSrc.family,
-        versionSegment,
+        activeVersionSegment,
         this.htmlUrlExtensionStyle
       ).url
     }
 
-    const symbolicVersionAlias = createSymbolicVersionAlias(
-      name,
-      version,
-      computeVersionSegment.call(this, name, version, 'alias'),
-      this.latestVersionUrlSegmentStrategy
+    Object.defineProperty(
+      componentVersion,
+      'activeVersionSegment',
+      activeVersionSegment === version
+        ? {
+            configurable: true,
+            get () {
+              return this.version
+            },
+          }
+        : { configurable: true, value: activeVersionSegment }
     )
-    if (symbolicVersionAlias) this.addFile(symbolicVersionAlias)
+
+    addSymbolicVersionAlias.call(this, componentVersion)
   }
 
   registerSiteStartPage (startPageSpec) {
@@ -335,7 +352,8 @@ class ContentCatalog {
       if (this.getById(ROOT_INDEX_PAGE_ID)) return
       const indexAlias = this.getById(ROOT_INDEX_ALIAS_ID)
       if (indexAlias) return indexAlias.synthetic ? Object.assign(indexAlias, { rel }) : undefined
-      return this.addFile({ src: Object.assign({}, ROOT_INDEX_ALIAS_ID), rel, synthetic: true })
+      const src = Object.assign({}, ROOT_INDEX_ALIAS_ID)
+      return this.addFile({ src, rel, synthetic: true }, { version: src.version })
     } else if (rel === false) {
       logger.warn('Start page specified for site has invalid syntax: %s', startPageSpec)
     } else if (startPageSpec.lastIndexOf(':') > startPageSpec.indexOf(':')) {
@@ -353,9 +371,14 @@ class ContentCatalog {
     // QUESTION should we throw an error if alias is invalid?
     if (!src || (inferredSpec && src.relative === '.adoc')) return
     const component = this.getComponent(src.component)
+    let componentVersion
     if (component) {
       // NOTE version is not set when alias specifies a component, but not a version
-      if (src.version == null) src.version = component.latest.version
+      if (src.version == null) {
+        src.version = (componentVersion = component.latest).version
+      } else {
+        componentVersion = this.getComponentVersion(component, src.version)
+      }
       const existingPage = this.getById(src)
       if (existingPage) {
         throw new Error(
@@ -380,12 +403,34 @@ class ContentCatalog {
       )
     }
     // NOTE the redirect producer will populate contents when the redirect facility is 'static'
-    const alias = this.addFile({ src, rel: target })
+    const alias = this.addFile({ src, rel: target }, componentVersion)
     // NOTE record the first alias this target claims as the preferred one
     if (!target.rel) target.rel = alias
     return alias
   }
 
+  /**
+   * Adds a splat (directory) alias from the specified version segment in one component to the specified
+   * version segment in the same or different component.
+   *
+   * @returns {File} The virtual file that represents the splat alias.
+   */
+  addSplatAlias (from, to) {
+    if (!from.versionSegment) throw new Error('cannot map splat alias from empty version segment')
+    const family = 'alias'
+    const baseSrc = { module: 'ROOT', family, relative: '', basename: '', stem: '', extname: '' }
+    const basePub = { splat: true }
+    const { component: fromComponent = to.component, versionSegment: fromVersionSegment } = from
+    const fromSrc = Object.assign({ component: fromComponent, version: fromVersionSegment }, baseSrc)
+    const fromPub = Object.assign(computePub(fromSrc, computeOut(fromSrc, family, fromVersionSegment), family), basePub)
+    const { component: toComponent, version: toVersion } = to
+    const toVersionSegment =
+      to.versionSegment ?? this.getComponentVersion(toComponent, toVersion)?.activeVersionSegment ?? toVersion
+    const toSrc = Object.assign({ component: toComponent, version: toVersion ?? toVersionSegment }, baseSrc)
+    const toPub = Object.assign(computePub(toSrc, computeOut(toSrc, family, toVersionSegment), family), basePub)
+    return this.addFile({ pub: fromPub, src: fromSrc, rel: { pub: toPub, src: toSrc } })
+  }
+
   /**
    * Attempts to resolve a string contextual page ID spec to a file in the catalog.
    *
@@ -400,7 +445,7 @@ class ContentCatalog {
    * @param {ContentCatalog} catalog - The content catalog in which to resolve the page file.
    * @param {Object} [ctx={}] - The context to use to qualified the contextual page ID.
    *
-   * @return {File} The virtual file to which the contextual page ID spec refers, or undefined if the
+   * @returns {File} The virtual file to which the contextual page ID spec refers, or undefined if the
    * file cannot be resolved.
    */
   resolvePage (spec, context = {}) {
@@ -473,7 +518,7 @@ function prepareSrc (src) {
   return update ? Object.assign(src, { basename, extname, stem }) : src
 }
 
-function computeOut (src, family, version, htmlUrlExtensionStyle) {
+function computeOut (src, family, versionSegment, htmlUrlExtensionStyle) {
   let { component, module: module_, basename, extname, relative, stem } = src
   if (component === 'ROOT') component = ''
   if (module_ === 'ROOT') module_ = ''
@@ -493,7 +538,7 @@ function computeOut (src, family, version, htmlUrlExtensionStyle) {
     familyPathSegment = '_attachments'
   }
 
-  const modulePath = path.join(component, version, module_)
+  const modulePath = path.join(component, versionSegment, module_)
   const dirname = path.join(modulePath, familyPathSegment, path.dirname(relative), indexifyPathSegment)
   const path_ = path.join(dirname, basename)
   const moduleRootPath = path.relative(dirname, modulePath) || '.'
@@ -502,13 +547,13 @@ function computeOut (src, family, version, htmlUrlExtensionStyle) {
   return { dirname, basename, path: path_, moduleRootPath, rootPath }
 }
 
-function computePub (src, out, family, version, htmlUrlExtensionStyle) {
+function computePub (src, out, family, versionSegment, htmlUrlExtensionStyle) {
   const pub = {}
   let url
   if (family === 'nav') {
     const component = src.component || 'ROOT'
     const urlSegments = component === 'ROOT' ? [] : [component]
-    if (version) urlSegments.push(version)
+    if (versionSegment) urlSegments.push(versionSegment)
     const module_ = src.module || 'ROOT'
     if (module_ !== 'ROOT') urlSegments.push(module_)
     if (urlSegments.length) urlSegments.push('')
@@ -527,71 +572,49 @@ function computePub (src, out, family, version, htmlUrlExtensionStyle) {
       urlSegments[lastUrlSegmentIdx] = ''
     }
     url = '/' + urlSegments.join('/')
-  } else {
-    if ((url = '/' + out.path) === '/.') url = '/'
-    if (family === 'alias' && !src.relative) pub.splat = true
+  } else if ((url = '/' + out.path) === '/.') {
+    url = '/'
   }
-
   pub.url = ~url.indexOf(' ') ? url.replace(SPACE_RX, '%20') : url
+  return out ? Object.assign(pub, { moduleRootPath: out.moduleRootPath, rootPath: out.rootPath }) : pub
+}
 
-  if (out) {
-    pub.moduleRootPath = out.moduleRootPath
-    pub.rootPath = out.rootPath
-  }
-
-  return pub
+function addSymbolicVersionAlias (componentVersion) {
+  const { name: component, version } = componentVersion
+  const originalVersionSegment = computeVersionSegment.call(this, componentVersion, 'original')
+  const symbolicVersionSegment = computeVersionSegment.call(this, componentVersion, 'alias')
+  if (symbolicVersionSegment === originalVersionSegment || symbolicVersionSegment == null) return
+  const originalVersionSrc = { component, version, versionSegment: originalVersionSegment }
+  const symbolicVersionSrc = { component, version, versionSegment: symbolicVersionSegment }
+  return this.latestVersionSegmentStrategy === 'redirect:to'
+    ? this.addSplatAlias(originalVersionSrc, symbolicVersionSrc)
+    : this.addSplatAlias(symbolicVersionSrc, originalVersionSrc)
 }
 
-function computeVersionSegment (name, version, mode) {
+function computeVersionSegment (componentVersion, mode) {
+  const version = componentVersion.version
   // special designation for master verson is @deprecated; special designation scheduled to be removed in Antora 4
-  if (mode === 'original') return !version || version === 'master' ? '' : version
-  const strategy = this.latestVersionUrlSegmentStrategy
-  if (!version || version === 'master') {
-    if (mode !== 'alias') return ''
+  const normalizedVersion = version && version !== 'master' ? version : ''
+  const { versionSegment = normalizedVersion } = componentVersion
+  if (mode === 'original') return versionSegment
+  const strategy = this.latestVersionSegmentStrategy
+  if (!versionSegment) {
+    if (!mode) return ''
     if (strategy === 'redirect:to') return
   }
-  if (strategy === 'redirect:to' || strategy === (mode === 'alias' ? 'redirect:from' : 'replace')) {
-    const component = this.getComponent(name)
-    const componentVersion = component && this.getComponentVersion(component, version)
-    if (componentVersion) {
-      const segment =
+  if (strategy === 'redirect:to' || strategy === (mode ? 'redirect:from' : 'replace')) {
+    let component
+    if ((component = 'name' in componentVersion && this.getComponent(componentVersion.name))) {
+      const latestSegment =
         componentVersion === component.latest
-          ? this.latestVersionUrlSegment
+          ? this.latestVersionSegment
           : componentVersion === component.latestPrerelease
-            ? this.latestPrereleaseVersionUrlSegment
+            ? this.latestPrereleaseVersionSegment
             : undefined
-      return segment == null ? version : segment
+      return latestSegment == null ? versionSegment : latestSegment
     }
   }
-  return version
-}
-
-function createSymbolicVersionAlias (component, version, symbolicVersionSegment, strategy) {
-  if (symbolicVersionSegment == null || symbolicVersionSegment === version) return
-  const family = 'alias'
-  const baseVersionAliasSrc = { component, module: 'ROOT', family, relative: '', basename: '', stem: '', extname: '' }
-  const symbolicVersionAliasSrc = Object.assign({}, baseVersionAliasSrc, { version: symbolicVersionSegment })
-  const symbolicVersionAlias = {
-    src: symbolicVersionAliasSrc,
-    pub: computePub(
-      symbolicVersionAliasSrc,
-      computeOut(symbolicVersionAliasSrc, family, symbolicVersionSegment),
-      family
-    ),
-  }
-  const originalVersionAliasSrc = Object.assign({}, baseVersionAliasSrc, { version })
-  const originalVersionSegment = computeVersionSegment(component, version, 'original')
-  const originalVersionAlias = {
-    src: originalVersionAliasSrc,
-    pub: computePub(
-      originalVersionAliasSrc,
-      computeOut(originalVersionAliasSrc, family, originalVersionSegment),
-      family
-    ),
-  }
-  return strategy === 'redirect:to'
-    ? Object.assign(originalVersionAlias, { out: undefined, rel: symbolicVersionAlias })
-    : Object.assign(symbolicVersionAlias, { out: undefined, rel: originalVersionAlias })
+  return versionSegment
 }
 
 function getFileLocation ({ path: path_, src: { abspath, origin } }) {

package/lib/util/resolve-resource.js

@@ -21,7 +21,7 @@ const parseResourceId = require('./parse-resource-id')
  *   The value "page" is used if not specified. This value is always used instead of family value provided by the ctx.
  * @param {Array<String>} [permittedFamilies=undefined] - An optional array of family names to allow.
  *
- * @return {File} The virtual file to which the contextual resource ID spec refers, undefined if
+ * @returns {File} The virtual file to which the contextual resource ID spec refers, undefined if
  * the file cannot be resolved, or false if the resource ID spec is invalid.
  */
 function resolveResource (spec, catalog, ctx = {}, defaultFamily = undefined, permittedFamilies = undefined) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/content-classifier",
-  "version": "3.1.1",
+  "version": "3.2.0-alpha.1",
   "description": "Organizes aggregated content into a virtual file catalog for use in an Antora documentation pipeline.",
   "license": "MPL-2.0",
   "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -27,8 +27,8 @@
     "#constants": "./lib/constants.js"
   },
   "dependencies": {
-    "@antora/asciidoc-loader": "3.1.1",
-    "@antora/logger": "3.1.1",
+    "@antora/asciidoc-loader": "3.2.0-alpha.1",
+    "@antora/logger": "3.2.0-alpha.1",
     "mime-types": "~2.1",
     "vinyl": "~2.2"
   },