@mikro-orm/decorators 7.0.2-dev.13 → 7.0.2-dev.15

package/es/Check.d.ts

@@ -1,2 +1,3 @@
 import { type CheckConstraint } from '@mikro-orm/core';
+/** Defines a database check constraint on a property (TC39 decorator). */
 export declare function Check<T>(options: CheckConstraint<T>): (value: unknown, context: ClassFieldDecoratorContext<T>) => void;

package/es/Check.js

@@ -1,3 +1,4 @@
+/** Defines a database check constraint on a property (TC39 decorator). */
 export function Check(options) {
     return function (value, context) {
         const meta = context.metadata;

package/es/CreateRequestContext.d.ts

@@ -1,3 +1,5 @@
 import { type ContextProvider } from '../utils.js';
+/** Wraps an async method in a new RequestContext, forking the EntityManager (TC39 decorator). */
 export declare function CreateRequestContext<T extends object>(contextProvider?: ContextProvider<T>, respectExistingContext?: boolean): (value: (this: T, ...args: any) => any, context: ClassMethodDecoratorContext<T>) => (this: T, ...args: any[]) => Promise<any>;
+/** Like `@CreateRequestContext`, but reuses an existing RequestContext if one is available (TC39 decorator). */
 export declare function EnsureRequestContext<T extends object>(context?: ContextProvider<T>): (value: (this: T, ...args: any) => any, context: ClassMethodDecoratorContext<T>) => (this: T, ...args: any[]) => Promise<any>;

package/es/CreateRequestContext.js

@@ -1,5 +1,6 @@
 import { RequestContext, TransactionContext } from '@mikro-orm/core';
 import { resolveContextProvider } from '../utils.js';
+/** Wraps an async method in a new RequestContext, forking the EntityManager (TC39 decorator). */
 export function CreateRequestContext(contextProvider, respectExistingContext = false) {
     return function (value, context) {
         const name = respectExistingContext ? 'EnsureRequestContext' : 'CreateRequestContext';
@@ -24,6 +25,7 @@ export function CreateRequestContext(contextProvider, respectExistingContext = f
         };
     };
 }
+/** Like `@CreateRequestContext`, but reuses an existing RequestContext if one is available (TC39 decorator). */
 export function EnsureRequestContext(context) {
     return CreateRequestContext(context, true);
 }

package/es/Embeddable.d.ts

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

package/es/Embeddable.js

@@ -1,5 +1,6 @@
 import { Utils } from '@mikro-orm/core';
 import { getMetadataFromDecorator } from '../utils.js';
+/** Marks a class as an embeddable type (TC39 decorator). */
 export function Embeddable(options = {}) {
     return function (target, context) {
         const meta = getMetadataFromDecorator(target);

package/es/Embedded.d.ts

@@ -1,2 +1,3 @@
 import { type EntityName, type EmbeddedOptions } from '@mikro-orm/core';
+/** Defines an embedded property on an entity (TC39 decorator). */
 export declare function Embedded<Owner extends object, Target>(type?: EmbeddedOptions<Owner, Target> | (() => EntityName<Target> | EntityName[]), options?: EmbeddedOptions<Owner, Target>): (value: unknown, context: ClassFieldDecoratorContext<Owner>) => void;

package/es/Embedded.js

@@ -1,5 +1,6 @@
 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);

package/es/Entity.d.ts

@@ -1,2 +1,3 @@
 import { type Constructor, type EntityOptions, type EntityClass } from '@mikro-orm/core';
+/** 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,5 +1,6 @@
 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);

package/es/Enum.d.ts

@@ -1,2 +1,3 @@
 import { type EnumOptions, type AnyEntity, type Dictionary } from '@mikro-orm/core';
+/** 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,5 +1,6 @@
 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);

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,4 +1,5 @@
 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);

package/es/Formula.d.ts

@@ -1,2 +1,3 @@
 import { type FormulaCallback, type PropertyOptions } from '@mikro-orm/core';
+/** 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,5 +1,6 @@
 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);

package/es/Indexed.d.ts

@@ -1,3 +1,5 @@
 import { type IndexOptions, type UniqueOptions, type Constructor } from '@mikro-orm/core';
+/** 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

@@ -9,9 +9,11 @@ function createDecorator(options, unique) {
         meta[key].push(options);
     };
 }
+/** Defines a database index on a property or entity class (TC39 decorator). */
 export function Index(options = {}) {
     return createDecorator(options, false);
 }
+/** Defines a unique constraint on a property or entity class (TC39 decorator). */
 export function Unique(options = {}) {
     return createDecorator(options, true);
 }

package/es/ManyToMany.d.ts

@@ -1,2 +1,3 @@
 import { type EntityName, type ManyToManyOptions, type Collection } from '@mikro-orm/core';
+/** 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,5 +1,6 @@
 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);

package/es/ManyToOne.d.ts

@@ -1,2 +1,3 @@
 import { type ManyToOneOptions, type EntityName, type Ref } from '@mikro-orm/core';
+/** 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,5 +1,6 @@
 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);

package/es/OneToMany.d.ts

@@ -1,3 +1,4 @@
 import { type Collection, type EntityName, type OneToManyOptions } from '@mikro-orm/core';
+/** 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/OneToOne.d.ts

@@ -1,2 +1,3 @@
 import { type EntityName, type OneToOneOptions, type Ref } from '@mikro-orm/core';
+/** 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,5 +1,6 @@
 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;

package/es/PrimaryKey.d.ts

@@ -1,3 +1,5 @@
 import { type PrimaryKeyOptions, type SerializedPrimaryKeyOptions } from '@mikro-orm/core';
+/** 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

@@ -12,9 +12,11 @@ function createDecorator(options, serialized) {
         };
     };
 }
+/** Marks a property as the primary key of an entity (TC39 decorator). */
 export function PrimaryKey(options = {}) {
     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);
 }

package/es/Property.d.ts

@@ -1,2 +1,3 @@
 import { type PropertyOptions } from '@mikro-orm/core';
+/** 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,5 +1,6 @@
 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);

package/es/hooks.d.ts

@@ -1,10 +1,18 @@
+/** 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()

package/es/hooks.js

@@ -7,27 +7,35 @@ function hook(type) {
         meta.hooks[type].push(value);
     };
 }
+/** Called before a new entity is persisted to the database (TC39 decorator). */
 export function BeforeCreate() {
     return hook(EventType.beforeCreate);
 }
+/** Called after a new entity has been persisted to the database (TC39 decorator). */
 export function AfterCreate() {
     return hook(EventType.afterCreate);
 }
+/** Called before an existing entity is updated in the database (TC39 decorator). */
 export function BeforeUpdate() {
     return hook(EventType.beforeUpdate);
 }
+/** Called after an existing entity has been updated in the database (TC39 decorator). */
 export function AfterUpdate() {
     return hook(EventType.afterUpdate);
 }
+/** Called before an entity is upserted (TC39 decorator). */
 export function BeforeUpsert() {
     return hook(EventType.beforeUpsert);
 }
+/** Called after an entity has been upserted (TC39 decorator). */
 export function AfterUpsert() {
     return hook(EventType.afterUpsert);
 }
+/** Called when an entity is instantiated by the EntityManager (TC39 decorator). */
 export function OnInit() {
     return hook(EventType.onInit);
 }
+/** Called after an entity is loaded from the database (TC39 decorator). */
 export function OnLoad() {
     return hook(EventType.onLoad);
 }

package/legacy/Check.d.ts

@@ -1,2 +1,3 @@
 import { type CheckConstraint, type EntityClass } from '@mikro-orm/core';
+/** Defines a database check constraint on a property or entity class (legacy TypeScript decorator). */
 export declare function Check<T>(options: CheckConstraint<T>): (target: T, propertyName?: T extends EntityClass<unknown> ? undefined : keyof T) => any;

package/legacy/Check.js

@@ -1,4 +1,5 @@
 import { getMetadataFromDecorator } from '../utils.js';
+/** Defines a database check constraint on a property or entity class (legacy TypeScript decorator). */
 export function Check(options) {
     return function (target, propertyName) {
         const meta = getMetadataFromDecorator((propertyName ? target.constructor : target));

package/legacy/CreateRequestContext.d.ts

@@ -1,3 +1,5 @@
 import { type ContextProvider } from '../utils.js';
+/** Wraps an async method in a new RequestContext, forking the EntityManager (legacy TypeScript decorator). */
 export declare function CreateRequestContext<T extends object>(context?: ContextProvider<T>, respectExistingContext?: boolean): MethodDecorator;
+/** Like `@CreateRequestContext`, but reuses an existing RequestContext if one is available (legacy TypeScript decorator). */
 export declare function EnsureRequestContext<T extends object>(context?: ContextProvider<T>): MethodDecorator;

package/legacy/CreateRequestContext.js

@@ -1,5 +1,6 @@
 import { RequestContext, TransactionContext } from '@mikro-orm/core';
 import { resolveContextProvider } from '../utils.js';
+/** Wraps an async method in a new RequestContext, forking the EntityManager (legacy TypeScript decorator). */
 export function CreateRequestContext(context, respectExistingContext = false) {
     return function (target, propertyKey, descriptor) {
         const originalMethod = descriptor.value;
@@ -26,6 +27,7 @@ export function CreateRequestContext(context, respectExistingContext = false) {
         return descriptor;
     };
 }
+/** Like `@CreateRequestContext`, but reuses an existing RequestContext if one is available (legacy TypeScript decorator). */
 export function EnsureRequestContext(context) {
     return CreateRequestContext(context, true);
 }

package/legacy/Embeddable.d.ts

@@ -1,2 +1,3 @@
 import { type EmbeddableOptions } from '@mikro-orm/core';
+/** Marks a class as an embeddable type (legacy TypeScript decorator). */
 export declare function Embeddable<T>(options?: EmbeddableOptions<T>): (target: T) => T;

package/legacy/Embeddable.js

@@ -1,4 +1,5 @@
 import { getMetadataFromDecorator } from '../utils.js';
+/** Marks a class as an embeddable type (legacy TypeScript decorator). */
 export function Embeddable(options = {}) {
     return function (target) {
         const meta = getMetadataFromDecorator(target);

package/legacy/Embedded.d.ts

@@ -1,2 +1,3 @@
 import { type AnyEntity, type EntityName, type EmbeddedOptions } from '@mikro-orm/core';
+/** Defines an embedded property on an entity (legacy TypeScript decorator). */
 export declare function Embedded<Owner extends object, Target>(type?: EmbeddedOptions<Owner, Target> | (() => EntityName<Target> | EntityName[]), options?: EmbeddedOptions<Owner, Target>): (target: AnyEntity, propertyName: string) => void;

package/legacy/Embedded.js

@@ -1,5 +1,6 @@
 import { ReferenceKind, Utils, } from '@mikro-orm/core';
 import { validateSingleDecorator, getMetadataFromDecorator } from '../utils.js';
+/** Defines an embedded property on an entity (legacy TypeScript decorator). */
 export function Embedded(type = {}, options = {}) {
     return function (target, propertyName) {
         const meta = getMetadataFromDecorator(target.constructor);

package/legacy/Entity.d.ts

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

package/legacy/Entity.js

@@ -1,5 +1,6 @@
 import { Utils } from '@mikro-orm/core';
 import { getMetadataFromDecorator } from '../utils.js';
+/** Marks a class as a MikroORM entity (legacy TypeScript decorator). */
 export function Entity(options = {}) {
     return function (target) {
         const meta = getMetadataFromDecorator(target);

package/legacy/Enum.d.ts

@@ -1,2 +1,3 @@
 import { type EnumOptions, type AnyEntity, type Dictionary } from '@mikro-orm/core';
+/** Defines an enum property on an entity (legacy TypeScript decorator). */
 export declare function Enum<T extends object>(options?: EnumOptions<AnyEntity> | (() => Dictionary)): (target: T, propertyName: string) => void;

package/legacy/Enum.js

@@ -1,5 +1,6 @@
 import { ReferenceKind, } from '@mikro-orm/core';
 import { getMetadataFromDecorator } from '../utils.js';
+/** Defines an enum property on an entity (legacy TypeScript decorator). */
 export function Enum(options = {}) {
     return function (target, propertyName) {
         const meta = getMetadataFromDecorator(target.constructor);

package/legacy/Filter.d.ts

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

package/legacy/Filter.js

@@ -1,4 +1,5 @@
 import { getMetadataFromDecorator } from '../utils.js';
+/** Registers a named filter on an entity class (legacy TypeScript decorator). */
 export function Filter(options) {
     return function (target) {
         const meta = getMetadataFromDecorator(target);

package/legacy/Formula.d.ts

@@ -1,2 +1,3 @@
 import { type FormulaCallback, type PropertyOptions } from '@mikro-orm/core';
+/** Defines a computed SQL formula property on an entity (legacy TypeScript decorator). */
 export declare function Formula<T extends object>(formula: string | FormulaCallback<T>, options?: PropertyOptions<T>): (target: T, propertyName: string) => void;

package/legacy/Formula.js

@@ -1,5 +1,6 @@
 import { ReferenceKind, } from '@mikro-orm/core';
 import { getMetadataFromDecorator } from '../utils.js';
+/** Defines a computed SQL formula property on an entity (legacy TypeScript decorator). */
 export function Formula(formula, options = {}) {
     return function (target, propertyName) {
         const meta = getMetadataFromDecorator(target.constructor);

package/legacy/Indexed.d.ts

@@ -1,3 +1,5 @@
 import { type EntityClass, type IndexOptions, type UniqueOptions } from '@mikro-orm/core';
+/** Defines a database index on a property or entity class (legacy TypeScript decorator). */
 export declare function Index<T extends object, H extends string>(options?: IndexOptions<T, H>): (target: T, propertyName?: T extends EntityClass<unknown> ? undefined : keyof T) => any;
+/** Defines a unique constraint on a property or entity class (legacy TypeScript decorator). */
 export declare function Unique<T extends object, H extends string>(options?: UniqueOptions<T, H>): (target: T, propertyName?: T extends EntityClass<unknown> ? undefined : keyof T) => any;

package/legacy/Indexed.js

@@ -11,9 +11,11 @@ function createDecorator(options, unique) {
         return undefined;
     };
 }
+/** Defines a database index on a property or entity class (legacy TypeScript decorator). */
 export function Index(options = {}) {
     return createDecorator(options, false);
 }
+/** Defines a unique constraint on a property or entity class (legacy TypeScript decorator). */
 export function Unique(options = {}) {
     return createDecorator(options, true);
 }

package/legacy/ManyToMany.d.ts

@@ -1,4 +1,5 @@
 import { type EntityName, type ManyToManyOptions } from '@mikro-orm/core';
+/** Defines a many-to-many relationship (legacy TypeScript decorator). */
 export declare function ManyToMany<Target extends object, Owner extends object>(entity: () => EntityName<Target>, mappedBy?: (string & keyof Target) | ((e: Target) => any), options?: Partial<ManyToManyOptions<Owner, Target>>): (target: Owner, propertyName: keyof Owner) => void;
 export declare function ManyToMany<Target extends object, Owner extends object>(entity: string, options?: any): never;
 export declare function ManyToMany<Target extends object, Owner extends object>(options?: ManyToManyOptions<Owner, Target>): (target: Owner, propertyName: keyof Owner) => void;

package/legacy/ManyToOne.d.ts

@@ -1,4 +1,5 @@
 import { type ManyToOneOptions, type EntityName } from '@mikro-orm/core';
+/** Defines a many-to-one relationship (legacy TypeScript decorator). */
 export declare function ManyToOne<Target extends object, Owner extends object>(entity: (e?: any) => EntityName<Target> | EntityName[], options?: Partial<ManyToOneOptions<Owner, Target>>): (target: Owner, propertyName: string) => void;
 export declare function ManyToOne<Target extends object, Owner extends object>(entity: string, options?: any): never;
 export declare function ManyToOne<Target extends object, Owner extends object>(options?: ManyToOneOptions<Owner, Target>): (target: Owner, propertyName: string) => void;

package/legacy/OneToMany.d.ts

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

package/legacy/OneToOne.d.ts

@@ -1,3 +1,4 @@
 import { type EntityName, type OneToOneOptions } from '@mikro-orm/core';
+/** Defines a one-to-one relationship (legacy TypeScript decorator). */
 export declare function OneToOne<Target, Owner>(entity: (e: Owner) => EntityName<Target> | EntityName[], mappedByOrOptions?: (string & keyof Target) | ((e: Target) => any) | Partial<OneToOneOptions<Owner, Target>>, options?: Partial<OneToOneOptions<Owner, Target>>): (target: Owner, propertyName: string) => void;
 export declare function OneToOne<Target, Owner>(entity?: OneToOneOptions<Owner, Target>): (target: Owner, propertyName: string) => void;

package/legacy/PrimaryKey.d.ts

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

package/legacy/PrimaryKey.js

@@ -13,9 +13,11 @@ function createDecorator(options, serialized) {
         };
     };
 }
+/** Marks a property as the primary key of an entity (legacy TypeScript decorator). */
 export function PrimaryKey(options = {}) {
     return createDecorator(options, false);
 }
+/** Marks a property as the serialized form of the primary key, e.g. for MongoDB ObjectId (legacy TypeScript decorator). */
 export function SerializedPrimaryKey(options = {}) {
     return createDecorator(options, true);
 }

package/legacy/Property.d.ts

@@ -1,2 +1,3 @@
 import { type PropertyOptions } from '@mikro-orm/core';
+/** Defines a scalar property on an entity (legacy TypeScript decorator). */
 export declare function Property<T extends object>(options?: PropertyOptions<T>): (target: T, propertyName: string) => void;

package/legacy/Property.js

@@ -1,5 +1,6 @@
 import { Utils, ReferenceKind } from '@mikro-orm/core';
 import { validateSingleDecorator, getMetadataFromDecorator } from '../utils.js';
+/** Defines a scalar property on an entity (legacy TypeScript decorator). */
 export function Property(options = {}) {
     return function (target, propertyName) {
         const meta = getMetadataFromDecorator(target.constructor);

package/legacy/ReflectMetadataProvider.d.ts

@@ -1,5 +1,6 @@
 import 'reflect-metadata';
 import { type EntityMetadata, type EntityProperty, MetadataProvider } from '@mikro-orm/core';
+/** Metadata provider that uses `reflect-metadata` to infer property types from TypeScript's emitted design:type metadata. */
 export declare class ReflectMetadataProvider extends MetadataProvider {
     loadEntityMetadata(meta: EntityMetadata): void;
     protected initPropertyType(meta: EntityMetadata, prop: EntityProperty): void;

package/legacy/ReflectMetadataProvider.js

@@ -1,5 +1,6 @@
 import 'reflect-metadata';
 import { EntitySchema, MetadataProvider, ReferenceKind, Utils, } from '@mikro-orm/core';
+/** Metadata provider that uses `reflect-metadata` to infer property types from TypeScript's emitted design:type metadata. */
 export class ReflectMetadataProvider extends MetadataProvider {
     loadEntityMetadata(meta) {
         // load types and column names

package/legacy/hooks.d.ts

@@ -1,10 +1,18 @@
+/** Called before a new entity is persisted to the database (legacy TypeScript decorator). */
 export declare function BeforeCreate(): (target: any, method: string) => void;
+/** Called after a new entity has been persisted to the database (legacy TypeScript decorator). */
 export declare function AfterCreate(): (target: any, method: string) => void;
+/** Called before an existing entity is updated in the database (legacy TypeScript decorator). */
 export declare function BeforeUpdate(): (target: any, method: string) => void;
+/** Called after an existing entity has been updated in the database (legacy TypeScript decorator). */
 export declare function AfterUpdate(): (target: any, method: string) => void;
+/** Called before an entity is upserted (legacy TypeScript decorator). */
 export declare function BeforeUpsert(): (target: any, method: string) => void;
+/** Called after an entity has been upserted (legacy TypeScript decorator). */
 export declare function AfterUpsert(): (target: any, method: string) => void;
+/** Called when an entity is instantiated by the EntityManager (legacy TypeScript decorator). */
 export declare function OnInit(): (target: any, method: string) => void;
+/** Called after an entity is loaded from the database (legacy TypeScript decorator). */
 export declare function OnLoad(): (target: any, method: string) => void;
 /**
  * Called before deleting entity, but only when providing initialized entity to EM#remove()

package/legacy/hooks.js

@@ -7,27 +7,35 @@ function hook(type) {
         meta.hooks[type].push(method);
     };
 }
+/** Called before a new entity is persisted to the database (legacy TypeScript decorator). */
 export function BeforeCreate() {
     return hook(EventType.beforeCreate);
 }
+/** Called after a new entity has been persisted to the database (legacy TypeScript decorator). */
 export function AfterCreate() {
     return hook(EventType.afterCreate);
 }
+/** Called before an existing entity is updated in the database (legacy TypeScript decorator). */
 export function BeforeUpdate() {
     return hook(EventType.beforeUpdate);
 }
+/** Called after an existing entity has been updated in the database (legacy TypeScript decorator). */
 export function AfterUpdate() {
     return hook(EventType.afterUpdate);
 }
+/** Called before an entity is upserted (legacy TypeScript decorator). */
 export function BeforeUpsert() {
     return hook(EventType.beforeUpsert);
 }
+/** Called after an entity has been upserted (legacy TypeScript decorator). */
 export function AfterUpsert() {
     return hook(EventType.afterUpsert);
 }
+/** Called when an entity is instantiated by the EntityManager (legacy TypeScript decorator). */
 export function OnInit() {
     return hook(EventType.onInit);
 }
+/** Called after an entity is loaded from the database (legacy TypeScript decorator). */
 export function OnLoad() {
     return hook(EventType.onLoad);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mikro-orm/decorators",
-  "version": "7.0.2-dev.13",
+  "version": "7.0.2-dev.15",
   "description": "TypeScript ORM for Node.js based on Data Mapper, Unit of Work and Identity Map patterns. Supports MongoDB, MySQL, PostgreSQL and SQLite databases as well as usage with vanilla JavaScript.",
   "keywords": [
     "data-mapper",
@@ -52,7 +52,7 @@
     "@mikro-orm/core": "^7.0.1"
   },
   "peerDependencies": {
-    "@mikro-orm/core": "7.0.2-dev.13",
+    "@mikro-orm/core": "7.0.2-dev.15",
     "reflect-metadata": "^0.1.0 || ^0.2.0"
   },
   "peerDependenciesMeta": {

package/utils.d.ts

@@ -39,6 +39,7 @@ export declare function prepareMetadataContext<T>(context: ClassFieldDecoratorCo
  * Analyzes stack trace of error created inside the function call.
  */
 export declare function lookupPathFromDecorator(name: string, stack?: string[]): string;
+/** Retrieves or creates the metadata object for a decorated entity class. */
 export declare function getMetadataFromDecorator<T = any>(target: T & Dictionary & {
     [MetadataStorage.PATH_SYMBOL]?: string;
 }): EntityMetadata<T>;

package/utils.js

@@ -114,6 +114,7 @@ export function lookupPathFromDecorator(name, stack) {
         return name;
     }
 }
+/** Retrieves or creates the metadata object for a decorated entity class. */
 export function getMetadataFromDecorator(target) {
     if (!Object.hasOwn(target, MetadataStorage.PATH_SYMBOL)) {
         Object.defineProperty(target, MetadataStorage.PATH_SYMBOL, {