@emoyly/problem 8.0.6 → 9.1.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Emil Petersen
+Copyright (c) 2025 Emil Petersen
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/{esm → dist}/problem.d.ts

@@ -6,7 +6,7 @@ export declare class Problem extends Error implements IProblem {
     detail: string | undefined;
     instance: string | undefined;
     errorObject?: unknown;
-    readonly __problemVersion = "8.0.6";
+    readonly __problemVersion = "9.1.0";
     data: unknown;
     source?: string;
     constructor(opts: ProblemOpts);

package/{esm → dist}/util/index.d.ts

@@ -2,3 +2,4 @@ export * from './getProblems.js';
 export * from './problemArray.js';
 export * from './misc.js';
 export * from './validation.js';
+export { major as majorVersion, version } from './version.js';

package/{esm → dist}/util/index.js

@@ -2,3 +2,4 @@ export * from './getProblems.js';
 export * from './problemArray.js';
 export * from './misc.js';
 export * from './validation.js';
+export { major as majorVersion, version } from './version.js';

package/dist/util/version.d.ts

@@ -0,0 +1,2 @@
+export declare const version = "9.1.0";
+export declare const major: number;

package/{esm → dist}/util/version.js

@@ -1,2 +1,2 @@
-export const version = '8.0.6';
+export const version = '9.1.0';
 export const major = Number(version.split('.')[0]);

package/package.json

@@ -1,39 +1,41 @@
 {
   "name": "@emoyly/problem",
-  "version": "8.0.6",
+  "version": "9.1.0",
   "description": "A simple error library based around the RFC-7807 standard with optional support for different parsers and middleware.",
-  "main": "cjs/index.js",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "repository": "https://github.com/emoyly/problem",
   "author": "Emil Petersen <emoyly@gmail.com>",
   "license": "MIT",
   "type": "module",
   "scripts": {
-    "build": "yarn dualBuild && tsc -p test/tsconfig.json",
-    "lint": "eslint src && eslint test",
+    "build": "concurrently \"tsc\" \"tsc -p test/tsconfig.json\"",
+    "lint": "concurrently \"eslint src\" \"eslint test\"",
     "publish": "yarn npm publish --access public --tolerate-republish",
-    "test": "node --import @swc-node/register/esm-register --test ./test/**/*.test.ts"
+    "test": "concurrently \"node --import @swc-node/register/esm-register --test ./test/**/*.test.ts\" \"node --import @swc-node/register/esm-register ./test/consumptionTest.ts\""
   },
   "devDependencies": {
-    "@emoyly/devutils": "^1.0.5",
-    "@emoyly/eslint-config": "^1.1.2",
-    "@emoyly/utils": "^1.0.4",
-    "@mikro-orm/core": "^6.4.2",
-    "@stylistic/eslint-plugin-js": "^2.12.1",
-    "@stylistic/eslint-plugin-ts": "^2.12.1",
-    "@swc-node/register": "^1.10.9",
-    "@swc/core": "^1.10.3",
-    "@types/express": "^5.0.0",
-    "@types/jsonwebtoken": "^9.0.7",
-    "@types/node": "^22.10.2",
-    "@types/semver": "^7.5.8",
-    "axios": "^1.7.9",
-    "eslint": "^9.17.0",
+    "@emoyly/devutils": "^1.1.0",
+    "@emoyly/eslint-config": "^1.2.2",
+    "@emoyly/utils": "^2.0.3",
+    "@mikro-orm/core": "^6.5.3",
+    "@stylistic/eslint-plugin-js": "^4.4.1",
+    "@stylistic/eslint-plugin-ts": "^4.4.1",
+    "@swc-node/register": "^1.11.1",
+    "@swc/core": "^1.13.5",
+    "@types/express": "^5.0.3",
+    "@types/jsonwebtoken": "^9.0.10",
+    "@types/node": "^24.5.0",
+    "@types/semver": "^7.7.1",
+    "axios": "^1.12.2",
+    "concurrently": "^9.2.1",
+    "eslint": "^9.35.0",
     "jsonwebtoken": "^9.0.2",
-    "semver": "^7.6.3",
+    "semver": "^7.7.2",
     "tsoa": "^6.6.0",
-    "typescript": "^5.7.2",
-    "typescript-eslint": "^8.18.2",
-    "zod": "^3.24.1"
+    "typescript": "^5.9.2",
+    "typescript-eslint": "^8.44.0",
+    "zod": "^4.1.8"
   },
   "peerDependencies": {
     "@mikro-orm/core": "*",
@@ -59,47 +61,21 @@
       "optional": true
     }
   },
-  "packageManager": "yarn@4.5.3",
+  "packageManager": "yarn@4.9.4",
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
   },
   "exports": {
-    ".": {
-      "import": "./esm/index.js",
-      "require": "./cjs/index.js"
-    },
-    "./middleware/axios": {
-      "import": "./esm/middleware/axios.js",
-      "require": "./cjs/middleware/axios.js"
-    },
-    "./middleware/base": {
-      "import": "./esm/middleware/base.js",
-      "require": "./cjs/middleware/base.js"
-    },
-    "./middleware/express": {
-      "import": "./esm/middleware/express.js",
-      "require": "./cjs/middleware/express.js"
-    },
-    "./parsers/axios": {
-      "import": "./esm/parsers/axios.js",
-      "require": "./cjs/parsers/axios.js"
-    },
-    "./parsers/jsonwebtoken": {
-      "import": "./esm/parsers/jsonwebtoken.js",
-      "require": "./cjs/parsers/jsonwebtoken.js"
-    },
-    "./parsers/mikroorm": {
-      "import": "./esm/parsers/mikroorm.js",
-      "require": "./cjs/parsers/mikroorm.js"
-    },
-    "./parsers/tsoa": {
-      "import": "./esm/parsers/tsoa.js",
-      "require": "./cjs/parsers/tsoa.js"
-    },
-    "./parsers/zod": {
-      "import": "./esm/parsers/zod.js",
-      "require": "./cjs/parsers/zod.js"
-    }
+    ".": "./dist/index.js",
+    "./defaults": "./dist/defaults/index.js",
+    "./middleware/axios": "./dist/middleware/axios.js",
+    "./middleware/base": "./dist/middleware/base.js",
+    "./middleware/express": "./dist/middleware/express.js",
+    "./parsers/axios": "./dist/parsers/axios.js",
+    "./parsers/jsonwebtoken": "./dist/parsers/jsonwebtoken.js",
+    "./parsers/mikroorm": "./dist/parsers/mikroorm.js",
+    "./parsers/tsoa": "./dist/parsers/tsoa.js",
+    "./parsers/zod": "./dist/parsers/zod.js"
   }
 }

package/{cjs/defaults/4xx.js → src/defaults/4xx.ts}

@@ -1,8 +1,8 @@
-"use strict";
 // Source: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.statusCodes = void 0;
-exports.statusCodes = {
+
+import { Codes } from '../typings/codes.js'
+
+export const statusCodes = {
     400: {
         status: 400,
         title: 'Bad Request',
@@ -148,4 +148,4 @@ exports.statusCodes = {
         title: 'Unavailable For Legal Reasons (RFC 7725)',
         type: 'errors/defaults/4xx/unavailableforlegalreasons'
     }
-};
+} as const satisfies Codes

package/{cjs/defaults/5xx.js → src/defaults/5xx.ts}

@@ -1,8 +1,8 @@
-"use strict";
 // Source: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.statusCodes = void 0;
-exports.statusCodes = {
+
+import { Codes } from '../typings/codes.js'
+
+export const statusCodes = {
     500: {
         status: 500,
         title: 'Internal Server Error',
@@ -58,4 +58,4 @@ exports.statusCodes = {
         title: 'Not Extended (RFC 2774)',
         type: 'errors/defaults/5xx/notextended'
     }
-};
+} as const satisfies Codes

package/{cjs/defaults/aws.js → src/defaults/aws.ts}

@@ -1,8 +1,8 @@
-"use strict";
 // Source: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-troubleshooting.html
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.statusCodes = void 0;
-exports.statusCodes = {
+
+import { Codes } from '../typings/codes.js'
+
+export const statusCodes = {
     460: {
         status: 460,
         title: 'Client closed connection before idle timeout period elapsed',
@@ -13,4 +13,4 @@ exports.statusCodes = {
         title: 'X-Forwarded-For contains more than 30 ips',
         type: '/errors/defaults/aws/toomanyips'
     }
-};
+} as const satisfies Codes

package/{cjs/defaults/cloudflare.js → src/defaults/cloudflare.ts}

@@ -1,8 +1,8 @@
-"use strict";
 // Source: https://support.cloudflare.com/hc/en-us/articles/115003011431
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.statusCodes = void 0;
-exports.statusCodes = {
+
+import { Codes } from '../typings/codes.js'
+
+export const statusCodes = {
     520: {
         status: 520,
         title: 'Web Server returned an unknown error',
@@ -49,4 +49,4 @@ exports.statusCodes = {
         title: 'Cloudflare returned 1xxx error',
         type: '/errors/defaults/cloudflare/1xxx'
     }
-};
+} as const satisfies Codes

package/{cjs/defaults/iis.js → src/defaults/iis.ts}

@@ -1,8 +1,8 @@
-"use strict";
 // Source: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.statusCodes = void 0;
-exports.statusCodes = {
+
+import { Codes } from '../typings/codes.js'
+
+export const statusCodes = {
     440: {
         status: 440,
         title: 'Login Time-out',
@@ -18,4 +18,4 @@ exports.statusCodes = {
         title: 'Redirect',
         type: '/errors/defaults/iis/redirect'
     }
-};
+} as const satisfies Codes

package/src/defaults/index.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/nginx.js → src/defaults/nginx.ts}

@@ -1,8 +1,8 @@
-"use strict";
 // Source: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.statusCodes = void 0;
-exports.statusCodes = {
+
+import { Codes } from '../typings/codes.js'
+
+export const statusCodes = {
     444: {
         status: 494,
         title: 'No Response',
@@ -33,4 +33,4 @@ exports.statusCodes = {
         title: 'Client Closed Request',
         type: '/errors/defaults/nginx/clientclosedreq'
     }
-};
+} as const satisfies Codes

package/{cjs/defaults/others.js → src/defaults/others.ts}

@@ -1,7 +1,6 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.otherErrors = void 0;
-exports.otherErrors = {
+import { Codes } from '../typings/codes.js'
+
+export const otherErrors = {
     'unknown': {
         status: 500,
         title: 'Unknown error',
@@ -37,4 +36,4 @@ exports.otherErrors = {
         title: 'Input failed validation',
         type: '/errors/defaults/others/validationerror'
     }
-};
+} as const satisfies Codes

package/src/index.ts

@@ -0,0 +1,4 @@
+export { Problem } from './problem.js'
+export * as defaults from './defaults/index.js'
+export * from './typings/index.js'
+export * from './util/index.js'

package/src/middleware/axios.ts

@@ -0,0 +1,26 @@
+import type { PartialMiddlewareOptions } from '../typings/middleware.js'
+import { MiddlewareBase } from './base.js'
+import axiosParser from '../parsers/axios.js'
+
+type InterceptorArray = [undefined, (error: unknown) => Promise<never>]
+
+export class AxiosMiddleware extends MiddlewareBase {
+    readonly name = 'axios'
+
+    constructor(options?: PartialMiddlewareOptions) {
+        super({
+            'parsers': [axiosParser]
+        }, options)
+    }
+
+    private readonly interceptor = async (error: unknown) => {
+        const problems = this.parse(error)
+        this.emit(problems)
+        return Promise.reject(problems)
+    }
+
+    /**
+     * @example instance.interceptors.response.use(...middleware.use())
+     */
+    readonly use = (): InterceptorArray => [undefined, this.interceptor]
+}

package/src/middleware/base.ts

@@ -0,0 +1,72 @@
+import { otherErrors } from '../defaults/index.js'
+import { Problem } from '../problem.js'
+import type { ProblemOpts } from '../typings/index.js'
+import type { MiddlewareOptions, PartialMiddlewareOptions, ProblemListener } from '../typings/middleware.js'
+import { getProblems } from '../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
+ */
+export abstract class MiddlewareBase {
+    readonly options: MiddlewareOptions
+    abstract readonly name: string
+    /**
+     * When nothing is returned from the parsers, just throw in a default "fallback" Problem object, so that a Problem is still actually returned/emitted
+     */
+    readonly enableFallback: boolean = true
+
+    constructor(defaultOptions: MiddlewareOptions, options?: PartialMiddlewareOptions) {
+        this.options = { ...defaultOptions, ...options }
+    }
+
+    /**
+     * Parse input using parsers
+     */
+    protected readonly parse = (input: unknown): Problem[] => {
+        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,
+                'source': `middleware:${this.name}`
+            })]
+
+            return []
+        }
+
+        for (const p of problems) {
+            if (!p.source) p.source = `middleware:${this.name}`
+        }
+
+        return problems
+    }
+
+    protected readonly fallback: ProblemOpts = otherErrors.unknown
+
+    protected readonly problemListeners: ProblemListener[] = []
+
+    protected emit = (list: Problem[]) => {
+        for (const listener of this.problemListeners) {
+            listener(list)
+        }
+    }
+
+    /**
+     * Listen to problems
+     */
+    readonly onProblem = (listener: ProblemListener) => {
+        this.problemListeners.push(listener)
+    }
+
+    /**
+     * Un-listen to problems
+     */
+    readonly offProblem = (listener: ProblemListener) => {
+        const idx = this.problemListeners.findIndex(val => val === listener)
+
+        if (idx < 0 || isNaN(idx)) return
+
+        this.problemListeners.splice(idx, 1)
+    }
+}

package/src/middleware/express.ts

@@ -0,0 +1,52 @@
+import type { NextFunction, Request, Response } from 'express'
+import type { PartialMiddlewareOptions } from '../typings/middleware.js'
+import { MiddlewareBase } from './base.js'
+import { Problem } from '../problem.js'
+import { codes4xx } from '../defaults/index.js'
+
+export class ExpressMiddleware extends MiddlewareBase {
+    readonly name = 'express'
+
+    private middleware = (error: unknown, req: Request, res: Response, next: NextFunction) => {
+        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()))
+    }
+
+    /**
+     * 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())
+     */
+    readonly use = () => this.middleware
+
+    constructor(options?: PartialMiddlewareOptions) {
+        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)
+     */
+    readonly notFound = (req: Request, res: Response, next: NextFunction) => {
+        const error = new Problem({
+            ...codes4xx[404],
+            'instance': req.originalUrl,
+            'detail': `No API endpoints exist on ${req.url} for request method ${req.method}`
+        })
+
+        return next(error)
+    }
+}

package/src/parsers/axios.ts

@@ -0,0 +1,59 @@
+import { otherErrors } from '../defaults/others.js'
+import { Problem } from '../problem.js'
+import type { Parser } from '../typings/parser.js'
+import { getProblems } from '../util/getProblems.js'
+import { getCodeDefaults } from '../util/misc.js'
+import { isAxiosError } from 'axios'
+
+const parse: Parser = (input) => {
+    if (typeof input !== 'object' || input == null) return []
+    if (!isAxiosError(input)) return []
+    const request = input.request
+
+    if (input?.response?.data) {
+        const problems = getProblems(input?.response?.data)
+        if (problems?.length) return problems
+    }
+
+    if (input?.response) {
+        const opts = getCodeDefaults(input.response.status)
+        if (opts) return [new Problem({
+            ...opts,
+            'instance': input?.config?.url,
+            'stack': input?.stack,
+            'errorObject': input,
+            'source': 'parser:axios'
+        })]
+    }
+
+    // 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({
+                ...otherErrors.networkError,
+                'instance': input?.config?.url,
+                'stack': input?.stack,
+                'errorObject': input,
+                'source': 'parser:axios'
+            })]
+        }
+
+        // Probably a ClientRequest
+        if (isNode && 'pipe' in request && 'destroy' in request) {
+            return [new Problem({
+                ...otherErrors.networkError,
+                'instance': input?.config?.url,
+                'stack': input?.stack,
+                'errorObject': input,
+                'source': 'parser:axios'
+            })]
+        }
+    }
+
+    return []
+}
+
+export default parse

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

@@ -1,8 +1,14 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const problem_js_1 = require("../problem.js");
-const jsonwebtoken_1 = require("jsonwebtoken");
-const errorMap = [
+import { Problem } from '../problem.js'
+import type { Parser } from '../typings/parser.js'
+import { JsonWebTokenError, NotBeforeError, TokenExpiredError } from 'jsonwebtoken'
+import type { ProblemOpts } from '../typings/problem.js'
+
+interface ErrorMap {
+    'search': string | RegExp,
+    'result': ProblemOpts,
+}
+
+const errorMap: ErrorMap[] = [
     {
         'search': 'invalid token',
         'result': {
@@ -67,37 +73,38 @@ const errorMap = [
             'title': 'The JSON Web Token subject is invalid',
         }
     }
-];
-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));
+]
+
+const parse: Parser = (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_js_1.Problem({
-                    ...found.result,
-                    'errorObject': input,
-                    'source': 'parser:jsonwebtoken'
-                })];
-        }
-    }
-    else if (input instanceof jsonwebtoken_1.TokenExpiredError && input.name === 'TokenExpiredError') {
-        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}`,
-                'status': 400,
-                'errorObject': input,
-                'source': 'parser:jsonwebtoken'
-            })];
-    }
-    else if (input instanceof jsonwebtoken_1.NotBeforeError && input.name === 'NotBeforeError') {
-        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}`,
-                'status': 400,
+            return [new Problem({
+                ...found.result,
                 'errorObject': input,
                 'source': 'parser:jsonwebtoken'
-            })];
+            })]
+        }
+    } else if (input instanceof TokenExpiredError && input.name === 'TokenExpiredError') {
+        return [new Problem({
+            'title': 'The JSON Web Token has expired',
+            'type': '/errors/jsonwebtoken/tokenexpired',
+            'detail': `The JSON Web Token expired at ${input.expiredAt}`,
+            'status': 400,
+            'errorObject': input,
+            'source': 'parser:jsonwebtoken'
+        })]
+    } else if (input instanceof NotBeforeError && input.name === 'NotBeforeError') {
+        return [new 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}`,
+            'status': 400,
+            'errorObject': input,
+            'source': 'parser:jsonwebtoken'
+        })]
     }
-};
-exports.default = parse;
+}
+
+export default parse

package/src/parsers/mikroorm.ts

@@ -0,0 +1,22 @@
+import { Problem } from '../problem.js'
+import { statusCodes } from '../defaults/4xx.js'
+import type { Parser } from '../typings/parser.js'
+import { NotFoundError } from '@mikro-orm/core'
+
+// TODO: Make this less bad
+const parse: Parser = (input) => {
+    if (!(input instanceof NotFoundError)) {
+        return
+    }
+
+    return [
+        new Problem({
+            ...statusCodes['404'],
+            'stack': input.stack,
+            'errorObject': input,
+            'source': 'parser:mikroorm'
+        })
+    ]
+}
+
+export default parse