Use middleware to resolve siteSection

Author: BrettJephson

packages/gitbook/src/app/(site)/fetch.ts

@@ -38,19 +38,22 @@ export async function fetchContentData() {
         ]);
 
     const site = siteStructure.site;
-    const spaces = siteStructure.spaces;
-    const sections = siteStructure.sections;
 
+    const sections = siteStructure.sections;
+    const section = siteStructure.sections?.find(section => section.id === content.siteSectionId);
+    
+    const spaces = siteStructure.spaces ?? (section ? parseSpacesFromSiteSpaces(section.siteSpaces) : []);
+    
     // we grab the space attached to the parent as it contains overriden customizations
-    const spaceRelativeToParent = spaces.find((space) => space.id === content.spaceId);
+    const spaceRelativeToParent = spaces?.find((space) => space.id === content.spaceId);
 
     return {
         content,
         contentTarget,
         space: spaceRelativeToParent ?? space,
         pages,
         sections,
-        section: siteStructure.section,
+        section,
         site,
         spaces,
         customization,
@@ -143,19 +146,30 @@ async function fetchSiteStructure(args: {
     siteShareKey: string | undefined;
     siteSpaceId: string | undefined;
 }) {
-    const { organizationId, siteId, siteSpaceId} = args;
+    const { organizationId, siteId, siteShareKey } = args;
     const [orgSite, siteStructure, siteParentCustomizations] = await Promise.all([
         getSite(organizationId, siteId),
-        getSiteStructure({ organizationId, siteId }),
+        getSiteStructure({ organizationId, siteId, siteShareKey }),
         getCurrentSiteCustomization({ organizationId, siteId, siteSpaceId: undefined }),
     ]);
 
-    const siteSections = siteStructure.type === 'sections' && siteStructure.structure ? siteStructure.structure : [];
+    const siteSections = siteStructure.type === 'sections' && siteStructure.structure ? siteStructure.structure : null;
+    const siteSpaces = siteStructure.type === 'siteSpaces' && siteStructure.structure ? parseSpacesFromSiteSpaces(siteStructure.structure) : null;
+
+    // override the title with the customization title
+    const site = {
+        ...orgSite,
+        ...(siteParentCustomizations?.title ? { title: siteParentCustomizations.title } : {}),
+    };
 
-    const section = siteSections.find(section => section.id === siteSpaceId || section.siteSpaces.find(siteSpace => siteSpace.id === siteSpaceId));
+    return {
+        site,
+        spaces: siteSpaces,
+        sections: siteSections,
+    };
+}
 
-    const siteSpaces: SiteSpace[] = siteStructure.type === 'siteSpaces' && siteStructure.structure ? siteStructure.structure : section?.siteSpaces ?? [];
-   
+function parseSpacesFromSiteSpaces(siteSpaces: SiteSpace[]) {
     const spaces: Record<string, Space> = {};
     siteSpaces.forEach((siteSpace) => {
         spaces[siteSpace.space.id] = {
@@ -167,19 +181,7 @@ async function fetchSiteStructure(args: {
             },
         };
     });
-
-    // override the title with the customization title
-    const site = {
-        ...orgSite,
-        ...(siteParentCustomizations?.title ? { title: siteParentCustomizations.title } : {}),
-    };
-
-    return {
-        site,
-        spaces: Object.values(spaces),
-        sections: siteSections,
-        section
-    };
+    return Object.values(spaces);
 }
 
 /**

packages/gitbook/src/components/SiteSectionTabs/SiteSectionTab.tsx

@@ -7,7 +7,7 @@ import { tcls } from '@/lib/tailwind';
 
 import { Button, Link } from '../primitives';
 
-export function SiteSectionTabs(props: { sections: SiteSection[]; section?: SiteSection; }) {
+export function SiteSectionTabs(props: { sections: SiteSection[]; section: SiteSection; }) {
     const { sections, section: currentSection } = props;
 
     const tabs = sections.map((section) => ({ id: section.id, label: section.title, path: section.urls.published ?? '' }));

packages/gitbook/src/components/SpaceLayout/SpaceLayout.tsx

@@ -31,7 +31,7 @@ export function SpaceLayout(props: {
     contentTarget: ContentTarget;
     space: Space;
     site: Site | null;
-    sections: SiteSection[];
+    sections: SiteSection[] | null;
     section?: SiteSection;
     spaces: Space[];
     customization: CustomizationSettings | SiteCustomizationSettings;
@@ -74,9 +74,9 @@ export function SpaceLayout(props: {
                 customization={customization}
             />
             <div className={tcls('scroll-nojump')}>
-                <div className={tcls(CONTAINER_STYLE)}>
+                { sections && section ? <div className={tcls(CONTAINER_STYLE)}>
                     <SiteSectionTabs sections={sections} section={section} />
-                </div>
+                </div> : null }
                 <div
                     className={tcls(
                         'flex',

packages/gitbook/src/lib/api.ts

@@ -45,6 +45,10 @@ export interface SpaceContentPointer {
 export interface SiteContentPointer extends SpaceContentPointer {
     organizationId: string;
     siteId: string;
+    /**
+     * ID of the siteSection. When rendering a multi-section site. Can be undefined.
+     */
+    siteSectionId: string | undefined;
     /**
      * ID of the siteSpace can be undefined when rendering in multi-id mode (for site previews)
      */
@@ -739,18 +743,25 @@ export const getSiteSpaces = cache({
 
 export const getSiteStructure = cache({
     name: 'api.getSiteStructure',
-    tag: ({ organizationId, siteId }) => getAPICacheTag({ tag: 'site', site: siteId }),
+    tag: ({ siteId }) => getAPICacheTag({ tag: 'site', site: siteId }),
     get: async (
-        args: { organizationId: string; siteId: string },
+        args: { 
+            organizationId: string;
+            siteId: string,
+            /** Site share key that can be used as context to resolve site space published urls */
+            siteShareKey: string | undefined;
+         },
         options: CacheFunctionOptions,
     ) => {
         const response = await api().orgs.getSiteStructure(
             args.organizationId,
             args.siteId,
-            {},
             {
-                signal: options.signal,
+                ...(args.siteShareKey ? { shareKey: args.siteShareKey } : {}),
+            },
+            {
                 ...noCacheFetchOptions,
+                signal: options.signal,
             },
         );
         return cacheResponse(response, {

packages/gitbook/src/lib/pointer.ts

@@ -11,6 +11,7 @@ export function getSiteContentPointer(): SiteContentPointer {
     const siteId = headerSet.get('x-gitbook-content-site');
     const organizationId = headerSet.get('x-gitbook-content-organization');
     const siteSpaceId = headerSet.get('x-gitbook-content-site-space');
+    const siteSectionId = headerSet.get('x-gitbook-content-site-section');
     const siteShareKey = headerSet.get('x-gitbook-content-site-share-key');
 
     if (!spaceId || !siteId || !organizationId) {
@@ -22,6 +23,7 @@ export function getSiteContentPointer(): SiteContentPointer {
     const pointer: SiteContentPointer = {
         siteId,
         spaceId,
+        siteSectionId: siteSectionId ?? undefined,
         siteSpaceId: siteSpaceId ?? undefined,
         siteShareKey: siteShareKey ?? undefined,
         organizationId,

packages/gitbook/src/middleware.ts

@@ -200,6 +200,9 @@ export async function middleware(request: NextRequest) {
     if ('site' in resolved) {
         headers.set('x-gitbook-content-organization', resolved.organization);
         headers.set('x-gitbook-content-site', resolved.site);
+        if (resolved.siteSection) {
+            headers.set('x-gitbook-content-site-section', resolved.siteSection);
+        }
         if (resolved.siteSpace) {
             headers.set('x-gitbook-content-site-space', resolved.siteSpace);
         }
@@ -208,6 +211,7 @@ export async function middleware(request: NextRequest) {
         }
     }
 
+
     // For tests, we make it possible to enable search indexation
     // using a query parameter.
     const xGitBookSearchIndexation =