@mikro-orm/core 7.0.0-dev.7 → 7.0.0-dev.70

package/utils/Configuration.d.ts

@@ -1,149 +1,151 @@
 import type { NamingStrategy } from '../naming-strategy/NamingStrategy.js';
 import { FileCacheAdapter } from '../cache/FileCacheAdapter.js';
-import { type SyncCacheAdapter, type CacheAdapter } from '../cache/CacheAdapter.js';
+import { type CacheAdapter, type SyncCacheAdapter } from '../cache/CacheAdapter.js';
 import type { EntityRepository } from '../entity/EntityRepository.js';
-import type { AnyEntity, Constructor, Dictionary, EntityClass, EntityClassGroup, FilterDef, Highlighter, HydratorConstructor, IHydrator, IMigrationGenerator, IPrimaryKey, MaybePromise, MigrationObject, EntityMetadata, EnsureDatabaseOptions, GenerateOptions, Migration } from '../typings.js';
+import type { AnyEntity, Constructor, Dictionary, EnsureDatabaseOptions, EntityClass, EntityMetadata, FilterDef, GenerateOptions, Highlighter, HydratorConstructor, IHydrator, IMigrationGenerator, IPrimaryKey, MaybePromise, Migration, MigrationObject } from '../typings.js';
 import { ObjectHydrator } from '../hydration/ObjectHydrator.js';
 import { NullHighlighter } from '../utils/NullHighlighter.js';
 import { type Logger, type LoggerNamespace, type LoggerOptions } from '../logging/Logger.js';
 import type { EntityManager } from '../EntityManager.js';
 import type { Platform } from '../platforms/Platform.js';
 import type { EntitySchema } from '../metadata/EntitySchema.js';
-import type { MetadataProvider } from '../metadata/MetadataProvider.js';
+import { MetadataProvider } from '../metadata/MetadataProvider.js';
 import type { MetadataStorage } from '../metadata/MetadataStorage.js';
-import { ReflectMetadataProvider } from '../metadata/ReflectMetadataProvider.js';
-import type { EmbeddedPrefixMode } from '../decorators/Embedded.js';
 import type { EventSubscriber } from '../events/EventSubscriber.js';
 import type { AssignOptions } from '../entity/EntityAssigner.js';
 import type { EntityManagerType, IDatabaseDriver } from '../drivers/IDatabaseDriver.js';
 import { NotFoundError } from '../errors.js';
-import { DataloaderType, FlushMode, LoadStrategy, PopulateHint } from '../enums.js';
+import { DataloaderType, FlushMode, LoadStrategy, PopulateHint, type EmbeddedPrefixMode } from '../enums.js';
 import { MemoryCacheAdapter } from '../cache/MemoryCacheAdapter.js';
 import { EntityComparator } from './EntityComparator.js';
 import type { Type } from '../types/Type.js';
 import type { MikroORM } from '../MikroORM.js';
-export declare class Configuration<D extends IDatabaseDriver = IDatabaseDriver, EM extends EntityManager = D[typeof EntityManagerType] & EntityManager> {
-    static readonly DEFAULTS: {
-        pool: {};
-        entities: never[];
-        entitiesTs: never[];
-        extensions: never[];
-        subscribers: never[];
-        filters: {};
-        discovery: {
-            warnWhenNoEntities: true;
-            requireEntitiesArray: false;
-            checkDuplicateTableNames: true;
-            checkDuplicateFieldNames: true;
-            checkDuplicateEntities: true;
-            checkNonPersistentCompositeProps: true;
-            alwaysAnalyseProperties: true;
-            disableDynamicFileAccess: false;
-            inferDefaultValues: true;
-        };
-        strict: false;
-        validate: false;
-        validateRequired: true;
-        context: (name: string) => EntityManager<IDatabaseDriver<import("../index.js").Connection>> | undefined;
-        contextName: string;
-        allowGlobalContext: false;
-        logger: (message?: any, ...optionalParams: any[]) => void;
-        colors: true;
-        findOneOrFailHandler: (entityName: string, where: Dictionary | IPrimaryKey) => NotFoundError<Partial<any>>;
-        findExactlyOneOrFailHandler: (entityName: string, where: Dictionary | IPrimaryKey) => NotFoundError<Partial<any>>;
-        baseDir: string;
-        hydrator: typeof ObjectHydrator;
-        flushMode: FlushMode.AUTO;
-        loadStrategy: LoadStrategy.JOINED;
-        dataloader: DataloaderType.NONE;
-        populateWhere: PopulateHint.ALL;
-        connect: true;
-        ignoreUndefinedInQuery: false;
-        onQuery: (sql: string) => string;
-        autoJoinOneToOneOwner: true;
-        autoJoinRefsForFilters: true;
-        propagationOnPrototype: true;
-        populateAfterFlush: true;
-        serialization: {
-            includePrimaryKeys: true;
-        };
-        assign: {
-            updateNestedEntities: true;
-            updateByPrimaryKey: true;
-            mergeObjectProperties: false;
-            mergeEmbeddedProperties: true;
-            ignoreUndefined: false;
-        };
-        persistOnCreate: true;
-        upsertManaged: true;
-        forceEntityConstructor: false;
-        forceUndefined: false;
-        ensureDatabase: true;
-        ensureIndexes: false;
-        batchSize: number;
-        debug: false;
-        ignoreDeprecations: false;
-        verbose: false;
-        driverOptions: {};
-        migrations: {
-            tableName: string;
-            path: string;
-            glob: string;
-            silent: false;
-            transactional: true;
-            disableForeignKeys: false;
-            allOrNothing: true;
-            dropTables: true;
-            safe: false;
-            snapshot: true;
-            emit: "ts";
-            fileName: (timestamp: string, name?: string) => string;
-        };
-        schemaGenerator: {
-            disableForeignKeys: false;
-            createForeignKeyConstraints: true;
-            ignoreSchema: never[];
-        };
-        embeddables: {
-            prefixMode: "absolute";
-        };
-        entityGenerator: {
-            forceUndefined: true;
-            undefinedDefaults: false;
-            bidirectionalRelations: false;
-            identifiedReferences: false;
-            scalarTypeInDecorator: false;
-            scalarPropertiesForRelations: "never";
-            fileName: (className: string) => string;
-            onlyPurePivotTables: false;
-            outputPurePivotTables: false;
-            readOnlyPivotTables: false;
-            useCoreBaseEntity: false;
-        };
-        metadataCache: {
-            pretty: false;
-            adapter: typeof FileCacheAdapter;
-            options: {
-                cacheDir: string;
-            };
-        };
-        resultCache: {
-            adapter: typeof MemoryCacheAdapter;
-            expiration: number;
-            options: {};
-        };
-        metadataProvider: typeof ReflectMetadataProvider;
-        highlighter: NullHighlighter;
-        seeder: {
-            path: string;
-            defaultSeeder: string;
-            glob: string;
-            emit: "ts";
-            fileName: (className: string) => string;
+declare const DEFAULTS: {
+    readonly pool: {};
+    readonly entities: readonly [];
+    readonly entitiesTs: readonly [];
+    readonly extensions: readonly [];
+    readonly subscribers: readonly [];
+    readonly filters: {};
+    readonly discovery: {
+        readonly warnWhenNoEntities: true;
+        readonly checkDuplicateTableNames: true;
+        readonly checkDuplicateFieldNames: true;
+        readonly checkDuplicateEntities: true;
+        readonly checkNonPersistentCompositeProps: true;
+        readonly inferDefaultValues: true;
+    };
+    readonly strict: false;
+    readonly validate: false;
+    readonly validateRequired: true;
+    readonly context: (name: string) => EntityManager<IDatabaseDriver<import("../index.js").Connection>> | undefined;
+    readonly contextName: "default";
+    readonly allowGlobalContext: false;
+    readonly logger: (message?: any, ...optionalParams: any[]) => void;
+    readonly colors: true;
+    readonly findOneOrFailHandler: (entityName: string, where: Dictionary | IPrimaryKey) => NotFoundError<Partial<any>>;
+    readonly findExactlyOneOrFailHandler: (entityName: string, where: Dictionary | IPrimaryKey) => NotFoundError<Partial<any>>;
+    readonly baseDir: string;
+    readonly hydrator: typeof ObjectHydrator;
+    readonly flushMode: FlushMode.AUTO;
+    readonly loadStrategy: LoadStrategy.BALANCED;
+    readonly dataloader: DataloaderType.NONE;
+    readonly populateWhere: PopulateHint.ALL;
+    readonly ignoreUndefinedInQuery: false;
+    readonly onQuery: (sql: string) => string;
+    readonly autoJoinOneToOneOwner: true;
+    readonly autoJoinRefsForFilters: true;
+    readonly filtersOnRelations: true;
+    readonly propagationOnPrototype: true;
+    readonly populateAfterFlush: true;
+    readonly serialization: {
+        readonly includePrimaryKeys: true;
+    };
+    readonly assign: {
+        readonly updateNestedEntities: true;
+        readonly updateByPrimaryKey: true;
+        readonly mergeObjectProperties: false;
+        readonly mergeEmbeddedProperties: true;
+        readonly ignoreUndefined: false;
+    };
+    readonly persistOnCreate: true;
+    readonly upsertManaged: true;
+    readonly forceEntityConstructor: false;
+    readonly forceUndefined: false;
+    readonly processOnCreateHooksEarly: false;
+    readonly ensureDatabase: true;
+    readonly ensureIndexes: false;
+    readonly batchSize: 300;
+    readonly hashAlgorithm: "md5";
+    readonly debug: false;
+    readonly ignoreDeprecations: false;
+    readonly verbose: false;
+    readonly driverOptions: {};
+    readonly migrations: {
+        readonly tableName: "mikro_orm_migrations";
+        readonly path: "./migrations";
+        readonly glob: "!(*.d).{js,ts,cjs}";
+        readonly silent: false;
+        readonly transactional: true;
+        readonly disableForeignKeys: false;
+        readonly allOrNothing: true;
+        readonly dropTables: true;
+        readonly safe: false;
+        readonly snapshot: true;
+        readonly emit: "ts";
+        readonly fileName: (timestamp: string, name?: string) => string;
+    };
+    readonly schemaGenerator: {
+        readonly disableForeignKeys: false;
+        readonly createForeignKeyConstraints: true;
+        readonly ignoreSchema: readonly [];
+        readonly skipTables: readonly [];
+        readonly skipColumns: {};
+    };
+    readonly embeddables: {
+        readonly prefixMode: "relative";
+    };
+    readonly entityGenerator: {
+        readonly forceUndefined: true;
+        readonly undefinedDefaults: false;
+        readonly scalarTypeInDecorator: false;
+        readonly bidirectionalRelations: true;
+        readonly identifiedReferences: true;
+        readonly scalarPropertiesForRelations: "never";
+        readonly entityDefinition: "defineEntity";
+        readonly decorators: "legacy";
+        readonly enumMode: "dictionary";
+        readonly fileName: (className: string) => string;
+        readonly onlyPurePivotTables: false;
+        readonly outputPurePivotTables: false;
+        readonly readOnlyPivotTables: false;
+        readonly useCoreBaseEntity: false;
+    };
+    readonly metadataCache: {
+        readonly pretty: false;
+        readonly adapter: typeof FileCacheAdapter;
+        readonly options: {
+            readonly cacheDir: string;
         };
-        preferReadReplicas: true;
-        dynamicImportProvider: (id: string) => Promise<any>;
     };
+    readonly resultCache: {
+        readonly adapter: typeof MemoryCacheAdapter;
+        readonly expiration: 1000;
+        readonly options: {};
+    };
+    readonly metadataProvider: typeof MetadataProvider;
+    readonly highlighter: NullHighlighter;
+    readonly seeder: {
+        readonly path: "./seeders";
+        readonly defaultSeeder: "DatabaseSeeder";
+        readonly glob: "!(*.d).{js,ts}";
+        readonly emit: "ts";
+        readonly fileName: (className: string) => string;
+    };
+    readonly preferReadReplicas: true;
+    readonly dynamicImportProvider: (id: string) => Promise<any>;
+};
+export declare class Configuration<D extends IDatabaseDriver = IDatabaseDriver, EM extends EntityManager<D> = D[typeof EntityManagerType] & EntityManager<D>> {
     private readonly options;
     private readonly logger;
     private readonly driver;
@@ -155,25 +157,21 @@ export declare class Configuration<D extends IDatabaseDriver = IDatabaseDriver,
     /**
      * Gets specific configuration option. Falls back to specified `defaultValue` if provided.
      */
-    get<T extends keyof MikroORMOptions<D, EM>, U extends MikroORMOptions<D, EM>[T]>(key: T, defaultValue?: U): U;
-    getAll(): MikroORMOptions<D, EM>;
+    get<T extends keyof Options<D, EM>, U extends RequiredOptions<D, EM>[T]>(key: T, defaultValue?: U): U;
+    getAll(): RequiredOptions<D, EM>;
     /**
      * Overrides specified configuration value.
      */
-    set<T extends keyof MikroORMOptions<D, EM>, U extends MikroORMOptions<D, EM>[T]>(key: T, value: U): void;
+    set<T extends keyof Options<D, EM>, U extends RequiredOptions<D, EM>[T]>(key: T, value: U): void;
     /**
      * Resets the configuration to its default value
      */
-    reset<T extends keyof MikroORMOptions<D, EM>>(key: T): void;
+    reset<T extends keyof RequiredOptions<D, EM>>(key: T): void;
     /**
      * Gets Logger instance.
      */
     getLogger(): Logger;
     getDataloaderType(): DataloaderType;
-    /**
-     * Gets current client URL (connection string).
-     */
-    getClientUrl(hidePassword?: boolean): string;
     getSchema(skipDefaultSchema?: boolean): string | undefined;
     /**
      * Gets current database driver instance.
@@ -208,7 +206,7 @@ export declare class Configuration<D extends IDatabaseDriver = IDatabaseDriver,
     /**
      * Gets EntityRepository class to be instantiated.
      */
-    getRepositoryClass(repository: () => EntityClass<EntityRepository<AnyEntity>>): MikroORMOptions<D, EM>['entityRepository'];
+    getRepositoryClass(repository: () => EntityClass<EntityRepository<AnyEntity>>): Options<D, EM>['entityRepository'];
     /**
      * Creates instance of given service and caches it.
      */
@@ -232,7 +230,7 @@ export declare class Configuration<D extends IDatabaseDriver = IDatabaseDriver,
 /**
  * Type helper to make it easier to use `mikro-orm.config.js`.
  */
-export declare function defineConfig<D extends IDatabaseDriver>(options: Options<D>): Options<D, D[typeof EntityManagerType] & EntityManager<IDatabaseDriver<import("../index.js").Connection>>>;
+export declare function defineConfig<D extends IDatabaseDriver = IDatabaseDriver, EM extends EntityManager<D> = EntityManager<D>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]>(options: Options<D, EM, Entities>): Options<D, EM, Entities>;
 export interface ConnectionOptions {
     dbName?: string;
     schema?: string;
@@ -282,105 +280,111 @@ export interface PoolConfig {
 }
 export interface MetadataDiscoveryOptions {
     warnWhenNoEntities?: boolean;
-    requireEntitiesArray?: boolean;
     checkDuplicateTableNames?: boolean;
     checkDuplicateFieldNames?: boolean;
     checkDuplicateEntities?: boolean;
     checkNonPersistentCompositeProps?: boolean;
-    alwaysAnalyseProperties?: boolean;
-    disableDynamicFileAccess?: boolean;
     inferDefaultValues?: boolean;
     getMappedType?: (type: string, platform: Platform) => Type<unknown> | undefined;
     onMetadata?: (meta: EntityMetadata, platform: Platform) => MaybePromise<void>;
     afterDiscovered?: (storage: MetadataStorage, platform: Platform) => MaybePromise<void>;
     tsConfigPath?: string;
+    /** @internal */
+    skipSyncDiscovery?: boolean;
 }
-export interface MikroORMOptions<D extends IDatabaseDriver = IDatabaseDriver, EM extends EntityManager = EntityManager> extends ConnectionOptions {
-    entities: (string | EntityClass<AnyEntity> | EntityClassGroup<AnyEntity> | EntitySchema)[];
-    entitiesTs: (string | EntityClass<AnyEntity> | EntityClassGroup<AnyEntity> | EntitySchema)[];
-    extensions: {
+export interface Options<Driver extends IDatabaseDriver = IDatabaseDriver, EM extends EntityManager<Driver> & Driver[typeof EntityManagerType] = EntityManager<Driver> & Driver[typeof EntityManagerType], Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> extends ConnectionOptions {
+    entities?: Entities;
+    entitiesTs?: Entities;
+    extensions?: {
         register: (orm: MikroORM) => void;
     }[];
-    subscribers: (EventSubscriber | Constructor<EventSubscriber>)[];
-    filters: Dictionary<{
+    subscribers?: (EventSubscriber | Constructor<EventSubscriber>)[];
+    filters?: Dictionary<{
         name?: string;
     } & Omit<FilterDef, 'name'>>;
-    discovery: MetadataDiscoveryOptions;
+    discovery?: MetadataDiscoveryOptions;
     driver?: {
-        new (config: Configuration): D;
+        new (config: Configuration): Driver;
     };
     namingStrategy?: {
         new (): NamingStrategy;
     };
     implicitTransactions?: boolean;
     disableTransactions?: boolean;
-    connect: boolean;
-    verbose: boolean;
+    verbose?: boolean;
     ignoreUndefinedInQuery?: boolean;
-    onQuery: (sql: string, params: readonly unknown[]) => string;
-    autoJoinOneToOneOwner: boolean;
-    autoJoinRefsForFilters: boolean;
-    propagationOnPrototype: boolean;
-    populateAfterFlush: boolean;
-    serialization: {
+    onQuery?: (sql: string, params: readonly unknown[]) => string;
+    autoJoinOneToOneOwner?: boolean;
+    autoJoinRefsForFilters?: boolean;
+    filtersOnRelations?: boolean;
+    propagationOnPrototype?: boolean;
+    populateAfterFlush?: boolean;
+    serialization?: {
         includePrimaryKeys?: boolean;
         /** Enforce unpopulated references to be returned as objects, e.g. `{ author: { id: 1 } }` instead of `{ author: 1 }`. */
         forceObject?: boolean;
     };
-    assign: AssignOptions<boolean>;
-    persistOnCreate: boolean;
-    upsertManaged: boolean;
-    forceEntityConstructor: boolean | (Constructor<AnyEntity> | string)[];
-    forceUndefined: boolean;
+    assign?: AssignOptions<boolean>;
+    persistOnCreate?: boolean;
+    upsertManaged?: boolean;
+    forceEntityConstructor?: boolean | (Constructor<AnyEntity> | string)[];
+    forceUndefined?: boolean;
+    /**
+     * Property `onCreate` hooks are normally executed during `flush` operation.
+     * With this option, they will be processed early inside `em.create()` method.
+     */
+    processOnCreateHooksEarly?: boolean;
     forceUtcTimezone?: boolean;
     timezone?: string;
-    ensureDatabase: boolean | EnsureDatabaseOptions;
-    ensureIndexes: boolean;
+    ensureDatabase?: boolean | EnsureDatabaseOptions;
+    ensureIndexes?: boolean;
     useBatchInserts?: boolean;
     useBatchUpdates?: boolean;
-    batchSize: number;
-    hydrator: HydratorConstructor;
-    loadStrategy: LoadStrategy | 'select-in' | 'joined';
-    dataloader: DataloaderType | boolean;
+    batchSize?: number;
+    hydrator?: HydratorConstructor;
+    loadStrategy?: LoadStrategy | `${LoadStrategy}`;
+    dataloader?: DataloaderType | boolean;
     populateWhere?: PopulateHint | `${PopulateHint}`;
-    flushMode: FlushMode | 'commit' | 'auto' | 'always';
+    flushMode?: FlushMode | `${FlushMode}`;
     entityRepository?: EntityClass<EntityRepository<any>>;
     entityManager?: Constructor<EM>;
     replicas?: ConnectionOptions[];
-    strict: boolean;
-    validate: boolean;
-    validateRequired: boolean;
-    context: (name: string) => EntityManager | undefined;
-    contextName: string;
-    allowGlobalContext: boolean;
+    strict?: boolean;
+    validate?: boolean;
+    validateRequired?: boolean;
+    context?: (name: string) => EntityManager | undefined;
+    contextName?: string;
+    allowGlobalContext?: boolean;
     disableIdentityMap?: boolean;
-    logger: (message: string) => void;
+    logger?: (message: string) => void;
     colors?: boolean;
     loggerFactory?: (options: LoggerOptions) => Logger;
-    findOneOrFailHandler: (entityName: string, where: Dictionary | IPrimaryKey) => Error;
-    findExactlyOneOrFailHandler: (entityName: string, where: Dictionary | IPrimaryKey) => Error;
-    debug: boolean | LoggerNamespace[];
-    ignoreDeprecations: boolean | string[];
-    highlighter: Highlighter;
+    findOneOrFailHandler?: (entityName: string, where: Dictionary | IPrimaryKey) => Error;
+    findExactlyOneOrFailHandler?: (entityName: string, where: Dictionary | IPrimaryKey) => Error;
+    debug?: boolean | LoggerNamespace[];
+    ignoreDeprecations?: boolean | string[];
+    highlighter?: Highlighter;
     /**
      * Using this option, you can force the ORM to use the TS options regardless of whether the TypeScript support
      * is detected or not. This effectively means using `entitiesTs` for discovery and `pathTs` for migrations and
      * seeders. Should be used only for tests and stay disabled for production builds.
      */
     preferTs?: boolean;
-    baseDir: string;
-    migrations: MigrationsOptions;
-    schemaGenerator: {
+    baseDir?: string;
+    migrations?: MigrationsOptions;
+    schemaGenerator?: {
         disableForeignKeys?: boolean;
         createForeignKeyConstraints?: boolean;
         ignoreSchema?: string[];
+        skipTables?: (string | RegExp)[];
+        skipColumns?: Dictionary<(string | RegExp)[]>;
         managementDbName?: string;
     };
-    embeddables: {
+    embeddables?: {
         prefixMode: EmbeddedPrefixMode;
     };
-    entityGenerator: GenerateOptions;
-    metadataCache: {
+    entityGenerator?: GenerateOptions;
+    metadataCache?: {
         enabled?: boolean;
         combined?: boolean | string;
         pretty?: boolean;
@@ -389,7 +393,7 @@ export interface MikroORMOptions<D extends IDatabaseDriver = IDatabaseDriver, EM
         };
         options?: Dictionary;
     };
-    resultCache: {
+    resultCache?: {
         expiration?: number;
         adapter?: {
             new (...params: any[]): CacheAdapter;
@@ -397,11 +401,18 @@ export interface MikroORMOptions<D extends IDatabaseDriver = IDatabaseDriver, EM
         options?: Dictionary;
         global?: boolean | number | [string, number];
     };
-    metadataProvider: {
+    metadataProvider?: {
         new (config: Configuration): MetadataProvider;
     };
-    seeder: SeederOptions;
-    preferReadReplicas: boolean;
-    dynamicImportProvider: (id: string) => Promise<unknown>;
+    seeder?: SeederOptions;
+    preferReadReplicas?: boolean;
+    dynamicImportProvider?: (id: string) => Promise<unknown>;
+    hashAlgorithm?: 'md5' | 'sha256';
 }
-export type Options<D extends IDatabaseDriver = IDatabaseDriver, EM extends D[typeof EntityManagerType] & EntityManager = D[typeof EntityManagerType] & EntityManager> = Pick<MikroORMOptions<D, EM>, Exclude<keyof MikroORMOptions<D, EM>, keyof typeof Configuration.DEFAULTS>> & Partial<MikroORMOptions<D, EM>>;
+type MarkRequired<T, D> = {
+    [K in keyof T as Extract<K, keyof D>]-?: T[K];
+} & {
+    [K in keyof T as Exclude<K, keyof D>]?: T[K];
+};
+export type RequiredOptions<D extends IDatabaseDriver = IDatabaseDriver, EM extends EntityManager<D> = EntityManager<D>, Entities extends (string | EntityClass<AnyEntity> | EntitySchema)[] = (string | EntityClass<AnyEntity> | EntitySchema)[]> = MarkRequired<Options<D, EM, Entities>, typeof DEFAULTS>;
+export {};