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

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/styles/primitives.css

@@ -511,7 +511,7 @@
   }
 
   /* show link button when expander summary is hovered */
-  & > .stldocs-expander:has(> .stldocs-expander-summary:is(:hover, :focus-within)) + .stldocs-deep-link-button,
+  & > .stldocs-expander:has(> .stldocs-expander-summary:hover) + .stldocs-deep-link-button,
   /* show link button when non-expander rows are hovered */
   &:not(:has(> .stldocs-expander)):hover > .stldocs-deep-link-button,
   /* keep it visible when it itself is hovered or focused */

package/dist/styles.css

@@ -1903,7 +1903,7 @@ a.stl-ui-button {
   }
 
   /* show link button when expander summary is hovered */
-  & > .stldocs-expander:has(> .stldocs-expander-summary:is(:hover, :focus-within)) + .stldocs-deep-link-button,
+  & > .stldocs-expander:has(> .stldocs-expander-summary:hover) + .stldocs-deep-link-button,
   /* show link button when non-expander rows are hovered */
   &:not(:has(> .stldocs-expander)):hover > .stldocs-deep-link-button,
   /* keep it visible when it itself is hovered or focused */

package/package.json

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