From ab4b982901cd04d74b8f637138d29b05f430a124 Mon Sep 17 00:00:00 2001
From: Craig Russell <1336281+CDRussell@users.noreply.github.com>
Date: Thu, 11 Dec 2025 13:57:56 +0000
Subject: [PATCH] Update sync APIs to support deletions

---
 .../sync/api/engine/DeletableDataManger.kt    | 39 +++++++++++++++++++
 .../com/duckduckgo/sync/api/engine/Models.kt  | 20 ++++++++++
 2 files changed, 59 insertions(+)
 create mode 100644 sync/sync-api/src/main/java/com/duckduckgo/sync/api/engine/DeletableDataManger.kt

diff --git a/sync/sync-api/src/main/java/com/duckduckgo/sync/api/engine/DeletableDataManger.kt b/sync/sync-api/src/main/java/com/duckduckgo/sync/api/engine/DeletableDataManger.kt
new file mode 100644
index 000000000000..cc9ffa6b5231
--- /dev/null
+++ b/sync/sync-api/src/main/java/com/duckduckgo/sync/api/engine/DeletableDataManger.kt
@@ -0,0 +1,39 @@
+/*
+ * Copyright (c) 2025 DuckDuckGo
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package com.duckduckgo.sync.api.engine
+
+interface DeletableDataManager {
+    /**
+     * Used by the SyncClient to get all the deletions from each syncable feature
+     */
+    fun getDeletions(): SyncDeletionRequest? = null
+
+    /**
+     * Which syncable data type this deletion is for
+     */
+    fun getType(): SyncableType
+
+    /**
+     * Called to notify that the deletion request was successful
+     */
+    fun onSuccess(response: SyncDeletionResponse) {}
+
+    /**
+     * Called to notify that the deletion request failed
+     */
+    fun onError(syncErrorResponse: SyncErrorResponse) {}
+}
diff --git a/sync/sync-api/src/main/java/com/duckduckgo/sync/api/engine/Models.kt b/sync/sync-api/src/main/java/com/duckduckgo/sync/api/engine/Models.kt
index baaf0bab2f8f..5ac427ae02c3 100644
--- a/sync/sync-api/src/main/java/com/duckduckgo/sync/api/engine/Models.kt
+++ b/sync/sync-api/src/main/java/com/duckduckgo/sync/api/engine/Models.kt
@@ -60,6 +60,26 @@ data class SyncChangesResponse(
     }
 }
 
+/**
+ * Represents a request to delete a syncable type
+ * @param type The type of syncable data to delete.
+ * @param untilTimestamp An optional timestamp to indicate that only items modified before this timestamp should be deleted.
+ */
+data class SyncDeletionRequest(
+    val type: SyncableType,
+    val untilTimestamp: String? = null,
+)
+
+/**
+ * Represents a response to a sync deletion request.
+ * @param type The type of syncable data that was deleted.
+ * @param untilTimestamp The timestamp provided in @[SyncDeletionRequest] indicating the last modified timestamp up until which deletions should be performed.
+ */
+data class SyncDeletionResponse(
+    val type: SyncableType,
+    val untilTimestamp: String? = null,
+)
+
 data class SyncErrorResponse(
     val type: SyncableType,
     val featureSyncError: FeatureSyncError,