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

package/dist/ruby-CSvGbSLe.js

@@ -0,0 +1,387 @@
+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/ruby.tsx
+var ruby_exports = /* @__PURE__ */ __export({
+	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: "StringIO",
+	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 { TypeName as a, Type as i, MethodSignature as n, ruby_exports as o, Property as r, Declaration as t };

package/dist/sdk-B5W3VipN.d.ts

@@ -0,0 +1,118 @@
+import { t as DocsLanguage } from "./routing-CMqh1cTZ.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime66 from "react/jsx-runtime";
+import * as SDKJSON from "@stainless/sdk-json";
+
+//#region src/components/sdk.d.ts
+type PropertyModelContextType = {
+  modelPath?: string;
+  propertyPath?: string;
+};
+declare const PropertyModelContext: React$1.Context<PropertyModelContextType>;
+declare function usePropertyModel(): PropertyModelContextType;
+type ReferenceNestingContextType = string[];
+declare const ReferenceNestingContext: React$1.Context<ReferenceNestingContextType>;
+declare function useReferenceNesting(): ReferenceNestingContextType;
+type SDKSnippetLanguagesType = Record<SDKJSON.SnippetLanguage, {
+  name: string;
+}>;
+declare const SDKSnippetLanguages: SDKSnippetLanguagesType;
+type TransformRequestSnippetFn = ({
+  snippet,
+  language
+}: {
+  snippet: string;
+  language: DocsLanguage;
+}) => string;
+type SDKChildrenProps = {
+  paths: SDKJSON.ID[];
+  expand?: boolean;
+  depth?: number;
+};
+declare function SDKChildren({
+  paths,
+  expand,
+  depth
+}: SDKChildrenProps): react_jsx_runtime66.JSX.Element;
+type SDKDeclarationProps = {
+  path: string;
+  expand?: boolean;
+  depth?: number;
+};
+declare function SDKDeclaration({
+  path,
+  expand,
+  depth
+}: SDKDeclarationProps): react_jsx_runtime66.JSX.Element;
+type SDKConstraintsProps = {
+  constraints?: Record<string, any>;
+};
+declare function SDKConstraints({
+  constraints
+}: SDKConstraintsProps): react_jsx_runtime66.JSX.Element | undefined;
+type SDKIconProps = {
+  language: SDKJSON.SnippetLanguage;
+  size?: number;
+};
+declare function SDKIcon({
+  language
+}: SDKIconProps): react_jsx_runtime66.JSX.Element | null;
+type SDKRequestTitleProps = {
+  snippetLanguage: SDKJSON.SnippetLanguage;
+};
+declare function SDKRequestTitle({
+  snippetLanguage
+}: SDKRequestTitleProps): react_jsx_runtime66.JSX.Element;
+type SDKExampleProps = {
+  method: SDKJSON.Method;
+  transformRequestSnippet?: TransformRequestSnippetFn;
+};
+declare function SDKExample({
+  method,
+  transformRequestSnippet
+}: SDKExampleProps): react_jsx_runtime66.JSX.Element;
+type SDKMethodProps = {
+  method: SDKJSON.Method;
+  transformRequestSnippet?: TransformRequestSnippetFn;
+};
+declare function SDKMethodHeader({
+  method
+}: SDKMethodProps): react_jsx_runtime66.JSX.Element;
+declare function SDKMethodInfo({
+  method
+}: SDKMethodProps): react_jsx_runtime66.JSX.Element;
+declare function SDKMethod({
+  method,
+  transformRequestSnippet
+}: SDKMethodProps): react_jsx_runtime66.JSX.Element;
+type SDKModelProps = {
+  model: SDKJSON.Model;
+};
+declare function SDKModel({
+  model
+}: SDKModelProps): react_jsx_runtime66.JSX.Element | null;
+type SDKReferenceProps = {
+  stainlessPath: string;
+  children?: React$1.ReactNode;
+};
+declare function SDKReference({
+  stainlessPath,
+  children
+}: SDKReferenceProps): string | number | bigint | boolean | Iterable<React$1.ReactNode> | Promise<string | number | bigint | boolean | React$1.ReactPortal | React$1.ReactElement<unknown, string | React$1.JSXElementConstructor<any>> | Iterable<React$1.ReactNode> | null | undefined> | react_jsx_runtime66.JSX.Element | null | undefined;
+type SDKLanguageBlockProps = {
+  language: DocsLanguage;
+  version: string;
+  install: string;
+  links: {
+    repo: string;
+    docs: string;
+  };
+};
+declare function SDKLanguageBlock({
+  language,
+  version,
+  install,
+  links
+}: SDKLanguageBlockProps): react_jsx_runtime66.JSX.Element;
+//#endregion
+export { TransformRequestSnippetFn as C, SDKSnippetLanguagesType as S, useReferenceNesting as T, SDKModelProps as _, SDKChildren as a, SDKRequestTitleProps as b, SDKDeclaration as c, SDKLanguageBlock as d, SDKMethod as f, SDKModel as g, SDKMethodProps as h, ReferenceNestingContextType as i, SDKExample as l, SDKMethodInfo as m, PropertyModelContextType as n, SDKConstraints as o, SDKMethodHeader as p, ReferenceNestingContext as r, SDKConstraintsProps as s, PropertyModelContext as t, SDKIcon as u, SDKReference as v, usePropertyModel as w, SDKSnippetLanguages as x, SDKRequestTitle as y };

package/dist/sdk-CS6A3HW3.d.ts

@@ -0,0 +1,118 @@
+import { t as DocsLanguage } from "./routing-CMqh1cTZ.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime55 from "react/jsx-runtime";
+import * as SDKJSON from "@stainless/sdk-json";
+
+//#region src/components/sdk.d.ts
+type PropertyModelContextType = {
+  modelPath?: string;
+  propertyPath?: string;
+};
+declare const PropertyModelContext: React$1.Context<PropertyModelContextType>;
+declare function usePropertyModel(): PropertyModelContextType;
+type ReferenceNestingContextType = string[];
+declare const ReferenceNestingContext: React$1.Context<ReferenceNestingContextType>;
+declare function useReferenceNesting(): ReferenceNestingContextType;
+type SDKSnippetLanguagesType = Record<SDKJSON.SnippetLanguage, {
+  name: string;
+}>;
+declare const SDKSnippetLanguages: SDKSnippetLanguagesType;
+type TransformRequestSnippetFn = ({
+  snippet,
+  language
+}: {
+  snippet: string;
+  language: DocsLanguage;
+}) => string;
+type SDKChildrenProps = {
+  paths: SDKJSON.ID[];
+  expand?: boolean;
+  depth?: number;
+};
+declare function SDKChildren({
+  paths,
+  expand,
+  depth
+}: SDKChildrenProps): react_jsx_runtime55.JSX.Element;
+type SDKDeclarationProps = {
+  path: string;
+  expand?: boolean;
+  depth?: number;
+};
+declare function SDKDeclaration({
+  path,
+  expand,
+  depth
+}: SDKDeclarationProps): react_jsx_runtime55.JSX.Element;
+type SDKConstraintsProps = {
+  constraints?: Record<string, any>;
+};
+declare function SDKConstraints({
+  constraints
+}: SDKConstraintsProps): react_jsx_runtime55.JSX.Element | undefined;
+type SDKIconProps = {
+  language: SDKJSON.SnippetLanguage;
+  size?: number;
+};
+declare function SDKIcon({
+  language
+}: SDKIconProps): react_jsx_runtime55.JSX.Element | null;
+type SDKRequestTitleProps = {
+  snippetLanguage: SDKJSON.SnippetLanguage;
+};
+declare function SDKRequestTitle({
+  snippetLanguage
+}: SDKRequestTitleProps): react_jsx_runtime55.JSX.Element;
+type SDKExampleProps = {
+  method: SDKJSON.Method;
+  transformRequestSnippet?: TransformRequestSnippetFn;
+};
+declare function SDKExample({
+  method,
+  transformRequestSnippet
+}: SDKExampleProps): react_jsx_runtime55.JSX.Element;
+type SDKMethodProps = {
+  method: SDKJSON.Method;
+  transformRequestSnippet?: TransformRequestSnippetFn;
+};
+declare function SDKMethodHeader({
+  method
+}: SDKMethodProps): react_jsx_runtime55.JSX.Element;
+declare function SDKMethodInfo({
+  method
+}: SDKMethodProps): react_jsx_runtime55.JSX.Element;
+declare function SDKMethod({
+  method,
+  transformRequestSnippet
+}: SDKMethodProps): react_jsx_runtime55.JSX.Element;
+type SDKModelProps = {
+  model: SDKJSON.Model;
+};
+declare function SDKModel({
+  model
+}: SDKModelProps): react_jsx_runtime55.JSX.Element | null;
+type SDKReferenceProps = {
+  stainlessPath: string;
+  children?: React$1.ReactNode;
+};
+declare function SDKReference({
+  stainlessPath,
+  children
+}: SDKReferenceProps): string | number | bigint | boolean | react_jsx_runtime55.JSX.Element | Iterable<React$1.ReactNode> | Promise<string | number | bigint | boolean | React$1.ReactPortal | React$1.ReactElement<unknown, string | React$1.JSXElementConstructor<any>> | Iterable<React$1.ReactNode> | null | undefined> | null | undefined;
+type SDKLanguageBlockProps = {
+  language: DocsLanguage;
+  version: string;
+  install: string;
+  links: {
+    repo: string;
+    docs: string;
+  };
+};
+declare function SDKLanguageBlock({
+  language,
+  version,
+  install,
+  links
+}: SDKLanguageBlockProps): react_jsx_runtime55.JSX.Element;
+//#endregion
+export { TransformRequestSnippetFn as C, SDKSnippetLanguagesType as S, useReferenceNesting as T, SDKModelProps as _, SDKChildren as a, SDKRequestTitleProps as b, SDKDeclaration as c, SDKLanguageBlock as d, SDKMethod as f, SDKModel as g, SDKMethodProps as h, ReferenceNestingContextType as i, SDKExample as l, SDKMethodInfo as m, PropertyModelContextType as n, SDKConstraints as o, SDKMethodHeader as p, ReferenceNestingContext as r, SDKConstraintsProps as s, PropertyModelContext as t, SDKIcon as u, SDKReference as v, usePropertyModel as w, SDKSnippetLanguages as x, SDKRequestTitle as y };