@constructor-io/constructorio-node 5.3.1 → 5.4.0

package/package.json

@@ -1,12 +1,11 @@
 {
   "name": "@constructor-io/constructorio-node",
-  "version": "5.3.1",
+  "version": "5.4.0",
   "description": "Constructor.io Node.js client",
   "main": "src/constructorio.js",
   "types": "src/types/constructorio.d.ts",
   "scripts": {
-    "verify-node-version": "chmod +x ./scripts/verify-node-version.sh && ./scripts/verify-node-version.sh",
-    "version": "npm run verify-node-version && npm run docs && git add ./docs/*",
+    "version": "npm run docs && git add ./docs/*",
     "check-license": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;MIT;0BSD;BSD-2-Clause'",
     "lint": "eslint 'src/**/*.js' 'spec/**/*.js' 'src/**/*.d.ts'",
     "test:parallel": "mkdir -p test && cp -rf src/* test && mocha --retries 3 --parallel ./spec/*",
@@ -64,5 +63,9 @@
   },
   "tsd": {
     "directory": "src/types/tests"
+  },
+  "volta": {
+    "node": "22.18.0",
+    "npm": "10.9.3"
   }
 }

package/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

package/src/types/index.d.ts

@@ -164,6 +164,7 @@ export interface ItemData extends Record<string, any> {
   keywords?: string[];
   url?: string;
   image_url?: string;
+  /** @deprecated This field is deprecated and will be removed in a future version. */
   facets?: Record<string, string[] | number[]>;
   group_ids?: string[];
   description?: string;

package/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>;