@stainless-api/docs-ui 0.1.0-beta.6 → 0.1.0-beta.61

package/dist/http-C7bu4oCl.js

@@ -0,0 +1,331 @@
+import { t as __exportAll } from "./chunk-BN_g-Awi.js";
+import { a as useLanguage, l as useSpec, r as useDeclaration } from "./docs-Di94viZV.js";
+import { n as useLanguageComponents } from "./contexts-CeV_L_Iy.js";
+import { t as useComponents } from "./use-components-BUz3GbO4.js";
+import { t as style_default } from "./style-LwfvXElj.js";
+import { i as PropertyToggle } from "./properties-DGL2J11L.js";
+import React from "react";
+import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
+
+//#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": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypePlain,
+				children: type.kind.slice(8).toLowerCase()
+			})
+		});
+		case "HttpTypeString": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypePlain,
+				children: "string"
+			})
+		});
+		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: "} "
+						})
+					]
+				})]
+			});
+		}
+	}
+}
+function MethodSignature({ decl }) {
+	return null;
+}
+function MethodInfo({ decl, children }) {
+	const Docs = useComponents();
+	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));
+	if ((decl.bodyParamsChildren?.["application/json"]?.length ?? 0) > 0) params.push(/* @__PURE__ */ jsxs("div", {
+		className: style_default.MethodInfoSection,
+		children: [/* @__PURE__ */ jsxs("h5", { children: ["Body Parameters", /* @__PURE__ */ jsx(PropertyToggle, { target: "body" })] }), /* @__PURE__ */ jsx("div", {
+			className: style_default.MethodParameters,
+			"data-stldocs-property-group": "body",
+			children: /* @__PURE__ */ jsx(Docs.SDKChildren, { paths: decl.bodyParamsChildren?.["application/json"] ?? [] })
+		})]
+	}, "method-info-section"));
+	return /* @__PURE__ */ jsxs("div", {
+		className: style_default.MethodInfo,
+		children: [
+			children && /* @__PURE__ */ jsx("div", {
+				className: style_default.MethodContent,
+				children
+			}),
+			params.length > 0 && params,
+			(decl.responseChildren?.length ?? 0) > 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: decl.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: [
+			/* @__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 { Type as a, Property as i, MethodInfo as n, TypeName as o, MethodSignature as r, http_exports as s, Declaration as t };