@stainless-api/docs-ui 0.1.0-beta.8 → 0.1.0-beta.81

package/dist/languages/http.js

@@ -0,0 +1,387 @@
+import { t as __exportAll } from "../chunk-BYypO7fO.js";
+import { useAvailableLanguages, useDeclaration, useLanguage, useSpec } from "../contexts/docs.js";
+import "../use-strict-context-L0c8JKg4.js";
+import { useNavigation } from "../contexts/navigation.js";
+import { useLanguageComponents } from "../contexts/index.js";
+import { useComponents } from "../contexts/use-components.js";
+import style_default from "../style.js";
+import { PropertyToggle } from "../components/properties.js";
+import { LanguageNames, generateRoute } from "../routing.js";
+import { useStreamingResponse } from "../components/sdk.js";
+import { getBodyParams } from "../utils.js";
+import "../components/index.js";
+import React from "react";
+import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
+import clsx from "clsx";
+import { BracesIcon, FormIcon } from "lucide-react";
+import { Badge } from "@stainless-api/ui-primitives";
+
+//#region src/languages/http.tsx
+var http_exports = /* @__PURE__ */ __exportAll({
+	Declaration: () => Declaration,
+	MethodInfo: () => MethodInfo,
+	MethodSignature: () => MethodSignature,
+	Property: () => Property,
+	Type: () => Type,
+	TypeName: () => TypeName
+});
+const ComplexTypes = {
+	HttpTypeUnion: "union",
+	HttpTypeIntersection: "intersection"
+};
+const constStyle = {
+	string: style_default.LiteralString,
+	number: style_default.LiteralNumeric,
+	boolean: style_default.LiteralBoolean
+};
+function Identifier({ name }) {
+	return /* @__PURE__ */ jsx(Fragment$1, { children: /* @__PURE__ */ jsx("span", {
+		className: style_default.TextIdentifier,
+		children: /^[_a-zA-Z][_a-zA-Z0-9]*$/.test(name) ? name : JSON.stringify(name)
+	}) });
+}
+function TypePreview({ path }) {
+	const spec = useSpec();
+	const language = useLanguage();
+	const decl = useDeclaration(path, false);
+	const { Join } = useComponents();
+	if (!(decl && "children" in decl && decl.children && decl.children.length > 0) || "type" in decl && decl["type"] && "kind" in decl["type"] && decl["type"]["kind"] === "HttpTypeUnion") return;
+	const items = decl.children.map((prop, key) => {
+		const decl = spec?.decls?.[language]?.[prop];
+		const ident = decl && "key" in decl ? decl.key : decl && "ident" in decl ? decl.ident : null;
+		return /* @__PURE__ */ jsx("span", {
+			className: style_default.TypePropertyName,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TextIdentifier,
+				children: ident
+			})
+		}, key);
+	});
+	return /* @__PURE__ */ jsxs("span", {
+		className: style_default.TypePreview,
+		"data-stldocs-type-preview": "properties",
+		children: [
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TypeBrace,
+				children: " { "
+			}),
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TypePreviewContent,
+				children: /* @__PURE__ */ jsx(Join, {
+					items,
+					limit: 3,
+					children: /* @__PURE__ */ jsx("span", {
+						className: style_default.TextOperator,
+						children: ", "
+					})
+				})
+			}),
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TypeBrace,
+				children: " } "
+			})
+		]
+	});
+}
+function TypeName({ type }) {
+	const Lang = useLanguageComponents();
+	if (type.kind === "HttpTypeArray") return /* @__PURE__ */ jsxs(Fragment$1, { children: ["array of ", /* @__PURE__ */ jsx(Lang.TypeName, { type: type.elementType })] });
+	if (type.kind === "HttpTypeUnion" && type.types.every((t) => t.kind === "HttpTypeLiteral")) return "enum";
+	if (type.kind === "HttpTypeReference" && type.ident.split(".").at(-1) === "Record") return "map";
+	return ComplexTypes[type.kind] ?? /* @__PURE__ */ jsx(Lang.Type, { type });
+}
+function Type({ type }) {
+	const Lang = useLanguageComponents();
+	const { Join, SDKReference } = useComponents();
+	switch (type.kind) {
+		case "HttpTypeUnknown":
+		case "HttpTypeUndefined":
+		case "HttpTypeNull":
+		case "HttpTypeBoolean":
+		case "HttpTypeNumber":
+		case "HttpTypeString": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypePlain,
+				children: type.kind.slice(8).toLowerCase()
+			})
+		});
+		case "HttpTypeBinary": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypePlain,
+				children: "file"
+			})
+		});
+		case "HttpTypeLiteral": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: constStyle[typeof type.literal],
+				children: JSON.stringify(type.literal)
+			})
+		});
+		case "HttpTypeArray": return /* @__PURE__ */ jsxs("span", {
+			className: style_default.Type,
+			children: [/* @__PURE__ */ jsx("span", {
+				className: style_default.TypeArray,
+				children: "array of "
+			}), /* @__PURE__ */ jsx(Lang.Type, { type: type.elementType })]
+		});
+		case "HttpTypeIntersection":
+		case "HttpTypeUnion": {
+			const items = type.types.map((t, key) => /* @__PURE__ */ jsx(Lang.Type, { type: t }, key));
+			const delimiter = type.kind === "HttpTypeUnion" ? "or" : "and";
+			return /* @__PURE__ */ jsx("span", {
+				className: style_default.Type,
+				children: /* @__PURE__ */ jsx("span", {
+					className: style_default.TypePreview,
+					"data-stldocs-type-preview": "union",
+					children: /* @__PURE__ */ jsx("span", {
+						className: style_default.TypePreviewContent,
+						children: /* @__PURE__ */ jsx(Join, {
+							items,
+							limit: 3,
+							children: /* @__PURE__ */ jsxs("span", {
+								className: style_default.TextOperator,
+								children: [
+									" ",
+									delimiter,
+									" "
+								]
+							})
+						})
+					})
+				})
+			});
+		}
+		case "HttpTypeReference": {
+			const name = type.ident.split(".").at(-1);
+			const params = type.typeParameters?.map((param, key) => /* @__PURE__ */ jsx(Lang.Type, { type: param }, key));
+			if (name === "Record" && type.typeParameters?.length === 2 && type.typeParameters?.at(0).kind === "HttpTypeString") return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TypeArray,
+					children: "map"
+				}),
+				"[",
+				params?.[1],
+				"]"
+			] });
+			return /* @__PURE__ */ jsxs("span", {
+				className: style_default.Type,
+				children: [
+					/* @__PURE__ */ jsx(SDKReference, {
+						stainlessPath: type.$ref,
+						children: name
+					}),
+					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: ">"
+						})
+					] }),
+					/* @__PURE__ */ jsx(TypePreview, { path: type.$ref })
+				]
+			});
+		}
+		case "HttpTypeObject": {
+			const items = type.members.map(({ ident }) => /* @__PURE__ */ jsx("span", {
+				className: style_default.TypePropertyName,
+				children: /* @__PURE__ */ jsx(Identifier, { name: ident })
+			}, ident));
+			return /* @__PURE__ */ jsxs("span", {
+				className: style_default.Type,
+				children: [/* @__PURE__ */ jsx("span", {
+					className: style_default.TypePlain,
+					children: "object"
+				}), /* @__PURE__ */ jsxs("span", {
+					className: style_default.TypePreview,
+					"data-stldocs-type-preview": "properties",
+					children: [
+						/* @__PURE__ */ jsx("span", {
+							className: style_default.TypeBrace,
+							children: " {"
+						}),
+						/* @__PURE__ */ jsxs("span", {
+							className: style_default.TypePreviewContent,
+							children: [
+								" ",
+								/* @__PURE__ */ jsx(Join, {
+									items,
+									limit: 3,
+									children: /* @__PURE__ */ jsx("span", {
+										className: style_default.TextOperator,
+										children: ", "
+									})
+								}),
+								" "
+							]
+						}),
+						/* @__PURE__ */ jsx("span", {
+							className: style_default.TypeBrace,
+							children: "} "
+						})
+					]
+				})]
+			});
+		}
+		default: return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypePlain,
+				children: "unknown"
+			})
+		});
+	}
+}
+function MethodSignature({ decl }) {
+	return null;
+}
+const EncodingBadges = {
+	unknown: null,
+	json: /* @__PURE__ */ jsx(Badge, {
+		size: "sm",
+		icon: /* @__PURE__ */ jsx(BracesIcon, {}),
+		children: "JSON"
+	}),
+	"form-data": /* @__PURE__ */ jsx(Badge, {
+		size: "sm",
+		icon: /* @__PURE__ */ jsx(FormIcon, {}),
+		children: "Form Data"
+	})
+};
+function MethodInfo({ decl, children }) {
+	const Docs = useComponents();
+	const streamingResponse = useStreamingResponse(decl);
+	const implementedLanguages = useAvailableLanguages(decl.stainlessPath);
+	const { basePath } = useNavigation();
+	const params = Object.entries(decl.paramsChildren).filter(([, value]) => value.length).map(([location, value]) => /* @__PURE__ */ jsx(React.Fragment, { children: /* @__PURE__ */ jsxs("div", {
+		className: style_default.MethodParameters,
+		"data-stldocs-property-group": location.at(0),
+		children: [/* @__PURE__ */ jsxs("h5", { children: [
+			location.at(0).toUpperCase(),
+			location.slice(1),
+			" Parameters",
+			/* @__PURE__ */ jsx(PropertyToggle, { target: location.at(0) })
+		] }), /* @__PURE__ */ jsx(Docs.SDKChildren, { paths: value })]
+	}) }, location));
+	const bodyParams = getBodyParams(decl);
+	if (bodyParams && bodyParams.params.length > 0) params.push(/* @__PURE__ */ jsxs("div", {
+		className: style_default.MethodInfoSection,
+		children: [/* @__PURE__ */ jsxs("h5", { children: [/* @__PURE__ */ jsxs("span", { children: ["Body Parameters", EncodingBadges[bodyParams.encoding]] }), /* @__PURE__ */ jsx(PropertyToggle, { target: "body" })] }), /* @__PURE__ */ jsx("div", {
+			className: style_default.MethodParameters,
+			"data-stldocs-property-group": "body",
+			children: /* @__PURE__ */ jsx(Docs.SDKChildren, { paths: bodyParams.params })
+		})]
+	}, "method-info-section"));
+	const responseChildren = "responseChildren" in decl && decl.responseChildren && decl.responseChildren.length > 0 ? [...decl.responseChildren] : [];
+	if (streamingResponse) responseChildren.push(streamingResponse);
+	if (params.length === 0 && responseChildren.length === 0) {
+		const availableLanguageLinks = implementedLanguages.filter((lang) => lang !== "http").flatMap((lang) => {
+			const url = generateRoute(basePath ?? "/", lang, decl.stainlessPath);
+			return url ? [{
+				url,
+				label: LanguageNames[lang] ?? lang
+			}] : [];
+		});
+		return /* @__PURE__ */ jsxs("div", {
+			className: style_default.MethodInfo,
+			children: [children, availableLanguageLinks.length > 0 && /* @__PURE__ */ jsxs("div", {
+				className: clsx("stl-ui-prose", style_default.MethodAvailableLanguages),
+				children: [/* @__PURE__ */ jsx("h5", { children: "Supported Languages" }), /* @__PURE__ */ jsxs("div", {
+					className: style_default.MethodAvailableLanguages,
+					children: ["This method is available in:", /* @__PURE__ */ jsx("ul", { children: availableLanguageLinks.map(({ url, label }) => {
+						return /* @__PURE__ */ jsx("li", { children: /* @__PURE__ */ jsx("a", {
+							href: url,
+							children: label
+						}) }, url);
+					}) })]
+				})]
+			})]
+		});
+	}
+	return /* @__PURE__ */ jsxs("div", {
+		className: style_default.MethodInfo,
+		children: [
+			children && /* @__PURE__ */ jsx("div", {
+				className: style_default.MethodContent,
+				children
+			}),
+			params.length > 0 && params,
+			responseChildren.length > 0 && /* @__PURE__ */ jsxs("div", {
+				className: style_default.MethodInfoSection,
+				children: [/* @__PURE__ */ jsxs("h5", { children: ["Returns", /* @__PURE__ */ jsx(PropertyToggle, { target: "returns" })] }), /* @__PURE__ */ jsx("div", {
+					className: style_default.MethodReturns,
+					"data-stldocs-property-group": "returns",
+					children: /* @__PURE__ */ jsx(Docs.SDKChildren, { paths: responseChildren })
+				})]
+			})
+		]
+	});
+}
+function renderVariantInfo(type) {
+	if (type.kind === "HttpTypeUnion" && type.types.every((t) => t.kind === "HttpTypeObject" || t.kind === "HttpTypeReference")) return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+		"One of the following ",
+		type.types.length,
+		" object variants:"
+	] });
+}
+function Property({ decl, children }) {
+	const Lang = useLanguageComponents();
+	if (!decl) return;
+	switch (decl.kind) {
+		case "HttpDeclProperty": {
+			const variants = renderVariantInfo(decl.type);
+			return children({
+				name: decl.key,
+				typeName: /* @__PURE__ */ jsx(Lang.TypeName, { type: decl.type }),
+				type: decl.type.kind in ComplexTypes && !variants && /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+			});
+		}
+		case "HttpDeclTypeAlias": return children({
+			name: decl.ident,
+			typeName: /* @__PURE__ */ jsx(Lang.TypeName, { type: decl.type })
+		});
+		case "HttpDeclReference": return children({ type: /* @__PURE__ */ jsx(Lang.Type, { type: decl.type }) });
+	}
+}
+function Declaration({ decl }) {
+	const Lang = useLanguageComponents();
+	if (!decl) return;
+	switch (decl.kind) {
+		case "HttpDeclProperty": return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TypePropertyName,
+				children: /* @__PURE__ */ jsx(Identifier, { name: decl.key })
+			}),
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextPunctuation,
+				children: ": "
+			}),
+			decl.optional && /* @__PURE__ */ jsx("span", {
+				className: style_default.TextPunctuation,
+				children: "optional "
+			}),
+			/* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		] });
+		case "HttpDeclTypeAlias": return /* @__PURE__ */ jsxs(Fragment$1, { children: [/^UnionMember/.test(decl.ident) ? null : /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsx(Identifier, { name: decl.ident }), /* @__PURE__ */ jsx("span", {
+			className: style_default.TextOperator,
+			children: " = "
+		})] }), /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })] });
+		case "HttpDeclReference": return /* @__PURE__ */ jsx(Lang.Type, { type: decl.type });
+	}
+}
+
+//#endregion
+export { Declaration, MethodInfo, MethodSignature, Property, Type, TypeName, http_exports as t };

package/dist/languages/index.d.ts

@@ -0,0 +1,51 @@
+import { S as Type, h as Resource, i as DeclarationNode } from "../index-pvh-w1xa.js";
+import { PropertyProps } from "../components/properties.js";
+import { t as typescript_d_exports } from "./typescript.js";
+import { t as java_d_exports } from "./java.js";
+import { t as go_d_exports } from "./go.js";
+import { t as python_d_exports } from "./python.js";
+import { t as ruby_d_exports } from "./ruby.js";
+import { t as http_d_exports } from "./http.js";
+import { t as csharp_d_exports } from "./csharp.js";
+import { t as php_d_exports } from "./php.js";
+import { t as cli_d_exports } from "./cli.js";
+import { t as terraform_d_exports } from "./terraform.js";
+import "../components/index.js";
+import { ReactNode } from "react";
+
+//#region src/languages/index.d.ts
+declare namespace index_d_exports {
+  export { LanguageComponentDefinition, PropertyFn, cli_d_exports as cli, csharp_d_exports as csharp, go_d_exports as go, http_d_exports as http, java_d_exports as java, kotlin, node, php_d_exports as php, python_d_exports as python, ruby_d_exports as ruby, terraform_d_exports as terraform, typescript_d_exports as typescript };
+}
+declare const node: typeof typescript_d_exports;
+declare const kotlin: typeof java_d_exports;
+type PropertyFn = (params: PropertyProps) => ReactNode;
+interface LanguageComponentDefinition {
+  Declaration(props: {
+    decl: DeclarationNode;
+  }): ReactNode;
+  Property(props: {
+    decl: DeclarationNode;
+    children: PropertyFn;
+  }): ReactNode;
+  TypeName(props: {
+    type: Type;
+    optional?: boolean;
+  }): ReactNode;
+  Type(props: {
+    type: Type;
+    optional?: boolean;
+  }): ReactNode;
+  MethodSignature(props: {
+    decl: DeclarationNode;
+  }): ReactNode;
+  MethodInfo?(props: {
+    decl: DeclarationNode;
+    children?: ReactNode;
+  }): ReactNode;
+  Resource?(props: {
+    resource: Resource;
+  }): ReactNode;
+}
+//#endregion
+export { LanguageComponentDefinition, PropertyFn, cli_d_exports as cli, csharp_d_exports as csharp, go_d_exports as go, http_d_exports as http, java_d_exports as java, kotlin, node, php_d_exports as php, python_d_exports as python, ruby_d_exports as ruby, index_d_exports as t, terraform_d_exports as terraform, typescript_d_exports as typescript };

package/dist/languages/index.js

@@ -0,0 +1,33 @@
+import { t as __exportAll } from "../chunk-BYypO7fO.js";
+import "../use-strict-context-L0c8JKg4.js";
+import { t as typescript_exports } from "./typescript.js";
+import { t as java_exports } from "./java.js";
+import { t as go_exports } from "./go.js";
+import { t as python_exports } from "./python.js";
+import { t as ruby_exports } from "./ruby.js";
+import { t as http_exports } from "./http.js";
+import { t as csharp_exports } from "./csharp.js";
+import { t as php_exports } from "./php.js";
+import { t as cli_exports } from "./cli.js";
+import { t as terraform_exports } from "./terraform.js";
+
+//#region src/languages/index.ts
+var languages_exports = /* @__PURE__ */ __exportAll({
+	cli: () => cli_exports,
+	csharp: () => csharp_exports,
+	go: () => go_exports,
+	http: () => http_exports,
+	java: () => java_exports,
+	kotlin: () => kotlin,
+	node: () => node,
+	php: () => php_exports,
+	python: () => python_exports,
+	ruby: () => ruby_exports,
+	terraform: () => terraform_exports,
+	typescript: () => typescript_exports
+});
+const node = typescript_exports;
+const kotlin = java_exports;
+
+//#endregion
+export { cli_exports as cli, csharp_exports as csharp, go_exports as go, http_exports as http, java_exports as java, kotlin, node, php_exports as php, python_exports as python, ruby_exports as ruby, languages_exports as t, terraform_exports as terraform, typescript_exports as typescript };

package/dist/languages/java.d.ts

@@ -0,0 +1,43 @@
+import { l as JavaAST } from "../index-pvh-w1xa.js";
+import { PropertyFn } from "./index.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/languages/java.d.ts
+declare namespace java_d_exports {
+  export { Declaration, DeclarationProps, MethodSignature, MethodSignatureProps, Property, PropertyProps, Type, TypeName };
+}
+type TypeProps = {
+  type: JavaAST.JavaType;
+  optional?: boolean;
+};
+declare function TypeName({
+  type,
+  optional
+}: TypeProps): react_jsx_runtime0.JSX.Element | "List";
+declare function Type({
+  type,
+  optional
+}: TypeProps): react_jsx_runtime0.JSX.Element;
+type MethodSignatureProps = {
+  decl: JavaAST.JavaDeclFunction;
+};
+declare function MethodSignature({
+  decl
+}: MethodSignatureProps): react_jsx_runtime0.JSX.Element;
+type PropertyProps = {
+  decl: JavaAST.JavaDeclaration;
+  children: PropertyFn;
+};
+declare function Property({
+  decl,
+  children
+}: PropertyProps): React$1.ReactNode;
+type DeclarationProps = {
+  decl: JavaAST.JavaDeclaration;
+};
+declare function Declaration({
+  decl
+}: DeclarationProps): react_jsx_runtime0.JSX.Element | null | undefined;
+//#endregion
+export { Declaration, DeclarationProps, MethodSignature, MethodSignatureProps, Property, PropertyProps, Type, TypeName, java_d_exports as t };