zero-doc 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+export { RouteParser } from './parser';
+export { APIInventoryGenerator } from './generator';
+export { AIEnricher } from './ai-enricher';
+export { GeminiEnricher } from './gemini-enricher';
+export * from './types';

package/dist/index.js

@@ -0,0 +1,26 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GeminiEnricher = exports.AIEnricher = exports.APIInventoryGenerator = exports.RouteParser = void 0;
+var parser_1 = require("./parser");
+Object.defineProperty(exports, "RouteParser", { enumerable: true, get: function () { return parser_1.RouteParser; } });
+var generator_1 = require("./generator");
+Object.defineProperty(exports, "APIInventoryGenerator", { enumerable: true, get: function () { return generator_1.APIInventoryGenerator; } });
+var ai_enricher_1 = require("./ai-enricher");
+Object.defineProperty(exports, "AIEnricher", { enumerable: true, get: function () { return ai_enricher_1.AIEnricher; } });
+var gemini_enricher_1 = require("./gemini-enricher");
+Object.defineProperty(exports, "GeminiEnricher", { enumerable: true, get: function () { return gemini_enricher_1.GeminiEnricher; } });
+__exportStar(require("./types"), exports);

package/dist/parser.d.ts

@@ -0,0 +1,14 @@
+import { RouteEndpoint } from './types';
+export declare class RouteParser {
+    private project;
+    private routes;
+    constructor(tsConfigPath?: string);
+    addSourceFiles(pattern: string): void;
+    parse(): RouteEndpoint[];
+    private extractRoute;
+    private extractGroup;
+    private extractPath;
+    private extractHandler;
+    private extractParameters;
+    getRoutes(): RouteEndpoint[];
+}

package/dist/parser.js

@@ -0,0 +1,176 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RouteParser = void 0;
+const ts_morph_1 = require("ts-morph");
+const nanoid_1 = require("nanoid");
+class RouteParser {
+    constructor(tsConfigPath) {
+        this.routes = [];
+        this.project = new ts_morph_1.Project({
+            tsConfigFilePath: tsConfigPath,
+            skipAddingFilesFromTsConfig: true,
+        });
+    }
+    addSourceFiles(pattern) {
+        this.project.addSourceFilesAtPaths(pattern);
+    }
+    parse() {
+        this.routes = [];
+        this.project.getSourceFiles().forEach(sourceFile => {
+            const filePath = sourceFile.getFilePath();
+            sourceFile.getDescendantsOfKind(ts_morph_1.SyntaxKind.CallExpression).forEach(call => {
+                const route = this.extractRoute(call, filePath);
+                if (route) {
+                    this.routes.push(route);
+                }
+            });
+        });
+        return this.routes;
+    }
+    extractRoute(call, filePath) {
+        const expression = call.getExpression();
+        const expressionText = expression.getText();
+        // Supports: app.get, router.post, fastify.put, etc.
+        const methodMatch = expressionText.match(/\.(get|post|put|delete|patch)$/i);
+        if (!methodMatch)
+            return null;
+        const method = methodMatch[1].toUpperCase();
+        const args = call.getArguments();
+        if (args.length < 2)
+            return null; // Needs at least (path, handler)
+        // Extract path (first argument)
+        const pathArg = args[0];
+        const path = this.extractPath(pathArg);
+        if (!path)
+            return null;
+        // Extract handler (usually last argument)
+        const handlerArg = args[args.length - 1];
+        const handler = this.extractHandler(handlerArg);
+        // Extract parameters from req.body and req.query
+        const parameters = this.extractParameters(handlerArg);
+        // Extract group from path (first segment after /)
+        const group = this.extractGroup(path);
+        return {
+            id: (0, nanoid_1.nanoid)(10),
+            method,
+            path,
+            group,
+            file: filePath,
+            line: call.getStartLineNumber(),
+            handler,
+            parameters,
+            metadata: {},
+        };
+    }
+    extractGroup(path) {
+        const segments = path.split('/').filter(s => s && !s.startsWith(':'));
+        if (segments.length === 0) {
+            return 'Root';
+        }
+        const firstSegment = segments[0];
+        const capitalized = firstSegment.charAt(0).toUpperCase() + firstSegment.slice(1);
+        return capitalized;
+    }
+    extractPath(node) {
+        const text = node.getText();
+        // Remove quotes and template literals
+        const cleaned = text.replace(/^['"`]|['"`]$/g, '');
+        // Validate if it looks like a path
+        if (cleaned.startsWith('/')) {
+            return cleaned;
+        }
+        return null;
+    }
+    extractHandler(node) {
+        const isAsync = node.getText().includes('async');
+        // Try to extract function name if it's a named function
+        let name;
+        if (ts_morph_1.Node.isIdentifier(node)) {
+            name = node.getText();
+        }
+        // Extract function parameters (req, res, next, etc.)
+        const parameters = [];
+        if (ts_morph_1.Node.isArrowFunction(node) || ts_morph_1.Node.isFunctionExpression(node)) {
+            node.getParameters().forEach(param => {
+                parameters.push(param.getName());
+            });
+        }
+        return {
+            name,
+            isAsync,
+            parameters,
+        };
+    }
+    extractParameters(handlerNode) {
+        const parameters = [];
+        // Look for accesses to req.body, req.query, req.params
+        if (ts_morph_1.Node.isArrowFunction(handlerNode) || ts_morph_1.Node.isFunctionExpression(handlerNode)) {
+            const body = handlerNode.getBody();
+            if (body) {
+                // Look for PropertyAccessExpression: req.body.email, req.query.page, etc.
+                body.getDescendantsOfKind(ts_morph_1.SyntaxKind.PropertyAccessExpression).forEach(prop => {
+                    const fullText = prop.getText();
+                    // req.body.fieldName
+                    const bodyMatch = fullText.match(/req\.body\.(\w+)/);
+                    if (bodyMatch) {
+                        parameters.push({
+                            name: bodyMatch[1],
+                            in: 'body',
+                            required: true, // Can be refined later
+                        });
+                    }
+                    // req.query.fieldName
+                    const queryMatch = fullText.match(/req\.query\.(\w+)/);
+                    if (queryMatch) {
+                        parameters.push({
+                            name: queryMatch[1],
+                            in: 'query',
+                        });
+                    }
+                    // req.params.fieldName
+                    const paramsMatch = fullText.match(/req\.params\.(\w+)/);
+                    if (paramsMatch) {
+                        parameters.push({
+                            name: paramsMatch[1],
+                            in: 'path',
+                            required: true,
+                        });
+                    }
+                });
+                // Look for destructuring: const { email, password } = req.body
+                body.getDescendantsOfKind(ts_morph_1.SyntaxKind.VariableDeclaration).forEach(varDecl => {
+                    const initializer = varDecl.getInitializer();
+                    if (initializer?.getText().startsWith('req.')) {
+                        const sourceText = initializer.getText();
+                        const name = varDecl.getName();
+                        // If it's destructuring
+                        if (name.startsWith('{')) {
+                            const fields = name
+                                .replace(/[{}]/g, '')
+                                .split(',')
+                                .map(f => f.trim());
+                            let location = 'body';
+                            if (sourceText.includes('req.query'))
+                                location = 'query';
+                            if (sourceText.includes('req.params'))
+                                location = 'path';
+                            fields.forEach(field => {
+                                parameters.push({
+                                    name: field,
+                                    in: location,
+                                    required: location !== 'query',
+                                });
+                            });
+                        }
+                    }
+                });
+            }
+        }
+        // Remove duplicates
+        return parameters.filter((param, index, self) => index === self.findIndex(p => p.name === param.name && p.in === param.in));
+    }
+    getRoutes() {
+        return this.routes;
+    }
+}
+exports.RouteParser = RouteParser;

package/dist/types.d.ts

@@ -0,0 +1,51 @@
+export interface RouteParameter {
+    name: string;
+    in: 'path' | 'query' | 'body' | 'header';
+    type?: string;
+    required?: boolean;
+    description?: string;
+    inferredType?: 'string' | 'number' | 'boolean' | 'object' | 'array';
+}
+export interface RouteEndpoint {
+    id: string;
+    method: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+    path: string;
+    group: string;
+    file: string;
+    line: number;
+    handler: {
+        name?: string;
+        isAsync: boolean;
+        parameters: string[];
+    };
+    parameters: RouteParameter[];
+    requestBody?: {
+        required: boolean;
+        fields: RouteParameter[];
+    };
+    response?: {
+        statusCode: number;
+        type?: string;
+    };
+    metadata?: {
+        tags?: string[];
+        summary?: string;
+        description?: string;
+        deprecated?: boolean;
+        title?: string;
+        aiGenerated?: boolean;
+    };
+}
+export interface APIInventory {
+    version: string;
+    generatedAt: string;
+    project: {
+        name?: string;
+        framework: 'express' | 'fastify' | 'unknown';
+    };
+    endpoints: RouteEndpoint[];
+    stats: {
+        totalEndpoints: number;
+        byMethod: Record<string, number>;
+    };
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,57 @@
+{
+  "name": "zero-doc",
+  "version": "1.0.0",
+  "description": "Zero-Config API Documentation Generator - Generate beautiful API docs from your code automatically",
+  "main": "dist/index.js",
+  "bin": {
+    "zero-doc": "./dist/cli.js"
+  },
+  "keywords": [
+    "api",
+    "documentation",
+    "docs",
+    "openapi",
+    "swagger",
+    "express",
+    "fastify",
+    "typescript",
+    "static-analysis",
+    "ai",
+    "zero-config"
+  ],
+  "author": "Lucas Sens",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "files": [
+    "dist",
+    "viewer",
+    "scripts"
+  ],
+  "scripts": {
+    "build": "tsc && npm run copy-viewer",
+    "copy-viewer": "node scripts/copy-viewer.js",
+    "dev": "ts-node src/cli.ts",
+    "generate": "ts-node src/cli.ts generate"
+  },
+  "dependencies": {
+    "@google/generative-ai": "^0.21.0",
+    "commander": "^11.0.0",
+    "dotenv": "^16.3.1",
+    "fs-extra": "^11.2.0",
+    "nanoid": "^3.3.7",
+    "openai": "^4.20.0",
+    "tmp": "^0.2.1",
+    "ts-morph": "^21.0.0"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^20.0.0",
+    "@types/tmp": "^0.2.6",
+    "ts-node": "^10.9.0",
+    "typescript": "^5.0.0"
+  }
+}
+

package/scripts/copy-viewer.js

@@ -0,0 +1,30 @@
+const fs = require('fs');
+const path = require('path');
+const fse = require('fs-extra');
+
+// Get the monorepo root (go up from packages/cli/scripts to root)
+const monorepoRoot = path.join(__dirname, '../../../');
+const viewerSource = path.join(monorepoRoot, 'apps/viewer');
+const viewerDest = path.join(__dirname, '../viewer');
+
+if (!fs.existsSync(viewerSource)) {
+  console.error('❌ Viewer source not found at:', viewerSource);
+  process.exit(1);
+}
+
+if (fs.existsSync(viewerDest)) {
+  fse.removeSync(viewerDest);
+}
+
+fse.copySync(viewerSource, viewerDest, {
+  filter: (src) => {
+    const relativePath = path.relative(viewerSource, src);
+    return !relativePath.includes('node_modules') &&
+           !relativePath.includes('dist') &&
+           !relativePath.startsWith('.git') &&
+           !relativePath.includes('package-lock.json');
+  }
+});
+
+console.log('✅ Viewer copied to packages/cli/viewer');
+

package/viewer/README.md

@@ -0,0 +1,41 @@
+# Zero-Doc Viewer
+
+Beautiful API documentation viewer built with React + Vite + Tailwind.
+
+## Quick Start
+
+```bash
+cd apps/viewer
+npm install
+npm run dev
+```
+
+The viewer will automatically load `api-inventory.json` from the `public` folder.
+
+## Features
+
+- ✅ Stripe-style documentation layout
+- ✅ Sidebar navigation grouped by HTTP method
+- ✅ Color-coded method badges (GET=green, POST=blue, etc.)
+- ✅ Automatic parameter tables
+- ✅ Code snippets (fetch & axios)
+- ✅ Dark mode code blocks
+- ✅ Responsive design
+
+## Structure
+
+```
+apps/viewer/
+├── src/
+│   ├── components/
+│   │   ├── Sidebar.tsx       # Navigation sidebar
+│   │   ├── EndpointView.tsx  # Main endpoint documentation
+│   │   ├── ParameterTable.tsx # Auto-generated parameter tables
+│   │   └── CodeSnippet.tsx   # fetch/axios code examples
+│   ├── App.tsx               # Main app component
+│   ├── types.ts              # TypeScript types
+│   └── main.tsx              # Entry point
+└── public/
+    └── api-inventory.json     # Generated API inventory
+```
+

package/viewer/index.html

@@ -0,0 +1,14 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <link rel="icon" type="image/svg+xml" href="/vite.svg" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>API Documentation - Zero Doc</title>
+  </head>
+  <body>
+    <div id="root"></div>
+    <script type="module" src="/src/main.tsx"></script>
+  </body>
+</html>
+

package/viewer/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@zero-doc/viewer",
+  "private": true,
+  "version": "1.0.0",
+  "type": "module",
+  "scripts": {
+    "dev": "vite",
+    "build": "tsc && vite build",
+    "preview": "vite preview"
+  },
+  "dependencies": {
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.43",
+    "@types/react-dom": "^18.2.17",
+    "@vitejs/plugin-react": "^4.2.1",
+    "autoprefixer": "^10.4.16",
+    "postcss": "^8.4.32",
+    "tailwindcss": "^3.3.6",
+    "typescript": "^5.2.2",
+    "vite": "^5.0.8"
+  }
+}
+

package/viewer/postcss.config.js

@@ -0,0 +1,6 @@
+export default {
+  plugins: {
+    tailwindcss: {},
+    autoprefixer: {},
+  },
+}

package/viewer/public/api-inventory.json

@@ -0,0 +1,151 @@
+{
+  "version": "1.0.0",
+  "generatedAt": "2025-12-28T06:58:49.389Z",
+  "project": {
+    "framework": "express"
+  },
+  "endpoints": [
+    {
+      "id": "-C8ltf6rc1",
+      "method": "GET",
+      "path": "/users",
+      "group": "Users",
+      "file": "C:/trampos/Projetos/Zero-Config API Reference/packages/cli/examples/express-routes.ts",
+      "line": 7,
+      "handler": {
+        "isAsync": false,
+        "parameters": [
+          "req",
+          "res"
+        ]
+      },
+      "parameters": [
+        {
+          "name": "page",
+          "in": "query"
+        },
+        {
+          "name": "limit",
+          "in": "query"
+        }
+      ],
+      "metadata": {}
+    },
+    {
+      "id": "ksWVmn7IFn",
+      "method": "GET",
+      "path": "/users/:id",
+      "group": "Users",
+      "file": "C:/trampos/Projetos/Zero-Config API Reference/packages/cli/examples/express-routes.ts",
+      "line": 14,
+      "handler": {
+        "isAsync": true,
+        "parameters": [
+          "req",
+          "res"
+        ]
+      },
+      "parameters": [
+        {
+          "name": "id",
+          "in": "path",
+          "required": true
+        }
+      ],
+      "metadata": {}
+    },
+    {
+      "id": "-nScJ4hpeC",
+      "method": "POST",
+      "path": "/users",
+      "group": "Users",
+      "file": "C:/trampos/Projetos/Zero-Config API Reference/packages/cli/examples/express-routes.ts",
+      "line": 20,
+      "handler": {
+        "isAsync": true,
+        "parameters": [
+          "req",
+          "res"
+        ]
+      },
+      "parameters": [
+        {
+          "name": "email",
+          "in": "body",
+          "required": true
+        },
+        {
+          "name": "password",
+          "in": "body",
+          "required": true
+        },
+        {
+          "name": "name",
+          "in": "body",
+          "required": true
+        }
+      ],
+      "metadata": {}
+    },
+    {
+      "id": "J2WEY9IHsB",
+      "method": "PUT",
+      "path": "/users/:id",
+      "group": "Users",
+      "file": "C:/trampos/Projetos/Zero-Config API Reference/packages/cli/examples/express-routes.ts",
+      "line": 26,
+      "handler": {
+        "isAsync": false,
+        "parameters": [
+          "req",
+          "res"
+        ]
+      },
+      "parameters": [
+        {
+          "name": "id",
+          "in": "path",
+          "required": true
+        },
+        {
+          "name": "email",
+          "in": "body",
+          "required": true
+        }
+      ],
+      "metadata": {}
+    },
+    {
+      "id": "Nam618R71j",
+      "method": "DELETE",
+      "path": "/users/:id",
+      "group": "Users",
+      "file": "C:/trampos/Projetos/Zero-Config API Reference/packages/cli/examples/express-routes.ts",
+      "line": 33,
+      "handler": {
+        "isAsync": true,
+        "parameters": [
+          "req",
+          "res"
+        ]
+      },
+      "parameters": [
+        {
+          "name": "id",
+          "in": "path",
+          "required": true
+        }
+      ],
+      "metadata": {}
+    }
+  ],
+  "stats": {
+    "totalEndpoints": 5,
+    "byMethod": {
+      "GET": 2,
+      "POST": 1,
+      "PUT": 1,
+      "DELETE": 1
+    }
+  }
+}