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

package/dist/routing-Ce0_tBW6.js

@@ -0,0 +1,197 @@
+import { t as __exportAll } from "./chunk-BN_g-Awi.js";
+
+//#region src/routing.ts
+var routing_exports = /* @__PURE__ */ __exportAll({
+	LanguageNames: () => LanguageNames,
+	Languages: () => Languages,
+	SupportedLanguageSyntaxes: () => SupportedLanguageSyntaxes,
+	expandToElement: () => expandToElement,
+	findNavigationPath: () => findNavigationPath,
+	generateRoute: () => generateRoute,
+	generateRouteList: () => generateRouteList,
+	getLanguageSnippet: () => getLanguageSnippet,
+	getResource: () => getResource,
+	isSupportedLanguage: () => isSupportedLanguage,
+	parseRoute: () => parseRoute,
+	parseStainlessPath: () => parseStainlessPath,
+	scrollToPath: () => scrollToPath,
+	trimStainlessPath: () => trimStainlessPath,
+	updateHistory: () => updateHistory,
+	walkTree: () => walkTree
+});
+const Languages = [
+	"http",
+	"node",
+	"python",
+	"go",
+	"typescript",
+	"terraform",
+	"ruby",
+	"java",
+	"kotlin",
+	"csharp",
+	"php",
+	"cli"
+];
+const SupportedLanguageSyntaxes = [
+	"http",
+	"javascript",
+	"python",
+	"go",
+	"typescript",
+	"terraform",
+	"ruby",
+	"java",
+	"kotlin",
+	"csharp",
+	"bash"
+];
+const LanguageNames = {
+	http: "HTTP",
+	node: "TypeScript",
+	typescript: "TypeScript",
+	python: "Python",
+	go: "Go",
+	ruby: "Ruby",
+	java: "Java",
+	kotlin: "Kotlin",
+	terraform: "Terraform",
+	csharp: "C#",
+	php: "PHP",
+	cli: "CLI Tool"
+};
+function getLanguageSnippet(language) {
+	return language === "http" ? "http.curl" : `${language}.default`;
+}
+function isSupportedLanguage(language) {
+	return Languages.includes(language);
+}
+const DefaultLanguage = "http";
+const StainlessPathPattern = /(\(resource\) (?<resource>[^\s]+))( > (\(method\) (?<method>[^\s]+)|\(model\) (?<model>[^\s]+))?)?/;
+function parseStainlessPath(stainlessPath) {
+	const match = stainlessPath.match(StainlessPathPattern);
+	if (!match?.groups) return null;
+	return {
+		resource: match.groups.resource?.split(".") ?? null,
+		method: match.groups.method ?? null,
+		model: match.groups.model ?? null,
+		routable: match.groups.model ? match[1] : match[0]
+	};
+}
+function trimStainlessPath(stainlessPath) {
+	return stainlessPath.replace(/ > \([^\s]+\)$/, "");
+}
+function getResource(stainlessPath) {
+	return parseStainlessPath(stainlessPath)?.resource?.[0];
+}
+function parseRoute(basePath, route) {
+	if (!route.startsWith(basePath)) return {
+		stainlessPath: "",
+		language: DefaultLanguage
+	};
+	if (basePath && route.startsWith(basePath)) route = route.slice(basePath.length);
+	let stainlessPath = "";
+	let elements = route.slice(1).split("/");
+	let language = DefaultLanguage;
+	if (elements[0] && Languages.includes(elements[0])) {
+		language = elements[0];
+		elements = elements.slice(1);
+	}
+	while (elements.length > 0) switch (elements.shift()) {
+		case "resources":
+			stainlessPath += `(resource) ${elements.shift()}`;
+			break;
+		case "subresources":
+			stainlessPath += `.${elements.shift()}`;
+			break;
+		case "methods":
+			stainlessPath += ` > (method) ${elements.shift()}`;
+			break;
+	}
+	return {
+		stainlessPath,
+		language
+	};
+}
+function generateRoute(basePath, language, stainlessPath) {
+	const parsedPath = parseStainlessPath(stainlessPath);
+	if (!parsedPath) return null;
+	const path = [basePath.endsWith("/") ? basePath.slice(0, -1) : basePath];
+	if (language && language !== DefaultLanguage) path.push(language);
+	const resources = parsedPath.resource.flatMap((name, index) => [index > 0 ? "subresources" : "resources", name]);
+	const resourcePath = parsedPath.model ? resources.slice(0, 2) : resources;
+	path.push(...resourcePath);
+	if (parsedPath.method) path.push("methods", parsedPath.method);
+	return stainlessPath.length > parsedPath.routable.length ? `${path.join("/")}#${encodeURIComponent(stainlessPath)}` : path.join("/");
+}
+function* walkResource(resource, path, includeModels) {
+	yield {
+		data: resource,
+		path
+	};
+	for (const data of Object.values(resource.methods)) yield {
+		data,
+		path: [
+			...path,
+			"methods",
+			data.name
+		]
+	};
+	if (includeModels) for (const data of Object.values(resource.models)) yield {
+		data,
+		path: [
+			...path,
+			"models",
+			data.name
+		]
+	};
+	for (const data of Object.values(resource.subresources ?? {})) yield* walkResource(data, [
+		...path,
+		"subresources",
+		data.name
+	]);
+}
+function* walkTree(spec, includeModels) {
+	for (const data of Object.values(spec.resources)) yield* walkResource(data, ["resources", data.name], includeModels);
+}
+function generateRouteList({ spec, languages, excludeLanguages = [] }) {
+	const entries = Array.from(walkTree(spec));
+	return (languages ?? spec.docs?.languages ?? ["http"]).filter((lang) => Languages.includes(lang) && lang !== "terraform").filter((lang) => !excludeLanguages?.includes(lang)).flatMap((language) => entries.map(({ path, data: { title, kind, stainlessPath } }) => ({
+		title,
+		kind,
+		language,
+		stainlessPath,
+		slug: (language === "http" ? path : [language, ...path]).join("/")
+	})));
+}
+function findNavigationPath(items, target) {
+	for (const item of Object.values(items)) {
+		if (item.stainlessPath === target) return [item.stainlessPath];
+		if (item.kind === "http_method") continue;
+		const path = findNavigationPath([...Object.values(item.methods ?? {}), ...Object.values(item.subresources ?? {})], target);
+		if (path) return [item.stainlessPath, ...path];
+	}
+}
+function expandToElement(el) {
+	while (el) {
+		if (el instanceof HTMLDetailsElement) el.open = true;
+		el = el.parentElement;
+	}
+}
+function scrollToPath(stainlessPath) {
+	const el = document.getElementById(stainlessPath);
+	if (el) {
+		expandToElement(el);
+		el.scrollIntoView({ behavior: "smooth" });
+	}
+}
+function updateHistory(basePath, language, stainlessPath) {
+	const path = generateRoute(basePath, language, stainlessPath);
+	window.history.pushState({
+		stainlessPath,
+		language
+	}, "", path);
+}
+
+//#endregion
+export { walkTree as _, findNavigationPath as a, getLanguageSnippet as c, parseRoute as d, parseStainlessPath as f, updateHistory as g, trimStainlessPath as h, expandToElement as i, getResource as l, scrollToPath as m, Languages as n, generateRoute as o, routing_exports as p, SupportedLanguageSyntaxes as r, generateRouteList as s, LanguageNames as t, isSupportedLanguage as u };

package/dist/routing-CtbZJru_.d.ts

@@ -0,0 +1,54 @@
+import { f as Resource, h as Spec, l as Method, u as Model } from "./index-zNpvNvtN.js";
+
+//#region src/routing.d.ts
+declare namespace routing_d_exports {
+  export { DocsLanguage, LanguageNames, Languages, ParsedStainlessPath, RouteEntry, SpecTreeEntry, SupportedLanguageSyntaxes, expandToElement, findNavigationPath, generateRoute, generateRouteList, getLanguageSnippet, getResource, isSupportedLanguage, parseRoute, parseStainlessPath, scrollToPath, trimStainlessPath, updateHistory, walkTree };
+}
+declare const Languages: readonly ["http", "node", "python", "go", "typescript", "terraform", "ruby", "java", "kotlin", "csharp", "php", "cli"];
+declare const SupportedLanguageSyntaxes: string[];
+type DocsLanguage = (typeof Languages)[number];
+declare const LanguageNames: Record<DocsLanguage, string>;
+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): {
+  resource: string[] | null;
+  method: string | null;
+  model: string | null;
+  routable: string | undefined;
+} | null;
+declare function trimStainlessPath(stainlessPath: string): string;
+declare function getResource(stainlessPath: string): string | undefined;
+declare function parseRoute(basePath: string, route: string): {
+  stainlessPath: string;
+  language: DocsLanguage;
+};
+declare function generateRoute(basePath: string, language: string, stainlessPath: string): string | null;
+type SpecTreeEntry = {
+  data: Method | Resource | Model;
+  path: string[];
+};
+declare function walkTree(spec: Spec, includeModels?: boolean): Generator<SpecTreeEntry, void, any>;
+type RouteEntry = {
+  title: string;
+  kind: SpecTreeEntry['data']['kind'];
+  language: DocsLanguage;
+  stainlessPath: string;
+  slug: string;
+};
+declare function generateRouteList({
+  spec,
+  languages,
+  excludeLanguages
+}: {
+  spec: Spec;
+  languages?: DocsLanguage[];
+  excludeLanguages?: DocsLanguage[];
+}): RouteEntry[];
+type ResourceOrMethod = Resource | Method;
+declare function findNavigationPath(items: ResourceOrMethod[], target: string): string[] | undefined;
+declare function expandToElement(el: HTMLElement | null): void;
+declare function scrollToPath(stainlessPath: string): void;
+declare function updateHistory(basePath: string, language: DocsLanguage, stainlessPath: string): void;
+//#endregion
+export { routing_d_exports as _, RouteEntry as a, updateHistory as b, expandToElement as c, generateRouteList as d, getLanguageSnippet as f, parseStainlessPath as g, parseRoute as h, ParsedStainlessPath as i, findNavigationPath as l, isSupportedLanguage as m, LanguageNames as n, SpecTreeEntry as o, getResource as p, Languages as r, SupportedLanguageSyntaxes as s, DocsLanguage as t, generateRoute as u, scrollToPath as v, walkTree as x, trimStainlessPath as y };

package/dist/routing.d.ts

@@ -0,0 +1,2 @@
+import { a as RouteEntry, b as updateHistory, c as expandToElement, d as generateRouteList, f as getLanguageSnippet, g as parseStainlessPath, h as parseRoute, i as ParsedStainlessPath, l as findNavigationPath, m as isSupportedLanguage, n as LanguageNames, o as SpecTreeEntry, p as getResource, r as Languages, s as SupportedLanguageSyntaxes, t as DocsLanguage, u as generateRoute, v as scrollToPath, x as walkTree, y as trimStainlessPath } from "./routing-CtbZJru_.js";
+export { DocsLanguage, LanguageNames, Languages, ParsedStainlessPath, RouteEntry, SpecTreeEntry, SupportedLanguageSyntaxes, expandToElement, findNavigationPath, generateRoute, generateRouteList, getLanguageSnippet, getResource, isSupportedLanguage, parseRoute, parseStainlessPath, scrollToPath, trimStainlessPath, updateHistory, walkTree };

package/dist/routing.js

@@ -1,180 +1,3 @@
-// src/routing.ts
-var Languages = [
-  "http",
-  "node",
-  "python",
-  "go",
-  "typescript",
-  "terraform",
-  "ruby",
-  "java",
-  "kotlin"
-];
-var SupportedLanguageSyntaxes = [
-  "http",
-  "javascript",
-  "python",
-  "go",
-  "typescript",
-  "terraform",
-  "ruby",
-  "java",
-  "kotlin"
-];
-var LanguageNames = {
-  http: "HTTP",
-  node: "TypeScript",
-  typescript: "TypeScript",
-  python: "Python",
-  go: "Go",
-  ruby: "Ruby",
-  java: "Java",
-  kotlin: "Kotlin",
-  terraform: "Terraform"
-};
-function getLanguageSnippet(language) {
-  return language === "http" ? "http.curl" : `${language}.default`;
-}
-function isSupportedLanguage(language) {
-  return Languages.includes(language);
-}
-var DefaultLanguage = "http";
-var StainlessPathPattern = /(\(resource\) (?<resource>[^\s]+))( > (\(method\) (?<method>[^\s]+)|\(model\) (?<model>[^\s]+))?)?/;
-function parseStainlessPath(stainlessPath) {
-  const match = stainlessPath.match(StainlessPathPattern);
-  if (!match) return null;
-  return {
-    resource: match.groups.resource.split("."),
-    method: match.groups.method ?? null,
-    model: match.groups.model ?? null,
-    routable: match.groups.model ? match[1] : match[0]
-  };
-}
-function trimStainlessPath(stainlessPath) {
-  return stainlessPath.replace(/ > \([^\s]+\)$/, "");
-}
-function getResource(stainlessPath) {
-  const parsed = parseStainlessPath(stainlessPath);
-  return parsed?.resource[0];
-}
-function parseRoute(basePath, route) {
-  if (!route.startsWith(basePath)) return { stainlessPath: "", language: DefaultLanguage };
-  if (basePath && route.startsWith(basePath)) route = route.slice(basePath.length);
-  let stainlessPath = "";
-  let elements = route.slice(1).split("/");
-  let language = DefaultLanguage;
-  if (elements[0] && Languages.includes(elements[0])) {
-    language = elements[0];
-    elements = elements.slice(1);
-  }
-  while (elements.length > 0) {
-    const element = elements.shift();
-    switch (element) {
-      case "resources":
-        stainlessPath += `(resource) ${elements.shift()}`;
-        break;
-      case "subresources":
-        stainlessPath += `.${elements.shift()}`;
-        break;
-      case "methods":
-        stainlessPath += ` > (method) ${elements.shift()}`;
-        break;
-    }
-  }
-  return { stainlessPath, language };
-}
-function generateRoute(basePath, language, stainlessPath) {
-  const parsedPath = parseStainlessPath(stainlessPath);
-  if (!parsedPath) return null;
-  const path = [basePath.endsWith("/") ? basePath.slice(0, -1) : basePath];
-  if (language && language !== DefaultLanguage) path.push(language);
-  const resources = parsedPath.resource.flatMap((name, index) => [
-    index > 0 ? "subresources" : "resources",
-    name
-  ]);
-  const resourcePath = parsedPath.model ? resources.slice(0, 2) : resources;
-  path.push(...resourcePath);
-  if (parsedPath.method) path.push("methods", parsedPath.method);
-  return stainlessPath.length > parsedPath.routable.length ? `${path.join("/")}#${encodeURIComponent(stainlessPath)}` : path.join("/");
-}
-function* walkResource(resource, path, includeModels) {
-  yield { data: resource, path };
-  for (const data of Object.values(resource.methods)) {
-    yield { data, path: [...path, "methods", data.name] };
-  }
-  if (includeModels)
-    for (const data of Object.values(resource.models)) {
-      yield { data, path: [...path, "models", data.name] };
-    }
-  for (const data of Object.values(resource.subresources ?? {})) {
-    yield* walkResource(data, [...path, "subresources", data.name]);
-  }
-}
-function* walkTree(spec, includeModels) {
-  for (const data of Object.values(spec.resources)) {
-    yield* walkResource(data, ["resources", data.name], includeModels);
-  }
-}
-function generateRouteList({
-  spec,
-  languages,
-  excludeLanguages = []
-}) {
-  const entries = Array.from(walkTree(spec));
-  const langs = languages ?? spec.docs?.languages ?? ["http"];
-  return langs.filter((lang) => Languages.includes(lang) && lang !== "terraform").filter((lang) => !excludeLanguages?.includes(lang)).flatMap(
-    (language) => entries.map(({ path, data: { title, kind, stainlessPath } }) => ({
-      title,
-      kind,
-      language,
-      stainlessPath,
-      slug: (language === "http" ? path : [language, ...path]).join("/")
-    }))
-  );
-}
-function findNavigationPath(items, target) {
-  for (const item of Object.values(items)) {
-    if (item.stainlessPath === target) return [item.stainlessPath];
-    if (item.kind === "http_method") continue;
-    const path = findNavigationPath(
-      [...Object.values(item.methods ?? {}), ...Object.values(item.subresources ?? {})],
-      target
-    );
-    if (path) return [item.stainlessPath, ...path];
-  }
-}
-function expandToElement(el) {
-  while (el) {
-    if (el.tagName === "DETAILS") el["open"] = true;
-    el = el.parentElement;
-  }
-}
-function scrollToPath(stainlessPath) {
-  const el = document.getElementById(stainlessPath);
-  if (el) {
-    expandToElement(el);
-    el.scrollIntoView({ behavior: "smooth" });
-  }
-}
-function updateHistory(basePath, language, stainlessPath) {
-  const path = generateRoute(basePath, language, stainlessPath);
-  window.history.pushState({ stainlessPath, language }, "", path);
-}
-export {
-  LanguageNames,
-  Languages,
-  SupportedLanguageSyntaxes,
-  expandToElement,
-  findNavigationPath,
-  generateRoute,
-  generateRouteList,
-  getLanguageSnippet,
-  getResource,
-  isSupportedLanguage,
-  parseRoute,
-  parseStainlessPath,
-  scrollToPath,
-  trimStainlessPath,
-  updateHistory,
-  walkTree
-};
+import { _ as walkTree, a as findNavigationPath, c as getLanguageSnippet, d as parseRoute, f as parseStainlessPath, g as updateHistory, h as trimStainlessPath, i as expandToElement, l as getResource, m as scrollToPath, n as Languages, o as generateRoute, r as SupportedLanguageSyntaxes, s as generateRouteList, t as LanguageNames, u as isSupportedLanguage } from "./routing-Ce0_tBW6.js";
+
+export { LanguageNames, Languages, SupportedLanguageSyntaxes, expandToElement, findNavigationPath, generateRoute, generateRouteList, getLanguageSnippet, getResource, isSupportedLanguage, parseRoute, parseStainlessPath, scrollToPath, trimStainlessPath, updateHistory, walkTree };