@openpkg-ts/adapters 0.2.1 → 0.3.0

package/README.md

@@ -2,6 +2,44 @@
 
 Framework adapters for OpenPkg API documentation.
 
+## Adapter Registry
+
+Self-registering adapter pattern for extensibility.
+
+```typescript
+import { registerAdapter, getAdapter, listAdapters } from '@openpkg-ts/adapters';
+
+// List available adapters
+const adapters = listAdapters();
+
+// Get adapter by id
+const fumadocs = getAdapter('fumadocs');
+await fumadocs.generate(spec, './docs/api');
+```
+
+### Creating Custom Adapters
+
+```typescript
+import { registerAdapter, type DocAdapter } from '@openpkg-ts/adapters';
+
+const myAdapter: DocAdapter = {
+  id: 'my-adapter',
+  name: 'My Adapter',
+  generate: async (spec, outDir) => {
+    // Generate docs to outDir
+  },
+};
+
+registerAdapter(myAdapter);
+```
+
+### CLI Integration
+
+```bash
+# Use adapter via CLI
+openpkg docs openpkg.json --adapter fumadocs -o docs/api/
+```
+
 ## Fumadocs
 
 ```bash
@@ -20,6 +58,8 @@ export const apiSource = loader({
 });
 ```
 
+Self-registers on import - no manual registration needed.
+
 ### CSS
 
 ```css
@@ -41,6 +81,12 @@ import { SidebarKindBadge } from '@openpkg-ts/adapters/fumadocs/components';
 | `mode` | `'pages' \| 'single'` | `'pages'` | Navigation mode |
 | `indexPage` | `boolean` | `true` | Generate index page |
 
+## Types
+
+```typescript
+import type { DocAdapter } from '@openpkg-ts/adapters';
+```
+
 ## Future Adapters
 
 - `@openpkg-ts/adapters/docusaurus` (planned)

package/dist/{components → fumadocs/components}/index.js

@@ -1,6 +1,6 @@
 import {
   SidebarKindBadge
-} from "../shared/chunk-t3t704xs.js";
+} from "../../shared/chunk-t3t704xs.js";
 export {
   SidebarKindBadge
 };

package/dist/{index.js → fumadocs/index.js}

@@ -1,11 +1,17 @@
+import {
+  registerAdapter
+} from "../registry.js";
 import {
   SidebarKindBadge
-} from "./shared/chunk-t3t704xs.js";
+} from "../shared/chunk-t3t704xs.js";
 
 // src/fumadocs/index.ts
+import * as fs from "node:fs";
+import * as path from "node:path";
+import { createDocs as createDocs2 } from "@openpkg-ts/sdk";
 import {
   buildSignatureString,
-  createDocs as createDocs2,
+  createDocs as createDocs3,
   exportToMarkdown,
   formatParameters,
   formatReturnType,
@@ -198,6 +204,25 @@ function openpkgSource(options) {
   }
   return { files };
 }
+
+// src/fumadocs/index.ts
+var fumadocsAdapter = {
+  id: "fumadocs",
+  name: "Fumadocs",
+  generate: async (spec, outDir) => {
+    const docs = createDocs2(spec);
+    const exports = docs.getAllExports();
+    if (!fs.existsSync(outDir)) {
+      fs.mkdirSync(outDir, { recursive: true });
+    }
+    for (const exp of exports) {
+      const content = docs.toMarkdown({ export: exp.id, frontmatter: true, codeSignatures: true });
+      const filename = `${exp.name}.md`;
+      fs.writeFileSync(path.join(outDir, filename), content);
+    }
+  }
+};
+registerAdapter(fumadocsAdapter);
 export {
   toSearchIndexJSON,
   toSearchIndex,
@@ -225,7 +250,7 @@ export {
   formatReturnType,
   formatParameters,
   exportToMarkdown,
-  createDocs2 as createDocs,
+  createDocs3 as createDocs,
   buildSignatureString,
   SidebarKindBadge,
   SidebarKindBadge as KindBadge

package/dist/registry.d.ts

@@ -0,0 +1,26 @@
+import { OpenPkg } from "@openpkg-ts/spec";
+/**
+* Doc adapter interface for extensible documentation generation.
+*/
+interface DocAdapter {
+	/** Unique adapter identifier */
+	id: string;
+	/** Human-readable name */
+	name: string;
+	/** Generate documentation to output directory */
+	generate: (spec: OpenPkg, outDir: string) => Promise<void>;
+}
+/**
+* Register a documentation adapter.
+*/
+declare function registerAdapter(adapter: DocAdapter): void;
+/**
+* Get an adapter by ID.
+* @returns The adapter or undefined if not found
+*/
+declare function getAdapter(id: string): DocAdapter | undefined;
+/**
+* List all registered adapters.
+*/
+declare function listAdapters(): DocAdapter[];
+export { registerAdapter, listAdapters, getAdapter, DocAdapter };

package/dist/registry.js

@@ -0,0 +1,18 @@
+// src/registry.ts
+var registry = new Map;
+function registerAdapter(adapter) {
+  registry.set(adapter.id, adapter);
+}
+function getAdapter(id) {
+  return registry.get(id);
+}
+function listAdapters() {
+  return Array.from(registry.values());
+}
+export {
+  registerAdapter,
+  listAdapters,
+  getAdapter
+};
+
+export { registerAdapter };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openpkg-ts/adapters",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Framework adapters for OpenPkg - Fumadocs, Docusaurus, Mintlify, etc.",
   "keywords": [
     "openpkg",
@@ -20,9 +20,13 @@
   "author": "Ryan Waits",
   "type": "module",
   "exports": {
+    ".": {
+      "import": "./src/registry.ts",
+      "types": "./src/registry.ts"
+    },
     "./fumadocs": {
-      "import": "./dist/index.js",
-      "types": "./dist/index.d.ts"
+      "import": "./src/fumadocs/index.ts",
+      "types": "./src/fumadocs/index.ts"
     },
     "./fumadocs/components": {
       "import": "./dist/components/index.js",
@@ -41,8 +45,8 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@openpkg-ts/sdk": "^0.30.1",
-    "@openpkg-ts/spec": "^0.27.1",
+    "@openpkg-ts/sdk": "^0.31.0",
+    "@openpkg-ts/spec": "^0.31.0",
     "@openpkg-ts/ui": "^0.1.2"
   },
   "peerDependencies": {