Develop

package.json

@@ -40,6 +40,7 @@
   },
   "devDependencies": {
     "@eslint/compat": "^1.1.1",
+    "@faker-js/faker": "^9.0.3",
     "@jest/test-sequencer": "^29.7.0",
     "@types/bcryptjs": "^2.4.6",
     "@types/body-parser": "^1.19.5",

src/core/base/Factory.ts

@@ -1,13 +1,22 @@
-import IFactory from "@src/core/interfaces/IFactory";
+import { faker } from "@faker-js/faker";
 import { ICtor } from "@src/core/interfaces/ICtor";
+import IFactory from "@src/core/interfaces/IFactory";
+
+import { IModel } from "../interfaces/IModel";
+import IModelAttributes from "../interfaces/IModelData";
 
 /**
  * Abstract base class for factories that create instances of a specific model.
  *
  * @template Model The type of model to create.
  * @template Data The type of data to pass to the model constructor.
  */
-export default abstract class Factory<Model, Data> implements IFactory {
+export default abstract class Factory<Model extends IModel = IModel> implements IFactory {
+
+    /**
+     * The faker instance to use.
+     */
+    protected faker = faker;
 
     /**
      * The constructor of the model to create.
@@ -29,8 +38,8 @@ export default abstract class Factory<Model, Data> implements IFactory {
      * @param data The data to pass to the model constructor.
      * @returns A new instance of the model.
      */
-    create(data: Data): Model {
+    createWithData<Data extends IModelAttributes = IModelAttributes>(data: Data | null = null): Model {
         return new this.modelCtor(data)
     }
-
+
 }

src/core/domains/auth/actions/create.ts

@@ -28,7 +28,7 @@ export default async (req: Request, res: Response): Promise<void> => {
         }
 
         // Create a new user
-        const user = new UserFactory().create({
+        const user = new UserFactory().createWithData({
             email,
             password,
             hashedPassword: hashPassword(password ?? ''),

src/core/domains/auth/factory/apiTokenFactory.ts

@@ -1,16 +1,13 @@
 import ApiToken from '@src/app/models/auth/ApiToken'
 import Factory from '@src/core/base/Factory'
-import IApiTokenModel, { IApiTokenData } from '@src/core/domains/auth/interfaces/IApitokenModel'
+import IApiTokenModel from '@src/core/domains/auth/interfaces/IApitokenModel'
 import IUserModel from '@src/core/domains/auth/interfaces/IUserModel'
 import tokenFactory from '@src/core/domains/auth/utils/generateToken'
 
 /**
  * Factory for creating ApiToken models.
- *
- * @class ApiTokenFactory
- * @extends {Factory<IApiTokenModel, IApiTokenData>}
  */
-class ApiTokenFactory extends Factory<IApiTokenModel, IApiTokenData> {
+class ApiTokenFactory extends Factory<IApiTokenModel> {
 
     constructor() {
         super(ApiToken)
@@ -23,7 +20,7 @@ class ApiTokenFactory extends Factory<IApiTokenModel, IApiTokenData> {
      * @returns {IApiTokenModel}
      */
     createFromUser(user: IUserModel, scopes: string[] = []): IApiTokenModel {
-        return new this.modelCtor({
+        return this.createWithData({
             userId: user.attributes?.id,
             token: tokenFactory(),
             scopes: scopes,

src/core/domains/auth/factory/userFactory.ts

@@ -7,7 +7,7 @@ import Factory from '@src/core/base/Factory';
  * @class UserFactory
  * @extends {Factory<User, IUserData>}
  */
-export default class UserFactory extends Factory<User, IUserData> {
+export default class UserFactory extends Factory<User> {
 
     /**
      * Constructor

src/core/interfaces/IFactory.ts

@@ -1,4 +1,5 @@
+
 export default interface IFactory {
     // eslint-disable-next-line no-unused-vars
-    create(...args: any[]): any;
+    createWithData(...args: any[]): any;
 }

src/tests/auth/auth.test.ts

@@ -36,7 +36,7 @@ describe('attempt to run app with normal appConfig', () => {
         /**
          * Create a test user
          */
-        testUser = new UserFactory().create({
+        testUser = new UserFactory().createWithData({
             email,
             hashedPassword,
             roles: [],

src/tests/factory/TestMovieFaker.ts

@@ -0,0 +1,23 @@
+import Factory from "@src/core/base/Factory";
+
+import { TestMovieModel } from "../models/models/TestMovie";
+
+class TestMovieFactory extends Factory<TestMovieModel> {
+
+    constructor() {
+        super(TestMovieModel)
+    }
+
+    createFakeMovie(): TestMovieModel {
+        return this.createWithData({
+            authorId: this.faker.number.int({ min: 1, max: 100 }).toString(),
+            name: this.faker.person.fullName(),
+            yearReleased: this.faker.number.int({ min: 1900, max: 2000 }),
+            createdAt: this.faker.date.past(),
+            updatedAt: this.faker.date.recent()
+        })
+    }
+
+}
+
+export default TestMovieFactory

src/tests/factory/factory.test.ts

@@ -0,0 +1,36 @@
+/* eslint-disable no-undef */
+import { describe } from '@jest/globals';
+import Kernel from '@src/core/Kernel';
+import testAppConfig from '@src/tests/config/testConfig';
+
+import TestDatabaseProvider from '../providers/TestDatabaseProvider';
+import TestMovieFactory from './TestMovieFaker';
+
+describe('test migrations', () => {
+
+
+    beforeAll(async () => {
+        await Kernel.boot({
+            ...testAppConfig,
+            providers: [
+                ...testAppConfig.providers,
+                new TestDatabaseProvider()
+            ]
+        }, {})
+
+
+    });
+
+
+    test('test factory', async () => {
+        const factory = new TestMovieFactory();
+        const movie = factory.createFakeMovie();
+
+        expect(movie).toBeTruthy();
+        expect(typeof movie.getAttribute('authorId') === 'string').toEqual(true);
+        expect(typeof movie.getAttribute('name') === 'string').toEqual(true);
+        expect(typeof movie.getAttribute('yearReleased') === 'number').toEqual(true);
+        expect(movie.getAttribute('createdAt') instanceof Date).toEqual(true);
+        expect(movie.getAttribute('updatedAt') instanceof Date).toEqual(true);
+    });
+});

yarn.lock

@@ -380,6 +380,11 @@
   dependencies:
     levn "^0.4.1"
 
+"@faker-js/faker@^9.0.3":
+  version "9.0.3"
+  resolved "https://registry.yarnpkg.com/@faker-js/faker/-/faker-9.0.3.tgz#be817db896b07d1716bc65d9aad1ba587b499826"
+  integrity sha512-lWrrK4QNlFSU+13PL9jMbMKLJYXDFu3tQfayBsMXX7KL/GiQeqfB1CzHkqD5UHBUtPAuPo6XwGbMFNdVMZObRA==
+
 "@gar/promisify@^1.0.1":
   version "1.1.3"
   resolved "https://registry.yarnpkg.com/@gar/promisify/-/promisify-1.1.3.tgz#555193ab2e3bb3b6adc3d551c9c030d9e860daf6"