vona-module-a-openapi 5.0.12 → 5.0.14

package/dist/service/openapi.js

@@ -1,352 +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;
-};
-import { OpenApiGeneratorV3, OpenApiGeneratorV31, OpenAPIRegistry } from '@asteasolutions/zod-to-openapi';
-import * as ModuleInfo from '@cabloy/module-info';
-import { isEmptyObject } from '@cabloy/utils';
-import { toUpperCaseFirstChar } from '@cabloy/word-utils';
-import { appMetadata, appResource, BeanBase, cast, HttpStatus, LocaleModuleNameSeparator, } from 'vona';
-import { RequestMethod, Service, SymbolRequestMappingHandler, } from 'vona-module-a-web';
-import { z } from 'zod';
-import { bodySchemaWrapperDefault } from "../lib/schema/bodySchemaWrapper.js";
-import { $schema } from "../lib/schema/schema.js";
-import { SymbolOpenApiOptions } from "../types/api.js";
-import { SymbolRouteHandlersArgumentsMeta } from "../types/decorator.js";
-const __ArgumentTypes = ['param', 'query', 'body', 'headers', 'fields', 'field', 'files', 'file'];
-let ServiceOpenapi = class ServiceOpenapi extends BeanBase {
-    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);
-        return apiObj;
-    }
-    generateJsonOfControllerAction(controller, actionKey, version = 'V31') {
-        const registry = new OpenAPIRegistry();
-        const beanOptions = appResource.getBean(controller);
-        if (!beanOptions)
-            throw new Error('invalid controller');
-        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);
-        return apiObj;
-    }
-    _translate(apiObj) {
-        // paths
-        if (apiObj.paths) {
-            for (const key in apiObj.paths) {
-                const pathObj = apiObj.paths[key];
-                for (const method in pathObj) {
-                    const methodObj = pathObj[method];
-                    this._translateStrings(methodObj, ['description', 'summary']);
-                    // parameters
-                    for (const parameterObj of methodObj.parameters || []) {
-                        this._translateSchema(parameterObj.schema);
-                    }
-                    // requestBody
-                    this._translateSchema(methodObj.requestBody?.content?.['application/json']?.schema);
-                }
-            }
-        }
-        // components
-        if (apiObj.components?.schemas) {
-            for (const key in apiObj.components.schemas) {
-                const schema = apiObj.components.schemas[key];
-                this._translateSchema(schema);
-            }
-        }
-    }
-    _translateSchema(schema) {
-        if (!schema)
-            return;
-        if (schema.type === 'object' && schema.required === undefined)
-            schema.required = [];
-        this._translateStrings(schema, ['title', 'description']);
-        const properties = cast(schema).properties;
-        if (properties && typeof properties === 'object') {
-            for (const prop in properties) {
-                const propObj = properties[prop];
-                this._translateSchema(propObj);
-            }
-        }
-    }
-    _translateStrings(obj, keys) {
-        for (const key of keys) {
-            this._translateString(obj, key);
-        }
-    }
-    _translateString(obj, key) {
-        if (!obj)
-            return;
-        if (obj[key] && obj[key].includes(LocaleModuleNameSeparator)) {
-            obj[key] = this.app.meta.text(obj[key]);
-        }
-    }
-    _collectRegistry() {
-        const registry = new OpenAPIRegistry();
-        // securitySchemes
-        const configSecuritySchemes = this.scope.config.securitySchemes;
-        for (const key in configSecuritySchemes) {
-            let securityScheme = configSecuritySchemes[key];
-            if (typeof securityScheme === 'function') {
-                securityScheme = securityScheme.call(this.app);
-            }
-            registry.registerComponent('securitySchemes', key, securityScheme);
-        }
-        // schema: independent
-        for (const sceneName of ['dto', 'entity']) {
-            const onionSlices = this.bean.onion[sceneName].getOnionsEnabled();
-            for (const onionSlice of onionSlices) {
-                if (onionSlice.beanOptions.options?.independent) {
-                    const schema = $schema(onionSlice.beanOptions.beanClass);
-                    registry.register(onionSlice.beanOptions.beanFullName, schema);
-                }
-            }
-        }
-        // controller
-        for (const controller of this.bean.onion.controller.getOnionsEnabled()) {
-            this._collectController(registry, controller.beanOptions.module, controller.beanOptions.beanClass);
-        }
-        return registry;
-    }
-    _collectController(registry, moduleName, controller, actionKey) {
-        // info
-        const info = ModuleInfo.parseInfo(moduleName);
-        // controller options
-        const beanOptions = appResource.getBean(controller);
-        if (!beanOptions)
-            return;
-        const controllerBeanFullName = beanOptions.beanFullName;
-        const controllerOptions = beanOptions.options;
-        const controllerPath = controllerOptions.path;
-        const controllerOpenApiOptions = appMetadata.getMetadata(SymbolOpenApiOptions, controller);
-        if (controllerOpenApiOptions?.exclude)
-            return;
-        // descs
-        const descs = Object.getOwnPropertyDescriptors(controller.prototype);
-        const actionKeys = actionKey ? [actionKey] : Object.keys(descs);
-        for (const actionKey of actionKeys) {
-            const desc = descs[actionKey];
-            if (['constructor'].includes(actionKey))
-                continue;
-            if (!desc.value || typeof desc.value !== 'function')
-                continue;
-            this._registerControllerAction(registry, info, controller, beanOptions, controllerBeanFullName, controllerPath, controllerOpenApiOptions, actionKey, desc);
-        }
-    }
-    _registerControllerAction(registry, info, controller, beanOptions, _controllerBeanFullName, controllerPath, controllerOpenApiOptions, actionKey, _desc) {
-        // app
-        const app = this.app;
-        // action options: should not extend controllerOpenApiOptions
-        const actionOpenApiOptions = appMetadata.getMetadata(SymbolOpenApiOptions, controller.prototype, actionKey);
-        if (actionOpenApiOptions?.exclude)
-            return;
-        // actionPath/actionMethod
-        if (!appMetadata.hasMetadata(SymbolRequestMappingHandler, controller.prototype, actionKey))
-            return;
-        const handlerMetadata = appMetadata.getMetadata(SymbolRequestMappingHandler, controller.prototype, actionKey);
-        const actionPath = handlerMetadata.path || '';
-        const actionMethod = handlerMetadata.method || RequestMethod.GET;
-        // routePath
-        const routePath = app.util.combineApiPathControllerAndAction(info.relativeName, controllerPath, actionPath, true, true);
-        // :id -> {id}
-        const routePath2 = routePath.replace(/:([^/]+)/g, '{$1}');
-        // tags
-        let tags = actionOpenApiOptions?.tags ?? controllerOpenApiOptions?.tags;
-        if (!tags || tags.length === 0) {
-            tags = [toUpperCaseFirstChar(this.app.util.combineResourceName(beanOptions.name, info.relativeName, true, true))];
-        }
-        // operationId
-        let operationId = actionOpenApiOptions?.operationId ?? actionKey;
-        operationId = `${tags[0]}_${operationId}`;
-        // security
-        const _public = actionOpenApiOptions?.public ?? controllerOpenApiOptions?.public;
-        let security;
-        if (!_public) {
-            security = [
-                {
-                    bearerAuth: [],
-                },
-            ];
-        }
-        // registerPath
-        registry.registerPath({
-            tags,
-            method: actionMethod,
-            path: routePath2,
-            operationId,
-            security,
-            description: actionOpenApiOptions?.description,
-            summary: actionOpenApiOptions?.summary,
-            request: this._collectRequest(controller, actionKey, actionOpenApiOptions, controllerOpenApiOptions),
-            responses: this._collectResponses(controller, actionKey, actionOpenApiOptions),
-        });
-    }
-    _collectRequest(controller, actionKey, actionOpenApiOptions, controllerOpenApiOptions) {
-        // meta
-        const argsMeta = this._prepareArgsMeta(controller, actionKey, actionOpenApiOptions, controllerOpenApiOptions);
-        if (!argsMeta)
-            return;
-        // args
-        const argsMapWithField = {};
-        const argsMapIsolate = {};
-        let isUpload;
-        for (const argMeta of argsMeta) {
-            if (!__ArgumentTypes.includes(argMeta.type))
-                continue;
-            if (['fields', 'field', 'files', 'file'].includes(argMeta.type)) {
-                isUpload = true;
-            }
-            if (argMeta.field) {
-                if (!argsMapWithField[argMeta.type]) {
-                    argsMapWithField[argMeta.type] = {};
-                }
-                argsMapWithField[argMeta.type][argMeta.field] = argMeta.schema;
-            }
-            else {
-                if (!argsMapIsolate[argMeta.type]) {
-                    argsMapIsolate[argMeta.type] = argMeta.schema;
-                }
-            }
-        }
-        // request
-        const request = {};
-        if (isUpload) {
-            const schemaObj = {};
-            // not check argsMapIsolate.fields
-            if (argsMapWithField.fields)
-                Object.assign(schemaObj, argsMapWithField.fields);
-            if (argsMapWithField.field)
-                Object.assign(schemaObj, argsMapWithField.field);
-            if (argsMapWithField.files)
-                Object.assign(schemaObj, argsMapWithField.files);
-            if (argsMapWithField.file)
-                Object.assign(schemaObj, argsMapWithField.file);
-            if (argsMapIsolate.files)
-                schemaObj.blobs = argsMapIsolate.files;
-            const schema = z.object(schemaObj);
-            // body
-            request.body = {
-                required: true,
-                content: {
-                    'multipart/form-data': {
-                        schema,
-                    },
-                },
-            };
-        }
-        else {
-            for (const argumentType of __ArgumentTypes) {
-                let schema = argsMapIsolate[argumentType];
-                if (argsMapWithField[argumentType]) {
-                    if (!schema) {
-                        schema = z.object(argsMapWithField[argumentType]);
-                    }
-                    else {
-                        schema = schema.extend(argsMapWithField[argumentType]);
-                    }
-                }
-                if (!schema)
-                    continue;
-                // record
-                if (argumentType === 'body') {
-                    // body
-                    request.body = {
-                        required: !schema.isOptional(),
-                        content: {
-                            'application/json': {
-                                schema,
-                            },
-                        },
-                    };
-                }
-                else {
-                    // others
-                    const name = argumentType === 'param' ? 'params' : argumentType;
-                    request[name] = schema;
-                }
-            }
-        }
-        return request;
-    }
-    _collectResponses(controller, actionKey, actionOpenApiOptions) {
-        // contentType
-        const contentType = actionOpenApiOptions?.contentType || 'application/json';
-        // body schema
-        const bodySchema = this._parseBodySchema(controller, actionKey, actionOpenApiOptions, contentType);
-        // response
-        const response = {
-            description: '',
-            content: {
-                [contentType]: {
-                    schema: bodySchema,
-                },
-            },
-        };
-        // responses
-        const responses = { [HttpStatus.OK]: response };
-        return responses;
-    }
-    _parseBodySchema(controller, actionKey, actionOpenApiOptions, contentType) {
-        // bodySchema
-        let bodySchema;
-        if (actionOpenApiOptions?.bodySchema) {
-            bodySchema = actionOpenApiOptions.bodySchema;
-        }
-        else {
-            const metaType = appMetadata.getDesignReturntype(controller.prototype, actionKey);
-            bodySchema = $schema(metaType);
-        }
-        // wrapper
-        if (contentType !== 'application/json')
-            return bodySchema;
-        if (actionOpenApiOptions?.bodySchemaWrapper === false)
-            return bodySchema;
-        const wrapper = actionOpenApiOptions?.bodySchemaWrapper ?? bodySchemaWrapperDefault;
-        return wrapper(bodySchema);
-    }
-    _prepareArgsMeta(controller, actionKey, actionOpenApiOptions, controllerOpenApiOptions) {
-        // meta
-        let argsMeta = appMetadata.getMetadata(SymbolRouteHandlersArgumentsMeta, controller.prototype, actionKey);
-        // headers
-        const objHeaders = Object.assign({}, this._combineArgHeaders(controllerOpenApiOptions?.headers), this._combineArgHeaders(actionOpenApiOptions?.headers));
-        // public
-        const _public = actionOpenApiOptions?.public ?? controllerOpenApiOptions?.public;
-        if (!_public && !objHeaders.Authorization) {
-            objHeaders.Authorization = z.string().optional();
-        }
-        if (isEmptyObject(objHeaders))
-            return argsMeta;
-        // merge
-        if (!argsMeta)
-            argsMeta = [];
-        let argHeaders = argsMeta.find(item => item.type === 'headers' && !item.field);
-        if (!argHeaders) {
-            argHeaders = { type: 'headers', field: undefined, schema: z.object(objHeaders) };
-            argsMeta.push(argHeaders);
-        }
-        else {
-            if (!argHeaders.schema.extend)
-                throw new Error(`headers schema is not valid: ${actionKey}`);
-            argHeaders.schema = argHeaders.schema.extend(objHeaders);
-        }
-        return argsMeta;
-    }
-    _combineArgHeaders(headers) {
-        if (!headers)
-            return;
-        const objHeaders = {};
-        for (const header of headers) {
-            objHeaders[header.name] = z.string().openapi({ description: header.description });
-        }
-        return objHeaders;
-    }
-};
-ServiceOpenapi = __decorate([
-    Service()
-], ServiceOpenapi);
-export { ServiceOpenapi };

package/dist/types/actions.js

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

package/dist/types/api.js

@@ -1 +0,0 @@
-export const SymbolOpenApiOptions = Symbol('SymbolOpenApiOptions');

package/dist/types/behavior.js

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

package/dist/types/component.js

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

package/dist/types/database.js

@@ -1,4 +0,0 @@
-export const OrderCoreBase = 100;
-export const OrderBusinessBase = 1000;
-export const OrderUnknownBase = 10000;
-export const OrderMaxBase = 100000;

package/dist/types/decorator.js

@@ -1,4 +0,0 @@
-export const SymbolDecoratorRule = Symbol('SymbolDecoratorRule');
-export const SymbolDecoratorRuleColumn = Symbol('SymbolDecoratorRuleColumn');
-export const SymbolRouteHandlersArgumentsMeta = Symbol('SymbolRouteHandlersArgumentsMeta');
-export const SymbolRouteHandlersArgumentsValue = Symbol('SymbolRouteHandlersArgumentsValue');

package/dist/types/index.js

@@ -1,8 +0,0 @@
-import '@cabloy/zod-query';
-export * from "./actions.js";
-export * from "./api.js";
-export * from "./behavior.js";
-export * from "./component.js";
-export * from "./database.js";
-export * from "./decorator.js";
-export * from "./rest.js";

package/dist/types/rest.js

@@ -1,2 +0,0 @@
-import 'openapi3-ts/oas30';
-import 'openapi3-ts/oas31';