Add skipTracking functionality to getQuizNextQuestion

esezen · esezen · commit 0d8e0e860796 · 2025-11-17T15:31:10.000+01:00
diff --git a/dist/constructorio-client-javascript-2.71.0.js b/dist/constructorio-client-javascript-2.71.0.js
diff --git a/docs/ConstructorIO.html b/docs/ConstructorIO.html
@@ -1745,7 +1745,7 @@ <h6>Properties</h6>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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
@@ -269,7 +269,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.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/module-agent.html b/docs/module-agent.html
@@ -512,7 +512,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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
@@ -410,7 +410,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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
@@ -851,7 +851,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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
@@ -3189,7 +3189,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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
@@ -78,7 +78,7 @@ <h1 class="page-title">quizzes</h1>
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_quizzes.js.html">modules/quizzes.js</a>, <a href="modules_quizzes.js.html#line102">line 102</a>
+        <a href="modules_quizzes.js.html">modules/quizzes.js</a>, <a href="modules_quizzes.js.html#line106">line 106</a>
     </li></ul></dd>
     
 
@@ -204,7 +204,7 @@ <h4 class="name" id="~getQuizAllQuestions"><span class="type-signature type-sign
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_quizzes.js.html">modules/quizzes.js</a>, <a href="modules_quizzes.js.html#line267">line 267</a>
+        <a href="modules_quizzes.js.html">modules/quizzes.js</a>, <a href="modules_quizzes.js.html#line272">line 272</a>
     </li></ul></dd>
     
 
@@ -633,7 +633,7 @@ <h4 class="name" id="~getQuizNextQuestion"><span class="type-signature type-sign
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_quizzes.js.html">modules/quizzes.js</a>, <a href="modules_quizzes.js.html#line115">line 115</a>
+        <a href="modules_quizzes.js.html">modules/quizzes.js</a>, <a href="modules_quizzes.js.html#line119">line 119</a>
     </li></ul></dd>
     
 
@@ -944,6 +944,40 @@ <h6>Properties</h6>
         </tr>
 
     
+
+        <tr>
+            
+                <td class="name"><code>skipTracking</code></td>
+            
+
+            <td class="type">
+            
+                
+<span class="param-type">boolean</span>
+
+
+
+            
+            </td>
+
+            
+                <td class="attributes">
+                
+                    &lt;optional><br>
+                
+
+                
+
+                
+                </td>
+            
+
+            
+
+            <td class="description last">If true, tracking for this question will be skipped. This is useful for preloading the first question of a quiz</td>
+        </tr>
+
+    
     </tbody>
 </table>
 
@@ -1108,7 +1142,7 @@ <h4 class="name" id="~getQuizResults"><span class="type-signature type-signature
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_quizzes.js.html">modules/quizzes.js</a>, <a href="modules_quizzes.js.html#line166">line 166</a>
+        <a href="modules_quizzes.js.html">modules/quizzes.js</a>, <a href="modules_quizzes.js.html#line171">line 171</a>
     </li></ul></dd>
     
 
@@ -1749,7 +1783,7 @@ <h4 class="name" id="~getQuizResultsConfig"><span class="type-signature type-sig
     
     <dt class="tag-source">Source:</dt>
     <dd class="tag-source"><ul class="dummy"><li>
-        <a href="modules_quizzes.js.html">modules/quizzes.js</a>, <a href="modules_quizzes.js.html#line222">line 222</a>
+        <a href="modules_quizzes.js.html">modules/quizzes.js</a>, <a href="modules_quizzes.js.html#line227">line 227</a>
     </li></ul></dd>
     
 
@@ -2143,7 +2177,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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
@@ -851,7 +851,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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
@@ -690,7 +690,7 @@ <h6>Properties</h6>
                 </td>
             
 
-            <td class="description last">The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/search-search-resultsqueries for details</td>
+            <td class="description last">The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results#query-params for details</td>
         </tr>
 
     
@@ -880,7 +880,7 @@ <h6>Properties</h6>
                 </td>
             
 
-            <td class="description last">Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results</td>
+            <td class="description last">Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results#query-params</td>
         </tr>
 
     
@@ -918,7 +918,7 @@ <h6>Properties</h6>
                 </td>
             
 
-            <td class="description last">An object specifying whether results must match `all`, `any` or `none` of a given filter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results</td>
+            <td class="description last">An object specifying whether results must match `all`, `any` or `none` of a given filter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results#query-params</td>
         </tr>
 
     
@@ -1446,7 +1446,7 @@ <h6>Properties</h6>
                 </td>
             
 
-            <td class="description last">The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/search-search-resultsqueries for details</td>
+            <td class="description last">The format options used to refine result groups. Please refer to https://docs.constructor.com/reference/v1-search-get-natural-language-search-results#query-params for details</td>
         </tr>
 
     
@@ -1636,7 +1636,7 @@ <h6>Properties</h6>
                 </td>
             
 
-            <td class="description last">Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-search-results</td>
+            <td class="description last">Parameters listed above can be serialized into a JSON object and parsed through this parameter. Please refer to https://docs.constructor.com/reference/v1-search-get-natural-language-search-results#query-params</td>
         </tr>
 
     
@@ -1803,7 +1803,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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
@@ -20327,7 +20327,7 @@ <h5 class="h5-returns">Returns:</h5>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
 </footer>
 
 <script>prettyPrint();</script>
diff --git a/docs/modules_agent.js.html b/docs/modules_agent.js.html
@@ -248,7 +248,7 @@ <h1 class="page-title">modules/agent.js</h1>
 <br class="clear">
 
 <footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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
@@ -101,7 +101,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.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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
@@ -591,7 +591,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.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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
@@ -91,7 +91,7 @@ <h1 class="page-title">modules/quizzes.js</h1>
   }
 
   if (parameters) {
-    const { section, answers, quizSessionId, quizVersionId, page, resultsPerPage, filters, fmtOptions, hiddenFields } = parameters;
+    const { section, answers, quizSessionId, quizVersionId, page, resultsPerPage, filters, fmtOptions, hiddenFields, skipTracking } = parameters;
 
     // Pull section from parameters
     if (section) {
@@ -138,6 +138,10 @@ <h1 class="page-title">modules/quizzes.js</h1>
         queryParams.fmt_options = { hidden_fields: hiddenFields };
       }
     }
+
+    if (skipTracking) {
+      queryParams.skip_tracking = skipTracking;
+    }
   }
 
   queryParams._dt = Date.now();
@@ -172,6 +176,7 @@ <h1 class="page-title">modules/quizzes.js</h1>
    * @param {array} [parameters.answers] - An array of answers in the format [[1,2], [1], ["true"], ["seen"], [""]]. Based on the question type, answers should either be an integer, "true"/"false", "seen" or an empty string ("") if skipped
    * @param {string} [parameters.quizVersionId] - Version identifier for the quiz. Version ID will be returned with the first request and it should be passed with subsequent requests. More information can be found: https://docs.constructor.com/reference/configuration-quizzes
    * @param {string} [parameters.quizSessionId] - Session identifier for the quiz. Session ID will be returned with the first request and it should be passed with subsequent requests. More information can be found: https://docs.constructor.com/reference/configuration-quizzes
+   * @param {boolean} [parameters.skipTracking] - If true, tracking for this question will be skipped. This is useful for preloading the first question of a quiz
    * @param {object} [networkParameters] - Parameters relevant to the network request
    * @param {number} [networkParameters.timeout] - Request timeout (in milliseconds)
    * @returns {Promise}
@@ -375,7 +380,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.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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
@@ -243,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.4</a> on Wed Oct 22 2025 19:15:54 GMT+0300 (GMT+03:00) 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.4</a> on Mon Nov 17 2025 15:31:05 GMT+0100 (Central European Standard Time) 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
