@zenweb/template 4.0.0 → 5.0.0

package/README.md

@@ -1,33 +1,23 @@
-# zenweb-template
+# template - 服务端模版渲染
 
-zenweb template render module
+## 功能说明
 
-## Install
+在服务器端使用模版引擎渲染模版并根据请求条件按需输出
 
-```bash
-yarn add @zenweb/template
-```
-
-### nunjucks
-
-```bash
-yarn add @zenweb/template-nunjucks
-```
+## 演示
 
-### handlebars
+### 安装
 
 ```bash
-yarn add @zenweb/template-handlebars
+yarn add @zenweb/template @zenweb/template-nunjucks
 ```
 
-## App Config
+### 配置
 
-src/index.ts
 ```ts
 import { create } from 'zenweb';
 import modTemplate from '@zenweb/template';
 import nunjucks from '@zenweb/template-nunjucks';
-import handlebars from '@zenweb/template-handlebars';
 
 create()
 
@@ -39,55 +29,59 @@ create()
   }),
 }))
 
-// Multiple Engines
-.setup(modTemplate({
-  type: 'xml',
-  matchPath: [/\.xml$/i],
-  templateAffix: '.xml',
-  engineName: 'xml',
-  engine: handlebars(),
-}))
-
 .start();
 ```
 
-## Use
+控制器使用
 
-src/controller/demo.ts
 ```ts
-import { Context, mapping } from "zenweb";
+import { Context, mapping, Body, $body } from 'zenweb';
 
-export class DemoController {
-  @mapping({ path: ['/', '/index.html'] })
-  index(ctx: Context) {
-    ctx.template('index.html');
-    return { name: 'Hello' };
+export class Controller {
+  @mapping({ path: '/', method: 'POST' })
+  post(body: Body) {
+    console.log(body.type); // POST body 内容类型
+    console.log(body.data); // POST Body 内容解析完成后的数据
   }
 
-  @mapping({ path: '/test.html' })
-  test() {
-    return { name: 'Test' };
+  @mapping({ path: '/', method: 'POST' })
+  async post() {
+    console.log(await getAge()); // 类型转换&校验
   }
+}
 
-  @mapping()
-  xml(ctx: Context) {
-    ctx.template({ engine: 'xml' })
-    return { name: 'Test' };
-  }
+async function getAge() {
+  return (await $body.get({ age: '!int' })).age;
 }
 ```
 
+模版代码
+
 template/index.html
 ```html
 <h1>Hello {{name}}</h1>
 ```
 
-template/test.html
-```html
-<h1>Hello {{name}}</h1>
-```
+## 依赖模块
 
-template/xml.xml
-```xml
-<root>{{name}}</root>
-```
+- @zenweb/result
+
+## Core 挂载项
+
+无
+
+## Context 挂载项
+
+- `templateOption`
+- `template(option)` 设置当前请求的模版渲染选项
+
+## 全局模式
+
+| 方法 | 功能 |
+| ----- | ---- |
+| $template() | 设置当前请求的模版渲染选项 |
+
+## 目前已支持的模版引擎
+
+[nunjucks](https://www.npmjs.com/package/@zenweb/template-nunjucks)
+[handlebars](https://www.npmjs.com/package/@zenweb/template-handlebars)

package/dist/global.d.ts

@@ -0,0 +1,9 @@
+import { TemplateOption } from "./types";
+/**
+ * 启用并设置模版渲染
+ * - 不传参数: 启用
+ * - false: 关闭模版渲染
+ * - string: 设置模版文件名
+ * - TemplateOption: 详细设置
+ */
+export declare function $template(template_or_option?: false | string | TemplateOption): void;

package/dist/global.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.$template = void 0;
+const core_1 = require("@zenweb/core");
+/**
+ * 启用并设置模版渲染
+ * - 不传参数: 启用
+ * - false: 关闭模版渲染
+ * - string: 设置模版文件名
+ * - TemplateOption: 详细设置
+ */
+function $template(template_or_option) {
+    return (0, core_1.$getContext)().template(template_or_option);
+}
+exports.$template = $template;

package/dist/index.d.ts

@@ -1,11 +1,11 @@
 import { SetupFunction } from '@zenweb/core';
 import { TemplateSetupOption, TemplateOption } from './types';
-import { TEMPLATE_OPTION } from './render';
 export * from './types';
+export * from './global';
 export default function setup(option: TemplateSetupOption): SetupFunction;
 declare module '@zenweb/core' {
     interface Context {
-        [TEMPLATE_OPTION]?: TemplateOption;
+        templateOption?: TemplateOption;
         /**
          * 启用并设置模版渲染
          * - 不传参数: 启用

package/dist/index.js

@@ -17,19 +17,20 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const result_1 = require("@zenweb/result");
 const render_1 = require("./render");
 __exportStar(require("./types"), exports);
+__exportStar(require("./global"), exports);
 function contextTemplate(template_or_option) {
     if (template_or_option === false) {
-        delete this[render_1.TEMPLATE_OPTION];
+        this.templateOption = undefined;
         return;
     }
-    if (!this[render_1.TEMPLATE_OPTION]) {
-        this[render_1.TEMPLATE_OPTION] = {};
+    if (!this.templateOption) {
+        this.templateOption = {};
     }
     if (typeof template_or_option === 'string') {
-        Object.assign(this[render_1.TEMPLATE_OPTION], { template: template_or_option });
+        Object.assign(this.templateOption, { template: template_or_option });
     }
     else if (typeof template_or_option === 'object') {
-        Object.assign(this[render_1.TEMPLATE_OPTION], template_or_option);
+        Object.assign(this.templateOption, template_or_option);
     }
 }
 function setup(option) {

package/dist/render.d.ts

@@ -1,9 +1,9 @@
 import { Context } from '@zenweb/core';
 import { ResultRender } from '@zenweb/result';
 import { TemplateSetupOption } from './types';
-export declare const TEMPLATE_OPTION: unique symbol;
 export declare class TemplateRender implements ResultRender {
     private _option;
+    enwrap: boolean;
     type: string;
     constructor(_option: TemplateSetupOption);
     match(ctx: Context): boolean;

package/dist/render.js

@@ -1,20 +1,36 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TemplateRender = exports.TEMPLATE_OPTION = void 0;
+exports.TemplateRender = void 0;
 const result_1 = require("@zenweb/result");
 const utils_1 = require("./utils");
-exports.TEMPLATE_OPTION = Symbol('template@option');
 class TemplateRender {
     constructor(_option) {
         this._option = _option;
+        this.enwrap = false;
         this.type = this._option.type || 'html';
     }
     match(ctx) {
-        const opt = ctx[exports.TEMPLATE_OPTION];
-        // 匹配引擎, 如果不设置引擎则直接匹配
-        if (opt && (!opt.engine || opt.engine === this._option.engineName)) {
-            (0, utils_1.debug)('matchEngine: %o', this._option.engineName);
-            return true;
+        const opt = ctx.templateOption;
+        if (opt) {
+            // 匹配引擎
+            if (opt.engine === this._option.engineName) {
+                (0, utils_1.debug)('matchEngine: %o', this._option.engineName);
+                return true;
+            }
+            // 指定模版
+            if (opt.template && this._option.templateAffix && opt.template.endsWith(this._option.templateAffix)) {
+                (0, utils_1.debug)('matchTemplateAffix: %o', this._option.templateAffix);
+                return true;
+            }
+        }
+        // 忽略路径规则
+        if (this._option.ignorePath) {
+            for (const reg of this._option.ignorePath) {
+                if (reg.test(ctx.path)) {
+                    (0, utils_1.debug)('ignorePath: %o', reg);
+                    return false;
+                }
+            }
         }
         // 匹配路径规则
         if (this._option.matchPath) {
@@ -27,7 +43,7 @@ class TemplateRender {
         }
         // 匹配 Accept 头类型
         if (this._option.matchAccept) {
-            const _type = ctx.accepts(this._option.matchAccept);
+            const _type = ctx.accepts().some(accept => { var _a; return (_a = this._option.matchAccept) === null || _a === void 0 ? void 0 : _a.includes(accept); });
             if (_type) {
                 (0, utils_1.debug)('matchAccept: %o', _type);
                 return true;
@@ -36,7 +52,7 @@ class TemplateRender {
         return false;
     }
     render(ctx, data) {
-        const opt = ctx[exports.TEMPLATE_OPTION] || {};
+        const opt = ctx.templateOption || {};
         let template = opt.template;
         if (data instanceof result_1.ResultFail) {
             data = { fail: data };

package/dist/types.d.ts

@@ -10,9 +10,13 @@ export interface TemplateSetupOption {
      */
     type?: string;
     /**
-     * 匹配路径结尾例如 `/.html$/i`
+     * 匹配路径，例如 `/.html$/i`
      */
     matchPath?: RegExp[];
+    /**
+     * 忽略路径，例如 `/^\/api\//i`
+     */
+    ignorePath?: RegExp[];
     /**
      * 匹配 Accept Type 头信息
      */

package/dist/utils.d.ts

@@ -1,3 +1,2 @@
-import { Debugger } from '@zenweb/core';
-export declare const debug: Debugger;
+export declare const debug: import("@zenweb/core").Debugger;
 export declare function cwdPath(p: string): string;

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@zenweb/template",
   "packageManager": "yarn@4.0.2",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "zenweb template render module",
   "exports": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "scripts": {
     "vscode": "yarn dlx @yarnpkg/sdks vscode",
     "build": "rimraf dist && tsc",
-    "prepublishOnly": "yarn run build",
+    "prepack": "yarn run build",
     "dev": "cd example && cross-env DEBUG=\\* ts-node app"
   },
   "files": [
@@ -27,17 +27,17 @@
   "homepage": "https://zenweb.node.ltd",
   "devDependencies": {
     "@types/node": "^20.10.6",
-    "@zenweb/inject": "^4.0.6",
+    "@zenweb/inject": "^5.0.1",
     "@zenweb/template-handlebars": "^3.0.0",
-    "@zenweb/template-nunjucks": "^3.0.0",
+    "@zenweb/template-nunjucks": "^3.3.0",
     "cross-env": "^7.0.3",
     "rimraf": "^4.4.1",
     "ts-node": "^10.9.1",
-    "typescript": "^5.3.3",
-    "zenweb": "^4.2.7"
+    "typescript": "~5.3.3",
+    "zenweb": "^5.0.0"
   },
   "dependencies": {
-    "@zenweb/core": "^4.2.1",
-    "@zenweb/result": "^3.12.6"
+    "@zenweb/core": "^5.0.0",
+    "@zenweb/result": "^4.1.3"
   }
 }