feat: show Culture and Leisure Division's venues first in relevance sort

Dependent on changes made in unified-search PRs:
- City-of-Helsinki/unified-search#209
  - Add showCultureAndLeisureDivisionFirst parameter to unifiedSearch
    query & isCultureAndLeisureDivisionVenue to UnifiedSearchVenue type
- City-of-Helsinki/unified-search#218
  - Add eventCount in UnifiedSearchVenue type

also:
- update schemas & generated types
- include isCultureAndLeisureDivisionVenue value in venue list to be
  able to verify results' sorting easier

refs LIIKUNTA-684

Author: karisal-anders

apps/sports-helsinki/config/vitest/mockDataUtils.ts

@@ -453,6 +453,7 @@ export const fakeVenuesSearchList = (
               reservation: null,
               serviceOwner: null,
               targetGroups: [],
+              isCultureAndLeisureDivisionVenue: true,
             },
           },
         };

apps/sports-helsinki/src/domain/search/combinedSearch/adapters/VenueSearchAdapter.ts

@@ -6,7 +6,6 @@ import type {
   AppLanguage,
   Coordinates,
   OrderByDistance,
-  UnifiedSearchLanguage,
 } from '@events-helsinki/components/types';
 import {
   SortOrder,
@@ -43,6 +42,7 @@ class VenueSearchAdapter implements CombinedSearchAdapter<VenueSearchParams> {
   orderByName: VenueSearchParams['orderByName'];
   orderByDistance: VenueSearchParams['orderByDistance'];
   orderByAccessibilityProfile: VenueSearchParams['orderByAccessibilityProfile'];
+  showCultureAndLeisureDivisionFirst: VenueSearchParams['showCultureAndLeisureDivisionFirst'];
   after?: VenueSearchParams['after'];
   first?: VenueSearchParams['first'];
 
@@ -60,9 +60,7 @@ class VenueSearchAdapter implements CombinedSearchAdapter<VenueSearchParams> {
     // Initialize the object with default values
     Object.assign(this, initialVenueSearchAdapterValues);
 
-    this.language = appToUnifiedSearchLanguageMap[
-      locale
-    ] as UnifiedSearchLanguage;
+    this.language = appToUnifiedSearchLanguageMap[locale];
     this.text = input.text || initialVenueSearchAdapterValues.text;
     this.ontologyTreeIdOrSets =
       this.getOntologyTreeIdOrSets(input) ||
@@ -74,6 +72,7 @@ class VenueSearchAdapter implements CombinedSearchAdapter<VenueSearchParams> {
       ? [ServiceOwnerType.MunicipalService]
       : initialVenueSearchAdapterValues.serviceOwnerTypes;
     this.mustHaveReservableResource = !!input.reservable;
+
     if (input.venueOrderBy?.includes('name')) {
       this.orderByName = input.venueOrderBy.startsWith('-')
         ? { order: SortOrder.Descending }
@@ -88,6 +87,10 @@ class VenueSearchAdapter implements CombinedSearchAdapter<VenueSearchParams> {
       } as OrderByDistance;
     } else if (isAccessibilityProfile(input.venueOrderBy)) {
       this.orderByAccessibilityProfile = input.venueOrderBy;
+    } else {
+      // Only show Culture and Leisure Division's venues first
+      // if no other specific ordering is defined → means "Sort by relevance",
+      this.showCultureAndLeisureDivisionFirst = true;
     }
   }
 

apps/sports-helsinki/src/domain/search/combinedSearch/adapters/__tests__/CombinedSearchFormAdapter.test.ts

@@ -131,6 +131,7 @@ describe('CombinedSearchFormAdapter', () => {
           first: AppConfig.pageSize,
           ontologyTreeIdOrSets: [['551']],
           openAt: null,
+          showCultureAndLeisureDivisionFirst: true,
         },
       ],
       [

apps/sports-helsinki/src/domain/search/combinedSearch/adapters/__tests__/VenueSearchAdapter.test.ts

@@ -1,14 +1,40 @@
+import type { Coordinates } from '@events-helsinki/components';
 import {
+  OrderDir,
   SENIORS_ONTOLOGY_TREE_IDS,
+  UnifiedSearchOrderBy,
   YOUTH_ONTOLOGY_TREE_IDS,
 } from '@events-helsinki/components';
 import { SortOrder, TARGET_GROUPS } from '@events-helsinki/components/types';
 import AppConfig from '../../../../app/AppConfig';
+import { initialCombinedSearchFormValues } from '../../constants';
 import type { CombinedSearchAdapterInput } from '../../types';
 import VenueSearchAdapter from '../VenueSearchAdapter';
 
 const locale = 'fi';
 
+const TEST_GEOLOCATION = {
+  latitude: 12.5,
+  longitude: 34.75,
+} as const satisfies Coordinates;
+
+const VENUE_ORDER_BY_RELEVANCE_COMBINATIONS = [
+  undefined,
+  null,
+  '',
+  `${UnifiedSearchOrderBy.relevance}-${OrderDir.asc}`,
+  `${UnifiedSearchOrderBy.relevance}-${OrderDir.desc}`,
+] as const;
+
+const VENUE_ORDER_BY_NAME_OR_DISTANCE_COMBINATIONS = [
+  `${UnifiedSearchOrderBy.name}-${OrderDir.asc}`,
+  `${UnifiedSearchOrderBy.name}-${OrderDir.desc}`,
+  `${UnifiedSearchOrderBy.distance}-${OrderDir.asc}`,
+  `${UnifiedSearchOrderBy.distance}-${OrderDir.desc}`,
+] as const;
+
+const TEST_TEXTS = ['test', '', null, '*'] as const;
+
 describe('VenueSearchAdapter', () => {
   describe('getQueryVariables', () => {
     it('converts the form values input to a desired search variables as an output', () => {
@@ -64,4 +90,61 @@ describe('VenueSearchAdapter', () => {
       );
     });
   });
+
+  describe('showCultureAndLeisureDivisionFirst is undefined', () => {
+    it.each(VENUE_ORDER_BY_NAME_OR_DISTANCE_COMBINATIONS)(
+      'when sorting by %s regardless of search text',
+      (venueOrderBy) => {
+        for (const text in TEST_TEXTS) {
+          const input: CombinedSearchAdapterInput = {
+            ...initialCombinedSearchFormValues,
+            text,
+            venueOrderBy,
+          };
+          const adapter = new VenueSearchAdapter(
+            input,
+            locale,
+            TEST_GEOLOCATION
+          );
+          expect(
+            adapter.getQueryVariables()['showCultureAndLeisureDivisionFirst']
+          ).toBeUndefined();
+        }
+      }
+    );
+  });
+
+  describe('showCultureAndLeisureDivisionFirst set to true', () => {
+    it('by default', () => {
+      const adapter = new VenueSearchAdapter(
+        initialCombinedSearchFormValues,
+        locale,
+        TEST_GEOLOCATION
+      );
+      expect(
+        adapter.getQueryVariables()['showCultureAndLeisureDivisionFirst']
+      ).toStrictEqual(true);
+    });
+
+    it.each(VENUE_ORDER_BY_RELEVANCE_COMBINATIONS)(
+      'when sorting by %s regardless of search text',
+      (venueOrderBy) => {
+        for (const text in TEST_TEXTS) {
+          const input: CombinedSearchAdapterInput = {
+            ...initialCombinedSearchFormValues,
+            text,
+            venueOrderBy,
+          };
+          const adapter = new VenueSearchAdapter(
+            input,
+            locale,
+            TEST_GEOLOCATION
+          );
+          expect(
+            adapter.getQueryVariables()['showCultureAndLeisureDivisionFirst']
+          ).toStrictEqual(true);
+        }
+      }
+    );
+  });
 });

apps/sports-helsinki/src/domain/search/combinedSearch/types.ts

@@ -134,6 +134,7 @@ export type VenueSearchParams = Pick<
   | 'orderByName'
   | 'orderByDistance'
   | 'orderByAccessibilityProfile'
+  | 'showCultureAndLeisureDivisionFirst'
   | 'after'
   | 'first'
 >;

packages/components/src/components/domain/unifiedSearch/graphql/unifiedSearchList.query.ts

@@ -18,6 +18,7 @@ export const SEARCH_LIST_QUERY = gql`
     $orderByAccessibilityProfile: AccessibilityProfile
     $showAccessibilityShortcomingsFor: AccessibilityProfile
     $mustHaveReservableResource: Boolean
+    $showCultureAndLeisureDivisionFirst: Boolean
     $includeHaukiFields: Boolean = true
   ) {
     unifiedSearch(
@@ -37,6 +38,7 @@ export const SEARCH_LIST_QUERY = gql`
       orderByDistance: $orderByDistance
       orderByName: $orderByName
       orderByAccessibilityProfile: $orderByAccessibilityProfile
+      showCultureAndLeisureDivisionFirst: $showCultureAndLeisureDivisionFirst
     ) {
       count
       pageInfo {
@@ -49,6 +51,7 @@ export const SEARCH_LIST_QUERY = gql`
             meta {
               id
             }
+            isCultureAndLeisureDivisionVenue
             name {
               fi
               sv