@emoyly/problem 4.1.11 → 5.0.0

package/typings/codes.d.ts

@@ -0,0 +1,5 @@
+import type { ProblemOpts } from './problem';
+export interface Codes {
+    [key: number]: ProblemOpts | undefined;
+    [key: string]: ProblemOpts | undefined;
+}

package/typings/events.d.ts

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

package/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 './codes';

package/typings/index.js

@@ -1,7 +1,11 @@
 "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]; } });
+    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];
@@ -11,7 +15,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 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);
+__exportStar(require("./codes"), exports);

package/typings/middleware.d.ts

@@ -6,4 +6,4 @@ export interface MiddlewareOptions {
      */
     parsers: Parser[];
 }
-export declare type PartialMiddlewareOptions = Partial<MiddlewareOptions>;
+export type PartialMiddlewareOptions = Partial<MiddlewareOptions>;

package/typings/parser.d.ts

@@ -1,9 +1,2 @@
 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;
-}
+export type Parser = (input: unknown) => Problem[];

package/typings/problem.d.ts

@@ -17,7 +17,8 @@ export interface IProblem {
     stack?: string;
     errorObject?: unknown;
     __problemVersion: string;
-    data?: any;
+    data?: unknown;
+    middleware?: string;
 }
-export declare type JsonProblem = Omit<IProblem, 'stack' | 'errorObject'>;
-export declare type ProblemOpts = Omit<IProblem, '__problemVersion'>;
+export type JsonProblem = Omit<IProblem, 'stack' | 'errorObject' | 'middleware'>;
+export type ProblemOpts = Omit<IProblem, '__problemVersion'>;

package/util/defaults.d.ts

@@ -0,0 +1,4 @@
+export declare const defaultType = "/errors/default/unknown";
+export declare const defaultTitle = "Unknown error";
+export declare const defaultDetail = "No extended details are available";
+export declare const defaultInstance = "/unknown";

package/util/defaults.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.defaultInstance = exports.defaultDetail = exports.defaultTitle = exports.defaultType = void 0;
+exports.defaultType = '/errors/default/unknown';
+exports.defaultTitle = 'Unknown error';
+exports.defaultDetail = 'No extended details are available';
+exports.defaultInstance = '/unknown';

package/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 isJsonProblem(input: unknown): input is JsonProblem;
 export declare function createFromJson({ title, type, instance, detail, status, data }: JsonProblem): Problem;
-export declare function getProblems(input: any): Problem[] | void;
+export declare function getProblems(input: unknown): Problem[] | void;

package/util/getProblems.js

@@ -2,16 +2,19 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getProblems = exports.createFromJson = exports.isJsonProblem = void 0;
 const problem_1 = require("../problem");
+const isProblemArray_1 = require("./isProblemArray");
 const version_1 = require("./version");
 const strings = ['title', 'type', 'instance', 'detail', '__problemVersion'];
 function isJsonProblem(input) {
+    if (input === null)
+        return false;
     if (typeof input !== 'object')
         return false;
-    if (!strings.every(val => typeof input[val] === 'string'))
+    if (!strings.every(val => val in input && typeof input[val] === 'string'))
         return false;
-    if (!version_1.isCompatibleVersion(input === null || input === void 0 ? void 0 : input.__problemVersion))
+    if (!(0, version_1.isCompatibleVersion)('__problemVersion' in input && input['__problemVersion'] === 'string' ? input['__problemVersion'] : ''))
         return false;
-    if (typeof input.status !== 'number')
+    if (!('status' in input) || typeof input.status !== 'number')
         return false;
     return true;
 }
@@ -31,7 +34,7 @@ function getProblems(input) {
     if (input instanceof problem_1.Problem) {
         return [input];
     }
-    if (input instanceof Array && input.every(val => val instanceof problem_1.Problem)) {
+    if ((0, isProblemArray_1.isProblemArray)(input)) {
         return input;
     }
     if (input instanceof Array && input.every(val => isJsonProblem(val))) {

package/util/isProblemArray.d.ts

@@ -0,0 +1,2 @@
+import { Problem } from '../problem';
+export declare function isProblemArray(input: unknown): input is Problem[];

package/util/isProblemArray.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isProblemArray = void 0;
+const problem_1 = require("../problem");
+function isProblemArray(input) {
+    if (!Array.isArray(input))
+        return false;
+    return input.every(val => val instanceof problem_1.Problem);
+}
+exports.isProblemArray = isProblemArray;

package/util/misc.d.ts

@@ -0,0 +1,2 @@
+import { ProblemOpts } from '../typings';
+export declare function getHttpError(statusCode: number | string): ProblemOpts | undefined;

package/util/misc.js

@@ -0,0 +1,43 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getHttpError = void 0;
+const allCodes = __importStar(require("../defaults"));
+function getHttpError(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);
+            if (!isNaN(conv))
+                statusCode = conv;
+        }
+        const code = codeObject[statusCode];
+        if (!code)
+            return;
+        return code;
+    }
+}
+exports.getHttpError = getHttpError;

package/util/version.d.ts

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

package/util/version.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isCompatibleVersion = exports.major = exports.version = void 0;
-exports.version = '4.0.0';
+exports.version = '5.0.0';
 exports.major = Number(exports.version.split('.')[0]);
 function isCompatibleVersion(inputVersion) {
     // TODO: Remove this

package/parsers/http.d.ts

@@ -1,3 +0,0 @@
-import { Problem } from '../problem';
-import type { HTTPErrorDetails } from '../typings/parser';
-export declare function parseHTTPError(input: HTTPErrorDetails): Problem | void;

package/parsers/http.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseHTTPError = void 0;
-const defaults_1 = require("../defaults");
-const problem_1 = require("../problem");
-const codes = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, defaults_1.codes4xx), defaults_1.codes5xx), defaults_1.codesAws), defaults_1.codesCloudflare), defaults_1.codesIis), defaults_1.codesNginx);
-function parseHTTPError(input) {
-    var _a;
-    if (input.statusCode) {
-        const found = (_a = Object.entries(codes).find(([key]) => { var _a; return key === ((_a = input.statusCode) === null || _a === void 0 ? void 0 : _a.toString()); })) === null || _a === void 0 ? void 0 : _a[1];
-        if (found)
-            return new problem_1.Problem(Object.assign({}, found));
-    }
-}
-exports.parseHTTPError = parseHTTPError;

package/typings/misc.d.ts

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