@stainless-api/docs 0.1.0-beta.129 → 0.1.0-beta.130

package/stl-docs/index.ts

@@ -76,7 +76,7 @@ function stainlessDocsStarlightIntegration(config: NormalizedStainlessDocsConfig
     disableCalloutSyntaxStarlightPlugin,
   ];
 
-  if (config.apiReference !== null) {
+  if (config.apiReference) {
     plugins.push(
       stainlessStarlight({
         ...config.apiReference,
@@ -162,8 +162,6 @@ function stainlessDocsIntegration(
   config: NormalizedStainlessDocsConfig,
   apiReferenceBasePath: string | null,
 ): AstroIntegration {
-  // The '\0' prefix tells Vite “this is a virtual module” and prevents it from being resolved again.
-  const resolveVirtualModuleId = (id: string) => `\0${id}`;
   let redirects: NormalizedRedirectConfig | null = null;
 
   return {
@@ -196,56 +194,44 @@ function stainlessDocsIntegration(
               FONTS: getFontRoles(config.fonts),
               LINK_GROUP_TITLES_TO_OVERVIEW_PAGES: config.linkGroupTitlesToOverviewPages,
               RENDER_CREDITS: config.credits,
+              SITE_TITLE: config.siteTitle,
+              ENABLE_AI_CHAT: !!config.aiChat,
             } satisfies typeof StlDocsVirtualModule),
-
-            'virtual:stl-docs/components/AiChat.tsx': `
-              ${
-                config.aiChat
-                  ? `export { default } from ${JSON.stringify(config.aiChat.chatComponentPath)};`
-                  : // export null when no AI chat component is provided
-                    `export default null;`
-              }
-              export const STAINLESS_PROJECT = ${config.apiReference ? JSON.stringify(config.apiReference.stainlessProject) : 'undefined'};
-            `,
           }),
         );
 
         updateConfig({
           fonts: [...flattenFonts(config.fonts), ...(astroConfig?.fonts ?? [])],
           vite: {
+            define: {
+              __STLDOCS_HAS_API_REFERENCE__: !!config.apiReference,
+              __STLDOCS_ENABLE_AI_CHAT__: !!config.aiChat,
+            },
             plugins: [
               {
-                name: 'stl-docs-vite',
+                name: 'stl-docs-virtual-modules',
                 resolveId(id) {
-                  if (virtualModules.has(id)) return resolveVirtualModuleId(id);
+                  // The '\0' prefix tells Vite “this is a virtual module” and prevents it from being resolved again.
+                  if (virtualModules.has(id)) return `\0${id}`;
                 },
                 load(id) {
                   const bare = id.replace(/^\0/, '');
                   if (virtualModules.has(bare)) return virtualModules.get(bare);
                 },
               },
+              // Separate plugin for the examples because it has async resolution; not a simple string
+              // like the above plugins
               ...(config.aiChat
                 ? [
                     await generateExamplesPlugin({
                       projectName: config.apiReference?.stainlessProject ?? undefined,
                       logger,
-                      exampleOverrides: config.aiChat?.exampleOverrides,
+                      exampleOverrides:
+                        typeof config.aiChat === 'object' ? config.aiChat.exampleOverrides : undefined,
                     }),
                   ]
                 : []),
             ],
-            optimizeDeps: {
-              include: config.aiChat
-                ? [
-                    '@stainless-api/docs-ai-chat > @stainless-api/ai-chat > lucide-react',
-                    '@stainless-api/docs-ai-chat > @stainless-api/ai-chat > motion',
-                    '@stainless-api/docs-ai-chat > @stainless-api/ai-chat > motion > framer-motion',
-                    '@stainless-api/docs-ai-chat > @stainless-api/ai-chat > react-markdown',
-                    '@stainless-api/docs-ai-chat > @stainless-api/ai-chat > react-syntax-highlighter',
-                    '@stainless-api/docs-ai-chat > @stainless-api/ai-chat > remark-gfm',
-                  ]
-                : [],
-            },
           },
           build: {
             ...astroConfig.build,

package/stl-docs/loadStlDocsConfig.ts

@@ -80,10 +80,7 @@ export type StainlessDocsUserConfig = {
      */
     disableProseMarkdownRendering?: boolean;
     disableStainlessProseIndexing?: boolean;
-    aiChat?: {
-      chatComponentPath: string;
-      exampleOverrides?: ExamplePromptResponse;
-    };
+    aiChat?: { exampleOverrides?: ExamplePromptResponse } | true;
     /**
      * Whether to link group titles to overview pages. Note: overview pages must already be present in the sidebar for this to work.
      *
@@ -140,6 +137,19 @@ function normalizeRouteMiddleware(userConfig: StainlessDocsUserConfig) {
   return entry;
 }
 
+function normalizeSiteTitle(userConfig: StainlessDocsUserConfig) {
+  if (typeof userConfig.title === 'string') {
+    return userConfig.title;
+  }
+  if (typeof userConfig.title === 'object') {
+    const firstValue = Object.values(userConfig.title)[0];
+    if (typeof firstValue === 'string') {
+      return firstValue;
+    }
+  }
+  throw new Error('Site title provided in config is not valid.');
+}
+
 function normalizeConfig(userConfig: StainlessDocsUserConfig) {
   const splitTabsEnabled = areSplitTabsEnabled(userConfig);
 
@@ -189,6 +199,7 @@ function normalizeConfig(userConfig: StainlessDocsUserConfig) {
     aiChat: userConfig.experimental?.aiChat,
     linkGroupTitlesToOverviewPages: userConfig.experimental?.linkGroupTitlesToOverviewPages ?? false,
     credits: !userConfig.disableCredits,
+    siteTitle: normalizeSiteTitle(userConfig),
   };
 
   return configWithDefaults;

package/stl-docs/proseSearchIndexing.ts

@@ -103,7 +103,7 @@ function chunkTextByWords(text: string): string[] {
   return chunks;
 }
 
-export type IndexEntry = {
+type IndexEntry = {
   chunk: { id: string; index: number; total: number };
   id: string;
   tag: string;
@@ -123,11 +123,7 @@ const DEFAULT_PATTERN = 'h1, h2, h3, h4, h5, h6, p, li, pre code';
  * - Extracts language metadata from code blocks (class="language-js")
  * - Uses word-based chunking with sentence boundary detection
  */
-export function* indexHTML(
-  content: string,
-  root = DEFAULT_ROOT,
-  pattern = DEFAULT_PATTERN,
-): Generator<IndexEntry> {
+function* indexHTML(content: string, root = DEFAULT_ROOT, pattern = DEFAULT_PATTERN): Generator<IndexEntry> {
   const $ = cheerio.load(content);
   const matches = $(root).find(pattern);
 

package/virtual-module.d.ts

@@ -21,6 +21,8 @@ declare module 'virtual:stl-starlight-virtual-module' {
   export const MIDDLEWARE: StlStarlightMiddleware;
   export const ENABLE_CONTEXT_MENU: boolean;
   export const STAINLESS_PROJECT: string | undefined;
+  export const LLMS_TXT_DESCRIPTION: string | null;
+  export const LLMS_TXT_DETAIL_THRESHOLD: number;
 }
 
 declare module 'virtual:stl-docs-virtual-module' {
@@ -61,26 +63,12 @@ declare module 'virtual:stl-docs-virtual-module' {
     additional?: FontConfig[];
   };
   export const RENDER_CREDITS: boolean;
-}
-
-declare module 'virtual:stl-docs/components/AiChat.tsx' {
-  const AiChatComponent:
-    | import('react').ComponentType<{
-        projectId: string;
-        language: import('@stainless-api/docs-ui/routing').DocsLanguage | undefined;
-        siteTitle: string | undefined;
-      }>
-    | null;
-  export default AiChatComponent;
-  export const STAINLESS_PROJECT: string | undefined;
+  export const SITE_TITLE: string;
+  export const ENABLE_AI_CHAT: boolean;
 }
 
 declare module 'virtual:stl-docs-ai-chat-examples' {
-  export type ExamplePrompt = {
-    longPrompt: string;
-    shortPrompt: string;
-    icon: React.ComponentType;
-  };
+  import type { ExamplePrompt } from './stl-docs/chat/ui/types';
 
   export const examples: ExamplePrompt[] | undefined;
 }
@@ -110,3 +98,6 @@ declare module 'virtual:stl-starlight-reference-sidebars' {
 
   export const sidebars: GeneratedSidebarDef[];
 }
+
+declare const __STLDOCS_HAS_API_REFERENCE__: boolean;
+declare const __STLDOCS_ENABLE_AI_CHAT__: boolean;

package/stl-docs/components/ClientRouterHead.astro

@@ -1,41 +0,0 @@
----
-import { ClientRouter } from 'astro:transitions';
-import Default from '@astrojs/starlight/components/Head.astro';
----
-
-<style is:global>
-  /* Disable native View Transitions animations */
-  :root::view-transition-old(root),
-  :root::view-transition-new(root) {
-    animation: none;
-  }
-  :root::view-transition-group(root) {
-    animation-duration: 0s;
-  }
-</style>
-
-<script>
-  console.log('[EXPERIMENTAL] using client router');
-</script>
-<script>
-  function setNavLinksMode(doc: Document) {
-    let mode = localStorage.getItem('stl-nav-links-mode');
-    // initial guess
-    if (mode === null) {
-      mode = window.innerWidth < 1000 ? 'mobile' : 'desktop';
-    }
-    doc.documentElement.classList.add('stl-nav-links-mode-' + mode);
-  }
-
-  setNavLinksMode(document);
-
-  // https://docs.astro.build/en/guides/view-transitions/#astrobefore-swap
-
-  document.addEventListener('astro:before-swap', (event) => {
-    setNavLinksMode(event.newDocument);
-  });
-</script>
-
-<ClientRouter />
-
-<Default />