vona-module-a-openapi 5.0.37 → 5.0.39

package/dist/.metadata/index.d.ts

@@ -1,3 +1,22 @@
+/** bean: begin */
+export * from '../bean/bean.openapi.ts';
+import 'vona';
+declare module 'vona' {
+}
+declare module 'vona-module-a-openapi' {
+    interface BeanOpenapi {
+    }
+}
+/** bean: end */
+/** bean: begin */
+import type { BeanOpenapi } from '../bean/bean.openapi.ts';
+import 'vona';
+declare module 'vona' {
+    interface IBeanRecordGlobal {
+        'openapi': BeanOpenapi;
+    }
+}
+/** bean: end */
 /** service: begin */
 export * from '../service/openapi.ts';
 import 'vona';
@@ -55,17 +74,26 @@ export interface IModuleSummerCache {
 /** config: begin */
 export * from '../config/config.ts';
 import type { config } from '../config/config.ts';
-/** config: end */
+export declare const locales: {
+    'en-us': {
+        ZodErrorRequired: string;
+    };
+    'zh-cn': {
+        ZodErrorRequired: string;
+    };
+};
+/** locale: end */
 /** main: begin */
 export * from '../main.ts';
 /** main: end */
 /** scope: begin */
-import { BeanScopeBase, type BeanScopeUtil, type TypeModuleConfig } from 'vona';
+import { BeanScopeBase, type BeanScopeUtil, type TypeModuleConfig, type TypeModuleLocales, type TypeLocaleBase } from 'vona';
 export declare class ScopeModuleAOpenapi extends BeanScopeBase {
 }
 export interface ScopeModuleAOpenapi {
     util: BeanScopeUtil;
     config: TypeModuleConfig<typeof config>;
+    locale: TypeModuleLocales<(typeof locales)[TypeLocaleBase]>;
     service: IModuleService;
     summerCache: IModuleSummerCache;
 }
@@ -80,5 +108,9 @@ declare module 'vona' {
     interface IBeanScopeConfig {
         'a-openapi': ReturnType<typeof config>;
     }
+    interface IBeanScopeLocale {
+        'a-openapi': (typeof locales)[TypeLocaleBase];
+    }
 }
+export declare function $locale<K extends keyof (typeof locales)[TypeLocaleBase]>(key: K): `a-openapi::${K}`;
 /** scope: end */

package/dist/bean/bean.openapi.d.ts

@@ -0,0 +1,7 @@
+import type { Constructable } from 'vona';
+import type { IOpenapiObject } from 'vona-module-a-openapiutils';
+import { BeanBase } from 'vona';
+export declare class BeanOpenapi extends BeanBase {
+    generateJsonOfClass<K extends keyof IOpenapiObject>(schemaClass: Constructable, version?: K): Promise<IOpenapiObject[K]>;
+    generateJsonOfClasses<K extends keyof IOpenapiObject>(schemaClasses: Constructable[], version?: K): Promise<IOpenapiObject[K]>;
+}

package/dist/config/locale/en-us.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    ZodErrorRequired: string;
+};
+export default _default;

package/dist/config/locale/zh-cn.d.ts

@@ -0,0 +1,4 @@
+declare const _default: {
+    ZodErrorRequired: string;
+};
+export default _default;

package/dist/index.js

@@ -1,36 +1,20 @@
 import { registerMappedClassMetadataKey, appMetadata, appResource, cast, deepExtend, BeanInfo, BeanBase, LocaleModuleNameSeparator, HttpStatus, BeanSimple, BeanScopeBase, useApp, beanFullNameFromOnionName } from 'vona';
-import * as ModuleInfo from '@cabloy/module-info';
+import { OpenAPIRegistry, OpenApiGeneratorV3, OpenApiGeneratorV31 } from '@cabloy/zod-to-openapi';
+import { Bean, Service, Scope } from 'vona-module-a-bean';
+import { SymbolDecoratorRule, SymbolOpenApiOptions } from 'vona-module-a-openapiutils';
+import { z } from 'zod';
 import { isEmptyObject, isClass, isNil } from '@cabloy/utils';
+import { ZodMetadata } from '@cabloy/zod-openapi';
+import * as ModuleInfo from '@cabloy/module-info';
 import { toUpperCaseFirstChar } from '@cabloy/word-utils';
+import { translateError } from '@cabloy/zod-errors-custom';
 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, SymbolOpenApiOptions } from 'vona-module-a-openapiutils';
 import { SymbolRequestMappingHandler } from 'vona-module-a-web';
-import { z } from 'zod';
-import { ZodMetadata } from '@cabloy/zod-openapi';
 import { SummerCache, BeanSummerCacheBase } from 'vona-module-a-summer';
 import 'openapi3-ts/oas30';
 import 'openapi3-ts/oas31';
 
-function _applyDecoratedDescriptor(i, e, r, n, l) {
-  var a = {};
-  return Object.keys(n).forEach(function (i) {
-    a[i] = n[i];
-  }), a.enumerable = !!a.enumerable, a.configurable = !!a.configurable, ("value" in a || a.initializer) && (a.writable = true), a = r.slice().reverse().reduce(function (r, n) {
-    return n(i, e, r) || r;
-  }, a), l && void 0 !== a.initializer && (a.value = a.initializer ? a.initializer.call(l) : void 0, a.initializer = void 0), void 0 === a.initializer ? (Object.defineProperty(i, e, a), null) : a;
-}
-
-function bodySchemaWrapperDefault(bodySchema) {
-  return z.object({
-    code: z.string(),
-    message: z.string(),
-    data: bodySchema
-  });
-}
-
 function getTargetDecoratorRules(target, disableRegisterMetadata) {
   if (!disableRegisterMetadata) {
     registerMappedClassMetadataKey(target, SymbolDecoratorRule, {
@@ -191,6 +175,52 @@ function _createSchemaObject(rules, options) {
   return schema;
 }
 
+var _dec$3, _dec2$3, _class$3;
+let BeanOpenapi = (_dec$3 = Bean(), _dec2$3 = BeanInfo({
+  module: "a-openapi"
+}), _dec$3(_class$3 = _dec2$3(_class$3 = class BeanOpenapi extends BeanBase {
+  // need not cache
+  async generateJsonOfClass(schemaClass, version = 'V31') {
+    return await this.generateJsonOfClasses([schemaClass], version);
+  }
+
+  // need not cache
+  async generateJsonOfClasses(schemaClasses, version = 'V31') {
+    const registry = new OpenAPIRegistry();
+    // schema: independent
+    let counter = 0;
+    for (const schemaClass of schemaClasses) {
+      const schema = $schema(schemaClass);
+      let beanFullName = appResource.getBeanFullName(schemaClass);
+      if (!beanFullName) {
+        beanFullName = `${schemaClass.name}_${counter++}`;
+      }
+      registry.register(beanFullName, schema);
+    }
+    const generator = version === 'V30' ? new OpenApiGeneratorV3(registry.definitions) : new OpenApiGeneratorV31(registry.definitions);
+    const apiObj = generator.generateDocument(this.scope.config.generateDocument[version]);
+    this.scope.service.openapi.translate(apiObj, 'rest');
+    return apiObj;
+  }
+}) || _class$3) || _class$3);
+
+function _applyDecoratedDescriptor(i, e, r, n, l) {
+  var a = {};
+  return Object.keys(n).forEach(function (i) {
+    a[i] = n[i];
+  }), a.enumerable = !!a.enumerable, a.configurable = !!a.configurable, ("value" in a || a.initializer) && (a.writable = true), a = r.slice().reverse().reduce(function (r, n) {
+    return n(i, e, r) || r;
+  }, a), l && void 0 !== a.initializer && (a.value = a.initializer ? a.initializer.call(l) : void 0, a.initializer = void 0), void 0 === a.initializer ? (Object.defineProperty(i, e, a), null) : a;
+}
+
+function bodySchemaWrapperDefault(bodySchema) {
+  return z.object({
+    code: z.string(),
+    message: z.string(),
+    data: bodySchema
+  });
+}
+
 const SymbolRouteHandlersArgumentsMeta = Symbol('SymbolRouteHandlersArgumentsMeta');
 const SymbolRouteHandlersArgumentsValue = Symbol('SymbolRouteHandlersArgumentsValue');
 
@@ -221,7 +251,7 @@ let ServiceOpenapi = (_dec$2 = Service(), _dec2$2 = BeanInfo({
     const registry = this._collectRegistry();
     const generator = version === 'V30' ? new OpenApiGeneratorV3(registry.definitions) : new OpenApiGeneratorV31(registry.definitions);
     const apiObj = generator.generateDocument(this.scope.config.generateDocument[version]);
-    this._translate(apiObj, 'api');
+    this.translate(apiObj, 'api');
     return apiObj;
   }
   async generateJsonOfControllerAction(controller, actionKey, version = 'V31') {
@@ -231,34 +261,10 @@ let ServiceOpenapi = (_dec$2 = Service(), _dec2$2 = BeanInfo({
     this._collectController(registry, beanOptions.module, controller, actionKey);
     const generator = version === 'V30' ? new OpenApiGeneratorV3(registry.definitions) : new OpenApiGeneratorV31(registry.definitions);
     const apiObj = generator.generateDocument(this.scope.config.generateDocument[version]);
-    this._translate(apiObj, 'rest');
+    this.translate(apiObj, 'rest');
     return apiObj;
   }
-
-  // need not cache
-  async generateJsonOfClass(schemaClass, version = 'V31') {
-    return await this.generateJsonOfClasses([schemaClass], version);
-  }
-
-  // need not cache
-  async generateJsonOfClasses(schemaClasses, version = 'V31') {
-    const registry = new OpenAPIRegistry();
-    // schema: independent
-    let counter = 0;
-    for (const schemaClass of schemaClasses) {
-      const schema = $schema(schemaClass);
-      let beanFullName = appResource.getBeanFullName(schemaClass);
-      if (!beanFullName) {
-        beanFullName = `${schemaClass.name}_${counter++}`;
-      }
-      registry.register(beanFullName, schema);
-    }
-    const generator = version === 'V30' ? new OpenApiGeneratorV3(registry.definitions) : new OpenApiGeneratorV31(registry.definitions);
-    const apiObj = generator.generateDocument(this.scope.config.generateDocument[version]);
-    this._translate(apiObj, 'rest');
-    return apiObj;
-  }
-  _translate(apiObj, generateJsonScene) {
+  translate(apiObj, generateJsonScene) {
     // paths
     if (apiObj.paths) {
       for (const key in apiObj.paths) {
@@ -294,6 +300,8 @@ let ServiceOpenapi = (_dec$2 = Service(), _dec2$2 = BeanInfo({
       schema.description = schema.title;
       delete schema.title;
     }
+    // errorMessage
+    this._translateErrorMessages(schema);
     // properties
     const properties = cast(schema).properties;
     if (properties && typeof properties === 'object') {
@@ -308,6 +316,23 @@ let ServiceOpenapi = (_dec$2 = Service(), _dec2$2 = BeanInfo({
       this._translateSchema(items, generateJsonScene);
     }
   }
+  _translateErrorMessages(obj) {
+    if (!obj.errorMessage) return;
+    for (const key in obj.errorMessage) {
+      let error = obj.errorMessage[key];
+      if (typeof error === 'function') {
+        error = error();
+      }
+      const scope = Object.assign({}, obj);
+      if (!isNil(obj.minLength)) scope.minimum = obj.minLength;
+      if (!isNil(obj.exclusiveMinimum)) scope.minimum = obj.exclusiveMinimum;
+      if (!isNil(obj.maxLength)) scope.maximum = obj.maxLength;
+      if (!isNil(obj.exclusiveMaximum)) scope.maximum = obj.exclusiveMaximum;
+      obj.errorMessage[key] = translateError((text, ...args) => {
+        return this.app.meta.text(text, ...args);
+      }, error, scope);
+    }
+  }
   _translateStrings(obj, keys) {
     for (const key of keys) {
       this._translateString(obj, key);
@@ -604,6 +629,14 @@ function config(_app) {
   };
 }
 
+var locale_en_us = {
+  ZodErrorRequired: 'Required'
+};
+
+var locale_zh_cn = {
+  ZodErrorRequired: '必填项'
+};
+
 function schemaRefCustomAdapter(_app) {
   const registry = new OpenAPIRegistry();
   const generator31 = new OpenApiGeneratorV31(registry.definitions);
@@ -638,12 +671,25 @@ class Main extends BeanSimple {
 }
 
 var _dec, _dec2, _class;
+const locales = {
+  'en-us': locale_en_us,
+  'zh-cn': locale_zh_cn
+};
 let ScopeModuleAOpenapi = (_dec = Scope(), _dec2 = BeanInfo({
   module: "a-openapi"
 }), _dec(_class = _dec2(_class = class ScopeModuleAOpenapi extends BeanScopeBase {}) || _class) || _class);
-
+function $locale(key) {
+  return `a-openapi::${key}`;
+}
 /** scope: end */
 
+function schemaRequired(params) {
+  params = params || $locale('ZodErrorRequired');
+  return function (schema) {
+    schema._zod.def.error = z.util.normalizeParams(params).error;
+    return schema;
+  };
+}
 function schemaEmail(params) {
   return function (_schema) {
     return z.email(params);
@@ -890,6 +936,7 @@ const v = {
   strictObject: schemaStrictObject,
   looseObject: schemaLooseObject,
   // helpers
+  required: schemaRequired,
   email: schemaEmail,
   url: schemaUrl,
   uuid: schemaUuid,
@@ -1028,4 +1075,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, getTargetDecoratorRuleColumnsMap, getTargetDecoratorRules, makeSchemaLike, makeSchemaLikes, mergeFieldOpenapiMetadata, mergeFieldsOpenapiMetadata, prepareClassType, schemaRefCustomAdapter, v };
+export { $locale, $schema, $schemaLazy, Api, BeanOpenapi, Main, OrderBusinessBase, OrderCoreBase, OrderMaxBase, OrderUnknownBase, ScopeModuleAOpenapi, ServiceOpenapi, SummerCacheJson, SymbolRouteHandlersArgumentsMeta, SymbolRouteHandlersArgumentsValue, SymbolSchemaDynamicRefId, addSchemaDynamic, bodySchemaWrapperDefault, config, getSchemaDynamic, getSchemasDynamic, getTargetDecoratorRuleColumns, getTargetDecoratorRuleColumnsMap, getTargetDecoratorRules, locales, makeSchemaLike, makeSchemaLikes, mergeFieldOpenapiMetadata, mergeFieldsOpenapiMetadata, prepareClassType, schemaRefCustomAdapter, v };

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

@@ -1,6 +1,7 @@
 import type { ISerializerTransformRecord, TypeSerializerTransformGetter } from 'vona-module-a-serialization';
 import type { ISchemaObjectExtensionFieldCaptcha } from '../../../types/captcha.ts';
 import { z } from 'zod';
+export declare function schemaRequired(params?: string | z.core.$ZodStringParams): (schema: z.ZodType) => z.ZodType;
 export declare function schemaEmail(params?: string | z.core.$ZodEmailParams): (_schema: z.ZodString) => z.ZodEmail;
 export declare function schemaUrl(params?: string | z.core.$ZodURLParams): (_schema: z.ZodString) => z.ZodURL;
 export declare function schemaUuid(params?: string | z.core.$ZodUUIDParams): (_schema: z.ZodString) => z.ZodUUID;

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

@@ -1,4 +1,4 @@
-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 { schemaBigNumber, schemaCaptcha, schemaEmail, schemaIPv4, schemaIPv6, schemaLowercase, schemaMax, schemaMin, schemaRegex, schemaRequired, 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';
@@ -10,6 +10,7 @@ export declare const v: {
     optional: typeof schemaOptional;
     strictObject: typeof schemaStrictObject;
     looseObject: typeof schemaLooseObject;
+    required: typeof schemaRequired;
     email: typeof schemaEmail;
     url: typeof schemaUrl;
     uuid: typeof schemaUuid;

package/dist/service/openapi.d.ts

@@ -1,15 +1,16 @@
+import type { OpenAPIObject as OpenAPIObject30 } from 'openapi3-ts/oas30';
+import type { OpenAPIObject as OpenAPIObject31 } from 'openapi3-ts/oas31';
 import type { Constructable } from 'vona';
-import type { IOpenapiObject } from 'vona-module-a-openapiutils';
+import type { IOpenapiObject, TypeGenerateJsonScene } from 'vona-module-a-openapiutils';
 import { BeanBase } from 'vona';
 export declare class ServiceOpenapi extends BeanBase {
     protected generateJsonCacheKey(args: any[], prop: string): string;
     protected generateJsonOfControllerActionCacheKey(args: any[], prop: string): string;
     generateJson<K extends keyof IOpenapiObject>(version?: K): Promise<IOpenapiObject[K]>;
     generateJsonOfControllerAction<K extends keyof IOpenapiObject>(controller: Constructable, actionKey: string, version?: K): Promise<IOpenapiObject[K]>;
-    generateJsonOfClass<K extends keyof IOpenapiObject>(schemaClass: Constructable, version?: K): Promise<IOpenapiObject[K]>;
-    generateJsonOfClasses<K extends keyof IOpenapiObject>(schemaClasses: Constructable[], version?: K): Promise<IOpenapiObject[K]>;
-    private _translate;
+    translate(apiObj: OpenAPIObject30 | OpenAPIObject31, generateJsonScene: TypeGenerateJsonScene): void;
     private _translateSchema;
+    private _translateErrorMessages;
     private _translateStrings;
     private _translateString;
     private _collectRegistry;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vona-module-a-openapi",
   "type": "module",
-  "version": "5.0.37",
+  "version": "5.0.39",
   "title": "a-openapi",
   "vonaModule": {
     "capabilities": {
@@ -35,9 +35,9 @@
     "static"
   ],
   "dependencies": {
-    "@cabloy/zod-openapi": "^1.0.2",
+    "@cabloy/zod-openapi": "^1.0.3",
     "@cabloy/zod-query": "^2.0.1",
-    "@cabloy/zod-to-openapi": "^8.1.1",
+    "@cabloy/zod-to-openapi": "^8.1.4",
     "@zhennann/currency": "^2.0.0",
     "openapi3-ts": "^4.5.0",
     "zod": "^4.1.5"