@stainless-api/docs-ui 0.1.0-beta.82 → 0.1.0-beta.83

package/dist/components/primitives.d.ts

@@ -58,7 +58,7 @@ type TooltipProps = {
 declare function Tooltip({
   content,
   children
-}: TooltipProps): string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | react.ReactPortal | react.ReactElement<unknown, string | react.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | react_jsx_runtime0.JSX.Element | null | undefined;
+}: TooltipProps): string | number | bigint | boolean | react_jsx_runtime0.JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | react.ReactPortal | react.ReactElement<unknown, string | react.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;
 type LinkProps = {
   stainlessPath?: string;
   scroll?: boolean;
@@ -69,7 +69,7 @@ declare function Link({
   scroll,
   children,
   ...props
-}: LinkProps): string | number | bigint | boolean | Iterable<ReactNode> | Promise<string | number | bigint | boolean | react.ReactPortal | react.ReactElement<unknown, string | react.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | react_jsx_runtime0.JSX.Element | null | undefined;
+}: LinkProps): string | number | bigint | boolean | react_jsx_runtime0.JSX.Element | Iterable<ReactNode> | Promise<string | number | bigint | boolean | react.ReactPortal | react.ReactElement<unknown, string | react.JSXElementConstructor<any>> | Iterable<ReactNode> | null | undefined> | null | undefined;
 type InputProps = {
   left?: ReactNode;
   right?: ReactNode;

package/dist/components/sdk.d.ts

@@ -108,7 +108,7 @@ type SDKReferenceProps = {
 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_runtime0.JSX.Element | null | undefined;
+}: SDKReferenceProps): string | number | bigint | boolean | react_jsx_runtime0.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;

package/dist/contexts/docs.d.ts

@@ -47,7 +47,7 @@ declare function useDeclaration<Required extends boolean>(stainlessPath: string,
 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 useLanguage(): "http" | "node" | "python" | "go" | "typescript" | "terraform" | "ruby" | "java" | "kotlin" | "csharp" | "php" | "cli";
 declare function useContentPanelLayout(): ContentPanelLayout;
 type DocsProviderProps = DocsContextType & {
   children: React$1.ReactNode;

package/dist/markdown/index.js

@@ -1,6 +1,6 @@
 import "../use-strict-context-L0c8JKg4.js";
 import { code, fence, heading, item, list, paragraph, parse, strong, text } from "./md.js";
-import { getDecl, getSnippet, stripMarkup } from "./utils.js";
+import { getCustomSnippetTitle, getDecl, getSnippets, stripMarkup } from "./utils.js";
 import { declaration as declaration$1, methodSignature, t as printer_exports } from "./printer.js";
 import Markdoc from "@markdoc/markdoc";
 
@@ -27,7 +27,7 @@ function renderMethod(env, method) {
 	const signature = methodSignature(env.language, decl);
 	const [httpMethod, endpoint] = method.endpoint.split(" ");
 	const output = [
-		heading(2, method.title),
+		heading(2, method.summary ?? method.title),
 		...env.language === "http" ? [] : [paragraph(code(stripMarkup(signature)))],
 		paragraph(strong(text(httpMethod)), text(" "), code(endpoint))
 	];
@@ -47,8 +47,14 @@ function renderMethod(env, method) {
 	}
 	if ("paramsChildren" in decl && Array.isArray(decl.paramsChildren) && decl.paramsChildren.length > 0) output.push(heading(3, "Parameters"), renderChildren(env, decl.paramsChildren));
 	if ("responseChildren" in decl && decl.responseChildren && decl.responseChildren.length > 0) output.push(heading(3, "Returns"), renderChildren(env, decl.responseChildren));
-	const snippet = getSnippet(env, method.stainlessPath);
-	if (snippet) output.push(heading(3, "Example"), fence(env.language, snippet));
+	const snippetEntries = getSnippets(env, method.stainlessPath);
+	for (const [key, { snippet, response }] of Object.entries(snippetEntries)) {
+		if (!snippet) continue;
+		let title = getCustomSnippetTitle(key);
+		if (title.toLowerCase() === "default") title = "Example";
+		output.push(heading(3, title), fence(env.language, snippet));
+		if (response) output.push(heading(4, "Response"), fence("json", response));
+	}
 	return output;
 }
 function renderModel(env, model) {

package/dist/markdown/utils.d.ts

@@ -15,7 +15,14 @@ type EnvironmentType = {
   };
 };
 declare function getDecl(env: EnvironmentType, path: string): LanguageDeclNodes[SpecLanguage] | undefined;
-declare function getSnippet(env: EnvironmentType, path: string, snippetId?: 'default' | `custom:${string}`): string | undefined;
+declare const customSnippetPrefix = "custom:";
+declare const getCustomSnippetTitle: (snippetId: string) => string;
+declare function getSnippets(env: EnvironmentType, path: string): {
+  [k: string]: {
+    snippet: string;
+    response: string | undefined;
+  };
+};
 declare function stripMarkup(content: string): string;
 //#endregion
-export { EnvironmentType, getDecl, getSnippet, stripMarkup };
+export { EnvironmentType, customSnippetPrefix, getCustomSnippetTitle, getDecl, getSnippets, stripMarkup };

package/dist/markdown/utils.js

@@ -10,14 +10,16 @@ function getDecl(env, path) {
 	}
 	return decl;
 }
-function getSnippet(env, path, snippetId = "default") {
+const customSnippetPrefix = "custom:";
+const getCustomSnippetTitle = (snippetId) => snippetId.startsWith(customSnippetPrefix) ? snippetId.slice(7) : snippetId;
+function getSnippets(env, path) {
 	const lang = env.language === "http" ? "http.curl" : `${env.language}.default`;
-	let snippet = env.spec?.snippets?.[lang]?.[path]?.[snippetId]?.content;
-	if (snippet && env.transforms?.transformRequestSnippet) snippet = env.transforms.transformRequestSnippet({
-		snippet,
-		language: env.language
-	});
-	return snippet;
+	const snippets = env.spec?.snippets?.[lang]?.[path];
+	const responses = env.spec?.snippetResponses?.http?.[path];
+	return Object.fromEntries(Object.entries(snippets ?? {}).map(([key, snippet]) => [key, {
+		snippet: snippet.content,
+		response: responses?.[key]?.[0]?.content
+	}]));
 }
 function stripMarkup(content) {
 	let output = "";
@@ -28,4 +30,4 @@ function stripMarkup(content) {
 }
 
 //#endregion
-export { getDecl, getSnippet, stripMarkup };
+export { customSnippetPrefix, getCustomSnippetTitle, getDecl, getSnippets, stripMarkup };

package/dist/routing.d.ts

@@ -8,7 +8,7 @@ declare const Languages: readonly ["http", "node", "python", "go", "typescript",
 declare const SupportedLanguageSyntaxes: string[];
 type DocsLanguage = (typeof Languages)[number];
 declare const LanguageNames: Record<DocsLanguage, string>;
-declare function getLanguageSnippet(language: DocsLanguage): "http.curl" | "cli.default" | "csharp.default" | "go.default" | "java.default" | "kotlin.default" | "node.default" | "php.default" | "python.default" | "ruby.default" | "terraform.default" | "typescript.default";
+declare function getLanguageSnippet(language: DocsLanguage): "http.curl" | "node.default" | "python.default" | "go.default" | "typescript.default" | "terraform.default" | "ruby.default" | "java.default" | "kotlin.default" | "csharp.default" | "php.default" | "cli.default";
 declare function isSupportedLanguage(language: string): language is DocsLanguage;
 type ParsedStainlessPath = ReturnType<typeof parseStainlessPath>;
 declare function parseStainlessPath(stainlessPath: string): {

package/dist/spec.d.ts

@@ -36,13 +36,13 @@ declare function generateNavigation(resource: Partial<Resource>): {
 declare function generateSpecForResource(spec: Spec, name: string, lang: DocsLanguage, transforms: SpecTransforms): Partial<Spec>;
 declare function transform(spec: Spec, transforms: SpecTransforms): {
   name: string;
-  lang: "cli" | "csharp" | "go" | "http" | "java" | "kotlin" | "node" | "php" | "python" | "ruby" | "terraform" | "typescript";
+  lang: "http" | "node" | "python" | "go" | "typescript" | "terraform" | "ruby" | "java" | "kotlin" | "csharp" | "php" | "cli";
   spec: Partial<Spec>;
 }[];
 declare function split(spec: Spec, transforms?: SpecTransforms): {
   resources: ReturnType<typeof transform>;
   navigation: {
-    languages: ("cli" | "csharp" | "go" | "http" | "java" | "kotlin" | "node" | "php" | "python" | "ruby" | "terraform" | "typescript" | "sql" | "openapi")[] | undefined;
+    languages: ("http" | "node" | "python" | "go" | "typescript" | "terraform" | "ruby" | "java" | "kotlin" | "csharp" | "php" | "cli" | "sql" | "openapi")[] | undefined;
     resources: {
       [k: string]: {
         title: string | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stainless-api/docs-ui",
   "private": false,
-  "version": "0.1.0-beta.82",
+  "version": "0.1.0-beta.83",
   "publishConfig": {
     "access": "public"
   },