@eggjs/view 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 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,283 @@
+# @eggjs/view
+
+[![NPM version](https://img.shields.io/npm/v/@eggjs/view.svg?style=flat-square)](https://npmjs.org/package/@eggjs/view)
+[![NPM quality](http://npm.packagequality.com/shield/@eggjs/view.svg?style=flat-square)](http://packagequality.com/#?package=@eggjs/view)
+[![NPM download](https://img.shields.io/npm/dm/@eggjs/view.svg?style=flat-square)](https://npmjs.org/package/@eggjs/view)
+[![Continuous Integration](https://github.com/eggjs/view/actions/workflows/nodejs.yml/badge.svg)](https://github.com/eggjs/view/actions/workflows/nodejs.yml)
+[![Test coverage](https://img.shields.io/codecov/c/github/eggjs/view.svg?style=flat-square)](https://codecov.io/gh/eggjs/view)
+[![Node.js Version](https://img.shields.io/node/v/@eggjs/view.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/view)
+
+Base view plugin for egg
+
+**it's a plugin that has been built-in for egg.**
+
+## Install
+
+```bash
+npm i @eggjs/view
+```
+
+## Usage
+
+```js
+// {app_root}/config/plugin.js
+exports.view = {
+  enable: true,
+  package: '@eggjs/view',
+};
+```
+
+## Use a template engine
+
+[egg-view] don't have build-in view engine, So you should choose a template engine like [ejs], and install [egg-view-ejs] plugin.
+
+You can choose a template engine first, link [ejs], so we use [egg-view-ejs] plugin.
+
+`egg-view` is in [eggjs], so you just need configure [egg-view-ejs].
+
+```js
+// config/plugin.js
+exports.ejs = {
+  enable: true,
+  package: 'egg-view-ejs',
+};
+```
+
+Configure the mapping, the file with `.ejs` extension will be rendered by ejs.
+
+```js
+// config/config.default.js
+exports.view = {
+  mapping: {
+    '.ejs': 'ejs',
+  },
+};
+```
+
+In controller, you can call `ctx.render`.
+
+```js
+module.exports = app => {
+  return class UserController extends app.Controller {
+    async list() {
+      const { ctx } = this;
+      await ctx.render('user.ejs');
+    }
+  };
+};
+```
+
+If you call `ctx.renderString`, you should specify viewEngine in viewOptions.
+
+```js
+module.exports = app => {
+  return class UserController extends app.Controller {
+    async list() {
+      const { ctx } = this;
+      ctx.body = await ctx.renderString('<%= user %>', { user: 'popomore' }, {
+        viewEngine: 'ejs',
+      });
+    }
+  };
+};
+```
+
+## Use multiple view engine
+
+[egg-view] support multiple view engine, so you can use more than one template engine in one application.
+
+If you want add another template engine like [nunjucks], then you can add [egg-view-nunjucks] plugin.
+
+Configure the plugin and mapping
+
+```js
+// config/config.default.js
+exports.view = {
+  mapping: {
+    '.ejs': 'ejs',
+    '.nj': 'nunjucks',
+  },
+};
+```
+
+You can simply render the file with `.nj` extension.
+
+```js
+await ctx.render('user.nj');
+```
+
+## How to write a view plugin
+
+You can use [egg-view]' API to register a plugin.
+
+### View engine
+
+Create a view engine class first, and implement `render` and `renderString`, if the template engine don't support, just throw an error. The view engine is context level, so it receive ctx in `constructor`.
+
+```js
+// lib/view.js
+module.exports = class MyView {
+  constructor(ctx) {
+    // do some initialize
+    // get the plugin config from `ctx.app.config`
+  }
+
+  async render(fullpath, locals) {
+    return myengine.render(fullpath, locals);
+  }
+
+  async renderString() { throw new Error('not implement'); }
+};
+```
+
+`render` and `renderString` support generator function, async function, or normal function return a promise.
+
+If the template engine only support callback, you can wrap it by Promise.
+
+```js
+class MyView {
+  render(fullpath, locals) {
+    return new Promise((resolve, reject) => {
+      myengine.render(fullpath, locals, (err, result) => {
+        if (err) {
+          reject(err);
+        } else {
+          resolve(result);
+        }
+      });
+    });
+  }
+};
+```
+
+These methods receive three arguments, `renderString` will pass tpl as the first argument instead of name in `render`.
+
+`render(name, locals, viewOptions)`
+
+- name: the file path that can resolve from root (`app/view` by default)
+- locals: data used by template
+- viewOptions: the view options for each render, it can override the view default config in `config/config.default.js`. Plugin should implement it if it has config.
+  When you implement view engine, you will receive this options from `render`, the options contain:
+  - root: egg-view will resolve the name to full path, but seperating root and name in viewOptions.
+  - name: the original name when call render
+  - locals: the original locals when call render
+
+`renderString(tpl, locals, viewOptions)`
+
+- tpl: the template string instead of the file, using in `renderString`
+- locals: same as `render`
+- viewOptions: same as `render`
+
+### Register
+
+After define a view engine, you can register it.
+
+```js
+// app.js
+module.exports = app => {
+  app.view.use('myName', require('./lib/view'));
+};
+```
+
+You can define a view engine name, normally it's a template name.
+
+### Configure
+
+Define plugin name and depend on [egg-view]
+
+```json
+{
+  "eggPlugin": {
+    "name": "myName",
+    "dependencies": [ "view" ]
+  }
+}
+```
+
+Set default config in `config/config.default.js`, the name is equals to plugin name.
+
+```js
+exports.myName = {},
+```
+
+See some examples
+
+- [egg-view-ejs]
+- [egg-view-nunjucks]
+
+## Configuration
+
+### Root
+
+Root is `${baseDir}/app/view` by default, but you can define multiple directory, seperated by `,`. [egg-view] will find a file from all root directories.
+
+```js
+module.exports = appInfo => {
+  const baseDir = appInfo.baseDir;
+  return {
+    view: {
+      root: `${baseDir}/app/view,${baseDir}/app/view2`
+    }
+  }
+}
+```
+
+### defaultExtension
+
+When render a file, you should specify a extension that let [egg-view] know whitch engine you want to use. However you can define `defaultExtension` without write the extension.
+
+```js
+// config/config.default.js
+exports.view = {
+  defaultExtension: '.html',
+};
+
+// controller
+module.exports = app => {
+  return class UserController extends app.Controller {
+    async list() {
+      const { ctx } = this;
+      // render user.html
+      await ctx.render('user');
+    }
+  };
+};
+```
+
+### viewEngine and defaultViewEngine
+
+If you are using `renderString`, you should specify viewEngine in view config, see example above.
+
+However, you can define `defaultViewEngine` without set each time.
+
+```js
+// config/config.default.js
+exports.view = {
+  defaultViewEngine: 'ejs',
+};
+```
+
+see [config/config.default.ts](https://github.com/eggjs/view/blob/master/src/config/config.default.ts) for more detail.
+
+## Questions & Suggestions
+
+Please open an issue [here](https://github.com/eggjs/egg/issues).
+
+## License
+
+[MIT](LICENSE)
+
+## Contributors
+
+[![Contributors](https://contrib.rocks/image?repo=eggjs/logrotator)](https://github.com/eggjs/logrotator/graphs/contributors)
+
+Made with [contributors-img](https://contrib.rocks).
+
+[eggjs]: https://eggjs.org
+[ejs]: https://github.com/mde/ejs
+[egg-view-ejs]: https://github.com/eggjs/egg-view-ejs
+[egg-view]: https://github.com/eggjs/view
+[nunjucks]: http://mozilla.github.io/nunjucks
+[egg-view-nunjucks]: https://github.com/eggjs/egg-view-nunjucks

package/dist/commonjs/app/extend/application.d.ts

@@ -0,0 +1,17 @@
+import { EggCore } from '@eggjs/core';
+import { ViewManager } from '../../lib/view_manager.js';
+declare const VIEW: unique symbol;
+export default class Application extends EggCore {
+    [VIEW]: ViewManager;
+    /**
+     * Retrieve ViewManager instance
+     * @member {ViewManager} Application#view
+     */
+    get view(): ViewManager;
+}
+declare module '@eggjs/core' {
+    interface EggCore {
+        get view(): ViewManager;
+    }
+}
+export {};

package/dist/commonjs/app/extend/application.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@eggjs/core");
+const view_manager_js_1 = require("../../lib/view_manager.js");
+const VIEW = Symbol('Application#view');
+class Application extends core_1.EggCore {
+    [VIEW];
+    /**
+     * Retrieve ViewManager instance
+     * @member {ViewManager} Application#view
+     */
+    get view() {
+        if (!this[VIEW]) {
+            this[VIEW] = new view_manager_js_1.ViewManager(this);
+        }
+        return this[VIEW];
+    }
+}
+exports.default = Application;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXBwbGljYXRpb24uanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi8uLi9zcmMvYXBwL2V4dGVuZC9hcHBsaWNhdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOztBQUFBLHNDQUFzQztBQUN0QywrREFBd0Q7QUFFeEQsTUFBTSxJQUFJLEdBQUcsTUFBTSxDQUFDLGtCQUFrQixDQUFDLENBQUM7QUFFeEMsTUFBcUIsV0FBWSxTQUFRLGNBQU87SUFDOUMsQ0FBQyxJQUFJLENBQUMsQ0FBYztJQUVwQjs7O09BR0c7SUFDSCxJQUFJLElBQUk7UUFDTixJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxFQUFFLENBQUM7WUFDaEIsSUFBSSxDQUFDLElBQUksQ0FBQyxHQUFHLElBQUksNkJBQVcsQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUNyQyxDQUFDO1FBQ0QsT0FBTyxJQUFJLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDcEIsQ0FBQztDQUNGO0FBYkQsOEJBYUMifQ==

package/dist/commonjs/app/extend/context.d.ts

@@ -0,0 +1,44 @@
+import { Context } from '@eggjs/core';
+import { ContextView } from '../../lib/context_view.js';
+import { RenderOptions } from '../../lib/view_manager.js';
+declare const VIEW: unique symbol;
+export default class ViewContext extends Context {
+    [VIEW]: ContextView;
+    /**
+     * Render a file by view engine, then set to body
+     * @param {String} name - the file path based on root
+     * @param {Object} [locals] - data used by template
+     * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
+     */
+    render(name: string, locals?: Record<string, any>, options?: RenderOptions): Promise<void>;
+    /**
+     * Render a file by view engine and return it
+     * @param {String} name - the file path based on root
+     * @param {Object} [locals] - data used by template
+     * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
+     * @return {Promise<String>} result - return a promise with a render result
+     */
+    renderView(name: string, locals?: Record<string, any>, options?: RenderOptions): Promise<string>;
+    /**
+     * Render template string by view engine and return it
+     * @param {String} tpl - template string
+     * @param {Object} [locals] - data used by template
+     * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
+     * @return {Promise<String>} result - return a promise with a render result
+     */
+    renderString(tpl: string, locals?: Record<string, any>, options?: RenderOptions): Promise<string>;
+    /**
+     * View instance that is created every request
+     * @member {ContextView} Context#view
+     */
+    get view(): ContextView;
+}
+declare module '@eggjs/core' {
+    interface Context {
+        view: ContextView;
+        render(name: string, locals?: Record<string, any>, options?: RenderOptions): Promise<void>;
+        renderView(name: string, locals?: Record<string, any>, options?: RenderOptions): Promise<string>;
+        renderString(tpl: string, locals?: Record<string, any>, options?: RenderOptions): Promise<string>;
+    }
+}
+export {};

package/dist/commonjs/app/extend/context.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@eggjs/core");
+const context_view_js_1 = require("../../lib/context_view.js");
+const VIEW = Symbol('Context#view');
+class ViewContext extends core_1.Context {
+    [VIEW];
+    /**
+     * Render a file by view engine, then set to body
+     * @param {String} name - the file path based on root
+     * @param {Object} [locals] - data used by template
+     * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
+     */
+    async render(name, locals, options) {
+        const body = await this.renderView(name, locals, options);
+        this.body = body;
+    }
+    /**
+     * Render a file by view engine and return it
+     * @param {String} name - the file path based on root
+     * @param {Object} [locals] - data used by template
+     * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
+     * @return {Promise<String>} result - return a promise with a render result
+     */
+    async renderView(name, locals, options) {
+        return await this.view.render(name, locals, options);
+    }
+    /**
+     * Render template string by view engine and return it
+     * @param {String} tpl - template string
+     * @param {Object} [locals] - data used by template
+     * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
+     * @return {Promise<String>} result - return a promise with a render result
+     */
+    async renderString(tpl, locals, options) {
+        return await this.view.renderString(tpl, locals, options);
+    }
+    /**
+     * View instance that is created every request
+     * @member {ContextView} Context#view
+     */
+    get view() {
+        if (!this[VIEW]) {
+            this[VIEW] = new context_view_js_1.ContextView(this);
+        }
+        return this[VIEW];
+    }
+}
+exports.default = ViewContext;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29udGV4dC5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uLy4uLy4uL3NyYy9hcHAvZXh0ZW5kL2NvbnRleHQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxzQ0FBc0M7QUFDdEMsK0RBQXdEO0FBR3hELE1BQU0sSUFBSSxHQUFHLE1BQU0sQ0FBQyxjQUFjLENBQUMsQ0FBQztBQUVwQyxNQUFxQixXQUFZLFNBQVEsY0FBTztJQUM5QyxDQUFDLElBQUksQ0FBQyxDQUFjO0lBRXBCOzs7OztPQUtHO0lBQ0gsS0FBSyxDQUFDLE1BQU0sQ0FBQyxJQUFZLEVBQUUsTUFBNEIsRUFBRSxPQUF1QjtRQUM5RSxNQUFNLElBQUksR0FBRyxNQUFNLElBQUksQ0FBQyxVQUFVLENBQUMsSUFBSSxFQUFFLE1BQU0sRUFBRSxPQUFPLENBQUMsQ0FBQztRQUMxRCxJQUFJLENBQUMsSUFBSSxHQUFHLElBQUksQ0FBQztJQUNuQixDQUFDO0lBRUQ7Ozs7OztPQU1HO0lBQ0gsS0FBSyxDQUFDLFVBQVUsQ0FDZCxJQUFZLEVBQ1osTUFBNEIsRUFDNUIsT0FBdUI7UUFFdkIsT0FBTyxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUMsTUFBTSxDQUFDLElBQUksRUFBRSxNQUFNLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDdkQsQ0FBQztJQUVEOzs7Ozs7T0FNRztJQUNILEtBQUssQ0FBQyxZQUFZLENBQUMsR0FBVyxFQUFFLE1BQTRCLEVBQUUsT0FBdUI7UUFDbkYsT0FBTyxNQUFNLElBQUksQ0FBQyxJQUFJLENBQUMsWUFBWSxDQUFDLEdBQUcsRUFBRSxNQUFNLEVBQUUsT0FBTyxDQUFDLENBQUM7SUFDNUQsQ0FBQztJQUVEOzs7T0FHRztJQUNILElBQUksSUFBSTtRQUNOLElBQUksQ0FBQyxJQUFJLENBQUMsSUFBSSxDQUFDLEVBQUUsQ0FBQztZQUNoQixJQUFJLENBQUMsSUFBSSxDQUFDLEdBQUcsSUFBSSw2QkFBVyxDQUFDLElBQUksQ0FBQyxDQUFDO1FBQ3JDLENBQUM7UUFDRCxPQUFPLElBQUksQ0FBQyxJQUFJLENBQUMsQ0FBQztJQUNwQixDQUFDO0NBQ0Y7QUFsREQsOEJBa0RDIn0=

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

@@ -0,0 +1,52 @@
+import type { EggAppInfo } from '@eggjs/core';
+/**
+ * view default config
+ * @member Config#view
+ * @property {String} [root=${baseDir}/app/view] - give a path to find the file, you can specify multiple path with `,` delimiter
+ * @property {Boolean} [cache=true] - whether cache the file's path
+ * @property {String} [defaultExtension] - defaultExtension can be added automatically when there is no extension  when call `ctx.render`
+ * @property {String} [defaultViewEngine] - set the default view engine if you don't want specify the viewEngine every request.
+ * @property {Object} mapping - map the file extension to view engine, such as `{ '.ejs': 'ejs' }`
+ */
+export interface ViewConfig {
+    /**
+     * give a path to find the file, you can specify multiple path with `,` delimiter
+     * Default is `${baseDir}/app/view`
+     */
+    root: string;
+    /**
+     * whether cache the file's path
+     * Default is `true`
+     */
+    cache: boolean;
+    /**
+     * defaultExtension can be added automatically when there is no extension  when call `ctx.render`
+     * Default is `.html`
+     */
+    defaultExtension: string;
+    /**
+     * set the default view engine if you don't want specify the viewEngine every request.
+     * Default is `''`
+     */
+    defaultViewEngine: string;
+    /**
+     * map the file extension to view engine, such as `{ '.ejs': 'ejs' }`
+     * Default is `{}`
+     */
+    mapping: Record<string, string>;
+}
+declare const _default: (appInfo: EggAppInfo) => {
+    view: {
+        root: string;
+        cache: boolean;
+        defaultExtension: string;
+        defaultViewEngine: string;
+        mapping: {};
+    };
+};
+export default _default;
+declare module '@eggjs/core' {
+    interface EggAppConfig {
+        view: ViewConfig;
+    }
+}

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

@@ -0,0 +1,16 @@
+"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"));
+exports.default = (appInfo) => ({
+    view: {
+        root: node_path_1.default.join(appInfo.baseDir, 'app/view'),
+        cache: true,
+        defaultExtension: '.html',
+        defaultViewEngine: '',
+        mapping: {},
+    },
+});
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmRlZmF1bHQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi8uLi9zcmMvY29uZmlnL2NvbmZpZy5kZWZhdWx0LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBQUEsMERBQTZCO0FBd0M3QixrQkFBZSxDQUFDLE9BQW1CLEVBQUUsRUFBRSxDQUFDLENBQUM7SUFDdkMsSUFBSSxFQUFFO1FBQ0osSUFBSSxFQUFFLG1CQUFJLENBQUMsSUFBSSxDQUFDLE9BQU8sQ0FBQyxPQUFPLEVBQUUsVUFBVSxDQUFDO1FBQzVDLEtBQUssRUFBRSxJQUFJO1FBQ1gsZ0JBQWdCLEVBQUUsT0FBTztRQUN6QixpQkFBaUIsRUFBRSxFQUFFO1FBQ3JCLE9BQU8sRUFBRSxFQUFFO0tBQ1o7Q0FDRixDQUFDLENBQUMifQ==

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

@@ -0,0 +1,3 @@
+import type { EggAppConfig } from '@eggjs/core';
+declare const _default: EggAppConfig;
+export default _default;

package/dist/commonjs/config/config.local.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = {
+    view: {
+        cache: false,
+    },
+};
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29uZmlnLmxvY2FsLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vLi4vc3JjL2NvbmZpZy9jb25maWcubG9jYWwudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFFQSxrQkFBZTtJQUNiLElBQUksRUFBRTtRQUNKLEtBQUssRUFBRSxLQUFLO0tBQ2I7Q0FDYyxDQUFDIn0=

package/dist/commonjs/index.d.ts

@@ -0,0 +1,2 @@
+import './config/config.default.js';
+import './app/extend/application.js';

package/dist/commonjs/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("./config/config.default.js");
+require("./app/extend/application.js");
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW5kZXgudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxzQ0FBb0M7QUFDcEMsdUNBQXFDIn0=

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

@@ -0,0 +1,48 @@
+import type { Context, EggCore } from '@eggjs/core';
+import { ViewManager, type ViewManagerConfig, type RenderOptions } from './view_manager.js';
+declare const RENDER: unique symbol;
+declare const RENDER_STRING: unique symbol;
+declare const GET_VIEW_ENGINE: unique symbol;
+declare const SET_LOCALS: unique symbol;
+/**
+ * View instance for each request.
+ *
+ * It will find the view engine, and render it.
+ * The view engine should be registered in {@link ViewManager}.
+ */
+export declare class ContextView {
+    protected ctx: Context;
+    protected app: EggCore;
+    protected viewManager: ViewManager;
+    protected config: ViewManagerConfig;
+    constructor(ctx: Context);
+    /**
+     * Render a file by view engine
+     * @param {String} name - the file path based on root
+     * @param {Object} [locals] - data used by template
+     * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
+     * @return {Promise<String>} result - return a promise with a render result
+     */
+    render(name: string, locals?: Record<string, any>, options?: RenderOptions): Promise<string>;
+    /**
+     * Render a template string by view engine
+     * @param {String} tpl - template string
+     * @param {Object} [locals] - data used by template
+     * @param {Object} [options] - view options, you can use `options.viewEngine` to specify view engine
+     * @return {Promise<String>} result - return a promise with a render result
+     */
+    renderString(tpl: string, locals?: Record<string, any>, options?: RenderOptions): Promise<string>;
+    [RENDER](name: string, locals?: Record<string, any>, options?: RenderOptions): Promise<string>;
+    [RENDER_STRING](tpl: string, locals?: Record<string, any>, options?: RenderOptions): Promise<string>;
+    [GET_VIEW_ENGINE](name: string): import("./view_manager.js").ViewEngine;
+    /**
+     * set locals for view, inject `locals.ctx`, `locals.request`, `locals.helper`
+     * @private
+     */
+    [SET_LOCALS](locals?: Record<string, any>): {
+        ctx: Context;
+        request: import("@eggjs/core").Request;
+        helper: import("egg").Helper;
+    } & Record<string, any>;
+}
+export {};