@emoyly/problem 4.1.6 → 4.1.9

package/dist/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/README.md

@@ -0,0 +1,59 @@
+# Problem
+## UNDER DEVELOPMENT - NOT READY FOR PRODUCTION
+
+Problem is an error handling library, based around the [RFC-7807 standard](https://tools.ietf.org/html/rfc7807), with support for additional parsers and middleware (Explained below).
+The library may not follow the standard completely in some cases. An example of which is that it currently only supports the JSON variant of problem details.
+There is also other features added, making it much more of an HTTP error handling framework, than just an implementation of the standard.
+
+# Terms
+
+## Middleware
+Middleware catches errors occurring in a node module, like Express or Axios, and converts it into a Problem object.
+
+## Parsers
+A parser converts common JS errors from various npm modules into Problem objects.
+
+# Usage & examples
+
+## Basic
+TODO: Write a basic explanation of just implementing the library somehow
+
+
+## Express
+```ts
+    import { ExpressMiddleware } from '@emoyly/problem/middleware/express'
+
+    const problemMiddleware = new ExpressMiddleware()
+
+    events.onProblem(problems => {
+        for (const problem of problems) {
+            // If its a 4XX error or alike, we don't really need to log it
+            if (problem.status < 500) continue
+            // Log the error. This could be replaced with a function reporting the error to something like Sentry
+            console.error(problem)
+        }
+    })
+
+    // In your Express middleware ↓
+
+    // Handles 404 errors
+    app.use(problemMiddleware.notFound)
+
+    // Responds in the right way
+    app.use(problemMiddleware.use())
+```
+
+## Axios
+```ts
+import axios from 'axios'
+import { Problem } from '@emoyly/problem'
+import { AxiosMiddleware } from '@emoyly/problem/middleware/axios'
+
+const api = axios.create({
+    'baseURL': `example.com`,
+})
+
+const middleware = new AxiosMiddleware()
+
+api.interceptors.response.use(...middleware.use())
+```

package/dist/SECURITY.md

@@ -0,0 +1,12 @@
+# Security Policy
+
+## Supported Versions
+
+Latest major/minor version is supported only for security updates.
+
+## Reporting a Vulnerability
+
+To report a vulnerability, please do not create public issue. Instead, use one of the following private channels:
+
+- Email can be found at https://github.com/emoyly
+- Discord at Emoyly#6969

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

@@ -0,0 +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;
+    };
+};

package/dist/defaults/4xx.js

@@ -0,0 +1,151 @@
+"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 = {
+    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/dist/defaults/5xx.d.ts

@@ -0,0 +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;
+    };
+};

package/dist/defaults/5xx.js

@@ -0,0 +1,61 @@
+"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 = {
+    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/dist/defaults/aws.d.ts

@@ -0,0 +1,12 @@
+export declare const statusCodes: {
+    460: {
+        status: number;
+        title: string;
+        type: string;
+    };
+    463: {
+        status: number;
+        title: string;
+        type: string;
+    };
+};

package/dist/defaults/aws.js

@@ -0,0 +1,16 @@
+"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 = {
+    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/dist/defaults/cloudflare.d.ts

@@ -0,0 +1,47 @@
+export declare const statusCodes: {
+    520: {
+        status: number;
+        title: string;
+        type: string;
+    };
+    521: {
+        status: number;
+        title: string;
+        type: string;
+    };
+    522: {
+        status: number;
+        title: string;
+        type: string;
+    };
+    523: {
+        status: number;
+        title: string;
+        type: string;
+    };
+    524: {
+        status: number;
+        title: string;
+        type: string;
+    };
+    525: {
+        status: number;
+        title: string;
+        type: string;
+    };
+    526: {
+        status: number;
+        title: string;
+        type: string;
+    };
+    527: {
+        status: number;
+        title: string;
+        type: string;
+    };
+    530: {
+        status: number;
+        title: string;
+        type: string;
+    };
+};

package/dist/defaults/cloudflare.js

@@ -0,0 +1,52 @@
+"use strict";
+// Source: https://support.cloudflare.com/hc/en-us/articles/115003011431
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.statusCodes = void 0;
+exports.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/dist/defaults/iis.d.ts

@@ -0,0 +1,17 @@
+export declare const statusCodes: {
+    440: {
+        status: number;
+        title: string;
+        type: string;
+    };
+    449: {
+        status: number;
+        title: string;
+        type: string;
+    };
+    451: {
+        status: number;
+        title: string;
+        type: string;
+    };
+};

package/dist/defaults/iis.js

@@ -0,0 +1,21 @@
+"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 = {
+    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/dist/defaults/index.d.ts

@@ -0,0 +1,7 @@
+export { statusCodes as codes4xx } from '../defaults/4xx';
+export { statusCodes as codes5xx } from '../defaults/5xx';
+export { statusCodes as codesAws } from '../defaults/aws';
+export { statusCodes as codesCloudflare } from '../defaults/cloudflare';
+export { statusCodes as codesIis } from '../defaults/iis';
+export { statusCodes as codesNginx } from '../defaults/nginx';
+export { otherErrors } from '../defaults/others';