@hedystia/swagger 1.2.3 → 1.2.5

package/dist/index.d.ts

@@ -0,0 +1,55 @@
+import { Hedystia } from 'hedystia';
+import { OpenAPI } from 'openapi-types';
+
+interface SwaggerOptions {
+    title?: string;
+    description?: string;
+    version?: string;
+    basePath?: string;
+    schemes?: string[];
+    consumes?: string[];
+    produces?: string[];
+    tags?: {
+        name: string;
+        description?: string;
+    }[];
+    securityDefinitions?: Record<string, any>;
+    externalDocs?: {
+        description: string;
+        url: string;
+    };
+    host?: string;
+}
+declare class Swagger {
+    private spec;
+    constructor(options?: SwaggerOptions);
+    addRoute(method: string, path: string, schema: any, summary?: string, description?: string, tags?: string[]): void;
+    private buildParameters;
+    private buildRequestBody;
+    private buildResponses;
+    validate(): Promise<boolean>;
+    getSpec(): OpenAPI.Document<{}>;
+    generateHTML(): string;
+}
+
+declare function swagger(options?: SwaggerOptions): {
+    plugin: Hedystia<[{
+        method: "GET";
+        path: "/";
+        params: any;
+        query: any;
+        headers: any;
+        response: any;
+    }, {
+        method: "GET";
+        path: "/json";
+        params: any;
+        query: any;
+        headers: any;
+        response: any;
+    }], {}>;
+    swagger: Swagger;
+    captureRoutes: (app: any) => void;
+};
+
+export { swagger };

package/dist/index.js

@@ -0,0 +1,204 @@
+"use strict";var h=Object.create;var a=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var y=Object.getOwnPropertyNames;var b=Object.getPrototypeOf,w=Object.prototype.hasOwnProperty;var x=(i,e)=>{for(var s in e)a(i,s,{get:e[s],enumerable:!0})},g=(i,e,s,t)=>{if(e&&typeof e=="object"||typeof e=="function")for(let r of y(e))!w.call(i,r)&&r!==s&&a(i,r,{get:()=>e[r],enumerable:!(t=f(e,r))||t.enumerable});return i};var v=(i,e,s)=>(s=i!=null?h(b(i)):{},g(e||!i||!i.__esModule?a(s,"default",{value:i,enumerable:!0}):s,i)),S=i=>g(a({},"__esModule",{value:!0}),i);var j={};x(j,{swagger:()=>k});module.exports=S(j);var u=require("hedystia");var l=v(require("@apidevtools/swagger-parser")),o=class{spec={openapi:"3.0.0",info:{title:"API Documentation",version:"1.0.0"},paths:{},components:{schemas:{}}};constructor(e={}){this.spec.info.title=e.title||"API Documentation",this.spec.info.description=e.description,this.spec.info.version=e.version||"1.0.0",e.tags&&(this.spec.tags=e.tags),e.externalDocs&&(this.spec.externalDocs=e.externalDocs),e.securityDefinitions&&(this.spec.components=this.spec.components||{},this.spec.components.securitySchemes=e.securityDefinitions)}addRoute(e,s,t,r,n,d){if(!t)return;let c=s.replace(/:([^/]+)/g,"{$1}");this.spec.paths||(this.spec.paths={}),this.spec.paths[c]||(this.spec.paths[c]={});let m=e.toLowerCase(),p={summary:r||`${e} ${s}`,parameters:this.buildParameters(t),requestBody:this.buildRequestBody(t),responses:this.buildResponses(t)};n&&(p.description=n),d&&(p.tags=d),this.spec.paths[c][m]=p}buildParameters(e){let s=[];if(e.params)try{let t=e.params;t.properties&&Object.entries(t.properties).forEach(([r,n])=>{s.push({name:r,in:"path",required:t.required?.includes(r)??!0,schema:n})})}catch(t){console.error("Failed to convert params schema:",t)}if(e.query)try{let t=e.query;t.properties&&Object.entries(t.properties).forEach(([r,n])=>{s.push({name:r,in:"query",required:t.required?.includes(r)??!1,schema:n})})}catch(t){console.error("Failed to convert query schema:",t)}return s.length>0?s:void 0}buildRequestBody(e){if(e.body)try{return{required:!0,content:{"application/json":{schema:e.body}}}}catch(s){console.error("Failed to convert body schema:",s);return}}buildResponses(e){let s={200:{description:"Successful response"}};if(e.response)try{let t=e.response;s[200].content={"application/json":{schema:t}}}catch(t){console.error("Failed to convert response schema:",t)}return s}async validate(){try{return await l.default.validate(this.spec),!0}catch(e){return console.error("Swagger validation error:",e),!1}}getSpec(){return this.spec}generateHTML(){return`
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1.0">
+  <title>${this.spec.info.title}</title>
+  <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.9.0/swagger-ui.css">
+  <style>
+    :root {
+      --primary-color: #3b82f6;
+      --primary-dark: #1d4ed8;
+      --secondary-color: #64748b;
+      --background-color: #f8fafc;
+      --card-background: #ffffff;
+      --text-color: #1e293b;
+      --border-color: #e2e8f0;
+    }
+
+    body {
+      font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, Oxygen, Ubuntu, Cantarell, 'Open Sans', 'Helvetica Neue', sans-serif;
+      margin: 0;
+      padding: 0;
+      background-color: var(--background-color);
+      color: var(--text-color);
+    }
+
+    .header {
+      background: linear-gradient(135deg, var(--primary-color), var(--primary-dark));
+      color: white;
+      padding: 2rem;
+      box-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px rgba(0, 0, 0, 0.06);
+    }
+
+    .container {
+      width: 100%;
+      max-width: 1200px;
+      margin: 0 auto;
+      padding: 0 1rem;
+    }
+
+    .header-content {
+      max-width: 1200px;
+      margin: 0 auto;
+    }
+
+    .title {
+      font-size: 2.25rem;
+      font-weight: 700;
+      margin: 0;
+      line-height: 1.2;
+    }
+
+    .description {
+      margin-top: 0.75rem;
+      font-size: 1.125rem;
+      opacity: 0.9;
+    }
+
+    .version {
+      display: inline-block;
+      background-color: rgba(255, 255, 255, 0.2);
+      padding: 0.25rem 0.75rem;
+      border-radius: 9999px;
+      font-size: 0.875rem;
+      margin-top: 0.75rem;
+    }
+
+    .main {
+      padding: 2rem 0;
+    }
+
+    .swagger-container {
+      background-color: var(--card-background);
+      border-radius: 0.5rem;
+      box-shadow: 0 4px 6px -1px rgba(0, 0, 0, 0.1), 0 2px 4px -1px rgba(0, 0, 0, 0.06);
+      padding: 1rem;
+      margin-bottom: 2rem;
+    }
+
+    .swagger-ui .topbar {
+      display: none;
+    }
+
+    .swagger-ui .info {
+      margin: 20px 0;
+    }
+
+    .swagger-ui .opblock-tag {
+      font-size: 1.25rem;
+      border-bottom: 1px solid var(--border-color);
+      padding: 10px 0;
+    }
+
+    .swagger-ui .opblock {
+      border-radius: 8px;
+      box-shadow: 0 1px 3px rgba(0, 0, 0, 0.1);
+      margin: 0 0 15px;
+    }
+
+    .swagger-ui .opblock .opblock-summary {
+      padding: 8px 20px;
+    }
+
+    .swagger-ui .btn {
+      border-radius: 4px;
+    }
+
+    .footer {
+      background-color: #1e293b;
+      color: white;
+      padding: 1.5rem 0;
+      text-align: center;
+      margin-top: 2rem;
+    }
+
+    .footer-content {
+      font-size: 0.875rem;
+      opacity: 0.8;
+    }
+
+    .footer-link {
+      color: white;
+      text-decoration: underline;
+      margin: 0 0.5rem;
+    }
+
+    /* Responsive adjustments */
+    @media (max-width: 768px) {
+      .header {
+        padding: 1.5rem 1rem;
+      }
+
+      .title {
+        font-size: 1.75rem;
+      }
+
+      .swagger-ui .wrapper {
+        padding: 0;
+      }
+
+      .swagger-ui .opblock .opblock-summary {
+        padding: 8px 10px;
+      }
+    }
+  </style>
+</head>
+<body>
+  <header class="header">
+    <div class="header-content">
+      <h1 class="title">${this.spec.info.title}</h1>
+      ${this.spec.info.description?`<p class="description">${this.spec.info.description}</p>`:""}
+      <span class="version">Version ${this.spec.info.version}</span>
+    </div>
+  </header>
+
+  <main class="main">
+    <div class="container">
+      <div class="swagger-container">
+        <div id="swagger-ui"></div>
+      </div>
+    </div>
+  </main>
+
+  <footer class="footer">
+    <div class="container">
+      <div class="footer-content">
+        <p>Powered by Hedystia</p>
+        <div>
+          <a href="https://github.com/Hedystia/Framework" class="footer-link" target="_blank">GitHub</a>
+          <a href="/swagger/json" class="footer-link" target="_blank">Raw JSON</a>
+        </div>
+      </div>
+    </div>
+  </footer>
+
+  <script src="https://cdn.jsdelivr.net/npm/swagger-ui-dist@5.9.0/swagger-ui-bundle.js"></script>
+  <script>
+    window.onload = function() {
+      const ui = SwaggerUIBundle({
+        spec: ${JSON.stringify(this.spec)},
+        dom_id: '#swagger-ui',
+        deepLinking: true,
+        presets: [
+          SwaggerUIBundle.presets.apis,
+          SwaggerUIBundle.SwaggerUIStandalonePreset
+        ],
+        layout: "BaseLayout",
+        docExpansion: "list",
+        defaultModelsExpandDepth: 1,
+        defaultModelExpandDepth: 1,
+        syntaxHighlight: {
+          activated: true,
+          theme: "agate"
+        },
+        filter: true,
+        withCredentials: true,
+        persistAuthorization: true
+      });
+    };
+  </script>
+</body>
+</html>
+  `}};function k(i={}){let e=new o(i);return{plugin:new u.Hedystia().get("/",()=>new Response(e.generateHTML(),{headers:{"Content-Type":"text/html"}})).get("/json",()=>Response.json(e.getSpec())),swagger:e,captureRoutes:t=>{if(t&&t.routes)for(let r of t.routes){let n={params:r.schema.params?r.schema.params.jsonSchema:void 0,query:r.schema.query?r.schema.query.jsonSchema:void 0,body:r.schema.body?r.schema.body.jsonSchema:void 0,response:r.schema.response?r.schema.response.jsonSchema:void 0};e.addRoute(r.method,r.path,n,r.schema.description||`${r.method} ${r.path}`,r.schema.description,r.schema.tags)}}}}0&&(module.exports={swagger});

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@hedystia/swagger",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "devDependencies": {
     "@types/bun": "latest",
     "tsup": "^8.3.5"
   },
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.1",
-    "hedystia": "^1.2.3",
+    "hedystia": "^1.2.5",
     "openapi-types": "^12.1.3"
   },
   "peerDependencies": {
@@ -47,5 +47,6 @@
   },
   "type": "commonjs",
   "types": "./dist/index.d.ts",
-  "main": "./dist/index.js"
+  "main": "./dist/index.js",
+  "module": "./dist/index.js"
 }

package/readme.md

@@ -131,10 +131,9 @@ app.use("/swagger", swaggerPlugin.plugin).listen(3000);
 - ✅ Router Groups & Middleware
 - ✅ Type-safe Client Generation
 - ✅ WebSocket Support
-- ✅ Standard Schema Compatibility
 
 ### Advanced Capabilities
-- ✅ Zod Validation - Changed to native validation plugin
+- ✅ Standard Schema Compatibility
 - ✅ Hooks System (onRequest, onError, etc)
 - ✅ Macro System for Auth/Rate Limiting
 - ✅ OpenAPI - Swagger Integration