flowdoc-gen 0.1.1 → 0.1.2

package/dist/bin.js

@@ -9,7 +9,7 @@ var __dirname = dirname(fileURLToPath(import.meta.url));
 var pkg = JSON.parse(readFileSync(join(__dirname, "../package.json"), "utf-8"));
 program.name("flowdoc").description("Auto-generate beautiful API documentation from your Express codebase").version(pkg.version);
 program.command("init").description("Scaffold a flowdoc.config.ts in the current directory").action(async () => {
-  const { init } = await import("./init-3GG2S3V3.js");
+  const { init } = await import("./init-6XHCTCLE.js");
   init();
 });
 program.command("generate").description("Parse your routes and write docs to the output folder").option("-c, --config <path>", "Path to flowdoc config file").option("-o, --output <path>", "Override output directory").option("-q, --quiet", "Suppress output").action(async (opts) => {

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.2",
   "description": "Auto-generate beautiful API documentation from your Express codebase — no annotations required",
   "type": "module",
   "bin": {

package/dist/bin.d.ts

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