zibri 2.2.0 → 2.3.0

package/src/di/register.function.ts

@@ -1,14 +1,14 @@
-import { GlobalRegistry } from '../global';
 import { DiContainer } from './di-container';
-import { DiProvider } from './models';
+import { GlobalRegistry } from '../global/global-registry';
+import { DiProvider } from './models/di-provider.model';
 
 /**
  * Registers a new DI provider.
  * @param provider - The provider to register.
- * @throws When the app is initialized or running.
+ * @throws When the app is initialized or started.
  */
 export function register<T>(provider: DiProvider<T>): void {
-    if (GlobalRegistry.isAppInitialized() || GlobalRegistry.isAppRunning()) {
+    if (GlobalRegistry.isAppInitialized() || GlobalRegistry.isAppStarted()) {
         throw new Error('You can only register providers before the app has been initialized');
     }
     const di: DiContainer = DiContainer.getInstance();

package/src/di/unregister.function.ts

@@ -1,14 +1,14 @@
-import { GlobalRegistry } from '../global';
 import { DiContainer } from './di-container';
-import { DiToken } from './models';
+import { GlobalRegistry } from '../global/global-registry';
+import { DiToken } from './models/di-token.model';
 
 /**
  * Removes the provided token from the dependency injection system.
  * @param token - The token to unregister.
- * @throws When the app is initialized or running.
+ * @throws When the app is initialized or started.
  */
 export function unregister<T>(token: DiToken<T>): void {
-    if (GlobalRegistry.isAppInitialized() || GlobalRegistry.isAppRunning()) {
+    if (GlobalRegistry.isAppInitialized() || GlobalRegistry.isAppStarted()) {
         throw new Error('You can only unregister providers before the app has been initialized');
     }
     const di: DiContainer = DiContainer.getInstance();

package/src/email/email-service.interface.ts

@@ -1,14 +1,9 @@
-import { ZibriApplication } from '../application';
-import { QueueEmailData as QueueEmailData } from './models';
+import { QueueEmailData } from './models/create-email-data.model';
 
 /**
  * Interface for a email service.
  */
 export interface EmailServiceInterface {
-    /**
-     * Attaches the service to the Zibri application.
-     */
-    attachTo: (app: ZibriApplication) => void,
     /**
      * Queues a new email.
      */

package/src/email/email.service.ts

@@ -1,29 +1,36 @@
-
 import { createTransport, Transporter } from 'nodemailer';
 import SMTPTransport from 'nodemailer/lib/smtp-transport';
 
-import { Repository } from '../data-source';
-import { inject, repositoryTokenFor, ZIBRI_DI_TOKENS } from '../di';
 import { EmailServiceInterface } from './email-service.interface';
-import { CreateEmailData, Email, EmailAttachment, EmailConfig, EmailConfigInput, EmailPriority, EmailStatus, QueueEmailData } from './models';
 import { ZibriApplication } from '../application';
-import { pathExists } from '../utilities';
+import { CreateEmailData, QueueEmailData } from './models/create-email-data.model';
 import { SendQueuedEmailsCronJob } from './send-queued-emails.cron-job';
-import { LoggerInterface } from '../logging';
-import { RateLimiter } from '../rate-limiting';
+import { Repository } from '../data-source/repository';
+import { Email } from './models/email.model';
+import { InjectRepository } from '../di/decorators/inject-repository.decorator';
+import { Inject } from '../di/decorators/inject.decorator';
+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 { type LoggerInterface } from '../logging/logger.interface';
+import { RateLimiter } from '../rate-limiting/rate-limiter';
+import { FsUtilities } from '../utilities/fs.utilities';
+import { EmailAttachment } from './models/email-attachment.model';
+import { EmailConfig, EmailConfigInput } from './models/email-config.model';
+import { EmailPriority } from './models/email-priority.enum';
+import { EmailStatus } from './models/email-status.enum';
+import { OnAppInit } from '../global/on-app-init.interface';
+import { OnAppShutdown } from '../global/on-app-shutdown.interface';
 
 /**
  * Default email service implementation of Zibri.
  */
-export class EmailService implements EmailServiceInterface {
+@Injectable({ register: 'onUse' })
+export class EmailService implements EmailServiceInterface, OnAppInit, OnAppShutdown {
     /**
      * The internal nodemailer transporter.
      */
     protected readonly transporter: Transporter<SMTPTransport.SentMessageInfo, SMTPTransport.Options>;
-    /**
-     * The repository that handles storing and receiving emails from the db.
-     */
-    protected readonly emailRepository: Repository<Email, CreateEmailData>;
     /**
      * The email configuration.
      */
@@ -32,13 +39,13 @@ export class EmailService implements EmailServiceInterface {
      * A rate limiter to prevent overloading the email provider.
      */
     protected readonly rateLimiter: RateLimiter;
-    /**
-     * A logger.
-     */
-    protected readonly logger: LoggerInterface;
 
-    constructor() {
-        this.emailRepository = inject(repositoryTokenFor(Email));
+    constructor(
+        @Inject(ZIBRI_DI_TOKENS.LOGGER)
+        private readonly logger: LoggerInterface,
+        @InjectRepository(Email)
+        private readonly emailRepository: Repository<Email, CreateEmailData>
+    ) {
         const config: EmailConfigInput | undefined = inject(ZIBRI_DI_TOKENS.EMAIL_CONFIG);
         if (!config) {
             throw new Error('no email config was provided for the token "ZIBRI_DI_TOKENS.MAIL_CONFIG"');
@@ -49,14 +56,18 @@ export class EmailService implements EmailServiceInterface {
         };
         this.rateLimiter = RateLimiter.perHour(this.config.maxEmailsPerHour);
         this.transporter = createTransport({ ...this.config, secure: config?.port === 465 });
-        this.logger = inject(ZIBRI_DI_TOKENS.LOGGER);
     }
 
     // eslint-disable-next-line jsdoc/require-jsdoc
-    attachTo(app: ZibriApplication): void {
+    onAppInit(app: ZibriApplication): void {
         app.options.cronJobs.push(SendQueuedEmailsCronJob);
     }
 
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    onAppShutdown(): void {
+        this.transporter.close();
+    }
+
     // eslint-disable-next-line jsdoc/require-jsdoc
     async queue(data: QueueEmailData): Promise<void> {
         await this.emailRepository.create({
@@ -126,7 +137,7 @@ export class EmailService implements EmailServiceInterface {
 
         await Promise.all(
             attachments.map(async a => {
-                if (!await pathExists(a.path)) {
+                if (!await FsUtilities.exists(a.path)) {
                     throw new Error(`mail attachment at path ${a.path} does not exist`);
                 }
             })

package/src/email/models/create-email-data.model.ts

@@ -1,5 +1,8 @@
 import { Email } from './email.model';
-import { IntersectionClass, OmitClass, PartialClass, PickClass } from '../../entity';
+import { IntersectionClass } from '../../entity/intersection-class.model';
+import { OmitClass } from '../../entity/omit-class.model';
+import { PartialClass } from '../../entity/partial-class.model';
+import { PickClass } from '../../entity/pick-class.model';
 
 /**
  * Data for creating a new email in the db.

package/src/email/models/email-attachment.model.ts

@@ -1,5 +1,5 @@
-
-import { Property } from '../../entity';
+import { Property } from '../../entity/decorators/property.decorator';
+import { type FsPath } from '../../utilities/fs.utilities';
 
 /**
  * An email attachment, consisting of filename and path.
@@ -15,5 +15,5 @@ export class EmailAttachment {
      * The path of the attachment.
      */
     @Property.string()
-    path!: string;
+    path!: FsPath;
 }

package/src/email/models/email-config.model.ts

@@ -1,4 +1,4 @@
-import { OmitStrict } from '../../types';
+import { OmitStrict } from '../../types/omit-strict.type';
 
 /**
  * Configuration for emails.

package/src/email/models/email.model.ts

@@ -1,8 +1,9 @@
 import { EmailAttachment } from './email-attachment.model';
 import { EmailPriority } from './email-priority.enum';
 import { EmailStatus } from './email-status.enum';
-import { Entity, Property } from '../../entity';
 import { BaseEntity } from '../../entity/base-entity.model';
+import { Entity } from '../../entity/decorators/entity.decorator';
+import { Property } from '../../entity/decorators/property.decorator';
 
 /**
  * Definition of a Email.

package/src/email/send-queued-emails.cron-job.ts

@@ -1,11 +1,11 @@
-import { CronJob, InitialCronConfig } from '../cron';
-import { inject, Injectable, ZIBRI_DI_TOKENS } from '../di';
-import { EmailServiceInterface } from './email-service.interface';
+import { type EmailServiceInterface } from './email-service.interface';
+import { CronJob, InitialCronConfig } from '../cron/cron-job.model';
+import { Inject } from '../di/decorators/inject.decorator';
+import { ZIBRI_DI_TOKENS } from '../di/default/zibri-di-tokens.default';
 
 /**
  * Cron Job for sending out queued emails.
  */
-@Injectable()
 export class SendQueuedEmailsCronJob extends CronJob {
     // eslint-disable-next-line jsdoc/require-jsdoc
     initialConfig: InitialCronConfig = {
@@ -14,12 +14,18 @@ export class SendQueuedEmailsCronJob extends CronJob {
         runOnInit: false
     };
 
+    constructor(
+        @Inject(ZIBRI_DI_TOKENS.EMAIL_SERVICE)
+        private readonly emailService: EmailServiceInterface
+    ) {
+        super();
+    }
+
     // eslint-disable-next-line jsdoc/require-jsdoc
     async onTick(): Promise<void> {
-        const emailService: EmailServiceInterface = inject(ZIBRI_DI_TOKENS.EMAIL_SERVICE);
         let goOn: boolean = true;
         while (goOn) {
-            goOn = await emailService.sendQueuedEmails();
+            goOn = await this.emailService.sendQueuedEmails();
         }
     }
 }

package/src/entity/decorators/entity.decorator.ts

@@ -1,5 +1,5 @@
-import { GlobalRegistry } from '../../global';
-import { Newable } from '../../types';
+import { GlobalRegistry } from '../../global/global-registry';
+import { Newable } from '../../types/newable.type';
 import { MetadataUtilities } from '../../utilities/metadata.utilities';
 import { toSnakeCase } from '../../utilities/to-snake-case.function';
 import { type BaseEntity } from '../base-entity.model';
@@ -11,18 +11,23 @@ export type EntityMetadata = {
     /**
      * The name of the table in the db.
      */
-    tableName: string
+    tableName: string,
+    /**
+     * Whether or not this entity is allowed to exist without belonging to a data source.
+     */
+    allowOrphan: boolean
 };
 
-// eslint-disable-next-line jsdoc/require-returns
 /**
  * Marks an entity.
- * @param tableName - The name of the table to generate for the entity.
+ * @param options - Configuration options for the entity.
  */
-export function Entity(tableName?: string): ClassDecorator {
+export function Entity(options: Partial<EntityMetadata> = {}): ClassDecorator {
+    const { tableName, allowOrphan = false } = options;
     return target => {
         const metadata: EntityMetadata = {
-            tableName: tableName ?? toSnakeCase(target.name)
+            tableName: tableName ?? toSnakeCase(target.name),
+            allowOrphan
         };
         MetadataUtilities.setEntityMetadata(target as unknown as Newable<BaseEntity>, metadata);
         GlobalRegistry.entityClasses.push(target as unknown as Newable<BaseEntity>);

package/src/entity/decorators/property.decorator.ts

@@ -1,11 +1,21 @@
 import { warn } from '../../logging/logger.helpers';
-import type { Newable } from '../../types';
+import { Newable } from '../../types/newable.type';
 import { MetadataUtilities } from '../../utilities/metadata.utilities';
 import type { BaseEntity } from '../base-entity.model';
-import type { ArrayPropertyItemMetadata, ArrayPropertyItemMetadataInput, ArrayPropertyMetadata, ArrayPropertyMetadataInput, BelongsToOnePropertyMetadataInput, BooleanPropertyMetadata, BooleanPropertyMetadataInput, DatePropertyMetadata, DatePropertyMetadataInput, HasOnePropertyMetadataInput, ManyToManyPropertyMetadata, ManyToManyPropertyMetadataInput, ManyToOnePropertyMetadata, ManyToOnePropertyMetadataInput, NumberPropertyMetadata, NumberPropertyMetadataInput, ObjectPropertyMetadata, ObjectPropertyMetadataInput, OneToManyPropertyMetadata, OneToManyPropertyMetadataInput, OneToOnePropertyMetadata, OneToOnePropertyMetadataInput, StringPropertyMetadata, StringPropertyMetadataInput, UnknownPropertyMetadata, UnknownPropertyMetadataInput } from '../models';
+import { ArrayPropertyMetadata, ArrayPropertyMetadataInput, ArrayPropertyItemMetadataInput, ArrayPropertyItemMetadata } from '../models/array-property-metadata.model';
 import type { WithDefaultMetadata } from '../models/base-property-metadata.model';
+import { BooleanPropertyMetadata, BooleanPropertyMetadataInput } from '../models/boolean-property-metadata.model';
+import { DatePropertyMetadata, DatePropertyMetadataInput } from '../models/date-property-metadata.model';
 import type { FilePropertyMetadata, FilePropertyMetadataInput } from '../models/file-property-metadata.model';
+import { ManyToManyPropertyMetadata, ManyToManyPropertyMetadataInput } from '../models/many-to-many-property-metadata.model';
+import { ManyToOnePropertyMetadata, ManyToOnePropertyMetadataInput } from '../models/many-to-one-property-metadata.model';
+import { NumberPropertyMetadata, NumberPropertyMetadataInput } from '../models/number-property-metadata.model';
+import { ObjectPropertyMetadata, ObjectPropertyMetadataInput } from '../models/object-property-metadata.model';
+import { OneToManyPropertyMetadata, OneToManyPropertyMetadataInput } from '../models/one-to-many-property-metadata.model';
+import { OneToOnePropertyMetadata, OneToOnePropertyMetadataInput, HasOnePropertyMetadataInput, BelongsToOnePropertyMetadataInput } from '../models/one-to-one-property-metadata.model';
 import { Relation } from '../models/relation.enum';
+import { StringPropertyMetadata, StringPropertyMetadataInput } from '../models/string-property-metadata.model';
+import { UnknownPropertyMetadata, UnknownPropertyMetadataInput } from '../models/unknown-property-metadata.model';
 
 /**
  * The metadata of a property.
@@ -55,7 +65,7 @@ export type RelationMetadataInput<T extends BaseEntity> = ManyToOnePropertyMetad
  */
 // eslint-disable-next-line typescript/no-namespace
 export namespace Property {
-    // eslint-disable-next-line jsdoc/require-returns
+
     /**
      * Defines a string property.
      * @param data - Additional data to specify the property.
@@ -79,7 +89,6 @@ export namespace Property {
         return applyData(fullMetadata, data);
     }
 
-    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines a number property.
      * @param data - Additional data to specify the property.
@@ -101,7 +110,6 @@ export namespace Property {
         return applyData(fullMetadata, data);
     }
 
-    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines a boolean property.
      * @param data - Additional data to specify the property.
@@ -118,7 +126,6 @@ export namespace Property {
         return applyData(fullMetadata, data);
     }
 
-    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines a date property.
      * @param data - Additional data to specify the property.
@@ -137,7 +144,6 @@ export namespace Property {
         return applyData(fullMetadata, data);
     }
 
-    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines an object property.
      * @param data - Additional data to specify the property.
@@ -154,7 +160,6 @@ export namespace Property {
         return applyData(fullMetadata, data);
     }
 
-    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines a file property.
      * @param data - Additional data to specify the property.
@@ -186,7 +191,6 @@ export namespace Property {
         };
     }
 
-    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines an array property.
      * @param data - Additional data to specify the property.
@@ -212,7 +216,6 @@ export namespace Property {
         };
     }
 
-    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines an unknown property.
      * @param data - Additional data to specify the property.
@@ -228,7 +231,6 @@ export namespace Property {
         return applyData(fullMetadata, data);
     }
 
-    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines a many to one property.
      * @param metadata - Additional data to specify the property.
@@ -245,7 +247,6 @@ export namespace Property {
         return applyData(fullMetadata as PropertyMetadata, metadata);
     }
 
-    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines a one to many property.
      * @param metadata - Additional data to specify the property.
@@ -262,7 +263,6 @@ export namespace Property {
         return applyData(fullMetadata as PropertyMetadata, metadata);
     }
 
-    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines a has one property.
      * @param metadata - Additional data to specify the property.
@@ -280,7 +280,6 @@ export namespace Property {
         return applyData(fullMetadata as PropertyMetadata, metadata);
     }
 
-    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines a belongs to one property.
      * @param metadata - Additional data to specify the property.
@@ -298,7 +297,6 @@ export namespace Property {
         return applyData(fullMetadata as PropertyMetadata, metadata);
     }
 
-    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines a many to many property.
      * @param metadata - Additional data to specify the property.

package/src/entity/generation/generate-entity-file.function.ts

@@ -1,9 +1,10 @@
 
 import { getEntityFileName } from './get-entity-file-name.function';
 import { EntityGenerationProvider } from './providers/entity-generation-provider.interface';
-import { OpenApiReferenceObject, OpenApiSchemaObject, OpenApiSchemas } from '../../open-api';
-import { ObjectUtilities, toPascalCase } from '../../utilities';
+import { OpenApiReferenceObject, OpenApiSchemaObject, OpenApiSchemas } from '../../open-api/open-api.model';
 import { addImportStatement } from '../../utilities/add-import-statement.function';
+import { ObjectUtilities } from '../../utilities/object.utilities';
+import { toPascalCase } from '../../utilities/to-pascal-case.function';
 
 /**
  * The result for generating a single entity.

package/src/entity/generation/generate-entity-files-for-provider.function.ts

@@ -1,12 +1,13 @@
-import { mkdir } from 'fs/promises';
-import path from 'path';
 
 import { generateEntityFile, GenerateEntityFileResult } from './generate-entity-file.function';
 import { getEntityFileName } from './get-entity-file-name.function';
-import { EntityGenerationProvider } from './providers';
+import { EntityGenerationProvider } from './providers/entity-generation-provider.interface';
 import { warn } from '../../logging/logger.helpers';
-import { OpenApiDefinition, OpenApiOperation, OpenApiReferenceObject, OpenApiResponseObject, OpenApiSchemaObject, OpenApiSchemas } from '../../open-api';
-import { ObjectUtilities, pathExists, toKebabCase, toPascalCase } from '../../utilities';
+import { OpenApiDefinition, OpenApiSchemas, OpenApiOperation, OpenApiResponseObject, OpenApiReferenceObject, OpenApiSchemaObject } from '../../open-api/open-api.model';
+import { FsUtilities, FsPath } from '../../utilities/fs.utilities';
+import { ObjectUtilities } from '../../utilities/object.utilities';
+import { toKebabCase } from '../../utilities/to-kebab-case.function';
+import { toPascalCase } from '../../utilities/to-pascal-case.function';
 
 /**
  * All data needed to generate a file.
@@ -15,7 +16,7 @@ export type FileToGenerate = {
     /**
      * The path where the file should be generated.
      */
-    path: string,
+    path: FsPath,
     /**
      * The actual content of the file in lines.
      */
@@ -122,8 +123,8 @@ export async function generateEntityFilesForProvider(
             const fileName: string = getEntityFileName(provider.prefix, key);
 
             // eslint-disable-next-line sonar/no-duplicate-string
-            const filePath: string = path.join(cwd, 'src/models/generated', toKebabCase(provider.prefix), fileName);
-            if (await pathExists(filePath)) {
+            const filePath: FsPath = FsUtilities.getPath(cwd, 'src/models/generated', toKebabCase(provider.prefix), fileName);
+            if (await FsUtilities.exists(filePath)) {
                 processedSchemas.add(key);
                 continue;
             }
@@ -153,8 +154,11 @@ export async function generateEntityFilesForProvider(
         };
     }
 
-    await mkdir(path.join(cwd, 'src/models/generated', toKebabCase(provider.prefix)), { recursive: true });
-    filesToGenerate.push({ path: path.join(cwd, 'src/models/generated', toKebabCase(provider.prefix), 'index.ts'), lines: indexLines });
+    await FsUtilities.mkdir(FsUtilities.getPath(cwd, 'src/models/generated', toKebabCase(provider.prefix)));
+    filesToGenerate.push({
+        path: FsUtilities.getPath(cwd, 'src/models/generated', toKebabCase(provider.prefix), 'index.ts'),
+        lines: indexLines
+    });
 
     return {
         filesToGenerate,

package/src/entity/generation/generate-entity-files-for-provider.test.ts

@@ -3,9 +3,11 @@ import assert from 'assert';
 import { describe, expect, it } from '@jest/globals';
 
 import { FileToGenerate, generateEntityFilesForProvider } from './generate-entity-files-for-provider.function';
-import { EntityGenerationProvider, OpenApiUrlProvider } from './providers';
-import { OpenApiDefinition } from '../../open-api';
-import { toKebabCase, toPascalCase } from '../../utilities';
+import { EntityGenerationProvider } from './providers/entity-generation-provider.interface';
+import { OpenApiUrlProvider } from './providers/open-api-url.provider';
+import { OpenApiDefinition } from '../../open-api/open-api.model';
+import { toKebabCase } from '../../utilities/to-kebab-case.function';
+import { toPascalCase } from '../../utilities/to-pascal-case.function';
 
 // small InlineProvider so tests are offline and deterministic
 class InlineProvider implements EntityGenerationProvider {

package/src/entity/generation/generate-entity-files.function.ts

@@ -1,19 +1,16 @@
-import { writeFile } from 'fs/promises';
-import path from 'path';
-
 import { register } from 'ts-node';
 
 import { FileToGenerate, generateEntityFilesForProvider, GenerateEntityFilesForProviderResult } from './generate-entity-files-for-provider.function';
 import { EntityGenerationProvider } from './providers/entity-generation-provider.interface';
-import { pathExists } from '../../utilities';
+import { FsUtilities, FsPath } from '../../utilities/fs.utilities';
 
 /**
  * Resolves providers from the src/models/generated/providers.ts file and generates entities from them.
  */
 export async function generateEntityFiles(): Promise<void> {
     const cwd: string = process.cwd();
-    const providersPath: string = await resolveProvidersPath(cwd);
-    const ext: string = path.extname(providersPath).toLowerCase();
+    const providersPath: FsPath = await resolveProvidersPath(cwd);
+    const ext: string = FsUtilities.extensionName(providersPath).toLowerCase();
     if (ext !== '.ts') {
         return;
     }
@@ -38,23 +35,24 @@ export async function generateEntityFiles(): Promise<void> {
     }
 
     if (indexLines.length) {
-        filesToGenerate.push({ path: path.join(cwd, 'src/models/generated/index.ts'), lines: indexLines });
-    }
-    for (const f of filesToGenerate) {
-        await writeFile(f.path, f.lines.join('\n'), 'utf8');
+        filesToGenerate.push({ path: FsUtilities.getPath(cwd, 'src/models/generated/index.ts'), lines: indexLines });
     }
+
+    await Promise.all(filesToGenerate.map(async f => {
+        await FsUtilities.upsertFile(f.path, f.lines.join('\n'));
+    }));
 }
 
 // eslint-disable-next-line jsdoc/require-jsdoc
-async function resolveProvidersPath(cwd: string): Promise<string> {
-    const candidates: string[] = [
-        path.join(cwd, 'src/models/generated/providers.js'),
-        path.join(cwd, 'src/models/generated/providers.cjs'),
-        path.join(cwd, 'src/models/generated/providers.mjs'),
-        path.join(cwd, 'src/models/generated/providers.ts')
+async function resolveProvidersPath(cwd: string): Promise<FsPath> {
+    const candidates: FsPath[] = [
+        FsUtilities.getPath(cwd, 'src/models/generated/providers.js'),
+        FsUtilities.getPath(cwd, 'src/models/generated/providers.cjs'),
+        FsUtilities.getPath(cwd, 'src/models/generated/providers.mjs'),
+        FsUtilities.getPath(cwd, 'src/models/generated/providers.ts')
     ];
-    const providersPath: string = await Promise.any(candidates.map(async p => {
-        if (await pathExists(p)) {
+    const providersPath: FsPath = await Promise.any(candidates.map(async p => {
+        if (await FsUtilities.exists(p)) {
             return p;
         }
         throw new Error(`Could not locate ${p}`);

package/src/entity/generation/get-entity-file-name.function.ts

@@ -1,4 +1,4 @@
-import { toKebabCase } from '../../utilities';
+import { toKebabCase } from '../../utilities/to-kebab-case.function';
 
 /**
  * Gets the file name for the given entity name.

package/src/entity/generation/providers/entity-generation-provider.interface.ts

@@ -1,4 +1,4 @@
-import { OpenApiDefinition } from '../../../open-api';
+import { OpenApiDefinition } from '../../../open-api/open-api.model';
 
 /**
  * A provider for automatic entity generation.

package/src/entity/generation/providers/open-api-file.provider.ts

@@ -1,9 +1,7 @@
-
-import { readFile } from 'fs/promises';
-
 import { EntityGenerationProvider } from './entity-generation-provider.interface';
 import { openApiToV3 } from './open-api-to-v3.function';
-import { OpenApiDefinition } from '../../../open-api';
+import { OpenApiDefinition } from '../../../open-api/open-api.model';
+import { FsUtilities, FsPath } from '../../../utilities/fs.utilities';
 
 /**
  * An entity generation provider using a local open api file.
@@ -11,14 +9,14 @@ import { OpenApiDefinition } from '../../../open-api';
 export class OpenApiFileProvider implements EntityGenerationProvider {
     constructor(
         readonly prefix: string,
-        protected readonly filePath: string,
+        protected readonly filePath: FsPath,
         readonly generateSchemasFromPaths: boolean = false,
         readonly markAsEntities: boolean = false
     ) {}
 
     // eslint-disable-next-line jsdoc/require-jsdoc
     async resolveSpec(): Promise<OpenApiDefinition> {
-        const spec: unknown = JSON.parse(await readFile(this.filePath, 'utf8'));
+        const spec: unknown = JSON.parse(await FsUtilities.readFile(this.filePath));
         return await openApiToV3(spec);
     }
 }

package/src/entity/generation/providers/open-api-to-v3.function.ts

@@ -1,6 +1,6 @@
 import { convertObj, ConvertOutputOptions } from 'swagger2openapi';
 
-import { OpenApiDefinition } from '../../../open-api';
+import { OpenApiDefinition } from '../../../open-api/open-api.model';
 
 /**
  * Converts the given spec to open api v3.1.

package/src/entity/generation/providers/open-api-url.provider.ts

@@ -1,9 +1,10 @@
 
 import { EntityGenerationProvider } from './entity-generation-provider.interface';
 import { openApiToV3 } from './open-api-to-v3.function';
-import { inject, ZIBRI_DI_TOKENS } from '../../../di';
-import { HttpClientInterface } from '../../../http-client';
-import { OpenApiDefinition } from '../../../open-api';
+import { ZIBRI_DI_TOKENS } from '../../../di/default/zibri-di-tokens.default';
+import { inject } from '../../../di/inject.function';
+import { HttpClientInterface } from '../../../http-client/http-client.interface';
+import { OpenApiDefinition } from '../../../open-api/open-api.model';
 
 /**
  * An entity generation provider using an open api url.

package/src/entity/intersection-class.model.ts

@@ -1,4 +1,4 @@
-import { Newable } from '../types';
+import { Newable } from '../types/newable.type';
 import { copyClassProperties } from './utilities/copy-class-properties.function';
 
 // eslint-disable-next-line jsdoc/require-jsdoc

package/src/entity/models/array-property-metadata.model.ts

@@ -1,6 +1,5 @@
-import { ExcludeStrict } from '../../types';
+import { ExcludeStrict } from '../../types/exclude-strict.type';
 import { type BaseEntity } from '../base-entity.model';
-import { PropertyMetadata, RelationMetadata } from '../decorators';
 import { BasePropertyMetadata } from './base-property-metadata.model';
 import { BooleanPropertyMetadataInput } from './boolean-property-metadata.model';
 import { DatePropertyMetadataInput } from './date-property-metadata.model';
@@ -9,6 +8,7 @@ import { NumberPropertyMetadataInput } from './number-property-metadata.model';
 import { ObjectPropertyMetadataInput } from './object-property-metadata.model';
 import { StringPropertyMetadataInput } from './string-property-metadata.model';
 import { UnknownPropertyMetadataInput } from './unknown-property-metadata.model';
+import { PropertyMetadata, RelationMetadata } from '../decorators/property.decorator';
 
 /**
  * Metadata for array properties.