@cuemath/leap 3.5.30-gg4 → 3.5.30-j1

package/dist/index.d.ts

@@ -244,6 +244,42 @@ export declare const CancellationReasonModal: NamedExoticComponent<object>;
 
 export declare const CancelSubscriptionModal: NamedExoticComponent<object>;
 
+declare enum CARD_TYPE {
+    'general' = "general",
+    'legacy' = "legacy",
+    'diagnostic' = "diagnostic",
+    'remedial' = "remedial",
+    'recap' = "recap",
+    'learn' = "learn",
+    'extra_practice' = "extra_practice",
+    'practice' = "practice",
+    'test' = "test",
+    'revision' = "revision",
+    'advanced' = "advanced",
+    'challenge' = "challenge",
+    'video' = "video",
+    'simulation' = "simulation",
+    'note' = "note",
+    'subjective' = "subjective",
+    'deck' = "deck",
+    'puzzle' = "puzzle",
+    'test_series' = "test_series",
+    'activity' = "activity",
+    'project' = "project",
+    'certificate' = "certificate",
+    'ppt_viva' = "ppt_viva",
+    'ppt_content' = "ppt_content",
+    'wb_activity' = "wb_activity",
+    'smart_practice' = "smart_practice",
+    'exit_ticket' = "exit_ticket",
+    'monthly_mastery_test' = "monthly_mastery_test",
+    'supplementary_mastery_test' = "supplementary_mastery_test",
+    'trial_diagnostic' = "trial_diagnostic",
+    'trial_basic' = "trial_basic",
+    'trial_intermediate' = "trial_intermediate",
+    'trial_advanced' = "trial_advanced"
+}
+
 export declare const CardTitle: MemoExoticComponent<({ cardHeader, nodeType, courseType, }: {
 cardHeader: string;
 nodeType: TNodeTypes_2;
@@ -589,6 +625,12 @@ export declare enum ErrorCode {
     USERNAME_NOT_ALLOWED = "40023"
 }
 
+declare interface ErrorProps {
+    buttonLabel?: string;
+    error: string;
+    handleClick: () => void;
+}
+
 export declare enum ESessionStatus {
     COMPLETED = "COMPLETED",
     IN_FUTURE = "IN FUTURE"
@@ -600,6 +642,11 @@ export declare enum ESummaryType {
     LEARNING_PLAN = "learningPlan"
 }
 
+export declare enum ETAB_IDS {
+    DAILY = "daily",
+    MONTHLY = "monthly"
+}
+
 export declare const EveningIcon: FC<SVGProps<SVGSVGElement>>;
 
 export declare const EVENTS: {
@@ -1028,28 +1075,20 @@ declare interface IBaseWorksheetProps {
     studentId: string;
     studentName?: string;
     worksheetName: string;
+    layout: IWorksheetLayout;
+    behavior: IWorksheetBehavior;
     initialResponseId?: string;
     initialItemIndex?: number;
-    layout: IWorksheetLayout;
     updatedResponses?: Record<string, IWorksheetResponse>;
     worksheetCompleted: boolean;
     showNudgeBanner?: boolean;
     markedAsCompleted?: boolean;
+    onResolveDoubt?: (responseId: string) => void;
+    onActiveQuestionChange?: (question: IWorksheetQuestion) => void;
     canResolveDoubt?: boolean;
+    onSkip?: (itemIndex: number, widgetIndex: number) => void;
     canShowActionBar?: boolean;
     actionBarRightElement?: ReactElement;
-    attemptId?: string;
-    itemsSignedRequest: string;
-    questionsSignedRequest: string;
-    summaryDescription?: ReactElement | null;
-    canSubmitWorksheet?: boolean;
-    subjectiveProps?: ISubjectiveSheetProps;
-    inClass?: boolean;
-    isLessonV3Enabled?: boolean;
-    isDesmosEnabled?: boolean;
-    nodeType: TNodeTypes;
-    mode: 'resume' | 'review' | 'preview';
-    loggerRef: MutableRefObject<(eventName: string, data?: Record<string, unknown>) => void>;
 }
 
 declare interface IBillingDetails {
@@ -1629,6 +1668,14 @@ declare interface IDigitalMeterProps {
     actAsTimer?: boolean;
 }
 
+declare interface IDotConfig {
+    dotColor?: TColorNames;
+    inactiveDotColor?: TColorNames;
+    activeIndicatorSize?: string;
+    inactiveIndicatorSize?: string;
+    spacing?: string;
+}
+
 declare type IDotLottieAnimationProps = XOR<WithSrc, WithData> & SharedProps;
 
 declare interface IDotLottieAnimationRef {
@@ -1690,12 +1737,6 @@ declare interface IErrorProps {
     size?: 'compact' | 'full';
 }
 
-declare interface IErrorProps_2 {
-    buttonLabel?: string;
-    error: string;
-    handleClick: () => void;
-}
-
 declare interface IExpandableHeaderProps {
     title: string;
     expanded: boolean;
@@ -2147,6 +2188,50 @@ declare interface ILearningSheetData {
     name: string;
 }
 
+declare interface ILearnosity {
+    ready: () => void;
+    questions: () => Record<string, unknown>;
+    question: (responseId: string) => {
+        enable: () => boolean;
+        disable: () => boolean;
+        getQuestion: () => ILearnosityQuestion;
+        getMetadata: () => ILearnosityQuestionMetadata;
+        getResponse: () => ILearnosityQuestionResponse;
+        getScore: (callback?: (score: ILearnosityQuestionScore | null) => void) => ILearnosityQuestionScore;
+        validate: (options?: {
+            showCorrectAnswers?: boolean;
+            feedbackAttempts?: boolean;
+        }, callback?: () => void) => void;
+        resetValidationUI: () => void;
+        on: (eventName: 'changed', callback: () => void) => void;
+        off: (eventName: 'changed', callback?: () => void) => void;
+    } | undefined;
+    append: (toAppend: {
+        questions: ILearnosityQuestion[];
+        responses?: Record<string, unknown>;
+    }) => void;
+    appendQuestion: (toAppend: {
+        questions: ILearnosityQuestion[];
+        responses?: Record<string, unknown>;
+    }) => void;
+    reset: () => void;
+    renderMath: (renderer: TMathRenderer) => void;
+}
+
+declare interface ILearnosityItem {
+    reference: string;
+    questions: ILearnosityQuestion[];
+    source: Record<string, unknown>;
+    content: string;
+    metadata: Record<string, unknown> | unknown[];
+    workflow: unknown[];
+    response_ids: string[];
+    feature_ids: unknown[];
+    features: unknown[];
+    itemType?: TItemType;
+    tags?: string[];
+}
+
 declare interface ILearnosityPreloaderProps {
     apiURL: string;
     fallbackAPIURL: string;
@@ -2337,6 +2422,7 @@ export declare const ILLUSTRATIONS: {
     CIRCLE_OUTERCIRCLE_BG: string;
     CLOCK_BADGE: string;
     CLOCK_ORANGE: string;
+    CODING_REPORT_ICON: string;
     COMMON: string;
     COMMUNITY_BULB: string;
     COMMUNITY_BULB_YELLOW_2: string;
@@ -2354,10 +2440,14 @@ export declare const ILLUSTRATIONS: {
     DURATION_90MIN_GRAY: string;
     EARTH_GREEN: string;
     ELLIPSE_CLIP: string;
+    ELP_ICON: string;
+    EMPTY_REPORTS: string;
+    ENGLISH_ICON: string;
     EPIC: string;
     EQUAL_OUTLINED: string;
     FEMALE_AVATAR: string;
     FOCUS_BLUE: string;
+    FULL_REPORT: string;
     GAME_PLAY: string;
     GLOBE_WITH_BLUE_FILL: string;
     GRADE_GRID_BACKGROUND: string;
@@ -2389,6 +2479,7 @@ export declare const ILLUSTRATIONS: {
     MASTERED_BADGE: string;
     MASTERED_SHIELD_GRAY: string;
     MASTERED_SHIELD_GREEN: string;
+    MATH_FIT_GREY: string;
     MENTAL_MATH: string;
     MILESTONE_INTRO_1: string;
     MILESTONE_INTRO_2: string;
@@ -2409,6 +2500,7 @@ export declare const ILLUSTRATIONS: {
     NODE_TEST_PREP_BG: string;
     NODE_VIDEO_BG: string;
     NO_ACTIVITY: string;
+    NO_REPORT: string;
     NUMBER_1_ORANGE: string;
     NUMBER_2_ORANGE: string;
     NUMBER_3_ORANGE: string;
@@ -2431,6 +2523,7 @@ export declare const ILLUSTRATIONS: {
     PRACTICED_SHIELD_GREY: string;
     PROFICIENT_BADGE: string;
     PROFILE_BOARD: string;
+    PTM_REPORT_ICON: string;
     PUZZLE: string;
     PUZZLE_DASHBOARD_BANNER: string;
     PUZZLE_PATTERN_BLUE: string;
@@ -2450,6 +2543,8 @@ export declare const ILLUSTRATIONS: {
     REPORT_404: string;
     ROCKET_BROKEN: string;
     ROCKET_YELLOW: string;
+    SAT_REPORT_ICON: string;
+    SCIENCE_REPORT_ICON: string;
     SCORE: string;
     SMILEY: string;
     STAR_BADGE: string;
@@ -2466,6 +2561,8 @@ export declare const ILLUSTRATIONS: {
     TEST_DIFFICULTY_MEDIUM: string;
     THREE_STARS_FILLED: string;
     THUMBS_UP_GREEN: string;
+    THUMPS_DOWN: string;
+    THUMPS_UP: string;
     TICK_GREEN: string;
     TIME_PURPLE: string;
     TROPHY_BLUE: string;
@@ -2538,6 +2635,14 @@ export { Image_2 as Image }
 export declare const ImageIcon: FC<SVGProps<SVGSVGElement>>;
 
 export declare const IMAGES: {
+    2021: string;
+    2022: string;
+    2023: string;
+    2024: string;
+    2025: string;
+    2026: string;
+    2027: string;
+    2028: string;
     ACHIEVEMENT_BG: string;
     APR: string;
     ASHTA: string;
@@ -2896,6 +3001,56 @@ declare interface IModalProviderProps extends PropsWithChildren {
     isUserAuthenticated?: boolean;
 }
 
+declare interface IMonthlyActivity {
+    id: string;
+    node_type: NODE_TYPES;
+    card_type: CARD_TYPE;
+    card_header: CARD_TYPE | null;
+    feedback_comments: string | null;
+    state: NODE_STATE;
+    title?: string;
+    accuracy?: number | null;
+    subtext?: string | null;
+    is_timed?: boolean;
+    image_hue?: THueNames;
+    image_url?: string;
+    sat_max_score?: number | null;
+    sat_total_score?: number | null;
+    item_ref?: string | null;
+    thumbnail_url?: string;
+    user_attempt_id?: string | null;
+    tip: string | null;
+    user_block_id: string | null;
+    user_chapter_id: string | null;
+    user_node_id: string | null;
+}
+
+declare interface IMonthlyReportProps {
+    reportId: string;
+    studentName: string;
+    onPuzzleClick?: (params: {
+        item_ref: IMonthlyActivity['item_ref'];
+        feedback_comments: IMonthlyActivity['feedback_comments'];
+        image_hue: IMonthlyActivity['image_hue'];
+        title: IMonthlyActivity['title'];
+        tip: IMonthlyActivity['tip'];
+    }) => void;
+    showSnackbar?: (params: {
+        type: 'error' | 'info';
+        message: string;
+        bgColor: string;
+    }) => void;
+    onFeedback?: (feedback: TFeedback, studentCourseId: string) => void;
+}
+
+declare interface IMonthlyTimelineProps {
+    userType: 'PARENT' | 'TEACHER' | 'STUDENT';
+    studentId: string;
+    courseStreams?: string[];
+    onReportClick?: (reportId: string, reportType: REPORT_TYPE, year: number, month: string) => void;
+    scrollAreaHeight?: string | number;
+}
+
 export declare interface IMultiplayerWebGameProps extends IBaseWebGameProps, ISyncableWebGameProps {
     enablePlayerTurnIndicators?: boolean;
 }
@@ -2919,6 +3074,12 @@ declare interface IMultiTabBlockerProps {
     onTabBlock?: (source: string) => void;
 }
 
+declare interface INavigationConfig {
+    buttonVariant?: 'primary' | 'secondary';
+    buttonSize?: 'xsmall' | 'small' | 'medium' | 'large';
+    spacing?: number;
+}
+
 export declare enum IndicatorType {
     TOOLTIP = "tooltip",
     NUDGE = "nudge"
@@ -3279,6 +3440,12 @@ declare interface IProgramOption {
     [key: string]: unknown;
 }
 
+declare interface IProgressTimelineTabs {
+    onTabClick: (tab: ETAB_IDS) => void;
+    activeTab: string;
+    headerHeight: number;
+}
+
 export declare interface IProject<T> {
     type: ProjectType;
     data: T[];
@@ -3316,6 +3483,10 @@ declare interface IProjects_2 {
     };
 }
 
+declare interface IPTMReportProps {
+    ptmId: string;
+}
+
 declare interface IPublishData {
     eventName: string;
     eventPayload: IActionData;
@@ -3919,6 +4090,33 @@ declare interface ISubmitModalProps_2 {
     courseStream: TCourseStream;
 }
 
+export declare interface ISwipableCarousel {
+    items: ReactNode[];
+    children?: ReactNode;
+    defaultIndex?: number;
+    transitionDuration?: number;
+    onSwipeLeft?: () => void;
+    onSwipeRight?: () => void;
+    onIndexChange?: (index: number) => void;
+    showDots?: boolean;
+    dotsConfig?: IDotConfig;
+    showNavigationButtons?: boolean;
+    navigationConfig?: INavigationConfig;
+    onDotClick?: (index: number) => void;
+}
+
+export declare interface ISwipableCarouselRefs {
+    currentIndex: number;
+    goToIndex: (index: number) => void;
+}
+
+declare interface ISwipeableComponentProps {
+    onSwipeLeft?: () => void;
+    onSwipeRight?: () => void;
+    minSwipeDistance?: number;
+    children: ReactNode;
+}
+
 declare interface ISyncableWebGameProps {
     joinByRoomId?: string;
     enableSync?: boolean;
@@ -4537,7 +4735,7 @@ declare interface IUseWorksheetLayout {
         showNudgeBanner?: boolean;
         topOffset: number;
         imageHue?: THueNames;
-    }): IWorksheetLayout;
+    }): IWorksheetProps['layout'];
 }
 
 export declare interface IValidateUsernameResponseDal {
@@ -4673,7 +4871,7 @@ export declare interface IWorksheetBehavior {
     /**
      * If worksheet is attempting outside the class setting
      * This needs teacherValidationEnabled to be true
-     * TODO: Consider changing to accept validation type: 'system' | 'teacher' | undefined instead of boolean
+     * TODO-ANTIL: Accept only validation which can be 'system' or 'teacher' or undefined
      */
     canTeacherValidate: boolean;
     /**
@@ -4736,7 +4934,7 @@ declare interface IWorksheetCallbackProps {
     }) => void;
     onBulkResponsesChange?: (responses: Record<string, IWorksheetResponse>) => void;
     onResponsesChange?: (responses: Record<string, IWorksheetResponse>) => void;
-    onMediaStateChange?: (question: IWorksheetQuestion, mediaType: TWORKSHEET_QUESTION_MEDIA_TYPE, mediaState: Record<string, unknown>) => void;
+    onMediaStateChange?: (question: IWorksheetQuestion, mediaType: TWORKSHHET_QUESTION_MEDIA_TYPE, mediaState: Record<string, unknown>) => void;
     onTeacherValidation?: (questionId: string, rating?: keyof typeof QUESTIONS_RATING) => void;
     onOptionalItemAssignment?: (itemType: TItemType) => void;
     onOptionalItemSkip?: (itemType: TItemType) => void;
@@ -4748,9 +4946,14 @@ declare interface IWorksheetCallbackProps {
     onExitTicketStart?: () => void;
     onExitTicketSubmit?: () => void;
     onSubmit?: (responses: Record<string, IWorksheetResponse>) => void;
-    onActiveQuestionChange?: (question: IWorksheetQuestion) => void;
-    onResolveDoubt?: (responseId: string) => void;
-    onSkip?: (itemIndex: number, widgetIndex: number) => void;
+    loggerRef: MutableRefObject<(eventName: string, data?: Record<string, unknown>) => void>;
+}
+
+declare interface IWorksheetContainerProps extends Omit<IBaseWorksheetProps, 'behavior'>, IWorksheetCallbackProps, ICueCanvasProps, ICueCanvasCallbackProps, IPointerSyncCallbackProps, IWorksheetPlugins {
+    studentId: string;
+    attemptId?: string;
+    itemsSignedRequest: string;
+    questionsSignedRequest: string;
     onLoaded: () => void;
     onErrored: (error: {
         code?: number;
@@ -4758,6 +4961,14 @@ declare interface IWorksheetCallbackProps {
     }) => void;
     onResponsesLoaded?: (responses: Record<string, IWorksheetResponse>) => void;
     openQuestionFeedbackModal?: (itemRef: string) => void;
+    summaryDescription?: ReactElement | null;
+    canSubmitWorksheet?: boolean;
+    subjectiveProps?: ISubjectiveSheetProps;
+    inClass?: boolean;
+    isLessonV3Enabled?: boolean;
+    isDesmosEnabled?: boolean;
+    nodeType: TNodeTypes;
+    mode: 'resume' | 'review' | 'preview';
 }
 
 declare interface IWorksheetLayout {
@@ -4816,6 +5027,18 @@ declare interface IWorksheetPlugins {
 }
 
 export declare interface IWorksheetProps extends IBaseWorksheetProps, IWorksheetCallbackProps, ICueCanvasProps, ICueCanvasCallbackProps, IPointerSyncCallbackProps, IWorksheetPlugins {
+    learnosityActivityRef?: string;
+    learnosityItems: ILearnosityItem[];
+    learnosityResponses?: Record<string, IWorksheetResponse>;
+    learnosity: ILearnosity;
+    appendedQuestionIds: string[];
+    questionsSignedRequest: string;
+    openQuestionFeedbackModal?: (itemRef: string) => void;
+    summaryDescription?: ReactElement | null;
+    canSubmitWorksheet?: boolean;
+    studentId: string;
+    attemptId?: string;
+    subjectiveProps?: ISubjectiveSheetProps;
 }
 
 export declare interface IWorksheetQuestion extends ILearnosityQuestion {
@@ -4835,7 +5058,7 @@ export declare interface IWorksheetRef {
     validateQuestion: (responseId: string, rating?: keyof typeof QUESTIONS_RATING, skipRemainingQuestions?: boolean) => void;
     assignOptionalItems: (itemType: TItemType) => void;
     skipOptionalItems: (itemType: TItemType) => void;
-    updateMediaState: (responseId: string, mediaType: TWORKSHEET_QUESTION_MEDIA_TYPE, mediaState: Record<string, unknown>) => void;
+    updateMediaState: (responseId: string, mediaType: TWORKSHHET_QUESTION_MEDIA_TYPE, mediaState: Record<string, unknown>) => void;
 }
 
 export declare interface IWorksheetResponse {
@@ -5114,6 +5337,10 @@ export declare const Mobile: FC<SVGProps<SVGSVGElement>>;
  */
 export declare const ModalProvider: FC<IModalProviderProps>;
 
+export declare const MonthlyReport: NamedExoticComponent<IMonthlyReportProps>;
+
+export declare const MonthlyTimeline: NamedExoticComponent<IMonthlyTimelineProps>;
+
 export declare const MoreVerticalIcon: FC<SVGProps<SVGSVGElement>>;
 
 export declare const MorningIcon: FC<SVGProps<SVGSVGElement>>;
@@ -5455,6 +5682,8 @@ export declare enum ProjectType {
     TABLE = "table"
 }
 
+export declare const PTMReport: NamedExoticComponent<IPTMReportProps>;
+
 export declare interface Puzzle extends BaseProject {
     question: string;
     isHintSeen: boolean;
@@ -5530,6 +5759,12 @@ export declare const ReferenceSheet: FC<IReferenceSheetProps>;
 
 export declare const RemotePeerPointer: NamedExoticComponent<IPointerProps>;
 
+export declare enum REPORT_TYPE {
+    MPR_V1 = "MPR_V1",
+    MPR_V2 = "MPR_V2",
+    PTM = "PTM"
+}
+
 export declare const ReportInformation: FC<IReportInformationProps>;
 
 export declare const ResendOTP: NamedExoticComponent<IOTPResendProps>;
@@ -5646,7 +5881,7 @@ export declare const SHEET_DATA_TYPE: {
 
 export declare const SHEET_STATE: Record<TSheetStateProps, TSheetStateProps>;
 
-export declare const SheetError: NamedExoticComponent<IErrorProps_2>;
+export declare const SheetError: NamedExoticComponent<ErrorProps>;
 
 export declare const SheetIcon: FC<SVGProps<SVGSVGElement>>;
 
@@ -5799,6 +6034,10 @@ export declare const StudentTrialReportModal: MemoExoticComponent<() => JSX.Elem
 
 export declare const SubmitMilestoneModal: FC<ISubmitModalProps>;
 
+export declare const SwipableCarousel: NamedExoticComponent<ISwipableCarousel & RefAttributes<ISwipableCarouselRefs>>;
+
+export declare const SwipeableComponent: React.FC<ISwipeableComponentProps>;
+
 export declare const SwitchIcon: FC<SVGProps<SVGSVGElement>>;
 
 declare const TAB_CODES: {
@@ -6065,6 +6304,8 @@ declare interface TextProps {
     $cursor?: 'pointer' | 'default' | 'text' | 'not-allowed' | 'move' | 'help';
 }
 
+declare type TFeedback = 'positive' | 'negative';
+
 export declare type TFontFamilyNames = `${'Athletics'}-${'Light' | 'Regular' | 'Medium' | 'Bold' | 'Black'}` | `${'UntitledSans'}-${'Regular' | 'Medium'}`;
 
 declare type TGoalCategory = keyof typeof GOAL_CATEGORY | null;
@@ -6100,6 +6341,8 @@ export declare const TickIcon: FC<SVGProps<SVGSVGElement>>;
  */
 export declare const TimeLeftTimeline: FC<ITimeLeftTimelineProps>;
 
+export declare const TimelineTabs: MemoExoticComponent<({ onTabClick, activeTab, headerHeight }: IProgressTimelineTabs) => JSX.Element>;
+
 export declare type TInclassChannelMetadata = {
     syncModule?: {
         name: 'MILESTONE_CREATE' | 'MILESTONE_EDIT' | 'MILESTONE_REVIEW';
@@ -6157,7 +6400,7 @@ export declare type TInclassMessage = {
     eventPayload: {
         attemptId: string;
         responseId: string;
-        mediaType: TWORKSHEET_QUESTION_MEDIA_TYPE;
+        mediaType: TWORKSHHET_QUESTION_MEDIA_TYPE;
         mediaState: Record<string, unknown>;
     };
 } | {
@@ -6581,6 +6824,8 @@ export declare type TLPARSheetData = {
     permissions: TSheetPermissions;
 };
 
+declare type TMathRenderer = 'mathjax' | 'mathquill';
+
 declare type TMathSectionSummary = {
     section_code: 'MATH';
 } & TSectionSummary;
@@ -7019,12 +7264,12 @@ export declare const Tutorial: ForwardRefExoticComponent<ITutorialProps & RefAtt
 
 export declare const TutoringIcon: FC<SVGProps<SVGSVGElement>>;
 
-declare type TWORKSHEET_QUESTION_MEDIA_TYPE = 'SIMULATION' | 'VIDEO' | 'AUDIO';
-
 declare type TWorksheetItems = {
     ref: string;
 };
 
+declare type TWORKSHHET_QUESTION_MEDIA_TYPE = 'SIMULATION' | 'VIDEO' | 'AUDIO';
+
 export declare type TZIndexMap = Record<keyof typeof ZINDEX, number>;
 
 export declare const UIContext: Context<UIContextProps>;
@@ -7426,7 +7671,7 @@ declare type WithSrc = {
     src: string;
 };
 
-export declare const Worksheet: NamedExoticComponent<IWorksheetProps & RefAttributes<IWorksheetRef>>;
+export declare const Worksheet: NamedExoticComponent<IWorksheetContainerProps & RefAttributes<IWorksheetRef>>;
 
 export declare const WORKSHEET_ACTION_BAR_HEIGHT = 56;