flowdoc-gen 0.1.1 → 0.1.3

package/dist/index.d.cts

@@ -0,0 +1,148 @@
+import { Request, Response, NextFunction } from 'express';
+
+type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
+type ParameterLocation = "path" | "query" | "header" | "cookie";
+type SchemaType = "string" | "number" | "integer" | "boolean" | "object" | "array" | "null";
+interface JsonSchema {
+    type?: SchemaType | SchemaType[];
+    format?: string;
+    description?: string;
+    example?: unknown;
+    enum?: unknown[];
+    properties?: Record<string, JsonSchema>;
+    items?: JsonSchema;
+    required?: string[];
+    additionalProperties?: boolean | JsonSchema;
+    anyOf?: JsonSchema[];
+    oneOf?: JsonSchema[];
+    allOf?: JsonSchema[];
+    nullable?: boolean;
+    minimum?: number;
+    maximum?: number;
+    minLength?: number;
+    maxLength?: number;
+    minItems?: number;
+    maxItems?: number;
+    pattern?: string;
+    title?: string;
+    default?: unknown;
+}
+interface RouteParameter {
+    name: string;
+    in: ParameterLocation;
+    required: boolean;
+    schema: JsonSchema;
+    description?: string;
+    example?: unknown;
+}
+interface RequestBody {
+    required: boolean;
+    description?: string;
+    content: {
+        "application/json"?: {
+            schema: JsonSchema;
+        };
+        "multipart/form-data"?: {
+            schema: JsonSchema;
+        };
+        "application/x-www-form-urlencoded"?: {
+            schema: JsonSchema;
+        };
+    };
+}
+interface ResponseBody {
+    description: string;
+    content?: {
+        "application/json"?: {
+            schema: JsonSchema;
+        };
+    };
+}
+interface RouteDoc {
+    method: HttpMethod;
+    path: string;
+    summary?: string;
+    description?: string;
+    tags: string[];
+    parameters: RouteParameter[];
+    requestBody?: RequestBody;
+    responses: Record<string, ResponseBody>;
+    deprecated?: boolean;
+    security?: Array<Record<string, string[]>>;
+    middleware?: string[];
+}
+interface ApiGroup {
+    name: string;
+    description?: string;
+    routes: RouteDoc[];
+}
+interface FlowDocSpec {
+    info: {
+        title: string;
+        version: string;
+        description?: string;
+        baseUrl: string;
+    };
+    auth?: {
+        type: "bearer" | "apiKey" | "basic" | "oauth2";
+        headerName?: string;
+        queryName?: string;
+    };
+    groups: ApiGroup[];
+    generatedAt: string;
+    sourceFramework: "express" | "nestjs";
+}
+interface FlowDocConfig {
+    name: string;
+    version?: string;
+    description?: string;
+    framework: "express" | "nestjs";
+    entry: string;
+    baseUrl?: string;
+    auth?: FlowDocSpec["auth"];
+    output?: string;
+    theme?: {
+        brand?: string;
+        logo?: string;
+        darkMode?: boolean;
+    };
+    groups?: Record<string, string[]>;
+    exclude?: string[];
+}
+
+interface GenerateOptions {
+    config?: string;
+    output?: string;
+    quiet?: boolean;
+}
+declare const generate: (opts?: GenerateOptions) => Promise<FlowDocSpec>;
+
+interface ServeOptions extends GenerateOptions {
+    port?: number;
+    noOpen?: boolean;
+    watch?: boolean;
+}
+declare const serve: (opts?: ServeOptions) => Promise<void>;
+
+declare const init: (cwd?: string) => void;
+
+interface FlowDocMiddlewareOptions {
+    /** Path to flowdoc.config.ts — defaults to auto-discovery from cwd */
+    config?: string;
+    /** Route prefix the middleware is mounted at — used only for the HTML shell */
+    path?: string;
+}
+/**
+ * Express middleware that serves flowdoc docs at whatever route you mount it on.
+ * baseUrl is auto-derived from each incoming request — no manual config needed.
+ *
+ * Usage:
+ *   import { flowdoc } from "flowdoc";
+ *   app.use("/docs", flowdoc());
+ */
+declare const flowdoc: (opts?: FlowDocMiddlewareOptions) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
+
+/** Type-safe config helper — use in flowdoc.config.ts */
+declare const defineConfig: (config: FlowDocConfig) => FlowDocConfig;
+
+export { type FlowDocConfig, type FlowDocMiddlewareOptions, type FlowDocSpec, type GenerateOptions, type JsonSchema, type RouteDoc, type ServeOptions, defineConfig, flowdoc, generate, init, serve };

package/dist/index.d.ts

@@ -1,6 +1,115 @@
-import { FlowDocSpec } from '@flowdoc/core';
 import { Request, Response, NextFunction } from 'express';
 
+type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE" | "HEAD" | "OPTIONS";
+type ParameterLocation = "path" | "query" | "header" | "cookie";
+type SchemaType = "string" | "number" | "integer" | "boolean" | "object" | "array" | "null";
+interface JsonSchema {
+    type?: SchemaType | SchemaType[];
+    format?: string;
+    description?: string;
+    example?: unknown;
+    enum?: unknown[];
+    properties?: Record<string, JsonSchema>;
+    items?: JsonSchema;
+    required?: string[];
+    additionalProperties?: boolean | JsonSchema;
+    anyOf?: JsonSchema[];
+    oneOf?: JsonSchema[];
+    allOf?: JsonSchema[];
+    nullable?: boolean;
+    minimum?: number;
+    maximum?: number;
+    minLength?: number;
+    maxLength?: number;
+    minItems?: number;
+    maxItems?: number;
+    pattern?: string;
+    title?: string;
+    default?: unknown;
+}
+interface RouteParameter {
+    name: string;
+    in: ParameterLocation;
+    required: boolean;
+    schema: JsonSchema;
+    description?: string;
+    example?: unknown;
+}
+interface RequestBody {
+    required: boolean;
+    description?: string;
+    content: {
+        "application/json"?: {
+            schema: JsonSchema;
+        };
+        "multipart/form-data"?: {
+            schema: JsonSchema;
+        };
+        "application/x-www-form-urlencoded"?: {
+            schema: JsonSchema;
+        };
+    };
+}
+interface ResponseBody {
+    description: string;
+    content?: {
+        "application/json"?: {
+            schema: JsonSchema;
+        };
+    };
+}
+interface RouteDoc {
+    method: HttpMethod;
+    path: string;
+    summary?: string;
+    description?: string;
+    tags: string[];
+    parameters: RouteParameter[];
+    requestBody?: RequestBody;
+    responses: Record<string, ResponseBody>;
+    deprecated?: boolean;
+    security?: Array<Record<string, string[]>>;
+    middleware?: string[];
+}
+interface ApiGroup {
+    name: string;
+    description?: string;
+    routes: RouteDoc[];
+}
+interface FlowDocSpec {
+    info: {
+        title: string;
+        version: string;
+        description?: string;
+        baseUrl: string;
+    };
+    auth?: {
+        type: "bearer" | "apiKey" | "basic" | "oauth2";
+        headerName?: string;
+        queryName?: string;
+    };
+    groups: ApiGroup[];
+    generatedAt: string;
+    sourceFramework: "express" | "nestjs";
+}
+interface FlowDocConfig {
+    name: string;
+    version?: string;
+    description?: string;
+    framework: "express" | "nestjs";
+    entry: string;
+    baseUrl?: string;
+    auth?: FlowDocSpec["auth"];
+    output?: string;
+    theme?: {
+        brand?: string;
+        logo?: string;
+        darkMode?: boolean;
+    };
+    groups?: Record<string, string[]>;
+    exclude?: string[];
+}
+
 interface GenerateOptions {
     config?: string;
     output?: string;
@@ -33,4 +142,7 @@ interface FlowDocMiddlewareOptions {
  */
 declare const flowdoc: (opts?: FlowDocMiddlewareOptions) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
 
-export { type FlowDocMiddlewareOptions, type GenerateOptions, type ServeOptions, flowdoc, generate, init, serve };
+/** Type-safe config helper — use in flowdoc.config.ts */
+declare const defineConfig: (config: FlowDocConfig) => FlowDocConfig;
+
+export { type FlowDocConfig, type FlowDocMiddlewareOptions, type FlowDocSpec, type GenerateOptions, type JsonSchema, type RouteDoc, type ServeOptions, defineConfig, flowdoc, generate, init, serve };

package/dist/index.js

@@ -1244,31 +1244,24 @@ var serve = async (opts = {}) => {
 import { writeFileSync as writeFileSync2, existsSync as existsSync5 } from "fs";
 import { resolve as resolve5 } from "path";
 import chalk3 from "chalk";
-var CONFIG_TEMPLATE = `import type { FlowDocConfig } from "@flowdoc/core";
+var CONFIG_TEMPLATE = `import { defineConfig } from "flowdoc-gen";
 
-const config: FlowDocConfig = {
+export default defineConfig({
   name: "My API",
   version: "1.0.0",
   description: "API documentation generated by flowdoc",
   framework: "express",
-  entry: "./src",           // folder or file containing your Express routes
-  baseUrl: "http://localhost:3000",
-  auth: {
-    type: "bearer",
-  },
+  entry: "./src",
   output: "./docs-output",
   theme: {
     brand: "#6366f1",
     darkMode: true,
   },
-  // Optional: manually group routes under named sections
-  // groups: {
-  //   "User Management": ["/users/**"],
-  //   "Auth": ["/auth/**"],
-  // },
-};
-
-export default config;
+  // groups: [
+  //   { name: "Auth",  match: "/auth/**" },
+  //   { name: "Users", match: "/users/**" },
+  // ],
+});
 `;
 var init = (cwd = process.cwd()) => {
   const configPath = resolve5(cwd, "flowdoc.config.ts");
@@ -1366,7 +1359,11 @@ var buildHtml = ({ baseUrl, brand }) => `<!DOCTYPE html>
   </head>
   <body><div id="root"></div></body>
 </html>`;
+
+// src/index.ts
+var defineConfig = (config) => config;
 export {
+  defineConfig,
   flowdoc,
   generate,
   init,

package/dist/{init-3GG2S3V3.js → init-6XHCTCLE.js}

@@ -2,31 +2,24 @@
 import { writeFileSync, existsSync } from "fs";
 import { resolve } from "path";
 import chalk from "chalk";
-var CONFIG_TEMPLATE = `import type { FlowDocConfig } from "@flowdoc/core";
+var CONFIG_TEMPLATE = `import { defineConfig } from "flowdoc-gen";
 
-const config: FlowDocConfig = {
+export default defineConfig({
   name: "My API",
   version: "1.0.0",
   description: "API documentation generated by flowdoc",
   framework: "express",
-  entry: "./src",           // folder or file containing your Express routes
-  baseUrl: "http://localhost:3000",
-  auth: {
-    type: "bearer",
-  },
+  entry: "./src",
   output: "./docs-output",
   theme: {
     brand: "#6366f1",
     darkMode: true,
   },
-  // Optional: manually group routes under named sections
-  // groups: {
-  //   "User Management": ["/users/**"],
-  //   "Auth": ["/auth/**"],
-  // },
-};
-
-export default config;
+  // groups: [
+  //   { name: "Auth",  match: "/auth/**" },
+  //   { name: "Users", match: "/users/**" },
+  // ],
+});
 `;
 var init = (cwd = process.cwd()) => {
   const configPath = resolve(cwd, "flowdoc.config.ts");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flowdoc-gen",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Auto-generate beautiful API documentation from your Express codebase — no annotations required",
   "type": "module",
   "bin": {
@@ -11,6 +11,7 @@
   "exports": {
     ".": {
       "import": "./dist/index.js",
+      "require": "./dist/index.cjs",
       "types": "./dist/index.d.ts"
     }
   },

package/dist/bin.d.ts

@@ -1 +0,0 @@
-#!/usr/bin/env node

package/dist/chunk-P6Z6T3W4.js

@@ -1,51 +0,0 @@
-import {
-  generate
-} from "./chunk-SAMPAR3A.js";
-
-// src/serve.ts
-import { createServer } from "http";
-import { createReadStream, existsSync } from "fs";
-import { join, extname } from "path";
-import chalk from "chalk";
-import open from "open";
-var MIME_TYPES = {
-  ".html": "text/html",
-  ".js": "application/javascript",
-  ".css": "text/css",
-  ".json": "application/json",
-  ".svg": "image/svg+xml",
-  ".png": "image/png",
-  ".ico": "image/x-icon"
-};
-var serve = async (opts = {}) => {
-  const spec = await generate({ ...opts, quiet: false });
-  const cwd = process.cwd();
-  const outputDir = opts.output ?? join(cwd, "docs-output");
-  const port = opts.port ?? 4e3;
-  const server = createServer((req, res) => {
-    const url = req.url === "/" || req.url === "" ? "/index.html" : req.url ?? "/index.html";
-    const filePath = join(outputDir, url);
-    if (!existsSync(filePath)) {
-      res.writeHead(404);
-      res.end("Not found");
-      return;
-    }
-    const ext = extname(filePath);
-    const contentType = MIME_TYPES[ext] ?? "application/octet-stream";
-    res.writeHead(200, { "Content-Type": contentType });
-    createReadStream(filePath).pipe(res);
-  });
-  server.listen(port, () => {
-    const url = `http://localhost:${port}`;
-    console.log();
-    console.log(`  ${chalk.bold("flowdoc")} is running at ${chalk.cyan(url)}`);
-    console.log();
-    if (!opts.noOpen) {
-      void open(url);
-    }
-  });
-};
-
-export {
-  serve
-};

package/dist/chunk-SAMPAR3A.js

@@ -1,93 +0,0 @@
-// src/generate.ts
-import { writeFileSync, mkdirSync, cpSync, existsSync } from "fs";
-import { resolve, join, dirname } from "path";
-import { fileURLToPath } from "url";
-import chalk from "chalk";
-import ora from "ora";
-import { findConfigFile, loadConfig, resolveConfig } from "@flowdoc/core";
-import { extractExpressRoutes } from "@flowdoc/parser";
-import { buildSpec } from "@flowdoc/parser";
-var generate = async (opts = {}) => {
-  const cwd = process.cwd();
-  const spinner = opts.quiet ? null : ora();
-  spinner?.start("Loading flowdoc config...");
-  const configPath = opts.config ? resolve(cwd, opts.config) : findConfigFile(cwd);
-  if (!configPath) {
-    spinner?.fail(chalk.red("No flowdoc.config.ts found. Run `flowdoc init` first."));
-    process.exit(1);
-  }
-  let rawConfig;
-  try {
-    rawConfig = await loadConfig(configPath);
-  } catch (err) {
-    spinner?.fail(chalk.red(`Failed to load config: ${String(err)}`));
-    process.exit(1);
-  }
-  const config = resolveConfig(rawConfig, cwd);
-  spinner?.succeed(`Config loaded \u2014 ${chalk.cyan(config.name)}`);
-  spinner?.start(`Scanning ${chalk.cyan(config.entry)} for routes...`);
-  let routes;
-  try {
-    routes = await extractExpressRoutes(config);
-  } catch (err) {
-    spinner?.fail(chalk.red(`Parse failed: ${String(err)}`));
-    process.exit(1);
-  }
-  spinner?.succeed(
-    `Found ${chalk.green(String(routes.length))} routes across ${chalk.cyan(config.framework)} app`
-  );
-  const spec = buildSpec(routes, config);
-  const outputDir = opts.output ? resolve(cwd, opts.output) : config.output ?? resolve(cwd, "docs-output");
-  mkdirSync(outputDir, { recursive: true });
-  const specPath = join(outputDir, "flowdoc.json");
-  writeFileSync(specPath, JSON.stringify(spec, null, 2), "utf-8");
-  await writeUiHtml(outputDir, config);
-  if (!opts.quiet) {
-    console.log();
-    console.log(chalk.bold("  flowdoc generated successfully"));
-    console.log();
-    console.log(`  ${chalk.gray("Spec:")}   ${chalk.cyan(specPath)}`);
-    console.log(`  ${chalk.gray("UI:")}     ${chalk.cyan(join(outputDir, "index.html"))}`);
-    console.log();
-    console.log(`  ${chalk.gray("Routes:")} ${chalk.green(String(routes.length))}`);
-    console.log(`  ${chalk.gray("Groups:")} ${chalk.green(String(spec.groups.length))}`);
-    console.log();
-  }
-  return spec;
-};
-var writeUiHtml = async (outputDir, config) => {
-  const brand = config.theme?.brand ?? "#6366f1";
-  const title = config.name;
-  const darkMode = config.theme?.darkMode !== false;
-  const cliRoot = dirname(dirname(fileURLToPath(import.meta.url)));
-  const uiAssetsSource = join(cliRoot, "ui-assets");
-  const uiAssetsDest = join(outputDir, "assets");
-  if (existsSync(uiAssetsSource)) {
-    mkdirSync(uiAssetsDest, { recursive: true });
-    cpSync(uiAssetsSource, uiAssetsDest, { recursive: true });
-  }
-  const html = generateHtmlShell({ title, brand, darkMode });
-  writeFileSync(join(outputDir, "index.html"), html, "utf-8");
-};
-var generateHtmlShell = ({ title, brand, darkMode }) => `<!DOCTYPE html>
-<html lang="en" class="${darkMode ? "dark" : ""}">
-  <head>
-    <meta charset="UTF-8" />
-    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>${title} \u2014 API Docs</title>
-    <meta name="description" content="API documentation generated by flowdoc" />
-    <script>
-      window.__FLOWDOC_BRAND__ = "${brand}";
-      window.__FLOWDOC_DARK__ = ${String(darkMode)};
-    </script>
-    <script type="module" crossorigin src="./assets/ui.js"></script>
-    <link rel="stylesheet" href="./assets/index.css" />
-  </head>
-  <body>
-    <div id="root"></div>
-  </body>
-</html>`;
-
-export {
-  generate
-};

package/dist/chunk-VG2YJHSH.js

@@ -1,52 +0,0 @@
-// src/init.ts
-import { writeFileSync, existsSync } from "fs";
-import { resolve } from "path";
-import chalk from "chalk";
-var CONFIG_TEMPLATE = `import type { FlowDocConfig } from "@flowdoc/core";
-
-const config: FlowDocConfig = {
-  name: "My API",
-  version: "1.0.0",
-  description: "API documentation generated by flowdoc",
-  framework: "express",
-  entry: "./src",           // folder or file containing your Express routes
-  baseUrl: "http://localhost:3000",
-  auth: {
-    type: "bearer",
-  },
-  output: "./docs-output",
-  theme: {
-    brand: "#6366f1",
-    darkMode: true,
-  },
-  // Optional: manually group routes under named sections
-  // groups: {
-  //   "User Management": ["/users/**"],
-  //   "Auth": ["/auth/**"],
-  // },
-};
-
-export default config;
-`;
-var init = (cwd = process.cwd()) => {
-  const configPath = resolve(cwd, "flowdoc.config.ts");
-  if (existsSync(configPath)) {
-    console.log(chalk.yellow("  flowdoc.config.ts already exists \u2014 skipping."));
-    return;
-  }
-  writeFileSync(configPath, CONFIG_TEMPLATE, "utf-8");
-  console.log();
-  console.log(`  ${chalk.bold("flowdoc")} initialized`);
-  console.log();
-  console.log(`  Created ${chalk.cyan("flowdoc.config.ts")}`);
-  console.log();
-  console.log("  Next steps:");
-  console.log(`    1. Edit ${chalk.cyan("flowdoc.config.ts")} \u2014 set your entry path`);
-  console.log(`    2. Run ${chalk.cyan("flowdoc generate")} to build your docs`);
-  console.log(`    3. Run ${chalk.cyan("flowdoc serve")} to preview locally`);
-  console.log();
-};
-
-export {
-  init
-};