Forms api backwards compatibility validation (#345)

* add api file and bcv support

* ignore ComposableSingleton classes

* update api file

* add todo

---------

Co-authored-by: Soren Roth <sor10874@esri.com>

Author: sorenoid

build.gradle.kts

@@ -20,6 +20,7 @@
 plugins {
     alias(libs.plugins.android.application) apply false
     alias(libs.plugins.android.library) apply false
+    alias(libs.plugins.binary.compatibility.validator) apply false
     alias(libs.plugins.kotlin.android) apply false
     alias(libs.plugins.gradle.secrets) apply false
     alias(libs.plugins.kapt) apply false

gradle/libs.versions.toml

@@ -11,6 +11,7 @@ androidxLifecycle = "2.6.2"
 androidxMaterialIcons = "1.4.3"
 androidxTestExt = "1.1.5"
 androidxWindow = "1.2.0"
+binaryCompatibilityValidator = "0.14.0"
 compileSdk = "34"
 compose-navigation = "2.7.5"
 dokka = "1.9.10"
@@ -72,6 +73,7 @@ dokka-versioning = { group = "org.jetbrains.dokka", name = "versioning-plugin",
 [plugins]
 android-application = { id = "com.android.application", version.ref = "androidGradlePlugin" }
 android-library = { id = "com.android.library", version.ref = "androidGradlePlugin" }
+binary-compatibility-validator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version.ref = "binaryCompatibilityValidator"}
 dokka = { id = "org.jetbrains.dokka", version.ref = "dokka" }
 hilt = { id = "com.google.dagger.hilt.android", version.ref = "hilt" }
 kapt = { id = "org.jetbrains.kotlin.kapt", version.ref = "kotlin" }

toolkit/featureforms/api/featureforms.api

@@ -0,0 +1,18 @@
+public final class com/arcgismaps/toolkit/featureforms/FeatureFormKt {
+	public static final fun FeatureForm (Lcom/arcgismaps/mapping/featureforms/FeatureForm;Landroidx/compose/ui/Modifier;Lcom/arcgismaps/toolkit/featureforms/ValidationErrorVisibility;Landroidx/compose/runtime/Composer;II)V
+}
+
+public abstract class com/arcgismaps/toolkit/featureforms/ValidationErrorVisibility {
+	public static final field $stable I
+}
+
+public final class com/arcgismaps/toolkit/featureforms/ValidationErrorVisibility$Automatic : com/arcgismaps/toolkit/featureforms/ValidationErrorVisibility {
+	public static final field $stable I
+	public static final field INSTANCE Lcom/arcgismaps/toolkit/featureforms/ValidationErrorVisibility$Automatic;
+}
+
+public final class com/arcgismaps/toolkit/featureforms/ValidationErrorVisibility$Visible : com/arcgismaps/toolkit/featureforms/ValidationErrorVisibility {
+	public static final field $stable I
+	public static final field INSTANCE Lcom/arcgismaps/toolkit/featureforms/ValidationErrorVisibility$Visible;
+}
+

toolkit/featureforms/build.gradle.kts

@@ -3,6 +3,7 @@ plugins {
     id("org.jetbrains.kotlin.android")
     id("artifact-deploy")
     id("com.google.android.libraries.mapsplatform.secrets-gradle-plugin")
+    alias(libs.plugins.binary.compatibility.validator) apply true
 }
 
 secrets {
@@ -50,6 +51,27 @@ android {
     }
 }
 
+apiValidation {
+    ignoredClasses.add("com.arcgismaps.toolkit.featureforms.BuildConfig")
+    // todo: remove when this is resolved https://github.com/Kotlin/binary-compatibility-validator/issues/74
+    // compose compiler generates public singletons for internal compose functions. this may be resolved in the compose
+    // compiler.
+    val composableSingletons = listOf(
+        "com.arcgismaps.toolkit.featureforms.components.base.ComposableSingletons\$BaseTextFieldKt",
+        "com.arcgismaps.toolkit.featureforms.components.codedvalue.ComposableSingletons\$ComboBoxFieldKt",
+        "com.arcgismaps.toolkit.featureforms.components.codedvalue.ComposableSingletons\$RadioButtonFieldKt",
+        "com.arcgismaps.toolkit.featureforms.components.datetime.ComposableSingletons\$DateTimeFieldKt",
+        "com.arcgismaps.toolkit.featureforms.components.datetime.picker.ComposableSingletons\$DateTimePickerKt",
+        "com.arcgismaps.toolkit.featureforms.components.datetime.picker.date.ComposableSingletons\$DatePickerKt",
+        "com.arcgismaps.toolkit.featureforms.components.datetime.picker.time.ComposableSingletons\$TimePickerKt",
+        "com.arcgismaps.toolkit.featureforms.components.formelement.ComposableSingletons\$AttachmentFormElementKt",
+        "com.arcgismaps.toolkit.featureforms.components.formelement.ComposableSingletons\$GroupElementKt"
+    )
+    
+    ignoredClasses.addAll(composableSingletons)
+}
+
+
 dependencies {
     api(arcgis.mapsSdk)
     implementation(platform(libs.coil.bom))