@stainless-api/docs 0.1.0-beta.11 → 0.1.0-beta.110

package/plugin/globalJs/copy.ts

@@ -1,30 +1,44 @@
-import { EXPERIMENTAL_COLLAPSIBLE_SNIPPETS } from 'virtual:stl-starlight-virtual-module';
+import {
+  RESOLVED_API_REFERENCE_PATH,
+  EXPERIMENTAL_COLLAPSIBLE_SNIPPETS,
+} from 'virtual:stl-starlight-virtual-module';
+import { getPageLoadEvent } from '../helpers/getPageLoadEvent';
+import { updateSelectedLanguage } from '../languages';
+import { navigate } from 'astro/virtual-modules/transitions-router.js';
 const copyIcon = `<rect width="14" height="14" x="8" y="8" rx="2" ry="2"/><path d="M4 16c-1.1 0-2-.9-2-2V4c0-1.1.9-2 2-2h10c1.1 0 2 .9 2 2"/>`;
 const circleAlertIcon = `<circle cx="12" cy="12" r="10"/><line x1="12" x2="12" y1="8" y2="12"/><line x1="12" x2="12.01" y1="16" y2="16"/>`;
 const checkIcon = `<path d="M20 6 9 17l-5-5"/>`;
 
+function getContent(button: HTMLElement, full: boolean) {
+  const isContentCollapsed = !!document.querySelector('.stldocs-snippet-code.stl-snippet-code-is-collapsed');
+
+  const content = button.closest('[data-stldocs-copy-parent]')!.querySelector('[data-stldocs-copy-content]')!;
+
+  const contentCopy = content.cloneNode(true) as HTMLElement;
+
+  contentCopy.querySelectorAll('.ellipsis').forEach((el) => el.remove());
+  if (EXPERIMENTAL_COLLAPSIBLE_SNIPPETS && isContentCollapsed && !full) {
+    contentCopy.querySelectorAll('.hidden').forEach((el) => el.remove());
+    contentCopy.querySelectorAll('.leading-ws').forEach((el) => el.remove());
+  }
+
+  return contentCopy.textContent!;
+}
+
+const preloadPlayground = async (event: Event) => {
+  const playButton = (event.target as HTMLElement).closest('[data-stldocs-snippet-play]') as HTMLElement;
+  if (playButton) {
+    loadPlayground(playButton);
+  }
+};
+addEventListener('mouseover', preloadPlayground);
 addEventListener('click', async (event) => {
   const copyButton = (event.target as HTMLElement).closest('[data-stldocs-snippet-copy]') as HTMLElement;
   if (copyButton) {
     const iconElement = copyButton.querySelector('.stldocs-icon') as SVGElement;
     clearTimeout(copyButton.dataset.__stldocsCopyTimeout);
     try {
-      const isContentCollapsed = !!document.querySelector(
-        '.stldocs-snippet-code.stl-snippet-code-is-collapsed',
-      );
-
-      const content = copyButton
-        .closest('[data-stldocs-copy-parent]')!
-        .querySelector('[data-stldocs-copy-content]')!;
-
-      const contentCopy = content.cloneNode(true) as HTMLElement;
-
-      contentCopy.querySelectorAll('.ellipsis').forEach((el) => el.remove());
-      if (EXPERIMENTAL_COLLAPSIBLE_SNIPPETS && isContentCollapsed) {
-        contentCopy.querySelectorAll('.hidden').forEach((el) => el.remove());
-        contentCopy.querySelectorAll('.leading-ws').forEach((el) => el.remove());
-      }
-      await navigator.clipboard.writeText(contentCopy.textContent!);
+      await navigator.clipboard.writeText(getContent(copyButton, false));
       iconElement.innerHTML = checkIcon;
     } catch {
       iconElement.innerHTML = circleAlertIcon;
@@ -34,4 +48,68 @@ addEventListener('click', async (event) => {
         iconElement.innerHTML = copyIcon;
       }, 1000) + '';
   }
+
+  const playButton = (event.target as HTMLElement).closest('[data-stldocs-snippet-play]') as HTMLElement;
+  if (playButton) {
+    showPlayground(playButton);
+  }
+});
+
+async function showPlayground(playButton: HTMLElement) {
+  if (playButton.getAttribute('aria-disabled') === 'true') return;
+  const iconElement = playButton.querySelector('.stldocs-icon') as SVGElement;
+  try {
+    // use aria-disabled, not disabled, to avoid losing focus
+    playButton.setAttribute('aria-disabled', 'true');
+    playButton.setAttribute('aria-label', 'Loading playground...');
+    playButton.classList.add('stl-ui-button--loading');
+    const showPlayground = loadPlayground(playButton);
+    await showPlayground();
+  } catch (e) {
+    console.error(e);
+    iconElement.innerHTML = circleAlertIcon;
+  }
+  playButton.removeAttribute('aria-disabled');
+  playButton.removeAttribute('aria-label');
+  playButton.classList.remove('stl-ui-button--loading');
+}
+
+function loadPlayground(playButton: HTMLElement) {
+  (playButton as any).__playgroundLoadPromise ??= (async () => {
+    const container = playButton.closest('.stldocs-snippet') as HTMLElement;
+    const language = (container.querySelector('.stl-sdk-select') as HTMLElement).dataset.currentValue;
+    const code = getContent(playButton, true);
+    // eslint-disable-next-line turbo/no-undeclared-env-vars
+    if (import.meta.env.DEV) {
+      const id = '/@id/astro:scripts/before-hydration.js';
+      await import(/* @vite-ignore */ id).catch(console.warn);
+    }
+    const { createPlayground } = await import('virtual:stl-playground/create');
+    const { default: playgroundData } = await import('virtual:stl-playground/data');
+    return createPlayground({
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      lang: language as any,
+      doc: (language === 'python' ? 'from rich import print\n' : '') + code.trimEnd(),
+      container,
+      onLanguageSelect: (value) => {
+        const originalLanguage = container.querySelector<HTMLElement>('[data-stldocs-snippet-select]')
+          ?.dataset.currentValue;
+        const path: string = updateSelectedLanguage(RESOLVED_API_REFERENCE_PATH, originalLanguage, value);
+        navigate(path.replace(/(\?.+)?($|#)/, (_, str, end) => (str ? str + '&play' : '?play') + end));
+      },
+      ...playgroundData,
+    });
+  })();
+  return async () => {
+    const promise = (playButton as any).__playgroundLoadPromise;
+    (playButton as any).__playgroundLoadPromise = null;
+    await ((await promise) as () => Promise<void>)();
+  };
+}
+document.addEventListener(getPageLoadEvent(), () => {
+  if (new URL(location.href).searchParams.has('play')) {
+    document.querySelectorAll('[data-stldocs-snippet-play]').forEach((e) => {
+      showPlayground(e as HTMLElement);
+    });
+  }
 });

package/plugin/globalJs/create-playground.shim.ts

@@ -0,0 +1,3 @@
+export function createPlayground(): () => Promise<void> {
+  return () => Promise.resolve();
+}

package/plugin/globalJs/method-descriptions.ts

@@ -0,0 +1,33 @@
+document.addEventListener('DOMContentLoaded', function () {
+  const COLLAPSED_HEIGHT = 170;
+
+  const container = document.querySelector<HTMLElement>('[data-stldocs-property-group="method-description"]');
+
+  if (!container) return;
+
+  const toggle = document?.querySelector<HTMLButtonElement>('[data-method-description-toggle]');
+  if (!toggle) return;
+
+  // If content isn't tall enough, don't show the button
+  if (container.scrollHeight <= COLLAPSED_HEIGHT + 1) {
+    toggle.hidden = true;
+    container.dataset.collapsed = 'false';
+    return;
+  }
+
+  // Only show button if content is taller than collapsed max height
+  if (container.scrollHeight > COLLAPSED_HEIGHT + 1) {
+    toggle.hidden = false;
+  } else {
+    // Not tall enough to need collapsing — show full content and hide button
+    container.dataset.collapsed = 'false';
+    toggle.hidden = true;
+    return;
+  }
+
+  toggle.addEventListener('click', function () {
+    const isCollapsed = container.dataset.collapsed !== 'false';
+    container.dataset.collapsed = isCollapsed ? 'false' : 'true';
+    toggle.textContent = isCollapsed ? 'Show less' : 'Show more';
+  });
+});

package/plugin/globalJs/navigation.ts

@@ -1,19 +1,17 @@
-import { parseRoute, scrollToPath } from '@stainless-api/docs-ui/src/routing';
-import { BASE_PATH } from 'virtual:stl-starlight-virtual-module';
+import { parseRoute, scrollToPath } from '@stainless-api/docs-ui/routing';
+import { RESOLVED_API_REFERENCE_PATH } from 'virtual:stl-starlight-virtual-module';
 import { updateSelectedLanguage } from '../languages';
 import { navigate } from 'astro:transitions/client';
 import { getPageLoadEvent } from '../helpers/getPageLoadEvent.ts';
 
-import { initDropdown } from '@stainless-api/docs-ui/src/components/scripts/dropdown';
-import { initDropdownButton } from '@stainless-api/ui-primitives/scripts';
-import { copyCurrentPageAsMarkdown, onSelectAIOption } from './ai-dropdown.ts';
+import { initDropdown } from '@stainless-api/docs/components/scripts';
 
 history.scrollRestoration = 'auto';
 
 function getStainlessPathForLocation() {
   return document.location.hash
     ? decodeURI(document.location.hash)
-    : parseRoute(BASE_PATH, document.location.href)?.stainlessPath;
+    : parseRoute(RESOLVED_API_REFERENCE_PATH, document.location.href)?.stainlessPath;
 }
 
 window.addEventListener('popstate', (ev: PopStateEvent) => {
@@ -24,38 +22,20 @@ window.addEventListener('popstate', (ev: PopStateEvent) => {
 });
 
 document.addEventListener(getPageLoadEvent(), () => {
-  initDropdown({
-    dropdownId: 'stldocs-snippet-select',
-    onSelect: (value) => {
-      const originalLanguage = document.getElementById('stldocs-snippet-select')?.dataset.currentValue;
-      navigate(updateSelectedLanguage(BASE_PATH, originalLanguage, value));
-    },
+  document.querySelectorAll<HTMLElement>('[data-stldocs-snippet-select]').forEach((rootElement) => {
+    initDropdown({
+      root: rootElement,
+      onSelect: (value) => {
+        const originalLanguage = rootElement.dataset.currentValue;
+        navigate(updateSelectedLanguage(RESOLVED_API_REFERENCE_PATH, originalLanguage, value));
+      },
+    });
   });
 
   const path = getStainlessPathForLocation();
   if (path) setTimeout(() => scrollToPath(path.slice(1)), 10);
 });
 
-document.addEventListener(getPageLoadEvent(), () => {
-  initDropdownButton({
-    dropdownId: 'ai-dropdown-button',
-    onSelect: onSelectAIOption,
-    onPrimaryAction: (el) => {
-      copyCurrentPageAsMarkdown();
-      const innerText = el.querySelector('[data-part="primary-action-text"]');
-      if (!innerText) return;
-
-      const originalInnerHtml = innerText.innerHTML;
-      innerText.innerHTML = 'Copied!';
-      el.classList.add('disabled');
-      setTimeout(() => {
-        innerText.innerHTML = originalInnerHtml;
-        el.classList.remove('disabled');
-      }, 1000);
-    },
-  });
-});
-
 document.addEventListener('click', (event) => {
   const toggle = (event.target as HTMLElement).closest(
     '[data-stldocs-property-toggle-expanded] > .stldocs-expand-toggle-content',

package/plugin/globalJs/playground-data.shim.ts

@@ -0,0 +1 @@
+export default {};

package/plugin/globalJs/playground-data.ts

@@ -0,0 +1,14 @@
+import wheelUrl from 'virtual:stl-playground/python/wheel.whl?url';
+import pyTypes from 'virtual:stl-playground/python.json';
+import tsTypes from 'virtual:stl-playground/typescript.json';
+import authData from 'virtual:stl-playground/auth.json';
+import { HIGHLIGHT_THEMES } from 'virtual:stl-starlight-virtual-module';
+import { Config } from 'virtual:stl-playground/create';
+
+export default {
+  wheelUrl,
+  pyTypes,
+  tsTypes,
+  authData,
+  HIGHLIGHT_THEMES,
+} satisfies Config;

package/plugin/helpers/generateDocsRoutes.ts

@@ -0,0 +1,59 @@
+import type * as SDKJSON from '@stainless/sdk-json';
+import { DocsLanguage, generateRouteList } from '@stainless-api/docs-ui/routing';
+import { EXCLUDE_LANGUAGES } from 'virtual:stl-starlight-virtual-module';
+import { api } from 'virtual:stainless-apis-manifest';
+import { getSDKJSONInSSR } from '../specs/fetchSpecSSR';
+
+export function generateDocsRoutes(spec: SDKJSON.Spec, excludeLanguages: DocsLanguage[] = EXCLUDE_LANGUAGES) {
+  const paths = generateRouteList({
+    spec,
+    excludeLanguages,
+  });
+  const readmes = Object.entries(spec.readme)
+    .filter(([language]) => language !== 'http')
+    .filter(([language]) => !excludeLanguages.includes(language as DocsLanguage))
+    .map(([language]) => ({
+      slug: language,
+      stainlessPath: null,
+      language: language as DocsLanguage,
+      title: 'Readme',
+      kind: 'readme' as const,
+    }));
+
+  return [...paths, ...readmes].map(({ slug, stainlessPath, language, title, kind }) => {
+    return {
+      params: { slug },
+      props: { stainlessPath, language, title, kind },
+    };
+  });
+}
+
+export async function generateAllDocsRoutes() {
+  const uniquePaths = new Set<string>();
+
+  const allRoutes = (
+    await Promise.all(
+      api.languages.map(async (entry) => {
+        const spec = await getSDKJSONInSSR(entry.language);
+
+        // this is super annoying, but preview worker _always_ generates HTTP routes
+        // so, we exclude them unless the we're explicitly told to include them
+        const excludeLanguages = [...EXCLUDE_LANGUAGES];
+        if (entry.language !== 'http') {
+          excludeLanguages.push('http');
+        }
+
+        const routes = generateDocsRoutes(spec, excludeLanguages);
+        return routes.filter((route) => {
+          if (uniquePaths.has(route.params.slug)) {
+            return false;
+          }
+          uniquePaths.add(route.params.slug);
+          return true;
+        });
+      }),
+    )
+  ).flat();
+
+  return allRoutes;
+}

package/plugin/helpers/multiSpec.ts

@@ -0,0 +1,8 @@
+import { api } from 'virtual:stainless-apis-manifest';
+import { EXCLUDE_LANGUAGES } from 'virtual:stl-starlight-virtual-module';
+
+export function getDocsLanguages() {
+  return api.languages
+    .map((language) => language.language)
+    .filter((language) => !EXCLUDE_LANGUAGES.includes(language));
+}