[NO-REF] - introduce skip_tracking param for quiz_next_question

spec/src/modules/quizzes.js

@@ -160,6 +160,19 @@ describe('ConstructorIO - Quizzes', () => {
       });
     });
 
+    it('Should skip tracking', () => {
+      const { quizzes } = new ConstructorIO({
+        apiKey: quizApiKey,
+        fetch: fetchSpy,
+      });
+
+      return quizzes.getQuizNextQuestion(validQuizId, { answers: validAnswers, skipTracking: true }).then(() => {
+        const requestedUrlParams = helpers.extractUrlParamsFromFetch(fetchSpy);
+
+        expect(requestedUrlParams).to.have.property('skip_tracking').to.equal('true');
+      });
+    });
+
     it('Should be rejected if an invalid quizId is provided', () => {
       const { quizzes } = new ConstructorIO({
         apiKey: quizApiKey,

src/modules/quizzes.js

@@ -44,7 +44,7 @@ function createQuizUrl(quizId, parameters, userParameters, options, path) {
   }
 
   if (parameters) {
-    const { section, answers, quizVersionId, quizSessionId, filters, resultsPerPage, page } = parameters;
+    const { section, answers, quizVersionId, quizSessionId, filters, resultsPerPage, page, skipTracking } = parameters;
 
     // Pull section from parameters
     if (section) {
@@ -61,6 +61,11 @@ function createQuizUrl(quizId, parameters, userParameters, options, path) {
       queryParams.quiz_session_id = quizSessionId;
     }
 
+    // Pull skip_tracking from parameters
+    if (skipTracking) {
+      queryParams.skip_tracking = skipTracking;
+    }
+
     if (!helpers.isNil(page)) {
       queryParams.page = page;
     }
@@ -112,6 +117,7 @@ class Quizzes {
    * @param {string} [parameters.section] - Product catalog section
    * @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 [here]{@link 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 [here]{@link 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} [userParameters] - Parameters relevant to the user request
    * @param {number} [userParameters.sessionId] - Session ID, utilized to personalize results
    * @param {string} [userParameters.clientId] - Client ID, utilized to personalize results

src/types/quizzes.d.ts

@@ -21,6 +21,10 @@ export interface QuizzesParameters {
   quizSessionId?: string;
 }
 
+export interface NextQuestionQuizzesParameters extends QuizzesParameters {
+  skipTracking?: boolean;
+}
+
 export interface QuizzesResultsParameters extends QuizzesParameters {
   answers: any[];
   page?: number;
@@ -35,7 +39,7 @@ declare class Quizzes {
 
   getQuizNextQuestion(
     quizId: string,
-    parameters?: QuizzesParameters,
+    parameters?: NextQuestionQuizzesParameters,
     userParameters?: UserParameters,
     networkParameters?: NetworkParameters
   ): Promise<NextQuestionResponse>;