Hide pages from table of contents when set as hidden (#2383)

Co-authored-by: Scott Cazan <[email protected]>

Author: SamyPesse

bun.lockb

@@ -363,6 +363,11 @@ const testCases: TestsCase[] = [
         name: 'Page options',
         baseUrl: 'https://gitbook.gitbook.io/test-1-1/',
         tests: [
+            {
+                name: 'Hidden',
+                url: 'page-options/page-hidden',
+                run: waitForCookiesDialog,
+            },
             {
                 name: 'With cover',
                 url: 'page-options/page-with-cover',

e2e/pages.spec.ts

@@ -20,7 +20,7 @@
     ],
     "dependencies": {
         "@geist-ui/icons": "^1.0.2",
-        "@gitbook/api": "^0.53.0",
+        "@gitbook/api": "^0.56.0",
         "@radix-ui/react-checkbox": "^1.0.4",
         "@radix-ui/react-popover": "^1.0.7",
         "@sentry/nextjs": "^7.94.1",

package.json

@@ -4,6 +4,7 @@ import {
     Revision,
     RevisionPageDocument,
     RevisionPageGroup,
+    RevisionPageLink,
     SiteCustomizationSettings,
     Space,
 } from '@gitbook/api';
@@ -313,9 +314,17 @@ function selectPages(
     ): FlatPageEntry[] => {
         return [
             { page, depth },
-            ...page.pages.flatMap((child) =>
-                child.type === 'link' ? [] : flattenPage(child, depth + 1),
-            ),
+            ...page.pages.flatMap((child) => {
+                if (child.type === 'link') {
+                    return [];
+                }
+
+                if (child.hidden) {
+                    return [];
+                }
+
+                return flattenPage(child, depth + 1);
+            }),
         ];
     };
 
@@ -340,8 +349,16 @@ function selectPages(
         return limitTo(flattenPage(found.page, 0));
     }
 
-    const allPages = rootPages.flatMap((page) =>
-        page.type === 'link' ? [] : flattenPage(page, 0),
-    );
+    const allPages = rootPages.flatMap((page) => {
+        if (page.type === 'link') {
+            return [];
+        }
+
+        if (page.hidden) {
+            return [];
+        }
+
+        return flattenPage(page, 0);
+    });
     return limitTo(allPages);
 }

src/app/(space)/(core)/~gitbook/pdf/page.tsx

@@ -19,6 +19,14 @@ export function PagesList(props: {
     return (
         <ul className={tcls('flex', 'flex-1', 'flex-col', 'gap-y-0.5', style)}>
             {pages.map((page) => {
+                if (page.type === 'link') {
+                    return <PageLinkItem key={page.id} page={page} context={context} />;
+                }
+
+                if (page.hidden) {
+                    return null;
+                }
+
                 if (page.type === 'group') {
                     return (
                         <PageGroupItem
@@ -29,8 +37,6 @@ export function PagesList(props: {
                             context={context}
                         />
                     );
-                } else if (page.type === 'link') {
-                    return <PageLinkItem key={page.id} page={page} context={context} />;
                 }
 
                 return (

src/components/TableOfContents/PagesList.tsx

@@ -75,12 +75,13 @@ export function resolvePageId(
 
 /**
  * Resolve the next/previous page before another one.
+ * It ignores hidden pages as this is used for navigation purpose.
  */
 export function resolvePrevNextPages(
     rootPages: Revision['pages'],
     page: RevisionPageDocument,
 ): { previous?: RevisionPageDocument; next?: RevisionPageDocument } {
-    const flat = flattenPages(rootPages);
+    const flat = flattenPages(rootPages, (page) => !page.hidden);
 
     const currentIndex = flat.findIndex((p) => p.id === page.id);
     if (currentIndex === -1) {
@@ -152,17 +153,27 @@ function resolvePageDocument(
     return { page, ancestors };
 }
 
-function flattenPages(pages: RevisionPage[]): RevisionPageDocument[] {
+/**
+ * Flatten a list of pages into a list of page documents.
+ */
+function flattenPages(
+    pages: RevisionPage[],
+    filter?: (page: RevisionPageDocument | RevisionPageGroup) => boolean,
+): RevisionPageDocument[] {
     const result: RevisionPageDocument[] = [];
     for (const page of pages) {
         if (page.type === 'link') {
             continue;
         }
 
+        if (filter && !filter(page)) {
+            continue;
+        }
+
         if (page.type === 'document') {
             result.push(page);
         }
-        result.push(...flattenPages(page.pages));
+        result.push(...flattenPages(page.pages, filter));
     }
 
     return result;