@openpkg-ts/fumadocs-adapter 0.2.1 → 0.2.3

package/package.json

@@ -1,14 +1,26 @@
 {
   "name": "@openpkg-ts/fumadocs-adapter",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "Fumadocs integration for OpenPkg API documentation",
   "type": "module",
   "sideEffects": false,
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
-    ".": "./src/index.ts",
-    "./components": "./src/components/index.ts",
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./components": {
+      "import": "./dist/components/index.js",
+      "types": "./dist/components/index.d.ts"
+    },
     "./css": "./src/styles/docskit.css"
   },
+  "files": [
+    "dist",
+    "src/styles"
+  ],
   "scripts": {
     "build": "bunup",
     "lint": "biome check src/",

package/CHANGELOG.md

@@ -1,45 +0,0 @@
-# @openpkg-ts/fumadocs-adapter
-
-## 0.2.1
-
-### Patch Changes
-
-- version bump for republish
-
-## 0.2.0
-
-### Minor Changes
-
-- Rename package from @doccov/fumadocs-adapter to @openpkg-ts/fumadocs-adapter
-
-## 0.1.0
-
-### Minor Changes
-
-- Initial release of @openpkg-ts/doc-generator
-
-  - Core API: createDocs(), loadSpec() for loading OpenPkg specs
-  - Query utilities: formatSchema(), buildSignatureString(), member filtering and sorting
-  - Renderers: Markdown/MDX, HTML, JSON output formats
-  - Navigation: Fumadocs, Docusaurus, and generic nav generation
-  - Search: Pagefind and Algolia compatible indexes
-  - React components: Headless (unstyled) and styled (Tailwind v4) variants
-  - CLI: generate, build, dev commands
-  - Adapter architecture: Extensible framework integration pattern
-
-### Patch Changes
-
-- Updated dependencies
-  - @openpkg-ts/doc-generator@0.1.0
-
-## 0.0.3
-
-### Patch Changes
-
-- Remove deprecated `tsType` field in favor of `schema`, add CLI warning when `--runtime` requested without built code
-
-## 0.0.2
-
-### Patch Changes
-
-- update components and configuration

package/bunup.config.ts

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

package/examples/01-basic-usage.ts

@@ -1,103 +0,0 @@
-/**
- * Example: Fumadocs Adapter Basic Usage
- *
- * Run from fumadocs-adapter: bun examples/01-basic-usage.ts
- */
-
-import {
-  buildSignatureString,
-  // Core API (re-exported from doc-generator)
-  createDocs,
-  createOpenPkg, // backward compat alias
-  // Query utilities
-  formatSchema,
-  getMethods,
-  getProperties,
-  toFumadocsMetaJSON,
-  // Render utilities
-  toMarkdown,
-  toNavigation,
-  // Search
-  toSearchIndex,
-} from '../src/index';
-
-// Sample spec for testing
-const sampleSpec = {
-  openpkg: '0.4.0',
-  meta: {
-    ecosystem: 'js/ts',
-    name: 'test-package',
-    version: '1.0.0',
-  },
-  exports: [
-    {
-      id: 'hello',
-      name: 'hello',
-      kind: 'function',
-      description: 'Say hello',
-      signatures: [
-        {
-          parameters: [{ name: 'name', required: true, schema: { type: 'string' } }],
-          returns: { schema: { type: 'string' } },
-        },
-      ],
-    },
-    {
-      id: 'Config',
-      name: 'Config',
-      kind: 'interface',
-      description: 'Configuration interface',
-      members: [
-        { name: 'debug', kind: 'property', schema: { type: 'boolean' }, optional: true },
-        { name: 'timeout', kind: 'property', schema: { type: 'number' } },
-      ],
-    },
-  ],
-  types: [],
-} as any;
-
-console.log('=== Fumadocs Adapter Usage ===\n');
-
-// Use createDocs (preferred)
-const docs = createDocs(sampleSpec);
-console.log('Package:', docs.spec.meta.name);
-console.log('Exports:', docs.getAllExports().length);
-
-// Or use createOpenPkg (backward compat)
-const openpkg = createOpenPkg(sampleSpec);
-console.log('\nUsing createOpenPkg (backward compat):');
-console.log('Same API:', openpkg.spec.meta.name);
-
-// Query
-console.log('\n--- Query ---');
-const hello = docs.getExport('hello');
-if (hello) {
-  console.log('Signature:', buildSignatureString(hello));
-}
-
-const config = docs.getExport('Config');
-if (config?.members) {
-  console.log(
-    'Config properties:',
-    getProperties(config.members)
-      .map((p) => p.name)
-      .join(', '),
-  );
-}
-
-// Render
-console.log('\n--- Render ---');
-const md = docs.toMarkdown({ export: 'hello' });
-console.log('Markdown:\n', md);
-
-// Navigation for Fumadocs
-console.log('\n--- Fumadocs Navigation ---');
-const meta = toFumadocsMetaJSON(sampleSpec, { basePath: '/api' });
-console.log(meta);
-
-// Search index
-console.log('\n--- Search Index ---');
-const searchIndex = toSearchIndex(sampleSpec);
-console.log('Records:', searchIndex.records.length);
-
-console.log('\n=== Done ===');

package/src/components/coverage-badge.tsx

@@ -1,110 +0,0 @@
-'use client';
-
-/**
- * Documentation drift information.
- * Describes a mismatch between docs and code.
- */
-export interface DocDrift {
-  type: string;
-  issue: string;
-  suggestion?: string;
-}
-
-/**
- * Documentation metadata for an export.
- * Contains coverage score, missing docs, and drift issues.
- */
-export interface DocsMetadata {
-  coverageScore?: number;
-  missing?: string[];
-  drift?: DocDrift[];
-}
-
-export interface CoverageBadgeProps {
-  docs: DocsMetadata;
-  showMissing?: boolean;
-  showDrift?: boolean;
-}
-
-function getScoreColor(score: number): string {
-  if (score >= 80) return 'text-green-600 dark:text-green-400 bg-green-500/10 border-green-500/20';
-  if (score >= 60)
-    return 'text-yellow-600 dark:text-yellow-400 bg-yellow-500/10 border-yellow-500/20';
-  return 'text-red-600 dark:text-red-400 bg-red-500/10 border-red-500/20';
-}
-
-function formatSignal(signal: string): string {
-  return signal.charAt(0).toUpperCase() + signal.slice(1);
-}
-
-export function CoverageBadge({
-  docs,
-  showMissing = true,
-  showDrift = true,
-}: CoverageBadgeProps): React.ReactNode {
-  const score = docs.coverageScore;
-  const hasMissing = showMissing && docs.missing && docs.missing.length > 0;
-  const hasDrift = showDrift && docs.drift && docs.drift.length > 0;
-
-  if (score == null && !hasMissing && !hasDrift) return null;
-
-  return (
-    <div className="my-6 space-y-3">
-      {score != null && (
-        <div
-          className={`inline-flex items-center gap-2 px-3 py-1.5 rounded-md border text-sm font-medium ${getScoreColor(score)}`}
-        >
-          <svg
-            className="w-4 h-4"
-            fill="none"
-            stroke="currentColor"
-            viewBox="0 0 24 24"
-            aria-hidden="true"
-          >
-            <path
-              strokeLinecap="round"
-              strokeLinejoin="round"
-              strokeWidth={2}
-              d="M9 12l2 2 4-4m6 2a9 9 0 11-18 0 9 9 0 0118 0z"
-            />
-          </svg>
-          Coverage: {score}%
-        </div>
-      )}
-
-      {hasMissing && (
-        <div className="rounded-md bg-yellow-500/10 border border-yellow-500/20 px-3 py-2">
-          <p className="text-sm font-medium text-yellow-600 dark:text-yellow-400 mb-1">
-            Missing Documentation
-          </p>
-          <ul className="text-sm text-yellow-600/80 dark:text-yellow-400/80 list-disc list-inside">
-            {docs.missing!.map((signal) => (
-              <li key={signal}>{formatSignal(signal)}</li>
-            ))}
-          </ul>
-        </div>
-      )}
-
-      {hasDrift && (
-        <div className="rounded-md bg-red-500/10 border border-red-500/20 px-3 py-2">
-          <p className="text-sm font-medium text-red-600 dark:text-red-400 mb-1">
-            Documentation Drift
-          </p>
-          <ul className="text-sm text-red-600/80 dark:text-red-400/80 space-y-1">
-            {docs.drift!.map((drift) => (
-              <li key={`${drift.type}-${drift.issue}`} className="flex flex-col">
-                <span className="font-medium">{drift.type}</span>
-                <span className="text-xs opacity-80">{drift.issue}</span>
-                {drift.suggestion && (
-                  <span className="text-xs text-fd-muted-foreground mt-0.5">
-                    Suggestion: {drift.suggestion}
-                  </span>
-                )}
-              </li>
-            ))}
-          </ul>
-        </div>
-      )}
-    </div>
-  );
-}

package/src/components/index.ts

@@ -1,42 +0,0 @@
-// CoverageBadge is doccov-specific, stays in fumadocs-adapter
-
-// Re-export headless components from doc-generator
-export {
-  CollapsibleMethod,
-  type CollapsibleMethodProps,
-  ExampleBlock,
-  type ExampleBlockProps,
-  ExpandableProperty,
-  type ExpandablePropertyProps,
-  MemberRow,
-  type MemberRowProps,
-  MembersTable,
-  type MembersTableProps,
-  NestedProperty,
-  type NestedPropertyProps,
-  ParamRow,
-  type ParamRowProps,
-  ParamTable,
-  type ParamTableProps,
-  Signature,
-  type SignatureProps,
-  TypeTable,
-  type TypeTableProps,
-} from '@openpkg-ts/doc-generator/react';
-// Re-export all styled components from doc-generator
-export {
-  APIPage,
-  type APIPageProps,
-  ClassPage,
-  type ClassPageProps,
-  EnumPage,
-  type EnumPageProps,
-  FunctionPage,
-  type FunctionPageProps,
-  InterfacePage,
-  type InterfacePageProps,
-  VariablePage,
-  type VariablePageProps,
-} from '@openpkg-ts/doc-generator/react/styled';
-export type { CoverageBadgeProps, DocDrift, DocsMetadata } from './coverage-badge';
-export { CoverageBadge } from './coverage-badge';

package/src/index.ts

@@ -1,83 +0,0 @@
-// Re-export core from @openpkg-ts/doc-generator
-
-// Re-export spec types for convenience
-export type {
-  DocsInstance as OpenPkgInstance,
-  LoadOptions as OpenPkgOptions,
-  OpenPkg,
-  SpecExample,
-  SpecExport,
-  SpecExportKind,
-  SpecMember,
-  SpecSchema,
-  SpecSignature,
-  SpecSignatureParameter,
-  SpecTag,
-  SpecType,
-  SpecTypeKind,
-  SpecTypeParameter,
-} from '@openpkg-ts/doc-generator';
-export {
-  type AlgoliaRecord,
-  buildSignatureString,
-  createDocs,
-  createDocs as createOpenPkg,
-  type DocsInstance,
-  type ExportMarkdownOptions,
-  exportToMarkdown,
-  formatParameters,
-  formatReturnType,
-  formatSchema,
-  formatTypeParameters,
-  getMethods,
-  getProperties,
-  groupByVisibility,
-  type HTMLOptions,
-  isMethod,
-  isProperty,
-  type JSONOptions,
-  type LoadOptions,
-  loadSpec,
-  type MarkdownOptions,
-  type NavOptions,
-  type PagefindRecord,
-  resolveTypeRef,
-  type SearchIndex,
-  type SearchOptions,
-  type SearchRecord,
-  sortByKindThenName,
-  sortByName,
-  toAlgoliaRecords,
-  toDocusaurusSidebarJS,
-  toFumadocsMetaJSON,
-  toHTML,
-  toJSON,
-  toJSONString,
-  toMarkdown,
-  toNavigation,
-  toPagefindRecords,
-  toSearchIndex,
-  toSearchIndexJSON,
-} from '@openpkg-ts/doc-generator';
-// Re-export styled components (most common use case)
-export {
-  APIPage,
-  type APIPageProps,
-  ClassPage,
-  type ClassPageProps,
-  EnumPage,
-  type EnumPageProps,
-  FunctionPage,
-  type FunctionPageProps,
-  InterfacePage,
-  type InterfacePageProps,
-  VariablePage,
-  type VariablePageProps,
-} from '@openpkg-ts/doc-generator/react/styled';
-// Re-export CoverageBadge (doccov-specific)
-export {
-  CoverageBadge,
-  type CoverageBadgeProps,
-  type DocDrift,
-  type DocsMetadata,
-} from './components/coverage-badge';

package/tsconfig.json

@@ -1,20 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2022",
-    "module": "ESNext",
-    "moduleResolution": "bundler",
-    "lib": ["ES2022", "DOM"],
-    "jsx": "react-jsx",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true,
-    "declaration": true,
-    "declarationMap": true,
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "resolveJsonModule": true
-  },
-  "include": ["src/**/*"],
-  "exclude": ["node_modules", "dist"]
-}