@cuemath/leap 2.8.35-beta-0.4 → 2.8.35-rj-0

package/dist/index.d.ts

@@ -9,6 +9,7 @@ import type { Dispatch } from 'react';
 import { FC } from 'react';
 import { ForwardRefExoticComponent } from 'react';
 import { HTMLAttributes } from 'react';
+import { IChannelMessage } from '@cuemath/cue-message-broker';
 import type { IframeHTMLAttributes } from 'react';
 import type { InputHTMLAttributes } from 'react';
 import { IProvidedProps } from 'google-maps-react';
@@ -165,6 +166,10 @@ export declare const ChevronLeftIcon: React_2.FC<IconProps_2>;
 
 export declare const ChevronRightIcon: React_2.FC<IconProps>;
 
+export declare enum CIRCLE_ACTION_IDS {
+    STREAK_DECREASED = "streak_decreased"
+}
+
 export declare enum CIRCLE_ONBOARDING_ANALYTICS_STEPS {
     SKILL_ACTIVITY = "skill_activity",
     GAMES_ACTIVITY = "games_activity",
@@ -298,8 +303,6 @@ export declare enum EPostGameStat {
     POINT = "point"
 }
 
-export declare const EPResourceAssign: FC<IEPResourceAssign>;
-
 export declare const EraserIcon: React.FC<React.SVGProps<SVGSVGElement>>;
 
 declare const Error_2: React_2.FC<IErrorProps>;
@@ -329,7 +332,6 @@ export declare const EVENTS: {
     MILESTONE_RESOURCE_UNASSIGNED: "MILESTONE_RESOURCE_UNASSIGNED";
     MILESTONE_RESOURCE_RESET: "MILESTONE_RESOURCE_RESET";
     PAST_MILESTONE_OUTCOME_ADDED: "PAST_MILESTONE_OUTCOME_ADDED";
-    MILESTONE_TEST_ASSIGNED: "MILESTONE_TEST_ASSIGNED";
     CHAPTER_UPDATED: "CHAPTER_UPDATED";
     LESSONS_MARKED_AS_FAMILIAR: "LESSONS_MARKED_AS_FAMILIAR";
     LESSONS_MARKED_AS_IRRELEVANT: "LESSONS_MARKED_AS_IRRELEVANT";
@@ -832,6 +834,8 @@ export declare interface ICircleHomeDetails {
     points: number;
     streakDays: number;
     streakStatus: TStreakStatus;
+    streakReduction: number;
+    streakDaysBeforeReduction: number;
     tournamentRank: number;
     projects: IProjects;
     timestamps: ITodaysContentTimeStamps;
@@ -1036,17 +1040,6 @@ declare interface IEditMilestoneModalProps extends IMilestoneEditProps {
     courseStream: TCourseStream;
 }
 
-declare interface IEPResourceAssign {
-    studentId: string;
-    stream: TCourseStream;
-    programId?: string;
-    userMilestoneId?: string;
-    onError: (errorMessage: string) => void;
-    onResourceAssign: (toastMessage: string) => void;
-    onExitResourceAssign: () => void;
-    onViewResource: (resource: IResourceItemData) => void;
-}
-
 declare interface IErrorProps {
     onTryAgain?: () => void;
     height?: string | number;
@@ -1131,6 +1124,8 @@ declare interface IGetCircleHomeResponseModel {
     points: number;
     tournament_rank: number;
     streak_days: number;
+    streak_reduction: number;
+    streak_days_before_reduction: number;
     streak_status: 'pending' | 'completed';
     projects: IProjects_2;
     timestamps: ITimeStampsResponseModel;
@@ -1213,6 +1208,11 @@ declare interface IIconButtonProps extends Omit<IButtonProps, 'label' | 'shape'
     customBgColor?: TColorNames;
 }
 
+declare interface IInfoBarProps {
+    hue: THueNames;
+    children: React.ReactNode;
+}
+
 export declare interface IInfoMessage {
     message: string;
     position: 'top' | 'bottom';
@@ -1356,6 +1356,10 @@ declare interface ILeaderboardProps {
     userId: string;
     onClose: () => void;
     isLoading: boolean;
+    streakInfo: {
+        streakReduction: number;
+        startTimestampToday: number;
+    };
 }
 
 declare interface ILearningSheetData {
@@ -1984,6 +1988,8 @@ export declare enum IndicatorType {
 
 export declare const Info2Icon: React_2.FC<React_2.SVGProps<SVGSVGElement>>;
 
+export declare const InfoBar: React.FC<IInfoBarProps>;
+
 export declare const InfoIcon: React.FC<React.SVGProps<SVGSVGElement>>;
 
 export declare interface INudgeProps {
@@ -2061,6 +2067,7 @@ export declare interface IPlayer {
     grade?: string;
     avatar?: IAvatarLayer[] | null;
     playerType: TUserTypes;
+    countryCode: string;
 }
 
 export declare interface IPlayerStats {
@@ -2275,24 +2282,6 @@ declare interface IReferenceSheetProps {
     };
 }
 
-export declare interface IResourceItemData {
-    boards: string[];
-    created_on: string;
-    created_on_ts: number;
-    grades: string[];
-    id: string;
-    is_lesson_v3_enabled: boolean;
-    is_live: boolean;
-    learnosity_activity_ref: string;
-    name: string;
-    node_id: string;
-    node_type: string;
-    stream: TCourseStream;
-    topics: string[];
-    updated_on: string;
-    updated_on_ts: number;
-}
-
 export declare interface IResponseAnalyticsProps extends Omit<IClickableAnalyticsProps, 'label'> {
 }
 
@@ -2606,13 +2595,11 @@ export declare const isV3WorksheetAttempt: (attempt: IWorksheetAttemptModel) =>
 declare interface ITabProps {
     label: number | string;
     $selected: boolean;
-    $width?: number | string;
+    $width?: number;
     $renderAs?: TTabVariants;
     $size?: TTabSizes;
     $disabled?: boolean;
     onClick: () => void;
-    shape?: 'curved' | 'square';
-    minWidth?: number;
 }
 
 export declare interface ITabSizeConfig {
@@ -2767,7 +2754,7 @@ declare interface ITimeStampsResponseModel {
     rush_hour_end_timestamp?: number;
 }
 
-declare interface ITodaysContentTimeStamps {
+export declare interface ITodaysContentTimeStamps {
     current: number;
     startTimestamp: number;
     endTimestamp: number;
@@ -2818,6 +2805,7 @@ declare interface ITrialSessionMetadata {
 }
 
 declare interface ITrialSessionProps {
+    countryCode: string;
     classStartedOn?: Date;
     height?: string | number;
     userType: TUserTypes;
@@ -3027,6 +3015,7 @@ export declare interface IWorksheetAttemptModel {
     desmos_calculator_enabled: boolean;
     due_date: number | null;
     state: TLPARSheetAttemptState;
+    canvas_data?: Array<IChannelMessage>;
 }
 
 export declare interface IWorksheetBehavior {
@@ -3274,14 +3263,15 @@ export declare enum JOURNEY_ID_STUDENT {
     CIRCLE_LEADERBOARD_INTRO_JOURNEY = "CIRCLE_LEADERBOARD_INTRO_JOURNEY",
     CIRCLE_POINTS_REWARD_JOURNEY = "CIRCLE_POINTS_REWARD_JOURNEY",
     CIRCLE_STREAK_UPDATE_JOURNEY = "CIRCLE_STREAK_UPDATE_JOURNEY",
-    CIRCLE_TUTORIAL_JOURNEY = "CIRCLE_TUTORIAL_JOURNEY"
+    CIRCLE_TUTORIAL_JOURNEY = "CIRCLE_TUTORIAL_JOURNEY",
+    CIRCLE_STREAK_REDUCTION_JOURNEY = "CIRCLE_STREAK_REDUCTION_JOURNEY"
 }
 
 export declare const JourneyProvider: FC<{
     children: ReactNode;
 }>;
 
-export declare const Leaderboard: ({ leaderboardData, type, userId, onClose, isLoading, }: ILeaderboardProps) => JSX_2.Element;
+export declare const Leaderboard: ({ leaderboardData, type, userId, onClose, isLoading, streakInfo, }: ILeaderboardProps) => JSX_2.Element;
 
 export declare const LearnosityPreloader: FC<PropsWithChildren<ILearnosityPreloaderProps>>;
 
@@ -3577,7 +3567,8 @@ export declare enum PLATFORM_EVENTS_STUDENT {
     STREAK_ICON_CLICKED = "streak_icon_clicked",
     LEADERBOARD_BUTTON_CLICKED = "leaderboard_button_clicked",
     ONBOARDING_STEP_VIEWED = "onboarding_step_viewed",
-    ONBOARDING_STEP_COMPLETED = "onboarding_step_completed"
+    ONBOARDING_STEP_COMPLETED = "onboarding_step_completed",
+    COACHMARK_DISMISSED = "coachmark_dismissed"
 }
 
 export declare enum PLATFORM_EVENTS_TEACHER {
@@ -3782,8 +3773,6 @@ export declare const SHEET_STATE: Record<TSheetStateProps, TSheetStateProps>;
 
 export declare const SheetError: NamedExoticComponent<ErrorProps>;
 
-export declare const SheetIcon: React.FC<React.SVGProps<SVGSVGElement>>;
-
 export declare const SheetList: FC<ISheetsListProps>;
 
 export declare const SheetLocked: MemoExoticComponent<({ onHomeClick }: {
@@ -3839,6 +3828,17 @@ declare const STICKER_BADGE: {
 
 export declare const StreakIcon: React_2.FC<IStreakIconProps>;
 
+export declare class StreakReductionLocalStorageUtil {
+    /**
+     * Determines whether the streak reduction should be shown today.
+     */
+    static showStreakReduction(storeKey: string, startTimestamp: number): boolean;
+    /**
+     * Call this when the user has dismissed the streak reduction.
+     */
+    static markStreakReductionDismissed(storeKey: string, startTimestamp: number): void;
+}
+
 export declare const StrikedEyeIcon: React.FC<React.SVGProps<SVGSVGElement>>;
 
 export declare const StudentDetails: FC<IStudentDetailsProps>;
@@ -4263,11 +4263,6 @@ export declare type TInclassMessage = {
     eventPayload: {
         milestoneId: string;
     };
-} | {
-    eventName: typeof EVENTS.MILESTONE_TEST_ASSIGNED;
-    eventPayload: {
-        milestoneId: string;
-    };
 } | {
     eventName: typeof EVENTS.MILESTONE_RESOURCE_RESET;
     eventPayload: {
@@ -4834,7 +4829,7 @@ export declare const UpIcon: React.FC<React.SVGProps<SVGSVGElement>>;
 
 export declare const useAutoPlayPermission: () => IAutoPlayPermissionContextType;
 
-export declare const useCanvasSyncBroker: (channelId: string, logEvent: (type: string, payload?: Record<string, unknown>) => void) => {
+export declare const useCanvasSyncBroker: (channelId: string, logEvent: (type: string, payload?: Record<string, unknown>) => void, initialCanvasData?: Array<IChannelMessage>) => {
     publishStrokes: ((message: unknown) => boolean) | undefined;
     channelStatus: ChannelStatus | undefined;
     closeChannel: () => void;
@@ -4885,9 +4880,9 @@ declare const useGetCircleHomeAPI: (initialId?: string, initialQuery?: IGetCircl
     } & Record<string, unknown>) | undefined;
 };
 
-export declare const useGetCircleHomeDetailsDal: (userId: string, countryCode: string, grade: string) => Omit<ReturnType<typeof useGetCircleHomeAPI>, "data" | "get"> & {
+export declare const useGetCircleHomeDetailsDal: (userId: string, grade: string) => Omit<ReturnType<typeof useGetCircleHomeAPI>, "data" | "get"> & {
     data: ICircleHomeDetails | null;
-    getCircleHomeDetails: () => void;
+    getCircleHomeDetails: (countryCode: string) => void;
 };
 
 declare const useGetLeaderboard: (initialId?: string, initialQuery?: IGetLeaderboardPayloadModel | undefined) => {