@avleon/core 0.0.45 → 0.0.46

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 {};