@openpkg-ts/doc-generator 0.1.2 → 0.2.0

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;
@@ -552,21 +553,23 @@ 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";
+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;
+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 +577,10 @@ 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 { 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;
 }