Merge pull request #362 from Ecwid/ECWID-116234_ApiClient-change

ECWID-116234 Implement alt-text support for all category images | Add alt property in for category image
Ecwid · Jan 24, 2024 · 5c009e5 · 5c009e5
2 parents 2ae67c1 + 185bac3
commit 5c009e5
Show file tree

Hide file tree

Showing 9 changed files with 40 additions and 25 deletions.
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/converter/FetchedCategory.kt b/src/main/kotlin/com/ecwid/apiclient/v3/converter/FetchedCategory.kt
@@ -17,6 +17,7 @@ fun FetchedCategory.toUpdated(): UpdatedCategory {
 		seoTitle = seoTitle,
 		seoTitleTranslated = seoTitleTranslated,
 		seoDescription = seoDescription,
-		seoDescriptionTranslated = seoDescriptionTranslated
+		seoDescriptionTranslated = seoDescriptionTranslated,
+		alt = alt?.toUpdated(),
 	)
 }
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/converter/FetchedProduct.kt b/src/main/kotlin/com/ecwid/apiclient/v3/converter/FetchedProduct.kt
@@ -224,11 +224,6 @@ fun FetchedProduct.ProductImage.toUpdated() = UpdatedProduct.ProductImage(
 	alt = alt?.toUpdated()
 )
 
-fun FetchedProduct.ProductImage.Alt.toUpdated() = UpdatedProduct.ProductImage.Alt(
-	main = main,
-	translated = translated
-)
-
 fun FetchedProduct.TaxInfo.toUpdated() = UpdatedProduct.TaxInfo(
 	taxable = taxable,
 	enabledManualTaxes = enabledManualTaxes,

diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/dto/category/request/UpdatedCategory.kt b/src/main/kotlin/com/ecwid/apiclient/v3/dto/category/request/UpdatedCategory.kt
@@ -4,6 +4,7 @@ import com.ecwid.apiclient.v3.dto.category.result.FetchedCategory
 import com.ecwid.apiclient.v3.dto.common.ApiUpdatedDTO
 import com.ecwid.apiclient.v3.dto.common.ApiUpdatedDTO.ModifyKind
 import com.ecwid.apiclient.v3.dto.common.LocalizedValueMap
+import com.ecwid.apiclient.v3.dto.common.UpdatedAlt
 
 data class UpdatedCategory(
 	val parentId: Int? = null,
@@ -18,8 +19,10 @@ data class UpdatedCategory(
 	val seoTitle: String? = null,
 	val seoTitleTranslated: LocalizedValueMap? = null,
 	val seoDescription: String? = null,
-	val seoDescriptionTranslated: LocalizedValueMap? = null
+	val seoDescriptionTranslated: LocalizedValueMap? = null,
+	val alt: UpdatedAlt? = null
 ) : ApiUpdatedDTO {
 
 	override fun getModifyKind() = ModifyKind.ReadWrite(FetchedCategory::class)
+
 }
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/dto/category/result/FetchedCategory.kt b/src/main/kotlin/com/ecwid/apiclient/v3/dto/category/result/FetchedCategory.kt
@@ -4,6 +4,7 @@ import com.ecwid.apiclient.v3.dto.category.request.UpdatedCategory
 import com.ecwid.apiclient.v3.dto.common.ApiFetchedDTO
 import com.ecwid.apiclient.v3.dto.common.ApiFetchedDTO.ModifyKind
 import com.ecwid.apiclient.v3.dto.common.ApiResultDTO
+import com.ecwid.apiclient.v3.dto.common.FetchedAlt
 import com.ecwid.apiclient.v3.dto.common.LocalizedValueMap
 import com.ecwid.apiclient.v3.dto.common.PictureInfo
 
@@ -32,8 +33,10 @@ data class FetchedCategory(
 	val seoTitle: String? = null,
 	val seoTitleTranslated: LocalizedValueMap? = null,
 	val seoDescription: String? = null,
-	val seoDescriptionTranslated: LocalizedValueMap? = null
+	val seoDescriptionTranslated: LocalizedValueMap? = null,
+	val alt: FetchedAlt? = null
 ) : ApiFetchedDTO, ApiResultDTO {
 
 	override fun getModifyKind() = ModifyKind.ReadWrite(UpdatedCategory::class)
+
 }
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/dto/common/Alt.kt b/src/main/kotlin/com/ecwid/apiclient/v3/dto/common/Alt.kt
@@ -0,0 +1,18 @@
+package com.ecwid.apiclient.v3.dto.common
+
+data class FetchedAlt(
+	val main: String? = null,
+	val translated: LocalizedValueMap? = null,
+) {
+	fun toUpdated(): UpdatedAlt {
+		return UpdatedAlt(
+			main = main,
+			translated = translated
+		)
+	}
+}
+
+data class UpdatedAlt(
+	val main: String? = null,
+	val translated: LocalizedValueMap? = null,
+)
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/dto/product/request/UpdatedProduct.kt b/src/main/kotlin/com/ecwid/apiclient/v3/dto/product/request/UpdatedProduct.kt
@@ -373,13 +373,8 @@ data class UpdatedProduct(
 	data class ProductImage(
 		val id: String = "0",
 		val orderBy: Int = 0,
-		val alt: Alt? = null
-	) {
-		data class Alt(
-			val main: String? = null,
-			val translated: LocalizedValueMap? = null
-		)
-	}
+		val alt: UpdatedAlt? = null
+	)
 
 	override fun getModifyKind() = ModifyKind.ReadWrite(FetchedProduct::class)
 }
diff --git a/src/main/kotlin/com/ecwid/apiclient/v3/dto/product/result/FetchedProduct.kt b/src/main/kotlin/com/ecwid/apiclient/v3/dto/product/result/FetchedProduct.kt
@@ -345,13 +345,8 @@ data class FetchedProduct(
 		val image800pxUrl: String? = null,
 		val image1500pxUrl: String? = null,
 		val imageOriginalUrl: String? = null,
-		val alt: Alt? = null
-	) {
-		data class Alt(
-			val main: String? = null,
-			val translated: LocalizedValueMap? = null
-		)
-	}
+		val alt: FetchedAlt? = null
+	)
 
 	data class ProductVideo(
 		val id: String = "0",

diff --git a/src/test/kotlin/com/ecwid/apiclient/v3/rule/nullablepropertyrules/FetchedCategoryRules.kt b/src/test/kotlin/com/ecwid/apiclient/v3/rule/nullablepropertyrules/FetchedCategoryRules.kt
@@ -1,6 +1,7 @@
 package com.ecwid.apiclient.v3.rule.nullablepropertyrules
 
 import com.ecwid.apiclient.v3.dto.category.result.FetchedCategory
+import com.ecwid.apiclient.v3.dto.common.FetchedAlt
 import com.ecwid.apiclient.v3.rule.NullablePropertyRule
 import com.ecwid.apiclient.v3.rule.NullablePropertyRule.AllowNullable
 import com.ecwid.apiclient.v3.rule.NullablePropertyRule.IgnoreNullable
@@ -25,5 +26,8 @@ val fetchedCategoryNullablePropertyRules: List<NullablePropertyRule<*, *>> = lis
 	AllowNullable(FetchedCategory::seoTitle),
 	AllowNullable(FetchedCategory::seoTitleTranslated),
 	AllowNullable(FetchedCategory::seoDescription),
-	AllowNullable(FetchedCategory::seoDescriptionTranslated)
+	AllowNullable(FetchedCategory::seoDescriptionTranslated),
+	AllowNullable(FetchedCategory::alt),
+	AllowNullable(FetchedAlt::main),
+	AllowNullable(FetchedAlt::translated),
 )
diff --git a/src/test/kotlin/com/ecwid/apiclient/v3/rule/nullablepropertyrules/FetchedProductRules.kt b/src/test/kotlin/com/ecwid/apiclient/v3/rule/nullablepropertyrules/FetchedProductRules.kt
@@ -1,5 +1,6 @@
 package com.ecwid.apiclient.v3.rule.nullablepropertyrules
 
+import com.ecwid.apiclient.v3.dto.common.FetchedAlt
 import com.ecwid.apiclient.v3.dto.product.result.FetchedProduct
 import com.ecwid.apiclient.v3.rule.NullablePropertyRule
 import com.ecwid.apiclient.v3.rule.NullablePropertyRule.AllowNullable
@@ -99,8 +100,8 @@ val fetchedProductNullablePropertyRules: List<NullablePropertyRule<*, *>> = list
 	IgnoreNullable(FetchedProduct.ProductImage::image800pxUrl),
 	IgnoreNullable(FetchedProduct.ProductImage::imageOriginalUrl),
 	AllowNullable(FetchedProduct.ProductImage::alt),
-	AllowNullable(FetchedProduct.ProductImage.Alt::main),
-	AllowNullable(FetchedProduct.ProductImage.Alt::translated),
+	AllowNullable(FetchedAlt::main),
+	AllowNullable(FetchedAlt::translated),
 	AllowNullable(FetchedProduct.ProductVideo::videoCoverId),
 	AllowNullable(FetchedProduct.ProductVideo::image160pxUrl),
 	AllowNullable(FetchedProduct.ProductVideo::image400pxUrl),