@emoyly/problem 7.0.6 → 8.0.0

package/esm/defaults/cloudflare.d.ts

@@ -1,47 +1,47 @@
 export declare const statusCodes: {
-    520: {
-        status: number;
-        title: string;
-        type: string;
-    };
-    521: {
-        status: number;
-        title: string;
-        type: string;
-    };
-    522: {
-        status: number;
-        title: string;
-        type: string;
-    };
-    523: {
-        status: number;
-        title: string;
-        type: string;
-    };
-    524: {
-        status: number;
-        title: string;
-        type: string;
-    };
-    525: {
-        status: number;
-        title: string;
-        type: string;
-    };
-    526: {
-        status: number;
-        title: string;
-        type: string;
-    };
-    527: {
-        status: number;
-        title: string;
-        type: string;
-    };
-    530: {
-        status: number;
-        title: string;
-        type: string;
+    readonly 520: {
+        readonly status: 520;
+        readonly title: "Web Server returned an unknown error";
+        readonly type: "/errors/defaults/cloudflare/unknownerror";
+    };
+    readonly 521: {
+        readonly status: 521;
+        readonly title: "Web server is down";
+        readonly type: "/errors/defaults/cloudflare/webserverdown";
+    };
+    readonly 522: {
+        readonly status: 522;
+        readonly title: "Connection timed out";
+        readonly type: "/errors/defaults/cloudflare/connectiontimeout";
+    };
+    readonly 523: {
+        readonly status: 523;
+        readonly title: "Origin is unreachable";
+        readonly type: "/errors/defaults/cloudflare/originunreachable";
+    };
+    readonly 524: {
+        readonly status: 524;
+        readonly title: "A timeout occurred";
+        readonly type: "/errors/defaults/cloudflare/timeout";
+    };
+    readonly 525: {
+        readonly status: 525;
+        readonly title: "SSL handshake failed";
+        readonly type: "/errors/defaults/cloudflare/sslhandshakefail";
+    };
+    readonly 526: {
+        readonly status: 526;
+        readonly title: "Invalid SSL certificate";
+        readonly type: "/errors/defaults/cloudflare/invalidssl";
+    };
+    readonly 527: {
+        readonly status: 527;
+        readonly title: "Railgun Listener to origin error";
+        readonly type: "/errors/defaults/cloudflare/railgunoriginerr";
+    };
+    readonly 530: {
+        readonly status: 530;
+        readonly title: "Cloudflare returned 1xxx error";
+        readonly type: "/errors/defaults/cloudflare/1xxx";
     };
 };

package/esm/defaults/iis.d.ts

@@ -1,17 +1,17 @@
 export declare const statusCodes: {
-    440: {
-        status: number;
-        title: string;
-        type: string;
+    readonly 440: {
+        readonly status: 440;
+        readonly title: "Login Time-out";
+        readonly type: "/errors/defaults/iis/logintimeout";
     };
-    449: {
-        status: number;
-        title: string;
-        type: string;
+    readonly 449: {
+        readonly status: 449;
+        readonly title: "Retry with required information";
+        readonly type: "/errors/defaults/iis/retrywith";
     };
-    451: {
-        status: number;
-        title: string;
-        type: string;
+    readonly 451: {
+        readonly status: 451;
+        readonly title: "Redirect";
+        readonly type: "/errors/defaults/iis/redirect";
     };
 };

package/esm/defaults/nginx.d.ts

@@ -1,32 +1,32 @@
 export declare const statusCodes: {
-    444: {
-        status: number;
-        title: string;
-        type: string;
+    readonly 444: {
+        readonly status: 494;
+        readonly title: "No Response";
+        readonly type: "/errors/defaults/nginx/noresponse";
     };
-    494: {
-        status: number;
-        title: string;
-        type: string;
+    readonly 494: {
+        readonly status: 494;
+        readonly title: "Request header too large";
+        readonly type: "/errors/defaults/nginx/headertoolarge";
     };
-    495: {
-        status: number;
-        title: string;
-        type: string;
+    readonly 495: {
+        readonly status: 495;
+        readonly title: "SSL Certificate Error";
+        readonly type: "/errors/defaults/nginx/sslcerterr";
     };
-    496: {
-        status: number;
-        title: string;
-        type: string;
+    readonly 496: {
+        readonly status: 496;
+        readonly title: "SSL Certificate Required";
+        readonly type: "/errors/defaults/nginx/sslcertrequired";
     };
-    497: {
-        status: number;
-        title: string;
-        type: string;
+    readonly 497: {
+        readonly status: 497;
+        readonly title: "HTTP Request Sent to HTTPS Port";
+        readonly type: "/errors/defaults/nginx/httpreqtohttpsport";
     };
-    499: {
-        status: number;
-        title: string;
-        type: string;
+    readonly 499: {
+        readonly status: 499;
+        readonly title: "Client Closed Request";
+        readonly type: "/errors/defaults/nginx/clientclosedreq";
     };
 };

package/esm/defaults/others.d.ts

@@ -1,37 +1,37 @@
 export declare const otherErrors: {
-    unknown: {
-        status: number;
-        title: string;
-        type: string;
+    readonly unknown: {
+        readonly status: 500;
+        readonly title: "Unknown error";
+        readonly type: "/errors/defaults/others/unknown";
     };
-    corsError: {
-        status: number;
-        title: string;
-        type: string;
+    readonly corsError: {
+        readonly status: 401;
+        readonly title: "Request not allowed by CORS policy";
+        readonly type: "/errors/defaults/others/corsdenied";
     };
-    problemParseError: {
-        status: number;
-        title: string;
-        type: string;
+    readonly problemParseError: {
+        readonly status: 1000;
+        readonly title: "Could not parse problem details";
+        readonly type: "/errors/defaults/others/problemparseerror";
     };
-    problemJsonError: {
-        status: number;
-        title: string;
-        type: string;
+    readonly problemJsonError: {
+        readonly status: 1000;
+        readonly title: "Could not parse problem JSON";
+        readonly type: "/errors/defaults/others/problemjsonerror";
     };
-    notAnError: {
-        status: number;
-        title: string;
-        type: string;
+    readonly notAnError: {
+        readonly status: 1000;
+        readonly title: "Not an error";
+        readonly type: "/errors/defaults/others/notanerror";
     };
-    networkError: {
-        status: number;
-        title: string;
-        type: string;
+    readonly networkError: {
+        readonly status: 1000;
+        readonly title: "Network error";
+        readonly type: "/errors/defaults/others/networkerror";
     };
-    inputValidationError: {
-        status: number;
-        title: string;
-        type: string;
+    readonly inputValidationError: {
+        readonly status: 400;
+        readonly title: "Input failed validation";
+        readonly type: "/errors/defaults/others/validationerror";
     };
 };

package/esm/middleware/axios.js

@@ -8,7 +8,7 @@ export class AxiosMiddleware extends MiddlewareBase {
         }, options);
     }
     interceptor = async (error) => {
-        const problems = await this.parse(error);
+        const problems = this.parse(error);
         this.emit(problems);
         return Promise.reject(problems);
     };

package/esm/middleware/base.d.ts

@@ -19,7 +19,7 @@ export declare abstract class MiddlewareBase {
     /**
      * Parse input using parsers
      */
-    parse: (input: unknown) => Promise<Problem[]>;
+    parse: (input: unknown) => Problem[];
     fallback: ProblemOpts;
     problemListeners: ProblemListener[];
     protected emit: (list: Problem[]) => void;

package/esm/middleware/base.js

@@ -16,7 +16,7 @@ export class MiddlewareBase {
     /**
      * Parse input using parsers
      */
-    parse = async (input) => {
+    parse = (input) => {
         const problems = getProblems(input, this.options.parsers);
         if (!problems || !Array.isArray(problems) || problems.length < 1) {
             if (this.enableFallback)
@@ -24,13 +24,13 @@ export class MiddlewareBase {
                         ...this.fallback,
                         'errorObject': input,
                         'stack': (typeof input === 'object' && input !== null && 'stack' in input && typeof input.stack === 'string') ? input.stack : undefined,
-                        'middleware': this.name
+                        'source': `middleware:${this.name}`
                     })];
             return [];
         }
         for (const p of problems) {
-            if (!p.middleware)
-                p.middleware = this.name;
+            if (!p.source)
+                p.source = `middleware:${this.name}`;
         }
         return problems;
     };

package/esm/middleware/express.js

@@ -1,38 +1,20 @@
 import { MiddlewareBase } from './base.js';
 import { Problem } from '../problem.js';
-import { codes4xx, otherErrors } from '../defaults/index.js';
-import { defaultInstance } from '../util/defaults.js';
+import { codes4xx } from '../defaults/index.js';
 export class ExpressMiddleware extends MiddlewareBase {
     name = 'express';
     middleware = (error, req, res, next) => {
-        this.parse(error)
-            .then(problems => {
-            for (const problem of problems) {
-                if (problem.instance === defaultInstance) {
-                    problem.instance = req.originalUrl;
-                }
+        const problems = this.parse(error);
+        for (const problem of problems) {
+            if (!problem.instance) {
+                problem.instance = req.originalUrl;
             }
-            this.emit(problems);
-            res
-                .contentType('application/problem+json')
-                .status(problems[0]?.status ?? 500)
-                .json(problems.map(val => val.toObject()));
-        })
-            .catch(err => {
-            res
-                .contentType('application/problem+json')
-                .status(500)
-                .json([
-                new Problem({
-                    ...otherErrors.unknown,
-                    'instance': req.originalUrl,
-                    'status': 500,
-                    'stack': err?.stack,
-                    'errorObject': err,
-                }).toObject()
-            ]);
-            throw err;
-        });
+        }
+        this.emit(problems);
+        res
+            .contentType('application/problem+json')
+            .status(problems[0]?.status ?? 500)
+            .json(problems.map(val => val.toObject()));
     };
     /**
      * This function applies the middleware to your Express application. Put this at the very end of your middleware/routes.

package/esm/parsers/axios.js

@@ -1,10 +1,8 @@
 import { otherErrors } from '../defaults/others.js';
 import { Problem } from '../problem.js';
 import { getProblems } from '../util/getProblems.js';
-import { getHttpError } from '../util/misc.js';
-function isAxiosError(payload) {
-    return typeof payload === 'object' && payload !== null && 'isAxiosError' in payload && payload.isAxiosError === true;
-}
+import { getCodeDefaults } from '../util/misc.js';
+import { isAxiosError } from 'axios';
 const parse = (input) => {
     if (typeof input !== 'object' || input == null)
         return [];
@@ -17,13 +15,14 @@ const parse = (input) => {
             return problems;
     }
     if (input?.response) {
-        const opts = getHttpError(input.response.status);
+        const opts = getCodeDefaults(input.response.status);
         if (opts)
             return [new Problem({
                     ...opts,
                     'instance': input?.config?.url,
                     'stack': input?.stack,
-                    'errorObject': input
+                    'errorObject': input,
+                    'source': 'parser:axios'
                 })];
     }
     // TODO: Fix this, this seems bad
@@ -35,7 +34,8 @@ const parse = (input) => {
                     ...otherErrors.networkError,
                     'instance': input?.config?.url,
                     'stack': input?.stack,
-                    'errorObject': input
+                    'errorObject': input,
+                    'source': 'parser:axios'
                 })];
         }
         // Probably a ClientRequest
@@ -44,7 +44,8 @@ const parse = (input) => {
                     ...otherErrors.networkError,
                     'instance': input?.config?.url,
                     'stack': input?.stack,
-                    'errorObject': input
+                    'errorObject': input,
+                    'source': 'parser:axios'
                 })];
         }
     }

package/esm/parsers/jsonwebtoken.js

@@ -73,6 +73,7 @@ const parse = (input) => {
             return [new Problem({
                     ...found.result,
                     'errorObject': input,
+                    'source': 'parser:jsonwebtoken'
                 })];
         }
     }
@@ -83,6 +84,7 @@ const parse = (input) => {
                 'detail': `The JSON Web Token expired at ${input.expiredAt}`,
                 'status': 400,
                 'errorObject': input,
+                'source': 'parser:jsonwebtoken'
             })];
     }
     else if (input instanceof NotBeforeError && input.name === 'NotBeforeError') {
@@ -92,6 +94,7 @@ const parse = (input) => {
                 'detail': `The JSON Web Token is not valid before ${input.date}`,
                 'status': 400,
                 'errorObject': input,
+                'source': 'parser:jsonwebtoken'
             })];
     }
 };

package/esm/parsers/mikroorm.js

@@ -11,6 +11,7 @@ const parse = (input) => {
             ...statusCodes['404'],
             'stack': input.stack,
             'errorObject': input,
+            'source': 'parser:mikroorm'
         })
     ];
 };

package/esm/parsers/tsoa.js

@@ -5,7 +5,7 @@ const parse = (input) => {
     if (!(input instanceof ValidateError)) {
         return;
     }
-    // TODO: Give actual useful responses instead of this shit
+    // TODO: Give actual useful responses instead of this 💩
     return [
         new Problem({
             ...otherErrors.inputValidationError,
@@ -15,7 +15,8 @@ const parse = (input) => {
                 'fields': input.fields,
             },
             'stack': input.stack,
-            'errorObject': input
+            'errorObject': input,
+            'source': 'parser:tsoa'
         })
     ];
 };

package/esm/parsers/zod.js

@@ -13,7 +13,8 @@ const parse = (input) => {
             'errorObject': input,
             'data': {
                 'issues': input.issues
-            }
+            },
+            'source': 'parser:zod'
         })];
 };
 export default parse;

package/esm/problem.d.ts

@@ -1,14 +1,14 @@
-import type { IProblem, ProblemOpts, JsonProblem } from './typings/problem.js';
+import type { IProblem, ProblemOpts, JsonProblemOutput } from './typings/problem.js';
 export declare class Problem extends Error implements IProblem {
     type: string;
     title: string;
     status: number;
-    detail: string;
-    instance: string;
+    detail: string | undefined;
+    instance: string | undefined;
     errorObject?: unknown;
-    __problemVersion: string;
+    readonly __problemVersion = "8.0.0";
     data: unknown;
-    middleware?: string;
-    constructor({ type, title, status, detail, instance, stack, errorObject, data, middleware }: ProblemOpts);
-    toObject: () => JsonProblem;
+    source?: string;
+    constructor(opts: ProblemOpts);
+    toObject: () => JsonProblemOutput;
 }

package/esm/problem.js

@@ -1,56 +1,65 @@
-import { defaultDetail, defaultInstance, defaultTitle, defaultType } from './util/defaults.js';
+import { validateBasicInput } from './util/validation.js';
 import { version } from './util/version.js';
 export class Problem extends Error {
-    type = defaultType;
-    title = defaultTitle;
-    status = 500;
-    detail = defaultDetail;
-    instance = defaultInstance;
+    type;
+    title;
+    status;
+    detail;
+    instance;
     errorObject;
     __problemVersion = version;
     data = undefined;
-    middleware;
-    constructor({ type, title, status, detail, instance, stack, errorObject, data, middleware }) {
-        super(detail ?? title ?? 'HTTP Problem Details');
-        // TODO: Figure out why i wrote this?
+    source;
+    constructor(opts) {
+        const valid = validateBasicInput(opts);
+        if (valid !== true)
+            throw valid;
+        super(opts.detail ?? opts.title ?? 'HTTP Problem Details');
+        // TODO: Figure out if this is still necessary
         Object.setPrototypeOf(this, new.target.prototype);
-        this.type = type;
-        this.title = title;
-        this.status = status;
-        if (detail)
-            this.detail = detail;
-        if (instance)
-            this.instance = instance;
-        if (errorObject)
-            this.errorObject = errorObject;
-        if (middleware)
-            this.middleware = middleware;
-        if (stack) {
-            this.stack = stack;
+        this.type = opts.type;
+        this.title = opts.title;
+        this.status = opts.status;
+        if (opts.detail)
+            this.detail = opts.detail;
+        if (opts.instance)
+            this.instance = opts.instance;
+        if (opts.errorObject)
+            this.errorObject = opts.errorObject;
+        if (opts.source)
+            this.source = opts.source;
+        if (opts.stack) {
+            this.stack = opts.stack;
         }
-        else if (errorObject && typeof errorObject === 'object' && 'stack' in errorObject && typeof errorObject.stack === 'string') {
-            this.stack = errorObject.stack;
+        else if (opts.errorObject && typeof opts.errorObject === 'object' && 'stack' in opts.errorObject && typeof opts.errorObject.stack === 'string') {
+            this.stack = opts.errorObject.stack;
         }
         else {
             if (typeof Error.captureStackTrace === 'function') {
                 Error.captureStackTrace(this, this.constructor);
             }
             else {
-                this.stack = new Error(detail ?? title ?? 'HTTP Problem Details').stack;
+                this.stack = new Error(opts.detail ?? opts.title ?? 'HTTP Problem Details').stack;
             }
         }
-        if (data)
-            this.data = data;
+        if (opts.data)
+            this.data = opts.data;
     }
     toObject = () => {
-        return {
+        const out = {
             'type': this.type,
             'title': this.title,
             'status': this.status,
-            'detail': this.detail,
-            'instance': this.instance,
             '__problemVersion': this.__problemVersion,
-            'data': this.data
         };
+        if (this.detail)
+            out.detail = this.detail;
+        if (this.instance)
+            out.instance = this.instance;
+        if (this.source)
+            out.source = this.source;
+        if (this.data)
+            out.data = this;
+        return out;
     };
 }