@emoyly/problem 7.0.6 → 8.0.0

package/cjs/util/getProblems.js

@@ -5,26 +5,29 @@ exports.createFromJson = createFromJson;
 exports.getProblems = getProblems;
 const problem_js_1 = require("../problem.js");
 const problemArray_js_1 = require("./problemArray.js");
-const version_js_1 = require("./version.js");
-const strings = ['title', 'type', 'instance', 'detail', '__problemVersion'];
+const validation_js_1 = require("./validation.js");
 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 (!(0, version_js_1.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 (0, validation_js_1.validateBasicInput)(input) === true;
 }
-function createFromJson({ title, type, instance, detail, status, data }) {
+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_js_1.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/cjs/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/cjs/util/index.js

@@ -15,6 +15,6 @@ 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("./problemArray.js"), exports);
 __exportStar(require("./misc.js"), exports);
+__exportStar(require("./validation.js"), exports);

package/cjs/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/cjs/util/misc.js

@@ -1,10 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getHttpError = getHttpError;
+exports.getCodeDefaults = getCodeDefaults;
 const allCodes = require("../defaults/index.js");
-function getHttpError(statusCode) {
+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);
@@ -13,7 +12,7 @@ function getHttpError(statusCode) {
         }
         const code = codeObject[statusCode];
         if (!code)
-            return;
+            continue;
         return code;
     }
 }

package/cjs/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/cjs/util/validation.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ProblemValidationError = void 0;
+exports.validateBasicInput = validateBasicInput;
+class ProblemValidationError extends Error {
+    errors;
+    constructor(errors) {
+        super(`Problem input is invalid:\n${errors.join('\n')}`);
+        this.errors = errors;
+    }
+}
+exports.ProblemValidationError = ProblemValidationError;
+const requiredStrings = ['title', 'type'];
+const optionalStrings = ['detail', '__problemVersion', 'instance', 'stack', 'source'];
+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/cjs/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/cjs/util/version.js

@@ -1,20 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.major = exports.version = void 0;
-exports.isCompatibleVersion = isCompatibleVersion;
-exports.version = '7.0.6';
+exports.version = '8.0.0';
 exports.major = Number(exports.version.split('.')[0]);
-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 !== exports.major)
-        return false;
-    return true;
-}

package/esm/defaults/4xx.d.ts

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

package/esm/defaults/5xx.d.ts

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

package/esm/defaults/aws.d.ts

@@ -1,12 +1,12 @@
 export declare const statusCodes: {
-    460: {
-        status: number;
-        title: string;
-        type: string;
+    readonly 460: {
+        readonly status: 460;
+        readonly title: "Client closed connection before idle timeout period elapsed";
+        readonly type: "/errors/defaults/aws/clientclosedbeforetimeout";
     };
-    463: {
-        status: number;
-        title: string;
-        type: string;
+    readonly 463: {
+        readonly status: 463;
+        readonly title: "X-Forwarded-For contains more than 30 ips";
+        readonly type: "/errors/defaults/aws/toomanyips";
     };
 };