From fb5f196d5d2d9e3dbb2624de955e70cc720f75d1 Mon Sep 17 00:00:00 2001 From: Zac Sweers Date: Thu, 6 Jun 2024 15:08:10 -0400 Subject: [PATCH] Exclude internal APIs from API dump --- build.gradle.kts | 1 + eithernet/api/eithernet.api | 11 ----------- eithernet/api/eithernet.klib.api | 9 --------- eithernet/test-fixtures/api/test-fixtures.api | 1 - eithernet/test-fixtures/api/test-fixtures.klib.api | 1 - 5 files changed, 1 insertion(+), 22 deletions(-) diff --git a/build.gradle.kts b/build.gradle.kts index 8f3b4f6..eda7322 100644 --- a/build.gradle.kts +++ b/build.gradle.kts @@ -40,6 +40,7 @@ plugins { apiValidation { @OptIn(ExperimentalBCVApi::class) klib.enabled = true + nonPublicMarkers += "com.slack.eithernet.InternalEitherNetApi" } tasks.dokkaHtmlMultiModule { diff --git a/eithernet/api/eithernet.api b/eithernet/api/eithernet.api index 975d37c..20da2f5 100644 --- a/eithernet/api/eithernet.api +++ b/eithernet/api/eithernet.api @@ -1,12 +1,10 @@ public final class com/slack/eithernet/AnnotationsKt { - public static final fun createStatusCode (I)Lcom/slack/eithernet/StatusCode; public static final fun errorType ([Ljava/lang/annotation/Annotation;)Lkotlin/Pair; public static final fun statusCode ([Ljava/lang/annotation/Annotation;)Lkotlin/Pair; public static final fun toKType (Lcom/slack/eithernet/ResultType;)Lkotlin/reflect/KType; } public final class com/slack/eithernet/Annotations_jvmKt { - public static final fun createResultType (Ljava/lang/reflect/Type;)Lcom/slack/eithernet/ResultType; public static final fun toType (Lcom/slack/eithernet/ResultType;)Ljava/lang/reflect/Type; } @@ -35,33 +33,27 @@ public abstract interface class com/slack/eithernet/ApiResult$Failure : com/slac } public final class com/slack/eithernet/ApiResult$Failure$ApiFailure : com/slack/eithernet/ApiResult$Failure { - public fun (Ljava/lang/Object;Ljava/util/Map;)V public final fun getError ()Ljava/lang/Object; public final fun withTags (Ljava/util/Map;)Lcom/slack/eithernet/ApiResult$Failure$ApiFailure; } public final class com/slack/eithernet/ApiResult$Failure$HttpFailure : com/slack/eithernet/ApiResult$Failure { - public fun (ILjava/lang/Object;Ljava/util/Map;)V public final fun getCode ()I public final fun getError ()Ljava/lang/Object; public final fun withTags (Ljava/util/Map;)Lcom/slack/eithernet/ApiResult$Failure$HttpFailure; } public final class com/slack/eithernet/ApiResult$Failure$NetworkFailure : com/slack/eithernet/ApiResult$Failure { - public fun (Ljava/io/IOException;Ljava/util/Map;)V public final fun getError ()Ljava/io/IOException; public final fun withTags (Ljava/util/Map;)Lcom/slack/eithernet/ApiResult$Failure$NetworkFailure; } public final class com/slack/eithernet/ApiResult$Failure$UnknownFailure : com/slack/eithernet/ApiResult$Failure { - public fun (Ljava/lang/Throwable;Ljava/util/Map;)V public final fun getError ()Ljava/lang/Throwable; public final fun withTags (Ljava/util/Map;)Lcom/slack/eithernet/ApiResult$Failure$UnknownFailure; } public final class com/slack/eithernet/ApiResult$Success : com/slack/eithernet/ApiResult { - public fun (Ljava/lang/Object;Ljava/util/Map;)V - public final fun getTags ()Ljava/util/Map; public final fun getValue ()Ljava/lang/Object; public final fun withTags (Ljava/util/Map;)Lcom/slack/eithernet/ApiResult$Success; } @@ -92,7 +84,6 @@ public abstract interface annotation class com/slack/eithernet/InternalEitherNet public final class com/slack/eithernet/KTypesKt { public static final fun canonicalize (Lkotlin/reflect/KType;)Lkotlin/reflect/KType; - public static final fun isFunctionallyEqualTo (Lkotlin/reflect/KType;Lkotlin/reflect/KType;)Z } public abstract interface annotation class com/slack/eithernet/ResultType : java/lang/annotation/Annotation { @@ -133,8 +124,6 @@ public final class com/slack/eithernet/TypesKt { } public final class com/slack/eithernet/Util { - public static final fun canonicalize (Ljava/lang/reflect/Type;)Ljava/lang/reflect/Type; - public static final fun removeSubtypeWildcard (Ljava/lang/reflect/Type;)Ljava/lang/reflect/Type; public static final fun resolve (Ljava/lang/reflect/Type;Ljava/lang/reflect/Type;Ljava/lang/Class;)Ljava/lang/reflect/Type; } diff --git a/eithernet/api/eithernet.klib.api b/eithernet/api/eithernet.klib.api index e0fa01d..0e9ba70 100644 --- a/eithernet/api/eithernet.klib.api +++ b/eithernet/api/eithernet.klib.api @@ -13,13 +13,11 @@ final class com.slack.eithernet/ApiException : kotlin/Exception { // com.slack.e } final fun (com.slack.eithernet/ResultType).com.slack.eithernet/toKType(): kotlin.reflect/KType // com.slack.eithernet/toKType|toKType@com.slack.eithernet.ResultType(){}[0] final fun (kotlin.reflect/KType).com.slack.eithernet/canonicalize(): kotlin.reflect/KType // com.slack.eithernet/canonicalize|canonicalize@kotlin.reflect.KType(){}[0] -final fun (kotlin.reflect/KType?).com.slack.eithernet/isFunctionallyEqualTo(kotlin.reflect/KType?): kotlin/Boolean // com.slack.eithernet/isFunctionallyEqualTo|isFunctionallyEqualTo@kotlin.reflect.KType?(kotlin.reflect.KType?){}[0] final fun (kotlin/Array).com.slack.eithernet/errorType(): kotlin/Pair>? // com.slack.eithernet/errorType|errorType@kotlin.Array(){}[0] final fun (kotlin/Array).com.slack.eithernet/statusCode(): kotlin/Pair>? // com.slack.eithernet/statusCode|statusCode@kotlin.Array(){}[0] final fun <#A: kotlin/Any, #B: kotlin/Any> (com.slack.eithernet/ApiResult<#A, #B>).com.slack.eithernet/successOrNull(): #A? // com.slack.eithernet/successOrNull|successOrNull@com.slack.eithernet.ApiResult<0:0,0:1>(){0§;1§}[0] final fun <#A: kotlin/Any> (com.slack.eithernet/ApiResult.Failure<#A>).com.slack.eithernet/exceptionOrNull(): kotlin/Throwable? // com.slack.eithernet/exceptionOrNull|exceptionOrNull@com.slack.eithernet.ApiResult.Failure<0:0>(){0§}[0] final fun <#A: kotlin/Any> (com.slack.eithernet/ApiResult<*, *>).com.slack.eithernet/tag(kotlin.reflect/KClass<#A>): #A? // com.slack.eithernet/tag|tag@com.slack.eithernet.ApiResult<*,*>(kotlin.reflect.KClass<0:0>){0§}[0] -final fun com.slack.eithernet/createStatusCode(kotlin/Int): com.slack.eithernet/StatusCode // com.slack.eithernet/createStatusCode|createStatusCode(kotlin.Int){}[0] final inline fun <#A: kotlin/Any, #B: kotlin/Any, #C: kotlin/Any?> (com.slack.eithernet/ApiResult<#A, #B>).com.slack.eithernet/fold(kotlin/Function1<#A, #C>, kotlin/Function1, kotlin/Function1, kotlin/Function1, #C>, kotlin/Function1, #C>): #C // com.slack.eithernet/fold|fold@com.slack.eithernet.ApiResult<0:0,0:1>(kotlin.Function1<0:0,0:2>;kotlin.Function1;kotlin.Function1;kotlin.Function1,0:2>;kotlin.Function1,0:2>){0§;1§;2§}[0] final inline fun <#A: kotlin/Any, #B: kotlin/Any, #C: kotlin/Any?> (com.slack.eithernet/ApiResult<#A, #B>).com.slack.eithernet/fold(noinline kotlin/Function1<#A, #C>, noinline kotlin/Function1, #C>): #C // com.slack.eithernet/fold|fold@com.slack.eithernet.ApiResult<0:0,0:1>(kotlin.Function1<0:0,0:2>;kotlin.Function1,0:2>){0§;1§;2§}[0] final inline fun <#A: kotlin/Any, #B: kotlin/Any> (com.slack.eithernet/ApiResult<#A, #B>).com.slack.eithernet/onApiFailure(kotlin/Function1, kotlin/Unit>): com.slack.eithernet/ApiResult<#A, #B> // com.slack.eithernet/onApiFailure|onApiFailure@com.slack.eithernet.ApiResult<0:0,0:1>(kotlin.Function1,kotlin.Unit>){0§;1§}[0] @@ -59,10 +57,7 @@ open annotation class com.slack.eithernet/StatusCode : kotlin/Annotation { // co } sealed interface <#A: out kotlin/Any, #B: out kotlin/Any> com.slack.eithernet/ApiResult { // com.slack.eithernet/ApiResult|null[0] final class <#A1: kotlin/Any> Success : com.slack.eithernet/ApiResult<#A1, kotlin/Nothing> { // com.slack.eithernet/ApiResult.Success|null[0] - constructor (#A1, kotlin.collections/Map, kotlin/Any>) // com.slack.eithernet/ApiResult.Success.|(1:0;kotlin.collections.Map,kotlin.Any>){}[0] final fun withTags(kotlin.collections/Map, kotlin/Any>): com.slack.eithernet/ApiResult.Success<#A1> // com.slack.eithernet/ApiResult.Success.withTags|withTags(kotlin.collections.Map,kotlin.Any>){}[0] - final val tags // com.slack.eithernet/ApiResult.Success.tags|{}tags[0] - final fun (): kotlin.collections/Map, kotlin/Any> // com.slack.eithernet/ApiResult.Success.tags.|(){}[0] final val value // com.slack.eithernet/ApiResult.Success.value|{}value[0] final fun (): #A1 // com.slack.eithernet/ApiResult.Success.value.|(){}[0] } @@ -77,13 +72,11 @@ sealed interface <#A: out kotlin/Any, #B: out kotlin/Any> com.slack.eithernet/Ap } sealed interface <#A1: kotlin/Any> Failure : com.slack.eithernet/ApiResult { // com.slack.eithernet/ApiResult.Failure|null[0] final class <#A2: kotlin/Any> ApiFailure : com.slack.eithernet/ApiResult.Failure<#A2> { // com.slack.eithernet/ApiResult.Failure.ApiFailure|null[0] - constructor (#A2?, kotlin.collections/Map, kotlin/Any>) // com.slack.eithernet/ApiResult.Failure.ApiFailure.|(1:0?;kotlin.collections.Map,kotlin.Any>){}[0] final fun withTags(kotlin.collections/Map, kotlin/Any>): com.slack.eithernet/ApiResult.Failure.ApiFailure<#A2> // com.slack.eithernet/ApiResult.Failure.ApiFailure.withTags|withTags(kotlin.collections.Map,kotlin.Any>){}[0] final val error // com.slack.eithernet/ApiResult.Failure.ApiFailure.error|{}error[0] final fun (): #A2? // com.slack.eithernet/ApiResult.Failure.ApiFailure.error.|(){}[0] } final class <#A2: kotlin/Any> HttpFailure : com.slack.eithernet/ApiResult.Failure<#A2> { // com.slack.eithernet/ApiResult.Failure.HttpFailure|null[0] - constructor (kotlin/Int, #A2?, kotlin.collections/Map, kotlin/Any>) // com.slack.eithernet/ApiResult.Failure.HttpFailure.|(kotlin.Int;1:0?;kotlin.collections.Map,kotlin.Any>){}[0] final fun withTags(kotlin.collections/Map, kotlin/Any>): com.slack.eithernet/ApiResult.Failure.HttpFailure<#A2> // com.slack.eithernet/ApiResult.Failure.HttpFailure.withTags|withTags(kotlin.collections.Map,kotlin.Any>){}[0] final val code // com.slack.eithernet/ApiResult.Failure.HttpFailure.code|{}code[0] final fun (): kotlin/Int // com.slack.eithernet/ApiResult.Failure.HttpFailure.code.|(){}[0] @@ -91,13 +84,11 @@ sealed interface <#A: out kotlin/Any, #B: out kotlin/Any> com.slack.eithernet/Ap final fun (): #A2? // com.slack.eithernet/ApiResult.Failure.HttpFailure.error.|(){}[0] } final class NetworkFailure : com.slack.eithernet/ApiResult.Failure { // com.slack.eithernet/ApiResult.Failure.NetworkFailure|null[0] - constructor (okio/IOException, kotlin.collections/Map, kotlin/Any>) // com.slack.eithernet/ApiResult.Failure.NetworkFailure.|(okio.IOException;kotlin.collections.Map,kotlin.Any>){}[0] final fun withTags(kotlin.collections/Map, kotlin/Any>): com.slack.eithernet/ApiResult.Failure.NetworkFailure // com.slack.eithernet/ApiResult.Failure.NetworkFailure.withTags|withTags(kotlin.collections.Map,kotlin.Any>){}[0] final val error // com.slack.eithernet/ApiResult.Failure.NetworkFailure.error|{}error[0] final fun (): okio/IOException // com.slack.eithernet/ApiResult.Failure.NetworkFailure.error.|(){}[0] } final class UnknownFailure : com.slack.eithernet/ApiResult.Failure { // com.slack.eithernet/ApiResult.Failure.UnknownFailure|null[0] - constructor (kotlin/Throwable, kotlin.collections/Map, kotlin/Any>) // com.slack.eithernet/ApiResult.Failure.UnknownFailure.|(kotlin.Throwable;kotlin.collections.Map,kotlin.Any>){}[0] final fun withTags(kotlin.collections/Map, kotlin/Any>): com.slack.eithernet/ApiResult.Failure.UnknownFailure // com.slack.eithernet/ApiResult.Failure.UnknownFailure.withTags|withTags(kotlin.collections.Map,kotlin.Any>){}[0] final val error // com.slack.eithernet/ApiResult.Failure.UnknownFailure.error|{}error[0] final fun (): kotlin/Throwable // com.slack.eithernet/ApiResult.Failure.UnknownFailure.error.|(){}[0] diff --git a/eithernet/test-fixtures/api/test-fixtures.api b/eithernet/test-fixtures/api/test-fixtures.api index 5454a0f..765f2d3 100644 --- a/eithernet/test-fixtures/api/test-fixtures.api +++ b/eithernet/test-fixtures/api/test-fixtures.api @@ -9,7 +9,6 @@ public final class com/slack/eithernet/test/CreateEndpointKeyKt { public abstract interface class com/slack/eithernet/test/EitherNetController { public abstract fun assertNoMoreQueuedResults ()V public abstract fun getApi ()Ljava/lang/Object; - public abstract fun unsafeEnqueue (Lcom/slack/eithernet/test/EndpointKey;Lkotlin/jvm/functions/Function2;)V } public final class com/slack/eithernet/test/EitherNetControllersKt { diff --git a/eithernet/test-fixtures/api/test-fixtures.klib.api b/eithernet/test-fixtures/api/test-fixtures.klib.api index b64a4df..5a766b6 100644 --- a/eithernet/test-fixtures/api/test-fixtures.klib.api +++ b/eithernet/test-fixtures/api/test-fixtures.klib.api @@ -10,7 +10,6 @@ abstract fun interface com.slack.eithernet.test/ApiValidator { // com.slack.eith abstract fun validate(kotlin.reflect/KClass<*>, kotlin.reflect/KFunction<*>, kotlin.collections/MutableList) // com.slack.eithernet.test/ApiValidator.validate|validate(kotlin.reflect.KClass<*>;kotlin.reflect.KFunction<*>;kotlin.collections.MutableList){}[0] } abstract interface <#A: kotlin/Any> com.slack.eithernet.test/EitherNetController { // com.slack.eithernet.test/EitherNetController|null[0] - abstract fun <#A1: kotlin/Any, #B1: kotlin/Any> unsafeEnqueue(com.slack.eithernet.test/EndpointKey, kotlin.coroutines/SuspendFunction1, com.slack.eithernet/ApiResult<#A1, #B1>>) // com.slack.eithernet.test/EitherNetController.unsafeEnqueue|unsafeEnqueue(com.slack.eithernet.test.EndpointKey;kotlin.coroutines.SuspendFunction1,com.slack.eithernet.ApiResult<0:0,0:1>>){0§;1§}[0] abstract fun assertNoMoreQueuedResults() // com.slack.eithernet.test/EitherNetController.assertNoMoreQueuedResults|assertNoMoreQueuedResults(){}[0] abstract val api // com.slack.eithernet.test/EitherNetController.api|{}api[0] abstract fun (): #A // com.slack.eithernet.test/EitherNetController.api.|(){}[0]