vona-module-a-openapi 5.0.38 → 5.0.40

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';

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/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);
@@ -741,21 +766,18 @@ function schemaRegex(regex, params) {
 function schemaTableIdentity() {
   const app = useApp();
   const ormConfig = app.util.getModuleConfigRaw('a-orm');
-  const _identityType = ormConfig?.table?.identityType ?? 'string';
+  const _identityType = ormConfig?.table?.identityType ?? 'bigint';
   return function (_schema) {
     if (_identityType === 'string') {
       return z.string();
     } else if (_identityType === 'number') {
       return z.number();
+    } else if (_identityType === 'bigint') {
+      return z.string().regex(/^\d+$/);
     }
     throw new Error('not support');
   };
 }
-function schemaBigNumber() {
-  return function (_schema) {
-    return z.union([z.string(), z.number()]);
-  };
-}
 function schemaCaptcha(options) {
   return function (schema) {
     return schema.openapi({
@@ -926,7 +948,6 @@ const v = {
   uppercase: schemaUppercase,
   regex: schemaRegex,
   tableIdentity: schemaTableIdentity,
-  bigNumber: schemaBigNumber,
   captcha: schemaCaptcha,
   serializerExclude: schemaSerializerExclude,
   serializerTransform: schemaSerializerTransform,
@@ -1050,4 +1071,4 @@ const OrderBusinessBase = 1000;
 const OrderUnknownBase = 10000;
 const OrderMaxBase = 100000;
 
-export { $locale, $schema, $schemaLazy, Api, 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 };
+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

@@ -16,7 +16,6 @@ export declare function schemaLowercase(params?: string | z.core.$ZodCheckLowerC
 export declare function schemaUppercase(params?: string | z.core.$ZodCheckUpperCaseParams): (schema: z.ZodString) => z.ZodString;
 export declare function schemaRegex(regex: RegExp, params?: string | z.core.$ZodCheckRegexParams): (schema: z.ZodString) => z.ZodString;
 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;

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

@@ -1,4 +1,4 @@
-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 { 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';
@@ -25,7 +25,6 @@ export declare const v: {
     uppercase: typeof schemaUppercase;
     regex: typeof schemaRegex;
     tableIdentity: typeof schemaTableIdentity;
-    bigNumber: typeof schemaBigNumber;
     captcha: typeof schemaCaptcha;
     serializerExclude: typeof schemaSerializerExclude;
     serializerTransform: typeof schemaSerializerTransform;

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.38",
+  "version": "5.0.40",
   "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"