web_api_base 1.3.1 → 1.4.0

package/dist/Application.d.ts

@@ -6,5 +6,6 @@ export default abstract class Application implements IApplication {
     Express: Express;
     constructor();
     StartAsync(): Promise<void>;
+    UseCors(): void;
     abstract Configure(appConfig: IApplicationConfiguration): void;
 }

package/dist/Application.js

@@ -22,12 +22,16 @@ class Application {
     StartAsync() {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.ApplicationConfiguration.StartAsync();
+            this.Express.use(express_1.default.json({ limit: 50 * 1024 * 1024 }));
             this.Configure(this.ApplicationConfiguration);
             this.Express.listen(this.ApplicationConfiguration.Port, this.ApplicationConfiguration.Host, () => {
                 console.log(`App running on ${this.ApplicationConfiguration.Host}:${this.ApplicationConfiguration.Port}`);
             });
         });
     }
+    UseCors() {
+        this.Express.use(require('cors')());
+    }
 }
 exports.default = Application;
 //# sourceMappingURL=Application.js.map

package/dist/Application.js.map

@@ -1 +1 @@
-{"version":3,"file":"Application.js","sourceRoot":"","sources":["../Application.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AACA,sDAAoC;AACpC,0FAAiE;AAIjE,MAA8B,WAAW;IAQrC;QAEI,IAAI,CAAC,wBAAwB,GAAG,IAAI,kCAAwB,EAAE,CAAC;QAE/D,IAAI,CAAC,OAAO,GAAG,IAAA,iBAAa,GAAE,CAAC;IAEnC,CAAC;IAGY,UAAU;;YAEnB,MAAM,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC;YAEjD,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;YAE9C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,GAAE,EAAE;gBAE5F,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,CAAC,wBAAwB,CAAC,IAAI,IAAI,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,CAAC,CAAC;YAC9G,CAAC,CAAC,CAAA;QACN,CAAC;KAAA;CAKJ;AAhCD,8BAgCC"}
+{"version":3,"file":"Application.js","sourceRoot":"","sources":["../Application.ts"],"names":[],"mappings":";;;;;;;;;;;;;;AACA,sDAAoC;AACpC,0FAAiE;AAIjE,MAA8B,WAAW;IAQrC;QAEI,IAAI,CAAC,wBAAwB,GAAG,IAAI,kCAAwB,EAAE,CAAC;QAE/D,IAAI,CAAC,OAAO,GAAG,IAAA,iBAAa,GAAE,CAAC;IAEnC,CAAC;IAGY,UAAU;;YAEnB,MAAM,IAAI,CAAC,wBAAwB,CAAC,UAAU,EAAE,CAAC;YAEjD,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,iBAAa,CAAC,IAAI,CAAC,EAAC,KAAK,EAAG,EAAE,GAAG,IAAI,GAAG,IAAI,EAAC,CAAC,CAAC,CAAC;YAEjE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAAC;YAE9C,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,GAAE,EAAE;gBAE5F,OAAO,CAAC,GAAG,CAAC,kBAAkB,IAAI,CAAC,wBAAwB,CAAC,IAAI,IAAI,IAAI,CAAC,wBAAwB,CAAC,IAAI,EAAE,CAAC,CAAC;YAC9G,CAAC,CAAC,CAAA;QACN,CAAC;KAAA;IAEM,OAAO;QAEV,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC;IACxC,CAAC;CAMJ;AAxCD,8BAwCC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "web_api_base",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "web api base",  
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -14,6 +14,7 @@
     "run:tests": "npx jest"
   },
   "author": "adriano.marino1992@gmail.com",
+  "repository": "https://github.com/adrianomarino1992/web_api_base.git",
   "license": "ISC",
   "dependencies": {
     "@types/express": "^4.17.15",

package/readme.md

@@ -0,0 +1,86 @@
+# WEB_API_BASE
+
+web_api_base is a npm packaged that allows to create web-apis like MVC of .NET
+
+## Installation
+
+
+
+```bash
+npm install web_api_base
+```
+
+
+## Usage
+
+First of all we need implement the abstract class __Application__. 
+After that, we need to create some controllers and, they must inherit  the abstract class __ControllerBase__.
+
+### SampleController.ts
+
+```typescript
+
+import { ControllerBase, ControllersDecorators as CD, HTTPVerbs as verbs } from "web_api_base";
+
+@CD.Route("/sample")
+export default class SampleController extends ControllerBase
+{   
+    @CD.Verb(verbs.GET)
+    @CD.Action("/hello")
+    public Hello() : void
+    {
+        this.OK({message: "Hello Word!"})
+    }
+    
+}
+```
+
+### App.ts
+
+```typescript
+import SampleController from "./controllers/SampleController ";
+
+
+import { ControllerBase, Application, IApplicationConfiguration, DependecyService } from "web_api_base";
+
+export default class App extends Application
+{   
+    
+    public override Configure(appConfig: IApplicationConfiguration): void
+    {      
+        appConfig.Host = "0.0.0.0";
+        appConfig.Port = 5555;  
+       
+        //allow CORS
+        this.UseCors();
+
+        //register in DI service
+        DependecyService.Register(SampleController);  
+    
+        //append the controller in the pipe line of requests
+        ControllerBase.AppendController(SampleController,this);  
+
+    }  
+}
+```
+
+### Index.ts
+
+```typescript
+import Application from './Application';
+
+new Application().StartAsync();
+```
+
+
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first
+to discuss what you would like to change.
+
+Please make sure to update tests as appropriate.
+
+## License
+
+[MIT](https://choosealicense.com/licenses/mit/)