@brillout/docpress 0.13.2 → 0.15.0

package/{config/resolveHeadingsData.ts → resolveConf.ts}

@@ -1,21 +1,22 @@
-export { resolveHeadingsData }
-export type { ActiveCategory }
+export { resolveConf }
+export type Conf = ReturnType<typeof resolveConf>
 
-import { assert, isBrowser, jsxToTextContent } from '../utils/server'
+import type { Config } from './types/Config'
+import type { NavItem } from './NavItemComponent'
+import type { LinkData } from './components'
+import type { PageContextServer } from 'vike/types'
+import type { PageSection } from './parsePageSections'
 import type {
   HeadingDefinition,
   HeadingDetachedDefinition,
   HeadingResolved,
   HeadingDetachedResolved,
-} from '../types/Heading'
-import type { Config } from '../types/Config'
-import type { NavItem } from '../NavItemComponent'
-import type { LinkData } from '../components'
-import type { Exports, PageContextOriginal } from './resolvePageContext'
+} from './types/Heading'
+import { assert } from './utils/assert'
+import { jsxToTextContent } from './utils/jsxToTextContent'
 import pc from '@brillout/picocolors'
-import { parseMarkdownMini } from '../parseMarkdownMini'
-import { determineNavItemsColumnLayout } from '../renderer/determineNavItemsColumnLayout'
-assert(!isBrowser())
+import { parseMarkdownMini } from './parseMarkdownMini'
+import { determineNavItemsColumnLayout } from './determineNavItemsColumnLayout'
 
 type PageSectionResolved = {
   url: string | null
@@ -25,14 +26,10 @@ type PageSectionResolved = {
   pageSectionLevel: number
 }
 
-type ActiveCategory = {
-  name: string
-  order: number
-  hide?: boolean
-}
-
-function resolveHeadingsData(pageContext: PageContextOriginal) {
-  const config = pageContext.config.docpress!
+function resolveConf(pageContext: PageContextServer) {
+  const config = pageContext.globalContext.config.docpress
+  const { urlPathname } = pageContext
+  const pageSections = pageContext.config.pageSectionsExport ?? []
 
   {
     const { headings, headingsDetached } = config
@@ -46,18 +43,19 @@ function resolveHeadingsData(pageContext: PageContextOriginal) {
   const { activeHeading, isDetachedPage, activeCategoryName } = getActiveHeading(
     headingsResolved,
     headingsDetachedResolved,
-    pageContext,
+    urlPathname,
   )
 
-  const { documentTitle, isLandingPage, pageTitle } = getTitles(activeHeading, pageContext, config)
+  const { documentTitle, isLandingPage, pageTitle } = getTitles(activeHeading, urlPathname, config)
 
-  const pageSectionsResolved = getPageSectionsResolved(pageContext, activeHeading)
+  const pageSectionsResolved = getPageSectionsResolved(pageSections, activeHeading)
 
-  const linksAll: LinkData[] = [
-    ...pageSectionsResolved.map(pageSectionToLinkData),
+  const linksGlobal: LinkData[] = [
     ...headingsResolved.map(headingToLinkData),
     ...headingsDetachedResolved.map(headingToLinkData),
   ]
+  const linksPage: LinkData[] = pageSectionsResolved.map(pageSectionToLinkData)
+  const linksAll = [...linksPage, ...linksGlobal]
 
   let navItemsAll: NavItem[]
   let navItemsDetached: NavItem[] | undefined
@@ -70,7 +68,7 @@ function resolveHeadingsData(pageContext: PageContextOriginal) {
     if (isDetachedPage) {
       navItemsDetached = [headingToNavItem(activeHeading), ...navItemsPageSections]
     } else {
-      const activeHeadingIndex = navItemsAll.findIndex((navItem) => navItem.url === pageContext.urlPathname)
+      const activeHeadingIndex = navItemsAll.findIndex((navItem) => navItem.url === urlPathname)
       assert(activeHeadingIndex >= 0)
       navItemsPageSections.forEach((navItem, i) => {
         navItemsAll.splice(activeHeadingIndex + 1 + i, 0, navItem)
@@ -78,18 +76,7 @@ function resolveHeadingsData(pageContext: PageContextOriginal) {
     }
   }
 
-  const activeCategory: ActiveCategory = config.categories
-    // normalize
-    ?.map((c, i) => ({
-      order: i,
-      ...(typeof c === 'string' ? { name: c } : c),
-    }))
-    .find((c) => c.name === activeCategoryName) ?? {
-    name: activeCategoryName,
-    order: 99999999999,
-  }
-
-  const pageContextAddendum = {
+  const conf = {
     navItemsAll,
     navItemsDetached,
     pageDesign: activeHeading.pageDesign,
@@ -97,10 +84,9 @@ function resolveHeadingsData(pageContext: PageContextOriginal) {
     isLandingPage,
     pageTitle,
     documentTitle,
-    // TODO: don't pass to client-side
-    activeCategory,
+    activeCategoryName,
   }
-  return pageContextAddendum
+  return conf
 }
 
 function headingToNavItem(heading: HeadingResolved | HeadingDetachedResolved): NavItem {
@@ -139,20 +125,15 @@ function pageSectionToLinkData(pageSection: PageSectionResolved): LinkData {
   }
 }
 
-function getTitles(
-  activeHeading: HeadingResolved | HeadingDetachedResolved,
-  pageContext: { urlPathname: string },
-  config: Config,
-) {
-  const url = pageContext.urlPathname
-  const isLandingPage = url === '/'
+function getTitles(activeHeading: HeadingResolved | HeadingDetachedResolved, urlPathname: string, config: Config) {
+  const isLandingPage = urlPathname === '/'
 
   const { title } = activeHeading
   let pageTitle = isLandingPage ? null : title
   let documentTitle = activeHeading.titleDocument || jsxToTextContent(parseMarkdownMini(title))
 
   if (!isLandingPage) {
-    documentTitle += ' | ' + config.projectInfo.projectName
+    documentTitle += ' | ' + config.name
   }
 
   if (isLandingPage) {
@@ -165,12 +146,11 @@ function getTitles(
 function getActiveHeading(
   headingsResolved: HeadingResolved[],
   headingsDetachedResolved: HeadingDetachedResolved[],
-  pageContext: { urlPathname: string; exports: Exports },
+  urlPathname: string,
 ) {
   let activeHeading: HeadingResolved | HeadingDetachedResolved | null = null
   let activeCategoryName = 'Miscellaneous'
   let headingCategory: string | undefined
-  const { urlPathname } = pageContext
   assert(urlPathname)
   for (const heading of headingsResolved) {
     if (heading.level === 1) {
@@ -206,11 +186,9 @@ function getActiveHeading(
 }
 
 function getPageSectionsResolved(
-  pageContext: { exports: Exports },
+  pageSections: PageSection[],
   activeHeading: HeadingResolved | HeadingDetachedResolved,
 ): PageSectionResolved[] {
-  const pageSections = pageContext.exports.pageSectionsExport ?? []
-
   const pageSectionsResolved = pageSections.map((pageSection) => {
     const { pageSectionTitle } = pageSection
     const url: null | string = pageSection.pageSectionId === null ? null : '#' + pageSection.pageSectionId

package/tsconfig.config.json

@@ -1,7 +1,4 @@
 {
   "extends": "./tsconfig.json",
-  "files": ["vite.config.ts", "+config.ts"],
-  "compilerOptions": {
-    "outDir": "./dist/"
-  }
+  "files": ["vite.config.ts", "+config.ts"]
 }

package/tsconfig.json

@@ -1,5 +1,6 @@
 {
   "compilerOptions": {
+    "outDir": "./dist/",
     "jsx": "react",
     "module": "ES2020",
     "moduleResolution": "Bundler",

package/types/Config.ts

@@ -3,36 +3,36 @@ export type { Config }
 import type { HeadingDefinition, HeadingDetachedDefinition } from './Heading'
 
 type Config = {
-  projectInfo: {
-    githubRepository: string
-    githubIssues: string
-    githubDiscussions?: string
-    projectName: string
-    projectVersion: string
-    discordInvite?: string
-    twitterProfile: string
-    blueskyHandle?: string
-  }
-  docsDir?: string
-  logoUrl?: string
-  faviconUrl?: string
-  algolia: null | {
+  name: string
+  version: string
+  url: string
+  /** Sets `<meta name="description" content="${tagline}" />` */
+  tagline: string
+  logo: string
+  favicon?: string
+  banner?: string
+
+  github: string
+  discord?: string
+  twitter?: string
+  bluesky?: string
+
+  headings: HeadingDefinition[]
+  headingsDetached: HeadingDetachedDefinition[]
+  categories?: Category[]
+
+  algolia?: {
     appId: string
     apiKey: string
     indexName: string
   }
-  headings: HeadingDefinition[]
-  headingsDetached: HeadingDetachedDefinition[]
-  categories?: Category[]
-  /** Sets `<meta name="description" content="${tagline}" />` */
-  tagline: string
-  websiteUrl: string
-  bannerUrl?: string
-  twitterHandle: string
-  globalNote?: React.ReactNode
+
   i18n?: true
   pressKit?: true
-  sponsorGithubAccount?: string
+  docsDir?: string
+
+  globalNote?: React.ReactNode
+  topNavigation?: React.ReactNode
   navMaxWidth?: number
   navLogoSize?: number
   navLogoStyle?: React.CSSProperties

package/types/Heading.ts

@@ -16,7 +16,8 @@ type HeadingResolved = {
   color?: string
   titleIcon?: string
   titleIconStyle?: React.CSSProperties
-} & Tmp
+  titleDocument?: string
+}
 
 type PageDesign = {
   hideTitle?: true
@@ -41,26 +42,18 @@ type HeadingDetachedDefinition = HeadingDefinitionCommon & {
   category?: string
 }
 
-type HeadingDefinition = HeadingDefinitionCommon & {
-  url?: null | string
-  titleInNav?: string
-} & HeadingDefinitionLevel &
-  Tmp
+type HeadingDefinition = HeadingDefinitionCommon & {} & (
+    | ({ level: 1; color: string; titleIcon?: string; titleIconStyle?: React.CSSProperties } & IsCategory)
+    | ({ level: 4 } & IsCategory)
+    | {
+        level: 2
+        titleInNav?: string
+        titleDocument?: string
+        sectionTitles?: string[]
+        url: null | string
+      }
+  )
 type IsCategory = {
   url?: undefined
-  titleDocument?: undefined
   titleInNav?: undefined
 }
-type HeadingDefinitionLevel =
-  | ({ level: 1; color: string; titleIcon?: string; titleIconStyle?: React.CSSProperties } & IsCategory)
-  | ({ level: 4 } & IsCategory)
-  | {
-      level: 2
-      sectionTitles?: string[]
-      url: null | string
-    }
-
-type Tmp = {
-  // TODO: remove? Both Vike and Telefunc set it to the same value than docpress.config.js#projectInfo.projectName
-  titleDocument?: string
-}

package/config/resolvePageContext.ts

@@ -1,49 +0,0 @@
-export { resolvePageContext }
-export type { PageContextOriginal }
-export type { PageContextResolved }
-export type { Exports }
-
-import { objectAssign } from '../utils/server'
-import type { PageContextServer } from 'vike/types'
-import type { PageSection } from '../parsePageSections'
-import { resolveHeadingsData } from './resolveHeadingsData'
-
-type Exports = {
-  pageSectionsExport?: PageSection[]
-}
-// TODO/refactor: remove PageContextOriginal in favor of using PageContextServer
-type PageContextOriginal = PageContextServer
-
-type PageContextResolved = ReturnType<typeof resolvePageContext>
-
-function resolvePageContext(pageContext: PageContextOriginal) {
-  const pageContextResolved = {}
-
-  objectAssign(pageContextResolved, resolveHeadingsData(pageContext))
-
-  const config = pageContext.config.docpress!
-  const {
-    algolia,
-    tagline,
-    twitterHandle,
-    bannerUrl,
-    websiteUrl,
-    projectInfo: { projectName },
-  } = config
-  const logoUrl = config.logoUrl ?? config.faviconUrl
-  objectAssign(pageContextResolved, {
-    urlPathname: pageContext.urlPathname, // TODO: remove
-    meta: {
-      projectName,
-      logoUrl,
-      twitterHandle,
-      bannerUrl,
-      websiteUrl,
-      tagline,
-      algolia,
-    },
-    config,
-  })
-
-  return pageContextResolved
-}

package/dist/config/resolveHeadingsData.d.ts

@@ -1,24 +0,0 @@
-export { resolveHeadingsData };
-export type { ActiveCategory };
-import type { NavItem } from '../NavItemComponent';
-import type { LinkData } from '../components';
-import type { PageContextOriginal } from './resolvePageContext';
-type ActiveCategory = {
-    name: string;
-    order: number;
-    hide?: boolean;
-};
-declare function resolveHeadingsData(pageContext: PageContextOriginal): {
-    navItemsAll: NavItem[];
-    navItemsDetached: NavItem[] | undefined;
-    pageDesign: {
-        hideTitle?: true;
-        hideMenuLeft?: true;
-        contentMaxWidth?: number;
-    } | undefined;
-    linksAll: LinkData[];
-    isLandingPage: boolean;
-    pageTitle: string | null;
-    documentTitle: string;
-    activeCategory: ActiveCategory;
-};

package/dist/config/resolvePageContext.d.ts

@@ -1,41 +0,0 @@
-export { resolvePageContext };
-export type { PageContextOriginal };
-export type { PageContextResolved };
-export type { Exports };
-import type { PageContextServer } from 'vike/types';
-import type { PageSection } from '../parsePageSections';
-type Exports = {
-    pageSectionsExport?: PageSection[];
-};
-type PageContextOriginal = PageContextServer;
-type PageContextResolved = ReturnType<typeof resolvePageContext>;
-declare function resolvePageContext(pageContext: PageContextOriginal): {
-    navItemsAll: import("../NavItemComponent").NavItem[];
-    navItemsDetached: import("../NavItemComponent").NavItem[] | undefined;
-    pageDesign: {
-        hideTitle?: true;
-        hideMenuLeft?: true;
-        contentMaxWidth?: number;
-    } | undefined;
-    linksAll: import("../components").LinkData[];
-    isLandingPage: boolean;
-    pageTitle: string | null;
-    documentTitle: string;
-    activeCategory: import("./resolveHeadingsData").ActiveCategory;
-} & {
-    urlPathname: string;
-    meta: {
-        projectName: string;
-        logoUrl: string | undefined;
-        twitterHandle: string;
-        bannerUrl: string | undefined;
-        websiteUrl: string;
-        tagline: string;
-        algolia: {
-            appId: string;
-            apiKey: string;
-            indexName: string;
-        } | null;
-    };
-    config: import("../types/Config").Config;
-};

package/dist/config/resolvePageContext.js

@@ -1,25 +0,0 @@
-export { resolvePageContext };
-import { objectAssign } from '../utils/server';
-import { resolveHeadingsData } from './resolveHeadingsData';
-function resolvePageContext(pageContext) {
-    var _a;
-    var pageContextResolved = {};
-    objectAssign(pageContextResolved, resolveHeadingsData(pageContext));
-    var config = pageContext.config.docpress;
-    var algolia = config.algolia, tagline = config.tagline, twitterHandle = config.twitterHandle, bannerUrl = config.bannerUrl, websiteUrl = config.websiteUrl, projectName = config.projectInfo.projectName;
-    var logoUrl = (_a = config.logoUrl) !== null && _a !== void 0 ? _a : config.faviconUrl;
-    objectAssign(pageContextResolved, {
-        urlPathname: pageContext.urlPathname, // TODO: remove
-        meta: {
-            projectName: projectName,
-            logoUrl: logoUrl,
-            twitterHandle: twitterHandle,
-            bannerUrl: bannerUrl,
-            websiteUrl: websiteUrl,
-            tagline: tagline,
-            algolia: algolia,
-        },
-        config: config,
-    });
-    return pageContextResolved;
-}

package/renderer/onBeforeRender.ts

@@ -1,12 +0,0 @@
-export { onBeforeRender }
-
-import { resolvePageContext, type PageContextOriginal } from '../config/resolvePageContext'
-
-function onBeforeRender(pageContextOriginal: PageContextOriginal) {
-  const pageContextResolved = resolvePageContext(pageContextOriginal)
-  return {
-    pageContext: {
-      pageContextResolved,
-    },
-  }
-}