@emoyly/problem 5.0.8 → 6.0.0

package/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+end_of_line = lf
+insert_final_newline = true
+charset = utf-8
+indent_style = space
+indent_size = 4
+
+[*.{yml,yaml}]
+indent_size = 2

package/.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+    "recommendations": [
+        "editorconfig.editorconfig",
+        "dbaeumer.vscode-eslint",
+        "gruntfuggly.todo-tree"
+    ]
+}

package/.vscode/settings.json

@@ -0,0 +1,2 @@
+{
+}

package/cjs/defaults/index.d.ts

@@ -0,0 +1,7 @@
+export { statusCodes as codes4xx } from '../defaults/4xx.js';
+export { statusCodes as codes5xx } from '../defaults/5xx.js';
+export { statusCodes as codesAws } from '../defaults/aws.js';
+export { statusCodes as codesCloudflare } from '../defaults/cloudflare.js';
+export { statusCodes as codesIis } from '../defaults/iis.js';
+export { statusCodes as codesNginx } from '../defaults/nginx.js';
+export { otherErrors } from '../defaults/others.js';

package/cjs/defaults/index.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.otherErrors = exports.codesNginx = exports.codesIis = exports.codesCloudflare = exports.codesAws = exports.codes5xx = exports.codes4xx = void 0;
+var _4xx_js_1 = require("../defaults/4xx.js");
+Object.defineProperty(exports, "codes4xx", { enumerable: true, get: function () { return _4xx_js_1.statusCodes; } });
+var _5xx_js_1 = require("../defaults/5xx.js");
+Object.defineProperty(exports, "codes5xx", { enumerable: true, get: function () { return _5xx_js_1.statusCodes; } });
+var aws_js_1 = require("../defaults/aws.js");
+Object.defineProperty(exports, "codesAws", { enumerable: true, get: function () { return aws_js_1.statusCodes; } });
+var cloudflare_js_1 = require("../defaults/cloudflare.js");
+Object.defineProperty(exports, "codesCloudflare", { enumerable: true, get: function () { return cloudflare_js_1.statusCodes; } });
+var iis_js_1 = require("../defaults/iis.js");
+Object.defineProperty(exports, "codesIis", { enumerable: true, get: function () { return iis_js_1.statusCodes; } });
+var nginx_js_1 = require("../defaults/nginx.js");
+Object.defineProperty(exports, "codesNginx", { enumerable: true, get: function () { return nginx_js_1.statusCodes; } });
+var others_js_1 = require("../defaults/others.js");
+Object.defineProperty(exports, "otherErrors", { enumerable: true, get: function () { return others_js_1.otherErrors; } });

package/cjs/index.d.ts

@@ -0,0 +1,5 @@
+export { Problem } from './problem.js';
+export * as defaults from './defaults/index.js';
+export { default as events } from './util/events.js';
+export * from './typings/index.js';
+export * from './util/isProblemArray.js';

package/cjs/index.js

@@ -0,0 +1,24 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.events = exports.defaults = exports.Problem = void 0;
+var problem_js_1 = require("./problem.js");
+Object.defineProperty(exports, "Problem", { enumerable: true, get: function () { return problem_js_1.Problem; } });
+exports.defaults = require("./defaults/index.js");
+var events_js_1 = require("./util/events.js");
+Object.defineProperty(exports, "events", { enumerable: true, get: function () { return events_js_1.default; } });
+__exportStar(require("./typings/index.js"), exports);
+__exportStar(require("./util/isProblemArray.js"), exports);

package/{middleware → cjs/middleware}/axios.d.ts

@@ -1,5 +1,5 @@
-import type { PartialMiddlewareOptions } from '../typings/middleware';
-import { MiddlewareBase } from './base';
+import type { PartialMiddlewareOptions } from '../typings/middleware.js';
+import { MiddlewareBase } from './base.js';
 type InterceptorArray = [undefined, (error: unknown) => Promise<never>];
 export declare class AxiosMiddleware extends MiddlewareBase {
     name: string;

package/cjs/middleware/axios.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AxiosMiddleware = void 0;
+const base_js_1 = require("./base.js");
+const axios_js_1 = require("../parsers/axios.js");
+const events_js_1 = require("../util/events.js");
+class AxiosMiddleware extends base_js_1.MiddlewareBase {
+    name = 'axios';
+    constructor(options) {
+        super({
+            'parsers': [axios_js_1.default]
+        }, options);
+    }
+    interceptor = async (error) => {
+        const problems = await this.parse(error);
+        events_js_1.default.emit(problems);
+        return Promise.reject(problems);
+    };
+    /**
+     * @example instance.interceptors.response.use(...middleware.use())
+     */
+    use = () => [undefined, this.interceptor];
+}
+exports.AxiosMiddleware = AxiosMiddleware;

package/{middleware → cjs/middleware}/base.d.ts

@@ -1,6 +1,6 @@
-import { Problem } from '../problem';
-import type { ProblemOpts } from '../typings';
-import type { MiddlewareOptions, PartialMiddlewareOptions } from '../typings/middleware';
+import { Problem } from '../problem.js';
+import type { ProblemOpts } from '../typings/index.js';
+import type { MiddlewareOptions, PartialMiddlewareOptions } from '../typings/middleware.js';
 /**
  * Middleware collects errors from somewhere, transforms them into something recognizable by a parser, and then passes them to the parsers, and then returns an array of Problems to whatever is using the middleware
  */

package/cjs/middleware/base.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MiddlewareBase = void 0;
+const index_js_1 = require("../defaults/index.js");
+const problem_js_1 = require("../problem.js");
+const getProblems_js_1 = require("../util/getProblems.js");
+/**
+ * Middleware collects errors from somewhere, transforms them into something recognizable by a parser, and then passes them to the parsers, and then returns an array of Problems to whatever is using the middleware
+ */
+class MiddlewareBase {
+    options;
+    /**
+     * When nothing is returned from the parsers, just throw in a default "fallback" Problem object, so that a Problem is still actually returned/emitted
+     */
+    enableFallback = true;
+    constructor(defaultOptions, options) {
+        this.options = { ...defaultOptions, ...options };
+    }
+    /**
+     * Parse input using parsers
+     */
+    parse = async (input) => {
+        const problems = [];
+        const prob = (0, getProblems_js_1.getProblems)(input);
+        if (!prob) {
+            for (const parse of this.options.parsers) {
+                const resp = parse(input);
+                if (!resp.length)
+                    continue;
+                problems.push(...resp);
+                break;
+            }
+            if (!problems.length && this.enableFallback) {
+                problems.push(new problem_js_1.Problem({
+                    ...this.fallback,
+                    'errorObject': input,
+                    'stack': (typeof input === 'object' && input !== null && 'stack' in input && typeof input.stack === 'string') ? input.stack : undefined
+                }));
+            }
+        }
+        else {
+            problems.push(...prob);
+        }
+        for (const p of problems) {
+            if (!p.middleware)
+                p.middleware = this.name;
+        }
+        return problems;
+    };
+    fallback = index_js_1.otherErrors.unknown;
+}
+exports.MiddlewareBase = MiddlewareBase;

package/{middleware → cjs/middleware}/express.d.ts

@@ -1,6 +1,6 @@
 import type { NextFunction, Request, Response } from 'express';
-import type { PartialMiddlewareOptions } from '../typings/middleware';
-import { MiddlewareBase } from './base';
+import type { PartialMiddlewareOptions } from '../typings/middleware.js';
+import { MiddlewareBase } from './base.js';
 export declare class ExpressMiddleware extends MiddlewareBase {
     name: string;
     middleware: (error: unknown, req: Request, res: Response, next: NextFunction) => void;

package/cjs/middleware/express.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ExpressMiddleware = void 0;
+const base_js_1 = require("./base.js");
+const problem_js_1 = require("../problem.js");
+const index_js_1 = require("../defaults/index.js");
+const events_js_1 = require("../util/events.js");
+const defaults_js_1 = require("../util/defaults.js");
+class ExpressMiddleware extends base_js_1.MiddlewareBase {
+    name = 'express';
+    middleware = (error, req, res, next) => {
+        this.parse(error)
+            .then(problems => {
+            for (const problem of problems) {
+                if (problem.instance === defaults_js_1.defaultInstance) {
+                    problem.instance = req.originalUrl;
+                }
+            }
+            events_js_1.default.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_js_1.Problem({
+                    ...index_js_1.otherErrors.unknown,
+                    'instance': req.originalUrl,
+                    'status': 500,
+                    'stack': err?.stack,
+                    'errorObject': err,
+                }).toObject()
+            ]);
+            throw err;
+        });
+    };
+    /**
+     * This function applies the middleware to your Express application. Put this at the very end of your middleware/routes.
+     * If you want to also handle 404 errors, check out the notFound middleware function.
+     * @example app.use(middleware.use())
+     */
+    use = () => this.middleware;
+    constructor(options) {
+        super({
+            'parsers': []
+        }, options);
+    }
+    /**
+     * Put this right before the middleware.use() to catch all 404 errors and respond with a Problem instead of the default Express response
+     * @example app.use(middleware.notFound)
+     */
+    notFound = (req, res, next) => {
+        const error = new problem_js_1.Problem({
+            ...index_js_1.codes4xx[404],
+            'instance': req.originalUrl,
+            'detail': `No API endpoints exist on ${req.url} for request method ${req.method}`
+        });
+        return next(error);
+    };
+}
+exports.ExpressMiddleware = ExpressMiddleware;

package/cjs/package.json

@@ -0,0 +1,3 @@
+{
+    "type": "commonjs"
+}

package/cjs/parsers/axios.d.ts

@@ -0,0 +1,3 @@
+import type { Parser } from '../typings/parser.js';
+declare const parse: Parser;
+export default parse;

package/cjs/parsers/axios.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const others_js_1 = require("../defaults/others.js");
+const problem_js_1 = require("../problem.js");
+const getProblems_js_1 = require("../util/getProblems.js");
+const misc_js_1 = require("../util/misc.js");
+function isAxiosError(payload) {
+    return typeof payload === 'object' && payload !== null && 'isAxiosError' in payload && payload.isAxiosError === true;
+}
+const parse = (input) => {
+    if (typeof input !== 'object' || input == null)
+        return [];
+    if (!isAxiosError(input))
+        return [];
+    const request = input.request;
+    if (input?.response?.data) {
+        const problems = (0, getProblems_js_1.getProblems)(input?.response?.data);
+        if (problems?.length)
+            return problems;
+    }
+    if (input?.response) {
+        const opts = (0, misc_js_1.getHttpError)(input.response.status);
+        if (opts)
+            return [new problem_js_1.Problem({
+                    ...opts,
+                    'instance': input?.config?.url,
+                    'stack': input?.stack,
+                    'errorObject': input
+                })];
+    }
+    // TODO: Fix this, this seems bad
+    if (request) {
+        const isNode = typeof process !== 'undefined' && process.versions && process.versions.node;
+        const isBrowser = typeof window !== 'undefined' && typeof window.document !== 'undefined';
+        if (isBrowser && request instanceof XMLHttpRequest) {
+            return [new problem_js_1.Problem({
+                    ...others_js_1.otherErrors.networkError,
+                    'instance': input?.config?.url,
+                    'stack': input?.stack,
+                    'errorObject': input
+                })];
+        }
+        // Probably a ClientRequest
+        if (isNode && 'pipe' in request && 'destroy' in request) {
+            return [new problem_js_1.Problem({
+                    ...others_js_1.otherErrors.networkError,
+                    'instance': input?.config?.url,
+                    'stack': input?.stack,
+                    'errorObject': input
+                })];
+        }
+    }
+    return [];
+};
+exports.default = parse;

package/cjs/parsers/jsonwebtoken.d.ts

@@ -0,0 +1,3 @@
+import type { Parser } from '../typings/parser.js';
+declare const parse: Parser;
+export default parse;

package/{parsers → cjs/parsers}/jsonwebtoken.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const problem_1 = require("../problem");
+const problem_js_1 = require("../problem.js");
 const jsonwebtoken_1 = require("jsonwebtoken");
 const errorMap = [
     {
@@ -72,11 +72,11 @@ const parse = (input) => {
     if (input instanceof jsonwebtoken_1.JsonWebTokenError && input.name === 'JsonWebTokenError') {
         const found = errorMap.find(val => typeof val.search === 'string' ? val.search === input.message : val.search.test(input.message));
         if (found) {
-            return [new problem_1.Problem(found.result)];
+            return [new problem_js_1.Problem(found.result)];
         }
     }
     else if (input instanceof jsonwebtoken_1.TokenExpiredError && input.name === 'TokenExpiredError') {
-        return [new problem_1.Problem({
+        return [new problem_js_1.Problem({
                 'title': 'The JSON Web Token has expired',
                 'type': '/errors/jsonwebtoken/tokenexpired',
                 'detail': `The JSON Web Token expired at ${input.expiredAt}`,
@@ -84,7 +84,7 @@ const parse = (input) => {
             })];
     }
     else if (input instanceof jsonwebtoken_1.NotBeforeError && input.name === 'NotBeforeError') {
-        return [new problem_1.Problem({
+        return [new problem_js_1.Problem({
                 'title': 'The JSON Web Token is not valid yet',
                 'type': '/errors/jsonwebtoken/notbefore',
                 'detail': `The JSON Web Token is not valid before ${input.date}`,

package/cjs/parsers/mikroorm.d.ts

@@ -0,0 +1,3 @@
+import type { Parser } from '../typings/parser.js';
+declare const parse: Parser;
+export default parse;

package/{parsers → cjs/parsers}/mikroorm.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const problem_1 = require("../problem");
-const _4xx_1 = require("../defaults/4xx");
+const problem_js_1 = require("../problem.js");
+const _4xx_js_1 = require("../defaults/4xx.js");
 const core_1 = require("@mikro-orm/core");
 // TODO: Make this less bad
 const parse = (input) => {
@@ -9,7 +9,11 @@ const parse = (input) => {
         return [];
     }
     return [
-        new problem_1.Problem(Object.assign(Object.assign({}, _4xx_1.statusCodes['404']), { 'stack': input.stack, 'errorObject': input }))
+        new problem_js_1.Problem({
+            ..._4xx_js_1.statusCodes['404'],
+            'stack': input.stack,
+            'errorObject': input,
+        })
     ];
 };
 exports.default = parse;

package/cjs/parsers/tsoa.d.ts

@@ -0,0 +1,3 @@
+import type { Parser } from '../typings/parser.js';
+declare const parse: Parser;
+export default parse;

package/{parsers → cjs/parsers}/tsoa.js

@@ -1,17 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const tsoa_1 = require("tsoa");
-const problem_1 = require("../problem");
-const others_1 = require("../defaults/others");
+const problem_js_1 = require("../problem.js");
+const others_js_1 = require("../defaults/others.js");
 const parse = (input) => {
     if (!(input instanceof tsoa_1.ValidateError)) {
         return [];
     }
     // TODO: Give actual useful responses instead of this shit
     return [
-        new problem_1.Problem(Object.assign(Object.assign({}, others_1.otherErrors.inputValidationError), { 'detail': input.message, 'status': input.status, 'data': {
+        new problem_js_1.Problem({
+            ...others_js_1.otherErrors.inputValidationError,
+            'detail': input.message,
+            'status': input.status,
+            'data': {
                 'fields': input.fields,
-            }, 'stack': input.stack }))
+            },
+            'stack': input.stack,
+        })
     ];
 };
 exports.default = parse;

package/{problem.d.ts → cjs/problem.d.ts}

@@ -1,4 +1,4 @@
-import type { IProblem, ProblemOpts, JsonProblem } from './typings/problem';
+import type { IProblem, ProblemOpts, JsonProblem } from './typings/problem.js';
 export declare class Problem extends Error implements IProblem {
     type: string;
     title: string;

package/{problem.js → cjs/problem.js}

@@ -1,30 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Problem = void 0;
-const defaults_1 = require("./util/defaults");
-const version_1 = require("./util/version");
+const defaults_js_1 = require("./util/defaults.js");
+const version_js_1 = require("./util/version.js");
 class Problem extends Error {
+    type = defaults_js_1.defaultType;
+    title = defaults_js_1.defaultTitle;
+    status = 500;
+    detail = defaults_js_1.defaultDetail;
+    instance = defaults_js_1.defaultInstance;
+    errorObject;
+    __problemVersion = version_js_1.version;
+    data = undefined;
+    middleware;
     constructor({ type, title, status, detail, instance, stack, errorObject, data, middleware }) {
-        var _a, _b;
-        super((_a = detail !== null && detail !== void 0 ? detail : title) !== null && _a !== void 0 ? _a : 'HTTP Problem Details');
-        this.type = defaults_1.defaultType;
-        this.title = defaults_1.defaultTitle;
-        this.status = 500;
-        this.detail = defaults_1.defaultDetail;
-        this.instance = defaults_1.defaultInstance;
-        this.__problemVersion = version_1.version;
-        this.data = undefined;
-        this.toObject = () => {
-            return {
-                'type': this.type,
-                'title': this.title,
-                'status': this.status,
-                'detail': this.detail,
-                'instance': this.instance,
-                '__problemVersion': this.__problemVersion,
-                'data': this.data
-            };
-        };
+        super(detail ?? title ?? 'HTTP Problem Details');
         // TODO: Figure out why i wrote this?
         Object.setPrototypeOf(this, new.target.prototype);
         this.type = type;
@@ -49,11 +39,22 @@ class Problem extends Error {
                 Error.captureStackTrace(this, this.constructor);
             }
             else {
-                this.stack = new Error((_b = detail !== null && detail !== void 0 ? detail : title) !== null && _b !== void 0 ? _b : 'HTTP Problem Details').stack;
+                this.stack = new Error(detail ?? title ?? 'HTTP Problem Details').stack;
             }
         }
         if (data)
             this.data = data;
     }
+    toObject = () => {
+        return {
+            'type': this.type,
+            'title': this.title,
+            'status': this.status,
+            'detail': this.detail,
+            'instance': this.instance,
+            '__problemVersion': this.__problemVersion,
+            'data': this.data
+        };
+    };
 }
 exports.Problem = Problem;