Merge #288

288: Update version for the next release (v0.11.0) r=brunoocasali a=meili-bot

_This PR is auto-generated._

The automated script updates the version of meilisearch-dart to a new version: "v0.11.0"


Co-authored-by: meili-bot <74670311+meili-bot@users.noreply.github.com>
Co-authored-by: Bruno Casali <brunoocasali@gmail.com>

Author: 3 people

CHANGELOG.md

@@ -1,5 +1,32 @@
 [comment]: <> (All notable changes to this project will be documented in this file.)
 
+# 0.11.0
+### Breaking Changes:
+
+- Changes `Searcheable`, `SearchResult`, `PaginatedSearchResult` signatures to be generic `Searcheable<T>`, `SearchResult<T>`, `PaginatedSearchResult<T>`
+- Adds a new `map<TOther>` method to `Searcheable<T>` and its subclasses to map the search result to a different type.
+- All search operations produce `Searcheable<Map<String, dynamic>>` by default, which can be mapped to other types using the `map<TOther>` method.
+- Revert some of the `Object?` types that were changed from `dynamic`: 
+  - `MeiliSearchClient` class `Future<Map<String, dynamic>> health();`
+  - `HttpRequest` class `Map<String, dynamic> headers();`
+  - `MeiliSearchIndex` class `Future<Searcheable<Map<String, dynamic>>> search(...);`
+  - `MeiliSearchIndex` class`Future<Map<String, dynamic>?> getDocument(Object id, {List<String> fields});`
+  - `MeiliSearchIndex` class `Future<Result<Map<String, dynamic>>> getDocuments({DocumentsQuery? params});`
+- `Searcheable<T>.hits` is non-nullable now, and defaults to `const []`
+
+### Changes: 
+
+- Introduced new extension methods to help consumers cast `Future<Searchable<T>>` to the corresponding type:
+```dart
+final result = await index.search('').then((value) => (value as SearchResult<Map<String, dynamic>>).map(BookDto.fromMap));
+final resultPaginated = await index.search('').then((value) => (value as PaginatedSearchResult<Map<String, dynamic>>).map(BookDto.fromMap));
+```
+to:
+```dart
+final result = await index.search('').asSearchResult().map(BookDto.fromMap);
+final resultPaginated = await index.search('').asPaginatedResult().map(BookDto.fromMap);
+```
+
 # 0.10.2
 ### Changes:
 

README.md

@@ -48,7 +48,7 @@ You can install the **meilisearch** package by adding a few lines into `pubspec.
 
 ```yaml
 dependencies:
-  meilisearch: ^0.10.2
+  meilisearch: ^0.11.0
 ```
 
 Then open your terminal and update dart packages.

example/pubspec.lock

@@ -35,7 +35,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "0.10.2"
+    version: "0.11.0"
   path:
     dependency: transitive
     description:

example/pubspec.yaml

@@ -6,7 +6,7 @@ environment:
   sdk: ">=2.12.0 <3.0.0"
 
 dependencies:
-  meilisearch: "0.10.2"
+  meilisearch: "0.11.0"
 
 dependency_overrides:
   meilisearch:

lib/src/version.dart

@@ -1,5 +1,5 @@
 class Version {
-  static const String current = '0.10.2';
+  static const String current = '0.11.0';
 
   static String get qualifiedVersion {
     return "Meilisearch Dart (v$current)";

pubspec.yaml

@@ -1,6 +1,6 @@
 name: meilisearch
 description: Meilisearch Dart is the Meilisearch API client for Dart and Flutter developers.
-version: 0.10.2
+version: 0.11.0
 homepage: https://meilisearch.com
 repository: https://github.com/meilisearch/meilisearch-dart
 issue_tracker: https://github.com/meilisearch/meilisearch-dart/issues