routup 1.0.0-alpha.2 → 1.0.0-alpha.4

package/README.md

@@ -1,4 +1,10 @@
-# routup 🧙‍
+<div align="center">
+
+[![Routup banner](./.github/assets/banner.png)](https://routup.net)
+
+</div>
+
+# Routup 🧙‍
 
 [![npm version](https://badge.fury.io/js/routup.svg)](https://badge.fury.io/js/routup)
 [![main](https://github.com/Tada5hi/routup/actions/workflows/main.yml/badge.svg)](https://github.com/Tada5hi/routup/actions/workflows/main.yml)

package/dist/helpers/index.d.ts

@@ -1,3 +1,2 @@
 export * from './request';
 export * from './response';
-export * from './type';

package/dist/helpers/request/cookie.d.ts

@@ -1,8 +1,11 @@
 /// <reference types="node" />
 import type { IncomingMessage } from 'node:http';
-import type { RequestFn } from '../type';
-export declare function setRequestCookieFn(fn: RequestFn): void;
+import type { Request } from '../../type';
+type RequestCookieFn = (req: Request) => Record<string, string>;
+export declare function setRequestCookieFn(fn: RequestCookieFn): void;
 export declare function useRequestCookies(req: IncomingMessage): Record<string, string>;
 export declare function hasRequestCookies(req: IncomingMessage): boolean;
 export declare function useRequestCookie(req: IncomingMessage, name: string): string | undefined;
-export declare function setRequestCookies(req: IncomingMessage, record: Record<string, any>, mergeIt?: boolean): void;
+export declare function setRequestCookies(req: IncomingMessage, record: Record<string, any>): void;
+export declare function extendRequestCookies(req: IncomingMessage, record: Record<string, any>): void;
+export {};

package/dist/helpers/request/query.d.ts

@@ -1,8 +1,11 @@
 import type { Request } from '../../type';
-import type { RequestFn } from '../type';
-export declare function setRequestQueryFn(fn: RequestFn): void;
+type RequestQueryFn = (req: Request) => Record<string, any>;
+export declare function setRequestQueryFn(fn: RequestQueryFn): void;
 export declare function useRequestQuery(req: Request): Record<string, any>;
 export declare function useRequestQuery(req: Request, key: string): any;
 export declare function hasRequestQuery(req: Request): boolean;
 export declare function setRequestQuery(req: Request, key: string, value: unknown): void;
-export declare function setRequestQuery(req: Request, record: Record<string, any>, append?: boolean): void;
+export declare function setRequestQuery(req: Request, record: Record<string, any>): void;
+export declare function extendRequestQuery(req: Request, key: string, value: unknown): void;
+export declare function extendRequestQuery(req: Request, record: Record<string, any>): void;
+export {};

package/dist/helpers/response/send-format.d.ts

@@ -1,6 +1,7 @@
 import type { Response } from '../../type';
-export type ResponseFormat = {
-    [key: string]: () => void;
+type ResponseFormats = {
     default: () => void;
+    [key: string]: () => void;
 };
-export declare function sendFormat(_res: Response, _format: ResponseFormat): void;
+export declare function sendFormat(res: Response, input: ResponseFormats): void;
+export {};

package/dist/index.cjs

@@ -3,9 +3,9 @@
 var continu = require('continu');
 var process = require('node:process');
 var zod = require('zod');
-var smob = require('smob');
 var crypto = require('node:crypto');
 var node_fs = require('node:fs');
+var smob = require('smob');
 var proxyAddr = require('proxy-addr');
 var mimeExplorer = require('mime-explorer');
 var http = require('@ebec/http');
@@ -15,15 +15,6 @@ var path = require('node:path');
 var pathToRegexp = require('path-to-regexp');
 var node_http = require('node:http');
 
-/*
- * 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) {
-    return !!item && typeof item === 'object' && !Array.isArray(item);
-}
-
 /**
  * Determine if object is a Stats object.
  *
@@ -31,8 +22,7 @@ var node_http = require('node:http');
  * @return {boolean}
  * @api private
  */ function isStatsObject(obj) {
-    // genuine fs.Stats
-    if (typeof node_fs.Stats === 'function' && obj instanceof node_fs.Stats) {
+    /* istanbul ignore next */ if (typeof node_fs.Stats === 'function' && obj instanceof node_fs.Stats) {
         return true;
     }
     // quack quack
@@ -65,6 +55,15 @@ 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) {
+    return !!item && typeof item === 'object' && !Array.isArray(item);
+}
+
 function buildEtagFn(input) {
     if (typeof input === 'function') {
         return input;
@@ -156,11 +155,11 @@ function isPromise(p) {
     }, timeout);
     res.once('close', ()=>{
         clearTimeout(instance);
-        if (typeof done === 'function') {
+        /* istanbul ignore next */ if (typeof done === 'function') {
             done();
         }
     });
-    res.once('error', (e)=>{
+    /* istanbul ignore next */ res.once('error', (e)=>{
         clearTimeout(instance);
         if (typeof done === 'function') {
             done(e);
@@ -366,7 +365,7 @@ function setRequestCookieFn(fn) {
     requestFn$1 = fn;
 }
 function useRequestCookies(req) {
-    if (!(CookieSymbol in req) && typeof requestFn$1 !== 'undefined') {
+    if (!(CookieSymbol in req) && typeof requestFn$1 === 'function') {
         req[CookieSymbol] = requestFn$1(req);
     }
     if (CookieSymbol in req) {
@@ -380,11 +379,12 @@ function hasRequestCookies(req) {
 function useRequestCookie(req, name) {
     return useRequestCookies(req)[name];
 }
-function setRequestCookies(req, record, mergeIt) {
+function setRequestCookies(req, record) {
+    req[CookieSymbol] = record;
+}
+function extendRequestCookies(req, record) {
     if (CookieSymbol in req) {
-        if (mergeIt) {
-            req[CookieSymbol] = smob.merge(req[CookieSymbol], record);
-        }
+        req[CookieSymbol] = smob.merge(req[CookieSymbol], record);
         return;
     }
     req[CookieSymbol] = record;
@@ -613,7 +613,7 @@ function setRequestMountPath(req, basePath) {
  * view the LICENSE file that was distributed with this source code.
  */ const ParamsSymbol = Symbol.for('ReqParams');
 function useRequestParams(req) {
-    if ('params' in req) {
+    /* istanbul ignore next */ if ('params' in req) {
         return req.params;
     }
     if (ParamsSymbol in req) {
@@ -700,25 +700,28 @@ function hasRequestQuery(req) {
     return QuerySymbol in req && isObject(req[QuerySymbol]);
 }
 function setRequestQuery(req, key, value) {
+    if (isObject(key)) {
+        req[QuerySymbol] = key;
+        return;
+    }
+    req[QuerySymbol] = {
+        [key]: value
+    };
+}
+function extendRequestQuery(req, key, value) {
     if (QuerySymbol in req) {
-        if (typeof key === 'object') {
-            if (value) {
-                req[QuerySymbol] = smob.merge(req[QuerySymbol], key);
-            } else {
-                req[QuerySymbol] = key;
-            }
+        if (isObject(key)) {
+            req[QuerySymbol] = smob.merge(req[QuerySymbol], key);
         } else {
             req[QuerySymbol][key] = value;
         }
         return;
     }
-    if (typeof key === 'object') {
-        req[QuerySymbol] = key;
+    if (isObject(key)) {
+        setRequestQuery(req, key);
         return;
     }
-    req[QuerySymbol] = {
-        [key]: value
-    };
+    setRequestQuery(req, key, value);
 }
 
 /*
@@ -807,20 +810,20 @@ function setResponseContentTypeByFileName(res, fileName) {
         }
     }
 }
-function onResponseFinished(res, cb) {
+/* istanbul ignore next */ function onResponseFinished(res, cb) {
     let called;
     const callCallback = (err)=>{
         if (called) return;
         called = true;
         cb(err);
     };
-    res.on('finish', async ()=>{
+    res.on('finish', ()=>{
         callCallback();
     });
-    res.on('close', async ()=>{
+    res.on('close', ()=>{
         callCallback();
     });
-    res.on('error', async (err)=>{
+    res.on('error', (err)=>{
         callCallback(err);
     });
 }
@@ -947,7 +950,7 @@ function sendCreated(res, chunk) {
     stream.on('open', ()=>{
         stream.pipe(res);
     });
-    stream.on('error', (err)=>{
+    /* istanbul ignore next */ stream.on('error', (err)=>{
         if (typeof fn === 'function') {
             fn(err);
         } else {
@@ -990,7 +993,7 @@ function sendFile(res, filePath, fn) {
         setResponseContentTypeByFileName(res, fileName);
     }
     resolveStats(options, (err, stats)=>{
-        if (err) {
+        /* istanbul ignore next */ if (err) {
             if (typeof fn === 'function') {
                 fn(err);
             } else {
@@ -1005,7 +1008,10 @@ function sendFile(res, filePath, fn) {
             const [x, y] = rangeHeader.replace('bytes=', '').split('-');
             streamOptions.end = Math.min(parseInt(y, 10) || stats.size - 1, stats.size - 1);
             streamOptions.start = parseInt(x, 10) || 0;
-            if (streamOptions.start >= stats.size || streamOptions.end >= stats.size) {
+            if (streamOptions.end >= stats.size) {
+                streamOptions.end = stats.size - 1;
+            }
+            if (streamOptions.start >= stats.size) {
                 res.setHeader(exports.HeaderName.CONTENT_RANGE, `bytes */${stats.size}`);
                 res.statusCode = 416;
                 res.end();
@@ -1019,16 +1025,20 @@ function sendFile(res, filePath, fn) {
         res.setHeader(exports.HeaderName.ACCEPT_RANGES, 'bytes');
         res.setHeader(exports.HeaderName.LAST_MODIFIED, stats.mtime.toUTCString());
         res.setHeader(exports.HeaderName.ETag, `W/"${stats.size}-${stats.mtime.getTime()}"`);
-        sendStream(res, node_fs.createReadStream(options?.filePath, streamOptions), fn);
+        sendStream(res, node_fs.createReadStream(options.filePath, streamOptions), fn);
     });
 }
 
-/*
- * 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 sendFormat(_res, _format) {}
+function sendFormat(res, input) {
+    const { default: formatDefault , ...formats } = input;
+    const contentTypes = Object.keys(formats);
+    const contentType = getRequestAcceptableContentType(res.req, contentTypes);
+    if (contentType) {
+        formats[contentType]();
+        return;
+    }
+    formatDefault();
+}
 
 function sendRedirect(res, location, statusCode = 302) {
     res.statusCode = statusCode;
@@ -1556,7 +1566,11 @@ exports.buildConfig = buildConfig;
 exports.buildEtagFn = buildEtagFn;
 exports.buildTrustProxyFn = buildTrustProxyFn;
 exports.cleanDoubleSlashes = cleanDoubleSlashes;
+exports.createEtag = createEtag;
 exports.createRequestTimeout = createRequestTimeout;
+exports.extendRequestCookies = extendRequestCookies;
+exports.extendRequestQuery = extendRequestQuery;
+exports.generateETag = generateETag;
 exports.getCharsetForMimeType = getCharsetForMimeType;
 exports.getConfigOption = getConfigOption;
 exports.getMimeType = getMimeType;