vona-module-a-openapi 5.0.22 → 5.0.25

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

@@ -25,6 +25,25 @@ declare module 'vona' {
     }
 }
 /** service: end */
+/** summerCache: begin */
+export * from '../bean/summerCache.json.ts';
+import { type IDecoratorSummerCacheOptions } from 'vona-module-a-summer';
+declare module 'vona-module-a-summer' {
+    interface ISummerCacheRecord {
+        'a-openapi:json': IDecoratorSummerCacheOptions;
+    }
+}
+declare module 'vona-module-a-openapi' {
+    interface SummerCacheJson {
+    }
+}
+/** summerCache: end */
+/** summerCache: begin */
+import type { SummerCacheJson } from '../bean/summerCache.json.ts';
+export interface IModuleSummerCache {
+    'json': SummerCacheJson;
+}
+/** summerCache: end */
 /** config: begin */
 export * from '../config/config.ts';
 import type { config } from '../config/config.ts';
@@ -201,6 +220,7 @@ export interface ScopeModuleAOpenapi {
     config: TypeModuleConfig<typeof config>;
     locale: TypeModuleLocales<(typeof locales)[TypeLocaleBase]>;
     service: IModuleService;
+    summerCache: IModuleSummerCache;
 }
 import 'vona';
 declare module 'vona' {

package/dist/bean/summerCache.json.d.ts

@@ -0,0 +1,7 @@
+import type { ISummerCacheGet, TSummerCacheActionOptions } from 'vona-module-a-summer';
+import { BeanSummerCacheBase } from 'vona-module-a-summer';
+export type TSummerCacheJsonKey = any;
+export type TSummerCacheJsonData = any;
+export declare class SummerCacheJson extends BeanSummerCacheBase<TSummerCacheJsonKey, TSummerCacheJsonData> implements ISummerCacheGet<TSummerCacheJsonKey, TSummerCacheJsonData> {
+    getNative(_key?: TSummerCacheJsonKey, _options?: TSummerCacheActionOptions<TSummerCacheJsonKey, TSummerCacheJsonData>): Promise<TSummerCacheJsonData | null | undefined>;
+}

package/dist/index.js

@@ -5,13 +5,24 @@ import { isEmptyObject, isNil } from '@cabloy/utils';
 import { toUpperCaseFirstChar } from '@cabloy/word-utils';
 import { getTypeName, coerceWithNil } from '@cabloy/zod-query';
 import { Service, Scope } from 'vona-module-a-bean';
+import { Caching } from 'vona-module-a-caching';
 import { SymbolDecoratorRule, SymbolOpenApiOptions, SymbolDecoratorRuleColumn } from 'vona-module-a-openapiutils';
 import { SymbolRequestMappingHandler } from 'vona-module-a-web';
 import { z } from 'zod';
+import { SummerCache, BeanSummerCacheBase } from 'vona-module-a-summer';
 import { locales as locales$1, setErrorMapDefault, setErrorMapSchema } from '@cabloy/zod-errors-custom';
 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(),
@@ -51,19 +62,37 @@ function $schema(classType, options) {
 const SymbolRouteHandlersArgumentsMeta = Symbol('SymbolRouteHandlersArgumentsMeta');
 const SymbolRouteHandlersArgumentsValue = Symbol('SymbolRouteHandlersArgumentsValue');
 
-var _dec$1, _dec2$1, _class$1;
+var _dec$2, _dec2$2, _dec3, _dec4, _dec5, _dec6, _dec7, _dec8, _class$2, _class2;
 const __ArgumentTypes = ['param', 'query', 'body', 'headers', 'fields', 'field', 'files', 'file'];
-let ServiceOpenapi = (_dec$1 = Service(), _dec2$1 = BeanInfo({
+let ServiceOpenapi = (_dec$2 = Service(), _dec2$2 = BeanInfo({
   module: "a-openapi"
-}), _dec$1(_class$1 = _dec2$1(_class$1 = class ServiceOpenapi extends BeanBase {
-  generateJson(version = 'V31') {
+}), _dec3 = Caching.get({
+  cacheName: 'a-openapi:json',
+  cacheKeyFn: 'generateJsonCacheKey'
+}), _dec4 = Reflect.metadata("design:type", Function), _dec5 = Reflect.metadata("design:paramtypes", [typeof K === "undefined" ? Object : K]), _dec6 = Caching.get({
+  cacheName: 'a-openapi:json',
+  cacheKeyFn: 'generateJsonOfControllerActionCacheKey'
+}), _dec7 = Reflect.metadata("design:type", Function), _dec8 = Reflect.metadata("design:paramtypes", [typeof Constructable === "undefined" ? Object : Constructable, String, typeof K === "undefined" ? Object : K]), _dec$2(_class$2 = _dec2$2(_class$2 = (_class2 = class ServiceOpenapi extends BeanBase {
+  generateJsonCacheKey(args, prop) {
+    const version = args[0] ?? 'V31';
+    const locale = this.ctx.locale;
+    return `${prop}_${version}_${locale}`;
+  }
+  generateJsonOfControllerActionCacheKey(args, prop) {
+    const [controller, actionKey, version] = args;
+    const beanOptions = appResource.getBean(controller);
+    const beanFullName = beanOptions.beanFullName;
+    const locale = this.ctx.locale;
+    return `${prop}_${beanFullName}_${actionKey}_${version ?? 'V31'}_${locale}`;
+  }
+  async generateJson(version = 'V31') {
     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');
     return apiObj;
   }
-  generateJsonOfControllerAction(controller, actionKey, version = 'V31') {
+  async generateJsonOfControllerAction(controller, actionKey, version = 'V31') {
     const registry = new OpenAPIRegistry();
     const beanOptions = appResource.getBean(controller);
     if (!beanOptions) throw new Error('invalid controller');
@@ -278,7 +307,7 @@ let ServiceOpenapi = (_dec$1 = Service(), _dec2$1 = BeanInfo({
         if (!schema) continue;
         // check schema
         if (getTypeName(schema) === 'ZodAny') {
-          throw new Error(`Invalid OpenAPI argument type: ${info.relativeName}:${controller.name}.${actionKey}#${argumentType}`);
+          throw new Error(`Invalid Openapi argument type: ${info.relativeName}:${controller.name}.${actionKey}#${argumentType}`);
         }
         // record
         if (argumentType === 'body') {
@@ -372,6 +401,15 @@ let ServiceOpenapi = (_dec$1 = Service(), _dec2$1 = BeanInfo({
     }
     return objHeaders;
   }
+}, _applyDecoratedDescriptor(_class2.prototype, "generateJson", [_dec3, _dec4, _dec5], Object.getOwnPropertyDescriptor(_class2.prototype, "generateJson"), _class2.prototype), _applyDecoratedDescriptor(_class2.prototype, "generateJsonOfControllerAction", [_dec6, _dec7, _dec8], Object.getOwnPropertyDescriptor(_class2.prototype, "generateJsonOfControllerAction"), _class2.prototype), _class2)) || _class$2) || _class$2);
+
+var _dec$1, _dec2$1, _class$1;
+let SummerCacheJson = (_dec$1 = SummerCache({
+  preset: 'mem'
+}), _dec2$1 = BeanInfo({
+  module: "a-openapi"
+}), _dec$1(_class$1 = _dec2$1(_class$1 = class SummerCacheJson extends BeanSummerCacheBase {
+  async getNative(_key, _options) {}
 }) || _class$1) || _class$1);
 
 function config(_app) {
@@ -475,7 +513,7 @@ function getTargetDecoratorRuleColumns(target) {
   registerMappedClassMetadataKey(target, SymbolDecoratorRuleColumn);
   return appMetadata.getOwnMetadataMap(true, SymbolDecoratorRuleColumn, target);
 }
-function mergeFieldsOpenAPIMetadata(target) {
+function mergeFieldsOpenapiMetadata(target) {
   // rules
   const rules = getTargetDecoratorRules(target.prototype);
   // beanOptions
@@ -795,4 +833,4 @@ const OrderBusinessBase = 1000;
 const OrderUnknownBase = 10000;
 const OrderMaxBase = 100000;
 
-export { $locale, $schema, Api, Arg, Main, OrderBusinessBase, OrderCoreBase, OrderMaxBase, OrderUnknownBase, ScopeModuleAOpenapi, ServiceOpenapi, SymbolRouteHandlersArgumentsMeta, SymbolRouteHandlersArgumentsValue, bodySchemaWrapperDefault, config, createPipesArgumentDecorator, errorsAdapter, getTargetDecoratorRuleColumns, getTargetDecoratorRules, locales, makeSchemaLike, makeSchemaLikes, mergeFieldsOpenAPIMetadata, v };
+export { $locale, $schema, Api, Arg, Main, OrderBusinessBase, OrderCoreBase, OrderMaxBase, OrderUnknownBase, ScopeModuleAOpenapi, ServiceOpenapi, SummerCacheJson, SymbolRouteHandlersArgumentsMeta, SymbolRouteHandlersArgumentsValue, bodySchemaWrapperDefault, config, createPipesArgumentDecorator, errorsAdapter, getTargetDecoratorRuleColumns, getTargetDecoratorRules, locales, makeSchemaLike, makeSchemaLikes, mergeFieldsOpenapiMetadata, v };

package/dist/lib/utils.d.ts

@@ -1,4 +1,4 @@
 import type { Constructable } from 'vona';
 export declare function getTargetDecoratorRules(target: object): Record<PropertyKey, unknown>;
 export declare function getTargetDecoratorRuleColumns(target: object): Record<PropertyKey, unknown>;
-export declare function mergeFieldsOpenAPIMetadata(target: Constructable): void;
+export declare function mergeFieldsOpenapiMetadata(target: Constructable): void;

package/dist/service/openapi.d.ts

@@ -1,9 +1,11 @@
 import type { Constructable } from 'vona';
-import type { IOpenAPIObject } from 'vona-module-a-openapiutils';
+import type { IOpenapiObject } from 'vona-module-a-openapiutils';
 import { BeanBase } from 'vona';
 export declare class ServiceOpenapi extends BeanBase {
-    generateJson<K extends keyof IOpenAPIObject>(version?: K): IOpenAPIObject[K];
-    generateJsonOfControllerAction<K extends keyof IOpenAPIObject>(controller: Constructable, actionKey: string, version?: K): IOpenAPIObject[K];
+    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]>;
     private _translate;
     private _translateSchema;
     private _translateStrings;

package/dist/types/rest.d.ts

@@ -28,9 +28,9 @@ declare module 'openapi3-ts/oas31' {
 export type TypeFieldRenderComponent = (keyof IComponentRecord) | (keyof TypeResourceActionRowRecordRender) | 'text' | 'textarea' | 'select' | 'checkbox' | 'radio' | 'switch' | 'image' | 'file' | 'color' | 'password' | 'email' | 'url';
 export type TypeFieldRenderComponentProvider = (keyof IComponentRecord) | (keyof TypeResourceActionRowRecordRender) | 'input' | 'textarea' | 'select';
 export type TypeSchemaScene = 'table' | 'form';
-export type TypeOpenAPIMetadata<T extends ZodTypeAny = ZodTypeAny> = Partial<ZodOpenAPIMetadata<z.input<T>>>;
+export type TypeOpenapiMetadata<T extends ZodTypeAny = ZodTypeAny> = Partial<ZodOpenAPIMetadata<z.input<T>>>;
 export type TypeEntityOptionsFields<T extends {}, More extends string | undefined = never> = {
-    [key in ((keyof T) | (More extends string ? More : never))]?: TypeOpenAPIMetadata | z.ZodSchema;
+    [key in ((keyof T) | (More extends string ? More : never))]?: TypeOpenapiMetadata | z.ZodSchema;
 };
 export type TypeControllerOptionsActions<T extends {}> = {
     [key in (keyof T)]?: IOpenApiOptions;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vona-module-a-openapi",
   "type": "module",
-  "version": "5.0.22",
+  "version": "5.0.25",
   "title": "a-openapi",
   "vonaModule": {
     "capabilities": {