@forklaunch/core 0.1.0

package/dist/cache/interfaces/ttlCache.interface.d.ts

@@ -0,0 +1,47 @@
+import { TtlCacheRecord } from "../types/ttlCacheRecord";
+/**
+ * Interface representing a TTL (Time-To-Live) cache.
+ */
+export interface TtlCache {
+    /**
+     * Puts a record into the cache.
+     *
+     * @param {TtlCacheRecord} cacheRecord - The cache record to put into the cache.
+     * @returns {Promise<void>} - A promise that resolves when the record is put into the cache.
+     */
+    putRecord(cacheRecord: TtlCacheRecord): Promise<void>;
+    /**
+     * Deletes a record from the cache.
+     *
+     * @param {string} cacheRecordKey - The key of the cache record to delete.
+     * @returns {Promise<void>} - A promise that resolves when the record is deleted from the cache.
+     */
+    deleteRecord(cacheRecordKey: string): Promise<void>;
+    /**
+     * Reads a record from the cache.
+     *
+     * @param {string} cacheRecordKey - The key of the cache record to read.
+     * @returns {Promise<TtlCacheRecord>} - A promise that resolves with the cache record.
+     */
+    readRecord(cacheRecordKey: string): Promise<TtlCacheRecord>;
+    /**
+     * Peeks at a record in the cache to check if it exists.
+     *
+     * @param {string} cacheRecordKey - The key of the cache record to peek at.
+     * @returns {Promise<boolean>} - A promise that resolves with a boolean indicating if the record exists.
+     */
+    peekRecord(cacheRecordKey: string): Promise<boolean>;
+    /**
+     * Gets the TTL (Time-To-Live) in milliseconds.
+     *
+     * @returns {number} - The TTL in milliseconds.
+     */
+    getTtlMilliseconds(): number;
+    /**
+     * Lists the keys in the cache that match a pattern prefix.
+     *
+     * @param {string} pattern_prefix - The pattern prefix to match.
+     * @returns {Promise<string[]>} - A promise that resolves with an array of keys matching the pattern prefix.
+     */
+    listKeys(pattern_prefix: string): Promise<string[]>;
+}

package/dist/cache/interfaces/ttlCache.interface.js

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

package/dist/cache/interfaces/ttlCache.interface.js.map

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

package/dist/cache/redisTtlCache.d.ts

@@ -0,0 +1,64 @@
+import { TtlCache } from './interfaces/ttlCache.interface';
+import { TtlCacheRecord } from './types/ttlCacheRecord';
+/**
+ * Class representing a Redis-based TTL (Time-To-Live) cache.
+ * Implements the TtlCache interface.
+ */
+export declare class RedisTtlCache implements TtlCache {
+    private ttlMilliseconds;
+    private client;
+    /**
+     * Creates an instance of RedisTtlCache.
+     *
+     * @param {number} ttlMilliseconds - The default TTL in milliseconds.
+     */
+    constructor(ttlMilliseconds: number);
+    /**
+     * Puts a record into the Redis cache.
+     *
+     * @param {TtlCacheRecord} param0 - The cache record to put into the cache.
+     * @returns {Promise<void>} - A promise that resolves when the record is put into the cache.
+     */
+    putRecord({ key, value, ttlMilliseconds }: TtlCacheRecord): Promise<void>;
+    /**
+     * Deletes a record from the Redis cache.
+     *
+     * @param {string} cacheRecordKey - The key of the cache record to delete.
+     * @returns {Promise<void>} - A promise that resolves when the record is deleted from the cache.
+     */
+    deleteRecord(cacheRecordKey: string): Promise<void>;
+    /**
+     * Reads a record from the Redis cache.
+     *
+     * @param {string} cacheRecordKey - The key of the cache record to read.
+     * @returns {Promise<TtlCacheRecord>} - A promise that resolves with the cache record.
+     * @throws {Error} - Throws an error if the record is not found.
+     */
+    readRecord(cacheRecordKey: string): Promise<TtlCacheRecord>;
+    /**
+     * Lists the keys in the Redis cache that match a pattern prefix.
+     *
+     * @param {string} pattern_prefix - The pattern prefix to match.
+     * @returns {Promise<string[]>} - A promise that resolves with an array of keys matching the pattern prefix.
+     */
+    listKeys(pattern_prefix: string): Promise<string[]>;
+    /**
+     * Peeks at a record in the Redis cache to check if it exists.
+     *
+     * @param {string} cacheRecordKey - The key of the cache record to peek at.
+     * @returns {Promise<boolean>} - A promise that resolves with a boolean indicating if the record exists.
+     */
+    peekRecord(cacheRecordKey: string): Promise<boolean>;
+    /**
+     * Disconnects the Redis client.
+     *
+     * @returns {Promise<void>} - A promise that resolves when the client is disconnected.
+     */
+    disconnect(): Promise<void>;
+    /**
+     * Gets the default TTL (Time-To-Live) in milliseconds.
+     *
+     * @returns {number} - The TTL in milliseconds.
+     */
+    getTtlMilliseconds(): number;
+}

package/dist/cache/redisTtlCache.js

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RedisTtlCache = void 0;
+const redis_1 = require("redis");
+/**
+ * Class representing a Redis-based TTL (Time-To-Live) cache.
+ * Implements the TtlCache interface.
+ */
+class RedisTtlCache {
+    ttlMilliseconds;
+    client;
+    /**
+     * Creates an instance of RedisTtlCache.
+     *
+     * @param {number} ttlMilliseconds - The default TTL in milliseconds.
+     */
+    constructor(ttlMilliseconds) {
+        this.ttlMilliseconds = ttlMilliseconds;
+        // Connects to localhost:6379 by default
+        // url usage: redis[s]://[[username][:password]@][host][:port][/db-number]
+        this.client = (0, redis_1.createClient)();
+        this.client.on('error', (err) => console.log('Redis Client Error', err));
+        this.client.on('connect', () => {
+            console.log('\x1b[32m%s\x1b[0m', 'Successfully Connected to Redis'); // Green text
+        });
+        this.client.connect().catch(console.error);
+    }
+    /**
+     * Puts a record into the Redis cache.
+     *
+     * @param {TtlCacheRecord} param0 - The cache record to put into the cache.
+     * @returns {Promise<void>} - A promise that resolves when the record is put into the cache.
+     */
+    async putRecord({ key, value, ttlMilliseconds = this.ttlMilliseconds }) {
+        await this.client.set(key, JSON.stringify(value), {
+            PX: ttlMilliseconds
+        });
+    }
+    /**
+     * Deletes a record from the Redis cache.
+     *
+     * @param {string} cacheRecordKey - The key of the cache record to delete.
+     * @returns {Promise<void>} - A promise that resolves when the record is deleted from the cache.
+     */
+    async deleteRecord(cacheRecordKey) {
+        await this.client.del(cacheRecordKey);
+    }
+    /**
+     * Reads a record from the Redis cache.
+     *
+     * @param {string} cacheRecordKey - The key of the cache record to read.
+     * @returns {Promise<TtlCacheRecord>} - A promise that resolves with the cache record.
+     * @throws {Error} - Throws an error if the record is not found.
+     */
+    async readRecord(cacheRecordKey) {
+        const value = await this.client.get(cacheRecordKey);
+        if (value === null) {
+            throw new Error(`Record not found for key: ${cacheRecordKey}`);
+        }
+        const ttl = await this.client.ttl(cacheRecordKey); // Fetch TTL from Redis
+        return {
+            key: cacheRecordKey,
+            value: JSON.parse(value),
+            ttlMilliseconds: ttl * 1000
+        };
+    }
+    /**
+     * Lists the keys in the Redis cache that match a pattern prefix.
+     *
+     * @param {string} pattern_prefix - The pattern prefix to match.
+     * @returns {Promise<string[]>} - A promise that resolves with an array of keys matching the pattern prefix.
+     */
+    async listKeys(pattern_prefix) {
+        const keys = await this.client.keys(pattern_prefix + '*');
+        return keys;
+    }
+    /**
+     * Peeks at a record in the Redis cache to check if it exists.
+     *
+     * @param {string} cacheRecordKey - The key of the cache record to peek at.
+     * @returns {Promise<boolean>} - A promise that resolves with a boolean indicating if the record exists.
+     */
+    async peekRecord(cacheRecordKey) {
+        const result = await this.client.exists(cacheRecordKey);
+        return result === 1;
+    }
+    /**
+     * Disconnects the Redis client.
+     *
+     * @returns {Promise<void>} - A promise that resolves when the client is disconnected.
+     */
+    async disconnect() {
+        await this.client.quit();
+    }
+    /**
+     * Gets the default TTL (Time-To-Live) in milliseconds.
+     *
+     * @returns {number} - The TTL in milliseconds.
+     */
+    getTtlMilliseconds() {
+        return this.ttlMilliseconds;
+    }
+}
+exports.RedisTtlCache = RedisTtlCache;
+//# sourceMappingURL=redisTtlCache.js.map

package/dist/cache/redisTtlCache.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redisTtlCache.js","sourceRoot":"","sources":["../../cache/redisTtlCache.ts"],"names":[],"mappings":";;;AAAA,iCAAqC;AAIrC;;;GAGG;AACH,MAAa,aAAa;IAQJ;IAPZ,MAAM,CAAC;IAEf;;;;OAIG;IACH,YAAoB,eAAuB;QAAvB,oBAAe,GAAf,eAAe,CAAQ;QACzC,wCAAwC;QACxC,0EAA0E;QAC1E,IAAI,CAAC,MAAM,GAAG,IAAA,oBAAY,GAAE,CAAC;QAC7B,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,GAAG,CAAC,CAAC,CAAC;QACzE,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,SAAS,EAAE,GAAG,EAAE;YAC7B,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,iCAAiC,CAAC,CAAC,CAAE,aAAa;QACrF,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,eAAe,GAAG,IAAI,CAAC,eAAe,EAAkB;QACpF,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;YAChD,EAAE,EAAE,eAAe;SACpB,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,YAAY,CAAC,cAAsB;QACvC,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;IACxC,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CAAC,cAAsB;QACrC,MAAM,KAAK,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QACpD,IAAI,KAAK,KAAK,IAAI,EAAE;YAClB,MAAM,IAAI,KAAK,CAAC,6BAA6B,cAAc,EAAE,CAAC,CAAC;SAChE;QACD,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,uBAAuB;QAC1E,OAAO;YACL,GAAG,EAAE,cAAc;YACnB,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC;YACxB,eAAe,EAAE,GAAG,GAAG,IAAI;SAC5B,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CAAC,cAAsB;QACnC,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,cAAc,GAAG,GAAG,CAAC,CAAC;QAC1D,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,UAAU,CAAC,cAAsB;QACrC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC;QACxD,OAAO,MAAM,KAAK,CAAC,CAAC;IACtB,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,UAAU;QACd,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;IAED;;;;OAIG;IACH,kBAAkB;QAChB,OAAO,IAAI,CAAC,eAAe,CAAC;IAC9B,CAAC;CACF;AApGD,sCAoGC"}

package/dist/cache/types/ttlCacheRecord.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Type representing a TTL (Time-To-Live) cache record.
+ *
+ * @typedef {Object} TtlCacheRecord
+ * @property {string} key - The key of the cache record.
+ * @property {any} value - The value of the cache record.
+ * @property {number} ttlMilliseconds - The time-to-live of the cache record in milliseconds.
+ */
+export type TtlCacheRecord = {
+    key: string;
+    value: unknown;
+    ttlMilliseconds: number;
+};

package/dist/cache/types/ttlCacheRecord.js

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

package/dist/cache/types/ttlCacheRecord.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ttlCacheRecord.js","sourceRoot":"","sources":["../../../cache/types/ttlCacheRecord.ts"],"names":[],"mappings":""}

package/dist/controllers/interfaces/controller.interface.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Interface representing a controller.
+ *
+ * @interface Controller
+ */
+interface Controller {
+    /**
+     * The base path for the controller.
+     *
+     * @type {string}
+     * @readonly
+     */
+    readonly basePath: string;
+}
+export default Controller;

package/dist/controllers/interfaces/controller.interface.js

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

package/dist/controllers/interfaces/controller.interface.js.map

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

package/dist/database/mikro/models/entities/base.entity.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Abstract class representing a base entity.
+ */
+export declare abstract class BaseEntity {
+    /**
+     * The unique identifier for the entity.
+     *
+     * @type {string}
+     * @readonly
+     */
+    id: string;
+    /**
+     * The date when the entity was created.
+     *
+     * @type {Date}
+     */
+    createdAt: Date;
+    /**
+     * The date when the entity was last updated.
+     *
+     * @type {Date}
+     * @readonly
+     */
+    updatedAt: Date;
+}

package/dist/database/mikro/models/entities/base.entity.js

@@ -0,0 +1,53 @@
+"use strict";
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseEntity = void 0;
+const uuid_1 = require("uuid");
+const core_1 = require("@mikro-orm/core");
+/**
+ * Abstract class representing a base entity.
+ */
+class BaseEntity {
+    /**
+     * The unique identifier for the entity.
+     *
+     * @type {string}
+     * @readonly
+     */
+    id = (0, uuid_1.v4)();
+    /**
+     * The date when the entity was created.
+     *
+     * @type {Date}
+     */
+    createdAt = new Date();
+    /**
+     * The date when the entity was last updated.
+     *
+     * @type {Date}
+     * @readonly
+     */
+    updatedAt = new Date();
+}
+exports.BaseEntity = BaseEntity;
+__decorate([
+    (0, core_1.PrimaryKey)({ type: "uuid" }),
+    __metadata("design:type", String)
+], BaseEntity.prototype, "id", void 0);
+__decorate([
+    (0, core_1.Property)(),
+    __metadata("design:type", Date)
+], BaseEntity.prototype, "createdAt", void 0);
+__decorate([
+    (0, core_1.Property)({ onUpdate: () => new Date() }),
+    __metadata("design:type", Date)
+], BaseEntity.prototype, "updatedAt", void 0);
+//# sourceMappingURL=base.entity.js.map

package/dist/database/mikro/models/entities/base.entity.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.entity.js","sourceRoot":"","sources":["../../../../../database/mikro/models/entities/base.entity.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,+BAA0B;AAC1B,0CAAuD;AAEvD;;GAEG;AACH,MAAsB,UAAU;IAC9B;;;;;OAKG;IAEH,EAAE,GAAW,IAAA,SAAE,GAAE,CAAC;IAElB;;;;OAIG;IAEH,SAAS,GAAS,IAAI,IAAI,EAAE,CAAC;IAE7B;;;;;OAKG;IAEH,SAAS,GAAS,IAAI,IAAI,EAAE,CAAC;CAC9B;AA1BD,gCA0BC;AAlBC;IADC,IAAA,iBAAU,EAAC,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC;;sCACX;AAQlB;IADC,IAAA,eAAQ,GAAE;8BACA,IAAI;6CAAc;AAS7B;IADC,IAAA,eAAQ,EAAC,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,IAAI,IAAI,EAAE,EAAE,CAAC;8BAC9B,IAAI;6CAAc"}

package/dist/entityMapper/interfaces/entityMapper.interface.d.ts

@@ -0,0 +1,16 @@
+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/dist/entityMapper/interfaces/entityMapper.interface.js

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

package/dist/entityMapper/interfaces/entityMapper.interface.js.map

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

package/dist/entityMapper/models/baseEntityMapper.model.d.ts

@@ -0,0 +1,71 @@
+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 declare function construct<EntityMapperType, SV extends SchemaValidator>(self: EntityMapperConstructor<EntityMapperType, SV>, schemaValidator?: SV): EntityMapperType;
+/**
+ * Abstract class representing a base entityMapper.
+ *
+ * @template SV - A type that extends SchemaValidator.
+ */
+export declare 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>;
+    /**
+     * Creates an instance of BaseEntityMapper.
+     *
+     * @param {SV} schemaValidator - The schema provider.
+     */
+    constructor(schemaValidator: SV);
+    /**
+     * 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']);
+    /**
+     * 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'];
+    /**
+     * 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'];
+}

package/dist/entityMapper/models/baseEntityMapper.model.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseEntityMapper = exports.construct = void 0;
+/**
+ * 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.
+ */
+function construct(self, schemaValidator) {
+    return new self(schemaValidator || {});
+}
+exports.construct = construct;
+/**
+ * Abstract class representing a base entityMapper.
+ *
+ * @template SV - A type that extends SchemaValidator.
+ */
+class BaseEntityMapper {
+    /**
+    * The schema validator.
+    * @type {SV}
+    * @protected
+    */
+    _SV;
+    /**
+     * The schema provider.
+     * @type {SV}
+     * @protected
+     */
+    schemaValidator;
+    /**
+     * The Data Transfer Object (DTO).
+     * @type {EntityMapperSchema<this['schema'], SV>}
+     *
+     */
+    _dto = {};
+    /**
+     * Creates an instance of BaseEntityMapper.
+     *
+     * @param {SV} schemaValidator - The schema provider.
+     */
+    constructor(schemaValidator) {
+        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) {
+        if (!this.schemaValidator.validate(this.schemaValidator.schemify(this.schema), _dto)) {
+            throw new Error('Invalid DTO');
+        }
+        this._dto = _dto;
+    }
+    /**
+     * 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() {
+        return 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() {
+        return construct(this).schema;
+    }
+}
+exports.BaseEntityMapper = BaseEntityMapper;
+//# sourceMappingURL=baseEntityMapper.model.js.map

package/dist/entityMapper/models/baseEntityMapper.model.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"baseEntityMapper.model.js","sourceRoot":"","sources":["../../../entityMapper/models/baseEntityMapper.model.ts"],"names":[],"mappings":";;;AAIA;;;;;;;GAOG;AACH,SAAgB,SAAS,CAA+C,IAAmD,EAAE,eAAoB;IAC7I,OAAO,IAAI,IAAI,CAAC,eAAe,IAAI,EAAQ,CAAC,CAAC;AACjD,CAAC;AAFD,8BAEC;AAED;;;;GAIG;AACH,MAAsB,gBAAgB;IACjC;;;;MAIE;IACH,GAAG,CAAM;IAET;;;;OAIG;IACO,eAAe,CAAK;IAS9B;;;;OAIG;IACH,IAAI,GAA2C,EAAuD,CAAC;IAEvG;;;;OAIG;IACH,YAAY,eAAmB;QAC3B,IAAI,CAAC,eAAe,GAAG,eAAe,CAAC;IAC3C,CAAC;IAED;;;;;OAKG;IACH,IAAI,GAAG,CAAC,IAAkB;QACtB,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,CAAC,EAAE;YAClF,MAAM,IAAI,KAAK,CAAC,aAAa,CAAC,CAAC;SAClC;QACD,IAAI,CAAC,IAAI,GAAG,IAAyD,CAAC;IAC1E,CAAC;IAED;;;;;OAKG;IACH,IAAI,GAAG;QACH,OAAO,IAAI,CAAC,IAA+B,CAAC;IAChD,CAAC;IAED;;;;;;OAMG;IACH,MAAM,CAAC,MAAM;QACT,OAAO,SAAS,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC;IAClC,CAAC;CACJ;AAvED,4CAuEC"}

package/dist/entityMapper/models/requestEntityMapper.model.d.ts

@@ -0,0 +1,69 @@
+import { SchemaValidator } from "@forklaunch/validator/interfaces";
+import { BaseEntity } from "../../database/mikro/models/entities/base.entity";
+import { EntityMapperConstructor } from "../interfaces/entityMapper.interface";
+import { BaseEntityMapper } 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 declare 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);
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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'];
+}