@stainless-api/docs 0.1.0-beta.99 → 1.0.0-beta.140

package/CHANGELOG.md

@@ -1,5 +1,395 @@
 # @stainless-api/docs
 
+## 1.0.0-beta.140
+
+### Major Changes
+
+- 2c62934: License
+
+### Patch Changes
+
+- 1e86f14: update internal og-image breadcrumb resolver for compatibility with `@astrojs/starlight` 0.39, where autogenerated sidebar entries are nested inside a parent group's `items` array instead of carrying their own label.
+- Updated dependencies [2c62934]
+  - @stainless-api/ui-primitives@1.0.0-beta.54
+  - @stainless-api/docs-search@1.0.0-beta.50
+  - @stainless-api/docs-ui@1.0.0-beta.96
+
+## 0.1.0-beta.139
+
+### Minor Changes
+
+- d068123: bring-your-own spec loader
+- e5367b0: Move preview worker to @stainless/sdk-json package
+
+### Patch Changes
+
+- Updated dependencies [e5367b0]
+  - @stainless/sdk-json@0.1.0-beta.11
+
+## 0.1.0-beta.138
+
+### Patch Changes
+
+- bb5f952: Stop loading AI chat examples from obsolete Stainless endpoint
+- 25d7a11: Stop creating Algolia prose indexes during docs site builds. Vector-based prose indexing is unaffected and remains controlled by the `experimental.disableStainlessProseIndexing` flag.
+- Updated dependencies [25d7a11]
+  - @stainless-api/docs-search@0.1.0-beta.49
+
+## 0.1.0-beta.137
+
+### Minor Changes
+
+- ce2dd81: Add interface for customizing ai-chat behaviour
+
+### Patch Changes
+
+- 5f0fdda: Vendor dependencies for Stainless Config change
+- 680889d: feat: support disabling third-party context menu options
+
+## 0.1.0-beta.136
+
+### Minor Changes
+
+- 5a6e598: [og image] migrate Takumi to v1
+
+### Patch Changes
+
+- 8b7aaff: Adds markdown representation for overview
+- 23bd8f7: Update preview worker
+
+## 0.1.0-beta.135
+
+### Patch Changes
+
+- dea0395: fix backwards llmsTxt.disabled parsing
+
+## 0.1.0-beta.134
+
+### Minor Changes
+
+- eb35b5c: Integrate @stainless-api/docs-og-image package into core
+
+## 0.1.0-beta.133
+
+### Patch Changes
+
+- db5d00d: Fix for go version in install string
+
+## 0.1.0-beta.132
+
+### Patch Changes
+
+- 53772cd: Improve handling of invalid refs
+- 6091b54: Allow local files for builds
+- Updated dependencies [53772cd]
+  - @stainless-api/docs-ui@0.1.0-beta.95
+  - @stainless-api/docs-search@0.1.0-beta.48
+
+## 0.1.0-beta.131
+
+### Patch Changes
+
+- Updated dependencies [be32bea]
+  - @stainless-api/docs-ui@0.1.0-beta.94
+  - @stainless-api/docs-search@0.1.0-beta.47
+
+## 0.1.0-beta.130
+
+### Minor Changes
+
+- da5debb: Move ai chat packages into stl-starlight, and extract to a generic interface
+
+### Patch Changes
+
+- 3019a8b: Adds support for generating an llms.txt
+- 4d3b938: Remove dead code flagged by knip
+- b887dbb: Fix off-axis rotation of loading spinner in safari
+- cfd8ea1: Minor fixes for Python and Ruby
+- Updated dependencies [3019a8b]
+- Updated dependencies [4d3b938]
+- Updated dependencies [0791fb6]
+- Updated dependencies [01b77d0]
+- Updated dependencies [15e07d8]
+- Updated dependencies [ebc039a]
+- Updated dependencies [cfd8ea1]
+- Updated dependencies [68a7bf8]
+  - @stainless-api/docs-ui@0.1.0-beta.93
+  - @stainless-api/ui-primitives@0.1.0-beta.53
+  - @stainless-api/docs-search@0.1.0-beta.46
+
+## 0.1.0-beta.129
+
+### Minor Changes
+
+- 966ec34: Fixes nav dropdown logic
+
+### Patch Changes
+
+- Updated dependencies [966ec34]
+  - @stainless-api/ui-primitives@0.1.0-beta.52
+  - @stainless-api/docs-search@0.1.0-beta.45
+  - @stainless-api/docs-ui@0.1.0-beta.92
+
+## 0.1.0-beta.128
+
+### Patch Changes
+
+- e8a95f4: Revert “Fix getProsePages treating all pages as prose when API reference basePath is empty”
+
+## 0.1.0-beta.127
+
+### Patch Changes
+
+- e0d595f: Fix snippet copy button click handler
+- 8752b4e: Fix getProsePages treating all pages as prose when API reference basePath is ""
+- Updated dependencies [871f3c0]
+- Updated dependencies [871f3c0]
+  - @stainless-api/docs-ui@0.1.0-beta.91
+  - @stainless-api/docs-search@0.1.0-beta.44
+
+## 0.1.0-beta.126
+
+### Patch Changes
+
+- 992a07a: Update vendored preview worker
+- 1d1fa35: Use astro remark instead of `marked` to process api reference markdown
+- Updated dependencies [374c0e4]
+  - @stainless-api/ui-primitives@0.1.0-beta.51
+  - @stainless-api/docs-ui@0.1.0-beta.90
+  - @stainless-api/docs-search@0.1.0-beta.43
+
+## 0.1.0-beta.125
+
+### Patch Changes
+
+- 975ba51: cap prose indexing batches to 30MB
+- Updated dependencies [005419c]
+  - @stainless-api/docs-ui@0.1.0-beta.89
+  - @stainless-api/docs-search@0.1.0-beta.42
+
+## 0.1.0-beta.124
+
+### Patch Changes
+
+- 152c864: don’t try to load github themes unconditionally
+- Updated dependencies [af5a5d7]
+  - @stainless-api/docs-ui@0.1.0-beta.88
+  - @stainless-api/docs-search@0.1.0-beta.41
+
+## 0.1.0-beta.123
+
+### Patch Changes
+
+- 813b223: Fix base path appending to header links like mailto:
+
+## 0.1.0-beta.122
+
+### Minor Changes
+
+- f22893c: Add interactive examples to ai chat
+
+### Patch Changes
+
+- 3fbf5d8: Updates preview worker
+
+## 0.1.0-beta.121
+
+### Minor Changes
+
+- 9cb2166: Join base path with HEADER_LINKS and TABS
+
+### Patch Changes
+
+- 7701d8f: Clean up console warnings loading DocsSearch markdown renderer
+- Updated dependencies [7701d8f]
+- Updated dependencies [5460e81]
+  - @stainless-api/docs-ui@0.1.0-beta.87
+  - @stainless-api/docs-search@0.1.0-beta.40
+
+## 0.1.0-beta.120
+
+### Patch Changes
+
+- fe6cd04: Improves sidebar item rendering in Terraform
+
+## 0.1.0-beta.119
+
+### Patch Changes
+
+- 403c097: Export additional components
+- Updated dependencies [848cff4]
+- Updated dependencies [ea2b90c]
+  - @stainless-api/ui-primitives@0.1.0-beta.50
+  - @stainless-api/docs-ui@0.1.0-beta.86
+  - @stainless-api/docs-search@0.1.0-beta.39
+
+## 0.1.0-beta.118
+
+### Minor Changes
+
+- 9599de4: Updates preview worker to improve response snippets
+
+### Patch Changes
+
+- 7901fd4: fix astro scoping for language-block style?
+- Updated dependencies [93a3767]
+  - @stainless-api/docs-ui@0.1.0-beta.85
+  - @stainless-api/docs-search@0.1.0-beta.38
+
+## 0.1.0-beta.117
+
+### Patch Changes
+
+- af60696: ensure splash pages aren't uncentered from ghost sidebar
+
+## 0.1.0-beta.116
+
+### Patch Changes
+
+- ad9552c: don’t let toc shrink to its intrinisc size
+
+## 0.1.0-beta.115
+
+### Minor Changes
+
+- 2a9da30: Update to Astro 6
+
+## 0.1.0-beta.114
+
+### Patch Changes
+
+- Updated dependencies [eab438f]
+- Updated dependencies [438a593]
+  - @stainless-api/docs-search@0.1.0-beta.37
+  - @stainless-api/docs-ui@0.1.0-beta.84
+
+## 0.1.0-beta.113
+
+### Patch Changes
+
+- aeda757: Handles cases where pagefind does not exist
+- Updated dependencies [1c38511]
+- Updated dependencies [aeda757]
+  - @stainless-api/docs-ui@0.1.0-beta.83
+  - @stainless-api/docs-search@0.1.0-beta.36
+
+## 0.1.0-beta.112
+
+### Patch Changes
+
+- Updated dependencies [37cc2ac]
+  - @stainless-api/docs-ui@0.1.0-beta.82
+  - @stainless-api/docs-search@0.1.0-beta.35
+
+## 0.1.0-beta.111
+
+### Patch Changes
+
+- 6cab196: prevent summary elements from toggling when users are selecting text
+- Updated dependencies [134885b]
+- Updated dependencies [5ba9135]
+- Updated dependencies [df0c958]
+- Updated dependencies [e641d33]
+  - @stainless-api/docs-ui@0.1.0-beta.81
+  - @stainless-api/docs-search@0.1.0-beta.34
+
+## 0.1.0-beta.110
+
+### Minor Changes
+
+- c1723f0: Updates preview worker
+- 05cd046: Adds support for overriding components
+
+### Patch Changes
+
+- f38f92f: fix scroll-padding-top
+- Updated dependencies [05cd046]
+  - @stainless-api/docs-ui@0.1.0-beta.80
+  - @stainless-api/docs-search@0.1.0-beta.33
+
+## 0.1.0-beta.109
+
+### Patch Changes
+
+- b45d8e2: clean up empty state on Overview when there are no “Libraries”
+
+## 0.1.0-beta.108
+
+### Patch Changes
+
+- 27d2130: add powered by stainless to footer
+
+## 0.1.0-beta.107
+
+### Minor Changes
+
+- 971a12f: Adds an experimental flag to disable indexing
+
+## 0.1.0-beta.106
+
+### Patch Changes
+
+- a8ed299: Adds the ability for AI chat to move into a sidebar “panel” position.
+
+## 0.1.0-beta.105
+
+### Patch Changes
+
+- 46956c1: update preview worker
+- 04d04c1: update preview worker
+
+## 0.1.0-beta.104
+
+### Minor Changes
+
+- 6d9933d: Replace starlight page frame with top-level CSS grid layout
+- 1a150ee: Updates preview worker
+
+### Patch Changes
+
+- Updated dependencies [6d9933d]
+  - @stainless-api/ui-primitives@0.1.0-beta.49
+  - @stainless-api/docs-ui@0.1.0-beta.79
+  - @stainless-api/docs-search@0.1.0-beta.32
+
+## 0.1.0-beta.103
+
+### Patch Changes
+
+- Updated dependencies [54add64]
+  - @stainless-api/docs-ui@0.1.0-beta.78
+  - @stainless-api/docs-search@0.1.0-beta.31
+
+## 0.1.0-beta.102
+
+### Minor Changes
+
+- a1b8e83: adds starlight passthrough option for configuring pagefind
+
+## 0.1.0-beta.101
+
+### Patch Changes
+
+- f81fade: Fix false negatives detecting prose pages to convert to markdown
+- Updated dependencies [21e50d3]
+  - @stainless-api/docs-ui@0.1.0-beta.77
+  - @stainless-api/docs-search@0.1.0-beta.30
+
+## 0.1.0-beta.100
+
+### Minor Changes
+
+- 5701494: Improves sidebar perf + new experimental option to link group titles to overview pages for the group
+
+### Patch Changes
+
+- Updated dependencies [7ea23ef]
+- Updated dependencies [95fe66c]
+- Updated dependencies [5701494]
+  - @stainless-api/ui-primitives@0.1.0-beta.48
+  - @stainless-api/docs-ui@0.1.0-beta.76
+  - @stainless-api/docs-search@0.1.0-beta.29
+
 ## 0.1.0-beta.99
 
 ### Minor Changes

package/ambient.d.ts

@@ -0,0 +1,6 @@
+import 'react';
+declare module 'react' {
+  interface CSSProperties {
+    [key: `--${string}`]: string | number;
+  }
+}

package/eslint-suppressions.json

@@ -4,9 +4,12 @@
       "count": 1
     }
   },
-  "plugin/globalJs/copy.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 3
+  "plugin/components/StainlessIslands.tsx": {
+    "@typescript-eslint/no-unsafe-assignment": {
+      "count": 1
+    },
+    "@typescript-eslint/no-unsafe-member-access": {
+      "count": 2
     }
   },
   "plugin/index.ts": {
@@ -19,9 +22,22 @@
       "count": 1
     }
   },
-  "plugin/specs/worker.ts": {
-    "@typescript-eslint/no-explicit-any": {
-      "count": 3
+  "plugin/referencePlaceholderUtils.ts": {
+    "@typescript-eslint/no-unsafe-assignment": {
+      "count": 1
+    }
+  },
+  "stl-docs/components/sidebars/convertAstroSidebarToStl.tsx": {
+    "@typescript-eslint/no-unsafe-argument": {
+      "count": 1
+    },
+    "@typescript-eslint/no-unsafe-assignment": {
+      "count": 1
+    }
+  },
+  "stl-docs/proseDocSync.ts": {
+    "@typescript-eslint/restrict-template-expressions": {
+      "count": 4
     }
   }
 }

package/{eslint.config.js → eslint.config.ts}

@@ -1,10 +1,4 @@
-// @ts-check
-
 import { defineConfig } from 'eslint/config';
 import { config } from '@stainless/eslint-config/astro';
 
-export default defineConfig(
-  config,
-
-  { ignores: ['plugin/vendor/**'] },
-);
+export default defineConfig(config);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stainless-api/docs",
-  "version": "0.1.0-beta.99",
+  "version": "1.0.0-beta.140",
   "publishConfig": {
     "access": "public"
   },
@@ -14,71 +14,88 @@
     "./plugin/languages": "./plugin/languages.ts",
     "./stainless-docs/mintlify-compat": "./stl-docs/components/mintlify-compat/index.ts",
     "./mintlify-compat.css": "./styles/mintlify-compat.css",
-    "./components": "./stl-docs/components/index.ts",
-    "./components/scripts": "./stl-docs/components/scripts.ts",
     "./docs-config": "./stl-docs/loadStlDocsConfig.ts",
     "./specs/fetchSpecSSR": "./plugin/specs/fetchSpecSSR.ts",
     "./generate-docs-routes": "./plugin/helpers/generateDocsRoutes.ts",
+    "./components": "./stl-docs/components/index.ts",
+    "./components/scripts": "./stl-docs/components/scripts.ts",
     "./components/Head": "./stl-docs/components/Head.astro",
-    "./components/ContentBreadcrumbs": "./stl-docs/components/ContentBreadcrumbs.tsx"
+    "./components/PageFrame": "./stl-docs/components/PageFrame.astro",
+    "./components/PageTitle": "./stl-docs/components/PageTitle.astro",
+    "./components/ContentBreadcrumbs": "./stl-docs/components/ContentBreadcrumbs.tsx",
+    "./components/AIDropdown": "./stl-docs/components/AIDropdown.tsx",
+    "./components/Footer": "./stl-docs/components/Footer.astro",
+    "./components/Pagination": "./stl-docs/components/pagination/Pagination.astro",
+    "./og-image/components/OpenGraphImage": "./stl-docs/og-image/components/OpenGraphImage.tsx",
+    "./og-image/components/OpenGraphFunctionSignature": "./stl-docs/og-image/components/OpenGraphFunctionSignature.tsx",
+    "./schema-extension": "./stl-docs/schema-extension.ts",
+    "./chat": "./stl-docs/chat/docs-chat-handler.ts"
   },
   "keywords": [],
   "author": "",
-  "license": "ISC",
+  "license": "MIT",
   "engines": {
-    "node": ">=18.17.1"
+    "node": ">=22.12.0"
   },
   "peerDependencies": {
-    "@astrojs/starlight": ">=0.37.5",
-    "astro": ">=5.15.3",
+    "@astrojs/starlight": ">=0.38.0",
+    "takumi-js": ">=1.0.5",
+    "astro": ">=6.0.0",
     "react": ">=19.0.0",
     "react-dom": ">=19.0.0",
-    "vite": ">=6.2.1"
+    "vite": ">=7.3.1"
+  },
+  "peerDependenciesMeta": {
+    "takumi-js": {
+      "optional": true
+    }
   },
   "dependencies": {
-    "@astrojs/markdown-remark": "^6.3.10",
-    "@astrojs/react": "^4.4.2",
-    "@stainless-api/sdk": "0.1.0-alpha.19",
-    "astro-expressive-code": "^0.41.6",
-    "cheerio": "^1.1.2",
+    "@astrojs/markdown-remark": "^7.1.1",
+    "@astrojs/react": "^5.0.4",
+    "@markdoc/markdoc": "^0.5.7",
+    "@stainless-api/sdk": "0.5.0",
+    "cheerio": "^1.2.0",
     "clsx": "^2.1.1",
-    "dotenv": "17.2.3",
-    "lucide-react": "^0.562.0",
-    "marked": "^17.0.1",
-    "node-html-parser": "^7.0.1",
+    "dotenv": "17.4.2",
+    "lucide-react": "^1.14.0",
+    "motion": "^12.38.0",
+    "node-html-parser": "^7.1.0",
     "rehype-parse": "^9.0.1",
     "rehype-remark": "^10.0.1",
+    "react-markdown": "^10.1.0",
+    "react-syntax-highlighter": "^16.1.1",
     "remark-gfm": "^4.0.1",
     "remark-github-alerts": "^0.1.1",
     "remark-stringify": "^11.0.0",
-    "shiki": "^3.22.0",
+    "remend": "^1.3.0",
+    "shiki": "^4.0.2",
     "unified": "^11.0.5",
-    "vite-plugin-prebundle-workers": "^0.2.0",
-    "web-worker": "^1.5.0",
-    "yaml": "^2.8.2",
-    "@stainless-api/docs-search": "0.1.0-beta.28",
-    "@stainless-api/docs-ui": "0.1.0-beta.75",
-    "@stainless-api/ui-primitives": "0.1.0-beta.47"
+    "@stainless-api/docs-search": "1.0.0-beta.50",
+    "@stainless-api/docs-ui": "1.0.0-beta.96",
+    "@stainless-api/ui-primitives": "1.0.0-beta.54",
+    "@stainless/sdk-json": "^0.1.0-beta.11"
   },
   "devDependencies": {
-    "@astrojs/check": "^0.9.6",
-    "@markdoc/markdoc": "^0.5.4",
-    "@types/node": "24.10.9",
-    "@types/react": "19.2.10",
+    "@astrojs/check": "^0.9.9",
+    "takumi-js": "^1.1.2",
+    "@types/node": "24.12.2",
+    "@types/react": "19.2.14",
     "@types/react-dom": "^19.2.3",
-    "react": "^19.2.4",
-    "react-dom": "^19.2.4",
-    "tsx": "^4.21.0",
-    "typescript": "5.9.3",
-    "vite": "^6.4.1",
-    "zod": "^4.3.5",
-    "@stainless/eslint-config": "0.1.0-beta.1",
-    "@stainless/sdk-json": "^0.1.0-beta.7"
+    "@types/react-syntax-highlighter": "^15.5.13",
+    "astro": "^6.3.1",
+    "react": "^19.2.6",
+    "react-dom": "^19.2.6",
+    "typescript": "6.0.3",
+    "vite": "^7.3.2",
+    "vitest": "^4.1.5",
+    "zod": "^4.4.3",
+    "@stainless/eslint-config": "0.1.0-beta.2"
   },
   "scripts": {
-    "vendor-deps": "tsx scripts/vendor_deps.ts",
-    "lint": "eslint . --max-warnings 0",
+    "lint": "eslint --flag unstable_native_nodejs_ts_config . --max-warnings 0",
     "sync": "astro sync",
-    "check:types": "astro check"
+    "check:types": "astro check",
+    "test": "vitest run"
   }
 }

package/plugin/buildAlgoliaIndex.ts

@@ -2,7 +2,8 @@ import Markdoc from '@markdoc/markdoc';
 import { buildIndex } from '@stainless-api/docs-search/providers/algolia';
 import type { AstroIntegrationLogger } from 'astro';
 import { generateIndex } from '@stainless-api/docs-search/indexer';
-import { SpecComposite } from './specs';
+import type { LoadedSpecs } from './specs/utils';
+import { isSupportedLanguage } from '@stainless-api/docs-ui/routing';
 
 const markdocConfig = {
   nodes: {
@@ -19,10 +20,10 @@ function renderMarkdown(content?: string) {
 }
 
 export async function buildAlgoliaIndex({
-  specComposite,
+  loadedSpecs,
   logger,
 }: {
-  specComposite: SpecComposite;
+  loadedSpecs: LoadedSpecs;
   logger?: AstroIntegrationLogger;
 }) {
   function warnLog(message: string) {
@@ -57,15 +58,8 @@ export async function buildAlgoliaIndex({
     return;
   }
 
-  const indexEntries = specComposite.listUniqueSpecs().flatMap((spec) =>
-    Array.from(
-      generateIndex(
-        spec.data.sdkJson,
-        renderMarkdown,
-        true,
-        spec.data.languages.filter((l) => l !== 'sql' && l !== 'openapi'),
-      ),
-    ),
+  const indexEntries = loadedSpecs.flatMap((spec) =>
+    Array.from(generateIndex(spec.sdkJson, renderMarkdown, true, spec.languages.filter(isSupportedLanguage))),
   );
 
   await buildIndex(appId, indexName, algoliaWriteKey, indexEntries, renderMarkdown);

package/plugin/components/SDKSelect.astro

@@ -28,12 +28,6 @@ const options = getDocsLanguages().map((value) => ({
 const readmeSlug = language === 'http' ? API_REFERENCE_BASE_PATH : `${API_REFERENCE_BASE_PATH}/${language}`;
 ---
 
-<span
-  hidden
-  id="stldocs-data"
-  data-stldocs-basepath={data.basePath}
-  data-stldocs-defaultLanguage={data.defaultLanguage}></span>
-
 {
   (data.stainlessPath || slug === readmeSlug) && (
     <div class="stldocs-root stl-sdk-select">