@avleon/core 0.0.46 → 0.0.48

package/dist/collection.test.js

@@ -1,59 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const collection_1 = require("./collection");
-describe("Collection", () => {
-    let collection;
-    beforeEach(() => {
-        collection = collection_1.Collection.from([
-            {
-                id: 1,
-                body: "test 1",
-                completed: false,
-            },
-            {
-                id: 2,
-                body: "test 2",
-                completed: true,
-            },
-            {
-                id: 3,
-                body: "test 2",
-                completed: true,
-            },
-        ]);
-    });
-    afterEach(() => {
-        collection.clear();
-    });
-    describe("find()", () => {
-        it("should be return collection", () => {
-            const result = collection.find();
-            expect(result).toHaveProperty("length");
-            expect(result.length).toBe(3);
-        });
-        it("should return only completed task", () => {
-            const result = collection.find((todo) => todo.completed);
-            expect(result).toHaveProperty("length");
-            expect(result.length).toBe(2);
-            expect(result[0].id).toBe(2);
-        });
-    });
-    describe("findOne()", () => {
-        it("should be return todo", () => {
-            const result = collection.findOne({ where: { id: 1 } });
-            expect(result).toHaveProperty("id");
-            expect(result === null || result === void 0 ? void 0 : result.id).toBe(1);
-        });
-        it("should return only completed task", () => {
-            const result = collection.findOne({
-                where: {
-                    id: {
-                        $in: [3],
-                    },
-                },
-            });
-            expect(result).toHaveProperty("id");
-            expect(result === null || result === void 0 ? void 0 : result.completed).toBe(true);
-        });
-    });
-});

package/dist/config.d.ts

@@ -1,18 +0,0 @@
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
-import { Constructable } from "typedi";
-import { Environment } from "./environment-variables";
-export interface IConfig<T = any> {
-    config(env: Environment): T;
-}
-export declare function AppConfig<T extends IConfig>(target: Constructable<T>): void;
-export declare class AvleonConfig {
-    get<T extends IConfig<R>, R>(configClass: Constructable<T>): R;
-}
-export declare function GetConfig<T extends IConfig<R>, R = ReturnType<InstanceType<Constructable<T>>["config"]>>(ConfigClass: Constructable<T>): R;
-export declare function GetConfig<T = any>(config: string | symbol): T;
-export declare function CreateConfig<T>(token: string | symbol, callback: (env: Environment) => T): void;

package/dist/config.js

@@ -1,58 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.AvleonConfig = void 0;
-exports.AppConfig = AppConfig;
-exports.GetConfig = GetConfig;
-exports.CreateConfig = CreateConfig;
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
-const typedi_1 = require("typedi");
-const environment_variables_1 = require("./environment-variables");
-const helpers_1 = require("./helpers");
-function AppConfig(target) {
-    typedi_1.Container.set({ id: target, type: target });
-}
-class AvleonConfig {
-    get(configClass) {
-        const instance = typedi_1.Container.get(configClass);
-        if (!instance) {
-            throw new Error(`Configuration for ${configClass.name} not found.`);
-        }
-        return instance.config(new environment_variables_1.Environment());
-    }
-}
-exports.AvleonConfig = AvleonConfig;
-// Implementation
-function GetConfig(token) {
-    // 1. Class‐based: token.prototype.config is a function
-    if (typeof token === "function" &&
-        token.prototype != null &&
-        typeof token.prototype.config === "function") {
-        const instance = typedi_1.Container.get(token);
-        if (!instance) {
-            throw new Error(`Class "${token.name}" is not registered as a config.`);
-        }
-        return instance.config((0, helpers_1.inject)(environment_variables_1.Environment));
-    }
-    // 2. Functional: token is the callback itself
-    const stored = typedi_1.Container.get(token);
-    if (!stored) {
-        throw new Error("Config object is not registered.");
-    }
-    return stored;
-}
-function CreateConfig(token, callback) {
-    let env;
-    try {
-        env = typedi_1.Container.get(environment_variables_1.Environment);
-    }
-    catch (error) {
-        env = new environment_variables_1.Environment();
-    }
-    let config = callback(env);
-    typedi_1.Container.set(token, config);
-}

package/dist/config.test.d.ts

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

package/dist/config.test.js

@@ -1,40 +0,0 @@
-"use strict";
-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;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-require("reflect-metadata");
-const config_1 = require("./config");
-describe("Config", () => {
-    describe("class", () => {
-        it("should be call by get config", () => {
-            let MyConfig = class MyConfig {
-                config(env) {
-                    return {
-                        name: "avleon",
-                    };
-                }
-            };
-            MyConfig = __decorate([
-                config_1.AppConfig
-            ], MyConfig);
-            const mConfig = (0, config_1.GetConfig)(MyConfig);
-            expect(mConfig).toHaveProperty("name");
-            expect(mConfig["name"]).toBe("avleon");
-        });
-    });
-    describe("createConfig()", () => {
-        it("it should create config and called with GetConfig", () => {
-            (0, config_1.CreateConfig)("myconfig", (env) => ({
-                firstname: "tareq",
-                os: env.get("name"),
-            }));
-            const mConfig = (0, config_1.GetConfig)("myconfig");
-            expect(mConfig).toHaveProperty("firstname");
-            expect(mConfig.firstname).toBe("tareq");
-        });
-    });
-});

package/dist/constants.d.ts

@@ -1 +0,0 @@
-export declare const TEST_DATASOURCE_OPTIONS_KEY: unique symbol;

package/dist/constants.js

@@ -1,4 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TEST_DATASOURCE_OPTIONS_KEY = void 0;
-exports.TEST_DATASOURCE_OPTIONS_KEY = Symbol("itestdatasource");

package/dist/container.d.ts

@@ -1,30 +0,0 @@
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
-import { Knex } from "knex";
-import TypediContainer from "typedi";
-export declare const FEATURE_KEY: unique symbol;
-export declare const ROUTE_META_KEY: unique symbol;
-export declare const CONTROLLER_META_KEY: unique symbol;
-export declare const PARAM_META_KEY: unique symbol;
-export declare const QUERY_META_KEY: unique symbol;
-export declare const REQUEST_BODY_META_KEY: unique symbol;
-export declare const REQUEST_BODY_FILE_KEY: unique symbol;
-export declare const REQUEST_BODY_FILES_KEY: unique symbol;
-export declare const REQUEST_USER_META_KEY: unique symbol;
-export declare const REQUEST_HEADER_META_KEY: unique symbol;
-export declare const DATASOURCE_META_KEY: unique symbol;
-export declare const AUTHORIZATION_META_KEY: unique symbol;
-declare const Container: typeof TypediContainer;
-export declare function registerController(controller: Function): void;
-export declare function registerService(service: Function): void;
-export declare function getRegisteredServices(): Function[];
-export declare function getRegisteredControllers(): Function[];
-export declare const API_CONTROLLER_METADATA_KEY: unique symbol;
-export declare function isApiController(target: Function): boolean;
-export declare function registerDataSource(dataSource: any): void;
-export declare function registerKnex(dataSource: Knex.Config): void;
-export default Container;

package/dist/container.js

@@ -1,55 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.API_CONTROLLER_METADATA_KEY = exports.AUTHORIZATION_META_KEY = exports.DATASOURCE_META_KEY = exports.REQUEST_HEADER_META_KEY = exports.REQUEST_USER_META_KEY = exports.REQUEST_BODY_FILES_KEY = exports.REQUEST_BODY_FILE_KEY = exports.REQUEST_BODY_META_KEY = exports.QUERY_META_KEY = exports.PARAM_META_KEY = exports.CONTROLLER_META_KEY = exports.ROUTE_META_KEY = exports.FEATURE_KEY = void 0;
-exports.registerController = registerController;
-exports.registerService = registerService;
-exports.getRegisteredServices = getRegisteredServices;
-exports.getRegisteredControllers = getRegisteredControllers;
-exports.isApiController = isApiController;
-exports.registerDataSource = registerDataSource;
-exports.registerKnex = registerKnex;
-const typedi_1 = __importDefault(require("typedi"));
-exports.FEATURE_KEY = Symbol.for("features");
-exports.ROUTE_META_KEY = Symbol("iroute:options");
-exports.CONTROLLER_META_KEY = Symbol("icontroller:options");
-exports.PARAM_META_KEY = Symbol("iparam:options");
-exports.QUERY_META_KEY = Symbol("iparam:options");
-exports.REQUEST_BODY_META_KEY = Symbol("iparam:options");
-exports.REQUEST_BODY_FILE_KEY = Symbol("iparam:options");
-exports.REQUEST_BODY_FILES_KEY = Symbol("iparam:options");
-exports.REQUEST_USER_META_KEY = Symbol("iparam:options");
-exports.REQUEST_HEADER_META_KEY = Symbol("iheader:options");
-exports.DATASOURCE_META_KEY = Symbol("idatasource:options");
-exports.AUTHORIZATION_META_KEY = Symbol("idatasource:authorization");
-const controllerRegistry = new Set();
-const serviceRegistry = new Set();
-const optionsRegistry = new Map();
-const Container = typedi_1.default;
-function registerController(controller) {
-    controllerRegistry.add(controller);
-}
-function registerService(service) {
-    Container.set(service, service);
-    serviceRegistry.add(service);
-}
-function getRegisteredServices() {
-    return Array.from(serviceRegistry);
-}
-function getRegisteredControllers() {
-    return Array.from(controllerRegistry);
-}
-exports.API_CONTROLLER_METADATA_KEY = Symbol("apiController");
-function isApiController(target) {
-    return Reflect.getMetadata(exports.API_CONTROLLER_METADATA_KEY, target) === true;
-}
-Container.set("appName", "Iqra");
-function registerDataSource(dataSource) {
-    Container.set("idatasource", dataSource);
-}
-function registerKnex(dataSource) {
-    Container.set("KnexConnection", dataSource);
-}
-exports.default = Container;

package/dist/controller.d.ts

@@ -1,50 +0,0 @@
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
-export declare const REQUEST_METADATA_KEY: unique symbol;
-export declare function AvleonRequest(): ParameterDecorator;
-/**
- * Options for configuring a controller.
- * @remarks
- * Controller default options
- * @type {Object} ControllerOptions
- * @property {string} [name] - The name of the controller.
- * @property {string} [path] - The base path for the controller's routes.
- * @property {string} [version] - The version of the controller. If not provided, it will default to the version from `package.json`.
- * @property {string} [since] - The date or version since the controller was introduced.
- * @property {any} [meta] - Additional metadata associated with the controller.
- */
-export type ControllerOptions = {
-    /**
-     *@property {string} name
-     *@description Name of the controller. If specified it'll used as  swagger tags
-     *@default Contorller class name
-     * */
-    name?: string;
-    path?: string;
-    version?: string;
-    since?: string;
-    meta?: any;
-};
-export declare function createControllerDecorator(type?: "api" | "web"): (pathOrOptions?: string | ControllerOptions, maybeOptions?: ControllerOptions) => ClassDecorator;
-/**
- *@description Api controller's are used for rest . It will populate
- * json on return and all it http methods {get} {post} etc must return
- *Results.*
- * @param path {string} this will used as route prefix
- *
- **/
-export declare function ApiController(target: Function): void;
-export declare function ApiController(path: string): ClassDecorator;
-/**
- *@description Api controller's are used for rest . It will populate
- * json on return and all it http methods {get} {post} etc must return
- * Results.*
- * @param {ControllerOptions} options this will used as route prefix
- *
- **/
-export declare function ApiController(options: ControllerOptions): ClassDecorator;
-export declare function ApiController(path: string, options?: ControllerOptions): ClassDecorator;

package/dist/controller.js

@@ -1,71 +0,0 @@
-"use strict";
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.REQUEST_METADATA_KEY = void 0;
-exports.AvleonRequest = AvleonRequest;
-exports.createControllerDecorator = createControllerDecorator;
-exports.ApiController = ApiController;
-const typedi_1 = require("typedi");
-const container_1 = require("./container");
-exports.REQUEST_METADATA_KEY = Symbol('avleon:request');
-function AvleonRequest() {
-    return (target, propertyKey, parameterIndex) => {
-        const existingParams = Reflect.getMetadata(exports.REQUEST_METADATA_KEY, target, propertyKey) || [];
-        existingParams.push({
-            index: parameterIndex,
-            type: 'request',
-        });
-        Reflect.defineMetadata(exports.REQUEST_METADATA_KEY, existingParams, target, propertyKey);
-    };
-}
-function createControllerDecorator(type = "web") {
-    return function (pathOrOptions, maybeOptions) {
-        return function (target) {
-            let path = "/";
-            let options = {};
-            if (typeof pathOrOptions === "string") {
-                path = pathOrOptions;
-                options = maybeOptions || {};
-            }
-            else if (typeof pathOrOptions === "object") {
-                options = pathOrOptions;
-                path = options.path || "/";
-            }
-            Reflect.defineMetadata(container_1.API_CONTROLLER_METADATA_KEY, true, target);
-            // Ensure Service is applied as a ClassDecorator
-            if (typeof typedi_1.Service === "function") {
-                (0, container_1.registerController)(target); // Add to custom registry
-                (0, typedi_1.Service)()(target); // Apply DI decorator
-                Reflect.defineMetadata(container_1.CONTROLLER_META_KEY, { type, path, options }, target);
-            }
-            else {
-                throw new Error("Service decorator is not a function");
-            }
-        };
-    };
-}
-function ApiController(pathOrOptions = "/", mayBeOptions) {
-    if (typeof pathOrOptions == "function") {
-        Reflect.defineMetadata(container_1.API_CONTROLLER_METADATA_KEY, true, pathOrOptions);
-        // Ensure Service is applied as a ClassDecorator
-        if (typeof typedi_1.Service === "function") {
-            (0, container_1.registerController)(pathOrOptions); // Add to custom registry
-            (0, typedi_1.Service)()(pathOrOptions); // Apply DI decorator
-            Reflect.defineMetadata(container_1.CONTROLLER_META_KEY, { type: "api", path: "/", options: {} }, pathOrOptions);
-        }
-        else {
-            throw new Error("Service decorator is not a function");
-        }
-    }
-    else {
-        if (mayBeOptions) {
-            return createControllerDecorator("api")(pathOrOptions, mayBeOptions);
-        }
-        return createControllerDecorator("api")(pathOrOptions);
-    }
-}

package/dist/controller.test.d.ts

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

package/dist/controller.test.js

@@ -1,97 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-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;
-};
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-Object.defineProperty(exports, "__esModule", { value: true });
-require("reflect-metadata");
-const controller_1 = require("./controller");
-const containerModule = __importStar(require("./container"));
-describe("Controller Decorators", () => {
-    beforeEach(() => {
-        jest.clearAllMocks();
-    });
-    describe("ApiController", () => {
-        it("should apply metadata and Service decorator when used as a class decorator", () => {
-            const registerControllerSpy = jest.spyOn(containerModule, "registerController");
-            let TestController = class TestController {
-            };
-            TestController = __decorate([
-                controller_1.ApiController
-            ], TestController);
-            expect(Reflect.getMetadata(containerModule.API_CONTROLLER_METADATA_KEY, TestController)).toBe(true);
-            expect(registerControllerSpy).toHaveBeenCalledWith(TestController);
-            expect(Reflect.getMetadata(containerModule.CONTROLLER_META_KEY, TestController)).toEqual({
-                type: "api",
-                path: "/",
-                options: {},
-            });
-        });
-        it("should apply metadata and Service decorator when used with a path", () => {
-            const registerControllerSpy = jest.spyOn(containerModule, "registerController");
-            let TestController = class TestController {
-            };
-            TestController = __decorate([
-                (0, controller_1.ApiController)("/test")
-            ], TestController);
-            expect(Reflect.getMetadata(containerModule.API_CONTROLLER_METADATA_KEY, TestController)).toBe(true);
-            expect(registerControllerSpy).toHaveBeenCalledWith(TestController);
-            expect(Reflect.getMetadata(containerModule.CONTROLLER_META_KEY, TestController)).toEqual({
-                type: "api",
-                path: "/test",
-                options: {},
-            });
-        });
-        it("should apply metadata and Service decorator when used with options", () => {
-            const registerControllerSpy = jest.spyOn(containerModule, "registerController");
-            const options = { name: "Custom", path: "/custom", version: "1.0.0" };
-            let TestController = class TestController {
-            };
-            TestController = __decorate([
-                (0, controller_1.ApiController)(options)
-            ], TestController);
-            expect(Reflect.getMetadata(containerModule.API_CONTROLLER_METADATA_KEY, TestController)).toBe(true);
-            expect(registerControllerSpy).toHaveBeenCalledWith(TestController);
-            expect(Reflect.getMetadata(containerModule.CONTROLLER_META_KEY, TestController)).toEqual({
-                type: "api",
-                path: "/custom",
-                options,
-            });
-        });
-    });
-});

package/dist/core/application.d.ts

@@ -1,74 +0,0 @@
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
-import { FastifyInstance } from "fastify";
-import "@fastify/swagger";
-import { IAvleonApplication, AvleonApplicationOptions, CorsOptions, GlobalOptions } from "../interfaces/avleon-application";
-import { Constructor } from "../helpers";
-import { OpenApiUiOptions } from "../openapi";
-import { DataSource } from "typeorm";
-import { AvleonMiddleware } from "../middleware";
-import { AutoControllerOptions } from "./types";
-export declare class AvleonApplication implements IAvleonApplication {
-    app: FastifyInstance;
-    private router;
-    private static instance;
-    private alreadyRun;
-    private hasSwagger;
-    private globalSwaggerOptions;
-    private dataSourceOptions;
-    private dataSource;
-    private isMapFeatures;
-    private registerControllerAuto;
-    private registerControllerPath;
-    private controllers;
-    private _hasWebsocket;
-    private io;
-    private constructor();
-    static getApp(options?: AvleonApplicationOptions): AvleonApplication;
-    /**
-     * @deprecated Use `getApp` instead. This is internal.
-     */
-    static getInternalApp(options?: AvleonApplicationOptions): AvleonApplication;
-    useCors(options: CorsOptions): this;
-    useDatasource(dataSource: DataSource): this;
-    useMultipart(options?: any): this;
-    useOpenApi(options: OpenApiUiOptions): this;
-    private initSwagger;
-    useMiddlewares(middlewares: Constructor<AvleonMiddleware>[]): this;
-    useAuthorization(authorization: Constructor<any>): this;
-    useSerialization(): this;
-    useControllers(controllers: Constructor[] | AutoControllerOptions): this;
-    useStaticFiles(options: any): this;
-    useHttps(options?: any): this;
-    useGlobal(options: GlobalOptions): this;
-    useSocketIo(options?: any): this;
-    useKnex(options: any): this;
-    mapFeatures(): this;
-    private _mapControllers;
-    private _resolveControllerDir;
-    private autoControllers;
-    private _mapFeatures;
-    initializeDatabase(): Promise<void>;
-    handleSocket(socket: any): void;
-    mapGet<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
-        useMiddleware: <M extends AvleonMiddleware>(middlewares: Constructor<AvleonMiddleware>[]) => /*elided*/ any;
-        useOpenApi: (options: import("../openapi").OpenApiOptions) => /*elided*/ any;
-    };
-    mapPost<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
-        useMiddleware: <M extends AvleonMiddleware>(middlewares: Constructor<AvleonMiddleware>[]) => /*elided*/ any;
-        useOpenApi: (options: import("../openapi").OpenApiOptions) => /*elided*/ any;
-    };
-    mapPut<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
-        useMiddleware: <M extends AvleonMiddleware>(middlewares: Constructor<AvleonMiddleware>[]) => /*elided*/ any;
-        useOpenApi: (options: import("../openapi").OpenApiOptions) => /*elided*/ any;
-    };
-    mapDelete<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
-        useMiddleware: <M extends AvleonMiddleware>(middlewares: Constructor<AvleonMiddleware>[]) => /*elided*/ any;
-        useOpenApi: (options: import("../openapi").OpenApiOptions) => /*elided*/ any;
-    };
-    run(port?: number, fn?: CallableFunction): Promise<void>;
-}