Skip to content

feat: add generics support #81

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Add this to your package's `pubspec.yaml` file:

```yml
dependencies:
dart_appwrite: ^16.1.0
dart_appwrite: ^16.2.0
```

You can install packages from the command line:
Expand Down
20 changes: 14 additions & 6 deletions lib/services/account.dart
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,10 @@ class Account extends Service {
}

/// Get the list of identities for the currently logged in user.
Future<models.IdentityList> listIdentities({List<String>? queries}) async {
Future<models.IdentityList<T>> listIdentities<T>({
List<String>? queries,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath = '/account/identities';

final Map<String, dynamic> apiParams = {'queries': queries};
Expand All @@ -102,7 +105,7 @@ class Account extends Service {
headers: apiHeaders,
);

return models.IdentityList.fromMap(res.data);
return models.IdentityList.fromMap(res.data, fromJson);
}

/// Delete an identity by its unique ID.
Expand Down Expand Up @@ -150,7 +153,10 @@ class Account extends Service {

/// Get the list of latest security activity logs for the currently logged in
/// user. Each log returns user IP address, location and date and time of log.
Future<models.LogList> listLogs({List<String>? queries}) async {
Future<models.LogList<T>> listLogs<T>({
List<String>? queries,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath = '/account/logs';

final Map<String, dynamic> apiParams = {'queries': queries};
Expand All @@ -164,7 +170,7 @@ class Account extends Service {
headers: apiHeaders,
);

return models.LogList.fromMap(res.data);
return models.LogList.fromMap(res.data, fromJson);
}

/// Enable or disable MFA on an account.
Expand Down Expand Up @@ -565,7 +571,9 @@ class Account extends Service {

/// Get the list of active sessions across different devices for the currently
/// logged in user.
Future<models.SessionList> listSessions() async {
Future<models.SessionList<T>> listSessions<T>({
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath = '/account/sessions';

final Map<String, dynamic> apiParams = {};
Expand All @@ -579,7 +587,7 @@ class Account extends Service {
headers: apiHeaders,
);

return models.SessionList.fromMap(res.data);
return models.SessionList.fromMap(res.data, fromJson);
}

/// Delete all sessions from the user account and remove any sessions cookies
Expand Down
65 changes: 39 additions & 26 deletions lib/services/databases.dart
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,10 @@ class Databases extends Service {

/// Get a list of all databases from the current Appwrite project. You can use
/// the search parameter to filter your results.
Future<models.DatabaseList> list({
Future<models.DatabaseList<T>> list<T>({
List<String>? queries,
String? search,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath = '/databases';

Expand All @@ -27,7 +28,7 @@ class Databases extends Service {
headers: apiHeaders,
);

return models.DatabaseList.fromMap(res.data);
return models.DatabaseList.fromMap(res.data, fromJson);
}

/// Create a new Database.
Expand Down Expand Up @@ -128,10 +129,11 @@ class Databases extends Service {

/// Get a list of all collections that belong to the provided databaseId. You
/// can use the search parameter to filter your results.
Future<models.CollectionList> listCollections({
Future<models.CollectionList<T>> listCollections<T>({
required String databaseId,
List<String>? queries,
String? search,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath = '/databases/{databaseId}/collections'.replaceAll(
'{databaseId}',
Expand All @@ -152,7 +154,7 @@ class Databases extends Service {
headers: apiHeaders,
);

return models.CollectionList.fromMap(res.data);
return models.CollectionList.fromMap(res.data, fromJson);
}

/// Create a new Collection. Before using this route, you should create a new
Expand Down Expand Up @@ -273,10 +275,11 @@ class Databases extends Service {
}

/// List attributes in the collection.
Future<models.AttributeList> listAttributes({
Future<models.AttributeList<T>> listAttributes<T>({
required String databaseId,
required String collectionId,
List<String>? queries,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath =
'/databases/{databaseId}/collections/{collectionId}/attributes'
Expand All @@ -294,7 +297,7 @@ class Databases extends Service {
headers: apiHeaders,
);

return models.AttributeList.fromMap(res.data);
return models.AttributeList.fromMap(res.data, fromJson);
}

/// Create a boolean attribute.
Expand Down Expand Up @@ -1070,10 +1073,11 @@ class Databases extends Service {

/// Get a list of all the user's documents in a given collection. You can use
/// the query params to filter your results.
Future<models.DocumentList> listDocuments({
Future<models.DocumentList<T>> listDocuments<T>({
required String databaseId,
required String collectionId,
List<String>? queries,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath =
'/databases/{databaseId}/collections/{collectionId}/documents'
Expand All @@ -1091,19 +1095,20 @@ class Databases extends Service {
headers: apiHeaders,
);

return models.DocumentList.fromMap(res.data);
return models.DocumentList.fromMap(res.data, fromJson);
}

/// Create a new Document. Before using this route, you should create a new
/// collection resource using either a [server
/// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
/// API or directly from your database console.
Future<models.Document> createDocument({
Future<models.Document<T>> createDocument<T>({
required String databaseId,
required String collectionId,
required String documentId,
required Map data,
List<String>? permissions,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath =
'/databases/{databaseId}/collections/{collectionId}/documents'
Expand All @@ -1125,7 +1130,7 @@ class Databases extends Service {
headers: apiHeaders,
);

return models.Document.fromMap(res.data);
return models.Document.fromMap(res.data, fromJson);
}

/// **WARNING: Experimental Feature** - This endpoint is experimental and not
Expand All @@ -1136,10 +1141,11 @@ class Databases extends Service {
/// collection resource using either a [server
/// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
/// API or directly from your database console.
Future<models.DocumentList> createDocuments({
Future<models.DocumentList<T>> createDocuments<T>({
required String databaseId,
required String collectionId,
required List<Map> documents,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath =
'/databases/{databaseId}/collections/{collectionId}/documents'
Expand All @@ -1157,7 +1163,7 @@ class Databases extends Service {
headers: apiHeaders,
);

return models.DocumentList.fromMap(res.data);
return models.DocumentList.fromMap(res.data, fromJson);
}

/// **WARNING: Experimental Feature** - This endpoint is experimental and not
Expand All @@ -1168,10 +1174,11 @@ class Databases extends Service {
/// new collection resource using either a [server
/// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
/// API or directly from your database console.
Future<models.DocumentList> upsertDocuments({
Future<models.DocumentList<T>> upsertDocuments<T>({
required String databaseId,
required String collectionId,
required List<Map> documents,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath =
'/databases/{databaseId}/collections/{collectionId}/documents'
Expand All @@ -1189,7 +1196,7 @@ class Databases extends Service {
headers: apiHeaders,
);

return models.DocumentList.fromMap(res.data);
return models.DocumentList.fromMap(res.data, fromJson);
}

/// **WARNING: Experimental Feature** - This endpoint is experimental and not
Expand All @@ -1199,11 +1206,12 @@ class Databases extends Service {
/// Update all documents that match your queries, if no queries are submitted
/// then all documents are updated. You can pass only specific fields to be
/// updated.
Future<models.DocumentList> updateDocuments({
Future<models.DocumentList<T>> updateDocuments<T>({
required String databaseId,
required String collectionId,
Map? data,
List<String>? queries,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath =
'/databases/{databaseId}/collections/{collectionId}/documents'
Expand All @@ -1221,7 +1229,7 @@ class Databases extends Service {
headers: apiHeaders,
);

return models.DocumentList.fromMap(res.data);
return models.DocumentList.fromMap(res.data, fromJson);
}

/// **WARNING: Experimental Feature** - This endpoint is experimental and not
Expand All @@ -1230,10 +1238,11 @@ class Databases extends Service {
///
/// Bulk delete documents using queries, if no queries are passed then all
/// documents are deleted.
Future<models.DocumentList> deleteDocuments({
Future<models.DocumentList<T>> deleteDocuments<T>({
required String databaseId,
required String collectionId,
List<String>? queries,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath =
'/databases/{databaseId}/collections/{collectionId}/documents'
Expand All @@ -1251,16 +1260,17 @@ class Databases extends Service {
headers: apiHeaders,
);

return models.DocumentList.fromMap(res.data);
return models.DocumentList.fromMap(res.data, fromJson);
}

/// Get a document by its unique ID. This endpoint response returns a JSON
/// object with the document data.
Future<models.Document> getDocument({
Future<models.Document<T>> getDocument<T>({
required String databaseId,
required String collectionId,
required String documentId,
List<String>? queries,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath =
'/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
Expand All @@ -1279,7 +1289,7 @@ class Databases extends Service {
headers: apiHeaders,
);

return models.Document.fromMap(res.data);
return models.Document.fromMap(res.data, fromJson);
}

/// **WARNING: Experimental Feature** - This endpoint is experimental and not
Expand All @@ -1290,12 +1300,13 @@ class Databases extends Service {
/// new collection resource using either a [server
/// integration](https://appwrite.io/docs/server/databases#databasesCreateCollection)
/// API or directly from your database console.
Future<models.Document> upsertDocument({
Future<models.Document<T>> upsertDocument<T>({
required String databaseId,
required String collectionId,
required String documentId,
required Map data,
List<String>? permissions,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath =
'/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
Expand All @@ -1317,17 +1328,18 @@ class Databases extends Service {
headers: apiHeaders,
);

return models.Document.fromMap(res.data);
return models.Document.fromMap(res.data, fromJson);
}

/// Update a document by its unique ID. Using the patch method you can pass
/// only specific fields that will get updated.
Future<models.Document> updateDocument({
Future<models.Document<T>> updateDocument<T>({
required String databaseId,
required String collectionId,
required String documentId,
Map? data,
List<String>? permissions,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath =
'/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
Expand All @@ -1349,7 +1361,7 @@ class Databases extends Service {
headers: apiHeaders,
);

return models.Document.fromMap(res.data);
return models.Document.fromMap(res.data, fromJson);
}

/// Delete a document by its unique ID.
Expand Down Expand Up @@ -1379,10 +1391,11 @@ class Databases extends Service {
}

/// List indexes in the collection.
Future<models.IndexList> listIndexes({
Future<models.IndexList<T>> listIndexes<T>({
required String databaseId,
required String collectionId,
List<String>? queries,
T Function(Map<String, dynamic>)? fromJson,
}) async {
final String apiPath =
'/databases/{databaseId}/collections/{collectionId}/indexes'
Expand All @@ -1400,7 +1413,7 @@ class Databases extends Service {
headers: apiHeaders,
);

return models.IndexList.fromMap(res.data);
return models.IndexList.fromMap(res.data, fromJson);
}

/// Creates an index on the attributes listed. Your index should include all
Expand Down
Loading