chore(release): 1.5.0-dev.1 [skip ci]

# [1.5.0-dev.1](https://github.com/ReVanced/revanced-library/compare/v1.4.0...v1.5.0-dev.1) (2023-12-07)

### Features

* Add JSON de- and serialization of patches ([ecff6fe](ecff6fe0d3))

CHANGELOG.md

@@ -1,3 +1,24 @@
+# [1.5.0-dev.1](https://github.com/ReVanced/revanced-library/compare/v1.4.0...v1.5.0-dev.1) (2023-12-07)
+
+
+### Features
+
+* Add JSON de- and serialization of patches ([ecff6fe](https://github.com/ReVanced/revanced-library/commit/ecff6fe0d3889d729a0badcfa28b89610bd27d48))
+
+# [1.4.0](https://github.com/ReVanced/revanced-library/compare/v1.3.0...v1.4.0) (2023-11-27)
+
+
+### Bug Fixes
+
+* Differentiate no package compatibility to any version compatibility ([762b7e3](https://github.com/ReVanced/revanced-library/commit/762b7e3bc01e2ca33dfcdbb1b5028d60ef6e0a48))
+* Sort the version maps by the most common version ([e4be6db](https://github.com/ReVanced/revanced-library/commit/e4be6dbccd86700ffafe7cd8395e845bbd3d5138))
+
+
+### Features
+
+* Add `PatchUtils#getMostCommonCompatibleVersions` utility function ([c5f3536](https://github.com/ReVanced/revanced-library/commit/c5f3536cbb6997766076595dc0b2b5d2e861ca73))
+* Allow getting most common compatible versions for all packages ([96845ba](https://github.com/ReVanced/revanced-library/commit/96845ba265e6dc208c7ac96f5e58734209cd1720))
+
 # [1.4.0-dev.2](https://github.com/ReVanced/revanced-library/compare/v1.4.0-dev.1...v1.4.0-dev.2) (2023-11-27)
 
 

api/revanced-library.api

@@ -67,6 +67,47 @@ public final class app/revanced/library/PatchUtils {
 	public static synthetic fun getMostCommonCompatibleVersions$default (Lapp/revanced/library/PatchUtils;Ljava/util/Set;Ljava/util/Set;ZILjava/lang/Object;)Ljava/util/Map;
 }
 
+public final class app/revanced/library/PatchUtils$Json {
+	public static final field INSTANCE Lapp/revanced/library/PatchUtils$Json;
+	public final fun deserialize (Ljava/io/InputStream;Ljava/lang/Class;)Ljava/util/Set;
+	public final fun serialize (Ljava/util/Set;Lkotlin/jvm/functions/Function1;ZLjava/io/OutputStream;)V
+	public static synthetic fun serialize$default (Lapp/revanced/library/PatchUtils$Json;Ljava/util/Set;Lkotlin/jvm/functions/Function1;ZLjava/io/OutputStream;ILjava/lang/Object;)V
+}
+
+public final class app/revanced/library/PatchUtils$Json$FullJsonPatch : app/revanced/library/PatchUtils$Json$JsonPatch {
+	public static final field Companion Lapp/revanced/library/PatchUtils$Json$FullJsonPatch$Companion;
+	public final fun getCompatiblePackages ()Ljava/util/Set;
+	public final fun getDependencies ()Ljava/util/Set;
+	public final fun getDescription ()Ljava/lang/String;
+	public final fun getName ()Ljava/lang/String;
+	public final fun getOptions ()Ljava/util/Map;
+	public final fun getRequiresIntegrations ()Z
+	public final fun getUse ()Z
+	public final fun setRequiresIntegrations (Z)V
+}
+
+public final class app/revanced/library/PatchUtils$Json$FullJsonPatch$Companion {
+	public final fun fromPatch (Lapp/revanced/patcher/patch/Patch;)Lapp/revanced/library/PatchUtils$Json$FullJsonPatch;
+}
+
+public final class app/revanced/library/PatchUtils$Json$FullJsonPatch$FullJsonPatchOption {
+	public static final field Companion Lapp/revanced/library/PatchUtils$Json$FullJsonPatch$FullJsonPatchOption$Companion;
+	public final fun getDefault ()Ljava/lang/Object;
+	public final fun getDescription ()Ljava/lang/String;
+	public final fun getKey ()Ljava/lang/String;
+	public final fun getRequired ()Z
+	public final fun getTitle ()Ljava/lang/String;
+	public final fun getValueType ()Ljava/lang/String;
+	public final fun getValues ()Ljava/util/Map;
+}
+
+public final class app/revanced/library/PatchUtils$Json$FullJsonPatch$FullJsonPatchOption$Companion {
+	public final fun fromPatchOption (Lapp/revanced/patcher/patch/options/PatchOption;)Lapp/revanced/library/PatchUtils$Json$FullJsonPatch$FullJsonPatchOption;
+}
+
+public abstract interface class app/revanced/library/PatchUtils$Json$JsonPatch {
+}
+
 public abstract class app/revanced/library/adb/AdbManager {
 	public static final field Companion Lapp/revanced/library/adb/AdbManager$Companion;
 	public synthetic fun <init> (Ljava/lang/String;Lkotlin/jvm/internal/DefaultConstructorMarker;)V

gradle.properties

@@ -1,4 +1,4 @@
 org.gradle.parallel = true
 org.gradle.caching = true
 kotlin.code.style = official
-version = 1.4.0-dev.2
+version = 1.5.0-dev.1

gradle/libs.versions.toml

@@ -3,9 +3,9 @@ apksig = "8.1.4"
 bcpkix-jdk18on = "1.76"
 jackson-module-kotlin = "2.14.3"
 jadb = "1.2.1"
-kotlin-reflect = "1.9.10"
+kotlin-reflect = "1.9.20"
 kotlin-test = "1.9.20"
-revanced-patcher = "19.0.0"
+revanced-patcher = "19.1.0"
 binary-compatibility-validator = "0.13.2"
 
 [libraries]

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

@@ -3,24 +3,22 @@
 package app.revanced.library
 
 import app.revanced.library.Options.Patch.Option
-import app.revanced.patcher.PatchClass
 import app.revanced.patcher.PatchSet
 import app.revanced.patcher.patch.options.PatchOptionException
 import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
 import java.io.File
 import java.util.logging.Logger
 
-private typealias PatchList = List<PatchClass>
+@Suppress("unused")
-
 object Options {
     private val logger = Logger.getLogger(Options::class.java.name)
 
-    private var mapper = jacksonObjectMapper()
+    private val mapper = jacksonObjectMapper()
 
     /**
-     * Serializes the options for the patches in the list.
+     * Serializes the options for a set of patches.
      *
-     * @param patches The list of patches to serialize.
+     * @param patches The set of patches to serialize.
      * @param prettyPrint Whether to pretty print the JSON.
      * @return The JSON string containing the options.
      */
@@ -57,17 +55,16 @@ object Options {
             }
 
     /**
-     * Deserializes the options for the patches in the list.
+     * Deserializes the options to a set of patches.
      *
      * @param json The JSON string containing the options.
-     * @return The list of [Patch]s.
+     * @return A set of [Patch]s.
      * @see Patch
-     * @see PatchList
      */
     fun deserialize(json: String): Array<Patch> = mapper.readValue(json, Array<Patch>::class.java)
 
     /**
-     * Sets the options for the patches in the list.
+     * Sets the options for a set of patches.
      *
      * @param json The JSON string containing the options.
      */
@@ -95,7 +92,7 @@ object Options {
     }
 
     /**
-     * Sets the options for the patches in the list.
+     * Sets the options for a set of patches.
      *
      * @param file The file containing the JSON string containing the options.
      * @see setOptions

src/main/kotlin/app/revanced/library/PatchUtils.kt

@@ -1,7 +1,12 @@
 package app.revanced.library
 
+import app.revanced.patcher.PatchClass
 import app.revanced.patcher.PatchSet
 import app.revanced.patcher.patch.Patch
+import app.revanced.patcher.patch.options.PatchOption
+import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
+import java.io.InputStream
+import java.io.OutputStream
 
 typealias PackageName = String
 typealias Version = String
@@ -90,4 +95,104 @@ object PatchUtils {
                         .associate { it.key to it.value } as VersionMap
             }
         }
+
+    object Json {
+        private val mapper = jacksonObjectMapper()
+
+        /**
+         * Serializes a set of [Patch]es to a JSON string and writes it to an output stream.
+         *
+         * @param patches The set of [Patch]es to serialize.
+         * @param transform A function to transform the [Patch]es to [JsonPatch]es.
+         * @param prettyPrint Whether to pretty print the JSON.
+         * @param outputStream The output stream to write the JSON to.
+         */
+        fun serialize(
+            patches: PatchSet,
+            transform: (Patch<*>) -> JsonPatch = { patch -> FullJsonPatch.fromPatch(patch) },
+            prettyPrint: Boolean = false,
+            outputStream: OutputStream,
+        ) {
+            patches.map(transform).let { transformed ->
+                if (prettyPrint) {
+                    mapper.writerWithDefaultPrettyPrinter().writeValue(outputStream, transformed)
+                } else {
+                    mapper.writeValue(outputStream, transformed)
+                }
+            }
+        }
+
+        /**
+         * Deserializes a JSON string to a set of [FullJsonPatch]es from an input stream.
+         *
+         * @param inputStream The input stream to read the JSON from.
+         * @param jsonPatchElementClass The class of the [JsonPatch]es to deserialize.
+         * @return A set of [JsonPatch]es.
+         * @see FullJsonPatch
+         */
+        fun <T : JsonPatch> deserialize(
+            inputStream: InputStream,
+            jsonPatchElementClass: Class<T>,
+        ): Set<T> =
+            mapper.readValue(
+                inputStream,
+                mapper.typeFactory.constructCollectionType(Set::class.java, jsonPatchElementClass),
+            )
+
+        interface JsonPatch
+
+        /**
+         * A JSON representation of a [Patch].
+         * @see Patch
+         */
+        class FullJsonPatch internal constructor(
+            val name: String?,
+            val description: String?,
+            val compatiblePackages: Set<Patch.CompatiblePackage>?,
+            val dependencies: Set<PatchClass>?,
+            val use: Boolean,
+            var requiresIntegrations: Boolean,
+            val options: Map<String, FullJsonPatchOption<*>>,
+        ) : JsonPatch {
+            companion object {
+                fun fromPatch(patch: Patch<*>) =
+                    FullJsonPatch(
+                        patch.name,
+                        patch.description,
+                        patch.compatiblePackages,
+                        patch.dependencies,
+                        patch.use,
+                        patch.requiresIntegrations,
+                        patch.options.mapValues { FullJsonPatchOption.fromPatchOption(it.value) },
+                    )
+            }
+
+            /**
+             * A JSON representation of a [PatchOption].
+             * @see PatchOption
+             */
+            class FullJsonPatchOption<T> internal constructor(
+                val key: String,
+                val default: T?,
+                val values: Map<String, T?>?,
+                val title: String?,
+                val description: String?,
+                val required: Boolean,
+                val valueType: String,
+            ) {
+                companion object {
+                    fun fromPatchOption(option: PatchOption<*>) =
+                        FullJsonPatchOption(
+                            option.key,
+                            option.default,
+                            option.values,
+                            option.title,
+                            option.description,
+                            option.required,
+                            option.valueType,
+                        )
+                }
+            }
+        }
+    }
 }

src/test/kotlin/app/revanced/library/PatchUtilsTest.kt

@@ -4,19 +4,24 @@ import app.revanced.patcher.PatchSet
 import app.revanced.patcher.data.BytecodeContext
 import app.revanced.patcher.patch.BytecodePatch
 import app.revanced.patcher.patch.Patch
+import app.revanced.patcher.patch.options.PatchOption.PatchExtensions.booleanPatchOption
+import app.revanced.patcher.patch.options.PatchOption.PatchExtensions.intArrayPatchOption
+import app.revanced.patcher.patch.options.PatchOption.PatchExtensions.stringPatchOption
 import org.junit.jupiter.api.Test
+import java.io.ByteArrayInputStream
+import java.io.ByteArrayOutputStream
 import kotlin.test.assertEquals
 
 internal object PatchUtilsTest {
     private val patches =
         arrayOf(
-            newPatch("some.package", setOf("a")),
+            newPatch("some.package", setOf("a")) { stringPatchOption("string", "value") },
             newPatch("some.package", setOf("a", "b"), use = false),
             newPatch("some.package", setOf("a", "b", "c"), use = false),
             newPatch("some.other.package", setOf("b"), use = false),
-            newPatch("some.other.package", setOf("b", "c")),
+            newPatch("some.other.package", setOf("b", "c")) { booleanPatchOption("bool", true) },
             newPatch("some.other.package", setOf("b", "c", "d")),
-            newPatch("some.other.other.package"),
+            newPatch("some.other.other.package") { intArrayPatchOption("intArray", arrayOf(1, 2, 3)) },
             newPatch("some.other.other.package", setOf("a")),
             newPatch("some.other.other.package", setOf("b")),
             newPatch("some.other.other.other.package", use = false),
@@ -136,6 +141,20 @@ internal object PatchUtilsTest {
         assertEqualsVersion(null, patches, "other.package")
     }
 
+    @Test
+    fun `serializes to and deserializes from JSON string correctly`() {
+        val out = ByteArrayOutputStream()
+        PatchUtils.Json.serialize(patches, outputStream = out)
+
+        val deserialized =
+            PatchUtils.Json.deserialize(
+                ByteArrayInputStream(out.toByteArray()),
+                PatchUtils.Json.FullJsonPatch::class.java,
+            )
+
+        assert(patches.size == deserialized.size)
+    }
+
     private fun assertEqualsVersions(
         expected: PackageNameMap,
         patches: PatchSet,
@@ -170,19 +189,14 @@ internal object PatchUtilsTest {
         packageName: String,
         versions: Set<String>? = null,
         use: Boolean = true,
-    ) = object : BytecodePatch() {
+        options: Patch<*>.() -> Unit = {},
+    ) = object : BytecodePatch(
+        name = "test",
+        compatiblePackages = setOf(CompatiblePackage(packageName, versions?.toSet())),
+        use = use,
+    ) {
         init {
-            // Set the compatible packages field to the supplied package name and versions reflectively,
+            options()
-            // because the setter is private but needed for testing.
-            val compatiblePackagesField = Patch::class.java.getDeclaredField("compatiblePackages")
-
-            compatiblePackagesField.isAccessible = true
-            compatiblePackagesField.set(this, setOf(CompatiblePackage(packageName, versions?.toSet())))
-
-            val useField = Patch::class.java.getDeclaredField("use")
-
-            useField.isAccessible = true
-            useField.set(this, use)
         }
 
         override fun execute(context: BytecodeContext) {}