Update API client and condition for AI assistant (#3429)

Author: SamyPesse

.changeset/shiny-seahorses-tie.md

@@ -0,0 +1,5 @@
+---
+"gitbook": minor
+---
+
+Enable AI chat when AI mode is configured to assistant

bun.lock

@@ -247,7 +247,7 @@
     "react-dom": "^19.0.0",
   },
   "catalog": {
-    "@gitbook/api": "^0.126.0",
+    "@gitbook/api": "^0.128.0",
   },
   "packages": {
     "@ai-sdk/provider": ["@ai-sdk/[email protected]", "", { "dependencies": { "json-schema": "^0.4.0" } }, "sha512-0M+qjp+clUD0R1E5eWQFhxEvWLNaOtGQRUaBn8CUABnSKredagq92hUS9VjOzGsTm37xLfpaxl97AVtbeOsHew=="],
@@ -610,7 +610,7 @@
 
     "@fortawesome/fontawesome-svg-core": ["@fortawesome/[email protected]", "", { "dependencies": { "@fortawesome/fontawesome-common-types": "6.6.0" } }, "sha512-KHwPkCk6oRT4HADE7smhfsKudt9N/9lm6EJ5BVg0tD1yPA5hht837fB87F8pn15D8JfTqQOjhKTktwmLMiD7Kg=="],
 
-    "@gitbook/api": ["@gitbook/api@0.126.0", "", { "dependencies": { "event-iterator": "^2.0.0", "eventsource-parser": "^3.0.0" } }, "sha512-htDAGus+N+uSZZNHYP/My90EjaPMXaYXvwbnwOOFZqRUD5T6xsrMmUpMuNBF5KhdX/BBdwNKXUwt9Yeq7n80Bw=="],
+    "@gitbook/api": ["@gitbook/api@0.128.0", "", { "dependencies": { "event-iterator": "^2.0.0", "eventsource-parser": "^3.0.0" } }, "sha512-VO98hRGfUcFdwMplvFW49jz72/ew2waE7RCu+URKAY2AyPHAduv2zgluF5gF1VcDyuJM9PKFtsdsMtpUjI5sYg=="],
 
     "@gitbook/cache-tags": ["@gitbook/cache-tags@workspace:packages/cache-tags"],
 

package.json

@@ -34,7 +34,7 @@
     "workspaces": {
         "packages": ["packages/*"],
         "catalog": {
-            "@gitbook/api": "^0.126.0"
+            "@gitbook/api": "^0.128.0"
         }
     },
     "patchedDependencies": {

packages/gitbook/e2e/util.ts

@@ -1,8 +1,10 @@
 import { argosScreenshot } from '@argos-ci/playwright';
 import {
+    CustomizationAIMode,
     CustomizationBackground,
     CustomizationCorners,
     CustomizationDefaultFont,
+    CustomizationDefaultMonospaceFont,
     CustomizationDepth,
     type CustomizationHeaderItem,
     CustomizationHeaderPreset,
@@ -282,6 +284,7 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
             corners: CustomizationCorners.Rounded,
             depth: CustomizationDepth.Subtle,
             font: CustomizationDefaultFont.Inter,
+            monospaceFont: CustomizationDefaultMonospaceFont.IBMPlexMono,
             background: CustomizationBackground.Plain,
             icons: CustomizationIconsStyle.Regular,
             links: CustomizationLinksStyle.Default,
@@ -315,9 +318,13 @@ export function getCustomizationURL(partial: DeepPartial<SiteCustomizationSettin
         feedback: {
             enabled: false,
         },
+        // TODO: remove aiSearch once the cache has been fully updated (after 11/07/2025)
         aiSearch: {
             enabled: true,
         },
+        ai: {
+            mode: CustomizationAIMode.None,
+        },
         externalLinks: {
             target: SiteExternalLinksTarget.Self,
         },

packages/gitbook/src/components/DocumentView/Block.tsx

@@ -105,6 +105,9 @@ export function Block<T extends DocumentBlock>(props: BlockProps<T>) {
                 return <Stepper {...props} block={block} />;
             case 'stepper-step':
                 return <StepperStep {...props} block={block} />;
+            case 'if':
+                // If block should be processed by the API.
+                return null;
             case 'image':
             case 'code-line':
             case 'tabs-item':
@@ -142,6 +145,7 @@ export function BlockSkeleton(props: { block: DocumentBlock; style: ClassValue }
         case 'hint':
         case 'tabs':
         case 'stepper-step':
+        case 'if':
             return <SkeletonParagraph id={id} style={style} />;
         case 'expandable':
         case 'table':

packages/gitbook/src/components/Header/Header.tsx

@@ -5,6 +5,7 @@ import { CONTAINER_STYLE, HEADER_HEIGHT_DESKTOP } from '@/components/layout';
 import { getSpaceLanguage, t } from '@/intl/server';
 import { tcls } from '@/lib/tailwind';
 
+import { CustomizationAIMode } from '@gitbook/api';
 import { AIChatButton } from '../AIChat/AIChatButton';
 import { SearchButton } from '../Search';
 import { SiteSectionTabs, encodeClientSiteSections } from '../SiteSections';
@@ -154,7 +155,10 @@ export function Header(props: {
                                         <span className={tcls('flex-1')}>
                                             {t(
                                                 getSpaceLanguage(customization),
-                                                customization.aiSearch.enabled
+                                                // TODO: remove aiSearch and optional chain once the cache has been fully updated (after 11/07/2025)
+                                                customization.aiSearch?.enabled ||
+                                                    customization.ai?.mode !==
+                                                        CustomizationAIMode.None
                                                     ? 'search_or_ask'
                                                     : 'search'
                                             )}

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

@@ -1,5 +1,5 @@
 import type { GitBookSiteContext } from '@/lib/context';
-import { CustomizationHeaderPreset } from '@gitbook/api';
+import { CustomizationAIMode, CustomizationHeaderPreset } from '@gitbook/api';
 import React from 'react';
 
 import { Footer } from '@/components/Footer';
@@ -50,8 +50,9 @@ export function SpaceLayout(props: {
         customization.footer.logo ||
         customization.footer.groups?.length;
 
+    // TODO: remove aiSearch and optional chain once the cache has been fully updated (after 11/07/2025)
     const withAIChat =
-        context.customization.aiSearch.enabled &&
+        context.customization.ai?.mode === CustomizationAIMode.Assistant &&
         (context.site.id === 'site_p4Xo4' || context.site.id === 'site_JOVzv');
 
     return (
@@ -123,7 +124,11 @@ export function SpaceLayout(props: {
                                                             <span className={tcls('flex-1')}>
                                                                 {t(
                                                                     getSpaceLanguage(customization),
-                                                                    customization.aiSearch.enabled
+                                                                    // TODO: remove aiSearch and optional chain once the cache has been fully updated (after 11/07/2025)
+                                                                    customization.aiSearch
+                                                                        ?.enabled ||
+                                                                        customization.ai?.mode !==
+                                                                            CustomizationAIMode.None
                                                                         ? 'search_or_ask'
                                                                         : 'search'
                                                                 )}
@@ -167,7 +172,11 @@ export function SpaceLayout(props: {
                     <React.Suspense fallback={null}>
                         <SearchModal
                             spaceTitle={siteSpace.title}
-                            withAsk={customization.aiSearch.enabled}
+                            // TODO: remove aiSearch and optional chain once the cache has been fully updated (after 11/07/2025)
+                            withAsk={
+                                customization.aiSearch?.enabled ||
+                                customization.ai?.mode !== CustomizationAIMode.None
+                            }
                             withAIChat={withAIChat}
                             isMultiVariants={isMultiVariants}
                         />

packages/gitbook/src/lib/utils.ts

@@ -14,6 +14,7 @@ export function defaultCustomization(): api.SiteCustomizationSettings {
             successColor: { light: '#00C950', dark: '#00C950' },
             corners: api.CustomizationCorners.Rounded,
             font: api.CustomizationDefaultFont.Inter,
+            monospaceFont: api.CustomizationDefaultMonospaceFont.IBMPlexMono,
             background: api.CustomizationBackground.Plain,
             icons: api.CustomizationIconsStyle.Regular,
             links: api.CustomizationLinksStyle.Default,
@@ -48,9 +49,13 @@ export function defaultCustomization(): api.SiteCustomizationSettings {
         feedback: {
             enabled: false,
         },
+        // TODO: remove aiSearch once the cache has been fully updated (after 11/07/2025)
         aiSearch: {
             enabled: true,
         },
+        ai: {
+            mode: api.CustomizationAIMode.None,
+        },
         externalLinks: {
             target: api.SiteExternalLinksTarget.Self,
         },