@emoyly/problem 4.1.8 → 4.1.11

package/typings/events.d.ts

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

package/typings/events.js

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

package/typings/index.d.ts

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

package/typings/index.js

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

package/typings/middleware.d.ts

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

package/typings/middleware.js

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

package/typings/misc.d.ts

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

package/typings/misc.js

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

package/typings/parser.d.ts

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

package/typings/parser.js

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

package/typings/problem.d.ts

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

package/typings/problem.js

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

package/util/events.d.ts

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

package/util/events.js

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

package/util/getProblems.d.ts

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

package/util/getProblems.js

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

package/util/version.d.ts

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

package/util/version.js

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