vona-module-a-openapiutils 5.0.16 → 5.0.17

package/dist/index.js

@@ -41,10 +41,9 @@ const OrderLevelBaseMap = {
 
 const SymbolRouteHandlersArgumentsMeta = Symbol('SymbolRouteHandlersArgumentsMeta');
 const SymbolRouteHandlersArgumentsValue = Symbol('SymbolRouteHandlersArgumentsValue');
-
 const SymbolOpenApiOptions = Symbol('SymbolOpenApiOptions');
-
 const SymbolDecoratorRule = Symbol('SymbolDecoratorRule');
+const SymbolControllerResource = Symbol('SymbolControllerResource');
 
 function getTargetDecoratorRules(target, disableRegisterMetadata) {
   if (!disableRegisterMetadata) {
@@ -768,6 +767,13 @@ function setPublic(target, prop, _descriptor, value) {
   options.public = value;
 }
 
+function Resource() {
+  return function (target) {
+    // controller resource
+    appMetadata.defineMetadata(SymbolControllerResource, true, target);
+  };
+}
+
 function bodySchemaWrapperDefault(bodySchema) {
   return z.object({
     code: z.string(),
@@ -786,4 +792,4 @@ function $makeFilterTransform(filterTransformName, options) {
   return [filterTransformName, options];
 }
 
-export { $apiPath, $apiPathAndCombineParamsAndQuery, $locale, $makeFilterTransform, $makeSchema, $schema, $schemaLazy, Api, OrderBusinessBase, OrderCoreBase, OrderLevelBaseMap, OrderMaxBase, OrderUnknownBase, ScopeModuleAOpenapiutils, SymbolDecoratorRule, SymbolOpenApiOptions, SymbolRouteHandlersArgumentsMeta, SymbolRouteHandlersArgumentsValue, SymbolSchemaDynamicRefId, addSchemaDynamic, bodySchemaWrapperDefault, getSchemaDynamic, getSchemasDynamic, getTargetDecoratorRuleColumns, getTargetDecoratorRuleColumnsMap, getTargetDecoratorRules, locales, makeSchemaLike, makeSchemaLikes, mergeFieldOpenapiMetadata, mergeFieldsOpenapiMetadata, normalizeErrorParams, prepareClassType, setPublic, v };
+export { $apiPath, $apiPathAndCombineParamsAndQuery, $locale, $makeFilterTransform, $makeSchema, $schema, $schemaLazy, Api, OrderBusinessBase, OrderCoreBase, OrderLevelBaseMap, OrderMaxBase, OrderUnknownBase, Resource, ScopeModuleAOpenapiutils, SymbolControllerResource, SymbolDecoratorRule, SymbolOpenApiOptions, SymbolRouteHandlersArgumentsMeta, SymbolRouteHandlersArgumentsValue, SymbolSchemaDynamicRefId, addSchemaDynamic, bodySchemaWrapperDefault, getSchemaDynamic, getSchemasDynamic, getTargetDecoratorRuleColumns, getTargetDecoratorRuleColumnsMap, getTargetDecoratorRules, locales, makeSchemaLike, makeSchemaLikes, mergeFieldOpenapiMetadata, mergeFieldsOpenapiMetadata, normalizeErrorParams, prepareClassType, setPublic, v };

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

@@ -1,2 +1,5 @@
 export declare const SymbolRouteHandlersArgumentsMeta: unique symbol;
 export declare const SymbolRouteHandlersArgumentsValue: unique symbol;
+export declare const SymbolOpenApiOptions: unique symbol;
+export declare const SymbolDecoratorRule: unique symbol;
+export declare const SymbolControllerResource: unique symbol;

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

@@ -1,5 +1,5 @@
 import type { MetadataKey } from 'vona';
-import type { IOpenApiHeader, TypeResponseContentType } from '../../types/api.ts';
+import type { IOpenapiHeader, TypeResponseContentType } from '../../types/api.ts';
 import type { SchemaLike, SchemaLikeCreate } from '../../types/decorator.ts';
 import { Field } from './field.ts';
 declare function httpCode(httpCode: number): MethodDecorator;
@@ -8,8 +8,8 @@ declare function body(...schemaLikes: SchemaLike[]): MethodDecorator;
 declare function bodyCustom(bodySchemaWrapper: SchemaLikeCreate | false, ...schemaLikes: SchemaLike[]): MethodDecorator;
 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 header(header: IOpenapiHeader): ClassDecorator & MethodDecorator;
+declare function headers(headers: IOpenapiHeader[]): ClassDecorator & MethodDecorator;
 declare function setHeader(field: {
     [key: string]: string | string[];
 }): ClassDecorator & MethodDecorator;

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

@@ -1 +1,2 @@
 export * from './api.ts';
+export * from './resource.ts';

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

@@ -0,0 +1 @@
+export declare function Resource(): ClassDecorator;

package/dist/types/api.d.ts

@@ -3,8 +3,7 @@ import type { OpenAPIObject as OpenAPIObject31, SchemaObject as SchemaObject31 }
 import type { ILocaleMagic, VonaApplication } from 'vona';
 import type z from 'zod';
 import type { SchemaLikeCreate } from './decorator.ts';
-export declare const SymbolOpenApiOptions: unique symbol;
-export interface IOpenApiHeader {
+export interface IOpenapiHeader {
     name: string;
     description?: string;
 }
@@ -22,7 +21,7 @@ export interface IOpenapiSchemaObject {
     V31: SchemaObject31;
 }
 export type TypeSecuritySchemes = Record<string, ((this: VonaApplication) => object) | object>;
-export interface IOpenApiOptions {
+export interface IOpenapiOptions {
     public?: boolean;
     description?: string | ILocaleMagic;
     summary?: string | ILocaleMagic;
@@ -33,7 +32,7 @@ export interface IOpenApiOptions {
     exclude?: boolean;
     tags?: string[];
     operationId?: string;
-    headers?: IOpenApiHeader[];
+    headers?: IOpenapiHeader[];
     setHeaders?: IResponseHeaders;
 }
 export type TypeResponseContentType = 'application/json' | 'application/xml' | 'application/x-www-form-urlencoded' | 'multipart/form-data' | 'text/plain' | 'text/html' | 'application/octet-stream' | 'application/pdf' | 'image/png' | 'image/jpeg' | 'image/gif' | 'image/webp' | 'image/svg+xml' | 'image/bmp' | 'image/tiff' | 'image/vnd.microsoft.icon' | 'image/vnd.wap.wbmp' | 'image/x-icon' | 'image/x-jng' | 'image/x-ms-bmp' | 'image/x-portable-bitmap' | 'image/x-portable-graymap' | 'image/x-portable-pixmap' | 'image/x-xbitmap' | 'image/x-xpixmap' | 'image/x-xwindowdump' | 'image/bmp' | 'image/x-bmp' | 'image/x-xbitmap' | 'image/x-win-bitmap' | 'image/x-windows-bmp' | 'image/ms-bmp' | 'image/x-ms-bmp' | 'image/x-icon' | 'image/x-ico' | 'image/vnd.microsoft.icon' | 'image/ico' | 'image/icon' | 'text/css' | 'text/csv' | 'text/html' | 'text/javascript' | 'text/plain' | 'text/xml' | 'application/javascript' | 'application/ecmascript' | 'application/json' | 'application/ld+json' | 'application/manifest+json' | 'application/javascript' | 'application/x-javascript' | 'application/x-json' | 'application/x-ms-application';

package/dist/types/decorator.d.ts

@@ -3,4 +3,3 @@ import type z from 'zod';
 export type SchemaLikeCreate = (schema: any) => any;
 export type SchemaLike<T = unknown> = SchemaLikeCreate | z.ZodType<T> | Constructable;
 export type TypeDecoratorRules = Record<string, z.ZodType | undefined>;
-export declare const SymbolDecoratorRule: unique symbol;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vona-module-a-openapiutils",
   "type": "module",
-  "version": "5.0.16",
+  "version": "5.0.17",
   "title": "a-openapiutils",
   "vonaModule": {
     "dependencies": {}