@stainless-api/docs 0.1.0-beta.5 → 0.1.0-beta.50

package/CHANGELOG.md

@@ -1,5 +1,386 @@
 # @stainless-api/docs
 
+## 0.1.0-beta.50
+
+### Patch Changes
+
+- 6de051d: update vendored preview worker
+
+## 0.1.0-beta.49
+
+### Patch Changes
+
+- Updated dependencies [b9e4b82]
+- Updated dependencies [6d12e06]
+- Updated dependencies [5051795]
+  - @stainless-api/ui-primitives@0.1.0-beta.30
+  - @stainless-api/docs-ui@0.1.0-beta.41
+
+## 0.1.0-beta.48
+
+### Patch Changes
+
+- Updated dependencies [81b5b21]
+- Updated dependencies [ba269f9]
+- Updated dependencies [e2a7098]
+- Updated dependencies [589b13d]
+  - @stainless-api/ui-primitives@0.1.0-beta.29
+  - @stainless-api/docs-ui@0.1.0-beta.40
+
+## 0.1.0-beta.47
+
+### Patch Changes
+
+- 466285c: Fixes for expressive code styles
+  - Ensure expressive code styles are applied to docs sites that do not include API reference
+  - Use correct red & green palettes for ins/del diff annotations
+
+- Updated dependencies [d2d5d51]
+  - @stainless-api/ui-primitives@0.1.0-beta.28
+  - @stainless-api/docs-ui@0.1.0-beta.39
+
+## 0.1.0-beta.46
+
+### Minor Changes
+
+- b61b7c1: New theming system
+
+  A whole new set of design system variables used throughout docs, docs-ui, and ui-primitives
+
+  Improves customizability & uniformness compared to the old set of variables.
+
+### Patch Changes
+
+- Updated dependencies [b61b7c1]
+- Updated dependencies [262f201]
+  - @stainless-api/docs-ui@0.1.0-beta.38
+  - @stainless-api/ui-primitives@0.1.0-beta.27
+
+## 0.1.0-beta.45
+
+### Patch Changes
+
+- 00b33d9: syntax highlighting for markdown renderer
+- fa43cff: json brackets should use muted foreground color
+- c06e5c3: update marked dependency
+- 32d1735: experimental support for collapsible method descriptions
+- Updated dependencies [00b33d9]
+- Updated dependencies [32d1735]
+- Updated dependencies [23254d1]
+  - @stainless-api/ui-primitives@0.1.0-beta.26
+  - @stainless-api/docs-ui@0.1.0-beta.37
+
+## 0.1.0-beta.44
+
+### Patch Changes
+
+- Updated dependencies [38b7030]
+  - @stainless-api/docs-ui@0.1.0-beta.36
+
+## 0.1.0-beta.43
+
+### Patch Changes
+
+- a44a012: Remove debug code
+
+## 0.1.0-beta.42
+
+### Patch Changes
+
+- Updated dependencies [3817ff5]
+- Updated dependencies [391a7ce]
+- Updated dependencies [945d4f3]
+  - @stainless-api/docs-ui@0.1.0-beta.35
+
+## 0.1.0-beta.41
+
+### Patch Changes
+
+- 6557889: temporarily remove experimental AI search feature
+- Updated dependencies [6557889]
+  - @stainless-api/docs-ui@0.1.0-beta.34
+
+## 0.1.0-beta.40
+
+### Patch Changes
+
+- Updated dependencies [8670d73]
+  - @stainless-api/docs-ui@0.1.0-beta.33
+
+## 0.1.0-beta.39
+
+### Patch Changes
+
+- 242deef: fix mobile menu on splash pages
+- Updated dependencies [242deef]
+  - @stainless-api/ui-primitives@0.1.0-beta.25
+  - @stainless-api/docs-ui@0.1.0-beta.32
+
+## 0.1.0-beta.38
+
+### Patch Changes
+
+- Updated dependencies [c28b0a6]
+- Updated dependencies [f23c6bc]
+- Updated dependencies [2cd1b33]
+  - @stainless-api/docs-ui@0.1.0-beta.31
+  - @stainless-api/ui-primitives@0.1.0-beta.24
+
+## 0.1.0-beta.37
+
+### Patch Changes
+
+- 5f14e53: Render page descriptions as part of page header by default
+- Updated dependencies [49e1b93]
+  - @stainless-api/docs-ui@0.1.0-beta.30
+  - @stainless-api/ui-primitives@0.1.0-beta.23
+
+## 0.1.0-beta.36
+
+### Patch Changes
+
+- Updated dependencies [7897575]
+  - @stainless-api/ui-primitives@0.1.0-beta.22
+  - @stainless-api/docs-ui@0.1.0-beta.29
+
+## 0.1.0-beta.35
+
+### Patch Changes
+
+- Updated dependencies [344761e]
+  - @stainless-api/ui-primitives@0.1.0-beta.21
+  - @stainless-api/docs-ui@0.1.0-beta.28
+
+## 0.1.0-beta.34
+
+### Patch Changes
+
+- f5173e9: fix: theme flickering
+
+## 0.1.0-beta.33
+
+### Patch Changes
+
+- 7ef572c: feat: updated dropdowns
+- Updated dependencies [7ef572c]
+  - @stainless-api/docs-ui@0.1.0-beta.27
+  - @stainless-api/ui-primitives@0.1.0-beta.20
+
+## 0.1.0-beta.32
+
+### Patch Changes
+
+- 58040d8: feat: ui primitives updates, cursor support
+- Updated dependencies [58040d8]
+  - @stainless-api/docs-ui@0.1.0-beta.26
+  - @stainless-api/ui-primitives@0.1.0-beta.19
+
+## 0.1.0-beta.31
+
+### Patch Changes
+
+- Updated dependencies [afd1f8e]
+- Updated dependencies [279fa0e]
+  - @stainless-api/docs-ui@0.1.0-beta.25
+
+## 0.1.0-beta.30
+
+### Patch Changes
+
+- Updated dependencies [ab570bc]
+  - @stainless-api/docs-ui@0.1.0-beta.24
+
+## 0.1.0-beta.29
+
+### Patch Changes
+
+- Updated dependencies [279fa0e]
+  - @stainless-api/docs-ui@0.1.0-beta.23
+
+## 0.1.0-beta.28
+
+### Minor Changes
+
+- c635741: Updated worker and fixed docs-ui jsx issue
+
+### Patch Changes
+
+- Updated dependencies [c635741]
+  - @stainless-api/docs-ui@0.1.0-beta.22
+  - @stainless-api/ui-primitives@0.1.0-beta.18
+
+## 0.1.0-beta.27
+
+### Patch Changes
+
+- de189ee: remove max width on site title
+
+## 0.1.0-beta.26
+
+### Patch Changes
+
+- 1517484: fixing font loading, updating nav bar height
+- Updated dependencies [1517484]
+  - @stainless-api/docs-ui@0.1.0-beta.21
+  - @stainless-api/ui-primitives@0.1.0-beta.17
+
+## 0.1.0-beta.25
+
+### Patch Changes
+
+- Updated dependencies [b9ce1b6]
+  - @stainless-api/docs-ui@0.1.0-beta.20
+
+## 0.1.0-beta.24
+
+### Patch Changes
+
+- Updated dependencies [402222a]
+  - @stainless-api/docs-ui@0.1.0-beta.19
+
+## 0.1.0-beta.23
+
+### Patch Changes
+
+- Updated dependencies [2150eee]
+  - @stainless-api/docs-ui@0.1.0-beta.18
+
+## 0.1.0-beta.22
+
+### Patch Changes
+
+- Updated dependencies [f7ba067]
+  - @stainless-api/docs-ui@0.1.0-beta.17
+
+## 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

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,21 @@
 {
   "name": "@stainless-api/docs",
-  "version": "0.1.0-beta.5",
+  "version": "0.1.0-beta.50",
   "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",
+    "./components/scripts": "./stl-docs/components/scripts.ts"
   },
   "keywords": [],
   "author": "",
@@ -34,41 +24,55 @@
     "node": ">=18.17.1"
   },
   "peerDependencies": {
-    "@astrojs/starlight": ">=0.34.0",
-    "astro": ">=5.5.0"
+    "@astrojs/starlight": ">=0.36.1",
+    "astro": ">=5.15.3",
+    "react": ">=19.0.0",
+    "react-dom": ">=19.0.0",
+    "vite": ">=6.2.1"
   },
   "dependencies": {
-    "@astrojs/markdown-remark": "^6.3.2",
-    "@astrojs/react": "^4.3.1",
-    "@stainless-api/sdk": "0.1.0-alpha.12",
+    "@astrojs/markdown-remark": "^6.3.9",
+    "@astrojs/react": "^4.4.2",
+    "@stainless-api/sdk": "0.1.0-alpha.16",
+    "astro-expressive-code": "^0.41.3",
     "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",
+    "lucide-react": "^0.554.0",
+    "marked": "^17.0.1",
+    "node-html-parser": "^7.0.1",
+    "rehype-parse": "^9.0.1",
+    "rehype-remark": "^10.0.1",
+    "remark-gfm": "^4.0.1",
     "remark-github-alerts": "^0.1.1",
-    "shiki": "^3.9.2",
+    "remark-stringify": "^11.0.0",
+    "shiki": "^3.15.0",
+    "unified": "^11.0.5",
     "web-worker": "^1.5.0",
-    "yaml": "^2.8.0",
-    "@stainless-api/docs-ui": "0.1.0-beta.4",
-    "@stainless-api/ui-primitives": "0.1.0-beta.5"
+    "yaml": "^2.8.1",
+    "@stainless-api/docs-ui": "0.1.0-beta.41",
+    "@stainless-api/ui-primitives": "0.1.0-beta.30"
   },
   "devDependencies": {
-    "@markdoc/markdoc": "^0.5.2",
-    "@types/node": "^24.4.0",
-    "@types/react": "^19.1.13",
-    "@types/react-dom": "^19.1.9",
-    "tsx": "^4.20.3",
-    "zod": "^4.0.0",
-    "@stainless/eslint-config": "0.0.0"
+    "@astrojs/check": "^0.9.5",
+    "@markdoc/markdoc": "^0.5.4",
+    "@types/node": "24.10.1",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "react": "^19.2.0",
+    "react-dom": "^19.2.0",
+    "tsx": "^4.20.6",
+    "typescript": "5.9.3",
+    "vite": "^6.4.1",
+    "zod": "^4.1.13",
+    "@stainless/sdk-json": "^0.1.0-beta.0",
+    "@stainless/eslint-config": "0.1.0-beta.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 { Languages } from '@stainless-api/docs-ui/src/routing';
-import { buildIndex } from '@stainless-api/docs-ui/src/search/providers/algolia';
+import type * as SDKJSON from '@stainless/sdk-json';
+import { Languages } from '@stainless-api/docs-ui/routing';
+import { buildIndex } from '@stainless-api/docs-ui/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.');
 }