@mikro-orm/core 7.0.0-rc.1 → 7.0.0-rc.3

package/entity/validators.js

@@ -52,7 +52,8 @@ export function validateParams(params, type = 'search condition', field) {
 }
 /** @internal */
 export function validatePrimaryKey(entity, meta) {
-    const pkExists = meta.primaryKeys.every(pk => entity[pk] != null) || (meta.serializedPrimaryKey && entity[meta.serializedPrimaryKey] != null);
+    const pkExists = meta.primaryKeys.every(pk => entity[pk] != null) ||
+        (meta.serializedPrimaryKey && entity[meta.serializedPrimaryKey] != null);
     if (!entity || !pkExists) {
         throw ValidationError.fromMergeWithoutPK(meta);
     }

package/enums.js

@@ -49,22 +49,8 @@ export var QueryOperator;
     QueryOperator["$hasKeys"] = "?&";
     QueryOperator["$hasSomeKeys"] = "?|";
 })(QueryOperator || (QueryOperator = {}));
-export const ARRAY_OPERATORS = [
-    '$eq',
-    '$gt',
-    '$gte',
-    '$lt',
-    '$lte',
-    '$ne',
-    '$overlap',
-    '$contains',
-    '$contained',
-];
-export const JSON_KEY_OPERATORS = [
-    '$hasKey',
-    '$hasKeys',
-    '$hasSomeKeys',
-];
+export const ARRAY_OPERATORS = ['$eq', '$gt', '$gte', '$lt', '$lte', '$ne', '$overlap', '$contains', '$contained'];
+export const JSON_KEY_OPERATORS = ['$hasKey', '$hasKeys', '$hasSomeKeys'];
 export var QueryOrder;
 (function (QueryOrder) {
     QueryOrder["ASC"] = "ASC";
@@ -100,7 +86,16 @@ export var QueryFlag;
     QueryFlag["IDENTITY_INSERT"] = "IDENTITY_INSERT";
     QueryFlag["OUTPUT_TABLE"] = "OUTPUT_TABLE";
 })(QueryFlag || (QueryFlag = {}));
-export const SCALAR_TYPES = new Set(['string', 'number', 'boolean', 'bigint', 'Uint8Array', 'Date', 'Buffer', 'RegExp']);
+export const SCALAR_TYPES = new Set([
+    'string',
+    'number',
+    'boolean',
+    'bigint',
+    'Uint8Array',
+    'Date',
+    'Buffer',
+    'RegExp',
+]);
 export var ReferenceKind;
 (function (ReferenceKind) {
     ReferenceKind["SCALAR"] = "scalar";

package/errors.js

@@ -34,12 +34,19 @@ export class ValidationError extends Error {
         return new ValidationError(`Entity ${entity.constructor.name} is not managed. An entity is managed if its fetched from the database or registered as new through EntityManager.persist()`);
     }
     static notEntity(owner, prop, data) {
-        const type = Object.prototype.toString.call(data).match(/\[object (\w+)]/)[1].toLowerCase();
+        const type = Object.prototype.toString
+            .call(data)
+            .match(/\[object (\w+)]/)[1]
+            .toLowerCase();
         return new ValidationError(`Entity of type ${prop.type} expected for property ${owner.constructor.name}.${prop.name}, ${inspect(data)} of type ${type} given. If you are using Object.assign(entity, data), use em.assign(entity, data) instead.`);
     }
     static notDiscoveredEntity(data, meta, action = 'persist') {
         /* v8 ignore next */
-        const type = meta?.className ?? Object.prototype.toString.call(data).match(/\[object (\w+)]/)[1].toLowerCase();
+        const type = meta?.className ??
+            Object.prototype.toString
+                .call(data)
+                .match(/\[object (\w+)]/)[1]
+                .toLowerCase();
         let err = `Trying to ${action} not discovered entity of type ${type}.`;
         if (meta) {
             err += ` Entity with this name was discovered, but not the prototype you are passing to the ORM. If using EntitySchema, be sure to point to the implementation via \`class\`.`;
@@ -56,7 +63,10 @@ export class ValidationError extends Error {
         return new ValidationError(`Invalid enum array items provided in ${entityName}: ${inspect(invalid)}`);
     }
     static invalidType(type, value, mode) {
-        const valueType = Object.prototype.toString.call(value).match(/\[object (\w+)]/)[1].toLowerCase();
+        const valueType = Object.prototype.toString
+            .call(value)
+            .match(/\[object (\w+)]/)[1]
+            .toLowerCase();
         if (value instanceof Date) {
             value = value.toISOString();
         }
@@ -69,8 +79,8 @@ export class ValidationError extends Error {
     static cannotModifyInverseCollection(owner, property) {
         const inverseCollection = `${owner.constructor.name}.${property.name}`;
         const ownerCollection = `${property.type}.${property.mappedBy}`;
-        const error = `You cannot modify inverse side of M:N collection ${inverseCollection} when the owning side is not initialized. `
-            + `Consider working with the owning side instead (${ownerCollection}).`;
+        const error = `You cannot modify inverse side of M:N collection ${inverseCollection} when the owning side is not initialized. ` +
+            `Consider working with the owning side instead (${ownerCollection}).`;
         return new ValidationError(error, owner);
     }
     static cannotModifyReadonlyCollection(owner, property) {
@@ -79,7 +89,7 @@ export class ValidationError extends Error {
     static cannotRemoveFromCollectionWithoutOrphanRemoval(owner, property) {
         const options = [
             ' - add `orphanRemoval: true` to the collection options',
-            ' - add `deleteRule: \'cascade\'` to the owning side options',
+            " - add `deleteRule: 'cascade'` to the owning side options",
             ' - add `nullable: true` to the owning side options',
         ].join('\n');
         return new ValidationError(`Removing items from collection ${owner.constructor.name}.${property.name} without \`orphanRemoval: true\` would break non-null constraint on the owning side. You have several options: \n${options}`, owner);
@@ -91,7 +101,7 @@ export class ValidationError extends Error {
         return new ValidationError('You cannot call em.flush() from inside lifecycle hook handlers');
     }
     static cannotUseGlobalContext() {
-        return new ValidationError('Using global EntityManager instance methods for context specific actions is disallowed. If you need to work with the global instance\'s identity map, use `allowGlobalContext` configuration option or `fork()` instead.');
+        return new ValidationError("Using global EntityManager instance methods for context specific actions is disallowed. If you need to work with the global instance's identity map, use `allowGlobalContext` configuration option or `fork()` instead.");
     }
     static cannotUseOperatorsInsideEmbeddables(entityName, propName, payload) {
         return new ValidationError(`Using operators inside embeddables is not allowed, move the operator above. (property: ${Utils.className(entityName)}.${propName}, payload: ${inspect(payload)})`);
@@ -164,7 +174,7 @@ export class MetadataError extends ValidationError {
         return new MetadataError(`Entity ${meta.className} has wrong ${type} definition: '${prop}' does not exist. You need to use property name, not column name.`);
     }
     static multipleVersionFields(meta, fields) {
-        return new MetadataError(`Entity ${meta.className} has multiple version properties defined: '${fields.join('\', \'')}'. Only one version property is allowed per entity.`);
+        return new MetadataError(`Entity ${meta.className} has multiple version properties defined: '${fields.join("', '")}'. Only one version property is allowed per entity.`);
     }
     static invalidVersionFieldType(meta) {
         const prop = meta.properties[meta.versionProperty];

package/events/EventManager.js

@@ -35,7 +35,7 @@ export class EventManager {
         const hooks = (meta?.hooks[event] || []);
         listeners.push(...hooks.map(hook => {
             const prototypeHook = meta?.prototype[hook];
-            const handler = typeof hook === 'function' ? hook : entity[hook] ?? prototypeHook;
+            const handler = typeof hook === 'function' ? hook : (entity[hook] ?? prototypeHook);
             return handler.bind(entity);
         }));
         for (const listener of this.listeners[event] ?? new Set()) {

package/exceptions.js

@@ -9,10 +9,15 @@ export class DriverException extends Error {
     errmsg;
     constructor(previous) {
         super(previous.message);
-        Object.getOwnPropertyNames(previous).forEach(k => this[k] = previous[k]);
+        Object.getOwnPropertyNames(previous).forEach(k => (this[k] = previous[k]));
         this.name = this.constructor.name;
         Error.captureStackTrace(this, this.constructor);
-        this.stack += '\n\n' + previous.stack.split('\n').filter(l => l.trim().startsWith('at ')).join('\n');
+        this.stack +=
+            '\n\n' +
+                previous
+                    .stack.split('\n')
+                    .filter(l => l.trim().startsWith('at '))
+                    .join('\n');
     }
 }
 /**

package/hydration/ObjectHydrator.js

@@ -66,7 +66,10 @@ export class ObjectHydrator extends Hydrator {
         const hydrateScalar = (prop, path, dataKey) => {
             const entityKey = path.map(k => this.wrap(k)).join('');
             const tz = this.platform.getTimezone();
-            const convertorKey = path.filter(k => !k.match(/\[idx_\d+]/)).map(k => this.safeKey(k)).join('_');
+            const convertorKey = path
+                .filter(k => !k.match(/\[idx_\d+]/))
+                .map(k => this.safeKey(k))
+                .join('_');
             const ret = [];
             const idx = this.tmpIndex++;
             const nullVal = this.config.get('forceUndefined') ? 'undefined' : 'null';
@@ -139,7 +142,9 @@ export class ObjectHydrator extends Hydrator {
             ret.push(`  if (data${dataKey} === null) {\n    entity${entityKey} = ${nullVal};`);
             ret.push(`  } else if (typeof data${dataKey} !== 'undefined') {`);
             // For polymorphic: instanceof check; for regular: isPrimaryKey() check
-            const pkCheck = prop.polymorphic ? `data${dataKey} instanceof PolymorphicRef` : `isPrimaryKey(data${dataKey}, true)`;
+            const pkCheck = prop.polymorphic
+                ? `data${dataKey} instanceof PolymorphicRef`
+                : `isPrimaryKey(data${dataKey}, true)`;
             ret.push(`    if (${pkCheck}) {`);
             // When targetKey is set, pass the key option to createReference so it uses the alternate key
             const keyOption = prop.targetKey ? `, key: '${prop.targetKey}'` : '';
@@ -232,7 +237,10 @@ export class ObjectHydrator extends Hydrator {
             return ret;
         };
         const registerEmbeddedPrototype = (prop, path) => {
-            const convertorKey = path.filter(k => !k.match(/\[idx_\d+]/)).map(k => this.safeKey(k)).join('_');
+            const convertorKey = path
+                .filter(k => !k.match(/\[idx_\d+]/))
+                .map(k => this.safeKey(k))
+                .join('_');
             if (prop.targetMeta?.polymorphs) {
                 prop.targetMeta.polymorphs.forEach(meta => {
                     context.set(`prototype_${convertorKey}_${meta.className}`, meta.prototype);
@@ -297,7 +305,9 @@ export class ObjectHydrator extends Hydrator {
                     meta.props
                         .filter(p => p.embedded?.[0] === prop.name)
                         .forEach(childProp => {
-                        const childDataKey = prop.object ? dataKey + this.wrap(childProp.embedded[1]) : this.wrap(childProp.name);
+                        const childDataKey = prop.object
+                            ? dataKey + this.wrap(childProp.embedded[1])
+                            : this.wrap(childProp.name);
                         const prop2 = childMeta.properties[childProp.embedded[1]];
                         const prop3 = {
                             ...prop2,
@@ -305,8 +315,9 @@ export class ObjectHydrator extends Hydrator {
                             embedded: childProp.embedded,
                             embeddedProps: childProp.embeddedProps,
                         };
-                        // eslint-disable-next-line @typescript-eslint/no-use-before-define
-                        ret.push(...hydrateProperty(prop3, childProp.object, [...path, childProp.embedded[1]], childDataKey).map(l => '    ' + l));
+                        ret.push(
+                        // eslint-disable-next-line @typescript-eslint/no-use-before-define, no-use-before-define
+                        ...hydrateProperty(prop3, childProp.object, [...path, childProp.embedded[1]], childDataKey).map(l => '    ' + l));
                     });
                     ret.push(`    }`);
                 });
@@ -321,8 +332,9 @@ export class ObjectHydrator extends Hydrator {
                     .filter(p => p.embedded?.[0] === prop.name)
                     .forEach(childProp => {
                     const childDataKey = prop.object ? dataKey + this.wrap(childProp.embedded[1]) : this.wrap(childProp.name);
-                    // eslint-disable-next-line @typescript-eslint/no-use-before-define
-                    ret.push(...hydrateProperty(childProp, prop.object, [...path, childProp.embedded[1]], childDataKey).map(l => '  ' + l));
+                    ret.push(
+                    // eslint-disable-next-line @typescript-eslint/no-use-before-define, no-use-before-define
+                    ...hydrateProperty(childProp, prop.object, [...path, childProp.embedded[1]], childDataKey).map(l => '  ' + l));
                 });
             }
             /* v8 ignore next */
@@ -353,7 +365,8 @@ export class ObjectHydrator extends Hydrator {
         };
         const hydrateProperty = (prop, object = prop.object, path = [prop.name], dataKey) => {
             const entityKey = path.map(k => this.wrap(k)).join('');
-            dataKey = dataKey ?? (object ? entityKey : this.wrap(normalizeAccessors ? (prop.accessor ?? prop.name) : prop.name));
+            dataKey =
+                dataKey ?? (object ? entityKey : this.wrap(normalizeAccessors ? (prop.accessor ?? prop.name) : prop.name));
             const ret = [];
             if ([ReferenceKind.MANY_TO_ONE, ReferenceKind.ONE_TO_ONE].includes(prop.kind) && !prop.mapToPk) {
                 ret.push(...hydrateToOne(prop, dataKey, entityKey));
@@ -372,7 +385,8 @@ export class ObjectHydrator extends Hydrator {
                     }
                 }
             }
-            else { // ReferenceKind.SCALAR
+            else {
+                // ReferenceKind.SCALAR
                 ret.push(...hydrateScalar(prop, path, dataKey));
             }
             if (this.config.get('forceUndefined')) {
@@ -383,9 +397,9 @@ export class ObjectHydrator extends Hydrator {
         for (const prop of props) {
             lines.push(...hydrateProperty(prop));
         }
-        const code = `// compiled hydrator for entity ${meta.className} (${type + normalizeAccessors ? ' normalized' : ''})\n`
-            + `return function(entity, data, factory, newEntity, convertCustomTypes, schema, parentSchema, normalizeAccessors) {\n`
-            + `${lines.join('\n')}\n}`;
+        const code = `// compiled hydrator for entity ${meta.className} (${type + normalizeAccessors ? ' normalized' : ''})\n` +
+            `return function(entity, data, factory, newEntity, convertCustomTypes, schema, parentSchema, normalizeAccessors) {\n` +
+            `${lines.join('\n')}\n}`;
         const fnKey = `hydrator-${meta.uniqueName}-${type}-${normalizeAccessors}`;
         const hydrator = Utils.createFunction(context, code, this.config.get('compiledFunctions'), fnKey);
         this.hydrators[key].set(meta.class, hydrator);

package/index.d.ts

@@ -2,8 +2,8 @@
  * @packageDocumentation
  * @module core
  */
-export { EntityMetadata, PrimaryKeyProp, EntityRepositoryType, OptionalProps, EagerProps, HiddenProps, Config } from './typings.js';
-export type { CompiledFunctions, Constructor, ConnectionType, Dictionary, Primary, IPrimaryKey, ObjectQuery, FilterQuery, IWrappedEntity, EntityName, EntityData, Highlighter, MaybePromise, AnyEntity, EntityClass, EntityProperty, PopulateOptions, Populate, Loaded, New, LoadedReference, LoadedCollection, IMigrator, IMigrationGenerator, MigratorEvent, GetRepository, MigrationObject, DeepPartial, PrimaryProperty, Cast, IsUnknown, EntityDictionary, EntityDTO, MigrationDiff, GenerateOptions, FilterObject, IEntityGenerator, ISeedManager, RequiredEntityData, CheckCallback, IndexCallback, FormulaCallback, FormulaTable, SchemaTable, SchemaColumns, SimpleColumnMeta, Rel, Ref, ScalarRef, EntityRef, ISchemaGenerator, UmzugMigration, MigrateOptions, MigrationResult, MigrationRow, EntityKey, EntityValue, EntityDataValue, FilterKey, EntityType, FromEntityType, Selected, IsSubset, EntityProps, ExpandProperty, ExpandScalar, FilterItemValue, ExpandQuery, Scalar, ExpandHint, FilterValue, MergeLoaded, MergeSelected, TypeConfig, AnyString, ClearDatabaseOptions, CreateSchemaOptions, EnsureDatabaseOptions, UpdateSchemaOptions, DropSchemaOptions, RefreshDatabaseOptions, AutoPath, UnboxArray, MetadataProcessor, ImportsResolver, RequiredNullable, DefineConfig, Opt, Hidden, EntitySchemaWithMeta, InferEntity, CheckConstraint, GeneratedColumnCallback, FilterDef, EntityCtor, Subquery, PopulateHintOptions, Prefixes, } from './typings.js';
+export { EntityMetadata, PrimaryKeyProp, EntityRepositoryType, OptionalProps, EagerProps, HiddenProps, Config, EntityName, } from './typings.js';
+export type { CompiledFunctions, Constructor, ConnectionType, Dictionary, Primary, IPrimaryKey, ObjectQuery, FilterQuery, IWrappedEntity, InferEntityName, EntityData, Highlighter, MaybePromise, AnyEntity, EntityClass, EntityProperty, PopulateOptions, Populate, Loaded, New, LoadedReference, LoadedCollection, IMigrator, IMigrationGenerator, MigratorEvent, GetRepository, MigrationObject, DeepPartial, PrimaryProperty, Cast, IsUnknown, EntityDictionary, EntityDTO, EntityDTOFlat, EntityDTOProp, SerializeDTO, MigrationDiff, GenerateOptions, FilterObject, IMigrationRunner, IEntityGenerator, ISeedManager, SeederObject, IMigratorStorage, RequiredEntityData, CheckCallback, IndexCallback, FormulaCallback, FormulaTable, SchemaTable, SchemaColumns, SimpleColumnMeta, Rel, Ref, ScalarRef, EntityRef, ISchemaGenerator, MigrationInfo, MigrateOptions, MigrationResult, MigrationRow, EntityKey, EntityValue, EntityDataValue, FilterKey, EntityType, FromEntityType, Selected, IsSubset, EntityProps, ExpandProperty, ExpandScalar, FilterItemValue, ExpandQuery, Scalar, ExpandHint, FilterValue, MergeLoaded, MergeSelected, TypeConfig, AnyString, ClearDatabaseOptions, CreateSchemaOptions, EnsureDatabaseOptions, UpdateSchemaOptions, DropSchemaOptions, RefreshDatabaseOptions, AutoPath, UnboxArray, MetadataProcessor, ImportsResolver, RequiredNullable, DefineConfig, Opt, Hidden, EntitySchemaWithMeta, InferEntity, CheckConstraint, GeneratedColumnCallback, FilterDef, EntityCtor, Subquery, PopulateHintOptions, Prefixes, } from './typings.js';
 export * from './enums.js';
 export * from './errors.js';
 export * from './exceptions.js';

package/index.js

@@ -2,7 +2,7 @@
  * @packageDocumentation
  * @module core
  */
-export { EntityMetadata, PrimaryKeyProp, EntityRepositoryType, OptionalProps, EagerProps, HiddenProps, Config } from './typings.js';
+export { EntityMetadata, PrimaryKeyProp, EntityRepositoryType, OptionalProps, EagerProps, HiddenProps, Config, EntityName, } from './typings.js';
 export * from './enums.js';
 export * from './errors.js';
 export * from './exceptions.js';

package/logging/DefaultLogger.js

@@ -29,9 +29,7 @@ export class DefaultLogger {
         if (context?.level === 'warning') {
             message = colors.yellow(message);
         }
-        const label = context?.label
-            ? colors.cyan(`(${context.label}) `)
-            : '';
+        const label = context?.label ? colors.cyan(`(${context.label}) `) : '';
         this.writer(colors.grey(`[${namespace}] `) + label + message);
     }
     /**
@@ -60,8 +58,8 @@ export class DefaultLogger {
         if (namespace === 'deprecated') {
             const { ignoreDeprecations = false } = this.options;
             return Array.isArray(ignoreDeprecations)
-                /* v8 ignore next */
-                ? !ignoreDeprecations.includes(context?.label ?? '')
+                ? /* v8 ignore next */
+                    !ignoreDeprecations.includes(context?.label ?? '')
                 : !ignoreDeprecations;
         }
         return !!debugMode && (!Array.isArray(debugMode) || debugMode.includes(namespace));

package/logging/colors.js

@@ -1,11 +1,8 @@
 import { getEnv } from '../utils/env-vars.js';
 const bool = (k) => ['true', 't', '1'].includes(getEnv(k)?.toLowerCase() ?? '');
-const boolIfDefined = (k) => getEnv(k) != null ? bool(k) : true;
-const enabled = () => !bool('NO_COLOR')
-    && !bool('MIKRO_ORM_NO_COLOR')
-    && boolIfDefined('FORCE_COLOR')
-    && boolIfDefined('MIKRO_ORM_COLORS');
-const wrap = (fn) => (text) => enabled() ? fn(text) : text;
+const boolIfDefined = (k) => (getEnv(k) != null ? bool(k) : true);
+const enabled = () => !bool('NO_COLOR') && !bool('MIKRO_ORM_NO_COLOR') && boolIfDefined('FORCE_COLOR') && boolIfDefined('MIKRO_ORM_COLORS');
+const wrap = (fn) => (text) => (enabled() ? fn(text) : text);
 /** @internal */
 export const colors = {
     red: wrap((text) => `\x1B[31m${text}\x1B[39m`),

package/metadata/EntitySchema.d.ts

@@ -1,6 +1,6 @@
 import { EntityMetadata, type AnyEntity, type EntityKey, type Constructor, type DeepPartial, type EntityName, type EntityProperty, type CleanKeys, type ExpandProperty, type IsNever, type EntityCtor } from '../typings.js';
 import { type EventType, ReferenceKind } from '../enums.js';
-import type { EventSubscriber } from '../events/EventSubscriber.js';
+import type { EventArgs } from '../events/EventSubscriber.js';
 import { Type } from '../types/Type.js';
 import type { PropertyOptions, ManyToOneOptions, OneToOneOptions, OneToManyOptions, ManyToManyOptions, EmbeddedOptions, EnumOptions, PrimaryKeyOptions, SerializedPrimaryKeyOptions, IndexOptions, UniqueOptions } from './types.js';
 type TypeType = string | NumberConstructor | StringConstructor | BooleanConstructor | DateConstructor | ArrayConstructor | Constructor<Type<any>> | Type<any>;
@@ -108,6 +108,6 @@ export declare class EntitySchema<Entity = any, Base = never, Class extends Enti
      * });
      * ```
      */
-    addHook<Event extends EventType | `${EventType}`>(event: Event, handler: NonNullable<EventSubscriber<Entity>[Event]>): this;
+    addHook<T extends Entity = Entity>(event: EventType | `${EventType}`, handler: (args: EventArgs<T>) => void | Promise<void>): this;
 }
 export {};

package/metadata/EntitySchema.js

@@ -34,7 +34,12 @@ export class EntitySchema {
     }
     addProperty(name, type, options = {}) {
         this.renameCompositeOptions(name, options);
-        const prop = { name, kind: ReferenceKind.SCALAR, ...options, ...this.normalizeType(options, type) };
+        const prop = {
+            name,
+            kind: ReferenceKind.SCALAR,
+            ...options,
+            ...this.normalizeType(options, type),
+        };
         if (type && Type.isMappedType(type.prototype)) {
             prop.type = type;
         }
@@ -299,7 +304,12 @@ export class EntitySchema {
             }
             else if (options.entity) {
                 const tmp = options.entity();
-                type = options.type = Array.isArray(tmp) ? tmp.map(t => Utils.className(t)).sort().join(' | ') : Utils.className(tmp);
+                type = options.type = Array.isArray(tmp)
+                    ? tmp
+                        .map(t => Utils.className(t))
+                        .sort()
+                        .join(' | ')
+                    : Utils.className(tmp);
                 const target = tmp instanceof EntitySchema ? tmp.meta.class : tmp;
                 return { type, target };
             }