@openpkg-ts/fumadocs-adapter 0.2.4 → 0.3.0

package/dist/index.d.ts

@@ -1,5 +1,80 @@
-import { DocsInstance, LoadOptions, OpenPkg, SpecExample, SpecExport, SpecExportKind, SpecMember, SpecSchema, SpecSignature, SpecSignatureParameter, SpecTag, SpecType, SpecTypeKind, SpecTypeParameter } from "@openpkg-ts/doc-generator";
-import { AlgoliaRecord, buildSignatureString, createDocs, createDocs as createDocs2, DocsInstance as DocsInstance2, ExportMarkdownOptions, exportToMarkdown, formatParameters, formatReturnType, formatSchema, formatTypeParameters, getMethods, getProperties, groupByVisibility, HTMLOptions, isMethod, isProperty, JSONOptions, LoadOptions as LoadOptions2, loadSpec, MarkdownOptions, NavOptions, PagefindRecord, resolveTypeRef, SearchIndex, SearchOptions, SearchRecord, sortByKindThenName, sortByName, toAlgoliaRecords, toDocusaurusSidebarJS, toFumadocsMetaJSON, toHTML, toJSON, toJSONString, toMarkdown, toNavigation, toPagefindRecords, toSearchIndex, toSearchIndexJSON } from "@openpkg-ts/doc-generator";
+import { Source } from "fumadocs-core/source";
+import { DocsInstance, OpenPkg, SpecExport } from "@openpkg-ts/doc-generator";
+interface OpenPkgSourceOptions {
+	/** OpenPkg spec or DocsInstance */
+	spec: OpenPkg | DocsInstance;
+	/** Base directory for pages (default: 'api') */
+	baseDir?: string;
+}
+interface OpenPkgPageData {
+	title: string;
+	description?: string;
+	/** The from the spec */
+	export: SpecExport;
+	/** The full OpenPkg spec */
+	spec: OpenPkg;
+}
+interface OpenPkgMetaData {
+	title: string;
+	pages: string[];
+	defaultOpen?: boolean;
+}
+/**
+* Create a virtual source for Fumadocs from an OpenPkg spec.
+*
+* This generates virtual pages grouped by kind (functions, types, etc.)
+* that integrate with Fumadocs' loader and sidebar.
+*
+* @example
+* ```ts
+* import { loader } from 'fumadocs-core/source';
+* import { openpkgSource } from '@openpkg-ts/fumadocs-adapter';
+* import spec from './openpkg.json';
+*
+* const source = loader({
+*   baseUrl: '/docs/api',
+*   source: openpkgSource({ spec }),
+* });
+* ```
+*/
+declare function openpkgSource(options: OpenPkgSourceOptions): Source<{
+	pageData: OpenPkgPageData
+	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, sortByKindThenName, sortByName, toAlgoliaRecords, toDocusaurusSidebarJS, toFumadocsMetaJSON, toHTML, toJSON, toJSONString, toMarkdown, toNavigation, toPagefindRecords, toSearchIndex, toSearchIndexJSON } from "@openpkg-ts/doc-generator";
 import { APIPage, APIPageProps, ClassPage, ClassPageProps, CodeTabs, CodeTab, CodeTabsProps, EnumPage, EnumPageProps, ExportCard, ExportCardProps, ExportIndexPage, ExportIndexPageProps, FunctionPage, FunctionPageProps, ImportSection, ImportSectionProps, InterfacePage, InterfacePageProps, NestedPropertyItemProps, ParameterItem, ParameterItemProps, VariablePage, VariablePageProps } from "@openpkg-ts/doc-generator/react/styled";
 /**
 * Documentation drift information.
@@ -25,4 +100,4 @@ interface CoverageBadgeProps {
 	showDrift?: boolean;
 }
 declare function CoverageBadge({ docs, showMissing, showDrift }: CoverageBadgeProps): React.ReactNode;
-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, createDocs2 as createOpenPkg, createDocs, buildSignatureString, VariablePageProps, VariablePage, SpecTypeParameter, SpecTypeKind, SpecType, SpecTag, SpecSignatureParameter, SpecSignature, SpecSchema, SpecMember, SpecExportKind, SpecExport, SpecExample, SearchRecord, SearchOptions, SearchIndex, ParameterItemProps, ParameterItem, PagefindRecord, LoadOptions as OpenPkgOptions, DocsInstance as OpenPkgInstance, OpenPkg, NestedPropertyItemProps, NavOptions, MarkdownOptions, LoadOptions2 as LoadOptions, JSONOptions, InterfacePageProps, InterfacePage, ImportSectionProps, ImportSection, HTMLOptions, FunctionPageProps, FunctionPage, ExportMarkdownOptions, ExportIndexPageProps, ExportIndexPage, ExportCardProps, ExportCard, EnumPageProps, EnumPage, DocsMetadata, DocsInstance2 as DocsInstance, DocDrift, CoverageBadgeProps, CoverageBadge, CodeTabsProps, CodeTabs, CodeTab, ClassPageProps, ClassPage, AlgoliaRecord, APIPageProps, APIPage };
+export { toSearchIndexJSON, toSearchIndex, toPagefindRecords, toNavigation, toMarkdown, toJSONString, toJSON, toHTML, toFumadocsMetaJSON, toDocusaurusSidebarJS, toAlgoliaRecords, sortByName, sortByKindThenName, resolveTypeRef, openpkgSource, openpkgPlugin, loadSpec, isProperty, isMethod, groupByVisibility, getProperties, getMethods, formatTypeParameters, formatSchema, formatReturnType, formatParameters, exportToMarkdown, createDocs2 as createOpenPkg, createDocs, buildSignatureString, 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, OpenPkgPageData, LoadOptions as OpenPkgOptions, OpenPkgMetaData, DocsInstance2 as OpenPkgInstance, OpenPkg2 as OpenPkg, NestedPropertyItemProps, NavOptions, MarkdownOptions, LoadOptions2 as LoadOptions, KindBadgeProps, KindBadge, JSONOptions, InterfacePageProps, InterfacePage, ImportSectionProps, ImportSection, HTMLOptions, FunctionPageProps, FunctionPage, ExportMarkdownOptions, ExportIndexPageProps, ExportIndexPage, ExportCardProps, ExportCard, EnumPageProps, EnumPage, DocsMetadata, DocsInstance3 as DocsInstance, DocDrift, CoverageBadgeProps, CoverageBadge, CodeTabsProps, CodeTabs, CodeTab, ClassPageProps, ClassPage, AlgoliaRecord, APIPageProps, APIPage };

package/dist/index.js

@@ -2,11 +2,140 @@ import {
   CoverageBadge
 } from "./shared/chunk-a91ch1vp.js";
 
+// src/source.ts
+import { createDocs } from "@openpkg-ts/doc-generator";
+var KIND_ORDER = [
+  "function",
+  "class",
+  "interface",
+  "type",
+  "enum",
+  "variable"
+];
+var KIND_LABELS = {
+  function: "Functions",
+  class: "Classes",
+  interface: "Interfaces",
+  type: "Types",
+  enum: "Enums",
+  variable: "Variables",
+  namespace: "Namespaces",
+  module: "Modules",
+  reference: "References",
+  external: "External"
+};
+function openpkgSource(options) {
+  const { baseDir = "api" } = options;
+  const docs = "getAllExports" in options.spec ? options.spec : createDocs(options.spec);
+  const spec = docs.spec;
+  const exports = docs.getAllExports();
+  const groupedByKind = new Map;
+  for (const exp of exports) {
+    const kind = exp.kind;
+    if (!groupedByKind.has(kind)) {
+      groupedByKind.set(kind, []);
+    }
+    groupedByKind.get(kind).push(exp);
+  }
+  const files = [];
+  const rootPages = [];
+  for (const kind of KIND_ORDER) {
+    if (groupedByKind.has(kind)) {
+      rootPages.push(`...${kind}s`);
+    }
+  }
+  files.push({
+    type: "meta",
+    path: `${baseDir}/meta.json`,
+    data: {
+      title: spec.meta.name || "API Reference",
+      pages: rootPages,
+      defaultOpen: true
+    }
+  });
+  for (const kind of KIND_ORDER) {
+    const kindExports = groupedByKind.get(kind);
+    if (!kindExports || kindExports.length === 0)
+      continue;
+    const kindDir = `${baseDir}/${kind}s`;
+    const label = KIND_LABELS[kind] || `${kind}s`;
+    const sortedExports = [...kindExports].sort((a, b) => a.name.localeCompare(b.name));
+    files.push({
+      type: "meta",
+      path: `${kindDir}/meta.json`,
+      data: {
+        title: label,
+        pages: sortedExports.map((exp) => exp.id),
+        defaultOpen: false
+      }
+    });
+    for (const exp of sortedExports) {
+      files.push({
+        type: "page",
+        path: `${kindDir}/${exp.id}.mdx`,
+        slugs: [kind + "s", exp.id],
+        data: {
+          title: exp.name,
+          description: exp.description,
+          export: exp,
+          spec
+        }
+      });
+    }
+  }
+  return { files };
+}
+// src/plugin.ts
+import { createElement } from "react";
+var KIND_BADGES = {
+  function: { label: "fn", className: "openpkg-badge-function" },
+  class: { label: "C", className: "openpkg-badge-class" },
+  interface: { label: "I", className: "openpkg-badge-interface" },
+  type: { label: "T", className: "openpkg-badge-type" },
+  enum: { label: "E", className: "openpkg-badge-enum" },
+  variable: { label: "V", className: "openpkg-badge-variable" },
+  namespace: { label: "N", className: "openpkg-badge-namespace" },
+  module: { label: "M", className: "openpkg-badge-module" },
+  reference: { label: "R", className: "openpkg-badge-reference" },
+  external: { label: "X", className: "openpkg-badge-external" }
+};
+function KindBadge({ kind, className }) {
+  const badge = KIND_BADGES[kind];
+  if (!badge)
+    return null;
+  return createElement("span", {
+    className: `openpkg-kind-badge ${badge.className} ${className || ""}`.trim(),
+    "data-kind": kind
+  }, badge.label);
+}
+function openpkgPlugin(options = {}) {
+  const { showBadges = true } = options;
+  return {
+    name: "openpkg",
+    transformPageTree: {
+      file(node, filePath) {
+        if (!showBadges || !filePath)
+          return node;
+        const file = this.storage.read(filePath);
+        if (!file || file.format !== "page")
+          return node;
+        const pageData = file.data;
+        const kind = pageData.export?.kind;
+        if (!kind || !KIND_BADGES[kind])
+          return node;
+        const badge = createElement(KindBadge, { kind });
+        const newName = createElement("span", { className: "openpkg-sidebar-item" }, badge, node.name);
+        return { ...node, name: newName };
+      }
+    }
+  };
+}
+
 // src/index.ts
 import {
   buildSignatureString,
-  createDocs,
   createDocs as createDocs2,
+  createDocs as createDocs3,
   exportToMarkdown,
   formatParameters,
   formatReturnType,
@@ -61,6 +190,8 @@ export {
   sortByName,
   sortByKindThenName,
   resolveTypeRef,
+  openpkgSource,
+  openpkgPlugin,
   loadSpec,
   isProperty,
   isMethod,
@@ -72,11 +203,12 @@ export {
   formatReturnType,
   formatParameters,
   exportToMarkdown,
-  createDocs2 as createOpenPkg,
-  createDocs,
+  createDocs3 as createOpenPkg,
+  createDocs2 as createDocs,
   buildSignatureString,
   VariablePage,
   ParameterItem,
+  KindBadge,
   InterfacePage,
   ImportSection,
   FunctionPage,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openpkg-ts/fumadocs-adapter",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "Fumadocs integration for OpenPkg API documentation",
   "type": "module",
   "sideEffects": false,
@@ -28,14 +28,16 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@openpkg-ts/doc-generator": "^0.2.0"
+    "@openpkg-ts/doc-generator": "^0.2.2"
   },
   "peerDependencies": {
+    "fumadocs-core": "^16.0.0",
     "react": "^18 || ^19"
   },
   "devDependencies": {
     "@types/react": "^19.0.0",
     "bunup": "^0.11.5",
+    "fumadocs-core": "^16.4.0",
     "typescript": "^5.0.0"
   }
 }