🎉 Add Partial Updates

Author: drexhacker

CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.0.5] - 2024-12-10
+
+### Improvements
+- Add `updatedFields` save param to facilitate partial updates (PATCH).
+- Updated the documentation to showcase the usage of this param.
+
 ## [0.0.4] - 2024-12-08
 
 ### Improvements

README.md

@@ -8,7 +8,7 @@ A Flutter Data adapter for Appwrite that provides offline support, real-time upd
 - 📱 **Offline Support**: Work with your data even when offline
 - ⚡ **Real-time Updates**: Listen to changes in your Appwrite collections in real-time
 - 🔍 **Advanced Querying**: Supported operators: '==', '!=', '>', '>=', '<', '<=', 'startsWith', 'endsWith', 'contains', 'search', 'between', 'in', 'isNull', 'isNotNull'.
-- 🎯 **Type-safe**: Fully typed models and queries
+- 🎯 **Type-safe**: Fully typed models, queries, & partial updates
 - 🪄 **Easy Integration**: Simple setup process with minimal configuration
 
 ## Prerequisites
@@ -27,7 +27,7 @@ Add this to your package's pubspec.yaml file:
 
 ```yaml
 dependencies:
-  appwrite_offline: ^0.0.3
+  appwrite_offline: ^0.0.5
 ```
 
 ## Setup
@@ -92,6 +92,12 @@ class Product extends DataModel<Product> {
 dart run build_runner build -d
 ```
 
+OR
+
+```bash
+dart run build_runner watch
+```
+
 ## Usage
 
 ### Basic Operations
@@ -100,7 +106,7 @@ dart run build_runner build -d
 class ProductsScreen extends ConsumerWidget {
   @override
   Widget build(BuildContext context, WidgetRef ref) {
-    // Watch all products with offline support
+    // Watch all products with offline sync support
     final productsState = ref.products.watchAll(
       syncLocal: true,
     );
@@ -141,12 +147,23 @@ class ProductFormScreen extends ConsumerWidget {
           name: 'New Product',
           price: 99.99,
         ).save();
-
+        
         // Update existing product
         final updatedProduct = await Product(
           name: 'Updated Product',
           price: 149.99,
         ).withKeyOf(existingProduct).save();
+        
+        // Partially update existing product
+        final updatedProduct = await Product(
+          name: 'Product Name',
+          price: 239.99,
+        ).withKeyOf(existingProduct).save(
+          params: {
+            "updatedFields": jsonEncode(['price']), 
+            // This informs the adapter to only send these fields, hence improving performance
+          },
+        );
       },
       child: Text('Save Product'),
     );

lib/adapters/appwrite.dart

@@ -6,6 +6,7 @@ import 'dart:convert';
 import 'package:appwrite_offline/config.dart';
 import 'package:appwrite_offline/extensions/framework.dart';
 import 'package:appwrite_offline/models.dart';
+import 'package:flutter/foundation.dart' show debugPrint;
 import 'package:flutter_data/flutter_data.dart';
 import 'package:appwrite/appwrite.dart';
 
@@ -179,7 +180,6 @@ mixin AppwriteAdapter<T extends DataModel<T>> on RemoteAdapter<T> {
           uri.pathSegments.length > 2 ? uri.pathSegments[2] : null;
 
       dynamic response;
-
       Map? bodyData = body != null ? json.decode(body as String) : null;
       Set<String> keysToRemove = {'id', 'createdAt', 'updatedAt'};
       bodyData?.removeWhere(
@@ -263,14 +263,16 @@ mixin AppwriteAdapter<T extends DataModel<T>> on RemoteAdapter<T> {
           break;
         case DataRequestMethod.PUT:
         case DataRequestMethod.PATCH:
-          if (documentId == null) {
+          if (documentId == null || bodyData == null) {
             throw Exception('Document ID is required for PATCH operations');
           }
+          final updateData = _parsePartialUpdate(
+              queryParams: uri.queryParameters, body: bodyData);
           final updatedDoc = await _databases.updateDocument(
             databaseId: databaseId,
             collectionId: collectionId,
             documentId: documentId,
-            data: bodyData,
+            data: updateData,
           );
           updatedDoc.data.addAll({
             "id": updatedDoc.$id,
@@ -361,6 +363,23 @@ mixin AppwriteAdapter<T extends DataModel<T>> on RemoteAdapter<T> {
     return commonExceptions.any(err.contains);
   }
 
+  /// Parses updatedFields from query parameters
+  ///
+  /// And Returns only a new request body with only updated fields
+  Map _parsePartialUpdate(
+      {required Map<String, String> queryParams, required Map body}) {
+    if (!queryParams.containsKey('updatedFields')) {
+      return body;
+    }
+
+    List updatedFields = json.decode(queryParams['updatedFields']!);
+    Set keysToRemove =
+        body.keys.where((key) => !updatedFields.contains(key)).toSet();
+    body.removeWhere(
+        (key, value) => value == null || keysToRemove.contains(key));
+    return body;
+  }
+
   /// Parses permission rules from query parameters
   ///
   /// Supported permission types:

pubspec.yaml

@@ -1,6 +1,6 @@
 name: appwrite_offline
 description: "A Flutter Data adapter for Appwrite that provides offline support, real-time updates, and seamless integration with Flutter Data's powerful features."
-version: 0.0.4
+version: 0.0.5
 homepage: https://github.com/cybroidtech/appwrite_offline
 repository: https://github.com/cybroidtech/appwrite_offline
 issue_tracker: https://github.com/cybroidtech/appwrite_offline/issues