@mikro-orm/core 6.5.8-dev.5 → 6.5.8-dev.7

package/entity/defineEntity.d.ts

@@ -6,14 +6,14 @@ import type { ManyToOneOptions } from '../decorators/ManyToOne';
 import type { OneToManyOptions } from '../decorators/OneToMany';
 import type { OneToOneOptions } from '../decorators/OneToOne';
 import type { ManyToManyOptions } from '../decorators/ManyToMany';
-import type { AnyString, GeneratedColumnCallback, Constructor, Opt, Hidden, CheckCallback, FilterQuery, EntityName, Dictionary, EntityMetadata } from '../typings';
+import type { AnyString, GeneratedColumnCallback, Constructor, CheckCallback, FilterQuery, EntityName, Dictionary, EntityMetadata, PrimaryKeyProp, Hidden, Opt } from '../typings';
 import type { Reference, ScalarReference } from './Reference';
 import type { SerializeOptions } from '../serialization/EntitySerializer';
 import type { Cascade, DeferMode, LoadStrategy, QueryOrderMap } from '../enums';
-import type { Collection } from './Collection';
 import type { IType, Type } from '../types/Type';
 import { types } from '../types';
 import { EntitySchema } from '../metadata/EntitySchema';
+import type { Collection } from './Collection';
 /** @internal */
 export declare class PropertyOptionsBuilder<Value> {
     '~options': PropertyOptions<any>;
@@ -21,157 +21,186 @@ export declare class PropertyOptionsBuilder<Value> {
         value: Value;
     };
     constructor(options: PropertyOptionsBuilder<Value>['~options']);
+    protected assignOptions(options: Partial<PropertyOptionsBuilder<any>['~options']>): this;
     /**
      * Alias for `fieldName`.
      */
-    name(name: string): PropertyOptionsBuilder<Value>;
+    name(name: string): this;
     /**
      * Specify database column name for this property.
      *
      * @see https://mikro-orm.io/docs/naming-strategy
      */
-    fieldName(fieldName: string): PropertyOptionsBuilder<Value>;
+    fieldName(fieldName: string): this;
     /**
      * Specify database column names for this property.
      * Same as `fieldName` but for composite FKs.
      *
      * @see https://mikro-orm.io/docs/naming-strategy
      */
-    fieldNames(...fieldNames: string[]): PropertyOptionsBuilder<Value>;
+    fieldNames(...fieldNames: string[]): this;
     /**
      * Specify an exact database column type for {@link https://mikro-orm.io/docs/schema-generator Schema Generator}. This option is only for simple properties represented by a single column. (SQL only)
      */
-    columnType(columnType: ColumnType | AnyString): PropertyOptionsBuilder<Value>;
+    columnType(columnType: ColumnType | AnyString): this;
     /**
      * Specify an exact database column type for {@link https://mikro-orm.io/docs/schema-generator Schema Generator}. This option is suitable for composite keys, where one property is represented by multiple columns. (SQL only)
      */
-    columnTypes(...columnTypes: (ColumnType | AnyString)[]): PropertyOptionsBuilder<Value>;
+    columnTypes(...columnTypes: (ColumnType | AnyString)[]): this;
     /**
      * Explicitly specify the runtime type.
      *
      * @see https://mikro-orm.io/docs/metadata-providers
      * @see https://mikro-orm.io/docs/custom-types
      */
-    type<TType extends PropertyValueType>(type: TType): PropertyOptionsBuilder<InferPropertyValueType<TType>>;
+    type<TType extends PropertyValueType>(type: TType): this;
     /**
      * Runtime type of the property. This is the JS type that your property is mapped to, e.g. `string` or `number`, and is normally inferred automatically via `reflect-metadata`.
      * In some cases, the inference won't work, and you might need to specify the `runtimeType` explicitly - the most common one is when you use a union type with null like `foo: number | null`.
      */
-    runtimeType(runtimeType: string): PropertyOptionsBuilder<Value>;
+    runtimeType(runtimeType: string): this;
     /**
      * Set length of database column, used for datetime/timestamp/varchar column types for {@link https://mikro-orm.io/docs/schema-generator Schema Generator}. (SQL only)
      */
-    length(length: number): PropertyOptionsBuilder<Value>;
+    length(length: number): this;
     /**
      * Set precision of database column to represent the number of significant digits. (SQL only)
      */
-    precision(precision: number): PropertyOptionsBuilder<Value>;
+    precision(precision: number): this;
     /**
      * Set scale of database column to represents the number of digits after the decimal point. (SQL only)
      */
-    scale(scale: number): PropertyOptionsBuilder<Value>;
+    scale(scale: number): this;
     /**
      * Explicitly specify the auto increment of the primary key.
      */
-    autoincrement<T extends boolean = true>(autoincrement?: T): PropertyOptionsBuilder<T extends true ? Opt<Value> : Value>;
+    autoincrement<T extends boolean = true>(autoincrement?: T): this & {
+        '~options': {
+            autoincrement: T;
+        };
+    };
     /**
      * Add the property to the `returning` statement.
      */
-    returning(returning?: boolean): PropertyOptionsBuilder<Value>;
+    returning(returning?: boolean): this;
     /**
      * Automatically set the property value when entity gets created, executed during flush operation.
      * @param entity
      */
-    onCreate(onCreate: (entity: any, em: EntityManager) => Value): PropertyOptionsBuilder<Opt<Value>>;
+    onCreate(onCreate: (entity: any, em: EntityManager) => Value): this & {
+        '~options': {
+            onCreate: (...args: any[]) => any;
+        };
+    };
     /**
      * Automatically update the property value every time entity gets updated, executed during flush operation.
      * @param entity
      */
-    onUpdate(onUpdate: (entity: any, em: EntityManager) => Value): PropertyOptionsBuilder<Value>;
+    onUpdate(onUpdate: (entity: any, em: EntityManager) => Value): this;
     /**
      * Specify default column value for {@link https://mikro-orm.io/docs/schema-generator Schema Generator}.
      * This is a runtime value, assignable to the entity property. (SQL only)
      */
-    default(defaultValue: string | string[] | number | number[] | boolean | null): PropertyOptionsBuilder<Opt<Value>>;
+    default<T extends string | string[] | number | number[] | boolean | null>(defaultValue: T): this & {
+        '~options': {
+            default: T;
+        };
+    };
     /**
      * Specify SQL functions for {@link https://mikro-orm.io/docs/schema-generator Schema Generator}. (SQL only)
      * Since v4 you should use defaultRaw for SQL functions. e.g. now()
      */
-    defaultRaw(defaultRaw: string): PropertyOptionsBuilder<Value>;
+    defaultRaw(defaultRaw: string): this & {
+        '~options': {
+            defaultRaw: string;
+        };
+    };
     /**
      * Set to map some SQL snippet for the entity.
      *
      * @see https://mikro-orm.io/docs/defining-entities#formulas Formulas
      */
-    formula(formula: string | ((alias: string) => string)): PropertyOptionsBuilder<Value>;
+    formula(formula: string | ((alias: string) => string)): this;
     /**
      * For generated columns. This will be appended to the column type after the `generated always` clause.
      */
-    generated(generated: string | GeneratedColumnCallback<any>): PropertyOptionsBuilder<Value>;
+    generated(generated: string | GeneratedColumnCallback<any>): this;
     /**
      * Set column as nullable for {@link https://mikro-orm.io/docs/schema-generator Schema Generator}.
      */
-    nullable<T extends boolean = true>(nullable?: T): PropertyOptionsBuilder<T extends true ? Value extends ScalarReference<infer InnerValue> ? ScalarReference<InnerValue | null> : Value | null | undefined : NonNullable<Value>>;
+    nullable<T extends boolean = true>(nullable?: T): this & {
+        '~options': {
+            nullable: T;
+        };
+    };
     /**
      * Set column as unsigned for {@link https://mikro-orm.io/docs/schema-generator Schema Generator}. (SQL only)
      */
-    unsigned(unsigned?: boolean): PropertyOptionsBuilder<Value>;
+    unsigned(unsigned?: boolean): this;
     /**
      * Set false to define {@link https://mikro-orm.io/docs/serializing#shadow-properties Shadow Property}.
      */
-    persist(persist?: boolean): PropertyOptionsBuilder<Value>;
+    persist(persist?: boolean): this;
     /**
      * Set false to disable hydration of this property. Useful for persisted getters.
      */
-    hydrate(hydrate?: boolean): PropertyOptionsBuilder<Value>;
+    hydrate(hydrate?: boolean): this;
     /**
      * Enable `ScalarReference` wrapper for lazy values. Use this in combination with `lazy: true` to have a type-safe accessor object in place of the value.
      */
-    ref<T extends boolean = true>(ref?: T): PropertyOptionsBuilder<T extends true ? ScalarReference<Value> : UnwrapRef<Value>>;
+    ref<T extends boolean = true>(ref?: T): T extends true ? WithRef<this> : WithoutRef<this>;
     /**
      * Set false to disable change tracking on a property level.
      *
      * @see https://mikro-orm.io/docs/unit-of-work#change-tracking-and-performance-considerations
      */
-    trackChanges(trackChanges?: boolean): PropertyOptionsBuilder<Value>;
+    trackChanges(trackChanges?: boolean): this;
     /**
      * Set to true to omit the property when {@link https://mikro-orm.io/docs/serializing Serializing}.
      */
-    hidden<T extends boolean = true>(hidden?: T): PropertyOptionsBuilder<T extends true ? Hidden<Value> : Value>;
+    hidden<T extends boolean = true>(hidden?: T): this & {
+        '~options': {
+            hidden: T;
+        };
+    };
     /**
      * Set to true to enable {@link https://mikro-orm.io/docs/transactions#optimistic-locking Optimistic Locking} via version field. (SQL only)
      */
-    version(version?: boolean): PropertyOptionsBuilder<Value>;
+    version(version?: boolean): this;
     /**
      * Set to true to enable {@link https://mikro-orm.io/docs/transactions#optimistic-locking Optimistic Locking} via concurrency fields.
      */
-    concurrencyCheck(concurrencyCheck?: boolean): PropertyOptionsBuilder<Value>;
+    concurrencyCheck(concurrencyCheck?: boolean): this;
     /**
      * Explicitly specify index on a property.
      */
-    index(index?: boolean | string): PropertyOptionsBuilder<Value>;
+    index(index?: boolean | string): this;
     /**
      * Set column as unique for {@link https://mikro-orm.io/docs/schema-generator Schema Generator}. (SQL only)
      */
-    unique(unique?: boolean | string): PropertyOptionsBuilder<Value>;
+    unique(unique?: boolean | string): this;
     /**
      * Specify column with check constraints. (Postgres driver only)
      *
      * @see https://mikro-orm.io/docs/defining-entities#check-constraints
      */
-    check(check: string | CheckCallback<any>): PropertyOptionsBuilder<Value>;
+    check(check: string | CheckCallback<any>): this;
     /**
      * Set to omit the property from the select clause for lazy loading.
      *
      * @see https://mikro-orm.io/docs/defining-entities#lazy-scalar-properties
      */
-    lazy<T extends boolean = true>(lazy?: boolean, ref?: T): PropertyOptionsBuilder<T extends true ? ScalarReference<Value> : UnwrapRef<Value>>;
+    lazy<T extends boolean = true>(lazy?: boolean, ref?: T): T extends true ? WithRef<this> : WithoutRef<this>;
     /**
      * Set true to define entity's unique primary key identifier.
      *
      * @see https://mikro-orm.io/docs/decorators#primarykey
      */
-    primary(primary?: boolean): PropertyOptionsBuilder<Value>;
+    primary<T extends boolean = true>(primary?: T): this & {
+        '~options': {
+            primary: T;
+        };
+    };
     /**
      * Set true to define the properties as setter. (virtual)
      *
@@ -183,7 +212,7 @@ export declare class PropertyOptionsBuilder<Value> {
      * }
      * ```
      */
-    setter(setter?: boolean): PropertyOptionsBuilder<Value>;
+    setter(setter?: boolean): this;
     /**
      * Set true to define the properties as getter. (virtual)
      *
@@ -195,7 +224,7 @@ export declare class PropertyOptionsBuilder<Value> {
      * }
      * ```
      */
-    getter(getter?: boolean): PropertyOptionsBuilder<Value>;
+    getter(getter?: boolean): this;
     /**
      * When defining a property over a method (not a getter, a regular function), you can use this option to point
      * to the method name.
@@ -208,45 +237,45 @@ export declare class PropertyOptionsBuilder<Value> {
      * }
      * ```
      */
-    getterName(getterName: string): PropertyOptionsBuilder<Value>;
+    getterName(getterName: string): this;
     /**
      * Set to define serialized primary key for MongoDB. (virtual)
      * Alias for `@SerializedPrimaryKey()` decorator.
      *
      * @see https://mikro-orm.io/docs/decorators#serializedprimarykey
      */
-    serializedPrimaryKey(serializedPrimaryKey?: boolean): PropertyOptionsBuilder<Value>;
+    serializedPrimaryKey(serializedPrimaryKey?: boolean): this;
     /**
      * Set to use serialize property. Allow to specify a callback that will be used when serializing a property.
      *
      * @see https://mikro-orm.io/docs/serializing#property-serializers
      */
-    serializer(serializer: (value: Value, options?: SerializeOptions<any>) => any): PropertyOptionsBuilder<Value>;
+    serializer(serializer: (value: Value, options?: SerializeOptions<any>) => any): this;
     /**
      * Specify name of key for the serialized value.
      */
-    serializedName(serializedName: string): PropertyOptionsBuilder<Value>;
+    serializedName(serializedName: string): this;
     /**
      * Specify serialization groups for `serialize()` calls. If a property does not specify any group, it will be included,
      * otherwise only properties with a matching group are included.
      */
-    groups(...groups: string[]): PropertyOptionsBuilder<Value>;
+    groups(...groups: string[]): this;
     /**
      * Specify a custom order based on the values. (SQL only)
      */
-    customOrder(...customOrder: (string[] | number[] | boolean[])): PropertyOptionsBuilder<Value>;
+    customOrder(...customOrder: (string[] | number[] | boolean[])): this;
     /**
      * Specify comment of column for {@link https://mikro-orm.io/docs/schema-generator Schema Generator}. (SQL only)
      */
-    comment(comment: string): PropertyOptionsBuilder<Value>;
+    comment(comment: string): this;
     /** mysql only */
-    extra(extra: string): PropertyOptionsBuilder<Value>;
+    extra(extra: string): this;
     /**
      * Set to avoid a perpetual diff from the {@link https://mikro-orm.io/docs/schema-generator Schema Generator} when columns are generated.
      *
      * @see https://mikro-orm.io/docs/defining-entities#sql-generated-columns
      */
-    ignoreSchemaChanges(...ignoreSchemaChanges: ('type' | 'extra' | 'default')[]): PropertyOptionsBuilder<Value>;
+    ignoreSchemaChanges(...ignoreSchemaChanges: ('type' | 'extra' | 'default')[]): this;
     /**
      * Set the TypeScript type of the property.
      */
@@ -269,178 +298,175 @@ export declare class EnumOptionsBuilder<Value> extends PropertyOptionsBuilder<Va
         enum: true;
     } & EnumOptions<any>;
     constructor(options: EnumOptionsBuilder<Value>['~options']);
-    array<T extends boolean = true>(array?: T): EnumOptionsBuilder<T extends true ? Value[] : UnwrapArray<Value>>;
+    protected assignOptions(options: Partial<EnumOptionsBuilder<any>['~options']>): this;
+    array<T extends boolean = true>(array?: T): this & {
+        '~options': {
+            array: T;
+        };
+    };
     /** for postgres, by default it uses text column with check constraint */
-    nativeEnumName(nativeEnumName: string): EnumOptionsBuilder<Value>;
+    nativeEnumName(nativeEnumName: string): this;
 }
 /** @internal */
 export declare class EmbeddedOptionsBuilder<Value> extends PropertyOptionsBuilder<Value> {
     '~options': ({
         kind: 'embedded';
         entity: () => EntitySchema<any, any> | EntitySchema<any, any>[];
-    } & EmbeddedOptions<any, any> & PropertyOptions<any>);
+    } & EmbeddedOptions<any, any>);
     constructor(options: EmbeddedOptionsBuilder<Value>['~options']);
-    prefix(prefix: string): EmbeddedOptionsBuilder<Value>;
-    prefixMode(prefixMode: EmbeddedPrefixMode): EmbeddedOptionsBuilder<Value>;
-    object(object?: boolean): EmbeddedOptionsBuilder<Value>;
-    array<T extends boolean = true>(array?: T): EmbeddedOptionsBuilder<T extends true ? Value[] : UnwrapArray<Value>>;
+    protected assignOptions(options: Partial<EmbeddedOptionsBuilder<any>['~options']>): this;
+    prefix(prefix: string | boolean): this;
+    prefixMode(prefixMode: EmbeddedPrefixMode): this;
+    object(object?: boolean): this;
+    array<T extends boolean = true>(array?: T): this & {
+        '~options': {
+            array: T;
+        };
+    };
 }
 /** @internal */
-export declare class ReferenceOptionsBuilder<Value extends object> extends PropertyOptionsBuilder<Value> {
+export declare abstract class ReferenceOptionsBuilder<Value extends object> extends PropertyOptionsBuilder<Value> {
     '~options': ReferenceOptions<any, any>;
     constructor(options: ReferenceOptionsBuilder<Value>['~options']);
+    protected abstract assignOptions(options: Partial<ReferenceOptionsBuilder<any>['~options']>): this;
     /** Set what actions on owning entity should be cascaded to the relationship. Defaults to [Cascade.PERSIST, Cascade.MERGE] (see {@doclink cascading}). */
-    cascade(...cascade: Cascade[]): ReferenceOptionsBuilder<Value>;
+    cascade(...cascade: Cascade[]): this;
     /** Always load the relationship. Discouraged for use with to-many relations for performance reasons. */
-    eager(eager?: boolean): ReferenceOptionsBuilder<Value>;
+    eager(eager?: boolean): this;
     /** Override the default loading strategy for this property. This option has precedence over the global `loadStrategy`, but can be overridden by `FindOptions.strategy`. */
-    strategy(strategy: LoadStrategy | `${LoadStrategy}`): ReferenceOptionsBuilder<Value>;
-    /**
-     * @internal
-     * re-declare to override type inference
-     */
-    ref(ref?: boolean): ReferenceOptionsBuilder<any>;
-    /**
-     * @internal
-     * re-declare to override type inference
-     */
-    primary(primary?: boolean): ReferenceOptionsBuilder<any>;
+    strategy(strategy: LoadStrategy | `${LoadStrategy}`): this;
 }
 /** @internal */
 export declare class ManyToManyOptionsBuilder<TargetValue extends object> extends ReferenceOptionsBuilder<TargetValue> {
     '~options': ({
         kind: 'm:n';
         entity: () => EntitySchema<any, any>;
-    } & ManyToManyOptions<any, UnwrapCollection<TargetValue>>);
+    } & ManyToManyOptions<any, TargetValue>);
     constructor(options: ManyToManyOptionsBuilder<TargetValue>['~options']);
+    protected assignOptions(options: Partial<ManyToManyOptionsBuilder<any>['~options']>): this;
     /** Set this side as owning. Owning side is where the foreign key is defined. This option is not required if you use `inversedBy` or `mappedBy` to distinguish owning and inverse side. */
-    owner(owner?: boolean): ManyToManyOptionsBuilder<TargetValue>;
+    owner(owner?: boolean): this;
     /** Point to the inverse side property name. */
-    inversedBy(inversedBy: (string & keyof UnwrapCollection<TargetValue>) | ((e: UnwrapCollection<TargetValue>) => any)): ManyToManyOptionsBuilder<TargetValue>;
+    inversedBy(inversedBy: (string & keyof TargetValue) | ((e: TargetValue) => any)): this;
     /** Point to the owning side property name. */
-    mappedBy(mappedBy: string | ((e: any) => any)): ManyToManyOptionsBuilder<TargetValue>;
+    mappedBy(mappedBy: string | ((e: any) => any)): this;
     /** Condition for {@doclink collections#declarative-partial-loading | Declarative partial loading}. */
-    where(...where: FilterQuery<object>[]): ManyToManyOptionsBuilder<TargetValue>;
+    where(...where: FilterQuery<object>[]): this;
     /** Set default ordering. */
-    orderBy(...orderBy: QueryOrderMap<object>[]): ManyToManyOptionsBuilder<TargetValue>;
+    orderBy(...orderBy: QueryOrderMap<object>[]): this;
     /** Force stable insertion order of items in the collection (see {@doclink collections | Collections}). */
-    fixedOrder(fixedOrder?: boolean): ManyToManyOptionsBuilder<TargetValue>;
+    fixedOrder(fixedOrder?: boolean): this;
     /** Override default order column name (`id`) for fixed ordering. */
-    fixedOrderColumn(fixedOrderColumn: string): ManyToManyOptionsBuilder<TargetValue>;
+    fixedOrderColumn(fixedOrderColumn: string): this;
     /** Override default name for pivot table (see {@doclink naming-strategy | Naming Strategy}). */
-    pivotTable(pivotTable: string): ManyToManyOptionsBuilder<TargetValue>;
+    pivotTable(pivotTable: string): this;
     /** Set pivot entity for this relation (see {@doclink collections#custom-pivot-table-entity | Custom pivot table entity}). */
-    pivotEntity(pivotEntity: string | (() => EntityName<any>)): ManyToManyOptionsBuilder<TargetValue>;
+    pivotEntity(pivotEntity: string | (() => EntityName<any>)): this;
     /** Override the default database column name on the owning side (see {@doclink naming-strategy | Naming Strategy}). This option is only for simple properties represented by a single column. */
-    joinColumn(joinColumn: string): ManyToManyOptionsBuilder<TargetValue>;
+    joinColumn(joinColumn: string): this;
     /** Override the default database column name on the owning side (see {@doclink naming-strategy | Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. */
-    joinColumns(...joinColumns: string[]): ManyToManyOptionsBuilder<TargetValue>;
+    joinColumns(...joinColumns: string[]): this;
     /** Override the default database column name on the inverse side (see {@doclink naming-strategy | Naming Strategy}). This option is only for simple properties represented by a single column. */
-    inverseJoinColumn(inverseJoinColumn: string): ManyToManyOptionsBuilder<TargetValue>;
+    inverseJoinColumn(inverseJoinColumn: string): this;
     /** Override the default database column name on the inverse side (see {@doclink naming-strategy | Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. */
-    inverseJoinColumns(...inverseJoinColumns: string[]): ManyToManyOptionsBuilder<TargetValue>;
+    inverseJoinColumns(...inverseJoinColumns: string[]): this;
     /** Override the default database column name on the target entity (see {@doclink naming-strategy | Naming Strategy}). This option is only for simple properties represented by a single column. */
-    referenceColumnName(referenceColumnName: string): ManyToManyOptionsBuilder<TargetValue>;
+    referenceColumnName(referenceColumnName: string): this;
     /** Override the default database column name on the target entity (see {@doclink naming-strategy | Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. */
-    referencedColumnNames(...referencedColumnNames: string[]): ManyToManyOptionsBuilder<TargetValue>;
+    referencedColumnNames(...referencedColumnNames: string[]): this;
     /** What to do when the target entity gets deleted. */
-    deleteRule(deleteRule: 'cascade' | 'no action' | 'set null' | 'set default' | AnyString): ManyToManyOptionsBuilder<TargetValue>;
+    deleteRule(deleteRule: 'cascade' | 'no action' | 'set null' | 'set default' | AnyString): this;
     /** What to do when the reference to the target entity gets updated. */
-    updateRule(updateRule: 'cascade' | 'no action' | 'set null' | 'set default' | AnyString): ManyToManyOptionsBuilder<TargetValue>;
+    updateRule(updateRule: 'cascade' | 'no action' | 'set null' | 'set default' | AnyString): this;
 }
 /** @internal */
 export declare class ManyToOneOptionsBuilder<TargetValue extends object> extends ReferenceOptionsBuilder<TargetValue> {
     '~options': ({
         kind: 'm:1';
         entity: () => EntitySchema<any, any>;
-    } & ManyToOneOptions<any, UnwrapRef<TargetValue>>);
+    } & ManyToOneOptions<any, TargetValue>);
     constructor(options: ManyToOneOptionsBuilder<TargetValue>['~options']);
+    protected assignOptions(options: Partial<ManyToOneOptionsBuilder<any>['~options']>): this;
     /** Point to the inverse side property name. */
-    inversedBy(inversedBy: (string & keyof UnwrapRef<TargetValue>) | ((e: UnwrapRef<TargetValue>) => any)): ManyToOneOptionsBuilder<TargetValue>;
-    /** Wrap the entity in {@apilink Reference} wrapper. */
-    ref<T extends boolean = true>(ref?: T): ManyToOneOptionsBuilder<T extends true ? Reference<TargetValue> : UnwrapRef<TargetValue>>;
-    /** Use this relation as a primary key. */
-    primary(primary?: boolean): ManyToOneOptionsBuilder<TargetValue>;
+    inversedBy(inversedBy: (string & keyof TargetValue) | ((e: TargetValue) => any)): this;
     /** Map this relation to the primary key value instead of an entity. */
-    mapToPk(mapToPk?: boolean): ManyToOneOptionsBuilder<TargetValue>;
+    mapToPk(mapToPk?: boolean): this;
     /** Override the default database column name on the owning side (see {@doclink naming-strategy | Naming Strategy}). This option is only for simple properties represented by a single column. */
-    joinColumn(joinColumn: string): ManyToOneOptionsBuilder<TargetValue>;
+    joinColumn(joinColumn: string): this;
     /** Override the default database column name on the owning side (see {@doclink naming-strategy | Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. */
-    joinColumns(...joinColumns: string[]): ManyToOneOptionsBuilder<TargetValue>;
+    joinColumns(...joinColumns: string[]): this;
     /** When a part of a composite column is shared in other properties, use this option to specify what columns are considered as owned by this property. This is useful when your composite property is nullable, but parts of it are not. */
-    ownColumns(...ownColumns: string[]): ManyToOneOptionsBuilder<TargetValue>;
+    ownColumns(...ownColumns: string[]): this;
     /** Override the default database column name on the target entity (see {@doclink naming-strategy | Naming Strategy}). This option is only for simple properties represented by a single column. */
-    referenceColumnName(referenceColumnName: string): ManyToOneOptionsBuilder<TargetValue>;
+    referenceColumnName(referenceColumnName: string): this;
     /** Override the default database column name on the target entity (see {@doclink naming-strategy | Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. */
-    referencedColumnNames(...referencedColumnNames: string[]): ManyToOneOptionsBuilder<TargetValue>;
+    referencedColumnNames(...referencedColumnNames: string[]): this;
     /** What to do when the target entity gets deleted. */
-    deleteRule(deleteRule: 'cascade' | 'no action' | 'set null' | 'set default' | AnyString): ManyToOneOptionsBuilder<TargetValue>;
+    deleteRule(deleteRule: 'cascade' | 'no action' | 'set null' | 'set default' | AnyString): this;
     /** What to do when the reference to the target entity gets updated. */
-    updateRule(updateRule: 'cascade' | 'no action' | 'set null' | 'set default' | AnyString): ManyToOneOptionsBuilder<TargetValue>;
+    updateRule(updateRule: 'cascade' | 'no action' | 'set null' | 'set default' | AnyString): this;
     /** Set the constraint type. Immediate constraints are checked for each statement, while deferred ones are only checked at the end of the transaction. Only for postgres unique constraints. */
-    deferMode(deferMode: DeferMode | `${DeferMode}`): ManyToOneOptionsBuilder<TargetValue>;
+    deferMode(deferMode: DeferMode | `${DeferMode}`): this;
 }
 /** @internal */
 export declare class OneToManyOptionsBuilder<TargetValue extends object> extends ReferenceOptionsBuilder<TargetValue> {
     '~options': ({
         kind: '1:m';
         entity: () => EntitySchema<TargetValue>;
-    } & OneToManyOptions<any, UnwrapCollection<TargetValue>>);
+    } & OneToManyOptions<any, TargetValue>);
     constructor(options: OneToManyOptionsBuilder<TargetValue>['~options']);
+    protected assignOptions(options: Partial<OneToManyOptionsBuilder<any>['~options']>): this;
     /** Remove the entity when it gets disconnected from the relationship (see {@doclink cascading | Cascading}). */
-    orphanRemoval(orphanRemoval?: boolean): OneToManyOptionsBuilder<TargetValue>;
+    orphanRemoval(orphanRemoval?: boolean): this;
     /** Set default ordering. */
-    orderBy(orderBy: QueryOrderMap<UnwrapCollection<TargetValue>> | QueryOrderMap<UnwrapCollection<TargetValue>>[]): OneToManyOptionsBuilder<TargetValue>;
+    orderBy(orderBy: QueryOrderMap<TargetValue> | QueryOrderMap<TargetValue>[]): this;
     /** Condition for {@doclink collections#declarative-partial-loading | Declarative partial loading}. */
-    where(where: FilterQuery<UnwrapCollection<TargetValue>>): OneToManyOptionsBuilder<TargetValue>;
+    where(where: FilterQuery<TargetValue>): this;
     /** Override the default database column name on the owning side (see {@doclink naming-strategy | Naming Strategy}). This option is only for simple properties represented by a single column. */
-    joinColumn(joinColumn: string): OneToManyOptionsBuilder<TargetValue>;
+    joinColumn(joinColumn: string): this;
     /** Override the default database column name on the owning side (see {@doclink naming-strategy | Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. */
-    joinColumns(...joinColumns: string[]): OneToManyOptionsBuilder<TargetValue>;
+    joinColumns(...joinColumns: string[]): this;
     /** Override the default database column name on the inverse side (see {@doclink naming-strategy | Naming Strategy}). This option is only for simple properties represented by a single column. */
-    inverseJoinColumn(inverseJoinColumn: string): OneToManyOptionsBuilder<TargetValue>;
+    inverseJoinColumn(inverseJoinColumn: string): this;
     /** Override the default database column name on the inverse side (see {@doclink naming-strategy | Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. */
-    inverseJoinColumns(...inverseJoinColumns: string[]): OneToManyOptionsBuilder<TargetValue>;
+    inverseJoinColumns(...inverseJoinColumns: string[]): this;
     /** Override the default database column name on the target entity (see {@doclink naming-strategy | Naming Strategy}). This option is only for simple properties represented by a single column. */
-    referenceColumnName(referenceColumnName: string): OneToManyOptionsBuilder<TargetValue>;
+    referenceColumnName(referenceColumnName: string): this;
     /** Override the default database column name on the target entity (see {@doclink naming-strategy | Naming Strategy}). This option is suitable for composite keys, where one property is represented by multiple columns. */
-    referencedColumnNames(...referencedColumnNames: string[]): OneToManyOptionsBuilder<TargetValue>;
+    referencedColumnNames(...referencedColumnNames: string[]): this;
 }
 /** @internal */
 export declare class OneToManyOptionsBuilderOnlyMappedBy<TargetValue extends object> {
     '~options': ({
         kind: '1:m';
         entity: () => EntitySchema<TargetValue>;
-    } & Omit<OneToManyOptions<any, UnwrapCollection<TargetValue>>, 'mappedBy'>);
+    } & Omit<OneToManyOptions<any, TargetValue>, 'mappedBy'>);
     constructor(options: OneToManyOptionsBuilderOnlyMappedBy<TargetValue>['~options']);
     /** Point to the owning side property name. */
-    mappedBy(mappedBy: (AnyString & keyof UnwrapCollection<TargetValue>) | ((e: UnwrapCollection<TargetValue>) => any)): OneToManyOptionsBuilder<TargetValue>;
+    mappedBy(mappedBy: (AnyString & keyof TargetValue) | ((e: TargetValue) => any)): OneToManyOptionsBuilder<TargetValue>;
 }
 /** @internal */
 export declare class OneToOneOptionsBuilder<TargetValue extends object> extends ReferenceOptionsBuilder<TargetValue> {
     '~options': ({
         kind: '1:1';
         entity: () => EntitySchema<any, any>;
-    } & OneToOneOptions<any, UnwrapRef<TargetValue>>);
+    } & OneToOneOptions<any, TargetValue>);
     constructor(options: OneToOneOptionsBuilder<TargetValue>['~options']);
+    protected assignOptions(options: Partial<OneToOneOptionsBuilder<any>['~options']>): this;
     /** Set this side as owning. Owning side is where the foreign key is defined. This option is not required if you use `inversedBy` or `mappedBy` to distinguish owning and inverse side. */
-    owner(owner?: boolean): OneToOneOptionsBuilder<TargetValue>;
+    owner(owner?: boolean): this;
     /** Point to the inverse side property name. */
-    inversedBy(inversedBy: (string & keyof UnwrapRef<TargetValue>) | ((e: UnwrapRef<TargetValue>) => any)): OneToOneOptionsBuilder<TargetValue>;
-    /** Wrap the entity in {@apilink Reference} wrapper. */
-    ref<T extends boolean = true>(ref?: T): OneToOneOptionsBuilder<T extends true ? Reference<TargetValue> : UnwrapRef<TargetValue>>;
-    /** Use this relation as a primary key. */
-    primary(primary?: boolean): OneToOneOptionsBuilder<TargetValue>;
+    inversedBy(inversedBy: (string & keyof TargetValue) | ((e: TargetValue) => any)): this;
     /** Map this relation to the primary key value instead of an entity. */
-    mapToPk(mapToPk?: boolean): OneToOneOptionsBuilder<TargetValue>;
+    mapToPk(mapToPk?: boolean): this;
     /** When a part of a composite column is shared in other properties, use this option to specify what columns are considered as owned by this property. This is useful when your composite property is nullable, but parts of it are not. */
-    ownColumns(...ownColumns: string[]): OneToOneOptionsBuilder<TargetValue>;
+    ownColumns(...ownColumns: string[]): this;
     /** What to do when the target entity gets deleted. */
-    deleteRule(deleteRule: 'cascade' | 'no action' | 'set null' | 'set default' | AnyString): OneToOneOptionsBuilder<TargetValue>;
+    deleteRule(deleteRule: 'cascade' | 'no action' | 'set null' | 'set default' | AnyString): this;
     /** What to do when the reference to the target entity gets updated. */
-    updateRule(updateRule: 'cascade' | 'no action' | 'set null' | 'set default' | AnyString): OneToOneOptionsBuilder<TargetValue>;
+    updateRule(updateRule: 'cascade' | 'no action' | 'set null' | 'set default' | AnyString): this;
     /** Set the constraint type. Immediate constraints are checked for each statement, while deferred ones are only checked at the end of the transaction. Only for postgres unique constraints. */
-    deferMode(deferMode: DeferMode | `${DeferMode}`): OneToOneOptionsBuilder<TargetValue>;
+    deferMode(deferMode: DeferMode | `${DeferMode}`): this;
 }
 declare const propertyBuilders: {
     bigint: <Mode extends "bigint" | "number" | "string" = "bigint">(mode?: Mode) => PropertyOptionsBuilder<(Mode extends "bigint" ? bigint : Mode extends "number" ? number : string) & {}>;
@@ -451,10 +477,10 @@ declare const propertyBuilders: {
     type: <T extends PropertyValueType>(type: T) => PropertyOptionsBuilder<InferPropertyValueType<T>>;
     enum: <const T extends (number | string)[] | (() => Dictionary)>(items?: T) => EnumOptionsBuilder<T extends () => Dictionary ? ValueOf<ReturnType<T>> : T extends (infer Value)[] ? Value : T>;
     embedded: <Target extends EntitySchema<any, any> | EntitySchema<any, any>[]>(target: Target) => EmbeddedOptionsBuilder<InferEntity<Target extends (infer T)[] ? T : Target>>;
-    manyToMany: <Target extends EntitySchema<any, any>>(target: Target) => ManyToManyOptionsBuilder<Collection<InferEntity<Target>, object>>;
-    manyToOne: <Target extends EntitySchema<any, any>>(target: Target) => ManyToOneOptionsBuilder<Reference<InferEntity<Target>>>;
-    oneToMany: <Target extends EntitySchema<any, any>>(target: Target) => OneToManyOptionsBuilderOnlyMappedBy<Collection<InferEntity<Target>, object>>;
-    oneToOne: <Target extends EntitySchema<any, any>>(target: Target) => OneToOneOptionsBuilder<Reference<InferEntity<Target>>>;
+    manyToMany: <Target extends EntitySchema<any, any>>(target: Target) => ManyToManyOptionsBuilder<InferEntity<Target>>;
+    manyToOne: <Target extends EntitySchema<any, any>>(target: Target) => ManyToOneOptionsBuilder<InferEntity<Target>>;
+    oneToMany: <Target extends EntitySchema<any, any>>(target: Target) => OneToManyOptionsBuilderOnlyMappedBy<InferEntity<Target>>;
+    oneToOne: <Target extends EntitySchema<any, any>>(target: Target) => OneToOneOptionsBuilder<InferEntity<Target>>;
     date: () => PropertyOptionsBuilder<string>;
     time: () => PropertyOptionsBuilder<any>;
     datetime: () => PropertyOptionsBuilder<Date>;
@@ -475,10 +501,11 @@ declare const propertyBuilders: {
     interval: () => PropertyOptionsBuilder<string>;
     unknown: () => PropertyOptionsBuilder<{}>;
 };
-export declare function defineEntity<Properties extends Record<string, any>>(meta: Omit<Partial<EntityMetadata<InferEntityFromProperties<Properties>>>, 'properties' | 'extends'> & {
+export declare function defineEntity<Properties extends Record<string, any>, const PK extends (keyof Properties)[] | undefined = undefined>(meta: Omit<Partial<EntityMetadata<InferEntityFromProperties<Properties, PK>>>, 'properties' | 'extends' | 'primaryKeys'> & {
     name: string;
     properties: Properties | ((properties: typeof propertyBuilders) => Properties);
-}): EntitySchema<InferEntityFromProperties<Properties>, never>;
+    primaryKeys?: PK & InferPrimaryKey<Properties>[];
+}): EntitySchema<InferEntityFromProperties<Properties, PK>, never>;
 export declare namespace defineEntity {
     var properties: {
         bigint: <Mode extends "bigint" | "number" | "string" = "bigint">(mode?: Mode) => PropertyOptionsBuilder<(Mode extends "bigint" ? bigint : Mode extends "number" ? number : string) & {}>;
@@ -489,10 +516,10 @@ export declare namespace defineEntity {
         type: <T extends PropertyValueType>(type: T) => PropertyOptionsBuilder<InferPropertyValueType<T>>;
         enum: <const T extends (number | string)[] | (() => Dictionary)>(items?: T) => EnumOptionsBuilder<T extends () => Dictionary ? ValueOf<ReturnType<T>> : T extends (infer Value)[] ? Value : T>;
         embedded: <Target extends EntitySchema<any, any> | EntitySchema<any, any>[]>(target: Target) => EmbeddedOptionsBuilder<InferEntity<Target extends (infer T)[] ? T : Target>>;
-        manyToMany: <Target extends EntitySchema<any, any>>(target: Target) => ManyToManyOptionsBuilder<Collection<InferEntity<Target>, object>>;
-        manyToOne: <Target extends EntitySchema<any, any>>(target: Target) => ManyToOneOptionsBuilder<Reference<InferEntity<Target>>>;
-        oneToMany: <Target extends EntitySchema<any, any>>(target: Target) => OneToManyOptionsBuilderOnlyMappedBy<Collection<InferEntity<Target>, object>>;
-        oneToOne: <Target extends EntitySchema<any, any>>(target: Target) => OneToOneOptionsBuilder<Reference<InferEntity<Target>>>;
+        manyToMany: <Target extends EntitySchema<any, any>>(target: Target) => ManyToManyOptionsBuilder<InferEntity<Target>>;
+        manyToOne: <Target extends EntitySchema<any, any>>(target: Target) => ManyToOneOptionsBuilder<InferEntity<Target>>;
+        oneToMany: <Target extends EntitySchema<any, any>>(target: Target) => OneToManyOptionsBuilderOnlyMappedBy<InferEntity<Target>>;
+        oneToOne: <Target extends EntitySchema<any, any>>(target: Target) => OneToOneOptionsBuilder<InferEntity<Target>>;
         date: () => PropertyOptionsBuilder<string>;
         time: () => PropertyOptionsBuilder<any>;
         datetime: () => PropertyOptionsBuilder<Date>;
@@ -519,19 +546,96 @@ type InferPropertyValueType<T extends PropertyValueType> = T extends string ? In
 type InferTypeByString<T extends string> = T extends keyof typeof types ? InferJSType<typeof types[T]> : InferColumnType<T>;
 type InferJSType<T> = T extends typeof Type<infer TValue, any> ? NonNullable<TValue> : never;
 type InferColumnType<T extends string> = T extends 'int' | 'int4' | 'integer' | 'bigint' | 'int8' | 'int2' | 'tinyint' | 'smallint' | 'mediumint' ? number : T extends 'double' | 'double precision' | 'real' | 'float8' | 'decimal' | 'numeric' | 'float' | 'float4' ? number : T extends 'datetime' | 'time' | 'time with time zone' | 'timestamp' | 'timestamp with time zone' | 'timetz' | 'timestamptz' | 'date' | 'interval' ? Date : T extends 'ObjectId' | 'objectId' | 'character varying' | 'varchar' | 'char' | 'character' | 'uuid' | 'text' | 'tinytext' | 'mediumtext' | 'longtext' | 'enum' ? string : T extends 'boolean' | 'bool' | 'bit' ? boolean : T extends 'blob' | 'tinyblob' | 'mediumblob' | 'longblob' | 'bytea' ? Buffer : T extends 'point' | 'line' | 'lseg' | 'box' | 'circle' | 'path' | 'polygon' | 'geometry' ? number[] : T extends 'tsvector' | 'tsquery' ? string[] : T extends 'json' | 'jsonb' ? any : any;
-export type InferEntityFromProperties<Properties extends Record<string, any>> = {
-    -readonly [K in keyof Properties]: Properties[K] extends (() => any) ? InferBuilderValue<ReturnType<Properties[K]>> : InferBuilderValue<Properties[K]>;
+export type InferEntityFromProperties<Properties extends Record<string, any>, PK extends (keyof Properties)[] | undefined = undefined> = {
+    -readonly [K in keyof Properties]: InferBuilderValue<MaybeReturnType<Properties[K]>>;
+} & {
+    [PrimaryKeyProp]?: PK extends undefined ? InferPrimaryKey<Properties> extends never ? never : IsUnion<InferPrimaryKey<Properties>> extends true ? InferPrimaryKey<Properties>[] : InferPrimaryKey<Properties> : PK;
+};
+export type InferPrimaryKey<Properties extends Record<string, any>> = {
+    [K in keyof Properties]: MaybeReturnType<Properties[K]> extends {
+        '~options': {
+            primary: true;
+        };
+    } ? K : never;
+}[keyof Properties];
+type MaybeReturnType<T> = T extends (...args: any[]) => infer R ? R : T;
+type WithRef<T> = T & {
+    '~options': {
+        ref: true;
+    };
+};
+type WithoutRef<T> = T extends WithRef<infer U> ? U & {
+    '~options': {
+        ref: false;
+    };
+} : T & {
+    '~options': {
+        ref: false;
+    };
 };
 type InferBuilderValue<Builder> = Builder extends {
     '~type'?: {
-        value: infer T;
+        value: infer Value;
+    };
+} ? MaybeHidden<MaybeOpt<MaybeRef<MaybeNullable<MaybeArray<Value, Builder>, Builder>, Builder>, Builder>, Builder> : never;
+type MaybeArray<Value, Builder> = Builder extends {
+    '~options': {
+        array: true;
+    };
+} ? Value[] : Value;
+type MaybeNullable<Value, Builder> = Builder extends {
+    '~options': {
+        nullable: true;
+    };
+} ? Value | null | undefined : Value;
+type MaybeRef<Value, Builder> = Builder extends {
+    '~options': {
+        ref: false;
+    };
+} ? Value : Builder extends {
+    '~options': {
+        kind: '1:1';
+    };
+} ? Value extends object ? Reference<Value> : never : Builder extends {
+    '~options': {
+        kind: 'm:1';
+    };
+} ? Value extends object ? Reference<Value> : never : Builder extends {
+    '~options': {
+        kind: '1:m';
+    };
+} ? Value extends object ? Collection<Value> : never : Builder extends {
+    '~options': {
+        kind: 'm:n';
+    };
+} ? Value extends object ? Collection<Value> : never : Builder extends {
+    '~options': {
+        ref: true;
+    };
+} ? ScalarReference<Value> : Value;
+type MaybeOpt<Value, Builder> = Builder extends {
+    '~options': {
+        autoincrement: true;
+    };
+} ? Opt<Value> : Builder extends {
+    '~options': {
+        onCreate: Function;
+    };
+} ? Opt<Value> : Builder extends {
+    '~options': {
+        default: string | string[] | number | number[] | boolean | null;
+    };
+} ? Opt<Value> : Builder extends {
+    '~options': {
+        defaultRaw: string;
+    };
+} ? Opt<Value> : Value;
+type MaybeHidden<Value, Builder> = Builder extends {
+    '~options': {
+        hidden: true;
     };
-} ? T : never;
-type UnwrapRef<T> = T extends ScalarReference<any> ? UnwrapScalarReference<T> : T extends Reference<any> ? UnwrapReference<T> : T;
-type UnwrapScalarReference<T extends ScalarReference<any>> = T extends ScalarReference<infer Value> ? Value : T;
-type UnwrapReference<T extends Reference<any>> = T extends Reference<infer Value> ? Value : T;
-type UnwrapCollection<T> = T extends Collection<infer Value> ? Value : T;
-type UnwrapArray<T> = T extends (infer Value)[] ? Value : T;
+} ? Hidden<Value> : Value;
 type ValueOf<T extends Dictionary> = T[keyof T];
+type IsUnion<T, U = T> = T extends U ? ([U] extends [T] ? false : true) : false;
 export type InferEntity<Schema> = Schema extends EntitySchema<infer Entity, any> ? Entity : never;
 export {};