Merge pull request #1836 from nextcloud/declarative-ui

Declarative UI

Author: tobiasKaminsky

.idea/codeStyles/Project.xml

@@ -23,6 +23,7 @@
 import com.owncloud.android.lib.resources.status.NextcloudVersion;
 import com.owncloud.android.lib.resources.status.OCCapability;
 import com.owncloud.android.lib.resources.status.OwnCloudVersion;
+import com.owncloud.android.lib.resources.status.Type;
 
 import org.junit.Test;
 
@@ -161,4 +162,17 @@ private void checkCapability(OCCapability capability, String userId) {
             assertTrue(capability.isWCFEnabled().isFalse());
         }
     }
+    
+    @Test
+    public void testClientIntegration() {
+        // get capabilities
+        RemoteOperationResult<OCCapability> result = new GetCapabilitiesRemoteOperation().execute(nextcloudClient);
+        assertTrue(result.isSuccess());
+        assertNotNull(result.getResultData());
+
+        OCCapability capability = result.getResultData();
+
+        assertEquals(1, capability.getClientIntegrationEndpoints(Type.CONTEXT_MENU, "application/pdf").size());
+        assertEquals(0, capability.getClientIntegrationEndpoints(Type.CREATE_NEW, "").size());
+    } 
 }

library/src/androidTest/java/com/owncloud/android/GetCapabilitiesRemoteOperationIT.java

@@ -0,0 +1,19 @@
+/*
+ * Nextcloud Android Library
+ *
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2025 Tobias Kaminsky <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import com.google.gson.annotations.SerializedName
+
+data class App(
+    val version: Double,
+    @SerializedName("context-menu")
+    val contextMenu: List<Endpoint>,
+    @SerializedName("create-new")
+    val createNew: List<Endpoint>
+)

library/src/main/java/com/nextcloud/android/lib/resources/clientintegration/App.kt

@@ -0,0 +1,18 @@
+/*
+ * Nextcloud Android Library
+ *
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2025 Tobias Kaminsky <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import android.os.Parcelable
+import kotlinx.parcelize.Parcelize
+
+@Parcelize
+data class ClientIntegrationUI(
+    val version: Double,
+    val root: Layout?
+) : Parcelable

library/src/main/java/com/nextcloud/android/lib/resources/clientintegration/ClientIntegrationUI.kt

@@ -0,0 +1,13 @@
+/*
+ * Nextcloud Android Library
+ *
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2025 Tobias Kaminsky <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import android.os.Parcelable
+
+interface Element : Parcelable

library/src/main/java/com/nextcloud/android/lib/resources/clientintegration/Element.kt

@@ -0,0 +1,68 @@
+/*
+ * Nextcloud Android Library
+ *
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2025 Tobias Kaminsky <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import com.google.gson.Gson
+import com.google.gson.JsonDeserializationContext
+import com.google.gson.JsonDeserializer
+import com.google.gson.JsonElement
+import com.google.gson.JsonParseException
+import com.google.gson.JsonSerializationContext
+import com.google.gson.JsonSerializer
+import java.lang.reflect.Type
+
+class ElementTypeAdapter :
+    JsonSerializer<Element>,
+    JsonDeserializer<Element> {
+    override fun serialize(
+        src: Element,
+        type: Type,
+        context: JsonSerializationContext
+    ): JsonElement {
+        // needs to be a new Gson instance, otherwise we end up in a loop
+        val element = Gson().toJsonTree(src)
+        element.asJsonObject.addProperty("element", src.javaClass.name)
+
+        return element
+    }
+
+    @Throws(JsonParseException::class, ClassNotFoundException::class, Throwable::class)
+    override fun deserialize(
+        json: JsonElement,
+        type: Type,
+        context: JsonDeserializationContext
+    ): Element? {
+        val jsonObject = json.asJsonObject
+        val typeName = jsonObject.get("element").asString
+
+        try {
+            val prefix = "com.nextcloud.android.lib.resources.clientintegration"
+            val cls: Class<out Element> =
+                when (typeName) {
+                    "Button" ->
+                        Class.forName("$prefix.LayoutButton") as Class<out Element>
+
+                    "Text" ->
+                        Class.forName("$prefix.LayoutText") as Class<out Element>
+
+                    "Image" ->
+                        Class.forName("$prefix.LayoutImage") as Class<out Element>
+
+                    "URL" ->
+                        Class.forName("$prefix.LayoutURL") as Class<out Element>
+
+                    else -> return null
+                }
+
+            return Gson().fromJson(json, cls)
+        } catch (e: ClassNotFoundException) {
+            throw JsonParseException(e)
+        }
+    }
+}

library/src/main/java/com/nextcloud/android/lib/resources/clientintegration/ElementTypeAdapter.kt

@@ -0,0 +1,25 @@
+/*
+ * Nextcloud Android Library
+ *
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2025 Tobias Kaminsky <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import android.os.Parcelable
+import com.google.gson.annotations.SerializedName
+import com.owncloud.android.lib.resources.status.Method
+import kotlinx.parcelize.Parcelize
+
+@Parcelize
+data class Endpoint(
+    val name: String,
+    val url: String,
+    var method: Method?,
+    @SerializedName("mimetype_filters")
+    val mimetypeFilter: String?,
+    val params: Map<String, String>?,
+    val icon: String?
+) : Parcelable

library/src/main/java/com/nextcloud/android/lib/resources/clientintegration/Endpoint.kt

@@ -0,0 +1,20 @@
+/*
+ * Nextcloud Android Library
+ *
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2025 Tobias Kaminsky <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import android.os.Parcelable
+import com.google.gson.annotations.SerializedName
+import kotlinx.parcelize.Parcelize
+
+@Parcelize
+data class Layout(
+    @SerializedName("orientation")
+    var orientation: LayoutOrientation,
+    var rows: List<LayoutRow>
+) : Parcelable

library/src/main/java/com/nextcloud/android/lib/resources/clientintegration/Layout.kt

@@ -0,0 +1,19 @@
+/*
+ * Nextcloud Android Library
+ *
+ * SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
+ * SPDX-FileCopyrightText: 2025 Tobias Kaminsky <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import android.os.Parcelable
+import kotlinx.parcelize.Parcelize
+
+@Parcelize
+data class LayoutButton(
+    val label: String,
+    val type: String
+) : Element,
+    Parcelable

library/src/main/java/com/nextcloud/android/lib/resources/clientintegration/LayoutButton.kt

@@ -0,0 +1,17 @@
+/*
+ * Nextcloud Android Library
+ *
+ * SPDX-FileCopyrightText: 2025 Alper Ozturk <[email protected]>
+ * SPDX-License-Identifier: MIT
+ */
+
+package com.nextcloud.android.lib.resources.clientintegration
+
+import android.os.Parcelable
+import kotlinx.parcelize.Parcelize
+
+@Parcelize
+data class LayoutImage(
+    val url: String
+) : Element,
+    Parcelable