zibri 2.3.0 → 2.4.1

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

@@ -1,5 +1,8 @@
+import { FindOptionsOrder, FindOptionsOrderValue, FindOptionsRelations } from 'typeorm';
+
 import { GlobalRegistry } from '../../global/global-registry';
 import { Newable } from '../../types/newable.type';
+import { OmitStrict } from '../../types/omit-strict.type';
 import { MetadataUtilities } from '../../utilities/metadata.utilities';
 import { toSnakeCase } from '../../utilities/to-snake-case.function';
 import { type BaseEntity } from '../base-entity.model';
@@ -15,19 +18,55 @@ export type EntityMetadata = {
     /**
      * Whether or not this entity is allowed to exist without belonging to a data source.
      */
-    allowOrphan: boolean
+    allowOrphan: boolean,
+    /**
+     * Default ordering to apply to results when nothing has been specified.
+     */
+    // eslint-disable-next-line typescript/no-explicit-any
+    defaultOrder?: FindOptionsOrder<any>,
+    /**
+     * Default relations to include in results when nothing has been specified.
+     */
+    // eslint-disable-next-line typescript/no-explicit-any
+    defaultRelations?: FindOptionsRelations<any>
+};
+
+// eslint-disable-next-line jsdoc/require-jsdoc
+type EntityMetadataInput<
+    TOrderKey extends string = never,
+    TRelationKey extends string = never
+> = OmitStrict<Partial<EntityMetadata>, 'defaultOrder' | 'defaultRelations'> & {
+    /**
+     * Default ordering to apply to results when nothing has been specified.
+     */
+    defaultOrder?: { [K in TOrderKey]?: FindOptionsOrderValue },
+    /**
+     * Default relations to include in results when nothing has been specified.
+     */
+    // eslint-disable-next-line typescript/no-explicit-any
+    defaultRelations?: { [K in TRelationKey]?: FindOptionsRelations<any> | boolean }
 };
 
+// eslint-disable-next-line jsdoc/require-jsdoc, typescript/no-explicit-any
+type ConstrainKeys<TKey extends string> = [TKey] extends [never] ? object : Record<TKey, any>;
+
+// eslint-disable-next-line jsdoc/require-returns
 /**
  * Marks an entity.
  * @param options - Configuration options for the entity.
  */
-export function Entity(options: Partial<EntityMetadata> = {}): ClassDecorator {
-    const { tableName, allowOrphan = false } = options;
-    return target => {
+export function Entity<TOrderKey extends string, TRelationKey extends string>(
+    options: EntityMetadataInput<TOrderKey, TRelationKey> = {}
+) {
+    const { tableName, defaultOrder, defaultRelations, allowOrphan = false } = options;
+    return <T extends ConstrainKeys<TOrderKey> & ConstrainKeys<TRelationKey>>(
+        target: Newable<T>
+    ): void => {
         const metadata: EntityMetadata = {
             tableName: tableName ?? toSnakeCase(target.name),
-            allowOrphan
+            allowOrphan,
+            defaultOrder,
+            defaultRelations
         };
         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,18 +1,20 @@
+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';
+import { BelongsToOnePropertyMetadata, BelongsToOnePropertyMetadataInput } from '../models/belongs-to-one-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 { HasOnePropertyMetadata, HasOnePropertyMetadataInput } from '../models/has-one-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';
@@ -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
@@ -35,13 +38,15 @@ export type PropertyMetadata = StringPropertyMetadata
  */
 export type RelationMetadata<T extends BaseEntity> = ManyToOnePropertyMetadata<T>
     | OneToManyPropertyMetadata<T>
-    | OneToOnePropertyMetadata<T>
+    | HasOnePropertyMetadata<T>
+    | BelongsToOnePropertyMetadata<T>
     | ManyToManyPropertyMetadata<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
@@ -50,15 +55,14 @@ export type PropertyMetadataInput = StringPropertyMetadataInput
     | BooleanPropertyMetadataInput
     | UnknownPropertyMetadataInput;
 
-/**
- * The metadata input to define a relation property.
- */
-export type RelationMetadataInput<T extends BaseEntity> = ManyToOnePropertyMetadataInput<T>
-    | OneToManyPropertyMetadataInput<T>
-    | OneToOnePropertyMetadataInput<T>
-    | HasOnePropertyMetadataInput<T>
-    | BelongsToOnePropertyMetadataInput<T>
-    | ManyToManyPropertyMetadataInput<T>;
+// /**
+//  * The metadata input to define a relation property.
+//  */
+// export type RelationMetadataInput<T extends BaseEntity> = ManyToOnePropertyMetadataInput<T>
+//     | OneToManyPropertyMetadataInput<T>
+//     | HasOnePropertyMetadataInput<T>
+//     | BelongsToOnePropertyMetadataInput<T>
+//     | ManyToManyPropertyMetadataInput<T>;
 
 /**
  * Bundles decorators for properties.
@@ -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,10 +93,13 @@ 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);
+        return applyData(fullMetadata);
     }
 
     /**
@@ -103,11 +116,13 @@ 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);
+        return applyData(fullMetadata);
     }
 
     /**
@@ -120,10 +135,11 @@ 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);
+        return applyData(fullMetadata);
     }
 
     /**
@@ -138,10 +154,11 @@ 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);
+        return applyData(fullMetadata);
     }
 
     /**
@@ -153,11 +170,12 @@ export namespace Property {
             required: true,
             type: 'object',
             description: undefined,
-            excludeFromChangeSets: false,
+            exclude: false,
+            excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
             allowAdditionalProperties: false,
             ...data
         };
-        return applyData(fullMetadata, data);
+        return applyData(fullMetadata);
     }
 
     /**
@@ -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,26 +245,39 @@ 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);
+        return applyData(fullMetadata);
     }
 
+    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines a many to one property.
      * @param metadata - Additional data to specify the property.
      */
-    export function manyToOne<T extends BaseEntity>(metadata: ManyToOnePropertyMetadataInput<T>): PropertyDecorator {
+    export function manyToOne<T extends BaseEntity, TJoinKey extends string>(
+        metadata: ManyToOnePropertyMetadataInput<T, TJoinKey>
+    ) {
         const fullMetadata: ManyToOnePropertyMetadata<T> = {
             required: true,
             type: Relation.MANY_TO_ONE,
             cascade: [],
             description: undefined,
-            excludeFromChangeSets: false,
+            joinColumn: undefined,
+            exclude: false,
+            excludeFromChangeSets: typeof metadata?.exclude === 'boolean' ? metadata.exclude : false,
             ...metadata
         };
-        return applyData(fullMetadata as PropertyMetadata, metadata);
+
+        // eslint-disable-next-line typescript/no-explicit-any
+        return <TCurrentEntity extends Partial<Record<TJoinKey, any>>>(
+            target: TCurrentEntity,
+            propertyKey: string | symbol
+        ): void => {
+            applyData(fullMetadata as PropertyMetadata)(target, propertyKey);
+        };
     }
 
     /**
@@ -257,10 +290,11 @@ 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);
+        return applyData(fullMetadata as PropertyMetadata);
     }
 
     /**
@@ -268,33 +302,44 @@ export namespace Property {
      * @param metadata - Additional data to specify the property.
      */
     export function hasOne<T extends BaseEntity>(metadata: HasOnePropertyMetadataInput<T>): PropertyDecorator {
-        const fullMetadata: OneToOnePropertyMetadata<T> = {
+        const fullMetadata: HasOnePropertyMetadata<T> = {
             required: true,
-            type: Relation.ONE_TO_ONE,
+            type: Relation.HAS_ONE,
             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);
+        return applyData(fullMetadata as PropertyMetadata);
     }
 
+    // eslint-disable-next-line jsdoc/require-returns
     /**
      * Defines a belongs to one property.
      * @param metadata - Additional data to specify the property.
      */
-    export function belongsToOne<T extends BaseEntity>(metadata: BelongsToOnePropertyMetadataInput<T>): PropertyDecorator {
-        const fullMetadata: OneToOnePropertyMetadata<T> = {
+    export function belongsToOne<T extends BaseEntity, TJoinKey extends string>(
+        metadata: BelongsToOnePropertyMetadataInput<T, TJoinKey>
+    ) {
+        const fullMetadata: BelongsToOnePropertyMetadata<T> = {
             required: true,
-            type: Relation.ONE_TO_ONE,
+            type: Relation.BELONGS_TO_ONE,
             cascade: [],
-            joinColumn: true,
+            joinColumn: undefined,
             description: undefined,
-            excludeFromChangeSets: false,
+            exclude: false,
+            excludeFromChangeSets: typeof metadata?.exclude === 'boolean' ? metadata.exclude : false,
             ...metadata
         };
-        return applyData(fullMetadata as PropertyMetadata, metadata);
+
+        // eslint-disable-next-line typescript/no-explicit-any
+        return <TCurrentEntity extends Partial<Record<TJoinKey, any>>>(
+            target: TCurrentEntity,
+            propertyKey: string | symbol
+        ): void => {
+            applyData(fullMetadata as PropertyMetadata)(target, propertyKey);
+        };
     }
 
     /**
@@ -305,22 +350,30 @@ export namespace Property {
         const fullMetadata: ManyToManyPropertyMetadata<T> = {
             required: true,
             type: Relation.MANY_TO_MANY,
-            cascade: [],
+            cascade: metadata.joinTable === true ? ['remove'] : [],
             description: undefined,
+            joinTable: undefined,
             persistence: true,
-            excludeFromChangeSets: false,
+            exclude: false,
+            excludeFromChangeSets: typeof metadata?.exclude === 'boolean' ? metadata.exclude : false,
             ...metadata
         };
-        return applyData(fullMetadata as PropertyMetadata, metadata);
+        return applyData(fullMetadata as PropertyMetadata);
     }
 }
 
 // eslint-disable-next-line jsdoc/require-jsdoc
-function applyData(data: PropertyMetadata, inputData: PropertyMetadataInput | undefined): PropertyDecorator {
+function applyData(data: PropertyMetadata): 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.`);
+        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 +391,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 +406,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 +424,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 +435,8 @@ export function createArrayItemPropertyMetadata(
             return {
                 required: true,
                 description: undefined,
-                excludeFromChangeSets: false,
+                exclude: false,
+                excludeFromChangeSets: typeof data?.exclude === 'boolean' ? data.exclude : false,
                 ...data
             };
         }
@@ -385,7 +444,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 +455,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 +467,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 +476,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 +496,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/entity-metadata-missing.error.ts

@@ -0,0 +1,15 @@
+import { BaseEntity } from './base-entity.model';
+import { Newable } from '../types/newable.type';
+
+/**
+ * An error that gets thrown when entity metadata that is required is missing.
+ */
+export class EntityMetadataMissingError extends Error {
+    constructor(entity: Newable<BaseEntity>, usage: string = '') {
+        super([
+            `Could not find entity metadata for ${entity.name} ${usage}`,
+            'Did you forget to decorate it with @Entity?'
+        ].join('\n'));
+        this.name = 'EntityMetadataMissingError';
+    }
+}

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

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

@@ -2,6 +2,7 @@ import { EntityGenerationProvider } from './entity-generation-provider.interface
 import { openApiToV3 } from './open-api-to-v3.function';
 import { OpenApiDefinition } from '../../../open-api/open-api.model';
 import { FsUtilities, FsPath } from '../../../utilities/fs.utilities';
+import { JsonUtilities } from '../../../utilities/json.utilities';
 
 /**
  * An entity generation provider using a local open api file.
@@ -16,7 +17,7 @@ export class OpenApiFileProvider implements EntityGenerationProvider {
 
     // eslint-disable-next-line jsdoc/require-jsdoc
     async resolveSpec(): Promise<OpenApiDefinition> {
-        const spec: unknown = JSON.parse(await FsUtilities.readFile(this.filePath));
+        const spec: unknown = JsonUtilities.parse(await FsUtilities.readFile(this.filePath));
         return await openApiToV3(spec);
     }
 }

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

@@ -36,8 +36,8 @@ export type ArrayPropertyItemMetadata = ExcludeStrict<PropertyMetadata, Relation
 /**
  * Input Metadata for array property items.
  */
-// eslint-disable-next-line jsdoc/require-jsdoc
-export type ArrayPropertyItemMetadataInput = StringPropertyMetadataInput & { type: 'string' }
+// eslint-disable-next-line jsdoc/require-jsdoc, typescript/no-explicit-any
+export type ArrayPropertyItemMetadataInput = StringPropertyMetadataInput<any, any, any, any, any> & { type: 'string' }
     // eslint-disable-next-line jsdoc/require-jsdoc
     | NumberPropertyMetadataInput & { type: 'number' }
     // eslint-disable-next-line jsdoc/require-jsdoc

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

@@ -1,24 +1,49 @@
-import { BaseEntity } from '../base-entity.model';
+import { HttpRequestContext } from '../../context/request/http-request.context';
+import { WebsocketRequestContext } from '../../context/request/websocket-request.context';
+
+/**
+ * Value for the exclude setting on a property.
+ */
+export type ExcludePropertyValue = boolean
+    // eslint-disable-next-line typescript/no-explicit-any
+    | ((data: any, ctx: HttpRequestContext | WebsocketRequestContext | undefined) => boolean | Promise<boolean>);
+/**
+ * Value for the required setting on a property.
+ */
+export type RequiredPropertyValue = boolean
+    // eslint-disable-next-line typescript/no-explicit-any
+    | ((data: any, ctx: HttpRequestContext | WebsocketRequestContext | undefined) => boolean | Promise<boolean>);
 
 /**
  * Metadata shared by all properties.
  */
-// eslint-disable-next-line typescript/no-explicit-any
-export type BasePropertyMetadata<T extends BaseEntity = any> = {
+export type BasePropertyMetadata = {
     /**
      * Whether or not the property is required.
      */
-    required: boolean | ((data: T) => boolean),
+    required: RequiredPropertyValue,
     /**
      * A description of the property.
      */
     description: string | undefined,
+    /**
+     * Whether this property should be excluded from external-facing outputs.
+     */
+    exclude: ExcludePropertyValue,
     /**
      * Whether or not this property should be excluded when generating change sets.
      */
     excludeFromChangeSets: boolean
 };
 
+/**
+ * Value for the default setting on a property.
+ */
+export type DefaultPropertyValue<T extends string | number | boolean | Date> = T
+    | undefined
+    // eslint-disable-next-line typescript/no-explicit-any
+    | ((createData: any, ctx: HttpRequestContext | WebsocketRequestContext | undefined) => T | Promise<T>);
+
 /**
  * Adds a default property which can be used to fill empty properties with default values.
  */
@@ -26,6 +51,5 @@ export type WithDefaultMetadata<T extends string | number | boolean | Date> = {
     /**
      * The default value to set an empty property to when defined.
      */
-    // eslint-disable-next-line typescript/no-explicit-any
-    default: T | ((createData: any) => T | Promise<T>) | undefined
+    default: DefaultPropertyValue<T>
 };

package/src/entity/models/base-relation-metadata.model.ts

@@ -16,7 +16,7 @@ export type BaseRelationMetadata<T extends BaseEntity> = BasePropertyMetadata
         target: () => Newable<T>,
         /**
          * The name of the inverse property on the target,
-         * e.g. 'user' if Posts has `@ManyToOne(() => User, 'post')`.
+         * e.g. 'user' if Posts has `@Property.manyToOne(() => User, 'post')`.
          */
         inverseSide: keyof T
     };