@stainless-api/docs 0.1.0-beta.18 → 0.1.0-beta.19

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @stainless-api/docs
 
+## 0.1.0-beta.19
+
+### Patch Changes
+
+- 15c003d: fix react peer dependencies
+- Updated dependencies [15c003d]
+  - @stainless-api/docs-ui@0.1.0-beta.15
+  - @stainless-api/ui-primitives@0.1.0-beta.15
+
 ## 0.1.0-beta.18
 
 ### Patch Changes

package/eslint-suppressions.json

@@ -0,0 +1,47 @@
+{
+  "plugin/buildAlgoliaIndex.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 2
+    }
+  },
+  "plugin/cms/client.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 1
+    }
+  },
+  "plugin/cms/server.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 4
+    }
+  },
+  "plugin/cms/sidebar-builder.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 1
+    }
+  },
+  "plugin/cms/worker.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 4
+    }
+  },
+  "plugin/components/SnippetCode.tsx": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 1
+    }
+  },
+  "plugin/index.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 1
+    }
+  },
+  "plugin/languages.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 1
+    }
+  },
+  "shared/virtualModule.ts": {
+    "@typescript-eslint/no-explicit-any": {
+      "count": 1
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stainless-api/docs",
-  "version": "0.1.0-beta.18",
+  "version": "0.1.0-beta.19",
   "publishConfig": {
     "access": "public"
   },
@@ -24,7 +24,10 @@
   },
   "peerDependencies": {
     "@astrojs/starlight": ">=0.36.1",
-    "astro": ">=5.15.3"
+    "astro": ">=5.15.3",
+    "vite": ">=6.2.1",
+    "react": ">=19.0.0",
+    "react-dom": ">=19.0.0"
   },
   "dependencies": {
     "@astrojs/markdown-remark": "^6.3.2",
@@ -37,8 +40,6 @@
     "highlight.js": "^11.11.1",
     "lucide-react": "^0.544.0",
     "marked": "^16.0.0",
-    "react": "^19.2.0",
-    "react-dom": "^19.2.0",
     "remark-github-alerts": "^0.1.1",
     "shiki": "^3.9.2",
     "web-worker": "^1.5.0",
@@ -49,21 +50,28 @@
     "remark-gfm": "^4.0.1",
     "remark-stringify": "^11.0.0",
     "unified": "^11.0.5",
-    "@stainless-api/docs-ui": "0.1.0-beta.14",
-    "@stainless-api/ui-primitives": "0.1.0-beta.14"
+    "@stainless-api/docs-ui": "0.1.0-beta.15",
+    "@stainless-api/ui-primitives": "0.1.0-beta.15"
   },
   "devDependencies": {
+    "@astrojs/check": "^0.9.5",
     "@markdoc/markdoc": "^0.5.2",
     "@types/node": "^24.4.0",
     "@types/react": "^19.2.2",
     "@types/react-dom": "^19.2.2",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
     "tsx": "^4.20.3",
+    "typescript": "5.9.3",
+    "vite": "^6.3.6",
     "zod": "^4.0.0",
+    "@stainless/sdk-json": "^0.0.0",
     "@stainless/eslint-config": "0.0.0"
   },
   "scripts": {
     "vendor-deps": "pnpm tsx scripts/vendor_deps.ts",
     "lint": "eslint . --max-warnings 0",
-    "sync": "astro sync"
+    "sync": "astro sync",
+    "check:types": "astro check"
   }
 }

package/plugin/buildAlgoliaIndex.ts

@@ -1,7 +1,7 @@
 import Markdoc from '@markdoc/markdoc';
 import Stainless from '@stainless-api/sdk';
 import { createSDKJSON, parseInputs, transformOAS } from './cms/worker';
-import type * as SDKJSON from '~/lib/json-spec-v2/types';
+import type * as SDKJSON from '@stainless/sdk-json';
 import { Languages } from '@stainless-api/docs-ui/src/routing';
 import { buildIndex } from '@stainless-api/docs-ui/src/search/providers/algolia';
 import type { VersionUserConfig } from './loadPluginConfig';

package/plugin/cms/server.ts

@@ -2,7 +2,7 @@ import type { AstroIntegrationLogger } from 'astro';
 import { createServer, IncomingMessage } from 'http';
 import { readFile } from 'fs/promises';
 
-import type * as SDKJSON from '~/lib/json-spec-v2/types';
+import type * as SDKJSON from '@stainless/sdk-json';
 import { createSDKJSON, parseInputs, transformOAS } from './worker';
 import { Languages, parseRoute, type DocsLanguage } from '@stainless-api/docs-ui/src/routing';
 import Stainless, { APIError } from '@stainless-api/sdk';
@@ -20,7 +20,7 @@ export type InputFilePaths = {
   configPath?: string;
 };
 
-async function versionInfo(project: string, apiKey: string) {
+async function versionInfo(project: string, apiKey: string): Promise<Record<DocsLanguage, string>> {
   const data = await fetch(`https://api.stainless.com/api/projects/${project}/package-versions`, {
     headers: { Authorization: `Bearer ${apiKey}` },
   });

package/plugin/cms/sidebar-builder.ts

@@ -1,4 +1,4 @@
-import type * as SDKJSON from '~/lib/json-spec-v2/types';
+import type * as SDKJSON from '@stainless/sdk-json';
 import { generateRoute, walkTree, type DocsLanguage } from '@stainless-api/docs-ui/src/routing';
 import type { StarlightRouteData } from '@astrojs/starlight/route-data';
 
@@ -120,22 +120,12 @@ export type GeneratedSidebarConfig = {
 };
 
 function countKeys(obj?: Record<string, any>) {
-  let o = obj ?? {};
+  const o = obj ?? {};
   return Object.keys(o).length;
 }
 
-function getMethodDeclForLanguage(entry: SDKJSON.Method, spec: SDKJSON.Spec, language: DocsLanguage) {
-  const decls = spec.decls[language] ?? {};
-  const decl = decls[entry.stainlessPath];
-  if (decl !== undefined) {
-    if ('ident' in decl) {
-      return decl;
-    }
-  }
-  return null;
-}
-
-type MethodDecl = Exclude<ReturnType<typeof getMethodDeclForLanguage>, null>;
+type HasIdent<T> = T extends { ident: unknown } ? T : never;
+type MethodDecl = HasIdent<SDKJSON.LanguageDeclNodes[SDKJSON.SpecLanguage]>;
 
 function makeAPIOverviewPage(): UserSidebarAPIOverviewPage {
   return {
@@ -166,7 +156,7 @@ function pullOutSharedModelsResource(resources: SDKJSON.Resource[]): {
 }
 
 export class SidebarConfigItemsBuilder {
-  private getMethodDeclForLanguage(entry: SDKJSON.Method) {
+  private getMethodDeclForLanguage(entry: SDKJSON.Method): MethodDecl | null {
     const decls = this.spec.decls[this.language] ?? {};
     const decl = decls[entry.stainlessPath];
     if (decl !== undefined) {
@@ -244,7 +234,7 @@ export class SidebarConfigItemsBuilder {
 
   public generateItems(): ReferenceSidebarConfigItem[] {
     const resourceMap = this.spec.resources;
-    let { resources, sharedModelsResource } = pullOutSharedModelsResource(Object.values(resourceMap ?? {}));
+    const { resources, sharedModelsResource } = pullOutSharedModelsResource(Object.values(resourceMap ?? {}));
 
     const entries: ReferenceSidebarConfigItem[] = resources.filter(isResourceNonEmpty).map((r) => {
       return this.generateResourceGroup(r, false);

package/plugin/cms/worker.ts

@@ -1,6 +1,6 @@
 import Worker from 'web-worker';
 import { Languages, type DocsLanguage } from '@stainless-api/docs-ui/src/routing';
-import type * as SDKJSON from '~/lib/json-spec-v2/types';
+import type * as SDKJSON from '@stainless/sdk-json';
 import { fileURLToPath } from 'node:url';
 import { dirname, resolve } from 'node:path';
 import fs from 'fs/promises';
@@ -98,7 +98,7 @@ export async function createSDKJSON({
       try {
         const content = await fs.readFile(mdfile);
         return [language, content.toString()];
-      } catch (err) {
+      } catch {
         return [language, null];
       }
     }),

package/plugin/components/SnippetCode.tsx

@@ -54,7 +54,7 @@ function wrapFirstNSpaces($line: cheerio.Cheerio<any>, n: number) {
   const m = inner.match(new RegExp(`^( {1,${n}})`));
   if (!m) return;
 
-  const lead = m[1];
+  const lead = m[1]!;
   $firstSpan.html(`<span class="leading-ws">${lead}</span>${inner.slice(lead.length)}`);
 }
 

package/plugin/components/search/SearchIsland.tsx

@@ -1,5 +1,5 @@
 import * as React from 'react';
-import { BASE_PATH, SEARCH } from 'virtual:stl-starlight-virtual-module';
+import { BASE_PATH, HIGHLIGHT_THEMES, SEARCH } from 'virtual:stl-starlight-virtual-module';
 import { parseRoute, generateRoute } from '@stainless-api/docs-ui/src/routing';
 import { SearchModal } from '@stainless-api/docs-ui/src/search/index';
 import { ChatModal } from '@stainless-api/docs-ui/src/components/chat';
@@ -9,6 +9,7 @@ import type { BundledLanguage, BundledTheme, HighlighterGeneric } from 'shiki';
 
 import {
   DocsProvider,
+  type MarkdownContext,
   MarkdownProvider,
   NavigationProvider,
   SearchProvider,
@@ -27,7 +28,7 @@ async function getHighlighter() {
   return $$highlighter;
 }
 
-async function createMarkdownRenderer() {
+async function createMarkdownRenderer(): Promise<MarkdownContext> {
   const highlighter = await getHighlighter();
   const markdocConfig: Markdoc.Config = {
     nodes: {
@@ -66,16 +67,25 @@ async function createMarkdownRenderer() {
     },
   };
 
-  return (content: string) => {
-    const ast = Markdoc.parse(content);
-    const transformed = Markdoc.transform(ast, markdocConfig);
-    return Markdoc.renderers.html(transformed);
+  return {
+    render: (content: string) => {
+      const ast = Markdoc.parse(content);
+      const transformed = Markdoc.transform(ast, markdocConfig);
+      return Markdoc.renderers.html(transformed);
+    },
+    highlight: (content: string, language: string) => {
+      return highlighter.codeToHtml(content, {
+        lang: language ?? 'javascript',
+        themes: HIGHLIGHT_THEMES || {},
+      });
+    },
   };
 }
 
 export function DocsSearch({ settings, currentPath }: { settings: SearchSettings; currentPath: string }) {
-  const renderMarkdown = React.use(createMarkdownRenderer());
+  const markdownRenderer = React.use(createMarkdownRenderer());
   const { stainlessPath, language } = parseRoute(BASE_PATH, currentPath);
+  // eslint-disable-next-line turbo/no-undeclared-env-vars
   const pageFind = import.meta.env.DEV ? undefined : '/pagefind/pagefind.js';
 
   function handleSelect(path: string) {
@@ -86,7 +96,7 @@ export function DocsSearch({ settings, currentPath }: { settings: SearchSettings
   return (
     <DocsProvider spec={null} language={language}>
       <NavigationProvider basePath="/" selectedPath={stainlessPath}>
-        <MarkdownProvider render={renderMarkdown}>
+        <MarkdownProvider {...markdownRenderer}>
           <SearchProvider onSelect={handleSelect} pageFind={pageFind} settings={settings}>
             <div className="stldocs-root">
               <SearchModal id="stldocs-search" />

package/plugin/generateAPIReferenceLink.ts

@@ -1,7 +1,7 @@
 // This is probably temporary, but it fills in functionality needed for Mintlify imports
 
 import type { StarlightRouteData } from '@astrojs/starlight/route-data';
-import type * as SDKJSON from '~/lib/json-spec-v2/types';
+import type * as SDKJSON from '@stainless/sdk-json';
 import { walkTree } from '@stainless-api/docs-ui/src/routing';
 
 const INTERNAL_REFERENCE_ENTRY_MARKER = 'STL_STARLIGHT_API_REFERENCE_METHOD_LINK_PLACEHOLDER';

package/plugin/index.ts

@@ -122,7 +122,7 @@ async function stlStarlightAstroIntegration(
 
   const { apiKey, version, devPaths } = tmpGetCMSServerConfig(pluginConfig.specRetrieverConfig);
 
-  const cmsServer = await startDevServer({
+  const cmsServer = startDevServer({
     port: CMS_PORT,
     apiKey: apiKey.value,
     version,
@@ -225,6 +225,8 @@ async function stlStarlightAstroIntegration(
                         EXPERIMENTAL_COLLAPSIBLE_SNIPPETS: pluginConfig.experimentalCollapsibleSnippets,
                         PROPERTY_SETTINGS: pluginConfig.propertySettings,
                         SEARCH: pluginConfig.search,
+                        // @ts-expect-error internal prop
+                        ENABLE_CONTEXT_MENU: pluginConfig._contextMenu,
                       }),
                       vmMiddlewareExport,
                     ].join('\n');

package/plugin/languages.ts

@@ -44,7 +44,7 @@ export function applyLanguageToLinks(basePath?: string, defaultLanguage?: string
     `[data-stldocs-overview],[data-stldocs-method],a.nav-link[href^='${basePath}']`,
   );
 
-  for (var link of links) {
+  for (const link of links) {
     const href = link.getAttribute('href');
     const prefix = generatePrefix(basePath, language);
     if (href?.startsWith(basePath) && !href?.startsWith(prefix)) {

package/plugin/loadPluginConfig.ts

@@ -299,7 +299,9 @@ function normalizeConfig(partial: SomeStainlessStarlightUserConfig, command: Ast
     if (!apiKey) {
       throw new Error(
         [
-          bold('No Stainless credentials found. Please choose one of the following options to authenticate with Stainless:'),
+          bold(
+            'No Stainless credentials found. Please choose one of the following options to authenticate with Stainless:',
+          ),
           '- Run `stl auth login` to authenticate via the Stainless CLI',
           '- Provide a Stainless API key via the `STAINLESS_API_KEY` environment variable (eg. in a .env file)',
           '- Set the `apiKey` option in the Stainless Docs config',

package/plugin/react/Routing.tsx

@@ -6,7 +6,7 @@ import remarkGfmAlerts from 'remark-github-alerts';
 
 import type { MarkdownHeading } from 'astro';
 import type { StarlightRouteData } from '@astrojs/starlight/route-data';
-import type * as SDKJSON from '~/lib/json-spec-v2/types';
+import type * as SDKJSON from '@stainless/sdk-json';
 import { LanguageNames, type DocsLanguage } from '@stainless-api/docs-ui/src/routing';
 
 import {
@@ -48,9 +48,8 @@ import {
   HIGHLIGHT_THEMES,
   BREADCRUMB_CONFIG,
   PROPERTY_SETTINGS,
+  ENABLE_CONTEXT_MENU,
 } from 'virtual:stl-starlight-virtual-module';
-// TODO (eventually): this file should really probably only be importing from the starlight virtual module
-import { ENABLE_CONTEXT_MENU } from 'virtual:stl-docs-virtual-module';
 import style from '@stainless-api/docs-ui/src/style';
 import { createHighlighter, type BundledLanguage, type BundledTheme, type HighlighterGeneric } from 'shiki';
 import { SnippetCode, SnippetContainer, SnippetRequestContainer } from '../components/SnippetCode';
@@ -302,7 +301,10 @@ export function RenderSpec({
   const parsed = parseStainlessPath(path);
   const resource = getResourceFromSpec(path, spec);
 
-  if (!resource || !parsed) return null;
+  if (!resource || !parsed) {
+    console.warn(`Could not find resource or parsed path for '${path}'`);
+    return null;
+  }
 
   return (
     <DocsProvider
@@ -336,7 +338,7 @@ export function RenderSpec({
                 </div>
                 {kind === 'http_method' ? (
                   <SDKMethod
-                    method={resource.methods[parsed.method]}
+                    method={resource.methods[parsed.method!]!}
                     transformRequestSnippet={transformRequestSnippet}
                   />
                 ) : (
@@ -357,10 +359,14 @@ export function RenderMethod({ path }: { path: string }) {
 
   const parsed = parseStainlessPath(path);
   const resource = getResourceFromSpec(path, spec);
-  if (!resource || !parsed) return null;
 
-  const meth = resource.methods[parsed.method];
-  return <SDKMethod method={meth} />;
+  if (!resource || !parsed) {
+    console.warn(`Could not find resource or parsed path for '${path}'`);
+    return null;
+  }
+
+  const method = resource.methods[parsed.method!]!;
+  return <SDKMethod method={method} />;
 }
 
 export async function getReadmeContent(spec: SDKJSON.Spec, language: DocsLanguage) {

package/plugin/referencePlaceholderUtils.ts

@@ -58,7 +58,7 @@ function recursiveGetPlaceholderItems(
   items: PlaceholderItemResult[],
 ): PlaceholderItemResult[] {
   for (let i = 0; i < sidebar.length; i++) {
-    const entry = sidebar[i];
+    const entry = sidebar[i]!;
     if ('attrs' in entry && entry.attrs?.about === INTERNAL_REFERENCE_ENTRY_MARKER) {
       items.push({
         index: i,

package/plugin/routes/Docs.astro

@@ -1,16 +1,15 @@
 ---
-import StarlightPage from "@astrojs/starlight/components/StarlightPage.astro";
-import { cmsClient } from "../cms/client";
+import StarlightPage from '@astrojs/starlight/components/StarlightPage.astro';
+import { cmsClient } from '../cms/client';
 import {
   getReadmeContent,
   generateDocsRoutes,
   buildPageNavigation,
   RenderSpec,
   astroMarkdownRender,
-} from "../react/Routing";
-import { getResourceFromSpec } from "@stainless-api/docs-ui/src/utils";
-import { BASE_PATH, CONTENT_PANEL_LAYOUT,MIDDLEWARE } from "virtual:stl-starlight-virtual-module";
-
+} from '../react/Routing';
+import { getResourceFromSpec } from '@stainless-api/docs-ui/src/utils';
+import { BASE_PATH, CONTENT_PANEL_LAYOUT, MIDDLEWARE } from 'virtual:stl-starlight-virtual-module';
 
 const spec = await cmsClient.getSpec();
 const routes = generateDocsRoutes(spec);
@@ -18,29 +17,24 @@ const routes = generateDocsRoutes(spec);
 const route = routes.find((r) => r.params.slug === Astro.params.slug);
 
 if (!route) {
-  throw new Error("No such route");
+  throw new Error(`Could not find a route for slug '${Astro.params.slug}'`);
 }
 
 // PageTitle override will skip rendering the default Starlight title
 // @ts-expect-error - _stlStarlightPage isn't typed yet
 Astro.locals._stlStarlightPage = {
   skipRenderingStarlightTitle: route.props.kind === 'readme' ? false : true,
-}
+};
 
 const readmeContent = await getReadmeContent(spec, route.props.language);
-const readme =
-  route.props.kind === "readme"
-    ? await astroMarkdownRender(readmeContent ?? "")
-    : null;
+const readme = route.props.kind === 'readme' ? await astroMarkdownRender(readmeContent ?? '') : null;
 
-const resource = route.props.stainlessPath
-  ? getResourceFromSpec(route.props.stainlessPath, spec)
-  : null;
+const resource = route.props.stainlessPath ? getResourceFromSpec(route.props.stainlessPath, spec) : null;
 
 const pageNav =
-  route.props.kind === "resource" && resource
+  route.props.kind === 'resource' && resource
     ? buildPageNavigation(resource)
-    : route.props.kind === "readme" && readme?.metadata
+    : route.props.kind === 'readme' && readme?.metadata
       ? readme?.metadata.headings
       : [];
 
@@ -48,33 +42,27 @@ const props = route.props;
 
 if (readme) {
   const repo = spec.metadata?.[props.language]?.code_url;
-  readme.code = readme.code.replace(
-    /<a href="(?!(?:https?:\/\/|\/\/))([^"]+)"/g,
-    `<a href="${repo}/$1"`);
-  props.title = readme.metadata.headings[0].text ?? "Overview";
+  readme.code = readme.code.replace(/<a href="(?!(?:https?:\/\/|\/\/))([^"]+)"/g, `<a href="${repo}/$1"`);
+  props.title = readme.metadata.headings[0]!.text ?? 'Overview';
 }
-
 ---
 
-
 <StarlightPage
   headings={pageNav}
   frontmatter={{
     title: props?.title,
     head: [
       {
-        tag: "link",
+        tag: 'link',
         attrs: {
-          rel: "alternate",
-          type: "text/markdown",
-          href: `${BASE_PATH}/${Astro.params.slug}.md`
-        }
-      }
+          rel: 'alternate',
+          type: 'text/markdown',
+          href: `${BASE_PATH}/${Astro.params.slug}.md`,
+        },
+      },
     ],
     pagefind: false,
-    tableOfContents: ["resource", "readme"].includes(props.kind)
-      ? { maxHeadingLevel: 6 }
-      : false,
+    tableOfContents: ['resource', 'readme'].includes(props.kind) ? { maxHeadingLevel: 6 } : false,
   }}
 >
   {
@@ -90,7 +78,9 @@ if (readme) {
           transformRequestSnippet={MIDDLEWARE.transformRequestSnippet}
         />
 
-        <style is:inline>
+        <style
+          is:inline
+          set:text={`
           #stldocs-snippet-title {
             display: flex;
             gap: 5px;
@@ -104,45 +94,47 @@ if (readme) {
             }
           }
 
-
           [data-has-sidebar]:not([data-has-toc]) .sl-container {
             max-width: 1428px;
           }
-          
-        </style>
+        `}
+        />
       </div>
     ) : (
       <>
         <Fragment set:html={readme?.code} />
-        <style is:inline>
-          .sl-markdown-content h1:first-of-type {
-            display: none;
-          }
+        <style
+          is:inline
+          set:text={`
+            .sl-markdown-content h1:first-of-type {
+              display: none;
+            }
 
-          .sl-markdown-content img {
-            display: inline-block;
-            vertical-align: text-bottom;
-          }
+            .sl-markdown-content img {
+              display: inline-block;
+              vertical-align: text-bottom;
+            }
 
-          .sl-markdown-content .octicon {
-            margin-right: 0.2rem;
-            overflow: visible !important;
-            -webkit-mask: var(--oct-icon) no-repeat;
-            mask: var(--oct-icon) no-repeat;
-            -webkit-mask-size: 100% 100%;
-            mask-size: 100% 100%;
-            background-color: currentColor;
-            color: inherit;
-            display: inline-block;
-            vertical-align: text-bottom;
-            width: 1em;
-            height: 1em;
-          }
+            .sl-markdown-content .octicon {
+              margin-right: 0.2rem;
+              overflow: visible !important;
+              -webkit-mask: var(--oct-icon) no-repeat;
+              mask: var(--oct-icon) no-repeat;
+              -webkit-mask-size: 100% 100%;
+              mask-size: 100% 100%;
+              background-color: currentColor;
+              color: inherit;
+              display: inline-block;
+              vertical-align: text-bottom;
+              width: 1em;
+              height: 1em;
+            }
 
-          .sl-markdown-content code {
-            white-space: pre-wrap;
-          }
-        </style>
+            .sl-markdown-content code {
+              white-space: pre-wrap;
+            }
+          `}
+        />
       </>
     )
   }

package/plugin/routes/Overview.astro

@@ -8,10 +8,10 @@ import { RenderLibraries, RenderSpecOverview, type SpecMetadata } from '../react
 const spec = await cmsClient.getSpec();
 
 const languages: DocsLanguage[] = spec.docs!.languages ?? ['http'];
-const metadata = languages
+const metadata: SpecMetadata = languages
   .filter((language) => !['http', 'terraform'].includes(language) && spec.metadata[language])
   .filter((language) => !EXCLUDE_LANGUAGES.includes(language))
-  .map((language) => [language, spec.metadata[language]]) as SpecMetadata;
+  .map<SpecMetadata[number]>((language) => [language, spec.metadata[language]!]);
 
 // PageTitle override will skip rendering the default Starlight title
 // @ts-expect-error - _stlStarlightPage isn't typed yet

package/plugin/routes/markdown.ts

@@ -47,7 +47,7 @@ export const GET: APIRoute<RouteProps> = async ({ props }) => {
     },
   };
 
-  const target = props.kind === 'http_method' && parsed?.method ? resource.methods[parsed.method] : resource;
+  const target = props.kind === 'http_method' && parsed?.method ? resource.methods[parsed.method]! : resource;
   const output = renderMarkdown(env, target);
 
   return new Response(output, {

package/stl-docs/components/PageTitle.astro

@@ -1,9 +1,10 @@
 ---
-import { ENABLE_CONTEXT_MENU, ENABLE_PROSE_MARKDOWN_RENDERING } from 'virtual:stl-docs-virtual-module';
+import { ENABLE_PROSE_MARKDOWN_RENDERING } from 'virtual:stl-docs-virtual-module';
 import type { StarlightRouteData } from '@astrojs/starlight/route-data';
 import Default from '@astrojs/starlight/components/PageTitle.astro';
 import { ContentBreadcrumbs } from './ContentBreadcrumbs';
 import { AIDropdown } from './AIDropdown';
+import { ENABLE_CONTEXT_MENU } from 'virtual:stl-starlight-virtual-module';
 
 function sidebarHasEntry(sidebarEntry: StarlightRouteData['sidebar'], currentPath?: string) {
   if (!currentPath) return false;

package/stl-docs/components/ThemeSelect.astro

@@ -59,7 +59,7 @@ const options = [
   <Dropdown className="theme-select-container" data-theme-select>
     <DropdownTrigger withChevron>
       <span class="stl-dropdown-icon">
-        {options.map(({ value, label, icon }) => <Fragment set:html={icon} />)}
+        {options.map(({ icon }) => <Fragment set:html={icon} />)}
       </span>
     </DropdownTrigger>
     <DropdownMenu role="listbox">
@@ -182,7 +182,7 @@ const options = [
     applyTheme(event.newDocument, loadTheme());
   });
 
-  document.addEventListener(getPageLoadEvent(), (e) => {
+  document.addEventListener(getPageLoadEvent(), () => {
     setupThemeMode(document);
   });
 </script>

package/stl-docs/components/headers/StackedHeader.astro

@@ -1,12 +1,12 @@
 ---
-import LanguageSelect from "virtual:starlight/components/LanguageSelect";
-import Search from "virtual:starlight/components/Search";
-import SiteTitle from "virtual:starlight/components/SiteTitle";
+import LanguageSelect from 'virtual:starlight/components/LanguageSelect';
+import Search from 'virtual:starlight/components/Search';
+import SiteTitle from 'virtual:starlight/components/SiteTitle';
 import HeaderLinks from './HeaderLinks.astro';
-import { TABS } from "virtual:stl-docs-virtual-module";
-import ThemeSelect from "virtual:starlight/components/ThemeSelect";
-import SecondaryNavTabs from "../nav-tabs/SecondaryNavTabs.astro";
-import SplashMobileMenuToggle from "./SplashMobileMenuToggle.astro";
+import { TABS } from 'virtual:stl-docs-virtual-module';
+import ThemeSelect from 'virtual:starlight/components/ThemeSelect';
+import SecondaryNavTabs from '../nav-tabs/SecondaryNavTabs.astro';
+import SplashMobileMenuToggle from './SplashMobileMenuToggle.astro';
 
 interface Props {
   shouldRenderSearch?: boolean;
@@ -38,14 +38,14 @@ const { hasSidebar } = Astro.locals.starlightRoute;
 <SecondaryNavTabs />
 
 <style is:inline>
-    .stl-top-container {
-      display: flex;
-      flex-direction: row;
-      align-items: center;
-      justify-content: end;
-      gap: 0.5rem;
-      width: 100%;
-    }
+  .stl-top-container {
+    display: flex;
+    flex-direction: row;
+    align-items: center;
+    justify-content: end;
+    gap: 0.5rem;
+    width: 100%;
+  }
   @media (min-width: 50rem) {
     :root {
       --sl-nav-height: 80px;
@@ -64,12 +64,17 @@ const { hasSidebar } = Astro.locals.starlightRoute;
   }
 </style>
 
-{TABS.length === 0 && (
-  <style is:inline>
-    @media (min-width: 50rem) {
-      :root {
-        --sl-nav-height: 56px;
-      }
-    }
-  </style>
-)}
+{
+  TABS.length === 0 && (
+    <style
+      is:inline
+      set:text={`
+        @media (min-width: 50rem) {
+          :root {
+            --sl-nav-height: 56px;
+          }
+        }
+      `}
+    />
+  )
+}

package/stl-docs/components/nav-tabs/NavDropdown.astro

@@ -17,7 +17,7 @@ const BUTTON_ID = 'nav-dropdown-button';
 
 const navLinks = buildNavLinks(Astro.locals.starlightRoute);
 
-const buttonText = (navLinks.find((item) => item.active) ?? navLinks[0]).label;
+const buttonText = (navLinks.find((item) => item.active) ?? navLinks[0]!).label;
 ---
 
 <div class="stldocs-root nav-dropdown-root">

package/stl-docs/components/nav-tabs/buildNavLinks.ts

@@ -1,9 +1,10 @@
 import type { StarlightRouteData } from '@astrojs/starlight/route-data';
 import { TABS } from 'virtual:stl-docs-virtual-module';
+import type { StarlightRouteWithStlDocs } from '../../tabsMiddleware';
 
 export function buildNavLinks(starlightRoute: StarlightRouteData) {
-  // TODO: specify the type of Astro.locals.starlightRoute._stlDocs
-  const activeTabIndex = starlightRoute._stlDocs?.activeTabIndex;
+  const routeData: StarlightRouteWithStlDocs = starlightRoute;
+  const activeTabIndex = routeData?._stlDocs?.activeTabIndex;
 
   const navLinks = TABS.map((item, index) => ({
     ...item,

package/stl-docs/index.ts

@@ -7,7 +7,7 @@ import { disableCalloutSyntaxStarlightPlugin } from './disableCalloutSyntax';
 import type { AstroIntegration } from 'astro';
 
 import { normalizeRedirects, type NormalizedRedirectConfig } from './redirects';
-import path, { join } from 'path';
+import { join } from 'path';
 import { mkdirSync, writeFileSync } from 'fs';
 import {
   parseStlDocsConfig,
@@ -62,7 +62,13 @@ function stainlessDocsStarlightIntegration(config: NormalizedStainlessDocsConfig
   ];
 
   if (config.apiReference !== null) {
-    plugins.push(stainlessStarlight(config.apiReference));
+    plugins.push(
+      stainlessStarlight({
+        ...config.apiReference,
+        // @ts-expect-error internal prop
+        _contextMenu: config.contextMenu,
+      }),
+    );
     componentOverrides.Sidebar = resolveSrcFile(COMPONENTS_FOLDER, './sidebars/SDKSelectSidebar.astro');
     componentOverrides.Search = resolveSrcFile('/plugin/components/search/Search.astro');
   }
@@ -165,7 +171,6 @@ function stainlessDocsIntegration(
                       ENABLE_CLIENT_ROUTER: config.enableClientRouter,
                       API_REFERENCE_BASE_PATH: apiReferenceBasePath,
                       ENABLE_PROSE_MARKDOWN_RENDERING: config.enableProseMarkdownRendering,
-                      ENABLE_CONTEXT_MENU: config.contextMenu,
                     });
                   }
                 },

package/stl-docs/proseMarkdown/proseMarkdownMiddleware.ts

@@ -4,6 +4,7 @@ import { API_REFERENCE_BASE_PATH } from 'virtual:stl-docs-virtual-module';
 
 // this is only run in `astro dev` for rendering prose content as Markdown on the fly.
 export const onRequest = defineMiddleware(async (context, next) => {
+  // eslint-disable-next-line turbo/no-undeclared-env-vars
   if (!import.meta.env.DEV) {
     return next();
   }

package/stl-docs/tabsMiddleware.ts

@@ -58,7 +58,7 @@ function getTabIndexForSlug(
   match: 'exact' | 'prefix';
 } | null {
   // ↓ exact match eg. slug = "/blog" and there is a link containing "/blog"
-  let tab = linksByTab.get(slug);
+  const tab = linksByTab.get(slug)!;
   if (typeof tab === 'string') {
     return {
       match: 'exact',
@@ -88,13 +88,19 @@ function getNonSplitLinksByTab() {
   const linksByTab = new Map<string, string>();
 
   for (let i = 0; i < TABS.length; i++) {
-    const tab = TABS[i];
+    const tab = TABS[i]!;
     linksByTab.set(tab.link, String(i));
   }
 
   return linksByTab;
 }
 
+export interface StarlightRouteWithStlDocs extends StarlightRouteData {
+  _stlDocs?: {
+    activeTabIndex: number;
+  };
+}
+
 export const onRequest = defineRouteMiddleware(async (context) => {
   // if using content collection schema, use: context.locals.starlightRoute.entry.data.stainlessStarlight
   // this worked without collections but relied on hijacking starlightRoute: context.props.frontmatter.stainlessStarlight
@@ -143,7 +149,8 @@ export const onRequest = defineRouteMiddleware(async (context) => {
   }
 
   // We store the active tab index so we can use it in our nav tabs component
-  context.locals.starlightRoute._stlDocs = {
+  const routeData: StarlightRouteWithStlDocs = context.locals.starlightRoute;
+  routeData._stlDocs = {
     activeTabIndex: activeTabIndex.index,
   };
 

package/styles/fonts.css

@@ -5,7 +5,9 @@
   font-display: swap;
   font-weight: 100 900;
   src: url(../plugin/assets/fonts/geist/geist-latin.woff2) format('woff2-variations');
-  unicode-range: U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+0304,U+0308,U+0329,U+2000-206F,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD;
+  unicode-range:
+    U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329,
+    U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
 }
 @font-face {
   font-family: 'Geist';
@@ -13,7 +15,9 @@
   font-display: swap;
   font-weight: 100 900;
   src: url(../plugin/assets/fonts/geist/geist-italic-latin.woff2) format('woff2-variations');
-  unicode-range: U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+0304,U+0308,U+0329,U+2000-206F,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD;
+  unicode-range:
+    U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329,
+    U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
 }
 @font-face {
   font-family: 'Geist';
@@ -21,7 +25,9 @@
   font-display: swap;
   font-weight: 100 900;
   src: url(../plugin/assets/fonts/geist/geist-latin-ext.woff2) format('woff2-variations');
-  unicode-range: U+0100-02BA,U+02BD-02C5,U+02C7-02CC,U+02CE-02D7,U+02DD-02FF,U+0304,U+0308,U+0329,U+1D00-1DBF,U+1E00-1E9F,U+1EF2-1EFF,U+2020,U+20A0-20AB,U+20AD-20C0,U+2113,U+2C60-2C7F,U+A720-A7FF;
+  unicode-range:
+    U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF,
+    U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0, U+2113, U+2C60-2C7F, U+A720-A7FF;
 }
 @font-face {
   font-family: 'Geist';
@@ -29,10 +35,11 @@
   font-display: swap;
   font-weight: 100 900;
   src: url(../plugin/assets/fonts/geist/geist-italic-latin-ext.woff2) format('woff2-variations');
-  unicode-range: U+0100-02BA,U+02BD-02C5,U+02C7-02CC,U+02CE-02D7,U+02DD-02FF,U+0304,U+0308,U+0329,U+1D00-1DBF,U+1E00-1E9F,U+1EF2-1EFF,U+2020,U+20A0-20AB,U+20AD-20C0,U+2113,U+2C60-2C7F,U+A720-A7FF;
+  unicode-range:
+    U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF,
+    U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0, U+2113, U+2C60-2C7F, U+A720-A7FF;
 }
 
-
 /* Geist Mono */
 @font-face {
   font-family: 'Geist Mono';
@@ -40,7 +47,9 @@
   font-display: swap;
   font-weight: 100 900;
   src: url(../plugin/assets/fonts/geist/geist-mono-latin.woff2) format('woff2-variations');
-  unicode-range: U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+0304,U+0308,U+0329,U+2000-206F,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD;
+  unicode-range:
+    U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329,
+    U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
 }
 @font-face {
   font-family: 'Geist Mono';
@@ -48,7 +57,9 @@
   font-display: swap;
   font-weight: 100 900;
   src: url(../plugin/assets/fonts/geist/geist-mono-italic-latin.woff2) format('woff2-variations');
-  unicode-range: U+0000-00FF,U+0131,U+0152-0153,U+02BB-02BC,U+02C6,U+02DA,U+02DC,U+0304,U+0308,U+0329,U+2000-206F,U+20AC,U+2122,U+2191,U+2193,U+2212,U+2215,U+FEFF,U+FFFD;
+  unicode-range:
+    U+0000-00FF, U+0131, U+0152-0153, U+02BB-02BC, U+02C6, U+02DA, U+02DC, U+0304, U+0308, U+0329,
+    U+2000-206F, U+20AC, U+2122, U+2191, U+2193, U+2212, U+2215, U+FEFF, U+FFFD;
 }
 @font-face {
   font-family: 'Geist Mono';
@@ -56,7 +67,9 @@
   font-display: swap;
   font-weight: 100 900;
   src: url(../plugin/assets/fonts/geist/geist-mono-latin-ext.woff2) format('woff2-variations');
-  unicode-range: U+0100-02BA,U+02BD-02C5,U+02C7-02CC,U+02CE-02D7,U+02DD-02FF,U+0304,U+0308,U+0329,U+1D00-1DBF,U+1E00-1E9F,U+1EF2-1EFF,U+2020,U+20A0-20AB,U+20AD-20C0,U+2113,U+2C60-2C7F,U+A720-A7FF;
+  unicode-range:
+    U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF,
+    U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0, U+2113, U+2C60-2C7F, U+A720-A7FF;
 }
 @font-face {
   font-family: 'Geist Mono';
@@ -64,5 +77,7 @@
   font-display: swap;
   font-weight: 100 900;
   src: url(../plugin/assets/fonts/geist/geist-mono-italic-latin-ext.woff2) format('woff2-variations');
-  unicode-range: U+0100-02BA,U+02BD-02C5,U+02C7-02CC,U+02CE-02D7,U+02DD-02FF,U+0304,U+0308,U+0329,U+1D00-1DBF,U+1E00-1E9F,U+1EF2-1EFF,U+2020,U+20A0-20AB,U+20AD-20C0,U+2113,U+2C60-2C7F,U+A720-A7FF;
+  unicode-range:
+    U+0100-02BA, U+02BD-02C5, U+02C7-02CC, U+02CE-02D7, U+02DD-02FF, U+0304, U+0308, U+0329, U+1D00-1DBF,
+    U+1E00-1E9F, U+1EF2-1EFF, U+2020, U+20A0-20AB, U+20AD-20C0, U+2113, U+2C60-2C7F, U+A720-A7FF;
 }

package/styles/sidebar.css

@@ -65,7 +65,8 @@
   }
   .stl-sdk-select .stldocs-dropdown-trigger {
     /* dropdown should match link padding, accounting for 1px border */
-    padding: calc(var(--stl-sidebar-item-padding-block) - 1px) calc(var(--stl-sidebar-item-padding-inline) - 1px);
+    padding: calc(var(--stl-sidebar-item-padding-block) - 1px)
+      calc(var(--stl-sidebar-item-padding-inline) - 1px);
   }
   li a {
     color: var(--stl-ui-foreground-secondary);

package/tsconfig.json

@@ -7,11 +7,8 @@
     ".stl-docs/**/*",
     "./plugin/**/*"
   ],
-  "exclude": ["dist"],
+  "exclude": ["dist", "**/preview.worker.docs.js"],
   "compilerOptions": {
-    "paths": {
-      "~/*": ["../../../stainless/legacy-dir-root/*"]
-    },
     "jsx": "react-jsx",
     "jsxImportSource": "react"
   }

package/virtual-module.d.ts

@@ -18,6 +18,7 @@ declare module 'virtual:stl-starlight-virtual-module' {
   export const PROPERTY_SETTINGS: PropertySettingsType;
   export const MIDDLEWARE: StlStarlightMiddleware;
   export const SEARCH: StainlessStarlightUserConfig['search'];
+  export const ENABLE_CONTEXT_MENU: boolean;
 }
 
 declare module 'virtual:stl-docs-virtual-module' {
@@ -42,5 +43,4 @@ declare module 'virtual:stl-docs-virtual-module' {
   export const ENABLE_CLIENT_ROUTER: boolean;
   export const API_REFERENCE_BASE_PATH: string | null;
   export const ENABLE_PROSE_MARKDOWN_RENDERING: boolean;
-  export const ENABLE_CONTEXT_MENU: boolean;
 }