use getPublishedContentSite API (GitbookIO#2570)

Co-authored-by: Samy Pessé <samypesse@gmail.com>

Author: taranvohra

.changeset/long-dryers-try.md

@@ -0,0 +1,5 @@
+---
+'gitbook': patch
+---
+
+Optimize performances by using new API endpoint for fetching site data.

bun.lockb

@@ -16,7 +16,7 @@
  "clean": "rm -rf ./.next && rm -rf ./public/~gitbook/static"
  },
  "dependencies": {
- "@gitbook/api": "^0.73.0",
+ "@gitbook/api": "^0.76.0",
  "@gitbook/cache-do": "workspace:*",
  "@gitbook/emoji-codepoints": "workspace:*",
  "@gitbook/icons": "workspace:*",

packages/gitbook/package.json

@@ -1,11 +1,11 @@
 import { getSpaceLanguage, t } from '@/intl/server';
-import { getSiteLayoutData } from '@/lib/api';
+import { getSiteData } from '@/lib/api';
 import { getSiteContentPointer } from '@/lib/pointer';
 import { tcls } from '@/lib/tailwind';
 
 export default async function NotFound() {
  const pointer = getSiteContentPointer();
- const { customization } = await getSiteLayoutData(pointer);
+ const { customization } = await getSiteData(pointer);
 
  const language = getSpaceLanguage(customization);
 

packages/gitbook/src/app/(site)/(content)/[[...pathname]]/not-found.tsx

@@ -73,7 +73,7 @@ export default async function Page(props: {
  page,
  };
 
- const withSections = Boolean(sections && sections.length > 0);
+ const withSections = Boolean(sections && sections.list.length > 0);
  const headerOffset = { sectionsHeader: withSections, topHeader: withTopHeader };
 
  return (

packages/gitbook/src/app/(site)/(content)/[[...pathname]]/page.tsx

@@ -1,7 +1,6 @@
-import { ContentVisibility } from '@gitbook/api';
 import { NextRequest } from 'next/server';
 
-import { getCollection, getSite, getSpace } from '@/lib/api';
+import { getSpace, getSite } from '@/lib/api';
 import { absoluteHref } from '@/lib/links';
 import { getSiteContentPointer } from '@/lib/pointer';
 import { isSpaceIndexable } from '@/lib/seo';

packages/gitbook/src/app/(site)/(core)/robots.txt/route.ts

@@ -3,7 +3,7 @@ import { ImageResponse } from 'next/og';
 import { NextRequest } from 'next/server';
 import React from 'react';
 
-import { getCurrentSiteCustomization, getSite, getSpace } from '@/lib/api';
+import { getSite, getSiteData, getSpace } from '@/lib/api';
 import { getEmojiForCode } from '@/lib/emojis';
 import { getSiteContentPointer } from '@/lib/pointer';
 import { tcls } from '@/lib/tailwind';
@@ -38,9 +38,9 @@ export async function GET(req: NextRequest) {
  const pointer = getSiteContentPointer();
  const spaceId = pointer.spaceId;
 
- const [space, customization] = await Promise.all([
+ const [space, { customization }] = await Promise.all([
  getSpace(spaceId, pointer.siteShareKey),
- getCurrentSiteCustomization(pointer),
+ getSiteData(pointer),
  ]);
  const site = await getSite(pointer.organizationId, pointer.siteId);
  const contentTitle = getContentTitle(space, customization, site);

packages/gitbook/src/app/(site)/(core)/~gitbook/icon/route.tsx

@@ -1,14 +1,11 @@
-import { RevisionPage, SiteSection, SiteSpace, Space } from '@gitbook/api';
-import { assert } from 'ts-essentials';
+import { RevisionPage } from '@gitbook/api';
 
 import {
  getRevisionPageByPath,
  getDocument,
  ContentTarget,
+ getSpaceContentData,
  getSiteData,
- getSite,
- getCurrentSiteCustomization,
- getSiteStructure,
 } from '@/lib/api';
 import { resolvePagePath, resolvePageId } from '@/lib/pages';
 import { getSiteContentPointer } from '@/lib/pointer';
@@ -21,35 +18,18 @@ export interface PageIdParams {
  pageId: string;
 }
 
-export type SectionsList = { list: SiteSection[]; section: SiteSection; index: number };
-
 /**
  * Fetch all the data needed to render the content layout.
  */
 export async function fetchContentData() {
  const content = getSiteContentPointer();
 
- const [{ space, contentTarget, pages, customization, scripts }, siteStructure] =
+ const [{ space, contentTarget, pages }, { customization, site, sections, spaces, scripts }] =
  await Promise.all([
+ getSpaceContentData(content, content.siteShareKey),
  getSiteData(content),
- fetchSiteStructure({
- organizationId: content.organizationId,
- siteId: content.siteId,
- siteShareKey: content.siteShareKey,
- }),
  ]);
 
- const site = siteStructure.site;
-
- const siteSections =
- content.siteSectionId && siteStructure.sections
- ? parseSiteSectionsList(content.siteSectionId, siteStructure.sections)
- : null;
-
- const spaces =
- siteStructure.spaces ??
- (siteSections ? parseSpacesFromSiteSpaces(siteSections.section.siteSpaces) : []);
-
  // we grab the space attached to the parent as it contains overriden customizations
  const spaceRelativeToParent = spaces?.find((space) => space.id === content.spaceId);
 
@@ -58,53 +38,30 @@ export async function fetchContentData() {
  contentTarget,
  space: spaceRelativeToParent ?? space,
  pages,
- sections: siteSections,
  site,
+ sections,
  spaces,
  customization,
  scripts,
  ancestors: [],
  };
 }
 
-function parseSiteSectionsList(siteSectionId: string, sections: SiteSection[]) {
- const section = sections.find((section) => section.id === siteSectionId);
- assert(sectionIsDefined(section), 'A section must be defined when there are multiple sections');
- return { list: sections, section, index: sections.indexOf(section) } satisfies SectionsList;
-}
-
-function sectionIsDefined(section?: SiteSection): section is NonNullable<SiteSection> {
- return typeof section !== 'undefined' && section !== null;
-}
-
 /**
  * Fetch all the data needed to render the content.
  * Optimized to fetch in parallel as much as possible.
  */
 export async function fetchPageData(params: PagePathParams | PageIdParams) {
- const content = getSiteContentPointer();
+ const contentData = await fetchContentData();
 
- const { space, contentTarget, pages, customization, scripts } = await getSiteData(content);
- const page = await resolvePage(contentTarget, pages, params);
- const [siteStructure, document] = await Promise.all([
- fetchSiteStructure({
- organizationId: content.organizationId,
- siteId: content.siteId,
- siteShareKey: content.siteShareKey,
- }),
- page?.page.documentId ? getDocument(space.id, page.page.documentId) : null,
- ]);
+ const page = await resolvePage(contentData.contentTarget, contentData.pages, params);
+ const document = page?.page.documentId
+ ? await getDocument(contentData.space.id, page.page.documentId)
+ : null;
 
  return {
- content,
- contentTarget,
- space,
- pages,
- customization,
- scripts,
- ancestors: [],
+ ...contentData,
  ...page,
- ...siteStructure,
  document,
  };
 }
@@ -150,59 +107,6 @@ async function resolvePage(
  return undefined;
 }
 
-/**
- * Fetch the structure of an organization site.
- * This includes the site and its sections or spaces.
- */
-async function fetchSiteStructure(args: {
- organizationId: string;
- siteId: string;
- siteShareKey: string | undefined;
-}) {
- const { organizationId, siteId, siteShareKey } = args;
- const [orgSite, siteStructure, siteParentCustomizations] = await Promise.all([
- getSite(organizationId, siteId),
- getSiteStructure({ organizationId, siteId, siteShareKey }),
- getCurrentSiteCustomization({ organizationId, siteId, siteSpaceId: undefined }),
- ]);
-
- 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 } : {}),
- };
-
- return {
- site,
- spaces: siteSpaces,
- sections: siteSections,
- };
-}
-
-function parseSpacesFromSiteSpaces(siteSpaces: SiteSpace[]) {
- const spaces: Record<string, Space> = {};
- siteSpaces.forEach((siteSpace) => {
- spaces[siteSpace.space.id] = {
- ...siteSpace.space,
- title: siteSpace.title ?? siteSpace.space.title,
- urls: {
- ...siteSpace.space.urls,
- published: siteSpace.urls.published,
- },
- };
- });
- return Object.values(spaces);
-}
-
 /**
  * Get the page path from the params.
  */

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

@@ -1,5 +1,5 @@
 import { CustomizationRootLayout } from '@/components/RootLayout';
-import { getSiteLayoutData } from '@/lib/api';
+import { getSiteData } from '@/lib/api';
 import { getSiteContentPointer } from '@/lib/pointer';
 
 /**
@@ -10,7 +10,7 @@ export default async function SiteRootLayout(props: { children: React.ReactNode
  const { children } = props;
 
  const pointer = getSiteContentPointer();
- const { customization } = await getSiteLayoutData(pointer);
+ const { customization } = await getSiteData(pointer);
 
  return (
  <CustomizationRootLayout customization={customization}>{children}</CustomizationRootLayout>

packages/gitbook/src/app/(site)/layout.tsx

@@ -1,7 +1,7 @@
 import { SpaceIntegrationScript } from '@gitbook/api';
 
 import { CustomizationRootLayout } from '@/components/RootLayout';
-import { getSiteLayoutData, getSpaceCustomization } from '@/lib/api';
+import { getSiteData, getSpaceCustomization } from '@/lib/api';
 
 import { getSiteOrSpacePointerForPDF } from './pointer';
 
@@ -14,7 +14,7 @@ export default async function PDFRootLayout(props: { children: React.ReactNode }
 
  const pointer = getSiteOrSpacePointerForPDF();
  const { customization } = await ('siteId' in pointer
- ? getSiteLayoutData(pointer)
+ ? getSiteData(pointer)
  : getSpaceLayoutData(pointer.spaceId));
 
  return (
@@ -26,7 +26,7 @@ export default async function PDFRootLayout(props: { children: React.ReactNode }
  * Fetch all the layout data about a space at once.
  */
 async function getSpaceLayoutData(spaceId: string) {
- const [customization, scripts] = await Promise.all([
+ const [{ customization }, scripts] = await Promise.all([
  getSpaceCustomization(spaceId),
  [] as SpaceIntegrationScript[],
  ]);