web_api_base 1.0.0 → 1.0.1

package/.vscode/launch.json

@@ -1,21 +0,0 @@
-{
-    // Use IntelliSense to learn about possible attributes.
-    // Hover to view descriptions of existing attributes.
-    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-    "version": "0.2.0",
-    "configurations": [
-        
-        {
-            "type": "node",
-            "request": "launch",
-            "name": "Launch Program",
-            "skipFiles": [
-                "<node_internals>/**"
-            ],
-            "program": "${file}",
-            "outFiles": [
-                "${workspaceFolder}/**/*.js"
-            ]
-        }
-    ]
-}

package/Application.ts

@@ -1,39 +0,0 @@
-import { Express } from "express";
-import ExpressModule from "express";
-import ApplicationConfiguration from "./ApplicationConfiguration"
-import IApplication from "./interfaces/IApplication";
-import IApplicationConfiguration from "./interfaces/IApplicationConfiguration";
-
-export default abstract class Application implements IApplication
-{
-
-    private ApplicationConfiguration : IApplicationConfiguration;
-
-    public Express : Express;
-
-
-    constructor()
-    {
-        this.ApplicationConfiguration = new ApplicationConfiguration();
-
-        this.Express = ExpressModule();
-
-    }
-    
-
-    public async StartAsync() : Promise<void>
-    {
-        await this.ApplicationConfiguration.StartAsync();
-
-        this.Configure(this.ApplicationConfiguration);
-
-        this.Express.listen(this.ApplicationConfiguration.Port, this.ApplicationConfiguration.Host, ()=>
-        {
-            console.log(`App running on ${this.ApplicationConfiguration.Host}:${this.ApplicationConfiguration.Port}`);
-        })
-    }
-
-    public abstract Configure(appConfig : IApplicationConfiguration): void;
-    
-    
-}

package/ApplicationConfiguration.ts

@@ -1,82 +0,0 @@
-import File from 'fs';
-
-import IApplicationConfiguration from './interfaces/IApplicationConfiguration';
-
-
-export default class Configuration implements IApplicationConfiguration
-{
-
-    public Host : string = "0.0.0.0";    
-    public Port : number = 5555;
-
-    constructor()
-    {
-        process.env["root_dir"] = __dirname;
-    }
-
-    public async StartAsync() : Promise<void>
-    {
-        if(!await this.CheckFileAsync())
-        {
-            await this.CreateFileAsync();
-            
-        }else{
-
-            await this.ReadFileAsync();
-        }
-    }
-
-    private async CheckFileAsync() : Promise<boolean>
-    {
-        return new Promise<boolean>((resolve, _) => resolve(File.existsSync(`${__dirname}\\config.json`)));        
-    }
-
-    private async ReadFileAsync() : Promise<boolean>
-    {
-        return new Promise<boolean>((resolve, _) => 
-        {
-            File.readFile(`${__dirname}\\config.json`, 'utf-8', (error, data) => 
-            {
-                if(error)
-                {
-                    throw error;
-                }
-
-                let json : any = JSON.parse(data);
-
-                for(let key in this)
-                {
-                    if(json[key] != undefined)
-                    {
-                        this[key] = json[key];
-                    }
-                }
-
-                resolve(true);
-
-            })
-        })
-    }
-
-    private async CreateFileAsync() : Promise<boolean>
-    {
-
-        return new Promise<boolean>((resolve, _)=>{
-
-            File.writeFile(`${__dirname}\\config.json`, JSON.stringify(this), 'utf-8', error => 
-            {
-                
-                if(error)
-                {
-                    throw error;
-                }
-
-                resolve(true);
-    
-            });   
-        })
-             
-    }
-
-}
-

package/__tests__/classes/Controller.ts

@@ -1,38 +0,0 @@
-/* istanbul ignore next */
-
-import { ControllerBase } from "../../controllers/base/ControllerBase";
-import ControllersDecorators from "../../decorators/controllers/ControllerDecorators";
-import { HTTPVerbs } from "../../enums/httpVerbs/HttpVerbs";
-import IApplication from "../../interfaces/IApplication";
-import {Request, Response} from 'express'
-
-@ControllersDecorators.Route("/test")
-export class ControllerTest extends ControllerBase
-{
-    constructor()
-    {
-        super();
-    }
-
-    @ControllersDecorators.Action("Test")
-    @ControllersDecorators.Verb(HTTPVerbs.GET)
-    @ControllersDecorators.Argument<string>('name')
-    public TestAction(name : string)
-    {
-        console.log(name);
-    }
-
-    @ControllersDecorators.Action("Test")
-    @ControllersDecorators.Verb(HTTPVerbs.GET)
-    @ControllersDecorators.Argument<string, number>('name', 'age')
-    public TestActionTwo(name : string, age : number)
-    {
-        console.log(name, age);
-    }
-
-
-    public AppendSync(application: IApplication): void 
-    {
-        
-    }
-}

package/__tests__/decorators/controllers/ControllerDecorators.spec.ts

@@ -1,67 +0,0 @@
-import { ControllerTest } from "../../classes/Controller";
-import ControllersDecorators from "../../../decorators/controllers/ControllerDecorators";
-import { HTTPVerbs } from "../../../enums/httpVerbs/HttpVerbs";
-
-describe('testing controllers decorators', ()=>
-{
-
-    test("action name", ()=>
-    {
-        var controller = new ControllerTest();
-        let action = ControllersDecorators.GetAction(controller, "TestAction");
-        expect(action).toBe("Test");
-
-    },10^5)
-
-    test("http verb", ()=>
-    {
-        var controller = new ControllerTest();
-        let verb = ControllersDecorators.GetVerb(controller, "TestAction");
-        expect(verb).toBe(HTTPVerbs.GET);
-
-    },10^5)
-
-    test("action with one arg", ()=>
-    {
-        var controller = new ControllerTest();
-        
-        var handler = ControllersDecorators.GetArgumentsHandler(controller, 'TestAction');
-
-        var arr = handler?.CreateArgumentsList({name : "adriano"});
-
-        Reflect.apply(controller.TestAction, controller, arr ?? []);
-
-        expect(arr).not.toBeNull();
-
-
-    },10^5)
-
-
-    test("action with two args", ()=>
-    {
-        var controller = new ControllerTest();
-        
-        var handler = ControllersDecorators.GetArgumentsHandler(controller, 'TestActionTwo');
-
-        var arr = handler?.CreateArgumentsList({name : "adriano", age : 30});
-
-        Reflect.apply(controller.TestActionTwo, controller, arr ?? []);
-
-        expect(arr).not.toBeNull();
-
-
-    },10^5)
-
-
-    test("controller route", ()=>
-    {
-        var controller = new ControllerTest();
-        
-        var route = ControllersDecorators.GetRoute(controller);
-        
-        expect(route!).toBe("/test");
-
-
-    },10^5)
-
-})

package/controllers/base/ControllerBase.ts

@@ -1,116 +0,0 @@
-import IController from "../../interfaces/IController";
-import {Request, Response} from 'express'
-import ControllersDecorators from '../../decorators/controllers/ControllerDecorators';
-import DependecyService from '../../dependencyInjection/DependecyService';
-import IApplication from "../../interfaces/IApplication";
-import { HTTPVerbs } from "../../enums/httpVerbs/HttpVerbs";
-
-
-export class ControllerBase implements IController
-{
-    Request : Request = {} as Request;
-    Response : Response = {} as Response;
-
-    constructor()
-    {
-        
-    }
-
-    public OK<T>(result : T)
-    {
-        this.Response.status(200);
-        this.Response.json(result);
-    }
-
-    public Created()
-    {
-        this.Response.status(201);
-        this.Response.end();
-    }
-    
-    public BadRequest<T>(result : T)
-    {
-        this.Response.status(400);
-        this.Response.json(result);
-    }
-
-    public Error<T>(result : T)
-    {
-        this.Response.status(500);
-        this.Response.json(result);
-    }
-
-    public SendResponse<T>(status : number, result : T)
-    {
-        this.Response.status(status);
-        this.Response.json(result);
-    }
-
-    public static AppendController<T extends IController>(ctor : { new (...args : any[]) : T;}, application : IApplication) : void
-    {
-        let empty = new ctor() as any;
-                
-        let methods = Reflect.ownKeys(empty.constructor.prototype).filter(m => 
-            {
-                return typeof empty[m] == "function" ;
-            })     
-
-        let route = ControllersDecorators.GetRoute(empty);
-
-        if(!route)
-            return;
-
-
-        for(let method of methods)
-        {
-            let action = ControllersDecorators.GetAction(empty, method.toString());
-
-            if(!action){
-                continue;                
-            }
-            
-            let verb = ControllersDecorators.GetVerb(empty, method.toString());
-
-            if(!verb)
-                verb = HTTPVerbs.GET;
-
-            console.debug("appended : " , verb,`${route}${action}`);
-
-            (application.Express as any)[verb.toString().toLowerCase()](`${route}${action}`, (req : Request, resp : Response) => 
-            {
-
-                let midlewares = ControllersDecorators.GetMidlewares(empty).reverse();
-
-                midlewares.push(...ControllersDecorators.GetBefores(empty, method.toString()).reverse());
-
-                if(midlewares)
-                {
-                    for(let method of midlewares)
-                    {
-                        method(req);
-                    }
-                }
-
-                let args = ControllersDecorators.GetArgumentsHandler(empty, method.toString());
-                let params = [];
-                
-                if(args)
-                {
-                    if(args.Arguments.length > 0)
-                    {
-                        if(req.body && verb == (HTTPVerbs.POST || verb == HTTPVerbs.PUT))
-                            params = args.CreateArgumentsList(req.body);
-                        if(req.query)
-                            params.push(...args.CreateArgumentsList(req.query))
-                    }
-                }
-
-                let controller = DependecyService.ResolveCtor(empty.constructor) as IController;
-                controller.Request = req;
-                controller.Response = resp;
-                (controller as any)[method](...params);
-            })
-        }
-                
-    }
-}

package/decorators/controllers/ControllerDecorators.ts

@@ -1,187 +0,0 @@
-import { REFUSED } from 'dns';
-import 'reflect-metadata';
-
-import { HTTPVerbs } from '../../enums/httpVerbs/HttpVerbs';
-import IController from '../../interfaces/IController';
-import IMidleware from '../../midlewares/IMidleware';
-
-export default class ControllersDecorators
-{
-    constructor()
-    {
-
-    }
-
-    private static RouteKeyMetadata = "meta:controllerRoute";
-    private static ActionVerbKeyMetadata = "meta:actionVerb";
-    private static ActionNameKeyMetadata = "meta:actionName";
-    private static ArgumentsHandlerKeyMetadata = "meta:argHandler";
-    private static ControllerMidlewaresKeyMetadata = "meta:controllerMidlewaresKey";
-    private static ActionsMidlewaresKeyMetadata = "meta:actionMidlewaresKey";
-    
-
-    public static Route(route : string)  
-    {
-        return function( target : Function)
-        {
-            Reflect.defineMetadata(ControllersDecorators.RouteKeyMetadata, route, target);
-            
-        }
-    }
-
-    public static Use(midleware : IMidleware)  
-    {
-        return function( target : Function)
-        {
-            let current : IMidleware[] = Reflect.getMetadata(ControllersDecorators.ControllerMidlewaresKeyMetadata, target) ?? [];
-
-            current.push(midleware);
-
-            Reflect.defineMetadata(ControllersDecorators.ControllerMidlewaresKeyMetadata, current, target);            
-        }
-    }
-
-    public static GetMidlewares(controller : IController) : IMidleware[]
-    {
-       return Reflect.getMetadata(ControllersDecorators.ControllerMidlewaresKeyMetadata, controller.constructor) ?? [];
-    }
-
-    public static Before(midleware : IMidleware)  
-    {
-        return function( target : Object, methodName : string, propertyDescriptor : PropertyDescriptor)
-        {
-            let current : IMidleware[] = Reflect.getMetadata(ControllersDecorators.ActionsMidlewaresKeyMetadata, target, methodName) ?? [];
-
-            current.push(midleware);
-
-            ControllersDecorators.SetMetaData(ControllersDecorators.ActionsMidlewaresKeyMetadata, target, methodName, current);
-            
-        }
-    }
-
-    public static GetBefores(controller : IController, methodName : string) : IMidleware[]
-    {
-       return this.GetMetaData<IMidleware[]>(ControllersDecorators.ActionsMidlewaresKeyMetadata, controller, methodName) ?? [];
-    }
-
-    public static GetRoute(controller : IController) : string | undefined
-    {
-       return Reflect.getMetadata(ControllersDecorators.RouteKeyMetadata, controller.constructor);
-    }
-
-
-    public static Verb(verb : HTTPVerbs)  
-    {
-        return function( target : Object, methodName : string, propertyDescriptor : PropertyDescriptor)
-        {
-            ControllersDecorators.SetMetaData(ControllersDecorators.ActionVerbKeyMetadata, target, methodName, verb);
-            
-        }
-    }
-
-    public static GetVerb(target : IController, methodName : string ) : HTTPVerbs | undefined
-    {
-        let meta = this.GetMetaData<HTTPVerbs>(ControllersDecorators.ActionVerbKeyMetadata, target, methodName);
-
-        return meta;
-    }
-
-    public static Action(actionName : String)  
-    {
-        return function( target : Object, methodName : string, propertyDescriptor : PropertyDescriptor)
-        {
-            ControllersDecorators.SetMetaData(ControllersDecorators.ActionNameKeyMetadata, target, methodName, actionName);
-            
-        }
-    }
-
-    public static GetAction(target : IController, methodName : string ) : string | undefined
-    {
-        let meta = this.GetMetaData<string>(ControllersDecorators.ActionNameKeyMetadata, target, methodName);
-
-        return meta;
-    }
-   
-    
-    public static Argument<T>(argName1 : string) : ( target : Object, methodName : string, propertyDescriptor : PropertyDescriptor) => void
-    public static Argument<T, U>(argName1 : string, argName2?: string)  : ( target : Object, methodName : string, propertyDescriptor : PropertyDescriptor) => void
-    public static Argument<T, U, K>(argName1 : string, argName2?: string, argName3? : string)  : ( target : Object, methodName : string, propertyDescriptor : PropertyDescriptor) => void
-    public static Argument<T, U, K, Y>(argName1 : string, argName2?: string, argName3? : string, argName4? : string)  : ( target : Object, methodName : string, propertyDescriptor : PropertyDescriptor) => void
-    public static Argument<T, U, K, Y, J>(argName1 : string, argName2?: string, argName3? : string, argName4? : string, argName5? : string)  : ( target : Object, methodName : string, propertyDescriptor : PropertyDescriptor) => void
-    public static Argument<T, U, K, Y, J, V>(argName1 : string, argName2?: string, argName3? : string, argName4? : string, argName5? : string, argName6? : string)  : ( target : Object, methodName : string, propertyDescriptor : PropertyDescriptor) => void
-    {
-        return function( target : Object, methodName : string, propertyDescriptor : PropertyDescriptor)
-        {
-            ControllersDecorators.SetMetaData(ControllersDecorators.ArgumentsHandlerKeyMetadata, target, methodName, 
-                {
-                    
-
-                    Arguments : [argName1, argName2, argName3, argName4, argName5, argName6],
-
-                    CreateArgumentsList : (args : any) => 
-                    {
-                        let results = [] as any[];
-
-                        
-                        if (argName1 && (args[argName1] as unknown as T) != undefined) 
-                            results[0] = args[argName1] as T;
-
-                        if (argName2 && (args[argName2] as unknown as U) != undefined) 
-                            results[1] = args[argName2] as U;
-            
-                        if (argName3 && (args[argName3] as unknown as K) != undefined) 
-                            results[2] = args[argName3] as K;
-            
-                        if (argName4 && (args[argName4] as unknown as Y) != undefined) 
-                            results[3] = args[argName4] as Y;
-            
-                        if (argName5 && (args[argName5] as unknown as J) != undefined) 
-                            results[4] = args[argName5] as J;
-            
-                        if (argName6 && (args[argName6] as unknown as V) != undefined) 
-                            results[5] = args[argName6] as V;
-
-                        return results;
-
-                    } 
-                });
-            
-        }
-    }
-
-    
-
-    public static GetArgumentsHandler(target : IController, methodName : string ) : IArgumentResolverHandler | undefined
-    {
-        let handler = this.GetMetaData<IArgumentResolverHandler>(ControllersDecorators.ArgumentsHandlerKeyMetadata, target, methodName);
-
-        return handler;
-    }
-    
-    private static SetMetaData<T>(key: string, target : Object, methodName : string, value : T)
-    {
-        var meta = Reflect.getOwnMetadata(key, target as Object, methodName);
-    
-        if(!meta)
-            Reflect.defineMetadata(key, value, target as Object, methodName);
-    }
-
-
-    private static GetMetaData<T>(key: string, target : Object, methodName : string) : T | undefined
-    {
-        var meta = Reflect.getMetadata(key, target, methodName);
-    
-        if(meta != undefined)
-            return meta as T;
-        else 
-            return undefined;
-    }    
-
-}
-interface IArgumentResolverHandler
-{
-    Arguments : string[];
-    CreateArgumentsList : (args :any) => any[];
-}
-
-

package/dependencyInjection/DependecyService.ts

@@ -1,36 +0,0 @@
-export default class DependecyService
-{
-    private static _services : IService[] = [];
-
-    public static RegisterFor(type : Function, ctor : { new (...args : any[]) : any;}, builder? : () => any) : void    
-    {        
-        let defaultBuilder = () =>  Reflect.construct(ctor ?? type, []) as any;
-
-        this._services.push({ Type : type, Builder : builder ?? defaultBuilder });        
-    }
-
-    public static Register(type : Function, builder? : () => any) : void
-    {
-        let defaultBuilder = () => Reflect.construct(type, []);
-
-        this._services.push({ Type : type, Builder : builder ?? defaultBuilder });
-    }
-    
-    public static Resolve<T>(type : Function, args? : any[]) : T
-    {
-        return this._services.find(u => u.Type == type)?.Builder(args) as T;
-    }
-
-    public static ResolveCtor(ctor : Function, args? : any[]) : any
-    {
-        return this._services.find(u => u.Type == ctor)?.Builder(args);
-    }
-
-}
-
-
-interface IService
-{
-    Type : Function;
-    Builder : Function;
-}

package/enums/httpVerbs/HttpVerbs.ts

@@ -1,7 +0,0 @@
-export enum HTTPVerbs
-{
-    GET = "GET", 
-    POST = "POST", 
-    PUT = "PUT", 
-    DELETE = "DELETE"
-}

package/interfaces/IApplication.ts

@@ -1,13 +0,0 @@
-import { Express } from "express";
-import IApplicationConfiguration from './IApplicationConfiguration';
-
-import IController from "./IController";
-
-export default interface IApplication
-{
-    Express : Express;
-
-    StartAsync() : Promise<void>;    
-
-    Configure(appConfig : IApplicationConfiguration): void;
-}

package/interfaces/IApplicationConfiguration.ts

@@ -1,6 +0,0 @@
-export default interface IApplicationConfiguration
-{
-    Host : string;    
-    Port : number;
-    StartAsync() : Promise<void>
-}

package/interfaces/IController.ts

@@ -1,8 +0,0 @@
-import IApplication from "./IApplication";
-import {Request, Response} from 'express'
-
-export default interface IController
-{
-    Request : Request;
-    Response : Response;
-}

package/interfaces/entities/IDirectory.ts

@@ -1,6 +0,0 @@
-export interface IDirectory
-{
-    Path : string;
-    SubDirectories? : string[],
-    Files? : string[]
-}

package/jest.config.ts

@@ -1,6 +0,0 @@
-/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
-module.exports = {
-  preset: 'ts-jest',
-  testEnvironment: 'node',
-  modulePathIgnorePatterns: ['<rootDir>/__test__/classes/'],
-};

package/midlewares/IMidleware.ts

@@ -1,6 +0,0 @@
-import { Request } from "express";
-
-export default interface IMidleware
-{
-    (req : Request) : void
-}