@eggjs/onerror 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017-present Alibaba Group Holding Limited and other contributors.
+
+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/README.md

@@ -0,0 +1,67 @@
+# @eggjs/onerror
+
+[![NPM version][npm-image]][npm-url]
+[![Node.js CI](https://github.com/eggjs/onerror/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/onerror/actions/workflows/nodejs.yml)
+[![Test coverage][codecov-image]][codecov-url]
+[![Known Vulnerabilities][snyk-image]][snyk-url]
+[![npm download][download-image]][download-url]
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/onerror.svg?style=flat)](https://nodejs.org/en/download/)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com)
+![CodeRabbit Pull Request Reviews](https://img.shields.io/coderabbit/prs/github/eggjs/onerror)
+
+[npm-image]: https://img.shields.io/npm/v/@eggjs/onerror.svg?style=flat-square
+[npm-url]: https://npmjs.org/package/@eggjs/onerror
+[codecov-image]: https://codecov.io/github/eggjs/onerror/coverage.svg?branch=master
+[codecov-url]: https://codecov.io/github/eggjs/onerror?branch=master
+[snyk-image]: https://snyk.io/test/npm/@eggjs/onerror/badge.svg?style=flat-square
+[snyk-url]: https://snyk.io/test/npm/@eggjs/onerror
+[download-image]: https://img.shields.io/npm/dm/@eggjs/onerror.svg?style=flat-square
+[download-url]: https://npmjs.org/package/@eggjs/onerror
+
+Default error handling plugin for egg.
+
+## Install
+
+```bash
+npm i @eggjs/onerror
+```
+
+## Usage
+
+`egg-onerror` is on by default in egg. But you still can configure its properties to fits your scenarios.
+
+- `errorPageUrl: String or Function` - If user request html pages in production environment and unexpected error happened, it will redirect user to `errorPageUrl`.
+- `accepts: Function` - detect user's request accept `json` or `html`.
+- `all: Function` - customize error handler, if `all` present, negotiation will be ignored.
+- `html: Function` - customize html error handler.
+- `text: Function` - customize text error handler.
+- `json: Function` - customize json error handler.
+- `jsonp: Function` - customize jsonp error handler.
+
+```js
+// config.default.js
+// errorPageUrl support function
+exports.onerror = {
+  errorPageUrl: (err, ctx) => ctx.errorPageUrl || '/500',
+};
+
+// an accept detect function that mark all request with `x-requested-with=XMLHttpRequest` header accepts json.
+function accepts(ctx) {
+  if (ctx.get('x-requested-with') === 'XMLHttpRequest') return 'json';
+  return 'html';
+}
+```
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/eggjs/egg/issues).
+
+## License
+
+[MIT](https://github.com/eggjs/onerror/blob/master/LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/onerror)](https://github.com/eggjs/onerror/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).

package/dist/commonjs/agent.d.ts

@@ -0,0 +1,6 @@
+import type { ILifecycleBoot, EggCore } from '@eggjs/core';
+export default class Boot implements ILifecycleBoot {
+    private agent;
+    constructor(agent: EggCore);
+    didLoad(): Promise<void>;
+}

package/dist/commonjs/agent.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class Boot {
+    agent;
+    constructor(agent) {
+        this.agent = agent;
+    }
+    async didLoad() {
+        // should watch error event
+        this.agent.on('error', err => {
+            this.agent.coreLogger.error(err);
+        });
+    }
+}
+exports.default = Boot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWdlbnQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvYWdlbnQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFFQSxNQUFxQixJQUFJO0lBQ0g7SUFBcEIsWUFBb0IsS0FBYztRQUFkLFVBQUssR0FBTCxLQUFLLENBQVM7SUFBRyxDQUFDO0lBRXRDLEtBQUssQ0FBQyxPQUFPO1FBQ1gsMkJBQTJCO1FBQzNCLElBQUksQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLE9BQU8sRUFBRSxHQUFHLENBQUMsRUFBRTtZQUMzQixJQUFJLENBQUMsS0FBSyxDQUFDLFVBQVUsQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUM7UUFDbkMsQ0FBQyxDQUFDLENBQUM7SUFDTCxDQUFDO0NBQ0Y7QUFURCx1QkFTQyJ9

package/dist/commonjs/app.d.ts

@@ -0,0 +1,12 @@
+import { type OnerrorError } from 'koa-onerror';
+import type { ILifecycleBoot, EggCore } from '@eggjs/core';
+export interface OnerrorErrorWithCode extends OnerrorError {
+    code?: string;
+    type?: string;
+    errors?: any[];
+}
+export default class Boot implements ILifecycleBoot {
+    private app;
+    constructor(app: EggCore);
+    didLoad(): Promise<void>;
+}

package/dist/commonjs/app.js

@@ -0,0 +1,150 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_http_1 = __importDefault(require("node:http"));
+const node_fs_1 = __importDefault(require("node:fs"));
+const koa_onerror_1 = require("koa-onerror");
+const error_view_js_1 = require("./lib/error_view.js");
+const utils_js_1 = require("./lib/utils.js");
+class Boot {
+    app;
+    constructor(app) {
+        this.app = app;
+    }
+    async didLoad() {
+        // logging error
+        const config = this.app.config.onerror;
+        const viewTemplate = node_fs_1.default.readFileSync(config.templatePath, 'utf8');
+        const app = this.app;
+        app.on('error', (err, ctx) => {
+            if (!ctx) {
+                ctx = app.currentContext || app.createAnonymousContext();
+            }
+            if (config.appErrorFilter && !config.appErrorFilter(err, ctx))
+                return;
+            const status = (0, utils_js_1.detectStatus)(err);
+            // 5xx
+            if (status >= 500) {
+                try {
+                    ctx.logger.error(err);
+                }
+                catch (ex) {
+                    app.logger.error(err);
+                    app.logger.error(ex);
+                }
+                return;
+            }
+            // 4xx
+            try {
+                ctx.logger.warn(err);
+            }
+            catch (ex) {
+                app.logger.warn(err);
+                app.logger.error(ex);
+            }
+        });
+        const errorOptions = {
+            // support customize accepts function
+            accepts() {
+                const fn = config.accepts || utils_js_1.accepts;
+                return fn(this);
+            },
+            html(err, ctx) {
+                const status = (0, utils_js_1.detectStatus)(err);
+                const errorPageUrl = typeof config.errorPageUrl === 'function'
+                    ? config.errorPageUrl(err, ctx)
+                    : config.errorPageUrl;
+                // keep the real response status
+                ctx.realStatus = status;
+                // don't respond any error message in production env
+                if ((0, utils_js_1.isProd)(app)) {
+                    // 5xx
+                    if (status >= 500) {
+                        if (errorPageUrl) {
+                            const statusQuery = (errorPageUrl.indexOf('?') > 0 ? '&' : '?') +
+                                `real_status=${status}`;
+                            return ctx.redirect(errorPageUrl + statusQuery);
+                        }
+                        ctx.status = 500;
+                        ctx.body = `<h2>Internal Server Error, real status: ${status}</h2>`;
+                        return;
+                    }
+                    // 4xx
+                    ctx.status = status;
+                    ctx.body = `<h2>${status} ${node_http_1.default.STATUS_CODES[status]}</h2>`;
+                    return;
+                }
+                // show simple error format for unittest
+                if (app.config.env === 'unittest') {
+                    ctx.status = status;
+                    ctx.body = `${err.name}: ${err.message}\n${err.stack}`;
+                    return;
+                }
+                const errorView = new error_view_js_1.ErrorView(ctx, err, viewTemplate);
+                ctx.body = errorView.toHTML();
+            },
+            json(err, ctx) {
+                const status = (0, utils_js_1.detectStatus)(err);
+                let errorJson = {};
+                ctx.status = status;
+                const code = err.code ?? err.type;
+                const message = (0, utils_js_1.detectErrorMessage)(ctx, err);
+                if ((0, utils_js_1.isProd)(app)) {
+                    // 5xx server side error
+                    if (status >= 500) {
+                        errorJson = {
+                            code,
+                            // don't respond any error message in production env
+                            message: node_http_1.default.STATUS_CODES[status],
+                        };
+                    }
+                    else {
+                        // 4xx client side error
+                        // addition `errors`
+                        errorJson = {
+                            code,
+                            message,
+                            errors: err.errors,
+                        };
+                    }
+                }
+                else {
+                    errorJson = {
+                        code,
+                        message,
+                        errors: err.errors,
+                    };
+                    if (status >= 500) {
+                        // provide detail error stack in local env
+                        errorJson.stack = err.stack;
+                        errorJson.name = err.name;
+                        for (const key in err) {
+                            if (!errorJson[key]) {
+                                errorJson[key] = err[key];
+                            }
+                        }
+                    }
+                }
+                ctx.body = errorJson;
+            },
+            js(err, ctx) {
+                errorOptions.json.call(ctx, err, ctx);
+                if (ctx.createJsonpBody) {
+                    ctx.createJsonpBody(ctx.body);
+                }
+            },
+        };
+        // support customize error response
+        const keys = ['all', 'html', 'json', 'text', 'js'];
+        for (const type of keys) {
+            if (config[type]) {
+                Reflect.set(errorOptions, type, config[type]);
+            }
+        }
+        (0, koa_onerror_1.onerror)(app, errorOptions);
+    }
+}
+exports.default = Boot;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2FwcC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7OztBQUFBLDBEQUE2QjtBQUM3QixzREFBeUI7QUFDekIsNkNBQThFO0FBRTlFLHVEQUFnRDtBQUNoRCw2Q0FBbUY7QUFTbkYsTUFBcUIsSUFBSTtJQUNIO0lBQXBCLFlBQW9CLEdBQVk7UUFBWixRQUFHLEdBQUgsR0FBRyxDQUFTO0lBQUcsQ0FBQztJQUVwQyxLQUFLLENBQUMsT0FBTztRQUNYLGdCQUFnQjtRQUNoQixNQUFNLE1BQU0sR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDLE1BQU0sQ0FBQyxPQUFPLENBQUM7UUFDdkMsTUFBTSxZQUFZLEdBQUcsaUJBQUUsQ0FBQyxZQUFZLENBQUMsTUFBTSxDQUFDLFlBQVksRUFBRSxNQUFNLENBQUMsQ0FBQztRQUNsRSxNQUFNLEdBQUcsR0FBRyxJQUFJLENBQUMsR0FBRyxDQUFDO1FBQ3JCLEdBQUcsQ0FBQyxFQUFFLENBQUMsT0FBTyxFQUFFLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxFQUFFO1lBQzNCLElBQUksQ0FBQyxHQUFHLEVBQUUsQ0FBQztnQkFDVCxHQUFHLEdBQUcsR0FBRyxDQUFDLGNBQWMsSUFBSSxHQUFHLENBQUMsc0JBQXNCLEVBQUUsQ0FBQztZQUMzRCxDQUFDO1lBQ0QsSUFBSSxNQUFNLENBQUMsY0FBYyxJQUFJLENBQUMsTUFBTSxDQUFDLGNBQWMsQ0FBQyxHQUFHLEVBQUUsR0FBRyxDQUFDO2dCQUFFLE9BQU87WUFFdEUsTUFBTSxNQUFNLEdBQUcsSUFBQSx1QkFBWSxFQUFDLEdBQUcsQ0FBQyxDQUFDO1lBQ2pDLE1BQU07WUFDTixJQUFJLE1BQU0sSUFBSSxHQUFHLEVBQUUsQ0FBQztnQkFDbEIsSUFBSSxDQUFDO29CQUNILEdBQUcsQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEdBQUcsQ0FBQyxDQUFDO2dCQUN4QixDQUFDO2dCQUFDLE9BQU8sRUFBRSxFQUFFLENBQUM7b0JBQ1osR0FBRyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsR0FBRyxDQUFDLENBQUM7b0JBQ3RCLEdBQUcsQ0FBQyxNQUFNLENBQUMsS0FBSyxDQUFDLEVBQUUsQ0FBQyxDQUFDO2dCQUN2QixDQUFDO2dCQUNELE9BQU87WUFDVCxDQUFDO1lBRUQsTUFBTTtZQUNOLElBQUksQ0FBQztnQkFDSCxHQUFHLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztZQUN2QixDQUFDO1lBQUMsT0FBTyxFQUFFLEVBQUUsQ0FBQztnQkFDWixHQUFHLENBQUMsTUFBTSxDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQztnQkFDckIsR0FBRyxDQUFDLE1BQU0sQ0FBQyxLQUFLLENBQUMsRUFBRSxDQUFDLENBQUM7WUFDdkIsQ0FBQztRQUNILENBQUMsQ0FBQyxDQUFDO1FBRUgsTUFBTSxZQUFZLEdBQW1CO1lBQ25DLHFDQUFxQztZQUNyQyxPQUFPO2dCQUNMLE1BQU0sRUFBRSxHQUFHLE1BQU0sQ0FBQyxPQUFPLElBQUksa0JBQU8sQ0FBQztnQkFDckMsT0FBTyxFQUFFLENBQUMsSUFBVyxDQUFDLENBQUM7WUFDekIsQ0FBQztZQUVELElBQUksQ0FBQyxHQUFHLEVBQUUsR0FBWTtnQkFDcEIsTUFBTSxNQUFNLEdBQUcsSUFBQSx1QkFBWSxFQUFDLEdBQUcsQ0FBQyxDQUFDO2dCQUNqQyxNQUFNLFlBQVksR0FBRyxPQUFPLE1BQU0sQ0FBQyxZQUFZLEtBQUssVUFBVTtvQkFDNUQsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUMsR0FBRyxFQUFFLEdBQUcsQ0FBQztvQkFDL0IsQ0FBQyxDQUFDLE1BQU0sQ0FBQyxZQUFZLENBQUM7Z0JBRXhCLGdDQUFnQztnQkFDaEMsR0FBRyxDQUFDLFVBQVUsR0FBRyxNQUFNLENBQUM7Z0JBQ3hCLG9EQUFvRDtnQkFDcEQsSUFBSSxJQUFBLGlCQUFNLEVBQUMsR0FBRyxDQUFDLEVBQUUsQ0FBQztvQkFDaEIsTUFBTTtvQkFDTixJQUFJLE1BQU0sSUFBSSxHQUFHLEVBQUUsQ0FBQzt3QkFDbEIsSUFBSSxZQUFZLEVBQUUsQ0FBQzs0QkFDakIsTUFBTSxXQUFXLEdBQ2YsQ0FBQyxZQUFZLENBQUMsT0FBTyxDQUFDLEdBQUcsQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLENBQUMsR0FBRyxDQUFDLENBQUMsQ0FBQyxHQUFHLENBQUM7Z0NBQzNDLGVBQWUsTUFBTSxFQUFFLENBQUM7NEJBQzFCLE9BQU8sR0FBRyxDQUFDLFFBQVEsQ0FBQyxZQUFZLEdBQUcsV0FBVyxDQUFDLENBQUM7d0JBQ2xELENBQUM7d0JBQ0QsR0FBRyxDQUFDLE1BQU0sR0FBRyxHQUFHLENBQUM7d0JBQ2pCLEdBQUcsQ0FBQyxJQUFJLEdBQUcsMkNBQTJDLE1BQU0sT0FBTyxDQUFDO3dCQUNwRSxPQUFPO29CQUNULENBQUM7b0JBQ0QsTUFBTTtvQkFDTixHQUFHLENBQUMsTUFBTSxHQUFHLE1BQU0sQ0FBQztvQkFDcEIsR0FBRyxDQUFDLElBQUksR0FBRyxPQUFPLE1BQU0sSUFBSSxtQkFBSSxDQUFDLFlBQVksQ0FBQyxNQUFNLENBQUMsT0FBTyxDQUFDO29CQUM3RCxPQUFPO2dCQUNULENBQUM7Z0JBQ0Qsd0NBQXdDO2dCQUN4QyxJQUFJLEdBQUcsQ0FBQyxNQUFNLENBQUMsR0FBRyxLQUFLLFVBQVUsRUFBRSxDQUFDO29CQUNsQyxHQUFHLENBQUMsTUFBTSxHQUFHLE1BQU0sQ0FBQztvQkFDcEIsR0FBRyxDQUFDLElBQUksR0FBRyxHQUFHLEdBQUcsQ0FBQyxJQUFJLEtBQUssR0FBRyxDQUFDLE9BQU8sS0FBSyxHQUFHLENBQUMsS0FBSyxFQUFFLENBQUM7b0JBQ3ZELE9BQU87Z0JBQ1QsQ0FBQztnQkFFRCxNQUFNLFNBQVMsR0FBRyxJQUFJLHlCQUFTLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxZQUFZLENBQUMsQ0FBQztnQkFDeEQsR0FBRyxDQUFDLElBQUksR0FBRyxTQUFTLENBQUMsTUFBTSxFQUFFLENBQUM7WUFDaEMsQ0FBQztZQUVELElBQUksQ0FBQyxHQUF5QixFQUFFLEdBQVk7Z0JBQzFDLE1BQU0sTUFBTSxHQUFHLElBQUEsdUJBQVksRUFBQyxHQUFHLENBQUMsQ0FBQztnQkFDakMsSUFBSSxTQUFTLEdBQXdCLEVBQUUsQ0FBQztnQkFFeEMsR0FBRyxDQUFDLE1BQU0sR0FBRyxNQUFNLENBQUM7Z0JBQ3BCLE1BQU0sSUFBSSxHQUFHLEdBQUcsQ0FBQyxJQUFJLElBQUksR0FBRyxDQUFDLElBQUksQ0FBQztnQkFDbEMsTUFBTSxPQUFPLEdBQUcsSUFBQSw2QkFBa0IsRUFBQyxHQUFHLEVBQUUsR0FBRyxDQUFDLENBQUM7Z0JBRTdDLElBQUksSUFBQSxpQkFBTSxFQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7b0JBQ2hCLHdCQUF3QjtvQkFDeEIsSUFBSSxNQUFNLElBQUksR0FBRyxFQUFFLENBQUM7d0JBQ2xCLFNBQVMsR0FBRzs0QkFDVixJQUFJOzRCQUNKLG9EQUFvRDs0QkFDcEQsT0FBTyxFQUFFLG1CQUFJLENBQUMsWUFBWSxDQUFDLE1BQU0sQ0FBQzt5QkFDbkMsQ0FBQztvQkFDSixDQUFDO3lCQUFNLENBQUM7d0JBQ04sd0JBQXdCO3dCQUN4QixvQkFBb0I7d0JBQ3BCLFNBQVMsR0FBRzs0QkFDVixJQUFJOzRCQUNKLE9BQU87NEJBQ1AsTUFBTSxFQUFFLEdBQUcsQ0FBQyxNQUFNO3lCQUNuQixDQUFDO29CQUNKLENBQUM7Z0JBQ0gsQ0FBQztxQkFBTSxDQUFDO29CQUNOLFNBQVMsR0FBRzt3QkFDVixJQUFJO3dCQUNKLE9BQU87d0JBQ1AsTUFBTSxFQUFFLEdBQUcsQ0FBQyxNQUFNO3FCQUNuQixDQUFDO29CQUVGLElBQUksTUFBTSxJQUFJLEdBQUcsRUFBRSxDQUFDO3dCQUNsQiwwQ0FBMEM7d0JBQzFDLFNBQVMsQ0FBQyxLQUFLLEdBQUcsR0FBRyxDQUFDLEtBQUssQ0FBQzt3QkFDNUIsU0FBUyxDQUFDLElBQUksR0FBRyxHQUFHLENBQUMsSUFBSSxDQUFDO3dCQUMxQixLQUFLLE1BQU0sR0FBRyxJQUFJLEdBQUcsRUFBRSxDQUFDOzRCQUN0QixJQUFJLENBQUMsU0FBUyxDQUFDLEdBQUcsQ0FBQyxFQUFFLENBQUM7Z0NBQ3BCLFNBQVMsQ0FBQyxHQUFHLENBQUMsR0FBSSxHQUFXLENBQUMsR0FBRyxDQUFDLENBQUM7NEJBQ3JDLENBQUM7d0JBQ0gsQ0FBQztvQkFDSCxDQUFDO2dCQUNILENBQUM7Z0JBRUQsR0FBRyxDQUFDLElBQUksR0FBRyxTQUFTLENBQUM7WUFDdkIsQ0FBQztZQUVELEVBQUUsQ0FBQyxHQUFHLEVBQUUsR0FBWTtnQkFDbEIsWUFBWSxDQUFDLElBQUssQ0FBQyxJQUFJLENBQUMsR0FBRyxFQUFFLEdBQUcsRUFBRSxHQUFHLENBQUMsQ0FBQztnQkFFdkMsSUFBSSxHQUFHLENBQUMsZUFBZSxFQUFFLENBQUM7b0JBQ3hCLEdBQUcsQ0FBQyxlQUFlLENBQUMsR0FBRyxDQUFDLElBQUksQ0FBQyxDQUFDO2dCQUNoQyxDQUFDO1lBQ0gsQ0FBQztTQUNGLENBQUM7UUFFRixtQ0FBbUM7UUFDbkMsTUFBTSxJQUFJLEdBQTRCLENBQUUsS0FBSyxFQUFFLE1BQU0sRUFBRSxNQUFNLEVBQUUsTUFBTSxFQUFFLElBQUksQ0FBRSxDQUFDO1FBQzlFLEtBQUssTUFBTSxJQUFJLElBQUksSUFBSSxFQUFFLENBQUM7WUFDeEIsSUFBSSxNQUFNLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztnQkFDakIsT0FBTyxDQUFDLEdBQUcsQ0FBQyxZQUFZLEVBQUUsSUFBSSxFQUFFLE1BQU0sQ0FBQyxJQUFJLENBQUMsQ0FBQyxDQUFDO1lBQ2hELENBQUM7UUFDSCxDQUFDO1FBQ0QsSUFBQSxxQkFBTyxFQUFDLEdBQUcsRUFBRSxZQUFZLENBQUMsQ0FBQztJQUM3QixDQUFDO0NBQ0Y7QUFqSkQsdUJBaUpDIn0=

package/dist/commonjs/config/config.default.d.ts

@@ -0,0 +1,27 @@
+import type { Context } from '@eggjs/core';
+import type { OnerrorError, OnerrorOptions } from 'koa-onerror';
+export interface OnerrorConfig extends OnerrorOptions {
+    /**
+     * 5xx error will redirect to ${errorPageUrl}
+     * won't redirect in local env
+     *
+     * Default: `''`
+     */
+    errorPageUrl: string | ((err: OnerrorError, ctx: Context) => string);
+    /**
+     * will execute `appErrorFilter` when emit an error in `app`
+     * If `appErrorFilter` return false, egg-onerror won't log this error.
+     * You can logging in `appErrorFilter` and return false to override the default error logging.
+     *
+     * Default: `undefined`
+     */
+    appErrorFilter?: (err: OnerrorError, ctx: Context) => boolean;
+    /**
+     * default template path
+     */
+    templatePath: string;
+}
+declare const _default: {
+    onerror: OnerrorConfig;
+};
+export default _default;

package/dist/commonjs/config/config.default.js

@@ -0,0 +1,15 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const node_path_1 = __importDefault(require("node:path"));
+const utils_js_1 = require("../lib/utils.js");
+exports.default = {
+    onerror: {
+        errorPageUrl: '',
+        appErrorFilter: undefined,
+        templatePath: node_path_1.default.join((0, utils_js_1.getSourceDirname)(), 'lib/onerror_page.mustache.html'),
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsMERBQTZCO0FBRzdCLDhDQUFtRDtBQXdCbkQsa0JBQWU7SUFDYixPQUFPLEVBQUU7UUFDUCxZQUFZLEVBQUUsRUFBRTtRQUNoQixjQUFjLEVBQUUsU0FBUztRQUN6QixZQUFZLEVBQUUsbUJBQUksQ0FBQyxJQUFJLENBQUMsSUFBQSwyQkFBZ0IsR0FBRSxFQUFFLGdDQUFnQyxDQUFDO0tBQzdEO0NBQ25CLENBQUMifQ==

package/dist/commonjs/index.d.ts

@@ -0,0 +1 @@
+import './types.js';

package/dist/commonjs/index.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("./types.js");
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxzQkFBb0IifQ==

package/dist/commonjs/lib/error_view.d.ts

@@ -0,0 +1,154 @@
+import { type StackFrame } from 'stack-trace';
+import type { OnerrorError } from 'koa-onerror';
+import type { Context } from '@eggjs/core';
+export interface FrameSource {
+    pre: string[];
+    line: string;
+    post: string[];
+}
+export interface Frame extends StackFrame {
+    context?: FrameSource;
+}
+export declare class ErrorView {
+    ctx: Context;
+    error: OnerrorError;
+    request: Context['request'];
+    app: Context['app'];
+    assets: Map<string, string>;
+    viewTemplate: string;
+    codeContext: number;
+    _filterHeaders: string[];
+    constructor(ctx: Context, error: OnerrorError, template: string);
+    /**
+     * get html error page
+     *
+     * @return {String} html page
+     */
+    toHTML(): string;
+    /**
+     * compile view
+     *
+     * @param {String} tpl - template
+     * @param {Object} locals - data used by template
+     */
+    compileView(tpl: string, locals: Record<string, unknown>): string;
+    /**
+     * check if the frame is node native file.
+     *
+     * @param {Frame} frame - current frame
+     */
+    isNode(frame: Frame): boolean;
+    /**
+     * check if the frame is app modules.
+     *
+     * @param {Object} frame - current frame
+     */
+    isApp(frame: Frame): boolean;
+    /**
+     * cache file asserts
+     *
+     * @param {String} key - assert key
+     * @param {String} value - assert content
+     */
+    setAssets(key: string, value: string): void;
+    /**
+     * get cache file asserts
+     *
+     * @param {String} key - assert key
+     */
+    getAssets(key: string): string | undefined;
+    /**
+     * get frame source
+     *
+     * @param {Object} frame - current frame
+     */
+    getFrameSource(frame: StackFrame): FrameSource;
+    /**
+     * parse error and return frame stack
+     */
+    parseError(): Frame[];
+    /**
+     * get stack context
+     *
+     * @param {Object} frame - current frame
+     */
+    getContext(frame: Frame): {
+        start?: undefined;
+        pre?: undefined;
+        line?: undefined;
+        post?: undefined;
+    } | {
+        start: number;
+        pre: string;
+        line: string;
+        post: string;
+    };
+    /**
+     * get frame classes, let view identify the frame
+     *
+     * @param {any} frame - current frame
+     * @param {any} index - current index
+     */
+    getFrameClasses(frame: Frame, index: number): string;
+    /**
+     * serialize frame and return meaningful data
+     *
+     * @param {Object} frame - current frame
+     */
+    serializeFrame(frame: Frame): {
+        extname: string;
+        file: string;
+        method: string;
+        line: number;
+        column: number;
+        context: {
+            start?: undefined;
+            pre?: undefined;
+            line?: undefined;
+            post?: undefined;
+        } | {
+            start: number;
+            pre: string;
+            line: string;
+            post: string;
+        };
+        classes: string;
+    };
+    /**
+     * serialize base data
+     *
+     * @param {Object} stack - frame stack
+     * @param {Function} frameFormatter - frame formatter function
+     */
+    serializeData(stack: Frame[], frameFormatter: (frame: Frame, index: number) => any): {
+        code: any;
+        message: string;
+        name: string;
+        status: number;
+        frames: any[];
+    };
+    /**
+     * serialize request object
+     */
+    serializeRequest(): {
+        url: string;
+        httpVersion: string;
+        method: string;
+        connection: string | undefined;
+        headers: {
+            key: string;
+            value: string | string[] | undefined;
+        }[];
+        cookies: {
+            key: string;
+            value: string | undefined;
+        }[];
+    };
+    /**
+     * serialize app info object
+     */
+    serializeAppInfo(): {
+        baseDir: string;
+        config: string;
+    };
+}