feat(query-builder): allow autocomplete on qb.orderBy()

Related: #2747
mikro-orm · Feb 11, 2022 · fdf03c3 · fdf03c3
1 parent 7ce12d6
commit fdf03c3
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 7 deletions.
diff --git a/packages/core/src/entity/EntityLoader.ts b/packages/core/src/entity/EntityLoader.ts
@@ -297,8 +297,8 @@ export class EntityLoader {
     const filtered = Utils.unique(children);
     const fields = this.buildFields(options.fields, prop);
     const innerOrderBy = Utils.asArray(options.orderBy)
-      .filter(orderBy => Utils.isObject(orderBy[prop.name]))
-      .map(orderBy => orderBy[prop.name]);
+      .filter(orderBy => Utils.isObject(orderBy[prop.name as string]))
+      .map(orderBy => orderBy[prop.name as string]);
     const { refresh, filters, ignoreLazyScalarProperties, populateWhere } = options;
 
     await this.populate<T>(prop.type, filtered, populate.children, {

diff --git a/packages/core/src/enums.ts b/packages/core/src/enums.ts
@@ -1,4 +1,4 @@
-import type { ExpandProperty } from './typings';
+import type { Dictionary, ExcludeFunctions, ExpandProperty } from './typings';
 import type { Transaction } from './connections';
 
 export const enum FlushMode {
@@ -74,9 +74,11 @@ export type QueryOrderKeysFlat = QueryOrder | QueryOrderNumeric | keyof typeof Q
 export type QueryOrderKeys<T> = QueryOrderKeysFlat | QueryOrderMap<T>;
 
 export type QueryOrderMap<T> = {
-  [K in keyof T]?: QueryOrderKeys<ExpandProperty<T[K]>>;
+  [K in keyof T as ExcludeFunctions<T, K>]?: QueryOrderKeys<ExpandProperty<T[K]>>;
 };
 
+export type QBQueryOrderMap<T> = QueryOrderMap<T> | Dictionary;
+
 export interface FlatQueryOrderMap {
   [x: string]: QueryOrderKeysFlat;
 }

diff --git a/packages/knex/src/query/QueryBuilder.ts b/packages/knex/src/query/QueryBuilder.ts
@@ -1,7 +1,7 @@
 import type { Knex } from 'knex';
 import type {
   AnyEntity, Dictionary, EntityData, EntityMetadata, EntityProperty, FlatQueryOrderMap, RequiredEntityData,
-  GroupOperator, MetadataStorage, PopulateOptions, QBFilterQuery, QueryOrderMap, QueryResult, FlushMode, FilterQuery,
+  GroupOperator, MetadataStorage, PopulateOptions, QBFilterQuery, QueryOrderMap, QueryResult, FlushMode, FilterQuery, QBQueryOrderMap,
 } from '@mikro-orm/core';
 import { LoadStrategy, LockMode, QueryFlag, QueryHelper, ReferenceType, Utils, ValidationError } from '@mikro-orm/core';
 import { QueryType } from './enums';
@@ -226,7 +226,7 @@ export class QueryBuilder<T extends AnyEntity<T> = AnyEntity> {
     return this.where(cond as string, params, '$or');
   }
 
-  orderBy(orderBy: QueryOrderMap<unknown> | QueryOrderMap<unknown>[]): this {
+  orderBy(orderBy: QBQueryOrderMap<T> | QBQueryOrderMap<T>[]): this {
     this._orderBy = [];
     Utils.asArray(orderBy).forEach(o => {
       const processed = QueryHelper.processWhere(o as Dictionary, this.entityName, this.metadata, this.platform, false)!;

diff --git a/packages/mongodb/src/MongoConnection.ts b/packages/mongodb/src/MongoConnection.ts
@@ -120,7 +120,7 @@ export class MongoConnection extends Connection {
     let query = `db.getCollection('${collection}').find(${this.logObject(where)}, ${this.logObject(options)})`;
     orderBy = Utils.asArray(orderBy);
 
-    if (orderBy.length > 0) {
+    if (Array.isArray(orderBy) && orderBy.length > 0) {
       const orderByTuples: [string, number][] = [];
       orderBy.forEach(o => {
         Object.keys(o).forEach(k => {