Remove hidden site spaces from navigation (#3795)

nolannbiron · web-flow · commit 04a41756783e · 2025-11-18T22:49:41.000+01:00
diff --git a/.changeset/three-melons-enjoy.md b/.changeset/three-melons-enjoy.md
@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Remove hidden site spaces from navigation
diff --git a/bun.lock b/bun.lock
@@ -344,7 +344,7 @@
     "react-dom": "catalog:",
   },
   "catalog": {
-    "@gitbook/api": "0.150.0",
+    "@gitbook/api": "0.151.0",
     "@scalar/api-client-react": "^1.3.46",
     "@tsconfig/node20": "^20.1.6",
     "@tsconfig/strictest": "^2.0.6",
@@ -725,7 +725,7 @@
 
     "@fortawesome/fontawesome-svg-core": ["@fortawesome/fontawesome-svg-core@6.6.0", "", { "dependencies": { "@fortawesome/fontawesome-common-types": "6.6.0" } }, "sha512-KHwPkCk6oRT4HADE7smhfsKudt9N/9lm6EJ5BVg0tD1yPA5hht837fB87F8pn15D8JfTqQOjhKTktwmLMiD7Kg=="],
 
-    "@gitbook/api": ["@gitbook/api@0.150.0", "", { "dependencies": { "event-iterator": "^2.0.0", "eventsource-parser": "^3.0.0" } }, "sha512-OjP52+BlBCo3BvKhLz5exR8uvzT9XaYuMACC72LGSsvyz7Ejiehs2JMrCmX3zQF1aJ+UemT6TTZCUx1T0PQyuQ=="],
+    "@gitbook/api": ["@gitbook/api@0.151.0", "", { "dependencies": { "event-iterator": "^2.0.0", "eventsource-parser": "^3.0.0" } }, "sha512-5d9+rZ2u6CKKIiVHO1Toyk+7wHtTOXmP0+sVIE3teRkceX4z5FGIIpa4XsFeKC9XeosncvehdshPaOGQtSDpTQ=="],
 
     "@gitbook/browser-types": ["@gitbook/browser-types@workspace:packages/browser-types"],
 
diff --git a/package.json b/package.json
@@ -41,7 +41,7 @@
         "catalog": {
             "@tsconfig/strictest": "^2.0.6",
             "@tsconfig/node20": "^20.1.6",
-            "@gitbook/api": "0.150.0",
+            "@gitbook/api": "0.151.0",
             "@scalar/api-client-react": "^1.3.46",
             "@types/react": "^19.0.0",
             "@types/react-dom": "^19.0.0",
diff --git a/packages/gitbook/src/lib/context.ts b/packages/gitbook/src/lib/context.ts
@@ -274,7 +274,7 @@ export async function fetchSiteContextByIds(
                 );
             }
 
-            return { siteSpaces, siteSpace };
+            return { siteSpaces: filterHiddenSiteSpaces(siteSpaces), siteSpace };
         }
 
         if (siteStructure.type === 'sections') {
@@ -295,7 +295,7 @@ export async function fetchSiteContextByIds(
                 );
             }
 
-            return { siteSpaces, siteSpace };
+            return { siteSpaces: filterHiddenSiteSpaces(siteSpaces), siteSpace };
         }
 
         // @ts-expect-error
@@ -426,6 +426,13 @@ export function checkIsRootSiteContext(context: GitBookSiteContext): boolean {
     }
 }
 
+/**
+ * Filter out hidden site spaces from a list of site spaces.
+ */
+function filterHiddenSiteSpaces(siteSpaces: SiteSpace[]): SiteSpace[] {
+    return siteSpaces.filter((siteSpace) => !siteSpace.hidden);
+}
+
 function parseSiteSectionsAndGroups(structure: SiteStructure, siteSectionId: string) {
     const sectionsAndGroups = getSiteStructureSections(structure, { ignoreGroups: false });
     const section = parseCurrentSection(structure, siteSectionId);

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'gitbook': patch
 +---
++
 +Remove hidden site spaces from navigation
Original file line number	Diff line number	Diff line change
`@@ -274,7 +274,7 @@ export async function fetchSiteContextByIds(`
`274`	`274`	`);`
`275`	`275`	`}`
`276`	`276`
`277`		`- return { siteSpaces, siteSpace };`
	`277`	`+ return { siteSpaces: filterHiddenSiteSpaces(siteSpaces), siteSpace };`
`278`	`278`	`}`
`279`	`279`
`280`	`280`	`if (siteStructure.type === 'sections') {`
`@@ -295,7 +295,7 @@ export async function fetchSiteContextByIds(`
`295`	`295`	`);`
`296`	`296`	`}`
`297`	`297`
`298`		`- return { siteSpaces, siteSpace };`
	`298`	`+ return { siteSpaces: filterHiddenSiteSpaces(siteSpaces), siteSpace };`
`299`	`299`	`}`
`300`	`300`
`301`	`301`	`// @ts-expect-error`
`@@ -426,6 +426,13 @@ export function checkIsRootSiteContext(context: GitBookSiteContext): boolean {`
`426`	`426`	`}`
`427`	`427`	`}`
`428`	`428`
	`429`	`+/**`
	`430`	`+ * Filter out hidden site spaces from a list of site spaces.`
	`431`	`+ */`
	`432`	`+function filterHiddenSiteSpaces(siteSpaces: SiteSpace[]): SiteSpace[] {`
	`433`	`+ return siteSpaces.filter((siteSpace) => !siteSpace.hidden);`
	`434`	`+}`
	`435`	`+`
`429`	`436`	`function parseSiteSectionsAndGroups(structure: SiteStructure, siteSectionId: string) {`
`430`	`437`	`const sectionsAndGroups = getSiteStructureSections(structure, { ignoreGroups: false });`
`431`	`438`	`const section = parseCurrentSection(structure, siteSectionId);`