@zenweb/template 4.1.0 → 5.1.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.js";
+/**
+ * 启用并设置模版渲染
+ * - 不传参数: 启用
+ * - false: 关闭模版渲染
+ * - string: 设置模版文件名
+ * - TemplateOption: 详细设置
+ */
+export declare function $template(template_or_option?: false | string | TemplateOption): void;

package/dist/global.js

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

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 import { SetupFunction } from '@zenweb/core';
-import { TemplateSetupOption, TemplateOption } from './types';
-export * from './types';
+import { TemplateSetupOption, TemplateOption } from './types.js';
+export * from './types.js';
+export * from './global.js';
 export default function setup(option: TemplateSetupOption): SetupFunction;
 declare module '@zenweb/core' {
     interface Context {

package/dist/index.js

@@ -1,22 +1,7 @@
-"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 __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const result_1 = require("@zenweb/result");
-const render_1 = require("./render");
-__exportStar(require("./types"), exports);
+import { RenderManager } from '@zenweb/result';
+import { TemplateRender } from './render.js';
+export * from './types.js';
+export * from './global.js';
 function contextTemplate(template_or_option) {
     if (template_or_option === false) {
         this.templateOption = undefined;
@@ -32,18 +17,17 @@ function contextTemplate(template_or_option) {
         Object.assign(this.templateOption, template_or_option);
     }
 }
-function setup(option) {
+export default function setup(option) {
     return async function template(setup) {
         if (!option.engineName) {
             option.engineName = option.engine.name;
         }
         setup.debug('option: %o', option);
         setup.assertModuleExists('result', '@zenweb/result');
-        const renderManager = await setup.core.injector.getInstance(result_1.RenderManager);
-        renderManager.add(new render_1.TemplateRender(option));
+        const renderManager = await setup.core.injector.getInstance(RenderManager);
+        renderManager.add(new TemplateRender(option));
         if (!('template' in setup.app.context)) {
             setup.defineContextProperty('template', { value: contextTemplate });
         }
     };
 }
-exports.default = setup;

package/dist/render.d.ts

@@ -1,6 +1,6 @@
 import { Context } from '@zenweb/core';
 import { ResultRender } from '@zenweb/result';
-import { TemplateSetupOption } from './types';
+import { TemplateSetupOption } from './types.js';
 export declare class TemplateRender implements ResultRender {
     private _option;
     enwrap: boolean;

package/dist/render.js

@@ -1,25 +1,24 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TemplateRender = void 0;
-const result_1 = require("@zenweb/result");
-const utils_1 = require("./utils");
-class TemplateRender {
+import { ResultFail } from '@zenweb/result';
+import { debug } from './utils.js';
+export class TemplateRender {
+    _option;
+    enwrap = false;
+    type;
     constructor(_option) {
         this._option = _option;
-        this.enwrap = false;
-        this.type = this._option.type || 'html';
+        this.type = _option.type || 'html';
     }
     match(ctx) {
         const opt = ctx.templateOption;
         if (opt) {
             // 匹配引擎
             if (opt.engine === this._option.engineName) {
-                (0, utils_1.debug)('matchEngine: %o', this._option.engineName);
+                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);
+                debug('matchTemplateAffix: %o', this._option.templateAffix);
                 return true;
             }
         }
@@ -27,7 +26,7 @@ class TemplateRender {
         if (this._option.ignorePath) {
             for (const reg of this._option.ignorePath) {
                 if (reg.test(ctx.path)) {
-                    (0, utils_1.debug)('ignorePath: %o', reg);
+                    debug('ignorePath: %o', reg);
                     return false;
                 }
             }
@@ -36,16 +35,16 @@ class TemplateRender {
         if (this._option.matchPath) {
             for (const reg of this._option.matchPath) {
                 if (reg.test(ctx.path)) {
-                    (0, utils_1.debug)('matchPath: %o', reg);
+                    debug('matchPath: %o', reg);
                     return true;
                 }
             }
         }
         // 匹配 Accept 头类型
         if (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); });
+            const _type = ctx.accepts().some(accept => this._option.matchAccept?.includes(accept));
             if (_type) {
-                (0, utils_1.debug)('matchAccept: %o', _type);
+                debug('matchAccept: %o', _type);
                 return true;
             }
         }
@@ -54,7 +53,7 @@ class TemplateRender {
     render(ctx, data) {
         const opt = ctx.templateOption || {};
         let template = opt.template;
-        if (data instanceof result_1.ResultFail) {
+        if (data instanceof ResultFail) {
             data = { fail: data };
             if (opt.failTemplate !== false) {
                 template = opt.failTemplate || this._option.failTemplate || template;
@@ -69,4 +68,3 @@ class TemplateRender {
         return this._option.engine(template, data);
     }
 }
-exports.TemplateRender = TemplateRender;

package/dist/types.js

@@ -1,2 +1 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+export {};

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/dist/utils.js

@@ -1,13 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cwdPath = exports.debug = void 0;
-const path = require("path");
-const core_1 = require("@zenweb/core");
-exports.debug = core_1.debug.extend('template');
-function cwdPath(p) {
+import * as path from 'path';
+import { debug as _debug } from '@zenweb/core';
+export const debug = _debug.extend('template');
+export function cwdPath(p) {
     if (p.startsWith('./')) {
         return path.join(process.cwd(), p.slice(2));
     }
     return p;
 }
-exports.cwdPath = cwdPath;

package/package.json

@@ -1,15 +1,14 @@
 {
   "name": "@zenweb/template",
-  "packageManager": "yarn@4.0.2",
-  "version": "4.1.0",
+  "type": "module",
+  "version": "5.1.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",
-    "prepack": "yarn run build",
-    "dev": "cd example && cross-env DEBUG=\\* ts-node app"
+    "prepack": "npm run build",
+    "dev": "cd example && node --env-file=.env --import tsx/esm app.ts"
   },
   "files": [
     "dist"
@@ -27,17 +26,16 @@
   "homepage": "https://zenweb.node.ltd",
   "devDependencies": {
     "@types/node": "^20.10.6",
-    "@zenweb/inject": "^4.1.1",
+    "@zenweb/inject": "^5.1.0",
     "@zenweb/template-handlebars": "^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.5.0"
+    "tsx": "^4.19.1",
+    "typescript": "^5.3.3",
+    "zenweb": "^5.1.0"
   },
   "dependencies": {
-    "@zenweb/core": "^4.3.2",
-    "@zenweb/result": "^4.0.0"
+    "@zenweb/core": "^5.1.0",
+    "@zenweb/result": "^5.0.0"
   }
 }