Add missing references to ObjectLiteral

Author: erlendfh

README.md

@@ -233,7 +233,7 @@ For all entities we want to create, we need to define a factory. To do so we giv
 
 | Types           | Description                                                                     |
 | --------------- | ------------------------------------------------------------------------------- |
-| `Entity`         | TypeORM Entity like the user or the pet in the samples.                          |
+| `Entity`        | TypeORM Entity like the user or the pet in the samples.                         |
 | `Context`       | Argument to pass some static data into the factory function.                    |
 | `EntityFactory` | This object is used to make new filled entities or create it into the database. |
 
@@ -242,7 +242,7 @@ For all entities we want to create, we need to define a factory. To do so we giv
 The define function creates a new entity factory.
 
 ```typescript
-define: <Entity, Context>(entity: Entity, factoryFn: FactoryFunction<Entity, Context>) => void;
+define: <Entity extends ObjectLiteral, Context>(entity: Entity, factoryFn: FactoryFunction<Entity, Context>) => void;
 ```
 
 ```typescript
@@ -258,7 +258,7 @@ define(User, (faker: typeof Faker, context: { roles: string[] }) => { ... })
 Factory retrieves the defined factory function and returns the EntityFactory to start creating new enities.
 
 ```typescript
-factory: (entity: Entity) => (context?: Context) => EntityFactory<Entity, Context>
+factory: (entity: Entity extends ObjectLiteral) => (context?: Context) => EntityFactory<Entity, Context>
 ```
 
 ```typescript
@@ -273,7 +273,7 @@ factory(Pet)({ name: 'Balou' })
 Use the `.map()` function to alter the generated value before they get persisted.
 
 ```typescript
-map(mapFunction: (entity: Entity) => Promise<Entity>): EntityFactory<Entity, Context>
+map(mapFunction: (entity: Entity extends ObjectLiteral) => Promise<Entity>): EntityFactory<Entity, Context>
 ```
 
 ```typescript

src/typeorm-seeding.ts

@@ -1,5 +1,5 @@
 import 'reflect-metadata'
-import { ObjectType, DataSource } from 'typeorm'
+import { ObjectType, DataSource, ObjectLiteral } from 'typeorm'
 
 import { EntityFactory } from './entity-factory'
 import { EntityFactoryDefinition, Factory, FactoryFunction, SeederConstructor, Seeder } from './types'
@@ -33,15 +33,18 @@ export { times } from './helpers'
 // Facade functions
 // -------------------------------------------------------------------------
 
-export const define = <Entity, Context>(entity: ObjectType<Entity>, factoryFn: FactoryFunction<Entity, Context>) => {
+export const define = <Entity extends ObjectLiteral, Context>(
+  entity: ObjectType<Entity>,
+  factoryFn: FactoryFunction<Entity, Context>,
+) => {
   ;(global as any).seeder.entityFactories.set(getNameOfEntity(entity), {
     entity,
     factory: factoryFn,
   })
 }
 
 export const factory: Factory =
-  <Entity, Context>(entity: ObjectType<Entity>) =>
+  <Entity extends ObjectLiteral, Context>(entity: ObjectType<Entity>) =>
   (context?: Context) => {
     const name = getNameOfEntity(entity)
     const entityFactoryObject = (global as any).seeder.entityFactories.get(name)

src/types.ts

@@ -1,22 +1,22 @@
 import * as Faker from 'faker'
-import { DataSource, ObjectType } from 'typeorm'
+import { DataSource, ObjectType, ObjectLiteral } from 'typeorm'
 
 import { EntityFactory } from './entity-factory'
 
 /**
  * FactoryFunction is the fucntion, which generate a new filled entity
  */
-export type FactoryFunction<Entity, Context> = (faker: typeof Faker, context?: Context) => Entity
+export type FactoryFunction<Entity extends ObjectLiteral, Context> = (faker: typeof Faker, context?: Context) => Entity
 
 /**
  * EntityProperty defines an object whose keys and values must be properties of the given Entity.
  */
-export type EntityProperty<Entity> = { [Property in keyof Entity]?: Entity[Property] }
+export type EntityProperty<Entity extends ObjectLiteral> = { [Property in keyof Entity]?: Entity[Property] }
 
 /**
  * Factory gets the EntityFactory to the given Entity and pass the context along
  */
-export type Factory = <Entity, Context>(
+export type Factory = <Entity extends ObjectLiteral, Context>(
   entity: ObjectType<Entity>,
 ) => (context?: Context) => EntityFactory<Entity, Context>
 
@@ -35,7 +35,7 @@ export type SeederConstructor = new () => Seeder
 /**
  * Value of our EntityFactory state
  */
-export interface EntityFactoryDefinition<Entity, Context> {
+export interface EntityFactoryDefinition<Entity extends ObjectLiteral, Context> {
   entity: ObjectType<Entity>
   factory: FactoryFunction<Entity, Context>
 }