lokicms-plugin-api-docs 1.0.0

package/README.md

@@ -0,0 +1,220 @@
+# lokicms-plugin-api-docs
+
+API documentation generator for LokiCMS with OpenAPI, Markdown, and TypeScript output support.
+
+## Features
+
+- **Runtime Introspection**: Automatically discovers registered MCP tools and content types
+- **Multiple Output Formats**: JSON, Markdown, OpenAPI 3.0, TypeScript interfaces
+- **Zod Schema Conversion**: Converts Zod schemas to JSON Schema for documentation
+- **5 MCP Tools**: Full control via Model Context Protocol
+
+## Installation
+
+```bash
+npm install lokicms-plugin-api-docs
+```
+
+## Usage
+
+```typescript
+import apiDocsPlugin from 'lokicms-plugin-api-docs';
+
+const cms = createLokiCMS({
+  plugins: [apiDocsPlugin],
+  apiDocs: {
+    title: 'My API',
+    version: '1.0.0',
+    description: 'API documentation for my LokiCMS project',
+    baseUrl: 'http://localhost:3000',
+    includeExamples: true,
+  },
+});
+```
+
+## MCP Tools
+
+| Tool | Description |
+|------|-------------|
+| `docs_generate` | Generate complete API documentation in specified format |
+| `docs_tools` | List all available MCP tools with their schemas |
+| `docs_content_types` | Document all content types and their fields |
+| `docs_export` | Export documentation to a file |
+| `docs_endpoints` | Generate REST-like endpoint documentation |
+
+### docs_generate
+
+Generate complete API documentation.
+
+```json
+{
+  "format": "openapi",
+  "includeTools": true,
+  "includeContentTypes": true,
+  "includeExamples": true,
+  "baseUrl": "https://api.example.com"
+}
+```
+
+### docs_tools
+
+List all available MCP tools.
+
+```json
+{
+  "format": "markdown",
+  "filter": "vault",
+  "includeExamples": true
+}
+```
+
+### docs_content_types
+
+Document content types.
+
+```json
+{
+  "format": "typescript",
+  "filter": "product"
+}
+```
+
+### docs_export
+
+Export documentation to a file.
+
+```json
+{
+  "format": "openapi",
+  "outputPath": "./docs/api.json"
+}
+```
+
+### docs_endpoints
+
+Generate endpoint documentation.
+
+```json
+{
+  "format": "markdown",
+  "groupByTag": true
+}
+```
+
+## Output Formats
+
+### JSON
+
+Raw structured JSON output with all documentation data.
+
+### Markdown
+
+Human-readable documentation with tables and formatting:
+
+```markdown
+# My API Documentation
+
+## MCP Tools
+
+### vault_create
+Create a new credential
+
+**Parameters:**
+| Name | Type | Required | Description |
+|------|------|----------|-------------|
+| `name` | string | Yes | Credential name |
+...
+```
+
+### OpenAPI 3.0
+
+Standard OpenAPI specification for use with Swagger UI, Postman, etc.
+
+```json
+{
+  "openapi": "3.0.0",
+  "info": {
+    "title": "My API",
+    "version": "1.0.0"
+  },
+  "paths": {
+    "/mcp/vault_create": {
+      "post": {
+        "summary": "Create a new credential",
+        ...
+      }
+    }
+  }
+}
+```
+
+### TypeScript
+
+Generated TypeScript interfaces for type-safe frontend integration:
+
+```typescript
+/**
+ * Create a new credential
+ */
+export interface VaultCreateInput {
+  /** Credential name */
+  name: string;
+  /** Credential value */
+  value: string;
+  /** Project identifier */
+  project: string;
+  // ...
+}
+```
+
+## Programmatic Usage
+
+```typescript
+import {
+  getDocGenerator,
+  formatAsOpenApi,
+  generateTypeScript,
+} from 'lokicms-plugin-api-docs';
+
+// Get the documentation generator
+const docGen = getDocGenerator();
+
+// Generate documentation
+const docs = await docGen.generate({
+  includeTools: true,
+  includeContentTypes: true,
+  includeExamples: true,
+});
+
+// Format as OpenAPI
+const openApiSpec = formatAsOpenApi(docs, {
+  baseUrl: 'https://api.example.com',
+});
+
+// Generate TypeScript interfaces
+const tsOutput = generateTypeScript(docs);
+console.log(tsOutput.code);
+```
+
+## Configuration
+
+```typescript
+interface ApiDocsConfig {
+  /** API title for documentation */
+  title?: string;
+  /** API version */
+  version?: string;
+  /** API description */
+  description?: string;
+  /** Base URL for endpoints */
+  baseUrl?: string;
+  /** Include example values in documentation */
+  includeExamples?: boolean;
+  /** Default output directory for exports */
+  outputDir?: string;
+}
+```
+
+## License
+
+MIT

package/dist/formatters/json-formatter.d.ts

@@ -0,0 +1,25 @@
+/**
+ * JSON Formatter
+ * Outputs API documentation as formatted JSON
+ */
+import type { ApiDocumentation } from '../types.js';
+/**
+ * Format documentation as JSON
+ */
+export declare function formatAsJson(docs: ApiDocumentation, options?: {
+    pretty?: boolean;
+    includeMetadata?: boolean;
+}): string;
+/**
+ * Format a subset of documentation as JSON
+ */
+export declare function formatToolsAsJson(tools: ApiDocumentation['tools'], pretty?: boolean): string;
+/**
+ * Format content types as JSON
+ */
+export declare function formatContentTypesAsJson(contentTypes: ApiDocumentation['contentTypes'], pretty?: boolean): string;
+/**
+ * Format endpoints as JSON
+ */
+export declare function formatEndpointsAsJson(endpoints: ApiDocumentation['endpoints'], pretty?: boolean): string;
+//# sourceMappingURL=json-formatter.d.ts.map

package/dist/formatters/json-formatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-formatter.d.ts","sourceRoot":"","sources":["../../src/formatters/json-formatter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAEpD;;GAEG;AACH,wBAAgB,YAAY,CAC1B,IAAI,EAAE,gBAAgB,EACtB,OAAO,GAAE;IACP,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,eAAe,CAAC,EAAE,OAAO,CAAC;CACtB,GACL,MAAM,CAcR;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAC/B,KAAK,EAAE,gBAAgB,CAAC,OAAO,CAAC,EAChC,MAAM,UAAO,GACZ,MAAM,CAIR;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CACtC,YAAY,EAAE,gBAAgB,CAAC,cAAc,CAAC,EAC9C,MAAM,UAAO,GACZ,MAAM,CAIR;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,SAAS,EAAE,gBAAgB,CAAC,WAAW,CAAC,EACxC,MAAM,UAAO,GACZ,MAAM,CAIR"}

package/dist/formatters/json-formatter.js

@@ -0,0 +1,45 @@
+/**
+ * JSON Formatter
+ * Outputs API documentation as formatted JSON
+ */
+/**
+ * Format documentation as JSON
+ */
+export function formatAsJson(docs, options = {}) {
+    const { pretty = true, includeMetadata = true } = options;
+    const output = includeMetadata
+        ? docs
+        : {
+            tools: docs.tools,
+            contentTypes: docs.contentTypes,
+            endpoints: docs.endpoints,
+        };
+    return pretty
+        ? JSON.stringify(output, null, 2)
+        : JSON.stringify(output);
+}
+/**
+ * Format a subset of documentation as JSON
+ */
+export function formatToolsAsJson(tools, pretty = true) {
+    return pretty
+        ? JSON.stringify({ tools }, null, 2)
+        : JSON.stringify({ tools });
+}
+/**
+ * Format content types as JSON
+ */
+export function formatContentTypesAsJson(contentTypes, pretty = true) {
+    return pretty
+        ? JSON.stringify({ contentTypes }, null, 2)
+        : JSON.stringify({ contentTypes });
+}
+/**
+ * Format endpoints as JSON
+ */
+export function formatEndpointsAsJson(endpoints, pretty = true) {
+    return pretty
+        ? JSON.stringify({ endpoints }, null, 2)
+        : JSON.stringify({ endpoints });
+}
+//# sourceMappingURL=json-formatter.js.map

package/dist/formatters/json-formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"json-formatter.js","sourceRoot":"","sources":["../../src/formatters/json-formatter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH;;GAEG;AACH,MAAM,UAAU,YAAY,CAC1B,IAAsB,EACtB,UAGI,EAAE;IAEN,MAAM,EAAE,MAAM,GAAG,IAAI,EAAE,eAAe,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAE1D,MAAM,MAAM,GAAG,eAAe;QAC5B,CAAC,CAAC,IAAI;QACN,CAAC,CAAC;YACE,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,YAAY,EAAE,IAAI,CAAC,YAAY;YAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IAEN,OAAO,MAAM;QACX,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC,CAAC;QACjC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAC7B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,iBAAiB,CAC/B,KAAgC,EAChC,MAAM,GAAG,IAAI;IAEb,OAAO,MAAM;QACX,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QACpC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;AAChC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,wBAAwB,CACtC,YAA8C,EAC9C,MAAM,GAAG,IAAI;IAEb,OAAO,MAAM;QACX,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,YAAY,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3C,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,YAAY,EAAE,CAAC,CAAC;AACvC,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,SAAwC,EACxC,MAAM,GAAG,IAAI;IAEb,OAAO,MAAM;QACX,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;QACxC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,SAAS,EAAE,CAAC,CAAC;AACpC,CAAC"}

package/dist/formatters/markdown-formatter.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Markdown Formatter
+ * Outputs API documentation as readable Markdown
+ */
+import type { ApiDocumentation, ToolDocumentation, ContentTypeDocumentation } from '../types.js';
+/**
+ * Format complete documentation as Markdown
+ */
+export declare function formatAsMarkdown(docs: ApiDocumentation, options?: {
+    includeTableOfContents?: boolean;
+    includeExamples?: boolean;
+}): string;
+/**
+ * Format tools only as Markdown
+ */
+export declare function formatToolsAsMarkdown(tools: ToolDocumentation[], includeExamples?: boolean): string;
+/**
+ * Format content types only as Markdown
+ */
+export declare function formatContentTypesAsMarkdown(contentTypes: ContentTypeDocumentation[]): string;
+//# sourceMappingURL=markdown-formatter.d.ts.map

package/dist/formatters/markdown-formatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-formatter.d.ts","sourceRoot":"","sources":["../../src/formatters/markdown-formatter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACV,gBAAgB,EAChB,iBAAiB,EACjB,wBAAwB,EAGzB,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,wBAAgB,gBAAgB,CAC9B,IAAI,EAAE,gBAAgB,EACtB,OAAO,GAAE;IACP,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,eAAe,CAAC,EAAE,OAAO,CAAC;CACtB,GACL,MAAM,CAuER;AA+HD;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,iBAAiB,EAAE,EAC1B,eAAe,UAAQ,GACtB,MAAM,CAYR;AAED;;GAEG;AACH,wBAAgB,4BAA4B,CAC1C,YAAY,EAAE,wBAAwB,EAAE,GACvC,MAAM,CAYR"}

package/dist/formatters/markdown-formatter.js

@@ -0,0 +1,203 @@
+/**
+ * Markdown Formatter
+ * Outputs API documentation as readable Markdown
+ */
+/**
+ * Format complete documentation as Markdown
+ */
+export function formatAsMarkdown(docs, options = {}) {
+    const { includeTableOfContents = true, includeExamples = false } = options;
+    const lines = [];
+    // Title
+    lines.push(`# ${docs.info.title}`);
+    lines.push('');
+    lines.push(docs.info.description);
+    lines.push('');
+    lines.push(`**Version:** ${docs.info.version}`);
+    lines.push(`**Generated:** ${docs.info.generatedAt}`);
+    lines.push('');
+    // Table of Contents
+    if (includeTableOfContents) {
+        lines.push('## Table of Contents');
+        lines.push('');
+        if (docs.tools.length > 0) {
+            lines.push('- [MCP Tools](#mcp-tools)');
+            for (const tool of docs.tools) {
+                lines.push(`  - [${tool.name}](#${tool.name.toLowerCase().replace(/_/g, '-')})`);
+            }
+        }
+        if (docs.contentTypes.length > 0) {
+            lines.push('- [Content Types](#content-types)');
+            for (const type of docs.contentTypes) {
+                lines.push(`  - [${type.name}](#${type.slug.toLowerCase()})`);
+            }
+        }
+        if (docs.endpoints && docs.endpoints.length > 0) {
+            lines.push('- [Endpoints](#endpoints)');
+        }
+        lines.push('');
+    }
+    // MCP Tools Section
+    if (docs.tools.length > 0) {
+        lines.push('---');
+        lines.push('');
+        lines.push('## MCP Tools');
+        lines.push('');
+        for (const tool of docs.tools) {
+            lines.push(...formatTool(tool, includeExamples));
+            lines.push('');
+        }
+    }
+    // Content Types Section
+    if (docs.contentTypes.length > 0) {
+        lines.push('---');
+        lines.push('');
+        lines.push('## Content Types');
+        lines.push('');
+        for (const contentType of docs.contentTypes) {
+            lines.push(...formatContentType(contentType));
+            lines.push('');
+        }
+    }
+    // Endpoints Section
+    if (docs.endpoints && docs.endpoints.length > 0) {
+        lines.push('---');
+        lines.push('');
+        lines.push('## Endpoints');
+        lines.push('');
+        lines.push(...formatEndpointsTable(docs.endpoints));
+    }
+    return lines.join('\n');
+}
+/**
+ * Format a single MCP tool as Markdown
+ */
+function formatTool(tool, includeExamples = false) {
+    const lines = [];
+    lines.push(`### ${tool.name}`);
+    lines.push('');
+    lines.push(tool.description);
+    lines.push('');
+    if (tool.parameters.length > 0) {
+        lines.push('**Parameters:**');
+        lines.push('');
+        lines.push('| Name | Type | Required | Description |');
+        lines.push('|------|------|----------|-------------|');
+        for (const param of tool.parameters) {
+            const required = param.required ? 'Yes' : 'No';
+            const description = formatDescription(param);
+            lines.push(`| \`${param.name}\` | ${param.type} | ${required} | ${description} |`);
+        }
+        lines.push('');
+    }
+    else {
+        lines.push('*No parameters required*');
+        lines.push('');
+    }
+    if (includeExamples && tool.examples && tool.examples.length > 0) {
+        lines.push('**Examples:**');
+        lines.push('');
+        for (const example of tool.examples) {
+            lines.push(`*${example.name}*${example.description ? ` - ${example.description}` : ''}`);
+            lines.push('');
+            lines.push('```json');
+            lines.push(JSON.stringify(example.input, null, 2));
+            lines.push('```');
+            lines.push('');
+        }
+    }
+    return lines;
+}
+/**
+ * Format parameter description with enum and default
+ */
+function formatDescription(param) {
+    let desc = param.description || '-';
+    if (param.enum && param.enum.length > 0) {
+        desc += ` (${param.enum.map(v => `\`${v}\``).join(', ')})`;
+    }
+    if (param.default !== undefined) {
+        desc += ` Default: \`${JSON.stringify(param.default)}\``;
+    }
+    return desc;
+}
+/**
+ * Format a content type as Markdown
+ */
+function formatContentType(contentType) {
+    const lines = [];
+    lines.push(`### ${contentType.name}`);
+    lines.push('');
+    if (contentType.description) {
+        lines.push(contentType.description);
+        lines.push('');
+    }
+    lines.push(`**Slug:** \`${contentType.slug}\``);
+    lines.push('');
+    if (contentType.fields.length > 0) {
+        lines.push('**Fields:**');
+        lines.push('');
+        lines.push('| Name | Type | Required | Description |');
+        lines.push('|------|------|----------|-------------|');
+        for (const field of contentType.fields) {
+            const required = field.required ? 'Yes' : 'No';
+            const description = field.description || '-';
+            lines.push(`| \`${field.name}\` | ${field.type} | ${required} | ${description} |`);
+        }
+        lines.push('');
+    }
+    return lines;
+}
+/**
+ * Format endpoints as a table
+ */
+function formatEndpointsTable(endpoints) {
+    const lines = [];
+    // Group by tags
+    const grouped = new Map();
+    for (const endpoint of endpoints) {
+        const tag = endpoint.tags?.[0] || 'General';
+        if (!grouped.has(tag)) {
+            grouped.set(tag, []);
+        }
+        grouped.get(tag).push(endpoint);
+    }
+    for (const [tag, tagEndpoints] of grouped) {
+        lines.push(`### ${tag}`);
+        lines.push('');
+        lines.push('| Method | Path | Summary |');
+        lines.push('|--------|------|---------|');
+        for (const endpoint of tagEndpoints) {
+            lines.push(`| \`${endpoint.method}\` | \`${endpoint.path}\` | ${endpoint.summary} |`);
+        }
+        lines.push('');
+    }
+    return lines;
+}
+/**
+ * Format tools only as Markdown
+ */
+export function formatToolsAsMarkdown(tools, includeExamples = false) {
+    const lines = [];
+    lines.push('# MCP Tools');
+    lines.push('');
+    for (const tool of tools) {
+        lines.push(...formatTool(tool, includeExamples));
+        lines.push('');
+    }
+    return lines.join('\n');
+}
+/**
+ * Format content types only as Markdown
+ */
+export function formatContentTypesAsMarkdown(contentTypes) {
+    const lines = [];
+    lines.push('# Content Types');
+    lines.push('');
+    for (const contentType of contentTypes) {
+        lines.push(...formatContentType(contentType));
+        lines.push('');
+    }
+    return lines.join('\n');
+}
+//# sourceMappingURL=markdown-formatter.js.map

package/dist/formatters/markdown-formatter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-formatter.js","sourceRoot":"","sources":["../../src/formatters/markdown-formatter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAUH;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAC9B,IAAsB,EACtB,UAGI,EAAE;IAEN,MAAM,EAAE,sBAAsB,GAAG,IAAI,EAAE,eAAe,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;IAC3E,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,QAAQ;IACR,KAAK,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC;IACnC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAClC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,gBAAgB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;IAChD,KAAK,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IACtD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,oBAAoB;IACpB,IAAI,sBAAsB,EAAE,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;QACnC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;YACxC,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBAC9B,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;YACnF,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjC,KAAK,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;YAChD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;gBACrC,KAAK,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,MAAM,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC;YAChE,CAAC;QACH,CAAC;QACD,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAChD,KAAK,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAAC;QAC1C,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,oBAAoB;IACpB,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEf,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;YAC9B,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC;YACjD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IAED,wBAAwB;IACxB,IAAI,IAAI,CAAC,YAAY,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QAEf,KAAK,MAAM,WAAW,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;YAC5C,KAAK,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC;YAC9C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IAED,oBAAoB;IACpB,IAAI,IAAI,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,GAAG,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC;IACtD,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,SAAS,UAAU,CAAC,IAAuB,EAAE,eAAe,GAAG,KAAK;IAClE,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;IAC/B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC7B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;QAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;QACvD,KAAK,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;QAEvD,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACpC,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;YAC/C,MAAM,WAAW,GAAG,iBAAiB,CAAC,KAAK,CAAC,CAAC;YAC7C,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,IAAI,MAAM,QAAQ,MAAM,WAAW,IAAI,CAAC,CAAC;QACrF,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;SAAM,CAAC;QACN,KAAK,CAAC,IAAI,CAAC,0BAA0B,CAAC,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,IAAI,eAAe,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjE,KAAK,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACpC,KAAK,CAAC,IAAI,CAAC,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,MAAM,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;YACzF,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YACf,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YACtB,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;YACnD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAClB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACjB,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,SAAS,iBAAiB,CAAC,KAAmB;IAC5C,IAAI,IAAI,GAAG,KAAK,CAAC,WAAW,IAAI,GAAG,CAAC;IAEpC,IAAI,KAAK,CAAC,IAAI,IAAI,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxC,IAAI,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;IAC7D,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;QAChC,IAAI,IAAI,eAAe,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;IAC3D,CAAC;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;GAEG;AACH,SAAS,iBAAiB,CAAC,WAAqC;IAC9D,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,OAAO,WAAW,CAAC,IAAI,EAAE,CAAC,CAAC;IACtC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACf,IAAI,WAAW,CAAC,WAAW,EAAE,CAAC;QAC5B,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,WAAW,CAAC,CAAC;QACpC,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IACD,KAAK,CAAC,IAAI,CAAC,eAAe,WAAW,CAAC,IAAI,IAAI,CAAC,CAAC;IAChD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClC,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;QACvD,KAAK,CAAC,IAAI,CAAC,0CAA0C,CAAC,CAAC;QAEvD,KAAK,MAAM,KAAK,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;YACvC,MAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC;YAC/C,MAAM,WAAW,GAAG,KAAK,CAAC,WAAW,IAAI,GAAG,CAAC;YAC7C,KAAK,CAAC,IAAI,CAAC,OAAO,KAAK,CAAC,IAAI,QAAQ,KAAK,CAAC,IAAI,MAAM,QAAQ,MAAM,WAAW,IAAI,CAAC,CAAC;QACrF,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,SAAS,oBAAoB,CAAC,SAAkC;IAC9D,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,gBAAgB;IAChB,MAAM,OAAO,GAAG,IAAI,GAAG,EAAmC,CAAC;IAE3D,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE,CAAC;QACjC,MAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC;QAC5C,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,CAAC;YACtB,OAAO,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;QACvB,CAAC;QACD,OAAO,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;IACnC,CAAC;IAED,KAAK,MAAM,CAAC,GAAG,EAAE,YAAY,CAAC,IAAI,OAAO,EAAE,CAAC;QAC1C,KAAK,CAAC,IAAI,CAAC,OAAO,GAAG,EAAE,CAAC,CAAC;QACzB,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;QACf,KAAK,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QAC1C,KAAK,CAAC,IAAI,CAAC,6BAA6B,CAAC,CAAC;QAE1C,KAAK,MAAM,QAAQ,IAAI,YAAY,EAAE,CAAC;YACpC,KAAK,CAAC,IAAI,CAAC,OAAO,QAAQ,CAAC,MAAM,UAAU,QAAQ,CAAC,IAAI,QAAQ,QAAQ,CAAC,OAAO,IAAI,CAAC,CAAC;QACxF,CAAC;QACD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CACnC,KAA0B,EAC1B,eAAe,GAAG,KAAK;IAEvB,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;IAC1B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACzB,KAAK,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC,CAAC;QACjD,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,4BAA4B,CAC1C,YAAwC;IAExC,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,KAAK,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;IAC9B,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IAEf,KAAK,MAAM,WAAW,IAAI,YAAY,EAAE,CAAC;QACvC,KAAK,CAAC,IAAI,CAAC,GAAG,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC;QAC9C,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;IACjB,CAAC;IAED,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}

package/dist/formatters/openapi-formatter.d.ts

@@ -0,0 +1,14 @@
+/**
+ * OpenAPI Formatter
+ * Outputs API documentation as OpenAPI 3.0 specification
+ */
+import type { ApiDocumentation } from '../types.js';
+/**
+ * Format documentation as OpenAPI 3.0 specification
+ */
+export declare function formatAsOpenApi(docs: ApiDocumentation, options?: {
+    baseUrl?: string;
+    serverDescription?: string;
+    outputFormat?: 'json' | 'yaml';
+}): string;
+//# sourceMappingURL=openapi-formatter.d.ts.map

package/dist/formatters/openapi-formatter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"openapi-formatter.d.ts","sourceRoot":"","sources":["../../src/formatters/openapi-formatter.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACV,gBAAgB,EAQjB,MAAM,aAAa,CAAC;AAErB;;GAEG;AACH,wBAAgB,eAAe,CAC7B,IAAI,EAAE,gBAAgB,EACtB,OAAO,GAAE;IACP,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CAC3B,GACL,MAAM,CAcR"}