@emoyly/problem 4.1.10 → 4.1.11

package/{dist/typings → typings}/events.d.ts

@@ -1,2 +1,2 @@
-import type { Problem } from '../problem';
-export declare type ProblemListener = (problems: Problem[]) => void;
+import type { Problem } from '../problem';
+export declare type ProblemListener = (problems: Problem[]) => void;

package/{dist/typings → typings}/events.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/{dist/typings → typings}/index.d.ts

@@ -1,5 +1,5 @@
-export * from './middleware';
-export * from './misc';
-export * from './parser';
-export * from './problem';
-export * from './events';
+export * from './middleware';
+export * from './misc';
+export * from './parser';
+export * from './problem';
+export * from './events';

package/{dist/typings → typings}/index.js

@@ -1,17 +1,17 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (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("./middleware"), exports);
-__exportStar(require("./misc"), exports);
-__exportStar(require("./parser"), exports);
-__exportStar(require("./problem"), exports);
-__exportStar(require("./events"), exports);
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (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("./middleware"), exports);
+__exportStar(require("./misc"), exports);
+__exportStar(require("./parser"), exports);
+__exportStar(require("./problem"), exports);
+__exportStar(require("./events"), exports);

package/{dist/typings → typings}/middleware.d.ts

@@ -1,9 +1,9 @@
-import type { Parser } from './parser';
-export interface MiddlewareOptions {
-    /**
-     * A list of parsers to be used by the middleware.
-     * Parsers are run in the order they sit in the array
-     */
-    parsers: Parser[];
-}
-export declare type PartialMiddlewareOptions = Partial<MiddlewareOptions>;
+import type { Parser } from './parser';
+export interface MiddlewareOptions {
+    /**
+     * A list of parsers to be used by the middleware.
+     * Parsers are run in the order they sit in the array
+     */
+    parsers: Parser[];
+}
+export declare type PartialMiddlewareOptions = Partial<MiddlewareOptions>;

package/{dist/typings → typings}/middleware.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/{dist/typings → typings}/misc.d.ts

@@ -1,3 +1,3 @@
-export interface ResponseHeaders {
-    [key: string]: string;
-}
+export interface ResponseHeaders {
+    [key: string]: string;
+}

package/{dist/typings → typings}/misc.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/{dist/typings → typings}/parser.d.ts

@@ -1,9 +1,9 @@
-import type { Problem } from '../problem';
-import type { ResponseHeaders } from './misc';
-export declare type Parser = (input: any) => Problem[];
-export interface HTTPErrorDetails {
-    statusCode?: number;
-    url: string;
-    body?: string;
-    headers?: ResponseHeaders;
-}
+import type { Problem } from '../problem';
+import type { ResponseHeaders } from './misc';
+export declare type Parser = (input: any) => Problem[];
+export interface HTTPErrorDetails {
+    statusCode?: number;
+    url: string;
+    body?: string;
+    headers?: ResponseHeaders;
+}

package/{dist/typings → typings}/parser.js

@@ -1,2 +1,2 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -1,23 +1,23 @@
-/**
- * @param {string} type - A URI refrence that identifies the problem type.
- * @param {string} title - A short, human-readable summary of the problem
- * type.  It SHOULD NOT change from occurrence to occurrence of the problem
- * @param {number} status - The HTTP status code
- * @param {string} detail - A human-readable explanation specific to this
-      occurrence of the problem.
- * @property {string} instance - A URI reference that identifies the specific
-      occurrence of the problem
-**/
-export interface IProblem {
-    type: string;
-    title: string;
-    status: number;
-    detail?: string;
-    instance?: string;
-    stack?: string;
-    errorObject?: unknown;
-    __problemVersion: string;
-    data?: any;
-}
-export declare type JsonProblem = Omit<IProblem, 'stack' | 'errorObject'>;
-export declare type ProblemOpts = Omit<IProblem, '__problemVersion'>;
+/**
+ * @param {string} type - A URI refrence that identifies the problem type.
+ * @param {string} title - A short, human-readable summary of the problem
+ * type.  It SHOULD NOT change from occurrence to occurrence of the problem
+ * @param {number} status - The HTTP status code
+ * @param {string} detail - A human-readable explanation specific to this
+      occurrence of the problem.
+ * @property {string} instance - A URI reference that identifies the specific
+      occurrence of the problem
+**/
+export interface IProblem {
+    type: string;
+    title: string;
+    status: number;
+    detail?: string;
+    instance?: string;
+    stack?: string;
+    errorObject?: unknown;
+    __problemVersion: string;
+    data?: any;
+}
+export declare type JsonProblem = Omit<IProblem, 'stack' | 'errorObject'>;
+export declare type ProblemOpts = Omit<IProblem, '__problemVersion'>;

package/{dist/typings → typings}/problem.js

@@ -1,12 +1,12 @@
-"use strict";
-/**
- * @param {string} type - A URI refrence that identifies the problem type.
- * @param {string} title - A short, human-readable summary of the problem
- * type.  It SHOULD NOT change from occurrence to occurrence of the problem
- * @param {number} status - The HTTP status code
- * @param {string} detail - A human-readable explanation specific to this
-      occurrence of the problem.
- * @property {string} instance - A URI reference that identifies the specific
-      occurrence of the problem
-**/
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+/**
+ * @param {string} type - A URI refrence that identifies the problem type.
+ * @param {string} title - A short, human-readable summary of the problem
+ * type.  It SHOULD NOT change from occurrence to occurrence of the problem
+ * @param {number} status - The HTTP status code
+ * @param {string} detail - A human-readable explanation specific to this
+      occurrence of the problem.
+ * @property {string} instance - A URI reference that identifies the specific
+      occurrence of the problem
+**/
+Object.defineProperty(exports, "__esModule", { value: true });

package/{dist/util → util}/events.d.ts

@@ -1,16 +1,16 @@
-import type { ProblemListener } from '../typings/events';
-import { Problem } from '../problem';
-declare class ProblemEvents {
-    listeners: ProblemListener[];
-    emit: (list: Problem[]) => void;
-    /**
-     * Listen to problems
-     */
-    onProblem: (listener: ProblemListener) => void;
-    /**
-     * Un-listen to problems
-     */
-    offProblem: (listener: ProblemListener) => void;
-}
-declare const instance: ProblemEvents;
-export default instance;
+import type { ProblemListener } from '../typings/events';
+import { Problem } from '../problem';
+declare class ProblemEvents {
+    listeners: ProblemListener[];
+    emit: (list: Problem[]) => void;
+    /**
+     * Listen to problems
+     */
+    onProblem: (listener: ProblemListener) => void;
+    /**
+     * Un-listen to problems
+     */
+    offProblem: (listener: ProblemListener) => void;
+}
+declare const instance: ProblemEvents;
+export default instance;

package/{dist/util → util}/events.js

@@ -1,29 +1,29 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class ProblemEvents {
-    constructor() {
-        this.listeners = [];
-        this.emit = (list) => {
-            for (const listener of this.listeners) {
-                listener(list);
-            }
-        };
-        /**
-         * Listen to problems
-         */
-        this.onProblem = (listener) => {
-            this.listeners.push(listener);
-        };
-        /**
-         * Un-listen to problems
-         */
-        this.offProblem = (listener) => {
-            const idx = this.listeners.findIndex(val => val === listener);
-            if (idx < 0 || isNaN(idx))
-                return;
-            this.listeners.splice(idx, 1);
-        };
-    }
-}
-const instance = new ProblemEvents();
-exports.default = instance;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ProblemEvents {
+    constructor() {
+        this.listeners = [];
+        this.emit = (list) => {
+            for (const listener of this.listeners) {
+                listener(list);
+            }
+        };
+        /**
+         * Listen to problems
+         */
+        this.onProblem = (listener) => {
+            this.listeners.push(listener);
+        };
+        /**
+         * Un-listen to problems
+         */
+        this.offProblem = (listener) => {
+            const idx = this.listeners.findIndex(val => val === listener);
+            if (idx < 0 || isNaN(idx))
+                return;
+            this.listeners.splice(idx, 1);
+        };
+    }
+}
+const instance = new ProblemEvents();
+exports.default = instance;

package/{dist/util → util}/getProblems.d.ts

@@ -1,5 +1,5 @@
-import { Problem } from '../problem';
-import type { JsonProblem } from '../typings/problem';
-export declare function isJsonProblem(input: any): input is JsonProblem;
-export declare function createFromJson({ title, type, instance, detail, status, data }: JsonProblem): Problem;
-export declare function getProblems(input: any): Problem[] | void;
+import { Problem } from '../problem';
+import type { JsonProblem } from '../typings/problem';
+export declare function isJsonProblem(input: any): input is JsonProblem;
+export declare function createFromJson({ title, type, instance, detail, status, data }: JsonProblem): Problem;
+export declare function getProblems(input: any): Problem[] | void;

package/{dist/util → util}/getProblems.js

@@ -1,45 +1,45 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getProblems = exports.createFromJson = exports.isJsonProblem = void 0;
-const problem_1 = require("../problem");
-const version_1 = require("./version");
-const strings = ['title', 'type', 'instance', 'detail', '__problemVersion'];
-function isJsonProblem(input) {
-    if (typeof input !== 'object')
-        return false;
-    if (!strings.every(val => typeof input[val] === 'string'))
-        return false;
-    if (!version_1.isCompatibleVersion(input === null || input === void 0 ? void 0 : input.__problemVersion))
-        return false;
-    if (typeof input.status !== 'number')
-        return false;
-    return true;
-}
-exports.isJsonProblem = isJsonProblem;
-function createFromJson({ title, type, instance, detail, status, data }) {
-    return new problem_1.Problem({ title, type, instance, detail, status, data });
-}
-exports.createFromJson = createFromJson;
-function getProblems(input) {
-    if (typeof input === 'string') {
-        try {
-            const p = JSON.parse(input);
-            input = p;
-        }
-        catch (err) { /**/ }
-    }
-    if (input instanceof problem_1.Problem) {
-        return [input];
-    }
-    if (input instanceof Array && input.every(val => val instanceof problem_1.Problem)) {
-        return input;
-    }
-    if (input instanceof Array && input.every(val => isJsonProblem(val))) {
-        const _input = input;
-        return _input.map(val => createFromJson(val));
-    }
-    if (isJsonProblem(input)) {
-        return [createFromJson(input)];
-    }
-}
-exports.getProblems = getProblems;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getProblems = exports.createFromJson = exports.isJsonProblem = void 0;
+const problem_1 = require("../problem");
+const version_1 = require("./version");
+const strings = ['title', 'type', 'instance', 'detail', '__problemVersion'];
+function isJsonProblem(input) {
+    if (typeof input !== 'object')
+        return false;
+    if (!strings.every(val => typeof input[val] === 'string'))
+        return false;
+    if (!version_1.isCompatibleVersion(input === null || input === void 0 ? void 0 : input.__problemVersion))
+        return false;
+    if (typeof input.status !== 'number')
+        return false;
+    return true;
+}
+exports.isJsonProblem = isJsonProblem;
+function createFromJson({ title, type, instance, detail, status, data }) {
+    return new problem_1.Problem({ title, type, instance, detail, status, data });
+}
+exports.createFromJson = createFromJson;
+function getProblems(input) {
+    if (typeof input === 'string') {
+        try {
+            const p = JSON.parse(input);
+            input = p;
+        }
+        catch (err) { /**/ }
+    }
+    if (input instanceof problem_1.Problem) {
+        return [input];
+    }
+    if (input instanceof Array && input.every(val => val instanceof problem_1.Problem)) {
+        return input;
+    }
+    if (input instanceof Array && input.every(val => isJsonProblem(val))) {
+        const _input = input;
+        return _input.map(val => createFromJson(val));
+    }
+    if (isJsonProblem(input)) {
+        return [createFromJson(input)];
+    }
+}
+exports.getProblems = getProblems;

package/{dist/util → util}/version.d.ts

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

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

@@ -1,20 +1,20 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isCompatibleVersion = exports.major = exports.version = void 0;
-exports.version = '4.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;
-}
-exports.isCompatibleVersion = isCompatibleVersion;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isCompatibleVersion = exports.major = exports.version = void 0;
+exports.version = '4.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;
+}
+exports.isCompatibleVersion = isCompatibleVersion;

package/dist/LICENSE

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

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

@@ -1,12 +0,0 @@
-# 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/package.json

@@ -1,45 +0,0 @@
-{
-    "name": "@emoyly/problem",
-    "version": "4.1.6",
-    "description": "A simple error library based around the RFC-7807 standard with optional support for Sentry.io and Express",
-    "main": "index.js",
-    "types": "index.d.ts",
-    "repository": "https://github.com/emoyly/problem",
-    "author": "Emil Petersen <emoyly@gmail.com>",
-    "license": "MIT",
-    "scripts": {
-        "build": "tsc",
-        "lint": "eslint src",
-        "copy": "node scripts/copy"
-    },
-    "devDependencies": {
-        "@mikro-orm/core": "^4.5.9",
-        "@types/express": "^4.17.11",
-        "@types/jsonwebtoken": "^8.5.1",
-        "@types/node": "^15.0.1",
-        "@typescript-eslint/eslint-plugin": "^4.22.0",
-        "@typescript-eslint/parser": "^4.22.0",
-        "eslint": "^7.25.0",
-        "fs-extra": "^9.1.0",
-        "jsonwebtoken": "^8.5.1",
-        "tsoa": "^3.7.0",
-        "typescript": "^4.2.4"
-    },
-    "peerDependencies": {
-        "@mikro-orm/core": "^4.5.9",
-        "jsonwebtoken": "^8.5.1",
-        "tsoa": "^3.7.0"
-    },
-    "peerDependenciesMeta": {
-        "@mikro-orm/core": {
-            "optional": true
-        },
-        "jsonwebtoken": {
-            "optional": true
-        },
-        "tsoa": {
-            "optional": true
-        }
-    },
-    "packageManager": "yarn@3.2.0"
-}