vona-module-a-openapi 5.0.31 → 5.0.33

package/dist/index.js

@@ -1,12 +1,12 @@
 import { registerMappedClassMetadataKey, appMetadata, appResource, cast, deepExtend, BeanInfo, BeanBase, LocaleModuleNameSeparator, HttpStatus, BeanSimple, BeanScopeBase, useApp, beanFullNameFromOnionName } from 'vona';
 import * as ModuleInfo from '@cabloy/module-info';
-import { isClass, isEmptyObject, isNil } from '@cabloy/utils';
+import { isEmptyObject, isClass, isNil } from '@cabloy/utils';
 import { toUpperCaseFirstChar } from '@cabloy/word-utils';
 import { getInnerTypeName, coerceWithNil } from '@cabloy/zod-query';
 import { OpenApiGeneratorV3, OpenApiGeneratorV31, OpenAPIRegistry } from '@cabloy/zod-to-openapi';
 import { Service, Scope } from 'vona-module-a-bean';
 import { Caching } from 'vona-module-a-caching';
-import { SymbolDecoratorRule, SymbolDecoratorRuleColumn, SymbolOpenApiOptions } from 'vona-module-a-openapiutils';
+import { SymbolDecoratorRule, SymbolOpenApiOptions } from 'vona-module-a-openapiutils';
 import { SymbolRequestMappingHandler } from 'vona-module-a-web';
 import { z } from 'zod';
 import { ZodMetadata } from '@cabloy/zod-openapi';
@@ -31,21 +31,29 @@ function bodySchemaWrapperDefault(bodySchema) {
   });
 }
 
-function getTargetDecoratorRules(target) {
-  registerMappedClassMetadataKey(target, SymbolDecoratorRule, {
-    partialClass: meta => {
-      return meta.optional();
-    }
-  });
+function getTargetDecoratorRules(target, disableRegisterMetadata) {
+  if (!disableRegisterMetadata) {
+    registerMappedClassMetadataKey(target, SymbolDecoratorRule, {
+      partialClass: meta => {
+        return meta.optional();
+      }
+    });
+  }
   return appMetadata.getOwnMetadataMap(true, SymbolDecoratorRule, target);
 }
 function getTargetDecoratorRuleColumns(target) {
-  registerMappedClassMetadataKey(target, SymbolDecoratorRuleColumn);
-  return appMetadata.getOwnMetadataMap(true, SymbolDecoratorRuleColumn, target);
+  const rules = getTargetDecoratorRules(target, true);
+  return Object.keys(rules);
+}
+function getTargetDecoratorRuleColumnsMap(target) {
+  const columns = getTargetDecoratorRuleColumns(target);
+  const map = {};
+  for (const column of columns) {
+    map[column] = column;
+  }
+  return map;
 }
 function mergeFieldsOpenapiMetadata(target) {
-  // rules
-  const rules = getTargetDecoratorRules(target.prototype);
   // beanOptions
   const beanOptions = appResource.getBean(target);
   const fields = cast(beanOptions?.options)?.fields;
@@ -53,18 +61,36 @@ function mergeFieldsOpenapiMetadata(target) {
   for (const key in fields) {
     const field = fields[key];
     if (!field) continue;
-    const schemaCurrent = rules[key];
-    const metadataCurrent = schemaCurrent ? ZodMetadata.getOpenapiMetadata(schemaCurrent) : undefined;
-    if (Object.prototype.hasOwnProperty.call(field, 'parseAsync')) {
-      const schema = field;
+    mergeFieldOpenapiMetadata(target.prototype, key, field);
+  }
+}
+
+// fieldRule maybe undefined
+function mergeFieldOpenapiMetadata(target, prop, fieldRule) {
+  // rules
+  const rules = getTargetDecoratorRules(target);
+  // rule
+  const schemaCurrent = rules[prop];
+  const metadataCurrent = schemaCurrent ? ZodMetadata.getOpenapiMetadata(schemaCurrent) : undefined;
+  // merge
+  if (Object.prototype.hasOwnProperty.call(fieldRule, 'parseAsync')) {
+    const schema = fieldRule;
+    if (isEmptyObject(metadataCurrent)) {
+      rules[prop] = schema;
+    } else {
       const metadataCustom = ZodMetadata.getOpenapiMetadata(schema);
-      rules[key] = schema.openapi(deepExtend({}, metadataCurrent, metadataCustom));
+      rules[prop] = schema.openapi(deepExtend({}, metadataCurrent, metadataCustom));
+    }
+  } else {
+    if (schemaCurrent) {
+      if (!isEmptyObject(fieldRule)) {
+        rules[prop] = schemaCurrent.openapi(deepExtend({}, metadataCurrent, fieldRule));
+      }
     } else {
-      // use deepExtend for sure strict
-      if (schemaCurrent) {
-        rules[key] = schemaCurrent.openapi(deepExtend({}, metadataCurrent, field));
+      if (isEmptyObject(fieldRule)) {
+        rules[prop] = z.any();
       } else {
-        rules[key] = z.any().openapi(deepExtend({}, field));
+        rules[prop] = z.any().openapi(fieldRule);
       }
     }
   }
@@ -259,11 +285,13 @@ let ServiceOpenapi = (_dec$2 = Service(), _dec2$2 = BeanInfo({
   _translateSchema(schema, generateJsonScene) {
     if (!schema) return;
     if (schema.type === 'object' && schema.required === undefined) schema.required = [];
+    // schema
     this._translateStrings(schema, ['title', 'description']);
     if (generateJsonScene === 'api' && !schema.description && schema.title) {
       schema.description = schema.title;
       delete schema.title;
     }
+    // properties
     const properties = cast(schema).properties;
     if (properties && typeof properties === 'object') {
       for (const prop in properties) {
@@ -271,6 +299,11 @@ let ServiceOpenapi = (_dec$2 = Service(), _dec2$2 = BeanInfo({
         this._translateSchema(propObj, generateJsonScene);
       }
     }
+    // items
+    const items = cast(schema).items;
+    if (items && typeof items === 'object') {
+      this._translateSchema(items, generateJsonScene);
+    }
   }
   _translateStrings(obj, keys) {
     for (const key of keys) {
@@ -618,14 +651,9 @@ let ScopeModuleAOpenapi = (_dec = Scope(), _dec2 = BeanInfo({
 
 function Field(...schemaLikes) {
   return function (target, prop) {
-    // rules
-    const rules = getTargetDecoratorRules(target);
-    // rule
     const metaType = appMetadata.getDesignType(target, prop);
-    rules[prop] = makeSchemaLikes(schemaLikes, metaType);
-    //
-    const columns = getTargetDecoratorRuleColumns(target);
-    columns[prop] = prop;
+    const schema = makeSchemaLikes(schemaLikes, metaType);
+    mergeFieldOpenapiMetadata(target, prop, schema);
   };
 }
 
@@ -962,4 +990,4 @@ const OrderBusinessBase = 1000;
 const OrderUnknownBase = 10000;
 const OrderMaxBase = 100000;
 
-export { $schema, $schemaLazy, Api, Main, OrderBusinessBase, OrderCoreBase, OrderMaxBase, OrderUnknownBase, ScopeModuleAOpenapi, ServiceOpenapi, SummerCacheJson, SymbolRouteHandlersArgumentsMeta, SymbolRouteHandlersArgumentsValue, SymbolSchemaDynamicRefId, addSchemaDynamic, bodySchemaWrapperDefault, config, getSchemaDynamic, getSchemasDynamic, getTargetDecoratorRuleColumns, getTargetDecoratorRules, makeSchemaLike, makeSchemaLikes, mergeFieldsOpenapiMetadata, prepareClassType, schemaRefCustomAdapter, v };
+export { $schema, $schemaLazy, Api, Main, OrderBusinessBase, OrderCoreBase, OrderMaxBase, OrderUnknownBase, ScopeModuleAOpenapi, ServiceOpenapi, SummerCacheJson, SymbolRouteHandlersArgumentsMeta, SymbolRouteHandlersArgumentsValue, SymbolSchemaDynamicRefId, addSchemaDynamic, bodySchemaWrapperDefault, config, getSchemaDynamic, getSchemasDynamic, getTargetDecoratorRuleColumns, getTargetDecoratorRuleColumnsMap, getTargetDecoratorRules, makeSchemaLike, makeSchemaLikes, mergeFieldOpenapiMetadata, mergeFieldsOpenapiMetadata, prepareClassType, schemaRefCustomAdapter, v };

package/dist/lib/utils.d.ts

@@ -1,6 +1,10 @@
 import type { Constructable } from 'vona';
 import type { TypeDecoratorRules } from 'vona-module-a-openapiutils';
-export declare function getTargetDecoratorRules(target: object): TypeDecoratorRules;
-export declare function getTargetDecoratorRuleColumns(target: object): Record<PropertyKey, unknown>;
+import type { TypeOpenapiMetadata } from '../types/rest.ts';
+import { z } from 'zod';
+export declare function getTargetDecoratorRules(target: object, disableRegisterMetadata?: boolean): TypeDecoratorRules;
+export declare function getTargetDecoratorRuleColumns(target: object): string[];
+export declare function getTargetDecoratorRuleColumnsMap(target: object): Record<string, string>;
 export declare function mergeFieldsOpenapiMetadata(target: Constructable): void;
+export declare function mergeFieldOpenapiMetadata(target: object, prop: string, fieldRule?: TypeOpenapiMetadata | z.ZodType): void;
 export declare function prepareClassType<T>(classType: (() => Constructable<T>) | Constructable<T>): Constructable<T>;

package/dist/types/rest.d.ts

@@ -17,6 +17,7 @@ export interface ISchemaObjectExtensionFieldRest {
     form?: Omit<ISchemaObjectExtensionFieldRest, 'table' | 'form'>;
 }
 export interface ISchemaObjectExtensionField {
+    exclude?: boolean;
     rest?: ISchemaObjectExtensionFieldRest;
     query?: ISchemaObjectExtensionFieldQuery;
     captcha?: ISchemaObjectExtensionFieldCaptcha;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vona-module-a-openapi",
   "type": "module",
-  "version": "5.0.31",
+  "version": "5.0.33",
   "title": "a-openapi",
   "vonaModule": {
     "capabilities": {
@@ -35,7 +35,7 @@
     "static"
   ],
   "dependencies": {
-    "@cabloy/zod-errors-custom": "^2.0.1",
+    "@cabloy/zod-errors-custom": "^2.0.2",
     "@cabloy/zod-openapi": "^1.0.1",
     "@cabloy/zod-query": "^2.0.1",
     "@cabloy/zod-to-openapi": "^8.1.1",