zibri 2.2.0 → 2.2.1

package/src/metrics/metrics.service.ts

@@ -1,17 +1,21 @@
+import os from 'node:os';
+
 import { Registry, Counter, Histogram, collectDefaultMetrics, Gauge, MetricObjectWithValues, MetricValue } from 'prom-client';
 import si from 'systeminformation';
 
 import { CounterMetricName, GaugeMetricName, HistogramMetricName, MetricsServiceInterface, MetricsSnapshot } from './metrics-service.interface';
 import { ZibriApplication } from '../application';
-import { HttpRequest, HttpResponse } from '../http';
 import { CounterInterface } from './counter.interface';
 import { GaugeInterface } from './gauge.interface';
 import { HistogramInterface } from './histogram.interface';
 import { MetricType } from './metric-type.enum';
 import { Metric } from './metric.model';
 import { ScrapeMetricsCronJob } from './scrape-metrics.cron-job';
-import { AssetServiceInterface } from '../assets';
-import { inject, ZIBRI_DI_TOKENS } from '../di';
+import { AssetServiceInterface } from '../assets/asset-service.interface';
+import { ZIBRI_DI_TOKENS } from '../di/default/zibri-di-tokens.default';
+import { inject } from '../di/inject.function';
+import { HttpRequest } from '../http/http-request.model';
+import { HttpResponse } from '../http/http-response.model';
 
 // eslint-disable-next-line jsdoc/require-jsdoc
 class PromCounter implements CounterInterface {
@@ -71,6 +75,7 @@ export class PrometheusMetricsService implements MetricsServiceInterface {
         this.getHistogram(
             'http_request_duration_ms', ['method', 'route', 'status_code'], [50, 100, 200, 500, 1000, 2000, 5000]
         );
+        this.getGauge('process_cpu_count').set({ }, os.availableParallelism());
     }
 
     // eslint-disable-next-line jsdoc/require-jsdoc
@@ -110,7 +115,7 @@ export class PrometheusMetricsService implements MetricsServiceInterface {
     }
 
     // eslint-disable-next-line jsdoc/require-jsdoc
-    getCounter(name: CounterMetricName, labelNames?: string[]): PromCounter {
+    getCounter(name: CounterMetricName, labelNames: string[] = []): PromCounter {
         if (!this.counters.has(name)) {
             this.counters.set(name, new Counter({ name, help: name, labelNames, registers: [this.registry] }));
         }
@@ -119,7 +124,7 @@ export class PrometheusMetricsService implements MetricsServiceInterface {
     }
 
     // eslint-disable-next-line jsdoc/require-jsdoc
-    getGauge(name: GaugeMetricName, labelNames?: string[]): PromGauge {
+    getGauge(name: GaugeMetricName, labelNames: string[] = []): PromGauge {
         if (!this.gauges.has(name)) {
             this.gauges.set(name, new Gauge({ name, help: name, labelNames, registers: [this.registry] }));
         }
@@ -128,7 +133,7 @@ export class PrometheusMetricsService implements MetricsServiceInterface {
     }
 
     // eslint-disable-next-line jsdoc/require-jsdoc
-    getHistogram(name: HistogramMetricName, labelNames?: string[], buckets?: number[]): PromHistogram {
+    getHistogram(name: HistogramMetricName, labelNames: string[] = [], buckets: number[] = []): PromHistogram {
         if (!this.histograms.has(name)) {
             this.histograms.set(name, new Histogram({ name, help: name, labelNames, buckets, registers: [this.registry] }));
         }

package/src/metrics/scrape-metrics.cron-job.ts

@@ -1,7 +1,8 @@
-
-import { CronJob, InitialCronConfig } from '../cron';
-import { inject, Injectable, ZIBRI_DI_TOKENS } from '../di';
 import { MetricsServiceInterface } from './metrics-service.interface';
+import { CronJob, InitialCronConfig } from '../cron/cron-job.model';
+import { Injectable } from '../di/decorators/injectable.decorator';
+import { ZIBRI_DI_TOKENS } from '../di/default/zibri-di-tokens.default';
+import { inject } from '../di/inject.function';
 
 /**
  * CronJob that cleans up the temp folder of the form data body parser.

package/src/multithreading/models/thread-job-entity.model.ts

@@ -1,9 +1,11 @@
 import { BaseThreadJobWorkerData } from './base-thread-job-worker-data.model';
 import { ThreadJobStatus } from './thread-job-status.enum';
-import { Entity, Property } from '../../entity';
 import { BaseEntity } from '../../entity/base-entity.model';
-import type { OmitStrict, Percentage } from '../../types';
-import { ThreadJob } from '../services';
+import { Entity } from '../../entity/decorators/entity.decorator';
+import { Property } from '../../entity/decorators/property.decorator';
+import { OmitStrict } from '../../types/omit-strict.type';
+import { type Percentage } from '../../types/percentage.type';
+import { ThreadJob } from '../services/thread-job';
 
 // eslint-disable-next-line unusedImports/no-unused-vars
 const omitValues: (keyof ThreadJob<BaseThreadJobWorkerData, unknown>)[] = [

package/src/multithreading/models/thread-job-message.model.ts

@@ -1,5 +1,5 @@
 import { ThreadJobStatus } from './thread-job-status.enum';
-import { Percentage } from '../../types';
+import { Percentage } from '../../types/percentage.type';
 
 /**
  * The internal thread job message types.

package/src/multithreading/services/multithreading-service.interface.ts

@@ -1,6 +1,8 @@
-import { BaseThreadJobWorkerData, ThreadJobData, ThreadJobDataFunctions, ThreadJobEntity, ThreadJobFunction } from '../models';
-
 // TODO: add functionality to initialize functions in a registry that should be precompiled to avoid eval and improve performance.
+import { BaseThreadJobWorkerData } from '../models/base-thread-job-worker-data.model';
+import { ThreadJobData, ThreadJobDataFunctions } from '../models/thread-job-data.model';
+import { ThreadJobEntity } from '../models/thread-job-entity.model';
+import { ThreadJobFunction } from '../models/thread-job-function.model';
 
 /**
  * Definition for a service that handles multithreading.

package/src/multithreading/services/multithreading.service.test.ts

@@ -1,16 +1,22 @@
 import os from 'node:os';
-import path from 'node:path';
 import { performance } from 'perf_hooks';
 
 import { afterAll, beforeAll, describe, expect, it } from '@jest/globals';
 
 import { MultithreadingService } from './multithreading.service';
-import { AssetService } from '../../assets';
-import { Repository } from '../../data-source';
-import { Logger, LoggerInterface, LoggerTransport, LogLevel } from '../../logging';
-import { OmitStrict } from '../../types';
-import { Ms, UUIDUtilities } from '../../utilities';
-import { BaseThreadJobWorkerData, MultithreadingOptions, ThreadJobEntity } from '../models';
+import { AssetService } from '../../assets/asset.service';
+import { Repository } from '../../data-source/repository';
+import { LogLevel } from '../../logging/log-level.enum';
+import { Logger } from '../../logging/logger';
+import { LoggerInterface } from '../../logging/logger.interface';
+import { LoggerTransport } from '../../logging/transport/logger-transport.model';
+import { OmitStrict } from '../../types/omit-strict.type';
+import { FsUtilities } from '../../utilities/fs.utilities';
+import { Ms } from '../../utilities/ms';
+import { UUIDUtilities } from '../../utilities/uuid.utilities';
+import { BaseThreadJobWorkerData } from '../models/base-thread-job-worker-data.model';
+import { MultithreadingOptions } from '../models/multithreading-options.model';
+import { ThreadJobEntity } from '../models/thread-job-entity.model';
 
 // minimal in-memory repository used by the service in tests
 class InMemoryThreadJobRepository {
@@ -63,7 +69,7 @@ const logger: LoggerInterface = new Logger(
     }
 );
 const assetService: AssetService = new AssetService(logger);
-(assetService.assetsPath as unknown as string) = path.join(__dirname, '../../../sandbox/assets');
+(assetService.assetsPath as unknown as string) = FsUtilities.getPath(__dirname, '../../../sandbox/assets');
 
 function fib(n: number): number {
     if (n < 2) {

package/src/multithreading/services/multithreading.service.ts

@@ -1,19 +1,27 @@
 import os from 'node:os';
-import path from 'node:path';
 import { Worker } from 'node:worker_threads';
 
 import { filter, firstValueFrom } from 'rxjs';
 
 import { MultithreadingServiceInterface } from './multithreading-service.interface';
-import { Inject, InjectRepository, ZIBRI_DI_TOKENS } from '../../di';
-import { OmitStrict } from '../../types';
-import { BaseFunctionThreadJobWorkerData, BaseThreadJobWorkerData, type MultithreadingOptions, ThreadJobData, ThreadJobDataFunctions, ThreadJobEntity, ThreadJobFunction, ThreadJobMessage, ThreadJobStatus } from '../models';
 import { ThreadJob } from './thread-job';
 import { ThreadJobWorker } from './thread-job-worker';
-import type { AssetServiceInterface } from '../../assets';
-import { Repository } from '../../data-source';
-import type { LoggerInterface } from '../../logging';
-import { pathExists, UUIDUtilities } from '../../utilities';
+import { type AssetServiceInterface } from '../../assets/asset-service.interface';
+import { Repository } from '../../data-source/repository';
+import { InjectRepository } from '../../di/decorators/inject-repository.decorator';
+import { Inject } from '../../di/decorators/inject.decorator';
+import { ZIBRI_DI_TOKENS } from '../../di/default/zibri-di-tokens.default';
+import { type LoggerInterface } from '../../logging/logger.interface';
+import { OmitStrict } from '../../types/omit-strict.type';
+import { FsUtilities, Path } from '../../utilities/fs.utilities';
+import { UUIDUtilities } from '../../utilities/uuid.utilities';
+import { BaseFunctionThreadJobWorkerData, BaseThreadJobWorkerData } from '../models/base-thread-job-worker-data.model';
+import { type MultithreadingOptions } from '../models/multithreading-options.model';
+import { ThreadJobData, ThreadJobDataFunctions } from '../models/thread-job-data.model';
+import { ThreadJobEntity } from '../models/thread-job-entity.model';
+import { ThreadJobFunction } from '../models/thread-job-function.model';
+import { ThreadJobMessage } from '../models/thread-job-message.model';
+import { ThreadJobStatus } from '../models/thread-job-status.enum';
 
 /**
  * A service that handles multithreading.
@@ -31,7 +39,7 @@ export class MultithreadingService implements MultithreadingServiceInterface {
      * The workers that are currently idle.
      */
     private idleWorkers: ThreadJobWorker[] = [];
-    private readonly threadJobWorkerFilePath: string;
+    private readonly threadJobWorkerFilePath: Path;
 
     constructor(
         @Inject(ZIBRI_DI_TOKENS.MULTITHREADING_OPTIONS)
@@ -43,7 +51,7 @@ export class MultithreadingService implements MultithreadingServiceInterface {
         @Inject(ZIBRI_DI_TOKENS.LOGGER)
         private readonly logger: LoggerInterface
     ) {
-        this.threadJobWorkerFilePath = path.join(this.assetService.assetsPath, 'thread-job.worker.cjs');
+        this.threadJobWorkerFilePath = FsUtilities.getPath(this.assetService.assetsPath, 'thread-job.worker.cjs');
     }
 
     // eslint-disable-next-line jsdoc/require-jsdoc
@@ -82,7 +90,7 @@ export class MultithreadingService implements MultithreadingServiceInterface {
     }
 
     private async validateInputs(): Promise<void> {
-        const workerFileExists: boolean = await pathExists(this.threadJobWorkerFilePath);
+        const workerFileExists: boolean = await FsUtilities.exists(this.threadJobWorkerFilePath);
         if (!workerFileExists) {
             throw new Error(`Could not start MultithreadingService: The worker file at ${this.threadJobWorkerFilePath} does not exist.`);
         }

package/src/multithreading/services/thread-job.ts

@@ -1,7 +1,10 @@
 import { BehaviorSubject } from 'rxjs';
 
-import { Percentage } from '../../types';
-import { BaseThreadJobWorkerData, ThreadJobData, ThreadJobDataFunctions, ThreadJobEntity, ThreadJobStatus } from '../models';
+import { Percentage } from '../../types/percentage.type';
+import { BaseThreadJobWorkerData } from '../models/base-thread-job-worker-data.model';
+import { ThreadJobData, ThreadJobDataFunctions } from '../models/thread-job-data.model';
+import { ThreadJobEntity } from '../models/thread-job-entity.model';
+import { ThreadJobStatus } from '../models/thread-job-status.enum';
 
 /**
  * A thread job.

package/src/multithreading/services/worker/helpers.ts

@@ -1,7 +1,7 @@
 import { parentPort } from 'node:worker_threads';
 
-import { Percentage } from '../../../types';
-import { ThreadJobMessage } from '../../models';
+import { Percentage } from '../../../types/percentage.type';
+import { ThreadJobMessage } from '../../models/thread-job-message.model';
 
 /**
  * Reports the given progress to the thread job service.

package/src/multithreading/services/worker/thread-job.worker.ts

@@ -4,7 +4,9 @@ import { parentPort } from 'node:worker_threads';
 import { register } from 'ts-node';
 
 import { reportCompletion } from './helpers';
-import { BaseFunctionThreadJobWorkerData, BaseThreadJobWorkerData, ThreadJobFunction, ThreadJobMessage } from '../../models';
+import { BaseThreadJobWorkerData, BaseFunctionThreadJobWorkerData } from '../../models/base-thread-job-worker-data.model';
+import { ThreadJobFunction } from '../../models/thread-job-function.model';
+import { ThreadJobMessage } from '../../models/thread-job-message.model';
 
 if (!parentPort) {
     throw new Error('Internal Error with the thread-job-worker: parentPort not available.');

package/src/open-api/decorators/response.decorator.ts

@@ -1,7 +1,9 @@
-/* eslint-disable jsdoc/require-returns */
-import { HttpStatus } from '../../http';
-import { ExcludeStrict, Newable, OmitStrict } from '../../types';
-import { MetadataUtilities } from '../../utilities';
+
+import { HttpStatus } from '../../http/http-status.enum';
+import { ExcludeStrict } from '../../types/exclude-strict.type';
+import { Newable } from '../../types/newable.type';
+import { OmitStrict } from '../../types/omit-strict.type';
+import { MetadataUtilities } from '../../utilities/metadata.utilities';
 import { JsonOpenApiResponse, ErrorOpenApiResponse, FileOpenApiResponse, OpenApiResponse, HtmlOpenApiResponse } from '../open-api.model';
 import { PaginationResultClass } from '../pagination-result.model';
 

package/src/open-api/open-api-service.interface.ts

@@ -1,7 +1,7 @@
 
 import { ZibriApplication } from '../application';
-import { Route } from '../routing';
 import { OpenApiDefinition } from './open-api.model';
+import { Route } from '../routing/controller-route-configuration.model';
 
 /**
  * Interface for an open api service.

package/src/open-api/open-api.model.ts

@@ -1,7 +1,8 @@
 import { oas31 } from 'openapi3-ts';
 
-import { HttpStatus, MimeType } from '../http';
-import { Newable } from '../types';
+import { HttpStatus } from '../http/http-status.enum';
+import { MimeType } from '../http/mime-type.enum';
+import { Newable } from '../types/newable.type';
 
 /**
  * Alias for the root OpenAPI 3.1 document object.

package/src/open-api/open-api.service.ts

@@ -1,23 +1,39 @@
-import path from 'path';
-
 import swaggerUi from 'swagger-ui-express';
 
 import { ZibriApplication } from '../application';
-import { AssetServiceInterface } from '../assets';
-import { AuthServiceInterface, BelongsToMetadata, HasRoleMetadata, IsLoggedInMetadata } from '../auth';
-import { inject, ZIBRI_DI_TOKENS } from '../di';
-import { ManyToManyPropertyMetadata, ManyToOnePropertyMetadata, OmitClass, OneToManyPropertyMetadata, OneToOnePropertyMetadata, PropertyMetadata, Relation } from '../entity';
-import { BaseEntity } from '../entity/base-entity.model';
-import { GlobalRegistry } from '../global';
-import { HttpMethod, HttpStatus, KnownHeader, MimeType } from '../http';
-import { LoggerInterface } from '../logging';
-import { BodyMetadata, ControllerRouteConfiguration, HeaderParamMetadata, PathParamMetadata, QueryParamMetadata, Route, RouteHandler } from '../routing';
 import { OpenApiServiceInterface } from './open-api-service.interface';
-import { OpenApiContentObject, OpenApiDefinition, OpenApiOperation, OpenApiParameter, OpenApiParameterLocation, OpenApiPaths, OpenApiRequestBodyObject, OpenApiResponse, OpenApiResponseObject, OpenApiResponsesObject, OpenApiSchemaObject, OpenApiSecurityRequirementObject, OpenApiSecuritySchemeObject, OpenApiTagObject } from './open-api.model';
-import { FileResponse } from '../parsing';
+import { OpenApiDefinition, OpenApiTagObject, OpenApiSecuritySchemeObject, OpenApiPaths, OpenApiResponse, OpenApiOperation, OpenApiResponsesObject, OpenApiResponseObject, OpenApiContentObject, OpenApiSchemaObject, OpenApiSecurityRequirementObject, OpenApiRequestBodyObject, OpenApiParameterLocation, OpenApiParameter } from './open-api.model';
+import { AssetServiceInterface } from '../assets/asset-service.interface';
+import { AuthServiceInterface } from '../auth/auth-service.interface';
+import { BelongsToMetadata } from '../auth/models/belongs-to-metadata.model';
+import { HasRoleMetadata } from '../auth/models/has-role-metadata.model';
+import { IsLoggedInMetadata } from '../auth/models/is-logged-in-metadata.model';
+import { ZIBRI_DI_TOKENS } from '../di/default/zibri-di-tokens.default';
+import { inject } from '../di/inject.function';
+import { BaseEntity } from '../entity/base-entity.model';
+import { PropertyMetadata } from '../entity/decorators/property.decorator';
+import { ManyToManyPropertyMetadata } from '../entity/models/many-to-many-property-metadata.model';
+import { ManyToOnePropertyMetadata } from '../entity/models/many-to-one-property-metadata.model';
+import { OneToManyPropertyMetadata } from '../entity/models/one-to-many-property-metadata.model';
+import { OneToOnePropertyMetadata } from '../entity/models/one-to-one-property-metadata.model';
+import { Relation } from '../entity/models/relation.enum';
+import { OmitClass } from '../entity/omit-class.model';
+import { GlobalRegistry } from '../global/global-registry';
+import { HttpMethod } from '../http/http-method.enum';
+import { HttpStatus } from '../http/http-status.enum';
+import { KnownHeader } from '../http/known-header.enum';
+import { MimeType } from '../http/mime-type.enum';
+import { LoggerInterface } from '../logging/logger.interface';
+import { FileResponse } from '../parsing/form-data/file-response.model';
+import { Route, ControllerRouteConfiguration } from '../routing/controller-route-configuration.model';
+import { BodyMetadata } from '../routing/decorators/body.decorator';
+import { PathParamMetadata, QueryParamMetadata, HeaderParamMetadata } from '../routing/decorators/param.decorator';
 import { MissingBaseRouteError } from '../routing/missing-base-route.error';
-import { Newable } from '../types';
-import { MetadataUtilities, ObjectUtilities } from '../utilities';
+import { RouteHandler } from '../routing/route-configuration.model';
+import { Newable } from '../types/newable.type';
+import { FsUtilities, Path } from '../utilities/fs.utilities';
+import { MetadataUtilities } from '../utilities/metadata.utilities';
+import { ObjectUtilities } from '../utilities/object.utilities';
 
 const defaultDescriptionForHttpStatus: Record<HttpStatus | 'default', string> = {
     default: 'Response',
@@ -85,7 +101,7 @@ export class OpenApiService implements OpenApiServiceInterface {
             httpMethod: HttpMethod.GET,
             route: `${this.openApiRoute}/swagger-ui.css`,
             handler: () => {
-                const filePath: string = path.join(this.assetService.publicAssetsPath, 'open-api', 'swagger-ui.css');
+                const filePath: Path = FsUtilities.getPath(this.assetService.publicAssetsPath, 'open-api', 'swagger-ui.css');
                 return FileResponse.fromPath(filePath);
             }
         });
@@ -93,7 +109,7 @@ export class OpenApiService implements OpenApiServiceInterface {
             httpMethod: HttpMethod.GET,
             route: `${this.openApiRoute}/swagger-ui-bundle.js`,
             handler: () => {
-                const filePath: string = path.join(this.assetService.publicAssetsPath, 'open-api', 'swagger-ui-bundle.js');
+                const filePath: Path = FsUtilities.getPath(this.assetService.publicAssetsPath, 'open-api', 'swagger-ui-bundle.js');
                 return FileResponse.fromPath(filePath);
             }
         });
@@ -101,7 +117,11 @@ export class OpenApiService implements OpenApiServiceInterface {
             httpMethod: HttpMethod.GET,
             route: `${this.openApiRoute}/swagger-ui-standalone-preset.js`,
             handler: () => {
-                const filePath: string = path.join(this.assetService.publicAssetsPath, 'open-api', 'swagger-ui-standalone-preset.js');
+                const filePath: Path = FsUtilities.getPath(
+                    this.assetService.publicAssetsPath,
+                    'open-api',
+                    'swagger-ui-standalone-preset.js'
+                );
                 return FileResponse.fromPath(filePath);
             }
         });

package/src/open-api/pagination-result.model.ts

@@ -1,5 +1,5 @@
-import { Property } from '../entity';
-import { Newable } from '../types';
+import { Property } from '../entity/decorators/property.decorator';
+import { Newable } from '../types/newable.type';
 
 /**
  * Type of a pagination result, consisting of the items from the current page and the total amount of items.

package/src/parsing/body-parser.interface.ts

@@ -1,8 +1,9 @@
 import { ZibriApplication } from '../application';
-import { HttpRequest, MimeType } from '../http';
-import { HttpClientResponse } from '../http-client';
-import { BodyMetadata } from '../routing';
-import { WebsocketRequest } from '../websocket';
+import { HttpRequest } from '../http/http-request.model';
+import { MimeType } from '../http/mime-type.enum';
+import { HttpClientResponse } from '../http-client/http-client-response.model';
+import { BodyMetadata } from '../routing/decorators/body.decorator';
+import { WebsocketRequest } from '../websocket/models/websocket-request.model';
 
 /**
  * Interface for a body parser.

package/src/parsing/decorators/body-parser.decorator.ts

@@ -1,9 +1,8 @@
-import { GlobalRegistry } from '../../global';
-import { Newable } from '../../types';
-import { MetadataUtilities } from '../../utilities';
+import { GlobalRegistry } from '../../global/global-registry';
+import { Newable } from '../../types/newable.type';
+import { MetadataUtilities } from '../../utilities/metadata.utilities';
 import { BodyParserInterface } from '../body-parser.interface';
 
-// eslint-disable-next-line jsdoc/require-returns
 /**
  * Marks a request body parser.
  */

package/src/parsing/form-data/file-response.model.ts

@@ -1,12 +1,12 @@
-import { stat } from 'fs/promises';
-import path from 'path';
 import { Readable } from 'stream';
 
-import { inject, ZIBRI_DI_TOKENS } from '../../di';
-import { LooseFileMimeType, resolveMimeType } from '../../http';
-import { LoggerInterface } from '../../logging';
-import { OmitStrict } from '../../types';
-import { pathExists } from '../../utilities';
+import { ZIBRI_DI_TOKENS } from '../../di/default/zibri-di-tokens.default';
+import { inject } from '../../di/inject.function';
+import { LooseFileMimeType } from '../../http/mime-type.enum';
+import { resolveMimeType } from '../../http/mime-type.helpers';
+import { LoggerInterface } from '../../logging/logger.interface';
+import { OmitStrict } from '../../types/omit-strict.type';
+import { FsUtilities, Path } from '../../utilities/fs.utilities';
 
 /**
  * Data shared by all FileResponses.
@@ -70,12 +70,12 @@ export class FileResponse {
      * @param options - Additional options like file size.
      * @returns A new FileResponse.
      */
-    static async fromPath(p: string, options?: OmitStrict<PathFileResponseData, 'path'>): Promise<FileResponse> {
-        const fullPath: string = path.resolve(p);
-        const fileName: string = options?.filename ?? path.basename(fullPath);
+    static async fromPath(p: Path, options?: OmitStrict<PathFileResponseData, 'path'>): Promise<FileResponse> {
+        const fullPath: Path = FsUtilities.resolve(p);
+        const fileName: string = options?.filename ?? FsUtilities.baseName(fullPath);
         const mimeType: string = options?.mimeType ?? resolveMimeType(fileName);
 
-        if (!await pathExists(p)) {
+        if (!await FsUtilities.exists(p)) {
             throw new Error(`the file at path "${p}" does not exist.`);
         }
         if (!fileName.includes('.') && options?.mimeType == undefined) {
@@ -83,7 +83,7 @@ export class FileResponse {
             await logger.warn('the file name does not include a extension and no mimetype was provided.');
         }
 
-        const size: number = options?.size ?? (await stat(fullPath)).size;
+        const size: number = options?.size ?? (await FsUtilities.stat(fullPath)).size;
 
         return new this(fullPath, fileName, mimeType, size);
     }

package/src/parsing/form-data/file.model.ts

@@ -1,4 +1,5 @@
-import { Property } from '../../entity';
+import { Property } from '../../entity/decorators/property.decorator';
+import { type Path } from '../../utilities/fs.utilities';
 
 /**
  * A resolved file from a multipart/form-data request.
@@ -30,7 +31,7 @@ export class File {
 
     // eslint-disable-next-line jsdoc/require-jsdoc
     @Property.string()
-    path: string;
+    path: Path;
 
     constructor(file: File) {
         this.destination = file.destination;

package/src/parsing/form-data/form-data-body-parser-cleanup.cron-job.ts

@@ -1,9 +1,11 @@
-import { readdir, rm, readFile } from 'fs/promises';
-import path from 'path';
+import { Dirent } from 'node:fs';
 
 import { CLEANUP_AT_FILE_NAME } from './form-data.model';
-import { CronJob, InitialCronConfig } from '../../cron';
-import { inject, Injectable, ZIBRI_DI_TOKENS } from '../../di';
+import { CronJob, InitialCronConfig } from '../../cron/cron-job.model';
+import { Injectable } from '../../di/decorators/injectable.decorator';
+import { ZIBRI_DI_TOKENS } from '../../di/default/zibri-di-tokens.default';
+import { inject } from '../../di/inject.function';
+import { FsUtilities, Path } from '../../utilities/fs.utilities';
 
 /**
  * CronJob that cleans up the temp folder of the form data body parser.
@@ -19,21 +21,21 @@ export class FormDataBodyParserCleanupCronJob extends CronJob {
 
     // eslint-disable-next-line jsdoc/require-jsdoc
     async onTick(): Promise<void> {
-        const tempPath: string = inject(ZIBRI_DI_TOKENS.FILE_UPLOAD_TEMP_FOLDER);
+        const tempPath: Path = inject(ZIBRI_DI_TOKENS.FILE_UPLOAD_TEMP_FOLDER);
 
         await this.logger.info(`cleans up temp folder ${tempPath}`);
 
         try {
-            const folders: string[] = await readdir(tempPath);
+            const folders: Dirent[] = await FsUtilities.readdir(tempPath);
 
             let foldersToPreserve: number = 0;
             for (const folder of folders) {
                 try {
-                    const folderPath: string = path.join(tempPath, folder);
+                    const folderPath: Path = FsUtilities.getPath(tempPath, folder.parentPath, folder.name);
                     const shouldBePreserved: boolean = await this.hasRecentlyBeenCreated(folderPath);
 
                     if (!shouldBePreserved) {
-                        await rm(folderPath, { recursive: true });
+                        await FsUtilities.rm(folderPath);
                     }
                     else {
                         foldersToPreserve++;
@@ -51,11 +53,11 @@ export class FormDataBodyParserCleanupCronJob extends CronJob {
         }
     }
 
-    private async hasRecentlyBeenCreated(folderPath: string): Promise<boolean> {
-        const cleanupAtPath: string = path.join(folderPath, CLEANUP_AT_FILE_NAME);
+    private async hasRecentlyBeenCreated(folderPath: Path): Promise<boolean> {
+        const cleanupAtPath: Path = FsUtilities.getPath(folderPath, CLEANUP_AT_FILE_NAME);
         try {
             // Check if the file/folder has been modified within the last 24 hours
-            const cleanupAtMs: number = Number(await readFile(cleanupAtPath, 'utf8'));
+            const cleanupAtMs: number = Number(await FsUtilities.readFile(cleanupAtPath));
             return Date.now() > cleanupAtMs;
         }
         catch {