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

package/plugin/components/RequestBuilder/index.tsx

@@ -0,0 +1,37 @@
+import { ReactNode } from 'react';
+import * as SDKJSON from '@stainless/sdk-json';
+import { useSpec } from '@stainless-api/docs-ui/contexts';
+import { extractParams, Param } from './spec-helpers';
+import type { SnippetStainlessIslandProps } from './props';
+
+/** Load and process the spec on the server side to avoid inflating client bundle */
+export function RequestBuilder({
+  className,
+  children,
+  method,
+}: {
+  className: string;
+  children: ReactNode;
+  method: SDKJSON.Method;
+}) {
+  let params: Param[];
+  const spec = useSpec();
+  try {
+    if (!spec) throw new Error('Spec is required for RequestBuilder');
+    params = spec && extractParams(spec, method);
+  } catch (e) {
+    console.warn(e);
+    return <div className={className}>{children}</div>;
+  }
+  const [httpMethod, path] = method.endpoint.split(' ') as [string, string];
+
+  return (
+    <stl-island component="SnippetStainlessIsland" className={className}>
+      {/* Pass state down to the client component. TODO: we need a better solution for this */}
+      <template className="request-builder-props">
+        {JSON.stringify({ method: httpMethod, path, params } satisfies SnippetStainlessIslandProps)}
+      </template>
+      {children}
+    </stl-island>
+  );
+}

package/plugin/components/RequestBuilder/props.ts

@@ -0,0 +1,9 @@
+import z from 'zod';
+import { ParamSchema } from './spec-helpers';
+
+export const SnippetStainlessIslandPropsSchema = z.object({
+  method: z.string(),
+  path: z.string(),
+  params: z.array(ParamSchema),
+});
+export type SnippetStainlessIslandProps = z.infer<typeof SnippetStainlessIslandPropsSchema>;

package/plugin/components/RequestBuilder/spec-helpers.ts

@@ -0,0 +1,47 @@
+import type * as SDKJSON from '@stainless/sdk-json';
+import { printer } from '@stainless-api/docs-ui/markdown';
+import z from 'zod';
+import { getBodyParams } from '@stainless-api/docs-ui/utils';
+
+export const ParamSchema = z.object({
+  stainlessPath: z.string(),
+  location: z.string(),
+  key: z.string(),
+  type: z.string(),
+});
+
+export type Param = z.infer<typeof ParamSchema>;
+
+export function extractParams(spec: SDKJSON.Spec | undefined, method: SDKJSON.Method): Param[] {
+  const httpDecls = spec?.decls?.http;
+  if (!httpDecls) throw new Error('expected http language to be present in SDKJSON');
+  const decl = httpDecls?.[method.stainlessPath];
+  if (decl?.kind !== 'HttpDeclFunction') {
+    throw new Error(
+      'expected HttpDeclFunction at stainlessPath "' + method.stainlessPath + '", got ' + decl?.kind,
+    );
+  }
+  const bodyParams = getBodyParams(decl);
+  const params = [
+    ...Object.entries(decl.paramsChildren ?? {}).map(([location, children]) => ({ location, children })),
+    ...(bodyParams ? [{ location: 'body', children: bodyParams.params }] : []),
+  ]
+    .filter((e) => e.children.length)
+    .flatMap(({ location, children }) =>
+      children.map((child) => {
+        const resolved = httpDecls[child];
+        if (resolved?.kind !== 'HttpDeclProperty') {
+          throw new Error(
+            'expected HttpDeclProperty at stainlessPath "' + child + '", got ' + resolved?.kind,
+          );
+        }
+        return {
+          stainlessPath: resolved.stainlessPath,
+          location,
+          key: resolved.key,
+          type: (resolved.optional ? 'optional ' : '') + printer.type('http', resolved.type),
+        };
+      }),
+    );
+  return params;
+}

package/plugin/components/RequestBuilder/styles.css

@@ -0,0 +1,67 @@
+.request-builder-container form {
+  display: grid;
+
+  /* prettier-ignore */
+  grid-template-columns: /*info button*/max-content /*label*/max-content /*colon*/max-content /*input*/1fr;
+  font-family: var(--stl-typography-font);
+  font-size: var(--stl-typography-text-body-sm);
+  color: var(--stl-color-foreground);
+
+  & > * {
+    padding-inline-start: 12px;
+    padding-inline-end: 8px;
+  }
+
+  & > h4 {
+    grid-column: 1 / -1;
+    text-transform: capitalize;
+    font-size: var(--stl-typography-scale-sm);
+    margin-top: 0;
+    margin-bottom: 0.25em;
+    color: var(--stl-color-foreground-muted);
+    padding-top: 0.75rem;
+
+    &:not(:first-child) {
+      border-top: 1px solid var(--stl-color-border);
+    }
+  }
+
+  .request-builder-param {
+    grid-column: 1 / -1;
+    display: grid;
+    grid-template-columns: subgrid;
+    align-items: center;
+    column-gap: 0.5rem;
+    padding-block: 0.35rem;
+
+    .request-builder-param-info-button {
+      color: var(--stl-color-foreground-muted);
+      margin-inline: -4px;
+      padding: 0;
+    }
+    .request-builder-param-label {
+      font-family: var(--stl-typography-font-mono);
+    }
+    .request-builder-param-colon {
+      font-family: var(--stl-typography-font-mono);
+      color: var(--stl-color-foreground-muted);
+    }
+    /* TODO: new input component that is better stylable */
+    .request-builder-param-value {
+      input {
+        margin: 6px 8px;
+        font-size: inherit;
+      }
+    }
+
+    &:has(+ h4),
+    &:last-child {
+      padding-bottom: 0.75rem;
+    }
+  }
+}
+
+.request-builder-footer .stl-ui-button--ghost .stl-ui-button__icon {
+  color: var(--stl-color-foreground);
+  opacity: var(--stl-opacity-level-040);
+}

package/plugin/components/SDKSelect.astro

@@ -1,14 +1,14 @@
 ---
-import type { DocsLanguage } from '@stainless-api/docs-ui/src/routing';
-import { parseRoute } from '@stainless-api/docs-ui/src/routing';
-import { cmsClient } from '../cms/client';
-import { BASE_PATH, DEFAULT_LANGUAGE, EXCLUDE_LANGUAGES } from 'virtual:stl-starlight-virtual-module';
+import { parseRoute } from '@stainless-api/docs-ui/routing';
+import { DEFAULT_LANGUAGE } from 'virtual:stl-starlight-virtual-module';
 import { Languages } from '../languages';
 import { SDKSelectReactComponent } from '../react/Routing';
+import { getDocsLanguages } from '../helpers/multiSpec';
+import { API_REFERENCE_BASE_PATH } from 'virtual:stl-docs-virtual-module';
 
 const slug = `/${Astro.locals.starlightRoute.id}`;
 
-const basePath = BASE_PATH;
+const basePath = API_REFERENCE_BASE_PATH;
 const defaultLanguage = DEFAULT_LANGUAGE;
 const { language, stainlessPath } = parseRoute(basePath, slug);
 
@@ -19,28 +19,15 @@ const data = {
   defaultLanguage,
 };
 
-const spec = await cmsClient.getSpec();
+const options = getDocsLanguages().map((value) => ({
+  value,
+  label: Languages[value].name,
+  selected: data.language === value,
+}));
 
-// 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,
-    label: Languages[value].name,
-    selected: data.language === value,
-  }));
-
-const readmeSlug = language === 'http' ? BASE_PATH : `${BASE_PATH}/${language}`;
+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">
@@ -53,101 +40,21 @@ const readmeSlug = language === 'http' ? BASE_PATH : `${BASE_PATH}/${language}`;
   )
 }
 
-<style>
-  @layer starlight.core {
-    label {
-      --sl-label-icon-size: 16px;
-      --sl-caret-size: 1.25rem;
-      --sl-inline-padding: 0.5rem;
-      position: relative;
-      display: flex;
-      align-items: center;
-      gap: 0.25rem;
-      color: var(--sl-color-gray-1);
-    }
-
-    label:hover {
-      color: var(--sl-color-gray-2);
-    }
-
-    .icon {
-      position: absolute;
-      top: 50%;
-      transform: translateY(-50%);
-      pointer-events: none;
-      width: 16px;
-    }
-
-    select {
-      padding-block: 0.3rem;
-      padding-inline: calc(var(--sl-label-icon-size) + var(--sl-inline-padding) + 0.5rem)
-        calc(var(--sl-caret-size) + var(--sl-inline-padding) + 0.25rem);
-      margin-inline: calc(var(--sl-inline-padding) * -1);
-      width: calc(var(--sl-select-width) + var(--sl-inline-padding) * 2);
-      text-overflow: ellipsis;
-      color: inherit;
-      cursor: pointer;
-      appearance: none;
-      font-weight: 600;
-      text-transform: capitalize;
-    }
-
-    select:active {
-      font-weight: inherit;
-      /* font-family: sans-serif;
-      font-weight: 400; */
-    }
-
-    option {
-      background-color: var(--sl-color-bg-nav);
-      color: var(--sl-color-gray-1);
-    }
-
-    @media (min-width: 50rem) {
-      select {
-        font-size: var(--sl-text-sm);
-      }
-    }
-  }
-
-  @layer starlight.components {
-    .label-icon {
-      font-size: var(--sl-label-icon-size);
-      inset-inline-start: 0;
-    }
-
-    .caret {
-      font-size: var(--sl-caret-size);
-      inset-inline-end: 0;
-    }
-  }
-
-  .custom-select-wrapper {
-    --sl-inline-padding: 0.5rem;
-    position: relative;
-    display: inline-block;
-    /* These match the padding on the sidebar menu */
-    padding-left: var(--sl-inline-padding);
-    padding-right: var(--sl-inline-padding);
-
-    .icon.http path {
-      fill: var(--sl-color-text);
-    }
-  }
-</style>
 <script>
   import { navigate } from 'astro:transitions/client';
   import { updateSelectedLanguage } from '../languages';
-  import { initDropdown } from '@stainless-api/docs-ui/src/components/scripts/dropdown';
-  import { BASE_PATH } from 'virtual:stl-starlight-virtual-module';
+  import { initDropdown } from '@stainless-api/docs/components/scripts';
+  import { RESOLVED_API_REFERENCE_PATH } from 'virtual:stl-starlight-virtual-module';
   import { getPageLoadEvent } from '../helpers/getPageLoadEvent';
 
   document.addEventListener(getPageLoadEvent(), () => {
+    const sdkSelect = document.getElementById('sidebar-sdk-select');
+    if (!sdkSelect) return;
     initDropdown({
-      dropdownId: 'sidebar-sdk-select',
+      root: sdkSelect,
       onSelect: (value) => {
-        const originalLanguage = document.getElementById('sidebar-sdk-select')?.dataset.currentValue;
-        navigate(updateSelectedLanguage(BASE_PATH, originalLanguage, value));
+        const originalLanguage = sdkSelect.dataset.currentValue;
+        navigate(updateSelectedLanguage(RESOLVED_API_REFERENCE_PATH, originalLanguage, value));
       },
     });
   });

package/plugin/components/SnippetCode.tsx

@@ -1,14 +1,43 @@
-import type {
-  SnippetCodeProps,
-  SnippetContainerProps,
-  SnippetRequestContainerProps,
-} from '@stainless-api/docs-ui/src/components';
-import { useHighlight, useLanguage } from '@stainless-api/docs-ui/src/contexts';
-import style from '@stainless-api/docs-ui/src/style';
+import {
+  type SnippetCodeProps,
+  type SnippetContainerProps,
+  SnippetResponse as DocsUiSnippetResponse,
+} from '@stainless-api/docs-ui/components';
+import { useHighlight, useLanguage } from '@stainless-api/docs-ui/contexts';
+import style from '@stainless-api/docs-ui/style';
 import * as cheerio from 'cheerio/slim';
-import { EXPERIMENTAL_COLLAPSIBLE_SNIPPETS } from 'virtual:stl-starlight-virtual-module';
+import {
+  EXPERIMENTAL_COLLAPSIBLE_SNIPPETS,
+  EXPERIMENTAL_PLAYGROUNDS,
+  EXPERIMENTAL_REQUEST_BUILDER,
+} from 'virtual:stl-starlight-virtual-module';
 import clsx from 'clsx';
 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 (
+    <svg
+      xmlns="http://www.w3.org/2000/svg"
+      width={16}
+      height={16}
+      viewBox="0 0 24 24"
+      fill="none"
+      stroke="currentColor"
+      strokeWidth={2}
+      strokeLinecap="round"
+      strokeLinejoin="round"
+      className={'lucide ' + style.Icon}
+      aria-hidden="true"
+    >
+      <path d="m 1,2 h 1 a 4,4 0 0 1 4,4 v 1 m 5,15 H 10 A 4,4 0 0 1 6,18 V 6 a 4,4 0 0 1 4,-4 h 1 M 1,22 H 2 A 4,4 0 0 0 6,18 V 17 M 14.029059,8.147837 A 1.2853426,1.2853426 0 0 1 15.978924,7.0437277 L 22.40178,10.8959 a 1.2853426,1.2853426 0 0 1 0,2.208219 l -6.422856,3.852172 a 1.2853426,1.2853426 0 0 1 -1.949865,-1.105395 z" />
+    </svg>
+  );
+}
+
 /*
  * This may be replaced by additional data from the sdk.
  * Without information from the sdk, we use simple heuristics per language.
@@ -54,7 +83,7 @@ function wrapFirstNSpaces($line: cheerio.Cheerio<any>, n: number) {
   const m = inner.match(new RegExp(`^( {1,${n}})`));
   if (!m) return;
 
-  const lead = m[1];
+  const lead = m[1]!;
   $firstSpan.html(`<span class="leading-ws">${lead}</span>${inner.slice(lead.length)}`);
 }
 
@@ -124,63 +153,40 @@ function useIsCollapsible({ signature }: { signature?: string }): boolean {
   return Boolean(EXPERIMENTAL_COLLAPSIBLE_SNIPPETS && signature && language);
 }
 
-export function SnippetRequestContainer({ children, signature }: SnippetRequestContainerProps) {
-  const isCollapsible = useIsCollapsible({ signature });
-
-  return (
-    <div className="stl-snippet-request-container">
-      {children}
-      {signature && isCollapsible && (
-        <Button
-          className={'stl-snippet-expand-button'}
-          id="stl-snippet-expand-button"
-          size="sm"
-          variant="outline"
-        >
-          Show more
-        </Button>
-      )}
-    </div>
-  );
+function isActualMethod(value: object): value is Method {
+  return 'kind' in value && value.kind === 'http_method';
 }
 
-export function SnippetContainer({ children, signature }: SnippetContainerProps) {
+export function SnippetContainer({ children, signature, method }: SnippetContainerProps) {
   const isCollapsible = useIsCollapsible({ signature });
-
-  return (
-    <div
-      className={clsx(
-        style.Snippet,
-        isCollapsible ? 'stl-snippet-collapsible' : 'stl-snippet-non-collapsible',
-      )}
-    >
+  const className = clsx(
+    style.Snippet,
+    isCollapsible ? 'stl-snippet-collapsible' : 'stl-snippet-non-collapsible',
+  );
+  return EXPERIMENTAL_REQUEST_BUILDER && isActualMethod(method) ? (
+    <RequestBuilder className={className} method={method}>
       {children}
-    </div>
+    </RequestBuilder>
+  ) : (
+    <div className={className}>{children}</div>
   );
 }
 
-export function CondensibleSnippetCode({
-  content,
-  language,
-  signature,
-  highlighted,
-}: SnippetCodeProps & { signature: string; highlighted: string; language: string }) {
-  const ranges = getCollapsedRanges(content, language, signature);
-  const html = condensedShikiHtmlFull(highlighted, language, ranges);
-  const offset = getCounterOffset(ranges);
-
+export function SnippetButtons({ content }: { content: string }) {
+  void content;
+  const language = useLanguage();
   return (
-    <div
-      className={clsx(style.SnippetCode, 'stl-snippet-code-is-collapsed')}
-      data-snippet-expanded-offset={offset}
-    >
-      <pre className={style.SnippetCodeContent} data-stldocs-copy-content>
-        <code
-          className={language === 'json' ? 'snippet-json' : 'snippet'}
-          dangerouslySetInnerHTML={{ __html: html }}
-        />
-      </pre>
-    </div>
+    <>
+      <Button variant="outline" data-stldocs-snippet-copy>
+        <CopyIcon size={16} className={style.Icon} />
+      </Button>
+      {EXPERIMENTAL_PLAYGROUNDS &&
+        (language === 'python' || language === 'typescript' || language === 'http') && (
+          <Button data-stldocs-snippet-play variant="muted" border title="Play">
+            <PlaygroundIcon />
+          </Button>
+        )}
+    </>
   );
 }
 
@@ -200,16 +206,52 @@ export function SnippetCode({ content, signature, language: forcedLanguage }: Sn
   }
 
   return (
-    <div
-      className={clsx(style.SnippetCode, isCollapsible && 'stl-snippet-code-is-collapsed')}
-      data-snippet-expanded-offset={offset}
-    >
-      <pre className={style.SnippetCodeContent} data-stldocs-copy-content>
-        <code
-          className={(language as string) === 'json' ? 'snippet-json' : 'snippet'}
-          dangerouslySetInnerHTML={{ __html: highlighted }}
-        />
-      </pre>
+    <>
+      <div
+        className={clsx(style.SnippetCode, isCollapsible && 'stl-snippet-code-is-collapsed')}
+        data-snippet-expanded-offset={offset}
+        data-stldocs-copy-content
+        dangerouslySetInnerHTML={{ __html: highlighted }}
+      />
+      {signature && isCollapsible && (
+        <Button
+          className={'stl-snippet-expand-button'}
+          id="stl-snippet-expand-button"
+          size="sm"
+          variant="outline"
+        >
+          Show more
+        </Button>
+      )}
+      {EXPERIMENTAL_REQUEST_BUILDER && (
+        <div className="request-builder-container" style={{ display: 'contents' }}></div>
+      )}
+    </>
+  );
+}
+
+export function SnippetFooter() {
+  if (!EXPERIMENTAL_REQUEST_BUILDER) return null;
+  return (
+    <div className={clsx(style.SnippetFooter, 'try-it-footer')}>
+      {EXPERIMENTAL_REQUEST_BUILDER && (
+        <div className="request-builder-footer" style={{ display: 'contents' }}></div>
+      )}
+      <Button variant="accent" className="try-it-button">
+        <Button.Label>Try it</Button.Label>
+        <Button.Icon icon={PlayIcon} />
+      </Button>
     </div>
   );
 }
+
+export function SnippetResponse({ ...props }: React.ComponentProps<typeof DocsUiSnippetResponse>) {
+  return (
+    <>
+      <DocsUiSnippetResponse {...props} />
+      {EXPERIMENTAL_REQUEST_BUILDER && (
+        <div className="request-builder-response" style={{ display: 'contents' }} />
+      )}
+    </>
+  );
+}

package/plugin/components/StainlessIslands.tsx

@@ -0,0 +1,126 @@
+/**
+ * Technical overview:
+ * - `StainlessIslands.ts` is an Astro Client Island wherein we register a HTML custom element called `stl-island`
+ *     - When a `<stl-island component="MyComponent">` is added to the DOM, we:
+ *         1. receive a callback from the browser
+ *         2. dynamic-import `MyComponent`
+ *         3. create an instance of `MyComponent`, to which we pass the **`stl-island` DOM node** as a prop named `parent`
+ *         4. register the (`stlIslandDomNode` → `ReactNode`) pair in a global map named `roots`
+ *     - The actual Astro client island is a simple React component that renders all of the ReactNodes from the global `roots` map
+ *         - it uses a `useSyncExternalStore` to be notified of changes to the global `roots` map by registering a callback
+ *     - Each “stainless island” (instantiated by the custom element handler and rendered by the Astro client island) is responsible for using the `parent` prop it receives to identify one or more **portal targets** into which it can render its contents.
+ *         - the react parent of all Stainless Islands is the global `<StainlessIslands client:load />` singleton, but the _DOM parent_ is the various portal targets of all of the stainless islands
+ */
+
+import { useSyncExternalStore, ReactNode } from 'react';
+
+type StlIslandComponent = ({ parent }: { parent: HTMLElement }) => ReactNode;
+
+/**
+ * Register new Stainless Islands in this map.
+ * The component should be the default export and should be able to be dynamic-imported.
+ * The component should accept a single prop: `parent: HTMLElement`, which is the DOM node of the `<stl-island>` element.
+ * The component can create portals to render into the DOM subtree of the `parent`.
+ */
+const componentsMap: Record<string, () => Promise<{ default: StlIslandComponent }>> = {
+  SnippetStainlessIsland: () => import('./RequestBuilder/SnippetStainlessIsland'),
+};
+
+interface State {
+  roots: Map<HTMLElement, ReactNode>;
+  onRootsChange?: (() => void) | undefined;
+}
+
+// keep state in import.meta.hot.data so that our record of our react roots is not lost across HMR
+const state: State = import.meta.hot?.data?.state ?? {
+  roots: new Map(),
+};
+
+if (import.meta.hot?.data) {
+  import.meta.hot.data.state = state;
+}
+
+let key = 0;
+
+/**
+ * Custom element mounts and unmounts components and gives them a reference to the parent
+ * so they can render in portals.
+ */
+class StlIsland extends (globalThis?.HTMLElement ?? Object) {
+  connectedCallback(this: StlIsland) {
+    const componentName = this.getAttribute('component');
+    if (!componentName) {
+      console.error('[stl-island] missing required attribute "component"');
+      return;
+    }
+
+    if (!componentsMap[componentName]) {
+      console.error(`[stl-island] unknown component "${componentName}"`);
+      return;
+    }
+
+    componentsMap[componentName]().then(
+      ({ default: Component }) => {
+        state.roots = new Map(state.roots).set(this, <Component parent={this} key={key++} />);
+        state.onRootsChange?.();
+      },
+      (e) => {
+        console.error(`[stl-island] failed to load component "${componentName}":`, e);
+      },
+    );
+  }
+  connectedMoveCallback() {
+    // empty so we don't get disconnected/reconnected if the dom element gets moved
+  }
+  disconnectedCallback() {
+    state.roots = new Map(state.roots);
+    state.roots.delete(this);
+    state.onRootsChange?.();
+  }
+}
+
+if (typeof customElements !== 'undefined' && !customElements.get('stl-island')) {
+  customElements.define('stl-island', StlIsland);
+}
+
+declare global {
+  interface HTMLElementTagNameMap {
+    'stl-island': StlIsland;
+  }
+}
+declare module 'react' {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace JSX {
+    interface IntrinsicElements {
+      // client-loaded
+      'stl-island': React.DetailedHTMLProps<React.HTMLAttributes<StlIsland>, StlIsland> & {
+        component: keyof typeof componentsMap;
+      };
+    }
+  }
+}
+
+/** Renders all StainlessIslands that have been registered in the global `state.roots` map */
+function StainlessIslandsInner() {
+  const roots = useSyncExternalStore<Map<HTMLElement, ReactNode> | null>(
+    (onChange) => {
+      state.onRootsChange = onChange;
+      return () => {
+        state.onRootsChange = undefined;
+      };
+    },
+    () => {
+      return state.roots;
+    },
+    () => null,
+  );
+  if (!roots) return null;
+  return [...roots.values()];
+}
+
+export function StainlessIslands() {
+  // Astro tries to call this function outside of react to detect if it's
+  // an Astro JSX or React JSX component, which causes warnings if we use hooks,
+  // so we use a wrapper component to avoid the hook calls.
+  return <StainlessIslandsInner />;
+}