Add support for fmt_options in recommendations request

esezen · esezen · commit 83683129efad · 2025-06-17T19:49:02.000+03:00
diff --git a/dist/constructorio-client-javascript-2.64.3.js b/dist/constructorio-client-javascript-2.64.3.js
diff --git a/dist/constructorio-client-javascript-2.65.0.js b/dist/constructorio-client-javascript-2.65.0.js
diff --git a/docs/ConstructorIO.html b/docs/ConstructorIO.html
@@ -1607,7 +1607,7 @@ <h6>Properties</h6>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/constructorio.js.html b/docs/constructorio.js.html
@@ -254,7 +254,7 @@ <h1 class="page-title">constructorio.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/index.html b/docs/index.html
@@ -114,7 +114,7 @@ <h2>Development / npm commands</h2>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-assistant.html b/docs/module-assistant.html
@@ -457,7 +457,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-autocomplete.html b/docs/module-autocomplete.html
@@ -798,7 +798,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-browse.html b/docs/module-browse.html
@@ -3216,7 +3216,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-quizzes.html b/docs/module-quizzes.html
@@ -1661,7 +1661,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-recommendations.html b/docs/module-recommendations.html
@@ -66,7 +66,7 @@ <h1 class="page-title">recommendations</h1>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_recommendations.js.html">modules/recommendations.js</a>, <a href="modules_recommendations.js.html#line93">line 93</a>
+        <a href="modules_recommendations.js.html">modules/recommendations.js</a>, <a href="modules_recommendations.js.html#line99">line 99</a>
     </li></ul></dd>
     
 
@@ -151,7 +151,7 @@ <h4 class="name" id="~getRecommendations"><span class="type-signature type-signa
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_recommendations.js.html">modules/recommendations.js</a>, <a href="modules_recommendations.js.html#line106">line 106</a>
+        <a href="modules_recommendations.js.html">modules/recommendations.js</a>, <a href="modules_recommendations.js.html#line112">line 112</a>
     </li></ul></dd>
     
 
@@ -568,6 +568,40 @@ <h6>Properties</h6>
 
     
 
+        <tr>
+            
+                <td class="name"><code>fmtOptions</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">object</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">An object containing options to format different aspects of the response. Please refer to https://docs.constructor.com/reference/v1-recommendations-get-pod-results for details</td>
+        </tr>
+
+    
+
         <tr>
             
                 <td class="name"><code>hiddenFields</code></td>
@@ -764,7 +798,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-search.html b/docs/module-search.html
@@ -1750,7 +1750,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-tracker.html b/docs/module-tracker.html
@@ -151,7 +151,7 @@ <h4 class="name" id="~on"><span class="type-signature type-signature-inner">(inn
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2767">line 2767</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2777">line 2777</a>
     </li></ul></dd>
     
 
@@ -339,7 +339,7 @@ <h4 class="name" id="~trackAssistantResultClick"><span class="type-signature typ
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2562">line 2562</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2572">line 2572</a>
     </li></ul></dd>
     
 
@@ -873,7 +873,7 @@ <h4 class="name" id="~trackAssistantResultLoadFinished"><span class="type-signat
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2502">line 2502</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2512">line 2512</a>
     </li></ul></dd>
     
 
@@ -1307,7 +1307,7 @@ <h4 class="name" id="~trackAssistantResultLoadStarted"><span class="type-signatu
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2446">line 2446</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2456">line 2456</a>
     </li></ul></dd>
     
 
@@ -1708,7 +1708,7 @@ <h4 class="name" id="~trackAssistantResultView"><span class="type-signature type
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2633">line 2633</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2643">line 2643</a>
     </li></ul></dd>
     
 
@@ -2210,7 +2210,7 @@ <h4 class="name" id="~trackAssistantSearchSubmit"><span class="type-signature ty
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2701">line 2701</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2711">line 2711</a>
     </li></ul></dd>
     
 
@@ -2678,7 +2678,7 @@ <h4 class="name" id="~trackAssistantSubmit"><span class="type-signature type-sig
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2393">line 2393</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2403">line 2403</a>
     </li></ul></dd>
     
 
@@ -3652,7 +3652,7 @@ <h4 class="name" id="~trackBrowseResultClick"><span class="type-signature type-s
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line1590">line 1590</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line1600">line 1600</a>
     </li></ul></dd>
     
 
@@ -4529,7 +4529,7 @@ <h4 class="name" id="~trackBrowseResultsLoaded"><span class="type-signature type
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line1457">line 1457</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line1467">line 1467</a>
     </li></ul></dd>
     
 
@@ -5946,7 +5946,7 @@ <h4 class="name" id="~trackGenericResultClick"><span class="type-signature type-
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line1860">line 1860</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line1870">line 1870</a>
     </li></ul></dd>
     
 
@@ -7635,7 +7635,7 @@ <h4 class="name" id="~trackQuizConversion"><span class="type-signature type-sign
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2233">line 2233</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2243">line 2243</a>
     </li></ul></dd>
     
 
@@ -8359,7 +8359,7 @@ <h4 class="name" id="~trackQuizResultClick"><span class="type-signature type-sig
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2064">line 2064</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line2074">line 2074</a>
     </li></ul></dd>
     
 
@@ -9118,7 +9118,7 @@ <h4 class="name" id="~trackQuizResultsLoaded"><span class="type-signature type-s
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line1935">line 1935</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line1945">line 1945</a>
     </li></ul></dd>
     
 
@@ -9759,7 +9759,7 @@ <h4 class="name" id="~trackRecommendationClick"><span class="type-signature type
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line1322">line 1322</a>
+        <a href="modules_tracker.js.html">modules/tracker.js</a>, <a href="modules_tracker.js.html#line1332">line 1332</a>
     </li></ul></dd>
     
 
@@ -10999,6 +10999,50 @@ <h6>Properties</h6>
         </tr>
 
     
+
+        <tr>
+            
+                <td class="name"><code>seedItemIds</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">Array.&lt;string></span>
+|
+
+<span class="param-type">string</span>
+|
+
+<span class="param-type">number</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+                <td class="default">
+                
+                </td>
+            
+
+            <td class="description last">Item ID(s) to be used as seed</td>
+        </tr>
+
+    
     </tbody>
 </table>
 
@@ -13149,7 +13193,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_assistant.js.html b/docs/modules_assistant.js.html
@@ -245,7 +245,7 @@ <h1 class="page-title">modules/assistant.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_autocomplete.js.html b/docs/modules_autocomplete.js.html
@@ -276,7 +276,7 @@ <h1 class="page-title">modules/autocomplete.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_browse.js.html b/docs/modules_browse.js.html
@@ -593,7 +593,7 @@ <h1 class="page-title">modules/browse.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_quizzes.js.html b/docs/modules_quizzes.js.html
@@ -329,7 +329,7 @@ <h1 class="page-title">modules/quizzes.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_recommendations.js.html b/docs/modules_recommendations.js.html
@@ -85,6 +85,7 @@ <h1 class="page-title">modules/recommendations.js</h1>
       variationsMap,
       hiddenFields,
       preFilterExpression,
+      fmtOptions,
     } = parameters;
 
     // Pull num results number from parameters
@@ -112,6 +113,11 @@ <h1 class="page-title">modules/recommendations.js</h1>
       queryParams.filters = filters;
     }
 
+    // Pull format options from parameters
+    if (fmtOptions) {
+      queryParams.fmt_options = fmtOptions;
+    }
+
     // Pull hidden fields from parameters
     if (hiddenFields) {
       if (queryParams.fmt_options) {
@@ -166,6 +172,7 @@ <h1 class="page-title">modules/recommendations.js</h1>
    * @param {object} [parameters.filters] - Key / value mapping of filters used to refine results
    * @param {object} [parameters.variationsMap] - The variations map object to aggregate variations. Please refer to https://docs.constructor.com/reference/shared-variations-mapping for details
    * @param {object} [parameters.preFilterExpression] - Faceting expression to scope search results. Please refer to https://docs.constructor.com/reference/configuration-collections
+   * @param {object} [parameters.fmtOptions] - An object containing options to format different aspects of the response. Please refer to https://docs.constructor.com/reference/v1-recommendations-get-pod-results for details
    * @param {string[]} [parameters.hiddenFields] - Hidden metadata fields to return
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
@@ -236,7 +243,7 @@ <h1 class="page-title">modules/recommendations.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Thu May 08 2025 14:58:11 GMT+0300 (Eastern European Summer Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a> on Tue Jun 17 2025 19:49:00 GMT+0300 (GMT+03:00) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_search.js.html b/docs/modules_search.js.html
diff --git a/docs/modules_tracker.js.html b/docs/modules_tracker.js.html
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
diff --git a/src/version.js b/src/version.js
