@telebort/question-banks 1.0.0

package/dist/index.d.cts

@@ -0,0 +1,213 @@
+import { Course, Lesson, Question } from './schemas/index.cjs';
+export { BloomsTaxonomy, BloomsTaxonomySchema, CourseDomain, CourseDomainSchema, CourseSchema, CourseSummary, CourseSummarySchema, CourseTier, CourseTierSchema, Difficulty, DifficultySchema, Feedback, FeedbackSchema, LessonSchema, Option, OptionKey, OptionKeySchema, OptionSchema, QuestionArchetype, QuestionArchetypeSchema, QuestionMetadata, QuestionMetadataSchema, QuestionSchema, QuestionType, QuestionTypeSchema, QuestionWithoutAnswer, QuestionWithoutAnswerSchema } from './schemas/index.cjs';
+export { c as AssessmentSubmission, A as AssessmentSubmissionSchema, f as GradedAssessment, a as GradedAssessmentSchema, d as GradedResponse, G as GradedResponseSchema, e as MisconceptionReport, M as MisconceptionReportSchema, b as UserResponse, U as UserResponseSchema, g as ValidationResult, V as ValidationResultSchema } from './assessment-EEJoYtXy.cjs';
+import { Q as QuestionFilters, a as QuizCriteria, S as SearchOptions, b as Statistics, E as ExitTicketsConfig } from './index-BPlb4Ksx.cjs';
+export { C as CacheAdapter, D as DataSource } from './index-BPlb4Ksx.cjs';
+import 'zod';
+
+/**
+ * Core interfaces for the Exit Tickets SDK
+ */
+
+/**
+ * Query result with pagination
+ */
+interface QueryResult<T> {
+    data: T[];
+    total: number;
+    limit: number;
+    offset: number;
+    hasMore: boolean;
+}
+/**
+ * Data loader service interface
+ */
+interface IDataLoader {
+    loadCourses(): Promise<Course[]>;
+    getCourse(courseId: string): Promise<Course | null>;
+    getLesson(courseId: string, lessonNumber: number): Promise<Lesson | null>;
+    getQuestion(questionId: string): Promise<Question | null>;
+    getQuestionByGlobalId(globalId: string): Promise<Question | null>;
+    getAllQuestions(): Promise<Question[]>;
+}
+/**
+ * Query service interface
+ */
+interface IQueryService {
+    filterQuestions(filters: QuestionFilters): Promise<QueryResult<Question>>;
+    getRandomQuestions(count: number, filters?: QuestionFilters): Promise<Question[]>;
+    getQuestionTypes(): Promise<string[]>;
+    getDifficulties(): Promise<string[]>;
+    getAllTags(): Promise<string[]>;
+}
+/**
+ * Quiz generator service interface
+ */
+interface IQuizGenerator {
+    generateQuiz(criteria: QuizCriteria): Promise<{
+        questions: Question[];
+        metadata: {
+            distribution: Record<string, number>;
+            timestamp: string;
+        };
+    }>;
+    getLessonQuiz(courseId: string, lessonNumber: number): Promise<Question[]>;
+}
+/**
+ * Search service interface
+ */
+interface ISearchService {
+    search(options: SearchOptions): Promise<QueryResult<Question & {
+        relevanceScore: number;
+    }>>;
+    searchByTags(tags: string[], matchAll?: boolean): Promise<Question[]>;
+}
+/**
+ * Analytics service interface
+ */
+interface IAnalyticsService {
+    getStatistics(): Promise<Statistics>;
+    getCourseStatistics(courseId: string): Promise<Statistics & {
+        courseId: string;
+    }>;
+}
+/**
+ * Validation service interface (for answer checking)
+ */
+interface IValidationService {
+    validateAnswer(questionId: string, answer: string, mode: 'formative' | 'summative'): Promise<{
+        isCorrect: boolean;
+        feedback?: {
+            short: string;
+            detailed?: string;
+            socraticHint?: string;
+        };
+        misconceptionId?: string | null;
+        correctAnswer?: string;
+    }>;
+}
+
+/**
+ * @telebort/exit-tickets - Exit Tickets SDK
+ *
+ * Three-tier access to exit ticket questions and assessments:
+ *
+ * ## Free Tier - Schemas
+ * ```typescript
+ * import { QuestionSchema } from '@telebort/exit-tickets/schemas'
+ * ```
+ *
+ * ## Standard Tier - Validation API
+ * ```typescript
+ * import { ValidationClient } from '@telebort/exit-tickets/validation'
+ * ```
+ *
+ * ## Premium Tier - Full Access
+ * ```typescript
+ * import { PremiumClient } from '@telebort/exit-tickets/premium'
+ * ```
+ *
+ * ## SDK Factory (for custom data sources)
+ * ```typescript
+ * import { createExitTicketsSDK } from '@telebort/exit-tickets'
+ *
+ * const sdk = createExitTicketsSDK({
+ *   dataSource: {
+ *     async loadCourses() {
+ *       return myQuestionData
+ *     }
+ *   }
+ * })
+ * ```
+ */
+
+/**
+ * Exit Tickets SDK instance
+ */
+interface ExitTicketsSDK {
+    /**
+     * Data access methods
+     */
+    data: {
+        getCourses(): Promise<Course[]>;
+        getCourse(courseId: string): Promise<Course | null>;
+        getLesson(courseId: string, lessonNumber: number): Promise<Lesson | null>;
+        getQuestion(questionId: string): Promise<Question | null>;
+        getAllQuestions(): Promise<Question[]>;
+    };
+    /**
+     * Query methods
+     */
+    query: {
+        filterQuestions(filters: QuestionFilters): Promise<QueryResult<Question>>;
+        getRandomQuestions(count: number, filters?: QuestionFilters): Promise<Question[]>;
+    };
+    /**
+     * Quiz generation
+     */
+    quiz: {
+        generateQuiz(criteria: QuizCriteria): Promise<{
+            questions: Question[];
+            metadata: Record<string, unknown>;
+        }>;
+        getLessonQuiz(courseId: string, lessonNumber: number): Promise<Question[]>;
+    };
+    /**
+     * Search
+     */
+    search: {
+        search(options: SearchOptions): Promise<QueryResult<Question & {
+            relevanceScore: number;
+        }>>;
+        searchByTags(tags: string[], matchAll?: boolean): Promise<Question[]>;
+    };
+    /**
+     * Analytics
+     */
+    analytics: {
+        getStatistics(): Promise<Statistics>;
+        getCourseStatistics(courseId: string): Promise<Statistics & {
+            courseId: string;
+        }>;
+    };
+    /**
+     * Answer validation (requires question data loaded)
+     */
+    validate: {
+        checkAnswer(questionId: string, answer: string, mode: 'formative' | 'summative'): Promise<{
+            isCorrect: boolean;
+            feedback?: {
+                short: string;
+                detailed?: string;
+                socraticHint?: string;
+            };
+            misconceptionId?: string | null;
+            correctAnswer?: string;
+        }>;
+    };
+}
+/**
+ * Create an Exit Tickets SDK instance
+ *
+ * @param config - SDK configuration with data source
+ * @returns SDK instance with all services
+ *
+ * @example
+ * ```typescript
+ * // Using static JSON import
+ * import coursesData from './data/courses.json'
+ *
+ * const sdk = createExitTicketsSDK({
+ *   dataSource: {
+ *     async loadCourses() {
+ *       return coursesData
+ *     }
+ *   }
+ * })
+ *
+ * const questions = await sdk.query.filterQuestions({ courseId: 'ai-1' })
+ * ```
+ */
+declare function createExitTicketsSDK(config: ExitTicketsConfig): ExitTicketsSDK;
+
+export { Course, ExitTicketsConfig, type ExitTicketsSDK, type IAnalyticsService, type IDataLoader, type IQueryService, type IQuizGenerator, type ISearchService, type IValidationService, Lesson, type QueryResult, Question, QuestionFilters, QuizCriteria, SearchOptions, Statistics, createExitTicketsSDK };

package/dist/index.d.ts

@@ -0,0 +1,213 @@
+import { Course, Lesson, Question } from './schemas/index.js';
+export { BloomsTaxonomy, BloomsTaxonomySchema, CourseDomain, CourseDomainSchema, CourseSchema, CourseSummary, CourseSummarySchema, CourseTier, CourseTierSchema, Difficulty, DifficultySchema, Feedback, FeedbackSchema, LessonSchema, Option, OptionKey, OptionKeySchema, OptionSchema, QuestionArchetype, QuestionArchetypeSchema, QuestionMetadata, QuestionMetadataSchema, QuestionSchema, QuestionType, QuestionTypeSchema, QuestionWithoutAnswer, QuestionWithoutAnswerSchema } from './schemas/index.js';
+export { c as AssessmentSubmission, A as AssessmentSubmissionSchema, f as GradedAssessment, a as GradedAssessmentSchema, d as GradedResponse, G as GradedResponseSchema, e as MisconceptionReport, M as MisconceptionReportSchema, b as UserResponse, U as UserResponseSchema, g as ValidationResult, V as ValidationResultSchema } from './assessment-EEJoYtXy.js';
+import { Q as QuestionFilters, a as QuizCriteria, S as SearchOptions, b as Statistics, E as ExitTicketsConfig } from './index-BdbmdJgH.js';
+export { C as CacheAdapter, D as DataSource } from './index-BdbmdJgH.js';
+import 'zod';
+
+/**
+ * Core interfaces for the Exit Tickets SDK
+ */
+
+/**
+ * Query result with pagination
+ */
+interface QueryResult<T> {
+    data: T[];
+    total: number;
+    limit: number;
+    offset: number;
+    hasMore: boolean;
+}
+/**
+ * Data loader service interface
+ */
+interface IDataLoader {
+    loadCourses(): Promise<Course[]>;
+    getCourse(courseId: string): Promise<Course | null>;
+    getLesson(courseId: string, lessonNumber: number): Promise<Lesson | null>;
+    getQuestion(questionId: string): Promise<Question | null>;
+    getQuestionByGlobalId(globalId: string): Promise<Question | null>;
+    getAllQuestions(): Promise<Question[]>;
+}
+/**
+ * Query service interface
+ */
+interface IQueryService {
+    filterQuestions(filters: QuestionFilters): Promise<QueryResult<Question>>;
+    getRandomQuestions(count: number, filters?: QuestionFilters): Promise<Question[]>;
+    getQuestionTypes(): Promise<string[]>;
+    getDifficulties(): Promise<string[]>;
+    getAllTags(): Promise<string[]>;
+}
+/**
+ * Quiz generator service interface
+ */
+interface IQuizGenerator {
+    generateQuiz(criteria: QuizCriteria): Promise<{
+        questions: Question[];
+        metadata: {
+            distribution: Record<string, number>;
+            timestamp: string;
+        };
+    }>;
+    getLessonQuiz(courseId: string, lessonNumber: number): Promise<Question[]>;
+}
+/**
+ * Search service interface
+ */
+interface ISearchService {
+    search(options: SearchOptions): Promise<QueryResult<Question & {
+        relevanceScore: number;
+    }>>;
+    searchByTags(tags: string[], matchAll?: boolean): Promise<Question[]>;
+}
+/**
+ * Analytics service interface
+ */
+interface IAnalyticsService {
+    getStatistics(): Promise<Statistics>;
+    getCourseStatistics(courseId: string): Promise<Statistics & {
+        courseId: string;
+    }>;
+}
+/**
+ * Validation service interface (for answer checking)
+ */
+interface IValidationService {
+    validateAnswer(questionId: string, answer: string, mode: 'formative' | 'summative'): Promise<{
+        isCorrect: boolean;
+        feedback?: {
+            short: string;
+            detailed?: string;
+            socraticHint?: string;
+        };
+        misconceptionId?: string | null;
+        correctAnswer?: string;
+    }>;
+}
+
+/**
+ * @telebort/exit-tickets - Exit Tickets SDK
+ *
+ * Three-tier access to exit ticket questions and assessments:
+ *
+ * ## Free Tier - Schemas
+ * ```typescript
+ * import { QuestionSchema } from '@telebort/exit-tickets/schemas'
+ * ```
+ *
+ * ## Standard Tier - Validation API
+ * ```typescript
+ * import { ValidationClient } from '@telebort/exit-tickets/validation'
+ * ```
+ *
+ * ## Premium Tier - Full Access
+ * ```typescript
+ * import { PremiumClient } from '@telebort/exit-tickets/premium'
+ * ```
+ *
+ * ## SDK Factory (for custom data sources)
+ * ```typescript
+ * import { createExitTicketsSDK } from '@telebort/exit-tickets'
+ *
+ * const sdk = createExitTicketsSDK({
+ *   dataSource: {
+ *     async loadCourses() {
+ *       return myQuestionData
+ *     }
+ *   }
+ * })
+ * ```
+ */
+
+/**
+ * Exit Tickets SDK instance
+ */
+interface ExitTicketsSDK {
+    /**
+     * Data access methods
+     */
+    data: {
+        getCourses(): Promise<Course[]>;
+        getCourse(courseId: string): Promise<Course | null>;
+        getLesson(courseId: string, lessonNumber: number): Promise<Lesson | null>;
+        getQuestion(questionId: string): Promise<Question | null>;
+        getAllQuestions(): Promise<Question[]>;
+    };
+    /**
+     * Query methods
+     */
+    query: {
+        filterQuestions(filters: QuestionFilters): Promise<QueryResult<Question>>;
+        getRandomQuestions(count: number, filters?: QuestionFilters): Promise<Question[]>;
+    };
+    /**
+     * Quiz generation
+     */
+    quiz: {
+        generateQuiz(criteria: QuizCriteria): Promise<{
+            questions: Question[];
+            metadata: Record<string, unknown>;
+        }>;
+        getLessonQuiz(courseId: string, lessonNumber: number): Promise<Question[]>;
+    };
+    /**
+     * Search
+     */
+    search: {
+        search(options: SearchOptions): Promise<QueryResult<Question & {
+            relevanceScore: number;
+        }>>;
+        searchByTags(tags: string[], matchAll?: boolean): Promise<Question[]>;
+    };
+    /**
+     * Analytics
+     */
+    analytics: {
+        getStatistics(): Promise<Statistics>;
+        getCourseStatistics(courseId: string): Promise<Statistics & {
+            courseId: string;
+        }>;
+    };
+    /**
+     * Answer validation (requires question data loaded)
+     */
+    validate: {
+        checkAnswer(questionId: string, answer: string, mode: 'formative' | 'summative'): Promise<{
+            isCorrect: boolean;
+            feedback?: {
+                short: string;
+                detailed?: string;
+                socraticHint?: string;
+            };
+            misconceptionId?: string | null;
+            correctAnswer?: string;
+        }>;
+    };
+}
+/**
+ * Create an Exit Tickets SDK instance
+ *
+ * @param config - SDK configuration with data source
+ * @returns SDK instance with all services
+ *
+ * @example
+ * ```typescript
+ * // Using static JSON import
+ * import coursesData from './data/courses.json'
+ *
+ * const sdk = createExitTicketsSDK({
+ *   dataSource: {
+ *     async loadCourses() {
+ *       return coursesData
+ *     }
+ *   }
+ * })
+ *
+ * const questions = await sdk.query.filterQuestions({ courseId: 'ai-1' })
+ * ```
+ */
+declare function createExitTicketsSDK(config: ExitTicketsConfig): ExitTicketsSDK;
+
+export { Course, ExitTicketsConfig, type ExitTicketsSDK, type IAnalyticsService, type IDataLoader, type IQueryService, type IQuizGenerator, type ISearchService, type IValidationService, Lesson, type QueryResult, Question, QuestionFilters, QuizCriteria, SearchOptions, Statistics, createExitTicketsSDK };