Merge pull request #183 from meilisearch/indexes-changes

Add a type wrapper to the Indexes resources

Author: brunoocasali

lib/src/client.dart

@@ -1,4 +1,5 @@
 import 'package:meilisearch/src/key.dart';
+import 'package:meilisearch/src/query_parameters/indexes_query.dart';
 import 'package:meilisearch/src/query_parameters/keys_query.dart';
 import 'package:meilisearch/src/query_parameters/tasks_query.dart';
 import 'package:meilisearch/src/result.dart';
@@ -34,7 +35,7 @@ abstract class MeiliSearchClient {
   MeiliSearchIndex index(String uid);
 
   /// Return list of all existing indexes.
-  Future<List<MeiliSearchIndex>> getIndexes();
+  Future<Result<MeiliSearchIndex>> getIndexes({IndexesQuery? params});
 
   /// Find index by matching [uid]. Throws error if index is not exists.
   Future<MeiliSearchIndex> getIndex(String uid);

lib/src/client_impl.dart

@@ -1,5 +1,6 @@
 import 'package:dio/dio.dart';
 import 'package:meilisearch/src/client_task_impl.dart';
+import 'package:meilisearch/src/query_parameters/indexes_query.dart';
 import 'package:meilisearch/src/query_parameters/keys_query.dart';
 import 'package:meilisearch/src/query_parameters/tasks_query.dart';
 import 'package:meilisearch/src/result.dart';
@@ -74,13 +75,12 @@ class MeiliSearchClientImpl implements MeiliSearchClient {
   }
 
   @override
-  Future<List<MeiliSearchIndex>> getIndexes() async {
-    final response = await http.getMethod<List<dynamic>>('/indexes');
+  Future<Result<MeiliSearchIndex>> getIndexes({IndexesQuery? params}) async {
+    final response = await http.getMethod<Map<String, dynamic>>('/indexes',
+        queryParameters: params?.toQuery());
 
-    return response.data!
-        .cast<Map<String, dynamic>>()
-        .map((item) => MeiliSearchIndexImpl.fromMap(this, item))
-        .toList();
+    return Result<MeiliSearchIndex>.fromMapWithType(
+        response.data!, (item) => MeiliSearchIndexImpl.fromMap(this, item));
   }
 
   @override

lib/src/query_parameters/indexes_query.dart

@@ -0,0 +1,16 @@
+class IndexesQuery {
+  final int? offset;
+  final int? limit;
+
+  IndexesQuery({
+    this.limit,
+    this.offset,
+  });
+
+  Map<String, dynamic> toQuery() {
+    return <String, dynamic>{
+      'offset': this.offset,
+      'limit': this.limit,
+    }..removeWhere((key, value) => value == null);
+  }
+}

test/indexes_test.dart

@@ -74,12 +74,11 @@ void main() {
       await client.createIndex(uid).waitFor();
 
       final index = await client.getRawIndex(uid);
-      final keys = ['uid', 'name', 'primaryKey', 'createdAt', 'updatedAt'];
+      final keys = ['uid', 'primaryKey', 'createdAt', 'updatedAt'];
 
       expect(index.keys, containsAll(keys));
       expect(index.keys.length, keys.length);
       expect(index['primaryKey'], isNull);
-      expect(index['name'], equals(uid));
     });
 
     test('throws exception with a non-existing index', () async {
@@ -91,8 +90,8 @@ void main() {
       await client.createIndex(randomUid()).waitFor();
       await client.createIndex(randomUid()).waitFor();
       await client.createIndex(randomUid()).waitFor();
-      var indexes = await client.getIndexes();
-      expect(indexes.length, 3);
+      var response = await client.getIndexes();
+      expect(response.total, 3);
     });
 
     test('Create index object with UID', () async {

test/utils/client.dart

@@ -19,8 +19,8 @@ String get testServer {
 }
 
 Future<void> deleteAllIndexes() async {
-  var indexes = await client.getIndexes();
-  for (var item in indexes) {
+  var data = await client.getIndexes();
+  for (var item in data.results) {
     await item.delete();
   }
 }