@openpkg-ts/fumadocs-adapter 0.6.4 → 0.6.5

package/dist/index.d.ts

@@ -1,3 +1,66 @@
+import { DocsInstance as DocsInstance2, LoadOptions, OpenPkg as OpenPkg2, SpecExample, SpecExport as SpecExport2, SpecExportKind as SpecExportKind2, SpecMember, SpecSchema, SpecSignature, SpecSignatureParameter, SpecTag, SpecType, SpecTypeKind, SpecTypeParameter } from "@openpkg-ts/doc-generator";
+import { AlgoliaRecord, buildSignatureString, createDocs, createDocs as createDocs2, DocsInstance as DocsInstance3, ExportMarkdownOptions, exportToMarkdown, formatParameters, formatReturnType, formatSchema, formatTypeParameters, getMethods, getProperties, groupByVisibility, HTMLOptions, isMethod, isProperty, JSONOptions, LoadOptions as LoadOptions2, loadSpec, MarkdownOptions, NavOptions, PagefindRecord, resolveTypeRef, SearchIndex, SearchOptions, SearchRecord, sortByName, toAlgoliaRecords, toDocusaurusSidebarJS, toFumadocsMetaJSON, toHTML, toJSON, toJSONString, toMarkdown, toNavigation, toPagefindRecords, toSearchIndex, toSearchIndexJSON } from "@openpkg-ts/doc-generator";
+import { APIPage, APIPageProps, ClassPage, ClassPageProps, ClassSection, ClassSectionProps, CodeTab, CodeTabs, CodeTabsProps, EnumPage, EnumPageProps, EnumSection, EnumSectionProps, ExportCard, ExportCardProps, ExportIndexPage, ExportIndexPageProps, ExportSection, ExportSectionProps, FullAPIReferencePage, FullAPIReferencePageProps, FunctionPage, FunctionPageProps, FunctionSection, FunctionSectionProps, ImportSection, ImportSectionProps, InterfacePage, InterfacePageProps, InterfaceSection, InterfaceSectionProps, NestedPropertyItemProps, ParameterItem, ParameterItemProps, VariablePage, VariablePageProps, VariableSection, VariableSectionProps } from "@openpkg-ts/doc-generator/react/styled";
+/**
+* Documentation drift information.
+* Describes a mismatch between docs and code.
+*/
+interface DocDrift {
+	type: string;
+	issue: string;
+	suggestion?: string;
+}
+/**
+* Documentation metadata for an export.
+* Contains coverage score, missing docs, and drift issues.
+*/
+interface DocsMetadata {
+	coverageScore?: number;
+	missing?: string[];
+	drift?: DocDrift[];
+}
+interface CoverageBadgeProps {
+	docs: DocsMetadata;
+	showMissing?: boolean;
+	showDrift?: boolean;
+}
+declare function CoverageBadge({ docs, showMissing, showDrift }: CoverageBadgeProps): React.ReactNode;
+import { SpecExportKind } from "@openpkg-ts/doc-generator";
+import { ReactNode as ReactNode2 } from "react";
+interface SidebarKindBadgeProps {
+	kind: SpecExportKind;
+	className?: string;
+}
+/**
+* Sidebar badge component for fumadocs page tree.
+* Wraps @doccov/ui KindBadge with size="sm" for sidebar use.
+*
+* Uses createElement instead of JSX for compatibility with
+* fumadocs transformPageTree server context.
+*/
+declare function SidebarKindBadge({ kind, className }: SidebarKindBadgeProps): ReactNode2;
+import { LoaderPlugin } from "fumadocs-core/source";
+interface OpenpkgPluginOptions {
+	/** Show kind badges in sidebar (default: true) */
+	showBadges?: boolean;
+}
+/**
+* Fumadocs loader plugin that enhances page tree nodes with kind badges.
+*
+* @example
+* ```ts
+* import { loader } from 'fumadocs-core/source';
+* import { openpkgSource, openpkgPlugin } from '@openpkg-ts/fumadocs-adapter';
+* import spec from './openpkg.json';
+*
+* const source = loader({
+*   baseUrl: '/docs/api',
+*   source: openpkgSource({ spec }),
+*   plugins: [openpkgPlugin()],
+* });
+* ```
+*/
+declare function openpkgPlugin(options?: OpenpkgPluginOptions): LoaderPlugin;
 import { Source } from "fumadocs-core/source";
 import { DocsInstance, OpenPkg, SpecExport } from "@openpkg-ts/doc-generator";
 interface OpenPkgSourceOptions {
@@ -75,63 +138,4 @@ declare function openpkgSource(options: OpenPkgSourceOptions): Source<{
 	pageData: OpenPkgPageData | OpenPkgIndexPageData | OpenPkgSinglePageData
 	metaData: OpenPkgMetaData
 }>;
-import { LoaderPlugin } from "fumadocs-core/source";
-import { SpecExportKind } from "@openpkg-ts/doc-generator";
-import { ReactNode as ReactNode2 } from "react";
-interface KindBadgeProps {
-	kind: SpecExportKind;
-	className?: string;
-}
-/**
-* Badge component to display kind in sidebar.
-*/
-declare function KindBadge({ kind, className }: KindBadgeProps): ReactNode2;
-interface OpenpkgPluginOptions {
-	/** Show kind badges in sidebar (default: true) */
-	showBadges?: boolean;
-}
-/**
-* Fumadocs loader plugin that enhances page tree nodes with kind badges.
-*
-* @example
-* ```ts
-* import { loader } from 'fumadocs-core/source';
-* import { openpkgSource, openpkgPlugin } from '@openpkg-ts/fumadocs-adapter';
-* import spec from './openpkg.json';
-*
-* const source = loader({
-*   baseUrl: '/docs/api',
-*   source: openpkgSource({ spec }),
-*   plugins: [openpkgPlugin()],
-* });
-* ```
-*/
-declare function openpkgPlugin(options?: OpenpkgPluginOptions): LoaderPlugin;
-import { DocsInstance as DocsInstance2, LoadOptions, OpenPkg as OpenPkg2, SpecExample, SpecExport as SpecExport2, SpecExportKind as SpecExportKind2, SpecMember, SpecSchema, SpecSignature, SpecSignatureParameter, SpecTag, SpecType, SpecTypeKind, SpecTypeParameter } from "@openpkg-ts/doc-generator";
-import { AlgoliaRecord, buildSignatureString, createDocs, createDocs as createDocs2, DocsInstance as DocsInstance3, ExportMarkdownOptions, exportToMarkdown, formatParameters, formatReturnType, formatSchema, formatTypeParameters, getMethods, getProperties, groupByVisibility, HTMLOptions, isMethod, isProperty, JSONOptions, LoadOptions as LoadOptions2, loadSpec, MarkdownOptions, NavOptions, PagefindRecord, resolveTypeRef, SearchIndex, SearchOptions, SearchRecord, sortByName, toAlgoliaRecords, toDocusaurusSidebarJS, toFumadocsMetaJSON, toHTML, toJSON, toJSONString, toMarkdown, toNavigation, toPagefindRecords, toSearchIndex, toSearchIndexJSON } from "@openpkg-ts/doc-generator";
-import { APIPage, APIPageProps, ClassPage, ClassPageProps, ClassSection, ClassSectionProps, CodeTabs, CodeTab, CodeTabsProps, EnumPage, EnumPageProps, EnumSection, EnumSectionProps, ExportCard, ExportCardProps, ExportIndexPage, ExportIndexPageProps, ExportSection, ExportSectionProps, FullAPIReferencePage, FullAPIReferencePageProps, FunctionPage, FunctionPageProps, FunctionSection, FunctionSectionProps, ImportSection, ImportSectionProps, InterfacePage, InterfacePageProps, InterfaceSection, InterfaceSectionProps, NestedPropertyItemProps, ParameterItem, ParameterItemProps, VariablePage, VariablePageProps, VariableSection, VariableSectionProps } from "@openpkg-ts/doc-generator/react/styled";
-/**
-* Documentation drift information.
-* Describes a mismatch between docs and code.
-*/
-interface DocDrift {
-	type: string;
-	issue: string;
-	suggestion?: string;
-}
-/**
-* Documentation metadata for an export.
-* Contains coverage score, missing docs, and drift issues.
-*/
-interface DocsMetadata {
-	coverageScore?: number;
-	missing?: string[];
-	drift?: DocDrift[];
-}
-interface CoverageBadgeProps {
-	docs: DocsMetadata;
-	showMissing?: boolean;
-	showDrift?: boolean;
-}
-declare function CoverageBadge({ docs, showMissing, showDrift }: CoverageBadgeProps): React.ReactNode;
-export { toSearchIndexJSON, toSearchIndex, toPagefindRecords, toNavigation, toMarkdown, toJSONString, toJSON, toHTML, toFumadocsMetaJSON, toDocusaurusSidebarJS, toAlgoliaRecords, sortByName, resolveTypeRef, openpkgSource, openpkgPlugin, loadSpec, isProperty, isMethod, groupByVisibility, getProperties, getMethods, formatTypeParameters, formatSchema, formatReturnType, formatParameters, exportToMarkdown, createDocs2 as createOpenPkg, createDocs, buildSignatureString, VariableSectionProps, VariableSection, VariablePageProps, VariablePage, SpecTypeParameter, SpecTypeKind, SpecType, SpecTag, SpecSignatureParameter, SpecSignature, SpecSchema, SpecMember, SpecExportKind2 as SpecExportKind, SpecExport2 as SpecExport, SpecExample, SearchRecord, SearchOptions, SearchIndex, ParameterItemProps, ParameterItem, PagefindRecord, OpenpkgPluginOptions, OpenPkgSourceOptions, OpenPkgSinglePageData, OpenPkgPageData, LoadOptions as OpenPkgOptions, OpenPkgMetaData, DocsInstance2 as OpenPkgInstance, OpenPkgIndexPageData, OpenPkg2 as OpenPkg, NestedPropertyItemProps, NavOptions, MarkdownOptions, LoadOptions2 as LoadOptions, KindBadgeProps, KindBadge, JSONOptions, InterfaceSectionProps, InterfaceSection, InterfacePageProps, InterfacePage, ImportSectionProps, ImportSection, HTMLOptions, FunctionSectionProps, FunctionSection, FunctionPageProps, FunctionPage, FullAPIReferencePageProps, FullAPIReferencePage, ExportSectionProps, ExportSection, ExportMarkdownOptions, ExportIndexPageProps, ExportIndexPage, ExportCardProps, ExportCard, EnumSectionProps, EnumSection, EnumPageProps, EnumPage, DocsMetadata, DocsInstance3 as DocsInstance, DocDrift, CoverageBadgeProps, CoverageBadge, CodeTabsProps, CodeTabs, CodeTab, ClassSectionProps, ClassSection, ClassPageProps, ClassPage, AlgoliaRecord, APIPageProps, APIPage };
+export { toSearchIndexJSON, toSearchIndex, toPagefindRecords, toNavigation, toMarkdown, toJSONString, toJSON, toHTML, toFumadocsMetaJSON, toDocusaurusSidebarJS, toAlgoliaRecords, sortByName, resolveTypeRef, openpkgSource, openpkgPlugin, loadSpec, isProperty, isMethod, groupByVisibility, getProperties, getMethods, formatTypeParameters, formatSchema, formatReturnType, formatParameters, exportToMarkdown, createDocs2 as createOpenPkg, createDocs, buildSignatureString, VariableSectionProps, VariableSection, VariablePageProps, VariablePage, SpecTypeParameter, SpecTypeKind, SpecType, SpecTag, SpecSignatureParameter, SpecSignature, SpecSchema, SpecMember, SpecExportKind2 as SpecExportKind, SpecExport2 as SpecExport, SpecExample, SidebarKindBadgeProps, SidebarKindBadge, SearchRecord, SearchOptions, SearchIndex, ParameterItemProps, ParameterItem, PagefindRecord, OpenpkgPluginOptions, OpenPkgSourceOptions, OpenPkgSinglePageData, OpenPkgPageData, LoadOptions as OpenPkgOptions, OpenPkgMetaData, DocsInstance2 as OpenPkgInstance, OpenPkgIndexPageData, OpenPkg2 as OpenPkg, NestedPropertyItemProps, NavOptions, MarkdownOptions, LoadOptions2 as LoadOptions, SidebarKindBadgeProps as KindBadgeProps, SidebarKindBadge as KindBadge, JSONOptions, InterfaceSectionProps, InterfaceSection, InterfacePageProps, InterfacePage, ImportSectionProps, ImportSection, HTMLOptions, FunctionSectionProps, FunctionSection, FunctionPageProps, FunctionPage, FullAPIReferencePageProps, FullAPIReferencePage, ExportSectionProps, ExportSection, ExportMarkdownOptions, ExportIndexPageProps, ExportIndexPage, ExportCardProps, ExportCard, EnumSectionProps, EnumSection, EnumPageProps, EnumPage, DocsMetadata, DocsInstance3 as DocsInstance, DocDrift, CoverageBadgeProps, CoverageBadge, CodeTabsProps, CodeTabs, CodeTab, ClassSectionProps, ClassSection, ClassPageProps, ClassPage, AlgoliaRecord, APIPageProps, APIPage };