katax-cli 1.1.4 → 1.2.0

package/dist/templates/generators/swagger-template.js

@@ -0,0 +1,117 @@
+export function generateSwaggerSetup() {
+    return `import swaggerUi from 'swagger-ui-express';
+import { Express } from 'express';
+import fs from 'fs';
+import path from 'path';
+
+/**
+ * Setup Swagger UI documentation
+ */
+export function setupSwagger(app: Express): void {
+  try {
+    const swaggerPath = path.join(__dirname, '../openapi.json');
+    
+    if (!fs.existsSync(swaggerPath)) {
+      console.warn('⚠️  OpenAPI spec not found. Run: katax generate docs');
+      return;
+    }
+
+    const swaggerDocument = JSON.parse(fs.readFileSync(swaggerPath, 'utf-8'));
+
+    // Swagger UI options
+    const options = {
+      explorer: true,
+      customCss: '.swagger-ui .topbar { display: none }',
+      customSiteTitle: 'API Documentation',
+    };
+
+    // Setup Swagger UI
+    app.use('/docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));
+    app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, options));
+
+    // JSON endpoint
+    app.get('/openapi.json', (req, res) => {
+      res.setHeader('Content-Type', 'application/json');
+      res.send(swaggerDocument);
+    });
+
+    console.log('📖 API Documentation available at: http://localhost:3000/docs');
+  } catch (error) {
+    console.error('Failed to setup Swagger:', error);
+  }
+}
+`;
+}
+export function generateSwaggerReadme() {
+    return `# API Documentation
+
+## Swagger UI
+
+Interactive API documentation is available at:
+
+- **Development**: http://localhost:3000/docs
+- **OpenAPI Spec**: http://localhost:3000/openapi.json
+
+## Features
+
+✅ Interactive API testing
+✅ Auto-generated from code
+✅ Request/Response examples
+✅ Schema validation docs
+✅ Export to Postman
+
+## Usage
+
+### View Documentation
+
+\`\`\`bash
+# Start your API
+npm run dev
+
+# Open browser
+open http://localhost:3000/docs
+\`\`\`
+
+### Regenerate Documentation
+
+\`\`\`bash
+# Auto-regenerates when you generate endpoints
+katax generate crud users
+katax add endpoint products
+
+# Or manually regenerate
+katax generate docs
+katax generate docs --force
+\`\`\`
+
+### Export to Postman
+
+1. Open http://localhost:3000/openapi.json
+2. Copy the JSON
+3. In Postman: File → Import → Raw Text → Paste
+4. ✅ All endpoints imported!
+
+## Customization
+
+Edit \`src/config/swagger.config.ts\` to customize:
+- API title and description
+- Server URLs
+- Authentication schemes
+- Contact information
+
+## Maintaining Docs
+
+Documentation is automatically updated when you:
+- Generate CRUD resources
+- Add new endpoints
+- Update validators
+
+The documentation reads directly from your:
+- Route files (\`*.routes.ts\`)
+- Validator files (\`*.validator.ts\`)
+- Katax-core schemas
+
+**No manual updates needed!** 🎉
+`;
+}
+//# sourceMappingURL=swagger-template.js.map

package/dist/templates/generators/swagger-template.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"swagger-template.js","sourceRoot":"","sources":["../../../src/templates/generators/swagger-template.ts"],"names":[],"mappings":"AAKA,MAAM,UAAU,oBAAoB;IAClC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyCR,CAAC;AACF,CAAC;AAED,MAAM,UAAU,qBAAqB;IACnC,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAqER,CAAC;AACF,CAAC"}

package/dist/types/index.d.ts

@@ -1,13 +1,22 @@
 export interface ProjectConfig {
     name: string;
     description?: string;
-    type: 'rest-api' | 'graphql';
+    type: "rest-api" | "graphql";
     typescript: boolean;
-    database?: 'postgresql' | 'mysql' | 'mongodb' | 'none';
-    authentication?: 'jwt' | 'none';
-    validation: 'katax-core' | 'none';
-    orm?: 'none' | 'prisma' | 'typeorm';
+    database?: "postgresql" | "mysql" | "mongodb" | "none";
+    authentication?: "jwt" | "none";
+    validation: "katax-core" | "none";
+    swagger?: boolean;
+    orm?: "none" | "prisma" | "typeorm";
     port: number;
+    useKataxServiceManager?: boolean;
+    useRedis?: boolean;
+    redisConfig?: {
+        host?: string;
+        port?: string;
+        password?: string;
+        db?: string;
+    };
     dbConfig?: {
         host?: string;
         port?: string;
@@ -19,26 +28,26 @@ export interface ProjectConfig {
 }
 export interface EndpointConfig {
     name: string;
-    method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+    method: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
     path: string;
     addValidation: boolean;
     fields?: FieldConfig[];
     addAsyncValidators: boolean;
-    dbOperations?: ('create' | 'read' | 'update' | 'delete')[];
+    dbOperations?: ("create" | "read" | "update" | "delete")[];
 }
 export interface FieldConfig {
     name: string;
-    type: 'string' | 'number' | 'boolean' | 'date' | 'email' | 'array' | 'object';
+    type: "string" | "number" | "boolean" | "date" | "email" | "array" | "object";
     required: boolean;
     rules?: ValidationRule[];
     asyncValidator?: {
-        type: 'unique' | 'exists' | 'custom';
+        type: "unique" | "exists" | "custom";
         table?: string;
         column?: string;
     };
 }
 export interface ValidationRule {
-    type: 'minLength' | 'maxLength' | 'min' | 'max' | 'email' | 'regex' | 'oneOf' | 'custom';
+    type: "minLength" | "maxLength" | "min" | "max" | "email" | "regex" | "oneOf" | "custom";
     value?: any;
     message?: string;
 }

package/dist/types/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAC7B,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,YAAY,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IACvD,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAChC,UAAU,EAAE,YAAY,GAAG,MAAM,CAAC;IAClC,GAAG,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,OAAO,CAAC;IACvB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,CAAC,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC,EAAE,CAAC;CAC5D;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC9E,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,cAAc,CAAC,EAAE;QACf,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;QACrC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,WAAW,GAAG,WAAW,GAAG,KAAK,GAAG,KAAK,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;IACzF,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;CAClB"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,EAAE,UAAU,GAAG,SAAS,CAAC;IAC7B,UAAU,EAAE,OAAO,CAAC;IACpB,QAAQ,CAAC,EAAE,YAAY,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;IACvD,cAAc,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;IAChC,UAAU,EAAE,YAAY,GAAG,MAAM,CAAC;IAClC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,GAAG,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,SAAS,CAAC;IACpC,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB,CAAC,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,WAAW,CAAC,EAAE;QACZ,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,EAAE,CAAC,EAAE,MAAM,CAAC;KACb,CAAC;IACF,QAAQ,CAAC,EAAE;QACT,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,KAAK,GAAG,MAAM,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;IACpD,IAAI,EAAE,MAAM,CAAC;IACb,aAAa,EAAE,OAAO,CAAC;IACvB,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;IACvB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,YAAY,CAAC,EAAE,CAAC,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC,EAAE,CAAC;CAC5D;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG,OAAO,GAAG,OAAO,GAAG,QAAQ,CAAC;IAC9E,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,cAAc,EAAE,CAAC;IACzB,cAAc,CAAC,EAAE;QACf,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,QAAQ,CAAC;QACrC,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,MAAM,WAAW,cAAc;IAC7B,IAAI,EACA,WAAW,GACX,WAAW,GACX,KAAK,GACL,KAAK,GACL,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,CAAC;IACb,KAAK,CAAC,EAAE,GAAG,CAAC;IACZ,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,UAAU;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,WAAW,EAAE,CAAC;IACtB,OAAO,EAAE,OAAO,CAAC;CAClB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "katax-cli",
-  "version": "1.1.4",
+  "version": "1.2.0",
   "description": "CLI tool to generate Express APIs with TypeScript and katax-core validation",
   "type": "module",
   "main": "dist/index.js",