@antora/content-classifier 3.0.0-beta.1 → 3.0.0-beta.5

package/lib/constants.js

@@ -1,6 +1,6 @@
 'use strict'
 
 module.exports = Object.freeze({
-  START_ALIAS_ID: Object.freeze({ component: '', version: '', module: '', family: 'alias', relative: 'index.adoc' }),
-  START_PAGE_ID: Object.freeze({ component: '', version: '', module: '', family: 'page', relative: 'index.adoc' }),
+  ROOT_INDEX_ALIAS_ID: { component: 'ROOT', version: '', module: 'ROOT', family: 'alias', relative: 'index.adoc' },
+  ROOT_INDEX_PAGE_ID: { component: 'ROOT', version: '', module: 'ROOT', family: 'page', relative: 'index.adoc' },
 })

package/lib/content-catalog.js

@@ -9,7 +9,7 @@ const { posix: path } = require('path')
 const resolveResource = require('./util/resolve-resource')
 const versionCompare = require('./util/version-compare-desc')
 
-const { START_ALIAS_ID, START_PAGE_ID } = require('./constants')
+const { ROOT_INDEX_ALIAS_ID, ROOT_INDEX_PAGE_ID } = require('./constants')
 const SPACE_RX = / /g
 
 const $components = Symbol('components')
@@ -249,7 +249,7 @@ class ContentCatalog {
 
   // TODO add `follow` argument to control whether alias is followed
   getSiteStartPage () {
-    return this.getById(START_PAGE_ID) || (this.getById(START_ALIAS_ID) || {}).rel
+    return this.getById(ROOT_INDEX_PAGE_ID) || (this.getById(ROOT_INDEX_ALIAS_ID) || {}).rel
   }
 
   registerComponentVersionStartPage (name, componentVersion, startPageSpec = undefined) {
@@ -261,15 +261,19 @@ class ContentCatalog {
     }
     let startPage
     let startPageSrc
-    const indexPageId = { component: name, version, module: 'ROOT', family: 'page', relative: 'index.adoc' }
+    const indexPageId = Object.assign({}, ROOT_INDEX_PAGE_ID, { component: name, version })
     if (startPageSpec) {
       if (
         (startPage = this.resolvePage(startPageSpec, indexPageId)) &&
         (startPageSrc = startPage.src).component === name &&
         startPageSrc.version === version
       ) {
-        if ((startPageSrc.module !== 'ROOT' || startPageSrc.relative !== 'index.adoc') && !this.getById(indexPageId)) {
-          this.addFile({ src: Object.assign({}, indexPageId, { family: 'alias' }), rel: startPage })
+        if (!this.getById(indexPageId)) {
+          const indexAliasId = Object.assign({}, ROOT_INDEX_ALIAS_ID, { component: name, version })
+          const indexAlias = this.getById(indexAliasId)
+          indexAlias
+            ? indexAlias.synthetic && Object.assign(indexAlias, { rel: startPage })
+            : this.addFile({ src: indexAliasId, rel: startPage, synthetic: true })
         }
       } else {
         // TODO pass componentVersion as logObject
@@ -312,7 +316,10 @@ class ContentCatalog {
     if (!startPageSpec) return
     const rel = this.resolvePage(startPageSpec)
     if (rel) {
-      return this.addFile({ src: Object.assign({}, START_ALIAS_ID), rel })
+      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 })
     } else if (rel === false) {
       logger.warn('Start page specified for site has invalid syntax: %s', startPageSpec)
     } else if (~startPageSpec.indexOf(':')) {
@@ -367,9 +374,10 @@ class ContentCatalog {
    *
    * Parses the specified contextual page ID spec into a page ID object, then attempts to lookup a
    * file with this page ID in the catalog. If a component is specified, but not a version, the
-   * latest version of the component stored in the catalog is used. If a file cannot be resolved,
-   * the function returns undefined. If the spec does not match the page ID syntax, this function
-   * throws an error.
+   * latest version of the component stored in the catalog is used. If a page cannot be resolved,
+   * the search is attempted again for an "alias". If neither a page or alias can be resolved, the
+   * function returns undefined. If the spec does not match the page ID syntax, this function throws
+   * an error.
    *
    * @param {String} spec - The contextual page ID spec (e.g., version@component:module:topic/page.adoc).
    * @param {ContentCatalog} catalog - The content catalog in which to resolve the page file.
@@ -450,6 +458,7 @@ function prepareSrc (src) {
 
 function computeOut (src, family, version, htmlUrlExtensionStyle) {
   let { component, module: module_, basename, extname, relative, stem } = src
+  if (component === 'ROOT') component = ''
   if (module_ === 'ROOT') module_ = ''
   let indexifyPathSegment = ''
   let familyPathSegment = ''
@@ -480,8 +489,11 @@ function computePub (src, out, family, version, htmlUrlExtensionStyle) {
   const pub = {}
   let url
   if (family === 'nav') {
-    const urlSegments = version ? [src.component, version] : [src.component]
-    if (src.module && src.module !== 'ROOT') urlSegments.push(src.module)
+    const component = src.component || 'ROOT'
+    const urlSegments = component === 'ROOT' ? [] : [component]
+    if (version) urlSegments.push(version)
+    const module_ = src.module || 'ROOT'
+    if (module_ !== 'ROOT') urlSegments.push(module_)
     // an artificial URL used for resolving page references in navigation model
     url = '/' + urlSegments.join('/') + '/'
     pub.moduleRootPath = '.'
@@ -559,15 +571,9 @@ function createSymbolicVersionAlias (component, version, symbolicVersionSegment,
       family
     ),
   }
-  if (strategy === 'redirect:to') {
-    originalVersionAlias.out = undefined
-    originalVersionAlias.rel = symbolicVersionAlias
-    return originalVersionAlias
-  } else {
-    symbolicVersionAlias.out = undefined
-    symbolicVersionAlias.rel = originalVersionAlias
-    return symbolicVersionAlias
-  }
+  return strategy === 'redirect:to'
+    ? Object.assign(originalVersionAlias, { out: undefined, rel: symbolicVersionAlias })
+    : Object.assign(symbolicVersionAlias, { out: undefined, rel: originalVersionAlias })
 }
 
 function getFileLocation ({ path: path_, src: { abspath, origin } }) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antora/content-classifier",
-  "version": "3.0.0-beta.1",
+  "version": "3.0.0-beta.5",
   "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)",
@@ -16,7 +16,7 @@
   },
   "main": "lib/index.js",
   "dependencies": {
-    "@antora/logger": "3.0.0-beta.1",
+    "@antora/logger": "3.0.0-beta.5",
     "mime-types": "~2.1",
     "vinyl": "~2.2"
   },
@@ -34,5 +34,5 @@
     "static site",
     "web publishing"
   ],
-  "gitHead": "7c5ef1ea93dd489af533c80a936c736013c41769"
+  "gitHead": "a13d03df41654d4deb78211a5a54953ce2a35fb8"
 }