@stainless-api/docs-ui 0.1.0-beta.9 → 0.1.0-beta.90

package/dist/languages/ruby.js

@@ -0,0 +1,386 @@
+import { t as __exportAll } from "../chunk-pbuEa-1d.js";
+import { useDeclaration, useLanguage, useSpec } from "../contexts/docs.js";
+import "../component-generics-DYxBWv1v.js";
+import { useLanguageComponents } from "../contexts/index.js";
+import { useComponents } from "../contexts/use-components.js";
+import style_default from "../style.js";
+import * as React$1 from "react";
+import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
+//#region src/languages/ruby.tsx
+var ruby_exports = /* @__PURE__ */ __exportAll({
+	Declaration: () => Declaration,
+	MethodSignature: () => MethodSignature,
+	Property: () => Property,
+	Type: () => Type,
+	TypeName: () => TypeName
+});
+const ComplexTypes = {
+	RubyTypeObject: "object",
+	RubyTypeUnion: "union",
+	RubyTypeIntersection: "intersection",
+	RubyTypeArray: "array",
+	RubyTypeMap: "hash"
+};
+const Keywords = {
+	RubyTypeBinary: "FileInput",
+	RubyTypeUnknown: "untyped",
+	RubyTypeNull: "nil",
+	RubyTypeInteger: "Integer",
+	RubyTypeFloat: "Float",
+	RubyTypeBoolean: "bool"
+};
+function TypeName({ type }) {
+	const Lang = useLanguageComponents();
+	return ComplexTypes[type.kind] ?? /* @__PURE__ */ jsx(Lang.Type, { type });
+}
+const VALID_IDENTIFIER = /^[_A-Za-z][_A-Za-z0-9]*$/;
+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"] === "RubyTypeUnion") 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 && "ident" in p ? p["ident"] : 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 Type({ type }) {
+	const Lang = useLanguageComponents();
+	const { SDKReference, Join } = useComponents();
+	switch (type.kind) {
+		case "RubyTypeBinary":
+		case "RubyTypeUnknown":
+		case "RubyTypeNull":
+		case "RubyTypeInteger":
+		case "RubyTypeFloat":
+		case "RubyTypeBoolean": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeKeyword,
+				children: Keywords[type.kind]
+			})
+		});
+		case "RubyTypeString": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeString,
+				children: "String"
+			})
+		});
+		case "RubyTypeLiteral":
+			switch (typeof type.literal) {
+				case "string": return /* @__PURE__ */ jsx("span", {
+					className: style_default.Type,
+					children: /* @__PURE__ */ jsxs("span", {
+						className: style_default.LiteralString,
+						children: [":", type.literal.match(VALID_IDENTIFIER) ? type.literal : JSON.stringify(type.literal)]
+					})
+				});
+				case "number": return /* @__PURE__ */ jsx("span", {
+					className: style_default.Type,
+					children: /* @__PURE__ */ jsx("span", {
+						className: style_default.LiteralNumeric,
+						children: JSON.stringify(type.literal)
+					})
+				});
+				case "boolean": return /* @__PURE__ */ jsx("span", {
+					className: style_default.Type,
+					children: /* @__PURE__ */ jsx("span", {
+						className: style_default.LiteralBoolean,
+						children: JSON.stringify(type.literal)
+					})
+				});
+			}
+			break;
+		case "RubyTypeArray": 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 "RubyTypeMap": return /* @__PURE__ */ jsxs("span", {
+			className: style_default.Type,
+			children: [
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TypeArray,
+					children: "Hash["
+				}),
+				type.indexType.kind === "RubyTypeString" ? /* @__PURE__ */ jsx("span", {
+					className: style_default.TypeString,
+					children: "Symbol"
+				}) : /* @__PURE__ */ jsx(Lang.Type, { type: type.indexType }),
+				", ",
+				/* @__PURE__ */ jsx(Lang.Type, { type: type.itemType }),
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TypeArray,
+					children: "]"
+				})
+			]
+		});
+		case "RubyTypeReference": {
+			const name = type.ident.split(".").at(-1);
+			if (!type.typeParameters || type.typeParameters.length === 0) return /* @__PURE__ */ jsxs("span", {
+				className: style_default.Type,
+				children: [/* @__PURE__ */ jsx(SDKReference, {
+					stainlessPath: type.$ref,
+					children: name
+				}), /* @__PURE__ */ jsx(TypePreview, { path: type.$ref })]
+			});
+			const typeParameters = type.typeParameters.map((t, i) => /* @__PURE__ */ jsx(Lang.Type, { type: t }, i));
+			return /* @__PURE__ */ jsxs("span", {
+				className: style_default.Type,
+				children: [
+					/* @__PURE__ */ jsx(SDKReference, {
+						stainlessPath: type.$ref,
+						children: name
+					}),
+					/* @__PURE__ */ jsx("span", {
+						className: style_default.TypeBracket,
+						children: "<"
+					}),
+					/* @__PURE__ */ jsx(Join, {
+						items: typeParameters,
+						children: /* @__PURE__ */ jsx("span", {
+							className: style_default.TextOperator,
+							children: ", "
+						})
+					}),
+					/* @__PURE__ */ jsx("span", {
+						className: style_default.TypeBracket,
+						children: ">"
+					}),
+					/* @__PURE__ */ jsx(TypePreview, { path: type.$ref })
+				]
+			});
+		}
+		case "RubyTypeIntersection":
+		case "RubyTypeUnion": {
+			const items = type.types.map((t, key) => /* @__PURE__ */ jsx(Lang.Type, { type: t }, key));
+			const delimiter = type.kind === "RubyTypeUnion" ? "|" : "&";
+			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 "RubyTypeBuiltinClass": return /* @__PURE__ */ jsx("span", {
+			className: style_default.TypeReference,
+			children: type.className
+		});
+		case "RubyTypeObject": {
+			const items = type.members.map((prop, key) => /* @__PURE__ */ jsx("span", {
+				className: style_default.TextIdentifier,
+				children: prop.ident
+			}, key));
+			return /* @__PURE__ */ jsx("span", {
+				className: style_default.Type,
+				children: /* @__PURE__ */ jsx("span", {
+					className: style_default.TypePreview,
+					"data-stldocs-type-preview": "properties",
+					children: /* @__PURE__ */ jsxs("span", {
+						className: style_default.TypePreviewContent,
+						children: [
+							/* @__PURE__ */ jsx("span", {
+								className: style_default.TypeBrace,
+								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 } = useComponents();
+	const params = decl.args.map((param, i) => /* @__PURE__ */ jsx(React$1.Fragment, { 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: [
+				/* @__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__ */ jsx("span", {
+							className: style_default.SignatureParen,
+							children: ")"
+						}),
+						" -> ",
+						decl.returns ? /* @__PURE__ */ jsx(Lang.Type, { type: decl.returns }) : "void"
+					]
+				})
+			]
+		})
+	});
+}
+function Property({ decl, children }) {
+	const Lang = useLanguageComponents();
+	switch (decl.kind) {
+		case "RubyDeclProperty": return children({
+			name: decl.ident,
+			typeName: /* @__PURE__ */ jsx(Lang.TypeName, { type: decl.type }),
+			type: decl.type.kind in ComplexTypes && /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		});
+		case "RubyDeclTypeAlias": return children({
+			name: decl.ident,
+			typeName: "alias",
+			type: /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		});
+		case "RubyDeclReference": return children({ type: /* @__PURE__ */ jsx(Lang.Type, { type: decl.type }) });
+		case "RubyDeclClass": return children({
+			name: decl.ident,
+			typeName: "class"
+		});
+	}
+}
+function Declaration({ decl }) {
+	const Lang = useLanguageComponents();
+	if (!decl) return;
+	switch (decl.kind) {
+		case "RubyDeclProperty": 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: ": "
+			}),
+			/* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		] });
+		case "RubyDeclTypeAlias": 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 "RubyDeclClass": 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(TypePreview, { path: decl.stainlessPath })
+		] });
+		case "RubyDeclReference": return /* @__PURE__ */ jsx(Lang.Type, { type: decl.type });
+	}
+}
+//#endregion
+export { Declaration, MethodSignature, Property, Type, TypeName, ruby_exports as t };

package/dist/languages/terraform.d.ts

@@ -0,0 +1,2 @@
+import { A as Type, C as DeclarationProps, D as Resource, E as PropertyProps, M as TypeProps, N as isResourceEntirelyUnsupported, O as ResourceProps, S as Declaration, T as Property, j as TypeName, k as TerraformSource, w as MethodSignature } from "../index-gGDaf6FK.js";
+export { Declaration, DeclarationProps, MethodSignature, Property, PropertyProps, Resource, ResourceProps, TerraformSource, Type, TypeName, TypeProps, isResourceEntirelyUnsupported };

package/dist/languages/terraform.js

@@ -0,0 +1,259 @@
+import { t as __exportAll } from "../chunk-pbuEa-1d.js";
+import { useDeclaration, useSpec } from "../contexts/docs.js";
+import "../component-generics-DYxBWv1v.js";
+import { useLanguageComponents } from "../contexts/index.js";
+import { useComponents } from "../contexts/use-components.js";
+import style_default from "../style.js";
+import "react";
+import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
+import clsx from "clsx";
+import { Badge, Callout } from "@stainless-api/ui-primitives";
+//#region src/languages/terraform.tsx
+var terraform_exports = /* @__PURE__ */ __exportAll({
+	Declaration: () => Declaration,
+	MethodSignature: () => MethodSignature,
+	Property: () => Property,
+	Resource: () => Resource,
+	TerraformSource: () => TerraformSource,
+	Type: () => Type,
+	TypeName: () => TypeName,
+	isResourceEntirelyUnsupported: () => isResourceEntirelyUnsupported
+});
+function TypeName({ type }) {
+	return /* @__PURE__ */ jsx(useLanguageComponents().Type, { type });
+}
+function Type({ type }) {
+	const Lang = useLanguageComponents();
+	const { Join } = useComponents();
+	switch (type.category) {
+		case "nested": switch (type.type) {
+			case "ListNested":
+			case "MapNested":
+			case "SetNested": return /* @__PURE__ */ jsxs("span", {
+				className: style_default.Type,
+				children: [
+					/* @__PURE__ */ jsx("span", {
+						className: style_default.TypeArray,
+						children: type.type.replace("Nested", "")
+					}),
+					/* @__PURE__ */ jsx("span", {
+						className: style_default.TypeBracket,
+						children: "["
+					}),
+					/* @__PURE__ */ jsx("span", {
+						className: style_default.TypeReference,
+						children: "Attributes"
+					}),
+					/* @__PURE__ */ jsx("span", {
+						className: style_default.TypeBracket,
+						children: "]"
+					})
+				]
+			});
+			case "SingleNested": return /* @__PURE__ */ jsx("span", {
+				className: style_default.Type,
+				children: /* @__PURE__ */ jsx("span", {
+					className: style_default.TypeReference,
+					children: "Attributes"
+				})
+			});
+			default: return;
+		}
+		case "collection": return /* @__PURE__ */ jsxs("span", {
+			className: style_default.Type,
+			children: [
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TypeArray,
+					children: type.type
+				}),
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TypeBracket,
+					children: "["
+				}),
+				/* @__PURE__ */ jsx(Lang.Type, { type: type.elementType }),
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TypeBracket,
+					children: "]"
+				})
+			]
+		});
+		case "dynamic": {
+			const subtypes = type.allowedSubtypes.length > 0 ? /* @__PURE__ */ jsx(Join, {
+				items: type.allowedSubtypes,
+				children: " | "
+			}) : null;
+			return /* @__PURE__ */ jsx("span", {
+				className: style_default.Type,
+				children: /* @__PURE__ */ jsxs("span", {
+					className: style_default.TypeKeyword,
+					children: ["Dynamic ", subtypes]
+				})
+			});
+		}
+		case "primitive":
+			if (type.type === "String") return /* @__PURE__ */ jsx("span", {
+				className: style_default.Type,
+				children: /* @__PURE__ */ jsx("span", {
+					className: style_default.TypeString,
+					children: "String"
+				})
+			});
+			return /* @__PURE__ */ jsx("span", {
+				className: style_default.Type,
+				children: /* @__PURE__ */ jsx("span", {
+					className: style_default.TypeKeyword,
+					children: type.type
+				})
+			});
+		case "unknown": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeKeyword,
+				children: "JSON"
+			})
+		});
+	}
+}
+function MethodSignature() {
+	return null;
+}
+const PropGroups = [
+	"required",
+	"optional",
+	"computed"
+];
+function Property({ decl, children }) {
+	if (!decl) return null;
+	switch (decl.kind) {
+		case "TerraformDeclAttribute": return children({ name: decl.name });
+	}
+}
+function TerraformSource({ path, group }) {
+	const Docs = useComponents();
+	const decl = useDeclaration(path, true);
+	if (decl.kind !== "TerraformDeclSource") return;
+	const type = decl.type === "resource" ? "resource" : "data";
+	const badge = type === "resource" ? `success` : `note`;
+	const children = PropGroups.filter((section) => decl[section].length > 0).map((section) => {
+		const propGroupId = `${decl.name}-${section}-${group}`;
+		return /* @__PURE__ */ jsxs("div", {
+			className: style_default.ResourceContentGroup,
+			children: [/* @__PURE__ */ jsxs("h5", {
+				className: style_default.ResourceContentGroupModelTitle,
+				children: [
+					section,
+					" ",
+					/* @__PURE__ */ jsx(Docs.PropertyToggle, { target: propGroupId })
+				]
+			}), /* @__PURE__ */ jsx("div", {
+				className: style_default.ResourceContentProperties,
+				"data-stldocs-property-group": propGroupId,
+				children: /* @__PURE__ */ jsx(Docs.SDKChildren, { paths: decl[section] })
+			})]
+		}, section);
+	});
+	return /* @__PURE__ */ jsx("div", {
+		className: clsx(style_default.Method, style_default.MethodDoublePane),
+		children: /* @__PURE__ */ jsxs("div", {
+			className: style_default.MethodBody,
+			children: [/* @__PURE__ */ jsxs("div", {
+				className: style_default.MethodContentColumn,
+				children: [/* @__PURE__ */ jsxs("h4", {
+					className: style_default.TerraformResourceTitle,
+					children: [
+						/* @__PURE__ */ jsx(Badge, {
+							intent: badge,
+							children: type
+						}),
+						" ",
+						decl.name
+					]
+				}), children]
+			}), /* @__PURE__ */ jsx("div", {
+				className: clsx(style_default.MethodExample, "not-content", "stl-ui-not-prose"),
+				children: /* @__PURE__ */ jsx(Docs.SDKExample, { method: {
+					title: decl.name,
+					stainlessPath: path
+				} })
+			})]
+		})
+	});
+}
+function Declaration({ decl }) {
+	const Lang = useLanguageComponents();
+	if (!decl) return;
+	switch (decl.kind) {
+		case "TerraformDeclAttribute": {
+			const isOptional = decl.configurability === "optional" || decl.configurability === "computed_optional";
+			return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TextIdentifier,
+					children: decl.name
+				}),
+				isOptional && /* @__PURE__ */ jsx("span", {
+					className: style_default.TextPunctuation,
+					children: "?"
+				}),
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TextPunctuation,
+					children: ": "
+				}),
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TextKeyword,
+					children: /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+				})
+			] });
+		}
+		case "TerraformDeclServiceNode": {
+			const { resource, dataSource, listDataSource } = decl;
+			return /* @__PURE__ */ jsxs("div", {
+				className: style_default.Method,
+				children: [
+					resource && /* @__PURE__ */ jsx(TerraformSource, {
+						path: resource,
+						group: "resource"
+					}),
+					dataSource && /* @__PURE__ */ jsx(TerraformSource, {
+						path: dataSource,
+						group: "dataSource"
+					}),
+					listDataSource && /* @__PURE__ */ jsx(TerraformSource, {
+						path: listDataSource,
+						group: "listDataSource"
+					})
+				]
+			});
+		}
+	}
+}
+function isResourceEntirelyUnsupported(resource, decls) {
+	if (decls?.[resource.stainlessPath]) return false;
+	return Object.values(resource.subresources ?? {}).every((child) => isResourceEntirelyUnsupported(child, decls));
+}
+function Resource({ resource, parents }) {
+	const Docs = useComponents();
+	const Lang = useLanguageComponents();
+	const decl = useDeclaration(resource.stainlessPath, false);
+	const spec = useSpec();
+	if (decl) return /* @__PURE__ */ jsx("div", {
+		className: style_default.Resource,
+		"data-stl-resource-language": "terraform",
+		children: /* @__PURE__ */ jsxs("div", {
+			className: style_default.ResourceContent,
+			children: [/* @__PURE__ */ jsx(Docs.SDKResourceHeader, {
+				resource,
+				parents
+			}), /* @__PURE__ */ jsx(Lang.Declaration, { decl })]
+		})
+	});
+	if (!parents && isResourceEntirelyUnsupported(resource, spec?.decls.terraform)) return /* @__PURE__ */ jsxs(Callout, {
+		variant: "warning",
+		children: [
+			"The resource ",
+			/* @__PURE__ */ jsx("code", { children: resource.name }),
+			" is not supported in Terraform."
+		]
+	});
+}
+//#endregion
+export { Declaration, MethodSignature, Property, Resource, TerraformSource, Type, TypeName, isResourceEntirelyUnsupported, terraform_exports as t };

package/dist/languages/typescript.d.ts

@@ -0,0 +1,2 @@
+import { an as Property, cn as TypeName, in as MethodSignatureProps, nn as DeclarationProps, on as PropertyProps, rn as MethodSignature, sn as Type, tn as Declaration } from "../index-gGDaf6FK.js";
+export { Declaration, DeclarationProps, MethodSignature, MethodSignatureProps, Property, PropertyProps, Type, TypeName };