payload-quiz-plugin 1.0.0

package/dist/client.d.mts

@@ -0,0 +1,303 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React$1 from 'react';
+import { ClassValue } from 'clsx';
+
+/**
+ * Quiz Plugin Types
+ * These types are standalone and don't depend on generated payload-types
+ */
+/**
+ * Rich text data structure (Lexical format)
+ */
+type RichTextData = {
+    root: {
+        type: string;
+        children: unknown[];
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+} | null;
+/**
+ * Component for rendering rich text content
+ * This allows projects to provide their own RichText component
+ */
+type RichTextRenderer = React.ComponentType<{
+    data: RichTextData;
+    enableGutter?: boolean;
+    className?: string;
+}>;
+/**
+ * Choice option in a question
+ */
+type QuizChoice = {
+    id?: string | null;
+    text: string;
+    isCorrect?: boolean | null;
+    explanation?: RichTextData;
+};
+/**
+ * Question structure for the quiz
+ */
+type QuizQuestion = {
+    id: number;
+    question: string;
+    requiredAnswers?: number | null;
+    choices?: QuizChoice[] | null;
+    explanation?: RichTextData;
+};
+/**
+ * Test configuration
+ */
+type QuizTest = {
+    id?: number;
+    title: string;
+    slug?: string | null;
+    questionCount?: number | null;
+    timeLimit?: number | null;
+    passMark?: number | null;
+    questionsPerPage?: number | null;
+    allowGoBack?: boolean | null;
+    requireAllAnswered?: boolean | null;
+};
+/**
+ * User's answer to a question
+ */
+type UserAnswer = {
+    questionId: number;
+    selectedChoiceIds: string[];
+};
+/**
+ * Quiz state for the reducer
+ */
+type QuizState = {
+    status: 'loading' | 'ready' | 'in_progress' | 'completed';
+    questions: QuizQuestion[];
+    currentQuestionIndex: number;
+    answers: Map<number, string[]>;
+    startTime: number | null;
+    endTime: number | null;
+    timeRemaining: number;
+};
+/**
+ * Actions for the quiz reducer
+ */
+type QuizAction = {
+    type: 'SET_QUESTIONS';
+    questions: QuizQuestion[];
+} | {
+    type: 'START_QUIZ';
+    timeLimit: number;
+} | {
+    type: 'SELECT_ANSWER';
+    questionId: number;
+    choiceId: string;
+    isMultiple: boolean;
+} | {
+    type: 'DESELECT_ANSWER';
+    questionId: number;
+    choiceId: string;
+} | {
+    type: 'NEXT_QUESTION';
+} | {
+    type: 'PREV_QUESTION';
+} | {
+    type: 'GO_TO_QUESTION';
+    index: number;
+} | {
+    type: 'TICK_TIMER';
+} | {
+    type: 'FINISH_QUIZ';
+};
+/**
+ * Result of the quiz
+ */
+type QuizResult = {
+    totalQuestions: number;
+    correctAnswers: number;
+    incorrectAnswers: number;
+    unanswered: number;
+    score: number;
+    passed: boolean;
+    passMark: number;
+    timeTaken: number;
+    questionResults: QuestionResult[];
+};
+/**
+ * Result for a single question
+ */
+type QuestionResult = {
+    questionId: number;
+    question: string;
+    requiredAnswers: number;
+    isCorrect: boolean;
+    userAnswers: string[];
+    correctAnswers: string[];
+    choices: {
+        id: string;
+        text: string;
+        isCorrect: boolean;
+        wasSelected: boolean;
+        explanation?: RichTextData;
+    }[];
+    explanation?: RichTextData;
+};
+
+type QuizContextType = {
+    state: QuizState;
+    dispatch: React$1.Dispatch<QuizAction>;
+    currentQuestion: QuizQuestion | null;
+    isFirstQuestion: boolean;
+    isLastQuestion: boolean;
+    answeredCount: number;
+    selectAnswer: (choiceId: string) => void;
+    deselectAnswer: (choiceId: string) => void;
+    nextQuestion: () => void;
+    prevQuestion: () => void;
+    goToQuestion: (index: number) => void;
+    finishQuiz: () => void;
+    calculateResults: (passMark: number) => QuizResult;
+};
+declare function QuizProvider({ children, questions, timeLimit, }: {
+    children: React$1.ReactNode;
+    questions: QuizQuestion[];
+    timeLimit: number;
+}): react_jsx_runtime.JSX.Element;
+declare function useQuiz(): QuizContextType;
+
+type Props$4 = {
+    timeRemaining: number;
+    className?: string;
+};
+declare function QuizTimer({ timeRemaining, className }: Props$4): react_jsx_runtime.JSX.Element;
+
+type Props$3 = {
+    currentIndex: number;
+    totalQuestions: number;
+    answeredQuestions: Set<number>;
+    onQuestionClick?: (index: number) => void;
+    allowNavigation?: boolean;
+    className?: string;
+};
+declare function QuizProgress({ currentIndex, totalQuestions, answeredQuestions, onQuestionClick, allowNavigation, className, }: Props$3): react_jsx_runtime.JSX.Element;
+
+type Props$2 = {
+    question: QuizQuestion;
+    selectedChoiceIds: string[];
+    onSelectChoice: (choiceId: string) => void;
+    onDeselectChoice: (choiceId: string) => void;
+    className?: string;
+};
+declare function QuestionCard({ question, selectedChoiceIds, onSelectChoice, onDeselectChoice, className, }: Props$2): react_jsx_runtime.JSX.Element;
+
+type Props$1 = {
+    id: string;
+    text: string;
+    isSelected: boolean;
+    isMultiple: boolean;
+    onClick: () => void;
+    disabled?: boolean;
+    showResult?: boolean;
+    isCorrect?: boolean;
+    className?: string;
+};
+declare function ChoiceOption({ id, text, isSelected, isMultiple, onClick, disabled, showResult, isCorrect, className, }: Props$1): react_jsx_runtime.JSX.Element;
+
+type Props = {
+    result: QuizResult;
+    testSlug: string;
+    className?: string;
+    /** Optional custom component for rendering rich text explanations */
+    RichTextComponent?: RichTextRenderer;
+};
+declare function QuizResults({ result, testSlug, className, RichTextComponent }: Props): react_jsx_runtime.JSX.Element;
+
+/**
+ * Types for TestCard component
+ * These are standalone and don't depend on generated payload-types
+ */
+/**
+ * Media object structure (simplified)
+ */
+type TestCardMedia = {
+    url?: string | null;
+    alt?: string | null;
+    width?: number | null;
+    height?: number | null;
+    [key: string]: unknown;
+};
+/**
+ * Certificate type structure
+ */
+type TestCardCertificateType = {
+    id?: number | string;
+    shortName?: string | null;
+    title?: string | null;
+    [key: string]: unknown;
+};
+/**
+ * Test meta information
+ */
+type TestCardMeta = {
+    title?: string | null;
+    description?: string | null;
+    image?: TestCardMedia | number | string | null;
+};
+/**
+ * Data structure for a test card
+ */
+type TestCardData = {
+    id?: number | string;
+    slug?: string | null;
+    title?: string | null;
+    certificateType?: TestCardCertificateType | number | string | null;
+    meta?: TestCardMeta | null;
+    questionCount?: number | null;
+    timeLimit?: number | null;
+    passMark?: number | null;
+};
+/**
+ * Props for the TestCard component
+ */
+type TestCardProps = {
+    /** Test data to display */
+    doc?: TestCardData;
+    /** Override title */
+    title?: string;
+    /** Additional class names */
+    className?: string;
+    /** Custom media renderer component */
+    MediaComponent?: React.ComponentType<{
+        resource: TestCardMedia;
+        size?: string;
+        fill?: boolean;
+        pictureClassName?: string;
+        imgClassName?: string;
+    }>;
+};
+
+/**
+ * TestCard component for displaying test information in a card format
+ *
+ * @example
+ * ```tsx
+ * import { TestCard } from '@/plugins/quiz/client'
+ * import { Media } from '@/components/Media'
+ *
+ * <TestCard
+ *   doc={test}
+ *   MediaComponent={({ resource, size }) => (
+ *     <Media resource={resource} size={size} />
+ *   )}
+ * />
+ * ```
+ */
+declare function TestCard({ doc, title: titleFromProps, className, MediaComponent }: TestCardProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Utility function for merging Tailwind CSS classes
+ * This is a common pattern used with ShadCN/Tailwind
+ */
+
+declare function cn(...inputs: ClassValue[]): string;
+
+export { ChoiceOption, QuestionCard, type QuestionResult, type QuizAction, type QuizChoice, QuizProgress, QuizProvider, type QuizQuestion, type QuizResult, QuizResults, type QuizState, type QuizTest, QuizTimer, type RichTextData, type RichTextRenderer, TestCard, type TestCardCertificateType, type TestCardData, type TestCardMedia, type TestCardMeta, type TestCardProps, type UserAnswer, cn, useQuiz };

package/dist/client.d.ts

@@ -0,0 +1,303 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React$1 from 'react';
+import { ClassValue } from 'clsx';
+
+/**
+ * Quiz Plugin Types
+ * These types are standalone and don't depend on generated payload-types
+ */
+/**
+ * Rich text data structure (Lexical format)
+ */
+type RichTextData = {
+    root: {
+        type: string;
+        children: unknown[];
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+} | null;
+/**
+ * Component for rendering rich text content
+ * This allows projects to provide their own RichText component
+ */
+type RichTextRenderer = React.ComponentType<{
+    data: RichTextData;
+    enableGutter?: boolean;
+    className?: string;
+}>;
+/**
+ * Choice option in a question
+ */
+type QuizChoice = {
+    id?: string | null;
+    text: string;
+    isCorrect?: boolean | null;
+    explanation?: RichTextData;
+};
+/**
+ * Question structure for the quiz
+ */
+type QuizQuestion = {
+    id: number;
+    question: string;
+    requiredAnswers?: number | null;
+    choices?: QuizChoice[] | null;
+    explanation?: RichTextData;
+};
+/**
+ * Test configuration
+ */
+type QuizTest = {
+    id?: number;
+    title: string;
+    slug?: string | null;
+    questionCount?: number | null;
+    timeLimit?: number | null;
+    passMark?: number | null;
+    questionsPerPage?: number | null;
+    allowGoBack?: boolean | null;
+    requireAllAnswered?: boolean | null;
+};
+/**
+ * User's answer to a question
+ */
+type UserAnswer = {
+    questionId: number;
+    selectedChoiceIds: string[];
+};
+/**
+ * Quiz state for the reducer
+ */
+type QuizState = {
+    status: 'loading' | 'ready' | 'in_progress' | 'completed';
+    questions: QuizQuestion[];
+    currentQuestionIndex: number;
+    answers: Map<number, string[]>;
+    startTime: number | null;
+    endTime: number | null;
+    timeRemaining: number;
+};
+/**
+ * Actions for the quiz reducer
+ */
+type QuizAction = {
+    type: 'SET_QUESTIONS';
+    questions: QuizQuestion[];
+} | {
+    type: 'START_QUIZ';
+    timeLimit: number;
+} | {
+    type: 'SELECT_ANSWER';
+    questionId: number;
+    choiceId: string;
+    isMultiple: boolean;
+} | {
+    type: 'DESELECT_ANSWER';
+    questionId: number;
+    choiceId: string;
+} | {
+    type: 'NEXT_QUESTION';
+} | {
+    type: 'PREV_QUESTION';
+} | {
+    type: 'GO_TO_QUESTION';
+    index: number;
+} | {
+    type: 'TICK_TIMER';
+} | {
+    type: 'FINISH_QUIZ';
+};
+/**
+ * Result of the quiz
+ */
+type QuizResult = {
+    totalQuestions: number;
+    correctAnswers: number;
+    incorrectAnswers: number;
+    unanswered: number;
+    score: number;
+    passed: boolean;
+    passMark: number;
+    timeTaken: number;
+    questionResults: QuestionResult[];
+};
+/**
+ * Result for a single question
+ */
+type QuestionResult = {
+    questionId: number;
+    question: string;
+    requiredAnswers: number;
+    isCorrect: boolean;
+    userAnswers: string[];
+    correctAnswers: string[];
+    choices: {
+        id: string;
+        text: string;
+        isCorrect: boolean;
+        wasSelected: boolean;
+        explanation?: RichTextData;
+    }[];
+    explanation?: RichTextData;
+};
+
+type QuizContextType = {
+    state: QuizState;
+    dispatch: React$1.Dispatch<QuizAction>;
+    currentQuestion: QuizQuestion | null;
+    isFirstQuestion: boolean;
+    isLastQuestion: boolean;
+    answeredCount: number;
+    selectAnswer: (choiceId: string) => void;
+    deselectAnswer: (choiceId: string) => void;
+    nextQuestion: () => void;
+    prevQuestion: () => void;
+    goToQuestion: (index: number) => void;
+    finishQuiz: () => void;
+    calculateResults: (passMark: number) => QuizResult;
+};
+declare function QuizProvider({ children, questions, timeLimit, }: {
+    children: React$1.ReactNode;
+    questions: QuizQuestion[];
+    timeLimit: number;
+}): react_jsx_runtime.JSX.Element;
+declare function useQuiz(): QuizContextType;
+
+type Props$4 = {
+    timeRemaining: number;
+    className?: string;
+};
+declare function QuizTimer({ timeRemaining, className }: Props$4): react_jsx_runtime.JSX.Element;
+
+type Props$3 = {
+    currentIndex: number;
+    totalQuestions: number;
+    answeredQuestions: Set<number>;
+    onQuestionClick?: (index: number) => void;
+    allowNavigation?: boolean;
+    className?: string;
+};
+declare function QuizProgress({ currentIndex, totalQuestions, answeredQuestions, onQuestionClick, allowNavigation, className, }: Props$3): react_jsx_runtime.JSX.Element;
+
+type Props$2 = {
+    question: QuizQuestion;
+    selectedChoiceIds: string[];
+    onSelectChoice: (choiceId: string) => void;
+    onDeselectChoice: (choiceId: string) => void;
+    className?: string;
+};
+declare function QuestionCard({ question, selectedChoiceIds, onSelectChoice, onDeselectChoice, className, }: Props$2): react_jsx_runtime.JSX.Element;
+
+type Props$1 = {
+    id: string;
+    text: string;
+    isSelected: boolean;
+    isMultiple: boolean;
+    onClick: () => void;
+    disabled?: boolean;
+    showResult?: boolean;
+    isCorrect?: boolean;
+    className?: string;
+};
+declare function ChoiceOption({ id, text, isSelected, isMultiple, onClick, disabled, showResult, isCorrect, className, }: Props$1): react_jsx_runtime.JSX.Element;
+
+type Props = {
+    result: QuizResult;
+    testSlug: string;
+    className?: string;
+    /** Optional custom component for rendering rich text explanations */
+    RichTextComponent?: RichTextRenderer;
+};
+declare function QuizResults({ result, testSlug, className, RichTextComponent }: Props): react_jsx_runtime.JSX.Element;
+
+/**
+ * Types for TestCard component
+ * These are standalone and don't depend on generated payload-types
+ */
+/**
+ * Media object structure (simplified)
+ */
+type TestCardMedia = {
+    url?: string | null;
+    alt?: string | null;
+    width?: number | null;
+    height?: number | null;
+    [key: string]: unknown;
+};
+/**
+ * Certificate type structure
+ */
+type TestCardCertificateType = {
+    id?: number | string;
+    shortName?: string | null;
+    title?: string | null;
+    [key: string]: unknown;
+};
+/**
+ * Test meta information
+ */
+type TestCardMeta = {
+    title?: string | null;
+    description?: string | null;
+    image?: TestCardMedia | number | string | null;
+};
+/**
+ * Data structure for a test card
+ */
+type TestCardData = {
+    id?: number | string;
+    slug?: string | null;
+    title?: string | null;
+    certificateType?: TestCardCertificateType | number | string | null;
+    meta?: TestCardMeta | null;
+    questionCount?: number | null;
+    timeLimit?: number | null;
+    passMark?: number | null;
+};
+/**
+ * Props for the TestCard component
+ */
+type TestCardProps = {
+    /** Test data to display */
+    doc?: TestCardData;
+    /** Override title */
+    title?: string;
+    /** Additional class names */
+    className?: string;
+    /** Custom media renderer component */
+    MediaComponent?: React.ComponentType<{
+        resource: TestCardMedia;
+        size?: string;
+        fill?: boolean;
+        pictureClassName?: string;
+        imgClassName?: string;
+    }>;
+};
+
+/**
+ * TestCard component for displaying test information in a card format
+ *
+ * @example
+ * ```tsx
+ * import { TestCard } from '@/plugins/quiz/client'
+ * import { Media } from '@/components/Media'
+ *
+ * <TestCard
+ *   doc={test}
+ *   MediaComponent={({ resource, size }) => (
+ *     <Media resource={resource} size={size} />
+ *   )}
+ * />
+ * ```
+ */
+declare function TestCard({ doc, title: titleFromProps, className, MediaComponent }: TestCardProps): react_jsx_runtime.JSX.Element;
+
+/**
+ * Utility function for merging Tailwind CSS classes
+ * This is a common pattern used with ShadCN/Tailwind
+ */
+
+declare function cn(...inputs: ClassValue[]): string;
+
+export { ChoiceOption, QuestionCard, type QuestionResult, type QuizAction, type QuizChoice, QuizProgress, QuizProvider, type QuizQuestion, type QuizResult, QuizResults, type QuizState, type QuizTest, QuizTimer, type RichTextData, type RichTextRenderer, TestCard, type TestCardCertificateType, type TestCardData, type TestCardMedia, type TestCardMeta, type TestCardProps, type UserAnswer, cn, useQuiz };