feat(android): home widget support

.github/workflows/spotube-release-binary.yml

@@ -87,6 +87,12 @@ jobs:
         uses: dtolnay/rust-toolchain@stable
         with:
           toolchain: stable
+
+      - name: Install Xcode
+        if: ${{matrix.platform == 'ios'}}
+        uses: maxim-lobanov/setup-xcode@v1
+        with:
+          xcode-version: '16.1'
 
       - name: Install ${{matrix.platform}} dependencies
         run: |

.gitignore

@@ -79,4 +79,6 @@ android/key.properties
 tm.json
 
 # FVM Version Cache
-.fvm/
+.fvm/
+
+android/build

.vscode/settings.json

@@ -27,5 +27,5 @@
     "README.md": "LICENSE,CODE_OF_CONDUCT.md,CONTRIBUTING.md,SECURITY.md,CONTRIBUTION.md,CHANGELOG.md,PRIVACY_POLICY.md",
     "*.dart": "${capture}.g.dart,${capture}.freezed.dart"
   },
-  "dart.flutterSdkPath": ".fvm/flutter_sdk"
+  "dart.flutterSdkPath": ".fvm/versions/3.27.0"
 }

android/app/build.gradle

@@ -28,8 +28,10 @@ if (keystorePropertiesFile.exists()) {
     keystoreProperties.load(new FileInputStream(keystorePropertiesFile))
 }
 
+def composeVersion = "1.4.8"
+
 android {
-    namespace "dev.krtirtho.spotube"
+    namespace "oss.krtirtho.spotube"
 
     compileSdkVersion 35
 
@@ -48,6 +50,14 @@ android {
         main.java.srcDirs += 'src/main/kotlin'
     }
 
+    buildFeatures {
+        compose true
+    }
+
+    composeOptions {
+        kotlinCompilerExtensionVersion "$composeVersion" // Correlates with org.jetbrains.kotlin.android plugin in settings.gradle
+    }
+
     defaultConfig {
         applicationId "oss.krtirtho.spotube"
         minSdkVersion 24
@@ -65,6 +75,7 @@ android {
             storePassword keystoreProperties['storePassword']
         }
     }
+
     buildTypes {
         release {
             signingConfig signingConfigs.release
@@ -98,15 +109,28 @@ android {
         }
     }
 
+    packagingOptions {
+        resources.excludes += "DebugProbesKt.bin"
+    }
 }
 
 flutter {
     source '../..'
 }
 
+def glanceVersion = "1.1.1"
 dependencies {
     implementation 'androidx.lifecycle:lifecycle-viewmodel-ktx:2.5.1'
-
     // other deps so just ignore
     implementation 'com.android.support:multidex:2.0.1'
+
+    implementation "androidx.glance:glance-appwidget:$glanceVersion"
+    implementation "androidx.glance:glance-appwidget-preview:$glanceVersion"
+    implementation "androidx.glance:glance-preview:$glanceVersion"
+    implementation "androidx.glance:glance-material3:$glanceVersion"
+    implementation "androidx.glance:glance-material:$glanceVersion"
+    implementation "androidx.work:work-runtime-ktx:2.8.1"
+
+    implementation "org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3"
+    implementation 'com.google.code.gson:gson:2.11.0'
 }

android/app/proguard-rules.pro

@@ -1 +1,8 @@
--keep class androidx.lifecycle.DefaultLifecycleObserver
+-keep class androidx.lifecycle.DefaultLifecycleObserver
+
+-keepnames class kotlinx.serialization.** { *; }
+-keepnames class oss.krtirtho.spotube.glance.models.** { *; }
+-keep @kotlinx.serialization.Serializable class *
+-keepclassmembers class ** {
+    @kotlinx.serialization.* <fields>;
+}

android/app/src/main/AndroidManifest.xml

@@ -17,51 +17,50 @@
   </queries>
 
   <application
+    android:name="${applicationName}"
     android:allowBackup="false"
     android:fullBackupContent="false"
-    android:label="@string/app_name_en"
-    android:name="${applicationName}"
     android:icon="@mipmap/ic_launcher"
-    android:usesCleartextTraffic="true"
+    android:label="@string/app_name_en"
     android:requestLegacyExternalStorage="true"
-  >
+    android:usesCleartextTraffic="true">
     <!-- Enable Impeller -->
     <!-- <meta-data
-      android:name="io.flutter.embedding.android.EnableImpeller"
-      android:value="true" /> -->
+          android:name="io.flutter.embedding.android.EnableImpeller"
+          android:value="true" /> -->
 
     <activity
       android:name="com.ryanheise.audioservice.AudioServiceActivity"
+      android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
       android:exported="true"
+      android:hardwareAccelerated="true"
       android:launchMode="singleInstance"
       android:theme="@style/LaunchTheme"
-      android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
-      android:hardwareAccelerated="true"
-      android:windowSoftInputMode="adjustResize"
-    >
+      android:windowSoftInputMode="adjustResize">
       <!--
-        Specifies an Android theme to apply to this Activity as soon as
-        the Android process has started. This theme is visible to the user
-        while the Flutter UI initializes. After that, this theme continues
-        to determine the Window background behind the Flutter UI. 
-      -->
+              Specifies an Android theme to apply to this Activity as soon as
+              the Android process has started. This theme is visible to the user
+              while the Flutter UI initializes. After that, this theme continues
+              to determine the Window background behind the Flutter UI.
+            -->
       <meta-data
         android:name="io.flutter.embedding.android.NormalTheme"
-        android:resource="@style/NormalTheme"
-      />
+        android:resource="@style/NormalTheme" />
+
       <intent-filter>
         <action android:name="android.intent.action.MAIN" />
         <category android:name="android.intent.category.LAUNCHER" />
       </intent-filter>
 
       <intent-filter>
         <action android:name="android.intent.action.VIEW" />
+
         <category android:name="android.intent.category.DEFAULT" />
         <category android:name="android.intent.category.BROWSABLE" />
+
         <data
-          android:scheme="https"
           android:host="open.spotify.com"
-        />
+          android:scheme="https" />
       </intent-filter>
 
       <intent-filter>
@@ -72,35 +71,71 @@
 
       <intent-filter>
         <action android:name="android.intent.action.VIEW" />
+
         <category android:name="android.intent.category.DEFAULT" />
         <category android:name="android.intent.category.BROWSABLE" />
         <!-- Accepts URIs that begin with "spotify:// -->
         <data android:scheme="spotify" />
+        <data android:scheme="spotube" />
       </intent-filter>
 
+      <intent-filter>
+        <action android:name="es.antonborri.home_widget.action.LAUNCH" />
+      </intent-filter>
     </activity>
 
     <!-- AudioService Config -->
-    <service android:name="com.ryanheise.audioservice.AudioService"
-      android:foregroundServiceType="mediaPlayback"
-      android:exported="true">
+    <service
+      android:name="com.ryanheise.audioservice.AudioService"
+      android:exported="true"
+      android:foregroundServiceType="mediaPlayback">
       <intent-filter>
         <action android:name="android.media.browse.MediaBrowserService" />
       </intent-filter>
     </service>
-    <receiver android:name="com.ryanheise.audioservice.MediaButtonReceiver"
+    <receiver
+      android:name="com.ryanheise.audioservice.MediaButtonReceiver"
       android:exported="true">
       <intent-filter>
         <action android:name="android.intent.action.MEDIA_BUTTON" />
       </intent-filter>
     </receiver>
     <!-- =================== -->
 
-    <meta-data android:name="com.google.android.gms.car.application"
+    <meta-data
+      android:name="com.google.android.gms.car.application"
       android:resource="@xml/automotive_app_desc" />
 
+    <!--  Home Widget config  -->
+    <receiver
+      android:name=".glance.HomePlayerWidgetReceiver"
+      android:exported="true">
+      <intent-filter>
+        <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />
+      </intent-filter>
+      <meta-data
+        android:name="android.appwidget.provider"
+        android:resource="@xml/home_player_widget_config" />
+    </receiver>
+
+    <receiver
+      android:name="es.antonborri.home_widget.HomeWidgetBackgroundReceiver"
+      android:exported="true">
+      <intent-filter>
+        <action android:name="es.antonborri.home_widget.action.BACKGROUND" />
+      </intent-filter>
+    </receiver>
+
+    <service
+      android:name="es.antonborri.home_widget.HomeWidgetBackgroundService"
+      android:exported="true"
+      android:permission="android.permission.BIND_JOB_SERVICE" />
+    <!-- =================== -->
+
     <!-- Don't delete the meta-data below.
-             This is used by the Flutter tool to generate GeneratedPluginRegistrant.java -->
-    <meta-data android:name="flutterEmbedding" android:value="2" />
+                 This is used by the Flutter tool to generate GeneratedPluginRegistrant.java -->
+    <meta-data
+      android:name="flutterEmbedding"
+      android:value="2" />
   </application>
 </manifest>