@emoyly/problem 7.0.6 → 8.0.0

package/esm/util/getProblems.js

@@ -1,25 +1,28 @@
 import { Problem } from '../problem.js';
 import { isProblemArray } from './problemArray.js';
-import { isCompatibleVersion } from './version.js';
-const strings = ['title', 'type', 'instance', 'detail', '__problemVersion'];
+import { validateBasicInput } from './validation.js';
 export function isJsonProblem(input) {
-    if (input === null)
-        return false;
-    if (typeof input !== 'object')
-        return false;
-    if (!strings.every(val => val in input && typeof input[val] === 'string'))
-        return false;
-    if (!isCompatibleVersion(('__problemVersion' in input && typeof input['__problemVersion'] === 'string') ? input['__problemVersion'] : ''))
-        return false;
-    if (!('status' in input) || typeof input.status !== 'number')
-        return false;
-    return true;
+    return validateBasicInput(input) === true;
 }
-export function createFromJson({ title, type, instance, detail, status, data }) {
+export function createFromJson({ title, type, instance, detail, status, data: _data, ...extras }) {
+    let data;
+    const extraKeys = Object.keys(extras);
+    if /* No extras, just use data */ (extraKeys.length < 1) {
+        data = _data;
+    }
+    else if /* Extras but no data, just use extras */ ((_data === undefined || _data === null)) {
+        data = extras;
+    }
+    else if /* Data is not object we can merge with, and we do have extras */ (typeof _data !== 'object' || Array.isArray(_data) || Object.keys(_data).some(val => extraKeys.includes(val))) {
+        data = { original: _data, extras };
+    }
+    else {
+        data = { ...extras, ..._data };
+    }
     return new Problem({ title, type, instance, detail, status, data });
 }
 /**
- * Get an array of Problems from a given input.
+ * Get an array of Problems from any 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.
  */

package/esm/util/index.d.ts

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

package/esm/util/index.js

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

package/esm/util/misc.d.ts

@@ -1,2 +1,2 @@
-import { ProblemOpts } from '../typings/index.js';
-export declare function getHttpError(statusCode: number | string): ProblemOpts | undefined;
+import { CodeOpts } from '../typings/index.js';
+export declare function getCodeDefaults(statusCode: number | string): CodeOpts | undefined;

package/esm/util/misc.js

@@ -1,7 +1,6 @@
 import * as allCodes from '../defaults/index.js';
-export function getHttpError(statusCode) {
+export function getCodeDefaults(statusCode) {
     for (const key in allCodes) {
-        // This ensures all codes are written correctly as well, so that's a bonus
         const codeObject = allCodes[key];
         if (typeof statusCode === 'string') {
             const conv = Number(statusCode);
@@ -10,7 +9,7 @@ export function getHttpError(statusCode) {
         }
         const code = codeObject[statusCode];
         if (!code)
-            return;
+            continue;
         return code;
     }
 }

package/esm/util/validation.d.ts

@@ -0,0 +1,5 @@
+export declare class ProblemValidationError extends Error {
+    errors: string[];
+    constructor(errors: string[]);
+}
+export declare function validateBasicInput(input: unknown): true | ProblemValidationError;

package/esm/util/validation.js

@@ -0,0 +1,33 @@
+export class ProblemValidationError extends Error {
+    errors;
+    constructor(errors) {
+        super(`Problem input is invalid:\n${errors.join('\n')}`);
+        this.errors = errors;
+    }
+}
+const requiredStrings = ['title', 'type'];
+const optionalStrings = ['detail', '__problemVersion', 'instance', 'stack', 'source'];
+export function validateBasicInput(input) {
+    const errors = [];
+    if (input === null) {
+        errors.push('Input is null');
+        return new ProblemValidationError(errors);
+    }
+    if (typeof input !== 'object') {
+        errors.push('Input is not an object');
+        return new ProblemValidationError(errors);
+    }
+    const missingRequired = requiredStrings.filter(val => typeof input[val] !== 'string');
+    for (const miss of missingRequired) {
+        errors.push(`"${miss}" is missing or not a string`);
+    }
+    const wrongOptional = optionalStrings.filter((val) => val in input && input[val] !== undefined && input[val] !== null && typeof input[val] !== 'string');
+    for (const wrong of wrongOptional) {
+        errors.push(`"${wrong}" is set, and is not a string`);
+    }
+    if (!('status' in input) || typeof input.status !== 'number')
+        errors.push('Status is not a number');
+    if (errors.length > 0)
+        return new ProblemValidationError(errors);
+    return true;
+}

package/esm/util/version.d.ts

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

package/esm/util/version.js

@@ -1,16 +1,2 @@
-export const version = '7.0.6';
+export const version = '8.0.0';
 export const major = Number(version.split('.')[0]);
-export function isCompatibleVersion(inputVersion) {
-    // TODO: Remove this
-    if (inputVersion === 'lua-dev')
-        return true;
-    const parts = inputVersion.split('.');
-    const inputMajor = Number(parts[0]);
-    if (parts.length !== 3)
-        return false;
-    if (isNaN(inputMajor))
-        return false;
-    if (inputMajor !== major)
-        return false;
-    return true;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@emoyly/problem",
-  "version": "7.0.6",
+  "version": "8.0.0",
   "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",
@@ -8,27 +8,32 @@
   "license": "MIT",
   "type": "module",
   "scripts": {
-    "build": "yarn dualBuild",
-    "lint": "eslint src && node ./scripts/ensureCorrectVersion.js",
-    "publish": "yarn npm publish --access public --tolerate-republish"
+    "build": "yarn dualBuild && tsc -p test/tsconfig.json",
+    "lint": "eslint src && eslint test",
+    "publish": "yarn npm publish --access public --tolerate-republish",
+    "test": "node --import @swc-node/register/esm-register --test ./test/**/*.test.ts"
   },
   "devDependencies": {
     "@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",
+    "@mikro-orm/core": "^6.4.1",
+    "@stylistic/eslint-plugin-js": "^2.12.1",
+    "@stylistic/eslint-plugin-ts": "^2.12.1",
+    "@swc-node/register": "^1.10.9",
+    "@swc/core": "^1.10.1",
     "@types/express": "^5.0.0",
     "@types/jsonwebtoken": "^9.0.7",
-    "@types/node": "^22.10.1",
-    "axios": "^1.7.8",
-    "eslint": "^9.16.0",
+    "@types/node": "^22.10.2",
+    "@types/semver": "^7",
+    "axios": "^1.7.9",
+    "eslint": "^9.17.0",
     "jsonwebtoken": "^9.0.2",
-    "tsoa": "^6.5.1",
+    "semver": "^7.6.3",
+    "tsoa": "^6.6.0",
     "typescript": "^5.7.2",
-    "typescript-eslint": "^8.17.0",
-    "zod": "^3.23.8"
+    "typescript-eslint": "^8.18.1",
+    "zod": "^3.24.1"
   },
   "peerDependencies": {
     "@mikro-orm/core": "*",

package/tsconfig.json

@@ -10,6 +10,10 @@
     },
     "exclude": [
         "./esm/",
-        "./cjs/"
+        "./cjs/",
+        "./test/"
+    ],
+    "include": [
+        "./src"
     ]
 }

package/.editorconfig

@@ -1,11 +0,0 @@
-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

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

package/.vscode/settings.json

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

package/cjs/util/defaults.d.ts

@@ -1,4 +0,0 @@
-export declare const defaultType = "/errors/default/unknown";
-export declare const defaultTitle = "Unknown error";
-export declare const defaultDetail = "No extended details are available";
-export declare const defaultInstance = "/unknown";

package/cjs/util/defaults.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.defaultInstance = exports.defaultDetail = exports.defaultTitle = exports.defaultType = void 0;
-exports.defaultType = '/errors/default/unknown';
-exports.defaultTitle = 'Unknown error';
-exports.defaultDetail = 'No extended details are available';
-exports.defaultInstance = '/unknown';

package/esm/util/defaults.d.ts

@@ -1,4 +0,0 @@
-export declare const defaultType = "/errors/default/unknown";
-export declare const defaultTitle = "Unknown error";
-export declare const defaultDetail = "No extended details are available";
-export declare const defaultInstance = "/unknown";

package/esm/util/defaults.js

@@ -1,4 +0,0 @@
-export const defaultType = '/errors/default/unknown';
-export const defaultTitle = 'Unknown error';
-export const defaultDetail = 'No extended details are available';
-export const defaultInstance = '/unknown';

package/scripts/ensureCorrectVersion.js

@@ -1,20 +0,0 @@
-// @ts-check
-import * as fs from 'node:fs'
-import * as path from 'node:path'
-import { fileURLToPath } from 'node:url'
-
-const dirname = path.dirname(fileURLToPath(import.meta.url))
-
-const { version } = JSON.parse(fs.readFileSync(path.join(dirname, '..', 'package.json'), 'utf-8'))
-const versionTs = fs.readFileSync(path.join(dirname, '../src/util/version.ts'), 'utf-8')
-
-const match = versionTs.match(/(?<=export const version = ')(\d+\.\d+\.\d+)(?=')/)
-if (!match?.[0]){
-    throw new Error('Could not find version in version.ts')
-}
-
-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}`)

package/src/defaults/4xx.ts

@@ -1,149 +0,0 @@
-// Source: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
-
-export const statusCodes = {
-    400: {
-        status: 400,
-        title: 'Bad Request',
-        type: '/errors/defaults/4xx/badrequest',
-    },
-    401: {
-        status: 401,
-        title: 'Unauthorized',
-        type: '/errors/defaults/4xx/unauthorized',
-    },
-    402: {
-        status: 402,
-        title: 'Payment Required',
-        type: '/errors/defaults/4xx/paymentrequired',
-    },
-    403: {
-        status: 403,
-        title: 'Forbidden',
-        type: '/errors/defaults/4xx/forbidden',
-    },
-    404: {
-        status: 404,
-        title: 'Not Found',
-        type: '/errors/defaults/4xx/notfound',
-    },
-    406: {
-        status: 406,
-        title: 'Not Acceptable',
-        type: 'errors/defaults/4xx/notacceptable'
-    },
-    405: {
-        status: 405,
-        title: 'Method Not Allowed',
-        type: 'errors/defaults/4xx/methodnotallowed'
-    },
-    407: {
-        status: 407,
-        title: 'Proxy Authentication Required (RFC 7235)',
-        type: 'errors/defaults/4xx/proxyauthenticationrequired'
-    },
-    408: {
-        status: 408,
-        title: 'Request Timeout',
-        type: 'errors/defaults/4xx/requesttimeout'
-    },
-    409: {
-        status: 409,
-        title: 'Conflict',
-        type: 'errors/defaults/4xx/conflict'
-    },
-    410: {
-        status: 410,
-        title: 'Gone',
-        type: 'errors/defaults/4xx/gone'
-    },
-    411: {
-        status: 411,
-        title: 'Length Required',
-        type: 'errors/defaults/4xx/lengthrequired'
-    },
-    412: {
-        status: 412,
-        title: 'Precondition Failed (RFC 7232)',
-        type: 'errors/defaults/4xx/preconditionfailed'
-    },
-    413: {
-        status: 413,
-        title: 'Payload Too Large (RFC 7231)',
-        type: 'errors/defaults/4xx/payloadtoolarge'
-    },
-    414: {
-        status: 414,
-        title: 'URI Too Long (RFC 7231)',
-        type: 'errors/defaults/4xx/uritoolong'
-    },
-    415: {
-        status: 415,
-        title: 'Unsupported Media Type (RFC 7231)',
-        type: 'errors/defaults/4xx/unsupportedmediatype'
-    },
-    416: {
-        status: 416,
-        title: 'Range Not Satisfiable (RFC 7233)',
-        type: 'errors/defaults/4xx/rangenotsatisfiable'
-    },
-    417: {
-        status: 417,
-        title: 'Expectation Failed',
-        type: 'errors/defaults/4xx/expectationfailed'
-    },
-    418: {
-        status: 418,
-        title: 'I\'m a teapot (RFC 2324, RFC 7168)',
-        type: 'errors/defaults/4xx/i\'mateapot'
-    },
-    421: {
-        status: 421,
-        title: 'Misdirected Request (RFC 7540)',
-        type: 'errors/defaults/4xx/misdirectedrequest'
-    },
-    422: {
-        status: 422,
-        title: 'Unprocessable Entity (WebDAV; RFC 4918)',
-        type: 'errors/defaults/4xx/unprocessableentity'
-    },
-    423: {
-        status: 423,
-        title: 'Locked (WebDAV; RFC 4918)',
-        type: 'errors/defaults/4xx/locked'
-    },
-    424: {
-        status: 424,
-        title: 'Failed Dependency (WebDAV; RFC 4918)',
-        type: 'errors/defaults/4xx/faileddependency'
-    },
-    425: {
-        status: 425,
-        title: 'Too Early (RFC 8470)',
-        type: 'errors/defaults/4xx/tooearly'
-    },
-    426: {
-        status: 426,
-        title: 'Upgrade Required',
-        type: 'errors/defaults/4xx/upgraderequired'
-    },
-    428: {
-        status: 428,
-        title: 'Precondition Required (RFC 6585)',
-        type: 'errors/defaults/4xx/preconditionrequired'
-    },
-    429: {
-        status: 429,
-        title: 'Too Many Requests (RFC 6585)',
-        type: 'errors/defaults/4xx/toomanyrequests'
-    },
-    431: {
-        status: 431,
-        title: 'Request Header Fields Too Large (RFC 6585)',
-        type: 'errors/defaults/4xx/requestheaderfieldstoolarge'
-    },
-    451: {
-        status: 451,
-        title: 'Unavailable For Legal Reasons (RFC 7725)',
-        type: 'errors/defaults/4xx/unavailableforlegalreasons'
-    }
-}

package/src/defaults/5xx.ts

@@ -1,59 +0,0 @@
-// Source: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
-
-export const statusCodes = {
-    500: {
-        status: 500,
-        title: 'Internal Server Error',
-        type: 'errors/defaults/5xx/internalservererror'
-    },
-    501: {
-        status: 501,
-        title: 'Not Implemented',
-        type: 'errors/defaults/5xx/notimplemented'
-    },
-    502: {
-        status: 502,
-        title: 'Bad Gateway',
-        type: 'errors/defaults/5xx/badgateway'
-    },
-    503: {
-        status: 503,
-        title: 'Service Unavailable',
-        type: 'errors/defaults/5xx/serviceunavailable'
-    },
-    504: {
-        status: 504,
-        title: 'Gateway Timeout',
-        type: 'errors/defaults/5xx/gatewaytimeout'
-    },
-    505: {
-        status: 505,
-        title: 'HTTP Version Not Supported',
-        type: 'errors/defaults/5xx/httpversionnotsupported'
-    },
-    506: {
-        status: 506,
-        title: 'Variant Also Negotiates (RFC 2295)',
-        type: 'errors/defaults/5xx/variantalsonegotiates'
-    },
-    507: {
-        status: 507,
-        title: 'Insufficient Storage (WebDAV; RFC 4918)',
-        type: 'errors/defaults/5xx/insufficientstorage'
-    },
-    508: {
-        status: 508,
-        title: 'Loop Detected (WebDAV; RFC 5842)',
-        type: 'errors/defaults/5xx/loopdetected'
-    },
-    511: {
-        status: 511,
-        title: 'Network Authentication Required (RFC 6585)',
-        type: 'errors/defaults/5xx/networkauthenticationrequired'
-    },
-    510: {
-        status: 510,
-        title: 'Not Extended (RFC 2774)',
-        type: 'errors/defaults/5xx/notextended'
-    }
-}

package/src/defaults/aws.ts

@@ -1,14 +0,0 @@
-// Source: https://docs.aws.amazon.com/elasticloadbalancing/latest/application/load-balancer-troubleshooting.html
-
-export const statusCodes = {
-    460: {
-        status: 460,
-        title: 'Client closed connection before idle timeout period elapsed',
-        type: '/errors/defaults/aws/clientclosedbeforetimeout',
-    },
-    463: {
-        status: 463,
-        title: 'X-Forwarded-For contains more than 30 ips',
-        type: '/errors/defaults/aws/toomanyips'
-    }
-}

package/src/defaults/cloudflare.ts

@@ -1,50 +0,0 @@
-// Source: https://support.cloudflare.com/hc/en-us/articles/115003011431
-
-export const statusCodes = {
-    520: {
-        status: 520,
-        title: 'Web Server returned an unknown error',
-        type: '/errors/defaults/cloudflare/unknownerror',
-    },
-    521: {
-        status: 521,
-        title: 'Web server is down',
-        type: '/errors/defaults/cloudflare/webserverdown',
-    },
-    522: {
-        status: 522,
-        title: 'Connection timed out',
-        type: '/errors/defaults/cloudflare/connectiontimeout',
-    },
-    523: {
-        status: 523,
-        title: 'Origin is unreachable',
-        type: '/errors/defaults/cloudflare/originunreachable'
-    },
-    524: {
-        status: 524,
-        title: 'A timeout occurred',
-        type: '/errors/defaults/cloudflare/timeout'
-    },
-    525: {
-        status: 525,
-        title: 'SSL handshake failed',
-        type: '/errors/defaults/cloudflare/sslhandshakefail'
-    },
-    526: {
-        status: 526,
-        title: 'Invalid SSL certificate',
-        type: '/errors/defaults/cloudflare/invalidssl'
-    },
-    // A 527 error indicates an interrupted connection between Cloudflare and your origin's Railgun server (rg-listener)
-    527: {
-        status: 527,
-        title: 'Railgun Listener to origin error',
-        type: '/errors/defaults/cloudflare/railgunoriginerr'
-    },
-    530: {
-        status: 530,
-        title: 'Cloudflare returned 1xxx error',
-        type: '/errors/defaults/cloudflare/1xxx'
-    }
-}

package/src/defaults/iis.ts

@@ -1,19 +0,0 @@
-// Source: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
-
-export const statusCodes = {
-    440: {
-        status: 440,
-        title: 'Login Time-out',
-        type: '/errors/defaults/iis/logintimeout',
-    },
-    449: {
-        status: 449,
-        title: 'Retry with required information',
-        type: '/errors/defaults/iis/retrywith'
-    },
-    451: {
-        status: 451,
-        title: 'Redirect',
-        type: '/errors/defaults/iis/redirect'
-    }
-}

package/src/defaults/index.ts

@@ -1,7 +0,0 @@
-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/src/defaults/nginx.ts

@@ -1,34 +0,0 @@
-// Source: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
-
-export const statusCodes = {
-    444: {
-        status: 494,
-        title: 'No Response',
-        type: '/errors/defaults/nginx/noresponse',
-    },
-    494: {
-        status: 494,
-        title: 'Request header too large',
-        type: '/errors/defaults/nginx/headertoolarge',
-    },
-    495: {
-        status: 495,
-        title: 'SSL Certificate Error',
-        type: '/errors/defaults/nginx/sslcerterr'
-    },
-    496: {
-        status: 496,
-        title: 'SSL Certificate Required',
-        type: '/errors/defaults/nginx/sslcertrequired'
-    },
-    497: {
-        status: 497,
-        title: 'HTTP Request Sent to HTTPS Port',
-        type: '/errors/defaults/nginx/httpreqtohttpsport'
-    },
-    499: {
-        status: 499,
-        title: 'Client Closed Request',
-        type: '/errors/defaults/nginx/clientclosedreq'
-    }
-}

package/src/defaults/others.ts

@@ -1,37 +0,0 @@
-export const otherErrors = {
-    'unknown': {
-        status: 500,
-        title: 'Unknown error',
-        type: '/errors/defaults/others/unknown',
-    },
-    'corsError': {
-        status: 401,
-        title: 'Request not allowed by CORS policy',
-        type: '/errors/defaults/others/corsdenied',
-    },
-    'problemParseError': {
-        status: 1000,
-        title: 'Could not parse problem details',
-        type: '/errors/defaults/others/problemparseerror',
-    },
-    'problemJsonError': {
-        status: 1000,
-        title: 'Could not parse problem JSON',
-        type: '/errors/defaults/others/problemjsonerror',
-    },
-    'notAnError': {
-        status: 1000,
-        title: 'Not an error',
-        type: '/errors/defaults/others/notanerror',
-    },
-    'networkError': {
-        status: 1000,
-        title: 'Network error',
-        type: '/errors/defaults/others/networkerror'
-    },
-    'inputValidationError': {
-        status: 400,
-        title: 'Input failed validation',
-        type: '/errors/defaults/others/validationerror'
-    }
-}