feat: add {sort: { multi: true }} option to resolvers which have sort arg. This option makes sort arg as List where the client can provide several sorting keys.

closes #210

Author: nodkz

src/resolvers/__tests__/findMany-test.ts

@@ -1,8 +1,9 @@
-import { Resolver, schemaComposer, ObjectTypeComposer } from 'graphql-compose';
+import { Resolver, schemaComposer, ObjectTypeComposer, EnumTypeComposer } from 'graphql-compose';
 import { UserModel, IUser } from '../../__mocks__/userModel';
 import { findMany } from '../findMany';
 import { convertModelToGraphQL } from '../../fieldsConverter';
 import { ExtendedResolveParams } from '..';
+import { testFieldConfig } from '../../utils/testHelpers';
 
 beforeAll(() => UserModel.base.createConnection());
 afterAll(() => UserModel.base.disconnect());
@@ -155,4 +156,37 @@ describe('findMany() ->', () => {
       expect(resolver.getArgITC('filter').getFieldTypeName('age')).toBe('Float');
     });
   });
+
+  it('should support multi sort', async () => {
+    let spyQuery: any;
+    const resolver = findMany(UserModel, UserTC, { sort: { multi: true } }).wrapResolve(
+      (next) => (rp) => {
+        const res = next(rp);
+        spyQuery = rp.query;
+        return res;
+      }
+    );
+
+    expect((resolver.getArgTC('sort') as EnumTypeComposer).getFieldNames()).toEqual(
+      expect.arrayContaining([
+        '_ID_ASC',
+        '_ID_DESC',
+        'NAME_ASC',
+        'NAME_DESC',
+        'NAME__AGE_ASC',
+        'NAME__AGE_DESC',
+      ])
+    );
+    const res = await testFieldConfig({
+      field: resolver,
+      args: {
+        sort: ['_ID_ASC', 'NAME_ASC', '_ID_DESC'],
+      },
+      selection: `{
+        name
+      }`,
+    });
+    expect(res).toEqual([{ name: 'userName1' }, { name: 'userName2' }]);
+    expect(spyQuery?.options).toEqual({ limit: 1000, sort: { _id: 1, name: 1 } });
+  });
 });

src/resolvers/findByIds.ts

@@ -36,7 +36,7 @@ export interface FindByIdsResolverOpts {
 type TArgs = {
   _ids: any;
   limit?: number;
-  sort?: Record<string, any>;
+  sort?: string | string[] | Record<string, any>;
 };
 
 export function findByIds<TSource = any, TContext = any, TDoc extends Document = any>(

src/resolvers/findMany.ts

@@ -46,7 +46,7 @@ type TArgs = {
   filter?: any;
   limit?: number;
   skip?: number;
-  sort?: Record<string, any>;
+  sort?: string | string[] | Record<string, any>;
 };
 
 export function findMany<TSource = any, TContext = any, TDoc extends Document = any>(

src/resolvers/findOne.ts

@@ -40,7 +40,7 @@ export interface FindOneResolverOpts {
 
 type TArgs = {
   filter?: any;
-  sort?: Record<string, any>;
+  sort?: string | string[] | Record<string, any>;
   skip?: number;
 };
 

src/resolvers/helpers/__tests__/sort-test.ts

@@ -76,8 +76,17 @@ describe('Resolver helper `sort` ->', () => {
       const args: any = sortHelperArgs(UserTC, UserModel, {
         sortTypeName: 'SortInput',
       });
+      expect(args.sort.type.getTypeName()).toBe('SortInput');
       expect(args.sort.type).toBeInstanceOf(EnumTypeComposer);
     });
+
+    it('should return sort field as List', () => {
+      const args: any = sortHelperArgs(UserTC, UserModel, {
+        sortTypeName: 'SortInput',
+        multi: true,
+      });
+      expect(args.sort.type.getTypeName()).toBe('[SortInput!]');
+    });
   });
 
   describe('sortHelper()', () => {

src/resolvers/helpers/sort.ts

@@ -1,17 +1,23 @@
 /* eslint-disable no-use-before-define */
 
 import type { Model, Document } from 'mongoose';
-import type {
+import {
   ObjectTypeComposerArgumentConfigMapDefinition,
   ObjectTypeComposer,
   SchemaComposer,
   EnumTypeComposer,
+  isObject,
 } from 'graphql-compose';
 import { getIndexesFromModel, extendByReversedIndexes } from '../../utils/getIndexesFromModel';
 import type { ExtendedResolveParams } from '../index';
 
 export type SortHelperArgsOpts = {
   sortTypeName?: string;
+  /**
+   * Allow sort by several fields.
+   * This makes arg as array of sort values.
+   */
+  multi?: boolean;
 };
 
 export function sortHelperArgs<TDoc extends Document = any>(
@@ -35,14 +41,34 @@ export function sortHelperArgs<TDoc extends Document = any>(
 
   return {
     sort: {
-      type: gqSortType,
+      type: opts?.multi ? gqSortType.NonNull.List : gqSortType,
     },
   };
 }
 
 export function sortHelper(resolveParams: ExtendedResolveParams): void {
-  const sort = resolveParams && resolveParams.args && resolveParams.args.sort;
-  if (sort && typeof sort === 'object' && Object.keys(sort).length > 0) {
+  const _sort = resolveParams?.args?.sort;
+  if (!_sort) return;
+
+  let sort: Record<string, any>;
+  if (Array.isArray(_sort)) {
+    sort = {};
+    // combine array in one object,
+    // keep only first key occurrence (rest skip)
+    _sort.forEach((o) => {
+      if (isObject(o)) {
+        Object.keys(o).forEach((key) => {
+          if (!sort.hasOwnProperty(key)) {
+            sort[key] = (o as any)[key];
+          }
+        });
+      }
+    });
+  } else {
+    sort = _sort;
+  }
+
+  if (typeof sort === 'object' && Object.keys(sort).length > 0) {
     resolveParams.query = resolveParams.query.sort(sort);
   }
 }

src/resolvers/removeOne.ts

@@ -23,7 +23,7 @@ export interface RemoveOneResolverOpts {
 
 type TArgs = {
   filter?: any;
-  sort?: Record<string, any>;
+  sort?: string | string[] | Record<string, any>;
 };
 
 export function removeOne<TSource = any, TContext = any, TDoc extends Document = any>(

src/resolvers/updateMany.ts

@@ -38,7 +38,7 @@ type TArgs = {
   filter?: any;
   limit?: number;
   skip?: number;
-  sort?: string;
+  sort?: string | string[] | Record<string, any>;
 };
 
 export function updateMany<TSource = any, TContext = any, TDoc extends Document = any>(

src/resolvers/updateOne.ts

@@ -32,7 +32,7 @@ type TArgs = {
   record: any;
   filter?: any;
   skip?: number;
-  sort?: Record<string, any>;
+  sort?: string | string[] | Record<string, any>;
 };
 
 export function updateOne<TSource = any, TContext = any, TDoc extends Document = any>(