@avleon/core 0.0.44 → 0.0.46

package/package.json

@@ -1,34 +1,40 @@
 {
   "name": "@avleon/core",
-  "version": "0.0.44",
+  "version": "0.0.46",
+  "description": "TypeScript-first web framework built on Fastify",
+  "author": "Tareq Hossain",
+  "license": "ISC",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
   "keywords": [
     "restapi",
     "avleon",
     "backend",
-    "fastify"
-  ],
-  "author": "Tareq Hossain",
-  "license": "ISC",
-  "description": "avleon core",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/avleonjs/avleon-core"
-  },
-  "files": [
-    "dist"
+    "fastify",
+    "typescript"
   ],
-  "directories": {
-    "test": "."
+  "scripts": {
+    "build": "npm run clean && tsc",
+    "clean": "rimraf dist",
+    "prepublishOnly": "npm run build",
+    "watch": "tsc-watch",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "format": "prettier --write .",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "husky:init": "husky install"
   },
   "dependencies": {
     "class-transformer": "^0.5.1",
     "class-validator": "^0.14.2",
     "fastify": "^5.1.0",
-    "mime": "^4.1.0",
-    "pino": "^9.10.0",
-    "pino-pretty": "^13.1.1",
+    "mime": "^3.0.0",
     "reflect-metadata": "^0.2.2",
     "typedi": "^0.10.0"
   },
@@ -41,23 +47,23 @@
     "@fastify/view": "^11.0.0",
     "@scalar/fastify-api-reference": "*",
     "bcryptjs": "3.0.2",
+    "bull": "^4.16.5",
     "dotenv": "*",
     "fastify-socket.io": "^4.0.0",
     "highlight.js": "*",
     "ioredis": "*",
     "knex": "*",
-    "mssql": "*",
+    "mssql": ">=9.0.0",
     "mysql2": "*",
     "pg": "*",
+    "pino": "^9.0.0",
+    "pino-pretty": "^13.0.0",
     "sharp": "*",
     "socket.io": "*",
     "sqlite3": "*",
     "typeorm": "*"
   },
   "peerDependenciesMeta": {
-    "bcryptjs": {
-      "optional": true
-    },
     "@fastify/cors": {
       "optional": true
     },
@@ -79,13 +85,22 @@
     "@scalar/fastify-api-reference": {
       "optional": true
     },
-    "ioredis": {
+    "bcryptjs": {
       "optional": true
     },
-    "sharp": {
+    "bull": {
       "optional": true
     },
-    "typeorm": {
+    "dotenv": {
+      "optional": true
+    },
+    "fastify-socket.io": {
+      "optional": true
+    },
+    "highlight.js": {
+      "optional": true
+    },
+    "ioredis": {
       "optional": true
     },
     "knex": {
@@ -100,19 +115,22 @@
     "pg": {
       "optional": true
     },
-    "sqlite3": {
+    "pino": {
       "optional": true
     },
-    "fastify-socket.io": {
+    "pino-pretty": {
+      "optional": true
+    },
+    "sharp": {
       "optional": true
     },
     "socket.io": {
       "optional": true
     },
-    "dotenv": {
+    "sqlite3": {
       "optional": true
     },
-    "highlight.js": {
+    "typeorm": {
       "optional": true
     }
   },
@@ -140,15 +158,11 @@
       "cross-env CI=true jest --bail --findRelatedTests --passWithNoTests --config=jest.config.js"
     ]
   },
-  "scripts": {
-    "build": "npm run clean && tsc",
-    "clean": "rimraf dist",
-    "watch": "tsc-watch",
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix",
-    "format": "prettier --write .",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "husky:init": "husky install"
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/avleonjs/avleon-core"
+  },
+  "publishConfig": {
+    "access": "public"
   }
-}
+}

package/dist/application.d.ts

@@ -1,47 +0,0 @@
-import { Constructor } from "./helpers";
-import { RouteShorthandMethod } from "fastify";
-export interface AvleonApplication {
-    useCors: () => void;
-    useOpenApi: () => void;
-    useView: () => void;
-    useAuth: () => void;
-    useMultipart: () => void;
-    useDataSource: () => void;
-    useMiddlewares: () => void;
-    useControllers: () => void;
-    useAutoControllers: () => void;
-    useStaticFiles: () => void;
-    useCustomErrorHandler: () => void;
-    mapGroup: () => any;
-    mapGet: () => any;
-    mapPost: () => any;
-    mapPut: () => any;
-    mapPatch: () => any;
-    mapDelete: () => any;
-    mapView: () => any;
-    run: (port: number) => void;
-}
-export interface InlineRoutes {
-    get: RouteShorthandMethod;
-    post: RouteShorthandMethod;
-    put: RouteShorthandMethod;
-    patch: RouteShorthandMethod;
-    delete: RouteShorthandMethod;
-}
-export interface Application {
-    inlineRoutes: () => InlineRoutes;
-    mapGroup: (path?: string | RegExp) => InlineRoutes;
-    /**
-     * Start the application
-     * @param port
-     * @returns void
-     */
-    start: (port?: number) => void;
-}
-export interface TestApplication {
-    getController: <T>(controller: Constructor<T>) => T;
-}
-export declare class Builder {
-    static createApplication(): Application;
-    static createTestApplication(app?: Application): TestApplication;
-}

package/dist/application.js

@@ -1,50 +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.Builder = void 0;
-const typedi_1 = __importDefault(require("typedi"));
-const fastify_1 = __importDefault(require("fastify"));
-class IqraTestApplication {
-    getController(controller) {
-        const con = typedi_1.default.get(controller);
-        return con;
-    }
-}
-class IqraApplication {
-    constructor() {
-        if (!this.app) {
-            this.app = fastify_1.default.prototype;
-        }
-    }
-    inlineRoutes() {
-        return {
-            get: this.app.get,
-            post: this.app.post,
-            put: this.app.put,
-            patch: this.app.patch,
-            delete: this.app.delete,
-        };
-    }
-    mapGroup(path) {
-        return this.inlineRoutes();
-    }
-    start(port) {
-        const p = port ? port : 4000;
-        this.app.listen({ port: p });
-    }
-}
-class Builder {
-    static createApplication() {
-        const app = new IqraApplication();
-        return app;
-    }
-    static createTestApplication(app) {
-        const testApp = new IqraTestApplication();
-        return testApp;
-    }
-}
-exports.Builder = Builder;
-const app = Builder.createApplication();
-const route = app.inlineRoutes();

package/dist/icore.d.ts

@@ -1,226 +0,0 @@
-/**
- * @copyright 2024
- * @author Tareq Hossain
- * @email xtrinsic96@gmail.com
- * @url https://github.com/xtareq
- */
-import { FastifyReply, FastifyRequest, HookHandlerDoneFunction, InjectOptions, LightMyRequestResponse, FastifyLoggerOptions } from "fastify";
-import { Constructable } from "typedi";
-import { Constructor } from "./helpers";
-import { PathLike } from "fs";
-import { DataSource, DataSourceOptions } from "typeorm";
-import { AvleonMiddleware } from "./middleware";
-import { OpenApiOptions, OpenApiUiOptions } from "./openapi";
-import { IConfig } from "./config";
-import { FastifyCorsOptions } from "@fastify/cors";
-import { FastifyMultipartOptions } from "@fastify/multipart";
-import { MultipartFile } from "./multipart";
-import { ServerOptions } from "socket.io";
-import { Knex } from "knex";
-export type FuncRoute = {
-    handler: any;
-    middlewares?: any[];
-    schema?: {};
-};
-export interface IRequest extends FastifyRequest {
-    params: any;
-    query: any;
-    body: any;
-    headers: any;
-    user?: any;
-}
-export interface DoneFunction extends HookHandlerDoneFunction {
-}
-export interface IResponse extends FastifyReply {
-}
-export type TestResponseType = LightMyRequestResponse;
-export type TestResponse = TestResponseType | Promise<TestResponseType>;
-export interface TestApplication {
-    get: (url: string, options?: InjectOptions) => TestResponse;
-    post: (url: string, options?: InjectOptions) => TestResponse;
-    put: (url: string, options?: InjectOptions) => TestResponse;
-    patch: (url: string, options?: InjectOptions) => TestResponse;
-    delete: (url: string, options?: InjectOptions) => TestResponse;
-    options: (url: string, options?: InjectOptions) => TestResponse;
-    getController?: <T>(controller: Constructor<T>) => T;
-}
-export interface ParamMetaOptions {
-    index: number;
-    key: string;
-    name: string;
-    required: boolean;
-    validate: boolean;
-    dataType: any;
-    validatorClass: boolean;
-    schema?: any;
-    type: "route:param" | "route:query" | "route:body" | "route:header" | "route:user" | "route:file" | "route:files";
-}
-export interface ParamMetaFilesOptions {
-    index: number;
-    type: "route:files";
-    files: MultipartFile[];
-    fieldName: string;
-}
-export interface MethodParamMeta {
-    request: any[];
-    params: ParamMetaOptions[];
-    query: ParamMetaOptions[];
-    body: ParamMetaOptions[];
-    headers: ParamMetaOptions[];
-    currentUser: ParamMetaOptions[];
-    swagger?: OpenApiUiOptions;
-    file?: any[];
-    files?: ParamMetaFilesOptions[];
-}
-type StaticFileOptions = {
-    path?: PathLike;
-    prefix?: string;
-};
-type MultipartOptions = {
-    destination: PathLike;
-} & FastifyMultipartOptions;
-export type TestAppOptions = {
-    controllers: Constructor[];
-    dataSource?: DataSource;
-};
-export interface AvleonTestAppliction {
-    addDataSource: (dataSourceOptions: DataSourceOptions) => void;
-    getApp: (options?: TestAppOptions) => any;
-    getController: <T>(controller: Constructor<T>, deps: any[]) => T;
-}
-export type AutoControllerOptions = {
-    auto: true;
-    path?: string;
-};
-export interface IAvleonApplication {
-    isDevelopment(): boolean;
-    useCors(corsOptions?: FastifyCorsOptions): void;
-    useDataSource<T extends IConfig<R>, R = ReturnType<InstanceType<Constructable<T>>["config"]>>(ConfigClass: Constructable<T>, modifyConfig?: (config: R) => R): void;
-    useOpenApi<T extends IConfig<R>, R = ReturnType<InstanceType<Constructable<T>>["config"]>>(ConfigClass: Constructable<T>, modifyConfig?: (config: R) => R): void;
-    useMultipart(options: MultipartOptions): void;
-    useCache(options: any): void;
-    useMiddlewares<T extends AvleonMiddleware>(mclasses: Constructor<T>[]): void;
-    useAuthoriztion<T extends any>(middleware: Constructor<T>): void;
-    mapRoute<T extends (...args: any[]) => any>(method: "get" | "post" | "put" | "delete", path: string, fn: T): Promise<void>;
-    mapGet<T extends (...args: any[]) => any>(path: string, fn: T): any;
-    mapPost<T extends (...args: any[]) => any>(path: string, fn: T): any;
-    mapPut<T extends (...args: any[]) => any>(path: string, fn: T): any;
-    mapDelete<T extends (...args: any[]) => any>(path: string, fn: T): any;
-    useControllers(controllers: any[]): any;
-    useControllers(controllersOptions: AutoControllerOptions): any;
-    useControllers(controllersOrOptions: any[] | AutoControllerOptions): any;
-    useStaticFiles(options?: StaticFileOptions): void;
-    run(port?: number): Promise<void>;
-    getTestApp(): TestApplication;
-}
-type OpenApiConfigClass<T = any> = Constructable<IConfig<T>>;
-type OpenApiConfigInput<T = any> = OpenApiConfigClass<T> | T;
-type ConfigClass<T = any> = Constructable<IConfig<T>>;
-type ConfigInput<T = any> = ConfigClass<T> | T;
-export declare class AvleonApplication {
-    private static instance;
-    private static buildOptions;
-    private app;
-    private routeSet;
-    private alreadyRun;
-    private routes;
-    private middlewares;
-    private rMap;
-    private hasSwagger;
-    private _hasWebsocket;
-    private globalSwaggerOptions;
-    private dataSourceOptions?;
-    private controllers;
-    private authorizeMiddleware?;
-    private appConfig;
-    private dataSource?;
-    private isMapFeatures;
-    private registerControllerAuto;
-    private registerControllerPath;
-    private metaCache;
-    private multipartOptions;
-    private constructor();
-    static getApp(): AvleonApplication;
-    static getInternalApp(buildOptions: any): AvleonApplication;
-    useLogger<T = FastifyLoggerOptions>(corsOptions?: ConfigInput<T>): void;
-    isDevelopment(): boolean;
-    private initSwagger;
-    private _isConfigClass;
-    useCors<T = FastifyCorsOptions>(corsOptions?: ConfigInput<T>): void;
-    useWebSocket<T = Partial<ServerOptions>>(socketOptions: ConfigInput<T>): void;
-    useSocketIO<T = Partial<ServerOptions>>(socketOptions: ConfigInput<T>): void;
-    private _initWebSocket;
-    useOpenApi<T = OpenApiUiOptions>(configOrClass: OpenApiConfigInput<T>): void;
-    useMultipart<T extends MultipartOptions>(options: ConfigInput<T>): void;
-    useDataSource<T extends DataSourceOptions>(options: ConfigInput<T>): void;
-    useKnex<T extends Knex.Config>(options: ConfigInput<T>): void;
-    private _useCache;
-    useMiddlewares<T extends AvleonMiddleware>(mclasses: Constructor<T>[]): void;
-    useAuthoriztion<T extends any>(middleware: Constructor<T>): void;
-    useStaticFiles(options?: StaticFileOptions): void;
-    private handleMiddlewares;
-    private executeMiddlewares;
-    /**
-     * build controller
-     * @param controller
-     * @returns void
-     */
-    private buildController;
-    /**
-     * 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
-     */
-    private _mapArgs;
-    /**
-     * Process Meta for controlelr class methods
-     * @param prototype
-     * @param method
-     * @returns
-     */
-    private _processMeta;
-    private _resolveControllerDir;
-    private autoControllers;
-    useControllers(controllers: Constructor[] | AutoControllerOptions): void;
-    private _mapControllers;
-    private mapFn;
-    private _handleError;
-    mapRoute<T extends (...args: any[]) => any>(method: "get" | "post" | "put" | "delete", path: string | undefined, fn: T): Promise<void>;
-    private _routeHandler;
-    mapGet<T extends (...args: any[]) => any>(path: string | undefined, fn: T): {
-        useMiddleware: <M extends AvleonMiddleware>(middlewares: Constructor<AvleonMiddleware>[]) => /*elided*/ any;
-        useOpenApi: (options: 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: 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: 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: OpenApiOptions) => /*elided*/ any;
-    };
-    private _mapFeatures;
-    initializeDatabase(): Promise<void>;
-    handleSocket(socket: any): void;
-    run(port?: number, fn?: CallableFunction): Promise<void>;
-    getTestApp(buildOptions?: any): TestApplication;
-}
-export type Application = typeof AvleonApplication;
-export declare class AvleonTest {
-    private constructor();
-    static getController<T>(controller: Constructor<T>, deps?: any[]): T;
-    static getProvider<T>(service: Constructor<T>, deps?: any[]): T;
-    static createTestApplication(options: TestAppOptions): TestApplication;
-    static from(app: AvleonApplication): TestApplication;
-    static clean(): void;
-}
-export declare class Avleon {
-    static createApplication(): AvleonApplication;
-    static createTestApplication(options: TestAppOptions): TestApplication;
-}
-export {};