Merge #323

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

This version introduces features released on Meilisearch v1.2.0 🎉
Check out the changelog of [Meilisearch v1.2.0](https://github.com/meilisearch/meilisearch/releases/tag/v1.2.0) for more information on the changes. 
⚠️ If you want to adopt new features of this release, **update the Meilisearch server** to the according version.

Check the complete CHANGELOG here: https://github.com/meilisearch/meilisearch-dart/blob/main/CHANGELOG.md

### 💥 Breaking changes

- The method `deleteDocuments()` now supports a different behavior. This method now takes a `DeleteDocumentsQuery`, which could contain the filter or the `ids` (aka old behavior).  #318 `@ahmednfwela`  

  ⚠️ You must configure the attributes you want to filter using the `MeiliSearchIndex.filterableAttributes()`.
  ⚠️ Remember to **update your Meilisearch server to v1.2.0 or newer before** adopting it.
  
  Still, even being supported, the ability to receive only a list of ids is *deprecated*, and it will be removed soon.

  ```diff
  // from:
  - Future<Task> deleteDocuments(List<Object> ids)
  + Future<Task> deleteDocuments(DeleteDocumentsQuery query)
  
  // to:
  - index.deleteDocuments([456, 4])
  + index.deleteDocuments(DeleteDocumentsQuery(ids: [456, 4]))
  ```

- Add the ability to set `filter` in the `DocumentsQuery`. When a query with a `filter` is sent to `getDocuments(params: DocumentsQuery)` it will filter the documents like the `search` method. See [the docs on how to use filters](https://www.meilisearch.com/docs/learn/advanced/filtering#filter-basics). #318 `@ahmednfwela`  
  
  ⚠️ You must configure the attributes you want to filter using the `MeiliSearchIndex.filterableAttributes()`.
  ⚠️ Remember to **update your Meilisearch server to v1.2.0 or newer before** adopting it.


- `MeiliSearchIndex.search` now takes a `String query` and a `SearchQuery` object as the only inputs. #310 `@ahmednfwela`  
  - Replace any occurrence of search `index.search('xyz', ....)` with `index.search('xyz', SearchQuery(....))`

  ```diff
  - await client.index('books').search('query', sort: [], filter: ...);
  + await client.index('books').search('query', SearchQuery(sort: [], filter: ...));
  ```

- `Meili.geoBoundingBox` and `Meili.geoRadius` now take record values to represent the `lat`/`lng` points: #310 `@ahmednfwela`  
  ```diff
  // Confusing, unclear
  - Meili.geoBoundingBox(3,5.3,10,20)
  // Not Confusing :)
  + Meili.geoBoundingBox((lat: 3, lng: 5.3), (lat: 10, lng: 20))
  ```
  ```diff
  // Confusing, unclear
  - Meili.geoRadius(3, 5.3, 100)
  // Not Confusing :)
  + Meili.geoRadius((lat: 3, lng: 5.3), 100)
  ```
  
- Change `MultiSearchQuery.queries` to be a `List<IndexSearchQuery>` instead of a `List<SearchQuery>`: #310 `@ahmednfwela`  
  ```diff
  final result = await client.multiSearch(MultiSearchQuery(queries: [
  -      SearchQuery(
  +      IndexSearchQuery(
            query: "",
            indexUid: index1.uid,
          ),
  -    SearchQuery(
  +    IndexSearchQuery(
            query: "",
            indexUid: index2.uid,
          ),
  ];
  ```

### Enhancements:

- Introduce a new annotation `RequiredMeiliServerVersion` which documents the version these members were introduced. #310 `@ahmednfwela`  
- Introduce filter expressions for `IS NULL`, `IS NOT NULL`, `IS EMPTY`, `IS NOT EMPTY`. #310 `@ahmednfwela`  
- Added `filter`, `filterExpression` parameter to `DocumentsQuery`. #310 `@ahmednfwela`  
- Some internal `Queryable` refactoring to unify its behavior and avoid duplicating the code. #310 `@ahmednfwela` 
- Added a workaround for meilisearch/meilisearch#3740 by `jsonEncoding` attribute names when using `filterExpression`s #310 `@ahmednfwela`  
- A new type is introduced `IndexSearchQuery` which extends `SearchQuery`. #310 `@ahmednfwela`  
  - Added `copyWith` to `SearchQuery` and `IndexSearchQuery` #310 `@ahmednfwela`  

Thanks again to `@brunoocasali,` `@ahmednfwela!` 🎉


Co-authored-by: meili-bot <[email protected]>
Co-authored-by: Bruno Casali <[email protected]>

CHANGELOG.md

@@ -1,5 +1,69 @@
 [comment]: <> (All notable changes to this project will be documented in this file.)
 
+# 0.14.0
+### Breaking Changes:
+- Moved `indexUid`, `query` from `SearchQuery` to the new `IndexSearchQuery`.
+- Changed `deleteDocuments` signature:
+
+```diff
+// from:
+- Future<Task> deleteDocuments(List<Object> ids)
++ Future<Task> deleteDocuments(DeleteDocumentsQuery query)
+
+// to:
+- index.deleteDocuments([456, 4])
++ index.deleteDocuments(DeleteDocumentsQuery(ids: [456, 4]))
+```
+
+- `MeiliSearchIndex.search` now takes a `String query` and a `SearchQuery` object as the only inputs.
+  - Replace any ocurrence of search `index.search('xyz', ....)` with `index.search('xyz', SearchQuery(....))`
+
+```diff
+- await client.index('books').search('query', sort: [], filter: ...);
++ await client.index('books').search('query', SearchQuery(sort: [], filter: ...));
+```
+
+- `Meili.geoBoundingBox` and `Meili.geoRadius` now take record values to represent the `lat`/`lng` points:
+```diff
+// Confusing, unclear
+- Meili.geoBoundingBox(3,5.3,10,20)
+// Not Confusing :)
++ Meili.geoBoundingBox((lat: 3, lng: 5.3), (lat: 10, lng: 20))
+```
+```diff
+// Confusing, unclear
+- Meili.geoRadius(3, 5.3, 100)
+// Not Confusing :)
++ Meili.geoRadius((lat: 3, lng: 5.3), 100)
+```
+
+- Change `MultiSearchQuery.queries` to be a `List<IndexSearchQuery>` instead of a `List<SearchQuery>`:
+```diff
+final result = await client.multiSearch(MultiSearchQuery(queries: [
+-      SearchQuery(
++      IndexSearchQuery(
+          query: "",
+          indexUid: index1.uid,
+        ),
+-    SearchQuery(
++    IndexSearchQuery(
+          query: "",
+          indexUid: index2.uid,
+        ),
+];
+```
+
+### Changes:
+
+- Introduce a new annotation `RequiredMeiliServerVersion` which documents the version this members were introduced.
+- Introduce filter expressions for `IS NULL`, `IS NOT NULL`, `IS EMPTY`, `IS NOT EMPTY`.
+- Added `filter`, `filterExpression` parameter to `DocumentsQuery`.
+- Some internal `Queryable` refactoring to unify its behavior and avoid duplicating the code.
+- Added a workaround for https://github.com/meilisearch/meilisearch/issues/3740 by `jsonEncoding` attribute names when using `filterExpression`s
+- A new type is introduced `IndexSearchQuery` which extends `SearchQuery`.
+  - Added `copyWith` to `SearchQuery` and `IndexSearchQuery`
+
+
 # 0.13.0
 
 ### Breaking Changes
@@ -16,7 +80,7 @@
 ```diff
 - final Object? facetDistribution;
 + final Map<String, Map<String, int>>? facetDistribution;
-- final Object? matchesPosition;   
+- final Object? matchesPosition;
 + final Map<String, List<MatchPosition>>? matchesPosition;
 + final Map<String, FacetStat>? facetStats;
 ```
@@ -37,15 +101,15 @@
 - 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`: 
+- 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: 
+### Changes:
 
 - Introduced new extension methods to help consumers cast `Future<Searchable<T>>` to the corresponding type:
 ```dart

README.md

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

lib/src/version.dart

@@ -1,5 +1,5 @@
 class Version {
-  static const String current = '0.13.0';
+  static const String current = '0.14.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.13.0
+version: 0.14.0
 homepage: https://meilisearch.com
 repository: https://github.com/meilisearch/meilisearch-dart
 issue_tracker: https://github.com/meilisearch/meilisearch-dart/issues