@doccov/fumadocs-adapter 0.0.1

package/bunup.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from 'bunup';
+
+export default defineConfig({
+  entry: ['src/index.ts', 'src/server.ts', 'src/components/index.ts'],
+  dts: true,
+  clean: true,
+  format: ['esm'],
+  external: ['react', 'react-dom', '@doccov/ui'],
+});
+

package/dist/components/index.d.ts

@@ -0,0 +1,160 @@
+import { OpenPkg, SpecExport, SpecExportKind, SpecType } from "@openpkg-ts/spec";
+interface OpenPkgInstance {
+	/** The parsed OpenPkg spec */
+	spec: OpenPkg;
+	/** Get an by its ID */
+	getExport(id: string): SpecExport | undefined;
+	/** Get a type definition by its ID */
+	getType(id: string): SpecType | undefined;
+	/** Get all exports of a specific kind */
+	getExportsByKind(kind: SpecExportKind): SpecExport[];
+	/** Get all exports */
+	getAllExports(): SpecExport[];
+	/** Get all type definitions */
+	getAllTypes(): SpecType[];
+}
+import { OpenPkg as OpenPkg2 } from "@openpkg-ts/spec";
+interface APIPageProps {
+	/** Direct spec object */
+	spec?: OpenPkg2;
+	/** Or server instance from createOpenPkg() */
+	instance?: OpenPkgInstance;
+	/** Export ID to render */
+	id: string;
+}
+/**
+* Main API page component that renders documentation for a single export.
+*
+* @example
+* ```tsx
+* import { APIPage } from '@doccov/fumadocs-adapter';
+* import spec from './openpkg.json';
+*
+* <APIPage spec={spec} id="createClient" />
+* ```
+*
+* @example
+* ```tsx
+* // With server instance
+* import { APIPage } from '@doccov/fumadocs-adapter';
+* import { openpkg } from '@/lib/openpkg';
+*
+* <APIPage instance={openpkg} id="createClient" />
+* ```
+*/
+declare function APIPage({ spec, instance, id }: APIPageProps);
+import { OpenPkg as OpenPkg3, SpecExport as SpecExport2 } from "@openpkg-ts/spec";
+interface FunctionPageProps {
+	export: SpecExport2;
+	spec: OpenPkg3;
+}
+declare function FunctionPage({ export: exp, spec }: FunctionPageProps);
+import { OpenPkg as OpenPkg4, SpecExport as SpecExport3 } from "@openpkg-ts/spec";
+interface ClassPageProps {
+	export: SpecExport3;
+	spec: OpenPkg4;
+}
+declare function ClassPage({ export: exp, spec }: ClassPageProps);
+import { OpenPkg as OpenPkg5, SpecExport as SpecExport4 } from "@openpkg-ts/spec";
+interface InterfacePageProps {
+	export: SpecExport4;
+	spec: OpenPkg5;
+}
+declare function InterfacePage({ export: exp, spec }: InterfacePageProps);
+import { OpenPkg as OpenPkg6, SpecExport as SpecExport5 } from "@openpkg-ts/spec";
+interface EnumPageProps {
+	export: SpecExport5;
+	spec: OpenPkg6;
+}
+declare function EnumPage({ export: exp, spec }: EnumPageProps);
+import { OpenPkg as OpenPkg7, SpecExport as SpecExport6 } from "@openpkg-ts/spec";
+interface VariablePageProps {
+	export: SpecExport6;
+	spec: OpenPkg7;
+}
+declare function VariablePage({ export: exp, spec }: VariablePageProps);
+import { OpenPkg as OpenPkg8, SpecSignatureParameter, SpecMember } from "@openpkg-ts/spec";
+interface TypeTableProps {
+	items: (SpecSignatureParameter | SpecMember)[];
+	spec?: OpenPkg8;
+	showRequired?: boolean;
+}
+declare function TypeTable({ items, showRequired }: TypeTableProps);
+import { SpecExport as SpecExport7 } from "@openpkg-ts/spec";
+interface SignatureProps {
+	export: SpecExport7;
+	signatureIndex?: number;
+}
+declare function Signature({ export: exp, signatureIndex }: SignatureProps);
+interface ExamplesSectionProps {
+	examples: string[];
+}
+declare function ExamplesSection({ examples }: ExamplesSectionProps);
+import { SpecDocsMetadata } from "@openpkg-ts/spec";
+interface CoverageBadgeProps {
+	docs: SpecDocsMetadata;
+	showMissing?: boolean;
+	showDrift?: boolean;
+}
+declare function CoverageBadge({ docs, showMissing, showDrift }: CoverageBadgeProps);
+import { SpecMember as SpecMember2, OpenPkg as OpenPkg9 } from "@openpkg-ts/spec";
+interface MembersSectionProps {
+	members: SpecMember2[];
+	spec?: OpenPkg9;
+	title?: string;
+}
+declare function MembersSection({ members, spec, title }: MembersSectionProps);
+import { OpenPkg as OpenPkg10, SpecSignatureParameter as SpecSignatureParameter2 } from "@openpkg-ts/spec";
+interface ParameterCardProps {
+	param: SpecSignatureParameter2;
+	spec?: OpenPkg10;
+}
+declare function ParameterCard({ param, spec }: ParameterCardProps);
+interface CodeExampleProps {
+	code: string;
+	filename?: string;
+	language?: string;
+}
+declare function CodeExample({ code, filename, language }: CodeExampleProps);
+import { SpecSignatureParameter as SpecSignatureParameter3, SpecSchema } from "@openpkg-ts/spec";
+interface ExpandablePropertyProps {
+	param: SpecSignatureParameter3;
+	depth?: number;
+}
+interface NestedPropertyProps {
+	name: string;
+	schema: SpecSchema;
+	required?: boolean;
+	depth?: number;
+}
+/**
+* Nested property row with expandable nested objects
+*/
+declare function NestedProperty({ name, schema, required, depth }: NestedPropertyProps);
+/**
+* Top-level expandable property for method parameters
+* Entry point for rendering a parameter with progressive disclosure
+*/
+declare function ExpandableProperty({ param, depth }: ExpandablePropertyProps);
+import { SpecMember as SpecMember3 } from "@openpkg-ts/spec";
+interface CollapsibleMethodProps {
+	member: SpecMember3;
+	defaultExpanded?: boolean;
+}
+/**
+* Collapsible method section with expand/collapse behavior
+* Shows compact signature when collapsed, full details when expanded
+*/
+declare function CollapsibleMethod({ member, defaultExpanded }: CollapsibleMethodProps);
+import { SpecMember as SpecMember4 } from "@openpkg-ts/spec";
+interface MethodSectionProps {
+	member: SpecMember4;
+	/** @deprecated Use CollapsibleMethod directly with defaultExpanded */
+	defaultExpanded?: boolean;
+}
+/**
+* Method display section with collapsible behavior
+* @deprecated Use CollapsibleMethod directly for more control
+*/
+declare function MethodSection({ member, defaultExpanded }: MethodSectionProps);
+export { VariablePageProps, VariablePage, TypeTableProps, TypeTable, SignatureProps, Signature, ParameterCardProps, ParameterCard, NestedPropertyProps, NestedProperty, MethodSectionProps, MethodSection, MembersSectionProps, MembersSection, InterfacePageProps, InterfacePage, FunctionPageProps, FunctionPage, ExpandablePropertyProps, ExpandableProperty, ExamplesSectionProps, ExamplesSection, EnumPageProps, EnumPage, CoverageBadgeProps, CoverageBadge, CollapsibleMethodProps, CollapsibleMethod, CodeExampleProps, CodeExample, ClassPageProps, ClassPage, APIPageProps, APIPage };

package/dist/components/index.js

@@ -0,0 +1,237 @@
+"use client";
+import {
+  APIPage,
+  ClassPage,
+  CodeExample,
+  CollapsibleMethod,
+  CoverageBadge,
+  EnumPage,
+  ExamplesSection,
+  ExpandableProperty,
+  FunctionPage,
+  InterfacePage,
+  NestedProperty,
+  ParameterCard,
+  Signature,
+  TypeTable,
+  VariablePage
+} from "../shared/chunk-pqaj3kdh.js";
+// src/components/members-section.tsx
+import { jsxDEV } from "react/jsx-dev-runtime";
+
+function formatSchema(schema) {
+  if (!schema)
+    return "unknown";
+  if (typeof schema === "string")
+    return schema;
+  if (typeof schema === "object" && schema !== null) {
+    const s = schema;
+    if (s.$ref && typeof s.$ref === "string") {
+      return s.$ref.replace("#/types/", "");
+    }
+    if (s.tsType)
+      return String(s.tsType);
+    if (s.type)
+      return String(s.type);
+  }
+  return "unknown";
+}
+function groupMembersByKind(members) {
+  const groups = {
+    constructors: [],
+    properties: [],
+    methods: [],
+    accessors: [],
+    other: []
+  };
+  for (const member of members) {
+    const kind = member.kind?.toLowerCase() ?? "other";
+    if (kind === "constructor") {
+      groups.constructors.push(member);
+    } else if (kind === "property" || kind === "field") {
+      groups.properties.push(member);
+    } else if (kind === "method" || kind === "function") {
+      groups.methods.push(member);
+    } else if (kind === "getter" || kind === "setter" || kind === "accessor") {
+      groups.accessors.push(member);
+    } else {
+      groups.other.push(member);
+    }
+  }
+  return groups;
+}
+function MemberRow({ member }) {
+  const visibility = member.visibility ?? "public";
+  const isStatic = member.flags?.static;
+  const isAbstract = member.flags?.abstract;
+  const isReadonly = member.flags?.readonly;
+  const badges = [];
+  if (visibility !== "public")
+    badges.push(visibility);
+  if (isStatic)
+    badges.push("static");
+  if (isAbstract)
+    badges.push("abstract");
+  if (isReadonly)
+    badges.push("readonly");
+  const type = formatSchema(member.schema);
+  const sig = member.signatures?.[0];
+  let signature = "";
+  if (sig) {
+    const params = sig.parameters?.map((p) => {
+      const optional = p.required === false ? "?" : "";
+      return `${p.name}${optional}: ${formatSchema(p.schema)}`;
+    }) ?? [];
+    const returnType = sig.returns?.tsType ?? formatSchema(sig.returns?.schema) ?? "void";
+    signature = `(${params.join(", ")}): ${returnType}`;
+  }
+  return /* @__PURE__ */ jsxDEV("div", {
+    className: "py-3 border-b border-fd-border last:border-0",
+    children: [
+      /* @__PURE__ */ jsxDEV("div", {
+        className: "flex items-start gap-2",
+        children: [
+          /* @__PURE__ */ jsxDEV("code", {
+            className: "font-mono text-sm text-fd-primary",
+            children: [
+              member.name,
+              signature
+            ]
+          }, undefined, true, undefined, this),
+          badges.length > 0 && /* @__PURE__ */ jsxDEV("div", {
+            className: "flex gap-1",
+            children: badges.map((badge) => /* @__PURE__ */ jsxDEV("span", {
+              className: "text-xs px-1.5 py-0.5 rounded bg-fd-secondary text-fd-muted-foreground",
+              children: badge
+            }, badge, false, undefined, this))
+          }, undefined, false, undefined, this)
+        ]
+      }, undefined, true, undefined, this),
+      !signature && type !== "unknown" && /* @__PURE__ */ jsxDEV("code", {
+        className: "text-xs text-fd-muted-foreground font-mono mt-1 block",
+        children: type
+      }, undefined, false, undefined, this),
+      member.description && /* @__PURE__ */ jsxDEV("p", {
+        className: "text-sm text-fd-muted-foreground mt-1",
+        children: member.description
+      }, undefined, false, undefined, this)
+    ]
+  }, undefined, true, undefined, this);
+}
+function MembersSection({ members, spec, title = "Members" }) {
+  if (!members?.length)
+    return null;
+  const groups = groupMembersByKind(members);
+  return /* @__PURE__ */ jsxDEV("div", {
+    className: "my-6",
+    children: [
+      /* @__PURE__ */ jsxDEV("h3", {
+        className: "text-lg font-semibold mb-3",
+        children: title
+      }, undefined, false, undefined, this),
+      groups.constructors.length > 0 && /* @__PURE__ */ jsxDEV("div", {
+        className: "mb-6",
+        children: [
+          /* @__PURE__ */ jsxDEV("h4", {
+            className: "text-sm font-medium text-fd-muted-foreground mb-2 uppercase tracking-wide",
+            children: "Constructor"
+          }, undefined, false, undefined, this),
+          /* @__PURE__ */ jsxDEV("div", {
+            className: "rounded-lg border border-fd-border bg-fd-card",
+            children: groups.constructors.map((member, index) => /* @__PURE__ */ jsxDEV(MemberRow, {
+              member
+            }, member.name ?? index, false, undefined, this))
+          }, undefined, false, undefined, this)
+        ]
+      }, undefined, true, undefined, this),
+      groups.properties.length > 0 && /* @__PURE__ */ jsxDEV("div", {
+        className: "mb-6",
+        children: [
+          /* @__PURE__ */ jsxDEV("h4", {
+            className: "text-sm font-medium text-fd-muted-foreground mb-2 uppercase tracking-wide",
+            children: "Properties"
+          }, undefined, false, undefined, this),
+          /* @__PURE__ */ jsxDEV("div", {
+            className: "rounded-lg border border-fd-border bg-fd-card",
+            children: groups.properties.map((member, index) => /* @__PURE__ */ jsxDEV(MemberRow, {
+              member
+            }, member.name ?? index, false, undefined, this))
+          }, undefined, false, undefined, this)
+        ]
+      }, undefined, true, undefined, this),
+      groups.methods.length > 0 && /* @__PURE__ */ jsxDEV("div", {
+        className: "mb-6",
+        children: [
+          /* @__PURE__ */ jsxDEV("h4", {
+            className: "text-sm font-medium text-fd-muted-foreground mb-2 uppercase tracking-wide",
+            children: "Methods"
+          }, undefined, false, undefined, this),
+          /* @__PURE__ */ jsxDEV("div", {
+            className: "rounded-lg border border-fd-border bg-fd-card",
+            children: groups.methods.map((member, index) => /* @__PURE__ */ jsxDEV(MemberRow, {
+              member
+            }, member.name ?? index, false, undefined, this))
+          }, undefined, false, undefined, this)
+        ]
+      }, undefined, true, undefined, this),
+      groups.accessors.length > 0 && /* @__PURE__ */ jsxDEV("div", {
+        className: "mb-6",
+        children: [
+          /* @__PURE__ */ jsxDEV("h4", {
+            className: "text-sm font-medium text-fd-muted-foreground mb-2 uppercase tracking-wide",
+            children: "Accessors"
+          }, undefined, false, undefined, this),
+          /* @__PURE__ */ jsxDEV("div", {
+            className: "rounded-lg border border-fd-border bg-fd-card",
+            children: groups.accessors.map((member, index) => /* @__PURE__ */ jsxDEV(MemberRow, {
+              member
+            }, member.name ?? index, false, undefined, this))
+          }, undefined, false, undefined, this)
+        ]
+      }, undefined, true, undefined, this),
+      groups.other.length > 0 && /* @__PURE__ */ jsxDEV("div", {
+        className: "mb-6",
+        children: [
+          /* @__PURE__ */ jsxDEV("h4", {
+            className: "text-sm font-medium text-fd-muted-foreground mb-2 uppercase tracking-wide",
+            children: "Other"
+          }, undefined, false, undefined, this),
+          /* @__PURE__ */ jsxDEV("div", {
+            className: "rounded-lg border border-fd-border bg-fd-card",
+            children: groups.other.map((member, index) => /* @__PURE__ */ jsxDEV(MemberRow, {
+              member
+            }, member.name ?? index, false, undefined, this))
+          }, undefined, false, undefined, this)
+        ]
+      }, undefined, true, undefined, this)
+    ]
+  }, undefined, true, undefined, this);
+}
+// src/components/method-section.tsx
+import { jsxDEV as jsxDEV2 } from "react/jsx-dev-runtime";
+
+function MethodSection({ member, defaultExpanded = false }) {
+  return /* @__PURE__ */ jsxDEV2(CollapsibleMethod, {
+    member,
+    defaultExpanded
+  }, undefined, false, undefined, this);
+}
+export {
+  VariablePage,
+  TypeTable,
+  Signature,
+  ParameterCard,
+  NestedProperty,
+  MethodSection,
+  MembersSection,
+  InterfacePage,
+  FunctionPage,
+  ExpandableProperty,
+  ExamplesSection,
+  EnumPage,
+  CoverageBadge,
+  CollapsibleMethod,
+  CodeExample,
+  ClassPage,
+  APIPage
+};

package/dist/index.d.ts

@@ -0,0 +1,64 @@
+import { OpenPkg, SpecExport, SpecExportKind, SpecType } from "@openpkg-ts/spec";
+interface OpenPkgOptions {
+	/** Path to openpkg.json file or the spec object directly */
+	input: string | OpenPkg;
+}
+interface OpenPkgInstance {
+	/** The parsed OpenPkg spec */
+	spec: OpenPkg;
+	/** Get an by its ID */
+	getExport(id: string): SpecExport | undefined;
+	/** Get a type definition by its ID */
+	getType(id: string): SpecType | undefined;
+	/** Get all exports of a specific kind */
+	getExportsByKind(kind: SpecExportKind): SpecExport[];
+	/** Get all exports */
+	getAllExports(): SpecExport[];
+	/** Get all type definitions */
+	getAllTypes(): SpecType[];
+}
+/**
+* Creates an OpenPkg instance for use with Fumadocs components.
+*
+* @example
+* ```ts
+* // From file path
+* const openpkg = createOpenPkg({ input: './openpkg.json' });
+*
+* // From spec object
+* import spec from './openpkg.json';
+* const openpkg = createOpenPkg({ input: spec });
+* ```
+*/
+declare function createOpenPkg(options: OpenPkgOptions): OpenPkgInstance;
+import { OpenPkg as OpenPkg2 } from "@openpkg-ts/spec";
+interface APIPageProps {
+	/** Direct spec object */
+	spec?: OpenPkg2;
+	/** Or server instance from createOpenPkg() */
+	instance?: OpenPkgInstance;
+	/** Export ID to render */
+	id: string;
+}
+/**
+* Main API page component that renders documentation for a single export.
+*
+* @example
+* ```tsx
+* import { APIPage } from '@doccov/fumadocs-adapter';
+* import spec from './openpkg.json';
+*
+* <APIPage spec={spec} id="createClient" />
+* ```
+*
+* @example
+* ```tsx
+* // With server instance
+* import { APIPage } from '@doccov/fumadocs-adapter';
+* import { openpkg } from '@/lib/openpkg';
+*
+* <APIPage instance={openpkg} id="createClient" />
+* ```
+*/
+declare function APIPage({ spec, instance, id }: APIPageProps);
+export { createOpenPkg, OpenPkgOptions, OpenPkgInstance, APIPageProps, APIPage };

package/dist/index.js

@@ -0,0 +1,10 @@
+import {
+  createOpenPkg
+} from "./server.js";
+import {
+  APIPage
+} from "./shared/chunk-pqaj3kdh.js";
+export {
+  createOpenPkg,
+  APIPage
+};

package/dist/server.d.ts

@@ -0,0 +1,34 @@
+import { OpenPkg, SpecExport, SpecExportKind, SpecType } from "@openpkg-ts/spec";
+interface OpenPkgOptions {
+	/** Path to openpkg.json file or the spec object directly */
+	input: string | OpenPkg;
+}
+interface OpenPkgInstance {
+	/** The parsed OpenPkg spec */
+	spec: OpenPkg;
+	/** Get an by its ID */
+	getExport(id: string): SpecExport | undefined;
+	/** Get a type definition by its ID */
+	getType(id: string): SpecType | undefined;
+	/** Get all exports of a specific kind */
+	getExportsByKind(kind: SpecExportKind): SpecExport[];
+	/** Get all exports */
+	getAllExports(): SpecExport[];
+	/** Get all type definitions */
+	getAllTypes(): SpecType[];
+}
+/**
+* Creates an OpenPkg instance for use with Fumadocs components.
+*
+* @example
+* ```ts
+* // From file path
+* const openpkg = createOpenPkg({ input: './openpkg.json' });
+*
+* // From spec object
+* import spec from './openpkg.json';
+* const openpkg = createOpenPkg({ input: spec });
+* ```
+*/
+declare function createOpenPkg(options: OpenPkgOptions): OpenPkgInstance;
+export { createOpenPkg, OpenPkgOptions, OpenPkgInstance };

package/dist/server.js

@@ -0,0 +1,38 @@
+// src/server.ts
+import * as fs from "node:fs";
+function createOpenPkg(options) {
+  const spec = typeof options.input === "string" ? JSON.parse(fs.readFileSync(options.input, "utf-8")) : options.input;
+  const exportsById = new Map;
+  const typesById = new Map;
+  for (const exp of spec.exports) {
+    exportsById.set(exp.id, exp);
+  }
+  if (spec.types) {
+    for (const type of spec.types) {
+      typesById.set(type.id, type);
+    }
+  }
+  return {
+    spec,
+    getExport(id) {
+      return exportsById.get(id);
+    },
+    getType(id) {
+      return typesById.get(id);
+    },
+    getExportsByKind(kind) {
+      return spec.exports.filter((exp) => exp.kind === kind);
+    },
+    getAllExports() {
+      return spec.exports;
+    },
+    getAllTypes() {
+      return spec.types ?? [];
+    }
+  };
+}
+export {
+  createOpenPkg
+};
+
+export { createOpenPkg };