@forklaunch/core 0.1.0

package/dist/services/interfaces/baseService.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=baseService.js.map

package/dist/services/interfaces/baseService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseService.js","sourceRoot":"","sources":["../../../services/interfaces/baseService.ts"],"names":[],"mappings":""}

package/dist/tests/dto.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/dto.test.js

@@ -0,0 +1,179 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const typebox_1 = require("@forklaunch/validator/typebox");
+const base_entity_1 = require("../database/mikro/models/entities/base.entity");
+const requestEntityMapper_model_1 = require("../entityMapper/models/requestEntityMapper.model");
+const responseEntityMapper_model_1 = require("../entityMapper/models/responseEntityMapper.model");
+class TestEntity extends base_entity_1.BaseEntity {
+    name;
+    age;
+}
+class T extends requestEntityMapper_model_1.RequestEntityMapper {
+    toEntity(...additionalArgs) {
+        const entity = new TestEntity();
+        entity.id = this.dto.id;
+        entity.name = this.dto.name;
+        entity.age = this.dto.age;
+        return entity;
+    }
+    schema = {
+        id: typebox_1.string,
+        name: typebox_1.string,
+        age: typebox_1.number
+    };
+}
+const y = new T(new typebox_1.TypeboxSchemaValidator());
+y.fromJson({ id: '123', name: 'test', age: 1 });
+var x = { id: '123', name: 'test', age: 1 };
+T.fromJson(new typebox_1.TypeboxSchemaValidator(), x);
+T.fromJson(new typebox_1.TypeboxSchemaValidator(), {
+    id: '123',
+    name: 'test',
+    age: 1
+});
+class TestRequestEntityMapper extends requestEntityMapper_model_1.RequestEntityMapper {
+    schema = {
+        id: typebox_1.string,
+        name: typebox_1.string,
+        age: typebox_1.number,
+    };
+    toEntity(...additionalArgs) {
+        const entity = new TestEntity();
+        entity.id = this.dto.id;
+        entity.name = this.dto.name;
+        entity.age = this.dto.age;
+        return entity;
+    }
+}
+class TestResponseEntityMapper extends responseEntityMapper_model_1.ResponseEntityMapper {
+    schema = {
+        id: typebox_1.string,
+        name: typebox_1.string,
+        age: typebox_1.number
+    };
+    fromEntity(entity) {
+        this.dto = {
+            id: entity.id,
+            name: entity.name,
+            age: entity.age
+        };
+        return this;
+    }
+}
+function extractNonTimeBasedEntityFields(entity) {
+    entity.createdAt = new Date(0);
+    entity.updatedAt = new Date(0);
+    return entity;
+}
+describe('Request Entity Mapper Test', () => {
+    let TestRequestEM;
+    beforeAll(() => {
+        TestRequestEM = new TestRequestEntityMapper(new typebox_1.TypeboxSchemaValidator());
+    });
+    test('Schema Equality', async () => {
+        expect(TestRequestEM.schema).toEqual(TestRequestEntityMapper.schema());
+    });
+    test('From JSON', async () => {
+        const json = {
+            id: '123',
+            name: 'test',
+            age: 1,
+        };
+        const responseEM = TestRequestEM.fromJson(json);
+        const staticEM = TestRequestEntityMapper.fromJson(new typebox_1.TypeboxSchemaValidator(), json);
+        const expectedDto = {
+            id: '123',
+            name: 'test',
+            age: 1,
+        };
+        expect(staticEM.dto).toEqual(expectedDto);
+        expect(responseEM.dto).toEqual(expectedDto);
+        expect(responseEM.dto).toEqual(staticEM.dto);
+    });
+    test('Deserialization Equality', async () => {
+        const json = {
+            id: '123',
+            name: 'test',
+            age: 1,
+        };
+        const entity = extractNonTimeBasedEntityFields(TestRequestEM.deserializeJsonToEntity(json));
+        const objectEntity = extractNonTimeBasedEntityFields(TestRequestEM.fromJson(json).toEntity());
+        const staticEntity = extractNonTimeBasedEntityFields(TestRequestEntityMapper.deserializeJsonToEntity(new typebox_1.TypeboxSchemaValidator(), json));
+        let expectedEntity = new TestEntity();
+        expectedEntity.id = '123';
+        expectedEntity.name = 'test';
+        expectedEntity.age = 1;
+        expectedEntity = extractNonTimeBasedEntityFields(expectedEntity);
+        expect(entity).toEqual(expectedEntity);
+        expect(objectEntity).toEqual(expectedEntity);
+        expect(staticEntity).toEqual(expectedEntity);
+        expect(entity).toEqual(objectEntity);
+        expect(entity).toEqual(staticEntity);
+        expect(staticEntity).toEqual(expectedEntity);
+        expect(staticEntity).toEqual(objectEntity);
+    });
+    test('Serialization Failure', async () => {
+        const json = {
+            id: '123',
+            name: 'test',
+        };
+        // @ts-expect-error
+        expect(() => TestRequestEM.fromJson(json)).toThrow();
+        // @ts-expect-error
+        expect(() => TestRequestEntityMapper.fromJson(new typebox_1.TypeboxSchemaValidator(), json)).toThrow();
+    });
+});
+describe('Response Entity Mapper Test', () => {
+    let TestResponseEM;
+    beforeAll(() => {
+        TestResponseEM = new TestResponseEntityMapper(new typebox_1.TypeboxSchemaValidator());
+    });
+    test('Schema Equality', async () => {
+        expect(TestResponseEM.schema).toEqual(TestResponseEntityMapper.schema());
+    });
+    test('From Entity', async () => {
+        const entity = new TestEntity();
+        entity.id = '123';
+        entity.name = 'test';
+        entity.age = 1;
+        const responseEM = TestResponseEM.fromEntity(entity);
+        const staticEM = TestResponseEntityMapper.fromEntity(new typebox_1.TypeboxSchemaValidator(), entity);
+        const expectedDto = {
+            id: '123',
+            name: 'test',
+            age: 1,
+        };
+        expect(staticEM.dto).toEqual(expectedDto);
+        expect(responseEM.dto).toEqual(expectedDto);
+        expect(responseEM.dto).toEqual(staticEM.dto);
+    });
+    test('Serialization Equality', async () => {
+        const entity = new TestEntity();
+        entity.id = '123';
+        entity.name = 'test';
+        entity.age = 1;
+        const json = TestResponseEM.serializeEntityToJson(entity);
+        const objectJson = TestResponseEM.fromEntity(entity).toJson();
+        const staticJson = TestResponseEntityMapper.serializeEntityToJson(new typebox_1.TypeboxSchemaValidator(), entity);
+        const expectedJson = {
+            id: '123',
+            name: 'test',
+            age: 1,
+        };
+        expect(json).toEqual(expectedJson);
+        expect(objectJson).toEqual(expectedJson);
+        expect(staticJson).toEqual(expectedJson);
+        expect(json).toEqual(objectJson);
+        expect(json).toEqual(staticJson);
+        expect(staticJson).toEqual(expectedJson);
+        expect(staticJson).toEqual(objectJson);
+    });
+    test('Serialization Failure', async () => {
+        const entity = new TestEntity();
+        entity.id = '123';
+        entity.name = 'test';
+        expect(() => TestResponseEM.fromEntity(entity).toJson()).toThrow();
+        expect(() => TestResponseEntityMapper.fromEntity(new typebox_1.TypeboxSchemaValidator(), entity).toJson()).toThrow();
+    });
+});
+//# sourceMappingURL=dto.test.js.map

package/dist/tests/dto.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"dto.test.js","sourceRoot":"","sources":["../../tests/dto.test.ts"],"names":[],"mappings":";;AACA,2DAAuF;AAEvF,+EAA2E;AAC3E,gGAAuF;AACvF,kGAAyF;AAEzF,MAAM,UAAW,SAAQ,wBAAU;IAC/B,IAAI,CAAS;IACb,GAAG,CAAS;CACf;AAED,MAAM,CAAE,SAAQ,+CAAuD;IACnE,QAAQ,CAAC,GAAG,cAAyB;QACjC,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;QAC5B,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;QAE1B,OAAO,MAAM,CAAC;IAClB,CAAC;IACD,MAAM,GAAG;QACL,EAAE,EAAE,gBAAM;QACV,IAAI,EAAE,gBAAM;QACZ,GAAG,EAAE,gBAAM;KACd,CAAC;CAEL;AAED,MAAM,CAAC,GAAG,IAAI,CAAC,CAAC,IAAI,gCAAsB,EAAE,CAAC,CAAC;AAC9C,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;AAEhD,IAAI,CAAC,GAAG,EAAE,EAAE,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;AAI5C,CAAC,CAAC,QAAQ,CAAC,IAAI,gCAAsB,EAAE,EAAE,CAAC,CAAC,CAAC;AAC5C,CAAC,CAAC,QAAQ,CAAC,IAAI,gCAAsB,EAAE,EAAE;IACrC,EAAE,EAAE,KAAK;IACT,IAAI,EAAE,MAAM;IACZ,GAAG,EAAE,CAAC;CACT,CAAC,CAAC;AAEH,MAAM,uBAAwB,SAAQ,+CAAuD;IACzF,MAAM,GAAG;QACL,EAAE,EAAE,gBAAM;QACV,IAAI,EAAE,gBAAM;QACZ,GAAG,EAAE,gBAAM;KACd,CAAC;IAEF,QAAQ,CAAC,GAAG,cAAyB;QACjC,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,CAAC,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC;QAC5B,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;QAE1B,OAAO,MAAM,CAAC;IAClB,CAAC;CACJ;AAgBD,MAAM,wBAAyB,SAAQ,iDAAwD;IAC3F,MAAM,GAAG;QACL,EAAE,EAAE,gBAAM;QACV,IAAI,EAAE,gBAAM;QACZ,GAAG,EAAE,gBAAM;KACd,CAAC;IAEF,UAAU,CAAC,MAAkB;QACzB,IAAI,CAAC,GAAG,GAAG;YACP,EAAE,EAAE,MAAM,CAAC,EAAE;YACb,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,GAAG,EAAE,MAAM,CAAC,GAAG;SAClB,CAAC;QAEF,OAAO,IAAI,CAAC;IAChB,CAAC;CACJ;AAID,SAAS,+BAA+B,CAAuB,MAAS;IACpE,MAAM,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/B,MAAM,CAAC,SAAS,GAAG,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC;IAC/B,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IACxC,IAAI,aAAsC,CAAC;IAG3C,SAAS,CAAC,GAAG,EAAE;QACX,aAAa,GAAG,IAAI,uBAAuB,CAAC,IAAI,gCAAsB,EAAE,CAAC,CAAC;IAC9E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;QAC/B,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,uBAAuB,CAAC,MAAM,EAAE,CAAC,CAAC;IAC3E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,EAAE;QACzB,MAAM,IAAI,GAAG;YACT,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,MAAM;YACZ,GAAG,EAAE,CAAC;SACT,CAAC;QAEF,MAAM,UAAU,GAAG,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;QAChD,MAAM,QAAQ,GAAG,uBAAuB,CAAC,QAAQ,CAAC,IAAI,gCAAsB,EAAE,EAAE,IAAI,CAAC,CAAC;QACtF,MAAM,WAAW,GAAG;YAChB,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,MAAM;YACZ,GAAG,EAAE,CAAC;SACT,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC1C,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,IAAI,GAAG;YACT,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,MAAM;YACZ,GAAG,EAAE,CAAC;SACT,CAAC;QAEF,MAAM,MAAM,GAAG,+BAA+B,CAAC,aAAa,CAAC,uBAAuB,CAAC,IAAI,CAAC,CAAC,CAAC;QAC5F,MAAM,YAAY,GAAG,+BAA+B,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;QAC9F,MAAM,YAAY,GAAG,+BAA+B,CAAC,uBAAuB,CAAC,uBAAuB,CAAC,IAAI,gCAAsB,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC;QAC1I,IAAI,cAAc,GAAG,IAAI,UAAU,EAAE,CAAC;QACtC,cAAc,CAAC,EAAE,GAAG,KAAK,CAAC;QAC1B,cAAc,CAAC,IAAI,GAAG,MAAM,CAAC;QAC7B,cAAc,CAAC,GAAG,GAAG,CAAC,CAAC;QAEvB,cAAc,GAAG,+BAA+B,CAAC,cAAc,CAAC,CAAC;QAEjE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QACvC,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC7C,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACrC,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACrC,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;QAC7C,MAAM,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;QACrC,MAAM,IAAI,GAAG;YACT,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,MAAM;SACf,CAAC;QAEF,mBAAmB;QACnB,MAAM,CAAC,GAAG,EAAE,CAAC,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;QACrD,mBAAmB;QACnB,MAAM,CAAC,GAAG,EAAE,CAAC,uBAAuB,CAAC,QAAQ,CAAC,IAAI,gCAAsB,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC;IACjG,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,6BAA6B,EAAE,GAAG,EAAE;IACzC,IAAI,cAAwC,CAAC;IAE7C,SAAS,CAAC,GAAG,EAAE;QACX,cAAc,GAAG,IAAI,wBAAwB,CAAC,IAAI,gCAAsB,EAAE,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iBAAiB,EAAE,KAAK,IAAI,EAAE;QAC/B,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,wBAAwB,CAAC,MAAM,EAAE,CAAC,CAAC;IAC7E,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,aAAa,EAAE,KAAK,IAAI,EAAE;QAC3B,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,CAAC,EAAE,GAAG,KAAK,CAAC;QAClB,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC;QACrB,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC;QAEf,MAAM,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAG,wBAAwB,CAAC,UAAU,CAAC,IAAI,gCAAsB,EAAE,EAAE,MAAM,CAAC,CAAC;QAC3F,MAAM,WAAW,GAAG;YAChB,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,MAAM;YACZ,GAAG,EAAE,CAAC;SACT,CAAC;QAEF,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC1C,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QAC5C,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;IACjD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wBAAwB,EAAE,KAAK,IAAI,EAAE;QACtC,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,CAAC,EAAE,GAAG,KAAK,CAAC;QAClB,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC;QACrB,MAAM,CAAC,GAAG,GAAG,CAAC,CAAC;QAEf,MAAM,IAAI,GAAG,cAAc,CAAC,qBAAqB,CAAC,MAAM,CAAC,CAAC;QAC1D,MAAM,UAAU,GAAG,cAAc,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC;QAC9D,MAAM,UAAU,GAAG,wBAAwB,CAAC,qBAAqB,CAAC,IAAI,gCAAsB,EAAE,EAAE,MAAM,CAAC,CAAC;QACxG,MAAM,YAAY,GAAG;YACjB,EAAE,EAAE,KAAK;YACT,IAAI,EAAE,MAAM;YACZ,GAAG,EAAE,CAAC;SACT,CAAC;QAEF,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACnC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACzC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACzC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACjC,MAAM,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QACjC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QACzC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,uBAAuB,EAAE,KAAK,IAAI,EAAE;QACrC,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;QAChC,MAAM,CAAC,EAAE,GAAG,KAAK,CAAC;QAClB,MAAM,CAAC,IAAI,GAAG,MAAM,CAAC;QAErB,MAAM,CAAC,GAAG,EAAE,CAAC,cAAc,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;QACnE,MAAM,CAAC,GAAG,EAAE,CAAC,wBAAwB,CAAC,UAAU,CAAC,IAAI,gCAAsB,EAAE,EAAE,MAAM,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC;IAC/G,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/dist/tests/redisTtlCache.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/redisTtlCache.test.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const redisTtlCache_1 = require("../cache/redisTtlCache");
+describe('RedisTtlCache', () => {
+    let cache;
+    beforeAll(() => {
+        // Mock the Redis client
+        // Override the RedisTtlCache's client with the mock client
+        cache = new redisTtlCache_1.RedisTtlCache(5000);
+    });
+    afterAll(async () => {
+        // Ensure the Redis client is disconnected after tests complete
+        await cache.disconnect();
+    });
+    test('putRecord and readRecord', async () => {
+        const key = 'testKey';
+        const value = { data: 'testValue' };
+        const ttlMilliseconds = 10000; // 10 seconds
+        await cache.putRecord({ key, value, ttlMilliseconds });
+        const storedValue = await cache.readRecord(key);
+        expect(storedValue).toEqual(value);
+    });
+    test('peekRecord', async () => {
+        const key = 'testKey';
+        const exists = await cache.peekRecord(key);
+        expect(exists).toBeTruthy();
+    });
+    test('deleteRecord', async () => {
+        const key = 'testKey';
+        await cache.deleteRecord(key);
+        const existsAfterDelete = await cache.peekRecord(key);
+        expect(existsAfterDelete).toBeFalsy();
+    });
+});
+//# sourceMappingURL=redisTtlCache.test.js.map

package/dist/tests/redisTtlCache.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redisTtlCache.test.js","sourceRoot":"","sources":["../../tests/redisTtlCache.test.ts"],"names":[],"mappings":";;AAAA,0DAAuD;AAEvD,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC3B,IAAI,KAAoB,CAAC;IAEzB,SAAS,CAAC,GAAG,EAAE;QACX,wBAAwB;QACxB,2DAA2D;QAC3D,KAAK,GAAG,IAAI,6BAAa,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,KAAK,IAAI,EAAE;QAChB,+DAA+D;QAC/D,MAAM,KAAK,CAAC,UAAU,EAAE,CAAC;IAC7B,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,0BAA0B,EAAE,KAAK,IAAI,EAAE;QACxC,MAAM,GAAG,GAAG,SAAS,CAAC;QACtB,MAAM,KAAK,GAAG,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC;QACpC,MAAM,eAAe,GAAG,KAAK,CAAC,CAAC,aAAa;QAE5C,MAAM,KAAK,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,eAAe,EAAE,CAAC,CAAC;QACvD,MAAM,WAAW,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAEhD,MAAM,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACvC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,YAAY,EAAE,KAAK,IAAI,EAAE;QAC1B,MAAM,GAAG,GAAG,SAAS,CAAC;QACtB,MAAM,MAAM,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAE3C,MAAM,CAAC,MAAM,CAAC,CAAC,UAAU,EAAE,CAAC;IAChC,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,cAAc,EAAE,KAAK,IAAI,EAAE;QAC5B,MAAM,GAAG,GAAG,SAAS,CAAC;QACtB,MAAM,KAAK,CAAC,YAAY,CAAC,GAAG,CAAC,CAAC;QAC9B,MAAM,iBAAiB,GAAG,MAAM,KAAK,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC;QAEtD,MAAM,CAAC,iBAAiB,CAAC,CAAC,SAAS,EAAE,CAAC;IAC1C,CAAC,CAAC,CAAC;AACP,CAAC,CAAC,CAAC"}

package/entityMapper/interfaces/entityMapper.interface.ts

@@ -0,0 +1,17 @@
+import { SchemaValidator } from "@forklaunch/validator/interfaces";
+
+/**
+ * Interface representing a constructor for an entity mapper.
+ * 
+ * @template T - The type of the entity mapper.
+ * @interface EntityMapperConstructor
+ */
+export interface EntityMapperConstructor<T, SV extends SchemaValidator> {
+    /**
+     * Creates a new instance of the entity mapper.
+     * 
+     * @param {SchemaValidator} schemaValidator - The arguments to pass to the constructor.
+     * @returns {T} - A new instance of the entity mapper.
+     */
+    new (schemaValidator: SV): T;
+}

package/entityMapper/models/baseEntityMapper.model.ts

@@ -0,0 +1,93 @@
+import { SchemaValidator } from "@forklaunch/validator/interfaces";
+import { EntityMapperConstructor } from "../interfaces/entityMapper.interface";
+import { EntityMapperSchema, EntityMapperSchemaValidatorObject } from "../types/entityMapper.types";
+
+/**
+ * Constructs an instance of a EntityMapperType.
+ *
+ * @template EntityMapperType - A type that extends BaseEntityMapper.
+ * @param {EntityMapperConstructor<EntityMapperType>} self - The constructor of the EntityMapperType.
+ * @param {...any[]} args - The arguments to pass to the constructor.
+ * @returns {EntityMapperType} - An instance of the EntityMapperType.
+ */
+export function construct<EntityMapperType, SV extends SchemaValidator>(self: EntityMapperConstructor<EntityMapperType, SV>, schemaValidator?: SV): EntityMapperType {
+    return new self(schemaValidator || {} as SV);
+}
+
+/**
+ * Abstract class representing a base entityMapper.
+ *
+ * @template SV - A type that extends SchemaValidator.
+ */
+export abstract class BaseEntityMapper<SV extends SchemaValidator> {
+     /**
+     * The schema validator.
+     * @type {SV}
+     * @protected
+     */
+    _SV!: SV;
+
+    /**
+     * The schema provider.
+     * @type {SV}
+     * @protected
+     */
+    protected schemaValidator: SV;
+
+    /**
+     * The schema definition.
+     * @type {EntityMapperSchemaValidatorObject<SV>}
+     * @abstract
+     */
+    abstract schema: EntityMapperSchemaValidatorObject<SV>;
+
+    /**
+     * The Data Transfer Object (DTO).
+     * @type {EntityMapperSchema<this['schema'], SV>}
+     *
+     */
+    _dto: EntityMapperSchema<this['schema'], SV> = {} as unknown as EntityMapperSchema<this['schema'], SV>;
+
+    /**
+     * Creates an instance of BaseEntityMapper.
+     * 
+     * @param {SV} schemaValidator - The schema provider.
+     */
+    constructor(schemaValidator: SV) {
+        this.schemaValidator = schemaValidator;
+    }
+
+    /**
+     * Validates and sets the Data Transfer Object (DTO).
+     * 
+     * @param {this['_dto']} dto - The Data Transfer Object (DTO).
+     * @throws {Error} - Throws an error if the DTO is invalid.
+     */
+    set dto(_dto: this['_dto']) {
+        if (!this.schemaValidator.validate(this.schemaValidator.schemify(this.schema), _dto)) {
+            throw new Error('Invalid DTO');
+        }
+        this._dto = _dto as unknown as EntityMapperSchema<this['schema'], SV>;
+    }
+
+    /**
+     * Validates and gets the Data Transfer Object (DTO).
+     * 
+     * @returns {this['_dto']} - The Data Transfer Object (DTO).
+     * @throws {Error} - Throws an error if the DTO is invalid.
+     */
+    get dto(): this['_dto'] {
+        return this._dto as unknown as this['_dto'];
+    }
+
+    /**
+     * Gets the schema of a EntityMapperType.
+     * 
+     * @template EntityMapperType - A type that extends BaseEntityMapper.
+     * @param {EntityMapperConstructor<EntityMapperType>} this - The constructor of the EntityMapperType.
+     * @returns {EntityMapperType['schema']} - The schema of the EntityMapperType.
+     */
+    static schema<EntityMapperType extends BaseEntityMapper<any>>(this: EntityMapperConstructor<EntityMapperType, EntityMapperType['_SV']>): EntityMapperType['schema'] {
+        return construct(this).schema;
+    }
+}

package/entityMapper/models/requestEntityMapper.model.ts

@@ -0,0 +1,91 @@
+import { SchemaValidator } from "@forklaunch/validator/interfaces";
+import { BaseEntity } from "../../database/mikro/models/entities/base.entity";
+import { EntityMapperConstructor } from "../interfaces/entityMapper.interface";
+import { EntityMapperStaticSchema } from "../types/entityMapper.types";
+import { BaseEntityMapper, construct } from "./baseEntityMapper.model";
+
+/**
+ * Abstract class representing a request entityMapper.
+ *
+ * @template Entity - A type that extends BaseEntity.
+ * @template SV - A type that extends SchemaValidator.
+ * @extends {BaseEntityMapper<SV>}
+ */
+export abstract class RequestEntityMapper<Entity extends BaseEntity | unknown, SV extends SchemaValidator> extends BaseEntityMapper<SV> {
+    /**
+     * The entity.
+     * @type {Entity}
+     * @protected
+     */
+    _Entity!: Entity;
+    
+    /**
+     * Creates an instance of RequestEntityMapper.
+     * 
+     * @param {SV} schemaValidator - The schema provider.
+     */
+    constructor(schemaValidator: SV) {
+        super(schemaValidator);
+    }
+
+    /**
+     * Converts the underlying DTO to an entity.
+     *
+     * @abstract
+     * @param {...unknown[]} additionalArgs - Additional arguments.
+     * @returns {Entity} - The entity.
+     */
+    abstract toEntity(...additionalArgs: unknown[]): Entity;
+
+    /**
+     * Populates the DTO with data from a JSON object.
+     *
+     * @param {this['_dto']} json - The JSON object.
+     * @returns {this} - The instance of the RequestEntityMapper.
+     */
+    fromJson(json: this['_dto']): this {
+        if (!this.schemaValidator.validate(this.schemaValidator.schemify(this.schema), json)) {
+            throw new Error('Invalid DTO');
+        }
+        this.dto = json;
+        return this;
+    }
+
+    /**
+     * Deserializes a JSON object to an entity.
+     *
+     * @param {this['_dto']} json - The JSON object.
+     * @param {...unknown[]} additionalArgs - Additional arguments.
+     * @returns {Entity} - The entity.
+     */
+    deserializeJsonToEntity(json: this['_dto'], ...additionalArgs: unknown[]): Entity {
+        return this.fromJson(json).toEntity(...additionalArgs);
+    }
+
+    /**
+     * Creates an instance of a RequestEntityMapper from a JSON object.
+     *
+     * @template EntityMapperType - A type that extends RequestEntityMapper.
+     * @param {EntityMapperConstructor<EntityMapperType>} this - The constructor of the EntityMapperType.
+     * @param {EntityMapperType['_SV']} schemaValidator - The schema provider.
+     * @param {EntityMapperStaticSchema<EntityMapperType>} json - The JSON object.
+     * @returns {EntityMapperType} - An instance of the EntityMapperType.
+     */
+    static fromJson<EntityMapperType extends RequestEntityMapper<unknown, any>>(this: EntityMapperConstructor<EntityMapperType, EntityMapperType['_SV']>, schemaValidator: EntityMapperType['_SV'], json: EntityMapperType['_dto']): EntityMapperType {
+        return construct(this, schemaValidator).fromJson(json as unknown as EntityMapperType['_dto']);
+    }
+
+    /**
+     * Deserializes a JSON object to an entity.
+     *
+     * @template EntityMapperType - A type that extends RequestEntityMapper.
+     * @param {EntityMapperConstructor<EntityMapperType>} this - The constructor of the EntityMapperType.
+     * @param {EntityMapperType['_SV']} schemaValidator - The schema provider.
+     * @param {EntityMapperStaticSchema<EntityMapperType>} json - The JSON object.
+     * @param {...unknown[]} additionalArgs - Additional arguments.
+     * @returns {EntityMapperType['_Entity']} - The entity.
+     */
+    static deserializeJsonToEntity<EntityMapperType extends RequestEntityMapper<unknown, any>>(this: EntityMapperConstructor<EntityMapperType, EntityMapperType['_SV']>, schemaValidator: EntityMapperType['_SV'], json: EntityMapperType['_dto'], ...additionalArgs: unknown[]): EntityMapperType['_Entity'] {
+        return construct(this, schemaValidator).fromJson(json as EntityMapperType['_dto']).toEntity(...additionalArgs);
+    }
+}

package/entityMapper/models/responseEntityMapper.model.ts

@@ -0,0 +1,77 @@
+import { SchemaValidator } from "@forklaunch/validator/interfaces";
+import { BaseEntity } from "../../database/mikro/models/entities/base.entity";
+import { EntityMapperConstructor } from "../interfaces/entityMapper.interface";
+import { EntityMapperStaticSchema } from "../types/entityMapper.types";
+import { BaseEntityMapper, construct } from "./baseEntityMapper.model";
+
+/**
+ * Abstract class representing a response entityMapper.
+ *
+ * @template Entity - A type that extends BaseEntity.
+ * @template SV - A type that extends SchemaValidator.
+ * @extends {BaseEntityMapper<SV>}
+ */
+export abstract class ResponseEntityMapper<Entity extends BaseEntity | unknown, SV extends SchemaValidator> extends BaseEntityMapper<SV> {
+    /**
+     * The entity type.
+     * @type {Entity}
+     * @protected
+     */
+    _Entity!: Entity;
+
+    /**
+     * Populates entityMapper with DTO from an entity.
+     *
+     * @abstract
+     * @param {Entity} entity - The entity to convert.
+     * @returns {this} - The instance of the ResponseEntityMapper.
+     */
+    abstract fromEntity(entity: Entity, ...additionalArgs: unknown[]): this;
+
+    /**
+     * Converts the underlying DTO to a JSON object.
+     *
+     * @param {...unknown[]} additionalArgs - Additional arguments.
+     * @returns {this['_dto']} - The JSON object.
+     */
+    toJson(): this['_dto'] {
+        if (!this.schemaValidator.validate(this.schemaValidator.schemify(this.schema), this.dto)) {
+            throw new Error('Invalid DTO');
+        }
+        return this.dto;
+    }
+
+    /**
+     * Serializes an entity to a JSON object.
+     *
+     * @param {Entity} entity - The entity to serialize.
+     * @returns {this['_dto']} - The JSON object.
+     */
+    serializeEntityToJson(entity: Entity): this['_dto'] {
+        return this.fromEntity(entity).toJson();
+    }
+
+    /**
+     * Populates entityMapper with DTO from an entity.
+     *
+     * @template EntityMapperType - A type that extends ResponseEntityMapper.
+     * @param {EntityMapperConstructor<EntityMapperType>} this - The constructor of the EntityMapperType.
+     * @param {EntityMapperType['_Entity']} entity - The entity to convert.
+     * @returns {EntityMapperType} - An instance of the EntityMapperType.
+     */
+    static fromEntity<EntityMapperType extends ResponseEntityMapper<unknown, any>>(this: EntityMapperConstructor<EntityMapperType, EntityMapperType['_SV']>, schemaValidator: EntityMapperType['_SV'], entity: EntityMapperType['_Entity']): EntityMapperType {
+        return construct(this, schemaValidator).fromEntity(entity);
+    }
+
+    /**
+     * Serializes an entity to a JSON object.
+     *
+     * @template EntityMapperType - A type that extends ResponseEntityMapper.
+     * @param {EntityMapperConstructor<EntityMapperType>} this - The constructor of the EntityMapperType.
+     * @param {EntityMapperType['_Entity']} entity - The entity to serialize.
+     * @returns {EntityMapperStaticSchema<EntityMapperType>} - The JSON object.
+     */
+    static serializeEntityToJson<EntityMapperType extends ResponseEntityMapper<unknown, any>>(this: EntityMapperConstructor<EntityMapperType, EntityMapperType['_SV']>, schemaValidator: EntityMapperType['_SV'], entity: EntityMapperType['_Entity']): EntityMapperStaticSchema<EntityMapperType> {
+        return construct(this, schemaValidator).serializeEntityToJson(entity) as EntityMapperStaticSchema<EntityMapperType>;
+    }
+}

package/entityMapper/types/entityMapper.types.ts

@@ -0,0 +1,29 @@
+import { Schema, SchemaCatchall, ValidSchemaObject } from "@forklaunch/validator/";
+import { SchemaValidator } from "@forklaunch/validator/interfaces";
+import { UnboxedObjectSchema } from "@forklaunch/validator/types";
+import { BaseEntityMapper } from "../models/baseEntityMapper.model";
+
+/**
+ * Type representing a schema validator object for an entity mapper.
+ * 
+ * @template SV - A type that extends SchemaValidator.
+ * @typedef {ValidSchemaObject<SV> | UnboxedObjectSchema<SchemaCatchall<SV>> & {}} EntityMapperSchemaValidatorObject
+ */
+export type EntityMapperSchemaValidatorObject<SV extends SchemaValidator> = ValidSchemaObject<SV> | UnboxedObjectSchema<SchemaCatchall<SV>>;
+
+/**
+ * Type representing the static schema of an entity mapper.
+ * 
+ * @template T - A type that extends BaseEntityMapper with a schema property.
+ * @typedef {Schema<T['schema'], T['_SV']> & {}} EntityMapperStaticSchema
+ */
+export type EntityMapperStaticSchema<T extends BaseEntityMapper<any> & { schema: any }> = Schema<T['schema'], T['_SV']>;
+
+/**
+ * Type representing the schema of an entity mapper.
+ * 
+ * @template T - A type that extends ValidSchemaObject or UnboxedObjectSchema with SchemaCatchall.
+ * @template SV - A type that extends SchemaValidator.
+ * @typedef {Schema<T, SV> & {}} EntityMapperSchema
+ */
+export type EntityMapperSchema<T extends ValidSchemaObject<SV> | UnboxedObjectSchema<SchemaCatchall<SV>>, SV extends SchemaValidator> = Schema<T, SV>;

package/eslint.config.mjs

@@ -0,0 +1,12 @@
+import pluginJs from "@eslint/js";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+
+export default [
+  {files: ["**/*.{ts}"]},
+  {ignores: ["tests/**/*", "dist/**/*", "node_modules/**/*"]},
+  {languageOptions: { globals: globals.browser }},
+  pluginJs.configs.recommended,
+  ...tseslint.configs.recommended,
+];