routup 1.0.0-alpha.6 → 1.0.1

package/README.md

@@ -66,7 +66,8 @@ router.listen(3000);
 
 ## Plugins
 
-According to the fact that routup is a minimalistic framework, it depends on plugins to cover some 
+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                                                            |

package/dist/constants.d.ts

@@ -1,4 +1,4 @@
-export declare enum Method {
+export declare enum MethodName {
     GET = "get",
     POST = "post",
     PUT = "put",
@@ -23,6 +23,7 @@ export declare enum HeaderName {
     COOKIE = "cookie",
     ETag = "etag",
     HOST = "host",
+    IF_MODIFIED_SINCE = "if-modified-since",
     IF_NONE_MATCH = "if-none-match",
     LAST_MODIFIED = "last-modified",
     LOCATION = "location",

package/dist/index.cjs

@@ -55,12 +55,7 @@ var node_http = require('node:http');
     return weak ? `W/${tag}` : tag;
 }
 
-/*
- * Copyright (c) 2022-2023.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */ function isObject(item) {
+function isObject(item) {
     return !!item && typeof item === 'object' && !Array.isArray(item);
 }
 
@@ -106,12 +101,7 @@ function buildTrustProxyFn(input) {
     return proxyAddr.compile(input || []);
 }
 
-/*
- * Copyright (c) 2022-2022.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */ function isInstance(input, name) {
+function isInstance(input, name) {
     return typeof input === 'object' && input !== null && input['@instanceof'] === Symbol.for(name);
 }
 
@@ -132,12 +122,7 @@ function getCharsetForMimeType(type) {
     return undefined;
 }
 
-/*
- * Copyright (c) 2022.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */ function isPath(input) {
+function isPath(input) {
     return typeof input === 'string' || input instanceof RegExp;
 }
 
@@ -167,12 +152,7 @@ function isPromise(p) {
     });
 }
 
-/*
- * Copyright (c) 2022-2023.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */ const TRAILING_SLASH_RE = /\/$|\/\?/;
+const TRAILING_SLASH_RE = /\/$|\/\?/;
 function hasTrailingSlash(input = '', queryParams = false) {
     if (!queryParams) {
         return input.endsWith('/');
@@ -255,21 +235,16 @@ function getConfigOption(key) {
     return config.get(key);
 }
 
-/*
- * Copyright (c) 2022-2023.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */ exports.Method = void 0;
-(function(Method) {
-    Method["GET"] = 'get';
-    Method["POST"] = 'post';
-    Method["PUT"] = 'put';
-    Method["PATCH"] = 'patch';
-    Method["DELETE"] = 'delete';
-    Method["OPTIONS"] = 'options';
-    Method["HEAD"] = 'head';
-})(exports.Method || (exports.Method = {}));
+exports.MethodName = void 0;
+(function(MethodName) {
+    MethodName["GET"] = 'get';
+    MethodName["POST"] = 'post';
+    MethodName["PUT"] = 'put';
+    MethodName["PATCH"] = 'patch';
+    MethodName["DELETE"] = 'delete';
+    MethodName["OPTIONS"] = 'options';
+    MethodName["HEAD"] = 'head';
+})(exports.MethodName || (exports.MethodName = {}));
 exports.HeaderName = void 0;
 (function(HeaderName) {
     HeaderName["ACCEPT"] = 'accept';
@@ -287,6 +262,7 @@ exports.HeaderName = void 0;
     HeaderName["COOKIE"] = 'cookie';
     HeaderName["ETag"] = 'etag';
     HeaderName["HOST"] = 'host';
+    HeaderName["IF_MODIFIED_SINCE"] = 'if-modified-since';
     HeaderName["IF_NONE_MATCH"] = 'if-none-match';
     HeaderName["LAST_MODIFIED"] = 'last-modified';
     HeaderName["LOCATION"] = 'location';
@@ -357,13 +333,8 @@ function extendRequestBody(req, key, value) {
     setRequestBody(req, key, value);
 }
 
-/*
- * Copyright (c) 2022.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */ function isRequestCacheable(req, modifiedTime) {
-    const modifiedSince = req.headers['if-modified-since'];
+function isRequestCacheable(req, modifiedTime) {
+    const modifiedSince = req.headers[exports.HeaderName.IF_MODIFIED_SINCE];
     if (!modifiedSince) {
         return false;
     }
@@ -454,12 +425,7 @@ function unsetRequestEnv(req, key) {
     }
 }
 
-/*
- * Copyright (c) 2022.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */ function getRequestHeader(req, name) {
+function getRequestHeader(req, name) {
     return req.headers[name];
 }
 function setRequestHeader(req, name, value) {
@@ -612,12 +578,7 @@ function getRequestIP(req, options) {
     return proxyAddr(req, trustProxy);
 }
 
-/*
- * Copyright (c) 2022.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */ const ReqMountPathSymbol = Symbol.for('ReqMountPath');
+const ReqMountPathSymbol = Symbol.for('ReqMountPath');
 function useRequestMountPath(req) {
     if (ReqMountPathSymbol in req) {
         return req[ReqMountPathSymbol];
@@ -628,12 +589,7 @@ function setRequestMountPath(req, basePath) {
     req[ReqMountPathSymbol] = basePath;
 }
 
-/*
- * Copyright (c) 2022.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */ const ParamsSymbol = Symbol.for('ReqParams');
+const ParamsSymbol = Symbol.for('ReqParams');
 function useRequestParams(req) {
     /* istanbul ignore next */ if ('params' in req) {
         return req.params;
@@ -655,15 +611,20 @@ function setRequestParam(req, key, value) {
     setRequestParams(req, params);
 }
 
+const PathSymbol = Symbol.for('ReqPath');
 function useRequestPath(req) {
     if ('path' in req) {
         return req.path;
     }
+    if (PathSymbol in req) {
+        return req[PathSymbol];
+    }
     if (typeof req.url === 'undefined') {
         return '/';
     }
     const parsed = new node_url.URL(req.url, 'http://localhost/');
-    return parsed.pathname;
+    req[PathSymbol] = parsed.pathname;
+    return req[PathSymbol];
 }
 
 function getRequestProtocol(req, options) {
@@ -741,12 +702,7 @@ function extendRequestQuery(req, key, value) {
     setRequestQuery(req, key, value);
 }
 
-/*
- * Copyright (c) 2022.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */ function setResponseCacheHeaders(res, options) {
+function setResponseCacheHeaders(res, options) {
     options = options || {};
     const cacheControls = [
         'public'
@@ -761,12 +717,7 @@ function extendRequestQuery(req, key, value) {
     res.setHeader('cache-control', cacheControls.join(', '));
 }
 
-/*
- * Copyright (c) 2022.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */ function appendResponseHeader(res, name, value) {
+function appendResponseHeader(res, name, value) {
     let header = res.getHeader(name);
     if (!header) {
         res.setHeader(name, value);
@@ -958,12 +909,7 @@ function sendCreated(res, chunk) {
     return send(res, chunk);
 }
 
-/*
- * Copyright (c) 2022.
- * Author Peter Placzek (tada5hi)
- * For the full copyright and license information,
- * view the LICENSE file that was distributed with this source code.
- */ function sendStream(res, stream, fn) {
+function sendStream(res, stream, fn) {
     stream.on('open', ()=>{
         stream.pipe(res);
     });
@@ -1210,16 +1156,16 @@ class Route {
     }
     matchMethod(method) {
         let name = method.toLowerCase();
-        if (name === exports.Method.HEAD && !smob.hasOwnProperty(this.layers, name)) {
-            name = exports.Method.GET;
+        if (name === exports.MethodName.HEAD && !smob.hasOwnProperty(this.layers, name)) {
+            name = exports.MethodName.GET;
         }
         return Object.prototype.hasOwnProperty.call(this.layers, name);
     }
     // --------------------------------------------------
     getMethods() {
         const keys = Object.keys(this.layers);
-        if (smob.hasOwnProperty(this.layers, exports.Method.GET) && !smob.hasOwnProperty(this.layers, exports.Method.HEAD)) {
-            keys.push(exports.Method.HEAD);
+        if (smob.hasOwnProperty(this.layers, exports.MethodName.GET) && !smob.hasOwnProperty(this.layers, exports.MethodName.HEAD)) {
+            keys.push(exports.MethodName.HEAD);
         }
         return keys;
     }
@@ -1230,8 +1176,8 @@ class Route {
             return;
         }
         let name = req.method.toLowerCase();
-        if (name === exports.Method.HEAD && !smob.hasOwnProperty(this.layers, name)) {
-            name = exports.Method.GET;
+        if (name === exports.MethodName.HEAD && !smob.hasOwnProperty(this.layers, name)) {
+            name = exports.MethodName.GET;
         }
         const layers = this.layers[name];
         /* istanbul ignore next */ if (typeof layers === 'undefined' || layers.length === 0 || typeof meta.path === 'undefined') {
@@ -1275,25 +1221,25 @@ class Route {
         }
     }
     get(...handlers) {
-        return this.register(exports.Method.GET, ...handlers);
+        return this.register(exports.MethodName.GET, ...handlers);
     }
     post(...handlers) {
-        return this.register(exports.Method.POST, ...handlers);
+        return this.register(exports.MethodName.POST, ...handlers);
     }
     put(...handlers) {
-        return this.register(exports.Method.PUT, ...handlers);
+        return this.register(exports.MethodName.PUT, ...handlers);
     }
     patch(...handlers) {
-        return this.register(exports.Method.PATCH, ...handlers);
+        return this.register(exports.MethodName.PATCH, ...handlers);
     }
     delete(...handlers) {
-        return this.register(exports.Method.DELETE, ...handlers);
+        return this.register(exports.MethodName.DELETE, ...handlers);
     }
     head(...handlers) {
-        return this.register(exports.Method.HEAD, ...handlers);
+        return this.register(exports.MethodName.HEAD, ...handlers);
     }
     options(...handlers) {
-        return this.register(exports.Method.OPTIONS, ...handlers);
+        return this.register(exports.MethodName.OPTIONS, ...handlers);
     }
     // --------------------------------------------------
     isStrictPath() {
@@ -1378,7 +1324,7 @@ class Router {
                 res.end();
                 return;
             }
-            if (req.method && req.method.toLowerCase() === exports.Method.OPTIONS) {
+            if (req.method && req.method.toLowerCase() === exports.MethodName.OPTIONS) {
                 const options = allowedMethods.map((key)=>key.toUpperCase()).join(',');
                 res.setHeader(exports.HeaderName.ALLOW, options);
                 send(res, options);
@@ -1427,8 +1373,8 @@ class Router {
                     match = layer.matchPath(path);
                     if (req.method && !layer.matchMethod(req.method)) {
                         match = false;
-                        if (req.method.toLowerCase() === exports.Method.OPTIONS) {
-                            allowedMethods = smob.mergeArrays(allowedMethods, layer.getMethods(), true);
+                        if (req.method.toLowerCase() === exports.MethodName.OPTIONS) {
+                            allowedMethods = smob.distinctArray(smob.merge(allowedMethods, layer.getMethods()));
                         }
                     }
                 }