feat: Sync skip delete

packages/at_commons/CHANGELOG.md

@@ -1,3 +1,5 @@
+## 5.1.0
+- feat: Introduce skipDeletesUntil for sync:from verb
 ## 5.0.2
 - fix: Add "publicKeyHash" and "hashingAlgo" type to metadata.
 - build[deps]: Upgraded the following package:

packages/at_commons/lib/src/verb/sync_verb_builder.dart

@@ -1,14 +1,23 @@
 import 'package:at_commons/at_builders.dart';
 
 class SyncVerbBuilder implements VerbBuilder {
+  /// commitId from which entries will be synced from server to client
   late int commitId;
 
+  /// if regex is set, then only keys matching the regex will be synced from server to client
   String? regex;
 
+  @Deprecated(
+      'This field is not used anymore even though it is set in client. Remove this in next major release')
   int limit = 10;
 
+  @Deprecated(
+      'This field is not used anymore even though it is set in client. Remove this in next major release')
   bool isPaginated = false;
 
+  /// if skipDeletesUntil is set, then delete commit entries whose commitId is <= skipDeletesUntil will not be synced from server to client
+  int? skipDeletesUntil;
+
   @override
   String buildCommand() {
     StringBuffer serverCommandBuffer = StringBuffer('sync:');
@@ -19,6 +28,9 @@ class SyncVerbBuilder implements VerbBuilder {
     if (isPaginated) {
       serverCommandBuffer.write(':limit:$limit');
     }
+    if (skipDeletesUntil != null) {
+      serverCommandBuffer.write(':skipDeletesUntil:$skipDeletesUntil');
+    }
     if (regex != null && regex!.isNotEmpty) {
       serverCommandBuffer.write(':$regex');
     }

packages/at_commons/lib/src/verb/syntax.dart

@@ -26,7 +26,7 @@ class VerbSyntax {
       r'^stats(?<statId>:((?!0)\d+)?(,(\d+))*)?(:(?<regex>(?<=:3:|:15:).+))?$';
   static const sync = r'^sync:(?<from_commit_seq>[0-9]+|-1)(:(?<regex>.+))?$';
   static const syncFrom =
-      r'^sync:from:(?<from_commit_seq>[0-9]+|-1)(:limit:(?<limit>\d+))(:(?<regex>.+))?$';
+      r'^sync:from:(?<from_commit_seq>[0-9]+|-1)(:limit:(?<limit>\d+))?(:skipDeletesUntil:(?<skipDeletesUntil>\d+))?(:(?<regex>.+))?$';
 
   @visibleForTesting
   static const metadataFragment = r'(:ttl:(?<ttl>(-?)\d+))?'

packages/at_commons/pubspec.yaml

@@ -1,6 +1,6 @@
 name: at_commons
 description: A library of Dart and Flutter utility classes that are used across other components of the atPlatform.
-version: 5.0.2
+version: 5.1.0
 repository: https://github.com/atsign-foundation/at_libraries
 homepage: https://atsign.dev
 

packages/at_commons/test/sync_verb_builder_test.dart

@@ -69,4 +69,17 @@ void main() {
     command = command.replaceAll('\n', '');
     assert(regex.hasMatch(command));
   });
+
+  test('build sync stream verb command with skipDeletes', () {
+    var syncVerbBuilder = SyncVerbBuilder()
+      ..commitId = -1
+      ..isPaginated = true
+      ..limit = 5
+      ..skipDeletesUntil = 20;
+    var command = syncVerbBuilder.buildCommand();
+    expect(command, 'sync:from:-1:limit:5:skipDeletesUntil:20\n');
+    var regex = RegExp(VerbSyntax.syncFrom);
+    command = command.replaceAll('\n', '');
+    assert(regex.hasMatch(command));
+  });
 }