@cuemath/leap 3.2.17-mb → 3.2.17-pzd-0.1

package/dist/index.d.ts

@@ -62,7 +62,7 @@ export declare const ArcButton: NamedExoticComponent<IArcButtonProps & {
     children?: ReactNode | undefined;
 } & RefAttributes<HTMLDivElement>>;
 
-export declare const ArrowTooltip: FC<IArrowTooltipProps>;
+export declare const ArrowTooltip: NamedExoticComponent<IArrowTooltipProps>;
 
 export declare const AUTH_TABS: IAuthTab[];
 
@@ -311,6 +311,10 @@ declare const COURSE_STREAMS: {
 
 export declare const CrossIcon: React.FC<React.SVGProps<SVGSVGElement>>;
 
+export declare const CueBoardFilledIcon: React.FC<React.SVGProps<SVGSVGElement>>;
+
+export declare const CueBoardIcon: React.FC<React.SVGProps<SVGSVGElement>>;
+
 export declare const CueCanvas: React_2.FC<ICueCanvas>;
 
 export declare const CueCanvasController: React_2.FC<IToolbarProps>;
@@ -351,6 +355,15 @@ export declare enum EClassTimeAlertLevel {
     FIFTEEN_MIN = "15min"
 }
 
+export declare enum EDeviceType {
+    MOBILE = 0,
+    TABLET = 1,
+    SMALL_DESKTOP = 2,
+    DESKTOP = 3,
+    LARGE_DEVICE = 4,
+    XLARGE_DEVICE = 5
+}
+
 export declare const Edit2Icon: React.FC<React.SVGProps<SVGSVGElement>>;
 
 export declare const EditIcon: React.FC<React.SVGProps<SVGSVGElement>>;
@@ -408,6 +421,9 @@ declare interface ErrorProps {
 }
 
 export declare const EVENTS: {
+    PUZZLE_ASSIGNED: "PUZZLE_ASSIGNED";
+    PUZZLE_UNASSIGNED: "PUZZLE_UNASSIGNED";
+    PUZZLE_REVIEWED: "PUZZLE_REVIEWED";
     PUZZLE_FEEDBACK_CELEBRATION: "PUZZLE_FEEDBACK_CELEBRATION";
     HOMEWORK_UNASSIGN: "HOMEWORK_UNASSIGN";
     INVALIDATE_HOMEWORK: "INVALIDATE_HOMEWORK";
@@ -517,7 +533,7 @@ declare const getCheckboxConfig: IGetCheckboxConfig;
 
 declare function getColors(): TColorsMap;
 
-declare const getDevice: (width: number) => TDeviceType;
+declare const getDevice: (width: number) => EDeviceType;
 
 declare const getInputConfig: IGetInputConfig;
 
@@ -564,6 +580,8 @@ export declare const HelpIcon: React_2.FC<React_2.SVGProps<SVGSVGElement>>;
 
 export declare const HighlighterIcon: React.FC<React.SVGProps<SVGSVGElement>>;
 
+export declare const HintFillIcon: React.FC<React.SVGProps<SVGSVGElement>>;
+
 export declare const HomeIcon: React_2.FC<React_2.SVGProps<SVGSVGElement>>;
 
 export declare const HomeworkCardList: React_2.NamedExoticComponent<HWCardListProps>;
@@ -580,6 +598,7 @@ declare interface HWCardListProps extends INodeCardCallbacks {
     homeworkRef?: React_2.RefObject<HTMLDivElement>;
     startHomePageJourney?: ({ studentId, stream, userType }: IHomepageStartJourneyProps) => void;
     canStartJourney?: boolean;
+    canStartPuzzleAssignedJourney?: boolean;
 }
 
 declare interface IAccordionSectionProps {
@@ -662,6 +681,7 @@ export declare interface IArrowTooltipProps {
     widthX?: number;
     zIndex?: number;
     parentWidth?: number | string;
+    isBlocking?: boolean;
 }
 
 declare interface IAttempt {
@@ -1367,6 +1387,7 @@ declare interface IErrorProps {
     theme?: 'light' | 'dark';
     title?: string;
     description?: string;
+    size?: 'compact' | 'full';
 }
 
 declare interface IExpandableHeaderProps {
@@ -1669,8 +1690,9 @@ export declare interface IJourneyContext {
      * @param scrollableContainerRef - Optional ref to a journey which has a scrollable container, it will make the entire page
      * uninteractable by adding an overlay - Required since we cannot determine the height of the scrollable container because
      * provider is at root level and from there we cannot access the scrollable container's height.
+     * @param isBlocking - If `true`, the journey will block user interaction with the page until completed. True by default.
      */
-    setJourney: (id: TJourneyId, coachmark: TCoachmarkJourneyProps[], scrollableContainerRef?: RefObject<HTMLDivElement | null>) => void;
+    setJourney: (id: TJourneyId, coachmark: TCoachmarkJourneyProps[], scrollableContainerRef?: RefObject<HTMLDivElement | null>, isBlocking?: boolean) => void;
     /**
      * Clears the current journey, removing all coachmarks.
      * Should be called inside useEffect to ensure cleanup.
@@ -2059,6 +2081,7 @@ export declare const ILLUSTRATIONS: {
     PROFICIENT_BADGE: string;
     PROFILE_BOARD: string;
     PUZZLE: string;
+    PUZZLE_DASHBOARD_BANNER: string;
     PUZZLE_PATTERN_BLUE: string;
     PUZZLE_PATTERN_GREEN: string;
     PUZZLE_PATTERN_ORANGE: string;
@@ -2441,7 +2464,7 @@ export declare interface IModal {
     /** Content to display inside the modal */
     element: ReactElement;
     /** Rendering style of the modal */
-    renderAs?: 'modal' | 'fullscreen' | 'spotlight' | 'fullscreen-transparent';
+    renderAs?: 'modal' | 'fullscreen' | 'spotlight';
     /** Whether the modal can be dismissed by clicking outside or ESC key (default: true) */
     isDismissable?: boolean;
     /** Whether the modal requires authentication to view (default: true) */
@@ -2776,6 +2799,7 @@ declare interface IPreviewWorksheetProps {
     items?: string[];
     onWorksheetLoaded?: (loaded: boolean) => void;
     onUnassign?: () => void;
+    canStartUnassignJourney?: boolean;
 }
 
 export declare interface IProject<T> {
@@ -2826,6 +2850,14 @@ declare interface IPuzzle extends IBaseProject {
     solved: boolean;
 }
 
+declare interface IPuzzleAppProps {
+    itemRef: string;
+    title: string;
+    imageHue: THueNames;
+    feedbackComments?: string;
+    tip?: string;
+}
+
 export declare interface IPuzzleCard {
     sheetData: TLPARSheetData;
     blockStatus?: TPuzzleCardBlockStatus | null;
@@ -2867,6 +2899,9 @@ export declare interface IPuzzleCardAssignData {
     node_type: TNodeTypes;
     node_id: string;
     user_node_id: string | null;
+    rewards?: TPuzzleRewards[];
+    student_elo_rating: number | null;
+    current_elo_rating: number | null;
 }
 
 declare interface IPuzzleCardContainerProps {
@@ -2877,7 +2912,12 @@ declare interface IPuzzleCardContainerProps {
     studentId: string;
     onFullyHidden?: () => void;
     onPuzzleClick: () => void;
-    onPuzzleAssign?: () => void;
+}
+
+declare interface IPuzzleDashboardProps {
+    studentId: string;
+    onBackCLick?: () => void;
+    onCardClick: (userNodeId: string) => void;
 }
 
 export declare interface IPuzzleWebGameProps extends IBaseWebGameProps, ISyncableWebGameProps {
@@ -2995,6 +3035,7 @@ export declare interface IReviewWorksheetModel {
     title?: string;
     worksheet_id?: string;
     node_type: TNodeTypes;
+    items?: TWorksheetItems[];
 }
 
 declare interface ISATSheetItemCallbacks {
@@ -3234,22 +3275,14 @@ declare interface IStepperProps {
     currentStep: number;
 }
 
-export declare interface IStickerData {
+declare interface IStickerData {
     id: string;
     emoji: string;
     lottieUrl?: string;
-    name: string;
-}
-
-export declare interface IStickerProps {
-    emoji: string;
-    lottieUrl?: string;
-    size?: number | string;
-    onClick?: () => void;
-    disabled?: boolean;
+    name?: string;
 }
 
-export declare interface IStickerSelectorProps {
+declare interface IStickerGridProps {
     stickers: IStickerData[];
     columns?: number;
     gap?: number;
@@ -3257,16 +3290,10 @@ export declare interface IStickerSelectorProps {
     onStickerClick?: (sticker: IStickerData) => void;
 }
 
-export declare interface IStickersProps {
-    stickers: string[];
-    effect: TStickerEffects;
-    count: number;
-    duration: number;
-}
-
 declare interface IStreakIconProps extends React.HTMLProps<HTMLDivElement> {
     value: number;
     blink?: boolean;
+    isInteractive?: boolean;
 }
 
 export declare interface IStreakLeaderboardDetails extends IBaseLeaderboardDetails {
@@ -3765,6 +3792,10 @@ declare interface IusePointerSyncProps {
     targetUserId?: string;
 }
 
+declare interface IUsePuzzleIntroJourney {
+    onJourneyComplete: () => void;
+}
+
 export declare interface IUserChapterData {
     chapter_code: string;
     chapter_id: string;
@@ -3819,12 +3850,6 @@ declare interface IUseTrialSessionMessageBroker {
     };
 }
 
-declare interface IUseViewportReturn {
-    isCompact: boolean;
-    isMobile: boolean;
-    isDesktop: boolean;
-}
-
 declare interface IUseWorksheetLayout {
     (options: {
         userType: TUserTypes;
@@ -3971,6 +3996,14 @@ export declare interface IWorksheetBehavior {
      *    For teacher we don't show review cta.
      */
     canTeacherValidate: boolean;
+    /**
+     * * In case of puzzle worksheet for teacher
+     * * If true,
+     *     Teacher validation button will be disabled.
+     * * If false,
+     *     Teacher validation button will be active.
+     */
+    canTeacherValidateDisabled?: boolean;
     /**
      * If true, questions will be validated and feedback will be shown.
      */
@@ -4022,6 +4055,10 @@ export declare interface IWorksheetBehavior {
      * If true, the user can unassign the sheet.
      */
     canUnAssign?: boolean;
+    /**
+     * If true, journey will be started.
+     */
+    canStartJourney?: boolean;
 }
 
 declare interface IWorksheetCallbackProps {
@@ -4182,16 +4219,23 @@ export declare enum JOURNEY_ID_STUDENT {
     CIRCLE_TABLES_INTRO_JOURNEY = "CIRCLE_TABLES_INTRO_JOURNEY",
     CIRCLE_TABLES_INFINTE_JOURNEY = "CIRCLE_TABLES_INFINITE_JOURNEY",
     CIRCLE_LESSONS_K_1_INTRO_JOURNEY = "CIRCLE_LESSONS_K_1_INTRO_JOURNEY",
-    CIRCLE_STREAK_REDUCTION_JOURNEY = "CIRCLE_STREAK_REDUCTION_JOURNEY",
     HOMEPAGE_JOURNEY = "HOMEPAGE_JOURNEY",
     CHAPTER_PAGE_JOURNEY = "CHAPTER_PAGE_JOURNEY",
-    CHALLENGE_ARENA_JOURNEY = "CHALLENGE_ARENA_JOURNEY"
+    PUZZLE_ATTEMPT_JOURNEY = "PUZZLE_ATTEMPT_JOURNEY",
+    CHALLENGE_ARENA_JOURNEY = "CHALLENGE_ARENA_JOURNEY",
+    PUZZLE_ASSIGNED_JOURNEY = "PUZZLE_ASSIGNED_JOURNEY",
+    PUZZLE_DASHBOARD_JOURNEY = "PUZZLE_DASHBOARD_JOURNEY"
 }
 
 export declare enum JOURNEY_ID_TEACHER {
     HOMEPAGE_JOURNEY = "HOMEPAGE_JOURNEY",
     CHAPTER_PAGE_JOURNEY = "CHAPTER_PAGE_JOURNEY",
-    CHALLENGE_ARENA_JOURNEY = "CHALLENGE_ARENA_JOURNEY"
+    CHALLENGE_ARENA_JOURNEY = "CHALLENGE_ARENA_JOURNEY",
+    PUZZLE_ASSIGN_JOURNEY = "PUZZLE_ASSIGN_JOURNEY",
+    PUZZLE_INTRO_JOURNEY = "PUZZLE_INTRO_JOURNEY",
+    PUZZLE_REVIEW_JOURNEY = "PUZZLE_REVIEW_JOURNEY",
+    PUZZLE_PROGRESS_JOURNEY = "PUZZLE_PROGRESS_JOURNEY",
+    PUZZLE_UNASSIGN_JOURNEY = "PUZZLE_UNASSIGN_JOURNEY"
 }
 
 export declare const JourneyProvider: FC<IJourneyProviderProps>;
@@ -4306,6 +4350,11 @@ export declare const LOTTIE: {
     PROFICIENT1X: string;
     PROJECT: string;
     PUZZLE: string;
+    PUZZLE_BLUE_LOTTIE: string;
+    PUZZLE_GREEN_LOTTIE: string;
+    PUZZLE_ORANGE_LOTTIE: string;
+    PUZZLE_PURPLE_LOTTIE: string;
+    PUZZLE_YELLOW_LOTTIE: string;
     RANDOM_MODE_SEGMENT_LOTTIE: string;
     RECAP: string;
     SEQUENCE_MODE_SEGMENT_LOTTIE: string;
@@ -4503,7 +4552,7 @@ export declare enum NODE_TYPES {
     'PUZZLE_CARD' = "PUZZLE_CARD"
 }
 
-export declare const Nudge: React_2.FC<INudgeProps>;
+export declare const Nudge: React_2.NamedExoticComponent<INudgeProps>;
 
 export declare const NumRangeInput: React.FC<NumRangeInputProps>;
 
@@ -4547,6 +4596,7 @@ export declare enum PLATFORM_EVENTS_STUDENT {
     CUSTOM_TEST_SUBMITTED = "custom_test_submitted",
     HOMEWORK_COMPLETED = "homework_completed",
     ERROR_VIA_AUTO_LOGIN_FROM_CUEMATH_APP = "error_via_auto_login_from_cuemath_app",
+    PUZZLE_ATTEMPTED = "puzzle_attempted",
     ACTIVITY_STARTED = "activity_started",
     ACTIVITY_TUTORIAL_SEEN = "activity_tutorial_seen",
     STREAK_ICON_CLICKED = "streak_icon_clicked",
@@ -4563,7 +4613,9 @@ export declare enum PLATFORM_EVENTS_TEACHER {
     LESSON_FEEDBACK_NEGATIVE = "lesson_feedback_negative",
     LESSON_FEEDBACK_BACK_BUTTON = "lesson_feedback_back_button",
     LESSON_FEEDBACK_SUBMIT = "lesson_feedback_submit",
-    LESSON_FEEDBACK_NEXT = "lesson_feedback_next"
+    LESSON_FEEDBACK_NEXT = "lesson_feedback_next",
+    PUZZLE_UNASSIGNED = "puzzle_unassigned",
+    PUZZLE_REVIEWED = "puzzle_reviewed"
 }
 
 export declare const Play2Icon: React_2.FC<React_2.SVGProps<SVGSVGElement>>;
@@ -4636,8 +4688,12 @@ declare const PUZZLE_CARD_STATE: {
 
 declare const PUZZLE_CARDS: "puzzle_cards";
 
+export declare const PuzzleApp: NamedExoticComponent<IPuzzleAppProps>;
+
 export declare const PuzzleCard: FC<IPuzzleCardContainerProps>;
 
+export declare const PuzzleDashboard: FC<IPuzzleDashboardProps>;
+
 export declare const PuzzleFeedbackCelebration: FC;
 
 export declare const PuzzleIcon: React.FC<React.SVGProps<SVGSVGElement>>;
@@ -4699,6 +4755,10 @@ declare const SAT_NODE_TYPE: {
 
 export declare const SATSheetSummary: FC<ISATSheetSummary>;
 
+export declare const ScreenGrabFilledIcon: React.FC<React.SVGProps<SVGSVGElement>>;
+
+export declare const ScreenGrabIcon: React.FC<React.SVGProps<SVGSVGElement>>;
+
 export declare const SearchableSelectInput: <IDType extends string | number>(props: ISearchableSelectInputProps<IDType>) => ReactElement;
 
 export declare const SearchIcon: React.FC<React.SVGProps<SVGSVGElement>>;
@@ -4827,11 +4887,22 @@ declare const STICKER_BADGE: {
     AWESOME: string;
 };
 
-export declare const stickerData: IStickerData[];
+declare type StickerEffect = 'burst_from_edges' | 'pop_expand' | 'float_up' | 'fall_down';
+
+export declare const StickerFilledIcon: React.FC<React.SVGProps<SVGSVGElement>>;
+
+export declare const StickerIcon: React.FC<React.SVGProps<SVGSVGElement>>;
 
-export declare const StickersEffects: React_2.NamedExoticComponent<IStickersProps>;
+export declare const Stickers: React_2.NamedExoticComponent<StickersProps>;
+
+declare interface StickersProps {
+    stickers: string[];
+    effect: StickerEffect;
+    count: number;
+    duration: number;
+}
 
-export declare const StickersSelector: React_2.NamedExoticComponent<IStickerSelectorProps>;
+export declare const StickersSelector: React_2.NamedExoticComponent<IStickerGridProps>;
 
 export declare const StreakIcon: React_2.FC<IStreakIconProps>;
 
@@ -5071,8 +5142,6 @@ declare type TCueProgramData = {
 
 declare type TDefaultSection = Record<string, unknown>;
 
-export declare type TDeviceType = 'mobile' | 'tablet' | 'small-desktop' | 'desktop' | 'large-device' | 'xlarge-device';
-
 declare type TDrawingData = ITile | IStroke | undefined;
 
 declare type TEnglishSectionSummary = {
@@ -5084,7 +5153,7 @@ declare type TEnrollmentTypes = (typeof ENROLLMENT_TYPES)[keyof typeof ENROLLMEN
 export declare const TestsCreation: FC<ITestsCreationProps>;
 
 /**
- * @param $renderAs - The text variant to render as (ah1-ah4, ab1-ab3, ac1-ac4, ub1-ub3), anything else is deprecated
+ * @param $renderAs (fallback for any device), @param $renderOnMobileAs, @param $renderOnTabletAs - The text variant to render as (ah1-ah4, ab1-ab3, ac1-ac4, ub1-ub3), anything else is deprecated
  */
 declare const Text_2: IStyledComponent<"web", Substitute<DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>, TextProps>>;
 export { Text_2 as Text }
@@ -5106,6 +5175,8 @@ declare interface TextProps {
     $inline?: boolean;
     $textDecoration?: string;
     $whiteSpace?: 'pre-line' | 'normal' | 'pre-wrap' | 'no-wrap' | 'pre' | 'break-spaces';
+    $renderOnMobileAs?: TTextVariants;
+    $renderOnTabletAs?: TTextVariants;
 }
 
 export declare type TFontFamilyNames = `${'Athletics'}-${'Light' | 'Regular' | 'Medium' | 'Bold' | 'Black'}` | `${'UntitledSans'}-${'Regular' | 'Medium'}`;
@@ -5360,6 +5431,21 @@ export declare type TInclassMessage = {
     eventPayload: {
         chapterId: string;
     };
+} | {
+    eventName: typeof EVENTS.PUZZLE_ASSIGNED;
+    eventPayload: {
+        puzzleId: string;
+    };
+} | {
+    eventName: typeof EVENTS.PUZZLE_UNASSIGNED;
+    eventPayload: {
+        puzzleId?: string;
+    };
+} | {
+    eventName: typeof EVENTS.PUZZLE_REVIEWED;
+    eventPayload: {
+        puzzleId: string;
+    };
 } | {
     eventName: 'TEACHER_BADGE';
     eventPayload: {
@@ -5749,7 +5835,7 @@ declare type TRenderAs_2 = 'canvas' | 'whiteboard';
 declare type TRewardHomeData = {
     user_badges: TBadgeData[] | [];
     user_rewards: TRewardsData[] | [];
-    user_stickers: TStickerData_2[] | [];
+    user_stickers: TStickerData[] | [];
 };
 
 declare type TRewardsData = {
@@ -5877,17 +5963,7 @@ export declare type TSkillStatus = 'pending' | 'completed';
 
 export declare type TSocialAuthProvider = 'google' | 'apple';
 
-export declare type TStickerData = {
-    id: number;
-    sticker: string;
-    x: number;
-    y: number;
-    size: number;
-    fromX?: string;
-    fromY?: string;
-};
-
-declare type TStickerData_2 = {
+declare type TStickerData = {
     actor_id: string;
     badge_id: string;
     badge_type: string;
@@ -5900,8 +5976,6 @@ declare type TStickerData_2 = {
     user_type: string;
 };
 
-export declare type TStickerEffects = 'burst-from-edges' | 'pop-expand' | 'float-up' | 'fall-down';
-
 export declare type TStreakStatus = 'pending' | 'completed';
 
 declare type TStyleAttrubutes = NonNullable<HTMLAttributes<HTMLDivElement>['style']>;
@@ -5990,6 +6064,10 @@ export declare const Tutorial: ({ src, title, onCross, showProgress, onTutorialP
 
 export declare const TutoringIcon: React_2.FC<React_2.SVGProps<SVGSVGElement>>;
 
+declare type TWorksheetItems = {
+    ref: string;
+};
+
 declare type TWORKSHHET_QUESTION_MEDIA_TYPE = 'SIMULATION' | 'VIDEO' | 'AUDIO';
 
 export declare type TZIndexMap = Record<keyof typeof ZINDEX, number>;
@@ -6197,6 +6275,21 @@ export declare const useModalParams: IUseModalParams;
 
 export declare const usePointerSync: ({ userType, targetUserId, }: IusePointerSyncProps) => IusePointerSyncMethods;
 
+export declare const usePuzzleDashboardJourney: () => {
+    puzzleProfileRef: RefObject<HTMLDivElement>;
+    startJourney: (avatar: IAvatarLayer[]) => void;
+};
+
+export declare const usePuzzleIntroJourney: ({ onJourneyComplete }: IUsePuzzleIntroJourney) => {
+    puzzleIconRef: RefObject<HTMLDivElement>;
+    startJourney: () => void;
+};
+
+export declare const usePuzzleProgressJourney: () => {
+    puzzleProgressRef: RefObject<HTMLDivElement>;
+    startJourney: () => void;
+};
+
 export declare const User2Icon: React.FC<React.SVGProps<SVGSVGElement>>;
 
 export declare const UserIcon: React.FC<React.SVGProps<SVGSVGElement>>;
@@ -6207,6 +6300,11 @@ export declare const UsernamePasswordForm: NamedExoticComponent<IUsernamePasswor
 
 export declare const UserTypeSelector: NamedExoticComponent<IUserTypeSelectorProps>;
 
+export declare const useTeacherPuzzleAssignedJourney: () => {
+    puzzleHomeTabRef: RefObject<HTMLDivElement>;
+    startJourney: () => void;
+};
+
 export declare const useTrackingContext: (commonAnalyticsProps: Record<string, unknown>, overrides?: Record<string, unknown>) => {
     onClick: TTrackCTA;
     onResponse: TTrackInput;
@@ -6217,8 +6315,6 @@ export declare const useTrialSessionMessageBroker: IUseTrialSessionMessageBroker
 
 export declare const useUIContext: () => UIContextProps;
 
-export declare const useViewport: () => IUseViewportReturn;
-
 export declare const useWorksheetLayout: IUseWorksheetLayout;
 
 export declare const useZoomDisable: () => void;