vona-module-a-openapi 5.0.12 → 5.0.14

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "vona-module-a-openapi",
   "type": "module",
-  "version": "5.0.12",
+  "version": "5.0.14",
   "title": "a-openapi",
   "vonaModule": {
     "capabilities": {
@@ -47,6 +47,6 @@
   "gitHead": "0eab9dc4a5622caffe89e7b1b3f02c08ccbc4c4b",
   "scripts": {
     "clean": "rimraf dist tsconfig.build.tsbuildinfo",
-    "tsc:publish": "npm run clean && tsc -p tsconfig.build.json"
+    "tsc:publish": "npm run clean && vona :bin:buildModule && tsc -p tsconfig.build.json"
   }
 }

package/dist/.metadata/index.js

@@ -1,39 +0,0 @@
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-/** main: end */
-/** scope: begin */
-import { BeanScopeBase } from 'vona';
-import { Scope } from 'vona-module-a-bean';
-/** config: end */
-/** locale: begin */
-import locale_en_us from "../config/locale/en-us.js";
-import locale_zh_cn from "../config/locale/zh-cn.js";
-/** service: end */
-/** config: begin */
-import 'vona';
-import 'vona';
-import 'vona';
-export * from "../config/config.js";
-/** locale: end */
-/** main: begin */
-export * from "../main.js";
-export const locales = {
-    'en-us': locale_en_us,
-    'zh-cn': locale_zh_cn,
-};
-/** service: begin */
-export * from "../service/openapi.js";
-let ScopeModuleAOpenapi = class ScopeModuleAOpenapi extends BeanScopeBase {
-};
-ScopeModuleAOpenapi = __decorate([
-    Scope()
-], ScopeModuleAOpenapi);
-export { ScopeModuleAOpenapi };
-export function $locale(key) {
-    return `a-openapi::${key}`;
-}
-/** scope: end */

package/dist/.metadata/this.js

@@ -1,2 +0,0 @@
-export const __ThisModule__ = 'a-openapi';
-export { ScopeModuleAOpenapi as ScopeModule } from "./index.js";

package/dist/config/config.js

@@ -1,30 +0,0 @@
-export function config(_app) {
-    return {
-        defaultVersion: 'V31',
-        generateDocument: {
-            V30: {
-                openapi: '3.0.0',
-                info: {
-                    version: '5.0.0',
-                    title: 'Vona',
-                    description: 'Vona API',
-                },
-            },
-            V31: {
-                openapi: '3.1.0',
-                info: {
-                    version: '5.0.0',
-                    title: 'Vona',
-                    description: 'Vona API',
-                },
-            },
-        },
-        securitySchemes: {
-            bearerAuth: {
-                type: 'http',
-                scheme: 'bearer',
-                bearerFormat: 'JWT',
-            },
-        },
-    };
-}

package/dist/config/locale/en-us.js

@@ -1,2 +0,0 @@
-import { locales } from '@cabloy/zod-errors-custom';
-export default locales['en-us'];

package/dist/config/locale/zh-cn.js

@@ -1,2 +0,0 @@
-import { locales } from '@cabloy/zod-errors-custom';
-export default locales['zh-cn'];

package/dist/lib/decorator/api.js

@@ -1,71 +0,0 @@
-import { appMetadata } from 'vona';
-import { SymbolOpenApiOptions } from "../../types/api.js";
-import { makeSchemaLikes } from "../schema/makeSchemaLikes.js";
-import { Field } from "./field.js";
-export function setPublic(target, prop, _descriptor, value) {
-    const options = appMetadata.getOwnMetadataMap(false, SymbolOpenApiOptions, target, prop);
-    options.public = value;
-}
-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;
-    };
-}
-export const Api = { field: Field, contentType, body, bodyCustom, exclude, tags, header, headers };

package/dist/lib/decorator/arguments.js

@@ -1,39 +0,0 @@
-import { createPipesArgumentDecorator } from "./pipesArgument.js";
-function Param(property, ...schemaLikes) {
-    return createPipesArgumentDecorator('param')(property, ...schemaLikes);
-}
-function Query(property, ...schemaLikes) {
-    return createPipesArgumentDecorator('query')(property, ...schemaLikes);
-}
-function Body(property, ...schemaLikes) {
-    return createPipesArgumentDecorator('body')(property, ...schemaLikes);
-}
-function Headers(property, ...schemaLikes) {
-    return createPipesArgumentDecorator('headers')(property, ...schemaLikes);
-}
-function Fields(property, ...schemaLikes) {
-    return createPipesArgumentDecorator('fields')(property, ...schemaLikes);
-}
-function Field(property, ...schemaLikes) {
-    return createPipesArgumentDecorator('field')(property, ...schemaLikes);
-}
-function Files(property, ...schemaLikes) {
-    return createPipesArgumentDecorator('files')(property, ...schemaLikes);
-}
-function File(property, ...schemaLikes) {
-    return createPipesArgumentDecorator('file')(property, ...schemaLikes);
-}
-function User(...schemaLikes) {
-    return createPipesArgumentDecorator('user')(undefined, ...schemaLikes);
-}
-export const Arg = {
-    param: Param,
-    query: Query,
-    body: Body,
-    headers: Headers,
-    fields: Fields,
-    field: Field,
-    files: Files,
-    file: File,
-    user: User,
-};

package/dist/lib/decorator/field.js

@@ -1,15 +0,0 @@
-import { appMetadata } from 'vona';
-import { makeSchemaLikes } from "../schema/makeSchemaLikes.js";
-import { getTargetDecoratorRuleColumns, getTargetDecoratorRules } from "../utils.js";
-export function Field(...schemaLikes) {
-    return function (target, prop) {
-        // rules
-        const rules = getTargetDecoratorRules(target);
-        // rule
-        const metaType = appMetadata.getDesignType(target, prop);
-        rules[prop] = makeSchemaLikes(schemaLikes, metaType);
-        //
-        const columns = getTargetDecoratorRuleColumns(target);
-        columns[prop] = prop;
-    };
-}

package/dist/lib/decorator/index.js

@@ -1,3 +0,0 @@
-export * from "./api.js";
-export * from "./arguments.js";
-export * from "./pipesArgument.js";

package/dist/lib/decorator/pipesArgument.js

@@ -1,35 +0,0 @@
-import { appMetadata } from 'vona';
-import { z } from 'zod';
-import { SymbolRouteHandlersArgumentsMeta, } from "../../types/decorator.js";
-import { makeSchemaLikes } from "../schema/makeSchemaLikes.js";
-export function createPipesArgumentDecorator(paramType, extractValue) {
-    return function (field, ...schemaLikes) {
-        return function (target, prop, index) {
-            // not inherit
-            const argsMeta = appMetadata.getOwnMetadataArray(false, SymbolRouteHandlersArgumentsMeta, target, prop);
-            const hasParamField = typeof field === 'string';
-            const paramField = hasParamField ? field : undefined;
-            const paramSchemaLikes = hasParamField ? schemaLikes : [field, ...schemaLikes].filter(item => !!item);
-            const paramtypes = appMetadata.getMetadata('design:paramtypes', target, prop);
-            let metaType;
-            if (paramType === 'file') {
-                metaType = z.string().openapi({ format: 'binary' });
-            }
-            else if (paramType === 'files') {
-                metaType = z.array(z.string().openapi({ format: 'binary' }));
-            }
-            else {
-                metaType = paramtypes[index];
-            }
-            const argSchema = makeSchemaLikes(paramSchemaLikes, metaType);
-            argsMeta.push({
-                index,
-                type: paramType,
-                field: paramField,
-                pipes: [argSchema],
-                schema: argSchema,
-                extractValue,
-            });
-        };
-    };
-}

package/dist/lib/index.js

@@ -1,4 +0,0 @@
-export * from "./decorator/index.js";
-export * from "./schema/index.js";
-export * from "./utils.js";
-export * from "./zod/index.js";

package/dist/lib/schema/bodySchemaWrapper.js

@@ -1,8 +0,0 @@
-import { z } from 'zod';
-export function bodySchemaWrapperDefault(bodySchema) {
-    return z.object({
-        code: z.string(),
-        message: z.string(),
-        data: bodySchema,
-    });
-}

package/dist/lib/schema/index.js

@@ -1,4 +0,0 @@
-export * from "./bodySchemaWrapper.js";
-export * from "./makeSchemaLikes.js";
-export * from "./schema.js";
-export * from "./v.js";

package/dist/lib/schema/makeSchemaLikes.js

@@ -1,29 +0,0 @@
-import { cast, isClassStrict } from 'vona';
-import { $schema } from "./schema.js";
-export function makeSchemaLikes(schemaLikes, typeInit) {
-    // default schema
-    let argSchema = $schema(typeInit);
-    // loop
-    for (let index = schemaLikes.length - 1; index >= 0; index--) {
-        const schemaLike = schemaLikes[index];
-        argSchema = makeSchemaLike(schemaLike, argSchema);
-    }
-    return argSchema;
-}
-export function makeSchemaLike(schemaLike, schemaPrevious) {
-    if (!schemaLike)
-        return schemaPrevious;
-    if (Object.prototype.hasOwnProperty.call(schemaLike, 'parseAsync')) {
-        // schema
-        return schemaLike;
-    }
-    else if (isClassStrict(schemaLike) ||
-        ['String', 'Number', 'Boolean', 'Date', 'BigInt', 'Array'].includes(cast(schemaLike).name)) {
-        // class
-        return $schema(cast(schemaLike));
-    }
-    else {
-        // function
-        return cast(schemaLike)(schemaPrevious);
-    }
-}

package/dist/lib/schema/schema.js

@@ -1,40 +0,0 @@
-import { appMetadata, appResource, cast } from 'vona';
-import { z } from 'zod';
-import { SymbolDecoratorRule } from "../../types/decorator.js";
-export function $schema(classType, options) {
-    if (!classType)
-        return z.any();
-    if (classType.parseAsync)
-        return classType;
-    if (classType.name === 'String')
-        return z.string();
-    if (classType.name === 'Number')
-        return z.number();
-    if (classType.name === 'Boolean')
-        return z.boolean();
-    if (classType.name === 'Date')
-        return z.date();
-    if (classType.name === 'BigInt')
-        return z.bigint();
-    if (classType.name === 'Array')
-        return z.array(z.any());
-    // check if object
-    const rules = classType.prototype ? appMetadata.getMetadata(SymbolDecoratorRule, classType.prototype) : undefined;
-    if (!rules) {
-        // not object
-        return z.any();
-    }
-    // object
-    let schema = z.object(rules);
-    if (options?.passthrough)
-        schema = schema.passthrough();
-    if (options?.strict)
-        schema = schema.strict();
-    // refId
-    const beanOptions = appResource.getBean(classType);
-    if (beanOptions) {
-        const openapi = cast(beanOptions.options)?.openapi;
-        schema = schema.openapi(beanOptions.beanFullName, openapi);
-    }
-    return schema;
-}

package/dist/lib/schema/v/helpers.js

@@ -1,36 +0,0 @@
-import { z } from 'zod';
-export function schemaEmail(message) {
-    return function (schema) {
-        return schema.email(message);
-    };
-}
-export function schemaUrl(message) {
-    return function (schema) {
-        return schema.url(message);
-    };
-}
-export function schemaUuid(message) {
-    return function (schema) {
-        return schema.uuid(message);
-    };
-}
-export function schemaIp(options) {
-    return function (schema) {
-        return schema.ip(options);
-    };
-}
-export function schemaMin(min, message) {
-    return function (schema) {
-        return schema.min(min, message);
-    };
-}
-export function schemaMax(max, message) {
-    return function (schema) {
-        return schema.max(max, message);
-    };
-}
-export function schemaTableIdentity() {
-    return function (_schema) {
-        return z.union([z.string(), z.number()]);
-    };
-}

package/dist/lib/schema/v/openapi.js

@@ -1,20 +0,0 @@
-export function schemaOpenapi(refId, metadata) {
-    return function (schema) {
-        return schema.openapi(refId, metadata);
-    };
-}
-export function schemaTitle(title) {
-    return function (schema) {
-        return schema.openapi({ title });
-    };
-}
-export function schemaDescription(description) {
-    return function (schema) {
-        return schema.openapi({ description });
-    };
-}
-export function schemaExample(example) {
-    return function (schema) {
-        return schema.openapi({ example });
-    };
-}

package/dist/lib/schema/v/system.js

@@ -1,34 +0,0 @@
-import { isNil } from '@cabloy/utils';
-import { coerceWithNil } from '@cabloy/zod-query';
-import { z } from 'zod';
-import { makeSchemaLike } from "../makeSchemaLikes.js";
-import { $schema } from "../schema.js";
-export function schemaDefault(defaultValue) {
-    return function (schema) {
-        return schema.default(defaultValue);
-    };
-}
-export function schemaOptional() {
-    return function (schema) {
-        return schema.optional();
-    };
-}
-export function schemaObject(classType, options) {
-    return function (_schema) {
-        return $schema(classType, options);
-    };
-}
-export function schemaArray(schemaLike, params) {
-    return function (schema) {
-        return z.preprocess(val => {
-            val = coerceWithNil(val);
-            if (isNil(val))
-                return val;
-            if (typeof val !== 'string')
-                return val;
-            if (isNil(params?.separator) && val[0] === '[')
-                return JSON.parse(val);
-            return val.split(params?.separator ?? ',');
-        }, z.array(makeSchemaLike(schemaLike ?? schema, z.any()), params));
-    };
-}

package/dist/lib/schema/v.js

@@ -1,22 +0,0 @@
-import { schemaEmail, schemaIp, schemaMax, schemaMin, schemaTableIdentity, schemaUrl, schemaUuid } from "./v/helpers.js";
-import { schemaDescription, schemaExample, schemaOpenapi, schemaTitle } from "./v/openapi.js";
-import { schemaArray, schemaDefault, schemaObject, schemaOptional } from "./v/system.js";
-export const v = {
-    array: schemaArray,
-    default: schemaDefault,
-    object: schemaObject,
-    optional: schemaOptional,
-    // helpers
-    email: schemaEmail,
-    url: schemaUrl,
-    uuid: schemaUuid,
-    ip: schemaIp,
-    min: schemaMin,
-    max: schemaMax,
-    tableIdentity: schemaTableIdentity,
-    // openapi
-    openapi: schemaOpenapi,
-    title: schemaTitle,
-    description: schemaDescription,
-    example: schemaExample,
-};

package/dist/lib/utils.js

@@ -1,43 +0,0 @@
-import { appMetadata, appResource, cast, deepExtend, registerMappedClassMetadataKey } from 'vona';
-import { z } from 'zod';
-import { SymbolDecoratorRule, SymbolDecoratorRuleColumn } from "../types/decorator.js";
-export function getTargetDecoratorRules(target) {
-    registerMappedClassMetadataKey(target, SymbolDecoratorRule, {
-        partialClass: (meta) => {
-            return meta.optional();
-        },
-    });
-    return appMetadata.getOwnMetadataMap(true, SymbolDecoratorRule, target);
-}
-export function getTargetDecoratorRuleColumns(target) {
-    registerMappedClassMetadataKey(target, SymbolDecoratorRuleColumn);
-    return appMetadata.getOwnMetadataMap(true, SymbolDecoratorRuleColumn, target);
-}
-export function mergeFieldsOpenAPIMetadata(target) {
-    // rules
-    const rules = getTargetDecoratorRules(target.prototype);
-    // beanOptions
-    const beanOptions = appResource.getBean(target);
-    const fields = cast(beanOptions?.options)?.fields;
-    if (!fields)
-        return;
-    for (const key in fields) {
-        const field = fields[key];
-        if (!field)
-            continue;
-        const schemaCurrent = rules[key];
-        if (Object.prototype.hasOwnProperty.call(field, 'parseAsync')) {
-            const schema = field;
-            rules[key] = schema.openapi(deepExtend({}, schemaCurrent?._def.openapi?.metadata, schema._def.openapi?.metadata));
-        }
-        else {
-            // use deepExtend for sure strict
-            if (schemaCurrent) {
-                rules[key] = schemaCurrent.openapi(deepExtend({}, schemaCurrent._def.openapi?.metadata, field));
-            }
-            else {
-                rules[key] = z.any().openapi(deepExtend({}, field));
-            }
-        }
-    }
-}

package/dist/lib/zod/errorUtil.js

@@ -1 +0,0 @@
-export {};

package/dist/lib/zod/errorsAdapter.js

@@ -1,9 +0,0 @@
-import { setErrorMapDefault, setErrorMapSchema } from '@cabloy/zod-errors-custom';
-export function errorsAdapter(app) {
-    setErrorMapDefault((text, ...args) => {
-        return app.meta.text(text, ...args);
-    });
-    setErrorMapSchema((text, ...args) => {
-        return app.meta.text(text, ...args);
-    });
-}

package/dist/lib/zod/index.js

@@ -1,2 +0,0 @@
-export * from "./errorsAdapter.js";
-export * from "./errorUtil.js";

package/dist/main.js

@@ -1,9 +0,0 @@
-import { BeanSimple } from 'vona';
-import { errorsAdapter } from "./lib/zod/errorsAdapter.js";
-export class Main extends BeanSimple {
-    async moduleLoading() { }
-    async moduleLoaded() {
-        errorsAdapter(this.app);
-    }
-    async configLoaded(_config) { }
-}