@lessonkit/react 0.9.3 → 1.0.1

package/dist/index.d.ts

@@ -1,18 +1,14 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import React from 'react';
 import * as _lessonkit_core from '@lessonkit/core';
-import { LessonId, CourseId, TelemetryUser, TrackingClient, LessonkitPlugin, TelemetryEventName, PluginHost, CheckId, BlockId } from '@lessonkit/core';
-export { AssessmentScoreInput, AssessmentScoreResult, InteractionBlockRegistration, LessonkitPlugin, LessonkitPluginContext, LessonkitPluginKind, PluginHost, createPluginHost, defineLessonkitPlugin } 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 { XAPITransport, XAPIClient } from '@lessonkit/xapi';
+import { LxpackBridgeMode } from '@lessonkit/lxpack/bridge';
 import { LessonkitThemeV1, ThemePresetName, PartialLessonkitThemeV1 } from '@lessonkit/themes';
 export { ThemePresetName } from '@lessonkit/themes';
 
-type ProgressState = {
-    activeLessonId?: LessonId;
-    completedLessonIds: ReadonlySet<LessonId>;
-    courseCompleted: boolean;
-};
-
 type LessonkitConfig = {
     courseId: CourseId;
     session?: {
@@ -37,12 +33,20 @@ type LessonkitConfig = {
     };
     lxpack?: {
         /** Forward completion events to `window.parent.lxpackBridge.v1` when embedded (default `auto`). */
-        bridge?: "auto" | "off";
+        bridge?: LxpackBridgeMode;
     };
     /** Framework plugins (analytics, LMS, assessment, interaction, AI). */
     plugins?: LessonkitPlugin[];
+    /** Runtime implementation (`v2` headless runtime is default; set `"v1"` to opt out). */
+    runtimeVersion?: "v1" | "v2";
+    /** Optional custom telemetry pipeline sinks (used alongside tracking/xapi). */
+    sinks?: _lessonkit_core.TelemetryPipelineSink[];
 };
 
+type LessonkitProviderProps = {
+    config: LessonkitConfig;
+    children: React.ReactNode;
+};
 type LessonkitRuntime = {
     config: LessonkitConfig;
     tracking: TrackingClient;
@@ -56,64 +60,65 @@ type LessonkitRuntime = {
     setActiveLesson: (lessonId: LessonId) => void;
     completeLesson: (lessonId: LessonId) => void;
     completeCourse: () => void;
-    track: (name: TelemetryEventName, data?: unknown, opts?: {
+    track: <N extends TelemetryEventName>(name: N, data?: TelemetryDataFor<N>, opts?: {
         lessonId?: LessonId;
     }) => void;
     plugins: PluginHost | null;
 };
-declare function LessonkitProvider(props: {
-    config: LessonkitConfig;
-    children: React.ReactNode;
-}): react_jsx_runtime.JSX.Element;
+declare function LessonkitProvider(props: LessonkitProviderProps): react_jsx_runtime.JSX.Element;
 
-declare function Course(props: {
+/** @internal Reset module warnings between tests. */
+declare function resetQuizWarningsForTests(): void;
+type CourseProps = {
     title: string;
     courseId: CourseId;
-    config?: Omit<React.ComponentProps<typeof LessonkitProvider>["config"], "courseId">;
+    config?: Omit<LessonkitConfig, "courseId">;
     children: React.ReactNode;
-}): react_jsx_runtime.JSX.Element;
-declare function Lesson(props: {
+};
+type LessonProps = {
     title: string;
     lessonId: LessonId;
+    /** When false, unmount does not emit lesson_completed (for routed multi-pane layouts). Default true. */
+    autoCompleteOnUnmount?: boolean;
     children: React.ReactNode;
-}): react_jsx_runtime.JSX.Element;
-declare function Scenario(props: {
+};
+type ScenarioProps = {
     blockId?: BlockId;
     children: React.ReactNode;
-}): react_jsx_runtime.JSX.Element;
-declare function Reflection(props: {
+};
+type ReflectionProps = {
     blockId?: BlockId;
     prompt?: string;
+    hint?: string;
+    value?: string;
+    onChange?: (value: string) => void;
     children?: React.ReactNode;
-}): react_jsx_runtime.JSX.Element;
-declare function KnowledgeCheck(props: {
-    checkId: CheckId;
-    question: string;
-    choices: string[];
-    answer: string;
-    passingScore?: number;
-}): react_jsx_runtime.JSX.Element;
-declare function Quiz(props: {
-    checkId: CheckId;
-    question: string;
-    choices: string[];
-    answer: string;
-    passingScore?: number;
-}): react_jsx_runtime.JSX.Element;
-declare function ProgressTracker(): react_jsx_runtime.JSX.Element;
+};
+type QuizProps = AssessmentDescriptor;
+type KnowledgeCheckProps = AssessmentDescriptor;
+type ProgressTrackerProps = {
+    totalLessons?: number;
+};
+declare function Course(props: CourseProps): react_jsx_runtime.JSX.Element;
+declare function Lesson(props: LessonProps): react_jsx_runtime.JSX.Element;
+declare function Scenario(props: ScenarioProps): react_jsx_runtime.JSX.Element;
+declare function Reflection(props: ReflectionProps): react_jsx_runtime.JSX.Element;
+declare function KnowledgeCheck(props: KnowledgeCheckProps): react_jsx_runtime.JSX.Element;
+declare function Quiz(props: QuizProps): react_jsx_runtime.JSX.Element;
+declare function ProgressTracker(props: ProgressTrackerProps): react_jsx_runtime.JSX.Element;
 
 declare function useLessonkit(): LessonkitRuntime;
-declare function useProgress(): ProgressState;
+declare function useProgress(): _lessonkit_core.ProgressState;
 declare function useTracking(): {
-    track: (name: _lessonkit_core.TelemetryEventName, data?: unknown, opts?: {
-        lessonId?: _lessonkit_core.LessonId;
+    track: <N extends _lessonkit_core.TelemetryEventName>(name: N, data?: _lessonkit_core.TelemetryDataFor<N>, opts?: {
+        lessonId?: LessonId;
     }) => void;
 };
 declare function useCompletion(): {
-    completeLesson: (lessonId: _lessonkit_core.LessonId) => void;
+    completeLesson: (lessonId: LessonId) => void;
     completeCourse: () => void;
 };
-declare function useQuizState(): {
+declare function useQuizState(enclosingLessonId?: LessonId): {
     answer: (opts: {
         checkId: CheckId;
         question: string;
@@ -182,8 +187,214 @@ type BlockCatalogEntry = {
         manualTracking?: string;
     };
 };
-declare const BLOCK_CATALOG: BlockCatalogEntry[];
+declare const BLOCK_CATALOG: ({
+    type: string;
+    category: "container";
+    description: string;
+    props: ({
+        name: string;
+        type: string;
+        required: true;
+        description: string;
+    } | {
+        name: string;
+        type: string;
+        required: false;
+        description: string;
+    })[];
+    requiredIds: string[];
+    a11y: {
+        element: string;
+        ariaLabel: string;
+        keyboard: string;
+        notes: string;
+        liveRegions?: undefined;
+    };
+    theming: {
+        surface: "global-inherit";
+        stylingNotes: string;
+        dataAttributes?: undefined;
+    };
+    telemetry: {
+        emits: string[];
+        manualTracking?: undefined;
+        requiresActiveLesson?: undefined;
+    };
+    parentConstraints?: undefined;
+    optionalIds?: undefined;
+    aliases?: undefined;
+} | {
+    type: string;
+    category: "container";
+    description: string;
+    props: ({
+        name: string;
+        type: string;
+        required: true;
+        description: string;
+    } | {
+        name: string;
+        type: string;
+        required: false;
+        description: string;
+    })[];
+    requiredIds: string[];
+    parentConstraints: string[];
+    a11y: {
+        element: string;
+        ariaLabel: string;
+        keyboard: string;
+        notes: string;
+        liveRegions?: undefined;
+    };
+    theming: {
+        surface: "global-inherit";
+        stylingNotes: string;
+        dataAttributes?: undefined;
+    };
+    telemetry: {
+        emits: string[];
+        manualTracking?: undefined;
+        requiresActiveLesson?: undefined;
+    };
+    optionalIds?: undefined;
+    aliases?: undefined;
+} | {
+    type: string;
+    category: "content";
+    description: string;
+    props: ({
+        name: string;
+        type: string;
+        required: false;
+        description: string;
+    } | {
+        name: string;
+        type: string;
+        required: true;
+        description: string;
+    })[];
+    requiredIds: never[];
+    optionalIds: string[];
+    parentConstraints: string[];
+    a11y: {
+        element: string;
+        ariaLabel: string;
+        keyboard: string;
+        notes: string;
+        liveRegions?: undefined;
+    };
+    theming: {
+        surface: "global-inherit";
+        dataAttributes: string[];
+        stylingNotes: string;
+    };
+    telemetry: {
+        emits: never[];
+        manualTracking: string;
+        requiresActiveLesson?: undefined;
+    };
+    aliases?: undefined;
+} | {
+    type: string;
+    category: "content";
+    description: string;
+    props: {
+        name: string;
+        type: string;
+        required: false;
+        description: string;
+    }[];
+    requiredIds: never[];
+    optionalIds: string[];
+    parentConstraints: string[];
+    a11y: {
+        element: string;
+        ariaLabel: string;
+        keyboard: string;
+        notes: string;
+        liveRegions?: undefined;
+    };
+    theming: {
+        surface: "global-inherit";
+        dataAttributes: string[];
+        stylingNotes: string;
+    };
+    telemetry: {
+        emits: never[];
+        requiresActiveLesson: true;
+        manualTracking: string;
+    };
+    aliases?: undefined;
+} | {
+    type: string;
+    aliases: string[];
+    category: "assessment";
+    description: string;
+    props: ({
+        name: string;
+        type: string;
+        required: true;
+        description: string;
+    } | {
+        name: string;
+        type: string;
+        required: false;
+        description: string;
+    })[];
+    requiredIds: string[];
+    parentConstraints: string[];
+    a11y: {
+        element: string;
+        ariaLabel: string;
+        keyboard: string;
+        liveRegions: string;
+        notes: string;
+    };
+    theming: {
+        surface: "global-inherit";
+        dataAttributes: string[];
+        stylingNotes: string;
+    };
+    telemetry: {
+        emits: string[];
+        requiresActiveLesson: true;
+        manualTracking?: undefined;
+    };
+    optionalIds?: undefined;
+} | {
+    type: string;
+    category: "chrome";
+    description: string;
+    props: {
+        name: string;
+        type: string;
+        required: false;
+        description: string;
+    }[];
+    requiredIds: never[];
+    parentConstraints: string[];
+    a11y: {
+        element: string;
+        ariaLabel: string;
+        keyboard: string;
+        notes: string;
+        liveRegions?: undefined;
+    };
+    theming: {
+        surface: "global-inherit";
+        stylingNotes: string;
+        dataAttributes?: undefined;
+    };
+    telemetry: {
+        emits: never[];
+        manualTracking?: undefined;
+        requiresActiveLesson?: undefined;
+    };
+    optionalIds?: undefined;
+    aliases?: undefined;
+})[];
 declare function buildBlockCatalog(): BlockCatalogEntry[];
 declare function getBlockCatalogEntry(type: string): BlockCatalogEntry | undefined;
 
-export { BLOCK_CATALOG, type BlockCatalogEntry, type BlockPropSpec, Course, KnowledgeCheck, Lesson, type LessonkitConfig, LessonkitProvider, type LessonkitRuntime, ProgressTracker, Quiz, Reflection, Scenario, type ThemeContextValue, type ThemeMode, ThemeProvider, type ThemeProviderProps, type ThemeResolvedMode, blockCatalogVersion, buildBlockCatalog, getBlockCatalogEntry, useCompletion, useLessonkit, useProgress, useQuizState, useTheme, useTracking };
+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 };