npm - go-duck-cli - Versions diffs - 1.3.2 → 1.3.5 - Mend

go-duck-cli 1.3.2 → 1.3.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (15) hide show

package/README.md +4 -1
package/generators/ai_docs.js +14 -11
package/generators/config.js +6 -1
package/generators/devops.js +86 -17
package/generators/docs.js +1 -1
package/generators/mqtt-topics.js +54 -0
package/generators/postman.js +24 -20
package/generators/router.js +8 -1
package/generators/swagger.js +26 -23
package/index.js +10 -1
package/package.json +22 -1
package/templates/docs/pages/index.hbs +12 -2
package/templates/docs/pages/integrations.hbs +6 -1
package/templates/docs/pages/mosquitto.hbs +6 -0
package/templates/go/router.go.hbs +467 -15

package/templates/go/router.go.hbs CHANGED Viewed

@@ -5,6 +5,7 @@ import (
     "fmt"
     "log"
     "net/http"
+    "strings"
     "time"
     "github.com/gin-gonic/gin"
@@ -162,41 +163,492 @@ func SetupRouter(appConfig *config.Config) *gin.Engine {
     })
     // Swagger Docs & UI
-    r.StaticFile("/swagger.json", "./docs/swagger.json")
+    // Expose standard OpenAPI endpoints (JHipster / Spring / WSO2 compatibility)
+    r.StaticFile("/v3/api-docs", "./docs/swagger.json")
+    r.StaticFile("/swagger.json", "./docs/swagger.json") // Legacy fallback
+    r.StaticFile("/api/mqtt-topics", "./docs/mqtt_topics.json5")
+    r.StaticFile("/logo.png", "./docs/web/logo.png")
     r.GET("/swagger", func(c *gin.Context) {
-        c.Data(http.StatusOK, "text/html; charset=utf-8", []byte(`<!DOCTYPE html>
+        swaggerHTML := `<!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="UTF-8">
-  <title>Swagger UI</title>
+  <title>Swagger UI (Secured)</title>
   <link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/4.15.5/swagger-ui.css" />
+  <script src="https://cdn.jsdelivr.net/npm/keycloak-js@24.0.4/dist/keycloak.min.js"></script>
+  <script src="https://unpkg.com/mqtt/dist/mqtt.min.js"></script>
   <style>
     html { box-sizing: border-box; overflow: -moz-scrollbars-vertical; overflow-y: scroll; }
     *, *:before, *:after { box-sizing: inherit; }
-    body { margin:0; background: #fafafa; }
+    body { margin:0; background: #fafafa; font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif; }
+    .top-nav {
+      background: rgba(255, 255, 255, 0.8);
+      backdrop-filter: blur(10px);
+      -webkit-backdrop-filter: blur(10px);
+      border-bottom: 1px solid rgba(0, 0, 0, 0.1);
+      padding: 12px 24px;
+      display: flex;
+      justify-content: space-between;
+      align-items: center;
+      position: sticky;
+      top: 0;
+      z-index: 1000;
+      box-shadow: 0 4px 6px -1px rgba(0,0,0,0.05);
+    }
+    .nav-brand {
+      font-weight: 700;
+      font-size: 1.2rem;
+      color: #333;
+      display: flex;
+      align-items: center;
+      gap: 10px;
+    }
+    .nav-controls {
+      display: flex;
+      align-items: center;
+      gap: 16px;
+    }
+    .tenant-input {
+      padding: 8px 12px;
+      border: 1px solid #ddd;
+      border-radius: 6px;
+      font-size: 0.9rem;
+      outline: none;
+      transition: border-color 0.2s;
+    }
+    .tenant-input:focus {
+      border-color: #4a90e2;
+    }
+    .btn {
+      padding: 8px 16px;
+      border-radius: 6px;
+      border: none;
+      font-weight: 600;
+      cursor: pointer;
+      transition: all 0.2s;
+      font-size: 0.9rem;
+    }
+    .btn-login {
+      background: #4a90e2;
+      color: white;
+    }
+    .btn-login:hover {
+      background: #357abd;
+    }
+    .btn-logout {
+      background: #e74c3c;
+      color: white;
+      display: none;
+    }
+    .btn-logout:hover {
+      background: #c0392b;
+    }
+    .status-indicator {
+      display: flex;
+      align-items: center;
+      gap: 6px;
+      font-size: 0.85rem;
+      color: #666;
+    }
+    .dot {
+      width: 8px;
+      height: 8px;
+      border-radius: 50%;
+      background: #ccc;
+    }
+    .dot.active {
+      background: #2ecc71;
+      box-shadow: 0 0 8px #2ecc71;
+    }
+    /* MQTT Topics Viewer */
+    #mqtt-modal {
+      display: none;
+      position: fixed;
+      top: 0; left: 0; width: 100%; height: 100%;
+      background: rgba(0,0,0,0.6);
+      z-index: 2000;
+      justify-content: center;
+      align-items: center;
+    }
+    .mqtt-content {
+      background: #000;
+      width: 80%; max-width: 900px;
+      border-radius: 8px;
+      padding: 20px;
+      color: #00ff00;
+      font-family: monospace;
+      position: relative;
+      box-shadow: 0 10px 25px rgba(0,0,0,0.5);
+    }
+    .mqtt-header {
+      display: flex;
+      justify-content: space-between;
+      margin-bottom: 10px;
+      border-bottom: 1px solid #333;
+      padding-bottom: 10px;
+    }
+    .mqtt-close { color: white; cursor: pointer; font-size: 1.5rem; }
+    .mqtt-dl { background: #333; color: white; border: none; padding: 5px 10px; cursor: pointer; border-radius: 4px; }
+    .mqtt-dl:hover { background: #555; }
+    .syntax-punct { color: #ff0000; }
+    /* Interactive MQTT Actions */
+    .mqtt-action-btn {
+      margin-left: 10px; padding: 2px 8px; border: none; border-radius: 4px;
+      font-size: 0.8rem; font-weight: bold; color: white; cursor: pointer;
+      vertical-align: middle;
+    }
+    #mqtt-action-modal {
+      display: none; position: fixed; top: 0; left: 0; width: 100%; height: 100%;
+      background: rgba(0,0,0,0.8); z-index: 3000; justify-content: center; align-items: center;
+    }
+    .mqtt-action-content {
+      background: #1e1e1e; width: 80%; max-width: 800px; border-radius: 8px; padding: 20px;
+      color: #fff; font-family: monospace; position: relative;
+    }
+    .mqtt-console {
+      background: #000; color: #0f0; padding: 10px; height: 300px; overflow-y: auto;
+      border-radius: 4px; margin-top: 10px; border: 1px solid #333; white-space: pre-wrap;
+    }
+    .mqtt-editor {
+      width: 100%; height: 200px; background: #000; color: #0f0; font-family: monospace;
+      padding: 10px; border: 1px solid #333; border-radius: 4px; margin-top: 10px;
+    }
+    .broker-input {
+      background: #333; color: #fff; border: 1px solid #555; padding: 5px;
+      border-radius: 4px; width: 250px; margin-left: 15px; font-family: monospace;
+    }
   </style>
 </head>
 <body>
+  <div class="top-nav">
+    <div class="nav-brand">
+      <img src="/logo.png" alt="GO-DUCK Logo" style="height: 32px; width: auto;" />
+      <div style="display: flex; flex-direction: column; line-height: 1.2;">
+        <span>{{app_name}} API Explorer</span>
+        <span style="font-size: 0.65em; font-weight: normal; color: #94a3b8;">
+          GO-DUCK v{{cli_version}} • Generated: {{generated_date}}
+        </span>
+      </div>
+    </div>
+    <div class="nav-controls">
+      <div class="status-indicator">
+        <div class="dot" id="auth-dot"></div>
+        <span id="auth-status">Unauthenticated</span>
+      </div>
+      <input type="text" id="tenant-input" class="tenant-input" placeholder="X-Tenant-ID" value="tenant_1" title="Multi-tenant DB Target" />
+      <button id="login-btn" class="btn btn-login">Login with Keycloak</button>
+      <button id="logout-btn" class="btn btn-logout">Logout</button>
+      <button id="mqtt-btn" class="btn" style="background: #2c3e50; color: white;">MQTT Topics</button>
+    </div>
+  </div>
   <div id="swagger-ui"></div>
+  <div id="mqtt-modal">
+    <div class="mqtt-content">
+      <div class="mqtt-header">
+        <h3 style="margin: 0; color: white;">MQTT Topics Dictionary (JSON5)</h3>
+        <div>
+          <button class="mqtt-dl" id="mqtt-dl-btn">Download JSON5</button>
+          <span class="mqtt-close" id="mqtt-close">&times;</span>
+        </div>
+      </div>
+      <pre id="mqtt-viewer" style="overflow-x: auto; max-height: 70vh; margin: 0;"></pre>
+    </div>
+  </div>
+  <div id="mqtt-action-modal">
+    <div class="mqtt-action-content">
+      <div style="display: flex; justify-content: space-between; border-bottom: 1px solid #333; padding-bottom: 10px;">
+        <div>
+          <h3 style="margin: 0; display: inline-block;"><span id="action-title">SUBSCRIBE</span>: <span id="action-topic" style="color: #3498db;"></span></h3>
+          <input type="text" id="broker-url" class="broker-input" value="ws://localhost:9001" title="Broker WS URL" />
+          <span id="broker-status" style="margin-left: 10px; font-size: 0.9rem; color: #f39c12;">Disconnected</span>
+        </div>
+        <span class="mqtt-close" id="mqtt-action-close">&times;</span>
+      </div>
+      <!-- Subscribe View -->
+      <div id="view-subscribe" style="display: none;">
+        <div class="mqtt-console" id="mqtt-console">Waiting for messages...\n</div>
+      </div>
+      <!-- Publish View -->
+      <div id="view-publish" style="display: none;">
+        <textarea id="mqtt-payload" class="mqtt-editor">{\n  "example": "payload"\n}</textarea>
+        <button id="mqtt-publish-btn" class="btn" style="background: #e74c3c; color: white; margin-top: 15px; width: 100%;">PUBLISH PAYLOAD</button>
+      </div>
+    </div>
+  </div>
   <script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/4.15.5/swagger-ui-bundle.js"></script>
   <script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/4.15.5/swagger-ui-standalone-preset.js"></script>
   <script>
+    const KEYCLOAK_URL = 'KEYCLOAK_URL_PLACEHOLDER';
+    const KEYCLOAK_REALM = 'KEYCLOAK_REALM_PLACEHOLDER';
+    const KEYCLOAK_CLIENT = 'KEYCLOAK_CLIENT_PLACEHOLDER';
+    let keycloak = null;
+    function updateUI(authenticated) {
+      if (authenticated) {
+        document.getElementById('login-btn').style.display = 'none';
+        document.getElementById('logout-btn').style.display = 'block';
+        document.getElementById('auth-dot').classList.add('active');
+        document.getElementById('auth-status').innerText = 'Authenticated (' + (keycloak.tokenParsed?.preferred_username || 'User') + ')';
+      } else {
+        document.getElementById('login-btn').style.display = 'block';
+        document.getElementById('logout-btn').style.display = 'none';
+        document.getElementById('auth-dot').classList.remove('active');
+        document.getElementById('auth-status').innerText = 'Unauthenticated';
+      }
+    }
     window.onload = function() {
-      const ui = SwaggerUIBundle({
-        url: "/swagger.json",
-        dom_id: '#swagger-ui',
-        deepLinking: true,
-        presets: [
-          SwaggerUIBundle.presets.apis,
-          SwaggerUIStandalonePreset
-        ],
-        layout: "StandaloneLayout"
+      // Initialize Keycloak
+      keycloak = new Keycloak({
+        url: KEYCLOAK_URL,
+        realm: KEYCLOAK_REALM,
+        clientId: KEYCLOAK_CLIENT
+      });
+      keycloak.init({ onLoad: 'check-sso', checkLoginIframe: false }).then(authenticated => {
+        updateUI(authenticated);
+        document.getElementById('login-btn').onclick = () => keycloak.login();
+        document.getElementById('logout-btn').onclick = () => keycloak.logout();
+        if (authenticated) {
+          // Auto-refresh token logic
+          setInterval(() => {
+            keycloak.updateToken(70).then(refreshed => {
+              if (refreshed) {
+                console.log('Token refreshed automatically');
+              }
+            }).catch(() => {
+              console.error('Failed to refresh token');
+              updateUI(false);
+            });
+          }, 60000); // Check every minute
+        }
+        // 4. Initialize Swagger UI
+        const ui = SwaggerUIBundle({
+          url: "/v3/api-docs",
+          dom_id: '#swagger-ui',
+          deepLinking: true,
+          presets: [
+            SwaggerUIBundle.presets.apis,
+            SwaggerUIStandalonePreset
+          ],
+          layout: "StandaloneLayout",
+          requestInterceptor: (req) => {
+            if (keycloak && keycloak.token) {
+              req.headers['Authorization'] = 'Bearer ' + keycloak.token;
+            }
+            const tenantId = document.getElementById('tenant-input').value;
+            if (tenantId) {
+              req.headers['X-Tenant-ID'] = tenantId;
+            }
+            return req;
+          }
+        });
+      }).catch(err => {
+        console.error("Keycloak initialization failed", err);
+        document.getElementById('auth-status').innerText = 'Keycloak init failed';
+        // Still load swagger without auth interceptor
+        window.ui = SwaggerUIBundle({
+          url: "/v3/api-docs",
+          dom_id: '#swagger-ui',
+          deepLinking: true,
+          presets: [
+            SwaggerUIBundle.presets.apis,
+            SwaggerUIStandalonePreset
+          ],
+          layout: "StandaloneLayout"
+        });
       });
-      window.ui = ui;
+      // MQTT Viewer Logic
+      const mqttModal = document.getElementById('mqtt-modal');
+      const actionModal = document.getElementById('mqtt-action-modal');
+      const actionTitle = document.getElementById('action-title');
+      const actionTopic = document.getElementById('action-topic');
+      const viewSub = document.getElementById('view-subscribe');
+      const viewPub = document.getElementById('view-publish');
+      const brokerInput = document.getElementById('broker-url');
+      const brokerStatus = document.getElementById('broker-status');
+      const mqttConsole = document.getElementById('mqtt-console');
+      const payloadEditor = document.getElementById('mqtt-payload');
+      let rawJson5 = '';
+      let mqttClient = null;
+      let currentTopic = '';
+      // Open Action Modal Logic (Global so inline onClick can call it)
+      window.openMqttAction = function(topic, action) {
+        currentTopic = topic;
+        actionTitle.innerText = action;
+        actionTopic.innerText = topic;
+        if (action === 'SEND') {
+          viewSub.style.display = 'none';
+          viewPub.style.display = 'block';
+        } else {
+          viewSub.style.display = 'block';
+          viewPub.style.display = 'none';
+          mqttConsole.innerHTML = `Waiting for messages on ${topic}...\\n`;
+        }
+        actionModal.style.display = 'flex';
+        connectMqtt();
+      };
+      function connectMqtt() {
+        if (mqttClient) {
+          if (mqttClient.options.href === brokerInput.value && mqttClient.connected) {
+             // Already connected to this broker, just subscribe if needed
+             if (actionTitle.innerText === 'SUBSCRIBE') mqttClient.subscribe(currentTopic);
+             return;
+          }
+          mqttClient.end();
+        }
+        brokerStatus.innerText = "Connecting...";
+        brokerStatus.style.color = "#f39c12";
+        try {
+          mqttClient = mqtt.connect(brokerInput.value);
+        } catch(e) {
+          brokerStatus.innerText = "Error: " + e.message;
+          brokerStatus.style.color = "#e74c3c";
+          return;
+        }
+        mqttClient.on('connect', () => {
+          brokerStatus.innerText = "Connected";
+          brokerStatus.style.color = "#2ecc71";
+          if (actionTitle.innerText === 'SUBSCRIBE') {
+            mqttClient.subscribe(currentTopic, (err) => {
+              if(!err) mqttConsole.innerHTML += `Subscribed to ${currentTopic}\\n`;
+            });
+          }
+        });
+        mqttClient.on('message', (topic, message) => {
+          if (topic === currentTopic) {
+            const time = new Date().toLocaleTimeString();
+            let msgStr = message.toString();
+            try { msgStr = JSON.stringify(JSON.parse(msgStr), null, 2); } catch(e){}
+            mqttConsole.innerHTML += `\\n<span style="color:#888">[${time}]</span>\\n${msgStr}\\n`;
+            mqttConsole.scrollTop = mqttConsole.scrollHeight;
+          }
+        });
+        mqttClient.on('error', (err) => {
+          brokerStatus.innerText = "Error";
+          brokerStatus.style.color = "#e74c3c";
+          console.error("MQTT Error:", err);
+        });
+      }
+      brokerInput.addEventListener('change', connectMqtt);
+      document.getElementById('mqtt-publish-btn').onclick = () => {
+        if (!mqttClient || !mqttClient.connected) {
+          alert("Broker not connected!");
+          return;
+        }
+        const payload = payloadEditor.value;
+        mqttClient.publish(currentTopic, payload, {}, (err) => {
+          if (err) {
+            alert("Failed to publish: " + err);
+          } else {
+            alert("Message published to " + currentTopic);
+            actionModal.style.display = 'none';
+          }
+        });
+      };
+      document.getElementById('mqtt-action-close').onclick = () => {
+        if (mqttClient && actionTitle.innerText === 'SUBSCRIBE') {
+          mqttClient.unsubscribe(currentTopic);
+        }
+        actionModal.style.display = 'none';
+      };
+      document.getElementById('mqtt-btn').onclick = () => {
+        fetch('/api/mqtt-topics')
+          .then(res => {
+            if (!res.ok) throw new Error("Status " + res.status);
+            return res.text();
+          })
+          .then(text => {
+            rawJson5 = text;
+            let highlighted = text
+              .replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;")
+              .replace(/([{}[\]:,])/g, '<span class="syntax-punct">$1</span>');
+            // Inject buttons next to topics (Only if authenticated)
+            highlighted = highlighted.replace(/"([^"]+)"(<span class="syntax-punct">.*?<\\/span>)/g, (match, topic, punct) => {
+              if (topic.includes('/')) {
+                let btnHtml = "";
+                if (keycloak && keycloak.authenticated) {
+                  const isSend = /patch|put|post|create|update/i.test(topic);
+                  const btnLabel = isSend ? "SEND" : "SUBSCRIBE";
+                  const btnColor = isSend ? "#e74c3c" : "#3498db";
+                  btnHtml = ` <button class="mqtt-action-btn" style="background:${btnColor}" onclick="openMqttAction('${topic}', '${btnLabel}')">${btnLabel}</button>`;
+                }
+                return `"${topic}"${punct}${btnHtml}`;
+              }
+              return match;
+            });
+            document.getElementById('mqtt-viewer').innerHTML = highlighted;
+            mqttModal.style.display = 'flex';
+          }).catch(err => alert('Failed to fetch MQTT topics: ' + err));
+      };
+      document.getElementById('mqtt-close').onclick = () => mqttModal.style.display = 'none';
+      document.getElementById('mqtt-dl-btn').onclick = () => {
+        const blob = new Blob([rawJson5], { type: 'application/json5' });
+        const url = URL.createObjectURL(blob);
+        const a = document.createElement('a');
+        a.href = url;
+        a.download = 'mqtt_topics.json5';
+        document.body.appendChild(a);
+        a.click();
+        document.body.removeChild(a);
+        URL.revokeObjectURL(url);
+      };
     };
   </script>
 </body>
-</html>`))
+</html>`
+        htmlStr := strings.ReplaceAll(swaggerHTML, "KEYCLOAK_URL_PLACEHOLDER", appConfig.GoDuck.Security.KeycloakHost)
+        htmlStr = strings.ReplaceAll(htmlStr, "KEYCLOAK_REALM_PLACEHOLDER", appConfig.GoDuck.Security.KeycloakRealm)
+        htmlStr = strings.ReplaceAll(htmlStr, "KEYCLOAK_CLIENT_PLACEHOLDER", appConfig.GoDuck.Security.KeycloakAppClientID)
+        c.Data(http.StatusOK, "text/html; charset=utf-8", []byte(htmlStr))
     })
     // Management APIs (Run-time DB onboarding)