@emoyly/problem 4.1.12 → 5.0.0

package/defaults/4xx.js

@@ -147,5 +147,5 @@ exports.statusCodes = {
         status: 451,
         title: 'Unavailable For Legal Reasons (RFC 7725)',
         type: 'errors/defaults/4xx/unavailableforlegalreasons'
-    },
+    }
 };

package/defaults/5xx.js

@@ -57,5 +57,5 @@ exports.statusCodes = {
         status: 510,
         title: 'Not Extended (RFC 2774)',
         type: 'errors/defaults/5xx/notextended'
-    },
+    }
 };

package/index.d.ts

@@ -2,3 +2,4 @@ export { Problem } from './problem';
 export * as defaults from './defaults';
 export { default as events } from './util/events';
 export * from './typings';
+export * from './util/isProblemArray';

package/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[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];
@@ -32,3 +36,4 @@ exports.defaults = __importStar(require("./defaults"));
 var events_1 = require("./util/events");
 Object.defineProperty(exports, "events", { enumerable: true, get: function () { return __importDefault(events_1).default; } });
 __exportStar(require("./typings"), exports);
+__exportStar(require("./util/isProblemArray"), exports);

package/middleware/axios.d.ts

@@ -1,10 +1,10 @@
 import type { PartialMiddlewareOptions } from '../typings/middleware';
 import { MiddlewareBase } from './base';
-declare type InterceptorArray = [undefined, (error: any) => Promise<never>];
+type InterceptorArray = [undefined, (error: unknown) => Promise<never>];
 export declare class AxiosMiddleware extends MiddlewareBase {
     name: string;
     constructor(options?: PartialMiddlewareOptions);
-    interceptor: (error: any) => Promise<never>;
+    interceptor: (error: unknown) => Promise<never>;
     /**
      * @example instance.interceptors.response.use(...middleware.use())
      */

package/middleware/base.d.ts

@@ -15,10 +15,10 @@ export declare abstract class MiddlewareBase {
     /**
      * Call this function when you want to use the middleware function
      */
-    abstract use(): any;
+    abstract use(): unknown;
     /**
      * Parse input using parsers
      */
-    parse: (input: any) => Promise<Problem[]>;
+    parse: (input: unknown) => Promise<Problem[]>;
     fallback: ProblemOpts;
 }

package/middleware/base.js

@@ -27,18 +27,25 @@ class MiddlewareBase {
          */
         this.parse = (input) => __awaiter(this, void 0, void 0, function* () {
             const problems = [];
-            const prob = getProblems_1.getProblems(input);
-            if (prob)
-                return prob;
-            for (const parse of this.options.parsers) {
-                const resp = parse(input);
-                if (!resp.length)
-                    continue;
-                problems.push(...resp);
-                break;
+            const prob = (0, getProblems_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_1.Problem(Object.assign(Object.assign({}, this.fallback), { 'errorObject': input, 'stack': (typeof input === 'object' && input !== null && 'stack' in input && typeof input.stack === 'string') ? input.stack : undefined })));
+                }
             }
-            if (!problems.length && this.enableFallback) {
-                problems.push(new problem_1.Problem(Object.assign(Object.assign({}, this.fallback), { 'errorObject': input, 'stack': input === null || input === void 0 ? void 0 : input.stack })));
+            else {
+                problems.push(...prob);
+            }
+            for (const p of problems) {
+                if (!p.middleware)
+                    p.middleware = this.name;
             }
             return problems;
         });

package/middleware/express.d.ts

@@ -3,13 +3,13 @@ import type { PartialMiddlewareOptions } from '../typings/middleware';
 import { MiddlewareBase } from './base';
 export declare class ExpressMiddleware extends MiddlewareBase {
     name: string;
-    middleware: (error: any, req: Request, res: Response, next: NextFunction) => void;
+    middleware: (error: unknown, req: Request, res: Response, next: NextFunction) => void;
     /**
      * 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: () => (error: any, req: Request, res: Response, next: NextFunction) => void;
+    use: () => (error: unknown, req: Request, res: Response, next: NextFunction) => void;
     constructor(options?: PartialMiddlewareOptions);
     /**
      * Put this right before the middleware.use() to catch all 404 errors and respond with a Problem instead of the default Express response

package/package.json

@@ -1,27 +1,32 @@
 {
     "name": "@emoyly/problem",
-    "version": "4.1.12",
+    "version": "5.0.0",
     "description": "A simple error library based around the RFC-7807 standard with optional support for Sentry.io and Express",
     "main": "index.js",
     "types": "index.d.ts",
     "repository": "https://github.com/emoyly/problem",
     "author": "Emil Petersen <emoyly@gmail.com>",
     "license": "MIT",
+    "scripts": {
+        "prepublish": "node ../scripts/ensureCorrectVersion.js"
+    },
     "devDependencies": {
-        "@mikro-orm/core": "^4.5.9",
-        "@types/express": "^4.17.11",
-        "@types/jsonwebtoken": "^8.5.1",
-        "@types/node": "^15.0.1",
-        "@typescript-eslint/eslint-plugin": "^4.22.0",
-        "@typescript-eslint/parser": "^4.22.0",
-        "eslint": "^7.25.0",
-        "fs-extra": "^9.1.0",
-        "jsonwebtoken": "^8.5.1",
-        "tsoa": "^3.7.0",
-        "typescript": "^4.2.4"
+        "@mikro-orm/core": "^5.6.11",
+        "@types/express": "^4.17.17",
+        "@types/jsonwebtoken": "^9.0.1",
+        "@types/node": "^18.14.0",
+        "@typescript-eslint/eslint-plugin": "^5.53.0",
+        "@typescript-eslint/parser": "^5.53.0",
+        "axios": "^1.3.3",
+        "eslint": "^8.34.0",
+        "fs-extra": "^11.1.0",
+        "jsonwebtoken": "^9.0.0",
+        "tsoa": "^5.1.1",
+        "typescript": "^4.9.5"
     },
     "peerDependencies": {
         "@mikro-orm/core": "^4.5.9",
+        "axios": "*",
         "jsonwebtoken": "^8.5.1",
         "tsoa": "^3.7.0"
     },
@@ -29,6 +34,9 @@
         "@mikro-orm/core": {
             "optional": true
         },
+        "axios": {
+            "optional": true
+        },
         "jsonwebtoken": {
             "optional": true
         },

package/parsers/axios.d.ts

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

package/parsers/axios.js

@@ -1,37 +1,37 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const axios_1 = require("axios");
 const others_1 = require("../defaults/others");
 const problem_1 = require("../problem");
 const getProblems_1 = require("../util/getProblems");
-const http_1 = require("./http");
+const misc_1 = require("../util/misc");
 const parse = (input) => {
-    var _a, _b, _c, _d, _e, _f;
+    var _a, _b, _c, _d, _e;
+    if (typeof input !== 'object' || input == null)
+        return [];
+    if (!(0, axios_1.isAxiosError)(input))
+        return [];
     const request = input.request;
     if ((_a = input === null || input === void 0 ? void 0 : input.response) === null || _a === void 0 ? void 0 : _a.data) {
-        const problems = getProblems_1.getProblems((_b = input === null || input === void 0 ? void 0 : input.response) === null || _b === void 0 ? void 0 : _b.data);
+        const problems = (0, getProblems_1.getProblems)((_b = input === null || input === void 0 ? void 0 : input.response) === null || _b === void 0 ? void 0 : _b.data);
         if (problems)
             return problems;
     }
     if (input === null || input === void 0 ? void 0 : input.response) {
-        const url = `${(_c = input.config) === null || _c === void 0 ? void 0 : _c.baseURL}${(_d = input.config) === null || _d === void 0 ? void 0 : _d.url}`;
-        const problem = http_1.parseHTTPError({
-            'body': input.response.data,
-            'headers': input.response.headers,
-            'statusCode': input.response.status,
-            url
-        });
-        if (problem)
-            return [problem];
+        const opts = (0, misc_1.getHttpError)(input.response.status);
+        if (opts)
+            return [new problem_1.Problem(Object.assign(Object.assign({}, opts), { 'instance': (_c = input === null || input === void 0 ? void 0 : input.config) === null || _c === void 0 ? void 0 : _c.url, 'stack': input === null || input === void 0 ? void 0 : 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_1.Problem(Object.assign(Object.assign({}, others_1.otherErrors.networkError), { 'instance': (_e = input === null || input === void 0 ? void 0 : input.config) === null || _e === void 0 ? void 0 : _e.url }))];
+            return [new problem_1.Problem(Object.assign(Object.assign({}, others_1.otherErrors.networkError), { 'instance': (_d = input === null || input === void 0 ? void 0 : input.config) === null || _d === void 0 ? void 0 : _d.url }))];
         }
         // Probably a ClientRequest
         if (isNode && 'pipe' in request && 'destroy' in request) {
-            return [new problem_1.Problem(Object.assign(Object.assign({}, others_1.otherErrors.networkError), { 'instance': (_f = input === null || input === void 0 ? void 0 : input.config) === null || _f === void 0 ? void 0 : _f.url }))];
+            return [new problem_1.Problem(Object.assign(Object.assign({}, others_1.otherErrors.networkError), { 'instance': (_e = input === null || input === void 0 ? void 0 : input.config) === null || _e === void 0 ? void 0 : _e.url }))];
         }
     }
     return [];

package/parsers/jsonwebtoken.d.ts

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

package/parsers/mikroorm.d.ts

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

package/parsers/tsoa.d.ts

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

package/problem.d.ts

@@ -1,4 +1,4 @@
-import { IProblem, ProblemOpts, JsonProblem } from './typings/problem';
+import type { IProblem, ProblemOpts, JsonProblem } from './typings/problem';
 export declare class Problem extends Error implements IProblem {
     type: string;
     title: string;
@@ -7,7 +7,8 @@ export declare class Problem extends Error implements IProblem {
     instance: string;
     errorObject?: unknown;
     __problemVersion: string;
-    data: any;
-    constructor({ type, title, status, detail, instance, stack, errorObject, data }: ProblemOpts);
+    data: unknown;
+    middleware?: string;
+    constructor({ type, title, status, detail, instance, stack, errorObject, data, middleware }: ProblemOpts);
     toObject: () => JsonProblem;
 }

package/problem.js

@@ -1,16 +1,17 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Problem = void 0;
+const defaults_1 = require("./util/defaults");
 const version_1 = require("./util/version");
 class Problem extends Error {
-    constructor({ type, title, status, detail, instance, stack, errorObject, data }) {
+    constructor({ type, title, status, detail, instance, stack, errorObject, data, middleware }) {
         var _a;
         super((_a = detail !== null && detail !== void 0 ? detail : title) !== null && _a !== void 0 ? _a : 'HTTP Problem Details');
-        this.type = '/errors/default/unknown';
-        this.title = 'Unknown error';
+        this.type = defaults_1.defaultType;
+        this.title = defaults_1.defaultTitle;
         this.status = 500;
-        this.detail = 'No extended details are available';
-        this.instance = '/unknown';
+        this.detail = defaults_1.defaultDetail;
+        this.instance = defaults_1.defaultInstance;
         this.__problemVersion = version_1.version;
         this.data = undefined;
         this.toObject = () => {
@@ -35,6 +36,8 @@ class Problem extends Error {
             this.instance = instance;
         if (errorObject)
             this.errorObject = errorObject;
+        if (middleware)
+            this.middleware = middleware;
         if (stack) {
             this.stack = stack;
         }