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

# [20.0.0-dev.1](https://github.com/ReVanced/revanced-patcher/compare/v19.3.1...v20.0.0-dev.1) (2024-07-22)

### Features

* Convert APIs to Kotlin DSL ([#298](https://github.com/ReVanced/revanced-patcher/issues/298)) ([3f9cbd2](3f9cbd2408))

### BREAKING CHANGES

* Various old APIs are removed, and DSL APIs are added instead.

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -11,18 +11,18 @@ body:
             <source
               width="256px"
               media="(prefers-color-scheme: dark)"
-              srcset="../../assets/revanced-headline/revanced-headline-vertical-dark.svg"
+              srcset="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-headline/revanced-headline-vertical-dark.svg"
             >
             <img 
               width="256px"
-              src="../../assets/revanced-headline/revanced-headline-vertical-light.svg"
+              src="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-headline/revanced-headline-vertical-light.svg"
             >
           </picture>
           <br>
           <a href="https://revanced.app/">
              <picture>
-                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="../../assets/revanced-logo/revanced-logo.svg" />
-                 <img height="24px" src="../../assets/revanced-logo/revanced-logo.svg" />
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-logo/revanced-logo.svg" />
+                 <img height="24px" src="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-logo/revanced-logo.svg" />
              </picture>
            </a>&nbsp;&nbsp;&nbsp;
            <a href="https://github.com/ReVanced">
@@ -70,7 +70,8 @@ body:
 
         Before creating a new bug report, please keep the following in mind:
 
-        - **Do not submit a duplicate bug report**: You can review existing bug reports [here](https://github.com/ReVanced/revanced-patcher/labels/Bug%20report).
+        - **Do not submit a duplicate bug report**: Search for existing bug reports [here](https://github.com/ReVanced/revanced-patcher/issues?q=label%3A%22Bug+report%22).
+        - **Review the contribution guidelines**: Make sure your bug report adheres to it. You can find the guidelines [here](https://github.com/ReVanced/revanced-patcher/blob/main/CONTRIBUTING.md).
         - **Do not use the issue page for support**: If you need help or have questions, check out other platforms on [revanced.app](https://revanced.app).
   - type: textarea
     attributes:
@@ -100,7 +101,7 @@ body:
       label: Acknowledgements
       description: Your bug report will be closed if you don't follow the checklist below.
       options:
-        - label: This issue is not a duplicate of an existing bug report.
+        - label: I have checked all open and closed bug reports and this is not a duplicate.
           required: true
         - label: I have chosen an appropriate title.
           required: true

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -11,18 +11,18 @@ body:
             <source
               width="256px"
               media="(prefers-color-scheme: dark)"
-              srcset="../../assets/revanced-headline/revanced-headline-vertical-dark.svg"
+              srcset="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-headline/revanced-headline-vertical-dark.svg"
             >
             <img 
               width="256px"
-              src="../../assets/revanced-headline/revanced-headline-vertical-light.svg"
+              src="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-headline/revanced-headline-vertical-light.svg"
             >
           </picture>
           <br>
           <a href="https://revanced.app/">
              <picture>
-                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="../../assets/revanced-logo/revanced-logo.svg" />
-                 <img height="24px" src="../../assets/revanced-logo/revanced-logo.svg" />
+                 <source height="24px" media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-logo/revanced-logo.svg" />
+                 <img height="24px" src="https://raw.githubusercontent.com/revanced/revanced-patcher/main/assets/revanced-logo/revanced-logo.svg" />
              </picture>
            </a>&nbsp;&nbsp;&nbsp;
            <a href="https://github.com/ReVanced">
@@ -70,7 +70,8 @@ body:
 
         Before creating a new feature request, please keep the following in mind:
 
-        - **Do not submit a duplicate feature request**: You can review existing feature requests [here](https://github.com/ReVanced/revanced-patcher/labels/Feature%20request).
+        - **Do not submit a duplicate feature request**: Search for existing feature requests [here](https://github.com/ReVanced/revanced-patcher/issues?q=label%3A%22Feature+request%22).
+        - **Review the contribution guidelines**: Make sure your feature request adheres to it. You can find the guidelines [here](https://github.com/ReVanced/revanced-patcher/blob/main/CONTRIBUTING.md).
         - **Do not use the issue page for support**: If you need help or have questions, check out other platforms on [revanced.app](https://revanced.app).
 
   - type: textarea
@@ -98,7 +99,7 @@ body:
       label: Acknowledgements
       description: Your feature request will be closed if you don't follow the checklist below.
       options:
-        - label: This issue is not a duplicate of an existing feature request.
+        - label: I have checked all open and closed feature requests and this is not a duplicate.
           required: true
         - label: I have chosen an appropriate title.
           required: true

.github/workflows/release.yml

@@ -42,7 +42,7 @@ jobs:
         with:
           gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
           passphrase: ${{ secrets.GPG_PASSPHRASE }}
-          fingerprint: ${{ env.GPG_FINGERPRINT }}
+          fingerprint: ${{ vars.GPG_FINGERPRINT }}
 
       - name: Release
         env:

.github/workflows/update_documentation.yml

@@ -11,7 +11,7 @@ jobs:
     name: Dispatch event to documentation repository
     if: github.ref == 'refs/heads/main'
     steps:
-      - uses: peter-evans/repository-dispatch@v2
+      - uses: peter-evans/repository-dispatch@v3
         with:
           token: ${{ secrets.DOCUMENTATION_REPO_ACCESS_TOKEN  }}
           repository: revanced/revanced-documentation

CHANGELOG.md

@@ -1,3 +1,15 @@
+# [20.0.0-dev.1](https://github.com/ReVanced/revanced-patcher/compare/v19.3.1...v20.0.0-dev.1) (2024-07-22)
+
+
+### Features
+
+* Convert APIs to Kotlin DSL ([#298](https://github.com/ReVanced/revanced-patcher/issues/298)) ([3f9cbd2](https://github.com/ReVanced/revanced-patcher/commit/3f9cbd2408fa085690a062b357e11e42c51e7f8b))
+
+
+### BREAKING CHANGES
+
+* Various old APIs are removed, and DSL APIs are added instead.
+
 ## [19.3.1](https://github.com/ReVanced/revanced-patcher/compare/v19.3.0...v19.3.1) (2024-02-14)
 
 ## [19.3.1-dev.1](https://github.com/ReVanced/revanced-patcher/compare/v19.3.0...v19.3.1-dev.1) (2024-02-14)

CONTRIBUTING.md

@@ -72,7 +72,7 @@ This document describes how to contribute to ReVanced Patcher.
 ## 🙏 Submitting a feature request
 
 Features can be requested by opening an issue using the
-[Feature request issue template](https://github.com/ReVanced/revanced-patcher/issues/new?assignees=&labels=Feature+request&projects=&template=feature-request.yml&title=feat%3A+).
+[Feature request issue template](https://github.com/ReVanced/revanced-patcher/issues/new?assignees=&labels=Feature+request&projects=&template=feature_request.yml&title=feat%3A+).
 
 > **Note**
 > Requests can be accepted or rejected at the discretion of maintainers of ReVanced Patcher.
@@ -81,7 +81,7 @@ Features can be requested by opening an issue using the
 ## 🐞 Submitting a bug report
 
 If you encounter a bug while using ReVanced Patcher, open an issue using the
-[Bug report issue template](https://github.com/ReVanced/revanced-patcher/issues/new?assignees=&labels=Bug+report&projects=&template=bug-report.yml&title=bug%3A+).
+[Bug report issue template](https://github.com/ReVanced/revanced-patcher/issues/new?assignees=&labels=Bug+report&projects=&template=bug_report.yml&title=bug%3A+).
 
 ## 📝 How to contribute
 

README.md

@@ -115,7 +115,7 @@ you can follow the [ReVanced documentation](https://github.com/ReVanced/revanced
 ### 📃 Documentation
 
 The documentation contains the fundamentals of ReVanced Patcher and how to use ReVanced Patcher to create patches.
-You can find it [here](https://github.com/ReVanced/revanced-patcher/tree/docs/docs).
+You can find it [here](https://github.com/ReVanced/revanced-patcher/tree/main/docs).
 
 ## 📜 Licence
 

build.gradle.kts

@@ -1,3 +1,5 @@
+import org.jetbrains.kotlin.gradle.dsl.JvmTarget
+
 plugins {
     alias(libs.plugins.kotlin)
     alias(libs.plugins.binary.compatibility.validator)
@@ -22,10 +24,9 @@ tasks {
 
 repositories {
     mavenCentral()
-    mavenLocal()
     google()
     maven {
-        // A repository must be speficied for some reason. "registry" is a dummy.
+        // A repository must be specified for some reason. "registry" is a dummy.
         url = uri("https://maven.pkg.github.com/revanced/registry")
         credentials {
             username = project.findProperty("gpr.user") as String? ?: System.getenv("GITHUB_ACTOR")
@@ -47,12 +48,20 @@ dependencies {
         // Exclude, otherwise the org.w3c.dom API breaks.
         exclude(group = "xerces", module = "xmlParserAPIs")
     }
-
     testImplementation(libs.kotlin.test)
+    testImplementation(libs.mockk)
 }
 
 kotlin {
-    jvmToolchain(11)
+    compilerOptions {
+        jvmTarget.set(JvmTarget.JVM_11)
+    }
+}
+
+java {
+    targetCompatibility = JavaVersion.VERSION_11
+
+    withSourcesJar()
 }
 
 publishing {

docs/1_patcher_intro.md

@@ -60,40 +60,43 @@
 
 # 💉 Introduction to ReVanced Patcher
 
-In order to create patches for Android applications, you first need to understand the fundamentals of ReVanced Patcher.
+To create patches for Android apps, it is recommended to know the basic concept of ReVanced Patcher.
 
 ## 📙 How it works
 
-ReVanced Patcher is a library that allows you to modify Android applications by applying patches to their APKs. It is built on top of [Smali](https://github.com/google/smali) for bytecode manipulation and [Androlib (Apktool)](https://github.com/iBotPeaches/Apktool) for resource decoding and encoding.
-ReVanced Patcher accepts a list of patches and integrations, and applies them to a given APK file. It then returns the modified components of the APK file, such as modified dex files and resources, that can be repackaged into a new APK file.
+ReVanced Patcher is a library that allows modifying Android apps by applying patches.
+It is built on top of [Smali](https://github.com/google/smali) for bytecode manipulation and [Androlib (Apktool)](https://github.com/iBotPeaches/Apktool)
+for resource decoding and encoding.
 
-ReVanced Patcher has a simple API that allows you to load patches and integrations from JAR files and apply them to an APK file.
-Later on, you will learn how to create patches.
+ReVanced Patcher receives a list of patches and applies them to a given APK file.
+It then returns the modified components of the APK file, such as modified dex files and resources,
+that can be repackaged into a new APK file.
+
+ReVanced Patcher has a simple API that allows you to load patches from RVP (JAR or DEX container) files
+and apply them to an APK file. Later on, you will learn how to create patches.
 
 ```kt
- // Executed patches do not necessarily reset their state.
- // For that reason it is important to create a new instance of the PatchBundleLoader
- // once the patches are executed instead of reusing the same instance of patches loaded by PatchBundleLoader.
-val patches: PatchSet /* = Set<Patch<*>> */ = PatchBundleLoader.Jar(File("revanced-patches.jar"))
-val integrations = setOf(File("integrations.apk"))
+val patches = loadPatchesFromJar(setOf(File("revanced-patches.rvp")))
 
-// Instantiating the patcher will decode the manifest of the APK file to read the package and version name.
-val patcherConfig = PatcherConfig(apkFile = File("some.apk"))
-val patcherResult = Patcher(patcherConfig).use { patcher ->
-    patcher.apply {
-        acceptIntegrations(integrations)
-        acceptPatches(patches)
+val patcherResult = Patcher(PatcherConfig(apkFile = File("some.apk"))).use { patcher ->
+    // Here you can access metadata about the APK file through patcher.context.packageMetadata
+    // such as package name, version code, version name, etc.
 
-        // Execute patches.
-        runBlocking {
-            patcher.apply(returnOnError = false).collect { patchResult ->
-                if (patchResult.exception != null)
-                    println("${patchResult.patchName} failed:\n${patchResult.exception}")
-                else
-                    println("${patchResult.patchName} succeeded")
-            }
+    // Add patches.
+    patcher += patches
+
+    // Execute the patches.
+    runBlocking {
+        patcher().collect { patchResult ->
+            if (patchResult.exception != null)
+                logger.info("\"${patchResult.patch}\" failed:\n${patchResult.exception}")
+            else
+                logger.info("\"${patchResult.patch}\" succeeded")
         }
-    }.get()
+    }
+
+    // Compile and save the patched APK file components.
+    patcher.get()
 }
 
 // The result of the patcher contains the modified components of the APK file that can be repackaged into a new APK file.

docs/2_1_setup.md

@@ -60,7 +60,7 @@
 
 # 👶 Setting up a development environment
 
-To get started developing patches with ReVanced Patcher, you need to prepare a development environment.
+To start developing patches with ReVanced Patcher, you must prepare a development environment.
 
 ## 📝 Prerequisites
 
@@ -84,21 +84,22 @@ Throughout the documentation, [ReVanced Patches](https://github.com/revanced/rev
    ./gradlew build
    ```
 
-   > [!NOTE]
-   > If the build fails due to authentication, you may need to authenticate to GitHub Packages.
-   > Create a PAT with the scope `read:packages` [here](https://github.com/settings/tokens/new?scopes=read:packages&description=ReVanced) and add your token to ~/.gradle/gradle.properties.
-   >
-   > Example `gradle.properties` file:
-   >
-   > ```properties
-   > gpr.user = user
-   > gpr.key = key
-   > ```
+> [!NOTE]
+> If the build fails due to authentication, you may need to authenticate to GitHub Packages.
+> Create a PAT with the scope `read:packages` [here](https://github.com/settings/tokens/new?scopes=read:packages&description=ReVanced) and add your token to ~/.gradle/gradle.properties.
+>
+> Example `gradle.properties` file:
+>
+> ```properties
+> gpr.user = user
+> gpr.key = key
+> ```
 
 3. Open the project in your IDE
 
 > [!TIP]
-> It is a good idea to set up a complete development environment for ReVanced, so that you can also test your patches by following the [ReVanced documentation](https://github.com/ReVanced/revanced-documentation).
+> It is a good idea to set up a complete development environment for ReVanced, so that you can also test your patches
+> by following the [ReVanced documentation](https://github.com/ReVanced/revanced-documentation).
 
 ## ⏭️ What's next
 

docs/3_structure_and_conventions.md

@@ -64,31 +64,39 @@ Over time, a specific project structure and conventions have been established.
 
 ## 📁 File structure
 
-Patches are organized in a specific file structure. The file structure is as follows:
+Patches are organized in a specific way. The file structure looks as follows:
 
 ```text
 📦your.patches.app.category
- ├ 📂fingerprints
- ├ ├ 🔍SomeFingerprintA.kt
- ├ └ 🔍SomeFingerprintB.kt
+ ├ 🔍Fingerprints.kt
  └ 🧩SomePatch.kt
 ```
 
+> [!NOTE]
+> Moving fingerprints to a separate file isn't strictly necessary, but it helps the organization when a patch uses multiple fingerprints.
+
 ## 📙 Conventions
 
-- 🔥 Name a patch after what it does. For example, if a patch removes ads, name it `RemoveAdsPatch`.
-  If a patch changes the color of a button, name it `ChangeButtonColorPatch`
+- 🔥 Name a patch after what it does. For example, if a patch removes ads, name it `Remove ads`.
+  If a patch changes the color of a button, name it `Change button color`
 - 🔥 Write the patch description in the third person, present tense, and end it with a period.
-  If a patch removes ads, the description can be omitted because of redundancy, but if a patch changes the color of a button, the description can be _Changes the color of the resume button to red._
-- 🔥 Write patches with modularity and reusability in mind. Patches can depend on each other, so it is important to write patches in a way that can be used in different contexts.
+  If a patch removes ads, the description can be omitted because of redundancy,
+  but if a patch changes the color of a button, the description can be _Changes the color of the resume button to red._
+- 🔥 Write patches with modularity and reusability in mind. Patches can depend on each other,
+  so it is important to write patches in a way that can be used in different contexts.
 - 🔥🔥 Keep patches as minimal as possible. This reduces the risk of failing patches.
   Instead of involving many abstract changes in one patch or writing entire methods or classes in a patch,
-  you can write code in integrations. Integrations are compiled classes that are merged into the app before patches are executed as described in [💉 Introduction to ReVanced Patcher](1_patcher_intro).
-  Patches can then reference methods and classes from integrations.
-  A real-world example of integrations can be found in the [ReVanced Integrations](https://github.com/ReVanced/revanced-integrations) repository
+  you can write code in extensions. An extension is a precompiled DEX file that is merged into the patched app 
+  before this patch is executed.
+  Patches can then reference methods and classes from extensions.
+  A real-world example of extensions can be found in the [ReVanced Patches](https://github.com/ReVanced/revanced-patches) repository
 - 🔥🔥🔥 Do not overload a fingerprint with information about a method that's likely to change.
-  In the example of an obfuscated method, it's better to fingerprint the method by its return type and parameters rather than its name because the name is likely to change. An intelligent selection of an opcode pattern or strings in a method can result in a strong fingerprint dynamic to app updates.
-- 🔥🔥🔥 Document your patches. Patches are abstract by nature, so it is important to document parts of the code that are not self-explanatory. For example, explain why and how a certain method is patched or large blocks of instructions that are modified or added to a method
+  In the example of an obfuscated method, it's better to fingerprint the method by its return type
+  and parameters rather than its name because the name is likely to change. An intelligent selection
+  of an opcode pattern or strings in a method can result in a strong fingerprint dynamic to app updates.
+- 🔥🔥🔥 Document your patches. Patches are abstract, so it is important to document parts of the code
+  that are not self-explanatory. For example, explain why and how a certain method is patched or large blocks
+  of instructions that are modified or added to a method
 
 ## ⏭️ What's next
 

gradle.properties

@@ -1,3 +1,3 @@
 org.gradle.parallel = true
 org.gradle.caching = true
-version = 19.3.1
+version = 20.0.0-dev.1

gradle/libs.versions.toml

@@ -3,8 +3,9 @@ android = "4.1.1.4"
 apktool-lib = "2.9.3"
 kotlin = "1.9.22"
 kotlinx-coroutines-core = "1.7.3"
+mockk = "1.13.10"
 multidexlib2 = "3.0.3.r3"
-smali = "3.0.4"
+smali = "3.0.5"
 binary-compatibility-validator = "0.14.0"
 xpp3 = "1.1.4c"
 
@@ -14,10 +15,11 @@ kotlin-reflect = { module = "org.jetbrains.kotlin:kotlin-reflect", version.ref =
 apktool-lib = { module = "app.revanced:apktool-lib", version.ref = "apktool-lib" }
 kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" }
 kotlinx-coroutines-core = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlinx-coroutines-core" }
+mockk = { module = "io.mockk:mockk", version.ref = "mockk" }
 multidexlib2 = { module = "app.revanced:multidexlib2", version.ref = "multidexlib2" }
 smali = { module = "com.android.tools.smali:smali", version.ref = "smali" }
 xpp3 = { module = "xpp3:xpp3", version.ref = "xpp3" }
 
 [plugins]
 binary-compatibility-validator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version.ref = "binary-compatibility-validator" }
-kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
+kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }

package-lock.json

@@ -9,7 +9,7 @@
         "@semantic-release/changelog": "^6.0.3",
         "@semantic-release/git": "^10.0.1",
         "gradle-semantic-release-plugin": "^1.9.1",
-        "semantic-release": "^23.0.0"
+        "semantic-release": "^23.0.2"
       }
     },
     "node_modules/@babel/code-frame": {
@@ -272,18 +272,18 @@
       }
     },
     "node_modules/@octokit/openapi-types": {
-      "version": "19.1.0",
-      "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-19.1.0.tgz",
-      "integrity": "sha512-6G+ywGClliGQwRsjvqVYpklIfa7oRPA0vyhPQG/1Feh+B+wU0vGH1JiJ5T25d3g1JZYBHzR2qefLi9x8Gt+cpw==",
+      "version": "20.0.0",
+      "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-20.0.0.tgz",
+      "integrity": "sha512-EtqRBEjp1dL/15V7WiX5LJMIxxkdiGJnabzYx5Apx4FkQIFgAfKumXeYAqqJCj1s+BMX4cPFIFC4OLCR6stlnA==",
       "dev": true
     },
     "node_modules/@octokit/plugin-paginate-rest": {
-      "version": "9.1.5",
-      "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-9.1.5.tgz",
-      "integrity": "sha512-WKTQXxK+bu49qzwv4qKbMMRXej1DU2gq017euWyKVudA6MldaSSQuxtz+vGbhxV4CjxpUxjZu6rM2wfc1FiWVg==",
+      "version": "9.2.0",
+      "resolved": "https://registry.npmjs.org/@octokit/plugin-paginate-rest/-/plugin-paginate-rest-9.2.0.tgz",
+      "integrity": "sha512-NKi0bJEZqOSbBLMv9kdAcuocpe05Q2xAXNLTGi0HN2GSMFJHNZuSoPNa0tcQFTOFCKe+ZaYBZ3lpXh1yxgUDCA==",
       "dev": true,
       "dependencies": {
-        "@octokit/types": "^12.4.0"
+        "@octokit/types": "^12.6.0"
       },
       "engines": {
         "node": ">= 18"
@@ -310,9 +310,9 @@
       }
     },
     "node_modules/@octokit/plugin-throttling": {
-      "version": "8.1.3",
-      "resolved": "https://registry.npmjs.org/@octokit/plugin-throttling/-/plugin-throttling-8.1.3.tgz",
-      "integrity": "sha512-pfyqaqpc0EXh5Cn4HX9lWYsZ4gGbjnSmUILeu4u2gnuM50K/wIk9s1Pxt3lVeVwekmITgN/nJdoh43Ka+vye8A==",
+      "version": "8.2.0",
+      "resolved": "https://registry.npmjs.org/@octokit/plugin-throttling/-/plugin-throttling-8.2.0.tgz",
+      "integrity": "sha512-nOpWtLayKFpgqmgD0y3GqXafMFuKcA4tRPZIfu7BArd2lEZeb1988nhWhwx4aZWmjDmUfdgVf7W+Tt4AmvRmMQ==",
       "dev": true,
       "dependencies": {
         "@octokit/types": "^12.2.0",
@@ -355,12 +355,12 @@
       }
     },
     "node_modules/@octokit/types": {
-      "version": "12.4.0",
-      "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.4.0.tgz",
-      "integrity": "sha512-FLWs/AvZllw/AGVs+nJ+ELCDZZJk+kY0zMen118xhL2zD0s1etIUHm1odgjP7epxYU1ln7SZxEUWYop5bhsdgQ==",
+      "version": "12.6.0",
+      "resolved": "https://registry.npmjs.org/@octokit/types/-/types-12.6.0.tgz",
+      "integrity": "sha512-1rhSOfRa6H9w4YwK0yrf5faDaDTb+yLyBUKOCV4xtCDB5VmIPqd/v9yr9o6SAzOAlRxMiRiCic6JVM1/kunVkw==",
       "dev": true,
       "dependencies": {
-        "@octokit/openapi-types": "^19.1.0"
+        "@octokit/openapi-types": "^20.0.0"
       }
     },
     "node_modules/@pnpm/config.env-replace": {
@@ -597,9 +597,9 @@
       }
     },
     "node_modules/@saithodev/semantic-release-backmerge/node_modules/npm-run-path": {
-      "version": "5.2.0",
-      "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.2.0.tgz",
-      "integrity": "sha512-W4/tgAXFqFA0iL7fk0+uQ3g7wkL8xJmx3XdK0VGb4cHW//eZTtKGvFBBoRKVTpY7n6ze4NL9ly7rgXcHufqXKg==",
+      "version": "5.3.0",
+      "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.3.0.tgz",
+      "integrity": "sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ==",
       "dev": true,
       "dependencies": {
         "path-key": "^4.0.0"
@@ -1101,9 +1101,9 @@
       }
     },
     "node_modules/@semantic-release/npm/node_modules/npm-run-path": {
-      "version": "5.2.0",
-      "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.2.0.tgz",
-      "integrity": "sha512-W4/tgAXFqFA0iL7fk0+uQ3g7wkL8xJmx3XdK0VGb4cHW//eZTtKGvFBBoRKVTpY7n6ze4NL9ly7rgXcHufqXKg==",
+      "version": "5.3.0",
+      "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.3.0.tgz",
+      "integrity": "sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ==",
       "dev": true,
       "dependencies": {
         "path-key": "^4.0.0"
@@ -1215,9 +1215,9 @@
       }
     },
     "node_modules/@sindresorhus/merge-streams": {
-      "version": "2.2.0",
-      "resolved": "https://registry.npmjs.org/@sindresorhus/merge-streams/-/merge-streams-2.2.0.tgz",
-      "integrity": "sha512-UTce8mUwUW0RikMb/eseJ7ys0BRkZVFB86orHzrfW12ZmFtym5zua8joZ4L7okH2dDFHkcFjqnZ5GocWBXOFtA==",
+      "version": "2.3.0",
+      "resolved": "https://registry.npmjs.org/@sindresorhus/merge-streams/-/merge-streams-2.3.0.tgz",
+      "integrity": "sha512-LtoMMhxAlorcGhmFYI+LhPgbPZCkgP6ra1YL604EeF6U98pLlQ3iWIGMdWSC+vWmPBWBNgmDBAhnAobLROJmwg==",
       "dev": true,
       "engines": {
         "node": ">=18"
@@ -1835,9 +1835,9 @@
       }
     },
     "node_modules/env-ci/node_modules/npm-run-path": {
-      "version": "5.2.0",
-      "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.2.0.tgz",
-      "integrity": "sha512-W4/tgAXFqFA0iL7fk0+uQ3g7wkL8xJmx3XdK0VGb4cHW//eZTtKGvFBBoRKVTpY7n6ze4NL9ly7rgXcHufqXKg==",
+      "version": "5.3.0",
+      "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.3.0.tgz",
+      "integrity": "sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ==",
       "dev": true,
       "dependencies": {
         "path-key": "^4.0.0"
@@ -2288,9 +2288,9 @@
       }
     },
     "node_modules/http-proxy-agent": {
-      "version": "7.0.1",
-      "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-7.0.1.tgz",
-      "integrity": "sha512-My1KCEPs6A0hb4qCVzYp8iEvA8j8YqcvXLZZH8C9OFuTYpYjHE7N2dtG3mRl1HMD4+VGXpF3XcDVcxGBT7yDZQ==",
+      "version": "7.0.2",
+      "resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-7.0.2.tgz",
+      "integrity": "sha512-T1gkAiYYDWYx3V5Bmyu7HcfcvL7mUrTWiM6yOfa3PIphViJ/gFPbvidQ+veqSOHci/PxBcDabeUNCzpOODJZig==",
       "dev": true,
       "dependencies": {
         "agent-base": "^7.1.0",
@@ -2301,9 +2301,9 @@
       }
     },
     "node_modules/https-proxy-agent": {
-      "version": "7.0.3",
-      "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.3.tgz",
-      "integrity": "sha512-kCnwztfX0KZJSLOBrcL0emLeFako55NWMovvyPP2AjsghNk9RB1yjSI+jVumPHYZsNXegNoqupSW9IY3afSH8w==",
+      "version": "7.0.4",
+      "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.4.tgz",
+      "integrity": "sha512-wlwpilI7YdjSkWaQ/7omYBMTliDcmCN8OLihO6I9B86g06lMyAoqgoDpV0XqoaPOKj+0DIdAvnsWfyAAhmimcg==",
       "dev": true,
       "dependencies": {
         "agent-base": "^7.0.2",
@@ -6011,9 +6011,9 @@
       }
     },
     "node_modules/read-pkg-up/node_modules/type-fest": {
-      "version": "4.10.2",
-      "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.10.2.tgz",
-      "integrity": "sha512-anpAG63wSpdEbLwOqH8L84urkL6PiVIov3EMmgIhhThevh9aiMQov+6Btx0wldNcvm4wV+e2/Rt1QdDwKHFbHw==",
+      "version": "4.10.3",
+      "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.10.3.tgz",
+      "integrity": "sha512-JLXyjizi072smKGGcZiAJDCNweT8J+AuRxmPZ1aG7TERg4ijx9REl8CNhbr36RV4qXqL1gO1FF9HL8OkVmmrsA==",
       "dev": true,
       "engines": {
         "node": ">=16"
@@ -6040,9 +6040,9 @@
       }
     },
     "node_modules/read-pkg/node_modules/type-fest": {
-      "version": "4.10.2",
-      "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.10.2.tgz",
-      "integrity": "sha512-anpAG63wSpdEbLwOqH8L84urkL6PiVIov3EMmgIhhThevh9aiMQov+6Btx0wldNcvm4wV+e2/Rt1QdDwKHFbHw==",
+      "version": "4.10.3",
+      "resolved": "https://registry.npmjs.org/type-fest/-/type-fest-4.10.3.tgz",
+      "integrity": "sha512-JLXyjizi072smKGGcZiAJDCNweT8J+AuRxmPZ1aG7TERg4ijx9REl8CNhbr36RV4qXqL1gO1FF9HL8OkVmmrsA==",
       "dev": true,
       "engines": {
         "node": ">=16"
@@ -6320,9 +6320,9 @@
       }
     },
     "node_modules/semantic-release/node_modules/npm-run-path": {
-      "version": "5.2.0",
-      "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.2.0.tgz",
-      "integrity": "sha512-W4/tgAXFqFA0iL7fk0+uQ3g7wkL8xJmx3XdK0VGb4cHW//eZTtKGvFBBoRKVTpY7n6ze4NL9ly7rgXcHufqXKg==",
+      "version": "5.3.0",
+      "resolved": "https://registry.npmjs.org/npm-run-path/-/npm-run-path-5.3.0.tgz",
+      "integrity": "sha512-ppwTtiJZq0O/ai0z7yfudtBpWIoxM8yE6nHi1X47eFR2EWORqfbu6CnPlNsjeN683eT0qG6H/Pyf9fCcvjnnnQ==",
       "dev": true,
       "dependencies": {
         "path-key": "^4.0.0"
@@ -6616,9 +6616,9 @@
       }
     },
     "node_modules/spdx-exceptions": {
-      "version": "2.4.0",
-      "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.4.0.tgz",
-      "integrity": "sha512-hcjppoJ68fhxA/cjbN4T8N6uCUejN8yFw69ttpqtBeCbF3u13n7mb31NB9jKwGTTWWnt9IbRA/mf1FprYS8wfw==",
+      "version": "2.5.0",
+      "resolved": "https://registry.npmjs.org/spdx-exceptions/-/spdx-exceptions-2.5.0.tgz",
+      "integrity": "sha512-PiU42r+xO4UbUS1buo3LPJkjlO7430Xn5SVAhdpzzsPHsjbYVflnnFdATgabnLude+Cqu25p6N+g2lw/PFsa4w==",
       "dev": true
     },
     "node_modules/spdx-expression-parse": {

package.json

@@ -4,6 +4,6 @@
     "@semantic-release/changelog": "^6.0.3",
     "@semantic-release/git": "^10.0.1",
     "gradle-semantic-release-plugin": "^1.9.1",
-    "semantic-release": "^23.0.0"
+    "semantic-release": "^23.0.2"
   }
 }

settings.gradle.kts

@@ -1,7 +1 @@
 rootProject.name = "revanced-patcher"
-
-buildCache {
-    local {
-        isEnabled = "CI" !in System.getenv()
-    }
-}

src/main/kotlin/app/revanced/patcher/IntegrationsConsumer.kt

@@ -1,11 +0,0 @@
-package app.revanced.patcher
-
-import java.io.File
-
-@FunctionalInterface
-interface IntegrationsConsumer {
-    fun acceptIntegrations(integrations: Set<File>)
-
-    @Deprecated("Use acceptIntegrations(Set<File>) instead.")
-    fun acceptIntegrations(integrations: List<File>)
-}

src/main/kotlin/app/revanced/patcher/PatchBundleLoader.kt

@@ -1,136 +0,0 @@
-@file:Suppress("unused")
-
-package app.revanced.patcher
-
-import app.revanced.patcher.patch.Patch
-import dalvik.system.DexClassLoader
-import lanchon.multidexlib2.BasicDexFileNamer
-import lanchon.multidexlib2.MultiDexIO
-import java.io.File
-import java.net.URLClassLoader
-import java.util.jar.JarFile
-import java.util.logging.Logger
-import kotlin.reflect.KClass
-
-
-/**
- * A set of [Patch]es.
- */
-typealias PatchSet = Set<Patch<*>>
-
-/**
- * A [Patch] class.
- */
-typealias PatchClass = KClass<out Patch<*>>
-
-/**
- * A loader of [Patch]es from patch bundles.
- * This will load all [Patch]es from the given patch bundles that have a name.
- *
- * @param getBinaryClassNames A function that returns the binary names of all classes in a patch bundle.
- * @param classLoader The [ClassLoader] to use for loading the classes.
- * @param patchBundles A set of patches to initialize this instance with.
- */
-sealed class PatchBundleLoader private constructor(
-    classLoader: ClassLoader,
-    patchBundles: Array<out File>,
-    getBinaryClassNames: (patchBundle: File) -> List<String>,
-    // This constructor parameter is unfortunately necessary,
-    // so that a reference to the mutable set is present in the constructor to be able to add patches to it.
-    // because the instance itself is a PatchSet, which is immutable, that is delegated by the parameter.
-    private val patchSet: MutableSet<Patch<*>> = mutableSetOf(),
-) : PatchSet by patchSet {
-    private val logger = Logger.getLogger(PatchBundleLoader::class.java.name)
-
-    init {
-        patchBundles.flatMap(getBinaryClassNames).asSequence().map {
-            classLoader.loadClass(it)
-        }.filter {
-            Patch::class.java.isAssignableFrom(it)
-        }.mapNotNull { patchClass ->
-            patchClass.getInstance(logger, silent = true)
-        }.filter {
-            it.name != null
-        }.let { patches ->
-            patchSet.addAll(patches)
-        }
-    }
-
-    internal companion object Utils {
-        /**
-         * Instantiates a [Patch]. If the class is a singleton, the INSTANCE field will be used.
-         *
-         * @param logger The [Logger] to use for logging.
-         * @param silent Whether to suppress logging.
-         * @return The instantiated [Patch] or `null` if the [Patch] could not be instantiated.
-         */
-        internal fun Class<*>.getInstance(
-            logger: Logger,
-            silent: Boolean = false,
-        ): Patch<*>? {
-            return try {
-                getField("INSTANCE").get(null)
-            } catch (exception: NoSuchFieldException) {
-                if (!silent) {
-                    logger.fine(
-                        "Patch class '$name' has no INSTANCE field, therefor not a singleton. " +
-                                "Attempting to instantiate it.",
-                    )
-                }
-
-                try {
-                    getDeclaredConstructor().newInstance()
-                } catch (exception: Exception) {
-                    if (!silent) {
-                        logger.severe(
-                            "Patch class '$name' is not singleton and has no suitable constructor, " +
-                                    "therefor cannot be instantiated and is ignored.",
-                        )
-                    }
-
-                    return null
-                }
-            } as Patch<*>
-        }
-    }
-
-    /**
-     * A [PatchBundleLoader] for JAR files.
-     *
-     * @param patchBundles The path to patch bundles of JAR format.
-     */
-    class Jar(vararg patchBundles: File) : PatchBundleLoader(
-        URLClassLoader(patchBundles.map { it.toURI().toURL() }.toTypedArray()),
-        patchBundles,
-        { patchBundle ->
-            JarFile(patchBundle).entries().toList().filter { it.name.endsWith(".class") }
-                .map { it.name.replace('/', '.').replace(".class", "") }
-        },
-    )
-
-    /**
-     * A [PatchBundleLoader] for [Dex] files.
-     *
-     * @param patchBundles The path to patch bundles of DEX format.
-     * @param optimizedDexDirectory The directory to store optimized DEX files in.
-     * This parameter is deprecated and has no effect since API level 26.
-     */
-    class Dex(vararg patchBundles: File, optimizedDexDirectory: File? = null) : PatchBundleLoader(
-        DexClassLoader(
-            patchBundles.joinToString(File.pathSeparator) { it.absolutePath },
-            optimizedDexDirectory?.absolutePath,
-            null,
-            PatchBundleLoader::class.java.classLoader,
-        ),
-        patchBundles,
-        { patchBundle ->
-            MultiDexIO.readDexFile(true, patchBundle, BasicDexFileNamer(), null, null).classes
-                .map { classDef ->
-                    classDef.type.substring(1, classDef.length - 1)
-                }
-        },
-    ) {
-        @Deprecated("This constructor is deprecated. Use the constructor with the second parameter instead.")
-        constructor(vararg patchBundles: File) : this(*patchBundles, optimizedDexDirectory = null)
-    }
-}

src/main/kotlin/app/revanced/patcher/PatchExecutorFunction.kt

@@ -1,8 +0,0 @@
-package app.revanced.patcher
-
-import app.revanced.patcher.patch.PatchResult
-import kotlinx.coroutines.flow.Flow
-import java.util.function.Function
-
-@FunctionalInterface
-interface PatchExecutorFunction : Function<Boolean, Flow<PatchResult>>

src/main/kotlin/app/revanced/patcher/PatcherConfig.kt

@@ -1,6 +1,6 @@
 package app.revanced.patcher
 
-import app.revanced.patcher.data.ResourceContext
+import app.revanced.patcher.patch.ResourcePatchContext
 import brut.androlib.Config
 import java.io.File
 import java.util.logging.Logger
@@ -27,9 +27,9 @@ class PatcherConfig(
     /**
      * The mode to use for resource decoding and compiling.
      *
-     * @see ResourceContext.ResourceMode
+     * @see ResourcePatchContext.ResourceMode
      */
-    internal var resourceMode = ResourceContext.ResourceMode.NONE
+    internal var resourceMode = ResourcePatchContext.ResourceMode.NONE
 
     /**
      * The configuration for decoding and compiling resources.

src/main/kotlin/app/revanced/patcher/PatcherContext.kt

@@ -1,8 +1,8 @@
 package app.revanced.patcher
 
-import app.revanced.patcher.data.BytecodeContext
-import app.revanced.patcher.data.ResourceContext
+import app.revanced.patcher.patch.BytecodePatchContext
 import app.revanced.patcher.patch.Patch
+import app.revanced.patcher.patch.ResourcePatchContext
 import brut.androlib.apk.ApkInfo
 import brut.directory.ExtFile
 
@@ -19,22 +19,22 @@ class PatcherContext internal constructor(config: PatcherConfig) {
     val packageMetadata = PackageMetadata(ApkInfo(ExtFile(config.apkFile)))
 
     /**
-     * The map of [Patch]es associated by their [PatchClass].
+     * The set of [Patch]es.
      */
-    internal val executablePatches = mutableMapOf<PatchClass, Patch<*>>()
+    internal val executablePatches = mutableSetOf<Patch<*>>()
 
     /**
-     * The map of all [Patch]es and their dependencies associated by their [PatchClass].
+     * The set of all [Patch]es and their dependencies.
      */
-    internal val allPatches = mutableMapOf<PatchClass, Patch<*>>()
+    internal val allPatches = mutableSetOf<Patch<*>>()
 
     /**
-     * A context for the patcher containing the current state of the resources.
+     * The context for patches containing the current state of the resources.
      */
-    internal val resourceContext = ResourceContext(packageMetadata, config)
+    internal val resourceContext = ResourcePatchContext(packageMetadata, config)
 
     /**
-     * A context for the patcher containing the current state of the bytecode.
+     * The context for patches containing the current state of the bytecode.
      */
-    internal val bytecodeContext = BytecodeContext(config)
+    internal val bytecodeContext = BytecodePatchContext(config)
 }

src/main/kotlin/app/revanced/patcher/PatcherException.kt

@@ -1,15 +0,0 @@
-package app.revanced.patcher
-
-/**
- * An exception thrown by ReVanced [Patcher].
- *
- * @param errorMessage The exception message.
- * @param cause The corresponding [Throwable].
- */
-sealed class PatcherException(errorMessage: String?, cause: Throwable?) : Exception(errorMessage, cause) {
-    constructor(errorMessage: String) : this(errorMessage, null)
-
-    class CircularDependencyException internal constructor(dependant: String) : PatcherException(
-        "Patch '$dependant' causes a circular dependency",
-    )
-}

src/main/kotlin/app/revanced/patcher/PatcherOptions.kt

@@ -1,25 +0,0 @@
-package app.revanced.patcher
-
-import java.io.File
-
-@Deprecated("Use PatcherConfig instead.")
-data class PatcherOptions(
-    internal val inputFile: File,
-    internal val resourceCachePath: File = File("revanced-resource-cache"),
-    internal val aaptBinaryPath: String? = null,
-    internal val frameworkFileDirectory: String? = null,
-    internal val multithreadingDexFileWriter: Boolean = false,
-) {
-    @Deprecated("This method will be removed in the future.")
-    fun recreateResourceCacheDirectory(): File {
-        PatcherConfig(
-            inputFile,
-            resourceCachePath,
-            aaptBinaryPath,
-            frameworkFileDirectory,
-            multithreadingDexFileWriter,
-        ).initializeTemporaryFilesDirectories()
-
-        return resourceCachePath
-    }
-}

src/main/kotlin/app/revanced/patcher/PatcherResult.kt

@@ -2,7 +2,6 @@ package app.revanced.patcher
 
 import java.io.File
 import java.io.InputStream
-import kotlin.jvm.internal.Intrinsics
 
 /**
  * The result of a patcher.
@@ -15,87 +14,6 @@ class PatcherResult internal constructor(
     val dexFiles: Set<PatchedDexFile>,
     val resources: PatchedResources?,
 ) {
-    @Deprecated("This method is not used anymore")
-    constructor(
-        dexFiles: List<PatchedDexFile>,
-        resourceFile: File?,
-        doNotCompress: List<String>? = null,
-    ) : this(dexFiles.toSet(), PatchedResources(resourceFile, null, doNotCompress?.toSet() ?: emptySet(), emptySet()))
-
-    @Deprecated("This method is not used anymore")
-    fun component1(): List<PatchedDexFile> {
-        return dexFiles.toList()
-    }
-
-    @Deprecated("This method is not used anymore")
-    fun component2(): File? {
-        return resources?.resourcesApk
-    }
-
-    @Deprecated("This method is not used anymore")
-    fun component3(): List<String>? {
-        return resources?.doNotCompress?.toList()
-    }
-
-    @Deprecated("This method is not used anymore")
-    fun copy(
-        dexFiles: List<PatchedDexFile>,
-        resourceFile: File?,
-        doNotCompress: List<String>? = null,
-    ): PatcherResult {
-        return PatcherResult(
-            dexFiles.toSet(),
-            PatchedResources(
-                resourceFile,
-                null,
-                doNotCompress?.toSet() ?: emptySet(),
-                emptySet(),
-            ),
-        )
-    }
-
-    @Deprecated("This method is not used anymore")
-    override fun toString(): String {
-        return (("PatcherResult(dexFiles=" + this.dexFiles + ", resourceFile=" + this.resources?.resourcesApk) + ", doNotCompress=" + this.resources?.doNotCompress) + ")"
-    }
-
-    @Deprecated("This method is not used anymore")
-    override fun hashCode(): Int {
-        val result = dexFiles.hashCode()
-        return (
-            (
-                (result * 31) +
-                    (if (this.resources?.resourcesApk == null) 0 else this.resources.resourcesApk.hashCode())
-                ) * 31
-            ) +
-            (if (this.resources?.doNotCompress == null) 0 else this.resources.doNotCompress.hashCode())
-    }
-
-    @Deprecated("This method is not used anymore")
-    override fun equals(other: Any?): Boolean {
-        if (this === other) {
-            return true
-        }
-        if (other is PatcherResult) {
-            return Intrinsics.areEqual(this.dexFiles, other.dexFiles) && Intrinsics.areEqual(
-                this.resources?.resourcesApk,
-                other.resources?.resourcesApk,
-            ) && Intrinsics.areEqual(this.resources?.doNotCompress, other.resources?.doNotCompress)
-        }
-        return false
-    }
-
-    @Suppress("DEPRECATION")
-    @Deprecated("This method is not used anymore")
-    fun getDexFiles() = component1()
-
-    @Suppress("DEPRECATION")
-    @Deprecated("This method is not used anymore")
-    fun getResourceFile() = component2()
-
-    @Suppress("DEPRECATION")
-    @Deprecated("This method is not used anymore")
-    fun getDoNotCompress() = component3()
 
     /**
      * A dex file.
@@ -103,10 +21,7 @@ class PatcherResult internal constructor(
      * @param name The original name of the dex file.
      * @param stream The dex file as [InputStream].
      */
-    class PatchedDexFile
-    // TODO: Add internal modifier.
-    @Deprecated("This constructor will be removed in the future.")
-    constructor(val name: String, val stream: InputStream)
+    class PatchedDexFile internal constructor(val name: String, val stream: InputStream)
 
     /**
      * The resources of a patched apk.

src/main/kotlin/app/revanced/patcher/PatchesConsumer.kt

@@ -1,10 +0,0 @@
-package app.revanced.patcher
-
-import app.revanced.patcher.patch.Patch
-
-@FunctionalInterface
-interface PatchesConsumer {
-    @Deprecated("Use acceptPatches(PatchSet) instead.", ReplaceWith("acceptPatches(patches.toSet())"))
-    fun acceptPatches(patches: List<Patch<*>>) = acceptPatches(patches.toSet())
-    fun acceptPatches(patches: PatchSet)
-}