@openpkg-ts/doc-generator 0.1.0

package/dist/react.d.ts

@@ -0,0 +1,221 @@
+import { SpecMember } from "@openpkg-ts/spec";
+interface CollapsibleMethodProps {
+	/** Method member to display */
+	member: SpecMember;
+	/** Default expanded state */
+	defaultExpanded?: boolean;
+	/** Custom className */
+	className?: string;
+	/** Custom header renderer */
+	renderHeader?: (member: SpecMember, expanded: boolean, toggle: () => void) => React.ReactNode;
+	/** Custom content renderer */
+	renderContent?: (member: SpecMember) => React.ReactNode;
+}
+/**
+* Headless collapsible method component.
+*
+* @example
+* ```tsx
+* <CollapsibleMethod member={method} defaultExpanded />
+*
+* // Custom rendering
+* <CollapsibleMethod
+*   member={method}
+*   renderHeader={(m, expanded, toggle) => (
+*     <button onClick={toggle}>{m.name}</button>
+*   )}
+* />
+* ```
+*/
+declare function CollapsibleMethod({ member, defaultExpanded, className, renderHeader, renderContent }: CollapsibleMethodProps): React.ReactNode;
+import { SpecExample } from "@openpkg-ts/spec";
+interface ExampleBlockProps {
+	/** Examples to display (string or SpecExample) */
+	examples: (string | SpecExample)[];
+	/** Custom className */
+	className?: string;
+	/** Custom example renderer */
+	renderExample?: (example: string | SpecExample, index: number) => React.ReactNode;
+}
+/**
+* Normalize example to string content.
+*/
+declare function getExampleCode(example: string | SpecExample): string;
+/**
+* Get example title if available.
+*/
+declare function getExampleTitle(example: string | SpecExample): string | undefined;
+/**
+* Get example language.
+*/
+declare function getExampleLanguage(example: string | SpecExample): string;
+/**
+* Clean code by removing markdown fences.
+*/
+declare function cleanCode(code: string): string;
+/**
+* Headless example block component.
+*
+* @example
+* ```tsx
+* <ExampleBlock examples={exp.examples} />
+*
+* // Custom rendering
+* <ExampleBlock
+*   examples={exp.examples}
+*   renderExample={(ex) => <CustomCode code={getExampleCode(ex)} />}
+* />
+* ```
+*/
+declare function ExampleBlock({ examples, className, renderExample }: ExampleBlockProps): React.ReactNode;
+import { SpecSchema, SpecSignatureParameter } from "@openpkg-ts/spec";
+interface ExpandablePropertyProps {
+	/** Parameter to display */
+	param: SpecSignatureParameter;
+	/** Nesting depth */
+	depth?: number;
+	/** Custom className */
+	className?: string;
+}
+interface NestedPropertyProps {
+	/** Property name */
+	name: string;
+	/** Property schema */
+	schema: SpecSchema;
+	/** Is required */
+	required?: boolean;
+	/** Nesting depth */
+	depth?: number;
+}
+/**
+* Nested property display.
+*/
+declare function NestedProperty({ name, schema, required, depth }: NestedPropertyProps): React.ReactNode;
+/**
+* Headless expandable property for parameters with nested objects.
+*
+* @example
+* ```tsx
+* <ExpandableProperty param={param} />
+* ```
+*/
+declare function ExpandableProperty({ param, depth, className }: ExpandablePropertyProps): React.ReactNode;
+import { SpecMember as SpecMember2 } from "@openpkg-ts/spec";
+interface MembersTableProps {
+	/** Members to display */
+	members: SpecMember2[];
+	/** Custom className */
+	className?: string;
+	/** Group by kind (constructor, property, method) */
+	groupByKind?: boolean;
+	/** Custom member renderer */
+	renderMember?: (member: SpecMember2, index: number) => React.ReactNode;
+}
+interface MemberGroups {
+	constructors: SpecMember2[];
+	properties: SpecMember2[];
+	methods: SpecMember2[];
+	accessors: SpecMember2[];
+	other: SpecMember2[];
+}
+/**
+* Group members by their kind.
+*/
+declare function groupMembersByKind(members: SpecMember2[]): MemberGroups;
+interface MemberRowProps {
+	member: SpecMember2;
+}
+/**
+* Individual member row.
+*/
+declare function MemberRow({ member }: MemberRowProps): React.ReactNode;
+/**
+* Headless members table for classes/interfaces.
+*
+* @example
+* ```tsx
+* <MembersTable members={exp.members} groupByKind />
+* ```
+*/
+declare function MembersTable({ members, className, groupByKind, renderMember }: MembersTableProps): React.ReactNode;
+import { SpecMember as SpecMember3, SpecSignatureParameter as SpecSignatureParameter2 } from "@openpkg-ts/spec";
+interface ParamTableProps {
+	/** Parameters or members to display */
+	items: (SpecSignatureParameter2 | SpecMember3)[];
+	/** Show required indicator */
+	showRequired?: boolean;
+	/** Custom className */
+	className?: string;
+	/** Render custom row */
+	renderRow?: (item: SpecSignatureParameter2 | SpecMember3, index: number) => React.ReactNode;
+}
+interface ParamRowProps {
+	item: SpecSignatureParameter2 | SpecMember3;
+	showRequired?: boolean;
+}
+/**
+* Individual parameter row component.
+*/
+declare function ParamRow({ item, showRequired }: ParamRowProps): React.ReactNode;
+/**
+* Headless parameter table component.
+*
+* @example
+* ```tsx
+* <ParamTable items={sig.parameters} />
+*
+* // Custom row rendering
+* <ParamTable
+*   items={sig.parameters}
+*   renderRow={(item) => <CustomRow key={item.name} param={item} />}
+* />
+* ```
+*/
+declare function ParamTable({ items, showRequired, className, renderRow }: ParamTableProps): React.ReactNode;
+import { SpecExport } from "@openpkg-ts/spec";
+interface SignatureProps {
+	/** The to render signature for */
+	export: SpecExport;
+	/** Index of signature to render (for overloaded functions) */
+	signatureIndex?: number;
+	/** Custom className */
+	className?: string;
+	/** Render prop for custom rendering */
+	children?: (signature: string) => React.ReactNode;
+}
+/**
+* Headless signature component. Renders a type signature string.
+*
+* @example
+* ```tsx
+* // Default rendering
+* <Signature export={fn} />
+*
+* // Custom rendering
+* <Signature export={fn}>
+*   {(sig) => <pre>{sig}</pre>}
+* </Signature>
+* ```
+*/
+declare function Signature({ export: exp, signatureIndex, className, children }: SignatureProps): React.ReactNode;
+import { SpecMember as SpecMember4, SpecSignatureParameter as SpecSignatureParameter3 } from "@openpkg-ts/spec";
+interface TypeTableProps {
+	/** Members or parameters to display */
+	items: (SpecSignatureParameter3 | SpecMember4)[];
+	/** Show required indicator */
+	showRequired?: boolean;
+	/** Custom className */
+	className?: string;
+	/** Render custom row */
+	renderRow?: (item: SpecSignatureParameter3 | SpecMember4, index: number) => React.ReactNode;
+}
+/**
+* Headless type table for displaying interface/type members.
+*
+* @example
+* ```tsx
+* <TypeTable items={exp.members} />
+* ```
+*/
+declare function TypeTable({ items, showRequired, className, renderRow }: TypeTableProps): React.ReactNode;
+export { groupMembersByKind, getExampleTitle, getExampleLanguage, getExampleCode, cleanCode, TypeTableProps, TypeTable, SignatureProps, Signature, ParamTableProps, ParamTable, ParamRowProps, ParamRow, NestedPropertyProps, NestedProperty, MembersTableProps, MembersTable, MemberRowProps, MemberRow, MemberGroups, ExpandablePropertyProps, ExpandableProperty, ExampleBlockProps, ExampleBlock, CollapsibleMethodProps, CollapsibleMethod };

package/dist/react.js

@@ -0,0 +1,35 @@
+import {
+  CollapsibleMethod,
+  ExampleBlock,
+  ExpandableProperty,
+  MemberRow,
+  MembersTable,
+  NestedProperty,
+  ParamRow,
+  ParamTable,
+  Signature,
+  TypeTable,
+  cleanCode,
+  getExampleCode,
+  getExampleLanguage,
+  getExampleTitle,
+  groupMembersByKind
+} from "./shared/chunk-e5fkh3kh.js";
+import"./shared/chunk-taeg9090.js";
+export {
+  groupMembersByKind,
+  getExampleTitle,
+  getExampleLanguage,
+  getExampleCode,
+  cleanCode,
+  TypeTable,
+  Signature,
+  ParamTable,
+  ParamRow,
+  NestedProperty,
+  MembersTable,
+  MemberRow,
+  ExpandableProperty,
+  ExampleBlock,
+  CollapsibleMethod
+};