zibri 2.1.7 → 2.2.1

package/src/di/di-container.ts

@@ -1,10 +1,12 @@
-import { GlobalRegistry } from '../global';
-import { Newable } from '../types';
-import { MetadataUtilities } from '../utilities';
-import { ZIBRI_DI_TOKENS } from './default';
+import { GlobalRegistry } from '../global/global-registry';
+import { Newable } from '../types/newable.type';
+import { MetadataUtilities } from '../utilities/metadata.utilities';
+import { ObjectUtilities } from '../utilities/object.utilities';
 import { ZIBRI_DI_PROVIDERS } from './default/zibri-di-providers.default';
+import { ZIBRI_DI_TOKENS } from './default/zibri-di-tokens.default';
 import { NoProviderError } from './errors/no-provider.error';
-import { DiToken, DiProvider } from './models';
+import { DiProvider } from './models/di-provider.model';
+import { DiToken, providersFromTokenRecord } from './models/di-token.model';
 
 /**
  * The dependency injection container.
@@ -18,9 +20,9 @@ export class DiContainer {
         for (const injectable of GlobalRegistry.injectables) {
             this.register(injectable);
         }
-        for (const key in ZIBRI_DI_TOKENS) {
-            const token: typeof ZIBRI_DI_TOKENS[keyof typeof ZIBRI_DI_TOKENS] = ZIBRI_DI_TOKENS[key as keyof typeof ZIBRI_DI_TOKENS];
-            this.register({ token, ...ZIBRI_DI_PROVIDERS[token] });
+        const defaultProviders: DiProvider<unknown>[] = providersFromTokenRecord(ZIBRI_DI_TOKENS, ZIBRI_DI_PROVIDERS);
+        for (const provider of defaultProviders) {
+            this.register(provider);
         }
     }
 
@@ -39,9 +41,6 @@ export class DiContainer {
      * @throws When the provider is invalid.
      */
     register<T>(provider: DiProvider<T>): void {
-        if (!provider.useClass && !provider.useFactory) {
-            throw new Error(`Provider for token ${provider.token.toString()} must specify useClass or useFactory`);
-        }
         this.providers.set(provider.token, provider);
     }
 
@@ -71,10 +70,9 @@ export class DiContainer {
             throw new NoProviderError(token, resolvingStack);
         }
 
-        if (!provider.useClass && !provider.useFactory) {
-            throw new Error(`Provider for ${provider.token.toString()} is invalid`);
+        if (provider.useClass || provider.useFactory) {
+            resolvingStack.push(provider.useClass ?? provider.useFactory);
         }
-        resolvingStack.push((provider.useClass ?? provider.useFactory) as Function);
 
         const instance: T = this.createInstanceFromProvider(provider, resolvingStack);
         resolvingStack.pop();
@@ -84,9 +82,11 @@ export class DiContainer {
     }
 
     private createInstanceFromProvider<T>(provider: DiProvider<T>, resolvingStack: Function[]): T {
-        const provide: Newable<T> | ((...deps: unknown[]) => T) | undefined = provider.useClass ?? provider.useFactory;
+        const provide: Newable<T> | ((...deps: unknown[]) => T) | T | undefined = provider.useClass
+            ?? provider.useFactory
+            ?? provider.useValue;
 
-        if (!provide) {
+        if (provide == undefined) {
             throw new Error(`Provider for ${provider.token.toString()} is invalid`);
         }
 
@@ -94,7 +94,7 @@ export class DiContainer {
         const paramTypes: unknown[] = MetadataUtilities.getParamTypes(provide);
 
         // compute max number of parameters to resolve
-        const highestExplicitIndex: number = Object.keys(explicitTokens).reduce((acc, k) => {
+        const highestExplicitIndex: number = ObjectUtilities.keys(explicitTokens).reduce((acc, k) => {
             const idx: number = Number(k);
             return Number.isFinite(idx) ? Math.max(acc, idx) : acc;
         }, -1);
@@ -117,7 +117,10 @@ export class DiContainer {
         if (provider.useFactory) {
             return provider.useFactory(...deps);
         }
+        if ('useValue' in provider) {
+            return provider.useValue;
+        }
 
-        throw new Error(`Provider for ${provider.token.toString()} is invalid`);
+        throw new Error(`Provider for ${(provider as DiProvider<T>).token.toString()} is invalid`);
     }
 }

package/src/di/errors/get-dependency-stack-trace.function.ts

@@ -1,4 +1,4 @@
-import { MetadataUtilities } from '../../utilities';
+import { MetadataUtilities } from '../../utilities/metadata.utilities';
 
 /**
  * Gets the stack trace for dependency resolution.

package/src/di/errors/no-provider.error.ts

@@ -1,13 +1,7 @@
 import { getDependencyStackTrace } from './get-dependency-stack-trace.function';
-import { MetadataUtilities } from '../../utilities';
-import { DiToken } from '../models';
-
-// eslint-disable-next-line jsdoc/require-jsdoc
-function tokenIsPrimitiveValue(token: DiToken<unknown>): boolean {
-    return [String, Number, Boolean, Date].includes(
-        token as unknown as StringConstructor | NumberConstructor | BooleanConstructor | DateConstructor
-    );
-}
+import { MetadataUtilities } from '../../utilities/metadata.utilities';
+import { DiToken } from '../models/di-token.model';
+import { InjectionToken } from '../models/injection-token.model';
 
 /**
  * Get the no providers error message from the provided token and stack.
@@ -16,16 +10,13 @@ function tokenIsPrimitiveValue(token: DiToken<unknown>): boolean {
  * @returns The message as a string.
  */
 function getNoProviderMessage(token: DiToken<unknown>, resolvingStack: Function[]): string {
-    if (typeof token === 'string') {
-        if (token.startsWith('Repository<') && token.endsWith('>')) {
-            const entity: string = token.split('Repository<')[1].split('>')[0];
-            return `No provider for repository token "${token}". Did you forget to register the entity "${entity}" in a data source?`;
+    if (token instanceof InjectionToken) {
+        if (token.key.startsWith('Repository<') && token.key.endsWith('>')) {
+            const entity: string = token.key.split('Repository<')[1].split('>')[0];
+            return `No provider for repository token "${token.key}". Did you forget to register the entity "${entity}" in a data source?`;
         }
-        return `No provider for custom token "${token}"`;
-    }
-    if (tokenIsPrimitiveValue(token)) {
         if (!resolvingStack.length) {
-            return `No provider for token "${token.name}". Did you forget to decorate it with @Inject()?`;
+            return `No provider for token "${token.key}". Did you forget to decorate it with @Inject()?`;
         }
         const currentClass: Function = resolvingStack[resolvingStack.length - 1];
         const paramTypes: unknown[] = MetadataUtilities.getParamTypes(currentClass);

package/src/di/inject.function.ts

@@ -1,5 +1,5 @@
 import { DiContainer } from './di-container';
-import { DiToken } from './models';
+import { DiToken } from './models/di-token.model';
 
 /**
  * Injects the registered value for the provided token.

package/src/di/models/di-provider.model.ts

@@ -1,20 +1,70 @@
-import { DiToken } from '.';
-import { Newable } from '../../types';
+import { DiToken } from './di-token.model';
+import { Newable } from '../../types/newable.type';
+import { OmitStrict } from '../../types/omit-strict.type';
+
+/**
+ * A type safe way to define providers when eg. Inside arrays.
+ *
+ * Does not do anything else.
+ * @param provider - The provider.
+ * @returns Just the given provider, without doing anything at all.
+ */
+export function defineProvider<T>(provider: DiProvider<T>): DiProvider<T> {
+    return provider;
+}
 
 /**
  * A DI provider.
  */
-export type DiProvider<T> = {
+export type DiProvider<T> = ClassDiProvider<T> | FactoryDiProvider<T> | ValueDiProvider<T>;
+
+/**
+ * A DiProvider without its token.
+ */
+export type DiProviderWithoutToken<T> = OmitStrict<ClassDiProvider<T>, 'token'>
+    | OmitStrict<FactoryDiProvider<T>, 'token'>
+    | OmitStrict<ValueDiProvider<T>, 'token'>;
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+type BaseDiProvider<T> = {
     /**
      * The token under which the value should be registered.
      */
-    token: DiToken<T>,
+    token: DiToken<T>
+};
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+type ClassDiProvider<T> = BaseDiProvider<T> & {
     /**
      * A class to register for the token.
      */
-    useClass?: Newable<T>,
+    useClass: Newable<NoInfer<T>>,
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    useFactory?: never,
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    useValue?: never
+};
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+type FactoryDiProvider<T> = BaseDiProvider<T> & {
     /**
      * A factory function that resolves the value to register for the token.
      */
-    useFactory?: (...deps: unknown[]) => T
+    useFactory: (...deps: unknown[]) => NoInfer<T>,
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    useClass?: never,
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    useValue?: never
+};
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+type ValueDiProvider<T> = BaseDiProvider<T> & {
+    /**
+     * A value to register for the token.
+     */
+    useValue: NoInfer<T>,
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    useFactory?: never,
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    useClass?: never
 };

package/src/di/models/di-token.model.ts

@@ -1,6 +1,48 @@
-import { Newable } from '../../types';
+import { DiProvider, DiProviderWithoutToken } from './di-provider.model';
+import { InjectionToken } from './injection-token.model';
+import { Newable } from '../../types/newable.type';
+import { ObjectUtilities } from '../../utilities/object.utilities';
 
 /**
  * A token where DI values can be registered under.
  */
-export type DiToken<T> = Newable<T> | string;
+export type DiToken<T> = Newable<T> | InjectionToken<T>;
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+type UnwrapDiToken<T>
+    = T extends InjectionToken<infer U> ? U
+        // eslint-disable-next-line typescript/no-explicit-any
+        : T extends new (...args: any[]) => infer U ? U
+            : unknown;
+
+/**
+ * A record of DI tokens.
+ */
+export type TokenRecord = Record<Uppercase<string>, DiToken<unknown>>;
+
+/**
+ * A record that maps the given DI tokens to a matching provider.
+ */
+export type DiTokenProviderRecord<Tokens extends TokenRecord> = {
+    [K in keyof Tokens]: DiProviderWithoutToken<UnwrapDiToken<Tokens[K]>>;
+};
+
+/**
+ * Resolves the DI providers from the given tokens and values.
+ * @param tokens - The token record.
+ * @param providers - The provider values matching the tokens.
+ * @returns An array of the built together DI providers.
+ */
+export function providersFromTokenRecord<Tokens extends TokenRecord>(
+    tokens: Tokens,
+    providers: DiTokenProviderRecord<Tokens>
+): DiProvider<unknown>[] {
+    const res: DiProvider<unknown>[] = [];
+
+    for (const k of ObjectUtilities.keys(tokens)) {
+        const token: DiToken<unknown> = (tokens as TokenRecord)[k];
+        res.push({ token, ...providers[k] });
+    }
+
+    return res;
+}

package/src/di/models/injection-token.model.ts

@@ -0,0 +1,24 @@
+const allInjectionTokenKeys: string[] = [];
+
+/**
+ * Defines an injection token for the given key.
+ */
+export class InjectionToken<T> {
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    protected readonly __brand?: T;
+
+    constructor(readonly key: string) {
+        if (allInjectionTokenKeys.includes(key)) {
+            throw new Error([
+                `An InjectionToken with the key "${key}" already exists.`,
+                'If you wanted to override it, you need to use the existing InjectionToken instance.'
+            ].join('\n'));
+        }
+        allInjectionTokenKeys.push(key);
+    }
+
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    toString(): string {
+        return this.key;
+    }
+}

package/src/di/register.function.ts

@@ -1,6 +1,6 @@
-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.

package/src/di/unregister.function.ts

@@ -1,6 +1,6 @@
-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.

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

@@ -1,5 +1,5 @@
 import { ZibriApplication } from '../application';
-import { QueueEmailData as QueueEmailData } from './models';
+import { QueueEmailData } from './models/create-email-data.model';
 
 /**
  * Interface for a email service.

package/src/email/email.service.ts

@@ -1,16 +1,22 @@
-
 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 { repositoryTokenFor } from '../di/decorators/inject-repository.decorator';
+import { ZIBRI_DI_TOKENS } from '../di/default/zibri-di-tokens.default';
+import { inject } from '../di/inject.function';
+import { 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';
 
 /**
  * Default email service implementation of Zibri.
@@ -126,7 +132,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/mailing-list/mailing-list-service.interface.ts

@@ -1,10 +1,10 @@
-import { MailingListSubscriber } from './models';
 import { ZibriApplication } from '../../application';
-import { OmitClass } from '../../entity';
-import { BaseEmailTemplateData } from '../../handlebars';
-import { Route } from '../../routing';
-import { OmitStrict } from '../../types';
-import { QueueEmailData } from '../models';
+import { MailingListSubscriber } from './models/mailing-list-subscriber.model';
+import { OmitClass } from '../../entity/omit-class.model';
+import { BaseEmailTemplateData } from '../../handlebars/render-template.function';
+import { Route } from '../../routing/controller-route-configuration.model';
+import { OmitStrict } from '../../types/omit-strict.type';
+import { QueueEmailData } from '../models/create-email-data.model';
 
 /**
  * The data required to queue a new mailing list email.

package/src/email/mailing-list/mailing-list.service.ts

@@ -1,17 +1,22 @@
 import { randomBytes } from 'crypto';
-import path from 'path';
 
 import { MailingListSubscriberCreateData, MailingListQueueEmailData, MailingListServiceInterface, BaseMailingListEmailTemplateData } from './mailing-list-service.interface';
-import { AssetServiceInterface } from '../../assets';
-import { Repository } from '../../data-source';
-import { inject, repositoryTokenFor, ZIBRI_DI_TOKENS } from '../../di';
-import { GlobalRegistry } from '../../global';
-import { BaseEmailTemplateData, renderTemplate, renderTemplateString } from '../../handlebars';
-import { Route } from '../../routing';
+import { AssetServiceInterface } from '../../assets/asset-service.interface';
+import { Repository } from '../../data-source/repository';
+import { repositoryTokenFor } from '../../di/decorators/inject-repository.decorator';
+import { ZIBRI_DI_TOKENS } from '../../di/default/zibri-di-tokens.default';
+import { inject } from '../../di/inject.function';
+import { GlobalRegistry } from '../../global/global-registry';
+import { BaseEmailTemplateData, renderTemplateString, renderTemplate } from '../../handlebars/render-template.function';
+import { Route } from '../../routing/controller-route-configuration.model';
+import { FsUtilities, Path } from '../../utilities/fs.utilities';
+import { PromiseUtilities } from '../../utilities/promise.utilities';
+import { validateEntitiesRegistered } from '../../utilities/validate-entities-registered.function';
 import { EmailServiceInterface } from '../email-service.interface';
-import { MailingList, MailingListSubscriber, MailingListSubscriptionConfirmationToken, MailingListSubscriptionConfirmationTokenCreateData } from './models';
-import { chunkedPromiseAll, validateEntitiesRegistered } from '../../utilities';
-import { EmailPriority } from '../models';
+import { EmailPriority } from '../models/email-priority.enum';
+import { MailingListSubscriber } from './models/mailing-list-subscriber.model';
+import { MailingListSubscriptionConfirmationToken, MailingListSubscriptionConfirmationTokenCreateData } from './models/mailing-list-subscription-confirmation-token.model';
+import { MailingList } from './models/mailing-list.model';
 
 /**
  * Default mailing list service implementation of Zibri.
@@ -66,8 +71,9 @@ export class MailingListService implements MailingListServiceInterface {
     // eslint-disable-next-line jsdoc/require-jsdoc
     async queueEmailForList<T extends BaseMailingListEmailTemplateData>(listId: string, data: MailingListQueueEmailData<T>): Promise<void> {
         const list: MailingList = await this.mailingListRepository.findById(listId);
-        await chunkedPromiseAll(
-            list.subscribers.map(async s => {
+        await PromiseUtilities.allChunked(
+            list.subscribers,
+            async s => {
                 const base: BaseEmailTemplateData['base'] = {
                     ...data.templateData.base,
                     baseUrl: GlobalRegistry.getAppData('baseUrl') ?? '',
@@ -82,7 +88,7 @@ export class MailingListService implements MailingListServiceInterface {
                     base
                 });
                 const html: string = await renderTemplate(
-                    path.join(this.assetService.emailTemplatePath, 'base-email.hbs') as `${string}.hbs`,
+                    FsUtilities.getPath(this.assetService.emailTemplatePath, 'base-email.hbs') as `${Path}.hbs`,
                     { content, base }
                 );
                 await this.emailService.queue({
@@ -92,7 +98,7 @@ export class MailingListService implements MailingListServiceInterface {
                     persist: false,
                     ...data
                 });
-            })
+            }
         );
     }
 
@@ -126,7 +132,7 @@ export class MailingListService implements MailingListServiceInterface {
             base: emailData.templateData.base
         });
         const html: string = await renderTemplate(
-            path.join(this.assetService.emailTemplatePath, 'base-email.hbs') as `${string}.hbs`,
+            FsUtilities.getPath(this.assetService.emailTemplatePath, 'base-email.hbs') as `${Path}.hbs`,
             { content, base: emailData.templateData.base }
         );
         await this.emailService.queue({ ...emailData, html, recipients: [subscriber.email] });

package/src/email/mailing-list/models/mailing-list-subscriber.model.ts

@@ -1,6 +1,7 @@
 import { MailingList } from './mailing-list.model';
-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';
 
 /**
  * Defines a subscriber to a single or multiple mailing lists.

package/src/email/mailing-list/models/mailing-list-subscription-confirmation-token.model.ts

@@ -1,5 +1,7 @@
-import { Entity, OmitClass, Property } from '../../../entity';
 import { BaseEntity } from '../../../entity/base-entity.model';
+import { Entity } from '../../../entity/decorators/entity.decorator';
+import { Property } from '../../../entity/decorators/property.decorator';
+import { OmitClass } from '../../../entity/omit-class.model';
 
 /**
  * A short lived token used to confirm a mailing list subscription.

package/src/email/mailing-list/models/mailing-list.model.ts

@@ -1,6 +1,7 @@
 import { MailingListSubscriber } from './mailing-list-subscriber.model';
-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';
 
 /**
  * A mailing list like a newsletter that people can easily subscribe and unsubscribe to.

package/src/email/mailing-list/models/update-mailing-list-preferences.model.ts

@@ -1,4 +1,4 @@
-import { Property } from '../../../entity';
+import { Property } from '../../../entity/decorators/property.decorator';
 
 /**
  * The data required for updating mailing list preferences.

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 Path } 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!: Path;
 }

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,6 +1,8 @@
-import { CronJob, InitialCronConfig } from '../cron';
-import { inject, Injectable, ZIBRI_DI_TOKENS } from '../di';
 import { EmailServiceInterface } from './email-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';
 
 /**
  * Cron Job for sending out queued emails.

package/src/entity/any-object.model.ts

@@ -0,0 +1,6 @@
+/**
+ * Base class for any object.
+ */
+export class AnyObject {
+    [key: string]: unknown
+}

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';
@@ -14,7 +14,6 @@ export type EntityMetadata = {
     tableName: string
 };
 
-// eslint-disable-next-line jsdoc/require-returns
 /**
  * Marks an entity.
  * @param tableName - The name of the table to generate for the entity.