@stainless-api/docs 0.1.0-beta.80 → 0.1.0-beta.82

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @stainless-api/docs
 
+## 0.1.0-beta.82
+
+### Patch Changes
+
+- 29089a7: add experimental support for prerender flag
+
+## 0.1.0-beta.81
+
+### Patch Changes
+
+- 5c257e2: separate steelie into separate packages
+
 ## 0.1.0-beta.80
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stainless-api/docs",
-  "version": "0.1.0-beta.80",
+  "version": "0.1.0-beta.82",
   "publishConfig": {
     "access": "public"
   },

package/plugin/index.ts

@@ -208,20 +208,20 @@ async function stlStarlightAstroIntegration(
         injectRoute({
           pattern: `${pluginConfig.basePath}/[...slug]/index.md`,
           entrypoint: resolveSrcFile('/plugin/routes/markdown.ts'),
-          prerender: command === 'build',
+          prerender: pluginConfig.experimentalPrerender ? command === 'build' : false,
         });
 
         const astroFile = command === 'build' ? 'DocsStatic' : 'Docs';
         injectRoute({
           pattern: `${pluginConfig.basePath}/[...slug]`,
           entrypoint: resolveSrcFile(`/plugin/routes/${astroFile}.astro`),
-          prerender: command === 'build',
+          prerender: pluginConfig.experimentalPrerender ? command === 'build' : false,
         });
 
         injectRoute({
           pattern: pluginConfig.basePath,
           entrypoint: resolveSrcFile('/plugin/routes/Overview.astro'),
-          prerender: command === 'build',
+          prerender: pluginConfig.experimentalPrerender ? command === 'build' : false,
         });
 
         updateConfig({

package/plugin/loadPluginConfig.ts

@@ -140,6 +140,12 @@ export type StainlessStarlightUserConfig = {
 
   /** When set to true, enables the experimental request builder interface for testing API endpoints. */
   experimentalRequestBuilder?: boolean;
+
+  /** Whether to prerender the api reference pages.
+   *
+   * @default true
+   */
+  experimentalPrerender?: boolean;
 };
 
 export type ExternalSpecServerUserConfig = Omit<StainlessStarlightUserConfig, 'stainlessProject'> & {
@@ -276,6 +282,7 @@ function normalizeConfig(partial: SomeStainlessStarlightUserConfig, command: Ast
     contextMenu: partial.contextMenu ?? true,
     experimentalPlaygrounds: partial.experimentalPlaygrounds ?? undefined,
     experimentalRequestBuilder: partial.experimentalRequestBuilder ?? false,
+    experimentalPrerender: partial.experimentalPrerender ?? true,
   };
 
   function getSpecRetrieverConfig(): SpecRetrieverConfig {

package/plugin/routes/markdown.ts

@@ -55,5 +55,3 @@ export const GET: APIRoute<RouteProps> = async ({ props }) => {
     headers: { 'Content-Type': 'text/plain' },
   });
 };
-
-export const prerender = true;

package/stl-docs/index.ts

@@ -73,6 +73,10 @@ function stainlessDocsStarlightIntegration(config: NormalizedStainlessDocsConfig
       stainlessStarlight({
         ...config.apiReference,
         contextMenu: config.contextMenu,
+        experimentalPrerender:
+          config.apiReference.experimentalPrerender === undefined
+            ? config.starlightPassThrough.prerender
+            : config.apiReference.experimentalPrerender,
       }),
     );
     componentOverrides.Sidebar = resolveSrcFile(COMPONENTS_FOLDER, './sidebars/SDKSelectSidebar.astro');
@@ -208,12 +212,12 @@ function stainlessDocsIntegration(
             optimizeDeps: {
               include: config.aiChat
                 ? [
-                    '@stainless-api/docs-ai-chat > lucide-react',
-                    '@stainless-api/docs-ai-chat > motion',
-                    '@stainless-api/docs-ai-chat > motion > framer-motion',
-                    '@stainless-api/docs-ai-chat > react-markdown',
-                    '@stainless-api/docs-ai-chat > react-syntax-highlighter',
-                    '@stainless-api/docs-ai-chat > remark-gfm',
+                    '@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',
                   ]
                 : [],
             },

package/stl-docs/loadStlDocsConfig.ts

@@ -37,7 +37,7 @@ type PassThroughStarlightConfigOptions = Pick<
 
 type ExperimentalStarlightCompatibilityConfig = Pick<
   StarlightConfigDefined,
-  'components' | 'routeMiddleware' | 'plugins'
+  'components' | 'routeMiddleware' | 'plugins' | 'prerender'
 >;
 
 export type Tabs = {
@@ -152,6 +152,7 @@ function normalizeConfig(userConfig: StainlessDocsUserConfig) {
       locales: userConfig.locales,
       lastUpdated: userConfig.lastUpdated,
       pagination: userConfig.pagination,
+      prerender: userConfig.experimental?.starlightCompat?.prerender ?? true,
     },
     starlightCompat: {
       components: userConfig.experimental?.starlightCompat?.components ?? {},