@tsed/common 7.0.0-alpha.2 → 7.0.0-beta.11

package/readme.md

@@ -31,32 +31,32 @@
 
 ## What it is
 
-Ts.ED is a framework on top of Express that helps you to write your application in TypeScript (or in ES6). It provides a lot of decorators 
+Ts.ED is a framework on top of Express that helps you to write your application in TypeScript (or in ES6). It provides a lot of decorators
 to make your code more readable and less error-prone.
 
 ## Features
 
-* Use our CLI to create a new project https://cli.tsed.io
-* Support TypeORM, Mongoose, GraphQL, Socket.io, Swagger-ui, Passport.js, etc...
-* Define class as Controller,
-* Define class as Service (IoC),
-* Define class as Middleware and MiddlewareError,
-* Define class as Converter (POJ to Model and Model to POJ),
-* Define root path for an entire controller and versioning your Rest API,
-* Define as sub-route path for a method,
-* Define routes on GET, POST, PUT, DELETE and HEAD verbs,
-* Define middlewares on routes,
-* Define required parameters,
-* Inject data from query string, path parameters, entire body, cookies, session or header,
-* Inject Request, Response, Next object from Express request,
-* Template (View),
-* Testing.
+- Use our CLI to create a new project https://cli.tsed.io
+- Support TypeORM, Mongoose, GraphQL, Socket.io, Swagger-ui, Passport.js, etc...
+- Define class as Controller,
+- Define class as Service (IoC),
+- Define class as Middleware and MiddlewareError,
+- Define class as Converter (POJ to Model and Model to POJ),
+- Define root path for an entire controller and versioning your Rest API,
+- Define as sub-route path for a method,
+- Define routes on GET, POST, PUT, DELETE and HEAD verbs,
+- Define middlewares on routes,
+- Define required parameters,
+- Inject data from query string, path parameters, entire body, cookies, session or header,
+- Inject Request, Response, Next object from Express request,
+- Template (View),
+- Testing.
 
 ## Documentation
 
 Documentation is available on [https://tsed.io](https://tsed.io)
 
-## Getting started 
+## Getting started
 
 See our [getting started here](https://tsed.io/getting-started/) to create new Ts.ED project or use
 our [CLI](https://cli.tsed.io)
@@ -65,8 +65,8 @@ our [CLI](https://cli.tsed.io)
 
 Examples are available on [https://tsed.io/tutorials/](https://tsed.io/tutorials/)
 
-
 ## Overview
+
 ### Server example
 
 Here an example to create a Server with Ts.ED:
@@ -75,37 +75,19 @@ Here an example to create a Server with Ts.ED:
 import {Configuration, Inject} from "@tsed/di";
 import {PlatformApplication} from "@tsed/common";
 import "@tsed/platform-express";
-import * as Path from "path";                              
-
-export const rootDir = Path.resolve(__dirname);
+import Path from "path";
+import cookieParser from "cookie-parser";
+import compress from "compression";
+import methodOverride from "method-override";
 
 @Configuration({
-  rootDir,
-  port: 3000
+  port: 3000,
+  middlewares: [cookieParser(), compress({}), methodOverride()]
 })
-export class Server {
-  @Inject()
-  app: PlatformApplication;
-
-  public $beforeRoutesInit() {
-    const cookieParser = require('cookie-parser'),
-      bodyParser = require('body-parser'),
-      compress = require('compression'),
-      methodOverride = require('method-override');
- 
-    this.app
-      .use(cookieParser())
-      .use(compress({}))
-      .use(methodOverride())
-      .use(bodyParser.json())
-      .use(bodyParser.urlencoded({
-        extended: true
-      }));
-  }   
-}
+export class Server {}
 ```
 
-To run your server, you have to use Platform API to bootstrap your application with the expected 
+To run your server, you have to use Platform API to bootstrap your application with the expected
 platform like Express.
 
 ```typescript
@@ -137,21 +119,34 @@ This is a simple controller to expose user resource. It use decorators to build
 ```typescript
 import {Inject} from "@tsed/di";
 import {Summary} from "@tsed/swagger";
-import {Returns, ReturnsArray, Controller, Get, QueryParams, PathParams, Delete, Post, Required, BodyParams, Status, Put} from "@tsed/common";
+import {
+  Returns,
+  ReturnsArray,
+  Controller,
+  Get,
+  QueryParams,
+  PathParams,
+  Delete,
+  Post,
+  Required,
+  BodyParams,
+  Status,
+  Put
+} from "@tsed/common";
 import {BadRequest} from "@tsed/exceptions";
 import {UsersService} from "../services/UsersService";
-import {User} from "../models/User"; 
+import {User} from "../models/User";
 
 @Controller("/users")
 export class UsersCtrl {
   @Inject()
-  usersService: UsersService;
+  protected usersService: UsersService;
 
   @Get("/:id")
   @Summary("Get a user from his Id")
   @Returns(User)
   async getUser(@PathParams("id") id: string): Promise<User> {
-     return this.usersService.findById(id);
+    return this.usersService.findById(id);
   }
 
   @Post("/")
@@ -168,41 +163,40 @@ export class UsersCtrl {
   @Returns(User)
   async putUser(@PathParams("id") id: string, @Required() @BodyParams() user: User): Promise<User> {
     if (user.id !== id) {
-      throw new BadRequest("ID mismatch with the given payload")
+      throw new BadRequest("ID mismatch with the given payload");
     }
 
     return this.usersService.save(user);
   }
-  
+
   @Delete("/:id")
   @Summary("Remove a user")
   @Status(204)
-  async deleteUser(@PathParams("id") @Required() id: string ): Promise<User> {
-     await this.usersService.delete(user);
+  async deleteUser(@PathParams("id") @Required() id: string): Promise<User> {
+    await this.usersService.delete(user);
   }
-  
+
   @Get("/")
   @Summary("Get all users")
   @ReturnsArray(User)
-  async findUser(@QueryParams("name") name: string){
+  async findUser(@QueryParams("name") name: string) {
     return this.usersService.find({name});
   }
 }
 ```
 
 ## Contributors
+
 Please read [contributing guidelines here](./CONTRIBUTING.md).
 
 <a href="https://github.com/tsedio/tsed/graphs/contributors"><img src="https://opencollective.com/tsed/contributors.svg?width=890" /></a>
 
-
 ## Backers
 
 Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/tsed#backer)]
 
 <a href="https://opencollective.com/tsed#backers" target="_blank"><img src="https://opencollective.com/tsed/tiers/backer.svg?width=890"></a>
 
-
 ## Sponsors
 
 Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/tsed#sponsor)]
@@ -220,4 +214,3 @@ The above copyright notice and this permission notice shall be included in all c
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 [travis]: https://travis-ci.org/
-

package/tsconfig.compile.esm.json

@@ -0,0 +1,13 @@
+{
+  "extends": "./tsconfig.compile.json",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "module": "ES2020",
+    "rootDir": "src",
+    "outDir": "./lib/esm",
+    "declaration": true,
+    "declarationDir": "./lib/types"
+  },
+  "include": ["src"],
+  "exclude": ["node_modules", "test", "lib", "benchmark", "coverage", "spec", "**/*.benchmark.ts", "**/*.spec.ts", "keys", "jest.config.js"]
+}

package/lib/PlatformModule.d.ts

@@ -1,15 +0,0 @@
-import { InjectorService } from "@tsed/di";
-import { Platform } from "./services/Platform";
-/**
- * @ignore
- */
-export declare class PlatformModule {
-    protected injector: InjectorService;
-    protected platform: Platform;
-    constructor(injector: InjectorService, platform: Platform);
-    /**
-     * Create routers from the collected controllers
-     */
-    createRoutersFromControllers(): (import("./interfaces").PlatformRouterMethods<any> | undefined)[];
-    $$loadRoutes(): void;
-}

package/lib/builder/PlatformControllerBuilder.d.ts

@@ -1,19 +0,0 @@
-import { InjectorService } from "@tsed/di";
-import { ControllerProvider } from "../domain/ControllerProvider";
-import { PlatformRouterMethods } from "../interfaces/PlatformRouterMethods";
-/**
- * @ignore
- */
-export declare class PlatformControllerBuilder {
-    private provider;
-    constructor(provider: ControllerProvider);
-    /**
-     *
-     * @returns {any}
-     */
-    build(injector: InjectorService): PlatformRouterMethods;
-    private buildEndpoints;
-    private buildEndpoint;
-    private buildChildrenCtrls;
-    private buildMiddlewares;
-}

package/lib/config/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./interfaces";
-export * from "./services/PlatformConfiguration";
-export * from "./services/PlatformConfiguration";

package/lib/config/interfaces/EndpointDirectoriesSettings.d.ts

@@ -1,3 +0,0 @@
-export interface EndpointDirectoriesSettings {
-    [endpoint: string]: any | string | (any | string)[];
-}

package/lib/config/interfaces/PlatformMulterSettings.d.ts

@@ -1,138 +0,0 @@
-/// <reference types="node" />
-import { FileFilterCallback } from "multer";
-import { Readable } from "stream";
-declare global {
-    namespace TsED {
-        interface MulterFile {
-            /** Name of the form field associated with this file. */
-            fieldname: string;
-            /** Name of the file on the uploader's computer. */
-            originalname: string;
-            /** Value of the `Content-Type` header for this file. */
-            mimetype: string;
-            /** Size of the file in bytes. */
-            size: number;
-            /**
-             * A readable stream of this file. Only available to the `_handleFile`
-             * callback for custom `StorageEngine`s.
-             */
-            stream: Readable;
-            /** `DiskStorage` only: Directory to which this file has been uploaded. */
-            destination: string;
-            /** `DiskStorage` only: Name of this file within `destination`. */
-            filename: string;
-            /** `DiskStorage` only: Full path to the uploaded file. */
-            path: string;
-            /** `MemoryStorage` only: A Buffer containing the entire file. */
-            buffer: Buffer;
-        }
-        interface MulterStorageEngine {
-        }
-        interface MulterOptions {
-            /**
-             * A `StorageEngine` responsible for processing files uploaded via Multer.
-             * Takes precedence over `dest`.
-             */
-            storage?: MulterStorageEngine;
-            /**
-             * The destination directory for uploaded files. If `storage` is not set
-             * and `dest` is, Multer will create a `DiskStorage` instance configured
-             * to store files at `dest` with random filenames.
-             *
-             * Ignored if `storage` is set.
-             */
-            dest?: string;
-            /**
-             * An object specifying various limits on incoming data. This object is
-             * passed to Busboy directly, and the details of properties can be found
-             * at https://github.com/mscdex/busboy#busboy-methods.
-             */
-            limits?: {
-                /** Maximum size of each form field name in bytes. (Default: 100) */
-                fieldNameSize?: number;
-                /** Maximum size of each form field value in bytes. (Default: 1048576) */
-                fieldSize?: number;
-                /** Maximum number of non-file form fields. (Default: Infinity) */
-                fields?: number;
-                /** Maximum size of each file in bytes. (Default: Infinity) */
-                fileSize?: number;
-                /** Maximum number of file fields. (Default: Infinity) */
-                files?: number;
-                /** Maximum number of parts (non-file fields + files). (Default: Infinity) */
-                parts?: number;
-                /** Maximum number of headers. (Default: 2000) */
-                headerPairs?: number;
-            };
-            /** Preserve the full path of the original filename rather than the basename. (Default: false) */
-            preservePath?: boolean;
-            /**
-             * Optional function to control which files are uploaded. This is called
-             * for every file that is processed.
-             *
-             * @param req The Express `Request` object.
-             * @param file Object containing information about the processed file.
-             * @param callback  a function to control which files should be uploaded and which should be skipped.
-             */
-            fileFilter?(req: Request, file: MulterFile, callback: FileFilterCallback): void;
-        }
-        interface MulterField {
-            name: string;
-            maxCount?: number;
-        }
-        type MulterHandler = (req: any, res: any) => Promise<any>;
-        interface Multer {
-            /**
-             * Returns middleware that processes a single file associated with the
-             * given form field.
-             *
-             * The `Request` object will be populated with a `file` object containing
-             * information about the processed file.
-             *
-             * @param fieldName Name of the multipart form field to process.
-             */
-            single(fieldName: string): MulterHandler;
-            /**
-             * Returns middleware that processes multiple files sharing the same field
-             * name.
-             *
-             * The `Request` object will be populated with a `files` array containing
-             * an information object for each processed file.
-             *
-             * @param fieldName Shared name of the multipart form fields to process.
-             * @param maxCount Optional. Maximum number of files to process. (default: Infinity)
-             * @throws `MulterError('LIMIT_UNEXPECTED_FILE')` if more than `maxCount` files are associated with `fieldName`
-             */
-            array(fieldName: string, maxCount?: number): MulterHandler;
-            /**
-             * Returns middleware that processes multiple files associated with the
-             * given form fields.
-             *
-             * The `Request` object will be populated with a `files` object which
-             * maps each field name to an array of the associated file information
-             * objects.
-             *
-             * @param fields Array of `Field` objects describing multipart form fields to process.
-             * @throws `MulterError('LIMIT_UNEXPECTED_FILE')` if more than `maxCount` files are associated with `fieldName` for any field.
-             */
-            fields(fields: MulterField[]): MulterHandler;
-            /**
-             * Returns middleware that processes all files contained in the multipart
-             * request.
-             *
-             * The `Request` object will be populated with a `files` array containing
-             * an information object for each processed file.
-             */
-            any(): MulterHandler;
-            /**
-             * Returns middleware that accepts only non-file multipart form fields.
-             *
-             * @throws `MulterError('LIMIT_UNEXPECTED_FILE')` if any file is encountered.
-             */
-            none(): MulterHandler;
-        }
-    }
-}
-export declare type PlatformMulter = TsED.Multer;
-export declare type PlatformMulterSettings = TsED.MulterOptions;
-export declare type PlatformMulterFile = TsED.MulterFile;
-export declare type PlatformMulterField = TsED.MulterField;

package/lib/config/interfaces/index.d.ts

@@ -1,84 +0,0 @@
-/// <reference types="node" />
-import { Env } from "@tsed/core";
-import Https from "https";
-import { ConverterSettings } from "./ConverterSettings";
-import { EndpointDirectoriesSettings } from "./EndpointDirectoriesSettings";
-import { PlatformLoggerSettings } from "./PlatformLoggerSettings";
-import { PlatformMulterSettings } from "./PlatformMulterSettings";
-import { PlatformStaticsSettings } from "./PlatformStaticsSettings";
-declare global {
-    namespace TsED {
-        interface LoggerConfiguration extends Partial<PlatformLoggerSettings> {
-        }
-        interface Configuration {
-            /**
-             * The root directory where you build run project. By default, it's equal to `process.cwd().
-             */
-            rootDir: string;
-            /**
-             * The environment profile. By default the environment profile is equals to `NODE_ENV`.
-             */
-            env: Env;
-            /**
-             * Port number for the [HTTP.Server](https://nodejs.org/api/http.html#http_class_http_server).
-             */
-            port: string | number;
-            /**
-             * Port number for the [HTTP.Server](https://nodejs.org/api/http.html#http_class_http_server).
-             */
-            httpPort: string | number | boolean;
-            /**
-             * Port number for the [HTTPs.Server](https://nodejs.org/api/https.html#https_class_https_server).
-             */
-            httpsPort: string | number | boolean;
-            /**
-             * [Https.ServerOptions](https://nodejs.org/api/tls.html#tls_tls_createserver_options_secureconnectionlistener)):
-             * - `key` &lt;string&gt; | &lt;string[]&gt; | [&lt;Buffer&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer) | &lt;Object[]&gt;: The private key of the server in PEM format. To support multiple keys using different algorithms an array can be provided either as a plain array of key strings or an array of objects in the format `{pem: key, passphrase: passphrase}`. This option is required for ciphers that make use of private keys.
-             * - `passphrase` &lt;string&gt; A string containing the passphrase for the private key or pfx.
-             * - `cert` &lt;string&gt; | &lt;string[]&gt; | [&lt;Buffer&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer) | [&lt;Buffer[]&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer): A string, Buffer, array of strings, or array of Buffers containing the certificate key of the server in PEM format. (Required)
-             * - `ca` &lt;string&gt; | &lt;string[]&gt; | [&lt;Buffer&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer) | [&lt;Buffer[]&gt;](https://nodejs.org/api/buffer.html#buffer_class_buffer): A string, Buffer, array of strings, or array of Buffers of trusted certificates in PEM format. If this is omitted several well known "root" CAs (like VeriSign) will be used. These are used to authorize connections.
-             */
-            httpsOptions: Https.ServerOptions;
-            /**
-             * Mount all controllers under a directories to an endpoint.
-             */
-            mount: EndpointDirectoriesSettings;
-            /**
-             * List of directories to scan [Services](/docs/services.md), [Middlewares](/docs/middlewares.md) or [Converters](/docs/converters.md).
-             */
-            componentsScan: (string | RegExp)[];
-            /**
-             * List of glob patterns. Exclude all files which matching with this list when Server scan all components with the `mount` or `scanComponents` options.
-             */
-            exclude: string[];
-            /**
-             * Configure the mimes accepted by default by the server.
-             */
-            acceptMimes: string[];
-            /**
-             * Enable debug mode. By default debug is false.
-             */
-            debug: boolean;
-            /**
-             * Converter configuration.
-             */
-            converter: Partial<ConverterSettings>;
-            /**
-             * Logger configuration.
-             */
-            logger?: LoggerConfiguration;
-            /**
-             * Object to mount all directories under to his endpoints. See more on [Serve Static](/tutorials/serve-static-files.md).
-             */
-            statics: PlatformStaticsSettings;
-            /**
-             * Object configure Multer. See more on [Upload file](/tutorials/serve-static-files.md).
-             */
-            multer: PlatformMulterSettings;
-        }
-    }
-}
-export * from "./PlatformLoggerSettings";
-export * from "./EndpointDirectoriesSettings";
-export * from "./PlatformStaticsSettings";
-export * from "./PlatformMulterSettings";

package/lib/decorators/httpServer.d.ts

@@ -1,27 +0,0 @@
-/// <reference types="node" />
-import { Type } from "@tsed/core";
-import Http from "http";
-/**
- * Inject the Http.Server instance.
- *
- * ### Example
- *
- * ```typescript
- * import {HttpServer, Service} from "@tsed/common";
- *
- * @Service()
- * export default class OtherService {
- *    constructor(@HttpServer httpServer: HttpServer) {}
- * }
- * ```
- *
- * > Note: TypeScript transform and store `HttpServer` as `Function` type in the metadata. So to inject a factory, you must use the `@Inject(type)` decorator.
- *
- * @param {Type<any>} target
- * @param {string} targetKey
- * @param {TypedPropertyDescriptor<Function> | number} descriptor
- * @returns {any}
- * @decorator
- */
-export declare function HttpServer(target: Type<any>, targetKey: string, descriptor: TypedPropertyDescriptor<Function> | number): any;
-export declare type HttpServer = Http.Server;

package/lib/decorators/httpsServer.d.ts

@@ -1,27 +0,0 @@
-/// <reference types="node" />
-import { Type } from "@tsed/core";
-import Https from "https";
-/**
- * Inject the Https.Server instance.
- *
- * ### Example
- *
- * ```typescript
- * import {HttpsServer, Service} from "@tsed/common";
- *
- * @Service()
- * export default class OtherService {
- *    constructor(@HttpsServer httpServer: HttpServer) {}
- * }
- * ```
- *
- * > Note: TypeScript transform and store `HttpsServer` as `Function` type in the metadata. So to inject a factory, you must use the `@Inject(type)` decorator.
- *
- * @param {Type<any>} target
- * @param {string} targetKey
- * @param {TypedPropertyDescriptor<Function> | number} descriptor
- * @returns {any}
- * @decorator
- */
-export declare function HttpsServer(target: Type<any>, targetKey: string, descriptor: TypedPropertyDescriptor<Function> | number): any;
-export declare type HttpsServer = Https.Server;

package/lib/decorators/index.d.ts

@@ -1,13 +0,0 @@
-export * from "./httpServer";
-export * from "./httpsServer";
-export * from "./multer";
-export * from "./method/route";
-export * from "./method/acceptMime";
-export * from "./method/location";
-export * from "./method/redirect";
-export * from "./method/endpointFn";
-export * from "./params/response";
-export * from "./params/request";
-export * from "./params/next";
-export * from "./params/error";
-export * from "../utils/mapReturnedResponse";

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

@@ -1,19 +0,0 @@
-/**
- * Set a mime list which are acceptable and checks if the specified content types are acceptable, based on the request’s Accept HTTP header field.
- *
- * ```typescript
- *  @Controller('/mypath')
- *  export class MyCtrl {
- *
- *    @Get('/')
- *    @AcceptMime('application/json')
- *    public getResource(){}
- *  }
- * ```
- *
- * @param mimes
- * @decorator
- * @operation
- * @response
- */
-export declare function AcceptMime(...mimes: string[]): Function;

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

@@ -1,8 +0,0 @@
-import { DecoratorParameters } from "@tsed/core";
-import { EndpointMetadata } from "../../domain";
-/**
- *
- * @param fn
- * @decorator
- */
-export declare function EndpointFn(fn: (endpoint: EndpointMetadata, parameters: DecoratorParameters) => void): MethodDecorator;

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

@@ -1 +0,0 @@
-export { Location } from "@tsed/schema";

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

@@ -1 +0,0 @@
-export { Redirect } from "@tsed/schema";

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

@@ -1 +0,0 @@
-export { Get, Post, Put, Patch, Delete, Head, Options, All } from "@tsed/schema";

package/lib/decorators/multer/index.d.ts

@@ -1,3 +0,0 @@
-export * from "./multerFileSize";
-export * from "./multerOptions";
-export * from "./multipartFile";

package/lib/domain/ControllerProvider.d.ts

@@ -1,53 +0,0 @@
-import { ControllerMiddlewares, Provider, TokenProvider } from "@tsed/di";
-import { JsonEntityStore } from "@tsed/schema";
-import { PlatformRouterMethods } from "../interfaces/PlatformRouterMethods";
-import { EndpointMetadata } from "./EndpointMetadata";
-export declare class ControllerProvider<T = any> extends Provider<T> {
-    readonly entity: JsonEntityStore;
-    private router;
-    constructor(provide: TokenProvider, options?: Partial<Provider>);
-    get path(): string;
-    set path(path: string);
-    /**
-     *
-     * @returns {EndpointMetadata[]}
-     */
-    get endpoints(): EndpointMetadata[];
-    get children(): TokenProvider[];
-    /**
-     *
-     * @returns {ControllerProvider}
-     */
-    get parent(): TokenProvider | undefined;
-    /**
-     *
-     */
-    get routerOptions(): any;
-    /**
-     *
-     * @param value
-     */
-    set routerOptions(value: any);
-    /**
-     *
-     * @returns {any[]}
-     */
-    get middlewares(): ControllerMiddlewares;
-    /**
-     *
-     * @param middlewares
-     */
-    set middlewares(middlewares: ControllerMiddlewares);
-    /**
-     *
-     * @returns {boolean}
-     */
-    hasChildren(): boolean;
-    /**
-     *
-     * @returns {boolean}
-     */
-    hasParent(): boolean;
-    getRouter<T extends PlatformRouterMethods = any>(): T;
-    setRouter(router: PlatformRouterMethods): this;
-}