@tsed/common 6.70.1 → 7.0.0-alpha.1

package/lib/index.modern.js

@@ -1,4 +1,4 @@
-import { DIConfiguration, ProviderType, ProviderScope, Injectable, InjectorService, Configuration, Inject, Constant, Scope, Opts, DIContext, Provider, Module, setLoggerLevel, GlobalProviders, registerProvider, createContainer, Container, getConfiguration, registerController, DITest } from '@tsed/di';
+import { DIConfiguration, ProviderType, ProviderScope, Injectable, InjectorService, Configuration, Inject, Constant, Scope, DIContext, Provider, Module, setLoggerLevel, GlobalProviders, registerProvider, Container, createContainer, getConfiguration, registerController, DITest } from '@tsed/di';
 export * from '@tsed/di';
 import { Context, ParamTypes, ParamMetadata, PlatformParams, UseParam, mapParamsOptions } from '@tsed/platform-params';
 export * from '@tsed/platform-params';
@@ -18,7 +18,8 @@ import { __decorate, __metadata, __param } from 'tslib';
 import { Env, AnyToPromise, AnyToPromiseStatus, nameOf, Store, descriptorOf, classOf, prototypeOf, deepMerge, isFunction, Enumerable, DecoratorTypes, isStream, isBoolean, isNumber, isString, uniq, toMap, constructorOf, StoreMerge, Metadata, useDecorators, useMethodDecorators, isArrayOrArrayClass, isClass } from '@tsed/core';
 import { PerfLogger } from '@tsed/perf';
 import { Exception, NotAcceptable } from '@tsed/exceptions';
-import { JsonEntityStore, getOperationsStores, JsonEntityComponent, OperationMethods, getProperties, Returns, Consumes, JsonEntityFn, Produces, Status } from '@tsed/schema';
+import { JsonEntityStore, getOperationsStores, JsonEntityComponent, OperationMethods, Returns, Consumes, JsonEntityFn, Produces } from '@tsed/schema';
+export { Location, Redirect } from '@tsed/schema';
 import { serialize, deserialize } from '@tsed/json-mapper';
 import { promisify } from 'util';
 import Http, { ServerResponse, IncomingMessage } from 'http';
@@ -670,14 +671,6 @@ let EndpointMetadata = EndpointMetadata_1 = class EndpointMetadata extends JsonE
     this.store.set("view", view);
   }
 
-  get location() {
-    return this.store.get("location");
-  }
-
-  set location(url) {
-    this.store.set("location", url);
-  }
-
   get acceptMimes() {
     return this.store.get("acceptMimes", []);
   }
@@ -685,16 +678,6 @@ let EndpointMetadata = EndpointMetadata_1 = class EndpointMetadata extends JsonE
   set acceptMimes(mimes) {
     this.store.set("acceptMimes", mimes);
   }
-
-  get redirect() {
-    return this.store.get("redirect");
-  }
-
-  set redirect(options) {
-    this.store.set("redirect", _extends({
-      status: 302
-    }, options));
-  }
   /**
    * Get all endpoints from a given class and his parents.
    * @param {Type<any>} target
@@ -847,12 +830,13 @@ function createHandlerMetadata(injector, obj, routeOptions = {}) {
   return new HandlerMetadata(options);
 }
 
-function toHeaders(headers) {
-  return Object.entries(headers).reduce((headers, [key, item]) => {
+function mergeHeaders(specHeaders, headers) {
+  return Object.entries(specHeaders).reduce((headers, [key, item]) => {
+    key = key.toLowerCase();
     return _extends({}, headers, {
-      [key]: String(item.example)
+      [key]: headers[key] === undefined ? String(item.example) : headers[key]
     });
-  }, {});
+  }, headers);
 }
 /**
  * @ignore
@@ -877,15 +861,13 @@ function setResponseHeaders(ctx) {
     response.status(operation.getStatus());
   }
 
+  const statusCode = response.statusCode;
   const headers = operation.getHeadersOf(response.statusCode);
-  response.setHeaders(toHeaders(headers));
-
-  if (endpoint.redirect) {
-    response.redirect(endpoint.redirect.status || 302, endpoint.redirect.url);
-  }
+  const mergedHeaders = mergeHeaders(headers, response.getHeaders());
+  response.setHeaders(mergedHeaders);
 
-  if (endpoint.location) {
-    response.location(endpoint.location);
+  if (operation.isRedirection(statusCode)) {
+    response.redirect(statusCode, String(mergedHeaders["location"]));
   }
 }
 
@@ -1486,22 +1468,6 @@ __decorate([__param(0, Context()), __metadata("design:type", Function), __metada
 
 PlatformMulterMiddleware = PlatformMulterMiddleware_1 = __decorate([Middleware()], PlatformMulterMiddleware);
 
-/**
- * @deprecated Since 2020-11-30. Use PlatformAcceptMimesMiddleware.
- * @ignore
- */
-
-let GlobalAcceptMimesMiddleware = class GlobalAcceptMimesMiddleware {
-  use(ctx) {
-    return;
-  }
-
-};
-
-__decorate([__param(0, Context()), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", void 0)], GlobalAcceptMimesMiddleware.prototype, "use", null);
-
-GlobalAcceptMimesMiddleware = __decorate([Middleware()], GlobalAcceptMimesMiddleware);
-
 /**
  * @middleware
  * @platform
@@ -1528,23 +1494,6 @@ __decorate([__param(0, Context()), __metadata("design:type", Function), __metada
 
 PlatformAcceptMimesMiddleware = __decorate([Middleware()], PlatformAcceptMimesMiddleware);
 
-/**
- * @middleware
- * @deprecated Since 2020-11-30. Use PlatformAcceptMimesMiddleware.
- * @ignore
- */
-
-let AcceptMimesMiddleware = class AcceptMimesMiddleware {
-  use(ctx) {
-    return;
-  }
-
-};
-
-__decorate([__param(0, Context()), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", void 0)], AcceptMimesMiddleware.prototype, "use", null);
-
-AcceptMimesMiddleware = __decorate([Middleware()], AcceptMimesMiddleware);
-
 /**
  * Create Ts.ED context handler
  * @param fn
@@ -1707,8 +1656,10 @@ class PlatformControllerBuilder {
  */
 
 let PlatformRequest = class PlatformRequest {
-  constructor(raw) {
-    this.raw = raw;
+  constructor({
+    request
+  }) {
+    this.raw = request;
   }
 
   get secure() {
@@ -1836,7 +1787,9 @@ let PlatformRequest = class PlatformRequest {
 
   destroy() {
     // @ts-ignore
-    delete this.raw;
+    delete this.raw; // @ts-ignore
+
+    delete this.response;
   }
   /**
    * Return the Framework response object (express, koa, etc...)
@@ -1856,7 +1809,7 @@ let PlatformRequest = class PlatformRequest {
   }
 
 };
-PlatformRequest = __decorate([Injectable(), Scope(ProviderScope.INSTANCE), __param(0, Opts), __metadata("design:paramtypes", [Object])], PlatformRequest);
+PlatformRequest = __decorate([Injectable(), Scope(ProviderScope.INSTANCE), __metadata("design:paramtypes", [Object])], PlatformRequest);
 
 var PlatformResponse_1;
 
@@ -1868,8 +1821,10 @@ const onFinished = require("on-finished");
 
 
 let PlatformResponse = PlatformResponse_1 = class PlatformResponse {
-  constructor(raw) {
-    this.raw = raw;
+  constructor({
+    response
+  }) {
+    this.raw = response;
   }
   /**
    * Get the current statusCode
@@ -1980,7 +1935,11 @@ let PlatformResponse = PlatformResponse_1 = class PlatformResponse {
   }
 
   setHeader(key, item) {
-    this.raw.set(key, String(item));
+    if (key.toLowerCase() === "location") {
+      return this.location(String(item));
+    }
+
+    this.raw.set(key, item);
     return this;
   }
   /**
@@ -2151,7 +2110,9 @@ let PlatformResponse = PlatformResponse_1 = class PlatformResponse {
   destroy() {
     // @ts-ignore
     delete this.raw;
-    delete this.data;
+    delete this.data; // @ts-ignore
+
+    delete this.request;
   }
 
   isHeadersSent() {
@@ -2159,28 +2120,24 @@ let PlatformResponse = PlatformResponse_1 = class PlatformResponse {
   }
 
 };
+PlatformResponse = PlatformResponse_1 = __decorate([Injectable(), Scope(ProviderScope.INSTANCE), __metadata("design:paramtypes", [Object])], PlatformResponse);
 
-__decorate([Inject(), __metadata("design:type", PlatformViews)], PlatformResponse.prototype, "platformViews", void 0);
-
-PlatformResponse = PlatformResponse_1 = __decorate([Injectable(), Scope(ProviderScope.INSTANCE), __param(0, Opts), __metadata("design:paramtypes", [Object])], PlatformResponse);
-
-const _excluded$2 = ["response", "request", "endpoint", "url", "ignoreUrlPatterns"];
+const _excluded$3 = ["event", "endpoint", "ignoreUrlPatterns", "ResponseKlass", "RequestKlass"];
 
 var _ignoreUrlPatterns = /*#__PURE__*/_classPrivateFieldLooseKey("ignoreUrlPatterns");
 
 class PlatformContext extends DIContext {
   constructor(_ref) {
     let {
-      response,
-      request,
+      event,
       endpoint,
-      url,
-      ignoreUrlPatterns = []
+      ignoreUrlPatterns = [],
+      ResponseKlass = PlatformResponse,
+      RequestKlass = PlatformRequest
     } = _ref,
-        options = _objectWithoutPropertiesLoose(_ref, _excluded$2);
+        options = _objectWithoutPropertiesLoose(_ref, _excluded$3);
 
     super(_extends({}, options, {
-      url,
       ignoreLog: () => {
         return _classPrivateFieldLooseBase(this, _ignoreUrlPatterns)[_ignoreUrlPatterns].find(reg => !!this.url.match(reg));
       }
@@ -2190,21 +2147,23 @@ class PlatformContext extends DIContext {
       value: void 0
     });
     _classPrivateFieldLooseBase(this, _ignoreUrlPatterns)[_ignoreUrlPatterns] = [];
-    this.url = url;
     endpoint && (this.endpoint = endpoint);
     _classPrivateFieldLooseBase(this, _ignoreUrlPatterns)[_ignoreUrlPatterns] = ignoreUrlPatterns.map(pattern => typeof pattern === "string" ? new RegExp(pattern, "gi") : pattern);
-
-    if (response) {
-      this.response = response;
-      this.container.set(PlatformResponse, response);
-    }
-
-    if (request) {
-      this.request = request;
-      this.container.set(PlatformRequest, request);
-    }
-
+    this.response = new ResponseKlass(event);
+    this.request = new RequestKlass(event);
+    this.response.request = this.request;
+    this.request.response = this.response;
+    this.request.request.$ctx = this;
+    this.request.request.id = this.id;
+    this.logger.url = this.url;
+    this.container.set(PlatformResponse, this.response);
+    this.container.set(PlatformRequest, this.request);
     this.container.set(PlatformContext, this);
+    this.response.setHeader("x-request-id", this.id);
+  }
+
+  get url() {
+    return this.request.url;
   }
 
   get app() {
@@ -2212,7 +2171,10 @@ class PlatformContext extends DIContext {
   }
 
   async destroy() {
+    var _this$request, _this$request$request;
+
     await super.destroy();
+    (_this$request = this.request) == null ? true : (_this$request$request = _this$request.request) == null ? true : delete _this$request$request.$ctx;
     this.response.destroy();
     this.request.destroy(); // @ts-ignore
 
@@ -2427,22 +2389,6 @@ class ControllerProvider extends Provider {
 
 }
 
-let PropertyMetadata = class PropertyMetadata extends JsonEntityStore {
-  static get(target, propertyKey) {
-    return JsonEntityStore.from(prototypeOf(target), propertyKey);
-  }
-  /**
-   * @deprecated Since 2020-11-11. Use getProperties from @tsed/schema
-   */
-
-
-  static getProperties(target, options = {}) {
-    return getProperties(target, options);
-  }
-
-};
-PropertyMetadata = __decorate([JsonEntityComponent(DecoratorTypes.PROP)], PropertyMetadata);
-
 function getControllerPath(basePath, provider) {
   return (basePath === provider.path ? provider.path : (basePath || "") + provider.path).replace(/\/\//gi, "/");
 }
@@ -2766,16 +2712,6 @@ async function listenHttpsServer(injector) {
   }
 }
 
-/**
- * @ignore
- * @deprecated User injector.load(container, module) instead
- */
-
-async function loadInjector(injector, container = createContainer()) {
-  injector.bootstrap(container);
-  return injector.load(container, PlatformModule);
-}
-
 function printRoutes(routes) {
   const mapColor = {
     GET: "green",
@@ -2807,47 +2743,49 @@ function printRoutes(routes) {
   return "\n" + str.trim();
 }
 
+const _excluded$2 = ["reqIdBuilder"];
+
 const uuidv4 = require("uuid").v4;
 
 const defaultReqIdBuilder = req => req.get("x-request-id") || uuidv4().replace(/-/gi, "");
 /**
  * Create the TsED context to wrap request, response, injector, etc...
  * @param injector
- * @param request
- * @param response
  * @ignore
  */
 
 
-async function createContext(injector, request, response) {
-  const {
-    level,
-    ignoreUrlPatterns,
-    maxStackSize,
+function createContext(injector) {
+  var _injector$getProvider, _injector$getProvider2;
+
+  const ResponseKlass = (_injector$getProvider = injector.getProvider(PlatformResponse)) == null ? void 0 : _injector$getProvider.useClass;
+  const RequestKlass = (_injector$getProvider2 = injector.getProvider(PlatformRequest)) == null ? void 0 : _injector$getProvider2.useClass;
+  const platformViews = injector.get(PlatformViews);
+
+  const _injector$settings$lo = injector.settings.logger,
+        {
     reqIdBuilder = defaultReqIdBuilder
-  } = injector.settings.logger;
-  const req = request.getRequest();
-  const id = reqIdBuilder(req);
-  const ctx = new PlatformContext({
-    id,
-    logger: injector.logger,
-    url: request.url,
-    ignoreUrlPatterns,
-    level,
-    maxStackSize,
-    injector,
-    response,
-    request
-  });
-  req.$ctx = ctx;
-  response.setHeader("x-request-id", id);
-  response.onEnd(async () => {
-    await ctx.emit("$onResponse", ctx);
-    await ctx.destroy();
-    delete req.$ctx;
-  });
-  await ctx.emit("$onRequest", ctx);
-  return ctx;
+  } = _injector$settings$lo,
+        loggerOptions = _objectWithoutPropertiesLoose(_injector$settings$lo, _excluded$2);
+
+  return async event => {
+    const ctx = new PlatformContext(_extends({
+      event,
+      id: reqIdBuilder(event.request),
+      logger: injector.logger
+    }, loggerOptions, {
+      injector,
+      ResponseKlass,
+      RequestKlass
+    }));
+    ctx.response.platformViews = platformViews;
+    ctx.response.onEnd(async () => {
+      await ctx.emit("$onResponse", ctx);
+      await ctx.destroy();
+    });
+    await ctx.emit("$onRequest", ctx);
+    return ctx;
+  };
 }
 
 const SKIP_HOOKS = ["$beforeInit", "$afterInit", "$onInit", "$onMountingMiddlewares"];
@@ -3090,20 +3028,6 @@ class PlatformBuilder {
     }));
     this.settings.set("routes", routes);
   }
-
-  createRequest(req) {
-    const Klass = _classPrivateFieldLooseBase(this, _providers)[_providers].get(PlatformRequest).useClass;
-
-    return new Klass(req);
-  }
-
-  createResponse(res) {
-    const Klass = _classPrivateFieldLooseBase(this, _providers)[_providers].get(PlatformResponse).useClass;
-
-    const response = new Klass(res);
-    response.platformViews = this.injector.get(PlatformViews);
-    return response;
-  }
   /**
    * Load middlewares from configuration for the given hook
    * @param hook
@@ -3164,17 +3088,11 @@ class PlatformBuilder {
   }
 
   async loadRoutes() {
-    var _this$settings$accept;
-
     // istanbul ignore next
     if (this.settings.logger.level !== "off") {
       this.app.use(PlatformLogMiddleware);
     }
 
-    if ((_this$settings$accept = this.settings.acceptMimes) != null && _this$settings$accept.length) {
-      this.app.use(GlobalAcceptMimesMiddleware);
-    }
-
     this.log("Load routes");
     await this.callHook("$beforeRoutesInit");
     await this.callHook("$$loadRoutes");
@@ -3545,43 +3463,6 @@ function AcceptMime(...mimes) {
   }));
 }
 
-/**
- * Sets the response Location HTTP header to the specified path parameter.
- *
- * ```typescript
- *  @Location('/foo/bar')
- *  @Location('http://example.com')
- *  @Location('back')
- *  private myMethod() {
- *
- *  }
- * ```
- *
- * A path value of “back” has a special meaning, it refers to the URL specified in the `Referer` header of the request. If the `Referer` header was not specified, it refers to “/”.
- *
- * @param location
- * @returns {Function}
- * @decorator
- * @operation
- */
-
-function Location(location) {
-  return EndpointFn(endpoint => {
-    endpoint.location = location;
-  });
-}
-
-function Redirect(status, url) {
-  url = !url ? status : url;
-  status = typeof status === "number" ? status : 302;
-  return useDecorators(Status(status), EndpointFn(endpoint => {
-    endpoint.redirect = {
-      status: +status,
-      url: url
-    };
-  }));
-}
-
 const _excluded$1 = ["children"];
 
 function mapOptions(options) {
@@ -3641,22 +3522,6 @@ function Controller(options) {
   };
 }
 
-/**
- * Return the current response data. Prefer the @@Context@@ decorator to get or set data.
- *
- * @decorator
- * @operation
- * @input
- * @deprecated Use `@Context() $ctx: Context` then $ctx.data.
- */
-
-function ResponseData() {
-  return UseParam({
-    paramType: ParamTypes.$CTX,
-    dataPath: "$ctx.data"
-  });
-}
-
 function getParamType$1(target, propertyKey, parameterIndex) {
   const type = Metadata.getOwnParamTypes(target, propertyKey)[parameterIndex];
 
@@ -3783,23 +3648,6 @@ function Err() {
   });
 }
 
-/**
- * Get the current endpoint metadata.
- * @decorator
- * @operation
- * @input
- * @deprecated Use `@Context() $ctx: Context` then `$ctx.endpoint` instead.
- */
-
-function EndpointInfo() {
-  return UseParam({
-    paramType: ParamTypes.$CTX,
-    dataPath: "$ctx.endpoint",
-    useConverter: false,
-    useValidation: false
-  });
-}
-
 const _excluded = ["use", "collection"];
 
 /**
@@ -3923,15 +3771,90 @@ class PlatformTest extends DITest {
     return (_DITest$injector$get = DITest.injector.get(PlatformApplication)) == null ? void 0 : _DITest$injector$get.callback();
   }
 
+  static createRequest(options = {}) {
+    return _extends({
+      headers: {},
+
+      get(key) {
+        return this.headers[key.toLowerCase()];
+      },
+
+      accepts(mime) {
+        return require("accepts")(this).types([].concat(mime));
+      }
+
+    }, options);
+  }
+
+  static createResponse(options = {}) {
+    return _extends({
+      headers: {},
+      locals: {},
+      statusCode: 200,
+
+      status(code) {
+        this.statusCode = code;
+        return this;
+      },
+
+      contentType(content) {
+        this.set("content-type", content);
+      },
+
+      contentLength(content) {
+        this.set("content-length", content);
+      },
+
+      redirect(status, path) {
+        this.statusCode = status;
+        this.set("location", path);
+      },
+
+      location(path) {
+        this.set("location", path);
+      },
+
+      get(key) {
+        return this.headers[key.toLowerCase()];
+      },
+
+      getHeaders() {
+        return this.headers;
+      },
+
+      set(key, value) {
+        this.headers[key.toLowerCase()] = value;
+        return this;
+      },
+
+      send(data) {
+        this.data = data;
+      },
+
+      json(data) {
+        this.data = data;
+      }
+
+    }, options);
+  }
+
   static createRequestContext(options = {}) {
-    options.request = options.request || new PlatformRequest({});
-    options.response = options.response || new PlatformResponse({});
-    return new PlatformContext(_extends({
+    var _options$request, _options$event, _options$response, _options$event2;
+
+    const event = {
+      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({
       id: "id",
       injector: DITest.injector,
       logger: DITest.injector.logger,
       url: "/"
-    }, options));
+    }, options, {
+      event
+    }));
+    ctx.response.platformViews = PlatformTest.get(PlatformViews);
+    return ctx;
   }
 
 }
@@ -3943,5 +3866,5 @@ GlobalProviders.createRegistry(ProviderType.CONTROLLER, ControllerProvider, {
 
 });
 
-export { AcceptMime, AcceptMimesMiddleware, All, AnyToPromiseWithCtx, Controller, ControllerProvider, ConverterService, Delete, EndpointFn, EndpointInfo, EndpointMetadata, Err, Get, GlobalAcceptMimesMiddleware, HandlerMetadata, HandlerType, Head, HttpServer, HttpsServer, Location, MulterFileSize, MulterOptions, MultipartFile, Next, Options, PLATFORM_ROUTER_OPTIONS, Patch, Platform, PlatformAcceptMimesMiddleware, PlatformApplication, PlatformBuilder, PlatformConfiguration, PlatformContext, PlatformControllerBuilder, PlatformHandler, PlatformLogMiddleware, PlatformModule, PlatformMulterMiddleware, PlatformRequest, PlatformResponse, PlatformRouteDetails, PlatformRouter, PlatformTest, Post, PropertyMetadata, Put, ROUTER_OPTIONS, Redirect, Req, Request, Res, Response, ResponseData, bindEndpointMiddleware, createContext, createHttpServer, createHttpsServer, createInjector, createPlatformApplication, listenHttpServer, listenHttpsServer, listenServer, loadInjector, mapReturnedResponse, printRoutes, useCtxHandler };
+export { AcceptMime, All, AnyToPromiseWithCtx, Controller, ControllerProvider, ConverterService, Delete, EndpointFn, EndpointMetadata, Err, Get, HandlerMetadata, HandlerType, Head, HttpServer, HttpsServer, MulterFileSize, MulterOptions, MultipartFile, Next, Options, PLATFORM_ROUTER_OPTIONS, Patch, Platform, PlatformAcceptMimesMiddleware, PlatformApplication, PlatformBuilder, PlatformConfiguration, PlatformContext, PlatformControllerBuilder, PlatformHandler, PlatformLogMiddleware, PlatformModule, PlatformMulterMiddleware, PlatformRequest, PlatformResponse, PlatformRouteDetails, PlatformRouter, PlatformTest, Post, Put, ROUTER_OPTIONS, Req, Request, Res, Response, bindEndpointMiddleware, createContext, createHttpServer, createHttpsServer, createInjector, createPlatformApplication, listenHttpServer, listenHttpsServer, listenServer, mapReturnedResponse, printRoutes, useCtxHandler };
 //# sourceMappingURL=index.modern.js.map