@avleon/core 0.0.39 → 0.0.42-rc0.1

package/dist/icore.js

@@ -62,6 +62,8 @@ const socket_io_1 = require("socket.io");
 const event_subscriber_1 = require("./event-subscriber");
 const stream_1 = __importDefault(require("stream"));
 const kenx_provider_1 = require("./kenx-provider");
+const controller_1 = require("./controller");
+const mime_1 = __importDefault(require("mime"));
 const isTsNode = process.env.TS_NODE_DEV ||
     process.env.TS_NODE_PROJECT ||
     process[Symbol.for("ts-node.register.instance")];
@@ -112,6 +114,17 @@ class AvleonApplication {
         }
         return AvleonApplication.instance;
     }
+    useLogger(corsOptions) {
+        let coptions = {};
+        if (corsOptions) {
+            if (this._isConfigClass(corsOptions)) {
+                coptions = this.appConfig.get(corsOptions);
+            }
+            else {
+                coptions = corsOptions;
+            }
+        }
+    }
     isDevelopment() {
         const env = container_1.default.get(environment_variables_1.Environment);
         return env.get("NODE_ENV") == "development";
@@ -128,7 +141,7 @@ class AvleonApplication {
         if (options.ui && options.ui == "scalar") {
             const scalarPlugin = (0, utils_1.optionalRequire)("@scalar/fastify-api-reference", {
                 failOnMissing: true,
-                customMessage: "Install \"@scalar/fastify-api-reference\" to enable API docs.\n\n  npm install @scalar/fastify-api-reference",
+                customMessage: 'Install "@scalar/fastify-api-reference" to enable API docs.\n\n  npm install @scalar/fastify-api-reference',
             });
             await this.app.register(scalarPlugin, {
                 routePrefix: rPrefix,
@@ -147,7 +160,7 @@ class AvleonApplication {
         else {
             const fastifySwaggerUi = (0, utils_1.optionalRequire)("@fastify/swagger-ui", {
                 failOnMissing: true,
-                customMessage: "Install \"@fastify/swagger-ui\" to enable API docs.\n\n  npm install @fastify/swagger-ui",
+                customMessage: 'Install "@fastify/swagger-ui" to enable API docs.\n\n  npm install @fastify/swagger-ui',
             });
             await this.app.register(fastifySwaggerUi, {
                 logo: logo ? logo : null,
@@ -181,7 +194,7 @@ class AvleonApplication {
     async _initWebSocket(options) {
         const fsSocketIO = (0, utils_1.optionalRequire)("fastify-socket.io", {
             failOnMissing: true,
-            customMessage: "Install \"fastify-socket.io\" to enable socket.io.\n\n run pnpm install fastify-socket.io",
+            customMessage: 'Install "fastify-socket.io" to enable socket.io.\n\n run pnpm install fastify-socket.io',
         });
         await this.app.register(fsSocketIO, options);
         const socketIO = await this.app.io;
@@ -209,8 +222,8 @@ class AvleonApplication {
         if (multipartOptions) {
             this.multipartOptions = multipartOptions;
             this.app.register(multipart_1.default, {
-                ...this.multipartOptions,
                 attachFieldsToBody: true,
+                ...this.multipartOptions,
             });
         }
     }
@@ -281,6 +294,7 @@ class AvleonApplication {
      * @returns void
      */
     async buildController(controller) {
+        var _a, _b;
         const ctrl = typedi_1.default.get(controller);
         const controllerMeta = Reflect.getMetadata(container_1.CONTROLLER_META_KEY, ctrl.constructor);
         if (!controllerMeta)
@@ -318,10 +332,39 @@ class AvleonApplication {
             if (!swaggerMeta.body && bodySchema) {
                 schema = { ...schema, body: bodySchema };
             }
+            // const isMultipart =
+            //   schema.consumes?.includes('multipart/form-data') ||
+            //   (schema.body && schema.body.type === 'object' &&
+            //   Object.values(schema.body.properties || {}).some((p: any) => p.format === 'binary'));
+            const isMultipart = ((_a = schema === null || schema === void 0 ? void 0 : schema.consumes) === null || _a === void 0 ? void 0 : _a.includes("multipart/form-data")) ||
+                Object.values(((_b = schema === null || schema === void 0 ? void 0 : schema.body) === null || _b === void 0 ? void 0 : _b.properties) || {}).some((p) => p.format === "binary");
+            // Prepare the route schema
+            let routeSchema = schema;
+            if (isMultipart) {
+                schema.consumes = ["multipart/form-data"];
+                if (!schema.body) {
+                    schema.body = {
+                        type: "object",
+                        properties: {},
+                    };
+                }
+                for (const param of allMeta.body) {
+                    if (param.type == "route:file") {
+                        schema.body.properties[param.key] = {
+                            type: "string",
+                            format: "binary",
+                        };
+                    }
+                    else {
+                        schema.body.properties[param.key] = { type: param.dataType };
+                    }
+                }
+            }
             this.app.route({
                 url: routePath,
                 method: methodmetaOptions.method.toUpperCase(),
-                schema: { ...schema },
+                schema: routeSchema,
+                attachValidation: isMultipart,
                 handler: async (req, res) => {
                     let reqClone = req;
                     // class level authrization
@@ -368,23 +411,25 @@ class AvleonApplication {
                             (0, validation_1.validateOrThrow)({ [queryMeta.key]: args[queryMeta.index] }, { [queryMeta.key]: { type: queryMeta.dataType } }, { location: "queryparam" });
                         }
                     }
-                    for (let bodyMeta of allMeta.body) {
-                        if (bodyMeta.validatorClass) {
-                            const err = await (0, helpers_1.validateObjectByInstance)(bodyMeta.dataType, args[bodyMeta.index]);
-                            if (err) {
-                                return await res.code(400).send({
-                                    code: 400,
-                                    error: "ValidationError",
-                                    errors: err,
-                                    message: err.message,
-                                });
+                    if (!isMultipart) {
+                        for (let bodyMeta of allMeta.body) {
+                            if (bodyMeta.validatorClass) {
+                                const err = await (0, helpers_1.validateObjectByInstance)(bodyMeta.dataType, args[bodyMeta.index]);
+                                if (err) {
+                                    return await res.code(400).send({
+                                        code: 400,
+                                        error: "ValidationError",
+                                        errors: err,
+                                        message: err.message,
+                                    });
+                                }
                             }
                         }
                     }
                     const result = await prototype[method].apply(ctrl, args);
                     // Custom wrapped file download
-                    if (result === null || result === void 0 ? void 0 : result.__isFileDownload) {
-                        const { stream, filename, contentType = "application/octet-stream", } = result;
+                    if (result === null || result === void 0 ? void 0 : result.download) {
+                        const { stream, filename } = result;
                         if (!stream || typeof stream.pipe !== "function") {
                             return res.code(500).send({
                                 code: 500,
@@ -392,6 +437,9 @@ class AvleonApplication {
                                 message: "Invalid stream object",
                             });
                         }
+                        const contentType = result.contentType ||
+                            mime_1.default.getType(filename) ||
+                            "application/octet-stream";
                         res.header("Content-Type", contentType);
                         res.header("Content-Disposition", `attachment; filename="${filename}"`);
                         stream.on("error", (err) => {
@@ -427,61 +475,128 @@ class AvleonApplication {
         }
     }
     /**
-     * map all request parameters
-     * @param req
-     * @param meta
-     * @returns
+     * Maps request data to controller method arguments based on decorators
+     * @param req - The incoming request object
+     * @param meta - Metadata about method parameters
+     * @returns Array of arguments to pass to the controller method
      */
     async _mapArgs(req, meta) {
-        var _a;
+        var _a, _b, _c, _d;
+        // Initialize args cache on request if not present
         if (!req.hasOwnProperty("_argsCache")) {
             Object.defineProperty(req, "_argsCache", {
                 value: new Map(),
                 enumerable: false,
+                writable: false,
+                configurable: false,
             });
         }
         const cache = req._argsCache;
-        const cacheKey = JSON.stringify(meta); // Faster key-based lookup
+        const cacheKey = JSON.stringify(meta);
+        // Return cached result if available
         if (cache.has(cacheKey)) {
             return cache.get(cacheKey);
         }
-        const args = meta.params.map((p) => req.params[p.key] || null);
-        meta.query.forEach((q) => (args[q.index] = q.key === "all" ? req.query : req.query[q.key]));
-        meta.body.forEach((body) => (args[body.index] = { ...req.body, ...req.formData }));
-        meta.currentUser.forEach((user) => (args[user.index] = req.user));
-        meta.headers.forEach((header) => (args[header.index] =
-            header.key === "all" ? req.headers : req.headers[header.key]));
-        if (meta.file) {
-            for await (let f of meta.file) {
-                args[f.index] = await req.file();
-            }
+        // Initialize args array with correct length
+        const maxIndex = Math.max(...meta.params.map((p) => p.index || 0), ...meta.query.map((q) => q.index), ...meta.body.map((b) => b.index), ...meta.currentUser.map((u) => u.index), ...meta.headers.map((h) => h.index), ...(((_a = meta.request) === null || _a === void 0 ? void 0 : _a.map((r) => r.index)) || []), ...(((_b = meta.file) === null || _b === void 0 ? void 0 : _b.map((f) => f.index)) || []), ...(((_c = meta.files) === null || _c === void 0 ? void 0 : _c.map((f) => f.index)) || []), -1) + 1;
+        const args = new Array(maxIndex).fill(undefined);
+        // Map route parameters
+        meta.params.forEach((p) => {
+            args[p.index] =
+                p.key == "all" ? { ...req.query } : req.params[p.key] || null;
+        });
+        // Map query parameters
+        meta.query.forEach((q) => {
+            args[q.index] = q.key == "all" ? { ...req.query } : req.query[q.key];
+        });
+        // Map body data (including form data)
+        meta.body.forEach((body) => {
+            args[body.index] = { ...req.body, ...req.formData };
+        });
+        // Map current user
+        meta.currentUser.forEach((user) => {
+            args[user.index] = req.user;
+        });
+        // Map headers
+        meta.headers.forEach((header) => {
+            args[header.index] =
+                header.key === "all" ? { ...req.headers } : req.headers[header.key];
+        });
+        // Map request object
+        if (meta.request && meta.request.length > 0) {
+            meta.request.forEach((r) => {
+                args[r.index] = req;
+            });
         }
-        if (meta.files &&
-            ((_a = req.headers["content-type"]) === null || _a === void 0 ? void 0 : _a.startsWith("multipart/form-data")) === true) {
+        // Handle file uploads (single or multiple files)
+        const needsFiles = (meta.file && meta.file.length > 0) ||
+            (meta.files && meta.files.length > 0);
+        if (needsFiles &&
+            ((_d = req.headers["content-type"]) === null || _d === void 0 ? void 0 : _d.startsWith("multipart/form-data"))) {
             const files = await req.saveRequestFiles();
             if (!files || files.length === 0) {
-                throw new exceptions_1.BadRequestException({ error: "No files uploaded" });
+                // Only throw error if files are explicitly required
+                if (meta.files && meta.files.length > 0) {
+                    throw new exceptions_1.BadRequestException({ error: "No files uploaded" });
+                }
+                // For single file (@File()), set to null
+                if (meta.file && meta.file.length > 0) {
+                    meta.file.forEach((f) => {
+                        args[f.index] = null;
+                    });
+                }
             }
-            const fileInfo = files.map((file) => ({
-                type: file.type,
-                filepath: file.filepath,
-                fieldname: file.fieldname,
-                filename: file.filename,
-                encoding: file.encoding,
-                mimetype: file.mimetype,
-                fields: file.fields,
-            }));
-            for await (let f of meta.files) {
-                const findex = fileInfo.findIndex((x) => x.fieldname == f.fieldName);
-                if (f.fieldName != "all" && findex == -1) {
-                    throw new exceptions_1.BadRequestException(`${f.fieldName} doesn't exists in request files tree.`);
+            else {
+                // Create file info objects
+                const fileInfo = files.map((file) => ({
+                    type: file.type,
+                    filepath: file.filepath,
+                    fieldname: file.fieldname,
+                    filename: file.filename,
+                    encoding: file.encoding,
+                    mimetype: file.mimetype,
+                    fields: file.fields,
+                }));
+                // Handle single file decorator (@File())
+                if (meta.file && meta.file.length > 0) {
+                    meta.file.forEach((f) => {
+                        if (f.fieldName === "all") {
+                            // Return first file if "all" is specified
+                            args[f.index] = fileInfo[0] || null;
+                        }
+                        else {
+                            // Find specific file by fieldname
+                            const file = fileInfo.find((x) => x.fieldname === f.fieldName);
+                            if (!file) {
+                                throw new exceptions_1.BadRequestException(`File field "${f.fieldName}" not found in uploaded files`);
+                            }
+                            args[f.index] = file;
+                        }
+                    });
+                }
+                if (meta.files && meta.files.length > 0) {
+                    meta.files.forEach((f) => {
+                        if (f.fieldName === "all") {
+                            args[f.index] = fileInfo;
+                        }
+                        else {
+                            const matchingFiles = fileInfo.filter((x) => x.fieldname === f.fieldName);
+                            if (matchingFiles.length === 0) {
+                                throw new exceptions_1.BadRequestException(`No files found for field "${f.fieldName}"`);
+                            }
+                            args[f.index] = matchingFiles;
+                        }
+                    });
                 }
-                args[f.index] =
-                    f.fieldName == "all"
-                        ? fileInfo
-                        : fileInfo.filter((x) => x.fieldname == f.fieldName);
             }
         }
+        else if (needsFiles) {
+            // Files expected but request is not multipart/form-data
+            throw new exceptions_1.BadRequestException({
+                error: "Invalid content type. Expected multipart/form-data for file uploads",
+            });
+        }
+        // Cache the result
         cache.set(cacheKey, args);
         return args;
     }
@@ -497,6 +612,7 @@ class AvleonApplication {
             return this.metaCache.get(cacheKey);
         }
         const meta = {
+            request: Reflect.getMetadata(controller_1.REQUEST_METADATA_KEY, prototype, method) || [],
             params: Reflect.getMetadata(container_1.PARAM_META_KEY, prototype, method) || [],
             query: Reflect.getMetadata(container_1.QUERY_META_KEY, prototype, method) || [],
             body: Reflect.getMetadata(container_1.REQUEST_BODY_META_KEY, prototype, method) || [],
@@ -557,7 +673,7 @@ class AvleonApplication {
         if (this.controllers.length > 0) {
             for (let controller of this.controllers) {
                 if ((0, container_1.isApiController)(controller)) {
-                    this.buildController(controller);
+                    await this.buildController(controller);
                 }
                 else {
                     throw new system_exception_1.SystemUseError("Not a api controller.");
@@ -677,7 +793,7 @@ class AvleonApplication {
         this.rMap.forEach((value, key) => {
             const [m, r] = key.split(":");
             this.app.route({
-                method: m,
+                method: m.toUpperCase(),
                 url: r,
                 schema: value.schema || {},
                 preHandler: value.middlewares ? value.middlewares : [],
@@ -687,19 +803,6 @@ class AvleonApplication {
                 },
             });
         });
-        this.app.setErrorHandler(async (error, req, res) => {
-            const handledErr = this._handleError(error);
-            if (error instanceof exceptions_1.ValidationErrorException ||
-                error instanceof exceptions_1.BadRequestException) {
-                return res.status(handledErr.code).send({
-                    code: handledErr.code,
-                    error: handledErr.error,
-                    errors: handledErr.message,
-                });
-            }
-            return res.status(handledErr.code).send(handledErr);
-        });
-        await this.app.ready();
         if (this._hasWebsocket) {
             await this.app.io.on("connection", this.handleSocket);
             await this.app.io.use((socket, next) => {
@@ -714,6 +817,25 @@ class AvleonApplication {
                 }
             });
         }
+        this.app.setErrorHandler((error, request, reply) => {
+            if (error instanceof exceptions_1.BaseHttpException) {
+                const response = {
+                    code: error.code,
+                    status: "Error",
+                    data: error.payload,
+                };
+                return reply
+                    .status(error.code || 500)
+                    .type("application/json")
+                    .serializer((payload) => JSON.stringify(payload))
+                    .send(response);
+            }
+            return reply.status(500).send({
+                code: 500,
+                message: error.message || "Internal Server Error",
+            });
+        });
+        await this.app.ready();
         await this.app.listen({ port });
         console.log(`Application running on http://127.0.0.1:${port}`);
     }
@@ -723,7 +845,7 @@ class AvleonApplication {
             this.rMap.forEach((value, key) => {
                 const [m, r] = key.split(":");
                 this.app.route({
-                    method: m,
+                    method: m.toUpperCase(),
                     url: r,
                     schema: value.schema || {},
                     preHandler: value.middlewares ? value.middlewares : [],

package/dist/icore.test.d.ts

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

package/dist/icore.test.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const icore_1 = require("./icore");
+describe("Avleon.createApplication", () => {
+    it("should return an instance of AvleonApplication", () => {
+        const app = icore_1.Avleon.createApplication();
+        expect(app).toBeInstanceOf(icore_1.AvleonApplication);
+    });
+    it("should always return the same instance (singleton)", () => {
+        const app1 = icore_1.Avleon.createApplication();
+        const app2 = icore_1.Avleon.createApplication();
+        expect(app1).toBe(app2);
+    });
+});

package/dist/index.d.ts

@@ -28,4 +28,28 @@ export * from "./event-dispatcher";
 export * from "./kenx-provider";
 export { Subscribe, Private } from "./event-subscriber";
 export declare const GetSchema: typeof sw.generateSwaggerSchema;
+export declare const GetObjectSchema: typeof sw.CreateSwaggerObjectSchema;
+export declare const OpenApiOk: (args1: any) => {
+    description: string;
+    content: {
+        "application/json": {
+            schema: {
+                type: string;
+                properties: {
+                    code: {
+                        type: string;
+                        example: number;
+                    };
+                    status: {
+                        type: string;
+                        example: string;
+                    };
+                    data: any;
+                };
+            };
+        };
+    };
+};
+export declare const OpenApiResponse: typeof sw.OpenApiResponse;
+export declare const OpenApiProperty: typeof sw.OpenApiProperty;
 export { default as AvleonContainer } from "./container";

package/dist/index.js

@@ -39,7 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AvleonContainer = exports.GetSchema = exports.Private = exports.Subscribe = exports.exclude = exports.pick = exports.validateRequestBody = exports.inject = void 0;
+exports.AvleonContainer = exports.OpenApiProperty = exports.OpenApiResponse = exports.OpenApiOk = exports.GetObjectSchema = exports.GetSchema = exports.Private = exports.Subscribe = exports.exclude = exports.pick = exports.validateRequestBody = exports.inject = void 0;
 /**
  * @copyright 2024
  * @author Tareq Hossain
@@ -76,5 +76,12 @@ var event_subscriber_1 = require("./event-subscriber");
 Object.defineProperty(exports, "Subscribe", { enumerable: true, get: function () { return event_subscriber_1.Subscribe; } });
 Object.defineProperty(exports, "Private", { enumerable: true, get: function () { return event_subscriber_1.Private; } });
 exports.GetSchema = sw.generateSwaggerSchema;
+exports.GetObjectSchema = sw.CreateSwaggerObjectSchema;
+const OpenApiOk = (args1) => {
+    return sw.OpenApiResponse(200, args1, "Success");
+};
+exports.OpenApiOk = OpenApiOk;
+exports.OpenApiResponse = sw.OpenApiResponse;
+exports.OpenApiProperty = sw.OpenApiProperty;
 var container_1 = require("./container");
 Object.defineProperty(exports, "AvleonContainer", { enumerable: true, get: function () { return __importDefault(container_1).default; } });

package/dist/kenx-provider.test.d.ts

@@ -0,0 +1 @@
+import "reflect-metadata";

package/dist/kenx-provider.test.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("reflect-metadata");
+const typedi_1 = require("typedi");
+const kenx_provider_1 = require("./kenx-provider");
+jest.mock("knex", () => jest.fn(() => ({ mock: "knexInstance" })));
+describe("DB", () => {
+    beforeEach(() => {
+        typedi_1.Container.reset();
+    });
+    it("should throw error if client is accessed before init", () => {
+        const db = new kenx_provider_1.DB();
+        expect(() => db.client).toThrow("Knex is not initialized. Call DB.init(config) first.");
+    });
+    it("should initialize knex and set connection", () => {
+        const db = new kenx_provider_1.DB();
+        const config = { client: "sqlite3", connection: {} };
+        const conn = db.init(config);
+        expect(conn).toEqual({ mock: "knexInstance" });
+        expect(db.client).toEqual({ mock: "knexInstance" });
+        expect(typedi_1.Container.get("KnexConnection")).toEqual({ mock: "knexInstance" });
+    });
+    it("should use existing connection from Container", () => {
+        const existingConn = { mock: "existingKnex" };
+        typedi_1.Container.set("KnexConnection", existingConn);
+        const db = new kenx_provider_1.DB();
+        expect(db.client).toBe(existingConn);
+    });
+    // it("should not reinitialize if connection exists", () => {
+    //     const db = new DB();
+    //     const config = { client: "sqlite3", connection: {} };
+    //     db.init(config as Knex.Config);
+    //     const conn2 = db.init(config as Knex.Config);
+    //     expect(conn2).toEqual({ mock: "knexInstance" });
+    // });
+});

package/dist/logger.test.d.ts

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

package/dist/logger.test.js

@@ -0,0 +1,42 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const logger_1 = require("./logger");
+const pino_1 = __importDefault(require("pino"));
+jest.mock("pino");
+describe("LoggerService constructor", () => {
+    const mockPino = pino_1.default;
+    beforeEach(() => {
+        mockPino.mockClear();
+    });
+    it("should initialize logger with default level 'info' when LOG_LEVEL is not set", () => {
+        delete process.env.LOG_LEVEL;
+        new logger_1.LoggerService();
+        expect(mockPino).toHaveBeenCalledWith({
+            level: "info",
+            transport: {
+                target: "pino-pretty",
+                options: {
+                    translateTime: "SYS:standard",
+                    ignore: "pid,hostname",
+                },
+            },
+        });
+    });
+    it("should initialize logger with LOG_LEVEL from environment", () => {
+        process.env.LOG_LEVEL = "debug";
+        new logger_1.LoggerService();
+        expect(mockPino).toHaveBeenCalledWith({
+            level: "debug",
+            transport: {
+                target: "pino-pretty",
+                options: {
+                    translateTime: "SYS:standard",
+                    ignore: "pid,hostname",
+                },
+            },
+        });
+    });
+});

package/dist/middleware.d.ts

@@ -14,6 +14,9 @@ export type AuthReturnTypes = IRequest | Promise<IRequest>;
 interface AuthorizeClass {
     authorize(req: IRequest, options?: any): AuthReturnTypes;
 }
+export declare function CanAuthorize(target: {
+    new (...args: any[]): AuthorizeClass;
+}): void;
 export declare function AppAuthorization(target: {
     new (...args: any[]): AuthorizeClass;
 }): void;

package/dist/middleware.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.AuthorizeMiddleware = exports.AvleonMiddleware = void 0;
+exports.CanAuthorize = CanAuthorize;
 exports.AppAuthorization = AppAuthorization;
 exports.Authorized = Authorized;
 exports.AppMiddleware = AppMiddleware;
@@ -19,6 +20,12 @@ exports.AvleonMiddleware = AvleonMiddleware;
 class AuthorizeMiddleware {
 }
 exports.AuthorizeMiddleware = AuthorizeMiddleware;
+function CanAuthorize(target) {
+    if (typeof target.prototype.authorize !== "function") {
+        throw new Error(`Class "${target.name}" must implement an "authorize" method.`);
+    }
+    (0, typedi_1.Service)()(target);
+}
 function AppAuthorization(target) {
     if (typeof target.prototype.authorize !== "function") {
         throw new Error(`Class "${target.name}" must implement an "authorize" method.`);

package/dist/middleware.test.d.ts

@@ -0,0 +1 @@
+import "reflect-metadata";