routup 3.0.0-alpha.2 → 3.0.0

package/README.md

@@ -61,6 +61,8 @@ as all concepts and basics are taught there.
 ### Handlers
 
 Both core and error handlers, can be defined in two different ways.
+Core handler functions can have up to 3 arguments (req, res, next) whereas error handler functions can have up to 4 arguments (err, req, res, next).
+This should be familiar to anyone who has used express before.
 
 **`Shorthand`**
 
@@ -187,17 +189,17 @@ According to the fact that routup is a minimalistic framework,
 it depends on [plugins](https://github.com/routup/plugins) to cover some 
 typically http framework functions, which are not integrated in the main package.
 
-| Name                                                                                          | Description                                                            |
-|-----------------------------------------------------------------------------------------------|------------------------------------------------------------------------|
-| [body](https://github.com/routup/plugins/tree/master/packages/body)                           | Read and parse the request body.                                       |
-| [cookie](https://github.com/routup/plugins/tree/master/packages/cookie)                       | Read and parse request cookies and serialize cookies for the response. |
-| [decorators](https://github.com/routup/plugins/tree/master/packages/decorators)               | Create request handlers with class-, method- & parameter-decorators.   |
-| [prometheus](https://github.com/routup/plugins/tree/master/packages/prometheus)               | Collect and serve metrics for prometheus.                              |
-| [query](https://github.com/routup/plugins/tree/master/packages/query)                         | Read and parse the query string of the request url.                    |
-| [rate-limit](https://github.com/routup/plugins/tree/master/packages/rate-limit)               | Rate limit incoming requests.                                          |
-| [rate-limit-redis](https://github.com/routup/plugins/tree/master/packages/rate-limit-redis)   | Redis adapter for the rate-limit plugin.                               |
-| [static](https://github.com/routup/plugins/tree/master/packages/static)                       | Serve static files from a directory.                                   |
-| [swagger](https://github.com/routup/plugins/tree/master/packages/swagger)                     | Serve generated docs from URL or based on a JSON file.                 |
+| Name                                                                                        | Description                                                            |
+|---------------------------------------------------------------------------------------------|------------------------------------------------------------------------|
+| [assets](https://github.com/routup/plugins/tree/master/packages/assets)                     | Serve static files from a directory.                                   |
+| [body](https://github.com/routup/plugins/tree/master/packages/body)                         | Read and parse the request body.                                       |
+| [cookie](https://github.com/routup/plugins/tree/master/packages/cookie)                     | Read and parse request cookies and serialize cookies for the response. |
+| [decorators](https://github.com/routup/plugins/tree/master/packages/decorators)             | Create request handlers with class-, method- & parameter-decorators.   |
+| [prometheus](https://github.com/routup/plugins/tree/master/packages/prometheus)             | Collect and serve metrics for prometheus.                              |
+| [query](https://github.com/routup/plugins/tree/master/packages/query)                       | Read and parse the query string of the request url.                    |
+| [rate-limit](https://github.com/routup/plugins/tree/master/packages/rate-limit)             | Rate limit incoming requests.                                          |
+| [rate-limit-redis](https://github.com/routup/plugins/tree/master/packages/rate-limit-redis) | Redis adapter for the rate-limit plugin.                               |
+| [swagger](https://github.com/routup/plugins/tree/master/packages/swagger)                   | Serve generated docs from URL or based on a JSON file.                 |
 
 ## Benchmarks
 

package/dist/index.cjs

@@ -79,6 +79,64 @@ function isError(input) {
     }, input);
 }
 
+function isRequestCacheable(req, modifiedTime) {
+    const modifiedSince = req.headers[exports.HeaderName.IF_MODIFIED_SINCE];
+    if (!modifiedSince) {
+        return false;
+    }
+    modifiedTime = typeof modifiedTime === 'string' ? new Date(modifiedTime) : modifiedTime;
+    return new Date(modifiedSince) >= modifiedTime;
+}
+
+const envSymbol = Symbol.for('ReqEnv');
+function setRequestEnv(req, key, value) {
+    if (envSymbol in req) {
+        if (typeof key === 'object') {
+            if (value) {
+                req[envSymbol] = smob.merge(req[envSymbol], key);
+            } else {
+                req[envSymbol] = key;
+            }
+        } else {
+            req[envSymbol][key] = value;
+        }
+        return;
+    }
+    if (typeof key === 'object') {
+        req[envSymbol] = key;
+        return;
+    }
+    req[envSymbol] = {
+        [key]: value
+    };
+}
+function useRequestEnv(req, key) {
+    if (envSymbol in req) {
+        if (typeof key === 'string') {
+            return req[envSymbol][key];
+        }
+        return req[envSymbol];
+    }
+    if (typeof key === 'string') {
+        return undefined;
+    }
+    return {};
+}
+function unsetRequestEnv(req, key) {
+    if (envSymbol in req) {
+        if (smob.hasOwnProperty(req[envSymbol], key)) {
+            delete req[envSymbol][key];
+        }
+    }
+}
+
+function getRequestHeader(req, name) {
+    return req.headers[name];
+}
+function setRequestHeader(req, name, value) {
+    req.headers[name] = value;
+}
+
 /*
   Set-Cookie header field-values are sometimes comma joined in one string. This splits them without choking on commas
   that are within a single set-cookie field-value, such as in the Expires portion.
@@ -364,160 +422,6 @@ function isWebResponse(input) {
     return typeof Response !== 'undefined' && input instanceof Response;
 }
 
-const BodySymbol = Symbol.for('ReqBody');
-function useRequestBody(req, key) {
-    let body;
-    /* istanbul ignore next */ if ('body' in req) {
-        body = req.body;
-    }
-    if (BodySymbol in req) {
-        if (body) {
-            body = smob.merge({}, req[BodySymbol], body);
-        } else {
-            body = req[BodySymbol];
-        }
-    }
-    if (body) {
-        if (typeof key === 'string') {
-            return body[key];
-        }
-        return body;
-    }
-    return typeof key === 'string' ? undefined : {};
-}
-function hasRequestBody(req) {
-    return 'body' in req || BodySymbol in req;
-}
-function setRequestBody(req, key, value) {
-    if (isObject(key)) {
-        req[BodySymbol] = key;
-        return;
-    }
-    req[BodySymbol] = {
-        [key]: value
-    };
-}
-function extendRequestBody(req, key, value) {
-    if (hasRequestBody(req)) {
-        const body = useRequestBody(req);
-        // body can not be merged :/
-        if (!isObject(body)) {
-            return;
-        }
-        if (isObject(key)) {
-            req[BodySymbol] = smob.merge({}, key, body);
-        } else {
-            body[key] = value;
-            req[BodySymbol] = body;
-        }
-        return;
-    }
-    if (isObject(key)) {
-        setRequestBody(req, key);
-        return;
-    }
-    setRequestBody(req, key, value);
-}
-
-function isRequestCacheable(req, modifiedTime) {
-    const modifiedSince = req.headers[exports.HeaderName.IF_MODIFIED_SINCE];
-    if (!modifiedSince) {
-        return false;
-    }
-    modifiedTime = typeof modifiedTime === 'string' ? new Date(modifiedTime) : modifiedTime;
-    return new Date(modifiedSince) >= modifiedTime;
-}
-
-const CookieSymbol = Symbol.for('ReqCookie');
-function useRequestCookies(req) {
-    if (CookieSymbol in req) {
-        return req[CookieSymbol];
-    }
-    return {};
-}
-function hasRequestCookies(req) {
-    return CookieSymbol in req && isObject(req[CookieSymbol]);
-}
-function useRequestCookie(req, name) {
-    return useRequestCookies(req)[name];
-}
-function setRequestCookies(req, key, value) {
-    if (isObject(key)) {
-        req[CookieSymbol] = key;
-        return;
-    }
-    req[CookieSymbol] = {
-        [key]: value
-    };
-}
-function extendRequestCookies(req, key, value) {
-    if (hasRequestCookies(req)) {
-        const cookies = useRequestCookies(req);
-        if (isObject(key)) {
-            req[CookieSymbol] = smob.merge({}, key, cookies);
-        } else {
-            cookies[key] = value;
-            req[CookieSymbol] = cookies;
-        }
-        req[CookieSymbol] = smob.merge(req[CookieSymbol], cookies);
-        return;
-    }
-    if (isObject(key)) {
-        setRequestCookies(req, key);
-        return;
-    }
-    setRequestCookies(req, key, value);
-}
-
-const envSymbol = Symbol.for('ReqEnv');
-function setRequestEnv(req, key, value) {
-    if (envSymbol in req) {
-        if (typeof key === 'object') {
-            if (value) {
-                req[envSymbol] = smob.merge(req[envSymbol], key);
-            } else {
-                req[envSymbol] = key;
-            }
-        } else {
-            req[envSymbol][key] = value;
-        }
-        return;
-    }
-    if (typeof key === 'object') {
-        req[envSymbol] = key;
-        return;
-    }
-    req[envSymbol] = {
-        [key]: value
-    };
-}
-function useRequestEnv(req, key) {
-    if (envSymbol in req) {
-        if (typeof key === 'string') {
-            return req[envSymbol][key];
-        }
-        return req[envSymbol];
-    }
-    if (typeof key === 'string') {
-        return undefined;
-    }
-    return {};
-}
-function unsetRequestEnv(req, key) {
-    if (envSymbol in req) {
-        if (smob.hasOwnProperty(req[envSymbol], key)) {
-            delete req[envSymbol][key];
-        }
-    }
-}
-
-function getRequestHeader(req, name) {
-    return req.headers[name];
-}
-function setRequestHeader(req, name, value) {
-    req.headers[name] = value;
-}
-
 const NegotiatorSymbol = Symbol.for('ReqNegotiator');
 function useRequestNegotiator(req) {
     if (NegotiatorSymbol in req) {
@@ -775,52 +679,6 @@ function getRequestProtocol(req, options) {
     return index !== -1 ? header.substring(0, index).trim() : header.trim();
 }
 
-const QuerySymbol = Symbol.for('ReqQuery');
-function useRequestQuery(req, key) {
-    /* istanbul ignore if  */ if ('query' in req) {
-        if (typeof key === 'string') {
-            return req.query[key];
-        }
-        return req.query;
-    }
-    if (QuerySymbol in req) {
-        if (typeof key === 'string') {
-            return req[QuerySymbol][key];
-        }
-        return req[QuerySymbol];
-    }
-    return typeof key === 'string' ? undefined : {};
-}
-function hasRequestQuery(req) {
-    return QuerySymbol in req && isObject(req[QuerySymbol]) || 'query' in req && isObject(req.query);
-}
-function setRequestQuery(req, key, value) {
-    if (isObject(key)) {
-        req[QuerySymbol] = key;
-        return;
-    }
-    req[QuerySymbol] = {
-        [key]: value
-    };
-}
-function extendRequestQuery(req, key, value) {
-    if (hasRequestQuery(req)) {
-        const query = useRequestQuery(req);
-        if (isObject(key)) {
-            req[QuerySymbol] = smob.merge({}, key, query);
-        } else {
-            query[key] = value;
-            req[QuerySymbol] = query;
-        }
-        return;
-    }
-    if (isObject(key)) {
-        setRequestQuery(req, key);
-        return;
-    }
-    setRequestQuery(req, key, value);
-}
-
 function createRequest(context) {
     let readable;
     if (context.body) {
@@ -1798,10 +1656,7 @@ function isPlugin(input) {
     if (typeof input.name !== 'undefined' && typeof input.name !== 'string') {
         return false;
     }
-    if (typeof input.install !== 'function' || input.install.length !== 1) {
-        return false;
-    }
-    return typeof input.version === 'undefined' || typeof input.version === 'string';
+    return typeof input.install === 'function' && input.install.length === 1;
 }
 
 function transformRouterOptions(input) {
@@ -1923,110 +1778,50 @@ class Router {
         }
         return false;
     }
-    delete(path, handler) {
-        if (isPath(path)) {
-            this.use({
-                ...handler,
-                method: exports.MethodName.DELETE,
-                path
-            });
-            return this;
-        }
-        this.use({
-            ...path,
-            method: exports.MethodName.DELETE
-        });
+    delete(...input) {
+        this.useForMethod(exports.MethodName.DELETE, ...input);
         return this;
     }
-    get(path, handler) {
-        if (isPath(path)) {
-            this.use({
-                ...handler,
-                method: exports.MethodName.GET,
-                path
-            });
-            return this;
-        }
-        this.use({
-            ...path,
-            method: exports.MethodName.GET
-        });
+    get(...input) {
+        this.useForMethod(exports.MethodName.GET, ...input);
         return this;
     }
-    post(path, handler) {
-        if (isPath(path)) {
-            this.use({
-                ...handler,
-                method: exports.MethodName.POST,
-                path
-            });
-            return this;
-        }
-        this.use({
-            ...path,
-            method: exports.MethodName.POST
-        });
+    post(...input) {
+        this.useForMethod(exports.MethodName.POST, ...input);
         return this;
     }
-    put(path, handler) {
-        if (isPath(path)) {
-            this.use({
-                ...handler,
-                method: exports.MethodName.PUT,
-                path
-            });
-            return this;
-        }
-        this.use({
-            ...path,
-            method: exports.MethodName.PUT
-        });
+    put(...input) {
+        this.useForMethod(exports.MethodName.PUT, ...input);
         return this;
     }
-    patch(path, handler) {
-        if (isPath(path)) {
-            this.use({
-                ...handler,
-                method: exports.MethodName.PATCH,
-                path
-            });
-            return this;
-        }
-        this.use({
-            ...path,
-            method: exports.MethodName.PATCH
-        });
+    patch(...input) {
+        this.useForMethod(exports.MethodName.PATCH, ...input);
         return this;
     }
-    head(path, handler) {
-        if (isPath(path)) {
-            this.use({
-                ...handler,
-                method: exports.MethodName.HEAD,
-                path
-            });
-            return this;
-        }
-        this.use({
-            ...path,
-            method: exports.MethodName.HEAD
-        });
+    head(...input) {
+        this.useForMethod(exports.MethodName.HEAD, ...input);
+        return this;
+    }
+    options(...input) {
+        this.useForMethod(exports.MethodName.OPTIONS, ...input);
         return this;
     }
-    options(path, handler) {
-        if (isPath(path)) {
+    // --------------------------------------------------
+    useForMethod(method, ...input) {
+        const base = {
+            method
+        };
+        for(let i = 0; i < input.length; i++){
+            const element = input[i];
+            if (isPath(element)) {
+                base.path = element;
+                continue;
+            }
             this.use({
-                ...handler,
-                method: exports.MethodName.OPTIONS,
-                path
+                ...base,
+                ...element
             });
-            return this;
         }
-        this.use({
-            ...path,
-            method: exports.MethodName.OPTIONS
-        });
-        return this;
     }
     use(...input) {
         const modifyPath = (input)=>{
@@ -2052,6 +1847,7 @@ class Router {
             if (isHandler(item)) {
                 item.path = path || modifyPath(item.path);
                 this.stack.push(new Layer(item));
+                continue;
             }
             if (isPlugin(item)) {
                 if (path) {
@@ -2068,15 +1864,15 @@ class Router {
     // --------------------------------------------------
     install(plugin, context = {}) {
         const name = context.name || plugin.name;
+        const router = new Router({
+            name
+        });
+        plugin.install(router);
         if (context.path) {
-            const router = new Router({
-                name
-            });
-            plugin.install(router);
             this.use(context.path, router);
-            return this;
+        } else {
+            this.use(router);
         }
-        plugin.install(this);
         return this;
     }
     // --------------------------------------------------
@@ -2114,9 +1910,6 @@ exports.dispatchNodeRequest = dispatchNodeRequest;
 exports.dispatchRawRequest = dispatchRawRequest;
 exports.dispatchWebRequest = dispatchWebRequest;
 exports.errorHandler = errorHandler;
-exports.extendRequestBody = extendRequestBody;
-exports.extendRequestCookies = extendRequestCookies;
-exports.extendRequestQuery = extendRequestQuery;
 exports.getRequestAcceptableCharset = getRequestAcceptableCharset;
 exports.getRequestAcceptableCharsets = getRequestAcceptableCharsets;
 exports.getRequestAcceptableContentType = getRequestAcceptableContentType;
@@ -2129,9 +1922,6 @@ exports.getRequestHeader = getRequestHeader;
 exports.getRequestHostName = getRequestHostName;
 exports.getRequestIP = getRequestIP;
 exports.getRequestProtocol = getRequestProtocol;
-exports.hasRequestBody = hasRequestBody;
-exports.hasRequestCookies = hasRequestCookies;
-exports.hasRequestQuery = hasRequestQuery;
 exports.isError = isError;
 exports.isHandler = isHandler;
 exports.isLayerInstance = isLayerInstance;
@@ -2151,29 +1941,22 @@ exports.sendRedirect = sendRedirect;
 exports.sendStream = sendStream;
 exports.sendWebBlob = sendWebBlob;
 exports.sendWebResponse = sendWebResponse;
-exports.setRequestBody = setRequestBody;
-exports.setRequestCookies = setRequestCookies;
 exports.setRequestEnv = setRequestEnv;
 exports.setRequestHeader = setRequestHeader;
 exports.setRequestMountPath = setRequestMountPath;
 exports.setRequestParam = setRequestParam;
 exports.setRequestParams = setRequestParams;
-exports.setRequestQuery = setRequestQuery;
 exports.setRequestRouterPath = setRequestRouterPath;
 exports.setResponseCacheHeaders = setResponseCacheHeaders;
 exports.setResponseContentTypeByFileName = setResponseContentTypeByFileName;
 exports.setResponseHeaderAttachment = setResponseHeaderAttachment;
 exports.setResponseHeaderContentType = setResponseHeaderContentType;
 exports.unsetRequestEnv = unsetRequestEnv;
-exports.useRequestBody = useRequestBody;
-exports.useRequestCookie = useRequestCookie;
-exports.useRequestCookies = useRequestCookies;
 exports.useRequestEnv = useRequestEnv;
 exports.useRequestMountPath = useRequestMountPath;
 exports.useRequestNegotiator = useRequestNegotiator;
 exports.useRequestParam = useRequestParam;
 exports.useRequestParams = useRequestParams;
 exports.useRequestPath = useRequestPath;
-exports.useRequestQuery = useRequestQuery;
 exports.useRequestRouterPath = useRequestRouterPath;
 //# sourceMappingURL=index.cjs.map