refactor(android): make sync callback optional (#7)

Author: OS-ruialves

.github/workflows/publish-android.yml

@@ -1,4 +1,4 @@
-name: Publish to Maven Central
+name: Publish Native Android Library
 
 on:
   release:
@@ -9,30 +9,47 @@ jobs:
   publish-android:
     runs-on: ubuntu-latest
     permissions: write-all
-    
     steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      
-      - name: Setup Java
+      - uses: actions/checkout@v2
+      - name: set up JDK 17
         uses: actions/setup-java@v4
         with:
-          java-version: '21'
+          java-version: '17'
           distribution: 'temurin'
-
+          
       - name: Grant execute permission for gradlew
         run: chmod +x ./android/gradlew
 
-      - name: Grant execute permission for publish script
+      - name: Grant execute permission for publishing script
         run: chmod +x ./scripts/publish-android.sh
 
+      - name: Make local props
+        run: |
+          cat << EOF > "./android/local.properties"
+          centralUsername=${{ secrets.ANDROID_CENTRAL_USERNAME }}
+          centralPassword=${{ secrets.ANDROID_CENTRAL_PASSWORD }}
+          sonatypeStagingProfileId=${{ secrets.ANDROID_SONATYPE_STAGING_PROFILE_ID }}
+          signing.keyId=${{ secrets.ANDROID_SIGNING_KEY_ID }}
+          signing.password=${{ secrets.ANDROID_SIGNING_PASSWORD }}
+          signing.key=${{ secrets.ANDROID_SIGNING_KEY }}
+          EOF
+          echo "local.properties file has been created successfully."
+
+      - name: Assemble release and add artifact to GH Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        if: ${{ github.event_name == 'release' }}
+        run: |
+          cd android && ./gradlew assembleRelease
+          gh release upload ${{ github.event.release.tag_name }} ./android/live-update-provider/build/outputs/aar/*.aar
+
       - name: Run publish script
         working-directory: ./scripts
         env:
-          ANDROID_OSSRH_USERNAME: ${{ secrets.ANDROID_OSSRH_USERNAME }}
-          ANDROID_OSSRH_PASSWORD: ${{ secrets.ANDROID_OSSRH_PASSWORD }}
+          ANDROID_CENTRAL_USERNAME: ${{ secrets.ANDROID_CENTRAL_USERNAME }}
+          ANDROID_CENTRAL_PASSWORD: ${{ secrets.ANDROID_CENTRAL_PASSWORD }}
           ANDROID_SIGNING_KEY_ID: ${{ secrets.ANDROID_SIGNING_KEY_ID }}
           ANDROID_SIGNING_PASSWORD: ${{ secrets.ANDROID_SIGNING_PASSWORD }}
-          ANDROID_SIGNING_KEY: ${{ secrets.ANDROID_SIGNING_SECRET_KEY }}
+          ANDROID_SIGNING_KEY: ${{ secrets.ANDROID_SIGNING_KEY }}
           ANDROID_SONATYPE_STAGING_PROFILE_ID: ${{ secrets.ANDROID_SONATYPE_STAGING_PROFILE_ID }}
         run: ./publish-android.sh

.gitignore

@@ -21,9 +21,8 @@ build/
 
 # Gradle files
 .gradle/
-**/. gradle/
+**/.gradle/
 local.properties
-gradle-wrapper.jar
 
 # Gradle build cache
 .gradle-cache/

README.md

@@ -1,21 +1,20 @@
 # Live Updates Provider SDK
 
-This repository contains the Live Updates Provider API for Android and iOS, which defines an abstraction layer for live update implementations.
+This repository contains the Live Updates Provider API for Android, which defines an abstraction layer for live update implementations.
 
 ## Project Structure
 
 ```
-live-updates-provider-sdk/
+live-update-provider-sdk/
 ├── android/                  # Android implementation
-│   ├── live-updates-provider/
+│   ├── live-update-provider/
 │   └── README.md
-└── ios/                      # iOS implementation (coming soon)
+└── scripts/                  # Publishing scripts
 ```
 
-## Platform Documentation
+## Documentation
 
 - [Android Implementation](android/README.md)
-- iOS Implementation (coming soon)
 
 ## Overview
 
@@ -31,4 +30,4 @@ Each platform implementation provides a default Ionic provider that integrates w
 
 ## License
 
-Copyright © 2024 Ionic
+Copyright © 2026 Ionic

android/README.md

@@ -2,55 +2,80 @@
 
 Android implementation of the Live Updates Provider API, which defines an abstraction layer for live update implementations.
 
+## Installation
+
+Add the dependency to your `build.gradle` or `build.gradle.kts`:
+
+**Gradle (Groovy)**
+```groovy
+dependencies {
+    implementation 'io.ionic:liveupdateprovider:0.1.0-alpha.1'
+}
+```
+
+**Gradle (Kotlin DSL)**
+```kotlin
+dependencies {
+    implementation("io.ionic:liveupdateprovider:0.1.0-alpha.1")
+}
+```
+
 ## Building
 
 ```bash
 # Build the library
-./gradlew :live-updates-provider:build
+./gradlew :live-update-provider:build
 
 # Run tests
-./gradlew :live-updates-provider:test
+./gradlew :live-update-provider:test
 
 # Generate AAR
-./gradlew :live-updates-provider:assembleRelease
+./gradlew :live-update-provider:assembleRelease
 ```
 
 The output AAR will be located at:
 ```
-android/live-updates-provider/build/outputs/aar/live-updates-provider-release.aar
+android/live-update-provider/build/outputs/aar/live-update-provider-release.aar
 ```
 
 ## Requirements
 
-- Android SDK 21+ (minSdk)
-- Kotlin 1.9.25
+- Android SDK 24+ (minSdk)
+- Kotlin 2.1.0
 - Java 17
-- Gradle 8.9+
+- Gradle 8.13+
 
 ## Dependencies
 
 The provider API module depends on:
 - AndroidX Core KTX
-- Kotlin Coroutines for Android
 
 ## Usage
 
-Providers register themselves with the `LiveUpdatesRegistry`:
+Providers register themselves with the `LiveUpdateProviderRegistry`:
 
 ```kotlin
 // Register a provider implementation
-LiveUpdatesRegistry.register(myProviderInstance)
+LiveUpdateProviderRegistry.register(myProviderInstance)
 
 // Resolve and create a manager
-val provider = LiveUpdatesRegistry.require("provider-id") // LiveUpdatesRegistry.resolve("provider-id")
-val config = ProviderConfig(mapOf("appId" to "my-app", "channel" to "your-channel"))
+val provider = LiveUpdateProviderRegistry.require("provider-id") // LiveUpdateProviderRegistry.resolve("provider-id")
+val config = mapOf("appId" to "my-app", "channel" to "your-channel")
 val manager = provider.createManager(context, config)
 
-// Sync and check for updates
-val result = manager.sync()
-if (result.didUpdate) {
-    val assetsDir = result.latestAppDirectory
-}
+// Sync (with callback)
+manager.sync(object : ProviderSyncCallback {
+    override fun onSuccess(result: ProviderSyncResult) {
+        // Check if update was applied
+        if (result is FederatedCapacitorSyncResult && result.didUpdate) {
+            val assetsDir = manager.latestAppDirectory
+        }
+    }
+
+    override fun onFailure(error: LiveUpdateError.SyncFailed) {
+        // Handle error
+    }
+})
 ```
 
 ## Publishing
@@ -60,23 +85,33 @@ if (result.didUpdate) {
 Publish to your local Maven repository for testing:
 
 ```bash
+export LIVE_UPDATE_PROVIDER_SDK_VERSION=0.1.0-alpha.1
 ./gradlew publishToMavenLocal
 ```
 
 ### Maven Central
 
-Production releases are automated via CI. The version is managed in `android/package.json`.
-
-1. Update the version in `android/package.json`
-2. Create a GitHub release
-3. The `publish-android.yml` workflow automatically runs `scripts/publish-android.sh`
-4. The script publishes to Maven Central if the version is not already published
+Production releases are automated via CI using `.github/workflows/publish-android.yml`.
 
-To manually publish, run the script from the repository root:
+**Prerequisites:**
+Configure the following GitHub secrets in your repository:
+- `ANDROID_CENTRAL_USERNAME` - Maven Central username
+- `ANDROID_CENTRAL_PASSWORD` - Maven Central password
+- `ANDROID_SONATYPE_STAGING_PROFILE_ID` - Sonatype staging profile ID
+- `ANDROID_SIGNING_KEY_ID` - GPG signing key ID
+- `ANDROID_SIGNING_PASSWORD` - GPG signing password
+- `ANDROID_SIGNING_KEY` - GPG signing key (base64 encoded)
 
-```bash
-./scripts/publish-android.sh
-```
+**Release Process:**
+1. Update the version in `android/package.json`
+2. Commit and merge changes to the main branch
+3. Create a GitHub release with tag matching the version (e.g., `v0.1.0-alpha.1`)
+4. The GitHub Actions workflow will:
+   - Build the Android library
+   - Upload the AAR artifact to the GitHub release
+   - Publish the library to Maven Central
+
+The version is read from `android/package.json` and the publish script checks if the version already exists on Maven Central before publishing.
 
 ## License
 

android/build.gradle.kts

@@ -1,3 +1,7 @@
+plugins {
+    id("org.jetbrains.dokka") version "2.0.0"
+}
+
 buildscript {
     val kotlinVersion = "2.1.0"
     extra.apply {
@@ -7,30 +11,38 @@ buildscript {
     repositories {
         google()
         mavenCentral()
+        maven {
+            url = uri("https://plugins.gradle.org/m2/")
+        }
     }
-    
+
     dependencies {
-        if (System.getenv("LIVEUPDATESPROVIDER_PUBLISH") == "true") {
+        if (System.getenv("LIVE_UPDATE_PROVIDER_PUBLISH") == "true") {
             classpath("io.github.gradle-nexus:publish-plugin:2.0.0")
         }
 
+        classpath("org.jetbrains.dokka:dokka-base:1.9.20")
         classpath("com.android.tools.build:gradle:8.13.0")
         classpath(kotlin("gradle-plugin", version = kotlinVersion))
+        classpath(kotlin("serialization", version = kotlinVersion))
     }
 }
 
-if (System.getenv("LIVEUPDATESPROVIDER_PUBLISH") == "true") {
+if (System.getenv("LIVE_UPDATE_PROVIDER_PUBLISH") == "true") {
     apply(plugin = "io.github.gradle-nexus.publish-plugin")
-    apply(from = file("./live-updates-provider/scripts/publish-root.gradle"))
+    apply(from = file("./live-update-provider/scripts/publish-root.gradle"))
 }
 
 allprojects {
     repositories {
         google()
         mavenCentral()
     }
+
+    apply(plugin = "org.jetbrains.dokka")
 }
 
-tasks.register<Delete>("clean") {
-    delete(rootProject.layout.buildDirectory)
+// register Clean task
+tasks.register("clean").configure {
+    delete("build")
 }

android/gradle/wrapper/gradle-wrapper.jar

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-all.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

android/gradle/wrapper/gradle-wrapper.properties

@@ -0,0 +1,57 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
+plugins {
+    id("com.android.library")
+    id("maven-publish")
+    kotlin("android")
+}
+
+if (System.getenv("LIVE_UPDATE_PROVIDER_PUBLISH") == "true") {
+    apply(from = file("./scripts/publish-module.gradle"))
+}
+
+android {
+    namespace = "io.ionic.liveupdateprovider"
+    compileSdk = 36
+
+    defaultConfig {
+        minSdk = 24
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+    }
+
+    sourceSets {
+        getByName("main").java.srcDirs("src/main/kotlin")
+        getByName("test").java.srcDirs("src/test/kotlin")
+    }
+
+    buildTypes {
+        getByName("release") {
+            isMinifyEnabled = false
+            proguardFiles(getDefaultProguardFile("proguard-android-optimize.txt"), "proguard-rules.pro")
+        }
+    }
+
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_17
+        targetCompatibility = JavaVersion.VERSION_17
+    }
+
+    kotlinOptions {
+        jvmTarget = "17"
+    }
+
+    publishing {
+        singleVariant("release")
+    }
+}
+
+kotlin {
+    compilerOptions {
+        jvmTarget = JvmTarget.JVM_17
+    }
+}
+
+dependencies {
+    implementation("androidx.core:core-ktx:1.17.0")
+    testImplementation("junit:junit:4.13.2")
+}