@stainless-api/docs-ui 0.1.0-beta.5 → 0.1.0-beta.51

package/dist/styles.mjs

@@ -0,0 +1 @@
+export {  };

package/dist/typescript-DXG9psK3.js

@@ -0,0 +1,449 @@
+import { t as __export } from "./chunk-DRcLgZ1e.js";
+import { a as useLanguage, l as useSpec, r as useDeclaration } from "./docs-CXqi26jB.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/typescript.tsx
+var typescript_exports = /* @__PURE__ */ __export({
+	Declaration: () => Declaration,
+	MethodSignature: () => MethodSignature,
+	Property: () => Property,
+	Type: () => Type,
+	TypeName: () => TypeName
+});
+const ComplexTypes = {
+	TSTypeObject: "object",
+	TSTypeUnion: "union",
+	TSTypeInterface: "interface",
+	TSTypeIntersection: "intersection",
+	TSTypeArray: "array"
+};
+const constStyle = {
+	string: style_default.LiteralString,
+	number: style_default.LiteralNumeric,
+	boolean: style_default.LiteralBoolean
+};
+function Identifier({ name, optional }) {
+	return /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsx("span", {
+		className: style_default.TextIdentifier,
+		children: /^[_a-zA-Z][_a-zA-Z0-9]*$/.test(name) ? name : JSON.stringify(name)
+	}), optional && /* @__PURE__ */ jsx("span", {
+		className: style_default.TextPunctuation,
+		children: "?"
+	})] });
+}
+function TypeParams({ params }) {
+	const Lang = useLanguageComponents();
+	const { Join } = useComponents();
+	if (!params?.length) return null;
+	const typeParams = params?.map((param, key) => param.constraint ? /* @__PURE__ */ jsxs(React$1.Fragment, { children: [
+		/* @__PURE__ */ jsx("span", {
+			className: style_default.TypeReference,
+			children: param.name
+		}),
+		/* @__PURE__ */ jsx("span", {
+			className: style_default.TextKeyword,
+			children: "extends "
+		}),
+		/* @__PURE__ */ jsx(Lang.Type, { type: param.constraint })
+	] }, key) : /* @__PURE__ */ jsx(React$1.Fragment, { children: "param.name" }, key));
+	return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+		/* @__PURE__ */ jsx("span", {
+			className: style_default.TypeBracket,
+			children: "<"
+		}),
+		/* @__PURE__ */ jsx(Join, {
+			items: typeParams,
+			limit: 3,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TextOperator,
+				children: ", "
+			})
+		}),
+		/* @__PURE__ */ jsx("span", {
+			className: style_default.TypeBracket,
+			children: ">"
+		})
+	] });
+}
+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) || decl && "type" in decl && "kind" in decl["type"] && decl["type"]["kind"] === "TSTypeUnion") return;
+	const items = decl.children.map((prop, key) => {
+		const p = spec?.decls?.[language]?.[prop];
+		return /* @__PURE__ */ jsx("span", {
+			className: style_default.TypePropertyName,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TextIdentifier,
+				children: p && "key" in p ? p["key"] : null
+			})
+		}, key);
+	});
+	return /* @__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 TypeName({ type }) {
+	const Lang = useLanguageComponents();
+	return ComplexTypes[type.kind] ?? /* @__PURE__ */ jsx(Lang.Type, { type });
+}
+function Type({ type }) {
+	const Lang = useLanguageComponents();
+	const { Join, SDKReference } = useComponents();
+	switch (type.kind) {
+		case "TSTypeUnknown":
+		case "TSTypeUndefined":
+		case "TSTypeNever":
+		case "TSTypeVoid":
+		case "TSTypeNull":
+		case "TSTypeAny":
+		case "TSTypeBoolean":
+		case "TSTypeNumber": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeKeyword,
+				children: type.kind.slice(6).toLowerCase()
+			})
+		});
+		case "TSTypeString": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeString,
+				children: "string"
+			})
+		});
+		case "TSTypeLiteral": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: constStyle[typeof type.literal],
+				children: JSON.stringify(type.literal)
+			})
+		});
+		case "TSTypeArray": 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 "TSTypeReference": {
+			const name = type.ident.split(".").at(-1);
+			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(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 "TSTypeIntersection":
+		case "TSTypeUnion": {
+			const items = type.types.map((t, key) => /* @__PURE__ */ jsx(Lang.Type, { type: t }, key));
+			const delimiter = type.kind === "TSTypeUnion" ? "|" : "&";
+			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 "TSTypeObject":
+		case "TSTypeInterface": {
+			const extend = type.kind === "TSTypeObject" ? null : type.extends?.map((ref, key) => /* @__PURE__ */ jsx(Lang.Type, { type: ref }, key));
+			const items = type.members.map((prop, key) => /* @__PURE__ */ jsxs(React$1.Fragment, { children: [
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TypePropertyName,
+					children: /* @__PURE__ */ jsx(Identifier, {
+						name: prop.ident,
+						optional: prop.optional
+					})
+				}),
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TextPunctuation,
+					children: ": "
+				}),
+				/* @__PURE__ */ jsx(Lang.Type, { type: prop.type })
+			] }, key));
+			return /* @__PURE__ */ jsxs("span", {
+				className: style_default.Type,
+				children: [extend?.length && /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsx("span", {
+					className: style_default.TypeKeyword,
+					children: " extends "
+				}), /* @__PURE__ */ jsx(Join, {
+					items: extend,
+					limit: 3,
+					children: /* @__PURE__ */ jsx("span", {
+						className: style_default.TextOperator,
+						children: ", "
+					})
+				})] }), /* @__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 MethodSignature({ decl }) {
+	const Lang = useLanguageComponents();
+	const { Join, Tooltip } = useComponents();
+	const params = decl.signature.parameters.map((param, i) => /* @__PURE__ */ jsxs(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
+		})
+	}), param.optional && /* @__PURE__ */ jsx("span", {
+		className: style_default.TextPunctuation,
+		children: "?"
+	})] }, i));
+	return /* @__PURE__ */ jsx("div", {
+		className: style_default.MethodSignature,
+		children: /* @__PURE__ */ jsxs("span", {
+			className: style_default.SignatureTitle,
+			children: [
+				decl.signature.async && /* @__PURE__ */ jsx("span", {
+					className: style_default.TextKeyword,
+					children: "async "
+				}),
+				/* @__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: [
+						decl.signature.typeParameters && /* @__PURE__ */ jsx(TypeParams, { params: decl.signature.typeParameters }),
+						/* @__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__ */ jsx("span", {
+							className: style_default.SignatureParen,
+							children: ")"
+						}),
+						decl.signature.returns && /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsx("span", {
+							className: style_default.TextPunctuation,
+							children: ": "
+						}), /* @__PURE__ */ jsx(Lang.Type, { type: decl.signature.returns })] })
+					]
+				})
+			]
+		})
+	});
+}
+function Property({ decl, children }) {
+	const Lang = useLanguageComponents();
+	if (!decl) return;
+	switch (decl.kind) {
+		case "TSDeclProperty": return children({
+			name: decl.key,
+			typeName: /* @__PURE__ */ jsx(Lang.TypeName, { type: decl.type }),
+			type: decl.type.kind in ComplexTypes && /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		});
+		case "TSDeclTypeAlias": return children({
+			name: decl.ident,
+			typeName: "alias",
+			type: /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		});
+		case "TSDeclReference": return children({ type: /* @__PURE__ */ jsx(Lang.Type, { type: decl.type }) });
+		case "TSDeclInterface": return children({ type: /* @__PURE__ */ jsxs(Fragment$1, { children: [
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextIdentifier,
+				children: decl.ident
+			}),
+			decl.typeParameters && /* @__PURE__ */ jsx(TypeParams, { params: decl.typeParameters }),
+			decl.extends?.flatMap((t, key) => /* @__PURE__ */ jsxs(React$1.Fragment, { children: [/* @__PURE__ */ jsx("span", {
+				className: style_default.TextKeyword,
+				children: " extends "
+			}), /* @__PURE__ */ jsx(Lang.Type, { type: t })] }, `extends:${key}`))
+		] }) });
+	}
+}
+function Declaration({ decl }) {
+	const Lang = useLanguageComponents();
+	if (!decl) return;
+	switch (decl.kind) {
+		case "TSDeclProperty": return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+			decl.declare && /* @__PURE__ */ jsx("span", {
+				className: style_default.TextKeyword,
+				children: "declare "
+			}),
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TypePropertyName,
+				children: /* @__PURE__ */ jsx(Identifier, {
+					name: decl.key,
+					optional: decl.optional
+				})
+			}),
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextPunctuation,
+				children: ": "
+			}),
+			/* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		] });
+		case "TSDeclFunction": return /* @__PURE__ */ jsx(Lang.MethodSignature, { decl });
+		case "TSDeclTypeAlias": return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+			/* @__PURE__ */ jsx(Identifier, { name: decl.ident }),
+			/* @__PURE__ */ jsx(TypeParams, { params: decl.typeParameters }),
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextOperator,
+				children: " = "
+			}),
+			/* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		] });
+		case "TSDeclReference": return /* @__PURE__ */ jsx(Lang.Type, { type: decl.type });
+		case "TSDeclInterface": return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextIdentifier,
+				children: decl.ident
+			}),
+			/* @__PURE__ */ jsx(TypeParams, { params: decl.typeParameters }),
+			decl.extends?.map((t, index) => /* @__PURE__ */ jsxs(React$1.Fragment, { children: [/* @__PURE__ */ jsx("span", {
+				className: style_default.TextKeyword,
+				children: " extends "
+			}), /* @__PURE__ */ jsx(Lang.Type, { type: t })] }, index)),
+			/* @__PURE__ */ jsx(TypePreview, { path: decl.stainlessPath })
+		] });
+		case "TSDeclClass": 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(TypeParams, { params: decl.typeParameters }),
+			decl.superClass ? /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsx("span", {
+				className: style_default.TextKeyword,
+				children: " extends "
+			}), /* @__PURE__ */ jsx(Lang.Type, { type: decl.superClass })] }) : null,
+			decl.implements?.map((t, index) => /* @__PURE__ */ jsxs(React$1.Fragment, { children: [/* @__PURE__ */ jsx("span", {
+				className: style_default.TextKeyword,
+				children: " implements "
+			}), /* @__PURE__ */ jsx(Lang.Type, { type: t })] }, index))
+		] });
+	}
+}
+
+//#endregion
+export { TypeName as a, Type as i, MethodSignature as n, typescript_exports as o, Property as r, Declaration as t };

package/dist/use-components-RWQbviGq.js

@@ -0,0 +1,7 @@
+import { i as useComponents } from "./component-generics-B6Fn47Mz.js";
+
+//#region src/contexts/use-components.tsx
+const useComponents$1 = () => useComponents();
+
+//#endregion
+export { useComponents$1 as t };

package/dist/utils-CqnL9Fc3.js

@@ -0,0 +1,31 @@
+import { Parser } from "htmlparser2";
+
+//#region src/markdown/utils.ts
+function getDecl(env, path) {
+	const decl = env.spec?.decls?.[env.language]?.[path];
+	if (decl?.kind?.endsWith("Reference")) {
+		const refId = "type" in decl && typeof decl["type"] === "object" && "$ref" in decl["type"] ? decl["type"]["$ref"] : null;
+		if (refId === path) return decl;
+		if (refId) return getDecl(env, refId);
+	}
+	return decl;
+}
+function getSnippet(env, path) {
+	const lang = env.language === "http" ? "http.curl" : `${env.language}.default`;
+	let snippet = env.spec?.snippets?.[lang]?.[path];
+	if (typeof snippet === "string" && env.transforms?.transformRequestSnippet) snippet = env.transforms.transformRequestSnippet({
+		snippet,
+		language: env.language
+	});
+	return snippet;
+}
+function stripMarkup(content) {
+	let output = "";
+	new Parser({ ontext(content$1) {
+		output += content$1;
+	} }).parseComplete(content);
+	return output;
+}
+
+//#endregion
+export { getSnippet as n, stripMarkup as r, getDecl as t };

package/dist/utils-DGnJ6mcU.d.ts

@@ -0,0 +1,21 @@
+import { t as DocsLanguage } from "./routing-CMqh1cTZ.js";
+import { C as TransformRequestSnippetFn } from "./sdk-B5W3VipN.js";
+import * as SDKJSON from "@stainless/sdk-json";
+
+//#region src/markdown/utils.d.ts
+type EnvironmentType = {
+  spec: SDKJSON.Spec;
+  language: DocsLanguage;
+  transforms?: {
+    transformRequestSnippet?: TransformRequestSnippetFn;
+  };
+  options: {
+    renderNestedResources?: boolean;
+    includeModelProperties?: boolean;
+  };
+};
+declare function getDecl(env: EnvironmentType, path: string): SDKJSON.LanguageDeclNodes[SDKJSON.SpecLanguage] | undefined;
+declare function getSnippet(env: EnvironmentType, path: string): string | undefined;
+declare function stripMarkup(content: string): string;
+//#endregion
+export { stripMarkup as i, getDecl as n, getSnippet as r, EnvironmentType as t };

package/dist/utils-D_1AWSRX.js

@@ -0,0 +1,32 @@
+import { t as __export } from "./chunk-DRcLgZ1e.js";
+import { f as parseStainlessPath } from "./routing-Wbb7YECB.js";
+
+//#region src/utils.ts
+var utils_exports = /* @__PURE__ */ __export({
+	flatResources: () => flatResources,
+	getResourceFromSpec: () => getResourceFromSpec,
+	isResourceEmpty: () => isResourceEmpty
+});
+function flatResources(resources, parents) {
+	return Object.keys(resources ?? {}).flatMap((key) => {
+		const resource = resources[key];
+		return [{
+			resource,
+			parents
+		}, ...resource.subresources ? flatResources(resource.subresources, [...parents, resource]) : []];
+	});
+}
+function getResourceFromSpec(stainlessPath, spec) {
+	if (typeof stainlessPath === "string") {
+		const parsed = parseStainlessPath(stainlessPath);
+		if (!parsed?.resource) return null;
+		stainlessPath = parsed.resource;
+	}
+	return stainlessPath.slice(1).reduce((acc, cur) => acc?.subresources?.[cur], spec.resources[stainlessPath[0]]) ?? null;
+}
+function isResourceEmpty(resource) {
+	return !(Object.values(resource.methods).length > 0 || Object.values(resource.models).length > 0 || Object.values(resource.subresources).length > 0);
+}
+
+//#endregion
+export { utils_exports as i, getResourceFromSpec as n, isResourceEmpty as r, flatResources as t };

package/dist/utils-d8paVwKN.d.ts

@@ -0,0 +1,14 @@
+import * as SDKJSON from "@stainless/sdk-json";
+
+//#region src/utils.d.ts
+declare namespace utils_d_exports {
+  export { flatResources, getResourceFromSpec, isResourceEmpty };
+}
+declare function flatResources(resources: Record<string, SDKJSON.Resource> | undefined, parents: SDKJSON.Resource[]): {
+  resource: SDKJSON.Resource;
+  parents: SDKJSON.Resource[];
+}[];
+declare function getResourceFromSpec(stainlessPath: string | string[], spec: SDKJSON.Spec): SDKJSON.Resource | null;
+declare function isResourceEmpty(resource: SDKJSON.Resource): boolean;
+//#endregion
+export { utils_d_exports as i, getResourceFromSpec as n, isResourceEmpty as r, flatResources as t };

package/dist/utils-uQbtk0-_.d.ts

@@ -0,0 +1,21 @@
+import { t as DocsLanguage } from "./routing-CMqh1cTZ.js";
+import { C as TransformRequestSnippetFn } from "./sdk-CS6A3HW3.js";
+import * as SDKJSON from "@stainless/sdk-json";
+
+//#region src/markdown/utils.d.ts
+type EnvironmentType = {
+  spec: SDKJSON.Spec;
+  language: DocsLanguage;
+  transforms?: {
+    transformRequestSnippet?: TransformRequestSnippetFn;
+  };
+  options: {
+    renderNestedResources?: boolean;
+    includeModelProperties?: boolean;
+  };
+};
+declare function getDecl(env: EnvironmentType, path: string): SDKJSON.LanguageDeclNodes[SDKJSON.SpecLanguage] | undefined;
+declare function getSnippet(env: EnvironmentType, path: string): string | undefined;
+declare function stripMarkup(content: string): string;
+//#endregion
+export { stripMarkup as i, getDecl as n, getSnippet as r, EnvironmentType as t };

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+import { n as getResourceFromSpec, r as isResourceEmpty, t as flatResources } from "./utils-d8paVwKN.js";
+export { flatResources, getResourceFromSpec, isResourceEmpty };

package/dist/utils.js

@@ -0,0 +1,3 @@
+import { n as getResourceFromSpec, r as isResourceEmpty, t as flatResources } from "./utils-D_1AWSRX.js";
+
+export { flatResources, getResourceFromSpec, isResourceEmpty };