@mikro-orm/decorators 7.0.2-dev.8 → 7.0.2

package/es/Embedded.js

@@ -1,14 +1,15 @@
-import { ReferenceKind, Utils, } from '@mikro-orm/core';
+import { ReferenceKind, Utils } from '@mikro-orm/core';
 import { prepareMetadataContext } from '../utils.js';
+/** Defines an embedded property on an entity (TC39 decorator). */
 export function Embedded(type = {}, options = {}) {
-    return function (value, context) {
-        const meta = prepareMetadataContext(context, ReferenceKind.EMBEDDED);
-        options = type instanceof Function ? { entity: type, ...options } : { ...type, ...options };
-        Utils.defaultValue(options, 'prefix', true);
-        meta.properties[context.name] = {
-            name: context.name,
-            kind: ReferenceKind.EMBEDDED,
-            ...options,
-        };
+  return function (value, context) {
+    const meta = prepareMetadataContext(context, ReferenceKind.EMBEDDED);
+    options = type instanceof Function ? { entity: type, ...options } : { ...type, ...options };
+    Utils.defaultValue(options, 'prefix', true);
+    meta.properties[context.name] = {
+      name: context.name,
+      kind: ReferenceKind.EMBEDDED,
+      ...options,
     };
+  };
 }

package/es/Entity.d.ts

@@ -1,2 +1,5 @@
 import { type Constructor, type EntityOptions, type EntityClass } from '@mikro-orm/core';
-export declare function Entity<Owner extends EntityClass<unknown> & Constructor>(options?: EntityOptions<Owner>): (target: Owner, context: ClassDecoratorContext<Owner>) => void;
+/** Marks a class as a MikroORM entity (TC39 decorator). */
+export declare function Entity<Owner extends EntityClass<unknown> & Constructor>(
+  options?: EntityOptions<Owner>,
+): (target: Owner, context: ClassDecoratorContext<Owner>) => void;

package/es/Entity.js

@@ -1,13 +1,14 @@
 import { Utils } from '@mikro-orm/core';
 import { getMetadataFromDecorator } from '../utils.js';
+/** Marks a class as a MikroORM entity (TC39 decorator). */
 export function Entity(options = {}) {
-    return function (target, context) {
-        const meta = getMetadataFromDecorator(target);
-        const metadata = { ...context.metadata };
-        Utils.mergeConfig(meta, metadata, options);
-        meta.class = target;
-        if (!options.abstract || meta.discriminatorColumn) {
-            meta.name = context.name;
-        }
-    };
+  return function (target, context) {
+    const meta = getMetadataFromDecorator(target);
+    const metadata = { ...context.metadata };
+    Utils.mergeConfig(meta, metadata, options);
+    meta.class = target;
+    if (!options.abstract || meta.discriminatorColumn) {
+      meta.name = context.name;
+    }
+  };
 }

package/es/Enum.d.ts

@@ -1,2 +1,5 @@
 import { type EnumOptions, type AnyEntity, type Dictionary } from '@mikro-orm/core';
-export declare function Enum<Owner extends object>(options?: EnumOptions<AnyEntity> | (() => Dictionary)): (target: unknown, context: ClassFieldDecoratorContext<Owner>) => void;
+/** Defines an enum property on an entity (TC39 decorator). */
+export declare function Enum<Owner extends object>(
+  options?: EnumOptions<AnyEntity> | (() => Dictionary),
+): (target: unknown, context: ClassFieldDecoratorContext<Owner>) => void;

package/es/Enum.js

@@ -1,14 +1,15 @@
-import { ReferenceKind, } from '@mikro-orm/core';
+import { ReferenceKind } from '@mikro-orm/core';
 import { prepareMetadataContext } from '../utils.js';
+/** Defines an enum property on an entity (TC39 decorator). */
 export function Enum(options = {}) {
-    return function (target, context) {
-        const meta = prepareMetadataContext(context);
-        options = options instanceof Function ? { items: options } : options;
-        meta.properties[context.name] = {
-            name: context.name,
-            kind: ReferenceKind.SCALAR,
-            enum: true,
-            ...options,
-        };
+  return function (target, context) {
+    const meta = prepareMetadataContext(context);
+    options = options instanceof Function ? { items: options } : options;
+    meta.properties[context.name] = {
+      name: context.name,
+      kind: ReferenceKind.SCALAR,
+      enum: true,
+      ...options,
     };
+  };
 }

package/es/Filter.d.ts

@@ -1,2 +1,3 @@
 import { type FilterDef, type EntityClass } from '@mikro-orm/core';
+/** Registers a named filter on an entity class (TC39 decorator). */
 export declare function Filter<T extends EntityClass<unknown>>(options: FilterDef<T>): (target: T) => void;

package/es/Filter.js

@@ -1,7 +1,8 @@
 import { getMetadataFromDecorator } from '../utils.js';
+/** Registers a named filter on an entity class (TC39 decorator). */
 export function Filter(options) {
-    return function (target) {
-        const meta = getMetadataFromDecorator(target);
-        meta.filters[options.name] = options;
-    };
+  return function (target) {
+    const meta = getMetadataFromDecorator(target);
+    meta.filters[options.name] = options;
+  };
 }

package/es/Formula.d.ts

@@ -1,2 +1,6 @@
 import { type FormulaCallback, type PropertyOptions } from '@mikro-orm/core';
-export declare function Formula<Owner extends object>(formula: string | FormulaCallback<Owner>, options?: PropertyOptions<Owner>): (value: unknown, context: ClassFieldDecoratorContext<Owner>) => void;
+/** Defines a computed SQL formula property on an entity (TC39 decorator). */
+export declare function Formula<Owner extends object>(
+  formula: string | FormulaCallback<Owner>,
+  options?: PropertyOptions<Owner>,
+): (value: unknown, context: ClassFieldDecoratorContext<Owner>) => void;

package/es/Formula.js

@@ -1,13 +1,14 @@
-import { ReferenceKind, } from '@mikro-orm/core';
+import { ReferenceKind } from '@mikro-orm/core';
 import { prepareMetadataContext } from '../utils.js';
+/** Defines a computed SQL formula property on an entity (TC39 decorator). */
 export function Formula(formula, options = {}) {
-    return function (value, context) {
-        const meta = prepareMetadataContext(context);
-        meta.properties[context.name] = {
-            name: context.name,
-            kind: ReferenceKind.SCALAR,
-            formula,
-            ...options,
-        };
+  return function (value, context) {
+    const meta = prepareMetadataContext(context);
+    meta.properties[context.name] = {
+      name: context.name,
+      kind: ReferenceKind.SCALAR,
+      formula,
+      ...options,
     };
+  };
 }

package/es/Indexed.d.ts

@@ -1,3 +1,9 @@
 import { type IndexOptions, type UniqueOptions, type Constructor } from '@mikro-orm/core';
-export declare function Index<T extends object, H extends string>(options?: IndexOptions<T, H>): (value: unknown, context: ClassDecoratorContext<T & Constructor> | ClassFieldDecoratorContext<T>) => any;
-export declare function Unique<T extends object, H extends string>(options?: UniqueOptions<T, H>): (value: unknown, context: ClassDecoratorContext<T & Constructor> | ClassFieldDecoratorContext<T>) => any;
+/** Defines a database index on a property or entity class (TC39 decorator). */
+export declare function Index<T extends object, H extends string>(
+  options?: IndexOptions<T, H>,
+): (value: unknown, context: ClassDecoratorContext<T & Constructor> | ClassFieldDecoratorContext<T>) => any;
+/** Defines a unique constraint on a property or entity class (TC39 decorator). */
+export declare function Unique<T extends object, H extends string>(
+  options?: UniqueOptions<T, H>,
+): (value: unknown, context: ClassDecoratorContext<T & Constructor> | ClassFieldDecoratorContext<T>) => any;

package/es/Indexed.js

@@ -1,17 +1,19 @@
 function createDecorator(options, unique) {
-    return function (value, context) {
-        const meta = context.metadata;
-        if (context.kind === 'field') {
-            options.properties ??= context.name;
-        }
-        const key = unique ? 'uniques' : 'indexes';
-        meta[key] ??= [];
-        meta[key].push(options);
-    };
+  return function (value, context) {
+    const meta = context.metadata;
+    if (context.kind === 'field') {
+      options.properties ??= context.name;
+    }
+    const key = unique ? 'uniques' : 'indexes';
+    meta[key] ??= [];
+    meta[key].push(options);
+  };
 }
+/** Defines a database index on a property or entity class (TC39 decorator). */
 export function Index(options = {}) {
-    return createDecorator(options, false);
+  return createDecorator(options, false);
 }
+/** Defines a unique constraint on a property or entity class (TC39 decorator). */
 export function Unique(options = {}) {
-    return createDecorator(options, true);
+  return createDecorator(options, true);
 }

package/es/ManyToMany.d.ts

@@ -1,2 +1,7 @@
 import { type EntityName, type ManyToManyOptions, type Collection } from '@mikro-orm/core';
-export declare function ManyToMany<Target extends object, Owner extends object>(entity?: ManyToManyOptions<Owner, Target> | string | (() => EntityName<Target>), mappedBy?: (string & keyof Target) | ((e: Target) => any), options?: Partial<ManyToManyOptions<Owner, Target>>): (_: unknown, context: ClassFieldDecoratorContext<Owner, Collection<Target> | undefined>) => void;
+/** Defines a many-to-many relationship (TC39 decorator). */
+export declare function ManyToMany<Target extends object, Owner extends object>(
+  entity?: ManyToManyOptions<Owner, Target> | string | (() => EntityName<Target>),
+  mappedBy?: (string & keyof Target) | ((e: Target) => any),
+  options?: Partial<ManyToManyOptions<Owner, Target>>,
+): (_: unknown, context: ClassFieldDecoratorContext<Owner, Collection<Target> | undefined>) => void;

package/es/ManyToMany.js

@@ -1,11 +1,12 @@
-import { ReferenceKind, Utils, } from '@mikro-orm/core';
+import { ReferenceKind, Utils } from '@mikro-orm/core';
 import { prepareMetadataContext, processDecoratorParameters } from '../utils.js';
+/** Defines a many-to-many relationship (TC39 decorator). */
 export function ManyToMany(entity, mappedBy, options = {}) {
-    return function (_, context) {
-        const meta = prepareMetadataContext(context, ReferenceKind.MANY_TO_MANY);
-        options = processDecoratorParameters({ entity, mappedBy, options });
-        const property = { name: context.name, kind: ReferenceKind.MANY_TO_MANY };
-        meta.properties[context.name] ??= {};
-        Utils.mergeConfig(meta.properties[context.name], property, options);
-    };
+  return function (_, context) {
+    const meta = prepareMetadataContext(context, ReferenceKind.MANY_TO_MANY);
+    options = processDecoratorParameters({ entity, mappedBy, options });
+    const property = { name: context.name, kind: ReferenceKind.MANY_TO_MANY };
+    meta.properties[context.name] ??= {};
+    Utils.mergeConfig(meta.properties[context.name], property, options);
+  };
 }

package/es/ManyToOne.d.ts

@@ -1,2 +1,6 @@
 import { type ManyToOneOptions, type EntityName, type Ref } from '@mikro-orm/core';
-export declare function ManyToOne<Target extends object, Owner extends object>(entity?: ManyToOneOptions<Owner, Target> | ((e?: Owner) => EntityName<Target> | EntityName[]), options?: Partial<ManyToOneOptions<Owner, Target>>): (_: unknown, context: ClassFieldDecoratorContext<Owner, Target | undefined | null | Ref<Target>>) => void;
+/** Defines a many-to-one relationship (TC39 decorator). */
+export declare function ManyToOne<Target extends object, Owner extends object>(
+  entity?: ManyToOneOptions<Owner, Target> | ((e?: Owner) => EntityName<Target> | EntityName[]),
+  options?: Partial<ManyToOneOptions<Owner, Target>>,
+): (_: unknown, context: ClassFieldDecoratorContext<Owner, Target | undefined | null | Ref<Target>>) => void;

package/es/ManyToOne.js

@@ -1,10 +1,11 @@
-import { ReferenceKind, Utils, } from '@mikro-orm/core';
+import { ReferenceKind, Utils } from '@mikro-orm/core';
 import { prepareMetadataContext, processDecoratorParameters } from '../utils.js';
+/** Defines a many-to-one relationship (TC39 decorator). */
 export function ManyToOne(entity = {}, options = {}) {
-    return function (_, context) {
-        const meta = prepareMetadataContext(context, ReferenceKind.MANY_TO_ONE);
-        options = processDecoratorParameters({ entity, options });
-        const property = { name: context.name, kind: ReferenceKind.MANY_TO_ONE };
-        meta.properties[context.name] = Utils.mergeConfig(meta.properties[context.name] ?? {}, property, options);
-    };
+  return function (_, context) {
+    const meta = prepareMetadataContext(context, ReferenceKind.MANY_TO_ONE);
+    options = processDecoratorParameters({ entity, options });
+    const property = { name: context.name, kind: ReferenceKind.MANY_TO_ONE };
+    meta.properties[context.name] = Utils.mergeConfig(meta.properties[context.name] ?? {}, property, options);
+  };
 }

package/es/OneToMany.d.ts

@@ -1,3 +1,10 @@
 import { type Collection, type EntityName, type OneToManyOptions } from '@mikro-orm/core';
-export declare function OneToMany<Target extends object, Owner extends object>(entity: string | ((e?: Owner) => EntityName<Target>), mappedBy: (string & keyof Target) | ((e: Target) => any), options?: Partial<OneToManyOptions<Owner, Target>>): (value: unknown, context: ClassFieldDecoratorContext<Owner, Collection<Target> | undefined>) => void;
-export declare function OneToMany<Target extends object, Owner extends object>(options: OneToManyOptions<Owner, Target>): (value: unknown, context: ClassFieldDecoratorContext<Owner, Collection<Target> | undefined>) => void;
+/** Defines a one-to-many relationship (TC39 decorator). */
+export declare function OneToMany<Target extends object, Owner extends object>(
+  entity: string | ((e?: Owner) => EntityName<Target>),
+  mappedBy: (string & keyof Target) | ((e: Target) => any),
+  options?: Partial<OneToManyOptions<Owner, Target>>,
+): (value: unknown, context: ClassFieldDecoratorContext<Owner, Collection<Target> | undefined>) => void;
+export declare function OneToMany<Target extends object, Owner extends object>(
+  options: OneToManyOptions<Owner, Target>,
+): (value: unknown, context: ClassFieldDecoratorContext<Owner, Collection<Target> | undefined>) => void;

package/es/OneToMany.js

@@ -1,11 +1,11 @@
-import { ReferenceKind, Utils, } from '@mikro-orm/core';
+import { ReferenceKind, Utils } from '@mikro-orm/core';
 import { prepareMetadataContext, processDecoratorParameters } from '../utils.js';
 export function OneToMany(entity, mappedBy, options = {}) {
-    return function (value, context) {
-        const meta = prepareMetadataContext(context, ReferenceKind.ONE_TO_MANY);
-        options = processDecoratorParameters({ entity, mappedBy, options });
-        const property = { name: context.name, kind: ReferenceKind.ONE_TO_MANY };
-        meta.properties[context.name] ??= {};
-        Utils.mergeConfig(meta.properties[context.name], property, options);
-    };
+  return function (value, context) {
+    const meta = prepareMetadataContext(context, ReferenceKind.ONE_TO_MANY);
+    options = processDecoratorParameters({ entity, mappedBy, options });
+    const property = { name: context.name, kind: ReferenceKind.ONE_TO_MANY };
+    meta.properties[context.name] ??= {};
+    Utils.mergeConfig(meta.properties[context.name], property, options);
+  };
 }

package/es/OneToOne.d.ts

@@ -1,2 +1,7 @@
 import { type EntityName, type OneToOneOptions, type Ref } from '@mikro-orm/core';
-export declare function OneToOne<Target extends object, Owner extends object>(entity?: OneToOneOptions<Owner, Target> | string | ((e: Owner) => EntityName<Target> | EntityName[]), mappedByOrOptions?: (string & keyof Target) | ((e: Target) => any) | Partial<OneToOneOptions<Owner, Target>>, options?: Partial<OneToOneOptions<Owner, Target>>): (_: unknown, context: ClassFieldDecoratorContext<Owner, Target | Ref<Target> | null | undefined>) => void;
+/** Defines a one-to-one relationship (TC39 decorator). */
+export declare function OneToOne<Target extends object, Owner extends object>(
+  entity?: OneToOneOptions<Owner, Target> | string | ((e: Owner) => EntityName<Target> | EntityName[]),
+  mappedByOrOptions?: (string & keyof Target) | ((e: Target) => any) | Partial<OneToOneOptions<Owner, Target>>,
+  options?: Partial<OneToOneOptions<Owner, Target>>,
+): (_: unknown, context: ClassFieldDecoratorContext<Owner, Target | Ref<Target> | null | undefined>) => void;

package/es/OneToOne.js

@@ -1,12 +1,13 @@
-import { ReferenceKind, } from '@mikro-orm/core';
+import { ReferenceKind } from '@mikro-orm/core';
 import { prepareMetadataContext, processDecoratorParameters } from '../utils.js';
+/** Defines a one-to-one relationship (TC39 decorator). */
 export function OneToOne(entity, mappedByOrOptions, options = {}) {
-    const mappedBy = typeof mappedByOrOptions === 'object' ? mappedByOrOptions.mappedBy : mappedByOrOptions;
-    options = typeof mappedByOrOptions === 'object' ? { ...mappedByOrOptions, ...options } : options;
-    return function (_, context) {
-        const meta = prepareMetadataContext(context, ReferenceKind.ONE_TO_ONE);
-        options = processDecoratorParameters({ entity, mappedBy, options });
-        const property = { name: context.name, kind: ReferenceKind.ONE_TO_ONE };
-        meta.properties[context.name] = Object.assign(meta.properties[context.name] ?? {}, property, options);
-    };
+  const mappedBy = typeof mappedByOrOptions === 'object' ? mappedByOrOptions.mappedBy : mappedByOrOptions;
+  options = typeof mappedByOrOptions === 'object' ? { ...mappedByOrOptions, ...options } : options;
+  return function (_, context) {
+    const meta = prepareMetadataContext(context, ReferenceKind.ONE_TO_ONE);
+    options = processDecoratorParameters({ entity, mappedBy, options });
+    const property = { name: context.name, kind: ReferenceKind.ONE_TO_ONE };
+    meta.properties[context.name] = Object.assign(meta.properties[context.name] ?? {}, property, options);
+  };
 }

package/es/PrimaryKey.d.ts

@@ -1,3 +1,9 @@
 import { type PrimaryKeyOptions, type SerializedPrimaryKeyOptions } from '@mikro-orm/core';
-export declare function PrimaryKey<T extends object>(options?: PrimaryKeyOptions<T>): (value: unknown, context: ClassFieldDecoratorContext<T>) => void;
-export declare function SerializedPrimaryKey<T extends object>(options?: SerializedPrimaryKeyOptions<T>): (value: unknown, context: ClassFieldDecoratorContext<T>) => void;
+/** Marks a property as the primary key of an entity (TC39 decorator). */
+export declare function PrimaryKey<T extends object>(
+  options?: PrimaryKeyOptions<T>,
+): (value: unknown, context: ClassFieldDecoratorContext<T>) => void;
+/** Marks a property as the serialized form of the primary key, e.g. for MongoDB ObjectId (TC39 decorator). */
+export declare function SerializedPrimaryKey<T extends object>(
+  options?: SerializedPrimaryKeyOptions<T>,
+): (value: unknown, context: ClassFieldDecoratorContext<T>) => void;

package/es/PrimaryKey.js

@@ -1,20 +1,22 @@
-import { ReferenceKind, } from '@mikro-orm/core';
+import { ReferenceKind } from '@mikro-orm/core';
 import { prepareMetadataContext } from '../utils.js';
 function createDecorator(options, serialized) {
-    return function (value, context) {
-        const meta = prepareMetadataContext(context, ReferenceKind.SCALAR);
-        const key = serialized ? 'serializedPrimaryKey' : 'primary';
-        options[key] = true;
-        meta.properties[context.name] = {
-            name: context.name,
-            kind: ReferenceKind.SCALAR,
-            ...options,
-        };
+  return function (value, context) {
+    const meta = prepareMetadataContext(context, ReferenceKind.SCALAR);
+    const key = serialized ? 'serializedPrimaryKey' : 'primary';
+    options[key] = true;
+    meta.properties[context.name] = {
+      name: context.name,
+      kind: ReferenceKind.SCALAR,
+      ...options,
     };
+  };
 }
+/** Marks a property as the primary key of an entity (TC39 decorator). */
 export function PrimaryKey(options = {}) {
-    return createDecorator(options, false);
+  return createDecorator(options, false);
 }
+/** Marks a property as the serialized form of the primary key, e.g. for MongoDB ObjectId (TC39 decorator). */
 export function SerializedPrimaryKey(options = {}) {
-    return createDecorator(options, true);
+  return createDecorator(options, true);
 }

package/es/Property.d.ts

@@ -1,2 +1,13 @@
 import { type PropertyOptions } from '@mikro-orm/core';
-export declare function Property<T extends object>(options?: PropertyOptions<T>): (value: unknown, context: ClassFieldDecoratorContext<T> | ClassGetterDecoratorContext<T> | ClassSetterDecoratorContext<T> | ClassAccessorDecoratorContext<T> | ClassMethodDecoratorContext<T>) => void;
+/** Defines a scalar property on an entity (TC39 decorator). */
+export declare function Property<T extends object>(
+  options?: PropertyOptions<T>,
+): (
+  value: unknown,
+  context:
+    | ClassFieldDecoratorContext<T>
+    | ClassGetterDecoratorContext<T>
+    | ClassSetterDecoratorContext<T>
+    | ClassAccessorDecoratorContext<T>
+    | ClassMethodDecoratorContext<T>,
+) => void;

package/es/Property.js

@@ -1,45 +1,42 @@
 import { ReferenceKind, Utils } from '@mikro-orm/core';
 import { prepareMetadataContext } from '../utils.js';
+/** Defines a scalar property on an entity (TC39 decorator). */
 export function Property(options = {}) {
-    return function (value, context) {
-        const meta = prepareMetadataContext(context, ReferenceKind.SCALAR);
-        const { check, ...opts } = options;
-        const prop = { kind: ReferenceKind.SCALAR, ...opts };
-        const name = options.name ?? context.name;
-        meta.checks ??= [];
-        if (context.name !== name) {
-            Utils.renameKey(options, 'name', 'fieldName');
-        }
-        if (context.kind === 'field') {
-            prop.name = context.name;
-            prop.getter = false;
-            prop.setter = false;
-        }
-        else if (context.kind === 'getter') {
-            prop.name = context.name;
-            prop.getter = true;
-            prop.setter = false;
-        }
-        else if (context.kind === 'setter') {
-            prop.name = context.name;
-            prop.getter = false;
-            prop.setter = true;
-        }
-        else if (context.kind === 'accessor') {
-            prop.name = context.name;
-            prop.getter = true;
-            prop.setter = true;
-        }
-        else if (context.kind === 'method') {
-            prop.getter = true;
-            prop.persist = false;
-            prop.type = 'method';
-            prop.getterName = context.name;
-            prop.name = name;
-        }
-        if (check) {
-            meta.checks.push({ property: prop.name, expression: check });
-        }
-        meta.properties[prop.name] = prop;
-    };
+  return function (value, context) {
+    const meta = prepareMetadataContext(context, ReferenceKind.SCALAR);
+    const { check, ...opts } = options;
+    const prop = { kind: ReferenceKind.SCALAR, ...opts };
+    const name = options.name ?? context.name;
+    meta.checks ??= [];
+    if (context.name !== name) {
+      Utils.renameKey(options, 'name', 'fieldName');
+    }
+    if (context.kind === 'field') {
+      prop.name = context.name;
+      prop.getter = false;
+      prop.setter = false;
+    } else if (context.kind === 'getter') {
+      prop.name = context.name;
+      prop.getter = true;
+      prop.setter = false;
+    } else if (context.kind === 'setter') {
+      prop.name = context.name;
+      prop.getter = false;
+      prop.setter = true;
+    } else if (context.kind === 'accessor') {
+      prop.name = context.name;
+      prop.getter = true;
+      prop.setter = true;
+    } else if (context.kind === 'method') {
+      prop.getter = true;
+      prop.persist = false;
+      prop.type = 'method';
+      prop.getterName = context.name;
+      prop.name = name;
+    }
+    if (check) {
+      meta.checks.push({ property: prop.name, expression: check });
+    }
+    meta.properties[prop.name] = prop;
+  };
 }

package/es/Transactional.d.ts

@@ -1,8 +1,8 @@
 import { type TransactionOptions } from '@mikro-orm/core';
 import { type ContextProvider } from '../utils.js';
 type TransactionalOptions<T> = TransactionOptions & {
-    context?: ContextProvider<T>;
-    contextName?: string;
+  context?: ContextProvider<T>;
+  contextName?: string;
 };
 /**
  * This decorator wraps the method with `em.transactional()`, so you can provide `TransactionOptions` just like with `em.transactional()`.
@@ -11,5 +11,10 @@ type TransactionalOptions<T> = TransactionOptions & {
  * It works on async functions and can be nested with `em.transactional()`.
  * Unlike `em.transactional()`, this decorator uses `REQUIRED` propagation by default, which means it will join existing transactions.
  */
-export declare function Transactional<Owner extends object, Value extends (this: Owner, ...args: any) => any = (this: Owner, ...args: any) => any>(options?: TransactionalOptions<Owner>): (value: Value, context: ClassMethodDecoratorContext<Owner, Value>) => (this: Owner, ...args: any) => Promise<any>;
+export declare function Transactional<
+  Owner extends object,
+  Value extends (this: Owner, ...args: any) => any = (this: Owner, ...args: any) => any,
+>(
+  options?: TransactionalOptions<Owner>,
+): (value: Value, context: ClassMethodDecoratorContext<Owner, Value>) => (this: Owner, ...args: any) => Promise<any>;
 export {};

package/es/Transactional.js

@@ -8,20 +8,23 @@ import { resolveContextProvider } from '../utils.js';
  * Unlike `em.transactional()`, this decorator uses `REQUIRED` propagation by default, which means it will join existing transactions.
  */
 export function Transactional(options = {}) {
-    return function (value, context) {
-        if (value.constructor.name !== 'AsyncFunction') {
-            throw new Error('@Transactional() should be use with async functions');
-        }
-        return async function (...args) {
-            const { context, contextName, ...txOptions } = options;
-            txOptions.propagation ??= TransactionPropagation.REQUIRED;
-            const em = (await resolveContextProvider(this, context)) ||
-                TransactionContext.getEntityManager(contextName) ||
-                RequestContext.getEntityManager(contextName);
-            if (!em) {
-                throw new Error(`@Transactional() decorator can only be applied to methods of classes with \`orm: MikroORM\` property, \`em: EntityManager\` property, or with a callback parameter like \`@Transactional(() => orm)\` that returns one of those types. The parameter will contain a reference to current \`this\`. Returning an EntityRepository from it is also supported.`);
-            }
-            return em.transactional(() => value.apply(this, args), txOptions);
-        };
+  return function (value, context) {
+    if (value.constructor.name !== 'AsyncFunction') {
+      throw new Error('@Transactional() should be use with async functions');
+    }
+    return async function (...args) {
+      const { context, contextName, ...txOptions } = options;
+      txOptions.propagation ??= TransactionPropagation.REQUIRED;
+      const em =
+        (await resolveContextProvider(this, context)) ||
+        TransactionContext.getEntityManager(contextName) ||
+        RequestContext.getEntityManager(contextName);
+      if (!em) {
+        throw new Error(
+          `@Transactional() decorator can only be applied to methods of classes with \`orm: MikroORM\` property, \`em: EntityManager\` property, or with a callback parameter like \`@Transactional(() => orm)\` that returns one of those types. The parameter will contain a reference to current \`this\`. Returning an EntityRepository from it is also supported.`,
+        );
+      }
+      return em.transactional(() => value.apply(this, args), txOptions);
     };
+  };
 }

package/es/hooks.d.ts

@@ -1,16 +1,48 @@
-export declare function BeforeCreate(): (value: (...args: any[]) => unknown, context: ClassMethodDecoratorContext) => void;
-export declare function AfterCreate(): (value: (...args: any[]) => unknown, context: ClassMethodDecoratorContext) => void;
-export declare function BeforeUpdate(): (value: (...args: any[]) => unknown, context: ClassMethodDecoratorContext) => void;
-export declare function AfterUpdate(): (value: (...args: any[]) => unknown, context: ClassMethodDecoratorContext) => void;
-export declare function BeforeUpsert(): (value: (...args: any[]) => unknown, context: ClassMethodDecoratorContext) => void;
-export declare function AfterUpsert(): (value: (...args: any[]) => unknown, context: ClassMethodDecoratorContext) => void;
+/** Called before a new entity is persisted to the database (TC39 decorator). */
+export declare function BeforeCreate(): (
+  value: (...args: any[]) => unknown,
+  context: ClassMethodDecoratorContext,
+) => void;
+/** Called after a new entity has been persisted to the database (TC39 decorator). */
+export declare function AfterCreate(): (
+  value: (...args: any[]) => unknown,
+  context: ClassMethodDecoratorContext,
+) => void;
+/** Called before an existing entity is updated in the database (TC39 decorator). */
+export declare function BeforeUpdate(): (
+  value: (...args: any[]) => unknown,
+  context: ClassMethodDecoratorContext,
+) => void;
+/** Called after an existing entity has been updated in the database (TC39 decorator). */
+export declare function AfterUpdate(): (
+  value: (...args: any[]) => unknown,
+  context: ClassMethodDecoratorContext,
+) => void;
+/** Called before an entity is upserted (TC39 decorator). */
+export declare function BeforeUpsert(): (
+  value: (...args: any[]) => unknown,
+  context: ClassMethodDecoratorContext,
+) => void;
+/** Called after an entity has been upserted (TC39 decorator). */
+export declare function AfterUpsert(): (
+  value: (...args: any[]) => unknown,
+  context: ClassMethodDecoratorContext,
+) => void;
+/** Called when an entity is instantiated by the EntityManager (TC39 decorator). */
 export declare function OnInit(): (value: (...args: any[]) => unknown, context: ClassMethodDecoratorContext) => void;
+/** Called after an entity is loaded from the database (TC39 decorator). */
 export declare function OnLoad(): (value: (...args: any[]) => unknown, context: ClassMethodDecoratorContext) => void;
 /**
  * Called before deleting entity, but only when providing initialized entity to EM#remove()
  */
-export declare function BeforeDelete(): (value: (...args: any[]) => unknown, context: ClassMethodDecoratorContext) => void;
+export declare function BeforeDelete(): (
+  value: (...args: any[]) => unknown,
+  context: ClassMethodDecoratorContext,
+) => void;
 /**
  * Called after deleting entity, but only when providing initialized entity to EM#remove()
  */
-export declare function AfterDelete(): (value: (...args: any[]) => unknown, context: ClassMethodDecoratorContext) => void;
+export declare function AfterDelete(): (
+  value: (...args: any[]) => unknown,
+  context: ClassMethodDecoratorContext,
+) => void;