Plugins: bringup

core/shared/build.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
     alias(libs.plugins.android.library)
     alias(libs.plugins.kotlin.android)
+    `maven-publish`
 }
 
 android {
@@ -35,4 +36,51 @@ android {
         jvmTarget = "1.8"
     }
     namespace = "de.mm20.launcher2.shared"
+
+    publishing {
+        singleVariant("release") {
+            withSourcesJar()
+        }
+    }
+}
+
+publishing {
+    publications {
+        register<MavenPublication>("release") {
+            groupId = "de.mm20.launcher2"
+            artifactId = "shared"
+            version = "1.0.0-SNAPSHOT"
+
+            pom {
+                name = "Kvaesitso SDK"
+                licenses {
+                    license {
+                        name = "The Apache License, Version 2.0"
+                        url = "http://www.apache.org/licenses/LICENSE-2.0.txt"
+                    }
+                }
+                developers {
+                    developer {
+                        id = "MM2-0"
+                        name = "U.N.Owen"
+                    }
+                }
+            }
+
+            afterEvaluate {
+                from(components["release"])
+            }
+        }
+    }
+    repositories {
+        mavenLocal()
+        maven {
+            name = "GitHubPackages"
+            url = uri("https://maven.pkg.github.com/MM2-0/Kvaesitso")
+            credentials {
+                username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME")
+                password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN")
+            }
+        }
+    }
 }

core/shared/src/main/java/de/mm20/launcher2/plugin/PluginState.kt

@@ -0,0 +1,10 @@
+package de.mm20.launcher2.plugin
+
+
+sealed class PluginState {
+    data object Ready : PluginState()
+    data class SetupRequired(
+        val setupActivity: String,
+        val message: String? = null,
+    ) : PluginState()
+}

core/shared/src/main/java/de/mm20/launcher2/plugin/PluginType.kt

@@ -0,0 +1,5 @@
+package de.mm20.launcher2.plugin
+
+enum class PluginType {
+    FileSearch,
+}

core/shared/src/main/java/de/mm20/launcher2/plugin/config/StorageStrategy.kt

@@ -0,0 +1,25 @@
+package de.mm20.launcher2.plugin.config
+
+/**
+ * Defines how the launcher should store search results from a plugin (i.e. when the search result is
+ * added to favorites).
+ */
+enum class StorageStrategy {
+    /**
+     * The launcher only stores the ID and the plugin provider for the search result. To restore the
+     * search result, the launcher will query the plugin provider again. This strategy allows the
+     * plugin provider to update a search result at a later point in time. However, plugins that use
+     * this strategy must guarantee that a search result can be restored in a timely manner. In
+     * particular, the plugin provider must be able to restore a search result without any network
+     * requests.
+     */
+    StoreReference,
+
+    /**
+     * The launcher stores all relevant information in its own internal database. This strategy
+     * is easier to implement, but search results cannot be updated at a later point in time.
+     * Use this strategy if your plugin needs to perform network requests to retrieve search
+     * results and if you don't want to implement a cache for search results.
+     */
+    StoreCopy,
+}

core/shared/src/main/java/de/mm20/launcher2/plugin/contracts/FilePluginContract.kt

@@ -1,28 +1,8 @@
-package de.mm20.launcher2.provider.files
+package de.mm20.launcher2.plugin.contracts
 
-import android.content.ContentUris
-import android.net.Uri
+abstract class FilePluginContract {
 
-object FilePluginContract {
-    object Roots {
-        const val Id = "id"
-        const val DisplayName = "display_name"
-        const val Description = "description"
-        const val Status = "status"
-        const val AccountAuthority = "account_authority"
-
-        const val PathSegment = "roots"
-
-        fun getContentUri(authority: String): Uri {
-            return Uri.Builder()
-                .scheme("content")
-                .authority(authority)
-                .path(PathSegment)
-                .build()
-        }
-    }
-
-    object Files {
+    object FileColumns {
         /**
          * The unique ID of the file.
          * Type: String
@@ -36,7 +16,8 @@ object FilePluginContract {
         const val DisplayName = "display_name"
 
         /**
-         * The MIME type of the file.
+         * The MIME type of the file. This is used to determine how to open the file. Make sure that
+         * this is either a common MIME type or that your app can handle this MIME type.
          * Type: String?
          */
         const val MimeType = "mime_type"
@@ -53,6 +34,22 @@ object FilePluginContract {
          */
         const val Path = "path"
 
+        /**
+         * The URI to view the file.
+         * Type: String?
+         */
+        const val ContentUri = "uri"
+
+        const val ThumbnailUri = "thumbnail_uri"
+
+        const val StorageStrategy = "storage_strategy"
+
+        /**
+         * Whether the file is a directory.
+         * Type: Int
+         */
+        const val IsDirectory = "is_directory"
+
         const val MetaTitle = "meta_title"
         const val MetaArtist = "meta_artist"
         const val MetaAlbum = "meta_album"

core/shared/src/main/java/de/mm20/launcher2/plugin/contracts/PluginContract.kt

@@ -0,0 +1,10 @@
+package de.mm20.launcher2.plugin.contracts
+
+object PluginContract {
+
+    const val Permission = "de.mm20.launcher2.permission.USE_PLUGINS"
+    object Methods {
+        const val GetType = "getType"
+        const val GetState = "getState"
+    }
+}

core/shared/src/main/java/de/mm20/launcher2/plugin/contracts/SearchPluginContract.kt

@@ -0,0 +1,9 @@
+package de.mm20.launcher2.plugin.contracts
+
+abstract class SearchPluginContract {
+    object Paths {
+        const val Search = "search"
+        const val Root = "root"
+        const val QueryParam = "query"
+    }
+}

core/shared/src/main/java/de/mm20/launcher2/provider/accounts/AccountPluginContract.kt

@@ -1,14 +0,0 @@
-package de.mm20.launcher2.provider.accounts
-
-object AccountPluginContract {
-    object Accounts {
-        const val Id = "id"
-        const val DisplayName = "display_name"
-        const val Type = "type"
-    }
-    object AccountTypes {
-        const val Id = "id"
-        const val DisplayName = "display_name"
-        const val SupportsMultipleAccounts = "supports_multiple_accounts"
-    }
-}