Merge #279

279: Adds support to multi-index search r=brunoocasali a=ahmednfwela

# Pull Request

## Related issue
Related to #267

## What does this PR do?
- Introduce `SearchQuery`, `MultiSearchQuery`, `MultiSearchResult`
- Add  `Future<MultiSearchResult> multiSearch(MultiSearchQuery requests);` to `MeiliSearchClient`
- [Breaking Change] Changed the signature of `Searcheable`, `SearchResult`, `PaginatedSearchResult` to be immutable with prober inheritance 

## PR checklist
Please check if your PR fulfills the following requirements:
- [ ] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

cc `@brunoocasali` after his holiday :)

Co-authored-by: Ahmed Fwela <[email protected]>

Author: bors[bot]

lib/meilisearch.dart

@@ -4,6 +4,9 @@ export 'src/client.dart';
 export 'src/index.dart';
 export 'src/settings/_exports.dart';
 export 'src/search_result.dart';
+export 'src/multi_search_result.dart';
+export 'src/multi_search_query.dart';
+export 'src/search_query.dart';
 export 'src/filter_builder/_exports.dart';
 export 'src/paginated_search_result.dart';
 export 'src/query_parameters/documents_query.dart';

lib/src/client.dart

@@ -10,6 +10,8 @@ import 'package:meilisearch/src/swap_index.dart';
 import 'package:meilisearch/src/tasks_results.dart';
 import 'package:meilisearch/src/task.dart';
 
+import 'multi_search_query.dart';
+import 'multi_search_result.dart';
 import 'http_request.dart';
 import 'index.dart';
 import 'client_impl.dart';
@@ -51,6 +53,9 @@ abstract class MeiliSearchClient {
     DateTime? expiresAt,
   });
 
+  /// does a Multi-index search
+  Future<MultiSearchResult> multiSearch(MultiSearchQuery requests);
+
   /// Create an index object by given [uid].
   MeiliSearchIndex index(String uid);
 

lib/src/client_impl.dart

@@ -10,6 +10,8 @@ import 'package:meilisearch/src/tasks_results.dart';
 import 'package:meilisearch/src/task.dart';
 import 'package:meilisearch/src/tenant_token.dart';
 
+import 'multi_search_result.dart';
+import 'multi_search_query.dart';
 import 'http_request.dart';
 import 'http_request_impl.dart';
 
@@ -258,4 +260,14 @@ class MeiliSearchClientImpl implements MeiliSearchClient {
 
     return Task.fromMap(response.data!);
   }
+
+  @override
+  Future<MultiSearchResult> multiSearch(MultiSearchQuery query) async {
+    final response = await http.postMethod<Map<String, Object?>>(
+      '/multi-search',
+      data: query.toMap(),
+    );
+
+    return MultiSearchResult.fromMap(response.data!);
+  }
 }

lib/src/index_impl.dart

@@ -1,6 +1,7 @@
 import 'dart:convert';
 import 'package:dio/dio.dart';
 import 'result.dart';
+import 'search_query.dart';
 import 'searchable.dart';
 import 'settings/_exports.dart';
 import 'tasks_results.dart';
@@ -126,30 +127,33 @@ class MeiliSearchIndexImpl implements MeiliSearchIndex {
     String? highlightPostTag,
     MatchingStrategy? matchingStrategy,
   }) async {
-    final data = <String, Object?>{
-      'q': query,
-      'offset': offset,
-      'limit': limit,
-      'page': page,
-      'hitsPerPage': hitsPerPage,
-      'filter': filter ?? filterExpression?.transform(),
-      'sort': sort,
-      'facets': facets,
-      'attributesToRetrieve': attributesToRetrieve,
-      'attributesToCrop': attributesToCrop,
-      'cropLength': cropLength,
-      'attributesToHighlight': attributesToHighlight,
-      'showMatchesPosition': showMatchesPosition,
-      'cropMarker': cropMarker,
-      'highlightPreTag': highlightPreTag,
-      'highlightPostTag': highlightPostTag,
-      'matchingStrategy': matchingStrategy?.name,
-    };
-    data.removeWhere((k, v) => v == null);
-    final response = await http
-        .postMethod<Map<String, Object?>>('/indexes/$uid/search', data: data);
-
-    return Searcheable.createSearchResult(response.data!);
+    final data = SearchQuery(
+      indexUid: uid,
+      query: query,
+      offset: offset,
+      limit: limit,
+      page: page,
+      hitsPerPage: hitsPerPage,
+      filter: filter,
+      filterExpression: filterExpression,
+      sort: sort,
+      facets: facets,
+      attributesToRetrieve: attributesToRetrieve,
+      attributesToCrop: attributesToCrop,
+      cropLength: cropLength,
+      attributesToHighlight: attributesToHighlight,
+      showMatchesPosition: showMatchesPosition,
+      cropMarker: cropMarker,
+      highlightPreTag: highlightPreTag,
+      highlightPostTag: highlightPostTag,
+      matchingStrategy: matchingStrategy,
+    ).toMap();
+
+    final response = await http.postMethod<Map<String, Object?>>(
+        '/indexes/$uid/search',
+        data: data..remove('indexUid'));
+
+    return Searcheable.createSearchResult(response.data!, indexUid: uid);
   }
 
   //

lib/src/multi_search_query.dart

@@ -0,0 +1,13 @@
+import 'search_query.dart';
+
+class MultiSearchQuery {
+  final List<SearchQuery> queries;
+
+  const MultiSearchQuery({
+    required this.queries,
+  });
+
+  Map<String, Object?> toMap() {
+    return {'queries': queries.map((e) => e.toMap()).toList()};
+  }
+}

lib/src/multi_search_result.dart

@@ -0,0 +1,18 @@
+import 'searchable.dart';
+
+class MultiSearchResult {
+  final List<Searcheable> results;
+
+  const MultiSearchResult({
+    required this.results,
+  });
+
+  factory MultiSearchResult.fromMap(Map<String, Object?> json) {
+    final list = json['results'] as List<Object?>;
+    final parsed = list
+        .cast<Map<String, Object?>>()
+        .map((e) => Searcheable.createSearchResult(e));
+
+    return MultiSearchResult(results: parsed.toList());
+  }
+}

lib/src/paginated_search_result.dart

@@ -1,12 +1,25 @@
 import 'package:meilisearch/src/searchable.dart';
 
 class PaginatedSearchResult extends Searcheable {
-  PaginatedSearchResult({
+  const PaginatedSearchResult({
+    List<Map<String, Object?>>? hits,
+    Object? facetDistribution,
+    Object? matchesPosition,
+    int? processingTimeMs,
+    String? query,
+    required String indexUid,
     this.hitsPerPage,
     this.page,
     this.totalHits,
     this.totalPages,
-  });
+  }) : super(
+          facetDistribution: facetDistribution,
+          hits: hits,
+          matchesPosition: matchesPosition,
+          processingTimeMs: processingTimeMs,
+          query: query,
+          indexUid: indexUid,
+        );
 
   /// Number of documents skipped
   final int? hitsPerPage;
@@ -20,20 +33,19 @@ class PaginatedSearchResult extends Searcheable {
   /// Total number of pages
   final int? totalPages;
 
-  factory PaginatedSearchResult.fromMap(Map<String, Object?> map) {
-    var result = PaginatedSearchResult(
+  factory PaginatedSearchResult.fromMap(Map<String, Object?> map,
+      {String? indexUid}) {
+    return PaginatedSearchResult(
       page: map['page'] as int?,
       hitsPerPage: map['hitsPerPage'] as int?,
       totalHits: map['totalHits'] as int?,
       totalPages: map['totalPages'] as int?,
+      hits: (map['hits'] as List?)?.cast<Map<String, Object?>>(),
+      query: map['query'] as String?,
+      processingTimeMs: map['processingTimeMs'] as int?,
+      facetDistribution: map['facetDistribution'],
+      matchesPosition: map['_matchesPosition'],
+      indexUid: indexUid ?? map['indexUid'] as String,
     );
-
-    result.hits = (map['hits'] as List?)?.cast<Map<String, Object?>>();
-    result.query = map['query'] as String?;
-    result.processingTimeMs = map['processingTimeMs'] as int?;
-    result.facetDistribution = map['facetDistribution'];
-    result.matchesPosition = map['_matchesPosition'];
-
-    return result;
   }
 }

lib/src/search_query.dart

@@ -0,0 +1,70 @@
+import 'filter_builder/_exports.dart';
+import 'matching_strategy_enum.dart';
+
+class SearchQuery {
+  final String indexUid;
+  final String? query;
+  final int? offset;
+  final int? limit;
+  final int? page;
+  final int? hitsPerPage;
+  final Object? filter;
+  final MeiliOperatorExpressionBase? filterExpression;
+  final List<String>? sort;
+  final List<String>? facets;
+  final List<String>? attributesToRetrieve;
+  final List<String>? attributesToCrop;
+  final int? cropLength;
+  final List<String>? attributesToHighlight;
+  final bool? showMatchesPosition;
+  final String? cropMarker;
+  final String? highlightPreTag;
+  final String? highlightPostTag;
+  final MatchingStrategy? matchingStrategy;
+
+  const SearchQuery({
+    required this.query,
+    required this.indexUid,
+    this.offset,
+    this.limit,
+    this.page,
+    this.hitsPerPage,
+    this.filter,
+    this.filterExpression,
+    this.sort,
+    this.facets,
+    this.attributesToRetrieve,
+    this.attributesToCrop,
+    this.cropLength,
+    this.attributesToHighlight,
+    this.showMatchesPosition,
+    this.cropMarker,
+    this.highlightPreTag,
+    this.highlightPostTag,
+    this.matchingStrategy,
+  });
+
+  Map<String, Object> toMap() {
+    return (<String, Object?>{
+      'indexUid': indexUid,
+      'q': query,
+      'offset': offset,
+      'limit': limit,
+      'page': page,
+      'hitsPerPage': hitsPerPage,
+      'filter': filter ?? filterExpression?.transform(),
+      'sort': sort,
+      'facets': facets,
+      'attributesToRetrieve': attributesToRetrieve,
+      'attributesToCrop': attributesToCrop,
+      'cropLength': cropLength,
+      'attributesToHighlight': attributesToHighlight,
+      'showMatchesPosition': showMatchesPosition,
+      'cropMarker': cropMarker,
+      'highlightPreTag': highlightPreTag,
+      'highlightPostTag': highlightPostTag,
+      'matchingStrategy': matchingStrategy?.name,
+    }..removeWhere((key, value) => value == null))
+        .cast<String, Object>();
+  }
+}

lib/src/search_result.dart

@@ -1,11 +1,24 @@
 import 'package:meilisearch/src/searchable.dart';
 
 class SearchResult extends Searcheable {
-  SearchResult({
+  const SearchResult({
+    List<Map<String, Object?>>? hits,
+    Object? facetDistribution,
+    Object? matchesPosition,
+    int? processingTimeMs,
+    String? query,
+    required String indexUid,
     this.offset,
     this.limit,
     this.estimatedTotalHits,
-  });
+  }) : super(
+          facetDistribution: facetDistribution,
+          hits: hits,
+          matchesPosition: matchesPosition,
+          processingTimeMs: processingTimeMs,
+          query: query,
+          indexUid: indexUid,
+        );
 
   /// Number of documents skipped
   final int? offset;
@@ -16,19 +29,17 @@ class SearchResult extends Searcheable {
   /// Estimated number of matches
   final int? estimatedTotalHits;
 
-  factory SearchResult.fromMap(Map<String, Object?> map) {
-    var result = SearchResult(
+  factory SearchResult.fromMap(Map<String, Object?> map, {String? indexUid}) {
+    return SearchResult(
       limit: map['limit'] as int?,
       offset: map['offset'] as int?,
       estimatedTotalHits: map['estimatedTotalHits'] as int?,
+      hits: (map['hits'] as List?)?.cast<Map<String, Object?>>(),
+      query: map['query'] as String?,
+      processingTimeMs: map['processingTimeMs'] as int?,
+      facetDistribution: map['facetDistribution'],
+      matchesPosition: map['_matchesPosition'],
+      indexUid: indexUid ?? map['indexUid'] as String,
     );
-
-    result.hits = (map['hits'] as List?)?.cast<Map<String, Object?>>();
-    result.query = map['query'] as String?;
-    result.processingTimeMs = map['processingTimeMs'] as int?;
-    result.facetDistribution = map['facetDistribution'];
-    result.matchesPosition = map['_matchesPosition'];
-
-    return result;
   }
 }

lib/src/searchable.dart

@@ -1,26 +1,38 @@
 import 'package:meilisearch/meilisearch.dart';
 
 abstract class Searcheable {
+  final String indexUid;
+
   /// Query originating the response
-  String? query;
+  final String? query;
 
   /// Results of the query
-  List<Map<String, Object?>>? hits;
+  final List<Map<String, Object?>>? hits;
 
   /// Distribution of the given facets
-  Object? facetDistribution;
+  final Object? facetDistribution;
 
   /// Contains the location of each occurrence of queried terms across all fields
-  Object? matchesPosition;
+  final Object? matchesPosition;
 
   /// Processing time of the query
-  int? processingTimeMs;
+  final int? processingTimeMs;
+
+  const Searcheable({
+    required this.indexUid,
+    this.query,
+    this.hits,
+    this.facetDistribution,
+    this.matchesPosition,
+    this.processingTimeMs,
+  });
 
-  static Searcheable createSearchResult(Map<String, Object?> map) {
+  static Searcheable createSearchResult(Map<String, Object?> map,
+      {String? indexUid}) {
     if (map['totalHits'] != null) {
-      return PaginatedSearchResult.fromMap(map);
+      return PaginatedSearchResult.fromMap(map, indexUid: indexUid);
     } else {
-      return SearchResult.fromMap(map);
+      return SearchResult.fromMap(map, indexUid: indexUid);
     }
   }
 }