First Commit

libraries/pushstore/api/build.gradle.kts

@@ -0,0 +1,19 @@
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2023-2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
+ * Please see LICENSE files in the repository root for full details.
+ */
+plugins {
+    id("io.element.android-library")
+}
+
+android {
+    namespace = "io.element.android.libraries.pushstore.api"
+}
+
+dependencies {
+    implementation(libs.coroutines.core)
+    implementation(projects.libraries.matrix.api)
+}

libraries/pushstore/api/src/main/kotlin/io/element/android/libraries/pushstore/api/UserPushStore.kt

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2023-2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.libraries.pushstore.api
+import kotlinx.coroutines.flow.Flow
+
+/**
+ * Store data related to push about a user.
+ */
+interface UserPushStore {
+    suspend fun getPushProviderName(): String?
+    suspend fun setPushProviderName(value: String)
+    suspend fun getCurrentRegisteredPushKey(): String?
+    suspend fun setCurrentRegisteredPushKey(value: String?)
+
+    fun getNotificationEnabledForDevice(): Flow<Boolean>
+    suspend fun setNotificationEnabledForDevice(enabled: Boolean)
+
+    fun ignoreRegistrationError(): Flow<Boolean>
+    suspend fun setIgnoreRegistrationError(ignore: Boolean)
+
+    /**
+     * Return true if Pin code is disabled, or if user set the settings to see full notification content.
+     */
+    fun useCompleteNotificationFormat(): Boolean
+
+    suspend fun reset()
+}

libraries/pushstore/api/src/main/kotlin/io/element/android/libraries/pushstore/api/UserPushStoreFactory.kt

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2023-2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.libraries.pushstore.api
+
+import io.element.android.libraries.matrix.api.core.SessionId
+
+/**
+ * Store data related to push about a user.
+ */
+interface UserPushStoreFactory {
+    fun getOrCreate(userId: SessionId): UserPushStore
+}

libraries/pushstore/api/src/main/kotlin/io/element/android/libraries/pushstore/api/clientsecret/PushClientSecret.kt

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2023-2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.libraries.pushstore.api.clientsecret
+
+import io.element.android.libraries.matrix.api.core.SessionId
+
+interface PushClientSecret {
+    /**
+     * To call when registering a pusher. It will return the existing secret or create a new one.
+     */
+    suspend fun getSecretForUser(userId: SessionId): String
+
+    /**
+     * To call when receiving a push containing a client secret.
+     * Return null if not found.
+     */
+    suspend fun getUserIdFromSecret(clientSecret: String): SessionId?
+}

libraries/pushstore/api/src/main/kotlin/io/element/android/libraries/pushstore/api/clientsecret/PushClientSecretFactory.kt

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2023-2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.libraries.pushstore.api.clientsecret
+
+interface PushClientSecretFactory {
+    fun create(): String
+}

libraries/pushstore/api/src/main/kotlin/io/element/android/libraries/pushstore/api/clientsecret/PushClientSecretStore.kt

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) 2025 Element Creations Ltd.
+ * Copyright 2023-2025 New Vector Ltd.
+ *
+ * SPDX-License-Identifier: AGPL-3.0-only OR LicenseRef-Element-Commercial.
+ * Please see LICENSE files in the repository root for full details.
+ */
+
+package io.element.android.libraries.pushstore.api.clientsecret
+
+import io.element.android.libraries.matrix.api.core.SessionId
+
+interface PushClientSecretStore {
+    suspend fun storeSecret(userId: SessionId, clientSecret: String)
+    suspend fun getSecret(userId: SessionId): String?
+    suspend fun resetSecret(userId: SessionId)
+    suspend fun getUserIdFromSecret(clientSecret: String): SessionId?
+}