@emoyly/problem 8.0.5 → 9.0.0

package/cjs/util/getProblems.js

@@ -1,62 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isJsonProblem = isJsonProblem;
-exports.createFromJson = createFromJson;
-exports.getProblems = getProblems;
-const problem_js_1 = require("../problem.js");
-const problemArray_js_1 = require("./problemArray.js");
-const validation_js_1 = require("./validation.js");
-function isJsonProblem(input) {
-    return (0, validation_js_1.validateBasicInput)(input) === true;
-}
-function createFromJson({ title, type, instance, detail, status, data: _data, __problemVersion, source, errorObject, stack, ...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 };
-    }
-    // TODO: Validate that source, errorObject and stack should actually be passed through
-    return new problem_js_1.Problem({ title, type, instance, detail, status, data, source, errorObject, stack });
-}
-/**
- * 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.
- */
-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, problemArray_js_1.isProblemArray)(input, false))
-        return input;
-    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 +0,0 @@
-export * from './getProblems.js';
-export * from './problemArray.js';
-export * from './misc.js';
-export * from './validation.js';

package/cjs/util/index.js

@@ -1,20 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./getProblems.js"), exports);
-__exportStar(require("./problemArray.js"), exports);
-__exportStar(require("./misc.js"), exports);
-__exportStar(require("./validation.js"), exports);

package/cjs/util/misc.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCodeDefaults = getCodeDefaults;
-const allCodes = require("../defaults/index.js");
-function getCodeDefaults(statusCode) {
-    for (const key in allCodes) {
-        const codeObject = allCodes[key];
-        if (typeof statusCode === 'string') {
-            const conv = Number(statusCode);
-            if (!isNaN(conv))
-                statusCode = conv;
-        }
-        const code = codeObject[statusCode];
-        if (!code)
-            continue;
-        return code;
-    }
-}

package/cjs/util/validation.js

@@ -1,38 +0,0 @@
-"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,2 +0,0 @@
-export declare const version = "8.0.5";
-export declare const major: number;

package/cjs/util/version.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.major = exports.version = void 0;
-exports.version = '8.0.5';
-exports.major = Number(exports.version.split('.')[0]);

package/eslint.config.mjs

@@ -1,5 +0,0 @@
-// @ts-check
-import defaultConfig from '@emoyly/eslint-config/default.mjs'
-import tsConfig from '@emoyly/eslint-config/typescript.mjs'
-
-export default [...defaultConfig, ...tsConfig]

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

@@ -1,147 +0,0 @@
-export declare const statusCodes: {
-    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 +0,0 @@
-export declare const statusCodes: {
-    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 +0,0 @@
-export declare const statusCodes: {
-    readonly 460: {
-        readonly status: 460;
-        readonly title: "Client closed connection before idle timeout period elapsed";
-        readonly type: "/errors/defaults/aws/clientclosedbeforetimeout";
-    };
-    readonly 463: {
-        readonly status: 463;
-        readonly title: "X-Forwarded-For contains more than 30 ips";
-        readonly type: "/errors/defaults/aws/toomanyips";
-    };
-};

package/esm/defaults/cloudflare.d.ts

@@ -1,47 +0,0 @@
-export declare const statusCodes: {
-    readonly 520: {
-        readonly status: 520;
-        readonly title: "Web Server returned an unknown error";
-        readonly type: "/errors/defaults/cloudflare/unknownerror";
-    };
-    readonly 521: {
-        readonly status: 521;
-        readonly title: "Web server is down";
-        readonly type: "/errors/defaults/cloudflare/webserverdown";
-    };
-    readonly 522: {
-        readonly status: 522;
-        readonly title: "Connection timed out";
-        readonly type: "/errors/defaults/cloudflare/connectiontimeout";
-    };
-    readonly 523: {
-        readonly status: 523;
-        readonly title: "Origin is unreachable";
-        readonly type: "/errors/defaults/cloudflare/originunreachable";
-    };
-    readonly 524: {
-        readonly status: 524;
-        readonly title: "A timeout occurred";
-        readonly type: "/errors/defaults/cloudflare/timeout";
-    };
-    readonly 525: {
-        readonly status: 525;
-        readonly title: "SSL handshake failed";
-        readonly type: "/errors/defaults/cloudflare/sslhandshakefail";
-    };
-    readonly 526: {
-        readonly status: 526;
-        readonly title: "Invalid SSL certificate";
-        readonly type: "/errors/defaults/cloudflare/invalidssl";
-    };
-    readonly 527: {
-        readonly status: 527;
-        readonly title: "Railgun Listener to origin error";
-        readonly type: "/errors/defaults/cloudflare/railgunoriginerr";
-    };
-    readonly 530: {
-        readonly status: 530;
-        readonly title: "Cloudflare returned 1xxx error";
-        readonly type: "/errors/defaults/cloudflare/1xxx";
-    };
-};

package/esm/defaults/iis.d.ts

@@ -1,17 +0,0 @@
-export declare const statusCodes: {
-    readonly 440: {
-        readonly status: 440;
-        readonly title: "Login Time-out";
-        readonly type: "/errors/defaults/iis/logintimeout";
-    };
-    readonly 449: {
-        readonly status: 449;
-        readonly title: "Retry with required information";
-        readonly type: "/errors/defaults/iis/retrywith";
-    };
-    readonly 451: {
-        readonly status: 451;
-        readonly title: "Redirect";
-        readonly type: "/errors/defaults/iis/redirect";
-    };
-};

package/esm/defaults/index.d.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/esm/defaults/nginx.d.ts

@@ -1,32 +0,0 @@
-export declare const statusCodes: {
-    readonly 444: {
-        readonly status: 494;
-        readonly title: "No Response";
-        readonly type: "/errors/defaults/nginx/noresponse";
-    };
-    readonly 494: {
-        readonly status: 494;
-        readonly title: "Request header too large";
-        readonly type: "/errors/defaults/nginx/headertoolarge";
-    };
-    readonly 495: {
-        readonly status: 495;
-        readonly title: "SSL Certificate Error";
-        readonly type: "/errors/defaults/nginx/sslcerterr";
-    };
-    readonly 496: {
-        readonly status: 496;
-        readonly title: "SSL Certificate Required";
-        readonly type: "/errors/defaults/nginx/sslcertrequired";
-    };
-    readonly 497: {
-        readonly status: 497;
-        readonly title: "HTTP Request Sent to HTTPS Port";
-        readonly type: "/errors/defaults/nginx/httpreqtohttpsport";
-    };
-    readonly 499: {
-        readonly status: 499;
-        readonly title: "Client Closed Request";
-        readonly type: "/errors/defaults/nginx/clientclosedreq";
-    };
-};

package/esm/defaults/others.d.ts

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

package/esm/index.d.ts

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

package/esm/middleware/axios.d.ts

@@ -1,13 +0,0 @@
-import type { PartialMiddlewareOptions } from '../typings/middleware.js';
-import { MiddlewareBase } from './base.js';
-type InterceptorArray = [undefined, (error: unknown) => Promise<never>];
-export declare class AxiosMiddleware extends MiddlewareBase {
-    name: string;
-    constructor(options?: PartialMiddlewareOptions);
-    interceptor: (error: unknown) => Promise<never>;
-    /**
-     * @example instance.interceptors.response.use(...middleware.use())
-     */
-    use: () => InterceptorArray;
-}
-export {};

package/esm/middleware/base.d.ts

@@ -1,30 +0,0 @@
-import { Problem } from '../problem.js';
-import type { ProblemOpts } from '../typings/index.js';
-import type { MiddlewareOptions, PartialMiddlewareOptions, ProblemListener } from '../typings/middleware.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 declare abstract class MiddlewareBase {
-    readonly options: MiddlewareOptions;
-    abstract 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 = true;
-    constructor(defaultOptions: MiddlewareOptions, options?: PartialMiddlewareOptions);
-    /**
-     * Parse input using parsers
-     */
-    protected parse: (input: unknown) => Problem[];
-    protected fallback: ProblemOpts;
-    protected problemListeners: ProblemListener[];
-    protected emit: (list: Problem[]) => void;
-    /**
-     * Listen to problems
-     */
-    onProblem: (listener: ProblemListener) => void;
-    /**
-     * Un-listen to problems
-     */
-    offProblem: (listener: ProblemListener) => void;
-}

package/esm/package.json

@@ -1,3 +0,0 @@
-{
-    "type": "module"
-}

package/esm/parsers/axios.d.ts

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

package/esm/parsers/jsonwebtoken.d.ts

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

package/esm/parsers/mikroorm.d.ts

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

package/esm/parsers/tsoa.d.ts

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

package/esm/parsers/zod.d.ts

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