docs: Use American spelling (#96)

# [3.2.0-dev.1](https://github.com/ReVanced/revanced-library/compare/v3.1.1-dev.1...v3.2.0-dev.1) (2025-05-27)

### Features

* Request the update ownership enforcement ([#71](https://github.com/ReVanced/revanced-library/issues/71)) ([be0f6bf](be0f6bf247))

.github/workflows/release.yml

@@ -10,6 +10,9 @@ on:
 jobs:
   release:
     name: Release
+    permissions:
+      contents: write
+      packages: write
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -49,5 +52,5 @@ jobs:
 
       - name: Release
         env:
-          GITHUB_TOKEN: ${{ secrets.REPOSITORY_PUSH_ACCESS }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: npm exec semantic-release

.releaserc

@@ -23,7 +23,8 @@
         "assets": [
           "CHANGELOG.md",
           "gradle.properties"
-        ]
+        ],
+        "message": "chore: Release v${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
       }
     ],
     [

CHANGELOG.md

@@ -1,3 +1,90 @@
+# [3.2.0-dev.1](https://github.com/ReVanced/revanced-library/compare/v3.1.1-dev.1...v3.2.0-dev.1) (2025-05-27)
+
+
+### Features
+
+* Request the update ownership enforcement ([#71](https://github.com/ReVanced/revanced-library/issues/71)) ([be0f6bf](https://github.com/ReVanced/revanced-library/commit/be0f6bf247461d16fbf649a9f2dc6facbb5b0c93))
+
+## [3.1.1-dev.1](https://github.com/ReVanced/revanced-library/compare/v3.1.0...v3.1.1-dev.1) (2025-05-02)
+
+
+### Bug Fixes
+
+* Interpret package name as a string instead of Regex when using grep  ([#68](https://github.com/ReVanced/revanced-library/issues/68)) ([254f36d](https://github.com/ReVanced/revanced-library/commit/254f36d03cc8fd3e2508a5e8f69bb5c8e1eb9775))
+
+# [3.1.0](https://github.com/ReVanced/revanced-library/compare/v3.0.2...v3.1.0) (2024-11-27)
+
+
+### Bug Fixes
+
+* Detect if app is installed by fixing inversion ([649f06b](https://github.com/ReVanced/revanced-library/commit/649f06b19dd4d2a3f3216a0b3ea947b9fe0d475f))
+
+
+### Features
+
+* Warn when option could not be set because the option does not exist ([7ec6504](https://github.com/ReVanced/revanced-library/commit/7ec650461935faf2a8fbb667db3cf137157b70b5))
+
+# [3.1.0-dev.1](https://github.com/ReVanced/revanced-library/compare/v3.0.3-dev.1...v3.1.0-dev.1) (2024-11-25)
+
+
+### Features
+
+* Warn when option could not be set because the option does not exist ([7ec6504](https://github.com/ReVanced/revanced-library/commit/7ec650461935faf2a8fbb667db3cf137157b70b5))
+
+## [3.0.3-dev.1](https://github.com/ReVanced/revanced-library/compare/v3.0.2...v3.0.3-dev.1) (2024-11-11)
+
+
+### Bug Fixes
+
+* Detect if app is installed by fixing inversion ([649f06b](https://github.com/ReVanced/revanced-library/commit/649f06b19dd4d2a3f3216a0b3ea947b9fe0d475f))
+
+## [3.0.2](https://github.com/ReVanced/revanced-library/compare/v3.0.1...v3.0.2) (2024-11-05)
+
+## [3.0.2-dev.1](https://github.com/ReVanced/revanced-library/compare/v3.0.1...v3.0.2-dev.1) (2024-11-05)
+
+## [3.0.1](https://github.com/ReVanced/revanced-library/compare/v3.0.0...v3.0.1) (2024-10-13)
+
+
+### Bug Fixes
+
+* Serialize compatible packages as a map instead of a set of pairs. ([737e272](https://github.com/ReVanced/revanced-library/commit/737e272481fe3b0b4c89233d139b5e657a0c1de4))
+
+## [3.0.1-dev.3](https://github.com/ReVanced/revanced-library/compare/v3.0.1-dev.2...v3.0.1-dev.3) (2024-10-06)
+
+## [3.0.1-dev.2](https://github.com/ReVanced/revanced-library/compare/v3.0.1-dev.1...v3.0.1-dev.2) (2024-10-01)
+
+## [3.0.1-dev.1](https://github.com/ReVanced/revanced-library/compare/v3.0.0...v3.0.1-dev.1) (2024-08-16)
+
+
+### Bug Fixes
+
+* Serialize compatible packages as a map instead of a set of pairs. ([737e272](https://github.com/ReVanced/revanced-library/commit/737e272481fe3b0b4c89233d139b5e657a0c1de4))
+
+# [3.0.0](https://github.com/ReVanced/revanced-library/compare/v2.3.0...v3.0.0) (2024-08-06)
+
+
+### Bug Fixes
+
+* Make functions internal which are supposed to be internal ([893d22d](https://github.com/ReVanced/revanced-library/commit/893d22d7938fa1c7544795635ed2ffacdd0cbf0d))
+
+
+### Build System
+
+* Refactor to DSL to bump ReVanced Patcher ([7f5d6da](https://github.com/ReVanced/revanced-library/commit/7f5d6dad7ba73e2ee53010241ba3204d04860a22))
+
+
+### Features
+
+* Add local Android installer ([#25](https://github.com/ReVanced/revanced-library/issues/25)) ([43d655a](https://github.com/ReVanced/revanced-library/commit/43d655aea5d86288ae9916630e0f30de219d5cfb))
+* Remove deprecated functions ([b9bf3bc](https://github.com/ReVanced/revanced-library/commit/b9bf3bc88284c0381c7370c3606b662da2ef380d))
+
+
+### BREAKING CHANGES
+
+* Some functions have been removed.
+* Some functions are not available anymore.
+* The signature of some functions has changed.
+
 # [3.0.0-dev.1](https://github.com/ReVanced/revanced-library/compare/v2.4.0-dev.1...v3.0.0-dev.1) (2024-08-06)
 
 

README.md

@@ -109,9 +109,9 @@ You can find the contribution guidelines [here](CONTRIBUTING.md).
 To build ReVanced Library,
 you can follow the [ReVanced documentation](https://github.com/ReVanced/revanced-documentation).
 
-## 📜 Licence
+## 📜 License
 
-ReVanced Library is licensed under the GPLv3 license. Please see the [licence file](LICENSE) for more information.
+ReVanced Library is licensed under the GPLv3 license. Please see the [license file](LICENSE) for more information.
 [tl;dr](https://www.tldrlegal.com/license/gnu-general-public-license-v3-gpl-3) you may copy, distribute and modify ReVanced Library as long as you track changes/dates in source files.
 Any modifications to ReVanced Library must also be made available under the GPL,
 along with build & install instructions.

build.gradle.kts

@@ -54,7 +54,7 @@ kotlin {
         commonMain.dependencies {
             implementation(libs.apksig)
             implementation(libs.apkzlib)
-            implementation(libs.bcpkix.jdk15on)
+            implementation(libs.bcpkix.jdk18on)
             implementation(libs.guava)
             implementation(libs.jadb)
             implementation(libs.kotlin.reflect)

gradle.properties

@@ -1,4 +1,4 @@
-version = 3.0.0-dev.1
+version = 3.2.0-dev.1
 #Gradle
 org.gradle.jvmargs = -Xmx2048M -Dfile.encoding=UTF-8 -Dkotlin.daemon.jvm.options="-Xmx2048M"
 org.gradle.caching = true

gradle/libs.versions.toml

@@ -1,20 +1,20 @@
 [versions]
-android = "8.5.1"
+android = "8.5.2"
-bcpkix-jdk15on = "1.70"
+bcpkix-jdk18on = "1.77"
 binary-compatibility-validator = "0.15.1"
-core-ktx = "1.13.1"
+core-ktx = "1.15.0"
-guava = "33.0.0-jre"
+guava = "33.2.1-jre"
-jadb = "1.2.1"
+jadb = "1.2.1.1"
-kotlin = "2.0.0"
+kotlin = "2.0.20"
 kotlinx-coroutines = "1.8.1"
 kotlinx-serialization = "1.7.1"
 libsu = "5.2.2"
-revanced-patcher = "20.0.0"
+revanced-patcher = "21.0.0"
 
 [libraries]
 apkzlib = { module = "com.android.tools.build:apkzlib", version.ref = "android" }
 apksig = { module = "com.android.tools.build:apksig", version.ref = "android" }
-bcpkix-jdk15on = { module = "org.bouncycastle:bcpkix-jdk15on", version.ref = "bcpkix-jdk15on" }
+bcpkix-jdk18on = { module = "org.bouncycastle:bcpkix-jdk18on", version.ref = "bcpkix-jdk18on" }
 core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "core-ktx" }
 guava = { module = "com.google.guava:guava", version.ref = "guava" }
 jadb = { module = "app.revanced:jadb", version.ref = "jadb" } # Fork with Shell v2 support.

package.json

@@ -3,7 +3,7 @@
     "@saithodev/semantic-release-backmerge": "^4.0.1",
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
-    "gradle-semantic-release-plugin": "^1.9.1",
+    "gradle-semantic-release-plugin": "^1.10.1",
-    "semantic-release": "^23.0.2"
+    "semantic-release": "^24.1.2"
   }
 }

src/androidMain/kotlin/app/revanced/library/installation/installer/LocalInstaller.kt

@@ -8,6 +8,7 @@ import android.content.Intent
 import android.content.IntentFilter
 import android.content.pm.PackageInstaller
 import android.content.pm.PackageManager
+import android.os.Build
 import androidx.core.content.ContextCompat
 import app.revanced.library.installation.installer.Installer.Apk
 import java.io.Closeable
@@ -85,10 +86,13 @@ class LocalInstaller(
 
     override fun close() = context.unregisterReceiver(broadcastReceiver)
 
+    @SuppressLint("MissingPermission")
     companion object {
         private val sessionParams = PackageInstaller.SessionParams(
             PackageInstaller.SessionParams.MODE_FULL_INSTALL,
         ).apply {
+            if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.UPSIDE_DOWN_CAKE)
+                setRequestUpdateOwnership(true)
             setInstallReason(PackageManager.INSTALL_REASON_USER)
         }
 

src/commonMain/kotlin/app/revanced/library/ApkUtils.kt

@@ -82,7 +82,7 @@ object ApkUtils {
                 // Delete resources that were staged for deletion.
                 if (resources.deleteResources.isNotEmpty()) {
                     targetApkZFile.entries().filter { entry ->
-                        resources.deleteResources.any { shouldDelete -> shouldDelete(entry.centralDirectoryHeader.name) }
+                        entry.centralDirectoryHeader.name in resources.deleteResources
                     }.forEach(StoredEntry::delete)
                 }
             }

src/commonMain/kotlin/app/revanced/library/Options.kt

@@ -19,11 +19,16 @@ private val logger = Logger.getLogger("Options")
  * @param options The options to set. The key is the patch name and the value is a map of option keys to option values.
  */
 fun Set<Patch<*>>.setOptions(options: PatchesOptions) = filter { it.name != null }.forEach { patch ->
-    val patchOptions = options[patch.name] ?: return@forEach
+    options[patch.name]?.forEach setOption@{ (optionKey, optionValue) ->
+        if (optionKey !in patch.options) {
+            return@setOption logger.warning(
+                "Could not set option for the \"${patch.name}\" patch because " +
+                    "option with key \"${optionKey}\" does not exist",
+            )
+        }
 
-    patch.options.forEach option@{ option ->
         try {
-            patch.options[option.key] = patchOptions[option.key] ?: return@option
+            patch.options[optionKey] = optionValue
         } catch (e: OptionException) {
             logger.warning("Could not set option value for the \"${patch.name}\" patch: ${e.message}")
         }

src/commonMain/kotlin/app/revanced/library/Serialization.kt

@@ -1,14 +1,19 @@
 package app.revanced.library
 
-import app.revanced.patcher.patch.*
+import app.revanced.patcher.patch.Option
-import kotlinx.serialization.*
+import app.revanced.patcher.patch.Patch
+import app.revanced.patcher.patch.VersionName
+import kotlinx.serialization.ExperimentalSerializationApi
+import kotlinx.serialization.KSerializer
 import kotlinx.serialization.builtins.*
 import kotlinx.serialization.descriptors.buildClassSerialDescriptor
 import kotlinx.serialization.descriptors.element
 import kotlinx.serialization.encoding.Decoder
 import kotlinx.serialization.encoding.Encoder
 import kotlinx.serialization.encoding.encodeStructure
-import kotlinx.serialization.json.*
+import kotlinx.serialization.json.Json
+import kotlinx.serialization.json.encodeToStream
+import kotlinx.serialization.serializer
 import java.io.OutputStream
 
 private class PatchSerializer : KSerializer<Patch<*>> {
@@ -17,7 +22,7 @@ private class PatchSerializer : KSerializer<Patch<*>> {
         element<String?>("description")
         element<Boolean>("use")
         element<List<String>>("dependencies")
-        element<Set<Package>?>("compatiblePackages")
+        element<Map<PackageName, Set<VersionName>?>?>("compatiblePackages")
         element("options", OptionSerializer.descriptor)
     }
 
@@ -52,8 +57,8 @@ private class PatchSerializer : KSerializer<Patch<*>> {
             encodeNullableSerializableElement(
                 descriptor,
                 4,
-                SetSerializer(PairSerializer(String.serializer(), SetSerializer(String.serializer()).nullable)),
+                MapSerializer(String.serializer(), SetSerializer(String.serializer()).nullable),
-                value.compatiblePackages,
+                value.compatiblePackages?.associate { (packageName, versions) -> packageName to versions },
             )
             encodeSerializableElement(
                 descriptor,

src/commonMain/kotlin/app/revanced/library/installation/installer/AdbInstaller.kt

@@ -1,11 +1,13 @@
 package app.revanced.library.installation.installer
 
 import app.revanced.library.installation.command.AdbShellCommandRunner
+import app.revanced.library.installation.command.ShellCommandRunner
+import app.revanced.library.installation.installer.Constants.GET_SDK_VERSION
 import app.revanced.library.installation.installer.Constants.INSTALLED_APK_PATH
-import app.revanced.library.installation.installer.Installer.Apk
 import se.vidstige.jadb.JadbException
 import se.vidstige.jadb.managers.Package
 import se.vidstige.jadb.managers.PackageManager
+import se.vidstige.jadb.managers.PackageManager.UPDATE_OWNERSHIP
 
 /**
  * [AdbInstaller] for installing and uninstalling [Apk] files using ADB.
@@ -17,18 +19,23 @@ import se.vidstige.jadb.managers.PackageManager
 class AdbInstaller(
     deviceSerial: String? = null,
 ) : Installer<AdbInstallerResult, Installation>() {
-    private val device = getDevice(deviceSerial, logger)
+    private val shellCommandRunner: ShellCommandRunner
-    private val adbShellCommandRunner = AdbShellCommandRunner(device)
+    private val packageManager: PackageManager
-    private val packageManager = PackageManager(device)
 
     init {
+        val device = getDevice(deviceSerial, logger)
+        shellCommandRunner = AdbShellCommandRunner(device)
+        packageManager = PackageManager(device)
+
         logger.fine("Connected to $deviceSerial")
     }
 
     override suspend fun install(apk: Apk): AdbInstallerResult {
-        logger.info("Installing ${apk.file.name}")
+        return runPackageManager {
-
+            val sdkVersion = shellCommandRunner(GET_SDK_VERSION).output.toInt()
-        return runPackageManager { install(apk.file) }
+            if (sdkVersion < 34) install(apk.file)
+            else installWithOptions(apk.file, listOf(UPDATE_OWNERSHIP))
+        }
     }
 
     override suspend fun uninstall(packageName: String): AdbInstallerResult {
@@ -39,7 +46,7 @@ class AdbInstaller(
 
     override suspend fun getInstallation(packageName: String): Installation? = packageManager.packages.find {
         it.toString() == packageName
-    }?.let { Installation(adbShellCommandRunner(INSTALLED_APK_PATH).output) }
+    }?.let { Installation(shellCommandRunner(INSTALLED_APK_PATH).output) }
 
     private fun runPackageManager(block: PackageManager.() -> Unit) = try {
         packageManager.run(block)

src/commonMain/kotlin/app/revanced/library/installation/installer/Constants.kt

@@ -4,26 +4,28 @@ package app.revanced.library.installation.installer
 internal object Constants {
     const val PLACEHOLDER = "PLACEHOLDER"
 
+    const val SELINUX_CONTEXT = "u:object_r:apk_data_file:s0"
     const val TMP_FILE_PATH = "/data/local/tmp/revanced.tmp"
     const val MOUNT_PATH = "/data/adb/revanced/"
     const val MOUNTED_APK_PATH = "$MOUNT_PATH$PLACEHOLDER.apk"
     const val MOUNT_SCRIPT_PATH = "/data/adb/service.d/mount_revanced_$PLACEHOLDER.sh"
 
     const val EXISTS = "[[ -f $PLACEHOLDER ]] || exit 1"
-    const val MOUNT_GREP = "grep $PLACEHOLDER /proc/mounts"
+    const val MOUNT_GREP = "grep -F $PLACEHOLDER /proc/mounts"
     const val DELETE = "rm -rf $PLACEHOLDER"
     const val CREATE_DIR = "mkdir -p"
     const val RESTART = "am start -S $PLACEHOLDER"
     const val KILL = "am force-stop $PLACEHOLDER"
     const val INSTALLED_APK_PATH = "pm path $PLACEHOLDER"
     const val CREATE_INSTALLATION_PATH = "$CREATE_DIR $MOUNT_PATH"
+    const val GET_SDK_VERSION = "getprop ro.build.version.sdk"
     
     const val MOUNT_APK =
         "base_path=\"$MOUNTED_APK_PATH\" && " +
             "mv $TMP_FILE_PATH \$base_path && " +
             "chmod 644 \$base_path && " +
             "chown system:system \$base_path && " +
-            "chcon u:object_r:apk_data_file:s0  \$base_path"
+            "chcon $SELINUX_CONTEXT  \$base_path"
 
     const val UMOUNT =
         "grep $PLACEHOLDER /proc/mounts | " +
@@ -52,7 +54,7 @@ internal object Constants {
 
         base_path="$MOUNTED_APK_PATH"
 
-        chcon u:object_r:apk_data_file:s0 ${'$'}base_path
+        chcon $SELINUX_CONTEXT ${'$'}base_path
 
         # Use Magisk mirror, if possible.
         if command -v magisk &> /dev/null; then

src/commonMain/kotlin/app/revanced/library/installation/installer/RootInstaller.kt

@@ -122,13 +122,12 @@ abstract class RootInstaller internal constructor(
      * @throws FailedToFindInstalledPackageException If the package is not installed.
      */
     private fun String.assertInstalled() {
-        if (INSTALLED_APK_PATH(this)().output.isNotEmpty()) {
+        if (INSTALLED_APK_PATH(this)().output.isEmpty()) {
             throw FailedToFindInstalledPackageException(this)
         }
     }
 
-    internal class FailedToFindInstalledPackageException internal constructor(packageName: String) :
+    internal class FailedToFindInstalledPackageException internal constructor(packageName: String) : Exception("Failed to find installed package \"$packageName\" because no activity was found")
-        Exception("Failed to find installed package \"$packageName\" because no activity was found")
 
     internal class PackageNameRequiredException internal constructor() : Exception("Package name is required")
     internal class NoRootPermissionException internal constructor() : Exception("No root permission")

src/commonTest/kotlin/app/revanced/library/SerializationTest.kt

@@ -1,6 +1,9 @@
 package app.revanced.library
 
-import app.revanced.patcher.patch.*
+import app.revanced.patcher.patch.booleanOption
+import app.revanced.patcher.patch.bytecodePatch
+import app.revanced.patcher.patch.floatsOption
+import app.revanced.patcher.patch.stringOption
 import kotlinx.serialization.json.*
 import java.io.ByteArrayOutputStream
 import kotlin.test.Test
@@ -33,7 +36,7 @@ class SerializationTest {
 
         assert(deserializedPatch["name"]!!.jsonPrimitive.content == "Test patch")
 
-        assert(deserializedPatch["compatiblePackages"]!!.jsonArray.size == 2) {
+        assert(deserializedPatch["compatiblePackages"]!!.jsonObject.size == 2) {
             "The patch should be compatible with two packages."
         }