@emoyly/problem 7.0.4 → 7.0.5

package/cjs/util/getProblems.js

@@ -4,7 +4,7 @@ exports.isJsonProblem = isJsonProblem;
 exports.createFromJson = createFromJson;
 exports.getProblems = getProblems;
 const problem_js_1 = require("../problem.js");
-const isProblemArray_js_1 = require("./isProblemArray.js");
+const problemArray_js_1 = require("./problemArray.js");
 const version_js_1 = require("./version.js");
 const strings = ['title', 'type', 'instance', 'detail', '__problemVersion'];
 function isJsonProblem(input) {
@@ -23,23 +23,36 @@ function isJsonProblem(input) {
 function createFromJson({ title, type, instance, detail, status, data }) {
     return new problem_js_1.Problem({ title, type, instance, detail, status, data });
 }
-function getProblems(input) {
+/**
+ * Get an array of Problems from a given input.
+ * Handles existing Problems, arrays of Problems, JSON Problems, JSON Problem arrays and optionally attempts to parse any input with the given parsers.
+ * Only returns an array of Problems if it can successfully parse the input.
+ */
+function getProblems(input, parsers) {
     if (typeof input === 'string') {
         try {
             const p = JSON.parse(input);
             input = p;
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
         }
         catch (err) { /**/ }
     }
     if (input instanceof problem_js_1.Problem)
         return [input];
-    if ((0, isProblemArray_js_1.isProblemArray)(input))
+    if ((0, problemArray_js_1.isProblemArray)(input, false))
         return input;
-    if (Array.isArray(input) && input.every(val => isJsonProblem(val))) {
-        const _input = input;
-        return _input.map(val => createFromJson(val));
+    if (Array.isArray(input) && input.length > 0 && input.every(val => isJsonProblem(val))) {
+        return input.map(val => createFromJson(val));
     }
     if (isJsonProblem(input)) {
         return [createFromJson(input)];
     }
+    if (parsers) {
+        for (const parser of parsers) {
+            const problems = parser(input);
+            if (!problems || !problems.length)
+                continue;
+            return problems;
+        }
+    }
 }

package/cjs/util/index.d.ts

@@ -1,4 +1,4 @@
 export * from './getProblems.js';
 export * from './defaults.js';
-export * from './isProblemArray.js';
+export * from './problemArray.js';
 export * from './misc.js';

package/cjs/util/index.js

@@ -16,5 +16,5 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./getProblems.js"), exports);
 __exportStar(require("./defaults.js"), exports);
-__exportStar(require("./isProblemArray.js"), exports);
+__exportStar(require("./problemArray.js"), exports);
 __exportStar(require("./misc.js"), exports);

package/cjs/util/problemArray.d.ts

@@ -0,0 +1,7 @@
+import { Problem } from '../problem.js';
+/**
+ * Checks whether a given object is an array of Problem objects
+ * @param input Object to test
+ * @param allowEmpty If true or undefined, an empty array is considered a Problem array. If false, an empty array is not considered a Problem array.
+ */
+export declare function isProblemArray(input: unknown, allowEmpty?: boolean): input is Problem[];

package/cjs/util/problemArray.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isProblemArray = isProblemArray;
+const problem_js_1 = require("../problem.js");
+/**
+ * Checks whether a given object is an array of Problem objects
+ * @param input Object to test
+ * @param allowEmpty If true or undefined, an empty array is considered a Problem array. If false, an empty array is not considered a Problem array.
+ */
+function isProblemArray(input, allowEmpty) {
+    if (!Array.isArray(input))
+        return false;
+    if (input.length < 1) {
+        if (typeof allowEmpty !== 'boolean') {
+            console.warn(new Error('@emoyly/problem -> isProblemArray: input is an empty array, and therefore is considered a Problem array. If this is not the intended behavior, consider setting the "onlyWhenContent" argument to true.'));
+            return true;
+        }
+        return allowEmpty;
+    }
+    return input.every(val => val instanceof problem_js_1.Problem);
+}

package/cjs/util/version.d.ts

@@ -1,3 +1,3 @@
-export declare const version = "7.0.4";
+export declare const version = "7.0.5";
 export declare const major: number;
 export declare function isCompatibleVersion(inputVersion: string): boolean;

package/cjs/util/version.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.major = exports.version = void 0;
 exports.isCompatibleVersion = isCompatibleVersion;
-exports.version = '7.0.4';
+exports.version = '7.0.5';
 exports.major = Number(exports.version.split('.')[0]);
 function isCompatibleVersion(inputVersion) {
     // TODO: Remove this

package/esm/middleware/base.js

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

package/esm/parsers/jsonwebtoken.js

@@ -70,7 +70,10 @@ const parse = (input) => {
     if (input instanceof 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(found.result)];
+            return [new Problem({
+                    ...found.result,
+                    'errorObject': input,
+                })];
         }
     }
     else if (input instanceof TokenExpiredError && input.name === 'TokenExpiredError') {
@@ -79,6 +82,7 @@ const parse = (input) => {
                 'type': '/errors/jsonwebtoken/tokenexpired',
                 'detail': `The JSON Web Token expired at ${input.expiredAt}`,
                 'status': 400,
+                'errorObject': input,
             })];
     }
     else if (input instanceof NotBeforeError && input.name === 'NotBeforeError') {
@@ -87,8 +91,8 @@ const parse = (input) => {
                 'type': '/errors/jsonwebtoken/notbefore',
                 'detail': `The JSON Web Token is not valid before ${input.date}`,
                 'status': 400,
+                'errorObject': input,
             })];
     }
-    return [];
 };
 export default parse;

package/esm/parsers/mikroorm.js

@@ -4,7 +4,7 @@ import { NotFoundError } from '@mikro-orm/core';
 // TODO: Make this less bad
 const parse = (input) => {
     if (!(input instanceof NotFoundError)) {
-        return [];
+        return;
     }
     return [
         new Problem({

package/esm/parsers/tsoa.js

@@ -3,7 +3,7 @@ import { Problem } from '../problem.js';
 import { otherErrors } from '../defaults/others.js';
 const parse = (input) => {
     if (!(input instanceof ValidateError)) {
-        return [];
+        return;
     }
     // TODO: Give actual useful responses instead of this shit
     return [
@@ -15,6 +15,7 @@ const parse = (input) => {
                 'fields': input.fields,
             },
             'stack': input.stack,
+            'errorObject': input
         })
     ];
 };

package/esm/parsers/zod.d.ts

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

package/esm/parsers/zod.js

@@ -0,0 +1,17 @@
+import { ZodError } from 'zod';
+import { Problem } from '../problem.js';
+import { otherErrors } from '../defaults/others.js';
+const parse = (input) => {
+    if (!(input instanceof ZodError)) {
+        return;
+    }
+    return [new Problem({
+            ...otherErrors.inputValidationError,
+            'detail': input.message,
+            'status': 400,
+            'stack': input.stack,
+            'errorObject': input,
+            'data': input.issues
+        })];
+};
+export default parse;