@doccov/ui 0.2.2 → 0.3.0

package/dist/docskit/index.d.ts

@@ -231,4 +231,175 @@ declare function TooltipLink(props: {
 });
 import { AnnotationHandler as AnnotationHandler13 } from "codehike/code";
 declare const wordWrap2: AnnotationHandler13;
-export { wordWrap2 as wordWrap, tooltip, toCodeGroup, theme, mark, link, lineNumbers2 as lineNumbers, hover, flagsToOptions, expandable, diff, collapse, callout, addDocsKit, WithNotes, WithHover, TooltipLink, TerminalSkeleton, Terminal, TabsTrigger, TabsList, TabsContent, Tabs, SingleCode, PackageInstall, MultiCode, InlineCodeSkeleton, HoverLink, DocsKitInlineCode, DocsKitCode, DiffStats, CopyButton, CodeTabsSkeleton, CodeInfo, CodeIcon, CodeGroup, CodeBlockSkeleton, Code, ClientTerminal, ClientInlineCode, ClientDocsKitCode, ClientDiffCodeProps, ClientDiffCode, ClientCode };
+import { VariantProps } from "class-variance-authority";
+import * as React5 from "react";
+type HttpMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+declare const endpointBadgeVariants: unknown;
+interface EndpointBadgeProps extends React5.HTMLAttributes<HTMLSpanElement>, VariantProps<typeof endpointBadgeVariants> {
+	method: HttpMethod;
+}
+declare const EndpointBadge: unknown;
+import * as React6 from "react";
+interface EndpointHeaderProps extends React6.HTMLAttributes<HTMLDivElement> {
+	/** HTTP method */
+	method: HttpMethod;
+	/** API path (e.g., "/v1/customers") */
+	path: string;
+	/** Show copy button on hover */
+	copyable?: boolean;
+}
+declare const EndpointHeader: unknown;
+import * as React7 from "react";
+interface APIParameterSchema {
+	/** Type name */
+	type?: string;
+	/** Formatted type string */
+	typeString?: string;
+	/** Description */
+	description?: string;
+	/** Nested properties for object types */
+	properties?: Record<string, APIParameterSchema>;
+	/** Required property names */
+	required?: string[];
+}
+interface APIParameterItemProps {
+	/** Parameter name */
+	name: string;
+	/** Type string (e.g., "string", "object") */
+	type: string;
+	/** Is required */
+	required?: boolean;
+	/** Description */
+	description?: string;
+	/** Nested children (for expandable objects) */
+	children?: APIParameterSchema;
+	/** Nesting depth */
+	depth?: number;
+	/** Custom className */
+	className?: string;
+}
+/**
+* Single parameter row with name, type, required badge, description, and expandable children.
+* Stripe-style API reference parameter display.
+*/
+declare function APIParameterItem({ name, type, required, description, children, depth, className }: APIParameterItemProps): React7.ReactNode;
+import * as React8 from "react";
+interface ParameterListProps {
+	/** Title above the list (e.g., "Body parameters") */
+	title?: string;
+	/** Number of items to show before collapsing */
+	collapseAfter?: number;
+	/** Child parameter items */
+	children: React8.ReactNode;
+	/** Custom className */
+	className?: string;
+}
+/**
+* Container for parameter items with optional "More parameters" collapse.
+*/
+declare function ParameterList({ title, collapseAfter, children, className }: ParameterListProps): React8.ReactNode;
+import * as React9 from "react";
+interface ResponseBlockProps {
+	/** Response JSON data */
+	data: object;
+	/** Optional title (e.g., "Response", "200 OK") */
+	title?: string;
+	/** Custom className */
+	className?: string;
+}
+/**
+* JSON response preview with syntax highlighting.
+* Displays formatted JSON with copy functionality.
+*/
+declare function ResponseBlock({ data, title, className }: ResponseBlockProps): React9.ReactNode;
+import * as React10 from "react";
+interface Language {
+	/** Language identifier (e.g., "curl", "node", "python") */
+	id: string;
+	/** Display label (e.g., "cURL", "Node.js", "Python") */
+	label: string;
+}
+interface LanguageSelectorProps {
+	/** Available languages */
+	languages: Language[];
+	/** Currently selected language id */
+	value: string;
+	/** Callback when language changes */
+	onChange: (languageId: string) => void;
+	/** Custom className */
+	className?: string;
+}
+/**
+* Dropdown selector for choosing code example language.
+* Used in APICodePanel to switch between language examples.
+*/
+declare function LanguageSelector({ languages, value, onChange, className }: LanguageSelectorProps): React10.ReactNode;
+import * as React11 from "react";
+interface CodeExample {
+	/** Language identifier */
+	languageId: string;
+	/** Code content */
+	code: string;
+	/** Optional syntax highlighting language (defaults to languageId) */
+	highlightLang?: string;
+}
+interface APICodePanelProps {
+	/** Available languages for the selector */
+	languages: Language[];
+	/** Code examples keyed by language id */
+	examples: CodeExample[];
+	/** Optional external link (e.g., to API playground) */
+	externalLink?: string;
+	/** Optional title shown in header */
+	title?: string;
+	/** Custom className */
+	className?: string;
+}
+/**
+* Right-side sticky code panel for API documentation.
+* Features language dropdown, copy button, and dark bg with syntax highlighting.
+*/
+declare function APICodePanel({ languages, examples, externalLink, title, className }: APICodePanelProps): React11.ReactNode;
+import * as React12 from "react";
+interface APISectionProps {
+	/** Section title (e.g., "Create a customer", "The Customer object") */
+	title: string;
+	/** Optional anchor id for deep linking */
+	id?: string;
+	/** Optional description */
+	description?: React12.ReactNode;
+	/** Left column content (parameters, returns, etc.) */
+	children: React12.ReactNode;
+	/** Languages for code panel */
+	languages: Language[];
+	/** Code examples for the right panel */
+	examples: CodeExample[];
+	/** Optional external link for code panel */
+	externalLink?: string;
+	/** Optional code panel title */
+	codePanelTitle?: string;
+	/** Custom className */
+	className?: string;
+}
+/**
+* Single API section with two-column layout.
+* Docs/params on left, sticky code panel on right.
+*/
+declare function APISection({ title, id, description, children, languages, examples, externalLink, codePanelTitle, className }: APISectionProps): React12.ReactNode;
+import * as React13 from "react";
+interface APIReferencePageProps {
+	/** Page title */
+	title: string;
+	/** Optional page description */
+	description?: React13.ReactNode;
+	/** API sections as children */
+	children: React13.ReactNode;
+	/** Custom className */
+	className?: string;
+}
+/**
+* Full page wrapper for API reference documentation.
+* Provides max-width container and consistent spacing.
+*/
+declare function APIReferencePage({ title, description, children, className }: APIReferencePageProps): React13.ReactNode;
+export { wordWrap2 as wordWrap, tooltip, toCodeGroup, theme, mark, link, lineNumbers2 as lineNumbers, hover, flagsToOptions, expandable, endpointBadgeVariants, diff, collapse, callout, addDocsKit, WithNotes, WithHover, TooltipLink, TerminalSkeleton, Terminal, TabsTrigger, TabsList, TabsContent, Tabs, SingleCode, ResponseBlockProps, ResponseBlock, ParameterListProps, ParameterList, PackageInstall, MultiCode, LanguageSelectorProps, LanguageSelector, Language, InlineCodeSkeleton, HttpMethod, HoverLink, EndpointHeaderProps, EndpointHeader, EndpointBadgeProps, EndpointBadge, DocsKitInlineCode, DocsKitCode, DiffStats, CopyButton, CodeTabsSkeleton, CodeInfo, CodeIcon, CodeGroup, CodeExample, CodeBlockSkeleton, Code, ClientTerminal, ClientInlineCode, ClientDocsKitCode, ClientDiffCodeProps, ClientDiffCode, ClientCode, APISectionProps, APISection, APIReferencePageProps, APIReferencePage, APIParameterSchema, APIParameterItemProps, APIParameterItem, APICodePanelProps, APICodePanel };