@tsed/platform-views 6.87.1 → 6.89.0

package/lib/cjs/decorators/view.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.View = void 0;
+const core_1 = require("@tsed/core");
+/**
+ * Use a view and sends the rendered HTML string to the client. Optional parameter:
+ *
+ * * viewOptions, an object whose properties define local variables for the view.
+ *
+ * The view argument is a string that is the file path of the view file to render.
+ * This can be an absolute path, or a path relative to the views setting.
+ * If the path does not contain a file extension, then the view engine setting determines the file extension.
+ * If the path does contain a file extension, then Express will load the module for the specified template engine (via require())
+ * and render it using the loaded module’s __express function.
+ *
+ * For more information, see [Using template engines with Express](http://expressjs.com/guide/using-template-engines.html).
+ *
+ * > NOTE: The view argument performs file system operations like reading a file from disk and evaluating Node.js modules,
+ * and as so for security reasons should not contain input from the end-user.
+ *
+ * @param path Relative path to the view file.
+ * @param options Additional options
+ * @decorator
+ * @operation
+ * @response
+ */
+function View(path, options) {
+    return (0, core_1.StoreSet)("view", { path, options });
+}
+exports.View = View;
+//# sourceMappingURL=view.js.map

package/lib/cjs/decorators/view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../src/decorators/view.ts"],"names":[],"mappings":";;;AAAA,qCAAoC;AAEpC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,SAAgB,IAAI,CAAC,IAAY,EAAE,OAAgB;IACjD,OAAO,IAAA,eAAQ,EAAC,MAAM,EAAE,EAAC,IAAI,EAAE,OAAO,EAAC,CAAQ,CAAC;AAClD,CAAC;AAFD,oBAEC","sourcesContent":["import {StoreSet} from \"@tsed/core\";\n\n/**\n * Use a view and sends the rendered HTML string to the client. Optional parameter:\n *\n * * viewOptions, an object whose properties define local variables for the view.\n *\n * The view argument is a string that is the file path of the view file to render.\n * This can be an absolute path, or a path relative to the views setting.\n * If the path does not contain a file extension, then the view engine setting determines the file extension.\n * If the path does contain a file extension, then Express will load the module for the specified template engine (via require())\n * and render it using the loaded module’s __express function.\n *\n * For more information, see [Using template engines with Express](http://expressjs.com/guide/using-template-engines.html).\n *\n * > NOTE: The view argument performs file system operations like reading a file from disk and evaluating Node.js modules,\n * and as so for security reasons should not contain input from the end-user.\n *\n * @param path Relative path to the view file.\n * @param options Additional options\n * @decorator\n * @operation\n * @response\n */\nexport function View(path: string, options?: Object): MethodDecorator {\n  return StoreSet(\"view\", {path, options}) as any;\n}\n"]}

package/lib/{domain → cjs/domain}/PlatformViewsSettings.d.ts

@@ -54,6 +54,7 @@ export interface PlatformViewEngine {
     render(path: string, options: PlatformRenderOptions): Promise<string>;
 }
 export interface PlatformViewsSettings {
+    disabled?: boolean;
     /**
      * Views directory.
      */

package/lib/cjs/domain/PlatformViewsSettings.js

@@ -0,0 +1,47 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PLATFORM_VIEWS_EXTENSIONS = void 0;
+exports.PLATFORM_VIEWS_EXTENSIONS = {
+    atpl: "atpl",
+    bracket: "bracket",
+    dot: "dot",
+    dust: "dust",
+    ect: "ect",
+    ejs: "ejs",
+    haml: "haml",
+    "haml-coffee": "haml-coffee",
+    hamlet: "hamlet",
+    hbs: "handlebars",
+    handlebars: "handlebars",
+    hogan: "hogan",
+    htmling: "htmling",
+    jazz: "jazz",
+    jqtpl: "jqtpl",
+    just: "just",
+    kernel: "kernel",
+    liquid: "liquid",
+    liquor: "liquor",
+    lodash: "lodash",
+    mote: "mote",
+    mustache: "mustache",
+    nunjucks: "nunjucks",
+    plates: "plates",
+    pug: "pug",
+    qejs: "qejs",
+    ractive: "ractive",
+    razor: "razor",
+    jsx: "react",
+    slm: "slm",
+    squirelly: "squirelly",
+    swig: "swig",
+    teacup: "teacup",
+    templayed: "templayed",
+    toffee: "toffee",
+    twig: "twig",
+    underscore: "underscore",
+    vash: "vash",
+    velocityjs: "velocityjs",
+    walrus: "walrus",
+    whiskers: "whiskers"
+};
+//# sourceMappingURL=PlatformViewsSettings.js.map

package/lib/cjs/domain/PlatformViewsSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlatformViewsSettings.js","sourceRoot":"","sources":["../../../src/domain/PlatformViewsSettings.ts"],"names":[],"mappings":";;;AAEa,QAAA,yBAAyB,GAAG;IACvC,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;IAClB,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,aAAa,EAAE,aAAa;IAC5B,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,YAAY;IACjB,UAAU,EAAE,YAAY;IACxB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,OAAO;IACZ,GAAG,EAAE,KAAK;IACV,SAAS,EAAE,WAAW;IACtB,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,YAAY;IACxB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;CACrB,CAAC","sourcesContent":["import {BaseContext} from \"@tsed/di\";\n\nexport const PLATFORM_VIEWS_EXTENSIONS = {\n  atpl: \"atpl\",\n  bracket: \"bracket\",\n  dot: \"dot\",\n  dust: \"dust\",\n  ect: \"ect\",\n  ejs: \"ejs\",\n  haml: \"haml\",\n  \"haml-coffee\": \"haml-coffee\",\n  hamlet: \"hamlet\",\n  hbs: \"handlebars\",\n  handlebars: \"handlebars\",\n  hogan: \"hogan\",\n  htmling: \"htmling\",\n  jazz: \"jazz\",\n  jqtpl: \"jqtpl\",\n  just: \"just\",\n  kernel: \"kernel\",\n  liquid: \"liquid\",\n  liquor: \"liquor\",\n  lodash: \"lodash\",\n  mote: \"mote\",\n  mustache: \"mustache\",\n  nunjucks: \"nunjucks\",\n  plates: \"plates\",\n  pug: \"pug\",\n  qejs: \"qejs\",\n  ractive: \"ractive\",\n  razor: \"razor\",\n  jsx: \"react\",\n  slm: \"slm\",\n  squirelly: \"squirelly\",\n  swig: \"swig\",\n  teacup: \"teacup\",\n  templayed: \"templayed\",\n  toffee: \"toffee\",\n  twig: \"twig\",\n  underscore: \"underscore\",\n  vash: \"vash\",\n  velocityjs: \"velocityjs\",\n  walrus: \"walrus\",\n  whiskers: \"whiskers\"\n};\n\nexport type PlatformViewsExtensionsTypes = Record<string, string>;\n\nexport interface PlatformViewsEngineOptions extends Record<string, unknown> {\n  requires?: any;\n}\n\nexport interface PlatformRenderOptions extends Record<string, unknown> {\n  $ctx: BaseContext;\n}\n\nexport interface PlatformViewEngine {\n  options: PlatformViewsEngineOptions;\n\n  render(path: string, options: PlatformRenderOptions): Promise<string>;\n}\n\nexport interface PlatformViewsSettings {\n  disabled?: boolean;\n  /**\n   * Views directory.\n   */\n  root?: string;\n  /**\n   * Enable cache. Ts.ED enable cache in PRODUCTION profile by default.\n   */\n  cache?: boolean;\n  /**\n   * Provide extensions mapping to match the expected engines.\n   */\n  extensions?: Partial<PlatformViewsExtensionsTypes>;\n  /**\n   * Default view engine extension.\n   * Allow omitting extension when using View decorator or render method.\n   */\n  viewEngine?: string;\n  /**\n   * Options mapping for each engine.\n   */\n  options?: Record<string, PlatformViewsEngineOptions>;\n}\n\ndeclare global {\n  namespace TsED {\n    interface Configuration {\n      /**\n       * Object to configure Views engines with Consolidate. See more on [View engine](/docs/template-engine.md).\n       */\n      views: PlatformViewsSettings;\n    }\n  }\n}\n"]}

package/lib/{index.d.ts → cjs/index.d.ts}

@@ -1,5 +1,3 @@
 export * from "./decorators/view";
 export * from "./domain/PlatformViewsSettings";
 export * from "./services/PlatformViews";
-export * from "./errors/TemplateRenderError";
-export * from "./utils/renderView";

package/lib/cjs/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+(0, tslib_1.__exportStar)(require("./decorators/view"), exports);
+(0, tslib_1.__exportStar)(require("./domain/PlatformViewsSettings"), exports);
+(0, tslib_1.__exportStar)(require("./services/PlatformViews"), exports);
+//# sourceMappingURL=index.js.map

package/lib/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA,iEAAkC;AAClC,8EAA+C;AAC/C,wEAAyC","sourcesContent":["export * from \"./decorators/view\";\nexport * from \"./domain/PlatformViewsSettings\";\nexport * from \"./services/PlatformViews\";\n"]}

package/lib/{services → cjs/services}/PlatformViews.d.ts

@@ -8,6 +8,7 @@ export declare class PlatformViews {
     env: Env;
     readonly root: string;
     readonly cache: boolean;
+    readonly disabled: string;
     readonly viewEngine: string;
     protected extensionsOptions: PlatformViewsExtensionsTypes;
     protected engineOptions: Record<string, PlatformViewsEngineOptions>;

package/lib/cjs/services/PlatformViews.js

@@ -0,0 +1,166 @@
+"use strict";
+var _PlatformViews_extensions, _PlatformViews_engines, _PlatformViews_cachePaths;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PlatformViews = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@tsed/core");
+const di_1 = require("@tsed/di");
+const fs_1 = (0, tslib_1.__importDefault)(require("fs"));
+const path_1 = require("path");
+const PlatformViewsSettings_1 = require("../domain/PlatformViewsSettings");
+function patchEJS(ejs) {
+    return {
+        compile(str, { client, ...options }) {
+            return (ejs || require("ejs")).compile(str, options);
+        }
+    };
+}
+async function tryImport(name) {
+    try {
+        return await Promise.resolve().then(() => (0, tslib_1.__importStar)(require(name)));
+    }
+    catch (er) {
+        // istanbul ignore next
+    }
+}
+/**
+ * @platform
+ */
+let PlatformViews = class PlatformViews {
+    constructor() {
+        _PlatformViews_extensions.set(this, void 0);
+        _PlatformViews_engines.set(this, new Map());
+        _PlatformViews_cachePaths.set(this, new Map());
+    }
+    async $onInit() {
+        if (!this.disabled) {
+            (0, tslib_1.__classPrivateFieldSet)(this, _PlatformViews_extensions, new Map(Object.entries({
+                ...PlatformViewsSettings_1.PLATFORM_VIEWS_EXTENSIONS,
+                ...this.extensionsOptions
+            })), "f");
+            await this.loadFromConsolidate();
+            await this.loadFromTsedEngines();
+        }
+    }
+    /**
+     * @deprecated
+     */
+    async loadFromConsolidate() {
+        const cons = await tryImport("consolidate");
+        if (cons) {
+            cons.requires.ejs = patchEJS(cons.requires.ejs);
+            (0, tslib_1.__classPrivateFieldGet)(this, _PlatformViews_extensions, "f").forEach((engineType) => {
+                if (cons[engineType]) {
+                    const options = this.getEngineOptions(engineType);
+                    if (options.requires) {
+                        cons.requires[engineType] = options.requires;
+                    }
+                    this.registerEngine(engineType, {
+                        options,
+                        render: cons[engineType]
+                    });
+                }
+            });
+        }
+    }
+    async loadFromTsedEngines() {
+        const tsed = await tryImport("@tsed/engines");
+        if (tsed) {
+            tsed.requires.set("ejs", patchEJS(tsed.requires.get("ejs")));
+            (0, tslib_1.__classPrivateFieldGet)(this, _PlatformViews_extensions, "f").forEach((engineType) => {
+                if (tsed.engines.has(engineType)) {
+                    const options = this.getEngineOptions(engineType);
+                    if (options.requires) {
+                        tsed.requires.set(engineType, options.requires);
+                    }
+                    this.registerEngine(engineType, {
+                        options,
+                        render: tsed.getEngine(engineType)
+                    });
+                }
+            });
+        }
+    }
+    getEngines() {
+        return [...(0, tslib_1.__classPrivateFieldGet)(this, _PlatformViews_extensions, "f").entries()].map(([extension, engineType]) => {
+            const engine = this.getEngine(this.getExtension(engineType));
+            return {
+                extension,
+                engine
+            };
+        });
+    }
+    registerEngine(engineType, engine) {
+        (0, tslib_1.__classPrivateFieldGet)(this, _PlatformViews_engines, "f").set(engineType, engine);
+        return this;
+    }
+    getEngine(type) {
+        return (0, tslib_1.__classPrivateFieldGet)(this, _PlatformViews_engines, "f").get((0, tslib_1.__classPrivateFieldGet)(this, _PlatformViews_extensions, "f").get(type) || type);
+    }
+    getEngineOptions(engineType) {
+        return (0, core_1.getValue)(this.engineOptions, engineType, {});
+    }
+    async render(viewPath, options = {}) {
+        const { path, extension } = (0, tslib_1.__classPrivateFieldGet)(this, _PlatformViews_cachePaths, "f").get(viewPath) || (0, tslib_1.__classPrivateFieldGet)(this, _PlatformViews_cachePaths, "f").set(viewPath, this.resolve(viewPath)).get(viewPath);
+        const engine = this.getEngine(extension);
+        if (!engine) {
+            throw new Error(`Engine not found to render the following "${viewPath}"`);
+        }
+        return engine.render(path, Object.assign({ cache: this.cache || this.env === core_1.Env.PROD }, engine.options, options));
+    }
+    getExtension(viewPath) {
+        return ((0, path_1.extname)(viewPath) || this.viewEngine).replace(/\./, "");
+    }
+    resolve(viewPath) {
+        const extension = this.getExtension(viewPath);
+        viewPath = viewPath.replace((0, path_1.extname)(viewPath), "") + "." + extension;
+        const path = [
+            viewPath,
+            (0, path_1.resolve)((0, path_1.join)(this.root, viewPath)),
+            (0, path_1.resolve)((0, path_1.join)(process.cwd(), "views", viewPath)),
+            (0, path_1.resolve)((0, path_1.join)(process.cwd(), "public", viewPath))
+        ].find((file) => fs_1.default.existsSync(file)) || viewPath;
+        return {
+            path,
+            extension
+        };
+    }
+};
+_PlatformViews_extensions = new WeakMap(), _PlatformViews_engines = new WeakMap(), _PlatformViews_cachePaths = new WeakMap();
+(0, tslib_1.__decorate)([
+    (0, di_1.Constant)("env"),
+    (0, tslib_1.__metadata)("design:type", String)
+], PlatformViews.prototype, "env", void 0);
+(0, tslib_1.__decorate)([
+    (0, di_1.Constant)("views.root", `${process.cwd()}/views`),
+    (0, tslib_1.__metadata)("design:type", String)
+], PlatformViews.prototype, "root", void 0);
+(0, tslib_1.__decorate)([
+    (0, di_1.Constant)("views.cache"),
+    (0, tslib_1.__metadata)("design:type", Boolean)
+], PlatformViews.prototype, "cache", void 0);
+(0, tslib_1.__decorate)([
+    (0, di_1.Constant)("views.disabled", false),
+    (0, tslib_1.__metadata)("design:type", String)
+], PlatformViews.prototype, "disabled", void 0);
+(0, tslib_1.__decorate)([
+    (0, di_1.Constant)("views.viewEngine", "ejs"),
+    (0, tslib_1.__metadata)("design:type", String)
+], PlatformViews.prototype, "viewEngine", void 0);
+(0, tslib_1.__decorate)([
+    (0, di_1.Constant)("views.extensions", {}),
+    (0, tslib_1.__metadata)("design:type", Object)
+], PlatformViews.prototype, "extensionsOptions", void 0);
+(0, tslib_1.__decorate)([
+    (0, di_1.Constant)("views.options", {}),
+    (0, tslib_1.__metadata)("design:type", Object)
+], PlatformViews.prototype, "engineOptions", void 0);
+PlatformViews = (0, tslib_1.__decorate)([
+    (0, di_1.Module)({
+        views: {
+            exists: true
+        }
+    })
+], PlatformViews);
+exports.PlatformViews = PlatformViews;
+//# sourceMappingURL=PlatformViews.js.map

package/lib/cjs/services/PlatformViews.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlatformViews.js","sourceRoot":"","sources":["../../../src/services/PlatformViews.ts"],"names":[],"mappings":";;;;;AAAA,qCAAyC;AACzC,iCAA0C;AAC1C,yDAAoB;AACpB,+BAA4C;AAC5C,2EAKyC;AAEzC,SAAS,QAAQ,CAAC,GAAQ;IACxB,OAAO;QACL,OAAO,CAAC,GAAW,EAAE,EAAC,MAAM,EAAE,GAAG,OAAO,EAAM;YAC5C,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACvD,CAAC;KACF,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,IAAY;IACnC,IAAI;QACF,OAAO,qEAAa,IAAI,GAAC,CAAC;KAC3B;IAAC,OAAO,EAAE,EAAE;QACX,uBAAuB;KACxB;AACH,CAAC;AAED;;GAEG;AAMH,IAAa,aAAa,GAA1B,MAAa,aAAa;IAA1B;QAsBE,4CAAiC;QACjC,iCAAW,IAAI,GAAG,EAA8B,EAAC;QACjD,oCAAc,IAAI,GAAG,EAA6C,EAAC;IA0HrE,CAAC;IAxHC,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,oCAAA,IAAI,6BAAe,IAAI,GAAG,CACxB,MAAM,CAAC,OAAO,CAAC;gBACb,GAAG,iDAAyB;gBAC5B,GAAG,IAAI,CAAC,iBAAiB;aAC1B,CAAC,CACH,MAAA,CAAC;YAEF,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACjC,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;SAClC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB;QACvB,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,aAAa,CAAC,CAAC;QAC5C,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAEhD,oCAAA,IAAI,iCAAY,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACtC,IAAK,IAAY,CAAC,UAAU,CAAC,EAAE;oBAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;oBAElD,IAAI,OAAO,CAAC,QAAQ,EAAE;wBACnB,IAAI,CAAC,QAAgB,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;qBACvD;oBAED,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE;wBAC9B,OAAO;wBACP,MAAM,EAAG,IAAY,CAAC,UAAU,CAAC;qBAClC,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED,KAAK,CAAC,mBAAmB;QACvB,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,eAAe,CAAC,CAAC;QAE9C,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAE7D,oCAAA,IAAI,iCAAY,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACtC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;oBAChC,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;oBAElD,IAAI,OAAO,CAAC,QAAQ,EAAE;wBACpB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;qBACjD;oBAED,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE;wBAC9B,OAAO;wBACP,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;qBACnC,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED,UAAU;QACR,OAAO,CAAC,GAAG,oCAAA,IAAI,iCAAY,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,EAAE;YACrE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAE,CAAC;YAE9D,OAAO;gBACL,SAAS;gBACT,MAAM;aACP,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,cAAc,CAAC,UAAkB,EAAE,MAA0B;QAC3D,oCAAA,IAAI,8BAAS,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAEtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,IAAY;QACpB,OAAO,oCAAA,IAAI,8BAAS,CAAC,GAAG,CAAC,oCAAA,IAAI,iCAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED,gBAAgB,CAAC,UAAkB;QACjC,OAAO,IAAA,eAAQ,EAAC,IAAI,CAAC,aAAa,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,UAAe,EAAE;QAC9C,MAAM,EAAC,IAAI,EAAE,SAAS,EAAC,GAAG,oCAAA,IAAI,iCAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,oCAAA,IAAI,iCAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;QAClI,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAEzC,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,6CAA6C,QAAQ,GAAG,CAAC,CAAC;SAC3E;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,EAAC,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,KAAK,UAAG,CAAC,IAAI,EAAC,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IACnH,CAAC;IAES,YAAY,CAAC,QAAgB;QACrC,OAAO,CAAC,IAAA,cAAO,EAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IAES,OAAO,CAAC,QAAgB;QAChC,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAE9C,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAA,cAAO,EAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,SAAS,CAAC;QAErE,MAAM,IAAI,GACR;YACE,QAAQ;YACR,IAAA,cAAO,EAAC,IAAA,WAAI,EAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAClC,IAAA,cAAO,EAAC,IAAA,WAAI,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC/C,IAAA,cAAO,EAAC,IAAA,WAAI,EAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;SACjD,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,QAAQ,CAAC;QAEpD,OAAO;YACL,IAAI;YACJ,SAAS;SACV,CAAC;IACJ,CAAC;CACF,CAAA;;AAhJC;IADC,IAAA,aAAQ,EAAC,KAAK,CAAC;;0CACP;AAGT;IADC,IAAA,aAAQ,EAAC,YAAY,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC;;2CAC3B;AAGtB;IADC,IAAA,aAAQ,EAAC,aAAa,CAAC;;4CACA;AAGxB;IADC,IAAA,aAAQ,EAAC,gBAAgB,EAAE,KAAK,CAAC;;+CACR;AAG1B;IADC,IAAA,aAAQ,EAAC,kBAAkB,EAAE,KAAK,CAAC;;iDACR;AAG5B;IADC,IAAA,aAAQ,EAAC,kBAAkB,EAAE,EAAE,CAAC;;wDACyB;AAG1D;IADC,IAAA,aAAQ,EAAC,eAAe,EAAE,EAAE,CAAC;;oDACsC;AApBzD,aAAa;IALzB,IAAA,WAAM,EAAC;QACN,KAAK,EAAE;YACL,MAAM,EAAE,IAAI;SACb;KACF,CAAC;GACW,aAAa,CAkJzB;AAlJY,sCAAa","sourcesContent":["import {Env, getValue} from \"@tsed/core\";\nimport {Constant, Module} from \"@tsed/di\";\nimport Fs from \"fs\";\nimport {extname, join, resolve} from \"path\";\nimport {\n  PLATFORM_VIEWS_EXTENSIONS,\n  PlatformViewEngine,\n  PlatformViewsEngineOptions,\n  PlatformViewsExtensionsTypes\n} from \"../domain/PlatformViewsSettings\";\n\nfunction patchEJS(ejs: any) {\n  return {\n    compile(str: string, {client, ...options}: any) {\n      return (ejs || require(\"ejs\")).compile(str, options);\n    }\n  };\n}\n\nasync function tryImport(name: string) {\n  try {\n    return await import(name);\n  } catch (er) {\n    // istanbul ignore next\n  }\n}\n\n/**\n * @platform\n */\n@Module({\n  views: {\n    exists: true\n  }\n})\nexport class PlatformViews {\n  @Constant(\"env\")\n  env: Env;\n\n  @Constant(\"views.root\", `${process.cwd()}/views`)\n  readonly root: string;\n\n  @Constant(\"views.cache\")\n  readonly cache: boolean;\n\n  @Constant(\"views.disabled\", false)\n  readonly disabled: string;\n\n  @Constant(\"views.viewEngine\", \"ejs\")\n  readonly viewEngine: string;\n\n  @Constant(\"views.extensions\", {})\n  protected extensionsOptions: PlatformViewsExtensionsTypes;\n\n  @Constant(\"views.options\", {})\n  protected engineOptions: Record<string, PlatformViewsEngineOptions>;\n\n  #extensions: Map<string, string>;\n  #engines = new Map<string, PlatformViewEngine>();\n  #cachePaths = new Map<string, {path: string; extension: string}>();\n\n  async $onInit() {\n    if (!this.disabled) {\n      this.#extensions = new Map(\n        Object.entries({\n          ...PLATFORM_VIEWS_EXTENSIONS,\n          ...this.extensionsOptions\n        })\n      );\n\n      await this.loadFromConsolidate();\n      await this.loadFromTsedEngines();\n    }\n  }\n\n  /**\n   * @deprecated\n   */\n  async loadFromConsolidate() {\n    const cons = await tryImport(\"consolidate\");\n    if (cons) {\n      cons.requires.ejs = patchEJS(cons.requires.ejs);\n\n      this.#extensions.forEach((engineType) => {\n        if ((cons as any)[engineType]) {\n          const options = this.getEngineOptions(engineType);\n\n          if (options.requires) {\n            (cons.requires as any)[engineType] = options.requires;\n          }\n\n          this.registerEngine(engineType, {\n            options,\n            render: (cons as any)[engineType]\n          });\n        }\n      });\n    }\n  }\n\n  async loadFromTsedEngines() {\n    const tsed = await tryImport(\"@tsed/engines\");\n\n    if (tsed) {\n      tsed.requires.set(\"ejs\", patchEJS(tsed.requires.get(\"ejs\")));\n\n      this.#extensions.forEach((engineType) => {\n        if (tsed.engines.has(engineType)) {\n          const options = this.getEngineOptions(engineType);\n\n          if (options.requires) {\n            tsed.requires.set(engineType, options.requires);\n          }\n\n          this.registerEngine(engineType, {\n            options,\n            render: tsed.getEngine(engineType)\n          });\n        }\n      });\n    }\n  }\n\n  getEngines() {\n    return [...this.#extensions.entries()].map(([extension, engineType]) => {\n      const engine = this.getEngine(this.getExtension(engineType))!;\n\n      return {\n        extension,\n        engine\n      };\n    });\n  }\n\n  registerEngine(engineType: string, engine: PlatformViewEngine) {\n    this.#engines.set(engineType, engine);\n\n    return this;\n  }\n\n  getEngine(type: string) {\n    return this.#engines.get(this.#extensions.get(type) || type);\n  }\n\n  getEngineOptions(engineType: string): PlatformViewsEngineOptions {\n    return getValue(this.engineOptions, engineType, {});\n  }\n\n  async render(viewPath: string, options: any = {}): Promise<string> {\n    const {path, extension} = this.#cachePaths.get(viewPath) || this.#cachePaths.set(viewPath, this.resolve(viewPath)).get(viewPath)!;\n    const engine = this.getEngine(extension);\n\n    if (!engine) {\n      throw new Error(`Engine not found to render the following \"${viewPath}\"`);\n    }\n\n    return engine.render(path, Object.assign({cache: this.cache || this.env === Env.PROD}, engine.options, options));\n  }\n\n  protected getExtension(viewPath: string) {\n    return (extname(viewPath) || this.viewEngine).replace(/\\./, \"\");\n  }\n\n  protected resolve(viewPath: string) {\n    const extension = this.getExtension(viewPath);\n\n    viewPath = viewPath.replace(extname(viewPath), \"\") + \".\" + extension;\n\n    const path =\n      [\n        viewPath,\n        resolve(join(this.root, viewPath)),\n        resolve(join(process.cwd(), \"views\", viewPath)),\n        resolve(join(process.cwd(), \"public\", viewPath))\n      ].find((file) => Fs.existsSync(file)) || viewPath;\n\n    return {\n      path,\n      extension\n    };\n  }\n}\n"]}

package/lib/esm/decorators/view.js

@@ -0,0 +1,27 @@
+import { StoreSet } from "@tsed/core";
+/**
+ * Use a view and sends the rendered HTML string to the client. Optional parameter:
+ *
+ * * viewOptions, an object whose properties define local variables for the view.
+ *
+ * The view argument is a string that is the file path of the view file to render.
+ * This can be an absolute path, or a path relative to the views setting.
+ * If the path does not contain a file extension, then the view engine setting determines the file extension.
+ * If the path does contain a file extension, then Express will load the module for the specified template engine (via require())
+ * and render it using the loaded module’s __express function.
+ *
+ * For more information, see [Using template engines with Express](http://expressjs.com/guide/using-template-engines.html).
+ *
+ * > NOTE: The view argument performs file system operations like reading a file from disk and evaluating Node.js modules,
+ * and as so for security reasons should not contain input from the end-user.
+ *
+ * @param path Relative path to the view file.
+ * @param options Additional options
+ * @decorator
+ * @operation
+ * @response
+ */
+export function View(path, options) {
+    return StoreSet("view", { path, options });
+}
+//# sourceMappingURL=view.js.map

package/lib/esm/decorators/view.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"view.js","sourceRoot":"","sources":["../../../src/decorators/view.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,QAAQ,EAAC,MAAM,YAAY,CAAC;AAEpC;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,UAAU,IAAI,CAAC,IAAY,EAAE,OAAgB;IACjD,OAAO,QAAQ,CAAC,MAAM,EAAE,EAAC,IAAI,EAAE,OAAO,EAAC,CAAQ,CAAC;AAClD,CAAC","sourcesContent":["import {StoreSet} from \"@tsed/core\";\n\n/**\n * Use a view and sends the rendered HTML string to the client. Optional parameter:\n *\n * * viewOptions, an object whose properties define local variables for the view.\n *\n * The view argument is a string that is the file path of the view file to render.\n * This can be an absolute path, or a path relative to the views setting.\n * If the path does not contain a file extension, then the view engine setting determines the file extension.\n * If the path does contain a file extension, then Express will load the module for the specified template engine (via require())\n * and render it using the loaded module’s __express function.\n *\n * For more information, see [Using template engines with Express](http://expressjs.com/guide/using-template-engines.html).\n *\n * > NOTE: The view argument performs file system operations like reading a file from disk and evaluating Node.js modules,\n * and as so for security reasons should not contain input from the end-user.\n *\n * @param path Relative path to the view file.\n * @param options Additional options\n * @decorator\n * @operation\n * @response\n */\nexport function View(path: string, options?: Object): MethodDecorator {\n  return StoreSet(\"view\", {path, options}) as any;\n}\n"]}

package/lib/esm/domain/PlatformViewsSettings.js

@@ -0,0 +1,44 @@
+export const PLATFORM_VIEWS_EXTENSIONS = {
+    atpl: "atpl",
+    bracket: "bracket",
+    dot: "dot",
+    dust: "dust",
+    ect: "ect",
+    ejs: "ejs",
+    haml: "haml",
+    "haml-coffee": "haml-coffee",
+    hamlet: "hamlet",
+    hbs: "handlebars",
+    handlebars: "handlebars",
+    hogan: "hogan",
+    htmling: "htmling",
+    jazz: "jazz",
+    jqtpl: "jqtpl",
+    just: "just",
+    kernel: "kernel",
+    liquid: "liquid",
+    liquor: "liquor",
+    lodash: "lodash",
+    mote: "mote",
+    mustache: "mustache",
+    nunjucks: "nunjucks",
+    plates: "plates",
+    pug: "pug",
+    qejs: "qejs",
+    ractive: "ractive",
+    razor: "razor",
+    jsx: "react",
+    slm: "slm",
+    squirelly: "squirelly",
+    swig: "swig",
+    teacup: "teacup",
+    templayed: "templayed",
+    toffee: "toffee",
+    twig: "twig",
+    underscore: "underscore",
+    vash: "vash",
+    velocityjs: "velocityjs",
+    walrus: "walrus",
+    whiskers: "whiskers"
+};
+//# sourceMappingURL=PlatformViewsSettings.js.map

package/lib/esm/domain/PlatformViewsSettings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlatformViewsSettings.js","sourceRoot":"","sources":["../../../src/domain/PlatformViewsSettings.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,yBAAyB,GAAG;IACvC,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;IAClB,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,KAAK;IACV,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,aAAa,EAAE,aAAa;IAC5B,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,YAAY;IACjB,UAAU,EAAE,YAAY;IACxB,KAAK,EAAE,OAAO;IACd,OAAO,EAAE,SAAS;IAClB,IAAI,EAAE,MAAM;IACZ,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,QAAQ,EAAE,UAAU;IACpB,QAAQ,EAAE,UAAU;IACpB,MAAM,EAAE,QAAQ;IAChB,GAAG,EAAE,KAAK;IACV,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,SAAS;IAClB,KAAK,EAAE,OAAO;IACd,GAAG,EAAE,OAAO;IACZ,GAAG,EAAE,KAAK;IACV,SAAS,EAAE,WAAW;IACtB,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,QAAQ;IAChB,SAAS,EAAE,WAAW;IACtB,MAAM,EAAE,QAAQ;IAChB,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,YAAY;IACxB,IAAI,EAAE,MAAM;IACZ,UAAU,EAAE,YAAY;IACxB,MAAM,EAAE,QAAQ;IAChB,QAAQ,EAAE,UAAU;CACrB,CAAC","sourcesContent":["import {BaseContext} from \"@tsed/di\";\n\nexport const PLATFORM_VIEWS_EXTENSIONS = {\n  atpl: \"atpl\",\n  bracket: \"bracket\",\n  dot: \"dot\",\n  dust: \"dust\",\n  ect: \"ect\",\n  ejs: \"ejs\",\n  haml: \"haml\",\n  \"haml-coffee\": \"haml-coffee\",\n  hamlet: \"hamlet\",\n  hbs: \"handlebars\",\n  handlebars: \"handlebars\",\n  hogan: \"hogan\",\n  htmling: \"htmling\",\n  jazz: \"jazz\",\n  jqtpl: \"jqtpl\",\n  just: \"just\",\n  kernel: \"kernel\",\n  liquid: \"liquid\",\n  liquor: \"liquor\",\n  lodash: \"lodash\",\n  mote: \"mote\",\n  mustache: \"mustache\",\n  nunjucks: \"nunjucks\",\n  plates: \"plates\",\n  pug: \"pug\",\n  qejs: \"qejs\",\n  ractive: \"ractive\",\n  razor: \"razor\",\n  jsx: \"react\",\n  slm: \"slm\",\n  squirelly: \"squirelly\",\n  swig: \"swig\",\n  teacup: \"teacup\",\n  templayed: \"templayed\",\n  toffee: \"toffee\",\n  twig: \"twig\",\n  underscore: \"underscore\",\n  vash: \"vash\",\n  velocityjs: \"velocityjs\",\n  walrus: \"walrus\",\n  whiskers: \"whiskers\"\n};\n\nexport type PlatformViewsExtensionsTypes = Record<string, string>;\n\nexport interface PlatformViewsEngineOptions extends Record<string, unknown> {\n  requires?: any;\n}\n\nexport interface PlatformRenderOptions extends Record<string, unknown> {\n  $ctx: BaseContext;\n}\n\nexport interface PlatformViewEngine {\n  options: PlatformViewsEngineOptions;\n\n  render(path: string, options: PlatformRenderOptions): Promise<string>;\n}\n\nexport interface PlatformViewsSettings {\n  disabled?: boolean;\n  /**\n   * Views directory.\n   */\n  root?: string;\n  /**\n   * Enable cache. Ts.ED enable cache in PRODUCTION profile by default.\n   */\n  cache?: boolean;\n  /**\n   * Provide extensions mapping to match the expected engines.\n   */\n  extensions?: Partial<PlatformViewsExtensionsTypes>;\n  /**\n   * Default view engine extension.\n   * Allow omitting extension when using View decorator or render method.\n   */\n  viewEngine?: string;\n  /**\n   * Options mapping for each engine.\n   */\n  options?: Record<string, PlatformViewsEngineOptions>;\n}\n\ndeclare global {\n  namespace TsED {\n    interface Configuration {\n      /**\n       * Object to configure Views engines with Consolidate. See more on [View engine](/docs/template-engine.md).\n       */\n      views: PlatformViewsSettings;\n    }\n  }\n}\n"]}

package/lib/esm/index.js

@@ -0,0 +1,4 @@
+export * from "./decorators/view";
+export * from "./domain/PlatformViewsSettings";
+export * from "./services/PlatformViews";
+//# sourceMappingURL=index.js.map

package/lib/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,gCAAgC,CAAC;AAC/C,cAAc,0BAA0B,CAAC","sourcesContent":["export * from \"./decorators/view\";\nexport * from \"./domain/PlatformViewsSettings\";\nexport * from \"./services/PlatformViews\";\n"]}

package/lib/esm/services/PlatformViews.js

@@ -0,0 +1,163 @@
+var _PlatformViews_extensions, _PlatformViews_engines, _PlatformViews_cachePaths;
+import { __classPrivateFieldGet, __classPrivateFieldSet, __decorate, __metadata } from "tslib";
+import { Env, getValue } from "@tsed/core";
+import { Constant, Module } from "@tsed/di";
+import Fs from "fs";
+import { extname, join, resolve } from "path";
+import { PLATFORM_VIEWS_EXTENSIONS } from "../domain/PlatformViewsSettings";
+function patchEJS(ejs) {
+    return {
+        compile(str, { client, ...options }) {
+            return (ejs || require("ejs")).compile(str, options);
+        }
+    };
+}
+async function tryImport(name) {
+    try {
+        return await import(name);
+    }
+    catch (er) {
+        // istanbul ignore next
+    }
+}
+/**
+ * @platform
+ */
+let PlatformViews = class PlatformViews {
+    constructor() {
+        _PlatformViews_extensions.set(this, void 0);
+        _PlatformViews_engines.set(this, new Map());
+        _PlatformViews_cachePaths.set(this, new Map());
+    }
+    async $onInit() {
+        if (!this.disabled) {
+            __classPrivateFieldSet(this, _PlatformViews_extensions, new Map(Object.entries({
+                ...PLATFORM_VIEWS_EXTENSIONS,
+                ...this.extensionsOptions
+            })), "f");
+            await this.loadFromConsolidate();
+            await this.loadFromTsedEngines();
+        }
+    }
+    /**
+     * @deprecated
+     */
+    async loadFromConsolidate() {
+        const cons = await tryImport("consolidate");
+        if (cons) {
+            cons.requires.ejs = patchEJS(cons.requires.ejs);
+            __classPrivateFieldGet(this, _PlatformViews_extensions, "f").forEach((engineType) => {
+                if (cons[engineType]) {
+                    const options = this.getEngineOptions(engineType);
+                    if (options.requires) {
+                        cons.requires[engineType] = options.requires;
+                    }
+                    this.registerEngine(engineType, {
+                        options,
+                        render: cons[engineType]
+                    });
+                }
+            });
+        }
+    }
+    async loadFromTsedEngines() {
+        const tsed = await tryImport("@tsed/engines");
+        if (tsed) {
+            tsed.requires.set("ejs", patchEJS(tsed.requires.get("ejs")));
+            __classPrivateFieldGet(this, _PlatformViews_extensions, "f").forEach((engineType) => {
+                if (tsed.engines.has(engineType)) {
+                    const options = this.getEngineOptions(engineType);
+                    if (options.requires) {
+                        tsed.requires.set(engineType, options.requires);
+                    }
+                    this.registerEngine(engineType, {
+                        options,
+                        render: tsed.getEngine(engineType)
+                    });
+                }
+            });
+        }
+    }
+    getEngines() {
+        return [...__classPrivateFieldGet(this, _PlatformViews_extensions, "f").entries()].map(([extension, engineType]) => {
+            const engine = this.getEngine(this.getExtension(engineType));
+            return {
+                extension,
+                engine
+            };
+        });
+    }
+    registerEngine(engineType, engine) {
+        __classPrivateFieldGet(this, _PlatformViews_engines, "f").set(engineType, engine);
+        return this;
+    }
+    getEngine(type) {
+        return __classPrivateFieldGet(this, _PlatformViews_engines, "f").get(__classPrivateFieldGet(this, _PlatformViews_extensions, "f").get(type) || type);
+    }
+    getEngineOptions(engineType) {
+        return getValue(this.engineOptions, engineType, {});
+    }
+    async render(viewPath, options = {}) {
+        const { path, extension } = __classPrivateFieldGet(this, _PlatformViews_cachePaths, "f").get(viewPath) || __classPrivateFieldGet(this, _PlatformViews_cachePaths, "f").set(viewPath, this.resolve(viewPath)).get(viewPath);
+        const engine = this.getEngine(extension);
+        if (!engine) {
+            throw new Error(`Engine not found to render the following "${viewPath}"`);
+        }
+        return engine.render(path, Object.assign({ cache: this.cache || this.env === Env.PROD }, engine.options, options));
+    }
+    getExtension(viewPath) {
+        return (extname(viewPath) || this.viewEngine).replace(/\./, "");
+    }
+    resolve(viewPath) {
+        const extension = this.getExtension(viewPath);
+        viewPath = viewPath.replace(extname(viewPath), "") + "." + extension;
+        const path = [
+            viewPath,
+            resolve(join(this.root, viewPath)),
+            resolve(join(process.cwd(), "views", viewPath)),
+            resolve(join(process.cwd(), "public", viewPath))
+        ].find((file) => Fs.existsSync(file)) || viewPath;
+        return {
+            path,
+            extension
+        };
+    }
+};
+_PlatformViews_extensions = new WeakMap(), _PlatformViews_engines = new WeakMap(), _PlatformViews_cachePaths = new WeakMap();
+__decorate([
+    Constant("env"),
+    __metadata("design:type", String)
+], PlatformViews.prototype, "env", void 0);
+__decorate([
+    Constant("views.root", `${process.cwd()}/views`),
+    __metadata("design:type", String)
+], PlatformViews.prototype, "root", void 0);
+__decorate([
+    Constant("views.cache"),
+    __metadata("design:type", Boolean)
+], PlatformViews.prototype, "cache", void 0);
+__decorate([
+    Constant("views.disabled", false),
+    __metadata("design:type", String)
+], PlatformViews.prototype, "disabled", void 0);
+__decorate([
+    Constant("views.viewEngine", "ejs"),
+    __metadata("design:type", String)
+], PlatformViews.prototype, "viewEngine", void 0);
+__decorate([
+    Constant("views.extensions", {}),
+    __metadata("design:type", Object)
+], PlatformViews.prototype, "extensionsOptions", void 0);
+__decorate([
+    Constant("views.options", {}),
+    __metadata("design:type", Object)
+], PlatformViews.prototype, "engineOptions", void 0);
+PlatformViews = __decorate([
+    Module({
+        views: {
+            exists: true
+        }
+    })
+], PlatformViews);
+export { PlatformViews };
+//# sourceMappingURL=PlatformViews.js.map

package/lib/esm/services/PlatformViews.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PlatformViews.js","sourceRoot":"","sources":["../../../src/services/PlatformViews.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAC,GAAG,EAAE,QAAQ,EAAC,MAAM,YAAY,CAAC;AACzC,OAAO,EAAC,QAAQ,EAAE,MAAM,EAAC,MAAM,UAAU,CAAC;AAC1C,OAAO,EAAE,MAAM,IAAI,CAAC;AACpB,OAAO,EAAC,OAAO,EAAE,IAAI,EAAE,OAAO,EAAC,MAAM,MAAM,CAAC;AAC5C,OAAO,EACL,yBAAyB,EAI1B,MAAM,iCAAiC,CAAC;AAEzC,SAAS,QAAQ,CAAC,GAAQ;IACxB,OAAO;QACL,OAAO,CAAC,GAAW,EAAE,EAAC,MAAM,EAAE,GAAG,OAAO,EAAM;YAC5C,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACvD,CAAC;KACF,CAAC;AACJ,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,IAAY;IACnC,IAAI;QACF,OAAO,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC;KAC3B;IAAC,OAAO,EAAE,EAAE;QACX,uBAAuB;KACxB;AACH,CAAC;AAED;;GAEG;AAMH,IAAa,aAAa,GAA1B,MAAa,aAAa;IAA1B;QAsBE,4CAAiC;QACjC,iCAAW,IAAI,GAAG,EAA8B,EAAC;QACjD,oCAAc,IAAI,GAAG,EAA6C,EAAC;IA0HrE,CAAC;IAxHC,KAAK,CAAC,OAAO;QACX,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE;YAClB,uBAAA,IAAI,6BAAe,IAAI,GAAG,CACxB,MAAM,CAAC,OAAO,CAAC;gBACb,GAAG,yBAAyB;gBAC5B,GAAG,IAAI,CAAC,iBAAiB;aAC1B,CAAC,CACH,MAAA,CAAC;YAEF,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;YACjC,MAAM,IAAI,CAAC,mBAAmB,EAAE,CAAC;SAClC;IACH,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,mBAAmB;QACvB,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,aAAa,CAAC,CAAC;QAC5C,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,QAAQ,CAAC,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YAEhD,uBAAA,IAAI,iCAAY,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACtC,IAAK,IAAY,CAAC,UAAU,CAAC,EAAE;oBAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;oBAElD,IAAI,OAAO,CAAC,QAAQ,EAAE;wBACnB,IAAI,CAAC,QAAgB,CAAC,UAAU,CAAC,GAAG,OAAO,CAAC,QAAQ,CAAC;qBACvD;oBAED,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE;wBAC9B,OAAO;wBACP,MAAM,EAAG,IAAY,CAAC,UAAU,CAAC;qBAClC,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED,KAAK,CAAC,mBAAmB;QACvB,MAAM,IAAI,GAAG,MAAM,SAAS,CAAC,eAAe,CAAC,CAAC;QAE9C,IAAI,IAAI,EAAE;YACR,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;YAE7D,uBAAA,IAAI,iCAAY,CAAC,OAAO,CAAC,CAAC,UAAU,EAAE,EAAE;gBACtC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;oBAChC,MAAM,OAAO,GAAG,IAAI,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC;oBAElD,IAAI,OAAO,CAAC,QAAQ,EAAE;wBACpB,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;qBACjD;oBAED,IAAI,CAAC,cAAc,CAAC,UAAU,EAAE;wBAC9B,OAAO;wBACP,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,UAAU,CAAC;qBACnC,CAAC,CAAC;iBACJ;YACH,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED,UAAU;QACR,OAAO,CAAC,GAAG,uBAAA,IAAI,iCAAY,CAAC,OAAO,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,SAAS,EAAE,UAAU,CAAC,EAAE,EAAE;YACrE,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,CAAE,CAAC;YAE9D,OAAO;gBACL,SAAS;gBACT,MAAM;aACP,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC;IAED,cAAc,CAAC,UAAkB,EAAE,MAA0B;QAC3D,uBAAA,IAAI,8BAAS,CAAC,GAAG,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QAEtC,OAAO,IAAI,CAAC;IACd,CAAC;IAED,SAAS,CAAC,IAAY;QACpB,OAAO,uBAAA,IAAI,8BAAS,CAAC,GAAG,CAAC,uBAAA,IAAI,iCAAY,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,CAAC;IAC/D,CAAC;IAED,gBAAgB,CAAC,UAAkB;QACjC,OAAO,QAAQ,CAAC,IAAI,CAAC,aAAa,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;IACtD,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,QAAgB,EAAE,UAAe,EAAE;QAC9C,MAAM,EAAC,IAAI,EAAE,SAAS,EAAC,GAAG,uBAAA,IAAI,iCAAY,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,uBAAA,IAAI,iCAAY,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;QAClI,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;QAEzC,IAAI,CAAC,MAAM,EAAE;YACX,MAAM,IAAI,KAAK,CAAC,6CAA6C,QAAQ,GAAG,CAAC,CAAC;SAC3E;QAED,OAAO,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,EAAC,KAAK,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,KAAK,GAAG,CAAC,IAAI,EAAC,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC;IACnH,CAAC;IAES,YAAY,CAAC,QAAgB;QACrC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAClE,CAAC;IAES,OAAO,CAAC,QAAgB;QAChC,MAAM,SAAS,GAAG,IAAI,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC;QAE9C,QAAQ,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,GAAG,GAAG,GAAG,SAAS,CAAC;QAErE,MAAM,IAAI,GACR;YACE,QAAQ;YACR,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;YAClC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC/C,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;SACjD,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,QAAQ,CAAC;QAEpD,OAAO;YACL,IAAI;YACJ,SAAS;SACV,CAAC;IACJ,CAAC;CACF,CAAA;;AAhJC;IADC,QAAQ,CAAC,KAAK,CAAC;;0CACP;AAGT;IADC,QAAQ,CAAC,YAAY,EAAE,GAAG,OAAO,CAAC,GAAG,EAAE,QAAQ,CAAC;;2CAC3B;AAGtB;IADC,QAAQ,CAAC,aAAa,CAAC;;4CACA;AAGxB;IADC,QAAQ,CAAC,gBAAgB,EAAE,KAAK,CAAC;;+CACR;AAG1B;IADC,QAAQ,CAAC,kBAAkB,EAAE,KAAK,CAAC;;iDACR;AAG5B;IADC,QAAQ,CAAC,kBAAkB,EAAE,EAAE,CAAC;;wDACyB;AAG1D;IADC,QAAQ,CAAC,eAAe,EAAE,EAAE,CAAC;;oDACsC;AApBzD,aAAa;IALzB,MAAM,CAAC;QACN,KAAK,EAAE;YACL,MAAM,EAAE,IAAI;SACb;KACF,CAAC;GACW,aAAa,CAkJzB;SAlJY,aAAa","sourcesContent":["import {Env, getValue} from \"@tsed/core\";\nimport {Constant, Module} from \"@tsed/di\";\nimport Fs from \"fs\";\nimport {extname, join, resolve} from \"path\";\nimport {\n  PLATFORM_VIEWS_EXTENSIONS,\n  PlatformViewEngine,\n  PlatformViewsEngineOptions,\n  PlatformViewsExtensionsTypes\n} from \"../domain/PlatformViewsSettings\";\n\nfunction patchEJS(ejs: any) {\n  return {\n    compile(str: string, {client, ...options}: any) {\n      return (ejs || require(\"ejs\")).compile(str, options);\n    }\n  };\n}\n\nasync function tryImport(name: string) {\n  try {\n    return await import(name);\n  } catch (er) {\n    // istanbul ignore next\n  }\n}\n\n/**\n * @platform\n */\n@Module({\n  views: {\n    exists: true\n  }\n})\nexport class PlatformViews {\n  @Constant(\"env\")\n  env: Env;\n\n  @Constant(\"views.root\", `${process.cwd()}/views`)\n  readonly root: string;\n\n  @Constant(\"views.cache\")\n  readonly cache: boolean;\n\n  @Constant(\"views.disabled\", false)\n  readonly disabled: string;\n\n  @Constant(\"views.viewEngine\", \"ejs\")\n  readonly viewEngine: string;\n\n  @Constant(\"views.extensions\", {})\n  protected extensionsOptions: PlatformViewsExtensionsTypes;\n\n  @Constant(\"views.options\", {})\n  protected engineOptions: Record<string, PlatformViewsEngineOptions>;\n\n  #extensions: Map<string, string>;\n  #engines = new Map<string, PlatformViewEngine>();\n  #cachePaths = new Map<string, {path: string; extension: string}>();\n\n  async $onInit() {\n    if (!this.disabled) {\n      this.#extensions = new Map(\n        Object.entries({\n          ...PLATFORM_VIEWS_EXTENSIONS,\n          ...this.extensionsOptions\n        })\n      );\n\n      await this.loadFromConsolidate();\n      await this.loadFromTsedEngines();\n    }\n  }\n\n  /**\n   * @deprecated\n   */\n  async loadFromConsolidate() {\n    const cons = await tryImport(\"consolidate\");\n    if (cons) {\n      cons.requires.ejs = patchEJS(cons.requires.ejs);\n\n      this.#extensions.forEach((engineType) => {\n        if ((cons as any)[engineType]) {\n          const options = this.getEngineOptions(engineType);\n\n          if (options.requires) {\n            (cons.requires as any)[engineType] = options.requires;\n          }\n\n          this.registerEngine(engineType, {\n            options,\n            render: (cons as any)[engineType]\n          });\n        }\n      });\n    }\n  }\n\n  async loadFromTsedEngines() {\n    const tsed = await tryImport(\"@tsed/engines\");\n\n    if (tsed) {\n      tsed.requires.set(\"ejs\", patchEJS(tsed.requires.get(\"ejs\")));\n\n      this.#extensions.forEach((engineType) => {\n        if (tsed.engines.has(engineType)) {\n          const options = this.getEngineOptions(engineType);\n\n          if (options.requires) {\n            tsed.requires.set(engineType, options.requires);\n          }\n\n          this.registerEngine(engineType, {\n            options,\n            render: tsed.getEngine(engineType)\n          });\n        }\n      });\n    }\n  }\n\n  getEngines() {\n    return [...this.#extensions.entries()].map(([extension, engineType]) => {\n      const engine = this.getEngine(this.getExtension(engineType))!;\n\n      return {\n        extension,\n        engine\n      };\n    });\n  }\n\n  registerEngine(engineType: string, engine: PlatformViewEngine) {\n    this.#engines.set(engineType, engine);\n\n    return this;\n  }\n\n  getEngine(type: string) {\n    return this.#engines.get(this.#extensions.get(type) || type);\n  }\n\n  getEngineOptions(engineType: string): PlatformViewsEngineOptions {\n    return getValue(this.engineOptions, engineType, {});\n  }\n\n  async render(viewPath: string, options: any = {}): Promise<string> {\n    const {path, extension} = this.#cachePaths.get(viewPath) || this.#cachePaths.set(viewPath, this.resolve(viewPath)).get(viewPath)!;\n    const engine = this.getEngine(extension);\n\n    if (!engine) {\n      throw new Error(`Engine not found to render the following \"${viewPath}\"`);\n    }\n\n    return engine.render(path, Object.assign({cache: this.cache || this.env === Env.PROD}, engine.options, options));\n  }\n\n  protected getExtension(viewPath: string) {\n    return (extname(viewPath) || this.viewEngine).replace(/\\./, \"\");\n  }\n\n  protected resolve(viewPath: string) {\n    const extension = this.getExtension(viewPath);\n\n    viewPath = viewPath.replace(extname(viewPath), \"\") + \".\" + extension;\n\n    const path =\n      [\n        viewPath,\n        resolve(join(this.root, viewPath)),\n        resolve(join(process.cwd(), \"views\", viewPath)),\n        resolve(join(process.cwd(), \"public\", viewPath))\n      ].find((file) => Fs.existsSync(file)) || viewPath;\n\n    return {\n      path,\n      extension\n    };\n  }\n}\n"]}

package/lib/types/decorators/view.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Use a view and sends the rendered HTML string to the client. Optional parameter:
+ *
+ * * viewOptions, an object whose properties define local variables for the view.
+ *
+ * The view argument is a string that is the file path of the view file to render.
+ * This can be an absolute path, or a path relative to the views setting.
+ * If the path does not contain a file extension, then the view engine setting determines the file extension.
+ * If the path does contain a file extension, then Express will load the module for the specified template engine (via require())
+ * and render it using the loaded module’s __express function.
+ *
+ * For more information, see [Using template engines with Express](http://expressjs.com/guide/using-template-engines.html).
+ *
+ * > NOTE: The view argument performs file system operations like reading a file from disk and evaluating Node.js modules,
+ * and as so for security reasons should not contain input from the end-user.
+ *
+ * @param path Relative path to the view file.
+ * @param options Additional options
+ * @decorator
+ * @operation
+ * @response
+ */
+export declare function View(path: string, options?: Object): MethodDecorator;