feat(express): Express 2.8.0 (#126)

express/.eslintrc.json

@@ -0,0 +1,173 @@
+{
+  "env": {
+      "browser": true,
+      "es6": true,
+      "node": true
+  },
+  "extends": [
+      "plugin:@typescript-eslint/recommended",
+      "plugin:@typescript-eslint/recommended-requiring-type-checking"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+      "project": "tsconfig.json",
+      "sourceType": "module"
+  },
+  "plugins": [
+      "eslint-plugin-import",
+      "eslint-plugin-jsdoc",
+      "@typescript-eslint"
+  ],
+  "rules": {
+      "@typescript-eslint/adjacent-overload-signatures": "error",
+      "@typescript-eslint/array-type": [
+          "error",
+          {
+              "default": "array"
+          }
+      ],
+      "@typescript-eslint/ban-types": [
+          "error",
+          {
+              "types": {
+                  "Object": {
+                      "message": "Avoid using the `Object` type. Did you mean `object`?"
+                  },
+                  "Function": {
+                      "message": "Avoid using the `Function` type. Prefer a specific function type, like `() => void`."
+                  },
+                  "Boolean": {
+                      "message": "Avoid using the `Boolean` type. Did you mean `boolean`?"
+                  },
+                  "Number": {
+                      "message": "Avoid using the `Number` type. Did you mean `number`?"
+                  },
+                  "String": {
+                      "message": "Avoid using the `String` type. Did you mean `string`?"
+                  },
+                  "Symbol": {
+                      "message": "Avoid using the `Symbol` type. Did you mean `symbol`?"
+                  }
+              }
+          }
+      ],
+      "@typescript-eslint/consistent-type-assertions": "error",
+      "@typescript-eslint/dot-notation": "error",
+      "@typescript-eslint/explicit-member-accessibility": [
+          "off",
+          {
+              "accessibility": "explicit"
+          }
+      ],
+      "@typescript-eslint/explicit-module-boundary-types": "off",
+      "@typescript-eslint/member-ordering": "off",
+      "@typescript-eslint/naming-convention": "off",
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/no-empty-interface": "error",
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-misused-new": "error",
+      "@typescript-eslint/no-misused-promises": [
+        "error",
+        {
+          "checksVoidReturn": false
+        }
+      ],
+      "@typescript-eslint/no-namespace": "error",
+      "@typescript-eslint/no-parameter-properties": "off",
+      "@typescript-eslint/no-unused-expressions": "error",
+      "@typescript-eslint/no-use-before-define": "off",
+      "@typescript-eslint/no-var-requires": "error",
+      "@typescript-eslint/prefer-for-of": "error",
+      "@typescript-eslint/prefer-function-type": "error",
+      "@typescript-eslint/prefer-namespace-keyword": "error",
+      "@typescript-eslint/quotes": [
+          "error",
+          "single"
+      ],
+      "@typescript-eslint/triple-slash-reference": [
+          "error",
+          {
+              "path": "always",
+              "types": "prefer-import",
+              "lib": "always"
+          }
+      ],
+      "@typescript-eslint/restrict-template-expressions": "off",
+      "@typescript-eslint/unified-signatures": "error",
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-call": "off",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+      "@typescript-eslint/no-unsafe-return": "off",
+      "@typescript-eslint/no-shadow": [
+        "error",
+        {
+            "hoist": "all"
+        }
+      ],
+      "arrow-parens": [
+          "off",
+          "always"
+      ],
+      "comma-dangle": ["error", "always-multiline"],
+      "complexity": "off",
+      "constructor-super": "error",
+      "eqeqeq": [
+          "error",
+          "smart"
+      ],
+      "guard-for-in": "error",
+      "id-blacklist": "off",
+      "id-match": "off",
+      "import/order": "off",
+      "jsdoc/check-alignment": "error",
+      "jsdoc/check-indentation": "error",
+      "jsdoc/newline-after-description": "error",
+      "max-classes-per-file": [
+          "error",
+          1
+      ],
+      "max-len": [
+          "error",
+          {
+              "code": 150
+          }
+      ],
+      "new-parens": "error",
+      "no-bitwise": "error",
+      "no-caller": "error",
+      "no-cond-assign": "error",
+      "no-console": "off",
+      "no-debugger": "error",
+      "no-empty": "off",
+      "no-eval": "error",
+      "no-fallthrough": "off",
+      "no-invalid-this": "off",
+      "no-new-wrappers": "error",
+      "no-throw-literal": "error",
+      "no-trailing-spaces": "error",
+      "no-undef-init": "error",
+      "no-underscore-dangle": "off",
+      "no-unsafe-finally": "error",
+      "no-unused-labels": "error",
+      "no-var": "error",
+      "object-shorthand": "error",
+      "one-var": [
+          "error",
+          "never"
+      ],
+      "prefer-const": "error",
+      "radix": "error",
+      "semi": "error",
+      "spaced-comment": [
+          "error",
+          "always",
+          {
+              "markers": [
+                  "/"
+              ]
+          }
+      ],
+      "use-isnan": "error",
+      "valid-typeof": "off"
+  }
+}

express/README.md

@@ -11,10 +11,11 @@ npm install @decorators/express --save
 ### API
 #### Functions
 * **attachControllers(app: Express.Application | Express.Router, controllers: Controller[])** - attach controllers to express application
+* **attachControllerInstances(app: Express.Application | Express.Router, controllers: Controller[])** - attach already existing instances of controllers
 
 #### Decorators
 ##### Class
-* **@Controller(baseUrl: string, middleware?: Middleware[])** - Registers controller for base url
+* **@Controller(baseUrl: string, middleware?: Middleware[])**, **@Controller(baseUrl: string, routerOptions: RouterOptions, middleware?: Middleware[])** - Registers controller for base url
 
 ##### Method
 * **@All(url: string, middleware?: Middleware[])** - Registers all routes
@@ -25,6 +26,7 @@ npm install @decorators/express --save
 * **@Patch(url: string, middleware?: Middleware[])** - Registers patch route
 * **@Options(url: string, middleware?: Middleware[])** - Registers options route
 * **@Head(url: string, middleware?: Middleware[])** - Registers head route
+* **@Status(code: number)** - Specifies status code for the route
 
 where middleware is the class that implements `Middleware` interface.
 
@@ -39,6 +41,14 @@ class UserMiddleware implements Middleware {
 }
 ```
 
+or a simple function
+
+```typescript
+function userMiddleware(request: Request, response: Response, next: NextFunction): void {
+  next();
+}
+```
+
 ##### Parameter
 * **@Request(property?: string)** (alias **@Req(property?: string)**) - Returns express req object or any other object, if name was specified
 * **@Response()** (alias **@Res**) - Returns express res object
@@ -67,6 +77,20 @@ Container.provide([
 ]);
 ```
 
+or as a function
+
+```typescript
+import { ERROR_MIDDLEWARE } from '@decorators/express';
+
+function serverErrorMiddleware(error: Error, request: Request, response: Response, next: NextFunction) {
+  next();
+}
+
+Container.provide([
+  { provide: ERROR_MIDDLEWARE, useValue: serverErrorMiddleware }
+]);
+```
+
 #### Dependency injection
 This module supports dependency injection provided by `@decorators/di` module. For example, see the full example below.