vona-module-a-openapiutils 5.0.14 → 5.0.15

package/dist/.metadata/locales.d.ts

@@ -7,4 +7,4 @@ export declare const locales: {
         ZodErrorRequired: string;
     };
 };
-export declare function $locale<K extends keyof (typeof locales)[TypeLocaleBase]>(key: K, ...args: any[]): import("vona").ILocaleMagic<`a-openapiutils::${K}`>;
+export declare function $locale<K extends keyof (typeof locales)[TypeLocaleBase]>(key: K, ...args: any[]): any;

package/dist/index.js

@@ -32,6 +32,11 @@ const OrderCoreBase = 100;
 const OrderBusinessBase = 1000;
 const OrderUnknownBase = 10000;
 const OrderMaxBase = 100000;
+const OrderLevelBaseMap = {
+  core: OrderCoreBase,
+  business: OrderBusinessBase,
+  max: OrderMaxBase
+};
 
 const SymbolRouteHandlersArgumentsMeta = Symbol('SymbolRouteHandlersArgumentsMeta');
 const SymbolRouteHandlersArgumentsValue = Symbol('SymbolRouteHandlersArgumentsValue');
@@ -232,6 +237,11 @@ function schemaFilterDateRange(options) {
     return schema.openapi({
       filter: {
         transform: ['a-web:dateRange', options]
+      },
+      rest: {
+        filter: {
+          render: 'dateRange'
+        }
       }
     });
   };
@@ -362,6 +372,88 @@ function schemaExample(example) {
   };
 }
 
+function schemaOrder(order, level, scene) {
+  const levelBase = OrderLevelBaseMap[level ?? 'business'];
+  const orderReal = levelBase + order;
+  return function (schema) {
+    return schema.openapi(scene ? {
+      rest: {
+        [scene]: {
+          order: orderReal
+        }
+      }
+    } : {
+      rest: {
+        order: orderReal
+      }
+    });
+  };
+}
+function schemaRender(render, scene) {
+  return function (schema) {
+    return schema.openapi(scene ? {
+      rest: {
+        [scene]: {
+          render: render
+        }
+      }
+    } : {
+      rest: {
+        render: render
+      }
+    });
+  };
+}
+function schemaVisible(visible, scene) {
+  return function (schema) {
+    return schema.openapi(scene ? {
+      rest: {
+        [scene]: {
+          visible
+        }
+      }
+    } : {
+      rest: {
+        visible
+      }
+    });
+  };
+}
+function schemaCurrency(currency, scene) {
+  return function (schema) {
+    const options = currency !== undefined ? {
+      render: 'currency',
+      currency
+    } : {
+      render: 'currency'
+    };
+    return schema.openapi(scene ? {
+      rest: {
+        [scene]: options
+      }
+    } : {
+      rest: options
+    });
+  };
+}
+function schemaDate(dateFormat, scene) {
+  return function (schema) {
+    const options = dateFormat !== undefined ? {
+      render: 'date',
+      dateFormat
+    } : {
+      render: 'date'
+    };
+    return schema.openapi(scene ? {
+      rest: {
+        [scene]: options
+      }
+    } : {
+      rest: options
+    });
+  };
+}
+
 function schemaSerializerTransform(serializerTransformName, options) {
   return function (schema) {
     return schema.openapi({
@@ -552,6 +644,12 @@ const v = {
   title: schemaTitle,
   description: schemaDescription,
   example: schemaExample,
+  // rest
+  currency: schemaCurrency,
+  date: schemaDate,
+  order: schemaOrder,
+  render: schemaRender,
+  visible: schemaVisible,
   // zod
   refine: schemaZodRefine,
   transform: schemaZodTransform
@@ -682,4 +780,4 @@ function $makeFilterTransform(filterTransformName, options) {
   return [filterTransformName, options];
 }
 
-export { $apiPath, $apiPathAndCombineParamsAndQuery, $locale, $makeFilterTransform, $makeSchema, $schema, $schemaLazy, Api, OrderBusinessBase, OrderCoreBase, OrderMaxBase, OrderUnknownBase, ScopeModuleAOpenapiutils, SymbolDecoratorRule, SymbolOpenApiOptions, SymbolRouteHandlersArgumentsMeta, SymbolRouteHandlersArgumentsValue, SymbolSchemaDynamicRefId, addSchemaDynamic, bodySchemaWrapperDefault, getSchemaDynamic, getSchemasDynamic, getTargetDecoratorRuleColumns, getTargetDecoratorRuleColumnsMap, getTargetDecoratorRules, locales, makeSchemaLike, makeSchemaLikes, mergeFieldOpenapiMetadata, mergeFieldsOpenapiMetadata, normalizeErrorParams, prepareClassType, setPublic, v };
+export { $apiPath, $apiPathAndCombineParamsAndQuery, $locale, $makeFilterTransform, $makeSchema, $schema, $schemaLazy, Api, OrderBusinessBase, OrderCoreBase, OrderLevelBaseMap, OrderMaxBase, OrderUnknownBase, ScopeModuleAOpenapiutils, SymbolDecoratorRule, SymbolOpenApiOptions, SymbolRouteHandlersArgumentsMeta, SymbolRouteHandlersArgumentsValue, SymbolSchemaDynamicRefId, addSchemaDynamic, bodySchemaWrapperDefault, getSchemaDynamic, getSchemasDynamic, getTargetDecoratorRuleColumns, getTargetDecoratorRuleColumnsMap, getTargetDecoratorRules, locales, makeSchemaLike, makeSchemaLikes, mergeFieldOpenapiMetadata, mergeFieldsOpenapiMetadata, normalizeErrorParams, prepareClassType, setPublic, v };

package/dist/lib/const/database.d.ts

@@ -2,3 +2,8 @@ export declare const OrderCoreBase = 100;
 export declare const OrderBusinessBase = 1000;
 export declare const OrderUnknownBase = 10000;
 export declare const OrderMaxBase = 100000;
+export declare const OrderLevelBaseMap: {
+    core: number;
+    business: number;
+    max: number;
+};

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

@@ -0,0 +1,9 @@
+import type { CurrencyOptions } from '@zhennann/currency';
+import type { TypeDateFormat, TypeRenderComponent, TypeSchemaScene } from 'vona-module-a-openapi';
+import type z from 'zod';
+import type { TypeSchemaOrderLevel } from '../../../types/order.ts';
+export declare function schemaOrder<T extends z.ZodType>(order: number, level?: TypeSchemaOrderLevel, scene?: TypeSchemaScene): (schema: T) => T;
+export declare function schemaRender<T extends z.ZodType>(render: TypeRenderComponent, scene?: TypeSchemaScene): (schema: T) => T;
+export declare function schemaVisible<T extends z.ZodType>(visible?: boolean, scene?: TypeSchemaScene): (schema: T) => T;
+export declare function schemaCurrency<T extends z.ZodType>(currency?: CurrencyOptions, scene?: TypeSchemaScene): (schema: T) => T;
+export declare function schemaDate<T extends z.ZodType>(dateFormat?: TypeDateFormat, scene?: TypeSchemaScene): (schema: T) => T;

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

@@ -1,6 +1,7 @@
 import { schemaFilter, schemaFilterDateRange, schemaFilterTransform } from './v/filter.ts';
 import { schemaCaptcha, schemaEmail, schemaIPv4, schemaIPv6, schemaLowercase, schemaMax, schemaMin, schemaRegex, schemaTableIdentity, schemaToLowerCase, schemaToUpperCase, schemaTrim, schemaUppercase, schemaUrl, schemaUuid } from './v/helpers.ts';
 import { schemaDescription, schemaExample, schemaOpenapi, schemaTitle } from './v/openapi.ts';
+import { schemaCurrency, schemaDate, schemaOrder, schemaRender, schemaVisible } from './v/rest.ts';
 import { schemaSerializerCustom, schemaSerializerExclude, schemaSerializerGetter, schemaSerializerReplace, schemaSerializerTransform } from './v/serializer.ts';
 import { schemaArray, schemaDefault, schemaLazy, schemaLooseObject, schemaObject, schemaOptional, schemaRequired, schemaStrictObject } from './v/system.ts';
 import { schemaZodRefine, schemaZodTransform } from './v/zod.ts';
@@ -40,6 +41,11 @@ export declare const v: {
     title: typeof schemaTitle;
     description: typeof schemaDescription;
     example: typeof schemaExample;
+    currency: typeof schemaCurrency;
+    date: typeof schemaDate;
+    order: typeof schemaOrder;
+    render: typeof schemaRender;
+    visible: typeof schemaVisible;
     refine: typeof schemaZodRefine;
     transform: typeof schemaZodTransform;
 };

package/dist/types/index.d.ts

@@ -1,2 +1,3 @@
 export * from './api.ts';
 export * from './decorator.ts';
+export * from './order.ts';

package/dist/types/order.d.ts

@@ -0,0 +1,7 @@
+import type { TypeSchemaScene } from 'vona-module-a-openapi';
+export type TypeSchemaOrderLevel = 'core' | 'business' | 'max';
+export interface ISchemaOrderParams {
+    order: number;
+    level?: TypeSchemaOrderLevel;
+    scene?: TypeSchemaScene;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vona-module-a-openapiutils",
   "type": "module",
-  "version": "5.0.14",
+  "version": "5.0.15",
   "title": "a-openapiutils",
   "vonaModule": {
     "dependencies": {}
@@ -25,6 +25,9 @@
     "assets",
     "dist"
   ],
+  "dependencies": {
+    "@zhennann/currency": "^2.0.0"
+  },
   "scripts": {
     "clean": "rimraf dist tsconfig.build.tsbuildinfo",
     "tsc:publish": "npm run clean && vona :bin:buildModule && tsc -p tsconfig.build.json"