added OrmConnection decorator and some docs

Author: Umed Khudoiberdiev

README.md

@@ -1 +1,234 @@
 # TypeDI Service container integration with TypeORM
+
+This extension for TypeORM provides handy decorators that can be used with [typedi](https://github.com/pleerock/typedi).
+
+## Installation
+
+* Install module:
+
+`npm install typeorm-typedi-extensions --save`
+
+* Install TypeDI:
+
+`npm install typedi --save`
+
+* Configure in your app TypeORM to use TypeDI Container, before you create a connection:
+
+```typescript
+import "reflect-metadata";
+import {createConnection, useContainer} from "typeorm";
+import {Container} from "typedi";
+
+useContainer(Container);
+createConnection({ 
+    /// ....
+}); 
+```
+
+* That's all, start using decorators!
+
+
+## Usage
+
+All decorators can be used on properties and constructor arguments, e.g. you can use both
+property and constructor injection.
+
+### @OrmConnection
+
+Injects `Connection` from where you can access anything in your connection.
+
+Example using property injection:
+
+```typescript
+import {Service} from "typedi";
+import {Connection} from "typeorm";
+import {OrmConnection} from "typeorm-typedi-extensions";
+
+@Service()
+export class PostRepository {
+    
+    @OrmConnection()
+    private connection: Connection;
+    
+}
+```
+
+Example using constructor injection:
+
+```typescript
+import {Service} from "typedi";
+import {Connection} from "typeorm";
+import {OrmConnection} from "typeorm-typedi-extensions";
+
+@Service()
+export class PostRepository {
+    
+    constructor(@OrmConnection() private connection: Connection) {
+    }
+    
+}
+```
+
+Optionally, you can specify a connection name in the decorator parameters.
+
+### @OrmEntityManager
+
+Injects `EntityManager` from where you can access any entity in your connection. 
+
+Example using property injection:
+
+```typescript
+import {Service} from "typedi";
+import {EntityManager} from "typeorm";
+import {OrmEntityManager} from "typeorm-typedi-extensions";
+
+@Service()
+export class PostRepository {
+    
+    @OrmEntityManager()
+    private entityManager: EntityManager;
+    
+}
+```
+
+Example using constructor injection:
+
+```typescript
+import {Service} from "typedi";
+import {EntityManager} from "typeorm";
+import {OrmEntityManager} from "typeorm-typedi-extensions";
+
+@Service()
+export class PostRepository {
+    
+    constructor(@OrmEntityManager() private entityManager: EntityManager) {
+    }
+    
+}
+```
+
+Optionally, you can specify a connection name in the decorator parameters.
+
+### @OrmRepository
+
+Injects `Repository` of some Entity.
+
+Example using property injection:
+
+```typescript
+import {Service} from "typedi";
+import {Repository} from "typeorm";
+import {OrmRepository} from "typeorm-typedi-extensions";
+import "../entity/Post";
+
+@Service()
+export class PostRepository {
+    
+    @OrmRepository(Post)
+    private repository: Repository<Post>;
+    
+}
+```
+
+Example using constructor injection:
+
+```typescript
+import {Service} from "typedi";
+import {Repository} from "typeorm";
+import {OrmRepository} from "typeorm-typedi-extensions";
+import "../entity/Post";
+
+@Service()
+export class PostRepository {
+    
+    constructor(@OrmRepository(Post) private repository: Repository<Post>) {
+    }
+    
+}
+```
+
+Optionally, you can specify a connection name in the decorator parameters.
+
+### @OrmTreeRepository
+
+Injects `TreeRepository` of some Entity.
+
+Example using property injection:
+
+```typescript
+import {Service} from "typedi";
+import {TreeRepository} from "typeorm";
+import {OrmTreeRepository} from "typeorm-typedi-extensions";
+import "../entity/Post";
+
+@Service()
+export class PostRepository {
+    
+    @OrmTreeRepository(Post)
+    private repository: TreeRepository<Post>;
+    
+}
+```
+
+Example using constructor injection:
+
+```typescript
+import {Service} from "typedi";
+import {TreeRepository} from "typeorm";
+import {OrmTreeRepository} from "typeorm-typedi-extensions";
+import "../entity/Post";
+
+@Service()
+export class PostRepository {
+    
+    constructor(@OrmTreeRepository(Post) private repository: TreeRepository<Post>) {
+    }
+    
+}
+```
+
+Optionally, you can specify a connection name in the decorator parameters.
+
+### @OrmSpecificRepository
+
+Injects `SpecificRepository` of some Entity.
+
+Example using property injection:
+
+```typescript
+import {Service} from "typedi";
+import {SpecificRepository} from "typeorm";
+import {OrmSpecificRepository} from "typeorm-typedi-extensions";
+import "../entity/Post";
+
+@Service()
+export class PostRepository {
+    
+    @OrmSpecificRepository(Post)
+    private repository: SpecificRepository<Post>;
+    
+}
+```
+
+Example using constructor injection:
+
+```typescript
+import {Service} from "typedi";
+import {SpecificRepository} from "typeorm";
+import {OrmSpecificRepository} from "typeorm-typedi-extensions";
+import "../entity/Post";
+
+@Service()
+export class PostRepository {
+    
+    constructor(@OrmSpecificRepository(Post) private repository: SpecificRepository<Post>) {
+    }
+    
+}
+```
+
+Optionally, you can specify a connection name in the decorator parameters.
+
+## Samples
+
+Take a look on samples in [./sample](sample) for examples of usages.

package.json

@@ -26,11 +26,11 @@
     "pg": "^6.1.0",
     "reflect-metadata": "^0.1.8",
     "typedi": "^0.4.2",
-    "typeorm": "^0.0.2-alpha.62",
+    "typeorm": "^0.0.2-alpha.63",
     "typescript": "^2.0.2"
   },
   "peerDependencies": {
-    "typeorm": "^0.0.2-alpha.62",
+    "typeorm": "^0.0.2-alpha.63",
     "typedi": "^0.4.2"
   }
 }

src/decorators/OrmConnection.ts

@@ -0,0 +1,26 @@
+import {ConnectionManager} from "typeorm";
+import {Container} from "typedi";
+
+/**
+ * Allows to inject an Connection using typedi's Container.
+ */
+export function OrmConnection(connectionName: string = "default"): Function {
+    return function(target: Object|Function, propertyName: string, index?: number) {
+
+        const getValue = () => {
+            const connectionManager = Container.get(ConnectionManager);
+            if (!connectionManager.has(connectionName))
+                throw new Error(`Cannot get connection "${connectionName}" from the connection manager. ` +
+                `Make sure you have created such connection. Also make sure you have called useContainer(Container) ` +
+                `in your application before you established a connection and importing any entity.`);
+
+            return connectionManager.get(connectionName);
+        };
+
+        if (index !== undefined) {
+            Container.registerParamHandler({ type: target as Function, index: index, getValue: getValue });
+        } else {
+            Container.registerPropertyHandler({ target: target as Function /* todo: looks like typedi wrong type here */, key: propertyName, getValue: getValue });
+        }
+    };
+}

src/index.ts

@@ -1,3 +1,4 @@
+export * from "./decorators/OrmConnection";
 export * from "./decorators/OrmEntityManager";
 export * from "./decorators/OrmRepository";
 export * from "./decorators/OrmSpecificRepository";