@stainless-api/docs 0.1.0-beta.2 → 0.1.0-beta.21

package/CHANGELOG.md

@@ -1,5 +1,158 @@
 # @stainless-api/docs
 
+## 0.1.0-beta.21
+
+### Patch Changes
+
+- 41e87cb: fix virtual module imports
+
+## 0.1.0-beta.20
+
+### Patch Changes
+
+- 9cdb24d: Update pagination components, fix search modal
+- Updated dependencies [9cdb24d]
+  - @stainless-api/docs-ui@0.1.0-beta.16
+  - @stainless-api/ui-primitives@0.1.0-beta.16
+
+## 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
+
+- Updated dependencies [0572f60]
+  - @stainless-api/docs-ui@0.1.0-beta.14
+
+## 0.1.0-beta.17
+
+### Patch Changes
+
+- a925bb4: fix markdown icon color in dark mode
+
+## 0.1.0-beta.16
+
+### Patch Changes
+
+- 0618d05: Markdown rendering of prose pages, ai context menu, auth via cli, minor fixes
+- Updated dependencies [0618d05]
+  - @stainless-api/docs-ui@0.1.0-beta.13
+  - @stainless-api/ui-primitives@0.1.0-beta.14
+
+## 0.1.0-beta.15
+
+### Patch Changes
+
+- e35360f: include ui-primitive packages
+- Updated dependencies [e35360f]
+  - @stainless-api/docs-ui@0.1.0-beta.12
+  - @stainless-api/ui-primitives@0.1.0-beta.13
+
+## 0.1.0-beta.14
+
+### Patch Changes
+
+- a529fd4: fix: site title height
+- Updated dependencies [a529fd4]
+  - @stainless-api/docs-ui@0.1.0-beta.11
+  - @stainless-api/ui-primitives@0.1.0-beta.12
+
+## 0.1.0-beta.13
+
+### Patch Changes
+
+- 26a4786: fix: include missing starlight config options
+- Updated dependencies [26a4786]
+  - @stainless-api/docs-ui@0.1.0-beta.10
+  - @stainless-api/ui-primitives@0.1.0-beta.11
+
+## 0.1.0-beta.12
+
+### Patch Changes
+
+- Updated dependencies [3e44a9c]
+  - @stainless-api/ui-primitives@0.1.0-beta.10
+  - @stainless-api/docs-ui@0.1.0-beta.9
+
+## 0.1.0-beta.11
+
+### Patch Changes
+
+- c96f895: Remove css layers, update sidebar styles, add new prose elements
+- Updated dependencies [c96f895]
+  - @stainless-api/docs-ui@0.1.0-beta.8
+  - @stainless-api/ui-primitives@0.1.0-beta.9
+
+## 0.1.0-beta.10
+
+### Patch Changes
+
+- dc059d2: should include option in stl-docs virtual module
+
+## 0.1.0-beta.9
+
+### Patch Changes
+
+- d15a520: fix initialization of dropdown buttons
+- Updated dependencies [d15a520]
+  - @stainless-api/ui-primitives@0.1.0-beta.8
+  - @stainless-api/docs-ui@0.1.0-beta.7
+
+## 0.1.0-beta.8
+
+### Minor Changes
+
+- 917493d: move stainlessDocs into default export
+
+## 0.1.0-beta.7
+
+### Patch Changes
+
+- Updated dependencies [34e7c61]
+  - @stainless-api/ui-primitives@0.1.0-beta.7
+  - @stainless-api/docs-ui@0.1.0-beta.6
+
+## 0.1.0-beta.6
+
+### Patch Changes
+
+- 34cbd12: verify publishing
+- Updated dependencies [f664b4d]
+- Updated dependencies [34cbd12]
+  - @stainless-api/ui-primitives@0.1.0-beta.6
+  - @stainless-api/docs-ui@0.1.0-beta.5
+
+## 0.1.0-beta.5
+
+### Patch Changes
+
+- Updated dependencies [e7a2a96]
+  - @stainless-api/ui-primitives@0.1.0-beta.5
+  - @stainless-api/docs-ui@0.1.0-beta.4
+
+## 0.1.0-beta.4
+
+### Patch Changes
+
+- Updated dependencies [2853ae8]
+  - @stainless-api/ui-primitives@0.1.0-beta.4
+  - @stainless-api/docs-ui@0.1.0-beta.3
+
+## 0.1.0-beta.3
+
+### Patch Changes
+
+- Updated dependencies [870af8d]
+  - @stainless-api/ui-primitives@0.1.0-beta.3
+  - @stainless-api/docs-ui@0.1.0-beta.2
+
 ## 0.1.0-beta.2
 
 ### Patch Changes

package/components/variables.css

@@ -1,7 +1,4 @@
 :root {
-  --sl-font: 'Geist', system-ui, sans-serif;
-  --sl-font-mono: 'Geist Mono', ui-monospace, monospace;
-
   --stldocs-font: var(--sl-font, system-ui, sans-serif);
   --stldocs-font-mono: var(--sl-font-mono, ui-monospace, monospace);
 
@@ -28,6 +25,7 @@
 
   --stldocs-color-bg: var(--sl-color-bg);
   --stldocs-color-bg-nav: var(--sl-color-bg-nav);
+  --stldocs-color-selected: var(--sl-color-gray-6);
   --stldocs-color-bg-ui: var(--sl-color-bg-ui);
 
   --stldocs-color-bg-inline-code: var(--sl-color-bg-inline-code);
@@ -74,30 +72,6 @@
   --stldocs-expander-right-margin: 8px;
   --stldocs-font-size-body: 14px;
   --stldocs-font-size-body-xs: 12px;
-
-  /* UI Overrides */
-  --stl-ui-button-border-radius: var(--sl-button-border-radius);
-  --stl-ui-text-body: var(--sl-text-sm);
-  --stl-ui-font-family: var(--sl-font);
-  --stl-ui-button-size: var(--sl-button-size);
-
-  --stl-ui-color-accent-low: var(--sl-color-accent-low);
-  --stl-ui-color-accent: var(--sl-color-accent);
-  --stl-ui-color-accent-high: var(--sl-color-accent-high);
-
-  --stl-ui-color-text: var(--sl-color-text);
-  --stl-ui-color-text-secondary: var(--sl-color-text-secondary);
-  --stl-ui-color-text-tertiary: var(--sl-color-text-tertiary);
-  --stl-ui-color-text-invert: var(--sl-color-text-invert);
-  --stl-ui-color-text-accent: var(--sl-color-text-accent);
-
-  --stl-ui-color-bg: var(--sl-color-bg);
-  --stl-ui-color-bg-ui: var(--sl-color-bg-ui);
-  --stl-ui-color-bg-inline-code: var(--sl-color-bg-inline-code);
-
-  --stl-ui-color-hairline-light: var(--sl-color-hairline-light);
-  --stl-ui-color-hairline: var(--sl-color-hairline);
-  --stl-ui-color-hairline-shade: var(--sl-color-hairline-shade);
 }
 
 /* These are the theme overrides - we need to come up with a good way to do this in starlight */

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/locals.d.ts

@@ -0,0 +1,14 @@
+type SidebarEntry = App.Locals['starlightRoute']['sidebar'][number];
+
+/**
+ * Extending Astro’s `App.Locals` interface
+ */
+declare namespace App {
+  interface Locals {
+    _stlStarlightPage?: {
+      skipRenderingStarlightTitle?: boolean;
+      hasMarkdownRoute?: boolean;
+      fullSidebar?: SidebarEntry[];
+    };
+  }
+}

package/package.json

@@ -1,31 +1,20 @@
 {
   "name": "@stainless-api/docs",
-  "version": "0.1.0-beta.2",
+  "version": "0.1.0-beta.21",
   "publishConfig": {
     "access": "public"
   },
   "description": "",
   "type": "module",
   "exports": {
+    ".": "./stl-docs/index.ts",
     "./plugin": "./plugin/index.ts",
-    "./OverviewRoute": "./plugin/routes/Overview.astro",
-    "./DocsRoute": "./plugin/routes/Docs.astro",
-    "./DocsStaticRoute": "./plugin/routes/DocsStatic.astro",
-    "./MarkdownRoute": "./plugin/routes/markdown.ts",
-    "./Search": "./plugin/components/search/Search.astro",
-    "./replaceSidebarPlaceholderMiddleware": "./plugin/replaceSidebarPlaceholderMiddleware.ts",
     "./plugin/middleware": "./plugin/middlewareBuilder/stlStarlightMiddleware.ts",
     "./plugin/MiddlewareTypes": "./plugin/middlewareBuilder/stainlessMiddleware.d.ts",
-    "./stainless-docs": "./stl-docs/index.ts",
-    "./Header": "./stl-docs/components/Header.astro",
-    "./ThemeSelect": "./stl-docs/components/ThemeSelect.astro",
-    "./Sidebar": "./stl-docs/components/Sidebar.astro",
-    "./ContentPanel": "./stl-docs/components/content-panel/ContentPanel.astro",
-    "./tabsMiddleware": "./stl-docs/tabsMiddleware.ts",
     "./stainless-docs/mintlify-compat": "./stl-docs/components/mintlify-compat/index.ts",
-    "./theme": "./theme.css",
     "./mintlify-compat.css": "./styles/mintlify-compat.css",
-    "./font-imports": "./styles/fonts.css"
+    "./font-imports": "./styles/fonts.css",
+    "./components": "./stl-docs/components/index.ts"
   },
   "keywords": [],
   "author": "",
@@ -34,41 +23,55 @@
     "node": ">=18.17.1"
   },
   "peerDependencies": {
-    "@astrojs/starlight": ">=0.34.0",
-    "astro": ">=5.5.0"
+    "@astrojs/starlight": ">=0.36.1",
+    "astro": ">=5.15.3",
+    "vite": ">=6.2.1",
+    "react": ">=19.0.0",
+    "react-dom": ">=19.0.0"
   },
   "dependencies": {
     "@astrojs/markdown-remark": "^6.3.2",
-    "@astrojs/react": "^4.3.1",
+    "@astrojs/react": "^4.4.1",
     "@stainless-api/sdk": "0.1.0-alpha.12",
     "cheerio": "^1.1.2",
     "clsx": "^2.1.1",
-    "dotenv": "17.2.2",
+    "dotenv": "17.2.3",
     "get-port": "^7.1.0",
     "highlight.js": "^11.11.1",
     "lucide-react": "^0.544.0",
     "marked": "^16.0.0",
-    "react": "^19.1.1",
-    "react-dom": "^19.1.1",
     "remark-github-alerts": "^0.1.1",
     "shiki": "^3.9.2",
     "web-worker": "^1.5.0",
     "yaml": "^2.8.0",
-    "@stainless-api/docs-ui": "0.1.0-beta.2",
-    "@stainless-api/ui-primitives": "0.1.0-beta.2"
+    "node-html-parser": "^7.0.1",
+    "rehype-parse": "^9.0.1",
+    "rehype-remark": "^10.0.1",
+    "remark-gfm": "^4.0.1",
+    "remark-stringify": "^11.0.0",
+    "unified": "^11.0.5",
+    "@stainless-api/docs-ui": "0.1.0-beta.16",
+    "@stainless-api/ui-primitives": "0.1.0-beta.16"
   },
   "devDependencies": {
+    "@astrojs/check": "^0.9.5",
     "@markdoc/markdoc": "^0.5.2",
     "@types/node": "^24.4.0",
-    "@types/react": "^19.1.13",
-    "@types/react-dom": "^19.1.9",
+    "@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/eslint-config": "0.0.0"
+    "@stainless/eslint-config": "0.0.0",
+    "@stainless/sdk-json": "^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,10 +1,11 @@
 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';
+import type { AstroIntegrationLogger } from 'astro';
 
 const markdocConfig = {
   nodes: {
@@ -20,7 +21,31 @@ function renderMarkdown(content?: string) {
   return Markdoc.renderers.html(transformed);
 }
 
-export async function buildAlgoliaIndex({ version, apiKey }: { version: VersionUserConfig; apiKey: string }) {
+export async function buildAlgoliaIndex({
+  version,
+  apiKey,
+  logger,
+}: {
+  version: VersionUserConfig;
+  apiKey: string;
+  logger?: AstroIntegrationLogger;
+}) {
+  function warnLog(message: string) {
+    if (logger) {
+      logger.warn(message);
+    } else {
+      console.warn(message);
+    }
+  }
+
+  function infoLog(message: string) {
+    if (logger) {
+      logger.info(message);
+    } else {
+      console.log(message);
+    }
+  }
+
   const client = new Stainless({ apiKey });
   const configs = await client.projects.configs.retrieve({
     project: version.stainlessProject,
@@ -64,9 +89,9 @@ export async function buildAlgoliaIndex({ version, apiKey }: { version: VersionU
       !indexName && 'PUBLIC_ALGOLIA_INDEX',
       !algoliaWriteKey && 'PRIVATE_ALGOLIA_WRITE_KEY',
     ].filter(Boolean);
-    console.warn(`⚠️ Skipping Algolia indexing due to missing environment variables: ${missing.join(', ')}`);
+    warnLog(`Skipping Algolia indexing due to missing environment variables: ${missing.join(', ')}`);
     return;
   }
   await buildIndex(appId, indexName, algoliaWriteKey, sdkJson, renderMarkdown);
-  console.log('Indexing complete.');
+  infoLog('Indexing complete.');
 }

package/plugin/cms/server.ts

@@ -1,10 +1,11 @@
+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 from '@stainless-api/sdk';
+import Stainless, { APIError } from '@stainless-api/sdk';
 
 import {
   toStarlightSidebar,
@@ -12,88 +13,118 @@ import {
   SidebarConfigItemsBuilder,
 } from './sidebar-builder';
 import type { VersionUserConfig } from '../loadPluginConfig';
+import { bold } from '../../shared/terminalUtils';
 
 export type InputFilePaths = {
   oasPath?: string;
   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}` },
   });
 
   const content = await data.text();
-  return JSON.parse(content);
+  return JSON.parse(content) as Record<DocsLanguage, string>;
+}
+
+function redactApiKey(apiKey: string) {
+  return apiKey
+    .split('')
+    .map((char, index) => (index < 10 ? char : '*'))
+    .join('');
 }
 
 async function loadSpec({
   apiKey,
   devPaths,
   version,
+  logger,
 }: {
   apiKey: string;
   devPaths: InputFilePaths;
   version: VersionUserConfig;
+  logger: AstroIntegrationLogger;
 }) {
-  let oasStr: string;
-  let configStr: string;
-  let versions: Record<DocsLanguage, string> | undefined;
-
-  if (devPaths.oasPath && devPaths.configPath) {
-    [oasStr, configStr] = await Promise.all([
-      readFile(devPaths.oasPath, 'utf-8'),
-      readFile(devPaths.configPath, 'utf-8'),
-    ]);
-  } else {
-    const client = new Stainless({ apiKey });
-    const configs = await client.projects.configs.retrieve({
-      project: version.stainlessProject,
-      branch: version.branch,
-      include: 'openapi',
-    });
+  async function unsafeLoad() {
+    let oasStr: string;
+    let configStr: string;
+    let versions: Record<DocsLanguage, string> | undefined;
+
+    if (devPaths.oasPath && devPaths.configPath) {
+      [oasStr, configStr] = await Promise.all([
+        readFile(devPaths.oasPath, 'utf-8'),
+        readFile(devPaths.configPath, 'utf-8'),
+      ]);
+    } else {
+      const client = new Stainless({ apiKey });
+      const configs = await client.projects.configs.retrieve({
+        project: version.stainlessProject,
+        branch: version.branch,
+        include: 'openapi',
+      });
 
-    versions = await versionInfo(version.stainlessProject, apiKey);
+      versions = await versionInfo(version.stainlessProject, apiKey);
 
-    const configYML = Object.values(configs)[0] as { content: any };
-    const oasJson = Object.values(configs)[1] as { content: any };
-    oasStr = oasJson['content'];
-    configStr = configYML['content'];
-  }
+      const configYML = Object.values(configs)[0] as { content: any };
+      const oasJson = Object.values(configs)[1] as { content: any };
+      oasStr = oasJson['content'];
+      configStr = configYML['content'];
+    }
 
-  const { oas, config } = await parseInputs({
-    oas: oasStr,
-    config: configStr,
-  });
+    const { oas, config } = await parseInputs({
+      oas: oasStr,
+      config: configStr,
+    });
 
-  const transformedOAS = await transformOAS({ oas, config });
+    const transformedOAS = await transformOAS({ oas, config });
 
-  const languages =
-    config.docs?.languages ??
-    (Object.entries(config.targets)
-      // @ts-expect-error we don't have the actual Stainless config type here
-      .filter(([name, target]) => Languages.includes(name) && !target.skip)
-      .map(([name]) => name) as SDKJSON.SpecLanguage[]);
+    const languages =
+      config.docs?.languages ??
+      (Object.entries(config.targets)
+        // @ts-expect-error we don't have the actual Stainless config type here
+        .filter(([name, target]) => Languages.includes(name) && !target.skip)
+        .map(([name]) => name) as SDKJSON.SpecLanguage[]);
 
-  const sdkJson = await createSDKJSON({
-    oas: transformedOAS,
-    config,
-    languages,
-  });
+    const sdkJson = await createSDKJSON({
+      oas: transformedOAS,
+      config,
+      languages,
+    });
 
-  if (versions) {
-    for (const [lang, version] of Object.entries(versions)) {
-      const meta = sdkJson.metadata[lang as DocsLanguage];
-      if (meta?.version) meta.version = version;
+    if (versions) {
+      for (const [lang, version] of Object.entries(versions)) {
+        const meta = sdkJson.metadata[lang as DocsLanguage];
+        if (meta?.version) meta.version = version;
+      }
     }
+
+    const id = crypto.randomUUID();
+
+    return {
+      data: sdkJson,
+      id,
+    };
   }
 
-  const id = crypto.randomUUID();
+  try {
+    const result = await unsafeLoad();
+    return result;
+  } catch (error) {
+    logger.error(bold('Failed to fetch API reference information from Stainless:'));
+    if (error instanceof APIError && error.status >= 400 && error.status < 500) {
+      logger.error(`Requested project slug: "${version.stainlessProject}"`);
+      logger.error(`API key: "${redactApiKey(apiKey)}"`);
+      logger.error(
+        `This error can usually be corrected by re-authenticating with the Stainless.  Use the CLI (stl auth login) or verify that the Stainless API key you're using can access the project mentioned above.`,
+      );
+    } else {
+      logger.error(error instanceof Error ? error.message : 'Unknown error');
+    }
 
-  return {
-    data: sdkJson,
-    id,
-  };
+    process.exit(1);
+  }
 }
 
 class Spec {
@@ -107,6 +138,7 @@ class Spec {
       apiKey: this.apiKey,
       devPaths: this.devPaths,
       version: this.version,
+      logger: this.logger,
     });
   }
 
@@ -128,15 +160,22 @@ class Spec {
     return spec;
   }
 
-  constructor(apiKey: string, version: VersionUserConfig, devPaths: InputFilePaths) {
+  constructor(
+    apiKey: string,
+    version: VersionUserConfig,
+    devPaths: InputFilePaths,
+    private logger: AstroIntegrationLogger,
+  ) {
     this.specPromise = loadSpec({
       apiKey,
       devPaths,
       version,
+      logger,
     });
     this.devPaths = devPaths;
     this.apiKey = apiKey;
     this.version = version;
+    this.logger = logger;
   }
 }
 
@@ -166,14 +205,16 @@ export function startDevServer({
   devPaths,
   apiKey,
   getGeneratedSidebarConfig,
+  logger,
 }: {
   port: number;
   version: VersionUserConfig;
   devPaths: InputFilePaths;
   apiKey: string;
   getGeneratedSidebarConfig: (id: number) => GeneratedSidebarConfig | null;
+  logger: AstroIntegrationLogger;
 }) {
-  const spec = new Spec(apiKey, version, devPaths);
+  const spec = new Spec(apiKey, version, devPaths, logger);
 
   const server = createServer(async (req, res) => {
     // Add CORS headers
@@ -250,7 +291,7 @@ export function startDevServer({
   });
 
   server.listen(port, () => {
-    console.log(`Server is running on port ${port}`);
+    logger.debug(`Stainless spec server is running on port: ${port}`);
   });
 
   return {
@@ -266,3 +307,5 @@ export function startDevServer({
     },
   };
 }
+
+export type DevSpecServer = Awaited<ReturnType<typeof startDevServer>>;