Feat: Add quiz type pin image

assets/src/js/front/course/_spotlight-quiz.js

@@ -2,7 +2,7 @@ window.jQuery(document).ready($ => {
     const { __ } = window.wp.i18n;
 
     // Currently only these types of question supports answer reveal mode.
-    const revealModeSupportedQuestions = ['true_false', 'single_choice', 'multiple_choice', 'draw_image'];
+    const revealModeSupportedQuestions = ['true_false', 'single_choice', 'multiple_choice', 'draw_image', 'pin_image'];
 
     let quiz_options = _tutorobject.quiz_options
     let interactions = new Map();
@@ -102,8 +102,8 @@ window.jQuery(document).ready($ => {
             });
         }
 
-        // Reveal mode for draw_image: show reference (instructor mask) and explanation.
-        if (is_reveal_mode() && $question_wrap.data('question-type') === 'draw_image') {
+        // Reveal mode for draw_image & pin_image: show reference (instructor mask) and explanation.
+        if (is_reveal_mode() && ['draw_image', 'pin_image'].includes($question_wrap.data('question-type'))) {
             $question_wrap.find('.tutor-quiz-explanation-wrapper').removeClass('tutor-d-none');
             $question_wrap.find('.tutor-draw-image-reference-wrapper').removeClass('tutor-d-none');
             goNext = true;
@@ -174,6 +174,17 @@ window.jQuery(document).ready($ => {
                         $question_wrap.find('.answer-help-block').html(`<p style="color: #dc3545">${__('Please draw on the image to answer this question.', 'tutor')}</p>`);
                         validated = false;
                     }
+                } else if ($question_wrap.data('question-type') === 'pin_image') {
+                    // Pin image: require normalized pin coordinates (hidden inputs [answers][pin][x|y]).
+                    var $pinX = $required_answer_wrap.find('input[name*="[answers][pin][x]"]');
+                    var $pinY = $required_answer_wrap.find('input[name*="[answers][pin][y]"]');
+                    if (
+                        !$pinX.length || !$pinY.length ||
+                        !$pinX.val().trim().length || !$pinY.val().trim().length
+                    ) {
+                        $question_wrap.find('.answer-help-block').html(`<p style="color: #dc3545">${__('Please drop a pin on the image to answer this question.', 'tutor')}</p>`);
+                        validated = false;
+                    }
                 } else if ($type === 'radio') {
                     if ($required_answer_wrap.find('input[type="radio"]:checked').length == 0) {
                         $question_wrap.find('.answer-help-block').html(`<p style="color: #dc3545">${__('Please select an option to answer', 'tutor')}</p>`);

assets/src/js/v3/entries/course-builder/components/curriculum/Question.tsx

@@ -40,6 +40,7 @@ const questionTypeIconMap: Record<Exclude<QuizQuestionType, 'single_choice' | 'i
   image_answering: 'quizImageAnswer',
   ordering: 'quizOrdering',
   draw_image: 'quizImageAnswer',
+  pin_image: 'quizImageAnswer',
   h5p: 'quizH5p',
 };
 

assets/src/js/v3/entries/course-builder/components/curriculum/QuestionConditions.tsx

@@ -54,6 +54,10 @@ const questionTypes = {
     label: __('Draw on Image', 'tutor'),
     icon: 'quizImageAnswer',
   },
+  pin_image: {
+    label: __('Pin on Image', 'tutor'),
+    icon: 'quizImageAnswer',
+  },
   h5p: {
     label: __('H5P', 'tutor'),
     icon: 'quizTrueFalse',

assets/src/js/v3/entries/course-builder/components/curriculum/QuestionForm.tsx

@@ -16,6 +16,7 @@ import MultipleChoiceAndOrdering from '@CourseBuilderComponents/curriculum/quest
 import OpenEndedAndShortAnswer from '@CourseBuilderComponents/curriculum/question-types/OpenEndedAndShortAnswer';
 import TrueFalse from '@CourseBuilderComponents/curriculum/question-types/TrueFalse';
 import DrawImage from '@CourseBuilderComponents/curriculum/question-types/DrawImage';
+import PinImage from '@CourseBuilderComponents/curriculum/question-types/PinImage';
 import { useQuizModalContext } from '@CourseBuilderContexts/QuizModalContext';
 
 import { tutorConfig } from '@TutorShared/config/config';
@@ -56,6 +57,7 @@ const QuestionForm = () => {
     image_answering: <ImageAnswering key={activeQuestionId} />,
     ordering: <MultipleChoiceAndOrdering key={activeQuestionId} />,
     draw_image: <DrawImage key={activeQuestionId} />,
+    pin_image: <PinImage key={activeQuestionId} />,
   } as const;
 
   useEffect(() => {

assets/src/js/v3/entries/course-builder/components/curriculum/QuestionList.tsx

@@ -110,6 +110,13 @@ const questionTypeOptions: {
     icon: 'quizImageAnswer',
     isPro: true,
   },
+  {
+    label: __('Pin on Image', 'tutor'),
+    value: 'pin_image',
+    // TODO: icon is not final.
+    icon: 'quizImageAnswer',
+    isPro: true,
+  },
 ];
 
 const isTutorPro = !!tutorConfig.tutor_pro_url;
@@ -230,7 +237,22 @@ const QuestionList = ({ isEditing }: { isEditing: boolean }) => {
                     is_correct: '1',
                   },
                 ]
-              : [],
+              : questionType === 'pin_image'
+                ? [
+                    {
+                      _data_status: QuizDataStatus.NEW,
+                      is_saved: true,
+                      answer_id: nanoid(),
+                      answer_title: '',
+                      belongs_question_id: questionId,
+                      belongs_question_type: 'pin_image',
+                      answer_two_gap_match: '',
+                      answer_view_format: 'pin_image',
+                      answer_order: 0,
+                      is_correct: '1',
+                    },
+                  ]
+                : [],
       answer_explanation: '',
       question_mark: 1,
       question_order: questionFields.length + 1,

assets/src/js/v3/entries/course-builder/components/curriculum/question-types/PinImage.tsx

@@ -0,0 +1,80 @@
+import { css } from '@emotion/react';
+import { useEffect } from 'react';
+import { Controller, useFieldArray, useFormContext } from 'react-hook-form';
+
+import { useQuizModalContext } from '@CourseBuilderContexts/QuizModalContext';
+import type { QuizForm } from '@CourseBuilderServices/quiz';
+import FormPinImage from '@TutorShared/components/fields/quiz/questions/FormPinImage';
+import { spacing } from '@TutorShared/config/styles';
+import { styleUtils } from '@TutorShared/utils/style-utils';
+import { QuizDataStatus, type QuizQuestionOption } from '@TutorShared/utils/types';
+import { nanoid } from '@TutorShared/utils/util';
+
+const PinImage = () => {
+  const form = useFormContext<QuizForm>();
+  const { activeQuestionId, activeQuestionIndex, validationError, setValidationError } = useQuizModalContext();
+
+  const answersPath = `questions.${activeQuestionIndex}.question_answers` as 'questions.0.question_answers';
+
+  const { fields: optionsFields } = useFieldArray({
+    control: form.control,
+    name: answersPath,
+  });
+
+  // Ensure there is always a single option for this question type.
+  useEffect(() => {
+    if (!activeQuestionId) {
+      return;
+    }
+    if (optionsFields.length > 0) {
+      return;
+    }
+    const baseAnswer: QuizQuestionOption = {
+      _data_status: QuizDataStatus.NEW,
+      is_saved: false,
+      answer_id: nanoid(),
+      belongs_question_id: activeQuestionId,
+      belongs_question_type: 'pin_image' as QuizQuestionOption['belongs_question_type'],
+      answer_title: '',
+      is_correct: '1',
+      image_id: undefined,
+      image_url: '',
+      answer_two_gap_match: '',
+      answer_view_format: 'pin_image',
+      answer_order: 0,
+    };
+    form.setValue(answersPath, [baseAnswer]);
+  }, [activeQuestionId, optionsFields.length, answersPath, form]);
+
+  // Only render Controller when the value exists to ensure field.value is always defined
+  if (optionsFields.length === 0) {
+    return null;
+  }
+
+  return (
+    <div css={styles.optionWrapper}>
+      <Controller
+        key={JSON.stringify(optionsFields[0])}
+        control={form.control}
+        name={`questions.${activeQuestionIndex}.question_answers.0` as 'questions.0.question_answers.0'}
+        render={(controllerProps) => (
+          <FormPinImage
+            {...controllerProps}
+            questionId={activeQuestionId}
+            validationError={validationError}
+            setValidationError={setValidationError}
+          />
+        )}
+      />
+    </div>
+  );
+};
+
+export default PinImage;
+
+const styles = {
+  optionWrapper: css`
+    ${styleUtils.display.flex('column')};
+    padding-left: ${spacing[40]};
+  `,
+};