@lessonkit/react 1.0.2 → 1.1.0

package/dist/index.d.cts

@@ -1,9 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
 import * as _lessonkit_core from '@lessonkit/core';
-import { CourseId, TelemetryUser, TrackingClient, LessonkitPlugin, ProgressState, LessonId, TelemetryEventName, TelemetryDataFor, PluginHost, BlockId, CheckId } from '@lessonkit/core';
-export { AssessmentScoreInput, AssessmentScoreResult, InteractionBlockRegistration, LessonkitPlugin, LessonkitPluginContext, LessonkitPluginKind, PluginHost, PluginRegistry, TelemetryPipelineSink, buildTelemetryEvent, createLessonkitRuntime, createPluginRegistry, createTelemetryPipeline, defineAssessmentPlugin, defineLifecyclePlugin, defineTelemetryPlugin } from '@lessonkit/core';
-import { AssessmentDescriptor } from '@lessonkit/lxpack';
+import { CourseId, TelemetryUser, TrackingClient, LessonkitPlugin, ProgressState, LessonId, TelemetryEventName, TelemetryDataFor, PluginHost, BlockId, AssessmentHandle, AssessmentBaseProps, AssessmentBehaviour, AssessmentAnsweredData, AssessmentCompletedData, CheckId } from '@lessonkit/core';
+export { AssessmentAnsweredData, AssessmentBaseProps, AssessmentBehaviour, AssessmentCompletedData, AssessmentHandle, AssessmentInteractionType, AssessmentScoreInput, AssessmentScoreResult, AssessmentXAPIData, InteractionBlockRegistration, LessonkitPlugin, LessonkitPluginContext, LessonkitPluginKind, PluginHost, PluginRegistry, TelemetryPipelineSink, buildTelemetryEvent, createLessonkitRuntime, createPluginRegistry, createTelemetryPipeline, defineAssessmentPlugin, defineLifecyclePlugin, defineTelemetryPlugin } from '@lessonkit/core';
+import { McqAssessmentDescriptor } from '@lessonkit/lxpack';
 import { XAPITransport, XAPIClient } from '@lessonkit/xapi';
 import { LxpackBridgeMode } from '@lessonkit/lxpack/bridge';
 import { LessonkitThemeV1, ThemePresetName, PartialLessonkitThemeV1 } from '@lessonkit/themes';
@@ -96,8 +96,8 @@ type ReflectionProps = {
     onChange?: (value: string) => void;
     children?: React.ReactNode;
 };
-type QuizProps = AssessmentDescriptor;
-type KnowledgeCheckProps = AssessmentDescriptor;
+type QuizProps = McqAssessmentDescriptor;
+type KnowledgeCheckProps = McqAssessmentDescriptor;
 type ProgressTrackerProps = {
     totalLessons?: number;
 };
@@ -109,6 +109,99 @@ declare function KnowledgeCheck(props: KnowledgeCheckProps): react_jsx_runtime.J
 declare function Quiz(props: QuizProps): react_jsx_runtime.JSX.Element;
 declare function ProgressTracker(props: ProgressTrackerProps): react_jsx_runtime.JSX.Element;
 
+type TrueFalseProps = AssessmentBaseProps & {
+    question: string;
+    answer: boolean;
+};
+declare const TrueFalse: React.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    question: string;
+    answer: boolean;
+} & React.RefAttributes<AssessmentHandle>>;
+
+type MarkTheWordsProps = AssessmentBaseProps & {
+    /** Plain text; words listed in `correctWords` are selectable targets. */
+    text: string;
+    correctWords: string[];
+};
+declare const MarkTheWords: React.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    /** Plain text; words listed in `correctWords` are selectable targets. */
+    text: string;
+    correctWords: string[];
+} & React.RefAttributes<AssessmentHandle>>;
+
+type FillInBlankSpec = {
+    id: string;
+    answer: string;
+};
+type FillInTheBlanksProps = AssessmentBaseProps & {
+    /** Text with `*` wrapping each blank answer, e.g. "The *capital* of France is *Paris*." */
+    template: string;
+    /** Optional explicit blanks (overrides parsing from template). */
+    blanks?: FillInBlankSpec[];
+};
+declare const FillInTheBlanks: React.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    /** Text with `*` wrapping each blank answer, e.g. "The *capital* of France is *Paris*." */
+    template: string;
+    /** Optional explicit blanks (overrides parsing from template). */
+    blanks?: FillInBlankSpec[];
+} & React.RefAttributes<AssessmentHandle>>;
+
+type DragTheWordsProps = AssessmentBaseProps & {
+    /** Sentence with `*` around drop zones; `words` are draggable options. */
+    template: string;
+    words: string[];
+};
+declare const DragTheWords: React.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    /** Sentence with `*` around drop zones; `words` are draggable options. */
+    template: string;
+    words: string[];
+} & React.RefAttributes<AssessmentHandle>>;
+
+type DragItem = {
+    id: string;
+    label: string;
+};
+type DropTarget = {
+    id: string;
+    label: string;
+    accepts: string;
+};
+type DragAndDropProps = AssessmentBaseProps & {
+    items: DragItem[];
+    targets: DropTarget[];
+};
+declare const DragAndDrop: React.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    items: DragItem[];
+    targets: DropTarget[];
+} & React.RefAttributes<AssessmentHandle>>;
+
+type AssessmentSequenceProps = AssessmentBehaviour & {
+    children: React.ReactNode;
+    /** Show one child assessment at a time (Question Set). */
+    sequential?: boolean;
+};
+declare function AssessmentSequence(props: AssessmentSequenceProps): react_jsx_runtime.JSX.Element;
+
+declare function useAssessmentState(enclosingLessonId?: LessonId): {
+    answer: (data: AssessmentAnsweredData) => void;
+    complete: (data: AssessmentCompletedData) => void;
+};
+
 declare function useLessonkit(): LessonkitRuntime;
 declare function useProgress(): _lessonkit_core.ProgressState;
 declare function useTracking(): {
@@ -122,6 +215,7 @@ declare function useCompletion(): {
     }) => void;
     completeCourse: () => void;
 };
+
 declare function useQuizState(enclosingLessonId?: LessonId): {
     answer: (opts: {
         checkId: CheckId;
@@ -137,6 +231,8 @@ declare function useQuizState(enclosingLessonId?: LessonId): {
     }) => void;
 };
 
+declare function resetAssessmentWarningsForTests(): void;
+
 type ThemeMode = "light" | "dark" | "system";
 type ThemeResolvedMode = "light" | "dark";
 type ThemeProviderProps = {
@@ -158,13 +254,14 @@ declare function ThemeProvider(props: ThemeProviderProps): react_jsx_runtime.JSX
 declare function useTheme(): ThemeContextValue;
 
 declare const blockCatalogVersion: 1;
+declare const blockCatalogV2Version: 2;
 type BlockPropSpec = {
     name: string;
     type: string;
     required: boolean;
     description: string;
 };
-type BlockCatalogEntry = {
+type BlockCatalogEntryBase = {
     type: string;
     aliases?: string[];
     category: "container" | "content" | "assessment" | "chrome";
@@ -191,6 +288,12 @@ type BlockCatalogEntry = {
         manualTracking?: string;
     };
 };
+type BlockCatalogEntry = BlockCatalogEntryBase;
+type BlockCatalogEntryV2 = BlockCatalogEntryBase & {
+    assessmentContract?: true;
+    h5pMachineName?: string;
+    h5pAlias?: string;
+};
 declare const BLOCK_CATALOG: ({
     type: string;
     category: "container";
@@ -398,7 +501,11 @@ declare const BLOCK_CATALOG: ({
     optionalIds?: undefined;
     aliases?: undefined;
 })[];
-declare function buildBlockCatalog(): BlockCatalogEntry[];
-declare function getBlockCatalogEntry(type: string): BlockCatalogEntry | undefined;
+declare const BLOCK_CATALOG_V2: BlockCatalogEntryV2[];
+type BuildBlockCatalogOptions = {
+    version?: 1 | 2;
+};
+declare function buildBlockCatalog(opts?: BuildBlockCatalogOptions): BlockCatalogEntry[] | BlockCatalogEntryV2[];
+declare function getBlockCatalogEntry(type: string, opts?: BuildBlockCatalogOptions): BlockCatalogEntry | BlockCatalogEntryV2 | undefined;
 
-export { BLOCK_CATALOG, type BlockCatalogEntry, type BlockPropSpec, Course, type CourseProps, KnowledgeCheck, type KnowledgeCheckProps, Lesson, type LessonProps, type LessonkitConfig, LessonkitProvider, type LessonkitProviderProps, type LessonkitRuntime, ProgressTracker, type ProgressTrackerProps, Quiz, type QuizProps, Reflection, type ReflectionProps, Scenario, type ScenarioProps, type ThemeContextValue, type ThemeMode, ThemeProvider, type ThemeProviderProps, type ThemeResolvedMode, blockCatalogVersion, buildBlockCatalog, getBlockCatalogEntry, resetQuizWarningsForTests, useCompletion, useLessonkit, useProgress, useQuizState, useTheme, useTracking };
+export { AssessmentSequence, type AssessmentSequenceProps, BLOCK_CATALOG, BLOCK_CATALOG_V2, type BlockCatalogEntry, type BlockCatalogEntryV2, type BlockPropSpec, Course, type CourseProps, DragAndDrop, type DragAndDropProps, type DragItem, DragTheWords, type DragTheWordsProps, type DropTarget, type FillInBlankSpec, FillInTheBlanks, type FillInTheBlanksProps, KnowledgeCheck, type KnowledgeCheckProps, Lesson, type LessonProps, type LessonkitConfig, LessonkitProvider, type LessonkitProviderProps, type LessonkitRuntime, MarkTheWords, type MarkTheWordsProps, ProgressTracker, type ProgressTrackerProps, Quiz, type QuizProps, Reflection, type ReflectionProps, Scenario, type ScenarioProps, type ThemeContextValue, type ThemeMode, ThemeProvider, type ThemeProviderProps, type ThemeResolvedMode, TrueFalse, type TrueFalseProps, blockCatalogV2Version, blockCatalogVersion, buildBlockCatalog, getBlockCatalogEntry, resetAssessmentWarningsForTests, resetQuizWarningsForTests, useAssessmentState, useCompletion, useLessonkit, useProgress, useQuizState, useTheme, useTracking };

package/dist/index.d.ts

@@ -1,9 +1,9 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
 import * as _lessonkit_core from '@lessonkit/core';
-import { CourseId, TelemetryUser, TrackingClient, LessonkitPlugin, ProgressState, LessonId, TelemetryEventName, TelemetryDataFor, PluginHost, BlockId, CheckId } from '@lessonkit/core';
-export { AssessmentScoreInput, AssessmentScoreResult, InteractionBlockRegistration, LessonkitPlugin, LessonkitPluginContext, LessonkitPluginKind, PluginHost, PluginRegistry, TelemetryPipelineSink, buildTelemetryEvent, createLessonkitRuntime, createPluginRegistry, createTelemetryPipeline, defineAssessmentPlugin, defineLifecyclePlugin, defineTelemetryPlugin } from '@lessonkit/core';
-import { AssessmentDescriptor } from '@lessonkit/lxpack';
+import { CourseId, TelemetryUser, TrackingClient, LessonkitPlugin, ProgressState, LessonId, TelemetryEventName, TelemetryDataFor, PluginHost, BlockId, AssessmentHandle, AssessmentBaseProps, AssessmentBehaviour, AssessmentAnsweredData, AssessmentCompletedData, CheckId } from '@lessonkit/core';
+export { AssessmentAnsweredData, AssessmentBaseProps, AssessmentBehaviour, AssessmentCompletedData, AssessmentHandle, AssessmentInteractionType, AssessmentScoreInput, AssessmentScoreResult, AssessmentXAPIData, InteractionBlockRegistration, LessonkitPlugin, LessonkitPluginContext, LessonkitPluginKind, PluginHost, PluginRegistry, TelemetryPipelineSink, buildTelemetryEvent, createLessonkitRuntime, createPluginRegistry, createTelemetryPipeline, defineAssessmentPlugin, defineLifecyclePlugin, defineTelemetryPlugin } from '@lessonkit/core';
+import { McqAssessmentDescriptor } from '@lessonkit/lxpack';
 import { XAPITransport, XAPIClient } from '@lessonkit/xapi';
 import { LxpackBridgeMode } from '@lessonkit/lxpack/bridge';
 import { LessonkitThemeV1, ThemePresetName, PartialLessonkitThemeV1 } from '@lessonkit/themes';
@@ -96,8 +96,8 @@ type ReflectionProps = {
     onChange?: (value: string) => void;
     children?: React.ReactNode;
 };
-type QuizProps = AssessmentDescriptor;
-type KnowledgeCheckProps = AssessmentDescriptor;
+type QuizProps = McqAssessmentDescriptor;
+type KnowledgeCheckProps = McqAssessmentDescriptor;
 type ProgressTrackerProps = {
     totalLessons?: number;
 };
@@ -109,6 +109,99 @@ declare function KnowledgeCheck(props: KnowledgeCheckProps): react_jsx_runtime.J
 declare function Quiz(props: QuizProps): react_jsx_runtime.JSX.Element;
 declare function ProgressTracker(props: ProgressTrackerProps): react_jsx_runtime.JSX.Element;
 
+type TrueFalseProps = AssessmentBaseProps & {
+    question: string;
+    answer: boolean;
+};
+declare const TrueFalse: React.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    question: string;
+    answer: boolean;
+} & React.RefAttributes<AssessmentHandle>>;
+
+type MarkTheWordsProps = AssessmentBaseProps & {
+    /** Plain text; words listed in `correctWords` are selectable targets. */
+    text: string;
+    correctWords: string[];
+};
+declare const MarkTheWords: React.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    /** Plain text; words listed in `correctWords` are selectable targets. */
+    text: string;
+    correctWords: string[];
+} & React.RefAttributes<AssessmentHandle>>;
+
+type FillInBlankSpec = {
+    id: string;
+    answer: string;
+};
+type FillInTheBlanksProps = AssessmentBaseProps & {
+    /** Text with `*` wrapping each blank answer, e.g. "The *capital* of France is *Paris*." */
+    template: string;
+    /** Optional explicit blanks (overrides parsing from template). */
+    blanks?: FillInBlankSpec[];
+};
+declare const FillInTheBlanks: React.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    /** Text with `*` wrapping each blank answer, e.g. "The *capital* of France is *Paris*." */
+    template: string;
+    /** Optional explicit blanks (overrides parsing from template). */
+    blanks?: FillInBlankSpec[];
+} & React.RefAttributes<AssessmentHandle>>;
+
+type DragTheWordsProps = AssessmentBaseProps & {
+    /** Sentence with `*` around drop zones; `words` are draggable options. */
+    template: string;
+    words: string[];
+};
+declare const DragTheWords: React.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    /** Sentence with `*` around drop zones; `words` are draggable options. */
+    template: string;
+    words: string[];
+} & React.RefAttributes<AssessmentHandle>>;
+
+type DragItem = {
+    id: string;
+    label: string;
+};
+type DropTarget = {
+    id: string;
+    label: string;
+    accepts: string;
+};
+type DragAndDropProps = AssessmentBaseProps & {
+    items: DragItem[];
+    targets: DropTarget[];
+};
+declare const DragAndDrop: React.ForwardRefExoticComponent<_lessonkit_core.AssessmentBehaviour & {
+    checkId: _lessonkit_core.CheckId;
+    passingScore?: number;
+} & {
+    items: DragItem[];
+    targets: DropTarget[];
+} & React.RefAttributes<AssessmentHandle>>;
+
+type AssessmentSequenceProps = AssessmentBehaviour & {
+    children: React.ReactNode;
+    /** Show one child assessment at a time (Question Set). */
+    sequential?: boolean;
+};
+declare function AssessmentSequence(props: AssessmentSequenceProps): react_jsx_runtime.JSX.Element;
+
+declare function useAssessmentState(enclosingLessonId?: LessonId): {
+    answer: (data: AssessmentAnsweredData) => void;
+    complete: (data: AssessmentCompletedData) => void;
+};
+
 declare function useLessonkit(): LessonkitRuntime;
 declare function useProgress(): _lessonkit_core.ProgressState;
 declare function useTracking(): {
@@ -122,6 +215,7 @@ declare function useCompletion(): {
     }) => void;
     completeCourse: () => void;
 };
+
 declare function useQuizState(enclosingLessonId?: LessonId): {
     answer: (opts: {
         checkId: CheckId;
@@ -137,6 +231,8 @@ declare function useQuizState(enclosingLessonId?: LessonId): {
     }) => void;
 };
 
+declare function resetAssessmentWarningsForTests(): void;
+
 type ThemeMode = "light" | "dark" | "system";
 type ThemeResolvedMode = "light" | "dark";
 type ThemeProviderProps = {
@@ -158,13 +254,14 @@ declare function ThemeProvider(props: ThemeProviderProps): react_jsx_runtime.JSX
 declare function useTheme(): ThemeContextValue;
 
 declare const blockCatalogVersion: 1;
+declare const blockCatalogV2Version: 2;
 type BlockPropSpec = {
     name: string;
     type: string;
     required: boolean;
     description: string;
 };
-type BlockCatalogEntry = {
+type BlockCatalogEntryBase = {
     type: string;
     aliases?: string[];
     category: "container" | "content" | "assessment" | "chrome";
@@ -191,6 +288,12 @@ type BlockCatalogEntry = {
         manualTracking?: string;
     };
 };
+type BlockCatalogEntry = BlockCatalogEntryBase;
+type BlockCatalogEntryV2 = BlockCatalogEntryBase & {
+    assessmentContract?: true;
+    h5pMachineName?: string;
+    h5pAlias?: string;
+};
 declare const BLOCK_CATALOG: ({
     type: string;
     category: "container";
@@ -398,7 +501,11 @@ declare const BLOCK_CATALOG: ({
     optionalIds?: undefined;
     aliases?: undefined;
 })[];
-declare function buildBlockCatalog(): BlockCatalogEntry[];
-declare function getBlockCatalogEntry(type: string): BlockCatalogEntry | undefined;
+declare const BLOCK_CATALOG_V2: BlockCatalogEntryV2[];
+type BuildBlockCatalogOptions = {
+    version?: 1 | 2;
+};
+declare function buildBlockCatalog(opts?: BuildBlockCatalogOptions): BlockCatalogEntry[] | BlockCatalogEntryV2[];
+declare function getBlockCatalogEntry(type: string, opts?: BuildBlockCatalogOptions): BlockCatalogEntry | BlockCatalogEntryV2 | undefined;
 
-export { BLOCK_CATALOG, type BlockCatalogEntry, type BlockPropSpec, Course, type CourseProps, KnowledgeCheck, type KnowledgeCheckProps, Lesson, type LessonProps, type LessonkitConfig, LessonkitProvider, type LessonkitProviderProps, type LessonkitRuntime, ProgressTracker, type ProgressTrackerProps, Quiz, type QuizProps, Reflection, type ReflectionProps, Scenario, type ScenarioProps, type ThemeContextValue, type ThemeMode, ThemeProvider, type ThemeProviderProps, type ThemeResolvedMode, blockCatalogVersion, buildBlockCatalog, getBlockCatalogEntry, resetQuizWarningsForTests, useCompletion, useLessonkit, useProgress, useQuizState, useTheme, useTracking };
+export { AssessmentSequence, type AssessmentSequenceProps, BLOCK_CATALOG, BLOCK_CATALOG_V2, type BlockCatalogEntry, type BlockCatalogEntryV2, type BlockPropSpec, Course, type CourseProps, DragAndDrop, type DragAndDropProps, type DragItem, DragTheWords, type DragTheWordsProps, type DropTarget, type FillInBlankSpec, FillInTheBlanks, type FillInTheBlanksProps, KnowledgeCheck, type KnowledgeCheckProps, Lesson, type LessonProps, type LessonkitConfig, LessonkitProvider, type LessonkitProviderProps, type LessonkitRuntime, MarkTheWords, type MarkTheWordsProps, ProgressTracker, type ProgressTrackerProps, Quiz, type QuizProps, Reflection, type ReflectionProps, Scenario, type ScenarioProps, type ThemeContextValue, type ThemeMode, ThemeProvider, type ThemeProviderProps, type ThemeResolvedMode, TrueFalse, type TrueFalseProps, blockCatalogV2Version, blockCatalogVersion, buildBlockCatalog, getBlockCatalogEntry, resetAssessmentWarningsForTests, resetQuizWarningsForTests, useAssessmentState, useCompletion, useLessonkit, useProgress, useQuizState, useTheme, useTracking };