@openpkg-ts/doc-generator 0.1.0

package/dist/index.js

@@ -0,0 +1,79 @@
+import {
+  createDocs,
+  exportToMarkdown,
+  loadSpec,
+  toAlgoliaRecords,
+  toDocusaurusSidebarJS,
+  toFumadocsMetaJSON,
+  toHTML,
+  toJSON,
+  toJSONString,
+  toMarkdown,
+  toNavigation,
+  toPagefindRecords,
+  toSearchIndex,
+  toSearchIndexJSON
+} from "./shared/chunk-7hg53zpt.js";
+import {
+  buildSignatureString,
+  formatParameters,
+  formatReturnType,
+  formatSchema,
+  formatTypeParameters,
+  getMethods,
+  getProperties,
+  groupByVisibility,
+  isMethod,
+  isProperty,
+  resolveTypeRef,
+  sortByKindThenName,
+  sortByName
+} from "./shared/chunk-taeg9090.js";
+
+// src/adapters/types.ts
+function createAdapterRegistry() {
+  const adapters = new Map;
+  return {
+    register(adapter) {
+      adapters.set(adapter.name, adapter);
+    },
+    get(name) {
+      return adapters.get(name);
+    },
+    list() {
+      return Array.from(adapters.values());
+    }
+  };
+}
+var adapterRegistry = createAdapterRegistry();
+export {
+  toSearchIndexJSON,
+  toSearchIndex,
+  toPagefindRecords,
+  toNavigation,
+  toMarkdown,
+  toJSONString,
+  toJSON,
+  toHTML,
+  toFumadocsMetaJSON,
+  toDocusaurusSidebarJS,
+  toAlgoliaRecords,
+  sortByName,
+  sortByKindThenName,
+  resolveTypeRef,
+  loadSpec,
+  isProperty,
+  isMethod,
+  groupByVisibility,
+  getProperties,
+  getMethods,
+  formatTypeParameters,
+  formatSchema,
+  formatReturnType,
+  formatParameters,
+  exportToMarkdown,
+  createDocs,
+  createAdapterRegistry,
+  buildSignatureString,
+  adapterRegistry
+};

package/dist/react-styled.d.ts

@@ -0,0 +1,588 @@
+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;
+import { OpenPkg as OpenPkg7 } from "@openpkg-ts/spec";
+import { OpenPkg as OpenPkg6, SpecExport as SpecExport3, SpecExportKind as SpecExportKind4, SpecType } from "@openpkg-ts/spec";
+interface HTMLOptions {
+	/** Page title override */
+	title?: string;
+	/** Include inline styles */
+	includeStyles?: boolean;
+	/** Custom CSS to inject */
+	customCSS?: string;
+	/** Custom head content */
+	headContent?: string;
+	/** Wrap in full HTML document */
+	fullDocument?: boolean;
+	/** Export to render (single mode) */
+	export?: string;
+}
+import { SpecExportKind } from "@openpkg-ts/spec";
+interface JSONOptions {
+	/** Include raw spec data alongside simplified data */
+	includeRaw?: boolean;
+	/** Export to render (single mode) */
+	export?: string;
+	/** Include computed fields (signatures, formatted types) */
+	computed?: boolean;
+	/** Flatten nested structures */
+	flatten?: boolean;
+}
+interface SimplifiedParameter {
+	name: string;
+	type: string;
+	required: boolean;
+	description?: string;
+	default?: unknown;
+	rest?: boolean;
+}
+interface SimplifiedReturn {
+	type: string;
+	description?: string;
+}
+interface SimplifiedSignature {
+	parameters: SimplifiedParameter[];
+	returns?: SimplifiedReturn;
+	description?: string;
+	typeParameters?: string[];
+}
+interface SimplifiedMember {
+	name: string;
+	kind: "property" | "method";
+	type?: string;
+	description?: string;
+	visibility?: "public" | "protected" | "private";
+	signature?: SimplifiedSignature;
+}
+interface SimplifiedExample {
+	code: string;
+	title?: string;
+	description?: string;
+	language?: string;
+}
+interface SimplifiedExport {
+	id: string;
+	name: string;
+	kind: SpecExportKind;
+	signature: string;
+	description?: string;
+	deprecated: boolean;
+	tags: Array<{
+		name: string;
+		text: string;
+	}>;
+	parameters?: SimplifiedParameter[];
+	returns?: SimplifiedReturn;
+	members?: SimplifiedMember[];
+	examples?: SimplifiedExample[];
+	extends?: string;
+	implements?: string[];
+	sourceFile?: string;
+	sourceLine?: number;
+}
+interface SimplifiedSpec {
+	name: string;
+	version?: string;
+	description?: string;
+	exports: SimplifiedExport[];
+	byKind: Record<SpecExportKind, SimplifiedExport[]>;
+	totalExports: number;
+}
+interface MarkdownOptions {
+	/** Include frontmatter in output */
+	frontmatter?: boolean;
+	/** Sections to include */
+	sections?: {
+		signature?: boolean;
+		description?: boolean;
+		parameters?: boolean;
+		returns?: boolean;
+		examples?: boolean;
+		members?: boolean;
+		properties?: boolean;
+		methods?: boolean;
+	};
+	/** Custom frontmatter fields */
+	customFrontmatter?: Record<string, unknown>;
+	/** Use code fences for signatures */
+	codeSignatures?: boolean;
+	/** Heading level offset (0 = starts at h1, 1 = starts at h2) */
+	headingOffset?: number;
+}
+interface ExportMarkdownOptions extends MarkdownOptions {
+	/** Export to render */
+	export?: string;
+}
+import { SpecExportKind as SpecExportKind2 } from "@openpkg-ts/spec";
+type NavFormat = "fumadocs" | "docusaurus" | "generic";
+type GroupBy = "kind" | "module" | "tag" | "none";
+interface NavOptions {
+	/** Output format */
+	format?: NavFormat;
+	/** How to group exports */
+	groupBy?: GroupBy;
+	/** Base path for links */
+	basePath?: string;
+	/** Custom slug generator */
+	slugify?: (name: string) => string;
+	/** Include index pages for groups */
+	includeGroupIndex?: boolean;
+	/** Custom kind labels */
+	kindLabels?: Partial<Record<SpecExportKind2, string>>;
+	/** Sort exports alphabetically */
+	sortAlphabetically?: boolean;
+}
+interface NavItem {
+	title: string;
+	href?: string;
+	items?: NavItem[];
+}
+interface NavGroup {
+	title: string;
+	items: NavItem[];
+	index?: string;
+}
+interface GenericNav {
+	title: string;
+	groups: NavGroup[];
+	items: NavItem[];
+}
+interface FumadocsMetaItem {
+	title: string;
+	pages?: string[];
+	defaultOpen?: boolean;
+}
+interface FumadocsMeta {
+	root?: boolean;
+	title?: string;
+	pages?: (string | FumadocsMetaItem)[];
+}
+interface DocusaurusSidebarItem {
+	type: "category" | "doc" | "link";
+	label: string;
+	items?: DocusaurusSidebarItem[];
+	id?: string;
+	href?: string;
+}
+type DocusaurusSidebar = DocusaurusSidebarItem[];
+import { SpecExportKind as SpecExportKind3 } from "@openpkg-ts/spec";
+interface SearchOptions {
+	/** Base URL for search result links */
+	baseUrl?: string;
+	/** Custom slug generator */
+	slugify?: (name: string) => string;
+	/** Include type signatures in search content */
+	includeSignatures?: boolean;
+	/** Include member names in search content */
+	includeMembers?: boolean;
+	/** Include parameter names in search content */
+	includeParameters?: boolean;
+	/** Weight multipliers for ranking */
+	weights?: {
+		name?: number;
+		description?: number;
+		signature?: number;
+		tags?: number;
+	};
+}
+interface PagefindRecord {
+	url: string;
+	content: string;
+	word_count: number;
+	filters: Record<string, string[]>;
+	meta: {
+		title: string;
+		kind?: string;
+		description?: string;
+		signature?: string;
+	};
+	anchors?: Array<{
+		element: string;
+		id: string;
+		text: string;
+	}>;
+	weighted_sections?: Array<{
+		weight: number;
+		text: string;
+	}>;
+}
+interface AlgoliaRecord {
+	objectID: string;
+	name: string;
+	kind: SpecExportKind3;
+	description?: string;
+	signature: string;
+	content: string;
+	tags: string[];
+	deprecated: boolean;
+	url: string;
+	hierarchy: {
+		lvl0: string;
+		lvl1: string;
+		lvl2?: string;
+	};
+	_rankingInfo?: {
+		nbTypos: number;
+		words: number;
+	};
+}
+interface SearchRecord {
+	id: string;
+	name: string;
+	kind: SpecExportKind3;
+	signature: string;
+	description?: string;
+	content: string;
+	keywords: string[];
+	url: string;
+	deprecated: boolean;
+}
+interface SearchIndex {
+	records: SearchRecord[];
+	version: string;
+	generatedAt: string;
+	packageName: string;
+}
+interface DocsInstance {
+	/** The parsed OpenPkg spec */
+	spec: OpenPkg6;
+	/** Get an by its ID */
+	getExport(id: string): SpecExport3 | undefined;
+	/** Get a type definition by its ID */
+	getType(id: string): SpecType | undefined;
+	/** Get all exports of a specific kind */
+	getExportsByKind(kind: SpecExportKind4): SpecExport3[];
+	/** Get all exports */
+	getAllExports(): SpecExport3[];
+	/** Get all type definitions */
+	getAllTypes(): SpecType[];
+	/** Get exports by JSDoc tag (e.g., '@beta', '@internal') */
+	getExportsByTag(tagName: string): SpecExport3[];
+	/** Search exports by name or description */
+	search(query: string): SpecExport3[];
+	/** Get exports belonging to a specific module/namespace */
+	getModule(moduleName: string): SpecExport3[];
+	/** Get deprecated exports */
+	getDeprecated(): SpecExport3[];
+	/** Get exports grouped by kind */
+	groupByKind(): Record<SpecExportKind4, SpecExport3[]>;
+	/** Render spec or single to MDX */
+	toMarkdown(options?: ExportMarkdownOptions): string;
+	/** Render spec or single to HTML */
+	toHTML(options?: HTMLOptions): string;
+	/** Render spec or single to JSON structure */
+	toJSON(options?: JSONOptions): SimplifiedSpec | SimplifiedExport;
+	/** Generate navigation structure */
+	toNavigation(options?: NavOptions): GenericNav | FumadocsMeta | DocusaurusSidebar;
+	/** Generate search index */
+	toSearchIndex(options?: SearchOptions): SearchIndex;
+	/** Generate Pagefind-compatible records */
+	toPagefindRecords(options?: SearchOptions): PagefindRecord[];
+	/** Generate Algolia-compatible records */
+	toAlgoliaRecords(options?: SearchOptions): AlgoliaRecord[];
+}
+interface APIPageProps {
+	/** Direct spec object */
+	spec?: OpenPkg7;
+	/** Or docs instance from createDocs() */
+	instance?: DocsInstance;
+	/** Export ID to render */
+	id: string;
+	/** Custom code example renderer */
+	renderExample?: (code: string, filename: string) => React.ReactNode;
+}
+/**
+* Main styled API page component that renders documentation for a single export.
+*
+* @example
+* ```tsx
+* import { APIPage } from '@openpkg-ts/doc-generator/react/styled'
+* import spec from './openpkg.json'
+*
+* <APIPage spec={spec} id="createClient" />
+* ```
+*
+* @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" />
+* ```
+*/
+declare function APIPage({ spec, instance, id, renderExample }: APIPageProps): React.ReactNode;
+import { OpenPkg as OpenPkg8, SpecExport as SpecExport4 } from "@openpkg-ts/spec";
+interface ClassPageProps {
+	export: SpecExport4;
+	spec: OpenPkg8;
+	/** Custom code example renderer */
+	renderExample?: (code: string, filename: string) => React.ReactNode;
+}
+/**
+* Styled class page component with Tailwind.
+*/
+declare function ClassPage({ export: exp, spec, renderExample }: ClassPageProps): React.ReactNode;
+import { OpenPkg as OpenPkg9, SpecExport as SpecExport5 } from "@openpkg-ts/spec";
+interface EnumPageProps {
+	export: SpecExport5;
+	spec: OpenPkg9;
+	/** Custom code example renderer */
+	renderExample?: (code: string, filename: string) => React.ReactNode;
+}
+/**
+* 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 FunctionPageProps {
+	export: SpecExport6;
+	spec: OpenPkg10;
+	/** Custom code example renderer */
+	renderExample?: (code: string, filename: string) => React.ReactNode;
+}
+/**
+* Styled function page component with Tailwind.
+*/
+declare function FunctionPage({ export: exp, spec, renderExample }: FunctionPageProps): React.ReactNode;
+import { OpenPkg as OpenPkg11, SpecExport as SpecExport7 } from "@openpkg-ts/spec";
+interface InterfacePageProps {
+	export: SpecExport7;
+	spec: OpenPkg11;
+	/** Custom code example renderer */
+	renderExample?: (code: string, filename: string) => React.ReactNode;
+}
+/**
+* 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";
+interface VariablePageProps {
+	export: SpecExport8;
+	spec: OpenPkg12;
+	/** Custom code example renderer */
+	renderExample?: (code: string, filename: string) => React.ReactNode;
+}
+/**
+* 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 };