@forklaunch/core 0.2.37 → 0.3.0

package/lib/database/index.mjs

@@ -0,0 +1,53 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __decorateClass = (decorators, target, key, kind) => {
+  var result = kind > 1 ? void 0 : kind ? __getOwnPropDesc(target, key) : target;
+  for (var i = decorators.length - 1, decorator; i >= 0; i--)
+    if (decorator = decorators[i])
+      result = (kind ? decorator(target, key, result) : decorator(result)) || result;
+  if (kind && result) __defProp(target, key, result);
+  return result;
+};
+
+// src/database/mikro/models/entities/base.entity.ts
+import { v4 } from "uuid";
+import { PrimaryKey, Property } from "@mikro-orm/core";
+var BaseEntity = class {
+  id = v4();
+  createdAt = /* @__PURE__ */ new Date();
+  updatedAt = /* @__PURE__ */ new Date();
+};
+__decorateClass([
+  PrimaryKey({ type: "uuid" })
+], BaseEntity.prototype, "id", 2);
+__decorateClass([
+  Property()
+], BaseEntity.prototype, "createdAt", 2);
+__decorateClass([
+  Property({ onUpdate: () => /* @__PURE__ */ new Date() })
+], BaseEntity.prototype, "updatedAt", 2);
+
+// src/database/mikro/models/entities/mongo.base.entity.ts
+import { PrimaryKey as PrimaryKey2, Property as Property2, SerializedPrimaryKey } from "@mikro-orm/core";
+var MongoBaseEntity = class {
+  _id;
+  id;
+  createdAt = /* @__PURE__ */ new Date();
+  updatedAt = /* @__PURE__ */ new Date();
+};
+__decorateClass([
+  PrimaryKey2()
+], MongoBaseEntity.prototype, "_id", 2);
+__decorateClass([
+  SerializedPrimaryKey()
+], MongoBaseEntity.prototype, "id", 2);
+__decorateClass([
+  Property2()
+], MongoBaseEntity.prototype, "createdAt", 2);
+__decorateClass([
+  Property2({ onUpdate: () => /* @__PURE__ */ new Date() })
+], MongoBaseEntity.prototype, "updatedAt", 2);
+export {
+  BaseEntity,
+  MongoBaseEntity
+};

package/lib/dtoMapper/index.d.mts

@@ -0,0 +1,215 @@
+import { AnySchemaValidator, UnboxedObjectSchema, SchemaValidator, Schema } from '@forklaunch/validator';
+import { B as BaseEntity } from '../base.entity-DNfmMOgd.mjs';
+
+/**
+ * Interface representing a constructor for an entity mapper.
+ *
+ * @template T - The type of the entity mapper.
+ * @template SV - The type of the schema validator.
+ * @interface DtoMapperConstructor
+ */
+interface DtoMapperConstructor<T, SV extends AnySchemaValidator> {
+    /**
+     * Creates a new instance of the entity mapper.
+     *
+     * @param {AnySchemaValidator} schemaValidator - The arguments to pass to the constructor.
+     * @returns {T} - A new instance of the entity mapper.
+     */
+    new (schemaValidator: SV): T;
+}
+
+/**
+ * Type representing a schema validator object for an entity mapper.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @typedef {SV['_ValidSchemaObject'] | UnboxedObjectSchema<SV>} DtoMapperSchemaValidatorObject
+ */
+type DtoMapperSchemaValidatorObject<SV extends AnySchemaValidator> = SV['_ValidSchemaObject'] | UnboxedObjectSchema<SV>;
+
+/**
+ * Abstract class representing a base entity mapper.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
+declare abstract class BaseDtoMapper<SV extends AnySchemaValidator> {
+    /**
+     * The schema validator exact type.
+     * @type {SV}
+     * @protected
+     */
+    _SV: SV;
+    /**
+     * The schema validator as a general type.
+     * @type {SchemaValidator}
+     * @protected
+     */
+    protected schemaValidator: SchemaValidator;
+    /**
+     * The schema definition.
+     * @type {DtoMapperSchemaValidatorObject<SV>}
+     * @abstract
+     */
+    abstract schema: DtoMapperSchemaValidatorObject<SV>;
+    /**
+     * The Data Transfer Object (DTO).
+     * @type {Schema<this['schema'], SV>}
+     */
+    _dto: Schema<this['schema'], SV>;
+    /**
+     * Creates an instance of BaseDtoMapper.
+     *
+     * @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).
+     */
+    get dto(): this['_dto'];
+    /**
+     * Gets the schema of a T.
+     *
+     * @template T - A type that extends BaseDtoMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @param {DtoMapperConstructor<T, SV>} this - The constructor of the T.
+     * @returns {T['schema']} - The schema of the T.
+     */
+    static schema<T extends BaseDtoMapper<SV>, SV extends AnySchemaValidator>(this: DtoMapperConstructor<T, SV>): T['schema'];
+}
+
+/**
+ * Abstract class representing a request entity mapper.
+ *
+ * @template Entity - A type that extends BaseEntity.
+ * @template SV - A type that extends AnySchemaValidator.
+ * @extends {BaseDtoMapper<SV>}
+ */
+declare abstract class RequestDtoMapper<Entity extends BaseEntity, SV extends AnySchemaValidator> extends BaseDtoMapper<SV> {
+    /**
+     * The entity type.
+     * @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;
+    /**
+     * Populates the DTO with data from a JSON object.
+     *
+     * @param {this['_dto']} json - The JSON object.
+     * @returns {this} - The instance of the RequestDtoMapper.
+     */
+    fromDto(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.
+     */
+    deserializeDtoToEntity(json: this['_dto'], ...additionalArgs: Parameters<this['toEntity']>): Entity;
+    /**
+     * Creates an instance of a RequestDtoMapper from a JSON object.
+     *
+     * @template T - A type that extends RequestDtoMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @template JsonType - The type of the JSON object.
+     * @param {DtoMapperConstructor<T, SV>} this - The constructor of the T.
+     * @param {SV} schemaValidator - The schema provider.
+     * @param {JsonType} json - The JSON object.
+     * @returns {T} - An instance of the T.
+     */
+    static fromDto<T extends RequestDtoMapper<BaseEntity, SV>, SV extends AnySchemaValidator, JsonType extends T['_dto']>(this: DtoMapperConstructor<T, SV>, schemaValidator: SV, json: JsonType): T;
+    /**
+     * Deserializes a JSON object to an entity.
+     *
+     * @template T - A type that extends RequestDtoMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @template JsonType - The type of the JSON object.
+     * @param {DtoMapperConstructor<T, SV>} this - The constructor of the T.
+     * @param {SV} schemaValidator - The schema provider.
+     * @param {JsonType} json - The JSON object.
+     * @param {...unknown[]} additionalArgs - Additional arguments.
+     * @returns {T['_Entity']} - The entity.
+     */
+    static deserializeDtoToEntity<T extends RequestDtoMapper<BaseEntity, SV>, SV extends AnySchemaValidator, JsonType extends T['_dto']>(this: DtoMapperConstructor<T, SV>, schemaValidator: SV, json: JsonType, ...additionalArgs: Parameters<T['toEntity']>): T['_Entity'];
+}
+
+/**
+ * Abstract class representing a response entity mapper.
+ *
+ * @template Entity - A type that extends BaseEntity.
+ * @template SV - A type that extends AnySchemaValidator.
+ * @extends {BaseDtoMapper<SV>}
+ */
+declare abstract class ResponseDtoMapper<Entity extends BaseEntity, SV extends AnySchemaValidator> extends BaseDtoMapper<SV> {
+    /**
+     * The entity type.
+     * @type {Entity}
+     * @protected
+     */
+    _Entity: Entity;
+    /**
+     * Populates entity mapper with DTO from an entity.
+     *
+     * @abstract
+     * @param {Entity} entity - The entity to convert.
+     * @param {...unknown[]} additionalArgs - Additional arguments.
+     * @returns {this} - The instance of the ResponseDtoMapper.
+     */
+    abstract fromEntity(entity: Entity, ...additionalArgs: unknown[]): this;
+    /**
+     * Converts the underlying DTO to a JSON object.
+     *
+     * @returns {this['_dto']} - The JSON object.
+     * @throws {Error} - Throws an error if the DTO is invalid.
+     */
+    toDto(): this['_dto'];
+    /**
+     * Serializes an entity to a JSON object.
+     *
+     * @param {Entity} entity - The entity to serialize.
+     * @returns {this['_dto']} - The JSON object.
+     * @throws {Error} - Throws an error if the DTO is invalid.
+     */
+    serializeEntityToDto(...[entity, ...additionalArgs]: Parameters<this['fromEntity']>): this['_dto'];
+    /**
+     * Populates entity mapper with DTO from an entity.
+     *
+     * @template T - A type that extends ResponseDtoMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @param {DtoMapperConstructor<T, SV>} this - The constructor of the T.
+     * @param {SV} schemaValidator - The schema provider.
+     * @param {T['_Entity']} entity - The entity to convert.
+     * @returns {T} - An instance of the T.
+     */
+    static fromEntity<T extends ResponseDtoMapper<BaseEntity, SV>, SV extends AnySchemaValidator>(this: DtoMapperConstructor<T, SV>, schemaValidator: SV, ...[entity, ...additionalArgs]: Parameters<T['fromEntity']>): T;
+    /**
+     * Serializes an entity to a JSON object.
+     *
+     * @template T - A type that extends ResponseDtoMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @param {DtoMapperConstructor<T, SV>} this - The constructor of the T.
+     * @param {SV} schemaValidator - The schema provider.
+     * @param {T['_Entity']} entity - The entity to serialize.
+     * @returns {T['_dto']} - The JSON object.
+     * @throws {Error} - Throws an error if the DTO is invalid.
+     */
+    static serializeEntityToDto<T extends ResponseDtoMapper<BaseEntity, SV>, SV extends AnySchemaValidator, DtoType extends T['_dto']>(this: DtoMapperConstructor<T, SV>, schemaValidator: SV, ...[entity, ...additionalArgs]: Parameters<T['fromEntity']>): DtoType;
+}
+
+export { RequestDtoMapper, ResponseDtoMapper };

package/lib/dtoMapper/index.d.ts

@@ -0,0 +1,215 @@
+import { AnySchemaValidator, UnboxedObjectSchema, SchemaValidator, Schema } from '@forklaunch/validator';
+import { B as BaseEntity } from '../base.entity-DNfmMOgd.js';
+
+/**
+ * Interface representing a constructor for an entity mapper.
+ *
+ * @template T - The type of the entity mapper.
+ * @template SV - The type of the schema validator.
+ * @interface DtoMapperConstructor
+ */
+interface DtoMapperConstructor<T, SV extends AnySchemaValidator> {
+    /**
+     * Creates a new instance of the entity mapper.
+     *
+     * @param {AnySchemaValidator} schemaValidator - The arguments to pass to the constructor.
+     * @returns {T} - A new instance of the entity mapper.
+     */
+    new (schemaValidator: SV): T;
+}
+
+/**
+ * Type representing a schema validator object for an entity mapper.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @typedef {SV['_ValidSchemaObject'] | UnboxedObjectSchema<SV>} DtoMapperSchemaValidatorObject
+ */
+type DtoMapperSchemaValidatorObject<SV extends AnySchemaValidator> = SV['_ValidSchemaObject'] | UnboxedObjectSchema<SV>;
+
+/**
+ * Abstract class representing a base entity mapper.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
+declare abstract class BaseDtoMapper<SV extends AnySchemaValidator> {
+    /**
+     * The schema validator exact type.
+     * @type {SV}
+     * @protected
+     */
+    _SV: SV;
+    /**
+     * The schema validator as a general type.
+     * @type {SchemaValidator}
+     * @protected
+     */
+    protected schemaValidator: SchemaValidator;
+    /**
+     * The schema definition.
+     * @type {DtoMapperSchemaValidatorObject<SV>}
+     * @abstract
+     */
+    abstract schema: DtoMapperSchemaValidatorObject<SV>;
+    /**
+     * The Data Transfer Object (DTO).
+     * @type {Schema<this['schema'], SV>}
+     */
+    _dto: Schema<this['schema'], SV>;
+    /**
+     * Creates an instance of BaseDtoMapper.
+     *
+     * @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).
+     */
+    get dto(): this['_dto'];
+    /**
+     * Gets the schema of a T.
+     *
+     * @template T - A type that extends BaseDtoMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @param {DtoMapperConstructor<T, SV>} this - The constructor of the T.
+     * @returns {T['schema']} - The schema of the T.
+     */
+    static schema<T extends BaseDtoMapper<SV>, SV extends AnySchemaValidator>(this: DtoMapperConstructor<T, SV>): T['schema'];
+}
+
+/**
+ * Abstract class representing a request entity mapper.
+ *
+ * @template Entity - A type that extends BaseEntity.
+ * @template SV - A type that extends AnySchemaValidator.
+ * @extends {BaseDtoMapper<SV>}
+ */
+declare abstract class RequestDtoMapper<Entity extends BaseEntity, SV extends AnySchemaValidator> extends BaseDtoMapper<SV> {
+    /**
+     * The entity type.
+     * @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;
+    /**
+     * Populates the DTO with data from a JSON object.
+     *
+     * @param {this['_dto']} json - The JSON object.
+     * @returns {this} - The instance of the RequestDtoMapper.
+     */
+    fromDto(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.
+     */
+    deserializeDtoToEntity(json: this['_dto'], ...additionalArgs: Parameters<this['toEntity']>): Entity;
+    /**
+     * Creates an instance of a RequestDtoMapper from a JSON object.
+     *
+     * @template T - A type that extends RequestDtoMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @template JsonType - The type of the JSON object.
+     * @param {DtoMapperConstructor<T, SV>} this - The constructor of the T.
+     * @param {SV} schemaValidator - The schema provider.
+     * @param {JsonType} json - The JSON object.
+     * @returns {T} - An instance of the T.
+     */
+    static fromDto<T extends RequestDtoMapper<BaseEntity, SV>, SV extends AnySchemaValidator, JsonType extends T['_dto']>(this: DtoMapperConstructor<T, SV>, schemaValidator: SV, json: JsonType): T;
+    /**
+     * Deserializes a JSON object to an entity.
+     *
+     * @template T - A type that extends RequestDtoMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @template JsonType - The type of the JSON object.
+     * @param {DtoMapperConstructor<T, SV>} this - The constructor of the T.
+     * @param {SV} schemaValidator - The schema provider.
+     * @param {JsonType} json - The JSON object.
+     * @param {...unknown[]} additionalArgs - Additional arguments.
+     * @returns {T['_Entity']} - The entity.
+     */
+    static deserializeDtoToEntity<T extends RequestDtoMapper<BaseEntity, SV>, SV extends AnySchemaValidator, JsonType extends T['_dto']>(this: DtoMapperConstructor<T, SV>, schemaValidator: SV, json: JsonType, ...additionalArgs: Parameters<T['toEntity']>): T['_Entity'];
+}
+
+/**
+ * Abstract class representing a response entity mapper.
+ *
+ * @template Entity - A type that extends BaseEntity.
+ * @template SV - A type that extends AnySchemaValidator.
+ * @extends {BaseDtoMapper<SV>}
+ */
+declare abstract class ResponseDtoMapper<Entity extends BaseEntity, SV extends AnySchemaValidator> extends BaseDtoMapper<SV> {
+    /**
+     * The entity type.
+     * @type {Entity}
+     * @protected
+     */
+    _Entity: Entity;
+    /**
+     * Populates entity mapper with DTO from an entity.
+     *
+     * @abstract
+     * @param {Entity} entity - The entity to convert.
+     * @param {...unknown[]} additionalArgs - Additional arguments.
+     * @returns {this} - The instance of the ResponseDtoMapper.
+     */
+    abstract fromEntity(entity: Entity, ...additionalArgs: unknown[]): this;
+    /**
+     * Converts the underlying DTO to a JSON object.
+     *
+     * @returns {this['_dto']} - The JSON object.
+     * @throws {Error} - Throws an error if the DTO is invalid.
+     */
+    toDto(): this['_dto'];
+    /**
+     * Serializes an entity to a JSON object.
+     *
+     * @param {Entity} entity - The entity to serialize.
+     * @returns {this['_dto']} - The JSON object.
+     * @throws {Error} - Throws an error if the DTO is invalid.
+     */
+    serializeEntityToDto(...[entity, ...additionalArgs]: Parameters<this['fromEntity']>): this['_dto'];
+    /**
+     * Populates entity mapper with DTO from an entity.
+     *
+     * @template T - A type that extends ResponseDtoMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @param {DtoMapperConstructor<T, SV>} this - The constructor of the T.
+     * @param {SV} schemaValidator - The schema provider.
+     * @param {T['_Entity']} entity - The entity to convert.
+     * @returns {T} - An instance of the T.
+     */
+    static fromEntity<T extends ResponseDtoMapper<BaseEntity, SV>, SV extends AnySchemaValidator>(this: DtoMapperConstructor<T, SV>, schemaValidator: SV, ...[entity, ...additionalArgs]: Parameters<T['fromEntity']>): T;
+    /**
+     * Serializes an entity to a JSON object.
+     *
+     * @template T - A type that extends ResponseDtoMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @param {DtoMapperConstructor<T, SV>} this - The constructor of the T.
+     * @param {SV} schemaValidator - The schema provider.
+     * @param {T['_Entity']} entity - The entity to serialize.
+     * @returns {T['_dto']} - The JSON object.
+     * @throws {Error} - Throws an error if the DTO is invalid.
+     */
+    static serializeEntityToDto<T extends ResponseDtoMapper<BaseEntity, SV>, SV extends AnySchemaValidator, DtoType extends T['_dto']>(this: DtoMapperConstructor<T, SV>, schemaValidator: SV, ...[entity, ...additionalArgs]: Parameters<T['fromEntity']>): DtoType;
+}
+
+export { RequestDtoMapper, ResponseDtoMapper };