@stainless-api/docs-ui 0.1.0-beta.9 → 0.1.0-beta.91

package/dist/markdown/utils.d.ts

@@ -0,0 +1,28 @@
+import { u as LanguageDeclNodes, v as Spec, y as SpecLanguage } from "../index-DFr9Mesr.js";
+import { t as DocsLanguage } from "../routing-yTSG7nWM.js";
+import { E as TransformRequestSnippetFn } from "../sdk-BengV7mg.js";
+
+//#region src/markdown/utils.d.ts
+type EnvironmentType = {
+  spec: Spec;
+  language: DocsLanguage;
+  transforms?: {
+    transformRequestSnippet?: TransformRequestSnippetFn;
+  };
+  options: {
+    renderNestedResources?: boolean;
+    includeModelProperties?: boolean | 'method-page';
+  };
+};
+declare function getDecl(env: EnvironmentType, path: string): LanguageDeclNodes[SpecLanguage] | 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, customSnippetPrefix, getCustomSnippetTitle, getDecl, getSnippets, stripMarkup };

package/dist/markdown/utils.js

@@ -0,0 +1,31 @@
+import { Parser } from "htmlparser2";
+//#region src/markdown/utils.ts
+function getDecl(env, path) {
+	const decl = env.spec?.decls?.[env.language]?.[path];
+	if (decl?.kind?.endsWith("Reference")) {
+		const refId = "type" in decl && typeof decl["type"] === "object" && "$ref" in decl["type"] ? decl["type"]["$ref"] : null;
+		if (refId === path) return decl;
+		if (refId) return getDecl(env, refId);
+	}
+	return decl;
+}
+const customSnippetPrefix = "custom:";
+const getCustomSnippetTitle = (snippetId) => snippetId.startsWith("custom:") ? snippetId.slice(7) : snippetId;
+function getSnippets(env, path) {
+	const lang = env.language === "http" ? "http.curl" : `${env.language}.default`;
+	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 = "";
+	new Parser({ ontext(content) {
+		output += content;
+	} }).parseComplete(content);
+	return output;
+}
+//#endregion
+export { customSnippetPrefix, getCustomSnippetTitle, getDecl, getSnippets, stripMarkup };

package/dist/markdown-B30HO-Vy.d.ts

@@ -0,0 +1,33 @@
+import React from "react";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/contexts/markdown.d.ts
+type MarkdownContextValue = {
+  highlight: (content: string, language: string) => string | Promise<string>;
+  render: (content: string) => string | Promise<string>;
+};
+declare const MarkdownContext: React.Context<MarkdownContextValue>;
+declare const useMarkdownContext: () => MarkdownContextValue;
+declare function useRenderMarkdown(content?: string): string | undefined;
+declare function useHighlight(content: string, language?: string): string;
+type MarkdownProviderProps = MarkdownContextValue & {
+  children: React.ReactNode;
+};
+declare function MarkdownProvider({
+  render,
+  highlight,
+  children
+}: MarkdownProviderProps): _$react_jsx_runtime0.JSX.Element;
+declare function SuspensefulMarkdownProviderInner({
+  value,
+  children
+}: {
+  value: Promise<MarkdownContextValue>;
+  children: React.ReactNode;
+}): _$react_jsx_runtime0.JSX.Element;
+declare function SuspensefulMarkdownProvider({
+  value,
+  children
+}: React.ComponentProps<typeof SuspensefulMarkdownProviderInner>): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+export { SuspensefulMarkdownProvider as a, useRenderMarkdown as c, MarkdownProviderProps as i, MarkdownContextValue as n, useHighlight as o, MarkdownProvider as r, useMarkdownContext as s, MarkdownContext as t };

package/dist/method-BKJnP-rW.d.ts

@@ -0,0 +1,59 @@
+import * as React$1 from "react";
+import { ReactNode } from "react";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/components/method.d.ts
+type MethodHeaderProps = {
+  title: ReactNode;
+  level?: 'h1' | 'h2' | 'h3' | 'h4' | 'h5';
+  signature?: ReactNode;
+  badges?: ReactNode;
+  children?: ReactNode;
+};
+declare function MethodHeader({
+  title,
+  badges,
+  signature,
+  children,
+  level
+}: MethodHeaderProps): _$react_jsx_runtime0.JSX.Element;
+type MethodRouteProps = {
+  httpMethod?: string;
+  endpoint?: string | ReactNode;
+  iconOnly?: boolean;
+};
+declare function MethodRoute({
+  httpMethod,
+  endpoint,
+  iconOnly
+}: MethodRouteProps): _$react_jsx_runtime0.JSX.Element;
+type MethodDescriptionProps = {
+  description?: string;
+};
+declare function MethodDescription({
+  description
+}: MethodDescriptionProps): _$react_jsx_runtime0.JSX.Element | undefined;
+type MethodInfoProps = {
+  children?: ReactNode;
+  parameters?: ReactNode;
+  returns?: ReactNode;
+};
+declare function MethodInfo({
+  children,
+  parameters,
+  returns
+}: MethodInfoProps): _$react_jsx_runtime0.JSX.Element;
+type MethodProps = {
+  id?: string;
+  header?: ReactNode;
+  children?: ReactNode;
+} & React$1.HTMLProps<HTMLDivElement>;
+declare function Method({
+  id,
+  header,
+  children,
+  className,
+  ...props
+}: MethodProps): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+export { MethodHeaderProps as a, MethodProps as c, MethodHeader as i, MethodRoute as l, MethodDescription as n, MethodInfo as o, MethodDescriptionProps as r, MethodInfoProps as s, Method as t, MethodRouteProps as u };

package/dist/navigation-DGl8lR6w.d.ts

@@ -0,0 +1,29 @@
+import { t as DocsLanguage } from "./routing-yTSG7nWM.js";
+import * as React$1 from "react";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/contexts/navigation.d.ts
+type NavigationHandler = (ev: React$1.MouseEvent | null, opts: {
+  href: string;
+  language: DocsLanguage;
+  stainlessPath: string;
+  scroll: boolean;
+}) => void;
+type NavigationContextType = {
+  basePath?: string;
+  selectedPath?: string;
+  navigationPath?: string[];
+  onNavigate?: NavigationHandler;
+};
+declare function useNavigation(): NavigationContextType;
+type NavigationProviderProps = NavigationContextType & {
+  children: React$1.ReactNode;
+};
+declare function NavigationProvider({
+  basePath,
+  selectedPath,
+  onNavigate,
+  children
+}: NavigationProviderProps): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+export { useNavigation as a, NavigationProviderProps as i, NavigationHandler as n, NavigationProvider as r, NavigationContextType as t };

package/dist/overview-iH1evPEF.d.ts

@@ -0,0 +1,39 @@
+import { d as Method, h as Resource } from "./index-DFr9Mesr.js";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/components/overview.d.ts
+type SDKResourceProps = {
+  resource: Resource;
+  parents?: Resource[];
+};
+declare function SDKResourceHeader({
+  resource,
+  parents
+}: SDKResourceProps): _$react_jsx_runtime0.JSX.Element | null;
+type SDKMethodSummaryProps = {
+  method: Method;
+};
+declare function SDKMethodSummary({
+  method
+}: SDKMethodSummaryProps): _$react_jsx_runtime0.JSX.Element;
+declare function SDKResource({
+  resource,
+  parents,
+  showModels
+}: SDKResourceProps & {
+  showModels?: boolean;
+}): _$react_jsx_runtime0.JSX.Element;
+type SDKOverviewProps = {
+  resource: Resource;
+};
+declare function SDKOverview({
+  resource
+}: SDKOverviewProps): _$react_jsx_runtime0.JSX.Element;
+type SDKRootProps = {
+  stainlessPath: string;
+};
+declare function SDKRoot({
+  stainlessPath
+}: SDKRootProps): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+export { SDKResource as a, SDKRoot as c, SDKOverviewProps as i, SDKRootProps as l, SDKMethodSummaryProps as n, SDKResourceHeader as o, SDKOverview as r, SDKResourceProps as s, SDKMethodSummary as t };

package/dist/primitives-BHt-BuLf.d.ts

@@ -0,0 +1,107 @@
+import * as _$react from "react";
+import { ReactNode } from "react";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/components/primitives.d.ts
+type JoinProps = {
+  items: ReactNode[];
+  limit?: number;
+  children: ReactNode;
+};
+declare function Join({
+  items,
+  limit,
+  children
+}: JoinProps): _$react_jsx_runtime0.JSX.Element[];
+type ExpanderProps = {
+  id?: string;
+  open?: boolean;
+  summary: ReactNode;
+  virtual?: boolean;
+  muted?: boolean;
+  children?: ReactNode;
+};
+declare function Expander({
+  id,
+  open,
+  summary,
+  virtual,
+  muted,
+  children
+}: ExpanderProps): _$react_jsx_runtime0.JSX.Element;
+declare function VirtualExpander({
+  id,
+  open: isOpen,
+  muted,
+  summary,
+  children
+}: Omit<ExpanderProps, 'virtual'>): _$react_jsx_runtime0.JSX.Element;
+declare function Markdown({
+  content,
+  style: cssStyle
+}: {
+  content: string;
+  style?: React.CSSProperties;
+}): "" | _$react_jsx_runtime0.JSX.Element | undefined;
+type BadgeProps = {
+  id: string;
+  children?: ReactNode;
+};
+declare function Badge({
+  id,
+  children
+}: BadgeProps): _$react_jsx_runtime0.JSX.Element;
+type TooltipProps = {
+  content: ReactNode;
+  children: ReactNode;
+};
+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;
+type LinkProps = {
+  stainlessPath?: string;
+  scroll?: boolean;
+  children?: ReactNode;
+} & React.HTMLProps<HTMLAnchorElement>;
+declare function Link({
+  stainlessPath,
+  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;
+type InputProps = {
+  left?: ReactNode;
+  right?: ReactNode;
+  ref?: React.Ref<HTMLInputElement>;
+} & React.InputHTMLAttributes<HTMLInputElement>;
+declare function Input({
+  left,
+  right,
+  ref,
+  className,
+  ...props
+}: InputProps): _$react_jsx_runtime0.JSX.Element;
+type ToggleButtonProps = {
+  children?: ReactNode;
+  selected?: boolean;
+} & React.ComponentProps<'button'>;
+declare function ToggleButton({
+  children,
+  selected,
+  ref,
+  ...props
+}: ToggleButtonProps): _$react_jsx_runtime0.JSX.Element;
+type ListViewProps<TItem> = {
+  items: Array<TItem>;
+  itemDelegate: (item: TItem, selected: boolean) => React.ReactNode;
+  onSelectListItem?: (item: TItem) => void;
+} & React.HTMLAttributes<HTMLDivElement>;
+declare function ListView<TItem>({
+  items,
+  itemDelegate,
+  onSelectListItem,
+  ...rest
+}: ListViewProps<TItem>): _$react_jsx_runtime0.JSX.Element;
+//#endregion
+export { Join as a, ListViewProps as c, ToggleButtonProps as d, Tooltip as f, InputProps as i, Markdown as l, Expander as n, Link as o, VirtualExpander as p, Input as r, ListView as s, Badge as t, ToggleButton as u };

package/dist/properties-CCbMRhSX.d.ts

@@ -0,0 +1,54 @@
+import { ReactNode } from "react";
+import * as _$react_jsx_runtime0 from "react/jsx-runtime";
+
+//#region src/components/properties.d.ts
+type PropertyToggleProps = {
+  target: string;
+};
+declare function PropertyToggle({
+  target
+}: PropertyToggleProps): _$react_jsx_runtime0.JSX.Element;
+type PropertyDescriptionProps = {
+  description?: string;
+};
+declare function PropertyDescription({
+  description
+}: PropertyDescriptionProps): _$react_jsx_runtime0.JSX.Element | undefined;
+type PropertyTitleProps = {
+  title?: string;
+};
+declare function PropertyTitle({
+  title
+}: PropertyTitleProps): _$react_jsx_runtime0.JSX.Element | undefined;
+type PropertyProps = {
+  id?: string;
+  name?: ReactNode;
+  typeName?: ReactNode;
+  badges?: ReactNode;
+  type?: ReactNode;
+  description?: string;
+  title?: string;
+  expand?: boolean;
+  deprecated?: boolean | string;
+  additional?: ReactNode;
+  declaration?: ReactNode;
+  constraints?: ReactNode;
+  children?: ReactNode;
+};
+declare function Property({
+  id,
+  name,
+  typeName,
+  badges,
+  type,
+  declaration,
+  description,
+  title,
+  deprecated,
+  expand,
+  additional,
+  constraints,
+  children
+}: PropertyProps): _$react_jsx_runtime0.JSX.Element | null;
+//#endregion
+export { PropertyTitle as a, PropertyToggleProps as c, PropertyProps as i, PropertyDescription as n, PropertyTitleProps as o, PropertyDescriptionProps as r, PropertyToggle as s, Property as t };

package/dist/routing-yTSG7nWM.d.ts

@@ -0,0 +1,61 @@
+import { d as Method, f as Model, h as Resource, v as Spec } from "./index-DFr9Mesr.js";
+
+//#region src/routing.d.ts
+declare namespace routing_d_exports {
+  export { DocsLanguage, LanguageNames, Languages, ParsedStainlessPath, RouteEntry, SpecTreeEntry, SupportedLanguageSyntaxes, expandToElement, findNavigationPath, generateMissingRouteList, 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[];
+declare function generateMissingRouteList({
+  spec,
+  basePath
+}: {
+  spec: Spec;
+  basePath: string;
+}): string[];
+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 { walkTree as S, parseStainlessPath as _, RouteEntry as a, trimStainlessPath as b, expandToElement as c, generateRoute as d, generateRouteList as f, parseRoute as g, isSupportedLanguage as h, ParsedStainlessPath as i, findNavigationPath as l, getResource as m, LanguageNames as n, SpecTreeEntry as o, getLanguageSnippet as p, Languages as r, SupportedLanguageSyntaxes as s, DocsLanguage as t, generateMissingRouteList as u, routing_d_exports as v, updateHistory as x, scrollToPath as y };

package/dist/routing.d.ts

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