@tsed/di 6.72.2 → 6.73.2

package/lib/decorators/controller.d.ts

@@ -0,0 +1,43 @@
+import { Type } from "@tsed/core";
+import { IProvider } from "../interfaces/IProvider";
+export declare type PathType = string | RegExp | (string | RegExp)[];
+export interface ControllerMiddlewares {
+    useBefore: any[];
+    use: any[];
+    useAfter: any[];
+}
+export interface ControllerOptions extends Partial<IProvider<any>> {
+    path?: PathType;
+    children?: Type<any>[];
+    routerOptions?: any;
+    middlewares?: Partial<ControllerMiddlewares>;
+}
+/**
+ * Declare a new controller with his Rest path. His methods annotated will be collected to build the routing list.
+ * This routing listing will be built with the `express.Router` object.
+ *
+ * ::: tip
+ * See [Controllers](/docs/controllers.md) section for more details
+ * :::
+ *
+ * ```typescript
+ *  @Controller("/calendars")
+ *  export provide CalendarCtrl {
+ *
+ *    @Get("/:id")
+ *    public get(
+ *      @Req() request: Req,
+ *      @Res() response: Res,
+ *      @Next() next: Next
+ *    ): void {
+ *
+ *    }
+ *  }
+ * ```
+ *
+ * @param options
+ * @controller
+ * @decorator
+ * @classDecorator
+ */
+export declare function Controller(options: PathType | ControllerOptions): ClassDecorator;

package/lib/decorators/index.d.ts

@@ -11,3 +11,4 @@ export * from "./configuration";
 export * from "./module";
 export * from "./opts";
 export * from "./useOpts";
+export * from "./controller";

package/lib/index.js

@@ -600,7 +600,7 @@ class ContextLogger {
 
 }
 
-const _excluded$1 = ["id", "injector", "logger", "ignoreLog"];
+const _excluded$2 = ["id", "injector", "logger", "ignoreLog"];
 class DIContext extends Map {
   constructor(_ref) {
     let {
@@ -609,7 +609,7 @@ class DIContext extends Map {
       logger,
       ignoreLog
     } = _ref,
-        options = _objectWithoutPropertiesLoose(_ref, _excluded$1);
+        options = _objectWithoutPropertiesLoose(_ref, _excluded$2);
 
     super();
     /**
@@ -1086,7 +1086,7 @@ function Configuration(configuration = {}) {
   };
 }
 
-const _excluded = ["scopes", "imports", "resolvers", "deps", "scope"];
+const _excluded$1 = ["scopes", "imports", "resolvers", "deps", "scope"];
 /**
  * Declare a new Ts.ED module
  *
@@ -1105,7 +1105,7 @@ function Module(options = {}) {
     resolvers,
     deps
   } = options,
-        configuration = _objectWithoutPropertiesLoose(options, _excluded);
+        configuration = _objectWithoutPropertiesLoose(options, _excluded$1);
 
   return core.useDecorators(Configuration(configuration), Injectable({
     type: exports.ProviderType.MODULE,
@@ -1226,6 +1226,65 @@ function UseOpts(options) {
   };
 }
 
+const _excluded = ["children"];
+
+function mapOptions(options) {
+  if (typeof options === "string" || options instanceof RegExp || core.isArrayOrArrayClass(options)) {
+    return {
+      path: options
+    };
+  }
+
+  return options;
+}
+/**
+ * Declare a new controller with his Rest path. His methods annotated will be collected to build the routing list.
+ * This routing listing will be built with the `express.Router` object.
+ *
+ * ::: tip
+ * See [Controllers](/docs/controllers.md) section for more details
+ * :::
+ *
+ * ```typescript
+ *  @Controller("/calendars")
+ *  export provide CalendarCtrl {
+ *
+ *    @Get("/:id")
+ *    public get(
+ *      @Req() request: Req,
+ *      @Res() response: Res,
+ *      @Next() next: Next
+ *    ): void {
+ *
+ *    }
+ *  }
+ * ```
+ *
+ * @param options
+ * @controller
+ * @decorator
+ * @classDecorator
+ */
+
+
+function Controller(options) {
+  const _mapOptions = mapOptions(options),
+        {
+    children = []
+  } = _mapOptions,
+        opts = _objectWithoutPropertiesLoose(_mapOptions, _excluded);
+
+  return target => {
+    registerController(_extends({
+      provide: target
+    }, opts));
+    core.Store.from(target).set("childrenControllers", children);
+    children.forEach(childToken => {
+      core.Store.from(childToken).set("parentController", target);
+    });
+  };
+}
+
 class InjectionError extends Error {
   constructor(token, origin) {
     super(core.isString(origin) ? origin : "");
@@ -2238,6 +2297,7 @@ exports.Configuration = Configuration;
 exports.Constant = Constant;
 exports.Container = Container;
 exports.ContextLogger = ContextLogger;
+exports.Controller = Controller;
 exports.DIConfiguration = DIConfiguration;
 exports.DIContext = DIContext;
 exports.DITest = DITest;