flowdoc-gen 0.1.2 → 0.1.4

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "flowdoc-gen",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "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"
     }
   },