@devbro/pashmak 0.1.27 → 0.1.28

package/dist/app/console/generate/GenerateApiDocsCommand.d.mts

@@ -0,0 +1,9 @@
+import { Command } from 'clipanion';
+
+declare class GenerateApiDocsCommand extends Command {
+    static paths: string[][];
+    execute(): Promise<void>;
+    private extractParameters;
+}
+
+export { GenerateApiDocsCommand };

package/dist/app/console/generate/GenerateApiDocsCommand.mjs

@@ -0,0 +1,117 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+import { cli, router } from "../../../facades.mjs";
+import { Command } from "clipanion";
+import path from "path";
+import * as fs from "fs/promises";
+class GenerateApiDocsCommand extends Command {
+  static {
+    __name(this, "GenerateApiDocsCommand");
+  }
+  static paths = [
+    [`make`, `apidocs`],
+    [`generate`, `apidocs`]
+  ];
+  async execute() {
+    const rootDir = process.cwd();
+    this.context.stdout.write(`Generating OpenAPI documentation...
+`);
+    const routes = router().routes;
+    const openApiSpec = {
+      openapi: "3.0.0",
+      info: {
+        title: "API Documentation",
+        version: "1.0.0",
+        description: "Auto-generated API documentation"
+      },
+      servers: [
+        {
+          url: "/",
+          description: "Local server"
+        }
+      ],
+      paths: {}
+    };
+    for (const route of routes) {
+      const routePath = route.path;
+      const openApiPath = routePath.replace(/:([a-zA-Z0-9_]+)/g, "{$1}");
+      if (!openApiSpec.paths[openApiPath]) {
+        openApiSpec.paths[openApiPath] = {};
+      }
+      for (const method of route.methods) {
+        const lowerMethod = method.toLowerCase();
+        if (lowerMethod === "head") {
+          continue;
+        }
+        openApiSpec.paths[openApiPath][lowerMethod] = {
+          summary: `${method} ${routePath}`,
+          description: `Endpoint for ${method} ${routePath}`,
+          parameters: this.extractParameters(routePath),
+          responses: {
+            "200": {
+              description: "Successful response",
+              content: {
+                "application/json": {
+                  schema: {
+                    type: "object"
+                  }
+                }
+              }
+            },
+            "500": {
+              description: "Internal server error"
+            }
+          }
+        };
+        if (["post", "put", "patch"].includes(lowerMethod)) {
+          openApiSpec.paths[openApiPath][lowerMethod].requestBody = {
+            required: true,
+            content: {
+              "application/json": {
+                schema: {
+                  type: "object"
+                }
+              }
+            }
+          };
+        }
+      }
+    }
+    const publicDir = path.join(rootDir, "public");
+    await fs.mkdir(publicDir, { recursive: true });
+    const outputPath = path.join(publicDir, "openapi.json");
+    await fs.writeFile(
+      outputPath,
+      JSON.stringify(openApiSpec, null, 2),
+      "utf-8"
+    );
+    this.context.stdout.write(
+      `OpenAPI documentation generated at: ${outputPath}
+`
+    );
+    this.context.stdout.write(`Total routes documented: ${routes.length}
+`);
+  }
+  extractParameters(routePath) {
+    const paramRegex = /:([a-zA-Z0-9_]+)/g;
+    const parameters = [];
+    let match;
+    while ((match = paramRegex.exec(routePath)) !== null) {
+      parameters.push({
+        name: match[1],
+        in: "path",
+        required: true,
+        schema: {
+          type: "string"
+        },
+        description: `Path parameter ${match[1]}`
+      });
+    }
+    return parameters;
+  }
+}
+cli().register(GenerateApiDocsCommand);
+export {
+  GenerateApiDocsCommand
+};
+//# sourceMappingURL=GenerateApiDocsCommand.mjs.map

package/dist/app/console/generate/GenerateApiDocsCommand.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../../src/app/console/generate/GenerateApiDocsCommand.mts"],"sourcesContent":["import { cli, router } from \"../../../facades.mjs\";\nimport { Command } from \"clipanion\";\nimport path from \"path\";\nimport * as fs from \"fs/promises\";\n\nexport class GenerateApiDocsCommand extends Command {\n  static paths = [\n    [`make`, `apidocs`],\n    [`generate`, `apidocs`],\n  ];\n\n  async execute() {\n    const rootDir = process.cwd();\n\n    this.context.stdout.write(`Generating OpenAPI documentation...\\n`);\n\n    // Get all routes from the router\n    const routes = router().routes;\n\n    // Generate OpenAPI 3.0 specification\n    const openApiSpec = {\n      openapi: \"3.0.0\",\n      info: {\n        title: \"API Documentation\",\n        version: \"1.0.0\",\n        description: \"Auto-generated API documentation\",\n      },\n      servers: [\n        {\n          url: \"/\",\n          description: \"Local server\",\n        },\n      ],\n      paths: {} as Record<string, any>,\n    };\n\n    // Process each route\n    for (const route of routes) {\n      const routePath = route.path;\n      // Convert route path to OpenAPI format (e.g., /api/:id -> /api/{id})\n      const openApiPath = routePath.replace(/:([a-zA-Z0-9_]+)/g, \"{$1}\");\n\n      if (!openApiSpec.paths[openApiPath]) {\n        openApiSpec.paths[openApiPath] = {};\n      }\n\n      // Add each HTTP method for this route\n      for (const method of route.methods) {\n        const lowerMethod = method.toLowerCase();\n\n        // Skip HEAD as it's usually auto-generated\n        if (lowerMethod === \"head\") {\n          continue;\n        }\n\n        openApiSpec.paths[openApiPath][lowerMethod] = {\n          summary: `${method} ${routePath}`,\n          description: `Endpoint for ${method} ${routePath}`,\n          parameters: this.extractParameters(routePath),\n          responses: {\n            \"200\": {\n              description: \"Successful response\",\n              content: {\n                \"application/json\": {\n                  schema: {\n                    type: \"object\",\n                  },\n                },\n              },\n            },\n            \"500\": {\n              description: \"Internal server error\",\n            },\n          },\n        };\n\n        // Add request body for POST, PUT, PATCH\n        if ([\"post\", \"put\", \"patch\"].includes(lowerMethod)) {\n          openApiSpec.paths[openApiPath][lowerMethod].requestBody = {\n            required: true,\n            content: {\n              \"application/json\": {\n                schema: {\n                  type: \"object\",\n                },\n              },\n            },\n          };\n        }\n      }\n    }\n\n    // Ensure public directory exists\n    const publicDir = path.join(rootDir, \"public\");\n    await fs.mkdir(publicDir, { recursive: true });\n\n    // Write the OpenAPI spec to public/openapi.json\n    const outputPath = path.join(publicDir, \"openapi.json\");\n    await fs.writeFile(\n      outputPath,\n      JSON.stringify(openApiSpec, null, 2),\n      \"utf-8\",\n    );\n\n    this.context.stdout.write(\n      `OpenAPI documentation generated at: ${outputPath}\\n`,\n    );\n    this.context.stdout.write(`Total routes documented: ${routes.length}\\n`);\n  }\n\n  private extractParameters(routePath: string): any[] {\n    const paramRegex = /:([a-zA-Z0-9_]+)/g;\n    const parameters: any[] = [];\n    let match;\n\n    while ((match = paramRegex.exec(routePath)) !== null) {\n      parameters.push({\n        name: match[1],\n        in: \"path\",\n        required: true,\n        schema: {\n          type: \"string\",\n        },\n        description: `Path parameter ${match[1]}`,\n      });\n    }\n\n    return parameters;\n  }\n}\n\ncli().register(GenerateApiDocsCommand);\n"],"mappings":";;AAAA,SAAS,KAAK,cAAc;AAC5B,SAAS,eAAe;AACxB,OAAO,UAAU;AACjB,YAAY,QAAQ;AAEb,MAAM,+BAA+B,QAAQ;AAAA,EALpD,OAKoD;AAAA;AAAA;AAAA,EAClD,OAAO,QAAQ;AAAA,IACb,CAAC,QAAQ,SAAS;AAAA,IAClB,CAAC,YAAY,SAAS;AAAA,EACxB;AAAA,EAEA,MAAM,UAAU;AACd,UAAM,UAAU,QAAQ,IAAI;AAE5B,SAAK,QAAQ,OAAO,MAAM;AAAA,CAAuC;AAGjE,UAAM,SAAS,OAAO,EAAE;AAGxB,UAAM,cAAc;AAAA,MAClB,SAAS;AAAA,MACT,MAAM;AAAA,QACJ,OAAO;AAAA,QACP,SAAS;AAAA,QACT,aAAa;AAAA,MACf;AAAA,MACA,SAAS;AAAA,QACP;AAAA,UACE,KAAK;AAAA,UACL,aAAa;AAAA,QACf;AAAA,MACF;AAAA,MACA,OAAO,CAAC;AAAA,IACV;AAGA,eAAW,SAAS,QAAQ;AAC1B,YAAM,YAAY,MAAM;AAExB,YAAM,cAAc,UAAU,QAAQ,qBAAqB,MAAM;AAEjE,UAAI,CAAC,YAAY,MAAM,WAAW,GAAG;AACnC,oBAAY,MAAM,WAAW,IAAI,CAAC;AAAA,MACpC;AAGA,iBAAW,UAAU,MAAM,SAAS;AAClC,cAAM,cAAc,OAAO,YAAY;AAGvC,YAAI,gBAAgB,QAAQ;AAC1B;AAAA,QACF;AAEA,oBAAY,MAAM,WAAW,EAAE,WAAW,IAAI;AAAA,UAC5C,SAAS,GAAG,MAAM,IAAI,SAAS;AAAA,UAC/B,aAAa,gBAAgB,MAAM,IAAI,SAAS;AAAA,UAChD,YAAY,KAAK,kBAAkB,SAAS;AAAA,UAC5C,WAAW;AAAA,YACT,OAAO;AAAA,cACL,aAAa;AAAA,cACb,SAAS;AAAA,gBACP,oBAAoB;AAAA,kBAClB,QAAQ;AAAA,oBACN,MAAM;AAAA,kBACR;AAAA,gBACF;AAAA,cACF;AAAA,YACF;AAAA,YACA,OAAO;AAAA,cACL,aAAa;AAAA,YACf;AAAA,UACF;AAAA,QACF;AAGA,YAAI,CAAC,QAAQ,OAAO,OAAO,EAAE,SAAS,WAAW,GAAG;AAClD,sBAAY,MAAM,WAAW,EAAE,WAAW,EAAE,cAAc;AAAA,YACxD,UAAU;AAAA,YACV,SAAS;AAAA,cACP,oBAAoB;AAAA,gBAClB,QAAQ;AAAA,kBACN,MAAM;AAAA,gBACR;AAAA,cACF;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAGA,UAAM,YAAY,KAAK,KAAK,SAAS,QAAQ;AAC7C,UAAM,GAAG,MAAM,WAAW,EAAE,WAAW,KAAK,CAAC;AAG7C,UAAM,aAAa,KAAK,KAAK,WAAW,cAAc;AACtD,UAAM,GAAG;AAAA,MACP;AAAA,MACA,KAAK,UAAU,aAAa,MAAM,CAAC;AAAA,MACnC;AAAA,IACF;AAEA,SAAK,QAAQ,OAAO;AAAA,MAClB,uCAAuC,UAAU;AAAA;AAAA,IACnD;AACA,SAAK,QAAQ,OAAO,MAAM,4BAA4B,OAAO,MAAM;AAAA,CAAI;AAAA,EACzE;AAAA,EAEQ,kBAAkB,WAA0B;AAClD,UAAM,aAAa;AACnB,UAAM,aAAoB,CAAC;AAC3B,QAAI;AAEJ,YAAQ,QAAQ,WAAW,KAAK,SAAS,OAAO,MAAM;AACpD,iBAAW,KAAK;AAAA,QACd,MAAM,MAAM,CAAC;AAAA,QACb,IAAI;AAAA,QACJ,UAAU;AAAA,QACV,QAAQ;AAAA,UACN,MAAM;AAAA,QACR;AAAA,QACA,aAAa,kBAAkB,MAAM,CAAC,CAAC;AAAA,MACzC,CAAC;AAAA,IACH;AAEA,WAAO;AAAA,EACT;AACF;AAEA,IAAI,EAAE,SAAS,sBAAsB;","names":[]}

package/dist/app/console/generate/index.d.mts

@@ -1,2 +1,3 @@
 export { GenerateControllerCommand } from './GenerateControllerCommand.mjs';
+export { GenerateApiDocsCommand } from './GenerateApiDocsCommand.mjs';
 import 'clipanion';

package/dist/app/console/generate/index.mjs

@@ -1,2 +1,3 @@
 export * from "./GenerateControllerCommand.mjs";
+export * from "./GenerateApiDocsCommand.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/app/console/generate/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../../../src/app/console/generate/index.mts"],"sourcesContent":["export * from \"./GenerateControllerCommand.mjs\";\n"],"mappings":"AAAA,cAAc;","names":[]}
+{"version":3,"sources":["../../../../src/app/console/generate/index.mts"],"sourcesContent":["export * from \"./GenerateControllerCommand.mjs\";\nexport * from \"./GenerateApiDocsCommand.mjs\";\n"],"mappings":"AAAA,cAAc;AACd,cAAc;","names":[]}

package/dist/app/console/index.d.mts

@@ -5,6 +5,7 @@ export { StartCommand } from './StartCommand.mjs';
 export { DefaultCommand } from './DefaultCommand.mjs';
 export { KeyGenerateCommand } from './KeyGenerateCommand.mjs';
 export { GenerateControllerCommand } from './generate/GenerateControllerCommand.mjs';
+export { GenerateApiDocsCommand } from './generate/GenerateApiDocsCommand.mjs';
 export { CreateProjectCommand } from './project/CreateProjectCommand.mjs';
 export { GenerateQueueMigrateCommand } from './queue/GenerateQueueMigrateCommand.mjs';
 import 'clipanion';