@forklaunch/core 0.1.0 → 0.1.2

package/entityMapper/models/requestEntityMapper.model.ts

@@ -1,8 +1,7 @@
-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";
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { BaseEntity } from '../../database/mikro/models/entities/base.entity';
+import { EntityMapperConstructor } from '../interfaces/entityMapper.interface';
+import { BaseEntityMapper, construct } from './baseEntityMapper.model';
 
 /**
  * Abstract class representing a request entityMapper.
@@ -11,81 +10,102 @@ import { BaseEntityMapper, construct } from "./baseEntityMapper.model";
  * @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);
-    }
+export abstract class RequestEntityMapper<
+  Entity extends BaseEntity,
+  SV extends AnySchemaValidator
+> extends BaseEntityMapper<SV> {
+  /**
+   * The entity.
+   * @type {Entity}
+   * @protected
+   */
+  _Entity!: Entity;
 
-    /**
-     * Converts the underlying DTO to an entity.
-     *
-     * @abstract
-     * @param {...unknown[]} additionalArgs - Additional arguments.
-     * @returns {Entity} - The entity.
-     */
-    abstract toEntity(...additionalArgs: unknown[]): Entity;
+  /**
+   * 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;
+  /**
+   * 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);
-    }
+  /**
+   * 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']);
-    }
+  /**
+   * Creates an instance of a RequestEntityMapper from a JSON object.
+   *
+   * @template T - A type that extends RequestEntityMapper.
+   * @param {EntityMapperConstructor<T>} this - The constructor of the T.
+   * @param {T['_SV']} schemaValidator - The schema provider.
+   * @param {T['_dto']} json - The JSON object.
+   * @returns {T} - An instance of the T.
+   */
+  static fromJson<
+    T extends RequestEntityMapper<BaseEntity, SV>,
+    SV extends AnySchemaValidator,
+    JsonType extends T['_dto']
+  >(
+    this: EntityMapperConstructor<T, SV>,
+    schemaValidator: SV,
+    json: JsonType
+  ): T {
+    return construct(this, schemaValidator).fromJson(json);
+  }
 
-    /**
-     * 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);
-    }
+  /**
+   * Deserializes a JSON object to an entity.
+   *
+   * @template T - A type that extends RequestEntityMapper.
+   * @param {EntityMapperConstructor<T>} this - The constructor of the T.
+   * @param {T['_SV']} schemaValidator - The schema provider.
+   * @param {T['_dto']} json - The JSON object.
+   * @param {...unknown[]} additionalArgs - Additional arguments.
+   * @returns {T['_Entity']} - The entity.
+   */
+  static deserializeJsonToEntity<
+    T extends RequestEntityMapper<BaseEntity, SV>,
+    SV extends AnySchemaValidator,
+    JsonType extends T['_dto']
+  >(
+    this: EntityMapperConstructor<T, SV>,
+    schemaValidator: SV,
+    json: JsonType,
+    ...additionalArgs: unknown[]
+  ): T['_Entity'] {
+    return construct(this, schemaValidator)
+      .fromJson(json)
+      .toEntity(...additionalArgs);
+  }
 }

package/entityMapper/models/responseEntityMapper.model.ts

@@ -1,8 +1,7 @@
-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";
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { BaseEntity } from '../../database/mikro/models/entities/base.entity';
+import { EntityMapperConstructor } from '../interfaces/entityMapper.interface';
+import { BaseEntityMapper, construct } from './baseEntityMapper.model';
 
 /**
  * Abstract class representing a response entityMapper.
@@ -11,67 +10,89 @@ import { BaseEntityMapper, construct } from "./baseEntityMapper.model";
  * @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;
+export abstract class ResponseEntityMapper<
+  Entity extends BaseEntity,
+  SV extends AnySchemaValidator
+> 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;
+  /**
+   * 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;
+  /**
+   * 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();
-    }
+  /**
+   * 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);
-    }
+  /**
+   * Populates entityMapper with DTO from an entity.
+   *
+   * @template T - A type that extends ResponseEntityMapper.
+   * @param {EntityMapperConstructor<T>} this - The constructor of the T.
+   * @param {T['_Entity']} entity - The entity to convert.
+   * @returns {T} - An instance of the T.
+   */
+  static fromEntity<
+    T extends ResponseEntityMapper<BaseEntity, SV>,
+    SV extends AnySchemaValidator
+  >(
+    this: EntityMapperConstructor<T, SV>,
+    schemaValidator: SV,
+    entity: T['_Entity']
+  ): T {
+    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>;
-    }
+  /**
+   * Serializes an entity to a JSON object.
+   *
+   * @template T - A type that extends ResponseEntityMapper.
+   * @param {EntityMapperConstructor<T>} this - The constructor of the T.
+   * @param {T['_Entity']} entity - The entity to serialize.
+   * @returns {T['_dto']} - The JSON object.
+   */
+  static serializeEntityToJson<
+    T extends ResponseEntityMapper<BaseEntity, SV>,
+    SV extends AnySchemaValidator
+  >(
+    this: EntityMapperConstructor<T, SV>,
+    schemaValidator: SV,
+    entity: T['_Entity']
+  ): T['_dto'] {
+    return construct(this, schemaValidator).serializeEntityToJson(entity);
+  }
 }

package/entityMapper/types/entityMapper.types.ts

@@ -1,29 +1,12 @@
-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";
+import { AnySchemaValidator } from '@forklaunch/validator';
+import { UnboxedObjectSchema } from '@forklaunch/validator/types';
 
 /**
  * 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>;
+export type EntityMapperSchemaValidatorObject<SV extends AnySchemaValidator> =
+  | SV['_ValidSchemaObject']
+  | UnboxedObjectSchema<SV>;

package/http/index.ts

@@ -0,0 +1,2 @@
+export * from './middlewares';
+export * from './types';

package/http/middlewares/index.ts

@@ -0,0 +1,2 @@
+export * from './request.middleware';
+export * from './response.middleware';