vona-module-a-openapi 5.0.16 → 5.0.18

package/dist/index.js

@@ -5,9 +5,9 @@ import { OpenApiGeneratorV3, OpenApiGeneratorV31, OpenAPIRegistry } from '@astea
 import * as ModuleInfo from '@cabloy/module-info';
 import { isEmptyObject, isNil } from '@cabloy/utils';
 import { toUpperCaseFirstChar } from '@cabloy/word-utils';
+import { getTypeName, coerceWithNil } from '@cabloy/zod-query';
 import { Service, SymbolRequestMappingHandler } from 'vona-module-a-web';
 import { z } from 'zod';
-import { coerceWithNil } from '@cabloy/zod-query';
 import 'openapi3-ts/oas30';
 import 'openapi3-ts/oas31';
 
@@ -275,11 +275,11 @@ let ServiceOpenapi = (_dec$1 = Service(), _dec2$1 = BeanInfo({
       security,
       description: actionOpenApiOptions?.description,
       summary: actionOpenApiOptions?.summary,
-      request: this._collectRequest(controller, actionKey, actionOpenApiOptions, controllerOpenApiOptions),
+      request: this._collectRequest(info, controller, actionKey, actionOpenApiOptions, controllerOpenApiOptions),
       responses: this._collectResponses(controller, actionKey, actionOpenApiOptions)
     });
   }
-  _collectRequest(controller, actionKey, actionOpenApiOptions, controllerOpenApiOptions) {
+  _collectRequest(info, controller, actionKey, actionOpenApiOptions, controllerOpenApiOptions) {
     // meta
     const argsMeta = this._prepareArgsMeta(controller, actionKey, actionOpenApiOptions, controllerOpenApiOptions);
     if (!argsMeta) return;
@@ -334,6 +334,10 @@ let ServiceOpenapi = (_dec$1 = Service(), _dec2$1 = BeanInfo({
           }
         }
         if (!schema) continue;
+        // check schema
+        if (getTypeName(schema) === 'ZodAny') {
+          throw new Error(`Invalid OpenAPI argument type: ${info.relativeName}:${controller.name}.${actionKey}#${argumentType}`);
+        }
         // record
         if (argumentType === 'body') {
           // body
@@ -519,6 +523,13 @@ function setPublic(target, prop, _descriptor, value) {
   const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
   options.public = value;
 }
+function httpCode(httpCode) {
+  return function (target, prop, descriptor) {
+    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
+    options.httpCode = httpCode;
+    return descriptor;
+  };
+}
 function contentType(contentType) {
   return function (target, prop, descriptor) {
     const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
@@ -579,15 +590,29 @@ function headers(headers) {
     return descriptor;
   };
 }
+function setHeader(field, val) {
+  return function (target, prop, descriptor) {
+    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
+    if (!options.setHeaders) options.setHeaders = {};
+    if (typeof field === 'string') {
+      options.setHeaders[field] = val;
+    } else {
+      Object.assign(options.setHeaders, field);
+    }
+    return descriptor;
+  };
+}
 const Api = {
   field: Field$1,
+  httpCode,
   contentType,
   body,
   bodyCustom,
   exclude,
   tags,
   header,
-  headers
+  headers,
+  setHeader
 };
 
 function createPipesArgumentDecorator(paramType, extractValue) {

package/dist/lib/decorator/api.d.ts

@@ -3,6 +3,7 @@ import type { IOpenApiHeader, TypeResponseContentType } from '../../types/api.ts
 import type { SchemaLike, SchemaLikeCreate } from '../../types/decorator.ts';
 import { Field } from './field.ts';
 export declare function setPublic(target: object, prop?: MetadataKey, _descriptor?: PropertyDescriptor, value?: boolean): void;
+declare function httpCode(httpCode: number): MethodDecorator;
 declare function contentType(contentType: TypeResponseContentType): MethodDecorator;
 declare function body(...schemaLikes: SchemaLike[]): MethodDecorator;
 declare function bodyCustom(bodySchemaWrapper: SchemaLikeCreate | false, ...schemaLikes: SchemaLike[]): MethodDecorator;
@@ -10,8 +11,13 @@ declare function exclude(): ClassDecorator & MethodDecorator;
 declare function tags(tags: string[]): ClassDecorator & MethodDecorator;
 declare function header(header: IOpenApiHeader): ClassDecorator & MethodDecorator;
 declare function headers(headers: IOpenApiHeader[]): ClassDecorator & MethodDecorator;
+declare function setHeader(field: {
+    [key: string]: string | string[];
+}): ClassDecorator & MethodDecorator;
+declare function setHeader(field: string, val: string | string[]): ClassDecorator & MethodDecorator;
 export declare const Api: {
     field: typeof Field;
+    httpCode: typeof httpCode;
     contentType: typeof contentType;
     body: typeof body;
     bodyCustom: typeof bodyCustom;
@@ -19,5 +25,6 @@ export declare const Api: {
     tags: typeof tags;
     header: typeof header;
     headers: typeof headers;
+    setHeader: typeof setHeader;
 };
 export {};

package/dist/types/api.d.ts

@@ -8,10 +8,14 @@ export interface IOpenApiHeader {
     name: string;
     description?: string;
 }
+export interface IResponseHeaders {
+    [key: string]: string | string[];
+}
 export interface IOpenApiOptions {
     public?: boolean;
     description?: string;
     summary?: string;
+    httpCode?: number;
     contentType?: TypeResponseContentType;
     bodySchema?: z.ZodSchema;
     bodySchemaWrapper?: SchemaLikeCreate | false;
@@ -19,6 +23,7 @@ export interface IOpenApiOptions {
     tags?: string[];
     operationId?: string;
     headers?: IOpenApiHeader[];
+    setHeaders?: IResponseHeaders;
 }
 export type TypeGenerateJsonScene = 'api' | 'rest';
 export type TypeOpenApiVersion = 'V30' | 'V31';

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vona-module-a-openapi",
   "type": "module",
-  "version": "5.0.16",
+  "version": "5.0.18",
   "title": "a-openapi",
   "vonaModule": {
     "capabilities": {
@@ -35,7 +35,7 @@
   "dependencies": {
     "@asteasolutions/zod-to-openapi": "^7.3.0",
     "@cabloy/zod-errors-custom": "^1.0.13",
-    "@cabloy/zod-query": "^1.0.14",
+    "@cabloy/zod-query": "^1.0.15",
     "@zhennann/currency": "^2.0.0",
     "openapi3-ts": "^4.4.0",
     "zod": "^3.25.58"