@moostjs/swagger 0.3.39 → 0.3.40

package/dist/index.cjs

@@ -4,7 +4,7 @@ var moost = require('moost');
 var eventHttp = require('@moostjs/event-http');
 var zod = require('@moostjs/zod');
 var httpStatic = require('@wooksjs/http-static');
-var path = require('path');
+var Path = require('path');
 var swaggerUiDist = require('swagger-ui-dist');
 var zodParser = require('zod-parser');
 
@@ -44,6 +44,9 @@ function SwaggerRequestBody(opt) {
         return meta;
     });
 }
+function SwaggerParam(opts) {
+    return getSwaggerMate().decorate('swaggerParams', opts, true);
+}
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -119,22 +122,7 @@ function mapToSwaggerSpec(metadata, options, logger) {
                 for (const [code, responseConfigs] of Object.entries(hmeta.swaggerResponses)) {
                     const newCode = code === '0' ? getDefaultStatusCode(handlerMethod) : code;
                     for (const [contentType, type] of Object.entries(responseConfigs)) {
-                        let schema;
-                        let zt;
-                        if (type instanceof zod.z.ZodType) {
-                            zt = type;
-                        }
-                        else if (typeof type === 'function') {
-                            zt = zod.getZodType({
-                                type,
-                            });
-                        }
-                        if (zt) {
-                            const parsed = myParseZod(zt);
-                            if (['ZodString', 'ZodNumber', 'ZodObject', 'ZodArray', 'ZodBoolean'].includes(parsed.$type)) {
-                                schema = getSwaggerSchema(parsed);
-                            }
-                        }
+                        const schema = getSwaggerSchemaFromSwaggerConfigType(type);
                         if (schema) {
                             responses = responses || {};
                             responses[newCode] = { content: { [contentType]: { schema } } };
@@ -194,6 +182,15 @@ function mapToSwaggerSpec(metadata, options, logger) {
                 responses,
             };
             const endpointSpec = swaggerSpec.paths[handlerPath][handlerMethod];
+            for (const param of hmeta?.swaggerParams || []) {
+                endpointSpec.parameters.push({
+                    name: param.name,
+                    in: param.in,
+                    description: param.description,
+                    required: !!param.required,
+                    schema: getSwaggerSchemaFromSwaggerConfigType(param.type) || { type: 'string' },
+                });
+            }
             for (const paramName of handler.registeredAs[0].args) {
                 const paramIndex = handler.meta.params.findIndex(param => param.paramSource === 'ROUTE' && param.paramName === paramName);
                 const paramMeta = handler.meta.params[paramIndex];
@@ -232,7 +229,7 @@ function mapToSwaggerSpec(metadata, options, logger) {
                     }, undefined, logger);
                     const parsed = myParseZod(zodType);
                     const schema = getSwaggerSchema(parsed, true);
-                    if (paramMeta.paramSource == 'QUERY_ITEM') {
+                    if (paramMeta.paramSource === 'QUERY_ITEM') {
                         endpointSpec.parameters.push({
                             name: paramMeta.paramName || '',
                             in: 'query',
@@ -241,7 +238,7 @@ function mapToSwaggerSpec(metadata, options, logger) {
                             schema: schema || { type: 'string' },
                         });
                     }
-                    else if (paramMeta.paramSource == 'QUERY' && parsed.$type === 'ZodObject') {
+                    else if (paramMeta.paramSource === 'QUERY' && parsed.$type === 'ZodObject') {
                         for (const [key, value] of Object.entries(parsed.$inner)) {
                             const schema = getSwaggerSchema(value, true);
                             if (schema) {
@@ -533,6 +530,28 @@ function getDefaultStatusCode(httpMethod) {
     };
     return defaultStatusCodes[httpMethod.toUpperCase()] || 200;
 }
+function getSwaggerSchemaFromSwaggerConfigType(type) {
+    let schema;
+    let zt;
+    if (type instanceof zod.z.ZodType) {
+        zt = type;
+    }
+    else if (typeof type === 'function') {
+        zt = zod.getZodType({
+            type,
+        });
+    }
+    if (zt) {
+        const parsed = myParseZod(zt);
+        if (['ZodString', 'ZodNumber', 'ZodObject', 'ZodArray', 'ZodBoolean'].includes(parsed.$type)) {
+            schema = getSwaggerSchema(parsed);
+        }
+    }
+    else if (type.type || type.$ref) {
+        schema = type;
+    }
+    return schema;
+}
 
 exports.SwaggerController = class SwaggerController {
     constructor(title = 'Moost API') {
@@ -542,7 +561,7 @@ exports.SwaggerController = class SwaggerController {
     'serveIndex'(url, location, status) {
         if (!url.endsWith('index.html') && !url.endsWith('/')) {
             status.value = 302;
-            location.value = path.join(url, '/');
+            location.value = Path.join(url, '/');
             return '';
         }
         return `<!DOCTYPE html>
@@ -648,6 +667,7 @@ exports.SwaggerController = __decorate([
 
 exports.SwaggerDescription = SwaggerDescription;
 exports.SwaggerExclude = SwaggerExclude;
+exports.SwaggerParam = SwaggerParam;
 exports.SwaggerRequestBody = SwaggerRequestBody;
 exports.SwaggerResponse = SwaggerResponse;
 exports.SwaggerTag = SwaggerTag;

package/dist/index.d.ts

@@ -49,16 +49,23 @@ interface TSwaggerMate {
     swaggerTags: string[];
     swaggerExclude: boolean;
     swaggerDescription: string;
-    swaggerResponses: Record<number, Record<string, TSwaggerResponseConfigValue>>;
-    swaggerRequestBody: Record<string, TSwaggerResponseConfigValue>;
+    swaggerResponses: Record<number, Record<string, TSwaggerConfigType>>;
+    swaggerRequestBody: Record<string, TSwaggerConfigType>;
+    swaggerParams: Array<{
+        name: string;
+        in: 'query' | 'header' | 'path' | 'formData' | 'body';
+        description?: string;
+        required?: boolean;
+        type?: TSwaggerConfigType;
+    }>;
 }
-type TSwaggerResponseConfigValue = TFunction | z.ZodType | TSwaggerSchema;
+type TSwaggerConfigType = TFunction | z.ZodType | TSwaggerSchema;
 interface TSwaggerResponseConfig {
     contentType?: string;
     description?: string;
-    response: TSwaggerResponseConfigValue;
+    response: TSwaggerConfigType;
 }
-type TSwaggerResponseOpts = TSwaggerResponseConfigValue | TSwaggerResponseConfig;
+type TSwaggerResponseOpts = TSwaggerConfigType | TSwaggerResponseConfig;
 
 declare const SwaggerTag: (tag: string) => MethodDecorator & ClassDecorator & ParameterDecorator & PropertyDecorator;
 declare const SwaggerExclude: () => MethodDecorator & ClassDecorator & ParameterDecorator & PropertyDecorator;
@@ -66,6 +73,7 @@ declare const SwaggerDescription: (descr: string) => MethodDecorator & ClassDeco
 declare function SwaggerResponse(opts: TSwaggerResponseOpts): MethodDecorator;
 declare function SwaggerResponse(code: number, opts: TSwaggerResponseOpts): MethodDecorator;
 declare function SwaggerRequestBody(opt: TSwaggerResponseOpts): MethodDecorator & ClassDecorator & ParameterDecorator & PropertyDecorator;
+declare function SwaggerParam(opts: TSwaggerMate['swaggerParams'][number]): MethodDecorator & ClassDecorator & ParameterDecorator & PropertyDecorator;
 
 declare class SwaggerController {
     protected title: string;
@@ -79,4 +87,4 @@ declare class SwaggerController {
     'serve'(path: string): Promise<unknown>;
 }
 
-export { SwaggerController, SwaggerDescription, SwaggerExclude, SwaggerRequestBody, SwaggerResponse, SwaggerTag, type TSwaggerMate, type TSwaggerResponseConfigValue, type TSwaggerResponseOpts, getSwaggerMate };
+export { SwaggerController, SwaggerDescription, SwaggerExclude, SwaggerParam, SwaggerRequestBody, SwaggerResponse, SwaggerTag, type TSwaggerConfigType, type TSwaggerMate, type TSwaggerResponseOpts, getSwaggerMate };

package/dist/index.mjs

@@ -1,8 +1,8 @@
 import { getMoostMate, Controller, Const, useEventLogger, useControllerContext, Moost } from 'moost';
 import { Get, SetHeader, Url, HeaderHook, StatusHook } from '@moostjs/event-http';
-import { z, getZodType, getZodTypeForProp, ZodSkip } from '@moostjs/zod';
+import { getZodType, z, getZodTypeForProp, ZodSkip } from '@moostjs/zod';
 import { serveFile } from '@wooksjs/http-static';
-import { join } from 'path';
+import Path from 'path';
 import { getAbsoluteFSPath } from 'swagger-ui-dist';
 import { parseZodType } from 'zod-parser';
 
@@ -42,6 +42,9 @@ function SwaggerRequestBody(opt) {
         return meta;
     });
 }
+function SwaggerParam(opts) {
+    return getSwaggerMate().decorate('swaggerParams', opts, true);
+}
 
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
@@ -117,22 +120,7 @@ function mapToSwaggerSpec(metadata, options, logger) {
                 for (const [code, responseConfigs] of Object.entries(hmeta.swaggerResponses)) {
                     const newCode = code === '0' ? getDefaultStatusCode(handlerMethod) : code;
                     for (const [contentType, type] of Object.entries(responseConfigs)) {
-                        let schema;
-                        let zt;
-                        if (type instanceof z.ZodType) {
-                            zt = type;
-                        }
-                        else if (typeof type === 'function') {
-                            zt = getZodType({
-                                type,
-                            });
-                        }
-                        if (zt) {
-                            const parsed = myParseZod(zt);
-                            if (['ZodString', 'ZodNumber', 'ZodObject', 'ZodArray', 'ZodBoolean'].includes(parsed.$type)) {
-                                schema = getSwaggerSchema(parsed);
-                            }
-                        }
+                        const schema = getSwaggerSchemaFromSwaggerConfigType(type);
                         if (schema) {
                             responses = responses || {};
                             responses[newCode] = { content: { [contentType]: { schema } } };
@@ -192,6 +180,15 @@ function mapToSwaggerSpec(metadata, options, logger) {
                 responses,
             };
             const endpointSpec = swaggerSpec.paths[handlerPath][handlerMethod];
+            for (const param of hmeta?.swaggerParams || []) {
+                endpointSpec.parameters.push({
+                    name: param.name,
+                    in: param.in,
+                    description: param.description,
+                    required: !!param.required,
+                    schema: getSwaggerSchemaFromSwaggerConfigType(param.type) || { type: 'string' },
+                });
+            }
             for (const paramName of handler.registeredAs[0].args) {
                 const paramIndex = handler.meta.params.findIndex(param => param.paramSource === 'ROUTE' && param.paramName === paramName);
                 const paramMeta = handler.meta.params[paramIndex];
@@ -230,7 +227,7 @@ function mapToSwaggerSpec(metadata, options, logger) {
                     }, undefined, logger);
                     const parsed = myParseZod(zodType);
                     const schema = getSwaggerSchema(parsed, true);
-                    if (paramMeta.paramSource == 'QUERY_ITEM') {
+                    if (paramMeta.paramSource === 'QUERY_ITEM') {
                         endpointSpec.parameters.push({
                             name: paramMeta.paramName || '',
                             in: 'query',
@@ -239,7 +236,7 @@ function mapToSwaggerSpec(metadata, options, logger) {
                             schema: schema || { type: 'string' },
                         });
                     }
-                    else if (paramMeta.paramSource == 'QUERY' && parsed.$type === 'ZodObject') {
+                    else if (paramMeta.paramSource === 'QUERY' && parsed.$type === 'ZodObject') {
                         for (const [key, value] of Object.entries(parsed.$inner)) {
                             const schema = getSwaggerSchema(value, true);
                             if (schema) {
@@ -531,6 +528,28 @@ function getDefaultStatusCode(httpMethod) {
     };
     return defaultStatusCodes[httpMethod.toUpperCase()] || 200;
 }
+function getSwaggerSchemaFromSwaggerConfigType(type) {
+    let schema;
+    let zt;
+    if (type instanceof z.ZodType) {
+        zt = type;
+    }
+    else if (typeof type === 'function') {
+        zt = getZodType({
+            type,
+        });
+    }
+    if (zt) {
+        const parsed = myParseZod(zt);
+        if (['ZodString', 'ZodNumber', 'ZodObject', 'ZodArray', 'ZodBoolean'].includes(parsed.$type)) {
+            schema = getSwaggerSchema(parsed);
+        }
+    }
+    else if (type.type || type.$ref) {
+        schema = type;
+    }
+    return schema;
+}
 
 let SwaggerController = class SwaggerController {
     constructor(title = 'Moost API') {
@@ -540,7 +559,7 @@ let SwaggerController = class SwaggerController {
     'serveIndex'(url, location, status) {
         if (!url.endsWith('index.html') && !url.endsWith('/')) {
             status.value = 302;
-            location.value = join(url, '/');
+            location.value = Path.join(url, '/');
             return '';
         }
         return `<!DOCTYPE html>
@@ -644,4 +663,4 @@ SwaggerController = __decorate([
     __metadata("design:paramtypes", [Object])
 ], SwaggerController);
 
-export { SwaggerController, SwaggerDescription, SwaggerExclude, SwaggerRequestBody, SwaggerResponse, SwaggerTag, getSwaggerMate };
+export { SwaggerController, SwaggerDescription, SwaggerExclude, SwaggerParam, SwaggerRequestBody, SwaggerResponse, SwaggerTag, getSwaggerMate };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moostjs/swagger",
-  "version": "0.3.39",
+  "version": "0.3.40",
   "description": "@moostjs/swagger",
   "sideEffects": false,
   "main": "dist/index.cjs",
@@ -37,13 +37,14 @@
   },
   "homepage": "https://github.com/moostjs/moostjs/tree/main/packages/swagger#readme",
   "peerDependencies": {
-    "moost": "0.3.39",
-    "@moostjs/event-http": "0.3.39"
+    "moost": "0.3.40",
+    "@moostjs/event-http": "0.3.40"
   },
   "dependencies": {
+    "@wooksjs/event-http": "^0.4.35",
     "swagger-ui-dist": "^5.10.5",
     "zod-parser": "^0.0.3",
-    "@moostjs/zod": "0.3.39",
+    "@moostjs/zod": "0.3.40",
     "@wooksjs/http-static": "^0.4.35"
   },
   "devDependencies": {