@docsector/docsector-reader 2.0.7 → 2.2.0

package/src/router/routes.js

@@ -1,4 +1,4 @@
-import { books } from 'virtual:docsector-books'
+import { pageEntries, versions } from 'virtual:docsector-books'
 import boot from 'pages/boot'
 
 const normalizeInternalLink = (linkTo) => {
@@ -31,114 +31,148 @@ const resolveInternalLinkBasePath = (linkTo) => {
   return normalizeRoutePath(withoutSubpage || '/')
 }
 
-const routeConfigByPath = new Map()
-for (const [bookId, book] of Object.entries(books || {})) {
-  const bookRoutes = book?.routes || {}
+const versionPrefixes = (versions || [])
+  .map(version => normalizeRoutePath(version?.routePrefix || ''))
+  .filter(prefix => prefix !== '/')
 
-  for (const [path, page] of Object.entries(bookRoutes)) {
-    const config = page?.config
-    if (config === null) {
-      continue
-    }
+const linkHasVersionPrefix = (linkTo) => {
+  const normalized = normalizeRoutePath(linkTo)
+  return versionPrefixes.some(prefix => normalized === prefix || normalized.startsWith(`${prefix}/`))
+}
 
-    const topPage = config?.book ?? config?.type ?? bookId ?? 'manual'
-    const routePath = normalizeRoutePath('/' + topPage + path)
+const normalizeVersionedInternalLink = (linkTo, versionPrefix = '') => {
+  const normalized = normalizeInternalLink(linkTo)
+  const prefix = normalizeRoutePath(versionPrefix)
 
-    routeConfigByPath.set(routePath, config || {})
+  if (prefix === '/' || linkHasVersionPrefix(normalized)) {
+    return normalized
   }
+
+  return normalizeRoutePath(`${prefix}${normalized}`)
+}
+
+const buildSourcePathBase = (entry, book, path) => {
+  return [entry?.sourceRoot, `${book}${path}`]
+    .filter(Boolean)
+    .map(segment => String(segment).replace(/^\/+|\/+$/g, ''))
+    .join('/')
+}
+
+const routeConfigByPath = new Map()
+for (const entry of pageEntries || []) {
+  const config = entry?.page?.config
+  if (config === null) {
+    continue
+  }
+
+  const topPage = config?.book ?? config?.type ?? entry?.book ?? 'manual'
+  const routePath = normalizeRoutePath(`${entry?.versionPrefix || ''}/${topPage}${entry?.pagePath || ''}`)
+
+  routeConfigByPath.set(routePath, config || {})
 }
 
 const pagesRoutes = []
-for (const [bookId, book] of Object.entries(books || {})) {
-  const bookRoutes = book?.routes || {}
-
-  for (const [path, page] of Object.entries(bookRoutes)) {
-    const rawConfig = page.config
-    if (rawConfig === null) {
-      continue
-    }
-
-    const config = rawConfig || {}
-    const menu = (typeof config.menu === 'object' && config.menu !== null) ? config.menu : {}
-    const subpages = {
-      showcase: config?.subpages?.showcase === true,
-      vs: config?.subpages?.vs === true
-    }
-
-    const topPage = config.book ?? config.type ?? bookId ?? 'manual'
-    const hasInternalLink = typeof config?.link?.to === 'string' && config.link.to.trim().length > 0
-    const internalLinkTo = hasInternalLink ? normalizeInternalLink(config.link.to) : null
-    const linkedConfig = hasInternalLink
-      ? routeConfigByPath.get(resolveInternalLinkBasePath(config.link.to))
-      : null
-    const icon = config.icon ?? linkedConfig?.icon
-    const status = typeof config.status === 'string'
-      ? config.status
-      : (typeof linkedConfig?.status === 'string' ? linkedConfig.status : 'done')
-
-    // @ Construct children
-    const children = hasInternalLink
-      ? [
-          {
-            path: '',
-            redirect: () => internalLinkTo
-          },
-          {
-            path: 'overview',
-            redirect: () => internalLinkTo
-          }
-        ]
-      : [
-          {
-            path: '',
-            redirect: (to) => `${to.path.replace(/\/$/, '')}/overview/`
-          },
-          {
-            path: 'overview',
-            component: () => import('components/DSubpage.vue'),
-            meta: {
-              status
-            }
-          }
-        ]
+for (const entry of pageEntries || []) {
+  const path = entry?.pagePath || ''
+  const page = entry?.page || {}
+  const rawConfig = page.config
+  if (rawConfig === null) {
+    continue
+  }
 
-    if (!hasInternalLink && subpages.showcase === true) {
-      children.push({
-        path: 'showcase',
-        component: () => import('components/DSubpage.vue'),
-        meta: {
-          status
+  const config = rawConfig || {}
+  const menu = (typeof config.menu === 'object' && config.menu !== null) ? config.menu : {}
+  const subpages = {
+    showcase: config?.subpages?.showcase === true,
+    vs: config?.subpages?.vs === true
+  }
+
+  const topPage = config.book ?? config.type ?? entry?.book ?? 'manual'
+  const routePath = normalizeRoutePath(`${entry?.versionPrefix || ''}/${topPage}${path}`)
+  const hasInternalLink = typeof config?.link?.to === 'string' && config.link.to.trim().length > 0
+  const internalLinkTo = hasInternalLink ? normalizeVersionedInternalLink(config.link.to, entry?.versionPrefix || '') : null
+  const linkedConfig = hasInternalLink
+    ? routeConfigByPath.get(resolveInternalLinkBasePath(internalLinkTo))
+    : null
+  const icon = config.icon ?? linkedConfig?.icon
+  const status = typeof config.status === 'string'
+    ? config.status
+    : (typeof linkedConfig?.status === 'string' ? linkedConfig.status : 'done')
+  const pageVersion = config.version ?? config.pageVersion ?? config.since ?? null
+
+  // @ Construct children
+  const children = hasInternalLink
+    ? [
+        {
+          path: '',
+          redirect: () => internalLinkTo
+        },
+        {
+          path: 'overview',
+          redirect: () => internalLinkTo
         }
-      })
-    }
-    if (!hasInternalLink && subpages.vs === true) {
-      children.push({
-        path: 'vs',
-        component: () => import('components/DSubpage.vue'),
-        meta: {
-          status
+      ]
+    : [
+        {
+          path: '',
+          redirect: (to) => `${to.path.replace(/\/$/, '')}/overview/`
+        },
+        {
+          path: 'overview',
+          component: () => import('components/DSubpage.vue'),
+          meta: {
+            status
+          }
         }
-      })
-    }
+      ]
 
-    // @ Push route to pageRoutes
-    pagesRoutes.push({
-      path: '/' + topPage + path,
-      component: () => import('layouts/DefaultLayout.vue'),
+  if (!hasInternalLink && subpages.showcase === true) {
+    children.push({
+      path: 'showcase',
+      component: () => import('components/DSubpage.vue'),
       meta: {
-        ...config,
-        icon,
-        status,
-        menu,
-        subpages,
-        data: page.data,
-        book: topPage,
-        // legacy compatibility
-        type: topPage
-      },
-      children
+        status
+      }
     })
   }
+  if (!hasInternalLink && subpages.vs === true) {
+    children.push({
+      path: 'vs',
+      component: () => import('components/DSubpage.vue'),
+      meta: {
+        status
+      }
+    })
+  }
+
+  // @ Push route to pageRoutes
+  pagesRoutes.push({
+    path: routePath,
+    component: () => import('layouts/DefaultLayout.vue'),
+    meta: {
+      ...config,
+      icon,
+      status,
+      pageVersion,
+      menu,
+      subpages,
+      data: page.data,
+      book: topPage,
+      // legacy compatibility
+      type: topPage,
+      version: entry.version,
+      versionLabel: entry.versionLabel,
+      versionCurrent: entry.versionCurrent,
+      versionPrefix: entry.versionPrefix || '',
+      sourceRoot: entry.sourceRoot || '',
+      sourcePathBase: buildSourcePathBase(entry, topPage, path),
+      pagePath: path,
+      i18nSegments: entry.i18nSegments || [topPage, ...String(path).replace(/^\//, '').split('/').filter(Boolean)],
+      menuGroupPath: String(path).replace(/^\//, '').split('/').filter(Boolean)[0] || '',
+      unversionedPath: entry.unversionedPath || `/${topPage}${path}`
+    },
+    children
+  })
 }
 
 const routes = [

package/src/store/App.js

@@ -5,7 +5,7 @@ export default {
   getters: {},
   mutations: {},
   actions: {
-    configureLanguage ({ commit, state }, routeMatched) {
+    configureLanguage ({ commit }, routeMatched) {
       // Reset stale nodes before configuring new language state
       commit('page/resetAnchor', null, { root: true })
       commit('page/resetAnchors', null, { root: true })
@@ -14,6 +14,7 @@ export default {
       // Route
       const firstRoutePath = routeMatched[0]?.path || ''
       const secondRoutePath = routeMatched[1]?.path || ''
+      const routeMeta = routeMatched[0]?.meta || {}
 
       const base = firstRoutePath === '/' ? 'home' : firstRoutePath.substr(1)
       let relative = secondRoutePath.substr(firstRoutePath.length)
@@ -31,12 +32,21 @@ export default {
       commit('page/setAbsolute', base + relative, { root: true })
 
       if (firstRoutePath) {
-        const i18nBase = base.replace(/_$/, '').replace(/\//g, '.')
-        const i18nRelative = relative.replace(/_$/, '').replace(/\//g, '.')
+        const fallbackBaseSegments = base
+          .replace(/_$/, '')
+          .split('/')
+          .filter(Boolean)
+        const i18nBase = Array.isArray(routeMeta.i18nSegments) && routeMeta.i18nSegments.length > 0
+          ? routeMeta.i18nSegments
+          : fallbackBaseSegments
+        const i18nRelative = relative
+          .replace(/_$/, '')
+          .split('/')
+          .filter(Boolean)
 
         commit('i18n/setBase', i18nBase, { root: true })
-        commit('i18n/setRelative', i18nRelative.substr(1), { root: true })
-        commit('i18n/setAbsolute', i18nBase + i18nRelative, { root: true })
+        commit('i18n/setRelative', i18nRelative, { root: true })
+        commit('i18n/setAbsolute', [...i18nBase, ...i18nRelative], { root: true })
       } else {
         commit('i18n/setBase', '', { root: true })
         commit('i18n/setRelative', '', { root: true })