From 69c613bdcfc611b61092ed438400ff37111e139a Mon Sep 17 00:00:00 2001
From: Clemens Grabmann <6975408+cgrabmann@users.noreply.github.com>
Date: Thu, 29 Apr 2021 19:13:39 +0200
Subject: [PATCH] fix(akita): restrict usage of sortByOrder to valid usages in
 type system

---
 libs/akita/src/lib/queryConfig.ts        | 17 +++++++++++++----
 libs/akita/src/lib/selectAllOverloads.ts |  9 ++++-----
 libs/akita/src/lib/types.ts              |  2 +-
 3 files changed, 18 insertions(+), 10 deletions(-)

diff --git a/libs/akita/src/lib/queryConfig.ts b/libs/akita/src/lib/queryConfig.ts
index 0bedd1ea..669a2d20 100644
--- a/libs/akita/src/lib/queryConfig.ts
+++ b/libs/akita/src/lib/queryConfig.ts
@@ -1,13 +1,22 @@
 import { Order } from './sort';
 
-export type SortBy<E, S = any> = ((a: E, b: E, state?: S) => number) | keyof E;
+type SortByFunction<E, S = any> = (a: E, b: E, state?: S) => number;
+type SortByKey<E> = keyof E;
+export type SortBy<E, S = any> = SortByFunction<E, S> | SortByKey<E>;
 
-export interface SortByOptions<E> {
-  sortBy?: SortBy<E>;
+interface SortByFunctionOptions<E> {
+  sortBy?: SortByFunction<E>;
+  sortByOrder?: undefined;
+}
+
+interface SortByKeyOptions<E> {
+  sortBy?: SortByKey<E>;
   sortByOrder?: Order;
 }
 
-export interface QueryConfigOptions<E = any> extends SortByOptions<E> {}
+export type SortByOptions<E> = SortByFunctionOptions<E> | SortByKeyOptions<E>;
+
+export type QueryConfigOptions<E = any> = SortByOptions<E>;
 
 export const queryConfigKey = 'akitaQueryConfig';
 
diff --git a/libs/akita/src/lib/selectAllOverloads.ts b/libs/akita/src/lib/selectAllOverloads.ts
index 7b92dee2..6ea6279e 100644
--- a/libs/akita/src/lib/selectAllOverloads.ts
+++ b/libs/akita/src/lib/selectAllOverloads.ts
@@ -1,9 +1,8 @@
 import { SelectOptions } from './types';
-import { SortBy } from './queryConfig';
-import { Order } from './sort';
+import { SortByOptions } from './queryConfig';
 
 export type SelectAllOptionsA<E> = { asObject: true; filterBy?: SelectOptions<E>['filterBy']; limitTo?: number; sortBy?: undefined; sortByOrder?: undefined };
-export type SelectAllOptionsB<E> = { filterBy: SelectOptions<E>['filterBy']; limitTo?: number; sortBy?: SortBy<E>; sortByOrder?: Order };
+export type SelectAllOptionsB<E> = { filterBy: SelectOptions<E>['filterBy']; limitTo?: number; } & SortByOptions<E>
 export type SelectAllOptionsC<E> = { asObject: true; limitTo?: number; sortBy?: undefined; sortByOrder?: undefined };
-export type SelectAllOptionsD<E> = { limitTo?: number; sortBy?: SortBy<E>; sortByOrder?: Order };
-export type SelectAllOptionsE<E> = { asObject: false; filterBy?: SelectOptions<E>['filterBy']; limitTo?: number; sortBy?: SortBy<E>; sortByOrder?: Order };
+export type SelectAllOptionsD<E> = { limitTo?: number; } & SortByOptions<E>
+export type SelectAllOptionsE<E> = { asObject: false; filterBy?: SelectOptions<E>['filterBy']; limitTo?: number; } & SortByOptions<E>
diff --git a/libs/akita/src/lib/types.ts b/libs/akita/src/lib/types.ts
index 77381130..3f8adc67 100644
--- a/libs/akita/src/lib/types.ts
+++ b/libs/akita/src/lib/types.ts
@@ -27,7 +27,7 @@ export interface MultiActiveState<T = ID> {
   active: T[];
 }
 
-export interface SelectOptions<E> extends SortByOptions<E> {
+export type SelectOptions<E> = SortByOptions<E> & {
   asObject?: boolean;
   filterBy?: ((entity: E, index?: number) => boolean) | ((entity: E, index?: number) => boolean)[] | undefined;
   limitTo?: number;