@openpkg-ts/doc-generator 0.1.2 → 0.2.1

package/dist/react-styled.d.ts

@@ -503,33 +503,34 @@ interface APIPageProps {
 	spec?: OpenPkg7;
 	/** Or docs instance from createDocs() */
 	instance?: DocsInstance;
-	/** Export ID to render */
-	id: string;
+	/** Export ID to render, or undefined for index page */
+	id?: string;
+	/** Base href for index page links (required when id is undefined) */
+	baseHref?: string;
+	/** Description for index page */
+	description?: string;
 	/** Custom code example renderer */
 	renderExample?: (code: string, filename: string) => React.ReactNode;
 }
 /**
-* Main styled API page component that renders documentation for a single export.
+* Main styled API page component that renders documentation.
+*
+* Renders either:
+* - Index page (when id is undefined) showing all exports in a grid
+* - Detail page (when id is provided) showing specific docs
 *
 * @example
 * ```tsx
-* import { APIPage } from '@openpkg-ts/doc-generator/react/styled'
-* import spec from './openpkg.json'
-*
-* <APIPage spec={spec} id="createClient" />
+* // Index mode - show all exports
+* <APIPage spec={spec} baseHref="/docs/api" />
 * ```
 *
 * @example
 * ```tsx
-* // With docs instance
-* import { APIPage } from '@openpkg-ts/doc-generator/react/styled'
-* import { createDocs } from '@openpkg-ts/doc-generator'
-*
-* const docs = createDocs('./openpkg.json')
-* <APIPage instance={docs} id="createClient" />
+* // Detail mode - show specific * <APIPage spec={spec} id="createClient" />
 * ```
 */
-declare function APIPage({ spec, instance, id, renderExample }: APIPageProps): React.ReactNode;
+declare function APIPage({ spec, instance, id, baseHref, description, renderExample }: APIPageProps): React.ReactNode;
 import { OpenPkg as OpenPkg8, SpecExport as SpecExport4 } from "@openpkg-ts/spec";
 interface ClassPageProps {
 	export: SpecExport4;
@@ -541,6 +542,28 @@ interface ClassPageProps {
 * Styled class page component with Tailwind.
 */
 declare function ClassPage({ export: exp, spec, renderExample }: ClassPageProps): React.ReactNode;
+import { ReactNode as ReactNode2 } from "react";
+interface CodeTab {
+	/** Tab label */
+	label: string;
+	/** Tab content (code block) */
+	content: ReactNode2;
+	/** Raw code for copy button */
+	code: string;
+}
+interface CodeTabsProps {
+	/** Array of tabs */
+	tabs: CodeTab[];
+	/** Default selected tab index */
+	defaultIndex?: number;
+	/** Custom className */
+	className?: string;
+}
+/**
+* Tabbed code block wrapper with copy button per tab.
+* Integrates with any code rendering component.
+*/
+declare function CodeTabs({ tabs, defaultIndex, className }: CodeTabsProps): React.ReactNode2;
 import { OpenPkg as OpenPkg9, SpecExport as SpecExport5 } from "@openpkg-ts/spec";
 interface EnumPageProps {
 	export: SpecExport5;
@@ -552,21 +575,68 @@ interface EnumPageProps {
 * Styled enum page component with Tailwind.
 */
 declare function EnumPage({ export: exp, spec, renderExample }: EnumPageProps): React.ReactNode;
-import { OpenPkg as OpenPkg10, SpecExport as SpecExport6 } from "@openpkg-ts/spec";
+interface ExportCardProps {
+	/** Function/name */
+	name: string;
+	/** Description snippet */
+	description?: string;
+	/** Link to detail page */
+	href: string;
+	/** Export kind: function, type, variable, class, interface, enum */
+	kind?: "function" | "type" | "variable" | "class" | "interface" | "enum";
+	/** Custom className */
+	className?: string;
+}
+/**
+* Card component for displaying exports in an index grid.
+* Features function name styling, description, and hover effects.
+*/
+declare function ExportCard({ name, description, href, kind, className }: ExportCardProps): React.ReactNode;
+import { OpenPkg as OpenPkg10 } from "@openpkg-ts/spec";
+import { ReactNode as ReactNode3 } from "react";
+interface ExportIndexPageProps {
+	/** OpenPkg spec */
+	spec: OpenPkg10;
+	/** Base href for links (e.g., '/docs/api') */
+	baseHref: string;
+	/** Optional intro description */
+	description?: string;
+	/** Custom className */
+	className?: string;
+}
+/**
+* Index page showing all exports in a grid, grouped by category.
+* AI SDK-style clean layout with responsive 2-column grid.
+*/
+declare function ExportIndexPage({ spec, baseHref, description, className }: ExportIndexPageProps): ReactNode3;
+import { OpenPkg as OpenPkg11, SpecExport as SpecExport6 } from "@openpkg-ts/spec";
+import { ReactNode as ReactNode4 } from "react";
 interface FunctionPageProps {
 	export: SpecExport6;
-	spec: OpenPkg10;
+	spec: OpenPkg11;
 	/** Custom code example renderer */
-	renderExample?: (code: string, filename: string) => React.ReactNode;
+	renderExample?: (code: string, filename: string) => ReactNode4;
 }
 /**
-* Styled function page component with Tailwind.
+* AI SDK-style function page with two-column layout.
+* Left: parameters, returns. Right: sticky code examples.
 */
-declare function FunctionPage({ export: exp, spec, renderExample }: FunctionPageProps): React.ReactNode;
-import { OpenPkg as OpenPkg11, SpecExport as SpecExport7 } from "@openpkg-ts/spec";
+declare function FunctionPage({ export: exp, spec, renderExample }: FunctionPageProps): ReactNode4;
+interface ImportSectionProps {
+	/** Import statement text */
+	importStatement: string;
+	/** Custom className */
+	className?: string;
+}
+/**
+* Displays a copyable import statement with one-click copy.
+* Monospace styling with copy button.
+*/
+declare function ImportSection({ importStatement, className }: ImportSectionProps): React.ReactNode;
+import { OpenPkg as OpenPkg12, SpecExport as SpecExport7 } from "@openpkg-ts/spec";
 interface InterfacePageProps {
 	export: SpecExport7;
-	spec: OpenPkg11;
+	spec: OpenPkg12;
 	/** Custom code example renderer */
 	renderExample?: (code: string, filename: string) => React.ReactNode;
 }
@@ -574,10 +644,34 @@ interface InterfacePageProps {
 * Styled interface/type page component with Tailwind.
 */
 declare function InterfacePage({ export: exp, spec, renderExample }: InterfacePageProps): React.ReactNode;
-import { OpenPkg as OpenPkg12, SpecExport as SpecExport8 } from "@openpkg-ts/spec";
+import { SpecSchema as SpecSchema2, SpecSignatureParameter as SpecSignatureParameter4 } from "@openpkg-ts/spec";
+interface ParameterItemProps {
+	/** Parameter to display */
+	param: SpecSignatureParameter4;
+	/** Nesting depth for indentation */
+	depth?: number;
+	/** Custom className */
+	className?: string;
+}
+interface NestedPropertyItemProps {
+	/** Property name */
+	name: string;
+	/** Property schema */
+	schema: SpecSchema2;
+	/** Is this property required */
+	required?: boolean;
+	/** Nesting depth */
+	depth?: number;
+}
+/**
+* Single parameter with expand capability for nested objects.
+* Features expandable nested params, type annotations, and required/optional badges.
+*/
+declare function ParameterItem({ param, depth, className }: ParameterItemProps): React.ReactNode;
+import { OpenPkg as OpenPkg13, SpecExport as SpecExport8 } from "@openpkg-ts/spec";
 interface VariablePageProps {
 	export: SpecExport8;
-	spec: OpenPkg12;
+	spec: OpenPkg13;
 	/** Custom code example renderer */
 	renderExample?: (code: string, filename: string) => React.ReactNode;
 }
@@ -585,4 +679,4 @@ interface VariablePageProps {
 * Styled variable/constant page component with Tailwind.
 */
 declare function VariablePage({ export: exp, spec, renderExample }: VariablePageProps): React.ReactNode;
-export { groupMembersByKind, getExampleTitle, getExampleLanguage, getExampleCode, cleanCode, VariablePageProps, VariablePage, TypeTableProps, TypeTable, SignatureProps, Signature, ParamTableProps, ParamTable, ParamRowProps, ParamRow, NestedPropertyProps, NestedProperty, MembersTableProps, MembersTable, MemberRowProps, MemberRow, MemberGroups, InterfacePageProps, InterfacePage, FunctionPageProps, FunctionPage, ExpandablePropertyProps, ExpandableProperty, ExampleBlockProps, ExampleBlock, EnumPageProps, EnumPage, CollapsibleMethodProps, CollapsibleMethod, ClassPageProps, ClassPage, APIPageProps, APIPage };
+export { groupMembersByKind, getExampleTitle, getExampleLanguage, getExampleCode, cleanCode, VariablePageProps, VariablePage, TypeTableProps, TypeTable, SignatureProps, Signature, ParameterItemProps, ParameterItem, ParamTableProps, ParamTable, ParamRowProps, ParamRow, NestedPropertyProps, NestedPropertyItemProps, NestedProperty, MembersTableProps, MembersTable, MemberRowProps, MemberRow, MemberGroups, InterfacePageProps, InterfacePage, ImportSectionProps, ImportSection, FunctionPageProps, FunctionPage, ExportIndexPageProps, ExportIndexPage, ExportCardProps, ExportCard, ExpandablePropertyProps, ExpandableProperty, ExampleBlockProps, ExampleBlock, EnumPageProps, EnumPage, CollapsibleMethodProps, CollapsibleMethod, CodeTabsProps, CodeTabs, CodeTab, ClassPageProps, ClassPage, APIPageProps, APIPage };