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

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

@@ -0,0 +1,46 @@
+import { c as LanguageDeclNodes, f as Resource, g as SpecLanguage, h as Spec } from "./index-zNpvNvtN.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime21 from "react/jsx-runtime";
+
+//#region src/contexts/docs.d.ts
+type ContentPanelLayout = 'double-pane' | 'single-pane';
+type PropertySettingsType = {
+  types?: 'simple' | 'rich';
+  includeModelProperties?: boolean;
+  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 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_runtime21.JSX.Element;
+//#endregion
+export { DocsProviderProps as a, useDeclaration as c, useResource as d, useSettings as f, DocsProvider as i, useDocs as l, useSpec as m, Declaration as n, PropertySettingsType as o, useSnippet as p, DocsContextType as r, useContentPanelLayout as s, ContentPanelLayout as t, useLanguage as u };

package/dist/docs-DSFRsmbQ.d.ts

@@ -0,0 +1,46 @@
+import { c as LanguageDeclNodes, f as Resource, g as SpecLanguage, h as Spec } from "./index-zNpvNvtN.js";
+import * as React$1 from "react";
+import * as react_jsx_runtime38 from "react/jsx-runtime";
+
+//#region src/contexts/docs.d.ts
+type ContentPanelLayout = 'double-pane' | 'single-pane';
+type PropertySettingsType = {
+  types?: 'simple' | 'rich';
+  includeModelProperties?: boolean;
+  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 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_runtime38.JSX.Element;
+//#endregion
+export { DocsProviderProps as a, useDeclaration as c, useResource as d, useSettings as f, DocsProvider as i, useDocs as l, useSpec as m, Declaration as n, PropertySettingsType as o, useSnippet as p, DocsContextType as r, useContentPanelLayout as s, ContentPanelLayout as t, useLanguage as u };

package/dist/docs-Di94viZV.js

@@ -0,0 +1,54 @@
+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 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 { useLanguage as a, useSnippet as c, useDocs as i, useSpec as l, useContentPanelLayout as n, useResource as o, useDeclaration as r, useSettings as s, DocsProvider as t };

package/dist/go-DuKdRGqU.js

@@ -0,0 +1,303 @@
+import { t as __exportAll } from "./chunk-BN_g-Awi.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 * as React$1 from "react";
+import { Fragment as Fragment$1, jsx, jsxs } from "react/jsx-runtime";
+
+//#region src/languages/go.tsx
+var go_exports = /* @__PURE__ */ __exportAll({
+	Declaration: () => Declaration,
+	MethodSignature: () => MethodSignature,
+	Property: () => Property,
+	Type: () => Type,
+	TypeName: () => TypeName
+});
+const ComplexTypes = {
+	GoTypeMap: "map",
+	GoTypeArray: "array"
+};
+const Keywords = {
+	GoTypeAny: "any",
+	GoTypeUnknown: "unknown",
+	GoTypeInt: "int64",
+	GoTypeFloat: "float64",
+	GoTypeBool: "bool",
+	GoTypeError: "error"
+};
+function isField(type) {
+	return type.kind === "GoTypeReference" && type.typeName === "param.Field";
+}
+function TypeName({ type }) {
+	const Lang = useLanguageComponents();
+	return isField(type) ? "field" : ComplexTypes[type.kind] ?? /* @__PURE__ */ jsx(Lang.Type, { type });
+}
+function Type({ type }) {
+	const Lang = useLanguageComponents();
+	const { Join, SDKReference } = useComponents();
+	switch (type.kind) {
+		case "GoTypeReference": {
+			const params = type.typeParameters?.map((param, key) => /* @__PURE__ */ jsx(Lang.Type, { type: param }, key));
+			return /* @__PURE__ */ jsxs("span", {
+				className: style_default.Type,
+				children: [type.$ref ? /* @__PURE__ */ jsx(SDKReference, {
+					stainlessPath: type.$ref,
+					children: type.typeName
+				}) : 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]
+			});
+		}
+		case "GoTypeAny":
+		case "GoTypeUnknown":
+		case "GoTypeInt":
+		case "GoTypeFloat":
+		case "GoTypeBool":
+		case "GoTypeError": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeKeyword,
+				children: Keywords[type.kind]
+			})
+		});
+		case "GoTypeString": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeString,
+				children: "string"
+			})
+		});
+		case "GoTypeArray": return /* @__PURE__ */ jsxs("span", {
+			className: style_default.Type,
+			children: [/* @__PURE__ */ jsx("span", {
+				className: style_default.TextOperator,
+				children: "[]"
+			}), /* @__PURE__ */ jsx(Lang.Type, { type: type.elementType })]
+		});
+		case "GoTypeStruct": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeKeyword,
+				children: "struct{…}"
+			})
+		});
+		case "GoTypeInterface": return /* @__PURE__ */ jsx("span", {
+			className: style_default.Type,
+			children: /* @__PURE__ */ jsx("span", {
+				className: style_default.TypeKeyword,
+				children: "interface{…}"
+			})
+		});
+		case "GoTypeMap": return /* @__PURE__ */ jsxs("span", {
+			className: style_default.Type,
+			children: [
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TypeKeyword,
+					children: "map"
+				}),
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TypeBracket,
+					children: "["
+				}),
+				/* @__PURE__ */ jsx(Lang.Type, { type: type.indexType }),
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TextPunctuation,
+					children: ","
+				}),
+				" ",
+				/* @__PURE__ */ jsx(Lang.Type, { type: type.itemType }),
+				/* @__PURE__ */ jsx("span", {
+					className: style_default.TypeBracket,
+					children: "]"
+				})
+			]
+		});
+		case "GoTypePointer": return /* @__PURE__ */ jsxs("span", {
+			className: style_default.Type,
+			children: [/* @__PURE__ */ jsx("span", {
+				className: style_default.TextOperator,
+				children: "*"
+			}), /* @__PURE__ */ jsx(Lang.Type, { type: type.inner })]
+		});
+	}
+}
+function MethodSignature({ decl }) {
+	const Lang = useLanguageComponents();
+	const { Join } = useComponents();
+	const params = decl.parameters.map((param, i) => /* @__PURE__ */ jsxs(React$1.Fragment, { children: [/* @__PURE__ */ jsx("span", {
+		className: style_default.TextIdentifier,
+		children: param.ident
+	}), param.optional && /* @__PURE__ */ jsx("span", {
+		className: style_default.TextPunctuation,
+		children: "?"
+	})] }, i));
+	const returns = decl.returnType.map((t, key) => /* @__PURE__ */ jsx(Lang.Type, { type: t }, key));
+	return /* @__PURE__ */ jsx("div", {
+		className: style_default.MethodSignature,
+		children: /* @__PURE__ */ jsxs("span", {
+			className: style_default.SignatureTitle,
+			children: [
+				decl.async && /* @__PURE__ */ jsx("span", {
+					className: style_default.TextKeyword,
+					children: "async "
+				}),
+				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)
+					})
+				}),
+				decl.kind === "GoDeclFunction" && /* @__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: [")", " "]
+						}),
+						decl.returnType.length === 1 ? returns : /* @__PURE__ */ jsxs(Fragment$1, { children: [
+							/* @__PURE__ */ jsx("span", {
+								className: style_default.SignatureParen,
+								children: "("
+							}),
+							/* @__PURE__ */ jsx(Join, {
+								items: returns,
+								children: /* @__PURE__ */ jsx("span", {
+									className: style_default.TextOperator,
+									children: ", "
+								})
+							}),
+							/* @__PURE__ */ jsx("span", {
+								className: style_default.SignatureParen,
+								children: ")"
+							})
+						] })
+					]
+				})
+			]
+		})
+	});
+}
+function Property({ decl, children }) {
+	const Docs = useComponents();
+	const Lang = useLanguageComponents();
+	if (!decl) return null;
+	switch (decl.kind) {
+		case "GoDeclProperty": return children({
+			name: decl.ident,
+			typeName: /* @__PURE__ */ jsx(Lang.TypeName, { type: decl.type }),
+			badges: decl.optional && /* @__PURE__ */ jsx(Docs.Badge, { id: "optional" }),
+			type: (isField(decl.type) || decl.type.kind in ComplexTypes) && /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		});
+		case "GoDeclConst": return children({
+			name: decl.ident,
+			typeName: "const",
+			type: /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		});
+		case "GoDeclReference": return children({ type: /* @__PURE__ */ jsx(Lang.Type, { type: decl.type }) });
+		case "GoDeclType":
+		case "GoDeclTypeAlias": {
+			const typeName = decl.type.kind === "GoTypeStruct" ? "struct" : decl.type.kind === "GoTypeInterface" ? "interface" : decl.kind === "GoDeclTypeAlias" ? "alias" : "type";
+			return children({
+				name: decl.ident,
+				typeName,
+				type: ["GoTypeStruct", "GoTypeInterface"].includes(decl.type.kind) || /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+			});
+		}
+	}
+}
+function Declaration({ decl }) {
+	const Lang = useLanguageComponents();
+	if (!decl) return;
+	switch (decl.kind) {
+		case "GoDeclType": return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextKeyword,
+				children: "type "
+			}),
+			/* @__PURE__ */ jsxs("span", {
+				className: style_default.TextIdentifier,
+				children: [decl.ident, " "]
+			}),
+			/* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		] });
+		case "GoDeclTypeAlias": return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextKeyword,
+				children: "type "
+			}),
+			/* @__PURE__ */ jsxs("span", {
+				className: style_default.TextIdentifier,
+				children: [decl.ident, " "]
+			}),
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextOperator,
+				children: "= "
+			}),
+			/* @__PURE__ */ jsx(Lang.Type, { type: decl.type })
+		] });
+		case "GoDeclProperty": return /* @__PURE__ */ jsxs(Fragment$1, { children: [/* @__PURE__ */ jsx("span", {
+			className: style_default.TypePropertyName,
+			children: /* @__PURE__ */ jsxs("span", {
+				className: style_default.TextIdentifier,
+				children: [decl.ident, " "]
+			})
+		}), /* @__PURE__ */ jsx(Lang.Type, { type: decl.type })] });
+		case "GoDeclReference": return /* @__PURE__ */ jsx(Lang.Type, { type: decl.type });
+		case "GoDeclConst": return /* @__PURE__ */ jsxs(Fragment$1, { children: [
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextKeyword,
+				children: "const "
+			}),
+			/* @__PURE__ */ jsxs("span", {
+				className: style_default.TextIdentifier,
+				children: [decl.ident, " "]
+			}),
+			/* @__PURE__ */ jsx(Lang.Type, { type: decl.type }),
+			/* @__PURE__ */ jsx("span", {
+				className: style_default.TextOperator,
+				children: " = "
+			}),
+			JSON.stringify(decl.value)
+		] });
+	}
+}
+
+//#endregion
+export { TypeName as a, Type as i, MethodSignature as n, go_exports as o, Property as r, Declaration as t };