@janga/norna 0.7.23 → 0.7.25

package/src/lib/siteNavigation.ts

@@ -1,5 +1,12 @@
 import type { HeadingNavigation, SectionNavigation } from './sectionContent';
 import type { SiteNode, SitePage } from './sitePages';
+import {
+	flattenSiteNavigationTree as flattenSiteNavigationTreeShared,
+	getDirectChildPages as getDirectChildPagesShared,
+	getFirstPageInNavigationNode as getFirstPageInNavigationNodeShared,
+	getListedSiteNavigationTree as getListedSiteNavigationTreeShared,
+	getSequentialPageNavigation as getSequentialPageNavigationShared,
+} from '../../scripts/lib/site-navigation-tree.mjs';
 
 export type SiteNavigationEntry = {
 	node: SiteNode;
@@ -11,57 +18,29 @@ export type SiteNavigationNode = SiteNavigationEntry & {
 	children: SiteNavigationNode[];
 };
 
-export const getSiteNavigationTree = (entries: SiteNavigationEntry[]) => {
-	const nodes = new Map<string, SiteNavigationNode>();
-	const roots: SiteNavigationNode[] = [];
-
-	for (const entry of entries) {
-		nodes.set(entry.node.pagePath, { ...entry, children: [] });
-	}
-
-	for (const entry of entries) {
-		const node = nodes.get(entry.node.pagePath);
-		if (!node) continue;
-
-		if (entry.node.isHome || entry.node.parentPagePath === null) {
-			roots.push(node);
-			continue;
-		}
-
-		const parent = nodes.get(entry.node.parentPagePath);
-		if (!parent) {
-			throw new Error(`Site node "${entry.node.pagePath}" has no parent node "${entry.node.parentPagePath}".`);
-		}
-
-		parent.children.push(node);
-	}
-
-	return roots;
-};
-
-export const getListedSiteNavigationTree = (entries: SiteNavigationEntry[]) => {
-	const filterListed = (nodes: SiteNavigationNode[]): SiteNavigationNode[] => nodes.flatMap((node) => {
-		if (!node.node.isHome && !node.node.navigation.listed) return [];
-		const children = filterListed(node.children);
-		if (node.node.kind === 'category' && children.length === 0) return [];
-		return [{ ...node, children }];
-	});
-
-	return filterListed(getSiteNavigationTree(entries));
-};
-
-export const getFirstPageInNavigationNode = (node: SiteNavigationNode): SitePage | null => {
-	if (node.node.kind === 'page') return node.node;
-
-	for (const child of node.children) {
-		const page = getFirstPageInNavigationNode(child);
-		if (page) return page;
+export const getListedSiteNavigationTree = (entries: SiteNavigationEntry[]) => (
+	getListedSiteNavigationTreeShared(entries) as SiteNavigationNode[]
+);
+
+export const getFirstPageInNavigationNode = (node: SiteNavigationNode): SitePage | null => (
+	getFirstPageInNavigationNodeShared(node) as SitePage | null
+);
+
+export const flattenSiteNavigationTree = (nodes: SiteNavigationNode[]): SiteNavigationNode[] => (
+	flattenSiteNavigationTreeShared(nodes) as SiteNavigationNode[]
+);
+
+export const getSequentialPageNavigation = (
+	nodes: SiteNavigationNode[],
+	currentPagePath: string,
+): { previous: SitePage | null; next: SitePage | null } => (
+	getSequentialPageNavigationShared(nodes, currentPagePath) as {
+		previous: SitePage | null;
+		next: SitePage | null;
 	}
+);
 
-	return null;
-};
-
-export const flattenSiteNavigationTree = (nodes: SiteNavigationNode[]): SiteNavigationNode[] => nodes.flatMap((node) => [
-	node,
-	...flattenSiteNavigationTree(node.children),
-]);
+export const getDirectChildPages = (
+	nodes: SiteNavigationNode[],
+	currentPagePath: string,
+): SitePage[] => getDirectChildPagesShared(nodes, currentPagePath) as SitePage[];

package/src/lib/sitePages.ts

@@ -36,6 +36,7 @@ export type SitePage = SiteNodeBase & {
 	markdown: string;
 	markdownDocument: Awaited<ReturnType<typeof parsePageMarkdown>>;
 	contentLabel: string;
+	contentPath: string;
 };
 
 export type SiteCategory = SiteNodeBase & {
@@ -86,20 +87,21 @@ const compareNumberPaths = (left: number[], right: number[]) => {
 const readPageMarkdownDocument = async (entry: SiteEntry) => {
 	const pageDirectory = getPageDirectory(entry);
 	const contentLabel = `${sitePagesLabel}/${pageDirectory}/content.md`;
-	const { body } = await readSiteFile(path.join(sitePagesDir, pageDirectory, 'content.md'), contentLabel);
+	const contentPath = path.join(sitePagesDir, pageDirectory, 'content.md');
+	const { body } = await readSiteFile(contentPath, contentLabel);
 	const markdownDocument = await parsePageMarkdown(body, { label: contentLabel });
 
 	if (markdownDocument.pageHeadings.length !== 1 || markdownDocument.regions[0]?.kind !== 'page-intro') {
 		throw new Error(`Page entry "${entry.id}" must contain exactly one Markdown H1 page title.`);
 	}
 
-	return { body, contentLabel, markdownDocument };
+	return { body, contentLabel, contentPath, markdownDocument };
 };
 
 const createSitePage = async (entry: SiteEntry): Promise<SitePage> => {
 	const isHome = isHomePageEntry(entry);
 	const pageMetadata = getPageMetadata(entry);
-	const { body, contentLabel, markdownDocument } = await readPageMarkdownDocument(entry);
+	const { body, contentLabel, contentPath, markdownDocument } = await readPageMarkdownDocument(entry);
 	const pageDirectory = pageMetadata.pageDirectory;
 	const pageId = pageMetadata.pageId;
 	const pagePath = pageMetadata.pagePath;
@@ -126,6 +128,7 @@ const createSitePage = async (entry: SiteEntry): Promise<SitePage> => {
 		pagePath,
 		parentPagePath: isHome ? null : pageMetadata.parentPagePath,
 		contentLabel,
+		contentPath,
 		markdown: body,
 		markdownDocument,
 		title: markdownDocument.pageTitle.title,

package/src/lib/sitePublicAssets.ts

@@ -4,6 +4,7 @@ import { sitePublicDir } from '../../scripts/lib/site-paths.mjs';
 import { browserIconAssetDefinitions } from '../../scripts/lib/public-asset-conventions.mjs';
 import projectConfig from '../../scripts/lib/project-config.mjs';
 export { getLogoAsset } from '../../scripts/lib/logo-assets.mjs';
+export { getSocialImageAsset } from '../../scripts/lib/social-image-assets.mjs';
 import { withBasePath } from './basePath';
 
 type IconLink = {

package/src/pages/404.astro

@@ -0,0 +1,110 @@
+---
+import { getCollection } from 'astro:content';
+import { resolveNavigationModel } from '../../scripts/lib/navigation-model.mjs';
+import { getTextWidthCssValue, resolveFrameColors, resolvePagePresentation } from '../../scripts/lib/presentation.mjs';
+import { projectConfig, resolveThemeVisualConfig } from '../../scripts/lib/project-config.mjs';
+import SiteBanners from '../components/SiteBanners.astro';
+import SiteNavigation from '../components/SiteNavigation.astro';
+import SiteSection from '../components/SiteSection.astro';
+import BaseLayout from '../layouts/BaseLayout.astro';
+import type { ResolvedSection } from '../lib/sectionContent';
+import { flattenSiteNavigationTree, getListedSiteNavigationTree } from '../lib/siteNavigation';
+import { getSiteModel, type SitePage } from '../lib/sitePages';
+import { getLogoAsset } from '../lib/sitePublicAssets';
+import { getToday, isVisibleToday } from '../lib/visibility';
+
+const siteDirectory = (process.env.NORNA_SITE_DIR ?? 'site').trim();
+const siteModel = await getSiteModel(await getCollection('site'));
+const { nodes: siteNodes, pages: sitePages } = siteModel;
+const homePage = sitePages.find((page) => page.isHome);
+if (!homePage) throw new Error('The required homepage is missing from the site page model.');
+
+const [siteTheme] = await getCollection('theme');
+if (!siteTheme) throw new Error('site/theme.yaml is required. Add a root theme before building the site.');
+const [sitewide] = await getCollection('sitewide');
+const sitewideData = sitewide?.data ?? {};
+const siteThemeData = siteTheme.data;
+const themeLabel = `${siteDirectory || 'site'}/${siteTheme.id}`;
+const visualTheme = resolveThemeVisualConfig(siteThemeData, themeLabel);
+const getPageContent = (page: SitePage) => page.markdownDocument.navigationHeadings.map((heading) => ({ ...heading }));
+const siteNavigation = siteNodes.map((node) => {
+	const headings = node.kind === 'page' ? getPageContent(node) : [];
+	return {
+		node,
+		headings,
+		sections: headings
+			.filter((heading) => heading.depth === 2)
+			.map(({ id, title }) => ({ id, title })),
+	};
+});
+const renderedNavigationEntries = flattenSiteNavigationTree(getListedSiteNavigationTree(siteNavigation));
+const navigationModel = resolveNavigationModel({
+	mode: projectConfig.navigation.mode,
+	nodes: renderedNavigationEntries.map(({ node, headings }) => ({
+		depth: Math.max(1, node.depth),
+		headings,
+		isHome: node.isHome,
+		kind: node.kind,
+		listed: node.navigation.listed,
+		pagePath: node.pagePath,
+	})),
+});
+const pagePresentation = resolvePagePresentation(siteThemeData, themeLabel, {
+	navigationMode: navigationModel.mode,
+});
+const pageTextWidth = getTextWidthCssValue(pagePresentation.typography.values.body.width);
+const frameColors = resolveFrameColors({ theme: siteThemeData, sourceLabel: themeLabel });
+const logoAsset = getLogoAsset();
+const logo = logoAsset
+	? {
+		src: logoAsset.href,
+		alt: homePage.title,
+		height: sitewideData.logo?.height,
+	}
+	: undefined;
+const today = getToday();
+const siteBanners = (sitewideData.banners ?? []).filter((banner) => isVisibleToday(banner.visible, today));
+const notFoundSection: ResolvedSection = {
+	id: null,
+	title: projectConfig.locale.labels.notFound,
+	titleHtml: projectConfig.locale.labels.notFound,
+	headingLevel: 1,
+	contentBlocks: [{
+		type: 'html',
+		html: `<p>${projectConfig.locale.labels.notFoundText}</p><p><a href="${projectConfig.site.basePath}">${projectConfig.locale.labels.returnHome}</a></p>`,
+	}],
+};
+const hasNavigationRailFrame = navigationModel.requestedMode === 'tree'
+	|| (
+		navigationModel.requestedMode === 'automatic'
+		&& (navigationModel.hasNestedPages || navigationModel.hasCategories)
+	);
+---
+
+<BaseLayout
+	title={projectConfig.locale.labels.notFound}
+	presentation={pagePresentation}
+	visualTheme={visualTheme}
+	frameColors={frameColors}
+	footer={sitewideData.footer}
+	indexable={false}
+>
+	<SiteNavigation
+		logo={logo}
+		navigationEntries={siteNavigation}
+		navigationMode={navigationModel.mode}
+		showTopNavigationSubmenus={navigationModel.requestedMode !== 'automatic' && navigationModel.mode !== 'tree'}
+		hasNavigationRailFrame={hasNavigationRailFrame}
+		frameColors={frameColors}
+		readerPreferences={pagePresentation.readerPreferences}
+	/>
+	{siteBanners.length > 0 && <SiteBanners banners={siteBanners} />}
+	<main class="site-content" id="main-content" style={`--page-text-width: ${pageTextWidth}`}>
+		<SiteSection
+			section={notFoundSection}
+			pagePresentation={pagePresentation}
+			visualTheme={visualTheme}
+			sectionIndex={0}
+		/>
+	</main>
+</BaseLayout>

package/src/pages/[...slug].astro

@@ -1,8 +1,11 @@
 ---
 import { getCollection } from 'astro:content';
 import { assertPageAliasModel, createPageAliasModel } from '../../scripts/lib/page-aliases.mjs';
+import { getGeneratedSiteRoutes } from '../../scripts/lib/page-aliases.mjs';
 import { getSitePublicFiles } from '../../scripts/lib/site-link-graph.mjs';
+import projectConfig from '../../scripts/lib/project-config.mjs';
 import PageAliasRedirect from '../components/PageAliasRedirect.astro';
+import SearchPage from '../components/SearchPage.astro';
 import SitePage from '../components/SitePage.astro';
 import { getSiteModel, getSitePage, isHomePageEntry } from '../lib/sitePages';
 
@@ -13,6 +16,7 @@ export async function getStaticPaths() {
 		categories: siteModel.categories,
 		pages: siteModel.pages,
 		publicFiles: await getSitePublicFiles(),
+		generatedRoutes: getGeneratedSiteRoutes({ searchEnabled: projectConfig.search.enabled }),
 	}));
 	const pagesByPathname = new Map(siteModel.pages.map((page) => [page.pathname, page]));
 
@@ -37,22 +41,28 @@ export async function getStaticPaths() {
 		};
 	});
 
-	return [...pagePaths, ...aliasPaths];
+	const searchPath = projectConfig.search.enabled
+		? [{ params: { slug: 'search' }, props: { searchPage: true } }]
+		: [];
+
+	return [...pagePaths, ...aliasPaths, ...searchPath];
 }
 
-const { alias, entry } = Astro.props;
+const { alias, entry, searchPage } = Astro.props;
 
-if (!alias && (!entry || isHomePageEntry(entry))) {
+if (!searchPage && !alias && (!entry || isHomePageEntry(entry))) {
 	throw new Error('Page entry is missing.');
 }
 
 const currentPage = entry ? await getSitePage(entry) : null;
 
-if (!alias && !currentPage?.pathSegment) {
+if (!searchPage && !alias && !currentPage?.pathSegment) {
 	throw new Error(`Page "${entry.id}" needs a page id.`);
 }
 ---
 
-{alias
+{searchPage
+	? <SearchPage />
+	: alias
 	? <PageAliasRedirect targetPathname={alias.targetPathname} targetTitle={alias.targetTitle} />
 	: <SitePage entry={entry} />}