@mikro-orm/core 7.2.0-dev.2 → 7.2.0-dev.21

package/EntityManager.d.ts

@@ -7,7 +7,7 @@ import { EntityLoader, type EntityLoaderOptions } from './entity/EntityLoader.js
 import { Reference } from './entity/Reference.js';
 import { UnitOfWork } from './unit-of-work/UnitOfWork.js';
 import type { CountByOptions, CountOptions, DeleteOptions, FilterOptions, FindAllOptions, FindByCursorOptions, FindOneOptions, FindOneOrFailOptions, FindOptions, GetReferenceOptions, IDatabaseDriver, LockOptions, NativeInsertUpdateOptions, StreamOptions, UpdateOptions, UpsertManyOptions, UpsertOptions } from './drivers/IDatabaseDriver.js';
-import type { AnyString, ArrayElement, AutoPath, ConnectionType, Dictionary, EntityClass, EntityData, EntityDictionary, EntityDTO, EntityKey, EntityMetadata, EntityName, FilterDef, FilterQuery, FromEntityType, GetRepository, IHydrator, IsSubset, Loaded, MergeLoaded, MergeSelected, ObjectQuery, PopulateOptions, Primary, Ref, RequiredEntityData, RoutineArgs, RoutineReturn, UnboxArray, IndexFilterQuery, WithUsingOptions } from './typings.js';
+import type { AnyString, ArrayElement, AutoPath, ConnectionType, Dictionary, EntityClass, EntityData, EntityDictionary, EntityDTO, EntityKey, EntityMetadata, EntityName, FilterDef, FilterQuery, FromEntityType, GetRepository, IHydrator, IsSubset, Loaded, MergeLoaded, MergeSelected, ObjectQuery, PopulateOptions, Primary, Ref, RequiredEntityData, RoutineArgs, RoutineReturn, SessionContext, UnboxArray, IndexFilterQuery, WithUsingOptions } from './typings.js';
 import type { Routine } from './metadata/Routine.js';
 import { FlushMode, LockMode, PopulatePath, type TransactionOptions } from './enums.js';
 import type { MetadataStorage } from './metadata/MetadataStorage.js';
@@ -95,7 +95,7 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
     /**
      * Registers global filter to this entity manager. Global filters are enabled by default (unless disabled via last parameter).
      */
-    addFilter<T extends EntityName | readonly EntityName[]>(options: FilterDef<T>): void;
+    addFilter<T extends EntityName | readonly EntityName[]>(options: Omit<FilterDef<T>, 'rls'>): void;
     /**
      * Sets filter parameter values globally inside context defined by this entity manager.
      * If you want to set shared value for all contexts, be sure to use the root entity manager.
@@ -105,6 +105,32 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
      * Returns filter parameters for given filter set in this context.
      */
     getFilterParams<T extends Dictionary = Dictionary>(name: string): T;
+    /**
+     * Sets the database session context (row level security) for this entity manager. Session variables are merged
+     * with any previously set ones, while the role is replaced when one is provided. The variables are applied via `set_config()` and are
+     * typically referenced by RLS policies through `current_setting()`.
+     */
+    setSessionContext(context: SessionContext): void;
+    private validateSessionContextStaging;
+    /** Merges into this exact instance — `fork()` must bypass context resolution to target the new fork. */
+    private mergeSessionContext;
+    /**
+     * Returns the database session context (row level security) set for this entity manager, or `undefined` if none.
+     */
+    getSessionContext(): SessionContext | undefined;
+    /**
+     * Clears the database session context, since `setSessionContext()` only ever merges variables and updates the role.
+     */
+    clearSessionContext(): void;
+    /** @internal session context to apply on `begin()` under the `'transaction'` strategy (`undefined` otherwise). */
+    getTransactionSessionContext(): SessionContext | undefined;
+    /**
+     * Wraps a driver call in a short implicit transaction when the session context needs to apply, so `set local`
+     * takes effect. Resolves to a plain call when already inside a transaction or when no session context is set.
+     *
+     * @internal
+     */
+    withSessionContext<T>(ctx: Transaction | undefined, cb: (ctx?: Transaction) => Promise<T>): Promise<T>;
     /**
      * Sets logger context for this entity manager.
      */
@@ -375,12 +401,10 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
      */
     nativeDelete<Entity extends object>(entityName: EntityName<Entity>, where: FilterQuery<NoInfer<Entity>>, options?: DeleteOptions<Entity>): Promise<number>;
     /**
-     * Maps raw database result to an entity and merges it to this EntityManager.
+     * Maps raw database result to an entity and merges it to this EntityManager by default.
+     * Use `disableIdentityMap` to return an isolated entity without affecting the current context.
      */
-    map<Entity extends object>(entityName: EntityName<Entity>, result: EntityDictionary<Entity>, options?: {
-        schema?: string;
-        mapped?: boolean;
-    }): Entity;
+    map<Entity extends object>(entityName: EntityName<Entity>, result: EntityDictionary<Entity>, options?: MapOptions): Entity;
     /**
      * Merges given entity to this EntityManager so it becomes managed. You can force refreshing of existing entities
      * via second parameter. By default, it will return already loaded entities without modifying them.
@@ -601,7 +625,7 @@ export declare class EntityManager<Driver extends IDatabaseDriver = IDatabaseDri
      * some additional lazy properties, if so, we reload and merge the data from database
      */
     protected shouldRefresh<T extends object, P extends string = never, F extends string = never, E extends string = never>(meta: EntityMetadata<T>, entity: T, options: FindOneOptions<T, P, F, E>): boolean;
-    protected prepareOptions(options: (FindOptions<any, any, any, any> | FindOneOptions<any, any, any, any> | CountOptions<any, any> | CountByOptions<any>) & AbortQueryOptions): void;
+    protected prepareOptions<Options extends (FindOptions<any, any, any, any> | FindOneOptions<any, any, any, any> | CountOptions<any, any> | CountByOptions<any>) & AbortQueryOptions>(options: Options): Options;
     /**
      * @internal
      */
@@ -667,6 +691,14 @@ export interface CreateOptions<Convert extends boolean> {
      */
     processOnCreateHooksEarly?: boolean;
 }
+export interface MapOptions {
+    /** schema to use when mapping the entity */
+    schema?: string;
+    /** set to true when the result is already mapped to entity property names */
+    mapped?: boolean;
+    /** map the entity in an isolated context without adding it to the identity map */
+    disableIdentityMap?: boolean;
+}
 export interface MergeOptions {
     refresh?: boolean;
     convertCustomTypes?: boolean;
@@ -694,6 +726,8 @@ export interface ForkOptions {
     keepTransactionContext?: boolean;
     /** default schema to use for this fork */
     schema?: string;
+    /** database session context (row level security) for this fork; inherited from the parent when not set */
+    session?: SessionContext;
     /** default logger context, can be overridden via {@apilink FindOptions} */
     loggerContext?: Dictionary;
     /**