go-duck-cli 1.3.2 → 1.3.5

package/generators/swagger.js

@@ -6,6 +6,9 @@ export const generateSwaggerDocs = async (config, entities, outputDir, openEntit
     const docsDir = path.join(outputDir, 'docs');
     await fs.ensureDir(docsDir);
 
+    const apiPrefixRaw = config.server?.rest?.['api-path-prefix'] || '/api';
+    const apiPrefix = apiPrefixRaw.endsWith('/') ? apiPrefixRaw.slice(0, -1) : apiPrefixRaw;
+
     const swagger = {
         openapi: '3.0.0',
         info: {
@@ -14,7 +17,7 @@ export const generateSwaggerDocs = async (config, entities, outputDir, openEntit
             description: `Generated documentation for ${config.name} microservice`
         },
         servers: [
-            { url: `http://localhost:${config.server?.port || 8080}`, description: 'Local Development Server' }
+            { url: "/", description: "Current Host" }
         ],
         paths: {},
         components: {
@@ -48,7 +51,7 @@ export const generateSwaggerDocs = async (config, entities, outputDir, openEntit
     };
 
     const commonHeaders = [
-        { name: 'X-Tenant-ID', in: 'header', required: true, schema: { type: 'string', default: 'default' }, description: 'Multi-tenancy context identifier' }
+        { name: 'X-Tenant-ID', in: 'header', required: false, schema: { type: 'string', default: 'default' }, description: 'Multi-tenancy context identifier' }
     ];
 
     const isOpen = (entityName, action) => {
@@ -81,7 +84,7 @@ export const generateSwaggerDocs = async (config, entities, outputDir, openEntit
             properties: {
                 id: { type: 'integer' },
                 ...entity.fields.reduce((acc, field) => {
-                    acc[field.name] = { type: mapToSwaggerType(field.type) };
+                    acc[field.name] = getSwaggerFieldSchema(field.type);
                     return acc;
                 }, {}),
                 createdAt: { type: 'string', format: 'date-time' },
@@ -201,14 +204,14 @@ export const generateSwaggerDocs = async (config, entities, outputDir, openEntit
         };
 
         // 1a. Secured Paths
-        addEntityOperations('/api', false);
+        addEntityOperations(apiPrefix, false);
 
         // 1b. Public Paths (if marked as open)
-        addEntityOperations('/open/api', true);
+        addEntityOperations('/open' + apiPrefix, true);
     }
 
     // 2. Add System Paths
-    swagger.paths['/api/rpc/{table}'] = {
+    swagger.paths[`${apiPrefix}/rpc/{table}`] = {
         get: {
             tags: ['Search Engine'],
             summary: 'Generic PostgREST RPC Engine',
@@ -240,7 +243,7 @@ export const generateSwaggerDocs = async (config, entities, outputDir, openEntit
         }
     };
 
-    swagger.paths['/api/admin/audit'] = {
+    swagger.paths[`${apiPrefix}/admin/audit`] = {
         get: {
             tags: ['Observability'],
             summary: 'Fetch Audit Trail',
@@ -270,7 +273,7 @@ export const generateSwaggerDocs = async (config, entities, outputDir, openEntit
                 }
             },
             parameters: [
-                { name: 'X-Tenant-ID', in: 'header', required: true, schema: { type: 'string', default: 'master_internal' }, description: 'SuperAdmin internal master bypass token' }
+                { name: 'X-Tenant-ID', in: 'header', required: false, schema: { type: 'string', default: 'master_internal' }, description: 'SuperAdmin internal master bypass token' }
             ],
             responses: {
                 200: { description: 'Success' },
@@ -281,7 +284,7 @@ export const generateSwaggerDocs = async (config, entities, outputDir, openEntit
     };
 
     if (config.elasticsearch?.enabled) {
-        swagger.paths['/api/search/{entity}'] = {
+        swagger.paths[`${apiPrefix}/search/{entity}`] = {
             get: {
                 tags: ['Search Engine'],
                 summary: 'Elasticsearch Global Search',
@@ -315,19 +318,19 @@ export const generateSwaggerDocs = async (config, entities, outputDir, openEntit
     console.log(chalk.gray('  Generated Swagger Documentation: swagger.json'));
 };
 
-const mapToSwaggerType = (type) => {
-    const types = {
-        'String': 'string',
-        'Integer': 'integer',
-        'Float': 'number',
-        'Boolean': 'boolean',
-        'Long': 'integer',
-        'BigDecimal': 'number',
-        'LocalDate': 'string',
-        'Instant': 'string',
-        'JSON': 'object',
-        'JSONB': 'object',
-        'Text': 'string'
+const getSwaggerFieldSchema = (type) => {
+    const schemas = {
+        'String': { type: 'string' },
+        'Integer': { type: 'integer', format: 'int32' },
+        'Float': { type: 'number', format: 'double' },
+        'Boolean': { type: 'boolean' },
+        'Long': { type: 'integer', format: 'int64' },
+        'BigDecimal': { type: 'number', format: 'double' },
+        'LocalDate': { type: 'string', format: 'date' },
+        'Instant': { type: 'string', format: 'date-time' },
+        'JSON': { type: 'object' },
+        'JSONB': { type: 'object' },
+        'Text': { type: 'string' }
     };
-    return types[type] || 'string';
+    return schemas[type] || { type: 'string' };
 };

package/index.js

@@ -31,6 +31,7 @@ import { generateWebSocketCode } from './generators/websocket.js';
 import { generateConfigLoader } from './generators/config.js';
 import { generateLoggerCode } from './generators/logger.js';
 import { generateMQTTCode } from './generators/mqtt.js';
+import { generateMQTTTopicsJSON } from './generators/mqtt-topics.js';
 import { generateCacheCode } from './generators/cache.js';
 import { generateResilienceCode } from './generators/resilience.js';
 import { generateTelemetryCode } from './generators/telemetry.js';
@@ -875,13 +876,21 @@ const generateYAMLConfigs = async (config, outputDir) => {
         delete cleanConfig.datasource['multitenancy-databases'];
     }
 
+    const toKebabCase = (str) => {
+        if (!str) return '';
+        return str.replace(/([a-z0-9])([A-Z])/g, '$1-$2').toLowerCase();
+    };
+
+    const rawApiPrefix = cleanConfig.server?.rest?.['api-path-prefix'] || `/${cleanConfig.name || 'api'}/api`;
+    const kebabApiPrefix = rawApiPrefix.split('/').map(segment => toKebabCase(segment)).join('/');
+
     const extendedConfig = {
         ...cleanConfig,
         server: {
             rest: {
                 port: cleanConfig.server?.rest?.port || cleanConfig.server?.port || 8080,
                 protocol: cleanConfig.server?.rest?.protocol || 'json',
-                'api-path-prefix': cleanConfig.server?.rest?.['api-path-prefix'] || `/${cleanConfig.name || 'api'}/api`
+                'api-path-prefix': kebabApiPrefix
             },
             'read-timeout': cleanConfig.server?.['read-timeout'] || '30s',
             'write-timeout': cleanConfig.server?.['write-timeout'] || '30s',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "go-duck-cli",
-  "version": "1.3.2",
+  "version": "1.3.5",
   "description": "The Ultimate Evolutionary Go Microservice Scaffolder.",
   "main": "index.js",
   "type": "module",
@@ -10,6 +10,9 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "author": "heavenscode",
   "license": "ISC",
   "dependencies": {
@@ -21,5 +24,23 @@
     "inquirer": "^8.2.7",
     "js-yaml": "^4.1.1",
     "open": "^11.0.0"
+  },
+  "keywords": [
+    "go",
+    "golang",
+    "microservice",
+    "scaffold",
+    "cli",
+    "generator",
+    "go-duck"
+  ],
+  
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/heavenscode/go-duck.git"
+  },
+  "homepage": "https://goduck.theheavenscode.com",
+  "bugs": {
+    "url": "https://github.com/heavenscode/go-duck/issues"
   }
 }

package/templates/docs/pages/index.hbs

@@ -16,7 +16,7 @@
                     <span class="animate-ping absolute inline-flex h-full w-full rounded-full bg-emerald-400 opacity-75"></span>
                     <span class="relative inline-flex rounded-full h-3 w-3 bg-emerald-500"></span>
                 </span>
-                <p class="text-[11px] font-black text-indigo-900 uppercase tracking-[0.25em]">The 395% Elite Milestone Surpassed</p>
+                <p class="text-[11px] font-black text-indigo-900 uppercase tracking-[0.25em]">The 420% Elite Milestone Surpassed</p>
             </div>
             
             <!-- Heroic Logo Anchor (Enhanced) -->
@@ -121,6 +121,16 @@
                     </div>
                 </div>
 
+                <div class="lg:col-span-12 bg-white p-10 rounded-[2.5rem] border border-amber-100 shadow-sm hover:shadow-2xl transition-all group relative overflow-hidden cursor-crosshair bg-gradient-to-br from-white to-amber-50/30">
+                    <p class="text-[9px] font-bold text-amber-600 uppercase tracking-widest mb-4">Elite Extension (+10%)</p>
+                    <h4 class="text-2xl font-black text-slate-900 mb-3 tracking-tight italic">API Gateway Standards & Swagger UI</h4>
+                    <p class="text-slate-600 leading-relaxed mb-8">Natively exposes OpenAPI JSON at the JHipster-standard <code>/v3/api-docs</code> endpoint. Features a completely re-engineered, glassmorphism Swagger UI deeply integrated with Keycloak SSO and automatic token refreshing.</p>
+                    <div class="flex gap-3">
+                        <span class="px-4 py-1.5 bg-amber-100 text-amber-700 text-[9px] font-black rounded-lg">JHIPSTER COMPATIBLE</span>
+                        <span class="px-4 py-1.5 bg-amber-100 text-amber-700 text-[9px] font-black rounded-lg">KEYCLOAK SSO UI</span>
+                    </div>
+                </div>
+
                 <div class="lg:col-span-12 bg-white p-10 rounded-[2.5rem] border border-fuchsia-100 shadow-sm hover:shadow-2xl transition-all group relative overflow-hidden cursor-crosshair bg-gradient-to-br from-white to-fuchsia-50/30">
                     <p class="text-[9px] font-bold text-fuchsia-600 uppercase tracking-widest mb-4">Elite Extension (+12%)</p>
                     <h4 class="text-2xl font-black text-slate-900 mb-3 tracking-tight italic">K8s Network Isolation & NodePorts</h4>
@@ -436,7 +446,7 @@
                 </div>
 
             <div class="mt-24 text-slate-500 font-mono text-[10px] uppercase tracking-[0.6em] font-black relative z-10">
-                GO-DUCK &bull; THE 395% ELITE MILESTONE &bull; SOVEREIGN CODE ORCHESTRATION
+                GO-DUCK &bull; THE 420% ELITE MILESTONE &bull; SOVEREIGN CODE ORCHESTRATION
             </div>
         </div>
     </section>

package/templates/docs/pages/integrations.hbs

@@ -86,8 +86,13 @@ class ApiProvider {
     <h2 class="text-2xl font-bold text-gray-800 mb-4 border-b pb-2">3. WSO2 API Manager Integration</h2>
     <p class="mb-4">GO-DUCK generated APIs can automatically register themselves with a <strong>WSO2 API Manager</strong> instance on startup. This uses the WSO2 Publisher REST API to import your dynamically generated OpenAPI 3.0 specs.</p>
     
+    <div class="bg-indigo-50 border-l-4 border-indigo-500 p-4 mb-6 rounded-r">
+        <h4 class="font-bold text-indigo-900 mb-1">Standard API Gateway Discovery</h4>
+        <p class="text-sm text-indigo-800">For external gateways (Kong, Apigee) and ecosystems like <strong>JHipster</strong> and <strong>Spring Boot</strong>, your microservice natively exposes its OpenAPI JSON at the standard <code>/v3/api-docs</code> endpoint. Legacy systems can still use <code>/swagger.json</code>.</p>
+    </div>
+
     <div class="bg-blue-50 border-l-4 border-blue-500 p-4 mb-6 rounded-r">
-        <p class="text-blue-900"><strong>Configuration:</strong> Enable this by adding the <code>wso2</code> block to your <code>config.yaml</code>.</p>
+        <p class="text-blue-900"><strong>WSO2 Configuration:</strong> Enable this by adding the <code>wso2</code> block to your <code>config.yaml</code>.</p>
     </div>
 
     <pre><code class="language-yaml">go-duck:

package/templates/docs/pages/mosquitto.hbs

@@ -29,6 +29,12 @@ messaging.Publish("events/users", event)</code></pre>
 mosquitto_sub -h localhost -p {{mqttPort}} -t "audit/logs/#" -v</code></pre>
 </section>
 
+<section class="mb-10">
+    <h2 class="text-2xl font-bold text-gray-800 mb-4 border-b pb-2">Interactive Swagger Console</h2>
+    <p class="mb-4">GO-DUCK's automatically generated Swagger UI features a built-in <strong>Interactive MQTT Topics Dictionary</strong>. By connecting via WebSockets, it allows authenticated users to dynamically <strong>SUBSCRIBE</strong> to event streams or <strong>PUBLISH</strong> payloads directly from the documentation interface!</p>
+    <p class="mb-4 text-sm text-gray-600 italic">Note: Ensure your Mosquitto broker is configured to accept WebSocket connections (default port 9001) for this feature to work.</p>
+</section>
+
 <section class="mb-10">
     <h2 class="text-2xl font-bold text-gray-800 mb-4 border-b pb-2">External Resources</h2>
     <ul class="space-y-2">