@emoyly/problem 7.0.4 → 7.0.5

package/esm/util/version.js

@@ -1,4 +1,4 @@
-export const version = '7.0.4';
+export const version = '7.0.5';
 export const major = Number(version.split('.')[0]);
 export function isCompatibleVersion(inputVersion) {
     // TODO: Remove this

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@emoyly/problem",
-  "version": "7.0.4",
-  "description": "A simple error library based around the RFC-7807 standard with optional support for Sentry.io and Express",
+  "version": "7.0.5",
+  "description": "A simple error library based around the RFC-7807 standard with optional support for different parsers and middleware.",
   "main": "cjs/index.js",
   "repository": "https://github.com/emoyly/problem",
   "author": "Emil Petersen <emoyly@gmail.com>",
@@ -9,29 +9,33 @@
   "type": "module",
   "scripts": {
     "build": "yarn dualBuild",
-    "lint": "eslint src",
+    "lint": "eslint src && node ./scripts/ensureCorrectVersion.js",
     "publish": "yarn npm publish --access public --tolerate-republish"
   },
   "devDependencies": {
-    "@emoyly/devutils": "^1.0.4",
-    "@emoyly/eslint-config": "^1.0.1",
-    "@emoyly/utils": "^1.0.1",
-    "@mikro-orm/core": "^6.2.9",
-    "@types/express": "^4.17.21",
-    "@types/jsonwebtoken": "^9.0.6",
-    "@types/node": "^20.14.11",
-    "axios": "^1.7.2",
-    "eslint": "^9.7.0",
+    "@emoyly/devutils": "^1.0.5",
+    "@emoyly/eslint-config": "^1.1.2",
+    "@emoyly/utils": "^1.0.4",
+    "@mikro-orm/core": "^6.4.0",
+    "@stylistic/eslint-plugin-js": "^2.11.0",
+    "@stylistic/eslint-plugin-ts": "^2.11.0",
+    "@types/express": "^5.0.0",
+    "@types/jsonwebtoken": "^9.0.7",
+    "@types/node": "^22.10.1",
+    "axios": "^1.7.8",
+    "eslint": "^9.16.0",
     "jsonwebtoken": "^9.0.2",
-    "tsoa": "^6.4.0",
-    "typescript": "^5.5.3",
-    "typescript-eslint": "^7.16.1"
+    "tsoa": "^6.5.1",
+    "typescript": "^5.7.2",
+    "typescript-eslint": "^8.17.0",
+    "zod": "^3.23.8"
   },
   "peerDependencies": {
     "@mikro-orm/core": "*",
     "axios": "*",
     "jsonwebtoken": "*",
-    "tsoa": "*"
+    "tsoa": "*",
+    "zod": "*"
   },
   "peerDependenciesMeta": {
     "@mikro-orm/core": {
@@ -45,9 +49,12 @@
     },
     "tsoa": {
       "optional": true
+    },
+    "zod": {
+      "optional": true
     }
   },
-  "packageManager": "yarn@4.3.1",
+  "packageManager": "yarn@4.5.3",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -84,6 +91,10 @@
     "./parsers/tsoa": {
       "import": "./esm/parsers/tsoa.js",
       "require": "./cjs/parsers/tsoa.js"
+    },
+    "./parsers/zod": {
+      "import": "./esm/parsers/zod.js",
+      "require": "./cjs/parsers/zod.js"
     }
   }
 }

package/scripts/ensureCorrectVersion.js

@@ -17,4 +17,4 @@ if (match[0] !== version){
     throw new Error(`Version in version.ts (${match[0]}) does not match package.json (${version})`)
 }
 
-console.log(`Version in version.ts matches package.json: ${version}`)
+//console.log(`Version in version.ts matches package.json: ${version}`)

package/src/middleware/base.ts

@@ -28,29 +28,17 @@ export abstract class MiddlewareBase {
      * Parse input using parsers
      */
     parse = async (input: unknown): Promise<Problem[]> => {
-        const problems: Problem[] = []
+        const problems = getProblems(input, this.options.parsers)
 
-        const prob = getProblems(input)
+        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
+            })]
 
-        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)
+            return []
         }
 
         for (const p of problems) {

package/src/parsers/axios.ts

@@ -9,7 +9,6 @@ function isAxiosError<T = unknown, D = unknown>(payload: unknown): payload is Ax
     return typeof payload === 'object' && payload !== null && 'isAxiosError' in payload && payload.isAxiosError === true
 }
 
-
 const parse: Parser = (input) => {
     if (typeof input !== 'object' || input == null) return []
     if (!isAxiosError(input)) return []

package/src/parsers/jsonwebtoken.ts

@@ -80,7 +80,10 @@ const parse: Parser = (input) => {
         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') {
         return [new Problem({
@@ -88,6 +91,7 @@ const parse: Parser = (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') {
         return [new Problem({
@@ -95,10 +99,9 @@ const parse: Parser = (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/src/parsers/mikroorm.ts

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

package/src/parsers/tsoa.ts

@@ -5,7 +5,7 @@ import type { Parser } from '../typings/parser.js'
 
 const parse: Parser = (input) => {
     if (!(input instanceof ValidateError)) {
-        return []
+        return
     }
 
     // TODO: Give actual useful responses instead of this shit
@@ -18,6 +18,7 @@ const parse: Parser = (input) => {
                 'fields': input.fields,
             },
             'stack': input.stack,
+            'errorObject': input
         })
     ]
 }

package/src/parsers/zod.ts

@@ -0,0 +1,21 @@
+import { ZodError } from 'zod'
+import type { Parser } from '../typings/parser.js'
+import { Problem } from '../problem.js'
+import { otherErrors } from '../defaults/others.js'
+
+const parse: Parser = (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

package/src/typings/parser.ts

@@ -1,3 +1,3 @@
 import type { Problem } from '../problem.js'
 
-export type Parser = (input: unknown) => Problem[]
+export type Parser = (input: unknown) => Problem[] | undefined

package/src/util/getProblems.ts

@@ -1,9 +1,10 @@
 import { Problem } from '../problem.js'
+import { Parser } from '../typings/parser.js'
 import type { JsonProblem } from '../typings/problem.js'
-import { isProblemArray } from './isProblemArray.js'
+import { isProblemArray } from './problemArray.js'
 import { isCompatibleVersion } from './version.js'
 
-const strings = ['title', 'type', 'instance', 'detail', '__problemVersion']
+const strings = ['title', 'type', 'instance', 'detail', '__problemVersion'] as const
 export function isJsonProblem(input: unknown): input is JsonProblem {
     if (input === null) return false
     if (typeof input !== 'object') return false
@@ -20,24 +21,36 @@ export function createFromJson({ title, type, instance, detail, status, data }:
     return new Problem({ title, type, instance, detail, status, data })
 }
 
-export function getProblems(input: unknown): Problem[] | void {
+/**
+ * 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.
+ */
+export function getProblems(input: unknown, parsers?: Parser[]): Problem[] | undefined {
     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) return [input]
-    if (isProblemArray(input)) return input
+    if (isProblemArray(input, false)) return input
 
-    if (Array.isArray(input) && input.every(val => isJsonProblem(val))) {
-        const _input = input as JsonProblem[]
-
-        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/src/util/index.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/src/util/misc.ts

@@ -18,3 +18,4 @@ export function getHttpError(statusCode: number | string): ProblemOpts | undefin
         return code
     }
 }
+

package/src/util/problemArray.ts

@@ -0,0 +1,21 @@
+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 function isProblemArray(input: unknown, allowEmpty?: boolean): input is Problem[] {
+    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)
+}

package/src/util/version.ts

@@ -1,4 +1,4 @@
-export const version = '7.0.4'
+export const version = '7.0.5'
 export const major = Number(version.split('.')[0])
 
 export function isCompatibleVersion(inputVersion: string) {

package/cjs/util/isProblemArray.d.ts

@@ -1,2 +0,0 @@
-import { Problem } from '../problem.js';
-export declare function isProblemArray(input: unknown): input is Problem[];

package/cjs/util/isProblemArray.js

@@ -1,9 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isProblemArray = isProblemArray;
-const problem_js_1 = require("../problem.js");
-function isProblemArray(input) {
-    if (!Array.isArray(input))
-        return false;
-    return input.every(val => val instanceof problem_js_1.Problem);
-}

package/esm/util/isProblemArray.d.ts

@@ -1,2 +0,0 @@
-import { Problem } from '../problem.js';
-export declare function isProblemArray(input: unknown): input is Problem[];

package/esm/util/isProblemArray.js

@@ -1,6 +0,0 @@
-import { Problem } from '../problem.js';
-export function isProblemArray(input) {
-    if (!Array.isArray(input))
-        return false;
-    return input.every(val => val instanceof Problem);
-}

package/src/util/isProblemArray.ts

@@ -1,6 +0,0 @@
-import { Problem } from '../problem.js'
-
-export function isProblemArray(input: unknown): input is Problem[] {
-    if (!Array.isArray(input)) return false
-    return input.every(val => val instanceof Problem)
-}