@constructor-io/constructorio-ui-quizzes 1.17.25 → 1.18.0

package/lib/cjs/components/CioQuiz/quizApiReducer.js

@@ -8,7 +8,7 @@ exports.initialState = {
     quizRequestState: constants_1.RequestStates.Stale,
 };
 function apiReducer(state, action) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r;
     switch (action.type) {
         case actions_1.QuizAPIActionTypes.SET_IS_LOADING:
             return Object.assign(Object.assign({}, state), { quizRequestState: constants_1.RequestStates.Loading, quizCurrentQuestion: undefined, quizResults: undefined });
@@ -36,10 +36,10 @@ function apiReducer(state, action) {
             return Object.assign(Object.assign({}, state), { quizRequestState: constants_1.RequestStates.Success, quizResults: (_o = action.payload) === null || _o === void 0 ? void 0 : _o.quizResults, quizCurrentQuestion: undefined, selectedOptionsWithAttributes: (_p = action.payload) === null || _p === void 0 ? void 0 : _p.quizResults.attributes });
         }
         case actions_1.QuizAPIActionTypes.SET_QUIZ_RESULTS_CONFIG: {
-            return Object.assign(Object.assign({}, state), { resultsConfig: (_q = action.payload) === null || _q === void 0 ? void 0 : _q.quizResultsConfig.results_config });
+            return Object.assign(Object.assign({}, state), { metadata: (_q = action.payload) === null || _q === void 0 ? void 0 : _q.quizResultsConfig.metadata, resultsConfig: (_r = action.payload) === null || _r === void 0 ? void 0 : _r.quizResultsConfig.results_config });
         }
         case actions_1.QuizAPIActionTypes.SET_QUIZ_RESULTS_CONFIG_ERROR: {
-            return Object.assign(Object.assign({}, state), { resultsConfig: null });
+            return Object.assign(Object.assign({}, state), { metadata: null, resultsConfig: null });
         }
         case actions_1.QuizAPIActionTypes.RESET_QUIZ:
             return Object.assign({}, exports.initialState);

package/lib/cjs/hooks/usePropsGetters/useSelectInputProps.js

@@ -40,7 +40,7 @@ function useSelectInputProps(quizAnswerChanged, nextQuestion, currentQuestionDat
             const prevSelected = {};
             if (Array.isArray(currentAnswer === null || currentAnswer === void 0 ? void 0 : currentAnswer.value)) {
                 (_a = currentAnswer === null || currentAnswer === void 0 ? void 0 : currentAnswer.value) === null || _a === void 0 ? void 0 : _a.forEach((answer) => {
-                    prevSelected[Number(answer.id)] = true;
+                    prevSelected[answer.id] = true;
                     setSelected(prevSelected);
                 });
             }

package/lib/cjs/hooks/useQuiz.js

@@ -8,7 +8,7 @@ const usePrimaryColorStyles_1 = tslib_1.__importDefault(require("./usePrimaryCol
 const useQuizEvents_1 = tslib_1.__importDefault(require("./useQuizEvents"));
 const useQuizState_1 = tslib_1.__importDefault(require("./useQuizState"));
 const useQuiz = (quizOptions) => {
-    var _a;
+    var _a, _b;
     const { apiKey, cioJsClient, primaryColor, resultsPageOptions } = quizOptions;
     // Log console errors for required parameters quizId
     (0, useConsoleErrors_1.default)(quizOptions);
@@ -36,6 +36,7 @@ const useQuiz = (quizOptions) => {
                 selectedOptionsWithAttributes: quizApiState.selectedOptionsWithAttributes,
                 matchedOptions: quizApiState.matchedOptions,
                 resultsConfig: (_a = quizApiState.resultsConfig) !== null && _a !== void 0 ? _a : null,
+                metadata: (_b = quizApiState.metadata) !== null && _b !== void 0 ? _b : null,
             },
             quizSessionStorageState,
         }, events: Object.assign({}, quizEvents) }, propGetters), { primaryColorStyles });

package/lib/cjs/hooks/useQuizState/useQuizApiState.js

@@ -6,11 +6,12 @@ const actions_1 = require("../../components/CioQuiz/actions");
 const quizApiReducer_1 = tslib_1.__importStar(require("../../components/CioQuiz/quizApiReducer"));
 const services_1 = require("../../services");
 const useQueryParams_1 = tslib_1.__importDefault(require("../useQueryParams"));
+const utils_1 = require("../../utils");
 const useQuizApiState = (quizOptions, cioClient, quizLocalState, skipToResults, dispatchLocalState
 // eslint-disable-next-line max-params
 ) => {
     const [quizApiState, dispatchApiState] = (0, react_1.useReducer)(quizApiReducer_1.default, quizApiReducer_1.initialState);
-    const { quizId, quizVersionId: quizVersionIdProp, resultsPageOptions } = quizOptions;
+    const { quizId, quizVersionId: quizVersionIdProp, resultsPageOptions, callbacks } = quizOptions;
     const { queryItems, queryAttributes, isSharedResultsQuery, answers, quizVersionId: quizVersionIdFromParam, } = (0, useQueryParams_1.default)();
     const dispatchQuizResults = () => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
         try {
@@ -76,8 +77,14 @@ const useQuizApiState = (quizOptions, cioClient, quizLocalState, skipToResults,
         }
     });
     (0, react_1.useEffect)(() => {
-        if (typeof quizApiState.resultsConfig === 'undefined')
+        if (typeof quizApiState.resultsConfig === 'undefined') {
             dispatchQuizResultsConfig();
+            return;
+        }
+        const { onQuizResultsConfigLoaded } = callbacks;
+        if (onQuizResultsConfigLoaded && (0, utils_1.isFunction)(onQuizResultsConfigLoaded)) {
+            onQuizResultsConfigLoaded(quizApiState.resultsConfig, quizApiState.metadata);
+        }
         // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [quizApiState.resultsConfig]);
     (0, react_1.useEffect)(() => {

package/lib/cjs/stories/Quiz/argTypes.js

@@ -127,6 +127,20 @@ exports.argTypes = {
             },
         },
     },
+    'callbacks.onQuizResultsConfigLoaded': {
+        description: 'Callback function to be called when results config is loaded.',
+        control: false,
+        table: {
+            subcategory: 'callbacks',
+            defaultValue: {
+                summary: 'null',
+            },
+            type: {
+                summary: '(resultsConfig, metadata) => void',
+                detail: '(resultsConfig?: QuizResultsConfig | null, metadata?: object | null) => void',
+            },
+        },
+    },
     cioJsClient: {
         description: 'Optional custom constructor instance. Either `apiKey` or `cioJsClient` are required',
     },

package/lib/cjs/utils.js

@@ -42,6 +42,7 @@ exports.functionStrings = {
     onQuizNextQuestion: `(question) => console.dir(question)`,
     onQuizSkipQuestion: `(question) => console.dir(question)`,
     onEmailResults: `(data) => console.dir(data)`,
+    onQuizResultsConfigLoaded: `(resultsConfig, metadata) => console.dir(resultsConfig, metadata)`,
     cioJsClient: `cioJsClient`,
 };
 const stringifyWithDefaults = (obj) => {

package/lib/cjs/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = '1.17.25';
+exports.default = '1.18.0';

package/lib/mjs/components/CioQuiz/quizApiReducer.js

@@ -74,12 +74,14 @@ export default function apiReducer(state, action) {
         case QuizAPIActionTypes.SET_QUIZ_RESULTS_CONFIG: {
             return {
                 ...state,
+                metadata: action.payload?.quizResultsConfig.metadata,
                 resultsConfig: action.payload?.quizResultsConfig.results_config,
             };
         }
         case QuizAPIActionTypes.SET_QUIZ_RESULTS_CONFIG_ERROR: {
             return {
                 ...state,
+                metadata: null,
                 resultsConfig: null,
             };
         }

package/lib/mjs/hooks/usePropsGetters/useSelectInputProps.js

@@ -36,7 +36,7 @@ export default function useSelectInputProps(quizAnswerChanged, nextQuestion, cur
             const prevSelected = {};
             if (Array.isArray(currentAnswer?.value)) {
                 currentAnswer?.value?.forEach((answer) => {
-                    prevSelected[Number(answer.id)] = true;
+                    prevSelected[answer.id] = true;
                     setSelected(prevSelected);
                 });
             }

package/lib/mjs/hooks/useQuiz.js

@@ -34,6 +34,7 @@ const useQuiz = (quizOptions) => {
                 selectedOptionsWithAttributes: quizApiState.selectedOptionsWithAttributes,
                 matchedOptions: quizApiState.matchedOptions,
                 resultsConfig: quizApiState.resultsConfig ?? null,
+                metadata: quizApiState.metadata ?? null,
             },
             quizSessionStorageState,
         },

package/lib/mjs/hooks/useQuizState/useQuizApiState.js

@@ -3,11 +3,12 @@ import { QuestionTypes, QuizAPIActionTypes, } from '../../components/CioQuiz/act
 import apiReducer, { initialState, } from '../../components/CioQuiz/quizApiReducer';
 import { getNextQuestion, getQuizResults, getBrowseResultsForItemIds, getQuizResultsConfig, } from '../../services';
 import useQueryParams from '../useQueryParams';
+import { isFunction } from '../../utils';
 const useQuizApiState = (quizOptions, cioClient, quizLocalState, skipToResults, dispatchLocalState
 // eslint-disable-next-line max-params
 ) => {
     const [quizApiState, dispatchApiState] = useReducer(apiReducer, initialState);
-    const { quizId, quizVersionId: quizVersionIdProp, resultsPageOptions } = quizOptions;
+    const { quizId, quizVersionId: quizVersionIdProp, resultsPageOptions, callbacks } = quizOptions;
     const { queryItems, queryAttributes, isSharedResultsQuery, answers, quizVersionId: quizVersionIdFromParam, } = useQueryParams();
     const dispatchQuizResults = async () => {
         try {
@@ -84,8 +85,14 @@ const useQuizApiState = (quizOptions, cioClient, quizLocalState, skipToResults,
         }
     };
     useEffect(() => {
-        if (typeof quizApiState.resultsConfig === 'undefined')
+        if (typeof quizApiState.resultsConfig === 'undefined') {
             dispatchQuizResultsConfig();
+            return;
+        }
+        const { onQuizResultsConfigLoaded } = callbacks;
+        if (onQuizResultsConfigLoaded && isFunction(onQuizResultsConfigLoaded)) {
+            onQuizResultsConfigLoaded(quizApiState.resultsConfig, quizApiState.metadata);
+        }
         // eslint-disable-next-line react-hooks/exhaustive-deps
     }, [quizApiState.resultsConfig]);
     useEffect(() => {

package/lib/mjs/stories/Quiz/argTypes.js

@@ -124,6 +124,20 @@ export const argTypes = {
             },
         },
     },
+    'callbacks.onQuizResultsConfigLoaded': {
+        description: 'Callback function to be called when results config is loaded.',
+        control: false,
+        table: {
+            subcategory: 'callbacks',
+            defaultValue: {
+                summary: 'null',
+            },
+            type: {
+                summary: '(resultsConfig, metadata) => void',
+                detail: '(resultsConfig?: QuizResultsConfig | null, metadata?: object | null) => void',
+            },
+        },
+    },
     cioJsClient: {
         description: 'Optional custom constructor instance. Either `apiKey` or `cioJsClient` are required',
     },

package/lib/mjs/utils.js

@@ -37,6 +37,7 @@ export const functionStrings = {
     onQuizNextQuestion: `(question) => console.dir(question)`,
     onQuizSkipQuestion: `(question) => console.dir(question)`,
     onEmailResults: `(data) => console.dir(data)`,
+    onQuizResultsConfigLoaded: `(resultsConfig, metadata) => console.dir(resultsConfig, metadata)`,
     cioJsClient: `cioJsClient`,
 };
 export const stringifyWithDefaults = (obj) => {

package/lib/mjs/version.js

@@ -1 +1 @@
-export default '1.17.25';
+export default '1.18.0';

package/lib/types/components/CioQuiz/quizApiReducer.d.ts

@@ -9,6 +9,7 @@ export type QuizAPIReducerState = {
     selectedOptionsWithAttributes?: string[];
     matchedOptions?: string[];
     resultsConfig?: QuizResultsConfig | null;
+    metadata?: object | null;
 };
 export declare const initialState: QuizAPIReducerState;
 export default function apiReducer(state: QuizAPIReducerState, action: ActionQuizAPI): QuizAPIReducerState;

package/lib/types/stories/Quiz/argTypes.d.ts

@@ -123,6 +123,20 @@ export declare const argTypes: {
             };
         };
     };
+    'callbacks.onQuizResultsConfigLoaded': {
+        description: string;
+        control: boolean;
+        table: {
+            subcategory: string;
+            defaultValue: {
+                summary: string;
+            };
+            type: {
+                summary: string;
+                detail: string;
+            };
+        };
+    };
     cioJsClient: {
         description: string;
     };

package/lib/types/types.d.ts

@@ -1,9 +1,11 @@
 import { CSSProperties } from 'react';
-import { QuizResultData, NextQuestionResponse, QuizResultsResponse, QuestionOption, Question, QuizResultsConfig, QuizzesResultsParameters, QuizzesParameters } from '@constructor-io/constructorio-client-javascript/lib/types';
+import { QuizResultData, NextQuestionResponse, QuizResultsResponse, QuestionOption, QuizResultsConfig, QuizzesResultsParameters, QuizzesParameters } from '@constructor-io/constructorio-client-javascript/lib/types';
+import { Question } from '@constructor-io/constructorio-client-javascript/lib/types/quizzes';
 import ConstructorIOClient, { GetBrowseResultsForItemIdsResponse } from '@constructor-io/constructorio-client-javascript';
 import { RequestStates } from './constants';
 import { QuestionTypes } from './components/CioQuiz/actions';
-export type { QuestionOption, QuestionImages, Question, NextQuestionResponse, QuizResultsResponse, QuizResultsConfigResponse, QuizResultsConfig, BrowseResultData, BrowseRequestType, QuizzesParameters, QuizzesResultsParameters, } from '@constructor-io/constructorio-client-javascript/lib/types';
+export type { QuestionOption, QuestionImages, NextQuestionResponse, QuizResultsResponse, QuizResultsConfigResponse, QuizResultsConfig, BrowseResultData, BrowseRequestType, QuizzesParameters, QuizzesResultsParameters, } from '@constructor-io/constructorio-client-javascript/lib/types/';
+export type { Question } from '@constructor-io/constructorio-client-javascript/lib/types/quizzes';
 export type QuizResultDataPartial = Partial<QuizResultData>;
 export type QuizEmailResults = {
     email: string;
@@ -33,6 +35,7 @@ export declare namespace QuizResultsEventsProps {
     type OnEmailResults = (data: QuizEmailResults) => Promise<void>;
     type OnShareResultsModalOpen = () => void;
     type OnShareResultsModalClose = () => void;
+    type OnQuizResultsConfigLoaded = (resultsConfig?: QuizResultsConfig | null, metadata?: object | null) => void;
 }
 export type QuizResultsRequestConfigs = Omit<QuizzesResultsParameters, keyof QuizzesParameters | 'page' | 'resultsPerPage'>;
 export interface ResultsPageOptions {
@@ -62,6 +65,7 @@ export interface Callbacks {
     onEmailResults?: QuizResultsEventsProps.OnEmailResults;
     onShareResultsModalOpen?: QuizResultsEventsProps.OnShareResultsModalOpen;
     onShareResultsModalClose?: QuizResultsEventsProps.OnShareResultsModalClose;
+    onQuizResultsConfigLoaded?: QuizResultsEventsProps.OnQuizResultsConfigLoaded;
 }
 export interface IQuizProps {
     apiKey?: string;

package/lib/types/utils.d.ts

@@ -10,6 +10,7 @@ export declare const functionStrings: {
     onQuizNextQuestion: string;
     onQuizSkipQuestion: string;
     onEmailResults: string;
+    onQuizResultsConfigLoaded: string;
     cioJsClient: string;
 };
 export declare const stringifyWithDefaults: (obj: {

package/lib/types/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.17.25";
+declare const _default: "1.18.0";
 export default _default;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-ui-quizzes",
-  "version": "1.17.25",
+  "version": "1.18.0",
   "description": "Constructor.io Quizzes UI library for web applications",
   "author": "Constructor.io Corporation",
   "license": "MIT",
@@ -25,11 +25,13 @@
     },
     ".": {
       "import": "./lib/mjs/index.js",
-      "require": "./lib/cjs/index.js"
+      "require": "./lib/cjs/index.js",
+      "types": "./lib/types/index.d.ts"
     },
     "./cjs": {
       "import": "./lib/cjs/index.js",
-      "require": "./lib/cjs/index.js"
+      "require": "./lib/cjs/index.js",
+      "types": "./lib/types/index.d.ts"
     }
   },
   "files": [
@@ -59,7 +61,7 @@
     "check-license": "license-checker --production --onlyAllow 'Apache-2.0;BSD-3-Clause;MIT;0BSD;BSD-2-Clause' --excludePackages 'picocolors@1.0.0'"
   },
   "peerDependencies": {
-    "@constructor-io/constructorio-client-javascript": "^2.65.1",
+    "@constructor-io/constructorio-client-javascript": "^2.67.5",
     "react": ">=16.12.0",
     "react-dom": ">=16.12.0",
     "tslib": "^2.4.0"
@@ -114,5 +116,9 @@
     "vite-plugin-css-injected-by-js": "^3.1.0",
     "webpack": "^5.75.0",
     "whatwg-fetch": "^3.6.20"
+  },
+  "volta": {
+    "node": "22.18.0",
+    "npm": "10.9.3"
   }
 }