Merge pull request #18 from bloomreach/dev

Dev > main v1.0.13
bloomreach · Feb 6, 2024 · f161e39 · f161e39
2 parents 60299c2 + 09caf3d
commit f161e39
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 5 deletions.
diff --git a/build.gradle b/build.gradle
@@ -10,19 +10,19 @@ android {
         minSdk 24
         targetSdk 32
         versionCode 1
-        versionName "1.0.12"
+        versionName "1.0.13"
         testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
         consumerProguardFiles "consumer-rules.pro"
     }
     buildTypes {
         debug {
-            buildConfigField "String", 'SDK_VERSION', '"1.0.9"'
+            buildConfigField "String", 'SDK_VERSION', '"1.0.13"'
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
         }
 
         release {
-            buildConfigField "String", 'SDK_VERSION', '"1.0.9"'
+            buildConfigField "String", 'SDK_VERSION', '"1.0.13"'
             minifyEnabled false
             proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
         }

diff --git a/src/main/java/com/bloomreach/discovery/api/ApiConstants.kt b/src/main/java/com/bloomreach/discovery/api/ApiConstants.kt
@@ -52,8 +52,11 @@ internal object ApiConstants {
     const val FACET = "facet"
     const val FILTER = "filter"
     const val IMAGE_ID = "image_id"
+    const val FACET_VERSION = "facet.version"
 
     const val DEFAULT_FACET_FLAG = false
 
+    const val CATEGORY_TYPE = "category_type"
+    const val CATEGORY_TYPE_DYNAMIC = "dynamic"
 
 }
diff --git a/src/main/java/com/bloomreach/discovery/api/BrApi.kt b/src/main/java/com/bloomreach/discovery/api/BrApi.kt
@@ -43,6 +43,16 @@ object BrApi {
         apiProcessor.processCoreApi(categorySearchRequest.getMap(), brApiCompletionListener)
     }
 
+    /**
+     * Method for calling Dynamic Category Search API request
+     * @param categorySearchRequest Request Object required for Category Search API
+     * @param brApiCompletionListener Callback listener
+     */
+    fun dynamicCategorySearchApi(categorySearchRequest: CategorySearchRequest, brApiCompletionListener: BrApiCompletionListener) {
+        categorySearchRequest.setDynamicCategory()
+        categorySearchApi(categorySearchRequest, brApiCompletionListener)
+    }
+
     /**
      * Method for calling Content API request
      * @param contentSearchRequest Request Object required for Content Search API

diff --git a/src/main/java/com/bloomreach/discovery/api/request/CategorySearchRequest.kt b/src/main/java/com/bloomreach/discovery/api/request/CategorySearchRequest.kt
@@ -29,4 +29,12 @@ class CategorySearchRequest() : SearchRequest<CategorySearchRequest>() {
     private fun setSearchType(): CategorySearchRequest {
         return set(ApiConstants.SEARCH_TYPE, ApiConstants.SEARCH_TYPE_CATEGORY)
     }
+
+    /**
+     * Method to set hardcoded default parameters required for Category Search API
+     * @return  A reference request object
+     */
+    internal fun setDynamicCategory(): CategorySearchRequest {
+        return set(ApiConstants.CATEGORY_TYPE, ApiConstants.CATEGORY_TYPE_DYNAMIC)
+    }
 }
diff --git a/src/main/java/com/bloomreach/discovery/api/request/SearchRequest.kt b/src/main/java/com/bloomreach/discovery/api/request/SearchRequest.kt
@@ -492,4 +492,15 @@ sealed class SearchRequest<T>() : RequestMap<T>() {
     fun url(value: String): T {
         return set(ApiConstants.URL, value)
     }
+
+    /**
+     * Method to Facet Version
+     *
+     * @param value facet version eg: '3.0'
+     *
+     * @return  A reference to the current Request object
+     */
+    fun facetVersion(value: String): T {
+        return set(ApiConstants.FACET_VERSION, value)
+    }
 }
diff --git a/src/main/java/com/bloomreach/discovery/pixel/PixelTracker.kt b/src/main/java/com/bloomreach/discovery/pixel/PixelTracker.kt
@@ -147,7 +147,7 @@ object PixelTracker {
     }
 
     /**
-     * Method for sending the Category Search Page View Pixel
+     * Method for sending the Category Page View Pixel
      * @param ref Synthetic URL from referrer screen
      * @param title Screen name of the app view.
      * @param categoryId Unique category ID as referred to in the database/catalog. Bloomreach requires the cat_id field to be unique across your site.
@@ -373,7 +373,7 @@ object PixelTracker {
             // create pixel object based ob input
             val pixelObject = PixelObject(
                 type = PixelType.EVENT,
-                pType = PageType.PRODUCT_PAGE,
+                pType = PageType.SEARCH_PAGE,
                 group = GroupType.SUGGEST,
                 eType = "submit",
                 ref = ref,
@@ -401,6 +401,7 @@ object PixelTracker {
      * @param searchTerm User's typed search query submitted to search box
      * @param catalogs List of CatalogItem that are shown in the page.
      */
+    @Deprecated("This method will be removed in future version. Instead use suggestionEventPixel(ref, title,typedTerm, searchTerm, catalogs)")
     fun suggestionEventPixel(
         ref: String,
         title: String,
@@ -435,6 +436,43 @@ object PixelTracker {
         }
     }
 
+    /**
+     * Method for sending the Suggestion Event Pixel
+     * @param ref Synthetic URL from referrer screen
+     * @param title Screen name of the app view.
+     * @param typedTerm The display query (the one or more letters) that the user has actually typed.
+    This is NOT the suggested word or phrase.
+     * @param searchTerm User's typed search query submitted to search box
+     * @param catalogs List of CatalogItem that are shown in the page.
+     */
+    fun suggestionEventPixel(
+        ref: String,
+        title: String,
+        typedTerm: String,
+        searchTerm: String,
+        catalogs: List<CatalogItem>? = null
+    ) {
+        if (this::brPixel.isInitialized) {
+            // create pixel object based ob input
+            val pixelObject = PixelObject(
+                type = PixelType.EVENT,
+                pType = PageType.PRODUCT_PAGE,
+                group = GroupType.SUGGEST,
+                eType = "click",
+                ref = ref,
+                title = title,
+                searchTerm = searchTerm,
+                typedTerm = typedTerm,
+                catalogs = catalogs
+            )
+
+            // send pixel for further processing
+            pixelProcessor.processPixel(pixelObject)
+        } else {
+            Log.e(TAG, "Pixel Tracker not initialised")
+        }
+    }
+
     /**
      * Method for sending the Quick Event Pixel
      * @param ref Synthetic URL from referrer screen