@tsed/common 6.87.2 → 6.88.0

package/lib/decorators/index.d.ts

@@ -6,6 +6,7 @@ export * from "./method/acceptMime";
 export * from "./method/location";
 export * from "./method/redirect";
 export * from "./method/endpointFn";
+export * from "./method/view";
 export * from "./params/responseData";
 export * from "./params/response";
 export * from "./params/request";

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

@@ -0,0 +1,25 @@
+/**
+ * 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
+ * @ignores
+ * @deprecated Use View decorator from @tsed/platform-views instead.
+ */
+export declare function View(path: string, options?: Object): MethodDecorator;

package/lib/index.d.ts

@@ -6,7 +6,6 @@ export * from "@tsed/platform-exceptions";
 export * from "@tsed/platform-response-filter";
 export * from "@tsed/platform-cache";
 export * from "@tsed/platform-middlewares";
-export * from "@tsed/platform-views";
 export * from "@tsed/components-scan";
 export * from "@tsed/platform-log-middleware";
 export { $log, Logger } from "@tsed/logger";

package/lib/index.js

@@ -6,7 +6,6 @@ var platformExceptions = require('@tsed/platform-exceptions');
 var platformResponseFilter = require('@tsed/platform-response-filter');
 var platformCache = require('@tsed/platform-cache');
 var platformMiddlewares = require('@tsed/platform-middlewares');
-var platformViews = require('@tsed/platform-views');
 var componentsScan = require('@tsed/components-scan');
 var platformLogMiddleware = require('@tsed/platform-log-middleware');
 var tslib = require('tslib');
@@ -1489,7 +1488,8 @@ function buildRouter(injector, provider) {
 exports.PlatformRequest = class PlatformRequest {
   constructor({
     request
-  }) {
+  }, $ctx) {
+    this.$ctx = $ctx;
     this.raw = request;
   }
 
@@ -1620,7 +1620,9 @@ exports.PlatformRequest = class PlatformRequest {
     // @ts-ignore
     delete this.raw; // @ts-ignore
 
-    delete this.response;
+    delete this.response; // @ts-ignore
+
+    delete this.$ctx;
   }
   /**
    * Return the Framework response object (express, koa, etc...)
@@ -1640,7 +1642,7 @@ exports.PlatformRequest = class PlatformRequest {
   }
 
 };
-exports.PlatformRequest = tslib.__decorate([di.Injectable(), di.Scope(di.ProviderScope.INSTANCE), tslib.__metadata("design:paramtypes", [Object])], exports.PlatformRequest);
+exports.PlatformRequest = tslib.__decorate([di.Injectable(), di.Scope(di.ProviderScope.INSTANCE), tslib.__metadata("design:paramtypes", [Object, Function])], exports.PlatformRequest);
 
 var PlatformResponse_1;
 
@@ -1654,7 +1656,8 @@ const onFinished = require("on-finished");
 exports.PlatformResponse = PlatformResponse_1 = class PlatformResponse {
   constructor({
     response
-  }) {
+  }, $ctx) {
+    this.$ctx = $ctx;
     this.raw = response;
   }
   /**
@@ -1871,7 +1874,11 @@ exports.PlatformResponse = PlatformResponse_1 = class PlatformResponse {
 
 
   async render(path, options = {}) {
-    return this.platformViews.render(path, _extends({}, this.locals, options));
+    const {
+      PlatformViews
+    } = await Promise.resolve().then(function () { return /*#__PURE__*/_interopNamespace(require('@tsed/platform-views')); });
+    const platformViews = await this.$ctx.injector.lazyInvoke(PlatformViews);
+    return platformViews.render(path, _extends({}, this.locals, options));
   }
   /**
    * Send any data to your consumer.
@@ -1943,7 +1950,9 @@ exports.PlatformResponse = PlatformResponse_1 = class PlatformResponse {
     delete this.raw;
     delete this.data; // @ts-ignore
 
-    delete this.request;
+    delete this.request; // @ts-ignore
+
+    delete this.$ctx;
   }
 
   isHeadersSent() {
@@ -1951,7 +1960,7 @@ exports.PlatformResponse = PlatformResponse_1 = class PlatformResponse {
   }
 
 };
-exports.PlatformResponse = PlatformResponse_1 = tslib.__decorate([di.Injectable(), di.Scope(di.ProviderScope.INSTANCE), tslib.__metadata("design:paramtypes", [Object])], exports.PlatformResponse);
+exports.PlatformResponse = PlatformResponse_1 = tslib.__decorate([di.Injectable(), di.Scope(di.ProviderScope.INSTANCE), tslib.__metadata("design:paramtypes", [Object, Function])], exports.PlatformResponse);
 
 const _excluded$2 = ["event", "endpoint", "ignoreUrlPatterns", "ResponseKlass", "RequestKlass"];
 class PlatformContext extends di.DIContext {
@@ -1973,8 +1982,8 @@ class PlatformContext extends di.DIContext {
     this.ignoreUrlPatterns = [];
     endpoint && (this.endpoint = endpoint);
     this.ignoreUrlPatterns = ignoreUrlPatterns.map(pattern => typeof pattern === "string" ? new RegExp(pattern, "gi") : pattern);
-    this.response = new ResponseKlass(event);
-    this.request = new RequestKlass(event);
+    this.response = new ResponseKlass(event, this);
+    this.request = new RequestKlass(event, this);
     this.response.request = this.request;
     this.request.response = this.response;
     this.request.request.$ctx = this;
@@ -2451,7 +2460,6 @@ function createContext(injector) {
 
   const ResponseKlass = (_injector$getProvider = injector.getProvider(exports.PlatformResponse)) == null ? void 0 : _injector$getProvider.useClass;
   const RequestKlass = (_injector$getProvider2 = injector.getProvider(exports.PlatformRequest)) == null ? void 0 : _injector$getProvider2.useClass;
-  const platformViews$1 = injector.get(platformViews.PlatformViews);
 
   const _ref = injector.settings.logger || {},
         {
@@ -2469,7 +2477,6 @@ function createContext(injector) {
       ResponseKlass,
       RequestKlass
     }));
-    ctx.response.platformViews = platformViews$1;
     ctx.response.onEnd(async () => {
       await ctx.emit("$onResponse", ctx);
       await ctx.destroy();
@@ -3036,6 +3043,39 @@ function EndpointFn(fn) {
   return schema.JsonEntityFn(fn);
 }
 
+/**
+ * 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
+ * @ignores
+ * @deprecated Use View decorator from @tsed/platform-views instead.
+ */
+// istanbul ignore next
+
+function View(path, options) {
+  return core.StoreSet("view", {
+    path,
+    options
+  });
+}
+
 /**
  * Return the current response data. Prefer the @@Context@@ decorator to get or set data.
  *
@@ -3396,7 +3436,7 @@ class PlatformTest extends di.DITest {
       request: (options == null ? void 0 : (_options$request = options.request) == null ? void 0 : _options$request.request) || (options == null ? void 0 : (_options$event = options.event) == null ? void 0 : _options$event.request) || PlatformTest.createRequest(),
       response: (options == null ? void 0 : (_options$response = options.response) == null ? void 0 : _options$response.response) || (options == null ? void 0 : (_options$event2 = options.event) == null ? void 0 : _options$event2.response) || PlatformTest.createResponse()
     };
-    const ctx = new PlatformContext(_extends({
+    return new PlatformContext(_extends({
       id: "id",
       injector: di.DITest.injector,
       logger: di.DITest.injector.logger,
@@ -3404,8 +3444,6 @@ class PlatformTest extends di.DITest {
     }, options, {
       event
     }));
-    ctx.response.platformViews = PlatformTest.get(platformViews.PlatformViews);
-    return ctx;
   }
 
 }
@@ -3513,6 +3551,7 @@ exports.Request = Request;
 exports.Res = Res;
 exports.Response = Response;
 exports.ResponseData = ResponseData;
+exports.View = View;
 exports.bindEndpointMiddleware = bindEndpointMiddleware;
 exports.buildRouter = buildRouter;
 exports.createContext = createContext;
@@ -3576,14 +3615,6 @@ Object.keys(platformMiddlewares).forEach(function (k) {
     }
   });
 });
-Object.keys(platformViews).forEach(function (k) {
-  if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
-    enumerable: true,
-    get: function () {
-      return platformViews[k];
-    }
-  });
-});
 Object.keys(componentsScan).forEach(function (k) {
   if (k !== 'default' && !exports.hasOwnProperty(k)) Object.defineProperty(exports, k, {
     enumerable: true,