Add new QuerySort object to search responses

Author: Dan Jones

src/query/response/api-response.ts

@@ -19,10 +19,17 @@ export type ApiAskModeResponse = {
   sources?: ApiSource[];
 };
 
+export type ApiQuerySort = {
+  property_name: string;
+  order: "ascending" | "descending";
+  tie_break?: ApiQuerySort;
+};
+
 export type ApiSearch = {
   query?: string;
   filters?: ApiPropertyFilter | ApiFilterAndOr;
   collection: string;
+  sort_property?: ApiQuerySort;
 };
 
 export type ApiAggregation = {

src/query/response/response-mapping.ts

@@ -16,6 +16,7 @@ import {
   AskModeResponse,
   Search,
   ModelUnitUsage,
+  QuerySort,
 } from "./response.js";
 
 import {
@@ -32,6 +33,7 @@ import {
   ApiAskModeResponse,
   ApiSearch,
   ApiModelUnitUsage,
+  ApiQuerySort,
 } from "./api-response.js";
 
 import { ServerSentEvent } from "./server-sent-events.js";
@@ -67,8 +69,17 @@ const mapSearches = (searches: ApiSearch[]): Search[] =>
     query: search.query,
     filters: search.filters ? mapFilter(search.filters) : undefined,
     collection: search.collection,
+    sortProperty: search.sort_property
+      ? mapQuerySort(search.sort_property)
+      : undefined,
   }));
 
+const mapQuerySort = (sort: ApiQuerySort): QuerySort => ({
+  propertyName: sort.property_name,
+  order: sort.order,
+  tieBreak: sort.tie_break ? mapQuerySort(sort.tie_break) : undefined,
+});
+
 const mapUsage = (usage: ApiModelUnitUsage): ModelUnitUsage => ({
   modelUnits: usage.model_units,
   usageInPlan: usage.usage_in_plan,

src/query/response/response.ts

@@ -17,6 +17,7 @@ export type Search = {
   query?: string;
   filters?: PropertyFilter | FilterAndOr;
   collection: string;
+  sortProperty?: QuerySort;
 };
 
 export type Aggregation = {
@@ -37,6 +38,12 @@ export type ModelUnitUsage = {
   remainingPlanRequests: number;
 };
 
+export type QuerySort = {
+  propertyName: string;
+  order: "ascending" | "descending";
+  tieBreak?: QuerySort;
+};
+
 export type QueryAgentResponse = {
   outputType: "finalState";
   originalQuery: string;