@brillout/docpress 0.7.2 → 0.7.4

package/package.json

@@ -1,20 +1,7 @@
 {
   "name": "@brillout/docpress",
-  "version": "0.7.2",
+  "version": "0.7.4",
   "type": "module",
-  "scripts": {
-    "======== Build": "",
-    "// Build vite.config.ts and +config.ts (other files don't need to be built as @brillout/docpress is noExternal)": "",
-    "build": "rm -rf dist/ && tsc --project tsconfig.config.json",
-    "======== Develop": "",
-    "dev": "tsc --watch --project tsconfig.config.json",
-    "// Check types of all source files while developing": "",
-    "typecheck": "tsc --noEmit --watch",
-    "========= Release": "",
-    "release": "release-me patch",
-    "release:minor": "release-me minor",
-    "release:commit": "release-me commit"
-  },
   "dependencies": {
     "@brillout/picocolors": "^1.0.10",
     "@docsearch/css": "^3.6.1",
@@ -37,13 +24,14 @@
     "react": ">=18.0.0",
     "react-dom": ">=18.0.0",
     "typescript": "*",
-    "vike": ">=0.4.195",
+    "vike": ">=0.4.198",
     "vite": ">=5.2.0"
   },
   "exports": {
     "./renderer/onRenderHtml": "./renderer/onRenderHtml.tsx",
     "./renderer/onRenderClient": "./renderer/onRenderClient.tsx",
     "./renderer/onBeforeRender": "./renderer/onBeforeRender.ts",
+    "./Layout": "./Layout.tsx",
     ".": "./index.ts",
     "./FeatureList/FeatureList": "./components/FeatureList/FeatureList.tsx",
     "./FeatureList/FeatureList.client": {
@@ -51,7 +39,10 @@
     },
     "./vite-config": "./dist/vite.config.js",
     "./config": "./dist/+config.js",
-    "./style": "./css/index.css"
+    "./style": "./css/index.css",
+    "./types": {
+      "types": "./types.d.ts"
+    }
   },
   "typesVersions": {
     "*": {
@@ -73,7 +64,7 @@
     }
   },
   "devDependencies": {
-    "@brillout/release-me": "^0.3.8",
+    "@brillout/release-me": "^0.4.2",
     "@types/node": "link:../demo/node_modules/@types/node/",
     "@types/react": "link:../demo/node_modules/@types/react/",
     "@types/react-dom": "link:../demo/node_modules/@types/react-dom/",
@@ -87,5 +78,18 @@
   "license": "MIT",
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "======== Build": "",
+    "// Build vite.config.ts and +config.ts (other files don't need to be built as @brillout/docpress is noExternal)": "",
+    "build": "rm -rf dist/ && tsc --project tsconfig.config.json",
+    "======== Develop": "",
+    "dev": "tsc --watch --project tsconfig.config.json",
+    "// Check types of all source files while developing": "",
+    "typecheck": "tsc --noEmit --watch",
+    "========= Release": "",
+    "release": "release-me patch",
+    "release:minor": "release-me minor",
+    "release:commit": "release-me commit"
   }
-}
+}

package/renderer/getPageElement.tsx

@@ -2,15 +2,26 @@ export { getPageElement }
 
 import type { PageContext } from 'vike/types'
 import type { PageContextResolved } from '../config/resolvePageContext'
-import { PageLayout } from '../PageLayout'
+import { PageContextProvider, PageContextProvider2 } from './usePageContext'
 import React from 'react'
 
 function getPageElement(pageContext: PageContext, pageContextResolved: PageContextResolved) {
   const { Page } = pageContext
+  const { Layout = PassThrough } = pageContext.config
   const page = (
-    <PageLayout pageContext={pageContextResolved} pageContext2={pageContext}>
-      <Page />
-    </PageLayout>
+    <React.StrictMode>
+      <PageContextProvider2 pageContext={pageContext}>
+        <PageContextProvider pageContext={pageContextResolved}>
+          <Layout pageContext={pageContextResolved} pageContext2={pageContext}>
+            <Page />
+          </Layout>
+        </PageContextProvider>
+      </PageContextProvider2>
+    </React.StrictMode>
   )
   return page
 }
+
+function PassThrough({ children }: any) {
+  return <>{children}</>
+}

package/renderer/onRenderClient.tsx

@@ -8,6 +8,7 @@ import { getPageElement } from './getPageElement'
 import {
   hideNavigationFullScreen,
   initNavigationFullscreen,
+  initNavigationFullscreenOnce,
 } from '../navigation/navigation-fullscreen/initNavigationFullscreen'
 import { hideMobileNavigation, initMobileNavigation } from '../navigation/initMobileNavigation'
 import { initPressKit } from '../navigation/initPressKit'
@@ -16,12 +17,18 @@ import { autoScrollNav } from '../autoScrollNav'
 import { installSectionUrlHashs } from '../installSectionUrlHashs'
 import { addFeatureClickHandlers, addTwitterWidgets } from '../components/FeatureList/FeatureList.client'
 
+addEcosystemStamp()
 initOnLinkClick()
+initNavigationFullscreenOnce()
 
 let root: ReactDOM.Root
-function onRenderClient(pageContext: PageContextClient) {
+let renderPromiseResolve: () => void
+async function onRenderClient(pageContext: PageContextClient) {
   // TODO: stop using any
   const pageContextResolved: PageContextResolved = (pageContext as any).pageContextResolved
+  const renderPromise = new Promise<void>((r) => {
+    renderPromiseResolve = r
+  })
   let page = getPageElement(pageContext, pageContextResolved)
   page = <OnRenderDoneHook>{page}</OnRenderDoneHook>
   const container = document.getElementById('page-view')!
@@ -33,10 +40,10 @@ function onRenderClient(pageContext: PageContextClient) {
     }
     root.render(page)
   }
-
   if (!pageContext.isHydration) {
     applyHead(pageContext)
   }
+  await renderPromise
 }
 
 function applyHead(pageContext: PageContextClient) {
@@ -54,6 +61,7 @@ function onRenderDone() {
   addFeatureClickHandlers()
   addTwitterWidgets()
   setHydrationIsFinished()
+  renderPromiseResolve()
 }
 
 function OnRenderDoneHook({ children }: { children: React.ReactNode }) {
@@ -88,3 +96,9 @@ function setHydrationIsFinished() {
   // - https://github.com/brillout/telefunc/blob/57c942c15b7795cfda96b5106acc9e098aa509aa/docs/.testRun.ts#L26
   ;(window as any).__docpress_hydrationFinished = true
 }
+
+// Used by:
+// - https://github.com/vikejs/vike/blob/87cca54f30b3c7e71867763d5723493d7eef37ab/vike/client/client-routing-runtime/prefetch.ts#L309-L312
+function addEcosystemStamp() {
+  ;(window as any)._isBrilloutDocpress = true
+}

package/types/Heading.ts

@@ -3,13 +3,13 @@ export { HeadingDetachedResolved }
 export { HeadingDetachedDefinition }
 export { HeadingDefinition }
 
-import type { EmojiName } from '../utils/server'
-
 type HeadingResolved = {
   url?: null | string
   level: number
   title: string
   titleInNav: string
+  noSideNavigation?: true
+  topNavigation?: true | string
   linkBreadcrumb: string[]
   sectionTitles?: string[]
 } & Tmp
@@ -19,22 +19,27 @@ type HeadingDetachedResolved = Omit<HeadingResolved, 'level' | 'linkBreadcrumb'>
   linkBreadcrumb: null
 }
 
-type HeadingDetachedDefinition = {
-  url: string
+type HeadingDefinitionCommon = {
   title: string
+  topNavigation?: true | string
+}
+
+type HeadingDetachedDefinition = HeadingDefinitionCommon & {
+  url: string
   sectionTitles?: string[]
 }
 
-type HeadingDefinition = {
+type HeadingDefinition = HeadingDefinitionCommon & {
   url?: null | string
-  title: string
   titleInNav?: string
+  noSideNavigation?: true
 } & HeadingDefinitionLevel &
   Tmp
 type IsCategory = {
   url?: undefined
   titleDocument?: undefined
   titleInNav?: undefined
+  noSideNavigation?: undefined
 }
 type HeadingDefinitionLevel =
   | ({ level: 1 } & IsCategory)

package/utils/assert.ts

@@ -10,14 +10,14 @@ if (isBrowser()) {
     [
       '[@brillout/docpress] DEV MODE',
       isDevMode() ? 'enabled' : 'disabled',
-      !isLocalhost() && 'run window.toggleDevMode() to toggle DEV MODE',
+      !isLocalhost() && '— run window.toggleDevMode() to toggle DEV MODE',
     ]
       .filter(Boolean)
       .join(' '),
   )
   if (isDevMode()) {
     window.onerror = (err) => {
-      alert(err)
+      window.alert(err)
       window.onerror = null
     }
   }
@@ -39,9 +39,6 @@ function assert(condition: unknown, debugInfo?: unknown): asserts condition {
     errMsg += ' Debug info: ' + String(debugInfo)
   }
   const err = new Error(errMsg)
-  if (isBrowser() && isDevMode()) {
-    window.alert(err.stack)
-  }
   throw err
 }
 
@@ -50,9 +47,6 @@ function assertUsage(condition: unknown, msg: string): asserts condition {
     return
   }
   const err = new Error('[DocPress][Wrong Usage] ' + msg)
-  if (isBrowser() && isDevMode()) {
-    window.alert(err.stack)
-  }
   throw err
 }
 
@@ -81,8 +75,9 @@ function assertWarning(condition: unknown, msg: string): asserts condition {
     return
   }
   msg = '[DocPress][Warning] ' + msg
-  console.warn(msg)
   if (isBrowser() && isDevMode()) {
-    window.alert(msg)
+    throw new Error(msg)
+  } else {
+    console.warn(msg)
   }
 }

package/PageLayout.tsx

@@ -1,48 +0,0 @@
-import React from 'react'
-import { Navigation, NavigationMask } from './navigation/Navigation'
-import type { PageContextResolved } from './config/resolvePageContext'
-import { MobileHeader } from './MobileHeader'
-import { EditPageNote } from './components/EditPageNote'
-import { PageContextProvider, PageContextProvider2 } from './renderer/usePageContext'
-import './PageLayout.css'
-import { NavigationFullscreenButton } from './navigation/navigation-fullscreen/NavigationFullscreenButton'
-import type { PageContext } from 'vike/types'
-import { parseTitle } from './parseTitle'
-
-export { PageLayout }
-
-function PageLayout({
-  pageContext,
-  children,
-  pageContext2,
-}: { pageContext: PageContextResolved; children: React.ReactNode; pageContext2: PageContext }) {
-  const { isLandingPage, pageTitle, navigationData } = pageContext
-  const pageTitleParsed = pageTitle && parseTitle(pageTitle)
-  const { globalNote } = pageContext.config
-  return (
-    <React.StrictMode>
-      <PageContextProvider2 pageContext={pageContext2}>
-        <PageContextProvider pageContext={pageContext}>
-          <div className={`page-layout ${isLandingPage ? 'landing-page' : 'doc-page'}`}>
-            <div id="navigation-wrapper">
-              <Navigation {...pageContext.navigationData} />
-            </div>
-            <NavigationFullscreenButton />
-            <div className="page-wrapper">
-              <div className="page-container">
-                <MobileHeader />
-                <div className="page-content">
-                  {globalNote}
-                  {pageTitleParsed && <h1 id={`${navigationData.currentUrl.replace('/', '')}`}>{pageTitleParsed}</h1>}
-                  {children}
-                  {!isLandingPage && <EditPageNote pageContext={pageContext} />}
-                </div>
-              </div>
-              <NavigationMask />
-            </div>
-          </div>
-        </PageContextProvider>
-      </PageContextProvider2>
-    </React.StrictMode>
-  )
-}