@stainless-api/docs-ui 0.1.0-beta.47 → 0.1.0-beta.49

package/dist/properties-jlGW3USi.js

@@ -0,0 +1,131 @@
+import { a as useLanguage, s as useSettings } from "./docs-CXqi26jB.js";
+import { t as useComponents } from "./use-components-RWQbviGq.js";
+import { t as style_default } from "./style-gnVEeXFj.js";
+import { Fragment, jsx, jsxs } from "react/jsx-runtime";
+import { ArrowDownWideNarrowIcon, ArrowUpNarrowWideIcon } from "lucide-react";
+
+//#region src/components/properties.tsx
+function PropertyToggle({ target }) {
+	return /* @__PURE__ */ jsxs("span", {
+		className: style_default.ExpandToggle,
+		"data-stldocs-property-toggle-expanded": "false",
+		"data-stldocs-property-toggle-target": target,
+		children: [/* @__PURE__ */ jsxs("span", {
+			className: style_default.ExpandToggleContent,
+			children: ["Expand ", /* @__PURE__ */ jsx(ArrowDownWideNarrowIcon, {
+				className: style_default.Icon,
+				size: 16
+			})]
+		}), /* @__PURE__ */ jsxs("span", {
+			className: style_default.ExpandToggleContent,
+			children: ["Collapse ", /* @__PURE__ */ jsx(ArrowUpNarrowWideIcon, {
+				className: style_default.Icon,
+				size: 16
+			})]
+		})]
+	});
+}
+function PropertyDescription({ description }) {
+	const { Markdown } = useComponents();
+	if (description) return /* @__PURE__ */ jsx("div", {
+		className: style_default.PropertyDescription,
+		children: /* @__PURE__ */ jsx(Markdown, { content: description })
+	});
+}
+function PropertyTitle({ title }) {
+	const { Markdown } = useComponents();
+	if (title) return /* @__PURE__ */ jsx("div", {
+		className: style_default.PropertyTitle,
+		children: /* @__PURE__ */ jsx(Markdown, { content: title })
+	});
+}
+function Property({ id, name, typeName, badges, type, declaration, description, title, deprecated, expand, additional, constraints, children }) {
+	const Docs = useComponents();
+	const language = useLanguage();
+	const properties = useSettings()?.properties;
+	const { collapseDescription, showTitle } = properties ?? {};
+	const types = properties?.types;
+	const textContent = /* @__PURE__ */ jsxs(Fragment, { children: [
+		typeof deprecated === "string" && /* @__PURE__ */ jsx("div", {
+			className: style_default.PropertyDeprecatedMessage,
+			children: deprecated
+		}),
+		description && /* @__PURE__ */ jsx(Docs.PropertyDescription, { description }),
+		constraints && /* @__PURE__ */ jsx("div", {
+			className: style_default.PropertyContent,
+			children: constraints
+		})
+	] });
+	const rich = /* @__PURE__ */ jsxs(Fragment, { children: [
+		/* @__PURE__ */ jsxs("div", {
+			className: style_default.PropertyDeclaration,
+			children: [
+				deprecated && /* @__PURE__ */ jsx("span", {
+					className: style_default.PropertyDeprecated,
+					children: "Deprecated"
+				}),
+				declaration,
+				badges && /* @__PURE__ */ jsx("span", {
+					className: style_default.PropertyBadges,
+					children: badges
+				})
+			]
+		}),
+		title && showTitle && /* @__PURE__ */ jsx(Docs.PropertyTitle, { title }),
+		collapseDescription === false ? textContent : null
+	] });
+	const simple = /* @__PURE__ */ jsxs(Fragment, { children: [
+		name && /* @__PURE__ */ jsxs("div", {
+			className: style_default.PropertyHeader,
+			children: [
+				deprecated && /* @__PURE__ */ jsx("span", {
+					className: style_default.PropertyDeprecated,
+					children: "Deprecated"
+				}),
+				name && /* @__PURE__ */ jsx("span", {
+					className: style_default.PropertyName,
+					children: name
+				}),
+				typeName && /* @__PURE__ */ jsx("span", {
+					className: style_default.PropertyTypeName,
+					children: typeName
+				}),
+				badges && /* @__PURE__ */ jsx("span", {
+					className: style_default.PropertyBadges,
+					children: badges
+				})
+			]
+		}),
+		type && /* @__PURE__ */ jsx("div", {
+			className: style_default.PropertyType,
+			children: type
+		}),
+		title && showTitle && /* @__PURE__ */ jsx(Docs.PropertyTitle, { title }),
+		collapseDescription === false ? textContent : null
+	] });
+	const content = /* @__PURE__ */ jsx("div", {
+		id,
+		className: style_default.PropertyInfo,
+		children: types === "simple" ? simple : rich
+	});
+	return /* @__PURE__ */ jsx("div", {
+		className: style_default.Property,
+		"data-stldocs-language": language,
+		children: children || collapseDescription !== false && description ? /* @__PURE__ */ jsxs(Docs.Expander, {
+			summary: content,
+			muted: !children,
+			open: expand,
+			children: [
+				collapseDescription !== false ? textContent : null,
+				additional,
+				children && /* @__PURE__ */ jsx("div", {
+					className: style_default.PropertyChildren,
+					children
+				})
+			]
+		}) : content
+	});
+}
+
+//#endregion
+export { PropertyToggle as i, PropertyDescription as n, PropertyTitle as r, Property as t };

package/dist/python-USOwFDv_.js

@@ -0,0 +1,279 @@
+import { t as __export } from "./chunk-DRcLgZ1e.js";
+import { n as useLanguageComponents } from "./contexts-p3rRZDlM.js";
+import { t as useComponents } from "./use-components-RWQbviGq.js";
+import { t as style_default } from "./style-gnVEeXFj.js";
+import * as React$1 from "react";
+import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
+
+//#region src/languages/python.tsx
+var python_exports = /* @__PURE__ */ __export({
+	Declaration: () => Declaration,
+	MethodSignature: () => MethodSignature,
+	Property: () => Property,
+	Type: () => Type,
+	TypeName: () => TypeName
+});
+const constStyle = {
+	string: style_default.LiteralString,
+	number: style_default.LiteralNumeric,
+	boolean: style_default.LiteralBoolean
+};
+function showFullType(type) {
+	if (type.kind !== "PythonTypeReference") return false;
+	return type.typeName === "Optional" ? showFullType(type.typeParameters[0]) : type.typeParameters.length > 0;
+}
+function TypeName({ type }) {
+	const Lang = useLanguageComponents();
+	if (type.kind === "PythonTypeReference") switch (type.typeName) {
+		case "Optional": return /* @__PURE__ */ jsx(Lang.TypeName, { type: type.typeParameters[0] });
+		case "List":
+		case "Iterable":
+		case "Literal":
+		case "Union": return type.typeName.toLowerCase();
+	}
+	return /* @__PURE__ */ jsx(Lang.Type, { type });
+}
+function Type({ type }) {
+	const Lang = useLanguageComponents();
+	const { Join, SDKReference } = useComponents();
+	switch (type.kind) {
+		case "PythonTypeAny":
+		case "PythonTypeUnknown":
+		case "PythonTypeInt":
+		case "PythonTypeFloat":
+		case "PythonTypeBool": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeKeyword,
+				children: type.kind.slice(10).toLowerCase()
+			})
+		});
+		case "PythonTypeString": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeString,
+				children: "str"
+			})
+		});
+		case "PythonTypeLiteral": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: constStyle[typeof type.literal.value],
+				children: JSON.stringify(type.literal.value)
+			})
+		});
+		case "PythonTypeArray": return /* @__PURE__ */ jsxs("span", {
+			className: style_default.Type,
+			children: [
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TypeArray,
+					children: "Array<"
+				}),
+				/* @__PURE__ */ jsx(Lang.Type, { type: type.elementType }),
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TypeArray,
+					children: ">"
+				})
+			]
+		});
+		case "PythonTypeClass": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeKeyword,
+				children: "class"
+			})
+		});
+		case "PythonTypeMap": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeKeyword,
+				children: "Dict"
+			})
+		});
+		case "PythonTypeReference": {
+			const params = type.typeParameters?.map((param, key) => /* @__PURE__ */ jsx(Lang.Type, { type: param }, key));
+			return /* @__PURE__ */ jsxs("span", {
+				className: style_default.Type,
+				children: [/* @__PURE__ */ jsx("span", {
+					className: type.typeName === "Optional" ? style_default.TypeArray : "",
+					children: /* @__PURE__ */ jsx(SDKReference, {
+						stainlessPath: type.$ref,
+						children: type.typeName
+					})
+				}), params && params.length > 0 && /* @__PURE__ */ jsxs(Fragment$1, { children: [
+					/* @__PURE__ */ jsx("span", {
+						className: style_default.TypeBracket,
+						children: "["
+					}),
+					/* @__PURE__ */ jsx(Join, {
+						items: params,
+						limit: 3,
+						children: /* @__PURE__ */ jsx("span", {
+							className: style_default.TextOperator,
+							children: ", "
+						})
+					}),
+					/* @__PURE__ */ jsx("span", {
+						className: style_default.TypeBracket,
+						children: "]"
+					})
+				] })]
+			});
+		}
+	}
+}
+function MethodSignature({ decl }) {
+	const Lang = useLanguageComponents();
+	const { Join, Tooltip } = useComponents();
+	const params = decl.parameters.map((param, i) => /* @__PURE__ */ jsx(React$1.Fragment, { children: /* @__PURE__ */ jsx(Tooltip, {
+		content: /* @__PURE__ */ jsx(Lang.Type, { type: param.type }),
+		children: /* @__PURE__ */ jsx("span", {
+			className: style_default.TextIdentifier,
+			children: param.ident
+		})
+	}) }, i));
+	return /* @__PURE__ */ jsx("div", {
+		className: style_default.MethodSignature,
+		children: /* @__PURE__ */ jsxs("span", {
+			className: style_default.SignatureTitle,
+			children: [
+				decl.async && /* @__PURE__ */ jsx("span", {
+					className: style_default.TextKeyword,
+					children: "async "
+				}),
+				decl.qualified && /* @__PURE__ */ jsx("span", {
+					className: style_default.SignatureQualified,
+					children: /* @__PURE__ */ jsx("span", {
+						className: style_default.TextIdentifier,
+						children: decl.qualified?.slice(0, -decl.ident.length)
+					})
+				}),
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.SignatureName,
+					children: /* @__PURE__ */ jsx("span", {
+						className: style_default.TextIdentifier,
+						children: decl.ident
+					})
+				}),
+				/* @__PURE__ */ jsxs("span", {
+					className: style_default.MethodSignature,
+					children: [
+						/* @__PURE__ */ jsx("span", {
+							className: style_default.SignatureParen,
+							children: "("
+						}),
+						/* @__PURE__ */ jsx("span", {
+							className: style_default.SignatureParams,
+							children: /* @__PURE__ */ jsx(Join, {
+								items: params,
+								children: /* @__PURE__ */ jsx("span", {
+									className: style_default.TextOperator,
+									children: ", "
+								})
+							})
+						}),
+						/* @__PURE__ */ jsxs("span", {
+							className: style_default.SignatureParen,
+							children: [")", " "]
+						}),
+						decl.returns && /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsx("span", {
+							className: style_default.TextOperator,
+							children: " -> "
+						}), /* @__PURE__ */ jsx(Lang.Type, { type: decl.returns })] })
+					]
+				})
+			]
+		})
+	});
+}
+function Property({ decl, children }) {
+	const Lang = useLanguageComponents();
+	if (!decl) return;
+	switch (decl.kind) {
+		case "PythonDeclProperty": return children({
+			name: decl.ident,
+			typeName: /* @__PURE__ */ jsx(Lang.TypeName, { type: decl.type }),
+			type: showFullType(decl.type) && /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		});
+		case "PythonDeclClass": return children({
+			name: decl.ident,
+			typeName: "class"
+		});
+		case "PythonDeclType": return children({
+			name: decl.ident,
+			typeName: "type",
+			type: /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		});
+		case "PythonDeclReference": return children({ type: /* @__PURE__ */ jsx(Lang.Type, { type: decl.type }) });
+	}
+}
+function Declaration({ decl }) {
+	const Lang = useLanguageComponents();
+	if (!decl) return;
+	switch (decl.kind) {
+		case "PythonDeclProperty": {
+			const nullable = decl.type.kind === "PythonTypeReference" && decl.type.typeName === "Optional" && (decl.type.typeParameters ?? []).length > 0;
+			return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TypePropertyName,
+					children: /* @__PURE__ */ jsx("span", {
+						className: style_default.TextIdentifier,
+						children: decl.ident
+					})
+				}),
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TextPunctuation,
+					children: ": "
+				}),
+				decl.optional && !nullable ? /* @__PURE__ */ jsxs(Fragment$1, { children: [
+					/* @__PURE__ */ jsx("span", {
+						className: style_default.TypePlain,
+						children: "Optional"
+					}),
+					/* @__PURE__ */ jsx("span", {
+						className: style_default.TypeBracket,
+						children: "["
+					}),
+					/* @__PURE__ */ jsx(Lang.Type, { type: decl.type }),
+					/* @__PURE__ */ jsx("span", {
+						className: style_default.TypeBrace,
+						children: "]"
+					})
+				] }) : /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+			] });
+		}
+		case "PythonDeclClass": return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextKeyword,
+				children: "class "
+			}),
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextIdentifier,
+				children: decl.ident
+			}),
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextPunctuation,
+				children: ": "
+			}),
+			/* @__PURE__ */ jsx("span", {
+				className: `${style_default.TypePreviewContent} ${style_default.TextPunctuation}`,
+				children: "…"
+			})
+		] });
+		case "PythonDeclType": return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextIdentifier,
+				children: decl.ident
+			}),
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextOperator,
+				children: " = "
+			}),
+			/* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		] });
+		case "PythonDeclReference": return /* @__PURE__ */ jsx(Lang.Type, { type: decl.type });
+	}
+}
+
+//#endregion
+export { TypeName as a, Type as i, MethodSignature as n, python_exports as o, Property as r, Declaration as t };

package/dist/routing-CMqh1cTZ.d.ts

@@ -0,0 +1,54 @@
+import * as SDKJSON from "@stainless/sdk-json";
+
+//#region src/routing.d.ts
+declare namespace routing_d_exports {
+  export { DocsLanguage, LanguageNames, Languages, ParsedStainlessPath, RouteEntry, SpecTreeEntry, SupportedLanguageSyntaxes, expandToElement, findNavigationPath, generateRoute, generateRouteList, getLanguageSnippet, getResource, isSupportedLanguage, parseRoute, parseStainlessPath, scrollToPath, trimStainlessPath, updateHistory, walkTree };
+}
+declare const Languages: readonly ["http", "node", "python", "go", "typescript", "terraform", "ruby", "java", "kotlin", "csharp", "php"];
+declare const SupportedLanguageSyntaxes: string[];
+type DocsLanguage = (typeof Languages)[number];
+declare const LanguageNames: Record<DocsLanguage, string>;
+declare function getLanguageSnippet(language: DocsLanguage): "http.curl" | "node.default" | "python.default" | "go.default" | "typescript.default" | "terraform.default" | "ruby.default" | "java.default" | "kotlin.default" | "csharp.default" | "php.default";
+declare function isSupportedLanguage(language: string): language is DocsLanguage;
+type ParsedStainlessPath = ReturnType<typeof parseStainlessPath>;
+declare function parseStainlessPath(stainlessPath: string): {
+  resource: string[] | null;
+  method: string | null;
+  model: string | null;
+  routable: string | undefined;
+} | null;
+declare function trimStainlessPath(stainlessPath: string): string;
+declare function getResource(stainlessPath: string): string | undefined;
+declare function parseRoute(basePath: string, route: string): {
+  stainlessPath: string;
+  language: DocsLanguage;
+};
+declare function generateRoute(basePath: string, language: string, stainlessPath: string): string | null;
+type SpecTreeEntry = {
+  data: SDKJSON.Method | SDKJSON.Resource | SDKJSON.Model;
+  path: string[];
+};
+declare function walkTree(spec: SDKJSON.Spec, includeModels?: boolean): Generator<SpecTreeEntry, void, any>;
+type RouteEntry = {
+  title: string;
+  kind: SpecTreeEntry['data']['kind'];
+  language: DocsLanguage;
+  stainlessPath: string;
+  slug: string;
+};
+declare function generateRouteList({
+  spec,
+  languages,
+  excludeLanguages
+}: {
+  spec: SDKJSON.Spec;
+  languages?: DocsLanguage[];
+  excludeLanguages?: DocsLanguage[];
+}): RouteEntry[];
+type ResourceOrMethod = SDKJSON.Resource | SDKJSON.Method;
+declare function findNavigationPath(items: ResourceOrMethod[], target: string): string[] | undefined;
+declare function expandToElement(el: HTMLElement | null): void;
+declare function scrollToPath(stainlessPath: string): void;
+declare function updateHistory(basePath: string, language: DocsLanguage, stainlessPath: string): void;
+//#endregion
+export { routing_d_exports as _, RouteEntry as a, updateHistory as b, expandToElement as c, generateRouteList as d, getLanguageSnippet as f, parseStainlessPath as g, parseRoute as h, ParsedStainlessPath as i, findNavigationPath as l, isSupportedLanguage as m, LanguageNames as n, SpecTreeEntry as o, getResource as p, Languages as r, SupportedLanguageSyntaxes as s, DocsLanguage as t, generateRoute as u, scrollToPath as v, walkTree as x, trimStainlessPath as y };

package/dist/{routing-BGBmkDBL.js → routing-Wbb7YECB.js}

@@ -1,4 +1,4 @@
-import { t as __export } from "./chunk-BWfJHHBp.js";
+import { t as __export } from "./chunk-DRcLgZ1e.js";
 
 //#region src/routing.ts
 var routing_exports = /* @__PURE__ */ __export({

package/dist/routing.d.ts

@@ -1,2 +1,2 @@
-import { a as RouteEntry, b as updateHistory, c as expandToElement, d as generateRouteList, f as getLanguageSnippet, g as parseStainlessPath, h as parseRoute, i as ParsedStainlessPath, l as findNavigationPath, m as isSupportedLanguage, n as LanguageNames, o as SpecTreeEntry, p as getResource, r as Languages, s as SupportedLanguageSyntaxes, t as DocsLanguage, u as generateRoute, v as scrollToPath, x as walkTree, y as trimStainlessPath } from "./routing-nN1nc0jx.js";
+import { a as RouteEntry, b as updateHistory, c as expandToElement, d as generateRouteList, f as getLanguageSnippet, g as parseStainlessPath, h as parseRoute, i as ParsedStainlessPath, l as findNavigationPath, m as isSupportedLanguage, n as LanguageNames, o as SpecTreeEntry, p as getResource, r as Languages, s as SupportedLanguageSyntaxes, t as DocsLanguage, u as generateRoute, v as scrollToPath, x as walkTree, y as trimStainlessPath } from "./routing-CMqh1cTZ.js";
 export { DocsLanguage, LanguageNames, Languages, ParsedStainlessPath, RouteEntry, SpecTreeEntry, SupportedLanguageSyntaxes, expandToElement, findNavigationPath, generateRoute, generateRouteList, getLanguageSnippet, getResource, isSupportedLanguage, parseRoute, parseStainlessPath, scrollToPath, trimStainlessPath, updateHistory, walkTree };

package/dist/routing.js

@@ -1,3 +1,3 @@
-import { _ as walkTree, a as findNavigationPath, c as getLanguageSnippet, d as parseRoute, f as parseStainlessPath, g as updateHistory, h as trimStainlessPath, i as expandToElement, l as getResource, m as scrollToPath, n as Languages, o as generateRoute, r as SupportedLanguageSyntaxes, s as generateRouteList, t as LanguageNames, u as isSupportedLanguage } from "./routing-BGBmkDBL.js";
+import { _ as walkTree, a as findNavigationPath, c as getLanguageSnippet, d as parseRoute, f as parseStainlessPath, g as updateHistory, h as trimStainlessPath, i as expandToElement, l as getResource, m as scrollToPath, n as Languages, o as generateRoute, r as SupportedLanguageSyntaxes, s as generateRouteList, t as LanguageNames, u as isSupportedLanguage } from "./routing-Wbb7YECB.js";
 
 export { LanguageNames, Languages, SupportedLanguageSyntaxes, expandToElement, findNavigationPath, generateRoute, generateRouteList, getLanguageSnippet, getResource, isSupportedLanguage, parseRoute, parseStainlessPath, scrollToPath, trimStainlessPath, updateHistory, walkTree };