catalog-client: reuse EntityOrderQuery

Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>

packages/catalog-client/api-report.md

@@ -188,12 +188,6 @@ export type EntityOrderQuery =
       order: 'asc' | 'desc';
     }>;
 
-// @public
-export type EntitySortField = {
-  field: string;
-  order: 'asc' | 'desc';
-};
-
 // @public
 export interface GetEntitiesByRefsRequest {
   entityRefs: string[];
@@ -268,7 +262,7 @@ export type GetPaginatedEntitiesInitialRequest =
       fields?: string[];
       limit?: number;
       filter?: EntitiesFilter;
-      sortFields?: EntitySortField[];
+      sortFields?: EntityOrderQuery;
       query?: string;
     }
   | undefined;

packages/catalog-client/src/CatalogClient.ts

@@ -224,8 +224,8 @@ export class CatalogClient implements CatalogApi {
         params.push(`limit=${limit}`);
       }
       if (sortFields !== undefined) {
-        sortFields.forEach(({ field, order }) =>
-          params.push(`sortField=${field},${order}`),
+        (Array.isArray(sortFields) ? sortFields : [sortFields]).forEach(
+          ({ field, order }) => params.push(`sortField=${field},${order}`),
         );
       }
       if (fields.length) {

packages/catalog-client/src/types/api.ts

@@ -366,13 +366,6 @@ export type EntitiesFilter =
   | Record<string, string | symbol | (string | symbol)[]>
   | undefined;
 
-/**
- * Used for sorting the entities.
- *
- * @public
- */
-export type EntitySortField = { field: string; order: 'asc' | 'desc' };
-
 /**
  * The response type for {@link CatalogClient.addLocation}.
  *
@@ -418,7 +411,7 @@ export type GetPaginatedEntitiesInitialRequest =
       fields?: string[];
       limit?: number;
       filter?: EntitiesFilter;
-      sortFields?: EntitySortField[];
+      sortFields?: EntityOrderQuery;
       query?: string;
     }
   | undefined;

packages/catalog-client/src/types/index.ts

@@ -26,7 +26,6 @@ export type {
   GetEntitiesByRefsRequest,
   GetEntitiesByRefsResponse,
   EntitiesFilter,
-  EntitySortField,
   GetEntitiesRequest,
   GetEntitiesResponse,
   GetEntityAncestorsRequest,