27aa5d92ea
* cleanup FEATURE_NEXTJS * fixing some server tests * updating article a for server tests * update h2 to h4 map topic tests * data off on TOCs * updating dropdown article versions links * Update so markdown renders in intros * updating typo and all server tests are now passing * remove nextjs feature flag * head.js tests pass * updating article-version-picker * remove nextjs feature flag browser test * update header.js tests * fix page-titles.js test * fix deprecated-enterprise versions * adding early access * testing * getting childTocItem * fixing table of contents to show child toc items * updated to 2 because the sidebar article also has the same link * remove comment * updating pick * Update TocLandingContext.tsx * update package.json and change className to h4 for h2 * updating with mikes feedback * remove a.active test * React clean up: Delete unnecessary layouts/includes Part 2 (#20143) * Delete unnecessary layouts * setting back tests failing :( * update layouts * delete unnecessary includes * remove github-ae-release-notes and updating layouts * remove a.active test
92 lines
3.0 KiB
JavaScript
92 lines
3.0 KiB
JavaScript
import findPageInSiteTree from '../../lib/find-page-in-site-tree.js'
|
|
|
|
// This module adds either flatTocItems or nestedTocItems to the context object for
|
|
// product, categorie, and map topic TOCs that don't have other layouts specified.
|
|
// They are rendered by includes/generic-toc-flat.html or inclueds/generic-toc-nested.html.
|
|
export default async function genericToc(req, res, next) {
|
|
if (!req.context.page) return next()
|
|
if (req.context.currentLayoutName !== 'default') return next()
|
|
// This middleware can only run on product, category, and map topics.
|
|
if (req.context.page.documentType === 'homepage' || req.context.page.documentType === 'article')
|
|
return next()
|
|
|
|
// This one product TOC is weird.
|
|
const isOneOffProductToc = req.context.page.relativePath === 'github/index.md'
|
|
|
|
// There are different types of TOC depending on the document type.
|
|
const tocTypes = {
|
|
product: 'flat',
|
|
category: 'nested',
|
|
mapTopic: 'flat',
|
|
}
|
|
|
|
// Find the current TOC type based on the current document type.
|
|
const currentTocType = tocTypes[req.context.page.documentType]
|
|
|
|
// Find the part of the site tree that corresponds to the current path.
|
|
const treePage = findPageInSiteTree(
|
|
req.context.currentProductTree,
|
|
req.context.currentEnglishTree,
|
|
req.pagePath
|
|
)
|
|
|
|
// Do not include hidden child items on a TOC page unless it's an Early Access category page.
|
|
req.context.showHiddenTocItems =
|
|
req.context.page.documentType === 'category' &&
|
|
req.context.currentPath.includes('/early-access/')
|
|
|
|
// Conditionally run getTocItems() recursively.
|
|
let isRecursive
|
|
// Conditionally render intros.
|
|
let renderIntros
|
|
|
|
// Get an array of child links with intros and add it to the context object.
|
|
if (currentTocType === 'flat' && !isOneOffProductToc) {
|
|
isRecursive = false
|
|
renderIntros = true
|
|
req.context.genericTocFlat = await getTocItems(
|
|
treePage.childPages,
|
|
req.context,
|
|
isRecursive,
|
|
renderIntros
|
|
)
|
|
}
|
|
|
|
// Get an array of child map topics and their child articles and add it to the context object.
|
|
if (currentTocType === 'nested' || isOneOffProductToc) {
|
|
isRecursive = !isOneOffProductToc
|
|
renderIntros = false
|
|
req.context.genericTocNested = await getTocItems(
|
|
treePage.childPages,
|
|
req.context,
|
|
isRecursive,
|
|
renderIntros
|
|
)
|
|
}
|
|
|
|
return next()
|
|
}
|
|
|
|
async function getTocItems(pagesArray, context, isRecursive, renderIntros) {
|
|
return (
|
|
await Promise.all(
|
|
pagesArray.map(async (child) => {
|
|
if (child.page.hidden && !context.showHiddenTocItems) return
|
|
|
|
return {
|
|
title: child.renderedFullTitle,
|
|
fullPath: child.href,
|
|
// renderProp is the most expensive part of this function.
|
|
intro: renderIntros
|
|
? await child.page.renderProp('intro', context, { unwrap: true })
|
|
: null,
|
|
childTocItems:
|
|
isRecursive && child.childPages
|
|
? await getTocItems(child.childPages, context, isRecursive, renderIntros)
|
|
: null,
|
|
}
|
|
})
|
|
)
|
|
).filter(Boolean)
|
|
}
|