feat: Search filtering logic (#6968)

* commit

* controller/service/repository logic

* use enum

* openapi

* suggest people

* suggest place/camera

* cursor hover

* refactor

* Add try catch

* Remove get people with name service

* Remove deadcode

* people selection

* People placement

* sort people

* Update server/src/domain/repositories/metadata.repository.ts

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>

* pr feedback

* styling

* done

* open api

* fix test

* use string type

* remmove bad merge

* use correct type

* fix test

* fix lint

* remove unused code

* remove unused code

* pr feedback

* pr feedback

---------

Co-authored-by: Jason Rasmussen <jrasm91@gmail.com>

mobile/openapi/.openapi-generator/FILES

@@ -120,6 +120,7 @@ doc/SearchExploreResponseDto.md
 doc/SearchFacetCountResponseDto.md
 doc/SearchFacetResponseDto.md
 doc/SearchResponseDto.md
+doc/SearchSuggestionType.md
 doc/ServerConfigDto.md
 doc/ServerFeaturesDto.md
 doc/ServerInfoApi.md
@@ -313,6 +314,7 @@ lib/model/search_explore_response_dto.dart
 lib/model/search_facet_count_response_dto.dart
 lib/model/search_facet_response_dto.dart
 lib/model/search_response_dto.dart
+lib/model/search_suggestion_type.dart
 lib/model/server_config_dto.dart
 lib/model/server_features_dto.dart
 lib/model/server_info_response_dto.dart
@@ -485,6 +487,7 @@ test/search_explore_response_dto_test.dart
 test/search_facet_count_response_dto_test.dart
 test/search_facet_response_dto_test.dart
 test/search_response_dto_test.dart
+test/search_suggestion_type_test.dart
 test/server_config_dto_test.dart
 test/server_features_dto_test.dart
 test/server_info_api_test.dart

mobile/openapi/README.md

@@ -161,6 +161,7 @@ Class | Method | HTTP request | Description
 *PersonApi* | [**updatePeople**](doc//PersonApi.md#updatepeople) | **PUT** /person | 
 *PersonApi* | [**updatePerson**](doc//PersonApi.md#updateperson) | **PUT** /person/{id} | 
 *SearchApi* | [**getExploreData**](doc//SearchApi.md#getexploredata) | **GET** /search/explore | 
+*SearchApi* | [**getSearchSuggestions**](doc//SearchApi.md#getsearchsuggestions) | **GET** /search/suggestions | 
 *SearchApi* | [**search**](doc//SearchApi.md#search) | **GET** /search | 
 *SearchApi* | [**searchMetadata**](doc//SearchApi.md#searchmetadata) | **GET** /search/metadata | 
 *SearchApi* | [**searchPerson**](doc//SearchApi.md#searchperson) | **GET** /search/person | 
@@ -315,6 +316,7 @@ Class | Method | HTTP request | Description
  - [SearchFacetCountResponseDto](doc//SearchFacetCountResponseDto.md)
  - [SearchFacetResponseDto](doc//SearchFacetResponseDto.md)
  - [SearchResponseDto](doc//SearchResponseDto.md)
+ - [SearchSuggestionType](doc//SearchSuggestionType.md)
  - [ServerConfigDto](doc//ServerConfigDto.md)
  - [ServerFeaturesDto](doc//ServerFeaturesDto.md)
  - [ServerInfoResponseDto](doc//ServerInfoResponseDto.md)

mobile/openapi/doc/SearchApi.md

@@ -10,6 +10,7 @@ All URIs are relative to */api*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**getExploreData**](SearchApi.md#getexploredata) | **GET** /search/explore | 
+[**getSearchSuggestions**](SearchApi.md#getsearchsuggestions) | **GET** /search/suggestions | 
 [**search**](SearchApi.md#search) | **GET** /search | 
 [**searchMetadata**](SearchApi.md#searchmetadata) | **GET** /search/metadata | 
 [**searchPerson**](SearchApi.md#searchperson) | **GET** /search/person | 
@@ -67,6 +68,69 @@ This endpoint does not need any parameter.
 
 [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
 
+# **getSearchSuggestions**
+> List<String> getSearchSuggestions(type, country, make, model, state)
+
+
+
+### Example
+```dart
+import 'package:openapi/api.dart';
+// TODO Configure API key authorization: cookie
+//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKey = 'YOUR_API_KEY';
+// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//defaultApiClient.getAuthentication<ApiKeyAuth>('cookie').apiKeyPrefix = 'Bearer';
+// TODO Configure API key authorization: api_key
+//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKey = 'YOUR_API_KEY';
+// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
+//defaultApiClient.getAuthentication<ApiKeyAuth>('api_key').apiKeyPrefix = 'Bearer';
+// TODO Configure HTTP Bearer authorization: bearer
+// Case 1. Use String Token
+//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken('YOUR_ACCESS_TOKEN');
+// Case 2. Use Function which generate token.
+// String yourTokenGeneratorFunction() { ... }
+//defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
+
+final api_instance = SearchApi();
+final type = ; // SearchSuggestionType | 
+final country = country_example; // String | 
+final make = make_example; // String | 
+final model = model_example; // String | 
+final state = state_example; // String | 
+
+try {
+    final result = api_instance.getSearchSuggestions(type, country, make, model, state);
+    print(result);
+} catch (e) {
+    print('Exception when calling SearchApi->getSearchSuggestions: $e\n');
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **type** | [**SearchSuggestionType**](.md)|  | 
+ **country** | **String**|  | [optional] 
+ **make** | **String**|  | [optional] 
+ **model** | **String**|  | [optional] 
+ **state** | **String**|  | [optional] 
+
+### Return type
+
+**List<String>**
+
+### Authorization
+
+[cookie](../README.md#cookie), [api_key](../README.md#api_key), [bearer](../README.md#bearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
 # **search**
 > SearchResponseDto search(clip, motion, page, q, query, recent, size, smart, type, withArchived)
 
@@ -91,7 +155,7 @@ import 'package:openapi/api.dart';
 //defaultApiClient.getAuthentication<HttpBearerAuth>('bearer').setAccessToken(yourTokenGeneratorFunction);
 
 final api_instance = SearchApi();
-final clip = true; // bool | @deprecated
+final clip = true; // bool | 
 final motion = true; // bool | 
 final page = 8.14; // num | 
 final q = q_example; // String | 
@@ -114,7 +178,7 @@ try {
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **clip** | **bool**| @deprecated | [optional] 
+ **clip** | **bool**|  | [optional] 
  **motion** | **bool**|  | [optional] 
  **page** | **num**|  | [optional] 
  **q** | **String**|  | [optional] 

mobile/openapi/doc/SearchSuggestionType.md

@@ -0,0 +1,14 @@
+# openapi.model.SearchSuggestionType
+
+## Load the model package
+```dart
+import 'package:openapi/api.dart';
+```
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

mobile/openapi/lib/api.dart

@@ -153,6 +153,7 @@ part 'model/search_explore_response_dto.dart';
 part 'model/search_facet_count_response_dto.dart';
 part 'model/search_facet_response_dto.dart';
 part 'model/search_response_dto.dart';
+part 'model/search_suggestion_type.dart';
 part 'model/server_config_dto.dart';
 part 'model/server_features_dto.dart';
 part 'model/server_info_response_dto.dart';

mobile/openapi/lib/api/search_api.dart

@@ -60,11 +60,90 @@ class SearchApi {
     return null;
   }
 
+  /// Performs an HTTP 'GET /search/suggestions' operation and returns the [Response].
+  /// Parameters:
+  ///
+  /// * [SearchSuggestionType] type (required):
+  ///
+  /// * [String] country:
+  ///
+  /// * [String] make:
+  ///
+  /// * [String] model:
+  ///
+  /// * [String] state:
+  Future<Response> getSearchSuggestionsWithHttpInfo(SearchSuggestionType type, { String? country, String? make, String? model, String? state, }) async {
+    // ignore: prefer_const_declarations
+    final path = r'/search/suggestions';
+
+    // ignore: prefer_final_locals
+    Object? postBody;
+
+    final queryParams = <QueryParam>[];
+    final headerParams = <String, String>{};
+    final formParams = <String, String>{};
+
+    if (country != null) {
+      queryParams.addAll(_queryParams('', 'country', country));
+    }
+    if (make != null) {
+      queryParams.addAll(_queryParams('', 'make', make));
+    }
+    if (model != null) {
+      queryParams.addAll(_queryParams('', 'model', model));
+    }
+    if (state != null) {
+      queryParams.addAll(_queryParams('', 'state', state));
+    }
+      queryParams.addAll(_queryParams('', 'type', type));
+
+    const contentTypes = <String>[];
+
+
+    return apiClient.invokeAPI(
+      path,
+      'GET',
+      queryParams,
+      postBody,
+      headerParams,
+      formParams,
+      contentTypes.isEmpty ? null : contentTypes.first,
+    );
+  }
+
+  /// Parameters:
+  ///
+  /// * [SearchSuggestionType] type (required):
+  ///
+  /// * [String] country:
+  ///
+  /// * [String] make:
+  ///
+  /// * [String] model:
+  ///
+  /// * [String] state:
+  Future<List<String>?> getSearchSuggestions(SearchSuggestionType type, { String? country, String? make, String? model, String? state, }) async {
+    final response = await getSearchSuggestionsWithHttpInfo(type,  country: country, make: make, model: model, state: state, );
+    if (response.statusCode >= HttpStatus.badRequest) {
+      throw ApiException(response.statusCode, await _decodeBodyBytes(response));
+    }
+    // When a remote server returns no body with a status of 204, we shall not decode it.
+    // At the time of writing this, `dart:convert` will throw an "Unexpected end of input"
+    // FormatException when trying to decode an empty string.
+    if (response.body.isNotEmpty && response.statusCode != HttpStatus.noContent) {
+      final responseBody = await _decodeBodyBytes(response);
+      return (await apiClient.deserializeAsync(responseBody, 'List<String>') as List)
+        .cast<String>()
+        .toList(growable: false);
+
+    }
+    return null;
+  }
+
   /// Performs an HTTP 'GET /search' operation and returns the [Response].
   /// Parameters:
   ///
   /// * [bool] clip:
-  ///   @deprecated
   ///
   /// * [bool] motion:
   ///
@@ -142,7 +221,6 @@ class SearchApi {
   /// Parameters:
   ///
   /// * [bool] clip:
-  ///   @deprecated
   ///
   /// * [bool] motion:
   ///

mobile/openapi/lib/api_client.dart

@@ -388,6 +388,8 @@ class ApiClient {
           return SearchFacetResponseDto.fromJson(value);
         case 'SearchResponseDto':
           return SearchResponseDto.fromJson(value);
+        case 'SearchSuggestionType':
+          return SearchSuggestionTypeTypeTransformer().decode(value);
         case 'ServerConfigDto':
           return ServerConfigDto.fromJson(value);
         case 'ServerFeaturesDto':

mobile/openapi/lib/api_helper.dart

@@ -109,6 +109,9 @@ String parameterToString(dynamic value) {
   if (value is ReactionType) {
     return ReactionTypeTypeTransformer().encode(value).toString();
   }
+  if (value is SearchSuggestionType) {
+    return SearchSuggestionTypeTypeTransformer().encode(value).toString();
+  }
   if (value is SharedLinkType) {
     return SharedLinkTypeTypeTransformer().encode(value).toString();
   }

mobile/openapi/lib/model/search_suggestion_type.dart

@@ -0,0 +1,94 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+part of openapi.api;
+
+
+class SearchSuggestionType {
+  /// Instantiate a new enum with the provided [value].
+  const SearchSuggestionType._(this.value);
+
+  /// The underlying value of this enum member.
+  final String value;
+
+  @override
+  String toString() => value;
+
+  String toJson() => value;
+
+  static const country = SearchSuggestionType._(r'country');
+  static const state = SearchSuggestionType._(r'state');
+  static const city = SearchSuggestionType._(r'city');
+  static const cameraMake = SearchSuggestionType._(r'camera-make');
+  static const cameraModel = SearchSuggestionType._(r'camera-model');
+
+  /// List of all possible values in this [enum][SearchSuggestionType].
+  static const values = <SearchSuggestionType>[
+    country,
+    state,
+    city,
+    cameraMake,
+    cameraModel,
+  ];
+
+  static SearchSuggestionType? fromJson(dynamic value) => SearchSuggestionTypeTypeTransformer().decode(value);
+
+  static List<SearchSuggestionType> listFromJson(dynamic json, {bool growable = false,}) {
+    final result = <SearchSuggestionType>[];
+    if (json is List && json.isNotEmpty) {
+      for (final row in json) {
+        final value = SearchSuggestionType.fromJson(row);
+        if (value != null) {
+          result.add(value);
+        }
+      }
+    }
+    return result.toList(growable: growable);
+  }
+}
+
+/// Transformation class that can [encode] an instance of [SearchSuggestionType] to String,
+/// and [decode] dynamic data back to [SearchSuggestionType].
+class SearchSuggestionTypeTypeTransformer {
+  factory SearchSuggestionTypeTypeTransformer() => _instance ??= const SearchSuggestionTypeTypeTransformer._();
+
+  const SearchSuggestionTypeTypeTransformer._();
+
+  String encode(SearchSuggestionType data) => data.value;
+
+  /// Decodes a [dynamic value][data] to a SearchSuggestionType.
+  ///
+  /// If [allowNull] is true and the [dynamic value][data] cannot be decoded successfully,
+  /// then null is returned. However, if [allowNull] is false and the [dynamic value][data]
+  /// cannot be decoded successfully, then an [UnimplementedError] is thrown.
+  ///
+  /// The [allowNull] is very handy when an API changes and a new enum value is added or removed,
+  /// and users are still using an old app with the old code.
+  SearchSuggestionType? decode(dynamic data, {bool allowNull = true}) {
+    if (data != null) {
+      switch (data) {
+        case r'country': return SearchSuggestionType.country;
+        case r'state': return SearchSuggestionType.state;
+        case r'city': return SearchSuggestionType.city;
+        case r'camera-make': return SearchSuggestionType.cameraMake;
+        case r'camera-model': return SearchSuggestionType.cameraModel;
+        default:
+          if (!allowNull) {
+            throw ArgumentError('Unknown enum value to decode: $data');
+          }
+      }
+    }
+    return null;
+  }
+
+  /// Singleton [SearchSuggestionTypeTypeTransformer] instance.
+  static SearchSuggestionTypeTypeTransformer? _instance;
+}
+

mobile/openapi/test/search_api_test.dart

@@ -22,6 +22,11 @@ void main() {
       // TODO
     });
 
+    //Future<List<String>> getSearchSuggestions(SearchSuggestionType type, { String country, String make, String model, String state }) async
+    test('test getSearchSuggestions', () async {
+      // TODO
+    });
+
     //Future<SearchResponseDto> search({ bool clip, bool motion, num page, String q, String query, bool recent, num size, bool smart, String type, bool withArchived }) async
     test('test search', () async {
       // TODO

mobile/openapi/test/search_suggestion_type_test.dart

@@ -0,0 +1,21 @@
+//
+// AUTO-GENERATED FILE, DO NOT MODIFY!
+//
+// @dart=2.12
+
+// ignore_for_file: unused_element, unused_import
+// ignore_for_file: always_put_required_named_parameters_first
+// ignore_for_file: constant_identifier_names
+// ignore_for_file: lines_longer_than_80_chars
+
+import 'package:openapi/api.dart';
+import 'package:test/test.dart';
+
+// tests for SearchSuggestionType
+void main() {
+
+  group('test SearchSuggestionType', () {
+
+  });
+
+}