nestjs-query-mikro-orm 0.1.3 → 0.1.5

package/dist/index.d.cts

@@ -1,13 +1,7 @@
-import { EntityName, AnyEntity, FilterQuery, EntityMetadata, EntityRepository } from '@mikro-orm/core';
+import { FilterQuery, EntityMetadata, EntityRepository, AnyEntity, EntityName } from '@mikro-orm/core';
 import { DynamicModule, FactoryProvider } from '@nestjs/common';
 import { Filter, Query, SortField, FilterComparisonOperators, CommonFieldComparisonBetweenType, AggregateQuery, AggregateResponse, Class, GetByIdOptions, FindRelationOptions, ModifyRelationOptions, QueryService, DeepPartial, FindByIdOptions, UpdateOneOptions, UpdateManyResponse, DeleteOneOptions, DeleteManyResponse, Filterable } from '@ptc-org/nestjs-query-core';
 
-declare class NestjsQueryMikroOrmModule {
-    static forFeature(entities: EntityName<AnyEntity>[], contextName?: string): DynamicModule;
-}
-
-declare const createMikroOrmQueryServiceProviders: (entities: EntityName<AnyEntity>[], contextName?: string) => FactoryProvider[];
-
 /**
  * @internal
  * Builds a WHERE clause from a Filter for MikroORM.
@@ -154,6 +148,11 @@ declare class ComparisonBuilder<Entity> {
     private isBetweenVal;
 }
 
+type RelationLoadStrategy = 'select-in' | 'joined' | 'balanced';
+interface RelationLoadOptions {
+    strategy?: RelationLoadStrategy;
+    useDataloader?: boolean;
+}
 type EntityIndexRelation<Relation> = Relation & {
     __nestjsQuery__entityIndex__: number;
 };
@@ -168,18 +167,32 @@ declare class RelationQueryBuilder<Entity extends object, Relation extends objec
     readonly filterQueryBuilder: FilterQueryBuilder<Relation>;
     constructor(repo: EntityRepository<Entity>, relation: string);
     /**
-     * Executes a relation select using `em.find` so the implementation is database-agnostic.
+     * Executes a relation select using MikroORM native relation population first.
      */
-    selectAndExecute(entity: Entity, query: Query<Relation>): Promise<Relation[]>;
+    selectAndExecute(entity: Entity, query: Query<Relation>, loadOptions?: RelationLoadOptions): Promise<Relation[]>;
+    batchSelectAndExecute(entities: Entity[], query: Query<Relation>, loadOptions?: RelationLoadOptions): Promise<Map<Entity, Relation[]>>;
+    populateEntityRelation(entity: Entity, useDataloader?: boolean, strategy?: RelationLoadStrategy): Promise<boolean>;
     count(entity: Entity, query: Query<Relation>): Promise<number>;
     aggregate(entity: Entity, query: Query<Relation>, aggregateQuery: AggregateQuery<Relation>): Promise<Record<string, unknown>[]>;
-    private buildWhereCondition;
     private getRelationMeta;
     get entityIndexColName(): string;
     getRelationPrimaryKeysPropertyNameAndColumnsName(): {
         columnName: string;
         propertyName: string;
     }[];
+    private getNativeLoadOptions;
+    private getNativePopulateOptions;
+    private tryBatchLoadRelationsNatively;
+    private tryLoadRelationsNatively;
+    private readLoadedRelation;
+    private applyPaging;
+    private applyPagingToMap;
+    private serializePrimaryKeyValue;
+    private hasFilterSortingOrPaging;
+    private hasFilterOrSorting;
+    private queryResolvedRelations;
+    private queryByOwnerCondition;
+    private buildWhereCondition;
 }
 
 declare enum AggregateFuncs {
@@ -220,15 +233,26 @@ declare class AggregateBuilder<Entity extends object> {
     private createGroupBySelect;
 }
 
+type RelationLoadingStrategy = RelationLoadStrategy;
+interface RelationLoadingOptions {
+    strategy?: RelationLoadingStrategy;
+    useDataloader?: boolean;
+}
+interface RelationQueryServiceOpts {
+    relationLoading?: RelationLoadingOptions;
+}
 /**
  * Base class to house relations loading.
  * @internal
  */
 declare abstract class RelationQueryService<Entity extends object> {
+    protected readonly relationLoadingStrategy: RelationLoadingStrategy | undefined;
+    protected readonly nativeLoadUseDataloader: boolean;
     abstract filterQueryBuilder: FilterQueryBuilder<Entity>;
     abstract EntityClass: Class<Entity>;
     abstract repo: EntityRepository<Entity>;
     abstract getById(id: string | number, opts?: GetByIdOptions<Entity>): Promise<Entity>;
+    constructor(opts?: RelationQueryServiceOpts);
     /**
      * Query for an array of relations.
      * @param RelationClass - The class to serialize the relations into.
@@ -343,6 +367,7 @@ declare abstract class RelationQueryService<Entity extends object> {
      */
     private batchFindRelations;
     private isRelationClassIdentity;
+    private getRelationLoadOptions;
     private getRelationMeta;
     private getRelationEntity;
     private getRelations;
@@ -352,6 +377,7 @@ declare abstract class RelationQueryService<Entity extends object> {
 interface MikroOrmQueryServiceOpts<Entity extends object> {
     useSoftDelete?: boolean;
     filterQueryBuilder?: FilterQueryBuilder<Entity>;
+    relationLoading?: RelationLoadingOptions;
 }
 /**
  * Base class for all query services that use a MikroORM EntityRepository.
@@ -525,4 +551,14 @@ declare class MikroOrmQueryService<Entity extends object> extends RelationQueryS
     private ensureSoftDeleteEnabled;
 }
 
-export { AggregateBuilder, ComparisonBuilder, type EntityComparisonField, type EntityIndexRelation, FilterQueryBuilder, MikroOrmQueryService, type MikroOrmQueryServiceOpts, type NestedRecord, NestjsQueryMikroOrmModule, RelationQueryBuilder, RelationQueryService, WhereBuilder, createMikroOrmQueryServiceProviders };
+interface NestjsQueryMikroOrmFeatureOptions {
+    contextName?: string;
+    queryServiceOpts?: MikroOrmQueryServiceOpts<AnyEntity>;
+}
+declare class NestjsQueryMikroOrmModule {
+    static forFeature(entities: EntityName<AnyEntity>[], contextNameOrOptions?: string | NestjsQueryMikroOrmFeatureOptions): DynamicModule;
+}
+
+declare const createMikroOrmQueryServiceProviders: (entities: EntityName<AnyEntity>[], contextName?: string, opts?: MikroOrmQueryServiceOpts<AnyEntity>) => FactoryProvider[];
+
+export { AggregateBuilder, ComparisonBuilder, type EntityComparisonField, type EntityIndexRelation, FilterQueryBuilder, MikroOrmQueryService, type MikroOrmQueryServiceOpts, type NestedRecord, type NestjsQueryMikroOrmFeatureOptions, NestjsQueryMikroOrmModule, type RelationLoadOptions, type RelationLoadStrategy, type RelationLoadingOptions, type RelationLoadingStrategy, RelationQueryBuilder, RelationQueryService, type RelationQueryServiceOpts, WhereBuilder, createMikroOrmQueryServiceProviders };

package/dist/index.d.ts

@@ -1,13 +1,7 @@
-import { EntityName, AnyEntity, FilterQuery, EntityMetadata, EntityRepository } from '@mikro-orm/core';
+import { FilterQuery, EntityMetadata, EntityRepository, AnyEntity, EntityName } from '@mikro-orm/core';
 import { DynamicModule, FactoryProvider } from '@nestjs/common';
 import { Filter, Query, SortField, FilterComparisonOperators, CommonFieldComparisonBetweenType, AggregateQuery, AggregateResponse, Class, GetByIdOptions, FindRelationOptions, ModifyRelationOptions, QueryService, DeepPartial, FindByIdOptions, UpdateOneOptions, UpdateManyResponse, DeleteOneOptions, DeleteManyResponse, Filterable } from '@ptc-org/nestjs-query-core';
 
-declare class NestjsQueryMikroOrmModule {
-    static forFeature(entities: EntityName<AnyEntity>[], contextName?: string): DynamicModule;
-}
-
-declare const createMikroOrmQueryServiceProviders: (entities: EntityName<AnyEntity>[], contextName?: string) => FactoryProvider[];
-
 /**
  * @internal
  * Builds a WHERE clause from a Filter for MikroORM.
@@ -154,6 +148,11 @@ declare class ComparisonBuilder<Entity> {
     private isBetweenVal;
 }
 
+type RelationLoadStrategy = 'select-in' | 'joined' | 'balanced';
+interface RelationLoadOptions {
+    strategy?: RelationLoadStrategy;
+    useDataloader?: boolean;
+}
 type EntityIndexRelation<Relation> = Relation & {
     __nestjsQuery__entityIndex__: number;
 };
@@ -168,18 +167,32 @@ declare class RelationQueryBuilder<Entity extends object, Relation extends objec
     readonly filterQueryBuilder: FilterQueryBuilder<Relation>;
     constructor(repo: EntityRepository<Entity>, relation: string);
     /**
-     * Executes a relation select using `em.find` so the implementation is database-agnostic.
+     * Executes a relation select using MikroORM native relation population first.
      */
-    selectAndExecute(entity: Entity, query: Query<Relation>): Promise<Relation[]>;
+    selectAndExecute(entity: Entity, query: Query<Relation>, loadOptions?: RelationLoadOptions): Promise<Relation[]>;
+    batchSelectAndExecute(entities: Entity[], query: Query<Relation>, loadOptions?: RelationLoadOptions): Promise<Map<Entity, Relation[]>>;
+    populateEntityRelation(entity: Entity, useDataloader?: boolean, strategy?: RelationLoadStrategy): Promise<boolean>;
     count(entity: Entity, query: Query<Relation>): Promise<number>;
     aggregate(entity: Entity, query: Query<Relation>, aggregateQuery: AggregateQuery<Relation>): Promise<Record<string, unknown>[]>;
-    private buildWhereCondition;
     private getRelationMeta;
     get entityIndexColName(): string;
     getRelationPrimaryKeysPropertyNameAndColumnsName(): {
         columnName: string;
         propertyName: string;
     }[];
+    private getNativeLoadOptions;
+    private getNativePopulateOptions;
+    private tryBatchLoadRelationsNatively;
+    private tryLoadRelationsNatively;
+    private readLoadedRelation;
+    private applyPaging;
+    private applyPagingToMap;
+    private serializePrimaryKeyValue;
+    private hasFilterSortingOrPaging;
+    private hasFilterOrSorting;
+    private queryResolvedRelations;
+    private queryByOwnerCondition;
+    private buildWhereCondition;
 }
 
 declare enum AggregateFuncs {
@@ -220,15 +233,26 @@ declare class AggregateBuilder<Entity extends object> {
     private createGroupBySelect;
 }
 
+type RelationLoadingStrategy = RelationLoadStrategy;
+interface RelationLoadingOptions {
+    strategy?: RelationLoadingStrategy;
+    useDataloader?: boolean;
+}
+interface RelationQueryServiceOpts {
+    relationLoading?: RelationLoadingOptions;
+}
 /**
  * Base class to house relations loading.
  * @internal
  */
 declare abstract class RelationQueryService<Entity extends object> {
+    protected readonly relationLoadingStrategy: RelationLoadingStrategy | undefined;
+    protected readonly nativeLoadUseDataloader: boolean;
     abstract filterQueryBuilder: FilterQueryBuilder<Entity>;
     abstract EntityClass: Class<Entity>;
     abstract repo: EntityRepository<Entity>;
     abstract getById(id: string | number, opts?: GetByIdOptions<Entity>): Promise<Entity>;
+    constructor(opts?: RelationQueryServiceOpts);
     /**
      * Query for an array of relations.
      * @param RelationClass - The class to serialize the relations into.
@@ -343,6 +367,7 @@ declare abstract class RelationQueryService<Entity extends object> {
      */
     private batchFindRelations;
     private isRelationClassIdentity;
+    private getRelationLoadOptions;
     private getRelationMeta;
     private getRelationEntity;
     private getRelations;
@@ -352,6 +377,7 @@ declare abstract class RelationQueryService<Entity extends object> {
 interface MikroOrmQueryServiceOpts<Entity extends object> {
     useSoftDelete?: boolean;
     filterQueryBuilder?: FilterQueryBuilder<Entity>;
+    relationLoading?: RelationLoadingOptions;
 }
 /**
  * Base class for all query services that use a MikroORM EntityRepository.
@@ -525,4 +551,14 @@ declare class MikroOrmQueryService<Entity extends object> extends RelationQueryS
     private ensureSoftDeleteEnabled;
 }
 
-export { AggregateBuilder, ComparisonBuilder, type EntityComparisonField, type EntityIndexRelation, FilterQueryBuilder, MikroOrmQueryService, type MikroOrmQueryServiceOpts, type NestedRecord, NestjsQueryMikroOrmModule, RelationQueryBuilder, RelationQueryService, WhereBuilder, createMikroOrmQueryServiceProviders };
+interface NestjsQueryMikroOrmFeatureOptions {
+    contextName?: string;
+    queryServiceOpts?: MikroOrmQueryServiceOpts<AnyEntity>;
+}
+declare class NestjsQueryMikroOrmModule {
+    static forFeature(entities: EntityName<AnyEntity>[], contextNameOrOptions?: string | NestjsQueryMikroOrmFeatureOptions): DynamicModule;
+}
+
+declare const createMikroOrmQueryServiceProviders: (entities: EntityName<AnyEntity>[], contextName?: string, opts?: MikroOrmQueryServiceOpts<AnyEntity>) => FactoryProvider[];
+
+export { AggregateBuilder, ComparisonBuilder, type EntityComparisonField, type EntityIndexRelation, FilterQueryBuilder, MikroOrmQueryService, type MikroOrmQueryServiceOpts, type NestedRecord, type NestjsQueryMikroOrmFeatureOptions, NestjsQueryMikroOrmModule, type RelationLoadOptions, type RelationLoadStrategy, type RelationLoadingOptions, type RelationLoadingStrategy, RelationQueryBuilder, RelationQueryService, type RelationQueryServiceOpts, WhereBuilder, createMikroOrmQueryServiceProviders };