# springboot-express ### Set up `npm i springboot-express` ## Usage Springboot-express allows of use express as springboot java but to minima. For use it you need to enabled `experimentalDecorators` property in your tsconfig.json as this framework use the annotations expressions, and as saying official documentation of typescript. Decorators are a stage 2 proposal for JavaScript and are available as an experimental feature of TypeScript. Springboot-express use Express framework as environment. ### Annotation - `@Spring.GetMapping( endpoint: string [, authLevel ] )` - `@Spring.PostMapping( endpoint: string [, authLevel ] )` - `@Spring.PutMapping( endpoint: string [, authLevel ] )` - `@Spring.DeleteMapping( endpoint: string [, authLevel ] )` - `@Spring.HeadMapping( endpoint: string [, authLevel ] )` - `@Spring.Configuration( path: string )` : don't support singleton pattern - `@Spring.Instance` ### Steps - Configuration Properties - Master controller - Server Environment configuration - Open Server # Configuration Properties - config.json ````json { "gateway": "0.0.0.0", "httpProtocol": true, "httpsProtocol": false, "port": 80, "sslPort": 443, "pagesDirectory": "src/dao/controller/pages" } ```` or properties file : ````properties gateway = 0.0.0.0 httpProtocol = true httpsProtocol = false port = 80 sslPort = 443 pagesDirectory = src/dao/controller/pages ```` Only for these properties, if they are not declared here is their value by default : - gateway : `0.0.0.0` - port : `80` - sslPort : `443` These parameters are mandatory and essential : - **pagesDirectory** : Absolute path directory - httpProtocol : `boolean` logger properties configuration : → [here](https://github.com/devGnode/logger20js#readme) ### Run with from your owns properties file configuration : - Form Master controller call : `loadProperties( path:string )` ````typescript this.loadProperties(process.cwd()+"/src/config/config.json"); ```` ### Run with annotation : Put this annotation at the top of your master class controller. This annotation don't support singleton pattern !! > @Spring.Configuration( path: string ) ````typescript @Spring.Configuration( path: string ) export class MasterController extends ExpressSpringApp{ constructor() { super(); } public config():MasterController{ // your config middleware .... beforeRunCallback ... return this; } } ```` ### Run with from owns properties class #### Organize Properties Configuration Best patrice : - Create your propertiesConfig class as below : ````typescript import {IPropertiesFile} from "lib-utils-ts"; import {Properties, PropertiesJson} from "lib-utils-ts"; export class PropertiesConfig implements IPropertiesFile{ private static readonly INSTANCE = new PropertiesConfig(); public static readonly CONFIG_FILE = process.cwd()+"/src/config/config.json"; private config: Properties; constructor() { try{ this.config = new PropertiesJson(); this.config.load(PropertiesConfig.getClass().getResourcesAsStream(process.cwd()+"/src/config/config.json" )); }catch (e) { console.log(e); } } public getProperty(key: string, defaultValue?: Object): Object { return this.config.getProperty(key,defaultValue); } public setProperty(key: string, value: Object): void { return this.config.setProperty(key,value); } /* .... more precise .... */ public static getInstance(){return this.INSTANCE;} } ```` otherwise : ````typescript import {Properties} from "lib-utils-ts"; try { properties: Properties = new PropertiesJson(); properties.load(PropertiesConfig.getClass().getResourcesAsStream(process.cwd() + "/src/config/config.json")); } catch (e) { console.log(e); } export const properties; ```` # Master Controller > public abstract class ExpressSpringApp extends ExpressSpringApplicationImpl Protected properties : - `prop: IPropertiesFile` - `baseUrl:string = "/v1"` - `middleWare: MiddleWare` Methods : - `getBaseUrl( ):string` : - `getApp( ):express.Application` : Express application handler - `getMiddleWare(): MiddleWare` : Express middleware - `setMockDefaultUserAccess( level: Spring;AUTH_LEVEL )` : Express middleware ( devTools Mock user without token ) - `loadProperties( path:string ):ExpressSpringApplicationImpl` : Express middleware - `config(): ExpressSpringApplicationImpl` : Throwable not implemented should be implemented in your MasterController - `initPages():ExpressSpringApplicationImpl` - `sslProtocol( ):void` - `listen( ):void` If you have somme importation error with `pagesDirectory` properties declare these properties here as below : > PropertiesConfig.getInstance().setProperty("pagesDirectory", process.cwd()+"/src/pages" ); ````typescript export class MasterController extends ExpressSpringApp{ private static readonly INSTANCE:MasterController = new MasterController(); constructor() { // Run with your owns properties class super(PropertiesConfig.getInstance()); // Run from your owns properties file // this.loadProperties( ".." ); } public config():MasterController{ return this; } public static getInstance( ):MasterController{return PortusController.INSTANCE;} } ```` Pages : Static Pages Handler: `````typescript export class Authentication { @Spring.GetMapping("/v1/authentication/firstFactor") public static firstFactorConnection(req: Request, res: Response):void{ res.json({ bar: "foo-bar" }); } @Spring.PostMapping("/v1/authentication/twoFactor") public static secondFactorConnection(req: Request, res: Response):void{ res.json({ bar: "foo-bar" }); } @Spring.PutMapping("/v1/admin", Spring.AUTH_LEVEL.ADMIN ) public static secondFactorConnection(req: Request, res: Response):void{ res.json({ bar: "foo-bar" }); } @Spring.DeleteMapping("/v1/logs", Spring.AUTH_LEVEL.USER ) public static secondFactorConnection(req: Request, res: Response):void{ res.json({ bar: "foo-bar" }); } /*....*/ } ````` Instantiated object > @Spring.Instance `````typescript @Spring.Instance export class Authentication { private foo:string ="authorized secret passphrase"; private pass:boolean = true; @Spring.GetMapping("/v1/instance") public static firstFactorConnection(req: Request, res: Response):void{ this.pass = true; res.json({ bar: this.foo }); } @Spring.PostMapping("/v1/instance/foo") public static secondFactorConnection(req: Request, res: Response):void{ if(!this.pass){ res.status(401).json({ status: "Unauthorized" }); return; } res.json({ bar: "foo-bar" }); } } ````` # Open Server ````typescript MasterController.getInstance().config().initPages().listen(); ```` If you want run the server when you have use `@Spring.Configuration` annotation you can use this trick : ````typescript new MasterController().config().initPages().listen(); ```` # MiddleWares - `jsonBodyParser( ):MidddleWare` : npm body-parser middleware - `cookieParser():MidddleWare` : not rpm cookie-parser, Home made cookie parser. - `routeLogger( pattern:string = null ):MiddleWare` : see documentation → [logger20js-ts express middleware](https://github.com/devGnode/logger20js#express-middleware-logger--120) - `jwtAuthorization( secret:string|Buffer, algorithm:ALGORITHM_JWT_ACCEPTED =ALGORITHM_JWT_ACCEPTED.HS256, cookieUser:Cookie = null):MidddleWare` → [doc](https://github.com/devGnode/springboot-express/tree/improvment/importation-pages#authorization-use-jwt-token) Define your middleware in your config method from your master class controller ````typescript public config( ):ExpressSpringApplicationImpl{ this.getMiddleWare() .jsonBodyParser() .cookieParser(); /*....*/ } ```` ### Cookie Parsing Enabled from your middleware config : `cookieParser()` Get cookie from callback : - property object: springboot > get cookie by this way : req["springboot"] ````typescript import {List} from "lib-utils-ts/src/Interface"; import {Cookie} from "lib-utils-ts/src/net/Cookie"; /*...*/ /*...*/ @Spring.GetMapping("/v1/getCookie") public static firstFactorConnection(req: Request, res: Response):void{ let spring:SpringbootReq = req["springboot"]; let cookie: List = spring.getCookie(); cookie.stream().each((value:Cookie)=>{ console.log( value.getName().trim() ) }); // getCookie cookie.stream() .filter(cookie=>cookie.getName().trim().equals("myCookie")) .findFirst() .orElse(null); res.send("OK"); } ```` # Authorization use JWT token Endpoint user authorization : | NAME | VALUE | |:---|:---:| | ALL | 0x00 | | ADMIN | 0x01 | | OPERATOR | 0x02 | | SELLER | 0x04 | | CUSTOMER | 0x08 | - `GetMapping( route: string, level: Spring.AUTH_LEVEL = Spring.AUTH_LEVEL.ALL )` - `PostMapping( route: string, level: Spring.AUTH_LEVEL = Spring.AUTH_LEVEL.ALL )` - `PutMapping( route: string, level: Spring.AUTH_LEVEL = Spring.AUTH_LEVEL.ALL) ` - `DeleteMapping( route: string, level: Spring.AUTH_LEVEL = Spring.AUTH_LEVEL.ALL )` - `HeadMapping( route: string, level: Spring.AUTH_LEVEL = Spring.AUTH_LEVEL.ALL )` ### 2 Methods ( Cookie, Header ) - Header bearer Authorization token ***Default*** ( Cookie argument is null by default ! ) - Cookie Authorization token Prototype of `jwtAuthorization` : - Secret : can be a buffer of a private key ( pem file ) or a simple string of characters - algorithm : HS256, RS256 - cookie : Cookie object. `new Cookie("NAME_OF_COOKIE")` if you want use by cookie Auth mode. Config Steps : if you use the feature by cookie way and cookieParser too. Make sur you have call `cookieParser` middleware before `jwtAuthorization` middleware. Cookie `HS256` : ````typescript public config( ):ExpressSpringApplicationImpl{ this.getMiddleWare() .cookieParser() .jwtAuthorization( "secret", ALGORITHM_JWT_ACCEPTED.HS256, new Cookie("jwtToken") );; /*....*/ } ```` Cookie `RS256` : ````typescript public config( ):ExpressSpringApplicationImpl{ this.getMiddleWare() .cookieParser() .jwtAuthorization( fs.readFileSync("key.pem"), ALGORITHM_JWT_ACCEPTED.RS256, new Cookie("jwtToken") );; /*....*/ } ```` ### Encode payload For have an access to your protect endpoint, make you payload as below : ````json { "sub": "username", "exp": 1616966915326, "access": [ { "role": 1 } ], } ```` ***Properties*** : - `sub` → username - `exp` → expiration timestamp - `access` → Object.role : Spring.AUTH_LEVEL ***Output*** : > eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJqbGhhd24iLCJleHAiOjE2MTY5NjY5MTUzMjYsImFjY2VzcyI6W3sicm9sZSI6MX1dfQ.LPtnpxS6h9Mz52c3XNhEcqJ8YkONuThAJJEW1BqUDSM ## :octocat: From git `` $ git clone https://github.com/devGnode/springboot-express.git ``