@stainless-api/docs-ui 0.1.0-beta.7 → 0.1.0-beta.70

package/dist/csharp-D6_jlynY.js

@@ -0,0 +1,283 @@
+import { t as __exportAll } from "./chunk-BN_g-Awi.js";
+import { n as useLanguageComponents } from "./contexts-CVj20VV4.js";
+import { t as useComponents } from "./use-components-BUz3GbO4.js";
+import { t as style_default } from "./style-HpXpcJ9v.js";
+import * as React$1 from "react";
+import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
+
+//#region src/languages/csharp.tsx
+var csharp_exports = /* @__PURE__ */ __exportAll({
+	Declaration: () => Declaration,
+	MethodSignature: () => MethodSignature,
+	Property: () => Property,
+	Type: () => Type,
+	TypeName: () => TypeName
+});
+const constStyle = {
+	string: style_default.LiteralString,
+	number: style_default.LiteralNumeric,
+	boolean: style_default.LiteralBoolean
+};
+function TypeName({ type, optional }) {
+	return /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsx(useLanguageComponents().Type, { type }), optional && /* @__PURE__ */ jsx("span", {
+		className: style_default.TextOperator,
+		children: "? "
+	})] });
+}
+function Type({ type }) {
+	const Lang = useLanguageComponents();
+	const { Join, SDKReference } = useComponents();
+	switch (type.kind) {
+		case "CSharpTypeReference": {
+			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: type.typeName
+					}),
+					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: ">"
+						})
+					] }) : null,
+					type.nullable && /* @__PURE__ */ jsx("span", {
+						className: style_default.TextOperator,
+						children: "?"
+					})
+				]
+			});
+		}
+		case "CSharpTypeClass":
+		case "CSharpTypeUnion": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeKeyword,
+				children: "class"
+			})
+		});
+		case "CSharpTypeEnum":
+		case "CSharpTypeBoolean":
+		case "CSharpTypeFloat":
+		case "CSharpTypeDouble":
+		case "CSharpTypeInt":
+		case "CSharpTypeLong": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeKeyword,
+				children: type.kind.slice(10)
+			})
+		});
+		case "CSharpTypeString": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeString,
+				children: "string"
+			})
+		});
+		case "CSharpTypeConstant": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeKeyword,
+				children: "JsonElement"
+			})
+		});
+	}
+}
+function MethodSignature({ decl }) {
+	const Lang = useLanguageComponents();
+	const { Join, Tooltip } = useComponents();
+	const params = decl.parameters.map((param, i) => /* @__PURE__ */ jsx(React$1.Fragment, { children: /* @__PURE__ */ jsxs(Tooltip, {
+		content: /* @__PURE__ */ jsx(Lang.Type, { type: param.typeAnnotation }),
+		children: [/* @__PURE__ */ jsx("span", {
+			className: style_default.TextIdentifier,
+			children: param.ident
+		}), param.hasDefault && /* @__PURE__ */ jsxs(Fragment$1, { children: [
+			" ",
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextOperator,
+				children: "="
+			}),
+			" ",
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextKeyword,
+				children: "default"
+			})
+		] })]
+	}) }, i));
+	return /* @__PURE__ */ jsx("div", {
+		className: style_default.MethodSignature,
+		children: /* @__PURE__ */ jsxs("span", {
+			className: style_default.SignatureTitle,
+			children: [
+				decl.returnType && /* @__PURE__ */ jsxs("span", {
+					className: style_default.SignatureReturns,
+					children: [/* @__PURE__ */ jsx(Lang.Type, { type: decl.returnType }), " "]
+				}),
+				decl.qualified && /* @__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__ */ jsxs("span", {
+							className: style_default.SignatureParen,
+							children: [")", " "]
+						})
+					]
+				})
+			]
+		})
+	});
+}
+function Property({ decl, children }) {
+	const Lang = useLanguageComponents();
+	if (!decl) return null;
+	switch (decl.kind) {
+		case "CSharpDeclProperty": {
+			const type = /* @__PURE__ */ jsx(Lang.Type, {
+				type: decl.type,
+				optional: decl.optional
+			});
+			return children({
+				name: decl.ident,
+				typeName: /* @__PURE__ */ jsx(Lang.TypeName, {
+					type: decl.type,
+					optional: decl.optional
+				}),
+				type
+			});
+		}
+		case "CSharpDeclConst": return children({
+			name: decl.ident,
+			typeName: "constant",
+			type: /* @__PURE__ */ jsx("span", {
+				className: constStyle[typeof decl.value],
+				children: JSON.stringify(decl.value)
+			})
+		});
+		case "CSharpDeclType": {
+			const typeName = decl.type.kind === "CSharpTypeUnion" ? "union" : decl.type.kind === "CSharpTypeEnum" ? "enum" : "class";
+			return children({
+				name: decl.ident,
+				typeName
+			});
+		}
+		case "CSharpDeclReference": return children({ type: /* @__PURE__ */ jsx(Lang.Type, { type: decl.type }) });
+	}
+}
+function Declaration({ decl }) {
+	const Docs = useComponents();
+	const Lang = useLanguageComponents();
+	if (!decl) return null;
+	switch (decl.kind) {
+		case "CSharpDeclConst": return /* @__PURE__ */ jsx(Fragment$1, { children: /* @__PURE__ */ jsx(Docs.Tooltip, {
+			content: JSON.stringify(decl.value),
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TextIdentifier,
+				children: decl.ident
+			})
+		}) });
+		case "CSharpDeclType": {
+			const keyword = decl.type.kind === "CSharpTypeEnum" ? "enum" : "class";
+			return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TextKeyword,
+					children: keyword
+				}),
+				" ",
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TextIdentifier,
+					children: decl.ident
+				}),
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TextPunctuation,
+					children: ":"
+				}),
+				decl.type.kind === "CSharpTypeUnion" && /* @__PURE__ */ jsxs(Fragment$1, { children: [
+					" ",
+					/* @__PURE__ */ jsx(Docs.Tooltip, {
+						content: "A class that can be one of several variants.",
+						children: /* @__PURE__ */ jsx(Docs.Badge, {
+							id: "csharp-union",
+							children: "union"
+						})
+					}),
+					" "
+				] })
+			] });
+		}
+		case "CSharpDeclProperty": return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+			decl.optional === false && /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsx("span", {
+				className: style_default.TextKeyword,
+				children: "required"
+			}), " "] }),
+			/* @__PURE__ */ jsx(Lang.Type, {
+				type: decl.type,
+				optional: decl.optional
+			}),
+			decl.nullable && !("nullable" in decl.type && decl.type.nullable) && /* @__PURE__ */ jsx("span", {
+				className: style_default.TextOperator,
+				children: "?"
+			}),
+			" ",
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextIdentifier,
+				children: decl.ident
+			}),
+			decl.type.kind === "CSharpTypeConstant" && /* @__PURE__ */ jsxs(Fragment$1, { children: [" ", /* @__PURE__ */ jsx(Docs.Tooltip, {
+				content: /* @__PURE__ */ jsx("span", {
+					className: style_default.TextIdentifier,
+					children: decl.type.value
+				}),
+				children: /* @__PURE__ */ jsx(Docs.Badge, {
+					id: "csharp-constant",
+					children: "constant"
+				})
+			})] })
+		] });
+		case "CSharpDeclReference": return /* @__PURE__ */ jsx(Lang.Type, { type: decl.type });
+	}
+}
+
+//#endregion
+export { TypeName as a, Type as i, MethodSignature as n, csharp_exports as o, Property as r, Declaration as t };

package/dist/docs-BmOB2f-I.js

@@ -0,0 +1,61 @@
+import * as React$1 from "react";
+import { jsx } from "react/jsx-runtime";
+
+//#region src/contexts/docs.tsx
+const DocsContextDefaults = {
+	settings: {},
+	language: "node",
+	spec: null
+};
+const DocsContext = React$1.createContext(DocsContextDefaults);
+function useDocs() {
+	return React$1.useContext(DocsContext);
+}
+function useSpec() {
+	return useDocs().spec;
+}
+function useSettings() {
+	return useDocs().settings;
+}
+function useSnippet(stainlessPath, language, variant) {
+	const defaultLanguage = useLanguage();
+	const snippetLanguage = [language ?? defaultLanguage, variant ?? "default"].join(".");
+	return useSpec()?.snippets?.[snippetLanguage]?.[stainlessPath];
+}
+function useDeclaration(stainlessPath, required, language) {
+	const defaultLanguage = useLanguage();
+	const decl = useSpec()?.decls?.[language ?? defaultLanguage]?.[stainlessPath];
+	if (required && !decl) throw new Error(`Declaration not found for '${stainlessPath}'`);
+	return decl;
+}
+function useAvailableLanguages(stainlessPath) {
+	const spec = useSpec();
+	return Object.keys(spec?.decls ?? {}).filter((lang) => spec?.decls?.[lang]?.[stainlessPath] !== void 0);
+}
+function useIgnoredResources() {
+	return ["(resource) webhooks > (model) unwrap_webhook_event > (schema)"];
+}
+function useResource(name) {
+	return useSpec()?.resources?.[name];
+}
+function useLanguage() {
+	return useDocs().language;
+}
+function useContentPanelLayout() {
+	return useDocs().settings?.contentPanelLayout ?? "double-pane";
+}
+function DocsProvider({ spec, language, settings, children }) {
+	const value = {
+		...DocsContextDefaults,
+		spec,
+		settings: settings ?? DocsContextDefaults.settings,
+		language: language ?? DocsContextDefaults.language
+	};
+	return /* @__PURE__ */ jsx(DocsContext.Provider, {
+		value,
+		children
+	});
+}
+
+//#endregion
+export { useDocs as a, useResource as c, useSpec as d, useDeclaration as i, useSettings as l, useAvailableLanguages as n, useIgnoredResources as o, useContentPanelLayout as r, useLanguage as s, DocsProvider as t, useSnippet as u };

package/dist/docs-g4IPmtZr.d.ts

@@ -0,0 +1,48 @@
+import { _ as Spec, m as Resource, u as LanguageDeclNodes, v as SpecLanguage } from "./index-CwjGm9zX.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime46 from "react/jsx-runtime";
+
+//#region src/contexts/docs.d.ts
+type ContentPanelLayout = 'double-pane' | 'single-pane';
+type PropertySettingsType = {
+  types?: 'simple' | 'rich';
+  includeModelProperties?: boolean | 'method-page';
+  collapseDescription?: boolean;
+  showTitle?: boolean;
+  expandDepth?: number;
+};
+type DocsContextType = {
+  language: SpecLanguage;
+  spec: Spec | null;
+  settings?: {
+    properties?: PropertySettingsType;
+    contentPanelLayout?: ContentPanelLayout;
+    virtualExpanders?: boolean;
+  };
+};
+declare function useDocs(): DocsContextType;
+declare function useSpec(): Spec | null;
+declare function useSettings(): {
+  properties?: PropertySettingsType;
+  contentPanelLayout?: ContentPanelLayout;
+  virtualExpanders?: boolean;
+} | undefined;
+declare function useSnippet(stainlessPath: string, language?: SpecLanguage, variant?: string): string | undefined;
+type Declaration = LanguageDeclNodes[SpecLanguage];
+declare function useDeclaration<Required extends boolean>(stainlessPath: string, required: Required, language?: SpecLanguage): (Required extends true ? never : undefined) | Declaration;
+declare function useAvailableLanguages(stainlessPath: string): SpecLanguage[];
+declare function useIgnoredResources(): string[];
+declare function useResource(name: string): Resource | undefined;
+declare function useLanguage(): "http" | "node" | "python" | "go" | "typescript" | "terraform" | "ruby" | "java" | "kotlin" | "csharp" | "php" | "cli";
+declare function useContentPanelLayout(): ContentPanelLayout;
+type DocsProviderProps = DocsContextType & {
+  children: React$1.ReactNode;
+};
+declare function DocsProvider({
+  spec,
+  language,
+  settings,
+  children
+}: DocsProviderProps): react_jsx_runtime46.JSX.Element;
+//#endregion
+export { DocsProviderProps as a, useContentPanelLayout as c, useIgnoredResources as d, useLanguage as f, useSpec as g, useSnippet as h, DocsProvider as i, useDeclaration as l, useSettings as m, Declaration as n, PropertySettingsType as o, useResource as p, DocsContextType as r, useAvailableLanguages as s, ContentPanelLayout as t, useDocs as u };

package/dist/docs-z3fl2eW-.d.ts

@@ -0,0 +1,48 @@
+import { _ as Spec, m as Resource, u as LanguageDeclNodes, v as SpecLanguage } from "./index-CwjGm9zX.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime76 from "react/jsx-runtime";
+
+//#region src/contexts/docs.d.ts
+type ContentPanelLayout = 'double-pane' | 'single-pane';
+type PropertySettingsType = {
+  types?: 'simple' | 'rich';
+  includeModelProperties?: boolean | 'method-page';
+  collapseDescription?: boolean;
+  showTitle?: boolean;
+  expandDepth?: number;
+};
+type DocsContextType = {
+  language: SpecLanguage;
+  spec: Spec | null;
+  settings?: {
+    properties?: PropertySettingsType;
+    contentPanelLayout?: ContentPanelLayout;
+    virtualExpanders?: boolean;
+  };
+};
+declare function useDocs(): DocsContextType;
+declare function useSpec(): Spec | null;
+declare function useSettings(): {
+  properties?: PropertySettingsType;
+  contentPanelLayout?: ContentPanelLayout;
+  virtualExpanders?: boolean;
+} | undefined;
+declare function useSnippet(stainlessPath: string, language?: SpecLanguage, variant?: string): string | undefined;
+type Declaration = LanguageDeclNodes[SpecLanguage];
+declare function useDeclaration<Required extends boolean>(stainlessPath: string, required: Required, language?: SpecLanguage): (Required extends true ? never : undefined) | Declaration;
+declare function useAvailableLanguages(stainlessPath: string): SpecLanguage[];
+declare function useIgnoredResources(): string[];
+declare function useResource(name: string): Resource | undefined;
+declare function useLanguage(): "cli" | "csharp" | "go" | "http" | "java" | "kotlin" | "node" | "php" | "python" | "ruby" | "terraform" | "typescript";
+declare function useContentPanelLayout(): ContentPanelLayout;
+type DocsProviderProps = DocsContextType & {
+  children: React$1.ReactNode;
+};
+declare function DocsProvider({
+  spec,
+  language,
+  settings,
+  children
+}: DocsProviderProps): react_jsx_runtime76.JSX.Element;
+//#endregion
+export { DocsProviderProps as a, useContentPanelLayout as c, useIgnoredResources as d, useLanguage as f, useSpec as g, useSnippet as h, DocsProvider as i, useDeclaration as l, useSettings as m, Declaration as n, PropertySettingsType as o, useResource as p, DocsContextType as r, useAvailableLanguages as s, ContentPanelLayout as t, useDocs as u };