@constructor-io/constructorio-ui-quizzes 1.8.3 → 1.9.0

package/lib/types/src/hooks/usePropsGetters/index.d.ts

@@ -1,4 +1,4 @@
-import { GetResetQuizButtonProps, GetCoverQuestionProps, GetNextQuestionButtonProps, GetOpenTextInputProps, GetPreviousQuestionButtonProps, GetQuizImageProps, GetSelectInputProps, QuizEventsReturn, GetHydrateQuizButtonProps, GetAddToCartButtonProps, GetQuizResultButtonProps, GetQuizResultLinkProps, GetSelectQuestionImageProps, GetAddToFavoritesButtonProps } from '../../types';
+import { GetResetQuizButtonProps, GetCoverQuestionProps, GetNextQuestionButtonProps, GetOpenTextInputProps, GetPreviousQuestionButtonProps, GetQuizImageProps, GetSelectInputProps, QuizEventsReturn, GetHydrateQuizButtonProps, GetAddToCartButtonProps, GetQuizResultButtonProps, GetQuizResultLinkProps, GetSelectQuestionImageProps, GetAddToFavoritesButtonProps, GetSkipQuestionButtonProps } from '../../types';
 import { QuizAPIReducerState } from '../../components/CioQuiz/quizApiReducer';
 import { QuizLocalReducerState } from '../../components/CioQuiz/quizLocalReducer';
 declare const usePropsGetters: (quizEvents: QuizEventsReturn, quizApiState: QuizAPIReducerState, quizLocalState: QuizLocalReducerState) => {
@@ -15,5 +15,6 @@ declare const usePropsGetters: (quizEvents: QuizEventsReturn, quizApiState: Quiz
     getAddToFavoritesButtonProps: GetAddToFavoritesButtonProps;
     getQuizResultButtonProps: GetQuizResultButtonProps;
     getQuizResultLinkProps: GetQuizResultLinkProps;
+    getSkipQuestionButtonProps: GetSkipQuestionButtonProps;
 };
 export default usePropsGetters;

package/lib/types/src/hooks/usePropsGetters/useSkipQuestionButtonProps.d.ts

@@ -0,0 +1,3 @@
+import { QuizAPIReducerState } from '../../components/CioQuiz/quizApiReducer';
+import { GetSkipQuestionButtonProps, QuizEventsReturn } from '../../types';
+export default function useSkipQuestionButtonProps(skipQuestion: QuizEventsReturn.SkipQuestion, quizApiState: QuizAPIReducerState): GetSkipQuestionButtonProps;

package/lib/types/src/hooks/useQuizEvents/useQuizSkipClick.d.ts

@@ -0,0 +1,6 @@
+import { ActionAnswerQuestion } from '../../components/CioQuiz/actions';
+import { QuizAPIReducerState } from '../../components/CioQuiz/quizApiReducer';
+import { QuizLocalReducerState } from '../../components/CioQuiz/quizLocalReducer';
+import { QuizEventsReturn, OnQuizSkipQuestion } from '../../types';
+declare const useQuizSkipClick: (quizApiState: QuizAPIReducerState, quizLocalState: QuizLocalReducerState, dispatchLocalState: React.Dispatch<ActionAnswerQuestion>, onQuizSkipQuestion?: OnQuizSkipQuestion) => QuizEventsReturn.NextQuestion;
+export default useQuizSkipClick;

package/lib/types/src/stories/Quiz/tests/mocks.d.ts

@@ -7,7 +7,7 @@ export declare const getMockQuestion: (type: `${QuestionTypes}`) => {
     title: string;
     description: string;
     cta_text: string;
-    type: "reset" | "open" | "cover" | "single" | "multiple" | "next" | "back" | "hydrate" | "complete";
+    type: "reset" | "open" | "cover" | "single" | "multiple" | "next" | "skip" | "back" | "hydrate" | "complete";
     input_placeholder: string;
 };
 export declare const getMockQuestionWithImage: (type: QuestionTypes) => {
@@ -18,7 +18,7 @@ export declare const getMockQuestionWithImage: (type: QuestionTypes) => {
     title: string;
     description: string;
     cta_text: string;
-    type: "reset" | "open" | "cover" | "single" | "multiple" | "next" | "back" | "hydrate" | "complete";
+    type: "reset" | "open" | "cover" | "single" | "multiple" | "next" | "skip" | "back" | "hydrate" | "complete";
     input_placeholder: string;
 };
 export declare const questionOptionsWithImages: {

package/lib/types/src/types.d.ts

@@ -34,8 +34,10 @@ export type QuestionWithAnswer = Question & {
     answer: AnswerInput;
 };
 export type OnQuizNextQuestion = (question: QuestionWithAnswer) => void;
+export type OnQuizSkipQuestion = (question: QuestionWithAnswer) => void;
 export interface Callbacks {
     onQuizNextQuestion?: OnQuizNextQuestion;
+    onQuizSkipQuestion?: OnQuizSkipQuestion;
 }
 export interface IQuizProps {
     apiKey?: string;
@@ -65,7 +67,7 @@ export interface QuizReturnState {
 }
 export type AnswerInput = {
     type: InputQuestionsTypes;
-    value: string | string[];
+    value: string | string[] | null;
 };
 export type AnswerInputState = {
     [key: string]: AnswerInput;
@@ -87,6 +89,7 @@ export type CurrentQuestion = NextQuestionResponse & {
 export declare namespace QuizEventsReturn {
     type QuizAnswerChanged = (payload?: string | string[]) => void;
     type NextQuestion = () => void;
+    type SkipQuestion = () => void;
     type PreviousQuestion = () => void;
     type ResetQuiz = () => void;
     type ResultClick = (result: QuizResultDataPartial, position: number) => void;
@@ -97,6 +100,7 @@ export declare namespace QuizEventsReturn {
 }
 export interface QuizEventsReturn {
     nextQuestion: QuizEventsReturn.NextQuestion;
+    skipQuestion: QuizEventsReturn.SkipQuestion;
     quizAnswerChanged: QuizEventsReturn.QuizAnswerChanged;
     previousQuestion: QuizEventsReturn.PreviousQuestion;
     resetQuiz: QuizEventsReturn.ResetQuiz;
@@ -121,6 +125,12 @@ export interface NextQuestionButtonProps {
     disabled?: boolean;
     onClick: React.MouseEventHandler<HTMLElement>;
 }
+export interface SkipQuestionButtonProps {
+    className: string;
+    type: 'submit' | 'reset' | 'button' | undefined;
+    disabled?: boolean;
+    onClick: React.MouseEventHandler<HTMLElement>;
+}
 export interface PreviousQuestionButtonProps {
     className: string;
     type: 'submit' | 'reset' | 'button' | undefined;
@@ -175,6 +185,7 @@ export type GetOpenTextInputProps = () => OpenTextInputProps;
 export type GetCoverQuestionProps = () => CoverQuestionProps;
 export type GetSelectInputProps = (option: QuestionOption) => SelectInputProps;
 export type GetNextQuestionButtonProps = () => NextQuestionButtonProps;
+export type GetSkipQuestionButtonProps = () => SkipQuestionButtonProps;
 export type GetPreviousQuestionButtonProps = () => PreviousQuestionButtonProps;
 export type GetResetQuizButtonProps = (stylesType?: 'primary' | 'secondary') => ResetQuizButtonProps;
 export type GetHydrateQuizButtonProps = () => HydrateQuizButtonProps;
@@ -200,6 +211,7 @@ export interface UseQuizReturn {
     events: QuizEventsReturn;
     getOpenTextInputProps: GetOpenTextInputProps;
     getNextQuestionButtonProps: GetNextQuestionButtonProps;
+    getSkipQuestionButtonProps: GetSkipQuestionButtonProps;
     getPreviousQuestionButtonProps: GetPreviousQuestionButtonProps;
     getQuizImageProps: GetQuizImageProps;
     getSelectQuestionImageProps: GetSelectQuestionImageProps;

package/lib/types/src/utils.d.ts

@@ -18,6 +18,7 @@ export declare const functionStrings: {
     onAddToFavoritesClick: string;
     onQuizResultsLoaded: string;
     onQuizNextQuestion: string;
+    onQuizSkipQuestion: string;
     cioJsClient: string;
 };
 export declare const stringifyWithDefaults: (obj: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@constructor-io/constructorio-ui-quizzes",
-  "version": "1.8.3",
+  "version": "1.9.0",
   "description": "Constructor.io Quizzes UI library for web applications",
   "author": "constructor.io",
   "license": "MIT",