Problem Details API

- Change all error responses to Problem Details
- UUIDv7
- PublicPathMiddleware: Directory auto index
- CORSMiddleware: Access-Control-Allow-Credentials
- Add support for Range when sending a file

Author: modscleo4

README.md

@@ -19,15 +19,28 @@ Midori is an opinionated Web API Framework designed for Node.js, using Node.js's
     - [x] JWE
     - [x] JWK
 - [x] CORS
+- [x] Content Security Policy
 - [x] Static Files
-- [x] Body Parser
-    - [x] JSON BigInt support
+- [x] Response Compression using `node:zlib` module
+    - [x] Gzip
+    - [x] Deflate
+    - [x] Brotli
+- [x] Extensible Body Parser and Response Serializer
+    - [x] JSON+BigInt
+    - [x] CSV
+    - [x] Form
+    - [x] Multipart
+    - [x] Streams
 - [x] Hashing using native Node.js `node:crypto` module
     - [x] PBKDF2
     - [x] Scrypt
     - [x] SHA-256
     - [x] SHA-512
-- [x] Basic Validation
+- [x] Problem Details
+- [x] Request Validation
+- [x] Auth
+    - [x] Basic
+    - [x] Bearer
 
 ## Roadmap
 - [ ] Tests
@@ -149,7 +162,10 @@ The HTTP module is responsible for handling HTTP requests and responses.
 import { Application } from 'midori/app';
 import { Request, Response } from 'midori/http';
 
-const handler = async (req: Request, app: Application): Promise<Response> {
+const handler = async (
+    req: Request,
+    app: Application
+): Promise<Response> {
     // ...
 }
 ```
@@ -158,7 +174,11 @@ const handler = async (req: Request, app: Application): Promise<Response> {
 import { Application } from 'midori/app';
 import { Request, Response } from 'midori/http';
 
-const middleware = async (req: Request, next: (req: Request) => Promise<Response>, app: Application): Promise<Response> {
+const middleware = async (
+    req: Request,
+    next: (req: Request) => Promise<Response>,
+    app: Application
+): Promise<Response> {
     // ...
 }
 ```

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@modscleo4/midori",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Midori is a Node.js web API framework with minimal dependencies and based on PSR ideas.",
   "type": "module",
   "keywords": [
@@ -101,8 +101,8 @@
   },
   "devDependencies": {
     "@types/mime-types": "^2.1.4",
-    "@types/node": "^20.10.0",
-    "typescript": "^5.3.2"
+    "@types/node": "^20.12.7",
+    "typescript": "^5.4.5"
   },
   "dependencies": {
     "mime-types": "^2.1.35"

package.json

@@ -14,6 +14,8 @@
  * limitations under the License.
  */
 
+import { OutgoingHttpHeaders } from "http";
+
 /**
  * Basic HTTP Error with a status code and message.
  * The HTTPErrorMiddleware will catch this error and send the status code and message to the client.
@@ -23,14 +25,17 @@ export default class HTTPError extends Error {
 
     constructor(
         message: string,
-        public status: number = 500
+        public status: number = 500,
+        public extra: Record<string, unknown> = {},
+        public extraHeaders: OutgoingHttpHeaders = {},
     ) {
         super(message);
     }
 
     toJSON(): object {
         return {
             message: this.message,
+            ...this.extra,
         };
     }
 }

src/errors/HTTPError.ts

@@ -22,13 +22,6 @@ export default class ValidationError extends HTTPError {
         message: string = 'Some fields are invalid',
         status: number = 400,
     ) {
-        super(message, status);
-    }
-
-    override toJSON(): object {
-        return {
-            ...super.toJSON(),
-            errors: this.errors,
-        };
+        super(message, status, { errors });
     }
 }

src/errors/ValidationError.ts

@@ -87,3 +87,140 @@ export enum EStatusCode {
     NOT_EXTENDED = 510,
     NETWORK_AUTHENTICATION_REQUIRED = 511
 }
+
+export function titleFromStatus(status: number): string | null {
+    switch (status) {
+        case EStatusCode.CONTINUE:
+            return 'Continue';
+        case EStatusCode.SWITCHING_PROTOCOLS:
+            return 'Switching Protocols';
+        case EStatusCode.PROCESSING:
+            return 'Processing';
+        case EStatusCode.EARLY_HINTS:
+            return 'Early Hints';
+
+        case EStatusCode.OK:
+            return 'OK';
+        case EStatusCode.CREATED:
+            return 'Created';
+        case EStatusCode.ACCEPTED:
+            return 'Accepted';
+        case EStatusCode.NON_AUTHORITATIVE_INFORMATION:
+            return 'Non-Authoritative Information';
+        case EStatusCode.NO_CONTENT:
+            return 'No Content';
+        case EStatusCode.RESET_CONTENT:
+            return 'Reset Content';
+        case EStatusCode.PARTIAL_CONTENT:
+            return 'Partial Content';
+        case EStatusCode.MULTI_STATUS:
+            return 'Multi-Status';
+        case EStatusCode.ALREADY_REPORTED:
+            return 'Already Reported';
+        case EStatusCode.IM_USED:
+            return 'IM Used';
+
+        case EStatusCode.MULTIPLE_CHOICES:
+            return 'Multiple Choices';
+        case EStatusCode.MOVED_PERMANENTLY:
+            return 'Moved Permanently';
+        case EStatusCode.FOUND:
+            return 'Found';
+        case EStatusCode.SEE_OTHER:
+            return 'See Other';
+        case EStatusCode.NOT_MODIFIED:
+            return 'Not Modified';
+        case EStatusCode.USE_PROXY:
+            return 'Use Proxy';
+        case EStatusCode.SWITCH_PROXY:
+            return 'Switch Proxy';
+        case EStatusCode.TEMPORARY_REDIRECT:
+            return 'Temporary Redirect';
+        case EStatusCode.PERMANENT_REDIRECT:
+            return 'Permanent Redirect';
+
+        case EStatusCode.BAD_REQUEST:
+            return 'Bad Request';
+        case EStatusCode.UNAUTHORIZED:
+            return 'Unauthorized';
+        case EStatusCode.PAYMENT_REQUIRED:
+            return 'Payment Required';
+        case EStatusCode.FORBIDDEN:
+            return 'Forbidden';
+        case EStatusCode.NOT_FOUND:
+            return 'Not Found';
+        case EStatusCode.METHOD_NOT_ALLOWED:
+            return 'Method Not Allowed';
+        case EStatusCode.NOT_ACCEPTABLE:
+            return 'Not Acceptable';
+        case EStatusCode.PROXY_AUTHENTICATION_REQUIRED:
+            return 'Proxy Authentication Required';
+        case EStatusCode.REQUEST_TIMEOUT:
+            return 'Request Timeout';
+        case EStatusCode.CONFLICT:
+            return 'Conflict';
+        case EStatusCode.GONE:
+            return 'Gone';
+        case EStatusCode.LENGTH_REQUIRED:
+            return 'Length Required';
+        case EStatusCode.PRECONDITION_FAILED:
+            return 'Precondition Failed';
+        case EStatusCode.PAYLOAD_TOO_LARGE:
+            return 'Payload Too Large';
+        case EStatusCode.URI_TOO_LONG:
+            return 'URI Too Long';
+        case EStatusCode.UNSUPPORTED_MEDIA_TYPE:
+            return 'Unsupported Media Type';
+        case EStatusCode.RANGE_NOT_SATISFIABLE:
+            return 'Range Not Satisfiable';
+        case EStatusCode.EXPECTATION_FAILED:
+            return 'Expectation Failed';
+        case EStatusCode.I_AM_A_TEAPOT:
+            return 'I\'m a teapot';
+        case EStatusCode.MISDIRECTED_REQUEST:
+            return 'Misdirected Request';
+        case EStatusCode.UNPROCESSABLE_ENTITY:
+            return 'Unprocessable Entity';
+        case EStatusCode.LOCKED:
+            return 'Locked';
+        case EStatusCode.FAILED_DEPENDENCY:
+            return 'Failed Dependency';
+        case EStatusCode.TOO_EARLY:
+            return 'Too Early';
+        case EStatusCode.UPGRADE_REQUIRED:
+            return 'Upgrade Required';
+        case EStatusCode.PRECONDITION_REQUIRED:
+            return 'Precondition Required';
+        case EStatusCode.TOO_MANY_REQUESTS:
+            return 'Too Many Requests';
+        case EStatusCode.REQUEST_HEADER_FIELDS_TOO_LARGE:
+            return 'Request Header Fields Too Large';
+        case EStatusCode.UNAVAILABLE_FOR_LEGAL_REASONS:
+            return 'Unavailable For Legal Reasons';
+
+        case EStatusCode.INTERNAL_SERVER_ERROR:
+            return 'Internal Server Error';
+        case EStatusCode.NOT_IMPLEMENTED:
+            return 'Not Implemented';
+        case EStatusCode.BAD_GATEWAY:
+            return 'Bad Gateway';
+        case EStatusCode.SERVICE_UNAVAILABLE:
+            return 'Service Unavailable';
+        case EStatusCode.GATEWAY_TIMEOUT:
+            return 'Gateway Timeout';
+        case EStatusCode.HTTP_VERSION_NOT_SUPPORTED:
+            return 'HTTP Version Not Supported';
+        case EStatusCode.VARIANT_ALSO_NEGOTIATES:
+            return 'Variant Also Negotiates';
+        case EStatusCode.INSUFFICIENT_STORAGE:
+            return 'Insufficient Storage';
+        case EStatusCode.LOOP_DETECTED:
+            return 'Loop Detected';
+        case EStatusCode.NOT_EXTENDED:
+            return 'Not Extended';
+        case EStatusCode.NETWORK_AUTHENTICATION_REQUIRED:
+            return 'Network Authentication Required';
+    }
+
+    return null;
+}

src/http/EStatusCode.ts

@@ -38,7 +38,7 @@ export default class Request<T = unknown> extends IncomingMessage {
     #path?: string;
     #body: Buffer[] = [];
     #parsedBody?: T = undefined;
-    #container?: Container<string | symbol, unknown> = new Container();
+    #container: Container<string | symbol, unknown> = new Container();
     #ip: string | undefined;
     #acceptPriority: string[] = [];
 
@@ -49,7 +49,7 @@ export default class Request<T = unknown> extends IncomingMessage {
         const url = new URL(this.url ?? '', `${this.headers['x-forwarded-proto'] ?? 'http'}://${this.headers.host}`);
 
         this.#query = url.searchParams;
-        this.#path = url.pathname;
+        this.#path = decodeURIComponent(url.pathname);
         this.#ip = this.socket.remoteAddress;
         if (this.headers['x-real-ip']) {
             this.#ip = Array.isArray(this.headers['x-real-ip']) ? this.headers['x-real-ip'][0] : this.headers['x-real-ip'];
@@ -142,7 +142,7 @@ export default class Request<T = unknown> extends IncomingMessage {
     }
 
     get container() {
-        return this.#container!;
+        return this.#container;
     }
 
     get ip() {