Merge pull request #72 from appwrite/dev

fix: pong response & chunked upload

Author: christyjacob4

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2024 Appwrite (https://appwrite.io) and individual contributors.
+Copyright (c) 2025 Appwrite (https://appwrite.io) and individual contributors.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

README.md

@@ -23,7 +23,7 @@ Add this to your package's `pubspec.yaml` file:
 
 ```yml
 dependencies:
-  dart_appwrite: ^12.2.0
+  dart_appwrite: ^13.0.0
 ```
 
 You can install packages from the command line:

docs/examples/account/update-mfa-challenge.md

@@ -7,7 +7,7 @@ Client client = Client()
 
 Account account = Account(client);
 
- result = await account.updateMfaChallenge(
+Session result = await account.updateMfaChallenge(
     challengeId: '<CHALLENGE_ID>',
     otp: '<OTP>',
 );

lib/services/account.dart

@@ -282,7 +282,7 @@ class Account extends Service {
   /// the flow, use
   /// [createMfaChallenge](/docs/references/cloud/client-web/account#createMfaChallenge)
   /// method.
-  Future updateMfaChallenge(
+  Future<models.Session> updateMfaChallenge(
       {required String challengeId, required String otp}) async {
     final String apiPath = '/account/mfa/challenge';
 
@@ -298,7 +298,7 @@ class Account extends Service {
     final res = await client.call(HttpMethod.put,
         path: apiPath, params: apiParams, headers: apiHeaders);
 
-    return res.data;
+    return models.Session.fromMap(res.data);
   }
 
   /// List factors

lib/services/functions.dart

@@ -364,6 +364,11 @@ class Functions extends Service {
 
   /// Rebuild deployment
   ///
+  /// Create a new build for an existing function deployment. This endpoint
+  /// allows you to rebuild a deployment with the updated function configuration,
+  /// including its entrypoint and build commands if they have been modified The
+  /// build process will be queued and executed asynchronously. The original
+  /// deployment's code will be preserved and used for the new build.
   Future createBuild(
       {required String functionId,
       required String deploymentId,
@@ -389,6 +394,11 @@ class Functions extends Service {
 
   /// Cancel deployment
   ///
+  /// Cancel an ongoing function deployment build. If the build is already in
+  /// progress, it will be stopped and marked as canceled. If the build hasn't
+  /// started yet, it will be marked as canceled without executing. You cannot
+  /// cancel builds that have already completed (status 'ready') or failed. The
+  /// response includes the final build status and details.
   Future<models.Build> updateDeploymentBuild(
       {required String functionId, required String deploymentId}) async {
     final String apiPath =

lib/services/messaging.dart

@@ -72,7 +72,9 @@ class Messaging extends Service {
 
   /// Update email
   ///
-  /// Update an email message by its unique ID.
+  /// Update an email message by its unique ID. This endpoint only works on
+  /// messages that are in draft status. Messages that are already processing,
+  /// sent, or failed cannot be updated.
   ///
   Future<models.Message> updateEmail(
       {required String messageId,
@@ -173,7 +175,9 @@ class Messaging extends Service {
 
   /// Update push notification
   ///
-  /// Update a push notification by its unique ID.
+  /// Update a push notification by its unique ID. This endpoint only works on
+  /// messages that are in draft status. Messages that are already processing,
+  /// sent, or failed cannot be updated.
   ///
   Future<models.Message> updatePush(
       {required String messageId,
@@ -264,7 +268,9 @@ class Messaging extends Service {
 
   /// Update SMS
   ///
-  /// Update an email message by its unique ID.
+  /// Update an SMS message by its unique ID. This endpoint only works on
+  /// messages that are in draft status. Messages that are already processing,
+  /// sent, or failed cannot be updated.
   ///
   Future<models.Message> updateSms(
       {required String messageId,

lib/services/users.dart

@@ -506,7 +506,7 @@ class Users extends Service {
   /// Delete authenticator
   ///
   /// Delete an authenticator app.
-  Future<models.User> deleteMfaAuthenticator(
+  Future deleteMfaAuthenticator(
       {required String userId, required enums.AuthenticatorType type}) async {
     final String apiPath = '/users/{userId}/mfa/authenticators/{type}'
         .replaceAll('{userId}', userId)
@@ -521,7 +521,7 @@ class Users extends Service {
     final res = await client.call(HttpMethod.delete,
         path: apiPath, params: apiParams, headers: apiHeaders);
 
-    return models.User.fromMap(res.data);
+    return res.data;
   }
 
   /// List factors

lib/src/client.dart

@@ -67,6 +67,9 @@ abstract class Client {
   /// Add headers that should be sent with all API calls.
   Client addHeader(String key, String value);
 
+  /// Sends a "ping" request to Appwrite to verify connectivity.
+  Future<String> ping();
+
   /// Upload a file in chunks.
   Future<Response> chunkedUpload({
     required String path,

lib/src/client_base.dart

@@ -34,6 +34,9 @@ abstract class ClientBase implements Client {
   @override
   ClientBase addHeader(String key, String value);
 
+  @override
+  Future<String> ping();
+
   @override
   Future<Response> call(
     HttpMethod method, {

lib/src/client_browser.dart

@@ -33,7 +33,7 @@ class ClientBrowser extends ClientBase with ClientMixin {
       'x-sdk-name': 'Dart',
       'x-sdk-platform': 'server',
       'x-sdk-language': 'dart',
-      'x-sdk-version': '12.2.0',
+      'x-sdk-version': '13.0.0',
       'X-Appwrite-Response-Format': '1.6.0',
     };
 
@@ -110,6 +110,15 @@ class ClientBrowser extends ClientBase with ClientMixin {
     return this;
   }
 
+  @override
+  Future<String> ping() async {
+    final String apiPath = '/ping';
+    final response = await call(HttpMethod.get,
+        path: apiPath, responseType: ResponseType.plain);
+
+    return response.data;
+  }
+
   @override
   Future<String?> webAuth(Uri url) async {
     final request = http.Request('GET', url);
@@ -147,7 +156,7 @@ class ClientBrowser extends ClientBase with ClientMixin {
     }
 
     var offset = 0;
-    if (idParamName.isNotEmpty && params[idParamName] != 'unique()') {
+    if (idParamName.isNotEmpty) {
       //make a request to check if a file already exists
       try {
         res = await call(

lib/src/client_io.dart

@@ -42,9 +42,9 @@ class ClientIO extends ClientBase with ClientMixin {
       'x-sdk-name': 'Dart',
       'x-sdk-platform': 'server',
       'x-sdk-language': 'dart',
-      'x-sdk-version': '12.2.0',
+      'x-sdk-version': '13.0.0',
       'user-agent':
-          'AppwriteDartSDK/12.2.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})',
+          'AppwriteDartSDK/13.0.0 (${Platform.operatingSystem}; ${Platform.operatingSystemVersion})',
       'X-Appwrite-Response-Format': '1.6.0',
     };
 
@@ -123,6 +123,15 @@ class ClientIO extends ClientBase with ClientMixin {
     return this;
   }
 
+  @override
+  Future<String> ping() async {
+    final String apiPath = '/ping';
+    final response = await call(HttpMethod.get,
+        path: apiPath, responseType: ResponseType.plain);
+
+    return response.data;
+  }
+
   @override
   Future<Response> chunkedUpload({
     required String path,
@@ -168,7 +177,7 @@ class ClientIO extends ClientBase with ClientMixin {
     }
 
     var offset = 0;
-    if (idParamName.isNotEmpty && params[idParamName] != 'unique()') {
+    if (idParamName.isNotEmpty) {
       //make a request to check if a file already exists
       try {
         res = await call(

lib/src/enums/image_format.dart

@@ -6,6 +6,7 @@ enum ImageFormat {
   gif(value: 'gif'),
   png(value: 'png'),
   webp(value: 'webp'),
+  heic(value: 'heic'),
   avif(value: 'avif');
 
   const ImageFormat({required this.value});

lib/src/models/attribute_enum.dart

@@ -59,7 +59,7 @@ class AttributeEnum implements Model {
       array: map['array'],
       $createdAt: map['\$createdAt'].toString(),
       $updatedAt: map['\$updatedAt'].toString(),
-      elements: map['elements'] ?? [],
+      elements: List.from(map['elements'] ?? []),
       format: map['format'].toString(),
       xdefault: map['default']?.toString(),
     );

lib/src/models/attribute_list.dart

@@ -16,7 +16,7 @@ class AttributeList implements Model {
   factory AttributeList.fromMap(Map<String, dynamic> map) {
     return AttributeList(
       total: map['total'],
-      attributes: map['attributes'] ?? [],
+      attributes: List.from(map['attributes'] ?? []),
     );
   }
 

lib/src/models/bucket.dart

@@ -58,12 +58,12 @@ class Bucket implements Model {
       $id: map['\$id'].toString(),
       $createdAt: map['\$createdAt'].toString(),
       $updatedAt: map['\$updatedAt'].toString(),
-      $permissions: map['\$permissions'] ?? [],
+      $permissions: List.from(map['\$permissions'] ?? []),
       fileSecurity: map['fileSecurity'],
       name: map['name'].toString(),
       enabled: map['enabled'],
       maximumFileSize: map['maximumFileSize'],
-      allowedFileExtensions: map['allowedFileExtensions'] ?? [],
+      allowedFileExtensions: List.from(map['allowedFileExtensions'] ?? []),
       compression: map['compression'].toString(),
       encryption: map['encryption'],
       antivirus: map['antivirus'],

lib/src/models/collection.dart

@@ -50,12 +50,12 @@ class Collection implements Model {
       $id: map['\$id'].toString(),
       $createdAt: map['\$createdAt'].toString(),
       $updatedAt: map['\$updatedAt'].toString(),
-      $permissions: map['\$permissions'] ?? [],
+      $permissions: List.from(map['\$permissions'] ?? []),
       databaseId: map['databaseId'].toString(),
       name: map['name'].toString(),
       enabled: map['enabled'],
       documentSecurity: map['documentSecurity'],
-      attributes: map['attributes'] ?? [],
+      attributes: List.from(map['attributes'] ?? []),
       indexes: List<Index>.from(map['indexes'].map((p) => Index.fromMap(p))),
     );
   }

lib/src/models/document.dart

@@ -19,6 +19,7 @@ class Document implements Model {
 
   /// Document permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
   final List<String> $permissions;
+
   final Map<String, dynamic> data;
 
   Document({
@@ -38,7 +39,7 @@ class Document implements Model {
       $databaseId: map['\$databaseId'].toString(),
       $createdAt: map['\$createdAt'].toString(),
       $updatedAt: map['\$updatedAt'].toString(),
-      $permissions: map['\$permissions'] ?? [],
+      $permissions: List.from(map['\$permissions'] ?? []),
       data: map,
     );
   }

lib/src/models/execution.dart

@@ -78,7 +78,7 @@ class Execution implements Model {
       $id: map['\$id'].toString(),
       $createdAt: map['\$createdAt'].toString(),
       $updatedAt: map['\$updatedAt'].toString(),
-      $permissions: map['\$permissions'] ?? [],
+      $permissions: List.from(map['\$permissions'] ?? []),
       functionId: map['functionId'].toString(),
       trigger: map['trigger'].toString(),
       status: map['status'].toString(),

lib/src/models/file.dart

@@ -55,7 +55,7 @@ class File implements Model {
       bucketId: map['bucketId'].toString(),
       $createdAt: map['\$createdAt'].toString(),
       $updatedAt: map['\$updatedAt'].toString(),
-      $permissions: map['\$permissions'] ?? [],
+      $permissions: List.from(map['\$permissions'] ?? []),
       name: map['name'].toString(),
       signature: map['signature'].toString(),
       mimeType: map['mimeType'].toString(),

lib/src/models/function.dart

@@ -106,16 +106,16 @@ class Func implements Model {
       $id: map['\$id'].toString(),
       $createdAt: map['\$createdAt'].toString(),
       $updatedAt: map['\$updatedAt'].toString(),
-      execute: map['execute'] ?? [],
+      execute: List.from(map['execute'] ?? []),
       name: map['name'].toString(),
       enabled: map['enabled'],
       live: map['live'],
       logging: map['logging'],
       runtime: map['runtime'].toString(),
       deployment: map['deployment'].toString(),
-      scopes: map['scopes'] ?? [],
+      scopes: List.from(map['scopes'] ?? []),
       vars: List<Variable>.from(map['vars'].map((p) => Variable.fromMap(p))),
-      events: map['events'] ?? [],
+      events: List.from(map['events'] ?? []),
       schedule: map['schedule'].toString(),
       timeout: map['timeout'],
       entrypoint: map['entrypoint'].toString(),

lib/src/models/index.dart

@@ -43,8 +43,8 @@ class Index implements Model {
       type: map['type'].toString(),
       status: map['status'].toString(),
       error: map['error'].toString(),
-      attributes: map['attributes'] ?? [],
-      orders: map['orders'],
+      attributes: List.from(map['attributes'] ?? []),
+      orders: List.from(map['orders'] ?? []),
       $createdAt: map['\$createdAt'].toString(),
       $updatedAt: map['\$updatedAt'].toString(),
     );

lib/src/models/membership.dart

@@ -71,7 +71,7 @@ class Membership implements Model {
       joined: map['joined'].toString(),
       confirm: map['confirm'],
       mfa: map['mfa'],
-      roles: map['roles'] ?? [],
+      roles: List.from(map['roles'] ?? []),
     );
   }
 

lib/src/models/message.dart

@@ -63,12 +63,12 @@ class Message implements Model {
       $createdAt: map['\$createdAt'].toString(),
       $updatedAt: map['\$updatedAt'].toString(),
       providerType: map['providerType'].toString(),
-      topics: map['topics'] ?? [],
-      users: map['users'] ?? [],
-      targets: map['targets'] ?? [],
+      topics: List.from(map['topics'] ?? []),
+      users: List.from(map['users'] ?? []),
+      targets: List.from(map['targets'] ?? []),
       scheduledAt: map['scheduledAt']?.toString(),
       deliveredAt: map['deliveredAt']?.toString(),
-      deliveryErrors: map['deliveryErrors'],
+      deliveryErrors: List.from(map['deliveryErrors'] ?? []),
       deliveredTotal: map['deliveredTotal'],
       data: map['data'],
       status: map['status'].toString(),

lib/src/models/mfa_recovery_codes.dart

@@ -11,7 +11,7 @@ class MfaRecoveryCodes implements Model {
 
   factory MfaRecoveryCodes.fromMap(Map<String, dynamic> map) {
     return MfaRecoveryCodes(
-      recoveryCodes: map['recoveryCodes'] ?? [],
+      recoveryCodes: List.from(map['recoveryCodes'] ?? []),
     );
   }
 

lib/src/models/runtime.dart

@@ -46,7 +46,7 @@ class Runtime implements Model {
       base: map['base'].toString(),
       image: map['image'].toString(),
       logo: map['logo'].toString(),
-      supports: map['supports'] ?? [],
+      supports: List.from(map['supports'] ?? []),
     );
   }
 

lib/src/models/session.dart

@@ -149,7 +149,7 @@ class Session implements Model {
       countryCode: map['countryCode'].toString(),
       countryName: map['countryName'].toString(),
       current: map['current'],
-      factors: map['factors'] ?? [],
+      factors: List.from(map['factors'] ?? []),
       secret: map['secret'].toString(),
       mfaUpdatedAt: map['mfaUpdatedAt'].toString(),
     );

lib/src/models/topic.dart

@@ -46,7 +46,7 @@ class Topic implements Model {
       emailTotal: map['emailTotal'],
       smsTotal: map['smsTotal'],
       pushTotal: map['pushTotal'],
-      subscribe: map['subscribe'] ?? [],
+      subscribe: List.from(map['subscribe'] ?? []),
     );
   }