@forklaunch/core 0.2.3 → 0.2.6

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

@@ -0,0 +1,63 @@
+/**
+ * Constructs an instance of a T.
+ *
+ * @template T - A type that extends BaseEntityMapper.
+ * @template SV - A type that extends AnySchemaValidator.
+ * @param {EntityMapperConstructor<T, SV>} self - The constructor of the T.
+ * @param {SV} [schemaValidator] - The optional schema validator.
+ * @returns {T} - An instance of the T.
+ */
+export function construct<T, SV>(self: EntityMapperConstructor<T, SV>, schemaValidator?: SV | undefined): T;
+/**
+ * Abstract class representing a base entity mapper.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ */
+export class BaseEntityMapper<SV> {
+    /**
+     * Gets the schema of a T.
+     *
+     * @template T - A type that extends BaseEntityMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @param {EntityMapperConstructor<T, SV>} this - The constructor of the T.
+     * @returns {T['schema']} - The schema of the T.
+     */
+    static schema<T, SV_1>(): T["schema"];
+    /**
+     * Creates an instance of BaseEntityMapper.
+     *
+     * @param {SV} schemaValidator - The schema provider.
+     */
+    constructor(schemaValidator: SV);
+    /**
+     * The schema validator exact type.
+     * @type {SV}
+     * @protected
+     */
+    protected _SV: SV;
+    /**
+     * The schema validator as a general type.
+     * @type {SchemaValidator}
+     * @protected
+     */
+    protected schemaValidator: SchemaValidator;
+    /**
+     * The Data Transfer Object (DTO).
+     * @type {Schema<this['schema'], SV>}
+     */
+    _dto: Schema<this["schema"], 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"];
+}
+//# sourceMappingURL=baseEntityMapper.model.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"baseEntityMapper.model.d.ts","sourceRoot":"","sources":["../../../../dist/entityMapper/models/baseEntityMapper.model.js"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,0BANa,CAAC,EACD,EAAE,QACJ,uBAAuB,CAAC,CAAC,EAAE,EAAE,CAAC,qCAE5B,CAAC,CAIb;AACD;;;;GAIG;AACH,8BAFa,EAAE;IAgDX;;;;;;;OAOG;IACH,cALa,CAAC,WAGD,CAAC,CAAC,QAAQ,CAAC,CAIvB;IAtCD;;;;OAIG;IACH,6BAFW,EAAE,EAIZ;IAxBD;;;;OAIG;IACH,eAHU,EAAE,CAGR;IACJ;;;;OAIG;IACH,2BAHU,eAAe,CAGT;IAChB;;;OAGG;IACH,MAFU,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC,CAE1B;IASV;;;;;OAKG;IACH,4BAKC;IACD;;;;OAIG;IACH,wBAEC;CAYJ"}

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

@@ -0,0 +1,58 @@
+/**
+ * Abstract class representing a request entity mapper.
+ *
+ * @template Entity - A type that extends BaseEntity.
+ * @template SV - A type that extends AnySchemaValidator.
+ * @extends {BaseEntityMapper<SV>}
+ */
+export class RequestEntityMapper<Entity, SV> extends BaseEntityMapper<SV> {
+    /**
+     * Creates an instance of a RequestEntityMapper from a JSON object.
+     *
+     * @template T - A type that extends RequestEntityMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @template JsonType - The type of the JSON object.
+     * @param {EntityMapperConstructor<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 fromJson<T, SV_1, JsonType>(schemaValidator: SV_1, json: JsonType): T;
+    /**
+     * Deserializes a JSON object to an entity.
+     *
+     * @template T - A type that extends RequestEntityMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @template JsonType - The type of the JSON object.
+     * @param {EntityMapperConstructor<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 deserializeJsonToEntity<T, SV_1, JsonType>(schemaValidator: SV_1, json: JsonType, ...additionalArgs: unknown[][]): T["_Entity"];
+    constructor(schemaValidator: SV);
+    /**
+     * The entity type.
+     * @type {Entity}
+     * @protected
+     */
+    protected _Entity: 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;
+}
+import { BaseEntityMapper } from './baseEntityMapper.model';
+//# sourceMappingURL=requestEntityMapper.model.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"requestEntityMapper.model.d.ts","sourceRoot":"","sources":["../../../../dist/entityMapper/models/requestEntityMapper.model.js"],"names":[],"mappings":"AACA;;;;;;GAMG;AACH,iCAJa,MAAM,EACN,EAAE;IAiCX;;;;;;;;;;OAUG;IACH,gBARa,CAAC,QAED,QAAQ,mBAEV,IAAE,QACF,QAAQ,GACN,CAAC,CAIb;IACD;;;;;;;;;;;OAWG;IACH,+BATa,CAAC,QAED,QAAQ,mBAEV,IAAE,QACF,QAAQ,qBACL,OAAO,EAAE,EAAA,GACV,CAAC,CAAC,SAAS,CAAC,CAMxB;;IA3DD;;;;OAIG;IACH,mBAHU,MAAM,CAGR;IACR;;;;;OAKG;IACH,eAHW,IAAI,CAAC,MAAM,CAAC,GACV,IAAI,CAQhB;IACD;;;;;;OAMG;IACH,8BAJW,IAAI,CAAC,MAAM,CAAC,qBACT,OAAO,EAAE,EAAA,GACV,MAAM,CAIlB;CAgCJ;iCArE2C,0BAA0B"}

package/lib/dist/entityMapper/models/responseEntityMapper.model.d.ts

@@ -0,0 +1,56 @@
+/**
+ * Abstract class representing a response entity mapper.
+ *
+ * @template Entity - A type that extends BaseEntity.
+ * @template SV - A type that extends AnySchemaValidator.
+ * @extends {BaseEntityMapper<SV>}
+ */
+export class ResponseEntityMapper<Entity, SV> extends BaseEntityMapper<SV> {
+    /**
+     * Populates entity mapper with DTO from an entity.
+     *
+     * @template T - A type that extends ResponseEntityMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @param {EntityMapperConstructor<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, SV_1>(schemaValidator: SV_1, entity: T["_Entity"]): T;
+    /**
+     * Serializes an entity to a JSON object.
+     *
+     * @template T - A type that extends ResponseEntityMapper.
+     * @template SV - A type that extends AnySchemaValidator.
+     * @param {EntityMapperConstructor<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 serializeEntityToJson<T, SV_1>(schemaValidator: SV_1, entity: T["_Entity"]): T["_dto"];
+    constructor(schemaValidator: SV);
+    /**
+     * The entity type.
+     * @type {Entity}
+     * @protected
+     */
+    protected _Entity: Entity;
+    /**
+     * Converts the underlying DTO to a JSON object.
+     *
+     * @returns {this['_dto']} - The JSON object.
+     * @throws {Error} - Throws an error if the DTO is invalid.
+     */
+    toJson(): 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.
+     */
+    serializeEntityToJson(entity: Entity): this["_dto"];
+}
+import { BaseEntityMapper } from './baseEntityMapper.model';
+//# sourceMappingURL=responseEntityMapper.model.d.ts.map

package/lib/dist/entityMapper/models/responseEntityMapper.model.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"responseEntityMapper.model.d.ts","sourceRoot":"","sources":["../../../../dist/entityMapper/models/responseEntityMapper.model.js"],"names":[],"mappings":"AACA;;;;;;GAMG;AACH,kCAJa,MAAM,EACN,EAAE;IAgCX;;;;;;;;;OASG;IACH,kBAPa,CAAC,yBAGH,IAAE,UACF,CAAC,CAAC,SAAS,CAAC,GACV,CAAC,CAIb;IACD;;;;;;;;;;OAUG;IACH,6BARa,CAAC,yBAGH,IAAE,UACF,CAAC,CAAC,SAAS,CAAC,GACV,CAAC,CAAC,MAAM,CAAC,CAKrB;;IAtDD;;;;OAIG;IACH,mBAHU,MAAM,CAGR;IACR;;;;;OAKG;IACH,UAHa,IAAI,CAAC,MAAM,CAAC,CAQxB;IACD;;;;;;OAMG;IACH,8BAJW,MAAM,GACJ,IAAI,CAAC,MAAM,CAAC,CAKxB;CA4BJ;iCAhE2C,0BAA0B"}

package/lib/dist/entityMapper/types/entityMapper.types.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=entityMapper.types.d.ts.map

package/lib/dist/entityMapper/types/entityMapper.types.d.ts.map

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

package/lib/dist/http/guards/isHttpContractDetails.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Type guard for HttpContractDetails
+ */
+export function isHttpContractDetails(contractDetails: any): boolean;
+//# sourceMappingURL=isHttpContractDetails.d.ts.map

package/lib/dist/http/guards/isHttpContractDetails.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isHttpContractDetails.d.ts","sourceRoot":"","sources":["../../../../dist/http/guards/isHttpContractDetails.js"],"names":[],"mappings":"AAAA;;GAEG;AACH,qEAEC"}

package/lib/dist/http/guards/isHttpContractDetails.js

@@ -0,0 +1,6 @@
+/**
+ * Type guard for HttpContractDetails
+ */
+export function isHttpContractDetails(contractDetails) {
+    return (contractDetails.body !== undefined);
+}

package/lib/dist/http/guards/isResponseShape.d.ts

@@ -0,0 +1,2 @@
+export function isResponseShape(response: any): boolean;
+//# sourceMappingURL=isResponseShape.d.ts.map

package/lib/dist/http/guards/isResponseShape.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"isResponseShape.d.ts","sourceRoot":"","sources":["../../../../dist/http/guards/isResponseShape.js"],"names":[],"mappings":"AAAA,wDAMC"}

package/lib/dist/http/guards/isResponseShape.js

@@ -0,0 +1,7 @@
+export function isResponseShape(response) {
+    return (response != null &&
+        Object.hasOwn(response, 'body') &&
+        Object.hasOwn(response, 'query') &&
+        Object.hasOwn(response, 'params') &&
+        Object.hasOwn(response, 'headers'));
+}

package/lib/dist/http/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./interfaces";
+export * from "./middleware";
+export * from "./openApiV3Generator";
+export * from "./types";
+export * from "./utils";
+//# sourceMappingURL=index.d.ts.map

package/lib/dist/http/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../dist/http/index.js"],"names":[],"mappings":""}

package/{dist → lib/dist}/http/index.js

@@ -1,6 +1,5 @@
-export * from './httpStatusCodes';
 export * from './interfaces';
 export * from './middleware';
 export * from './openApiV3Generator';
-export * from './regex';
 export * from './types';
+export * from './utils';

package/lib/dist/http/interfaces/expressLikeApplication.interface.d.ts

@@ -0,0 +1,12 @@
+export class ForklaunchExpressLikeApplication {
+    /**
+     * Creates an instance of the Application class.
+     *
+     * @param {SV} schemaValidator - The schema validator.
+     */
+    constructor(schemaValidator: SV, internal: any);
+    schemaValidator: SV;
+    internal: any;
+    routers: any[];
+}
+//# sourceMappingURL=expressLikeApplication.interface.d.ts.map

package/lib/dist/http/interfaces/expressLikeApplication.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"expressLikeApplication.interface.d.ts","sourceRoot":"","sources":["../../../../dist/http/interfaces/expressLikeApplication.interface.js"],"names":[],"mappings":"AAAA;IAII;;;;OAIG;IACH,6BAFW,EAAE,iBAKZ;IAXD,oBAAgB;IAChB,cAAS;IACT,eAAa;CAUhB"}

package/lib/dist/http/interfaces/expressLikeRouter.interface.d.ts

@@ -0,0 +1,103 @@
+/**
+ * Router class that sets up routes and middleware for an Express router, for use with controller/routes pattern.
+ *
+ * @template SV - A type that extends AnySchemaValidator.
+ * @template contractDetails - The contract details.
+ * @template functions - The handler middlware and function.
+ */
+export function typedHandler<SV, contractDetails, functions>(_schemaValidator: any, _method: any, contractDetails: any, ...functions: any[]): TypedHandler;
+/**
+ * A class that represents an Express-like router.
+ */
+export class ForklaunchExpressLikeRouter {
+    constructor(basePath: any, schemaValidator: any, internal: any);
+    schemaValidator: any;
+    internal: any;
+    routes: any[];
+    basePath: any;
+    /**
+     * Registers middleware to the router.
+     *
+     * @param {...unknown[]} args - The middleware to register.
+     * @returns {this} - The router instance.
+     */
+    use(...args: unknown[][]): this;
+    /**
+     * Registers a GET route with the specified contract details and handler functions.
+     *
+     * @template P - The type of request parameters.
+     * @template ResBodyMap - The type of response body.
+     * @template ReqBody - The type of request body.
+     * @template ReqQuery - The type of request query.
+     * @template LocalsObj - The type of local variables.
+     * @param {string} path - The path for the route.
+     * @param {PathParamHttpContractDetails<SV, P, ResBodyMap, ReqQuery>} contractDetails - The contract details.
+     * @param {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
+     * @returns {ExpressRouter} - The Express router.
+     */
+    get<P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>(path: string, contractDetailsOrTypedHandler: any, ...functions: SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[][]): ExpressRouter;
+    /**
+     * Registers a POST route with the specified contract details and handler functions.
+     *
+     * @template P - The type of request parameters.
+     * @template ResBodyMap - The type of response body.
+     * @template ReqBody - The type of request body.
+     * @template ReqQuery - The type of request query.
+     * @template LocalsObj - The type of local variables.
+     * @param {string} path - The path for the route.
+     * @param {HttpContractDetails<SV, P, ResBodyMap, ReqBody, ReqQuery>} contractDetails - The contract details.
+     * @param {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
+     * @returns {ExpressRouter} - The Express router.
+     */
+    post<P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>(path: string, contractDetailsOrTypedHandler: any, ...functions: SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[][]): ExpressRouter;
+    /**
+     * Registers a PUT route with the specified contract details and handler functions.
+     *
+     * @template P - The type of request parameters.
+     * @template ResBodyMap - The type of response body.
+     * @template ReqBody - The type of request body.
+     * @template ReqQuery - The type of request query.
+     * @template LocalsObj - The type of local variables.
+     * @param {string} path - The path for the route.
+     * @param {HttpContractDetails<SV, P, ResBodyMap, ReqBody, ReqQuery>} contractDetails - The contract details.
+     * @param {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
+     * @returns {ExpressRouter} - The Express router.
+     */
+    put<P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>(path: string, contractDetailsOrTypedHandler: any, ...functions: SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[][]): ExpressRouter;
+    /**
+     * Registers a PATCH route with the specified contract details and handler functions.
+     *
+     * @template P - The type of request parameters.
+     * @template ResBodyMap - The type of response body.
+     * @template ReqBody - The type of request body.
+     * @template ReqQuery - The type of request query.
+     * @template LocalsObj - The type of local variables.
+     * @param {string} path - The path for the route.
+     * @param {HttpContractDetails<SV, P, ResBodyMap, ReqBody, ReqQuery>} contractDetails - The contract details.
+     * @param {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
+     * @returns {ExpressRouter} - The Express router.
+     */
+    patch<P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>(path: string, contractDetailsOrTypedHandler: any, ...functions: SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[][]): ExpressRouter;
+    /**
+     * Registers a DELETE route with the specified contract details and handler functions.
+     *
+     * @template P - The type of request parameters.
+     * @template ResBodyMap - The type of response body.
+     * @template ReqBody - The type of request body.
+     * @template ReqQuery - The type of request query.
+     * @template LocalsObj - The type of local variables.
+     * @param {string} path - The path for the route.
+     * @param {PathParamHttpContractDetails<SV, P, ResBodyMap, ReqQuery>} contractDetails - The contract details.
+     * @param {...SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[]} functions - The handler functions.
+     * @returns {ExpressRouter} - The Express router.
+     */
+    delete<P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>(path: string, contractDetailsOrTypedHandler: any, ...functions: SchemaMiddlewareHandler<SV, P, ResBodyMap, ReqBody, ReqQuery, LocalsObj>[][]): ExpressRouter;
+    #private;
+}
+declare class TypedHandler {
+    constructor(contractDetails: any, functions: any);
+    contractDetails: any;
+    functions: any;
+}
+export {};
+//# sourceMappingURL=expressLikeRouter.interface.d.ts.map

package/lib/dist/http/interfaces/expressLikeRouter.interface.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"expressLikeRouter.interface.d.ts","sourceRoot":"","sources":["../../../../dist/http/interfaces/expressLikeRouter.interface.js"],"names":[],"mappings":"AAsUA;;;;;;GAMG;AACH,6BAJa,EAAE,4HAMd;AA7UD;;GAEG;AACH;IAKI,gEAMC;IAVD,qBAAgB;IAChB,cAAS;IACT,cAAY;IACZ,cAAS;IAyFT;;;;;OAKG;IACH,aAHc,OAAO,EAAE,EAAA,GACV,IAAI,CAKhB;IAwHD;;;;;;;;;;;;OAYG;IACH,IAVa,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,SAAS,QACX,MAAM,oDAEH,uBAAuB,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAA,GAC3E,aAAa,CAMzB;IACD;;;;;;;;;;;;OAYG;IACH,KAVa,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,SAAS,QACX,MAAM,oDAEH,uBAAuB,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAA,GAC3E,aAAa,CAMzB;IACD;;;;;;;;;;;;OAYG;IACH,IAVa,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,SAAS,QACX,MAAM,oDAEH,uBAAuB,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAA,GAC3E,aAAa,CAMzB;IACD;;;;;;;;;;;;OAYG;IACH,MAVa,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,SAAS,QACX,MAAM,oDAEH,uBAAuB,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAA,GAC3E,aAAa,CAMzB;IACD;;;;;;;;;;;;OAYG;IACH,OAVa,CAAC,EACD,UAAU,EACV,OAAO,EACP,QAAQ,EACR,SAAS,QACX,MAAM,oDAEH,uBAAuB,CAAC,EAAE,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC,EAAE,EAAA,GAC3E,aAAa,CAMzB;;CACJ;AACD;IAGI,kDAGC;IALD,qBAAgB;IAChB,eAAU;CAKb"}