Issue nestjs#59 - hierarchical injector improvements

Author: kamil.mysliwiec

CHANGELOG.md

@@ -1,3 +1,6 @@
+- Hierarchical injector. Injector improvements,
+- @Shared() decorator for scoped Modules,
+
 ## 1.0.0 (Final - 01.05.2017)
 
 - Added **Gateway Middlewares** support:

example/modules/app.module.ts

@@ -1,6 +1,8 @@
 import { Module } from './../../src/';
 import { UsersModule } from './users/users.module';
 import { ClientController } from './client/client.controller';
+import { Component } from '../../src/common/index';
+import { UsersService } from './users/users.service';
 
 @Module({
     modules: [ UsersModule ],

example/modules/shared/shared.module.ts

@@ -1,6 +1,8 @@
 import { Module } from '../../../src/common/utils/decorators/module.decorator';
 import { ChatGateway } from '../users/chat.gateway';
+import { Shared } from '../../../src/index';
 
+@Shared()
 @Module({
     components: [ ChatGateway ],
     exports: [ ChatGateway ],

example/modules/users/users.controller.ts

@@ -9,8 +9,7 @@ import { CustomExceptionFilter } from './exception.filter';
 @Controller('users')
 @ExceptionFilters(CustomExceptionFilter)
 export class UsersController {
-    constructor(
-        private usersService: UsersService) {}
+    constructor(private usersService: UsersService) {}
 
     @Get()
     public async getAllUsers(@Response() res: express.Response) {

example/modules/users/users.module.ts

@@ -1,4 +1,4 @@
-import { Module } from './../../../src/';
+import { Module, Shared } from './../../../src/';
 import { UsersController } from './users.controller';
 import { UsersService } from './users.service';
 import { AuthMiddleware } from './auth.middleware';

src/common/constants.ts

@@ -5,6 +5,8 @@ export const metadata = {
     EXPORTS: 'exports',
 };
 
+export const SHARED_MODULE_METADATA = '__sharedModule__';
+
 export const PATH_METADATA = 'path';
 export const PARAMTYPES_METADATA = 'design:paramtypes';
 export const SELF_DECLARED_DEPS_METADATA = 'self:paramtypes';

src/common/interfaces/module-metadata.interface.ts

@@ -2,7 +2,7 @@ import { NestModule } from './nest-module.interface';
 import { Controller } from './controller.interface';
 
 export interface ModuleMetadata {
-    modules?: NestModule[];
+    modules?: NestModule[] | any[];
     components?: any[];
     controllers?: Controller[] | any[];
     exports?: any[];

src/common/test/utils/shared.decorator.spec.ts

@@ -0,0 +1,21 @@
+import 'reflect-metadata';
+import { expect } from 'chai';
+import { Shared } from '../../utils/decorators/shared.decorator';
+import { SHARED_MODULE_METADATA } from '../../constants';
+
+describe('Shared', () => {
+    let type;
+    const token = '_';
+    class Test {}
+
+    beforeEach(() => {
+        type = Shared(token)(Test);
+    });
+    it('should enrich metatype with SharedModule token', () => {
+        const opaqueToken = Reflect.getMetadata(SHARED_MODULE_METADATA, type);
+        expect(opaqueToken).to.be.equal(token);
+    });
+    it('should set name of the metatype', () => {
+        expect(type.name).to.eq(Test.name);
+    });
+});

src/common/utils/decorators/shared.decorator.ts

@@ -0,0 +1,18 @@
+import 'reflect-metadata';
+import { ControllerMetadata } from '../../interfaces/controller-metadata.interface';
+import { isString } from '../shared.utils';
+import { PATH_METADATA, SHARED_MODULE_METADATA } from '../../constants';
+import { NestModuleMetatype } from '../../interfaces/module-metatype.interface';
+
+export const Shared = (token: string = 'global'): ClassDecorator => {
+    return (target: FunctionConstructor) => {
+        const Type = class extends target {
+            constructor(...args) {
+                super(...args);
+            }
+        };
+        Reflect.defineMetadata(SHARED_MODULE_METADATA, token, Type);
+        Object.defineProperty(Type, 'name', { value: target.name });
+        return Type;
+    };
+};

src/common/utils/index.ts

@@ -7,4 +7,5 @@ export * from './decorators/inject.decorator';
 export { Component as Middleware } from './decorators/component.decorator';
 export * from './decorators/route-params.decorator';
 export * from './decorators/catch.decorator';
-export * from './decorators/exception-filters.decorator';
+export * from './decorators/exception-filters.decorator';
+export * from './decorators/shared.decorator';