@stainless-api/docs-ui 0.1.0-beta.7 → 0.1.0-beta.70

package/dist/method-BzkPRXGL.d.ts

@@ -0,0 +1,59 @@
+import * as React$1 from "react";
+import { ReactNode } from "react";
+import * as react_jsx_runtime5 from "react/jsx-runtime";
+
+//#region src/components/method.d.ts
+type MethodHeaderProps = {
+  title: ReactNode;
+  level?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5';
+  signature?: ReactNode;
+  badges?: ReactNode;
+  children?: ReactNode;
+};
+declare function MethodHeader({
+  title,
+  badges,
+  signature,
+  children,
+  level
+}: MethodHeaderProps): react_jsx_runtime5.JSX.Element;
+type MethodRouteProps = {
+  httpMethod?: string;
+  endpoint?: string | ReactNode;
+  iconOnly?: boolean;
+};
+declare function MethodRoute({
+  httpMethod,
+  endpoint,
+  iconOnly
+}: MethodRouteProps): react_jsx_runtime5.JSX.Element;
+type MethodDescriptionProps = {
+  description?: string;
+};
+declare function MethodDescription({
+  description
+}: MethodDescriptionProps): react_jsx_runtime5.JSX.Element | undefined;
+type MethodInfoProps = {
+  children?: ReactNode;
+  parameters?: ReactNode;
+  returns?: ReactNode;
+};
+declare function MethodInfo({
+  children,
+  parameters,
+  returns
+}: MethodInfoProps): react_jsx_runtime5.JSX.Element;
+type MethodProps = {
+  id?: string;
+  header?: ReactNode;
+  children?: ReactNode;
+} & React$1.HTMLProps<HTMLDivElement>;
+declare function Method({
+  id,
+  header,
+  children,
+  className,
+  ...props
+}: MethodProps): react_jsx_runtime5.JSX.Element;
+//#endregion
+export { MethodHeaderProps as a, MethodProps as c, MethodHeader as i, MethodRoute as l, MethodDescription as n, MethodInfo as o, MethodDescriptionProps as r, MethodInfoProps as s, Method as t, MethodRouteProps as u };

package/dist/navigation-BW-SBvb4.d.ts

@@ -0,0 +1,29 @@
+import { t as DocsLanguage } from "./routing-utiR5mY3.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime86 from "react/jsx-runtime";
+
+//#region src/contexts/navigation.d.ts
+type NavigationHandler = (ev: React$1.MouseEvent | null, opts: {
+  href: string;
+  language: DocsLanguage;
+  stainlessPath: string;
+  scroll: boolean;
+}) => void;
+type NavigationContextType = {
+  basePath?: string;
+  selectedPath?: string;
+  navigationPath?: string[];
+  onNavigate?: NavigationHandler;
+};
+declare function useNavigation(): NavigationContextType;
+type NavigationProviderProps = NavigationContextType & {
+  children: React$1.ReactNode;
+};
+declare function NavigationProvider({
+  basePath,
+  selectedPath,
+  onNavigate,
+  children
+}: NavigationProviderProps): react_jsx_runtime86.JSX.Element;
+//#endregion
+export { useNavigation as a, NavigationProviderProps as i, NavigationHandler as n, NavigationProvider as r, NavigationContextType as t };

package/dist/navigation-DWYqC_HX.d.ts

@@ -0,0 +1,29 @@
+import { t as DocsLanguage } from "./routing-Cm_9XJiQ.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime48 from "react/jsx-runtime";
+
+//#region src/contexts/navigation.d.ts
+type NavigationHandler = (ev: React$1.MouseEvent | null, opts: {
+  href: string;
+  language: DocsLanguage;
+  stainlessPath: string;
+  scroll: boolean;
+}) => void;
+type NavigationContextType = {
+  basePath?: string;
+  selectedPath?: string;
+  navigationPath?: string[];
+  onNavigate?: NavigationHandler;
+};
+declare function useNavigation(): NavigationContextType;
+type NavigationProviderProps = NavigationContextType & {
+  children: React$1.ReactNode;
+};
+declare function NavigationProvider({
+  basePath,
+  selectedPath,
+  onNavigate,
+  children
+}: NavigationProviderProps): react_jsx_runtime48.JSX.Element;
+//#endregion
+export { useNavigation as a, NavigationProviderProps as i, NavigationHandler as n, NavigationProvider as r, NavigationContextType as t };

package/dist/navigation-aoYZ_tl4.js

@@ -0,0 +1,24 @@
+import * as React$1 from "react";
+import { jsx } from "react/jsx-runtime";
+
+//#region src/contexts/navigation.tsx
+const Defaults = { basePath: "/" };
+const NavigationContext = React$1.createContext(Defaults);
+function useNavigation() {
+	return React$1.useContext(NavigationContext);
+}
+function NavigationProvider({ basePath, selectedPath, onNavigate, children }) {
+	const value = {
+		...Defaults,
+		onNavigate,
+		basePath,
+		selectedPath
+	};
+	return /* @__PURE__ */ jsx(NavigationContext.Provider, {
+		value,
+		children
+	});
+}
+
+//#endregion
+export { useNavigation as n, NavigationProvider as t };

package/dist/overview-Cui1XtuC.d.ts

@@ -0,0 +1,39 @@
+import { d as Method, m as Resource } from "./index-CwjGm9zX.js";
+import * as react_jsx_runtime10 from "react/jsx-runtime";
+
+//#region src/components/overview.d.ts
+type SDKResourceProps = {
+  resource: Resource;
+  parents?: Resource[];
+};
+declare function SDKResourceHeader({
+  resource,
+  parents
+}: SDKResourceProps): react_jsx_runtime10.JSX.Element | null;
+type SDKMethodSummaryProps = {
+  method: Method;
+};
+declare function SDKMethodSummary({
+  method
+}: SDKMethodSummaryProps): react_jsx_runtime10.JSX.Element;
+declare function SDKResource({
+  resource,
+  parents,
+  showModels
+}: SDKResourceProps & {
+  showModels?: boolean;
+}): react_jsx_runtime10.JSX.Element;
+type SDKOverviewProps = {
+  resource: Resource;
+};
+declare function SDKOverview({
+  resource
+}: SDKOverviewProps): react_jsx_runtime10.JSX.Element;
+type SDKRootProps = {
+  stainlessPath: string;
+};
+declare function SDKRoot({
+  stainlessPath
+}: SDKRootProps): react_jsx_runtime10.JSX.Element | null;
+//#endregion
+export { SDKResource as a, SDKRoot as c, SDKOverviewProps as i, SDKRootProps as l, SDKMethodSummaryProps as n, SDKResourceHeader as o, SDKOverview as r, SDKResourceProps as s, SDKMethodSummary as t };

package/dist/overview-DFwfIK6k.js

@@ -0,0 +1,138 @@
+import { d as useSpec, i as useDeclaration, s as useLanguage } from "./docs-BmOB2f-I.js";
+import { n as useLanguageComponents } from "./contexts-CVj20VV4.js";
+import { t as useComponents } from "./use-components-BUz3GbO4.js";
+import { t as style_default } from "./style-HpXpcJ9v.js";
+import { i as PropertyToggle } from "./properties-BnbBKd5a.js";
+import { p as parseStainlessPath } from "./routing-C64k4fmX.js";
+import { s as Markdown } from "./primitives-DJEqe_r1.js";
+import { r as getResourceFromSpec, t as flatResources } from "./utils-DPbkW1Tz.js";
+import * as React$1 from "react";
+import { jsx, jsxs } from "react/jsx-runtime";
+import { ChevronRight } from "lucide-react";
+
+//#region src/components/overview.tsx
+function SDKResourceHeader({ resource, parents }) {
+	const segments = parents?.map((parent, index) => /* @__PURE__ */ jsxs("span", {
+		className: style_default.ResourceTitleSegment,
+		children: [parent.title, index < parents.length && /* @__PURE__ */ jsx(ChevronRight, {
+			size: 16,
+			className: style_default.Icon
+		})]
+	}, parent.stainlessPath));
+	if (!segments && !resource.description) return null;
+	return /* @__PURE__ */ jsxs("div", {
+		className: style_default.ResourceHeader,
+		children: [segments && /* @__PURE__ */ jsxs("h4", {
+			id: resource.stainlessPath,
+			className: style_default.ResourceTitle,
+			children: [segments, /* @__PURE__ */ jsx("span", {
+				className: style_default.ResourceTitleSegment,
+				children: resource.title
+			})]
+		}), resource.description && /* @__PURE__ */ jsx("div", {
+			className: style_default.ResourceDescription,
+			children: /* @__PURE__ */ jsx(Markdown, { content: resource.description })
+		})]
+	});
+}
+function SDKMethodSummary({ method }) {
+	const Docs = useComponents();
+	const Lang = useLanguageComponents();
+	const decl = useDeclaration(method.stainlessPath, true);
+	return /* @__PURE__ */ jsx(Docs.MethodHeader, {
+		level: "h5",
+		title: /* @__PURE__ */ jsx(Docs.Link, {
+			stainlessPath: method.stainlessPath,
+			children: method.summary || method.title
+		}),
+		signature: /* @__PURE__ */ jsx(Lang.MethodSignature, { decl }),
+		badges: method.deprecated && /* @__PURE__ */ jsx(Docs.Badge, {
+			id: "deprecated",
+			children: "Deprecated"
+		}),
+		children: /* @__PURE__ */ jsx(Docs.MethodRoute, {
+			httpMethod: method.httpMethod,
+			endpoint: method.endpoint.split(" ", 2).at(-1)
+		})
+	});
+}
+function SDKResource({ resource, parents, showModels }) {
+	const Docs = useComponents();
+	const Lang = useLanguageComponents();
+	const language = useLanguage();
+	const spec = useSpec();
+	const methods = Object.values(resource.methods).filter((method) => spec?.decls?.[language]?.[method.stainlessPath]);
+	const models = Object.values(resource.models).filter((model) => spec?.decls?.[language]?.[`${model.stainlessPath} > (schema)`]);
+	return /* @__PURE__ */ jsx("div", {
+		className: style_default.Resource,
+		"data-stl-resource-language": language,
+		children: /* @__PURE__ */ jsxs("div", {
+			className: style_default.ResourceContent,
+			children: [
+				/* @__PURE__ */ jsx(Docs.SDKResourceHeader, {
+					resource,
+					parents
+				}),
+				Lang.Resource && /* @__PURE__ */ jsx(Lang.Resource, { resource }),
+				methods.length > 0 && /* @__PURE__ */ jsx("div", {
+					className: style_default.ResourceContentGroup,
+					children: methods.map((method) => /* @__PURE__ */ jsx("div", {
+						className: style_default.MethodSummary,
+						children: /* @__PURE__ */ jsx(Docs.SDKMethodSummary, { method })
+					}, method.stainlessPath))
+				}),
+				showModels !== false && models.length > 0 && /* @__PURE__ */ jsxs("div", {
+					className: style_default.ResourceContentGroup,
+					"data-stldocs-property-group": "models",
+					children: [/* @__PURE__ */ jsxs("h5", {
+						className: style_default.ResourceContentGroupModelTitle,
+						children: ["Models", /* @__PURE__ */ jsx(PropertyToggle, { target: "models" })]
+					}), models.map((model) => /* @__PURE__ */ jsx(Docs.SDKModel, { model }, model.stainlessPath))]
+				})
+			]
+		})
+	});
+}
+function SDKOverview({ resource }) {
+	const { SDKResource } = useComponents();
+	const nested = React$1.useMemo(() => flatResources(resource.subresources, [resource]), [resource]);
+	return /* @__PURE__ */ jsxs("div", {
+		className: style_default.Overview,
+		children: [
+			/* @__PURE__ */ jsx("div", {
+				className: style_default.OverviewHeader,
+				children: /* @__PURE__ */ jsx("h1", { children: resource.title })
+			}),
+			/* @__PURE__ */ jsx(SDKResource, { resource }),
+			nested.map((props, index) => /* @__PURE__ */ jsx(SDKResource, { ...props }, index))
+		]
+	});
+}
+function SDKRoot({ stainlessPath }) {
+	const spec = useSpec();
+	const Docs = useComponents();
+	const parsed = parseStainlessPath(stainlessPath);
+	const resource = spec && getResourceFromSpec(stainlessPath, spec);
+	if (!resource || !parsed) {
+		console.warn(`Could not find resource or parsed path for '${stainlessPath}'`);
+		return null;
+	}
+	if (parsed.method) {
+		const method = resource.methods[parsed.method];
+		if (!method) {
+			console.warn(`Method '${parsed.method}' not found in resource '${resource.stainlessPath}'`);
+			return null;
+		}
+		return /* @__PURE__ */ jsx("div", {
+			className: style_default.Root,
+			children: /* @__PURE__ */ jsx(Docs.SDKMethod, { method })
+		});
+	}
+	return /* @__PURE__ */ jsx("div", {
+		className: style_default.Root,
+		children: /* @__PURE__ */ jsx(Docs.SDKOverview, { resource })
+	});
+}
+
+//#endregion
+export { SDKRoot as a, SDKResourceHeader as i, SDKOverview as n, SDKResource as r, SDKMethodSummary as t };

package/dist/overview-RXc9iPzz.d.ts

@@ -0,0 +1,39 @@
+import { d as Method, m as Resource } from "./index-CwjGm9zX.js";
+import * as react_jsx_runtime1 from "react/jsx-runtime";
+
+//#region src/components/overview.d.ts
+type SDKResourceProps = {
+  resource: Resource;
+  parents?: Resource[];
+};
+declare function SDKResourceHeader({
+  resource,
+  parents
+}: SDKResourceProps): react_jsx_runtime1.JSX.Element | null;
+type SDKMethodSummaryProps = {
+  method: Method;
+};
+declare function SDKMethodSummary({
+  method
+}: SDKMethodSummaryProps): react_jsx_runtime1.JSX.Element;
+declare function SDKResource({
+  resource,
+  parents,
+  showModels
+}: SDKResourceProps & {
+  showModels?: boolean;
+}): react_jsx_runtime1.JSX.Element;
+type SDKOverviewProps = {
+  resource: Resource;
+};
+declare function SDKOverview({
+  resource
+}: SDKOverviewProps): react_jsx_runtime1.JSX.Element;
+type SDKRootProps = {
+  stainlessPath: string;
+};
+declare function SDKRoot({
+  stainlessPath
+}: SDKRootProps): react_jsx_runtime1.JSX.Element | null;
+//#endregion
+export { SDKResource as a, SDKRoot as c, SDKOverviewProps as i, SDKRootProps as l, SDKMethodSummaryProps as n, SDKResourceHeader as o, SDKOverview as r, SDKResourceProps as s, SDKMethodSummary as t };

package/dist/primitives-DJEqe_r1.js

@@ -0,0 +1,250 @@
+import { l as useSettings, s as useLanguage } from "./docs-BmOB2f-I.js";
+import { n as useNavigation } from "./navigation-aoYZ_tl4.js";
+import { a as useRenderMarkdown } from "./markdown-CTKHMLVr.js";
+import { t as style_default } from "./style-HpXpcJ9v.js";
+import { s as generateRoute } from "./routing-C64k4fmX.js";
+import { Fragment, createContext, useCallback, useContext, useEffect, useMemo, useRef, useState } from "react";
+import { jsx, jsxs } from "react/jsx-runtime";
+import clsx from "clsx";
+import { MinusIcon, PlusIcon } from "lucide-react";
+
+//#region src/components/primitives.tsx
+function Join({ items, limit, children }) {
+	return (limit && items.length > limit + 1 ? [...items.slice(0, limit), /* @__PURE__ */ jsxs("span", {
+		className: style_default.Truncation,
+		children: [items.length - limit, " more"]
+	}, "truncation")] : items).map((item, index) => /* @__PURE__ */ jsxs(Fragment, { children: [!!index && children, item] }, `iterator:${index}`));
+}
+function Expander({ id, open, summary, virtual, muted, children }) {
+	const virtualExpanders = useSettings()?.virtualExpanders;
+	if (virtual || virtualExpanders) return /* @__PURE__ */ jsx(VirtualExpander, {
+		summary,
+		open,
+		muted,
+		id,
+		children
+	}, open ? "open" : "closed");
+	return /* @__PURE__ */ jsxs("details", {
+		className: style_default.Expander,
+		open,
+		"data-stldocs-expander-muted": muted,
+		"data-stldocs-expander-initial-state": open,
+		children: [/* @__PURE__ */ jsxs("summary", {
+			className: style_default.ExpanderSummary,
+			children: [/* @__PURE__ */ jsxs("div", {
+				className: style_default.ExpanderSummaryIcon,
+				children: [/* @__PURE__ */ jsx(PlusIcon, {
+					size: 16,
+					strokeWidth: 1,
+					className: style_default.Icon
+				}), /* @__PURE__ */ jsx(MinusIcon, {
+					size: 16,
+					strokeWidth: 1,
+					className: style_default.Icon
+				})]
+			}), /* @__PURE__ */ jsx("div", {
+				className: style_default.ExpanderSummaryContent,
+				children: summary
+			})]
+		}), /* @__PURE__ */ jsx("div", {
+			className: style_default.ExpanderContent,
+			id,
+			children
+		})]
+	});
+}
+function VirtualExpander({ id, open: isOpen, muted, summary, children }) {
+	const [open, setOpen] = useState(isOpen ?? false);
+	return /* @__PURE__ */ jsxs("div", {
+		className: style_default.Expander,
+		"data-open": open,
+		"data-stldocs-expander-muted": muted,
+		"data-stldocs-expander-initial-state": open,
+		children: [/* @__PURE__ */ jsxs("div", {
+			className: style_default.ExpanderSummary,
+			onClick: () => setOpen(!open),
+			children: [/* @__PURE__ */ jsxs("div", {
+				className: style_default.ExpanderSummaryIcon,
+				children: [/* @__PURE__ */ jsx(PlusIcon, {
+					size: 16,
+					className: style_default.Icon
+				}), /* @__PURE__ */ jsx(MinusIcon, {
+					size: 16,
+					className: style_default.Icon
+				})]
+			}), /* @__PURE__ */ jsx("div", {
+				className: style_default.ExpanderSummaryContent,
+				children: summary
+			})]
+		}), open && /* @__PURE__ */ jsx("div", {
+			className: style_default.ExpanderContent,
+			id,
+			children
+		})]
+	});
+}
+function Markdown({ content }) {
+	const rendered = useRenderMarkdown(content);
+	return rendered && /* @__PURE__ */ jsx("div", {
+		className: clsx(style_default.Markdown, style_default.Content, "stl-ui-prose"),
+		dangerouslySetInnerHTML: { __html: rendered }
+	});
+}
+function Badge({ id, children }) {
+	return /* @__PURE__ */ jsx("span", {
+		className: style_default.Badge,
+		"data-badge-id": id,
+		children: children ?? id
+	});
+}
+const TooltipNestingContext = createContext(false);
+function Tooltip({ content, children }) {
+	if (useContext(TooltipNestingContext)) return children;
+	return /* @__PURE__ */ jsxs("span", {
+		className: style_default.Tooltip,
+		children: [/* @__PURE__ */ jsx("span", {
+			className: style_default.TooltipContent,
+			children: /* @__PURE__ */ jsx(TooltipNestingContext.Provider, {
+				value: true,
+				children: content
+			})
+		}), /* @__PURE__ */ jsx("span", {
+			className: style_default.TooltipHost,
+			children
+		})]
+	});
+}
+function Link({ stainlessPath, scroll = true, children, ...props }) {
+	const { basePath, onNavigate } = useNavigation();
+	const language = useLanguage();
+	const href = useMemo(() => {
+		if (props.href) return props.href;
+		if (stainlessPath && basePath) return generateRoute(basePath, language, stainlessPath);
+	}, [
+		basePath,
+		language,
+		stainlessPath,
+		props.href
+	]);
+	const handleClick = useCallback((e) => {
+		if (props.onClick) props.onClick(e);
+		if (e.button !== 0 || e.metaKey || e.ctrlKey || e.shiftKey || e.altKey) return;
+		if (href && stainlessPath) onNavigate?.(e, {
+			href,
+			language,
+			stainlessPath,
+			scroll
+		});
+	}, [
+		href,
+		scroll,
+		onNavigate,
+		language,
+		props,
+		stainlessPath
+	]);
+	if (!href) return children;
+	return /* @__PURE__ */ jsx("a", {
+		href,
+		onClick: handleClick,
+		...props,
+		children
+	});
+}
+function Input({ left, right, ref, className, ...props }) {
+	return /* @__PURE__ */ jsxs("div", {
+		className: clsx(style_default.Input, props.disabled && style_default.InputDisabled, className),
+		children: [
+			left,
+			/* @__PURE__ */ jsx("input", {
+				...props,
+				ref,
+				className: style_default.InputTextField
+			}),
+			right
+		]
+	});
+}
+function ToggleButton({ children, selected, ref, ...props }) {
+	return /* @__PURE__ */ jsx("button", {
+		...props,
+		ref,
+		className: style_default.ToggleButton,
+		"data-stldocs-toggle-selected": selected,
+		children
+	});
+}
+function ListView({ items, itemDelegate, onSelectListItem, ...rest }) {
+	const [selectedIndex, setSelectedIndex] = useState(0);
+	const [keyboardIndex, setKeyboardIndex] = useState(0);
+	const listRef = useRef(null);
+	const itemRef = useRef(null);
+	const handleSelect = useCallback(() => {
+		const item = items[selectedIndex];
+		if (item) onSelectListItem?.(item);
+	}, [
+		items,
+		selectedIndex,
+		onSelectListItem
+	]);
+	useEffect(() => {
+		const ac = new AbortController();
+		document.addEventListener("keydown", (ev) => {
+			switch (ev.key) {
+				case "ArrowUp": {
+					ev.preventDefault();
+					const value = Math.max(0, selectedIndex - 1);
+					setSelectedIndex(value);
+					setKeyboardIndex(value);
+					break;
+				}
+				case "ArrowDown": {
+					ev.preventDefault();
+					const value = Math.min(items.length, selectedIndex + 1);
+					setSelectedIndex(value);
+					setKeyboardIndex(value);
+					break;
+				}
+				case "Enter":
+					ev.preventDefault();
+					handleSelect();
+					break;
+			}
+		}, { signal: ac.signal });
+		return () => ac.abort();
+	}, [
+		items,
+		selectedIndex,
+		handleSelect
+	]);
+	useEffect(() => {
+		if (!keyboardIndex || !itemRef.current || !listRef.current) {
+			listRef?.current?.scroll(0, 0);
+			return;
+		}
+		const selectedBounds = itemRef.current.getBoundingClientRect();
+		const listBounds = listRef.current.getBoundingClientRect();
+		if (selectedBounds.top < listBounds.top || selectedBounds.bottom > listBounds.bottom) itemRef.current.scrollIntoView({ block: "nearest" });
+	}, [
+		keyboardIndex,
+		items,
+		listRef
+	]);
+	return /* @__PURE__ */ jsx("div", {
+		ref: listRef,
+		className: style_default.ListView,
+		tabIndex: 0,
+		...rest,
+		children: items.map((item, index) => /* @__PURE__ */ jsx("div", {
+			ref: index === selectedIndex ? itemRef : null,
+			className: style_default.ListViewItem,
+			"data-stldocs-listview-selected": index === selectedIndex,
+			onClick: handleSelect,
+			onMouseEnter: () => setSelectedIndex(index),
+			children: itemDelegate(item, index === selectedIndex)
+		}, index))
+	});
+}
+
+//#endregion
+export { Link as a, ToggleButton as c, Join as i, Tooltip as l, Expander as n, ListView as o, Input as r, Markdown as s, Badge as t, VirtualExpander as u };