@galeh/chuka 1.0.5 → 1.0.7

package/README.md

@@ -0,0 +1,77 @@
+# Purpose
+This package aims at making the API programming much easier, using the expressjs as underlying library, it creates fast API's. It adds leverages expressjs by adding strong types, dependency injection and profound validation.
+
+# Example
+
+```typescript
+// main.ts
+const app = createApp({
+    dependencies: [
+        {
+            provide: 'catservice',
+            useClass: CatsService
+        }
+    ],    
+    routes: [
+        {
+            path: '/cats',
+            controller: CatsController
+        }
+    ],
+    middlewares: [
+        json()
+    ]
+});
+
+app.use((error: any, req: any, res: any, next: any) => {
+    res.status(400).json(error);
+})
+
+app.listen(8080, () => {
+    console.log('running application!');
+});
+
+```
+
+```typescript
+// example for a controller
+
+@injectable()
+export class CatsController extends Controller {
+    constructor(@inject('catservice') service: CatsServiceInterface) {
+        super();
+
+        const intercepted = this.middleware(
+            createLogger()
+        );
+
+        intercepted.middleware(
+            bodyValidator<CatModel>({
+                name: and(isDefined(), isString()),
+                country: isNumber(),
+                age: custom(model => Promise.resolve(!!(model.age && model.age > 2))),
+                parents: {
+                    name: isString(),
+                    parents: {
+                        country: isString(),
+                    }
+                }
+            })
+        ).post('/', async (req, res) => {{
+            const allcats = await service.add(req.body.name);
+            res.send(allcats);
+        }});
+        
+        intercepted.get('/', async (req, res) => {{
+            const allcats = await service.findAll();
+            res.send(allcats);
+        }});
+
+        intercepted.get('/:id', async (req, res) => {
+            const onecat = await service.findOne(+req.params.id);
+            res.send(onecat);
+        });
+    }
+}
+
+```

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@galeh/chuka",
-    "version": "1.0.5",
+    "version": "1.0.7",
     "description": "simple yet robust wrapper for expressjs",
     "keywords": [
         "chuka",
@@ -20,7 +20,10 @@
         "express-ws": "^5.0.2",
         "inversify": "^6.0.2",
         "reflect-metadata": "^0.2.1",
-        "tslib": "^2.6.2"
+        "tslib": "^2.6.2",
+        "@types/express": "^4.17.21",
+        "@types/express-ws": "^3.0.4",
+        "@types/ws": "^8.5.10"
     },
     "publishConfig": {
         "access": "public"