@opra/common 0.5.0 → 0.6.0

package/cjs/constants.js

@@ -0,0 +1 @@
+"use strict";

package/cjs/exception/enums/issue-severity.enum.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IssueSeverity = void 0;
+var IssueSeverity;
+(function (IssueSeverity) {
+    let Enum;
+    (function (Enum) {
+        Enum["fatal"] = "fatal";
+        Enum["error"] = "error";
+        Enum["warning"] = "warning";
+        Enum["info"] = "info";
+    })(Enum = IssueSeverity.Enum || (IssueSeverity.Enum = {}));
+    IssueSeverity.name = 'IssueSeverity';
+    IssueSeverity.description = 'Severity of the issue';
+    IssueSeverity.Keys = Object.keys(IssueSeverity);
+    IssueSeverity.descriptions = {
+        fatal: 'The issue caused the action to fail and no further checking could be performed',
+        error: 'The issue is sufficiently important to cause the action to fail',
+        warning: 'The issue is not important enough to cause the action to fail but ' +
+            'may cause it to be performed suboptimally or in a way that is not as desired',
+        info: 'The issue has no relation to the degree of success of the action'
+    };
+})(IssueSeverity = exports.IssueSeverity || (exports.IssueSeverity = {}));

package/cjs/exception/http-errors/bad-request.error.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadRequestError = void 0;
+const index_js_1 = require("../../i18n/index.js");
+const opra_exception_js_1 = require("../opra-exception.js");
+/**
+ * 400 Bad Request
+ * The server cannot or will not process the request due to something that is perceived to be a client error
+ * (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
+ */
+class BadRequestError extends opra_exception_js_1.OpraException {
+    status = 400;
+    setIssue(issue) {
+        super.setIssue({
+            message: (0, index_js_1.translate)('error:BAD_REQUEST', 'Bad request'),
+            severity: 'error',
+            code: 'BAD_REQUEST',
+            ...issue
+        });
+    }
+}
+exports.BadRequestError = BadRequestError;

package/cjs/exception/http-errors/failed-dependency.error.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FailedDependencyError = void 0;
+const index_js_1 = require("../../i18n/index.js");
+const opra_exception_js_1 = require("../opra-exception.js");
+/**
+ * 424 Failed Dependency
+ * The request failed due to failure of a previous request.
+ */
+class FailedDependencyError extends opra_exception_js_1.OpraException {
+    status = 424;
+    setIssue(issue) {
+        super.setIssue({
+            message: (0, index_js_1.translate)('error:FAILED_DEPENDENCY', 'The request failed due to failure of a previous request'),
+            severity: 'error',
+            code: 'FAILED_DEPENDENCY',
+            ...issue
+        });
+    }
+}
+exports.FailedDependencyError = FailedDependencyError;

package/cjs/exception/http-errors/forbidden.error.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForbiddenError = void 0;
+const index_js_1 = require("../../i18n/index.js");
+const opra_exception_js_1 = require("../opra-exception.js");
+/**
+ * 403 Forbidden
+ * The client does not have access rights to the content; that is, it is unauthorized,
+ * so the server is refusing to give the requested resource. Unlike 401 Unauthorized,
+ * the client's identity is known to the server.
+ */
+class ForbiddenError extends opra_exception_js_1.OpraException {
+    status = 403;
+    setIssue(issue) {
+        super.setIssue({
+            message: (0, index_js_1.translate)('error:FORBIDDEN', 'You are not authorized to perform this action'),
+            severity: 'error',
+            code: 'FORBIDDEN',
+            ...issue
+        });
+    }
+}
+exports.ForbiddenError = ForbiddenError;

package/cjs/exception/http-errors/internal-server.error.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalServerError = void 0;
+const index_js_1 = require("../../i18n/index.js");
+const opra_exception_js_1 = require("../opra-exception.js");
+/**
+ * 500 Internal Server Error
+ * The server has encountered a situation it does not know how to handle.
+ */
+class InternalServerError extends opra_exception_js_1.OpraException {
+    status = 500;
+    setIssue(issue) {
+        super.setIssue({
+            message: (0, index_js_1.translate)('error:INTERNAL_SERVER_ERROR', 'Internal server error'),
+            severity: 'error',
+            code: 'INTERNAL_SERVER_ERROR',
+            ...issue
+        });
+    }
+}
+exports.InternalServerError = InternalServerError;

package/cjs/exception/http-errors/method-not-allowed.error.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MethodNotAllowedError = void 0;
+const index_js_1 = require("../../i18n/index.js");
+const opra_exception_js_1 = require("../opra-exception.js");
+/**
+ * 405 Method Not Allowed
+ * The request method is known by the server but is not supported by the target resource.
+ * For example, an API may not allow calling DELETE to remove a resource.
+ */
+class MethodNotAllowedError extends opra_exception_js_1.OpraException {
+    status = 405;
+    setIssue(issue) {
+        super.setIssue({
+            message: (0, index_js_1.translate)('error:METHOD_NOT_ALLOWED', 'Method not allowed'),
+            severity: 'error',
+            code: 'METHOD_NOT_ALLOWED',
+            ...issue
+        });
+    }
+}
+exports.MethodNotAllowedError = MethodNotAllowedError;

package/cjs/exception/http-errors/not-acceptable.error.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotAcceptableError = void 0;
+const index_js_1 = require("../../i18n/index.js");
+const opra_exception_js_1 = require("../opra-exception.js");
+/**
+ * 406 Not Acceptable
+ * This response is sent when the web server, after performing server-driven content negotiation,
+ * doesn't find any content that conforms to the criteria given by the user agent.
+ */
+class NotAcceptableError extends opra_exception_js_1.OpraException {
+    status = 406;
+    setIssue(issue) {
+        super.setIssue({
+            message: (0, index_js_1.translate)('error:NOT_ACCEPTABLE', 'Not Acceptable'),
+            severity: 'error',
+            code: 'NOT_ACCEPTABLE',
+            ...issue
+        });
+    }
+}
+exports.NotAcceptableError = NotAcceptableError;

package/cjs/exception/http-errors/not-found.error.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotFoundError = void 0;
+const index_js_1 = require("../../i18n/index.js");
+const opra_exception_js_1 = require("../opra-exception.js");
+/**
+ * 404 Not Found
+ * The server can not find the requested resource. In the browser, this means the URL is not recognized.
+ * In an API, this can also mean that the endpoint is valid but the resource itself does not exist.
+ * Servers may also send this response instead of 403 Forbidden to hide the existence of a resource
+ * from an unauthorized client. This response code is probably the most well known due to its
+ * frequent occurrence on the web.
+ */
+class NotFoundError extends opra_exception_js_1.OpraException {
+    status = 404;
+    setIssue(issue) {
+        super.setIssue({
+            message: (0, index_js_1.translate)('error:NOT_FOUND', 'Not found'),
+            severity: 'error',
+            code: 'NOT_FOUND',
+            ...issue
+        });
+    }
+}
+exports.NotFoundError = NotFoundError;

package/cjs/exception/http-errors/unauthorized.error.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnauthorizedError = void 0;
+const index_js_1 = require("../../i18n/index.js");
+const opra_exception_js_1 = require("../opra-exception.js");
+/**
+ * 401 Unauthorized
+ * Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated".
+ * That is, the client must authenticate itself to get the requested response.
+ */
+class UnauthorizedError extends opra_exception_js_1.OpraException {
+    status = 401;
+    setIssue(issue) {
+        super.setIssue({
+            message: (0, index_js_1.translate)('error:UNAUTHORIZED', 'You have not been authenticated to perform this action'),
+            severity: 'error',
+            code: 'UNAUTHORIZED',
+            ...issue
+        });
+    }
+}
+exports.UnauthorizedError = UnauthorizedError;

package/cjs/exception/http-errors/unprocessable-entity.error.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnprocessableEntityError = void 0;
+const index_js_1 = require("../../i18n/index.js");
+const opra_exception_js_1 = require("../opra-exception.js");
+/**
+ * 422 Unprocessable Entity
+ * The request was well-formed but was unable to be followed due to semantic errors.
+ */
+class UnprocessableEntityError extends opra_exception_js_1.OpraException {
+    status = 422;
+    setIssue(issue) {
+        super.setIssue({
+            message: (0, index_js_1.translate)('error:UNPROCESSABLE_ENTITY', 'Unprocessable entity'),
+            severity: 'error',
+            code: 'UNPROCESSABLE_ENTITY',
+            ...issue
+        });
+    }
+}
+exports.UnprocessableEntityError = UnprocessableEntityError;

package/cjs/exception/index.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./opra-exception.js"), exports);
+tslib_1.__exportStar(require("./error-issue.js"), exports);
+tslib_1.__exportStar(require("./wrap-exception.js"), exports);
+tslib_1.__exportStar(require("./enums/issue-severity.enum.js"), exports);
+tslib_1.__exportStar(require("./http-errors/bad-request.error.js"), exports);
+tslib_1.__exportStar(require("./http-errors/failed-dependency.error.js"), exports);
+tslib_1.__exportStar(require("./http-errors/forbidden.error.js"), exports);
+tslib_1.__exportStar(require("./http-errors/internal-server.error.js"), exports);
+tslib_1.__exportStar(require("./http-errors/method-not-allowed.error.js"), exports);
+tslib_1.__exportStar(require("./http-errors/not-acceptable.error.js"), exports);
+tslib_1.__exportStar(require("./http-errors/not-found.error.js"), exports);
+tslib_1.__exportStar(require("./http-errors/unauthorized.error.js"), exports);
+tslib_1.__exportStar(require("./http-errors/unprocessable-entity.error.js"), exports);
+tslib_1.__exportStar(require("./resource-errors/resource-conflict.error.js"), exports);
+tslib_1.__exportStar(require("./resource-errors/resource-not-found.error.js"), exports);

package/cjs/exception/opra-exception.js

@@ -0,0 +1,56 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpraException = void 0;
+const index_js_1 = require("../i18n/index.js");
+/**
+ * Defines the base Opra exception, which is handled by the default Exceptions Handler.
+ */
+class OpraException extends Error {
+    _issue;
+    status = 500;
+    cause;
+    constructor(issue, cause) {
+        super('');
+        this._initName();
+        if (cause) {
+            this.cause = cause;
+            if (cause.stack)
+                this.stack = cause.stack;
+        }
+        this._init(issue || cause || 'Unknown error');
+        this.message = index_js_1.i18n.deep(this.issue.message);
+    }
+    get issue() {
+        return this._issue;
+    }
+    setIssue(issue) {
+        this._issue = {
+            message: 'Unknown error',
+            severity: 'error',
+            ...issue,
+        };
+    }
+    setStatus(status) {
+        this.status = status;
+        return this;
+    }
+    _initName() {
+        this.name = this.constructor.name;
+    }
+    _init(issue) {
+        if (issue instanceof Error) {
+            if (typeof issue.status === 'number')
+                this.status = issue.status;
+            else if (typeof issue.getStatus === 'function')
+                this.status = issue.getStatus();
+            this.setIssue({ message: issue.message });
+        }
+        else if (typeof issue === 'object') {
+            this.setIssue(issue);
+        }
+        else {
+            this.setIssue({ message: String(issue) });
+        }
+    }
+}
+exports.OpraException = OpraException;

package/cjs/exception/resource-errors/resource-conflict.error.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceConflictError = void 0;
+const index_js_1 = require("../../i18n/index.js");
+const opra_exception_js_1 = require("../opra-exception.js");
+class ResourceConflictError extends opra_exception_js_1.OpraException {
+    status = 409;
+    constructor(resource, fields, cause) {
+        super({
+            message: (0, index_js_1.translate)(`error:RESOURCE_CONFLICT`, { resource, fields }, `There is already an other {{resource}} resource with same field values ({{fields}})`),
+            severity: 'error',
+            code: 'RESOURCE_CONFLICT',
+            details: {
+                resource,
+                location: fields
+            },
+        }, cause);
+    }
+}
+exports.ResourceConflictError = ResourceConflictError;

package/cjs/exception/resource-errors/resource-not-found.error.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceNotFoundError = void 0;
+const index_js_1 = require("../../i18n/index.js");
+const opra_exception_js_1 = require("../opra-exception.js");
+class ResourceNotFoundError extends opra_exception_js_1.OpraException {
+    constructor(resource, keyValue, cause) {
+        super({
+            message: (0, index_js_1.translate)(`error:RESOURCE_NOT_FOUND`, { resource: resource + (keyValue ? '@' + keyValue : '') }, `The resource '{{resource}}' could not be found`),
+            severity: 'error',
+            code: 'RESOURCE_NOT_FOUND',
+            details: {
+                resource,
+                key: keyValue
+            }
+        }, cause);
+        this.status = 404;
+    }
+}
+exports.ResourceNotFoundError = ResourceNotFoundError;

package/cjs/exception/wrap-exception.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wrapException = void 0;
+const bad_request_error_js_1 = require("./http-errors/bad-request.error.js");
+const failed_dependency_error_js_1 = require("./http-errors/failed-dependency.error.js");
+const forbidden_error_js_1 = require("./http-errors/forbidden.error.js");
+const method_not_allowed_error_js_1 = require("./http-errors/method-not-allowed.error.js");
+const not_acceptable_error_js_1 = require("./http-errors/not-acceptable.error.js");
+const not_found_error_js_1 = require("./http-errors/not-found.error.js");
+const unauthorized_error_js_1 = require("./http-errors/unauthorized.error.js");
+const unprocessable_entity_error_js_1 = require("./http-errors/unprocessable-entity.error.js");
+const opra_exception_js_1 = require("./opra-exception.js");
+function wrapException(e) {
+    if (e instanceof opra_exception_js_1.OpraException)
+        return e;
+    let status = 500;
+    if (typeof e.status === 'number')
+        status = e.status;
+    else if (typeof e.getStatus === 'function')
+        status = e.getStatus();
+    switch (status) {
+        case 400:
+            return new bad_request_error_js_1.BadRequestError(e);
+        case 401:
+            return new unauthorized_error_js_1.UnauthorizedError(e);
+        case 403:
+            return new forbidden_error_js_1.ForbiddenError(e);
+        case 404:
+            return new not_found_error_js_1.NotFoundError(e);
+        case 405:
+            return new method_not_allowed_error_js_1.MethodNotAllowedError(e);
+        case 406:
+            return new not_acceptable_error_js_1.NotAcceptableError(e);
+        case 422:
+            return new unprocessable_entity_error_js_1.UnprocessableEntityError(e);
+        case 424:
+            return new failed_dependency_error_js_1.FailedDependencyError(e);
+        default:
+            return new failed_dependency_error_js_1.FailedDependencyError(e);
+    }
+}
+exports.wrapException = wrapException;