Merge branch 'dev' into 'main'

DCONN-78: Support additional API parameters in Recommendations widgets See merge request engineering/sm/magento-discovery-connector!22
bloomreach · Oct 22, 2024 · 1f99e39 · 1f99e39
2 parents 512cfbf + f8966ef
commit 1f99e39
Show file tree

Hide file tree

Showing 12 changed files with 54 additions and 28 deletions.
diff --git a/Block/Widget/Recommendation.php b/Block/Widget/Recommendation.php
@@ -136,15 +136,19 @@ public function getWidgetJsonConfig()
         } else {
             $itemSkus = null;
         }
+
+        $additionalParams = htmlentities($this->getData('additional_parameters') ?? '');
+        $this->logger->debug("additional_parameters: ".$additionalParams);
         $response = [
-            'title'=>$this->getData('title'),
+            'title' => $this->getData('title'),
             'widget_id' => $this->getData('rec_widget_id'),
             'widget_type' => $this->getData('rec_widget_type'),
             'category_id' => $this->getData('category_id'),
-            'query'=> $this->getData('keyword_query'),
-            'item_ids'=> $itemSkus,
-            'products_visible'=> $this->getData('products_visible'),
-            'products_to_fetch'=> $this->getData('products_to_fetch')
+            'query' => $this->getData('keyword_query'),
+            'item_ids' => $itemSkus,
+            'products_visible' => $this->getData('products_visible'),
+            'products_to_fetch' => $this->getData('products_to_fetch'),
+            'additional_parameters' => $additionalParams,
         ];
         return $this->jsonSerializer->serialize($response);
     }

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,3 +1,9 @@
+## 1.8.2
+
+## Changed
+
+- [`CHANGED`]: Support additional API parameters in Recommendations widgets.
+
 ## 1.8.1
 
 ## Fixed

diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
   "name": "bloomreach/bloomreach-connector-magento",
   "description": "Bloomreach connector for autosuggest,collection and product search",
-  "version": "1.8.1",
+  "version": "1.8.2",
   "type": "magento2-module",
   "license": "proprietary",
   "authors": [

diff --git a/etc/widget.xml b/etc/widget.xml
@@ -81,6 +81,10 @@
                     </option>
                 </options>
             </parameter>
+            <parameter name="additional_parameters" xsi:type="text" required="false" visible="true">
+                <label translate="true">Additional Parameters</label>
+                <description>Additional API parameters. For example, "name1=value1&amp;name2=value2"</description>
+            </parameter>
         </parameters>
     </widget>
 </widgets>
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "magento-connector",
-  "version": "1.8.1",
+  "version": "1.8.2",
   "description": "NPM tools to aid in developing this connector application",
   "main": "index.js",
   "repository": {

diff --git a/view/frontend/web/js/autosuggest.js b/view/frontend/web/js/autosuggest.js
diff --git a/view/frontend/web/js/category.js b/view/frontend/web/js/category.js
diff --git a/view/frontend/web/js/events.js b/view/frontend/web/js/events.js
diff --git a/view/frontend/web/js/recommendations.js b/view/frontend/web/js/recommendations.js
diff --git a/view/frontend/web/js/search.js b/view/frontend/web/js/search.js
diff --git a/view/frontend/web/js/view/recommendation.js b/view/frontend/web/js/view/recommendation.js
@@ -26,6 +26,28 @@ define(["uiComponent", "Magento_Customer/js/customer-data","pathwaysRecomSdk"],
             getWidgetConfig: function () {
                 return this.widgetConfig;
             },
+            getWidgetDataAttrs: function () {
+                const attrs = {
+                    'data-id': this.widgetConfig.widget_id,
+                    'data-type': this.widgetConfig.widget_type,
+                    'data-title': this.getWidgetTitle(),
+                    'data-category-id': this.widgetConfig.category_id,
+                    'data-query': this.widgetConfig.query,
+                    'data-item-ids': this.widgetConfig.item_ids,
+                    'data-user-id': this.getCustomer().uniqueId,
+                    'data-number-of-items-to-show': this.widgetConfig.products_visible,
+                    'data-number-of-items-to-fetch': this.widgetConfig.products_to_fetch,
+                };
+                if (this.widgetConfig.additional_parameters) {
+                    //decode html entities except double quotes
+                    attrs['data-additional-params'] = this.widgetConfig.additional_parameters
+                        .replaceAll('&amp;', '&')
+                        .replaceAll('&#039;', "'")
+                        .replaceAll('&lt;', '<')
+                        .replaceAll('&gt;', '>');
+                }
+                return attrs;
+            },
             getCustomer: function () {
                 return this.customer();
             },

diff --git a/view/frontend/web/template/widget/recommendation.html b/view/frontend/web/template/widget/recommendation.html
@@ -7,17 +7,7 @@
 <div class="widget-blm-recomm-path-wrapper">
     <h2 data-bind="text: getWidgetTitle()"></h2>
     <div class="blm-recommendations-widget"
-         data-bind="attr: {
-     'data-id': getWidgetConfig().widget_id,
-     'data-type': getWidgetConfig().widget_type,
-     'data-title': getWidgetTitle(),
-     'data-category-id': getWidgetConfig().category_id,
-     'data-query': getWidgetConfig().query,
-     'data-item-ids': getWidgetConfig().item_ids,
-     'data-user-id': getCustomer().uniqueId,
-     'data-number-of-items-to-show': getWidgetConfig().products_visible,
-     'data-number-of-items-to-fetch': getWidgetConfig().products_to_fetch
-     }">
+         data-bind="attr: getWidgetDataAttrs()">
         <div afterRender="afterRender">...</div>
     </div>
 </div>