refactor(seeder): use community driven faker fork and reexport it

Closes #2673

Author: B4nan

docs/docs/seeding.md

@@ -75,14 +75,13 @@ When testing you may insert entities in the database before starting a test. Ins
 
 Lets have a look at an example factory for an [Author entity](http://mikro-orm.io/docs/defining-entities).
 ```typescript
-import { Factory } from '@mikro-orm/seeder';
-import Faker from 'faker';
+import { Factory, Faker } from '@mikro-orm/seeder';
 import { Author } from './entities/author.entity';
 
 export class AuthorFactory extends Factory<Author> {
   model = Author;
 
-  definition(faker: typeof Faker): Partial<Author> {
+  definition(faker: Faker): Partial<Author> {
     return {
       name: faker.person.findName(),
       email: faker.internet.email(),
@@ -93,25 +92,25 @@ export class AuthorFactory extends Factory<Author> {
 ``` 
 Basically you extend the base `Factory` class, define a `model` property and a `definition` method. The `model` defines for which entity the factory generates entity instances. The `definition` method returns the default set of attribute values that should be applied when creating an entity using the factory.
 
-Via the faker property, factories have access to the [Faker library](https://github.com/marak/Faker.js/), which allows you to conveniently generate various kinds of random data for testing.
+Via the faker property, factories have access to the [Faker library](https://github.com/faker-js/faker), which allows you to conveniently generate various kinds of random data for testing.
 
 ### Creating entities using factories
 Once you defined your factories you can use them to generate entities. Simply import the factory, instantiate it and call the `makeOne` method.
 ```typescript
-const author: Author = new AuthorFactory(orm.em).makeOne();
+const author = new AuthorFactory(orm.em).makeOne();
 ```
 
 #### Generate multiple entities
 Generate multiple entities by calling the `make` method. The parameter of the `make` method is the number of entities you generate.
 ```typescript
 // Generate 5 authors
-const authors: Author[] = new AuthorFactory(orm.em).make(5);
+const authors = new AuthorFactory(orm.em).make(5);
 ``` 
 
 #### Overriding attributes
 If you would like to override some of the default values of your factories, you may pass an object to the make method. Only the specified attributes will be replaced while the rest of the attributes remain set to their default values as specified by the factory.
 ```typescript
-const author: Author = new AuthorFactory(orm.em).make({
+const author = new AuthorFactory(orm.em).make({
     name: 'John Snow'
 });
 ``` 
@@ -120,20 +119,20 @@ const author: Author = new AuthorFactory(orm.em).make({
 The `create` method instantiates entities and persists them to the database using the `persistAndFlush` method of the EntityManager.
 ```typescript
 // Make and persist a single author
-const author: Author = await new AuthorFactory(orm.em).createOne();
+const author = await new AuthorFactory(orm.em).createOne();
 
 // Make and persist 5 authors
-const authors: Author[] = await new AuthorFactory(orm.em).create(5);
+const authors = await new AuthorFactory(orm.em).create(5);
 ```
 You can override the default values of your factories by passing an object to the `create` method.
 ```typescript
 // Make and persist a single author
-const author: Author = await new AuthorFactory(orm.em).createOne({
+const author = await new AuthorFactory(orm.em).createOne({
     name: 'John Snow'
 });
 
 // Make and persist a 5 authors
-const authors: Author[] = await new AuthorFactory(orm.em).create(5, {
+const authors = await new AuthorFactory(orm.em).create(5, {
     name: 'John Snow'
 });
 ```

packages/seeder/package.json

@@ -48,13 +48,12 @@
     "access": "public"
   },
   "dependencies": {
-    "faker": "5.5.3"
+    "@faker-js/faker": "6.0.0-alpha.5"
   },
   "peerDependencies": {
     "@mikro-orm/core": "^5.0.0-rc.0"
   },
   "devDependencies": {
-    "@mikro-orm/core": "^5.0.0-rc.0",
-    "@types/faker": "5.5.9"
+    "@mikro-orm/core": "^5.0.0-rc.0"
   }
 }

packages/seeder/src/factory.ts

@@ -1,21 +1,23 @@
-import Faker from 'faker';
+import type { Faker } from '@faker-js/faker';
+import faker from '@faker-js/faker';
 import type { EntityManager } from '@mikro-orm/core';
 
 export abstract class Factory<C> {
 
   abstract readonly model: { new(): C };
   private eachFunction?: (entity: C) => void;
 
-  constructor(private readonly em: EntityManager) {
-  }
+  constructor(private readonly em: EntityManager) { }
 
-  protected abstract definition(faker: typeof Faker): Partial<C>;
+  protected abstract definition(faker: Faker): Partial<C>;
 
   private makeEntity(overrideParameters?: Partial<C>): C {
-    const entity = this.em.create(this.model, Object.assign({}, this.definition(Faker), overrideParameters));
+    const entity = this.em.create(this.model, Object.assign({}, this.definition(faker), overrideParameters));
+
     if (this.eachFunction) {
       this.eachFunction(entity);
     }
+
     return entity;
   }
 

packages/seeder/src/index.ts

@@ -5,3 +5,7 @@
 export * from './seeder';
 export * from './factory';
 export * from './seed-manager';
+
+// reexport faker instance and Faker type
+import faker, { Faker } from '@faker-js/faker';
+export { faker, Faker };

tests/features/seeder/factory.test.ts

@@ -1,7 +1,7 @@
 import { MikroORM } from '@mikro-orm/core';
 import { Factory } from '@mikro-orm/seeder';
 import type { SqliteDriver } from '@mikro-orm/sqlite';
-import type * as Faker from 'faker';
+import type { Faker } from '@mikro-orm/seeder';
 import { House } from './entities/house.entity';
 import { Project } from './entities/project.entity';
 import SpyInstance = jest.SpyInstance;
@@ -10,7 +10,7 @@ export class ProjectFactory extends Factory<Project> {
 
   model = Project;
 
-  definition(faker: typeof Faker): Partial<Project> {
+  definition(faker: Faker): Partial<Project> {
     return {
       name: 'Money vault',
       owner: faker.name.findName(),
@@ -24,7 +24,7 @@ export class HouseFactory extends Factory<House> {
 
   model = House;
 
-  definition(faker: typeof Faker): Partial<House> {
+  definition(faker: Faker): Partial<House> {
     return {
       address: faker.address.city(),
     };