@midwayjs/view 3.0.0-beta.8 → 3.0.2

package/dist/viewManager.js

@@ -10,19 +10,32 @@ var __metadata = (this && this.__metadata) || function (k, v) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ViewManager = void 0;
-const OriginViewManager = require("egg-view/lib/view_manager");
 const decorator_1 = require("@midwayjs/decorator");
-const mw_util_1 = require("@midwayjs/mw-util");
-let ViewManager = class ViewManager {
-    get extMap() {
-        return this.innerManager.extMap;
+const assert = require("assert");
+const path = require("path");
+const fs_1 = require("fs");
+let ViewManager = class ViewManager extends Map {
+    constructor() {
+        super(...arguments);
+        this.extMap = new Map();
+        this.fileMap = new Map();
     }
-    get config() {
-        return this.innerManager.config;
-    }
-    async init() {
-        const mockApp = (0, mw_util_1.createMockApp)(this.app);
-        this.innerManager = new OriginViewManager(mockApp);
+    init() {
+        this.config = this.viewConfig;
+        const rootSet = new Set(Object.values(this.config.rootDir));
+        if (this.config.root) {
+            this.config.root.split(/\s*,\s*/g).forEach(filepath => {
+                rootSet.add(filepath);
+            });
+        }
+        this.config.root = Array.from(rootSet.values()).filter(filepath => {
+            return (0, fs_1.existsSync)(filepath);
+        });
+        this.extMap = new Map();
+        this.fileMap = new Map();
+        for (const ext of Object.keys(this.config.mapping)) {
+            this.extMap.set(ext, this.config.mapping[ext]);
+        }
     }
     /**
      * This method can register view engine.
@@ -39,35 +52,70 @@ let ViewManager = class ViewManager {
      * @param {Object} viewEngine - the class of view engine
      */
     use(name, viewEngine) {
-        return this.innerManager.use(name, viewEngine);
+        assert(name, 'name is required');
+        assert(!this.has(name), `${name} has been registered`);
+        assert(viewEngine, 'viewEngine is required');
+        assert(viewEngine.prototype.render, 'viewEngine should implement `render` method');
+        assert(viewEngine.prototype.renderString, 'viewEngine should implement `renderString` method');
+        this.set(name, viewEngine);
     }
     /**
      * Resolve the path based on the given name,
-     * if the name is `user.html` and root is `app/view` (by default),
-     * it will return `app/view/user.html`
+     * if the name is `user.html` and root is `view` (by default),
+     * it will return `view/user.html`
      * @param {String} name - the given path name, it's relative to config.root
      * @return {String} filename - the full path
      */
     async resolve(name) {
-        return this.innerManager.resolve(name);
-    }
-    get(key) {
-        return this.innerManager.get(key);
+        const config = this.config;
+        // check cache
+        let filename = this.fileMap.get(name);
+        if (config.cache && filename)
+            return filename;
+        // try find it with default extension
+        filename = await resolvePath([name, name + config.defaultExtension], config.root);
+        assert(filename, `Can't find ${name} from ${config.root.join(',')}`);
+        // set cache
+        this.fileMap.set(name, filename);
+        return filename;
     }
 };
 __decorate([
     (0, decorator_1.App)(),
     __metadata("design:type", Object)
 ], ViewManager.prototype, "app", void 0);
+__decorate([
+    (0, decorator_1.Config)('view'),
+    __metadata("design:type", Object)
+], ViewManager.prototype, "viewConfig", void 0);
 __decorate([
     (0, decorator_1.Init)(),
     __metadata("design:type", Function),
     __metadata("design:paramtypes", []),
-    __metadata("design:returntype", Promise)
+    __metadata("design:returntype", void 0)
 ], ViewManager.prototype, "init", null);
 ViewManager = __decorate([
     (0, decorator_1.Provide)(),
     (0, decorator_1.Scope)(decorator_1.ScopeEnum.Singleton)
 ], ViewManager);
 exports.ViewManager = ViewManager;
+async function resolvePath(names, root) {
+    for (const name of names) {
+        for (const dir of root) {
+            const filename = path.join(dir, name);
+            try {
+                await fs_1.promises.access(filename, fs_1.constants.R_OK);
+                if (inpath(dir, filename)) {
+                    return filename;
+                }
+            }
+            catch (err) {
+                // ignore
+            }
+        }
+    }
+}
+function inpath(parent, sub) {
+    return sub.indexOf(parent) > -1;
+}
 //# sourceMappingURL=viewManager.js.map

package/dist/viewManager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"viewManager.js","sourceRoot":"","sources":["../src/viewManager.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,mDAO6B;AAC7B,iCAAiC;AACjC,6BAA6B;AAC7B,2BAAqD;AAKrD,IAAa,WAAW,GAAxB,MAAa,WAAY,SAAQ,GAAG;IAApC;;QASE,WAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACnB,YAAO,GAAG,IAAI,GAAG,EAAE,CAAC;IA8EtB,CAAC;IA3EC,IAAI;QACF,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;QAC9B,MAAM,OAAO,GAAgB,IAAI,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC;QACzE,IAAI,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE;YACpB,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE;gBACpD,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC;SACJ;QAED,IAAI,CAAC,MAAM,CAAC,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;YAChE,OAAO,IAAA,eAAU,EAAC,QAAQ,CAAC,CAAC;QAC9B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;QACxB,IAAI,CAAC,OAAO,GAAG,IAAI,GAAG,EAAE,CAAC;QACzB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE;YAClD,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;SAChD;IACH,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,IAAY,EAAE,UAAwC;QACxD,MAAM,CAAC,IAAI,EAAE,kBAAkB,CAAC,CAAC;QACjC,MAAM,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,GAAG,IAAI,sBAAsB,CAAC,CAAC;QAEvD,MAAM,CAAC,UAAU,EAAE,wBAAwB,CAAC,CAAC;QAC7C,MAAM,CACJ,UAAU,CAAC,SAAS,CAAC,MAAM,EAC3B,6CAA6C,CAC9C,CAAC;QACF,MAAM,CACJ,UAAU,CAAC,SAAS,CAAC,YAAY,EACjC,mDAAmD,CACpD,CAAC;QAEF,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC7B,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CAAC,IAAY;QACxB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC;QAE3B,cAAc;QACd,IAAI,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACtC,IAAI,MAAM,CAAC,KAAK,IAAI,QAAQ;YAAE,OAAO,QAAQ,CAAC;QAE9C,qCAAqC;QACrC,QAAQ,GAAG,MAAM,WAAW,CAC1B,CAAC,IAAI,EAAE,IAAI,GAAG,MAAM,CAAC,gBAAgB,CAAC,EACtC,MAAM,CAAC,IAAI,CACZ,CAAC;QACF,MAAM,CAAC,QAAQ,EAAE,cAAc,IAAI,SAAS,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAErE,YAAY;QACZ,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QACjC,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF,CAAA;AAtFC;IADC,IAAA,eAAG,GAAE;;wCACF;AAGJ;IADC,IAAA,kBAAM,EAAC,MAAM,CAAC;;+CACJ;AAQX;IADC,IAAA,gBAAI,GAAE;;;;uCAkBN;AA9BU,WAAW;IAFvB,IAAA,mBAAO,GAAE;IACT,IAAA,iBAAK,EAAC,qBAAS,CAAC,SAAS,CAAC;GACd,WAAW,CAwFvB;AAxFY,kCAAW;AA0FxB,KAAK,UAAU,WAAW,CAAC,KAAK,EAAE,IAAI;IACpC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACtB,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YACtC,IAAI;gBACF,MAAM,aAAQ,CAAC,MAAM,CAAC,QAAQ,EAAE,cAAS,CAAC,IAAI,CAAC,CAAC;gBAChD,IAAI,MAAM,CAAC,GAAG,EAAE,QAAQ,CAAC,EAAE;oBACzB,OAAO,QAAQ,CAAC;iBACjB;aACF;YAAC,OAAO,GAAG,EAAE;gBACZ,SAAS;aACV;SACF;KACF;AACH,CAAC;AAED,SAAS,MAAM,CAAC,MAAM,EAAE,GAAG;IACzB,OAAO,GAAG,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;AAClC,CAAC","sourcesContent":["import {\n  App,\n  Config,\n  Init,\n  Provide,\n  Scope,\n  ScopeEnum,\n} from '@midwayjs/decorator';\nimport * as assert from 'assert';\nimport * as path from 'path';\nimport { constants, existsSync, promises } from 'fs';\nimport { IViewEngine } from './interface';\n\n@Provide()\n@Scope(ScopeEnum.Singleton)\nexport class ViewManager extends Map {\n  @App()\n  app;\n\n  @Config('view')\n  viewConfig;\n\n  config;\n\n  extMap = new Map();\n  fileMap = new Map();\n\n  @Init()\n  init() {\n    this.config = this.viewConfig;\n    const rootSet: Set<string> = new Set(Object.values(this.config.rootDir));\n    if (this.config.root) {\n      this.config.root.split(/\\s*,\\s*/g).forEach(filepath => {\n        rootSet.add(filepath);\n      });\n    }\n\n    this.config.root = Array.from(rootSet.values()).filter(filepath => {\n      return existsSync(filepath);\n    });\n    this.extMap = new Map();\n    this.fileMap = new Map();\n    for (const ext of Object.keys(this.config.mapping)) {\n      this.extMap.set(ext, this.config.mapping[ext]);\n    }\n  }\n\n  /**\n   * This method can register view engine.\n   *\n   * You can define a view engine class contains two method, `render` and `renderString`\n   *\n   * ```js\n   * class View {\n   *   render() {}\n   *   renderString() {}\n   * }\n   * ```\n   * @param {String} name - the name of view engine\n   * @param {Object} viewEngine - the class of view engine\n   */\n  use(name: string, viewEngine: new (...args) => IViewEngine): void {\n    assert(name, 'name is required');\n    assert(!this.has(name), `${name} has been registered`);\n\n    assert(viewEngine, 'viewEngine is required');\n    assert(\n      viewEngine.prototype.render,\n      'viewEngine should implement `render` method'\n    );\n    assert(\n      viewEngine.prototype.renderString,\n      'viewEngine should implement `renderString` method'\n    );\n\n    this.set(name, viewEngine);\n  }\n\n  /**\n   * Resolve the path based on the given name,\n   * if the name is `user.html` and root is `view` (by default),\n   * it will return `view/user.html`\n   * @param {String} name - the given path name, it's relative to config.root\n   * @return {String} filename - the full path\n   */\n  async resolve(name: string): Promise<string> {\n    const config = this.config;\n\n    // check cache\n    let filename = this.fileMap.get(name);\n    if (config.cache && filename) return filename;\n\n    // try find it with default extension\n    filename = await resolvePath(\n      [name, name + config.defaultExtension],\n      config.root\n    );\n    assert(filename, `Can't find ${name} from ${config.root.join(',')}`);\n\n    // set cache\n    this.fileMap.set(name, filename);\n    return filename;\n  }\n}\n\nasync function resolvePath(names, root) {\n  for (const name of names) {\n    for (const dir of root) {\n      const filename = path.join(dir, name);\n      try {\n        await promises.access(filename, constants.R_OK);\n        if (inpath(dir, filename)) {\n          return filename;\n        }\n      } catch (err) {\n        // ignore\n      }\n    }\n  }\n}\n\nfunction inpath(parent, sub) {\n  return sub.indexOf(parent) > -1;\n}\n"]}

package/index.d.ts

@@ -1,54 +1,11 @@
+import { IViewEngine } from './dist';
 export * from './dist/index';
 
-interface RenderOptions {
-  name?: string;
-  root?: string;
-  locals?: Record<string, any>;
-  viewEngine?: string;
-}
-
 declare module '@midwayjs/core/dist/interface' {
-  interface Context {
-    /**
-     * 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
-     * @return {Promise<String>} result - return a promise with a render result
-     */
-    render(name: string, locals?: any, options?: RenderOptions): Promise<null>;
-
-    /**
-     * 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?: 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(
-      name: string,
-      locals?: any,
-      options?: RenderOptions
-    ): Promise<string>;
-  }
-
   interface MidwayConfig {
     view?: {
       /**
-       * give a path to find the file, you can specify multiple path with `,` delimiter
+       * give a path to find the file, it will be override rootDir.default
        */
       root?: string;
       /**
@@ -67,6 +24,31 @@ declare module '@midwayjs/core/dist/interface' {
        * map the file extension to view engine, such as `{ '.ejs': 'ejs' }`
        */
       mapping?: Record<string, string>;
+      /**
+       * give multi-path for root, it can be overwrite or add in different component
+       */
+      rootDir?: Record<string, string>;
     };
   }
 }
+
+declare module '@midwayjs/koa/dist/interface' {
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface Context extends IViewEngine {
+    //...
+  }
+}
+
+declare module '@midwayjs/web/dist/interface' {
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface Context extends IViewEngine {
+    //...
+  }
+}
+
+declare module '@midwayjs/faas/dist/interface' {
+  // eslint-disable-next-line @typescript-eslint/no-empty-interface
+  interface Context extends IViewEngine {
+    //...
+  }
+}

package/package.json

@@ -1,42 +1,37 @@
 {
   "name": "@midwayjs/view",
-  "version": "3.0.0-beta.8",
-  "description": "Midway Component for egg-view",
+  "version": "3.0.2",
+  "description": "Midway Component for render view",
   "main": "dist/index.js",
   "typings": "index.d.ts",
   "scripts": {
     "build": "tsc",
-    "test": "node --require=ts-node/register ../../node_modules/.bin/jest",
-    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --coverage --forceExit",
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit",
     "ci": "npm run test"
   },
   "keywords": [
     "midway",
     "component",
     "midway-view",
-    "view",
-    "egg-view"
+    "view"
   ],
   "author": "",
   "files": [
     "dist/**/*.js",
     "dist/**/*.d.ts",
-    "index.d.ts"
+    "index.d.ts",
+    "dist/**/*.js.map"
   ],
   "engines": {
     "node": ">=12"
   },
   "license": "MIT",
-  "dependencies": {
-    "@midwayjs/mw-util": "^1.0.0",
-    "egg-view": "^2.1.3",
-    "extend2": "^1.0.0"
-  },
   "devDependencies": {
-    "@midwayjs/core": "^3.0.0-beta.8",
-    "@midwayjs/decorator": "^3.0.0-beta.8",
-    "@midwayjs/koa": "^3.0.0-beta.8",
-    "@midwayjs/mock": "^3.0.0-beta.8"
+    "@midwayjs/core": "^3.0.2",
+    "@midwayjs/decorator": "^3.0.2",
+    "@midwayjs/koa": "^3.0.2",
+    "@midwayjs/mock": "^3.0.2"
   },
-  "gitHead": "bfafbdf8798f48d4daac5dd88ad53c6b2f33c110"
+  "gitHead": "ca77247d229978a736e79bb208579c014ed226fc"
 }