@openpkg-ts/doc-generator 0.3.4 → 0.5.0

package/README.md

@@ -169,7 +169,7 @@ import {
   getMethods,
   getProperties,
   groupByVisibility,
-  sortByKindThenName,
+  sortByName,
 } from '@openpkg-ts/doc-generator'
 
 formatSchema({ type: 'string' }) // 'string'

package/dist/cli.js

@@ -10,7 +10,7 @@ import {
   toJSONString,
   toNavigation,
   toPagefindRecords
-} from "./shared/server-83s9r625.js";
+} from "./shared/server-4yabn81t.js";
 
 // src/cli.ts
 import { readFileSync } from "node:fs";

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { OpenPkg as OpenPkg9, SpecExample, SpecExport as SpecExport5, SpecExportKind as SpecExportKind5, SpecMember as SpecMember2, SpecSchema as SpecSchema2, SpecSignature as SpecSignature2, SpecSignatureParameter, SpecTag, SpecType as SpecType3, SpecTypeKind, SpecTypeParameter as SpecTypeParameter2 } from "@openpkg-ts/spec";
+import { OpenPkg as OpenPkg10, SpecExample as SpecExample2, SpecExport as SpecExport6, SpecExportKind as SpecExportKind5, SpecMember as SpecMember2, SpecSchema as SpecSchema3, SpecSignature as SpecSignature2, SpecSignatureParameter as SpecSignatureParameter2, SpecTag, SpecType as SpecType3, SpecTypeKind, SpecTypeParameter as SpecTypeParameter2 } from "@openpkg-ts/spec";
 import { OpenPkg, SpecExport } from "@openpkg-ts/spec";
 import { ComponentType, ReactNode } from "react";
 /**
@@ -144,8 +144,8 @@ declare function createAdapterRegistry(): AdapterRegistry;
 * Default adapter registry instance.
 */
 declare const adapterRegistry: AdapterRegistry;
-import { OpenPkg as OpenPkg7, SpecExport as SpecExport3, SpecExportKind as SpecExportKind4, SpecType } from "@openpkg-ts/spec";
-import { OpenPkg as OpenPkg2 } from "@openpkg-ts/spec";
+import { OpenPkg as OpenPkg8, SpecExport as SpecExport4, SpecExportKind as SpecExportKind4, SpecType } from "@openpkg-ts/spec";
+import { OpenPkg as OpenPkg3 } from "@openpkg-ts/spec";
 interface HTMLOptions {
 	/** Page title override */
 	title?: string;
@@ -181,8 +181,8 @@ interface HTMLOptions {
 * const fragment = docs.toHTML({ export: 'greet', fullDocument: false })
 * ```
 */
-declare function toHTML2(spec: OpenPkg2, options?: HTMLOptions): string;
-import { OpenPkg as OpenPkg3, SpecExportKind } from "@openpkg-ts/spec";
+declare function toHTML2(spec: OpenPkg3, options?: HTMLOptions): string;
+import { OpenPkg as OpenPkg4, SpecExportKind } from "@openpkg-ts/spec";
 interface JSONOptions {
 	/** Include raw spec data alongside simplified data */
 	includeRaw?: boolean;
@@ -274,7 +274,7 @@ interface SimplifiedSpec {
 * // { id, name, kind, signature, parameters, returns, ... }
 * ```
 */
-declare function toJSON2(spec: OpenPkg3, options?: JSONOptions): SimplifiedSpec | SimplifiedExport;
+declare function toJSON2(spec: OpenPkg4, options?: JSONOptions): SimplifiedSpec | SimplifiedExport;
 /**
 * Serialize to JSON string with formatting.
 *
@@ -282,10 +282,10 @@ declare function toJSON2(spec: OpenPkg3, options?: JSONOptions): SimplifiedSpec
 * @param options - JSON options plus pretty formatting option
 * @returns JSON string
 */
-declare function toJSONString(spec: OpenPkg3, options?: JSONOptions & {
+declare function toJSONString(spec: OpenPkg4, options?: JSONOptions & {
 	pretty?: boolean;
 }): string;
-import { OpenPkg as OpenPkg4, SpecExport as SpecExport2 } from "@openpkg-ts/spec";
+import { OpenPkg as OpenPkg5, SpecExport as SpecExport3 } from "@openpkg-ts/spec";
 interface MarkdownOptions {
 	/** Include frontmatter in output */
 	frontmatter?: boolean;
@@ -327,7 +327,7 @@ interface ExportMarkdownOptions extends MarkdownOptions {
 * })
 * ```
 */
-declare function exportToMarkdown(exp: SpecExport2, options?: MarkdownOptions): string;
+declare function exportToMarkdown(exp: SpecExport3, options?: MarkdownOptions): string;
 /**
 * Render entire spec to MDX.
 *
@@ -347,8 +347,8 @@ declare function exportToMarkdown(exp: SpecExport2, options?: MarkdownOptions):
 * // Single * const fnMdx = docs.toMarkdown({ export: 'greet' })
 * ```
 */
-declare function toMarkdown2(spec: OpenPkg4, options?: ExportMarkdownOptions): string;
-import { OpenPkg as OpenPkg5, SpecExportKind as SpecExportKind2 } from "@openpkg-ts/spec";
+declare function toMarkdown2(spec: OpenPkg5, options?: ExportMarkdownOptions): string;
+import { OpenPkg as OpenPkg6, SpecExportKind as SpecExportKind2 } from "@openpkg-ts/spec";
 type NavFormat = "fumadocs" | "docusaurus" | "generic";
 type GroupBy = "kind" | "module" | "tag" | "none";
 interface NavOptions {
@@ -423,7 +423,7 @@ type DocusaurusSidebar = DocusaurusSidebarItem[];
 * const sidebar = docs.toNavigation({ format: 'docusaurus' })
 * ```
 */
-declare function toNavigation2(spec: OpenPkg5, options?: NavOptions): GenericNav | FumadocsMeta | DocusaurusSidebar;
+declare function toNavigation2(spec: OpenPkg6, options?: NavOptions): GenericNav | FumadocsMeta | DocusaurusSidebar;
 /**
 * Generate Fumadocs meta.json file content.
 *
@@ -437,7 +437,7 @@ declare function toNavigation2(spec: OpenPkg5, options?: NavOptions): GenericNav
 * fs.writeFileSync('docs/api/meta.json', meta)
 * ```
 */
-declare function toFumadocsMetaJSON(spec: OpenPkg5, options?: Omit<NavOptions, "format">): string;
+declare function toFumadocsMetaJSON(spec: OpenPkg6, options?: Omit<NavOptions, "format">): string;
 /**
 * Generate Docusaurus sidebar config.
 *
@@ -451,8 +451,8 @@ declare function toFumadocsMetaJSON(spec: OpenPkg5, options?: Omit<NavOptions, "
 * fs.writeFileSync('sidebars.js', sidebar)
 * ```
 */
-declare function toDocusaurusSidebarJS(spec: OpenPkg5, options?: Omit<NavOptions, "format">): string;
-import { OpenPkg as OpenPkg6, SpecExportKind as SpecExportKind3 } from "@openpkg-ts/spec";
+declare function toDocusaurusSidebarJS(spec: OpenPkg6, options?: Omit<NavOptions, "format">): string;
+import { OpenPkg as OpenPkg7, SpecExportKind as SpecExportKind3 } from "@openpkg-ts/spec";
 interface SearchOptions {
 	/** Base URL for search result links */
 	baseUrl?: string;
@@ -545,7 +545,7 @@ interface SearchIndex {
 * // { records: [...], version: '1.0.0', packageName: 'my-lib' }
 * ```
 */
-declare function toSearchIndex2(spec: OpenPkg6, options?: SearchOptions): SearchIndex;
+declare function toSearchIndex2(spec: OpenPkg7, options?: SearchOptions): SearchIndex;
 /**
 * Generate Pagefind-compatible records.
 *
@@ -561,7 +561,7 @@ declare function toSearchIndex2(spec: OpenPkg6, options?: SearchOptions): Search
 * })
 * ```
 */
-declare function toPagefindRecords2(spec: OpenPkg6, options?: SearchOptions): PagefindRecord[];
+declare function toPagefindRecords2(spec: OpenPkg7, options?: SearchOptions): PagefindRecord[];
 /**
 * Generate Algolia-compatible records.
 *
@@ -575,7 +575,7 @@ declare function toPagefindRecords2(spec: OpenPkg6, options?: SearchOptions): Pa
 * // Upload to Algolia index
 * ```
 */
-declare function toAlgoliaRecords2(spec: OpenPkg6, options?: SearchOptions): AlgoliaRecord[];
+declare function toAlgoliaRecords2(spec: OpenPkg7, options?: SearchOptions): AlgoliaRecord[];
 /**
 * Serialize search index to JSON string.
 *
@@ -589,36 +589,36 @@ declare function toAlgoliaRecords2(spec: OpenPkg6, options?: SearchOptions): Alg
 * fs.writeFileSync('search-index.json', json)
 * ```
 */
-declare function toSearchIndexJSON(spec: OpenPkg6, options?: SearchOptions & {
+declare function toSearchIndexJSON(spec: OpenPkg7, options?: SearchOptions & {
 	pretty?: boolean;
 }): string;
 interface LoadOptions {
 	/** Path to openpkg.json file or the spec object directly */
-	input: string | OpenPkg7;
+	input: string | OpenPkg8;
 }
 interface DocsInstance {
 	/** The parsed OpenPkg spec */
-	spec: OpenPkg7;
+	spec: OpenPkg8;
 	/** Get an by its ID */
-	getExport(id: string): SpecExport3 | undefined;
+	getExport(id: string): SpecExport4 | undefined;
 	/** Get a type definition by its ID */
 	getType(id: string): SpecType | undefined;
 	/** Get all exports of a specific kind */
-	getExportsByKind(kind: SpecExportKind4): SpecExport3[];
+	getExportsByKind(kind: SpecExportKind4): SpecExport4[];
 	/** Get all exports */
-	getAllExports(): SpecExport3[];
+	getAllExports(): SpecExport4[];
 	/** Get all type definitions */
 	getAllTypes(): SpecType[];
 	/** Get exports by JSDoc tag (e.g., '@beta', '@internal') */
-	getExportsByTag(tagName: string): SpecExport3[];
+	getExportsByTag(tagName: string): SpecExport4[];
 	/** Search exports by name or description */
-	search(query: string): SpecExport3[];
+	search(query: string): SpecExport4[];
 	/** Get exports belonging to a specific module/namespace */
-	getModule(moduleName: string): SpecExport3[];
+	getModule(moduleName: string): SpecExport4[];
 	/** Get deprecated exports */
-	getDeprecated(): SpecExport3[];
+	getDeprecated(): SpecExport4[];
 	/** Get exports grouped by kind */
-	groupByKind(): Record<SpecExportKind4, SpecExport3[]>;
+	groupByKind(): Record<SpecExportKind4, SpecExport4[]>;
 	/** Render spec or single to MDX */
 	toMarkdown(options?: ExportMarkdownOptions): string;
 	/** Render spec or single to HTML */
@@ -646,7 +646,7 @@ interface DocsInstance {
 * const docs = loadSpec(spec)
 * ```
 */
-declare function loadSpec(spec: OpenPkg7): DocsInstance;
+declare function loadSpec(spec: OpenPkg8): DocsInstance;
 /**
 * Creates a docs instance for querying and rendering API documentation.
 *
@@ -668,8 +668,8 @@ declare function loadSpec(spec: OpenPkg7): DocsInstance;
 * docs.search('hook')
 * ```
 */
-declare function createDocs(input: string | OpenPkg7): DocsInstance;
-import { OpenPkg as OpenPkg8, SpecExport as SpecExport4, SpecMember, SpecSchema, SpecSignature, SpecType as SpecType2, SpecTypeParameter } from "@openpkg-ts/spec";
+declare function createDocs(input: string | OpenPkg8): DocsInstance;
+import { OpenPkg as OpenPkg9, SpecExport as SpecExport5, SpecMember, SpecSchema as SpecSchema2, SpecSignature, SpecType as SpecType2, SpecTypeParameter } from "@openpkg-ts/spec";
 /**
 * Format a schema to a human-readable type string.
 *
@@ -683,7 +683,7 @@ import { OpenPkg as OpenPkg8, SpecExport as SpecExport4, SpecMember, SpecSchema,
 * formatSchema({ anyOf: [{ type: 'string' }, { type: 'number' }] }) // 'string | number'
 * ```
 */
-declare function formatSchema(schema: SpecSchema | undefined): string;
+declare function formatSchema(schema: SpecSchema2 | undefined): string;
 /**
 * Format type parameters to a string like `<T, U extends string>`.
 *
@@ -740,7 +740,7 @@ declare function formatReturnType(sig?: SpecSignature): string;
 * // 'class Logger extends EventEmitter'
 * ```
 */
-declare function buildSignatureString(exp: SpecExport4, sigIndex?: number): string;
+declare function buildSignatureString(exp: SpecExport5, sigIndex?: number): string;
 /**
 * Resolve a type reference to its definition.
 *
@@ -754,7 +754,7 @@ declare function buildSignatureString(exp: SpecExport4, sigIndex?: number): stri
 * // { id: 'User', name: 'User', kind: 'interface', ... }
 * ```
 */
-declare function resolveTypeRef(ref: string, spec: OpenPkg8): SpecType2 | undefined;
+declare function resolveTypeRef(ref: string, spec: OpenPkg9): SpecType2 | undefined;
 /**
 * Check if a member is a method (has signatures).
 *
@@ -816,12 +816,4 @@ declare function groupByVisibility(members?: SpecMember[]): {
 declare function sortByName<T extends {
 	name: string;
 }>(items: T[]): T[];
-/**
-* Sort exports by kind, then name.
-* Kind order: function, class, interface, type, enum, variable, namespace, module, reference, external.
-*
-* @param exports - Array of exports to sort
-* @returns New sorted array
-*/
-declare function sortByKindThenName(exports: SpecExport4[]): SpecExport4[];
-export { toSearchIndexJSON, toSearchIndex2 as toSearchIndex, toPagefindRecords2 as toPagefindRecords, toNavigation2 as toNavigation, toMarkdown2 as toMarkdown, toJSONString, toJSON2 as toJSON, toHTML2 as toHTML, toFumadocsMetaJSON, toDocusaurusSidebarJS, toAlgoliaRecords2 as toAlgoliaRecords, sortByName, sortByKindThenName, resolveTypeRef, loadSpec, isProperty, isMethod, groupByVisibility, getProperties, getMethods, formatTypeParameters, formatSchema, formatReturnType, formatParameters, exportToMarkdown, createDocs, createAdapterRegistry, buildSignatureString, adapterRegistry, SpecTypeParameter2 as SpecTypeParameter, SpecTypeKind, SpecType3 as SpecType, SpecTag, SpecSignatureParameter, SpecSignature2 as SpecSignature, SpecSchema2 as SpecSchema, SpecMember2 as SpecMember, SpecExportKind5 as SpecExportKind, SpecExport5 as SpecExport, SpecExample, SimplifiedSpec, SimplifiedSignature, SimplifiedReturn, SimplifiedParameter, SimplifiedMember, SimplifiedExport, SimplifiedExample, SearchRecord, SearchOptions, SearchIndex, SearchGeneratorOptions, PagefindRecord, PageGeneratorOptions, OpenPkg9 as OpenPkg, NavOptions, NavItem, NavGroup, NavGeneratorOptions, NavFormat, MarkdownOptions, LoadOptions, JSONOptions, HTMLOptions, GroupBy, GenericNav, GeneratedFile, FumadocsMetaItem, FumadocsMeta, FileGenerator, ExportPageProps, ExportMarkdownOptions, DocusaurusSidebarItem, DocusaurusSidebar, DocsInstance, DocFrameworkAdapter, ConfigValidationResult, ConfigOptions, ConfigHelper, AlgoliaRecord, AdapterRegistry, AdapterComponents, APIPageComponentProps };
+export { toSearchIndexJSON, toSearchIndex2 as toSearchIndex, toPagefindRecords2 as toPagefindRecords, toNavigation2 as toNavigation, toMarkdown2 as toMarkdown, toJSONString, toJSON2 as toJSON, toHTML2 as toHTML, toFumadocsMetaJSON, toDocusaurusSidebarJS, toAlgoliaRecords2 as toAlgoliaRecords, sortByName, resolveTypeRef, loadSpec, isProperty, isMethod, groupByVisibility, getProperties, getMethods, formatTypeParameters, formatSchema, formatReturnType, formatParameters, exportToMarkdown, createDocs, createAdapterRegistry, buildSignatureString, adapterRegistry, SpecTypeParameter2 as SpecTypeParameter, SpecTypeKind, SpecType3 as SpecType, SpecTag, SpecSignatureParameter2 as SpecSignatureParameter, SpecSignature2 as SpecSignature, SpecSchema3 as SpecSchema, SpecMember2 as SpecMember, SpecExportKind5 as SpecExportKind, SpecExport6 as SpecExport, SpecExample2 as SpecExample, SimplifiedSpec, SimplifiedSignature, SimplifiedReturn, SimplifiedParameter, SimplifiedMember, SimplifiedExport, SimplifiedExample, SearchRecord, SearchOptions, SearchIndex, SearchGeneratorOptions, PagefindRecord, PageGeneratorOptions, OpenPkg10 as OpenPkg, NavOptions, NavItem, NavGroup, NavGeneratorOptions, NavFormat, MarkdownOptions, LoadOptions, JSONOptions, HTMLOptions, GroupBy, GenericNav, GeneratedFile, FumadocsMetaItem, FumadocsMeta, FileGenerator, ExportPageProps, ExportMarkdownOptions, DocusaurusSidebarItem, DocusaurusSidebar, DocsInstance, DocFrameworkAdapter, ConfigValidationResult, ConfigOptions, ConfigHelper, AlgoliaRecord, AdapterRegistry, AdapterComponents, APIPageComponentProps };

package/dist/index.js

@@ -13,7 +13,6 @@ import {
   isProperty,
   loadSpec,
   resolveTypeRef,
-  sortByKindThenName,
   sortByName,
   toAlgoliaRecords,
   toDocusaurusSidebarJS,
@@ -26,7 +25,7 @@ import {
   toPagefindRecords,
   toSearchIndex,
   toSearchIndexJSON
-} from "./shared/server-83s9r625.js";
+} from "./shared/server-4yabn81t.js";
 
 // src/adapters/types.ts
 function createAdapterRegistry() {
@@ -57,7 +56,6 @@ export {
   toDocusaurusSidebarJS,
   toAlgoliaRecords,
   sortByName,
-  sortByKindThenName,
   resolveTypeRef,
   loadSpec,
   isProperty,

package/dist/react-styled.d.ts

@@ -533,28 +533,26 @@ interface APIPageProps {
 */
 declare function APIPage({ spec, instance, id, baseHref, description, renderExample }: APIPageProps): React.ReactNode;
 import { OpenPkg as OpenPkg8, SpecExport as SpecExport4 } from "@openpkg-ts/spec";
+import { ReactNode as ReactNode2 } from "react";
 interface ClassPageProps {
 	export: SpecExport4;
 	spec: OpenPkg8;
-	/** Custom code example renderer */
-	renderExample?: (code: string, filename: string) => React.ReactNode;
 }
 /**
 * Stripe-style class page with two-column layout.
 * Left: constructor, methods, properties. Right: sticky code examples.
 */
-declare function ClassPage({ export: exp, spec, renderExample }: ClassPageProps): React.ReactNode;
+declare function ClassPage({ export: exp, spec }: ClassPageProps): ReactNode2;
 import { OpenPkg as OpenPkg9, SpecExport as SpecExport5 } from "@openpkg-ts/spec";
+import { ReactNode as ReactNode3 } from "react";
 interface EnumPageProps {
 	export: SpecExport5;
 	spec: OpenPkg9;
-	/** Custom code example renderer */
-	renderExample?: (code: string, filename: string) => React.ReactNode;
 }
 /**
-* Styled enum page component with Tailwind.
+* Stripe-style enum page with two-column layout.
 */
-declare function EnumPage({ export: exp, spec, renderExample }: EnumPageProps): React.ReactNode;
+declare function EnumPage({ export: exp, spec }: EnumPageProps): ReactNode3;
 interface ExportCardProps {
 	/** Function/name */
 	name: string;
@@ -573,7 +571,7 @@ interface ExportCardProps {
 */
 declare function ExportCard({ name, description, href, kind, className }: ExportCardProps): React.ReactNode;
 import { OpenPkg as OpenPkg10 } from "@openpkg-ts/spec";
-import { ReactNode as ReactNode2 } from "react";
+import { ReactNode as ReactNode4 } from "react";
 interface ExportIndexPageProps {
 	/** OpenPkg spec */
 	spec: OpenPkg10;
@@ -592,32 +590,29 @@ interface ExportIndexPageProps {
 * 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, showSearch, showFilters }: ExportIndexPageProps): ReactNode2;
+declare function ExportIndexPage({ spec, baseHref, description, className, showSearch, showFilters }: ExportIndexPageProps): ReactNode4;
 import { OpenPkg as OpenPkg11, SpecExport as SpecExport6 } from "@openpkg-ts/spec";
-import { ReactNode as ReactNode3 } from "react";
+import { ReactNode as ReactNode5 } from "react";
 interface FunctionPageProps {
 	export: SpecExport6;
 	spec: OpenPkg11;
-	/** Custom code example renderer */
-	renderExample?: (code: string, filename: string) => ReactNode3;
 }
 /**
 * Stripe-style function page with two-column layout.
 * Left: parameters, returns. Right: sticky code examples.
 */
-declare function FunctionPage({ export: exp, spec, renderExample }: FunctionPageProps): ReactNode3;
+declare function FunctionPage({ export: exp, spec }: FunctionPageProps): ReactNode5;
 import { OpenPkg as OpenPkg12, SpecExport as SpecExport7 } from "@openpkg-ts/spec";
+import { ReactNode as ReactNode6 } from "react";
 interface InterfacePageProps {
 	export: SpecExport7;
 	spec: OpenPkg12;
-	/** Custom code example renderer */
-	renderExample?: (code: string, filename: string) => React.ReactNode;
 }
 /**
 * Stripe-style interface/type page with two-column layout.
 * Left: properties, methods. Right: sticky code examples.
 */
-declare function InterfacePage({ export: exp, spec, renderExample }: InterfacePageProps): React.ReactNode;
+declare function InterfacePage({ export: exp, spec }: InterfacePageProps): ReactNode6;
 import { SpecSchema as SpecSchema2, SpecSignatureParameter as SpecSignatureParameter4 } from "@openpkg-ts/spec";
 interface ParameterItemProps {
 	/** Parameter to display */
@@ -643,14 +638,13 @@ interface NestedPropertyItemProps {
 */
 declare function ParameterItem({ param, depth, className }: ParameterItemProps): React.ReactNode;
 import { OpenPkg as OpenPkg13, SpecExport as SpecExport8 } from "@openpkg-ts/spec";
+import { ReactNode as ReactNode7 } from "react";
 interface VariablePageProps {
 	export: SpecExport8;
 	spec: OpenPkg13;
-	/** Custom code example renderer */
-	renderExample?: (code: string, filename: string) => React.ReactNode;
 }
 /**
-* Styled variable/constant page component with Tailwind.
+* Stripe-style variable/constant page with two-column layout.
 */
-declare function VariablePage({ export: exp, spec, renderExample }: VariablePageProps): React.ReactNode;
+declare function VariablePage({ export: exp, spec }: VariablePageProps): ReactNode7;
 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 };