bootpress 7.1.1 → 8.0.0

package/README.md

@@ -4,10 +4,16 @@
 <p align=center>Express but Spring Boot like</p>
 
 ## Quick Start
-Recommended tool: [create-bootpress-app](https://www.npmjs.com/package/create-bootpress-app)
+Recommended tool: **[create-bootpress-app](https://www.npmjs.com/package/create-bootpress-app)**
+___
 
 ## Methods
-### **<u>RestService</u>**: Converts all methods to Express RequestHandlers
+### **<u>RestService</u>**: Converts all methods to Express RequestHandlers.
+Http Response Status will inherit status field of returned value by method or 200 by default.
+
+Http Response Body will be mapped to 'data' field or value itself by default.
+
+If you want to explicitly specify a field named 'data' or 'status' it's recommended to encapsulate your value with HttpResponse class.
 #### Basic usage:
 ```ts
 import express from "express";
@@ -128,6 +134,96 @@ const LogService = new LogServiceImpl();
 
 app.get("/logs", LogService.findAll() as RequestHandler)
 ```
+
+### **Argument Passers**
+
+```PassBody(serviceFunction)``` -> Passes body to service function without any validation
+
+```ParseBodyAs(type)(serviceFunction)``` -> Parses body to specified type then passes it to service function
+
+```PassBodyAs(type)(serviceFunction)``` -> Validates body with provided type and passes it to service function
+
+```PassAllParams(serviceFunction)``` -> Passes all path parameters to service function as a Record<string, string> (pure js object that contains key-value pairs)
+
+```PassAllQueries(serviceFunction)``` -> Passes query to service function as Record<string, string>
+
+```PassAllCookies(serviceFunction)``` -> Passes cookies to service function as Record<string, string>
+
+```PassParams(...paramNames)(serviceFunction)``` -> Passes specified parameters as arguments to service function
+
+```PassQueries(...queryNames)(serviceFunction)``` -> Passes specified queries as arguments to service function
+
+```PassCookies(...cookieNames)(serviceFunction)``` -> Passes specified cookies as arguments to service function
+
+```PassRequest(serviceFunction)``` -> Passes express request object to service function
+
+```PassResponse(serviceFunction)``` -> Passes express response object to service function
+
+### Chaining argument passers:
+Argument passers can be chained by passing result of one as serviceFunction parameter to other. e.g.:
+```ts
+// in rest service class:
+function serviceFunction(cookies, body){
+    ...
+}
+// in router:
+router.post("/", PassAllCookies( PassBodyAs(yourSchema)(restService.serviceFunction) ));
+```
+
+
+## Helper Methods
+
+### **getOrThrow(value, httpError)**
+Returns the value back if it's not null, undefined or empty array.
+### **getOrElse(value, defaultValue)**
+Returns the value if it's not null or undefined otherwise returns the default value.
+### **schema(object)**
+Helps you to define a JS Schema.
+### **as(any, string | object | array)**
+Tries to parse any value to provided type.
+
+If type of provided type is string then it's a primitive key and valid values are:
+```
+"string"
+"string[]"
+"boolean"
+"boolean[]"
+"number"
+"number[]"
+"integer"
+"integer[]"
+"string?"
+"string[]?"
+"boolean?"
+"boolean[]?"
+"number?"
+"number[]?"
+"integer?"
+"integer[]?"
+```
+If typeof provided type is object then it's a JS Schema and structure must follow:
+```
+{
+    "property": string | object | array // Nullable primitives not allowed here instead use question mark end of the property key
+    "nullableProperty?": string | object | array
+}
+```
+
+If typeof provided type is an array the structure must follow: 
+```
+[
+    yourJsSchemaObject
+]
+```
+There must be only one element in an array schema which defines ````ArrayOf<Schema>````
+### **asStrict(any, string | object | array)**
+Same as 'as' method but doesn't try to parse different types instead throws error.
+
+## v8.0.0 Release Notes:
+- Added support for async service functions. (You don't need to await if you wrapped your service with Bootpress functions)
+- Bugfix for falsy response values
+- Simplified implementation
+
 ## v7.1.0 Release Notes:
 - getOrThrow: Throws specified error when value is an empty array too.
 ## v7.0.0 Release Notes:

package/index.d.ts

@@ -4,16 +4,17 @@ import { ArraySchema, JsSchema, ValidTypeKeys } from "./helpers"
 type RequestHandler = (req: Request, res: Response) => void
 type RequsetHandlerWithArgs = (...args: any[]) => RequestHandler
 
-type RestedService<T extends Record<string, any>> = { [K in keyof T]:
+type RestedService<T extends Record<PropertyKey, any>> = { [K in keyof T]:
     T[K] extends Function
     ? (...args: Parameters<T[K]>) => RequestHandler
     : T[K]
 }
 
-declare function RestService<T extends Record<string, any>>(clazz: new () => T): RestedService<T>;
-declare function RestService<T extends Record<string, any>>(service: T): RestedService<T>;
+type InstanceOrClass<T extends Record<PropertyKey, any>> = T | (new () => T);
+
+declare function RestService<T extends Record<PropertyKey, any>>(service: InstanceOrClass<T>): RestedService<T>;
 declare function RestMethod<T>(callback: () => T): RequestHandler;
-declare function Restify(target: any, key: string, desc: PropertyDescriptor): PropertyDescriptor;
+declare function Restify(target: any, key: PropertyKey, desc: PropertyDescriptor): PropertyDescriptor;
 
 declare function PassBody(serviceFunction: RequestHandler | RequsetHandlerWithArgs): RequestHandler
 declare function ParseBodyAs(type: ValidTypeKeys | JsSchema | ArraySchema ): (serviceFunction: RequestHandler | RequsetHandlerWithArgs) => RequestHandler

package/index.js

@@ -28,48 +28,57 @@ function RestService(service) {
         ...Object.getOwnPropertyDescriptors(service),
         ...Object.getOwnPropertyDescriptors(service.__proto__ || {})
     };
-    const alteredDescriptors = Object.fromEntries(Object.entries(descriptors).filter(keyvalue => !protectedProperties.includes(keyvalue[0])).map(keyvalue => {
+    const newService = {};
+    Object.entries(descriptors).filter(keyvalue => !protectedProperties.includes(keyvalue[0])).forEach(keyvalue => {
         const propertyName = keyvalue[0];
         const value = keyvalue[1].value;
         if (typeof value == "function" && !propertyName.startsWith("#")) {
-            return [
-                propertyName,
-                {
-                    value: ((...args) =>
-                        (req, res) => {
-                            try {
-                                const result = value.bind(service)(...args);
-                                if (result === undefined) {
-                                    throw new HttpError(200, "Your method is executed but it returned undefined. Please avoid using 'void' methods as service methods.");
-                                } else if (result === null) {
-                                    throw new HttpError(200, "Your method is executed but it returned null. At least a value is expected to be returned.");
-                                }
-                                reply(res, result.status || 200, result.data || result)
-                            } catch (e) {
-                                reply(res, e.status || 500, e.message || e);
-                            }
-                        }),
-                    configurable: keyvalue[1].configurable,
-                    writable: keyvalue[1].writable,
-                    enumerable: false
-                }
-            ]
+            newService[propertyName] = ((...args) =>
+                (req, res) => {
+                    try {
+                        const result = service[propertyName](...args);
+                        if (result == undefined) {
+                            reply(res, 204, null);
+                        }
+                        else if (result instanceof Promise) {
+                            result.then(r => {
+                                reply(res, r.status ?? 200, r.data ?? r);
+                            }).catch(e => {
+                                reply(res, e.status ?? 500, e.message ?? e);
+                            })
+                        }
+                        else {
+                            reply(res, result.status ?? 200, result.data ?? result)
+                        }
+                    } catch (e) {
+                        reply(res, e.status ?? 500, e.message ?? e);
+                    }
+                });
         } else {
-            return keyvalue;
+            newService[propertyName] = service[propertyName];
         }
-    }));
-    Object.defineProperties(service, alteredDescriptors);
-    return service;
+    })
+    return newService;
 }
 
 function RestMethod(callback) {
     return (req, res) => {
         try {
             const result = callback();
-            reply(res, result.status || 200, result.data || result);
-            return result;
+            if (result == undefined) {
+                reply(res, 204, null);
+            }
+            else if (result instanceof Promise) {
+                result.then(r => {
+                    reply(res, r.status ?? 200, r.data ?? r);
+                }).catch(e => {
+                    reply(res, e.status ?? 500, e.message ?? e);
+                })
+            } else {
+                reply(res, result.status ?? 200, result.data ?? result);
+            }
         } catch (e) {
-            reply(res, e.status || 500, e.message || e)
+            reply(res, e.status ?? 500, e.message ?? e)
         }
     }
 }
@@ -82,10 +91,20 @@ function Restify(target, key, desc) {
             return (req, res) => {
                 try {
                     const result = oldFunc(...args);
-                    reply(res, result.status || 200, result.data || result);
-                    return result;
+                    if (result == undefined) {
+                        reply(res, 204, null);
+                    }
+                    else if (result instanceof Promise) {
+                        result.then(r => {
+                            reply(res, r.status ?? 200, r.data ?? r);
+                        }).catch(e => {
+                            reply(res, e.status ?? 500, e.message ?? e);
+                        })
+                    } else {
+                        reply(res, result.status ?? 200, result.data ?? result);
+                    }
                 } catch (e) {
-                    reply(res, e.status || 500, e.message || e);
+                    reply(res, e.status ?? 500, e.message ?? e);
                 }
             }
         }).bind(target)
@@ -204,25 +223,25 @@ function PassBodyAs(type) {
 }
 
 function PassBody(actualHandler) {
-        return (...args) => {
-            if (isRequstHandlerArgs(args)) {
-                const req = args.at(-3); const res = args.at(-2);
+    return (...args) => {
+        if (isRequstHandlerArgs(args)) {
+            const req = args.at(-3); const res = args.at(-2);
+            try {
+                return actualHandler(req.body)(req, res);
+            } catch (e) {
+                reply(res, e.status || 500, e.message || e);
+            }
+
+        } else {
+            return (req, res) => {
                 try {
-                    return actualHandler(req.body)(req, res);
+                    return actualHandler(...args, req.body)(req, res);
                 } catch (e) {
-                    reply(res, e.status || 500, e.message || e);
-                }
-
-            } else {
-                return (req, res) => {
-                    try {
-                        return actualHandler(...args, req.body)(req, res);
-                    } catch (e) {
-                        reply(res, e.status || 500, e.message || e)
-                    }
+                    reply(res, e.status || 500, e.message || e)
                 }
             }
         }
+    }
 }
 
 function PassRequest(actualHandler) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bootpress",
-  "version": "7.1.1",
+  "version": "8.0.0",
   "description": "REST service methods for express",
   "main": "index.js",
   "repository": {