apiforge-analyzer 1.3.1 → 1.3.3

package/dist/esm/index.js

@@ -9,7 +9,8 @@ import { analyzeNextApp } from './frameworks/nextjs-app.js';
 import { analyzeVite } from './frameworks/vite.js';
 import { analyzeReactRouter } from './frameworks/react-router.js';
 import { analyzeNestJS } from './frameworks/nestjs.js';
-import { detectFramework } from './detect.js';
+import { analyzeFastify } from './frameworks/fastify.js';
+import { detectFramework, SUPPORTED_FRAMEWORKS } from './detect.js';
 import { exportToJSON } from './export.js';
 import { uploadRoutes, writeStatusFile } from './uploader.js';
 import { detectArchitectureType } from './arch-detect.js';
@@ -107,6 +108,15 @@ export async function analyze(app, options) {
         framework = detectFramework(app).name;
         console.log(`📦 Detected framework: ${framework}`);
     }
+    // Reject loudly on an unsupported framework instead of falling through to
+    // `return []` — that return value is indistinguishable from "no routes",
+    // "no API key", "debounced", etc. A caller needs to be able to tell them apart.
+    if (!SUPPORTED_FRAMEWORKS.has(framework)) {
+        const msg = `Framework "${framework}" not supported yet (${[...SUPPORTED_FRAMEWORKS].join(', ')})`;
+        console.error(`❌ APIForge: ${msg}`);
+        writeStatusFile('error', { error: msg });
+        throw new Error(msg);
+    }
     try {
         switch (framework) {
             case 'nestjs':
@@ -131,6 +141,20 @@ export async function analyze(app, options) {
                     }
                 }
                 break;
+            case 'fastify':
+                if (!app) {
+                    const msg = 'Fastify app instance required — pass your app object to analyze()';
+                    console.error(`❌ ${msg}`);
+                    writeStatusFile('error', { error: msg });
+                    return [];
+                }
+                routes = await analyzeFastify(app, {
+                    scopeCatalogPath: options.scopeCatalogPath,
+                    errorCatalogPath: options.errorCatalogPath,
+                    envelopes: options.envelopes,
+                    annotationsPath: options.annotationsPath,
+                });
+                break;
             case 'nextjs-pages':
                 routes = await analyzeNextPages(options.nextDir || 'pages/api');
                 break;
@@ -143,11 +167,8 @@ export async function analyze(app, options) {
             case 'react-router':
                 routes = await analyzeReactRouter(options.nextDir || 'src/routes.tsx');
                 break;
-            default:
-                const msg = `Framework "${framework}" not supported yet (express, nextjs-pages, nextjs-app, vite, react-router)`;
-                console.warn(`⚠️  APIForge: ${msg}`);
-                writeStatusFile('error', { error: msg });
-                return [];
+            // No default: unsupported frameworks are rejected above, before this
+            // try block, so a thrown error here isn't silently swallowed into `[]`.
         }
     }
     catch (err) {
@@ -191,7 +212,7 @@ export async function analyze(app, options) {
     return routes;
 }
 // Re-exports for library consumers
-export { analyzeExpress, analyzeNextPages, analyzeNextApp, analyzeVite, analyzeReactRouter, analyzeNestJS };
+export { analyzeExpress, analyzeNextPages, analyzeNextApp, analyzeVite, analyzeReactRouter, analyzeNestJS, analyzeFastify };
 export { exportToJSON } from './export.js';
 export { uploadRoutes } from './uploader.js';
 export { detectFramework } from './detect.js';
@@ -201,6 +222,7 @@ export default {
     analyzeExpress,
     analyzeNextPages,
     analyzeNextApp,
+    analyzeFastify,
     analyzeVite,
     analyzeReactRouter,
     analyzeNestJS,

package/dist/types/detect.d.ts

@@ -1,11 +1,15 @@
-export type Framework = 'express' | 'fastify' | 'koa' | 'hapi' | 'nestjs' | 'nextjs-pages' | 'nextjs-app' | 'vite' | 'react-router' | 'node-http' | 'unknown';
+export type Framework = 'express' | 'fastify' | 'koa' | 'hapi' | 'nestjs' | 'nextjs-pages' | 'nextjs-app' | 'vite' | 'react-router' | 'unknown';
 export interface FrameworkInfo {
     name: Framework;
     version?: string;
     confidence: number;
+    /** Whether analyze() has a working analyzer for this framework. */
+    supported: boolean;
 }
 /**
- * Detect the web framework from the live app instance + filesystem hints.
- * Confidence is used to pick the best match when multiple signals fire.
+ * Frameworks analyze() can actually dispatch to. Detection can identify more
+ * frameworks than this (koa, hapi) — those are named so the detector is honest
+ * about what it saw, but `supported: false` tells callers not to expect output.
  */
+export declare const SUPPORTED_FRAMEWORKS: ReadonlySet<Framework>;
 export declare function detectFramework(app?: any): FrameworkInfo;

package/dist/types/frameworks/fastify.d.ts

@@ -0,0 +1,16 @@
+import type { Route } from "../export.js";
+type EnvelopeConfig = {
+    wrapper: string;
+    dataField: string;
+    excluded?: string[];
+    bare?: false;
+} | {
+    bare: true;
+};
+export declare function analyzeFastify(app: any, options?: {
+    scopeCatalogPath?: string;
+    errorCatalogPath?: string;
+    envelopes?: Record<string, EnvelopeConfig>;
+    annotationsPath?: string;
+}): Promise<Route[]>;
+export {};

package/dist/types/index.d.ts

@@ -7,6 +7,7 @@ import { analyzeNextApp } from './frameworks/nextjs-app.js';
 import { analyzeVite } from './frameworks/vite.js';
 import { analyzeReactRouter } from './frameworks/react-router.js';
 import { analyzeNestJS } from './frameworks/nestjs.js';
+import { analyzeFastify } from './frameworks/fastify.js';
 import { detectFramework } from './detect.js';
 import { exportToJSON } from './export.js';
 import { uploadRoutes } from './uploader.js';
@@ -28,11 +29,24 @@ export interface AnalyzerOptions {
     service?: string;
     /** CLI multi-service mode: write routes to this file and exit without uploading */
     statusFile?: string;
+    /** JSON file mapping scope name -> extra metadata, joined onto each route's resolved scope. */
+    scopeCatalogPath?: string;
+    /** JSON file mapping error code -> { status, retry?, ... }, joined onto routes by response status. */
+    errorCatalogPath?: string;
+    /** Per-prefix response envelope shape, e.g. { '/v2': { wrapper: 'data', dataField: 'data' } }. */
+    envelopes?: Record<string, {
+        wrapper: string;
+        dataField: string;
+        excluded?: string[];
+    }>;
+    /** JSON file keyed by "METHOD /path" carrying summary/description/tags/deprecated/errors overrides for what can't be inferred. */
+    annotationsPath?: string;
 }
 export declare function analyze(app: any, options: AnalyzerOptions): Promise<any[]>;
-export { analyzeExpress, analyzeNextPages, analyzeNextApp, analyzeVite, analyzeReactRouter, analyzeNestJS };
+export { analyzeExpress, analyzeNextPages, analyzeNextApp, analyzeVite, analyzeReactRouter, analyzeNestJS, analyzeFastify };
 export { exportToJSON } from './export.js';
 export { uploadRoutes } from './uploader.js';
+export type { Route } from './export.js';
 export { detectFramework } from './detect.js';
 export { detectArchitectureType } from './arch-detect.js';
 declare const _default: {
@@ -40,6 +54,7 @@ declare const _default: {
     analyzeExpress: typeof analyzeExpress;
     analyzeNextPages: typeof analyzeNextPages;
     analyzeNextApp: typeof analyzeNextApp;
+    analyzeFastify: typeof analyzeFastify;
     analyzeVite: typeof analyzeVite;
     analyzeReactRouter: typeof analyzeReactRouter;
     analyzeNestJS: typeof analyzeNestJS;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "apiforge-analyzer",
-  "version": "1.3.1",
-  "description": "Universal API documentation generator for Express, Next.js, Vite, React Router, and Node.js",
+  "version": "1.3.3",
+  "description": "Universal API documentation generator for Express, Fastify, Next.js, Vite, React Router, and Node.js",
   "type": "module",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",
@@ -24,7 +24,7 @@
   "scripts": {
     "build": "npm run build:esm && npm run build:cjs && npm run build:types",
     "build:esm": "tsc -p tsconfig.esm.json",
-    "build:cjs": "tsc -p tsconfig.cjs.json && echo '{\"type\":\"commonjs\"}' > dist/cjs/package.json",
+    "build:cjs": "tsc -p tsconfig.cjs.json && node -e \"require('fs').writeFileSync('dist/cjs/package.json', JSON.stringify({type:'commonjs'}))\"",
     "build:types": "tsc -p tsconfig.types.json",
     "prepublishOnly": "npm run build",
     "test": "node ../test-apps/run-all.cjs"
@@ -59,6 +59,9 @@
   "devDependencies": {
     "@types/express": "^4.17.21",
     "@types/node": "^20.0.0",
-    "typescript": "^5.3.0"
+    "fastify": "^5.12.1",
+    "ts-morph": "^28.0.0",
+    "typescript": "^5.3.0",
+    "zod": "^4.5.4"
   }
 }