vona-module-a-openapi 5.0.32 → 5.0.34

package/dist/index.js

@@ -1,6 +1,6 @@
 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';
@@ -54,8 +54,6 @@ function getTargetDecoratorRuleColumnsMap(target) {
   return map;
 }
 function mergeFieldsOpenapiMetadata(target) {
-  // rules
-  const rules = getTargetDecoratorRules(target.prototype);
   // beanOptions
   const beanOptions = appResource.getBean(target);
   const fields = cast(beanOptions?.options)?.fields;
@@ -63,21 +61,40 @@ 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);
       }
     }
   }
+  return rules;
 }
 function prepareClassType(classType) {
   return isClass(classType) ? classType : cast(classType)();
@@ -269,11 +286,15 @@ let ServiceOpenapi = (_dec$2 = Service(), _dec2$2 = BeanInfo({
   _translateSchema(schema, generateJsonScene) {
     if (!schema) return;
     if (schema.type === 'object' && schema.required === undefined) schema.required = [];
+    // serializerTransforms
+    delete schema.serializerTransforms;
+    // 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) {
@@ -281,6 +302,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) {
@@ -453,7 +479,7 @@ let ServiceOpenapi = (_dec$2 = Service(), _dec2$2 = BeanInfo({
         if (argumentType === 'body') {
           // body
           request.body = {
-            required: !schema.isOptional(),
+            required: !schema.safeParse(undefined).success,
             content: {
               'application/json': {
                 schema
@@ -592,10 +618,7 @@ function _patchGenerator(generator) {
   const gen = Object.getPrototypeOf(cast(generator).generator);
   gen.generateSchemaWithRef = function (zodSchema) {
     // schema ref
-    const lazySchema = ZodMetadata.getLazySchema(zodSchema);
-    if (lazySchema) {
-      zodSchema = lazySchema();
-    }
+    zodSchema = ZodMetadata.resolveLazySchema(zodSchema);
     const refId = ZodMetadata.getRefId(zodSchema);
     if (!refId) {
       return this.generateSimpleSchema(zodSchema);
@@ -626,108 +649,6 @@ let ScopeModuleAOpenapi = (_dec = Scope(), _dec2 = BeanInfo({
 
 /** scope: end */
 
-function Field(...schemaLikes) {
-  return function (target, prop) {
-    // rules
-    const rules = getTargetDecoratorRules(target);
-    // rule
-    const metaType = appMetadata.getDesignType(target, prop);
-    rules[prop] = makeSchemaLikes(schemaLikes, metaType);
-  };
-}
-
-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);
-    options.contentType = contentType;
-    return descriptor;
-  };
-}
-function body(...schemaLikes) {
-  return function (target, prop, descriptor) {
-    // schema
-    const metaType = appMetadata.getDesignReturntype(target, prop);
-    const schema = makeSchemaLikes(schemaLikes, metaType);
-    // options
-    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
-    options.bodySchema = schema;
-    return descriptor;
-  };
-}
-function bodyCustom(bodySchemaWrapper, ...schemaLikes) {
-  return function (target, prop, descriptor) {
-    // schema
-    const metaType = appMetadata.getDesignReturntype(target, prop);
-    const schema = makeSchemaLikes(schemaLikes, metaType);
-    // options
-    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
-    options.bodySchema = schema;
-    options.bodySchemaWrapper = bodySchemaWrapper;
-    return descriptor;
-  };
-}
-function exclude() {
-  return function (target, prop, descriptor) {
-    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
-    options.exclude = true;
-    return descriptor;
-  };
-}
-function tags(tags) {
-  return function (target, prop, descriptor) {
-    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
-    options.tags = tags;
-    return descriptor;
-  };
-}
-function header(header) {
-  return function (target, prop, descriptor) {
-    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
-    if (!options.headers) options.headers = [];
-    options.headers.push(header);
-    return descriptor;
-  };
-}
-function headers(headers) {
-  return function (target, prop, descriptor) {
-    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
-    if (!options.headers) options.headers = [];
-    options.headers.push(...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,
-  httpCode,
-  contentType,
-  body,
-  bodyCustom,
-  exclude,
-  tags,
-  header,
-  headers,
-  setHeader
-};
-
 function schemaEmail(params) {
   return function (_schema) {
     return z.email(params);
@@ -826,6 +747,42 @@ function schemaCaptcha(options) {
     });
   };
 }
+function schemaSerializerExclude() {
+  return function (schema) {
+    return schema.openapi({
+      exclude: true
+    });
+  };
+}
+function schemaSerializerTransform(serializerTransformName, options) {
+  return function (schema) {
+    return schema.openapi({
+      serializerTransforms: {
+        [serializerTransformName]: options
+      }
+    });
+  };
+}
+function schemaSerializerSensitive(options) {
+  return function (schema) {
+    return schema.openapi({
+      serializerTransforms: {
+        'a-serialization:sensitive': options
+      }
+    });
+  };
+}
+function schemaSerializerGetter(getter) {
+  return function (schema) {
+    return schema.openapi({
+      serializerTransforms: {
+        'a-serialization:getter': {
+          getter
+        }
+      }
+    });
+  };
+}
 
 function schemaOpenapi(refId, metadata) {
   return function (schema) {
@@ -954,6 +911,10 @@ const v = {
   tableIdentity: schemaTableIdentity,
   bigNumber: schemaBigNumber,
   captcha: schemaCaptcha,
+  serializerExclude: schemaSerializerExclude,
+  serializerTransform: schemaSerializerTransform,
+  serializerSensitive: schemaSerializerSensitive,
+  serializerGetter: schemaSerializerGetter,
   // openapi
   openapi: schemaOpenapi,
   title: schemaTitle,
@@ -964,9 +925,112 @@ const v = {
   transform: schemaZodTransform
 };
 
+function Field(...schemaLikes) {
+  return function (target, prop, descriptor) {
+    const metaType = appMetadata.getDesignType(target, prop);
+    const schema = makeSchemaLikes(schemaLikes, metaType);
+    const rules = mergeFieldOpenapiMetadata(target, prop, schema);
+    if (descriptor?.get) {
+      rules[prop] = v.serializerGetter(descriptor.get)(rules[prop]);
+    }
+  };
+}
+
+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);
+    options.contentType = contentType;
+    return descriptor;
+  };
+}
+function body(...schemaLikes) {
+  return function (target, prop, descriptor) {
+    // schema
+    const metaType = appMetadata.getDesignReturntype(target, prop);
+    const schema = makeSchemaLikes(schemaLikes, metaType);
+    // options
+    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
+    options.bodySchema = schema;
+    return descriptor;
+  };
+}
+function bodyCustom(bodySchemaWrapper, ...schemaLikes) {
+  return function (target, prop, descriptor) {
+    // schema
+    const metaType = appMetadata.getDesignReturntype(target, prop);
+    const schema = makeSchemaLikes(schemaLikes, metaType);
+    // options
+    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
+    options.bodySchema = schema;
+    options.bodySchemaWrapper = bodySchemaWrapper;
+    return descriptor;
+  };
+}
+function exclude() {
+  return function (target, prop, descriptor) {
+    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
+    options.exclude = true;
+    return descriptor;
+  };
+}
+function tags(tags) {
+  return function (target, prop, descriptor) {
+    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
+    options.tags = tags;
+    return descriptor;
+  };
+}
+function header(header) {
+  return function (target, prop, descriptor) {
+    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
+    if (!options.headers) options.headers = [];
+    options.headers.push(header);
+    return descriptor;
+  };
+}
+function headers(headers) {
+  return function (target, prop, descriptor) {
+    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
+    if (!options.headers) options.headers = [];
+    options.headers.push(...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,
+  httpCode,
+  contentType,
+  body,
+  bodyCustom,
+  exclude,
+  tags,
+  header,
+  headers,
+  setHeader
+};
+
 const OrderCoreBase = 100;
 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, getTargetDecoratorRuleColumnsMap, 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/schema/v/helpers.d.ts

@@ -1,3 +1,4 @@
+import type { ISerializerTransformRecord, TypeSerializerTransformGetter } from 'vona-module-a-serialization';
 import type { ISchemaObjectExtensionFieldCaptcha } from '../../../types/captcha.ts';
 import { z } from 'zod';
 export declare function schemaEmail(params?: string | z.core.$ZodEmailParams): (_schema: z.ZodString) => z.ZodEmail;
@@ -16,3 +17,7 @@ export declare function schemaRegex(regex: RegExp, params?: string | z.core.$Zod
 export declare function schemaTableIdentity(): (_schema?: any) => z.ZodString | z.ZodNumber;
 export declare function schemaBigNumber(): (_schema: any) => z.ZodType;
 export declare function schemaCaptcha(options: ISchemaObjectExtensionFieldCaptcha): (schema: z.ZodType) => z.ZodType;
+export declare function schemaSerializerExclude(): (schema: z.ZodType) => z.ZodType;
+export declare function schemaSerializerTransform<T extends keyof ISerializerTransformRecord>(serializerTransformName: T, options?: Partial<ISerializerTransformRecord[T]>): (schema: z.ZodType) => z.ZodType;
+export declare function schemaSerializerSensitive(options: ISerializerTransformRecord['a-serialization:sensitive']): (schema: z.ZodType) => z.ZodType;
+export declare function schemaSerializerGetter(getter: TypeSerializerTransformGetter): (schema: z.ZodType) => z.ZodType;

package/dist/lib/schema/v.d.ts

@@ -1,4 +1,4 @@
-import { schemaBigNumber, schemaCaptcha, schemaEmail, schemaIPv4, schemaIPv6, schemaLowercase, schemaMax, schemaMin, schemaRegex, schemaTableIdentity, schemaToLowerCase, schemaToUpperCase, schemaTrim, schemaUppercase, schemaUrl, schemaUuid } from './v/helpers.ts';
+import { schemaBigNumber, schemaCaptcha, schemaEmail, schemaIPv4, schemaIPv6, schemaLowercase, schemaMax, schemaMin, schemaRegex, schemaSerializerExclude, schemaSerializerGetter, schemaSerializerSensitive, schemaSerializerTransform, schemaTableIdentity, schemaToLowerCase, schemaToUpperCase, schemaTrim, schemaUppercase, schemaUrl, schemaUuid } from './v/helpers.ts';
 import { schemaDescription, schemaExample, schemaOpenapi, schemaTitle } from './v/openapi.ts';
 import { schemaArray, schemaDefault, schemaLazy, schemaLooseObject, schemaObject, schemaOptional, schemaStrictObject } from './v/system.ts';
 import { schemaZodRefine, schemaZodTransform } from './v/zod.ts';
@@ -26,6 +26,10 @@ export declare const v: {
     tableIdentity: typeof schemaTableIdentity;
     bigNumber: typeof schemaBigNumber;
     captcha: typeof schemaCaptcha;
+    serializerExclude: typeof schemaSerializerExclude;
+    serializerTransform: typeof schemaSerializerTransform;
+    serializerSensitive: typeof schemaSerializerSensitive;
+    serializerGetter: typeof schemaSerializerGetter;
     openapi: typeof schemaOpenapi;
     title: typeof schemaTitle;
     description: typeof schemaDescription;

package/dist/lib/utils.d.ts

@@ -1,7 +1,10 @@
 import type { Constructable } from 'vona';
 import type { TypeDecoratorRules } from 'vona-module-a-openapiutils';
+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): TypeDecoratorRules;
 export declare function prepareClassType<T>(classType: (() => Constructable<T>) | Constructable<T>): Constructable<T>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vona-module-a-openapi",
   "type": "module",
-  "version": "5.0.32",
+  "version": "5.0.34",
   "title": "a-openapi",
   "vonaModule": {
     "capabilities": {
@@ -36,7 +36,7 @@
   ],
   "dependencies": {
     "@cabloy/zod-errors-custom": "^2.0.2",
-    "@cabloy/zod-openapi": "^1.0.1",
+    "@cabloy/zod-openapi": "^1.0.2",
     "@cabloy/zod-query": "^2.0.1",
     "@cabloy/zod-to-openapi": "^8.1.1",
     "@zhennann/currency": "^2.0.0",