@stainless-api/docs 0.1.0-beta.85 → 0.1.0-beta.87

package/CHANGELOG.md

@@ -1,5 +1,32 @@
 # @stainless-api/docs
 
+## 0.1.0-beta.87
+
+### Patch Changes
+
+- b62eb05: improved support for webhooks and functions
+- Updated dependencies [b62eb05]
+- Updated dependencies [d42dd8f]
+  - @stainless-api/ui-primitives@0.1.0-beta.46
+  - @stainless-api/docs-ui@0.1.0-beta.65
+  - @stainless-api/docs-search@0.1.0-beta.18
+
+## 0.1.0-beta.86
+
+### Minor Changes
+
+- 7439be7: Adds Terraform rendering to docs
+
+### Patch Changes
+
+- c8fb9b3: fix layout shift on api pages
+- 3411ffe: Add underlying capabilities to the sidebar: collapsible/icon
+- 509a074: bump astro & starlight for pagefind fix
+- Updated dependencies [3411ffe]
+- Updated dependencies [7439be7]
+  - @stainless-api/docs-ui@0.1.0-beta.64
+  - @stainless-api/docs-search@0.1.0-beta.17
+
 ## 0.1.0-beta.85
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stainless-api/docs",
-  "version": "0.1.0-beta.85",
+  "version": "0.1.0-beta.87",
   "publishConfig": {
     "access": "public"
   },
@@ -30,7 +30,7 @@
     "node": ">=18.17.1"
   },
   "peerDependencies": {
-    "@astrojs/starlight": ">=0.37.4",
+    "@astrojs/starlight": ">=0.37.5",
     "astro": ">=5.15.3",
     "react": ">=19.0.0",
     "react-dom": ">=19.0.0",
@@ -58,9 +58,9 @@
     "vite-plugin-prebundle-workers": "^0.2.0",
     "web-worker": "^1.5.0",
     "yaml": "^2.8.2",
-    "@stainless-api/docs-search": "0.1.0-beta.16",
-    "@stainless-api/docs-ui": "0.1.0-beta.63",
-    "@stainless-api/ui-primitives": "0.1.0-beta.45"
+    "@stainless-api/docs-search": "0.1.0-beta.18",
+    "@stainless-api/docs-ui": "0.1.0-beta.65",
+    "@stainless-api/ui-primitives": "0.1.0-beta.46"
   },
   "devDependencies": {
     "@astrojs/check": "^0.9.6",
@@ -75,7 +75,7 @@
     "vite": "^6.4.1",
     "zod": "^4.3.5",
     "@stainless/eslint-config": "0.1.0-beta.1",
-    "@stainless/sdk-json": "^0.1.0-beta.3"
+    "@stainless/sdk-json": "^0.1.0-beta.4"
   },
   "scripts": {
     "vendor-deps": "tsx scripts/vendor_deps.ts",

package/plugin/components/SDKSelect.astro

@@ -24,7 +24,6 @@ const spec = await cmsClient.getSpec();
 // TODO: should not force unwrap this
 const languages: DocsLanguage[] = spec.docs!.languages ?? ['http'];
 const options = languages
-  .filter((language) => language !== 'terraform')
   .filter((language) => !EXCLUDE_LANGUAGES.includes(language))
   .map((value) => ({
     value,

package/plugin/components/SnippetCode.tsx

@@ -16,6 +16,7 @@ import { Button } from '@stainless-api/ui-primitives';
 import { CopyIcon, PlayIcon } from 'lucide-react';
 import React from 'react';
 import { RequestBuilder } from './RequestBuilder';
+import { Method } from '@stainless/sdk-json';
 
 function PlaygroundIcon() {
   return (
@@ -152,13 +153,17 @@ function useIsCollapsible({ signature }: { signature?: string }): boolean {
   return Boolean(EXPERIMENTAL_COLLAPSIBLE_SNIPPETS && signature && language);
 }
 
+function isActualMethod(value: object): value is Method {
+  return 'kind' in value && value.kind === 'http_method';
+}
+
 export function SnippetContainer({ children, signature, method }: SnippetContainerProps) {
   const isCollapsible = useIsCollapsible({ signature });
   const className = clsx(
     style.Snippet,
     isCollapsible ? 'stl-snippet-collapsible' : 'stl-snippet-non-collapsible',
   );
-  return EXPERIMENTAL_REQUEST_BUILDER ? (
+  return EXPERIMENTAL_REQUEST_BUILDER && isActualMethod(method) ? (
     <RequestBuilder className={className} method={method}>
       {children}
     </RequestBuilder>

package/plugin/index.ts

@@ -149,9 +149,9 @@ async function stlStarlightAstroIntegration(
       ).json()) as SpecResp;
       if (!spec || !auth) throw new Error('expected spec');
 
-      const langs = (spec.docs?.languages ?? ['http'])
-        .filter((lang) => lang !== 'terraform')
-        .filter((lang) => !pluginConfig.excludeLanguages?.includes(lang));
+      const langs = (spec.docs?.languages ?? ['http']).filter(
+        (lang) => !pluginConfig.excludeLanguages?.includes(lang),
+      );
 
       await buildPlaygrounds!({
         spec,

package/plugin/routes/Docs.astro

@@ -66,7 +66,10 @@ if (props.kind === 'http_method' && props.stainlessPath) {
   frontmatter={{
     title: props.title,
     pagefind: false,
-    tableOfContents: ['resource', 'readme'].includes(props.kind) ? { maxHeadingLevel: 6 } : false,
+    tableOfContents:
+      props.kind === 'readme' || (props.kind === 'resource' && props.language !== 'terraform')
+        ? { maxHeadingLevel: 6 }
+        : false,
   }}
 >
   {
@@ -81,17 +84,6 @@ if (props.kind === 'http_method' && props.stainlessPath) {
           contentPanelLayout={CONTENT_PANEL_LAYOUT}
           transformRequestSnippet={MIDDLEWARE.transformRequestSnippet}
         />
-
-        {/* TODO: we should not set inline styles here? */}
-        <style
-          is:inline
-          set:text={`
-
-          [data-has-sidebar]:not([data-has-toc]) .sl-container {
-            max-width: 1428px;
-          }
-        `}
-        />
       </div>
     ) : (
       <>

package/plugin/routes/Overview.astro

@@ -26,16 +26,18 @@ Astro.locals._stlStarlightPage = {
     tableOfContents: false,
   }}
 >
-  <h3>Libraries</h3>
+  <div class="stl-overview">
+    <h3>Libraries</h3>
 
-  <div class="stldocs-root language-blocks stl-ui-not-prose not-content">
-    <RenderLibraries metadata={metadata} />
-  </div>
+    <div class="stldocs-root language-blocks stl-ui-not-prose not-content">
+      <RenderLibraries metadata={metadata} />
+    </div>
 
-  <h3>API Overview</h3>
+    <h3>API Overview</h3>
 
-  <div class="stldocs-root api-overview stl-ui-not-prose">
-    <RenderSpecOverview spec={spec} language="http" />
+    <div class="stldocs-root api-overview stl-ui-not-prose">
+      <RenderSpecOverview spec={spec} language="http" />
+    </div>
   </div>
 </StarlightPage>
 

package/stl-docs/components/sidebars/BaseSidebar.astro

@@ -2,8 +2,10 @@
 import HeaderLinks from '../headers/HeaderLinks.astro';
 import { SidebarWithComponents } from './SidebarWithComponents';
 import SidebarPersister from '@astrojs/starlight/components/SidebarPersister.astro';
+import { convertAstroSidebarToStl } from './convertAstroSidebarToStl';
 
 const { sidebar } = Astro.locals.starlightRoute;
+const stlSidebar = convertAstroSidebarToStl(sidebar);
 ---
 
 <div class="stl-sidebar-header-links">
@@ -11,5 +13,5 @@ const { sidebar } = Astro.locals.starlightRoute;
 </div>
 <slot name="sdk-select" />
 <SidebarPersister>
-  <SidebarWithComponents entries={sidebar} withStarlightRestoration />
+  <SidebarWithComponents entries={stlSidebar} withStarlightRestoration />
 </SidebarPersister>

package/stl-docs/components/sidebars/convertAstroSidebarToStl.tsx

@@ -0,0 +1,46 @@
+import { StlSidebarEntry } from '@stainless-api/docs-ui/components';
+import { SidebarEntry } from '../pagination/util';
+import { ReactNode } from 'react';
+import { Badge, getHttpMethod } from '@stainless-api/ui-primitives';
+import { FunctionIcon } from '@stainless-api/ui-primitives/icons';
+
+export function convertAstroSidebarToStl(entries: SidebarEntry[]): StlSidebarEntry[] {
+  return entries.map((entry): StlSidebarEntry => {
+    if (entry.type === 'link') {
+      let icon: ReactNode | undefined;
+
+      const methodAttr = entry.attrs['data-stldocs-method'];
+      const httpMethod = getHttpMethod(methodAttr);
+      if (httpMethod) {
+        icon = <Badge.HTTP method={httpMethod} iconOnly size="sm" />;
+      }
+      // Support empty string as method to show generic "Function" badge
+      else if (methodAttr === '') {
+        icon = (
+          <Badge size="sm" icon={<FunctionIcon />} intent="info">
+            {''}
+          </Badge>
+        );
+      }
+
+      return {
+        type: 'link',
+        attrs: entry.attrs,
+        label: entry.label,
+        target: {
+          type: 'href',
+          href: entry.href,
+        },
+        isCurrent: entry.isCurrent,
+        icon,
+      };
+    } else {
+      return {
+        type: 'group',
+        label: entry.label,
+        collapsed: entry.collapsed,
+        entries: convertAstroSidebarToStl(entry.entries),
+      };
+    }
+  });
+}

package/styles/page.css

@@ -79,6 +79,14 @@
   padding: 1rem 0 0 var(--stldocs-content-padding);
 }
 
+[data-has-sidebar]:not([data-has-toc]) .sl-container {
+  max-width: 1428px;
+}
+
+.stl-overview {
+  max-width: var(--sl-content-width);
+}
+
 @media (min-width: 50rem) {
   :root[data-has-sidebar] {
     --sl-content-inline-start: calc(var(--sl-sidebar-width) + 2rem);