@thanh01.pmt/interactive-quiz-kit 1.0.23 → 1.0.25

package/dist/index.d.ts

@@ -0,0 +1,444 @@
+import { f as QuizQuestion, r as QuizConfig, Q as QuestionTypeStrings, p as SCORMSettings } from './quiz-config-1gNNhljP.js';
+export { B as BaseQuestion, d as BlocklyProgrammingQuestion, C as CodingQuestion, D as DragAndDropQuestion, k as DraggableItem, l as DropZone, F as FillInTheBlanksQuestion, m as HotspotArea, H as HotspotQuestion, j as MatchOptionItem, i as MatchPromptItem, c as MatchingQuestion, M as MultipleChoiceQuestion, a as MultipleResponseQuestion, N as NumericQuestion, g as QuestionOption, q as QuizSettings, R as RichContentString, e as ScratchProgrammingQuestion, h as SequenceItem, b as SequenceQuestion, S as ShortAnswerQuestion, o as SupportedCodingLanguage, n as TestCase, T as TrueFalseQuestion } from './quiz-config-1gNNhljP.js';
+import { Q as QuizResultType, U as UserAnswerType, I as ImportError, y as Goal, n as PracticeSession, h as QuizReviewContent, p as PracticeSessionSummary, o as PracticeStats, j as AchievementDefinition, i as Achievement, K as KnowledgeCard } from './ai-ecosystem-BJ5RR5Ys.js';
+export { r as ActivityCalendarData, u as AnalysisReport, A as AnswerDetail, x as ChatContext, C as ChatMessage, v as DashboardCardConfig, D as DashboardCardId, w as DashboardLayout, G as GoalType, t as ImageContextItem, L as LearningAnalysis, e as PerformanceByBloomLevel, b as PerformanceByCategory, d as PerformanceByDifficulty, P as PerformanceByLearningObjective, c as PerformanceByTopic, f as PerformanceMetric, s as PerformanceSummary, k as PracticeDifficulty, m as PracticeSuggestion, l as PracticeSuggestionTopic, q as PracticeTopicSummary, g as QuestionReview, R as RoadmapItem, T as TestCaseResult, a as UserAnswers, W as WeeklyRoadmap } from './ai-ecosystem-BJ5RR5Ys.js';
+import { ClassValue } from 'clsx';
+
+interface CodeNamedEntity {
+    id: string;
+    code: string;
+    name: string;
+    description?: string;
+}
+interface Subject extends CodeNamedEntity {
+    createdAt: string;
+    updatedAt: string;
+}
+interface GradeLevel extends CodeNamedEntity {
+}
+interface BloomLevelType extends CodeNamedEntity {
+}
+interface QuestionTypeType extends CodeNamedEntity {
+}
+interface Category extends CodeNamedEntity {
+}
+interface Context extends CodeNamedEntity {
+}
+interface Topic extends CodeNamedEntity {
+    subjectCode: string;
+}
+type BloomLevelName = "Remembering" | "Understanding" | "Applying" | "Analyzing" | "Evaluating" | "Creating";
+type StandardDifficulty = "easy" | "medium" | "hard";
+type KnowledgeDimension = "Factual" | "Conceptual" | "Procedural";
+type ApproachTableRawDifficulty = "E" | "M" | "H" | "E~M" | "M~H";
+interface Approach extends CodeNamedEntity {
+    verbEn: string;
+    verbVi: string;
+    bloomLevelCode: string;
+    knowledgeDimension: KnowledgeDimension;
+    iSpringQuizType: string;
+    rawDifficulty: ApproachTableRawDifficulty;
+    difficulty: StandardDifficulty;
+    suggestContext?: string;
+    exampleEn?: string;
+    exampleVi?: string;
+}
+interface LearningObjectiveMetadata extends CodeNamedEntity {
+    subjectCode?: string;
+}
+
+/**
+ * Represents the structure of a question as stored within the Question Bank.
+ * It combines the rich, flexible configuration from IQ-Kit's QuizQuestion
+ * with the structured metadata needed for management and filtering, inspired by QMS.
+ */
+interface QuestionInBank {
+    id: string;
+    code: string;
+    text: string;
+    lastModified: string;
+    questionTypeCode: string;
+    subjectCode: string;
+    topicCode: string;
+    gradeLevelCode: string;
+    bloomLevelCode: string;
+    difficulty?: StandardDifficulty;
+    approachCode?: string;
+    learningObjectiveCode?: string;
+    contextCode?: string;
+    categoryCode?: string;
+    gradeBand?: string;
+    course?: string;
+    createdAt?: string;
+    questionConfig: QuizQuestion;
+}
+
+interface LearningObjective {
+    loId: string;
+    loDescription: string;
+    subject: string;
+    category: string;
+    topic: string;
+    keywords: string[];
+    grade: string;
+    stemElements: string[];
+    bloomLevelsGuideline: string[];
+}
+
+interface QuizEngineCallbacks {
+    onQuizStart?: (initialData: {
+        initialQuestion: QuizQuestion | null;
+        currentQuestionNumber: number;
+        totalQuestions: number;
+        timeLimitInSeconds: number | null;
+        scormStatus?: QuizResultType['scormStatus'];
+        studentName?: string;
+    }) => void;
+    onQuestionChange?: (question: QuizQuestion | null, currentQuestionNumber: number, totalQuestions: number) => void;
+    onAnswerSubmit?: (question: QuizQuestion, userAnswer: UserAnswerType) => void;
+    onQuizFinish?: (results: QuizResultType) => void;
+    onTimeTick?: (timeLeftInSeconds: number) => void;
+    onQuizTimeUp?: () => void;
+}
+interface QuizEngineConstructorOptions {
+    config: QuizConfig;
+    callbacks?: QuizEngineCallbacks;
+}
+
+declare class QuizEngine {
+    private config;
+    private userAnswers;
+    private currentQuestionIndex;
+    questions: QuizQuestion[];
+    private callbacks;
+    private timerId;
+    private timeLeftInSeconds;
+    private scormService;
+    private quizResultState;
+    private overallStartTime;
+    private questionStartTime;
+    private questionTimings;
+    private evaluators;
+    constructor(options: QuizEngineConstructorOptions);
+    private registerEvaluators;
+    private _recordCurrentQuestionTime;
+    private startTimer;
+    private stopTimer;
+    private handleTick;
+    getTimeLeftInSeconds(): number | null;
+    getCurrentQuestion(): QuizQuestion | null;
+    getCurrentQuestionNumber(): number;
+    getTotalQuestions(): number;
+    getUserAnswer(questionId: string): UserAnswerType | undefined;
+    isQuizFinished(): boolean;
+    submitAnswer(questionId: string, answer: UserAnswerType): void;
+    nextQuestion(): QuizQuestion | null;
+    previousQuestion(): QuizQuestion | null;
+    goToQuestion(index: number): QuizQuestion | null;
+    getElapsedTime(): number;
+    destroy(): void;
+    calculateResults(): Promise<QuizResultType>;
+    private formatUserAnswerDetail;
+    private _calculateMetadataPerformance;
+    private _sendResultsToWebhook;
+    private _sendResultsToSCORM;
+}
+
+/**
+ * A service class to manage and manipulate a QuizConfig object in a headless way.
+ * This class operates on a deep copy of the initial quiz config to prevent side effects.
+ */
+declare class QuizEditorService {
+    private quiz;
+    constructor(initialQuiz: QuizConfig);
+    getQuiz(): QuizConfig;
+    static createNewQuestionTemplate(type: QuestionTypeStrings): QuizQuestion;
+    addQuestion(question: QuizQuestion): QuizConfig;
+    updateQuestion(updatedQuestion: QuizQuestion): QuizConfig;
+    deleteQuestionByIndex(index: number): QuizConfig;
+    moveQuestion(fromIndex: number, toIndex: number): QuizConfig;
+}
+
+/**
+ * Provides static methods for importing questions from JSON and TSV formats.
+ */
+declare class QuestionImportService {
+    static processJSON(jsonString: string): {
+        validQuestions: QuizQuestion[];
+        errors: ImportError[];
+    };
+    static processTSV(tsvString: string): {
+        validQuestions: QuizQuestion[];
+        errors: ImportError[];
+    };
+    private static processRawObjects;
+    private static transformTsvRowToRawObject;
+    private static createQuestionFromRawObject;
+}
+
+declare const GEMINI_API_KEY_SERVICE_NAME = "gemini";
+declare class APIKeyService {
+    private static getStorageKey;
+    /**
+     * Saves an API key to localStorage. The key is mildly obfuscated using Base64.
+     * @param serviceName - The name of the service (e.g., 'gemini').
+     * @param apiKey - The API key to save.
+     */
+    static saveAPIKey(serviceName: string, apiKey: string): void;
+    /**
+     * Retrieves an API key from localStorage.
+     * @param serviceName - The name of the service.
+     * @returns The decoded API key, or null if not found or if localStorage is unavailable.
+     */
+    static getAPIKey(serviceName: string): string | null;
+    /**
+     * Removes an API key from localStorage.
+     * @param serviceName - The name of the service.
+     */
+    static removeAPIKey(serviceName: string): void;
+    /**
+     * Checks if an API key exists in localStorage for the given service.
+     * @param serviceName - The name of the service.
+     * @returns True if a key exists, false otherwise.
+     */
+    static hasAPIKey(serviceName: string): boolean;
+}
+
+/**
+ * A headless, static service for managing user-specific configurations
+ * stored in the browser's localStorage.
+ */
+declare class UserConfigService {
+    private static getStorageKey;
+    static setConfig(key: string, value: any): void;
+    static getConfig<T>(key: string, defaultValue?: T | null): T | null;
+    static removeConfig(key: string): void;
+    static getFullName(): string | null;
+    static setFullName(name: string): void;
+    static getWeeklyGoal(): number | null;
+    static setWeeklyGoal(goal: number): void;
+    static getLanguage(): string;
+    static setLanguage(language: string): void;
+    static getGoals(): Goal[];
+    static saveGoals(goals: Goal[]): void;
+    /**
+     * Adds a new goal to the user's list. The goal object should not contain a description.
+     * @param newGoal A partial Goal object without id, description, isAchieved, or achievedAt.
+     */
+    static addGoal(newGoal: Omit<Goal, 'id' | 'isAchieved' | 'achievedAt'>): void;
+    static updateGoal(updatedGoal: Goal): void;
+    static deleteGoal(goalId: string): void;
+}
+
+declare class PracticeHistoryService {
+    static getPracticeHistory(): PracticeSession[];
+    private static saveHistory;
+    static saveCompletedPracticeSession(quizConfig: QuizConfig, result: QuizResultType, review?: QuizReviewContent | null): string;
+    static updatePracticeReview(sessionId: string, review: QuizReviewContent): void;
+    static getPracticeSessionById(sessionId: string): PracticeSession | null;
+    static getPracticeHistorySummary(): PracticeSessionSummary[];
+    static getPracticeStats(): PracticeStats;
+    static clearHistory(): void;
+}
+
+declare class AchievementService {
+    static getUnlockedAchievementsMap(): Record<string, number>;
+    private static saveUnlockedAchievementsMap;
+    static checkAndUnlockAchievements(history: PracticeSession[], stats: PracticeStats): AchievementDefinition[];
+    static getAllAchievementDefinitions(): AchievementDefinition[];
+    static getAllAchievementsWithStatus(): Achievement[];
+}
+
+interface Quote {
+    text: string;
+    author: string;
+}
+/**
+ * A headless, static service for providing motivational quotes.
+ */
+declare class QuoteService {
+    /**
+     * Retrieves a random quote from the internal quote bank.
+     * @returns A quote object containing text and author.
+     */
+    static getRandomQuote(): Quote;
+}
+
+interface KnowledgeCardStore {
+    sourceHash: string | null;
+    conceptsPlan: string[];
+    generatedConcepts: Record<string, boolean>;
+    cards: KnowledgeCard[];
+}
+/**
+ * A headless, static service for managing Knowledge Cards (Cheatsheet/Flashcards)
+ * stored in the browser's localStorage, with support for a resumable generation queue.
+ */
+declare class KnowledgeCardService {
+    static generateHash(str: string): string;
+    static getStore(): KnowledgeCardStore;
+    private static saveStore;
+    static getSourceHash(): string | null;
+    /**
+     * Saves a new card generation plan. This clears old cards and resets the generation progress.
+     * @param sourceHash The hash of the new source content.
+     * @param concepts An array of concept strings to be generated.
+     */
+    static saveCardPlan(sourceHash: string, concepts: string[]): void;
+    /**
+     * Saves a newly generated card to the store and marks its concept as completed.
+     * @param card The KnowledgeCard object to save.
+     */
+    static saveGeneratedCard(card: KnowledgeCard): void;
+    /**
+     * Gets the list of concepts that are in the plan but have not been generated yet.
+     * @returns An array of concept strings that are pending generation.
+     */
+    static getPendingConcepts(): string[];
+    /**
+     * Gets the current status of the card generation process.
+     * @returns An object with the total number of cards planned and the number completed.
+     */
+    static getGenerationStatus(): {
+        total: number;
+        completed: number;
+    };
+    /**
+     * Checks if a generation process is currently marked as running in this browser tab/session.
+     * Uses sessionStorage to prevent multiple tabs from running the same process.
+     * @returns True if a process is marked as running, false otherwise.
+     */
+    static isGenerationInProgress(): boolean;
+    /**
+     * Sets or clears the flag indicating that a generation process is active.
+     * @param status The status to set (true for running, false for stopped).
+     */
+    static setGenerationStatus(status: boolean): void;
+    static getCards(): KnowledgeCard[];
+    static getRandomCard(): KnowledgeCard | null;
+    static searchCards(query: string): KnowledgeCard[];
+}
+
+declare class MetadataService {
+    static getSubjects: () => Subject[];
+    static addSubject: (name: string, code: string) => Subject;
+    static updateSubject: (id: string, name: string, code: string) => Subject | null;
+    static deleteSubject: (code: string) => boolean;
+    static getGradeLevels: () => GradeLevel[];
+    static addGradeLevel: (name: string, code: string) => GradeLevel;
+    static updateGradeLevel: (id: string, name: string, code: string) => GradeLevel | null;
+    static deleteGradeLevel: (code: string) => boolean;
+    static getTopics: (subjectCode?: string) => Topic[];
+    static addTopic: (name: string, code: string, subjectCode: string) => Topic;
+    static updateTopic: (id: string, name: string, code: string, subjectCode: string) => Topic | null;
+    static deleteTopic: (code: string) => boolean;
+    static getBloomLevels: () => BloomLevelType[];
+    static addBloomLevel: (name: string, code: string, description?: string) => BloomLevelType;
+    static updateBloomLevel: (id: string, name: string, code: string, description?: string) => BloomLevelType | null;
+    static deleteBloomLevel: (code: string) => boolean;
+    static getQuestionTypes: () => QuestionTypeType[];
+    static addQuestionType: (name: string, code: string, description?: string) => QuestionTypeType;
+    static updateQuestionType: (id: string, name: string, code: string, description?: string) => QuestionTypeType | null;
+    static deleteQuestionType: (code: string) => boolean;
+    static getCategories: () => Category[];
+    static addCategory: (name: string, code: string, description?: string) => Category;
+    static updateCategory: (id: string, name: string, code: string, description?: string) => Category | null;
+    static deleteCategory: (code: string) => boolean;
+    static getContexts: () => Context[];
+    static addContext: (name: string, code: string, description?: string) => Context;
+    static updateContext: (id: string, name: string, code: string, description?: string) => Context | null;
+    static deleteContext: (code: string) => boolean;
+    static getApproaches: () => Approach[];
+    static addApproach: (approachData: Omit<Approach, "id" | "difficulty">) => Approach;
+    static updateApproach: (id: string, approachData: Partial<Omit<Approach, "id" | "difficulty">>) => Approach | null;
+    static deleteApproach: (code: string) => boolean;
+    static getLearningObjectives: (subjectCode?: string) => LearningObjectiveMetadata[];
+    static addLearningObjective: (name: string, code: string, subjectCode?: string, description?: string) => LearningObjectiveMetadata;
+    static updateLearningObjective: (id: string, name: string, code: string, subjectCode?: string, description?: string) => LearningObjectiveMetadata | null;
+    static deleteLearningObjective: (code: string) => boolean;
+}
+
+interface QuestionFilters {
+    subjectCode?: string;
+    topicCode?: string;
+    gradeLevelCode?: string;
+    bloomLevelCode?: string;
+    questionTypeCode?: string;
+    searchTerm?: string;
+    difficulty?: StandardDifficulty;
+}
+declare class QuestionBankService {
+    static getQuestions(filters?: QuestionFilters): QuestionInBank[];
+    static getQuestionByCode(code: string): QuestionInBank | undefined;
+    static addQuestion(questionData: Omit<QuestionInBank, 'id' | 'lastModified'>): QuestionInBank;
+    static updateQuestion(id: string, updates: Partial<Omit<QuestionInBank, 'id'>>): QuestionInBank | null;
+    static deleteQuestionByCode(code: string): boolean;
+}
+
+declare const generateLauncherHTML: (quizConfig: QuizConfig, libraryJSPath: string, quizDataPath: string, blocklyCSSPath: string, mainCSSPath: string, title?: string) => string;
+
+declare const generateSCORMManifest: (quizConfig: QuizConfig, scormVersion: "1.2" | "2004", // Explicitly take version
+launcherFile?: string, libraryJSPath?: string, quizDataPath?: string, blocklyCSSPath?: string, mainCSSPath?: string) => string;
+
+interface SCORMExportOptions {
+    scormVersion: "1.2" | "2004";
+}
+declare const exportQuizAsSCORMZip: (quiz: QuizConfig, options: SCORMExportOptions) => Promise<{
+    success: boolean;
+    error?: string;
+    fileName?: string;
+}>;
+
+declare class SCORMService {
+    private scormAPI;
+    private scormVersionFound;
+    private settings;
+    private isInitialized;
+    private isTerminated;
+    studentName: string | null;
+    constructor(settings: SCORMSettings);
+    private _findAPIRecursive;
+    private _findAPI;
+    hasAPI(): boolean;
+    getSCORMVersion(): "1.2" | "2004" | null;
+    initialize(): {
+        success: boolean;
+        error?: string;
+        studentName?: string;
+    };
+    terminate(): {
+        success: boolean;
+        error?: string;
+    };
+    setValue(element: string, value: string | number | boolean): {
+        success: boolean;
+        error?: string;
+    };
+    getValue(element: string): string | null;
+    commit(): {
+        success: boolean;
+        error?: string;
+    };
+    setScore(rawScore: number, maxScore: number, minScore?: number): void;
+    setLessonStatus(status: 'passed' | 'failed' | 'completed' | 'incomplete' | 'browsed', passed?: boolean): void;
+    getLastError(): {
+        code: string;
+        message: string;
+        diagnostic?: string;
+    };
+    formatCMITime(totalSeconds: number): string;
+}
+
+declare const sampleQuiz: QuizConfig;
+declare const emptyQuiz: QuizConfig;
+
+/**
+ * Generates a simple unique ID.
+ * @param prefix Optional prefix for the ID.
+ * @returns A string representing the unique ID.
+ */
+declare function generateUniqueId(prefix?: string): string;
+
+declare function cn(...inputs: ClassValue[]): string;
+
+export { APIKeyService, Achievement, AchievementDefinition, AchievementService, type Approach, type ApproachTableRawDifficulty, type BloomLevelName, type BloomLevelType, type Category, type CodeNamedEntity, type Context, GEMINI_API_KEY_SERVICE_NAME, Goal, type GradeLevel, ImportError, KnowledgeCard, KnowledgeCardService, type KnowledgeDimension, type LearningObjective, type LearningObjectiveMetadata, MetadataService, PracticeHistoryService, PracticeSession, PracticeSessionSummary, PracticeStats, QuestionBankService, type QuestionFilters, QuestionImportService, type QuestionInBank, QuestionTypeStrings, type QuestionTypeType, QuizConfig, QuizEditorService, QuizEngine, type QuizEngineCallbacks, type QuizEngineConstructorOptions, QuizQuestion, QuizResultType, QuizReviewContent, QuoteService, SCORMService, SCORMSettings, type StandardDifficulty, type Subject, type Topic, UserAnswerType, UserConfigService, cn, emptyQuiz, exportQuizAsSCORMZip, generateLauncherHTML, generateSCORMManifest, generateUniqueId, sampleQuiz };