nestjs-query-mikro-orm 0.0.8 → 0.1.0

package/dist/index.d.cts

@@ -1,7 +1,6 @@
-import { EntityName, AnyEntity, FilterQuery, EntityMetadata } from '@mikro-orm/core';
+import { EntityName, AnyEntity, FilterQuery, EntityMetadata, EntityRepository } from '@mikro-orm/core';
 import { DynamicModule, FactoryProvider } from '@nestjs/common';
-import { QueryBuilder, EntityRepository } from '@mikro-orm/knex';
-import { AggregateResponse, AggregateQuery, Filter, Query, Paging, SortField, CommonFieldComparisonBetweenType, FilterComparisonOperators, Class, GetByIdOptions, FindRelationOptions, ModifyRelationOptions, QueryService, DeepPartial, FindByIdOptions, UpdateOneOptions, UpdateManyResponse, DeleteOneOptions, DeleteManyResponse, Filterable } from '@nestjs-query/core';
+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;
@@ -9,43 +8,6 @@ declare class NestjsQueryMikroOrmModule {
 
 declare const createMikroOrmQueryServiceProviders: (entities: EntityName<AnyEntity>[], contextName?: string) => FactoryProvider[];
 
-declare enum AggregateFuncs {
-    AVG = "AVG",
-    SUM = "SUM",
-    COUNT = "COUNT",
-    MAX = "MAX",
-    MIN = "MIN"
-}
-/**
- * @internal
- * Builds aggregate queries for MikroORM.
- */
-declare class AggregateBuilder<Entity extends object> {
-    static asyncConvertToAggregateResponse<Entity>(responsePromise: Promise<Record<string, unknown>[]>): Promise<AggregateResponse<Entity>[]>;
-    static getAggregateSelects<Entity>(query: AggregateQuery<Entity>): string[];
-    private static getAggregateGroupBySelects;
-    private static getAggregateFuncSelects;
-    static getAggregateAlias<Entity>(func: AggregateFuncs, field: keyof Entity): string;
-    static getGroupByAlias<Entity>(field: keyof Entity): string;
-    static convertToAggregateResponse<Entity>(rawAggregates: Record<string, unknown>[]): AggregateResponse<Entity>[];
-    /**
-     * Gets the actual database column name for a property from entity metadata.
-     * @param metadata - the entity metadata
-     * @param propertyName - the property name
-     * @returns the database column name
-     */
-    private getColumnName;
-    /**
-     * Builds aggregate SELECT clause for MikroORM QueryBuilder.
-     * @param qb - the MikroORM QueryBuilder
-     * @param aggregate - the aggregates to select.
-     * @param alias - optional alias to use to qualify an identifier
-     */
-    build<Qb extends QueryBuilder<Entity>>(qb: Qb, aggregate: AggregateQuery<Entity>, alias?: string): Qb;
-    private createAggSelect;
-    private createGroupBySelect;
-}
-
 /**
  * @internal
  * Builds a WHERE clause from a Filter for MikroORM.
@@ -83,6 +45,16 @@ declare class WhereBuilder<Entity> {
     private isBetweenValue;
 }
 
+interface QueryBuilder<T = unknown> {
+    andWhere?(filter: FilterQuery<T>): this;
+    orderBy?(o: Record<string, unknown> | unknown): this;
+    groupBy?(field: string): this;
+    addSelect?(s: unknown): this;
+    mainAlias?: {
+        metadata?: EntityMetadata<T>;
+    };
+}
+
 /**
  * @internal
  *
@@ -99,30 +71,24 @@ interface NestedRecord<E = unknown> {
 declare class FilterQueryBuilder<Entity extends object> {
     readonly repo: EntityRepository<Entity>;
     readonly whereBuilder: WhereBuilder<Entity>;
-    readonly aggregateBuilder: AggregateBuilder<Entity>;
-    constructor(repo: EntityRepository<Entity>, whereBuilder?: WhereBuilder<Entity>, aggregateBuilder?: AggregateBuilder<Entity>);
+    constructor(repo: EntityRepository<Entity>, whereBuilder?: WhereBuilder<Entity>);
     /**
-     * Create a MikroORM QueryBuilder with `WHERE`, `ORDER BY` and `LIMIT/OFFSET` clauses.
-     *
-     * @param query - the query to apply.
-     */
-    select(query: Query<Entity>): QueryBuilder<Entity>;
-    selectById(id: string | number | (string | number)[], query: Query<Entity>): QueryBuilder<Entity>;
-    aggregate(query: Query<Entity>, aggregate: AggregateQuery<Entity>): QueryBuilder<Entity>;
-    /**
-     * Applies paging to a MikroORM query builder
-     * @param qb - the MikroORM QueryBuilder
-     * @param paging - the Paging options.
+     * NOTE: QueryBuilder-specific helpers removed; use `buildFindOptions` to
+     * produce a filter and options for `em.find`/`repo.find`.
      */
-    applyPaging<Q extends QueryBuilder<Entity>>(qb: Q, paging?: Paging): Q;
     /**
-     * Applies the aggregate selects from a Query to a MikroORM QueryBuilder.
-     *
-     * @param qb - the MikroORM QueryBuilder.
-     * @param aggregate - the aggregates to select.
-     * @param alias - optional alias to use to qualify an identifier
+     * Build a filter query and find options suitable for `em.find`/`repo.find` calls.
+     * This keeps usage DB-agnostic by returning plain filter objects and options
+     * instead of driver-specific QueryBuilder instances.
      */
-    applyAggregate<Q extends QueryBuilder<Entity>>(qb: Q, aggregate: AggregateQuery<Entity>, alias?: string): Q;
+    buildFindOptions(query: Query<Entity>): {
+        filterQuery?: FilterQuery<Entity>;
+        options?: {
+            limit?: number;
+            offset?: number;
+            orderBy?: Record<string, unknown>;
+        };
+    };
     /**
      * Applies the filter from a Query to a MikroORM QueryBuilder.
      *
@@ -171,7 +137,7 @@ type EntityComparisonField<Entity, F extends keyof Entity> = Entity[F] | Entity[
  * Maps nestjs-query comparison operators to MikroORM operators.
  * This is a simplified version since MikroORM uses object-based filters.
  */
-declare class SQLComparisonBuilder<Entity> {
+declare class ComparisonBuilder<Entity> {
     /**
      * Maps a comparison operator to MikroORM filter format.
      *
@@ -202,12 +168,7 @@ declare class RelationQueryBuilder<Entity extends object, Relation extends objec
     readonly filterQueryBuilder: FilterQueryBuilder<Relation>;
     constructor(repo: EntityRepository<Entity>, relation: string);
     /**
-     * Builds and returns a QueryBuilder for selecting relations without executing it.
-     * This is useful for testing or when you need to inspect/modify the query before execution.
-     */
-    select(entity: Entity, query: Query<Relation>): QueryBuilder<Relation>;
-    /**
-     * Executes the select query and returns the results.
+     * Executes a relation select using `em.find` so the implementation is database-agnostic.
      */
     selectAndExecute(entity: Entity, query: Query<Relation>): Promise<Relation[]>;
     count(entity: Entity, query: Query<Relation>): Promise<number>;
@@ -221,6 +182,44 @@ declare class RelationQueryBuilder<Entity extends object, Relation extends objec
     }[];
 }
 
+declare enum AggregateFuncs {
+    AVG = "AVG",
+    SUM = "SUM",
+    COUNT = "COUNT",
+    MAX = "MAX",
+    MIN = "MIN"
+}
+/**
+ * @internal
+ * Builds aggregate queries for MikroORM.
+ */
+declare class AggregateBuilder<Entity extends object> {
+    static buildSelectExpressions<Entity>(aggregate: AggregateQuery<Entity>, alias?: string): [string, string][];
+    static asyncConvertToAggregateResponse<Entity>(responsePromise: Promise<Record<string, unknown>[]>): Promise<AggregateResponse<Entity>[]>;
+    static getAggregateSelects<Entity>(query: AggregateQuery<Entity>): string[];
+    private static getAggregateGroupBySelects;
+    private static getAggregateFuncSelects;
+    static getAggregateAlias<Entity>(func: AggregateFuncs, field: keyof Entity): string;
+    static getGroupByAlias<Entity>(field: keyof Entity): string;
+    static convertToAggregateResponse<Entity>(rawAggregates: Record<string, unknown>[]): AggregateResponse<Entity>[];
+    /**
+     * Gets the actual database column name for a property from entity metadata.
+     * @param metadata - the entity metadata
+     * @param propertyName - the property name
+     * @returns the database column name
+     */
+    private getColumnName;
+    /**
+     * Builds aggregate SELECT clause for MikroORM QueryBuilder.
+     * @param qb - the MikroORM QueryBuilder
+     * @param aggregate - the aggregates to select.
+     * @param alias - optional alias to use to qualify an identifier
+     */
+    build<Qb extends QueryBuilder<Entity>>(qb: Qb, aggregate: AggregateQuery<Entity>, alias?: string): Qb;
+    private createAggSelect;
+    private createGroupBySelect;
+}
+
 /**
  * Base class to house relations loading.
  * @internal
@@ -376,7 +375,7 @@ declare class MikroOrmQueryService<Entity extends object> extends RelationQueryS
     constructor(repo: EntityRepository<Entity>, opts?: MikroOrmQueryServiceOpts<Entity>);
     get EntityClass(): Class<Entity>;
     /**
-     * Query for multiple entities, using a Query from `@nestjs-query/core`.
+     * Query for multiple entities, using a Query from `@ptc-org/nestjs-query-core`.
      *
      * @example
      * ```ts
@@ -451,7 +450,7 @@ declare class MikroOrmQueryService<Entity extends object> extends RelationQueryS
      */
     updateOne(id: number | string, update: DeepPartial<Entity>, opts?: UpdateOneOptions<Entity>): Promise<Entity>;
     /**
-     * Update multiple entities with a `@nestjs-query/core` Filter.
+     * Update multiple entities with a `@ptc-org/nestjs-query-core` Filter.
      *
      * @example
      * ```ts
@@ -478,7 +477,7 @@ declare class MikroOrmQueryService<Entity extends object> extends RelationQueryS
      */
     deleteOne(id: string | number, opts?: DeleteOneOptions<Entity>): Promise<Entity>;
     /**
-     * Delete multiple records with a `@nestjs-query/core` `Filter`.
+     * Delete multiple records with a `@ptc-org/nestjs-query-core` `Filter`.
      *
      * @example
      *
@@ -505,7 +504,7 @@ declare class MikroOrmQueryService<Entity extends object> extends RelationQueryS
      */
     restoreOne(id: string | number, opts?: Filterable<Entity>): Promise<Entity>;
     /**
-     * Restores multiple records with a `@nestjs-query/core` `Filter`.
+     * Restores multiple records with a `@ptc-org/nestjs-query-core` `Filter`.
      *
      * @example
      *
@@ -525,4 +524,4 @@ declare class MikroOrmQueryService<Entity extends object> extends RelationQueryS
     private ensureSoftDeleteEnabled;
 }
 
-export { AggregateBuilder, type EntityComparisonField, type EntityIndexRelation, FilterQueryBuilder, MikroOrmQueryService, type MikroOrmQueryServiceOpts, type NestedRecord, NestjsQueryMikroOrmModule, RelationQueryBuilder, RelationQueryService, SQLComparisonBuilder, WhereBuilder, createMikroOrmQueryServiceProviders };
+export { AggregateBuilder, ComparisonBuilder, type EntityComparisonField, type EntityIndexRelation, FilterQueryBuilder, MikroOrmQueryService, type MikroOrmQueryServiceOpts, type NestedRecord, NestjsQueryMikroOrmModule, RelationQueryBuilder, RelationQueryService, WhereBuilder, createMikroOrmQueryServiceProviders };

package/dist/index.d.ts

@@ -1,7 +1,6 @@
-import { EntityName, AnyEntity, FilterQuery, EntityMetadata } from '@mikro-orm/core';
+import { EntityName, AnyEntity, FilterQuery, EntityMetadata, EntityRepository } from '@mikro-orm/core';
 import { DynamicModule, FactoryProvider } from '@nestjs/common';
-import { QueryBuilder, EntityRepository } from '@mikro-orm/knex';
-import { AggregateResponse, AggregateQuery, Filter, Query, Paging, SortField, CommonFieldComparisonBetweenType, FilterComparisonOperators, Class, GetByIdOptions, FindRelationOptions, ModifyRelationOptions, QueryService, DeepPartial, FindByIdOptions, UpdateOneOptions, UpdateManyResponse, DeleteOneOptions, DeleteManyResponse, Filterable } from '@nestjs-query/core';
+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;
@@ -9,43 +8,6 @@ declare class NestjsQueryMikroOrmModule {
 
 declare const createMikroOrmQueryServiceProviders: (entities: EntityName<AnyEntity>[], contextName?: string) => FactoryProvider[];
 
-declare enum AggregateFuncs {
-    AVG = "AVG",
-    SUM = "SUM",
-    COUNT = "COUNT",
-    MAX = "MAX",
-    MIN = "MIN"
-}
-/**
- * @internal
- * Builds aggregate queries for MikroORM.
- */
-declare class AggregateBuilder<Entity extends object> {
-    static asyncConvertToAggregateResponse<Entity>(responsePromise: Promise<Record<string, unknown>[]>): Promise<AggregateResponse<Entity>[]>;
-    static getAggregateSelects<Entity>(query: AggregateQuery<Entity>): string[];
-    private static getAggregateGroupBySelects;
-    private static getAggregateFuncSelects;
-    static getAggregateAlias<Entity>(func: AggregateFuncs, field: keyof Entity): string;
-    static getGroupByAlias<Entity>(field: keyof Entity): string;
-    static convertToAggregateResponse<Entity>(rawAggregates: Record<string, unknown>[]): AggregateResponse<Entity>[];
-    /**
-     * Gets the actual database column name for a property from entity metadata.
-     * @param metadata - the entity metadata
-     * @param propertyName - the property name
-     * @returns the database column name
-     */
-    private getColumnName;
-    /**
-     * Builds aggregate SELECT clause for MikroORM QueryBuilder.
-     * @param qb - the MikroORM QueryBuilder
-     * @param aggregate - the aggregates to select.
-     * @param alias - optional alias to use to qualify an identifier
-     */
-    build<Qb extends QueryBuilder<Entity>>(qb: Qb, aggregate: AggregateQuery<Entity>, alias?: string): Qb;
-    private createAggSelect;
-    private createGroupBySelect;
-}
-
 /**
  * @internal
  * Builds a WHERE clause from a Filter for MikroORM.
@@ -83,6 +45,16 @@ declare class WhereBuilder<Entity> {
     private isBetweenValue;
 }
 
+interface QueryBuilder<T = unknown> {
+    andWhere?(filter: FilterQuery<T>): this;
+    orderBy?(o: Record<string, unknown> | unknown): this;
+    groupBy?(field: string): this;
+    addSelect?(s: unknown): this;
+    mainAlias?: {
+        metadata?: EntityMetadata<T>;
+    };
+}
+
 /**
  * @internal
  *
@@ -99,30 +71,24 @@ interface NestedRecord<E = unknown> {
 declare class FilterQueryBuilder<Entity extends object> {
     readonly repo: EntityRepository<Entity>;
     readonly whereBuilder: WhereBuilder<Entity>;
-    readonly aggregateBuilder: AggregateBuilder<Entity>;
-    constructor(repo: EntityRepository<Entity>, whereBuilder?: WhereBuilder<Entity>, aggregateBuilder?: AggregateBuilder<Entity>);
+    constructor(repo: EntityRepository<Entity>, whereBuilder?: WhereBuilder<Entity>);
     /**
-     * Create a MikroORM QueryBuilder with `WHERE`, `ORDER BY` and `LIMIT/OFFSET` clauses.
-     *
-     * @param query - the query to apply.
-     */
-    select(query: Query<Entity>): QueryBuilder<Entity>;
-    selectById(id: string | number | (string | number)[], query: Query<Entity>): QueryBuilder<Entity>;
-    aggregate(query: Query<Entity>, aggregate: AggregateQuery<Entity>): QueryBuilder<Entity>;
-    /**
-     * Applies paging to a MikroORM query builder
-     * @param qb - the MikroORM QueryBuilder
-     * @param paging - the Paging options.
+     * NOTE: QueryBuilder-specific helpers removed; use `buildFindOptions` to
+     * produce a filter and options for `em.find`/`repo.find`.
      */
-    applyPaging<Q extends QueryBuilder<Entity>>(qb: Q, paging?: Paging): Q;
     /**
-     * Applies the aggregate selects from a Query to a MikroORM QueryBuilder.
-     *
-     * @param qb - the MikroORM QueryBuilder.
-     * @param aggregate - the aggregates to select.
-     * @param alias - optional alias to use to qualify an identifier
+     * Build a filter query and find options suitable for `em.find`/`repo.find` calls.
+     * This keeps usage DB-agnostic by returning plain filter objects and options
+     * instead of driver-specific QueryBuilder instances.
      */
-    applyAggregate<Q extends QueryBuilder<Entity>>(qb: Q, aggregate: AggregateQuery<Entity>, alias?: string): Q;
+    buildFindOptions(query: Query<Entity>): {
+        filterQuery?: FilterQuery<Entity>;
+        options?: {
+            limit?: number;
+            offset?: number;
+            orderBy?: Record<string, unknown>;
+        };
+    };
     /**
      * Applies the filter from a Query to a MikroORM QueryBuilder.
      *
@@ -171,7 +137,7 @@ type EntityComparisonField<Entity, F extends keyof Entity> = Entity[F] | Entity[
  * Maps nestjs-query comparison operators to MikroORM operators.
  * This is a simplified version since MikroORM uses object-based filters.
  */
-declare class SQLComparisonBuilder<Entity> {
+declare class ComparisonBuilder<Entity> {
     /**
      * Maps a comparison operator to MikroORM filter format.
      *
@@ -202,12 +168,7 @@ declare class RelationQueryBuilder<Entity extends object, Relation extends objec
     readonly filterQueryBuilder: FilterQueryBuilder<Relation>;
     constructor(repo: EntityRepository<Entity>, relation: string);
     /**
-     * Builds and returns a QueryBuilder for selecting relations without executing it.
-     * This is useful for testing or when you need to inspect/modify the query before execution.
-     */
-    select(entity: Entity, query: Query<Relation>): QueryBuilder<Relation>;
-    /**
-     * Executes the select query and returns the results.
+     * Executes a relation select using `em.find` so the implementation is database-agnostic.
      */
     selectAndExecute(entity: Entity, query: Query<Relation>): Promise<Relation[]>;
     count(entity: Entity, query: Query<Relation>): Promise<number>;
@@ -221,6 +182,44 @@ declare class RelationQueryBuilder<Entity extends object, Relation extends objec
     }[];
 }
 
+declare enum AggregateFuncs {
+    AVG = "AVG",
+    SUM = "SUM",
+    COUNT = "COUNT",
+    MAX = "MAX",
+    MIN = "MIN"
+}
+/**
+ * @internal
+ * Builds aggregate queries for MikroORM.
+ */
+declare class AggregateBuilder<Entity extends object> {
+    static buildSelectExpressions<Entity>(aggregate: AggregateQuery<Entity>, alias?: string): [string, string][];
+    static asyncConvertToAggregateResponse<Entity>(responsePromise: Promise<Record<string, unknown>[]>): Promise<AggregateResponse<Entity>[]>;
+    static getAggregateSelects<Entity>(query: AggregateQuery<Entity>): string[];
+    private static getAggregateGroupBySelects;
+    private static getAggregateFuncSelects;
+    static getAggregateAlias<Entity>(func: AggregateFuncs, field: keyof Entity): string;
+    static getGroupByAlias<Entity>(field: keyof Entity): string;
+    static convertToAggregateResponse<Entity>(rawAggregates: Record<string, unknown>[]): AggregateResponse<Entity>[];
+    /**
+     * Gets the actual database column name for a property from entity metadata.
+     * @param metadata - the entity metadata
+     * @param propertyName - the property name
+     * @returns the database column name
+     */
+    private getColumnName;
+    /**
+     * Builds aggregate SELECT clause for MikroORM QueryBuilder.
+     * @param qb - the MikroORM QueryBuilder
+     * @param aggregate - the aggregates to select.
+     * @param alias - optional alias to use to qualify an identifier
+     */
+    build<Qb extends QueryBuilder<Entity>>(qb: Qb, aggregate: AggregateQuery<Entity>, alias?: string): Qb;
+    private createAggSelect;
+    private createGroupBySelect;
+}
+
 /**
  * Base class to house relations loading.
  * @internal
@@ -376,7 +375,7 @@ declare class MikroOrmQueryService<Entity extends object> extends RelationQueryS
     constructor(repo: EntityRepository<Entity>, opts?: MikroOrmQueryServiceOpts<Entity>);
     get EntityClass(): Class<Entity>;
     /**
-     * Query for multiple entities, using a Query from `@nestjs-query/core`.
+     * Query for multiple entities, using a Query from `@ptc-org/nestjs-query-core`.
      *
      * @example
      * ```ts
@@ -451,7 +450,7 @@ declare class MikroOrmQueryService<Entity extends object> extends RelationQueryS
      */
     updateOne(id: number | string, update: DeepPartial<Entity>, opts?: UpdateOneOptions<Entity>): Promise<Entity>;
     /**
-     * Update multiple entities with a `@nestjs-query/core` Filter.
+     * Update multiple entities with a `@ptc-org/nestjs-query-core` Filter.
      *
      * @example
      * ```ts
@@ -478,7 +477,7 @@ declare class MikroOrmQueryService<Entity extends object> extends RelationQueryS
      */
     deleteOne(id: string | number, opts?: DeleteOneOptions<Entity>): Promise<Entity>;
     /**
-     * Delete multiple records with a `@nestjs-query/core` `Filter`.
+     * Delete multiple records with a `@ptc-org/nestjs-query-core` `Filter`.
      *
      * @example
      *
@@ -505,7 +504,7 @@ declare class MikroOrmQueryService<Entity extends object> extends RelationQueryS
      */
     restoreOne(id: string | number, opts?: Filterable<Entity>): Promise<Entity>;
     /**
-     * Restores multiple records with a `@nestjs-query/core` `Filter`.
+     * Restores multiple records with a `@ptc-org/nestjs-query-core` `Filter`.
      *
      * @example
      *
@@ -525,4 +524,4 @@ declare class MikroOrmQueryService<Entity extends object> extends RelationQueryS
     private ensureSoftDeleteEnabled;
 }
 
-export { AggregateBuilder, type EntityComparisonField, type EntityIndexRelation, FilterQueryBuilder, MikroOrmQueryService, type MikroOrmQueryServiceOpts, type NestedRecord, NestjsQueryMikroOrmModule, RelationQueryBuilder, RelationQueryService, SQLComparisonBuilder, WhereBuilder, createMikroOrmQueryServiceProviders };
+export { AggregateBuilder, ComparisonBuilder, type EntityComparisonField, type EntityIndexRelation, FilterQueryBuilder, MikroOrmQueryService, type MikroOrmQueryServiceOpts, type NestedRecord, NestjsQueryMikroOrmModule, RelationQueryBuilder, RelationQueryService, WhereBuilder, createMikroOrmQueryServiceProviders };