zibri 2.3.0 → 2.4.0

package/src/di/default/zibri-di-providers.default.ts

@@ -9,12 +9,22 @@ import { ZIBRI_DI_TOKENS } from './zibri-di-tokens.default';
 import { AssetService } from '../../assets/asset.service';
 import { TwoFactorService } from '../../auth/2fa/two-factor.service';
 import { AuthService } from '../../auth/auth.service';
+import { EncryptionService } from '../../auth/encryption/encryption.service';
+import { AesGcmEncryptionStrategy } from '../../auth/encryption/strategies/aes-gcm.encryption-strategy';
+import { HashService } from '../../auth/hash/hash.service';
+import { BcryptHashStrategy } from '../../auth/hash/strategies/bcrypt.hash-strategy';
 import { UserService } from '../../auth/user/user.service';
 import { BackupService } from '../../backup/backup.service';
+import { CacheService } from '../../caching/cache.service';
+import { AlsUtilities } from '../../context/als.utilities';
+import { HttpRequestContext } from '../../context/request/http-request.context';
+import { ZIBRI_REQUEST_CONTEXT_TOKENS } from '../../context/request/request-context-token.model';
+import { WebsocketRequestContext } from '../../context/request/websocket-request.context';
 import { CronService } from '../../cron/cron.service';
 import { DataSourceService } from '../../data-source/data-source.service';
 import { EmailService } from '../../email/email.service';
 import { errorHandler } from '../../error-handling/error-handler';
+import { EventService } from '../../event/event.service';
 import { HttpClient } from '../../http-client/http-client';
 import { LocalizeOptionsInput } from '../../localization/models/localize-options.model';
 import { LogLevel } from '../../logging/log-level.enum';
@@ -23,8 +33,8 @@ import { LoggerTransport } from '../../logging/transport/logger-transport.model'
 import { PrometheusMetricsService } from '../../metrics/metrics.service';
 import { MultithreadingService } from '../../multithreading/services/multithreading.service';
 import { OpenApiService } from '../../open-api/open-api.service';
+import { CspSource } from '../../parsing/html/csp-options.model';
 import { Parser } from '../../parsing/parser';
-import { getCurrentRequest } from '../../routing/request.context';
 import { Router } from '../../routing/router';
 import { FsUtilities } from '../../utilities/fs.utilities';
 import { Ms } from '../../utilities/ms';
@@ -71,12 +81,12 @@ export const ZIBRI_DI_PROVIDERS: DiTokenProviderRecord<typeof ZIBRI_DI_TOKENS> =
     DATA_SOURCE_SERVICE: { useClass: DataSourceService },
     AUTH_SERVICE: { useClass: AuthService },
     TWO_FACTOR_SERVICE: { useClass: TwoFactorService },
-    OTP_HEADER: { useFactory: () => 'X-Authorization-OTP' },
+    OTP_HEADER: { useFactory: () => 'x-authorization-otp' },
     OTP_LENGTH: { useFactory: () => 6 },
     USER_SERVICE: { useClass: UserService },
     JWT_ACCESS_TOKEN_SECRET: { useFactory: () => undefined },
     JWT_REFRESH_TOKEN_SECRET: { useFactory: () => undefined },
-    JWT_PASSWORD_RESET_EMAIL_TEMPLATE: { useFactory: () => undefined },
+    PASSWORD_RESET_EMAIL_TEMPLATE: { useFactory: () => undefined },
     JWT_ACCESS_TOKEN_EXPIRES_IN_MS: { useFactory: () => Ms.HOUR },
     JWT_REFRESH_TOKEN_EXPIRES_IN_MS: { useFactory: () => 100 * Ms.DAY },
     CRON_SERVICE: { useClass: CronService },
@@ -97,9 +107,8 @@ export const ZIBRI_DI_PROVIDERS: DiTokenProviderRecord<typeof ZIBRI_DI_TOKENS> =
     FORMAT_PRICE: { useFactory: () => formatPrice },
     FORMAT_PERCENT: { useFactory: () => formatPercent },
     EMAIL_CONFIG: { useFactory: () => undefined },
-    JWT_PASSWORD_RESET_TOKEN_EXPIRES_IN_MS: { useFactory: () => 300000 },
-    JWT_CONFIRM_PASSWORD_RESET_URL: { useFactory: () => undefined },
-    CURRENT_REQUEST: { useFactory: () => getCurrentRequest() },
+    PASSWORD_RESET_TOKEN_EXPIRES_IN_MS: { useFactory: () => 300000 },
+    CONFIRM_PASSWORD_RESET_URL: { useFactory: () => undefined },
     MULTITHREADING_OPTIONS: {
         useFactory: () => ({
             maxThreads,
@@ -111,5 +120,65 @@ export const ZIBRI_DI_PROVIDERS: DiTokenProviderRecord<typeof ZIBRI_DI_TOKENS> =
     MULTITHREADING_SERVICE: { useClass: MultithreadingService },
     WEBSOCKET_SERVICE: { useClass: WebsocketService },
     WEBSOCKET_OPTIONS: { useFactory: () => ({ timeoutInMs: Ms.SECOND * 5, isAllowedToConnect: () => true }) },
-    HTTP_CLIENT: { useClass: HttpClient }
+    HTTP_CLIENT: { useClass: HttpClient },
+    EVENT_SERVICE: { useClass: EventService },
+    CORRELATION_ID_HEADER: { useValue: 'x-correlation-id' },
+    CSRF_TOKEN_HEADER: { useValue: 'x-csrf-token' },
+    COOKIE_AUTH_SESSION_OPTIONS: {
+        useValue: {
+            name: 'sessionId',
+            sameSite: 'lax',
+            path: '/'
+        }
+    },
+    COOKIE_AUTH_REFRESH_SESSION_OPTIONS: {
+        useValue: {
+            name: 'refreshSessionId',
+            sameSite: 'lax',
+            path: '/'
+        }
+    },
+    COOKIE_SIGN_SECRET: { useValue: undefined },
+    COOKIE_AUTH_SESSION_EXPIRES_IN_MS: { useValue: Ms.DAY },
+    COOKIE_AUTH_REFRESH_SESSION_EXPIRES_IN_MS: { useValue: Ms.DAY * 100 },
+    HASH_SERVICE: { useClass: HashService },
+    HASH_STRATEGIES: { useValue: [BcryptHashStrategy] },
+    ENCRYPTION_SERVICE: { useClass: EncryptionService },
+    ENCRYPTION_STRATEGIES: { useValue: [AesGcmEncryptionStrategy] },
+    ENCRYPTION_MASTER_OPTIONS: { useValue: undefined },
+    CACHE_SERVICE: { useClass: CacheService },
+    // dynamic
+    CURRENT_REQUEST_CONTEXT: {
+        useFactory: () => AlsUtilities.getCurrentRequestContext(),
+        cache: false
+    },
+    DEFAULT_CSP_OPTIONS: {
+        useFactory: () => {
+            const context: HttpRequestContext | WebsocketRequestContext | undefined = inject(ZIBRI_DI_TOKENS.CURRENT_REQUEST_CONTEXT);
+            const nonce: string | undefined = context?.get(ZIBRI_REQUEST_CONTEXT_TOKENS.NONCE);
+            const nonceSrc: CspSource | undefined = nonce ? `'nonce-${nonce}'` : undefined;
+            return {
+                baseUri: ['\'self\''],
+                connectSrc: [],
+                defaultSrc: ['\'self\''],
+                fontSrc: [],
+                formAction: ['\'self\''],
+                frameAncestors: ['\'self\''],
+                imgSrc: [],
+                mediaSrc: [],
+                objectSrc: ['\'none\''],
+                scriptSrc: [
+                    '\'self\'',
+                    ...nonceSrc ? [nonceSrc] : []
+                ],
+                scriptSrcAttr: ['\'none\''],
+                styleSrc: []
+            };
+        },
+        cache: false
+    },
+    CURRENT_CACHE_CONTEXT: {
+        useFactory: () => AlsUtilities.getCurrentCacheContext(),
+        cache: false
+    }
 };

package/src/di/default/zibri-di-tokens.default.ts

@@ -1,20 +1,30 @@
 import { AssetServiceInterface } from '../../assets/asset-service.interface';
 import { TwoFactorServiceInterface } from '../../auth/2fa/two-factor-service.interface';
 import { AuthServiceInterface } from '../../auth/auth-service.interface';
+import { EncryptionMasterOptions } from '../../auth/encryption/encryption-master-options.model';
+import { EncryptionServiceInterface } from '../../auth/encryption/encryption-service.interface';
+import { EncryptionStrategyInterface } from '../../auth/encryption/strategies/encryption-strategy.interface';
+import { HashServiceInterface } from '../../auth/hash/hash-service.interface';
+import { HashStrategyInterface } from '../../auth/hash/strategies/hash-strategy.interface';
+import { CookieAuthSessionOptionsInput } from '../../auth/strategies/cookie/cookie-auth.auth-strategy';
 import { PasswordResetEmailTemplate } from '../../auth/strategies/jwt/jwt-auth.controller';
 import { UserServiceInterface } from '../../auth/user/user-service.interface';
 import { BackupServiceInterface } from '../../backup/backup-service.interface';
+import { CacheServiceInterface } from '../../caching/cache-service.interface';
+import { HttpRequestContext } from '../../context/request/http-request.context';
+import { WebsocketRequestContext } from '../../context/request/websocket-request.context';
 import { CronServiceInterface } from '../../cron/cron-service.interface';
 import { DataSourceServiceInterface } from '../../data-source/data-source-service.interface';
 import { EmailServiceInterface } from '../../email/email-service.interface';
 import { EmailConfigInput } from '../../email/models/email-config.model';
 import { GlobalErrorHandler, ErrorPageTemplate } from '../../error-handling/error-handler.model';
-import { HttpRequest } from '../../http/http-request.model';
+import { EventServiceInterface } from '../../event/event-service.interface';
 import { HttpClientInterface } from '../../http-client/http-client.interface';
 import { FormatDateFn } from '../../localization/formatting/format-date-fn.model';
 import { FormatPercentFn } from '../../localization/formatting/format-percent-fn.model';
 import { FormatPriceFn } from '../../localization/formatting/format-price-fn.model';
 import { LocalizeOptionsInput, LocalizeOptions } from '../../localization/models/localize-options.model';
+import { LogCacheContext } from '../../logging/log-context.model';
 import { LogLevel } from '../../logging/log-level.enum';
 import { LoggerInterface } from '../../logging/logger.interface';
 import { LoggerTransport, BaseLoggerTransportConfig } from '../../logging/transport/logger-transport.model';
@@ -22,8 +32,10 @@ import { MetricsServiceInterface } from '../../metrics/metrics-service.interface
 import { MultithreadingOptions } from '../../multithreading/models/multithreading-options.model';
 import { MultithreadingServiceInterface } from '../../multithreading/services/multithreading-service.interface';
 import { OpenApiServiceInterface } from '../../open-api/open-api-service.interface';
+import { CspOptions } from '../../parsing/html/csp-options.model';
 import { ParserInterface } from '../../parsing/parser.interface';
 import { RouterInterface } from '../../routing/router.interface';
+import { Newable } from '../../types/newable.type';
 import { FsPath } from '../../utilities/fs.utilities';
 import { ValidationServiceInterface } from '../../validation/validation-service.interface';
 import { WebsocketOptions } from '../../websocket/models/websocket-options.model';
@@ -41,6 +53,7 @@ function ziToken<T = never>(k: `zi.${string}`): InjectionToken<T> {
  */
 // eslint-disable-next-line typescript/typedef
 export const ZIBRI_DI_TOKENS = {
+    // static/singleton tokens
     ROUTER: ziToken<RouterInterface>('zi.router'),
     LOGGER: ziToken<LoggerInterface>('zi.logger'),
     LOGGER_TRANSPORTS: ziToken<LoggerTransport<BaseLoggerTransportConfig>[]>('zi.logger_transports'),
@@ -62,10 +75,14 @@ export const ZIBRI_DI_TOKENS = {
     JWT_ACCESS_TOKEN_EXPIRES_IN_MS: ziToken<number>('zi.jwt_access_token_expires_in_ms'),
     JWT_REFRESH_TOKEN_SECRET: ziToken<string | undefined>('zi.jwt_refresh_token_secret'),
     JWT_REFRESH_TOKEN_EXPIRES_IN_MS: ziToken<number>('zi.jwt_refresh_token_expires_in_ms'),
-    JWT_PASSWORD_RESET_TOKEN_EXPIRES_IN_MS: ziToken<number>('zi.jwt_password_reset_token_expires_in_ms'),
-    JWT_CONFIRM_PASSWORD_RESET_URL: ziToken<string | undefined>('zi.jwt_confirm_password_reset_url'),
+    COOKIE_AUTH_SESSION_OPTIONS: ziToken<CookieAuthSessionOptionsInput>('zi.cookie_auth_session_options'),
+    COOKIE_AUTH_REFRESH_SESSION_OPTIONS: ziToken<CookieAuthSessionOptionsInput>('zi.cookie_auth_refresh_session_options'),
+    COOKIE_AUTH_SESSION_EXPIRES_IN_MS: ziToken<number>('zi.cookie_auth_session_expires_in_ms'),
+    COOKIE_AUTH_REFRESH_SESSION_EXPIRES_IN_MS: ziToken<number>('zi.cookie_auth_refresh_session_expires_in_ms'),
+    PASSWORD_RESET_TOKEN_EXPIRES_IN_MS: ziToken<number>('zi.password_reset_token_expires_in_ms'),
+    CONFIRM_PASSWORD_RESET_URL: ziToken<string | undefined>('zi.confirm_password_reset_url'),
     // eslint-disable-next-line typescript/no-explicit-any
-    JWT_PASSWORD_RESET_EMAIL_TEMPLATE: ziToken<PasswordResetEmailTemplate<any, any> | undefined>('zi.jwt_password_reset_email_template'),
+    PASSWORD_RESET_EMAIL_TEMPLATE: ziToken<PasswordResetEmailTemplate<any, any> | undefined>('zi.password_reset_email_template'),
     USER_SERVICE: ziToken<UserServiceInterface>('zi.user_service'),
     CRON_SERVICE: ziToken<CronServiceInterface>('zi.cron_service'),
     FILE_UPLOAD_TEMP_FOLDER: ziToken<FsPath>('zi.file_upload_temp_folder'),
@@ -76,11 +93,30 @@ export const ZIBRI_DI_TOKENS = {
     FORMAT_PERCENT: ziToken<FormatPercentFn>('zi.format_percent'),
     EMAIL_SERVICE: ziToken<EmailServiceInterface>('zi.email_service'),
     EMAIL_CONFIG: ziToken<EmailConfigInput | undefined>('zi.email_config'),
-    CURRENT_REQUEST: ziToken<HttpRequest | undefined>('zi.current_request'),
     MULTITHREADING_SERVICE: ziToken<MultithreadingServiceInterface>('zi.multithreading_service'),
     MULTITHREADING_OPTIONS: ziToken<MultithreadingOptions>('zi.multithreading_options'),
     // eslint-disable-next-line typescript/no-explicit-any
     WEBSOCKET_SERVICE: ziToken<WebsocketServiceInterface<any>>('zi.websocket_service'),
     WEBSOCKET_OPTIONS: ziToken<WebsocketOptions>('zi.websocket_options'),
-    HTTP_CLIENT: ziToken<HttpClientInterface>('zi.http_client')
+    HTTP_CLIENT: ziToken<HttpClientInterface>('zi.http_client'),
+    EVENT_SERVICE: ziToken<EventServiceInterface<Record<string, unknown>>>('zi.event_service'),
+    CORRELATION_ID_HEADER: ziToken<string>('zi.correlation_id_header'),
+    CSRF_TOKEN_HEADER: ziToken<string>('zi.csrf_token_header'),
+    COOKIE_SIGN_SECRET: ziToken<string | undefined>('zi.cookie_sign_secret'),
+    HASH_SERVICE: ziToken<HashServiceInterface>('zi.hash_service'),
+    HASH_STRATEGIES: ziToken<Newable<HashStrategyInterface<Record<string, unknown>>>[]>('zi.hash_strategies'),
+    ENCRYPTION_SERVICE: ziToken<EncryptionServiceInterface>('zi.encryption_service'),
+    ENCRYPTION_STRATEGIES: ziToken<
+        // eslint-disable-next-line typescript/no-explicit-any
+        Newable<EncryptionStrategyInterface<any, any, any>>[]
+    >('zi.encryption_strategies'),
+    // eslint-disable-next-line typescript/no-explicit-any
+    ENCRYPTION_MASTER_OPTIONS: ziToken<EncryptionMasterOptions<any, any, any> | undefined>(
+        'zi.encryption_master_options'
+    ),
+    CACHE_SERVICE: ziToken<CacheServiceInterface>('zi.cache_service'),
+    // dynamic/context based tokens
+    CURRENT_REQUEST_CONTEXT: ziToken<HttpRequestContext | WebsocketRequestContext | undefined>('zi.current_request_context'),
+    DEFAULT_CSP_OPTIONS: ziToken<CspOptions>('zi.default_csp_options'),
+    CURRENT_CACHE_CONTEXT: ziToken<LogCacheContext[] | undefined>('zi.current_cache_context')
 } as const satisfies TokenRecord;

package/src/di/di-container.ts

@@ -111,7 +111,9 @@ export class DiContainer {
         const instance: T = this.createInstanceFromProvider(provider, resolvingStack);
         resolvingStack.pop();
 
-        this.instances.set(provider.token, instance);
+        if (provider.useValue != undefined || ((provider.useFactory || provider.useClass) && provider.cache !== false)) {
+            this.instances.set(provider.token, instance);
+        }
 
         if (provider.useClass) {
             this.instances.set(provider.useClass as unknown as DiToken<unknown>, instance);
@@ -121,9 +123,12 @@ export class DiContainer {
     }
 
     private createInstanceFromProvider<T>(provider: DiProvider<T>, resolvingStack: Function[]): T {
+        if ('useValue' in provider) {
+            return provider.useValue as T;
+        }
+
         const provide: Newable<T> | ((...deps: unknown[]) => T) | T | undefined = provider.useClass
-            ?? provider.useFactory
-            ?? provider.useValue;
+            ?? provider.useFactory;
 
         if (provide == undefined) {
             throw new Error(`Provider for ${provider.token.toString()} is invalid`);
@@ -153,12 +158,9 @@ export class DiContainer {
         if (provider.useClass) {
             return new provider.useClass(...deps);
         }
-        if (provider.useFactory) {
+        if (provider.useFactory != undefined) {
             return provider.useFactory(...deps);
         }
-        if ('useValue' in provider) {
-            return provider.useValue;
-        }
 
         throw new Error(`Provider for ${(provider as DiProvider<T>).token.toString()} is invalid`);
     }

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

@@ -39,6 +39,12 @@ type ClassDiProvider<T> = BaseDiProvider<T> & {
      * A class to register for the token.
      */
     useClass: Newable<T>,
+    /**
+     * Whether or not the newly created class instance should be cached or recreated on every injection.
+     *
+     * Defaults to true.
+     */
+    cache?: boolean,
     // eslint-disable-next-line jsdoc/require-jsdoc
     useFactory?: never,
     // eslint-disable-next-line jsdoc/require-jsdoc
@@ -51,6 +57,12 @@ type FactoryDiProvider<T> = BaseDiProvider<T> & {
      * A factory function that resolves the value to register for the token.
      */
     useFactory: (...deps: unknown[]) => T,
+    /**
+     * Whether or not the result of the function should be cached or recomputed on every injection.
+     *
+     * Defaults to true.
+     */
+    cache?: boolean,
     // eslint-disable-next-line jsdoc/require-jsdoc
     useClass?: never,
     // eslint-disable-next-line jsdoc/require-jsdoc

package/src/email/email.service.ts

@@ -60,7 +60,9 @@ export class EmailService implements EmailServiceInterface, OnAppInit, OnAppShut
 
     // eslint-disable-next-line jsdoc/require-jsdoc
     onAppInit(app: ZibriApplication): void {
-        app.options.cronJobs.push(SendQueuedEmailsCronJob);
+        if (!app.options.cronJobs.includes(SendQueuedEmailsCronJob)) {
+            app.options.cronJobs.push(SendQueuedEmailsCronJob);
+        }
     }
 
     // eslint-disable-next-line jsdoc/require-jsdoc

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

@@ -1,4 +1,5 @@
 import { type EmailServiceInterface } from './email-service.interface';
+import { CronExpression } from '../cron/cron-expression.utilities';
 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';
@@ -10,7 +11,7 @@ export class SendQueuedEmailsCronJob extends CronJob {
     // eslint-disable-next-line jsdoc/require-jsdoc
     initialConfig: InitialCronConfig = {
         name: 'send queued emails',
-        cron: '*/5 * * * * *',
+        cron: CronExpression.every(5, 'seconds').build(),
         runOnInit: false
     };
 

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

@@ -1,6 +1,8 @@
+import { BaseDecryptOptions, BaseEncryptOptions } from '../../auth/encryption/strategies/encryption-strategy.interface';
 import { warn } from '../../logging/logger.helpers';
 import { Newable } from '../../types/newable.type';
 import { MetadataUtilities } from '../../utilities/metadata.utilities';
+import { AnyObject } from '../any-object.model';
 import type { BaseEntity } from '../base-entity.model';
 import { ArrayPropertyMetadata, ArrayPropertyMetadataInput, ArrayPropertyItemMetadataInput, ArrayPropertyItemMetadata } from '../models/array-property-metadata.model';
 import type { WithDefaultMetadata } from '../models/base-property-metadata.model';
@@ -20,7 +22,8 @@ import { UnknownPropertyMetadata, UnknownPropertyMetadataInput } from '../models
 /**
  * The metadata of a property.
  */
-export type PropertyMetadata = StringPropertyMetadata
+// eslint-disable-next-line typescript/no-explicit-any
+export type PropertyMetadata = StringPropertyMetadata<any, any, any, any, any>
     | NumberPropertyMetadata
     | ObjectPropertyMetadata
     | ArrayPropertyMetadata
@@ -41,7 +44,8 @@ export type RelationMetadata<T extends BaseEntity> = ManyToOnePropertyMetadata<T
 /**
  * The metadata input to define a property.
  */
-export type PropertyMetadataInput = StringPropertyMetadataInput
+// eslint-disable-next-line typescript/no-explicit-any
+export type PropertyMetadataInput = StringPropertyMetadataInput<any, any, any, any, any>
     | NumberPropertyMetadataInput
     | ObjectPropertyMetadataInput
     | ArrayPropertyMetadataInput
@@ -70,8 +74,14 @@ export namespace Property {
      * Defines a string property.
      * @param data - Additional data to specify the property.
      */
-    export function string(data?: StringPropertyMetadataInput): PropertyDecorator {
-        const fullMetadata: StringPropertyMetadata = {
+    export function string<
+        Data,
+        TKey,
+        TEncryptOptions extends BaseEncryptOptions<TKey>,
+        TDecryptOptions extends BaseDecryptOptions<TKey>,
+        THashOptions extends AnyObject
+    >(data?: StringPropertyMetadataInput<Data, TKey, TEncryptOptions, TDecryptOptions, THashOptions>): PropertyDecorator {
+        const fullMetadata: StringPropertyMetadata<Data, TKey, TEncryptOptions, TDecryptOptions, THashOptions> = {
             required: true,
             primary: false,
             type: 'string',
@@ -83,7 +93,10 @@ export namespace Property {
             regex: undefined,
             enum: undefined,
             default: undefined,
-            excludeFromChangeSets: false,
+            excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
+            exclude: false,
+            encryption: false,
+            hash: false,
             ...data
         };
         return applyData(fullMetadata, data);
@@ -103,8 +116,10 @@ export namespace Property {
             min: undefined,
             max: undefined,
             default: undefined,
-            excludeFromChangeSets: false,
+            excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
+            exclude: false,
             enum: undefined,
+            format: undefined,
             ...data
         };
         return applyData(fullMetadata, data);
@@ -120,7 +135,8 @@ export namespace Property {
             type: 'boolean',
             description: undefined,
             default: undefined,
-            excludeFromChangeSets: false,
+            excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
+            exclude: false,
             ...data
         };
         return applyData(fullMetadata, data);
@@ -138,7 +154,8 @@ export namespace Property {
             after: undefined,
             before: undefined,
             default: undefined,
-            excludeFromChangeSets: false,
+            exclude: false,
+            excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
             ...data
         };
         return applyData(fullMetadata, data);
@@ -153,7 +170,8 @@ export namespace Property {
             required: true,
             type: 'object',
             description: undefined,
-            excludeFromChangeSets: false,
+            exclude: false,
+            excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
             allowAdditionalProperties: false,
             ...data
         };
@@ -178,7 +196,8 @@ export namespace Property {
                 description: undefined,
                 allowedMimeTypes: 'all',
                 maxSize: '5mb',
-                excludeFromChangeSets: false,
+                exclude: false,
+                excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
                 ...data
             };
             const ctor: Newable<unknown> = target.constructor as Newable<unknown>;
@@ -201,7 +220,8 @@ export namespace Property {
                 required: true,
                 type: 'array',
                 description: undefined,
-                excludeFromChangeSets: false,
+                exclude: false,
+                excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
                 totalMaxSize: '50mb',
                 ...data,
                 items: createArrayItemPropertyMetadata(data.items, `${target.constructor.name}.${key.toString()}`)
@@ -225,7 +245,8 @@ export namespace Property {
             required: true,
             type: 'unknown',
             description: undefined,
-            excludeFromChangeSets: false,
+            exclude: false,
+            excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
             ...data
         };
         return applyData(fullMetadata, data);
@@ -241,7 +262,8 @@ export namespace Property {
             type: Relation.MANY_TO_ONE,
             cascade: [],
             description: undefined,
-            excludeFromChangeSets: false,
+            exclude: false,
+            excludeFromChangeSets: typeof metadata?.exclude === 'boolean' ? metadata.exclude : false,
             ...metadata
         };
         return applyData(fullMetadata as PropertyMetadata, metadata);
@@ -257,7 +279,8 @@ export namespace Property {
             type: Relation.ONE_TO_MANY,
             cascade: ['remove', 'insert', 'update'],
             description: undefined,
-            excludeFromChangeSets: false,
+            exclude: false,
+            excludeFromChangeSets: typeof metadata?.exclude === 'boolean' ? metadata.exclude : false,
             ...metadata
         };
         return applyData(fullMetadata as PropertyMetadata, metadata);
@@ -274,7 +297,8 @@ export namespace Property {
             cascade: ['remove', 'insert', 'update'],
             joinColumn: false,
             description: undefined,
-            excludeFromChangeSets: false,
+            exclude: false,
+            excludeFromChangeSets: typeof metadata?.exclude === 'boolean' ? metadata.exclude : false,
             ...metadata
         };
         return applyData(fullMetadata as PropertyMetadata, metadata);
@@ -291,7 +315,8 @@ export namespace Property {
             cascade: [],
             joinColumn: true,
             description: undefined,
-            excludeFromChangeSets: false,
+            exclude: false,
+            excludeFromChangeSets: typeof metadata?.exclude === 'boolean' ? metadata.exclude : false,
             ...metadata
         };
         return applyData(fullMetadata as PropertyMetadata, metadata);
@@ -308,7 +333,8 @@ export namespace Property {
             cascade: [],
             description: undefined,
             persistence: true,
-            excludeFromChangeSets: false,
+            exclude: false,
+            excludeFromChangeSets: typeof metadata?.exclude === 'boolean' ? metadata.exclude : false,
             ...metadata
         };
         return applyData(fullMetadata as PropertyMetadata, metadata);
@@ -319,8 +345,17 @@ export namespace Property {
 function applyData(data: PropertyMetadata, inputData: PropertyMetadataInput | undefined): PropertyDecorator {
     return (target, key) => {
         if (inputData?.required != undefined && (inputData as WithDefaultMetadata<string>).default != undefined) {
-            // eslint-disable-next-line stylistic/max-len
-            warn(`setting "required" on ${target.constructor.name}.${key.toString()} won't have any effect, because "default" is also set.`);
+            warn(`${target.constructor.name}.${key.toString()}: setting "required" won't have any effect, because "default" is also set.`);
+        }
+        if ('primary' in data && data.primary && data.exclude !== false) {
+            throw new Error(`${target.constructor.name}.${key.toString()}: Cannot mark a primary key with "exclude."`);
+        }
+        if (
+            'encryption' in data && 'hash' in data
+            && data.encryption !== undefined && data.encryption !== false
+            && data.hash !== undefined && data.hash !== false
+        ) {
+            throw new Error(`${target.constructor.name}.${key.toString()}: Cannot set the flags "encryption" and "hash" at the same time.`);
         }
         const ctor: Newable<unknown> = target.constructor as Newable<unknown>;
         // eslint-disable-next-line unicorn/error-message
@@ -338,6 +373,7 @@ function applyData(data: PropertyMetadata, inputData: PropertyMetadataInput | un
  * @param fullPropertyKey - The full key of the property.
  * @returns The full metadata.
  */
+// eslint-disable-next-line sonar/cognitive-complexity
 export function createArrayItemPropertyMetadata(
     data: ArrayPropertyItemMetadataInput,
     fullPropertyKey: string
@@ -352,7 +388,8 @@ export function createArrayItemPropertyMetadata(
                 min: undefined,
                 max: undefined,
                 default: undefined,
-                excludeFromChangeSets: false,
+                exclude: false,
+                excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
                 enum: undefined,
                 ...data
             };
@@ -369,7 +406,10 @@ export function createArrayItemPropertyMetadata(
                 regex: undefined,
                 enum: undefined,
                 default: undefined,
-                excludeFromChangeSets: false,
+                exclude: false,
+                encryption: false,
+                hash: false,
+                excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
                 ...data
             };
         }
@@ -377,7 +417,8 @@ export function createArrayItemPropertyMetadata(
             return {
                 required: true,
                 description: undefined,
-                excludeFromChangeSets: false,
+                exclude: false,
+                excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
                 ...data
             };
         }
@@ -385,7 +426,8 @@ export function createArrayItemPropertyMetadata(
             return {
                 required: true,
                 description: undefined,
-                excludeFromChangeSets: false,
+                exclude: false,
+                excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
                 allowAdditionalProperties: false,
                 ...data
             };
@@ -395,7 +437,8 @@ export function createArrayItemPropertyMetadata(
                 required: true,
                 description: undefined,
                 default: undefined,
-                excludeFromChangeSets: false,
+                exclude: false,
+                excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
                 ...data
             };
         }
@@ -406,7 +449,8 @@ export function createArrayItemPropertyMetadata(
                 after: undefined,
                 before: undefined,
                 default: undefined,
-                excludeFromChangeSets: false,
+                exclude: false,
+                excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
                 ...data
             };
         }
@@ -414,7 +458,8 @@ export function createArrayItemPropertyMetadata(
             const metadata: ArrayPropertyMetadata = {
                 required: true,
                 description: undefined,
-                excludeFromChangeSets: false,
+                exclude: false,
+                excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
                 totalMaxSize: '50mb',
                 ...data,
                 items: createArrayItemPropertyMetadata(data.items, fullPropertyKey)
@@ -433,7 +478,8 @@ export function createArrayItemPropertyMetadata(
                 description: undefined,
                 allowedMimeTypes: 'all',
                 maxSize: '5mb',
-                excludeFromChangeSets: false,
+                exclude: false,
+                excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
                 ...data
             };
         }

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

@@ -3,6 +3,7 @@ import { getEntityFileName } from './get-entity-file-name.function';
 import { EntityGenerationProvider } from './providers/entity-generation-provider.interface';
 import { OpenApiReferenceObject, OpenApiSchemaObject, OpenApiSchemas } from '../../open-api/open-api.model';
 import { addImportStatement } from '../../utilities/add-import-statement.function';
+import { JsonUtilities } from '../../utilities/json.utilities';
 import { ObjectUtilities } from '../../utilities/object.utilities';
 import { toPascalCase } from '../../utilities/to-pascal-case.function';
 
@@ -112,7 +113,7 @@ function mapSchemaToTsType(
     switch (schema.type) {
         case 'string': {
             if (schema.enum) {
-                return { type: schema.enum.map(v => JSON.stringify(v).replaceAll('"', '\'')).join(' | '), isRef: false };
+                return { type: schema.enum.map(v => JsonUtilities.stringify(v).replaceAll('"', '\'')).join(' | '), isRef: false };
             }
             if (schema.format === 'date-time') {
                 return { type: 'Date', isRef: false };
@@ -173,11 +174,11 @@ function mapSchemaToDecoratorLines(
                 if (isRequired) {
                     return ['    @Property.date()'];
                 }
-                return [`    @Property.date({ ${!isRequired ? 'required: false' : ''} })`];
+                return ['    @Property.date({ required: false })'];
             }
             // TODO
             // if (schema.enum) {
-            //     return { type: schema.enum.map(v => JSON.stringify(v)).join(' | '), isRef: false };
+            //     return { type: schema.enum.map(v => JsonUtilities.stringify(v)).join(' | '), isRef: false };
             // }
             if (isRequired) {
                 return ['    @Property.string()'];

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

@@ -1,4 +1,4 @@
-import { register } from 'ts-node';
+import { register as tsNodeRegister } from 'ts-node';
 
 import { FileToGenerate, generateEntityFilesForProvider, GenerateEntityFilesForProviderResult } from './generate-entity-files-for-provider.function';
 import { EntityGenerationProvider } from './providers/entity-generation-provider.interface';
@@ -14,7 +14,8 @@ export async function generateEntityFiles(): Promise<void> {
     if (ext !== '.ts') {
         return;
     }
-    register();
+    // Register ts-node so the dynamically required providers file can be loaded when it is authored in TypeScript.
+    tsNodeRegister();
     // eslint-disable-next-line typescript/no-explicit-any, typescript/no-unsafe-assignment, typescript/no-require-imports, typescript/no-var-requires
     const imported: any = require(providersPath);
     // eslint-disable-next-line typescript/no-unsafe-member-access