@forinda/kickjs-swagger 1.6.0 → 1.7.0

package/dist/index.js

@@ -7,8 +7,8 @@ var H = {
     return e != null && typeof e == "object" && typeof e.safeParse == "function" && typeof e.toJSONSchema == "function";
   },
   toJsonSchema(e) {
-    const { $schema: r, ...t } = e.toJSONSchema();
-    return t;
+    const { $schema: t, ...a } = e.toJSONSchema();
+    return a;
   }
 }, i = {
   OPERATION: /* @__PURE__ */ Symbol("kick:swagger:operation"),
@@ -18,58 +18,58 @@ var H = {
   EXCLUDE: /* @__PURE__ */ Symbol("kick:swagger:exclude")
 };
 function Z(e) {
-  return (r, t) => {
-    Reflect.defineMetadata(i.OPERATION, e, r.constructor, t);
+  return (t, a) => {
+    Reflect.defineMetadata(i.OPERATION, e, t.constructor, a);
   };
 }
 function Q(e) {
-  return (r, t) => {
-    const d = Reflect.getMetadata(i.RESPONSES, r.constructor, t) || [];
-    Reflect.defineMetadata(i.RESPONSES, [...d, e], r.constructor, t);
+  return (t, a) => {
+    const p = Reflect.getMetadata(i.RESPONSES, t.constructor, a) || [];
+    Reflect.defineMetadata(i.RESPONSES, [...p, e], t.constructor, a);
   };
 }
 function V(...e) {
-  return (r, t) => {
-    t ? Reflect.defineMetadata(i.TAGS, e, r.constructor, t) : Reflect.defineMetadata(i.TAGS, e, r);
+  return (t, a) => {
+    a ? Reflect.defineMetadata(i.TAGS, e, t.constructor, a) : Reflect.defineMetadata(i.TAGS, e, t);
   };
 }
 function K(e = "BearerAuth") {
-  return (r, t) => {
-    t ? Reflect.defineMetadata(i.BEARER_AUTH, e, r.constructor, t) : Reflect.defineMetadata(i.BEARER_AUTH, e, r);
+  return (t, a) => {
+    a ? Reflect.defineMetadata(i.BEARER_AUTH, e, t.constructor, a) : Reflect.defineMetadata(i.BEARER_AUTH, e, t);
   };
 }
 function ee() {
-  return (e, r) => {
-    r ? Reflect.defineMetadata(i.EXCLUDE, !0, e.constructor, r) : Reflect.defineMetadata(i.EXCLUDE, !0, e);
+  return (e, t) => {
+    t ? Reflect.defineMetadata(i.EXCLUDE, !0, e.constructor, t) : Reflect.defineMetadata(i.EXCLUDE, !0, e);
   };
 }
 var M = [];
-function F(e, r) {
+function F(e, t) {
   M.push({
     controllerClass: e,
-    mountPath: r
+    mountPath: t
   });
 }
 function x() {
   M.length = 0;
 }
 function J(e = {}) {
-  const r = e.schemaParser ?? H, t = (o) => {
+  const t = e.schemaParser ?? H, a = (o) => {
     try {
-      return r.supports(o) ? r.toJsonSchema(o) : null;
+      return t.supports(o) ? t.toJsonSchema(o) : null;
     } catch {
       return null;
     }
-  }, d = {};
-  let u = 0;
-  const p = (o, w) => {
-    let f = o.title || o.label || w || "";
-    if (f || (f = `Schema${++u}`), f = f.replace(/[^a-zA-Z0-9]/g, ""), !d[f]) {
-      const R = { ...o };
-      delete R.title, delete R.label, delete R.$schema, d[f] = R;
+  }, p = {};
+  let d = 0;
+  const m = (o, w) => {
+    let u = o.title || o.label || w || "";
+    if (u || (u = `Schema${++d}`), u = u.replace(/[^a-zA-Z0-9]/g, ""), !p[u]) {
+      const A = { ...o };
+      delete A.title, delete A.label, delete A.$schema, p[u] = A;
     }
-    return { $ref: `#/components/schemas/${f}` };
-  }, a = {
+    return { $ref: `#/components/schemas/${u}` };
+  }, r = {
     openapi: "3.0.3",
     info: {
       title: e.info?.title || "API",
@@ -83,81 +83,81 @@ function J(e = {}) {
     },
     tags: []
   };
-  e.servers && (a.servers = e.servers);
-  const m = /* @__PURE__ */ new Set(), g = {};
+  e.servers && (r.servers = e.servers);
+  const S = /* @__PURE__ */ new Set(), E = {};
   for (const { controllerClass: o, mountPath: w } of M) {
     if (Reflect.getMetadata(i.EXCLUDE, o)) continue;
-    const f = Reflect.getMetadata(T.ROUTES, o) || [], R = Reflect.getMetadata(i.TAGS, o) || [], I = Reflect.getMetadata(i.BEARER_AUTH, o);
-    for (const n of f) {
+    const u = Reflect.getMetadata(T.ROUTES, o) || [], A = Reflect.getMetadata(i.TAGS, o) || [], I = Reflect.getMetadata(i.BEARER_AUTH, o);
+    for (const n of u) {
       if (Reflect.getMetadata(i.EXCLUDE, o, n.handlerName)) continue;
-      const $ = C(w, n.path), P = $.replace(/:([a-zA-Z_]+)/g, "{$1}"), b = n.method.toLowerCase(), y = Reflect.getMetadata(i.OPERATION, o, n.handlerName) || {}, N = Reflect.getMetadata(i.RESPONSES, o, n.handlerName) || [], k = Reflect.getMetadata(i.TAGS, o, n.handlerName) || [], _ = Reflect.getMetadata(i.BEARER_AUTH, o, n.handlerName), v = k.length > 0 ? k : R;
-      v.forEach((s) => m.add(s));
+      const $ = C(w, n.path), P = $.replace(/:([a-zA-Z_]+)/g, "{$1}"), R = n.method.toLowerCase(), h = Reflect.getMetadata(i.OPERATION, o, n.handlerName) || {}, N = Reflect.getMetadata(i.RESPONSES, o, n.handlerName) || [], k = Reflect.getMetadata(i.TAGS, o, n.handlerName) || [], B = Reflect.getMetadata(i.BEARER_AUTH, o, n.handlerName), v = k.length > 0 ? k : A;
+      v.forEach((s) => S.add(s));
       const c = {
         ...v.length > 0 ? { tags: v } : {},
-        ...y.summary ? { summary: y.summary } : {},
-        ...y.description ? { description: y.description } : {},
-        ...y.operationId ? { operationId: y.operationId } : {},
-        ...y.deprecated ? { deprecated: !0 } : {},
+        ...h.summary ? { summary: h.summary } : {},
+        ...h.description ? { description: h.description } : {},
+        ...h.operationId ? { operationId: h.operationId } : {},
+        ...h.deprecated ? { deprecated: !0 } : {},
         parameters: [],
         responses: {}
-      }, B = $.match(/:([a-zA-Z_]+)/g) || [];
-      for (const s of B) {
+      }, _ = $.match(/:([a-zA-Z_]+)/g) || [];
+      for (const s of _) {
         const l = s.slice(1);
-        let A = { type: "string" };
+        let y = { type: "string" };
         if (n.validation?.params) {
-          const h = t(n.validation.params);
-          if (h?.properties && typeof h.properties == "object") {
-            const U = h.properties;
-            U[l] && (A = U[l]);
+          const f = a(n.validation.params);
+          if (f?.properties && typeof f.properties == "object") {
+            const U = f.properties;
+            U[l] && (y = U[l]);
           }
         }
         c.parameters.push({
           name: l,
           in: "path",
           required: !0,
-          schema: A
+          schema: y
         });
       }
       if (n.validation?.query) {
-        const s = t(n.validation.query);
+        const s = a(n.validation.query);
         if (s?.properties && typeof s.properties == "object") {
           const l = Array.isArray(s.required) ? s.required : [];
-          for (const [A, h] of Object.entries(s.properties)) c.parameters.push({
-            name: A,
+          for (const [y, f] of Object.entries(s.properties)) c.parameters.push({
+            name: y,
             in: "query",
-            required: l.includes(A),
-            schema: h
+            required: l.includes(y),
+            schema: f
           });
         }
       }
-      const S = Reflect.getMetadata(T.QUERY_PARAMS, o, n.handlerName);
-      if (S && (S.filterable?.length && c.parameters.push({
+      const g = Reflect.getMetadata(T.QUERY_PARAMS, o, n.handlerName);
+      if (g && (g.filterable?.length && c.parameters.push({
         name: "filter",
         in: "query",
         required: !1,
-        description: `Filter fields: ${S.filterable.join(", ")}. Format: \`field:operator:value\`. Operators: eq, neq, gt, gte, lt, lte, contains, starts, ends, in, between`,
+        description: `Filter fields: ${g.filterable.join(", ")}. Format: \`field:operator:value\`. Operators: eq, neq, gt, gte, lt, lte, contains, starts, ends, in, between`,
         schema: {
           type: "array",
           items: { type: "string" }
         },
         style: "form",
         explode: !0
-      }), S.sortable?.length && c.parameters.push({
+      }), g.sortable?.length && c.parameters.push({
         name: "sort",
         in: "query",
         required: !1,
-        description: `Sort fields: ${S.sortable.join(", ")}. Format: \`field:asc\` or \`field:desc\``,
+        description: `Sort fields: ${g.sortable.join(", ")}. Format: \`field:asc\` or \`field:desc\``,
         schema: {
           type: "array",
           items: { type: "string" }
         },
         style: "form",
         explode: !0
-      }), S.searchable?.length && c.parameters.push({
+      }), g.searchable?.length && c.parameters.push({
         name: "q",
         in: "query",
         required: !1,
-        description: `Search across: ${S.searchable.join(", ")}`,
+        description: `Search across: ${g.searchable.join(", ")}`,
         schema: { type: "string" }
       }), c.parameters.push({
         name: "page",
@@ -184,26 +184,26 @@ function J(e = {}) {
         "post",
         "put",
         "patch"
-      ].includes(b)) {
-        const s = t(n.validation.body);
+      ].includes(R)) {
+        const s = a(n.validation.body);
         if (s) {
-          const l = p(s, n.validation.name || `${n.handlerName}Body`);
+          const l = m(s, n.validation.name || `${n.handlerName}Body`);
           c.requestBody = {
             required: !0,
             content: { "application/json": { schema: l } }
           };
         }
       }
-      const E = Reflect.getMetadata(T.FILE_UPLOAD, o, n.handlerName);
-      if (E) {
-        const s = E.fieldName ?? "file", l = {};
-        E.mode === "array" ? l[s] = {
+      const b = Reflect.getMetadata(T.FILE_UPLOAD, o, n.handlerName);
+      if (b) {
+        const s = b.fieldName ?? "file", l = {};
+        b.mode === "array" ? l[s] = {
           type: "array",
           items: {
             type: "string",
             format: "binary"
           }
-        } : E.mode !== "none" && (l[s] = {
+        } : b.mode !== "none" && (l[s] = {
           type: "string",
           format: "binary"
         }), c.requestBody = {
@@ -217,38 +217,38 @@ function J(e = {}) {
       if (N.length > 0) for (const s of N) c.responses[String(s.status)] = {
         description: s.description || "",
         ...s.schema ? (() => {
-          const l = typeof s.schema == "function" || typeof s.schema == "object" ? t(s.schema) : null, A = s.name || `${n.handlerName}Response${s.status}`, h = l ? p(l, A) : typeof s.schema == "object" ? s.schema : void 0;
-          return h ? { content: { "application/json": { schema: h } } } : {};
+          const l = typeof s.schema == "function" || typeof s.schema == "object" ? a(s.schema) : null, y = s.name || `${n.handlerName}Response${s.status}`, f = l ? m(l, y) : typeof s.schema == "object" ? s.schema : void 0;
+          return f ? { content: { "application/json": { schema: f } } } : {};
         })() : {}
       };
       else {
-        const s = b === "post" ? "201" : b === "delete" ? "204" : "200";
+        const s = R === "post" ? "201" : R === "delete" ? "204" : "200";
         c.responses[s] = { description: "Successful operation" }, n.validation?.body && (c.responses[422] = { description: "Validation error" });
       }
-      const q = _ || I;
-      q && (c.security = [{ [q]: [] }], g[q] = {
+      const q = B || I;
+      q && (c.security = [{ [q]: [] }], E[q] = {
         type: "http",
         scheme: "bearer",
         bearerFormat: "JWT"
-      }), a.paths[P] || (a.paths[P] = {}), a.paths[P][b] = c;
+      }), r.paths[P] || (r.paths[P] = {}), r.paths[P][R] = c;
     }
   }
-  return a.tags = Array.from(m).map((o) => ({ name: o })), a.components.securitySchemes = g, e.bearerAuth && (g.BearerAuth || (a.components.securitySchemes.BearerAuth = {
+  return r.tags = Array.from(S).map((o) => ({ name: o })), r.components.securitySchemes = E, e.bearerAuth && (E.BearerAuth || (r.components.securitySchemes.BearerAuth = {
     type: "http",
     scheme: "bearer",
     bearerFormat: "JWT"
-  }), a.security = [{ BearerAuth: [] }]), a.components.schemas = d, Object.keys(a.components.schemas).length === 0 && delete a.components.schemas, Object.keys(a.components.securitySchemes).length === 0 && delete a.components.securitySchemes, Object.keys(a.components).length === 0 && delete a.components, a;
+  }), r.security = [{ BearerAuth: [] }]), r.components.schemas = p, Object.keys(r.components.schemas).length === 0 && delete r.components.schemas, Object.keys(r.components.securitySchemes).length === 0 && delete r.components.securitySchemes, Object.keys(r.components).length === 0 && delete r.components, r;
 }
 function j(e) {
   return e.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;").replace(/'/g, "&#39;");
 }
-function G(e, r = "API Docs") {
+function G(e, t = "API Docs") {
   return `<!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>${j(r)}</title>
+  <title>${j(t)}</title>
   <link rel="stylesheet" href="https://unpkg.com/swagger-ui-dist@5/swagger-ui.css">
 </head>
 <body>
@@ -268,13 +268,13 @@ function G(e, r = "API Docs") {
 </body>
 </html>`;
 }
-function z(e, r = "API Docs") {
+function z(e, t = "API Docs") {
   return `<!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="UTF-8">
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
-  <title>${j(r)}</title>
+  <title>${j(t)}</title>
 </head>
 <body>
   <redoc spec-url="${j(e)}"></redoc>
@@ -287,46 +287,46 @@ var O = D.for("SwaggerAdapter"), te = class {
   constructor(e = {}) {
     this.options = e;
   }
-  afterStart(e, r) {
+  afterStart({ server: e }) {
     const t = e?.address?.();
     if (!t || typeof t != "object") return;
-    const d = t.address === "::" || t.address === "0.0.0.0" ? "localhost" : t.address;
+    const a = t.address === "::" || t.address === "0.0.0.0" ? "localhost" : t.address;
     (!this.options.servers || this.options.servers.length === 0) && (this.options.servers = [{
-      url: `http://${d}:${t.port}`,
+      url: `http://${a}:${t.port}`,
       description: "HTTP server"
     }]);
-    const u = this.options.adapters?.find((p) => p.name === "WsAdapter" && typeof p.getStats == "function");
-    if (u) {
-      const p = u.getStats();
-      for (const a of Object.keys(p.namespaces || {})) this.options.servers.push({
-        url: `ws://${d}:${t.port}${a}`,
-        description: `WebSocket: ${a}`
+    const p = this.options.adapters?.find((d) => d.name === "WsAdapter" && typeof d.getStats == "function");
+    if (p) {
+      const d = p.getStats();
+      for (const m of Object.keys(d.namespaces || {})) this.options.servers.push({
+        url: `ws://${a}:${t.port}${m}`,
+        description: `WebSocket: ${m}`
       });
     }
   }
-  onRouteMount(e, r) {
-    F(e, r);
+  onRouteMount(e, t) {
+    F(e, t);
   }
-  beforeMount(e, r) {
+  beforeMount({ app: e }) {
     x();
-    const t = this.options.docsPath ?? "/docs", d = this.options.redocPath ?? "/redoc", u = this.options.specPath ?? "/openapi.json", p = L();
-    p.use((a, m, g) => {
-      m.setHeader("Content-Security-Policy", [
+    const t = this.options.docsPath ?? "/docs", a = this.options.redocPath ?? "/redoc", p = this.options.specPath ?? "/openapi.json", d = L();
+    d.use((m, r, S) => {
+      r.setHeader("Content-Security-Policy", [
         "default-src 'self'",
         "script-src 'self' 'unsafe-inline' https://unpkg.com https://cdn.redoc.ly https://cdn.jsdelivr.net",
         "style-src 'self' 'unsafe-inline' https://unpkg.com https://fonts.googleapis.com",
         "font-src 'self' https://fonts.gstatic.com",
         "img-src 'self' data: https://unpkg.com",
         "connect-src 'self'"
-      ].join("; ")), g();
-    }), p.get(u, (a, m) => {
-      const g = J(this.options);
-      m.json(g);
-    }), p.get(t, (a, m) => {
-      m.type("html").send(G(u, this.options.info?.title));
-    }), p.get(d, (a, m) => {
-      m.type("html").send(z(u, this.options.info?.title));
-    }), e.use(p), O.info(`Swagger UI:  ${t}`), O.info(`ReDoc:       ${d}`), O.info(`OpenAPI spec: ${u}`);
+      ].join("; ")), S();
+    }), d.get(p, (m, r) => {
+      const S = J(this.options);
+      r.json(S);
+    }), d.get(t, (m, r) => {
+      r.type("html").send(G(p, this.options.info?.title));
+    }), d.get(a, (m, r) => {
+      r.type("html").send(z(p, this.options.info?.title));
+    }), e.use(d), O.info(`Swagger UI:  ${t}`), O.info(`ReDoc:       ${a}`), O.info(`OpenAPI spec: ${p}`);
   }
 };
 export {

package/dist/swagger.adapter.d.ts

@@ -1,5 +1,4 @@
-import type { Express } from 'express';
-import { type AppAdapter, type Container } from '@forinda/kickjs-core';
+import { type AppAdapter, type AdapterContext } from '@forinda/kickjs-core';
 import { registerControllerForDocs, clearRegisteredRoutes, type SwaggerOptions } from './openapi-builder';
 export interface SwaggerAdapterOptions extends SwaggerOptions {
     /** Path to serve Swagger UI (default: '/docs') */
@@ -36,10 +35,10 @@ export declare class SwaggerAdapter implements AppAdapter {
     name: string;
     constructor(options?: SwaggerAdapterOptions);
     /** Auto-detect server URLs from the running HTTP server and peer adapters */
-    afterStart(server: any, _container: Container): void;
+    afterStart({ server }: AdapterContext): void;
     /** Collect controller metadata as routes are mounted */
     onRouteMount(controllerClass: any, mountPath: string): void;
-    beforeMount(app: Express, _container: Container): void;
+    beforeMount({ app }: AdapterContext): void;
 }
 export { registerControllerForDocs, clearRegisteredRoutes };
 //# sourceMappingURL=swagger.adapter.d.ts.map

package/dist/swagger.adapter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"swagger.adapter.d.ts","sourceRoot":"","sources":["../src/swagger.adapter.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,SAAS,CAAA;AACtC,OAAO,EAAU,KAAK,UAAU,EAAE,KAAK,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAC9E,OAAO,EAEL,yBAAyB,EACzB,qBAAqB,EACrB,KAAK,cAAc,EACpB,MAAM,mBAAmB,CAAA;AAK1B,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC3D,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,8CAA8C;IAC9C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAA;CACjB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,cAAe,YAAW,UAAU;IAGnC,OAAO,CAAC,OAAO;IAF3B,IAAI,SAAmB;gBAEH,OAAO,GAAE,qBAA0B;IAEvD,6EAA6E;IAC7E,UAAU,CAAC,MAAM,EAAE,GAAG,EAAE,UAAU,EAAE,SAAS,GAAG,IAAI;IA0BpD,wDAAwD;IACxD,YAAY,CAAC,eAAe,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAI3D,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,SAAS,GAAG,IAAI;CA+CvD;AAGD,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,CAAA"}
+{"version":3,"file":"swagger.adapter.d.ts","sourceRoot":"","sources":["../src/swagger.adapter.ts"],"names":[],"mappings":"AACA,OAAO,EAAU,KAAK,UAAU,EAAE,KAAK,cAAc,EAAE,MAAM,sBAAsB,CAAA;AACnF,OAAO,EAEL,yBAAyB,EACzB,qBAAqB,EACrB,KAAK,cAAc,EACpB,MAAM,mBAAmB,CAAA;AAK1B,MAAM,WAAW,qBAAsB,SAAQ,cAAc;IAC3D,kDAAkD;IAClD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,8CAA8C;IAC9C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,iEAAiE;IACjE,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,6EAA6E;IAC7E,QAAQ,CAAC,EAAE,GAAG,EAAE,CAAA;CACjB;AAED;;;;;;;;;;;;;;;;;;;GAmBG;AACH,qBAAa,cAAe,YAAW,UAAU;IAGnC,OAAO,CAAC,OAAO;IAF3B,IAAI,SAAmB;gBAEH,OAAO,GAAE,qBAA0B;IAEvD,6EAA6E;IAC7E,UAAU,CAAC,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,IAAI;IA0B5C,wDAAwD;IACxD,YAAY,CAAC,eAAe,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI;IAI3D,WAAW,CAAC,EAAE,GAAG,EAAE,EAAE,cAAc,GAAG,IAAI;CA+C3C;AAGD,OAAO,EAAE,yBAAyB,EAAE,qBAAqB,EAAE,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@forinda/kickjs-swagger",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "OpenAPI spec generation from decorators, Swagger UI and ReDoc serving for KickJS",
   "keywords": [
     "kickjs",
@@ -51,7 +51,7 @@
   ],
   "dependencies": {
     "reflect-metadata": "^0.2.2",
-    "@forinda/kickjs-core": "1.6.0"
+    "@forinda/kickjs-core": "1.7.0"
   },
   "peerDependencies": {
     "express": "^5.1.0",