@cuemath/leap 3.1.2-j2 → 3.1.2

package/dist/index.d.ts

@@ -295,10 +295,14 @@ export declare const CueCanvas: React.FC<ICueCanvas>;
 
 export declare const CueCanvasController: React_2.FC<IToolbarProps>;
 
+export declare const CueCanvasHomeworkController: NamedExoticComponent<IHomeWorkControllerProps>;
+
 export declare const CueCanvasProvider: FC<PropsWithChildren<{
     userType: TUserTypes;
 }>>;
 
+export declare const CueCanvasSideBar: NamedExoticComponent<ISidebar>;
+
 export declare const CuemathLogo: React_2.FC<React_2.SVGProps<SVGSVGElement>>;
 
 export declare const CueRocket: React.FC<React.SVGProps<SVGSVGElement>>;
@@ -753,7 +757,7 @@ declare interface IButtonProps extends ButtonHTMLAttributes<HTMLButtonElement>,
     shape?: 'curved' | 'square';
     disabled?: boolean;
     busy?: boolean;
-    width?: number | string;
+    width?: number;
     widthX?: number;
     Icon?: React.FC<React.SVGProps<SVGSVGElement>>;
     iconPosition?: 'left' | 'right';
@@ -799,6 +803,11 @@ declare interface ICalloutProps {
     marginBottomX: number;
 }
 
+declare interface ICanvasUpdateConfig {
+    dimesion?: IViewport;
+    gridName?: TCueCanvasGridName;
+}
+
 declare interface ICascadeSelectValue {
     variant: string;
     detail: string;
@@ -1204,6 +1213,8 @@ declare interface ICueCanvas {
     onUpdateHeight?: TUpdateHeight;
     onPublish?: TPublish;
     onSubscribe?: TSubscribe;
+    canvasConfig?: ICanvasUpdateConfig | null;
+    updateCanvasConfig?: TUpdateCanvasConfig;
 }
 
 declare interface ICueCanvasCallbackProps {
@@ -1451,6 +1462,7 @@ declare interface IGoalCurriculumMap {
     program_code: string;
     program_name: string;
     program_id: string;
+    is_live: boolean;
 }
 
 declare interface IGooglePlaceOption extends google.maps.places.AutocompletePrediction, ISelectOption<string> {
@@ -1478,6 +1490,30 @@ export declare interface IHomepageStartJourneyProps {
     userType: TUserTypes;
 }
 
+declare interface IHomeWorkControllerProps {
+    width: number;
+    hwRequests?: IHomeWorkHelpRequestModel[];
+    onMarkAsResolved?: (homeworkId: string, onSuccess: () => void) => void;
+    onSendImageToChat?: (homeworkId: string, snapshot: Blob[], onSuccess: () => void) => void;
+}
+
+export declare interface IHomeWorkHelpRequestModel {
+    channel_id: string;
+    created_on_ts: number;
+    homework_id: string;
+    id: string;
+    message_timestamp: string;
+    problem_description: string;
+    problem_image_urls: string[];
+    state: string;
+    student_id: string;
+    teacher_id: string;
+}
+
+declare interface IHomeWorkHelpRequestModelWithStudentName extends IHomeWorkHelpRequestModel {
+    student_name: string;
+}
+
 declare interface IIconButtonProps extends Omit<IButtonProps, 'label' | 'shape' | 'widthX' | 'width' | 'iconPosition' | 'alignSelf' | 'analyticsLabel' | 'renderAs'>, Required<Pick<IClickableAnalyticsProps, 'analyticsLabel'>> {
     Icon: React.FC<React.SVGProps<SVGSVGElement>>;
     customBgColor?: TColorNames;
@@ -1908,6 +1944,7 @@ export declare const ILLUSTRATIONS: {
     DURATION_60MIN_GRAY: string;
     DURATION_90MIN_GRAY: string;
     EARTH_GREEN: string;
+    ELLIPSE_CLIP: string;
     FEMALE_AVATAR: string;
     GAME_PLAY: string;
     GLOBE_WITH_BLUE_FILL: string;
@@ -2463,7 +2500,7 @@ declare interface IOTPResendProps {
     showVoiceOTP?: boolean;
     disabled?: boolean;
     renderAs?: 'submit' | 'text';
-    width?: number | string;
+    width?: number;
 }
 
 declare interface IOutcomeConfig {
@@ -2971,6 +3008,11 @@ declare interface ISheetsListProps extends ISheetItemCallbackProps {
     section?: TSheetsSection;
 }
 
+declare interface ISidebar {
+    grade?: string;
+    hwRequests?: IHomeWorkHelpRequestModelWithStudentName[];
+}
+
 declare interface ISignupMethodsProps {
     onEmailSignup: () => void;
     onPhoneSignup: () => void;
@@ -3010,8 +3052,7 @@ declare interface ISingleFieldFormProps {
 
 declare interface ISocialAccountNotFoundProps {
     onRetryLogin: () => void;
-    onGoToSignup?: () => void;
-    showGoToSignup?: boolean;
+    onGoToSignup: () => void;
 }
 
 declare interface ISocialLoginMethodsProps {
@@ -3340,6 +3381,8 @@ declare interface ITile {
         toPort?: string;
         toTileId: string;
     }[];
+    html?: string;
+    width?: number | string;
 }
 
 declare interface ITimeLeftTimelineProps {
@@ -3486,16 +3529,6 @@ declare interface IUseContextMenuClickHandler {
     };
 }
 
-declare interface IUseDeviceTypeReturn {
-    width: number;
-    isMobile: boolean;
-    isTablet: boolean;
-    isDesktop: boolean;
-    isLarge: boolean;
-    isXL: boolean;
-    deviceType: 'mobile' | 'tablet' | 'desktop' | 'large' | 'xl';
-}
-
 declare interface IUseForceReload {
     threshold: number;
     trackEvent: (event_name: string, payload: Record<string, unknown>, overrides: Record<string, unknown>) => void;
@@ -4060,11 +4093,6 @@ export declare const Maintenance: React_2.FC<IMaintenanceProps>;
 
 declare const MASTERY: "mastery";
 
-export declare const media: {
-    up920: string;
-    down919: string;
-};
-
 export declare const MilestoneActionWidget: React_2.FC<IMilestoneActionWidgetProps>;
 
 export declare const MilestoneCreate: React.FC<IMileStoneCreateContainerProps>;
@@ -4489,7 +4517,7 @@ export declare const SkipColoredIcon: React.FC<React.SVGProps<SVGSVGElement>>;
 
 export declare const SkipIcon: React.FC<React.SVGProps<SVGSVGElement>>;
 
-export declare const SocialAccountNotFound: MemoExoticComponent<({ onRetryLogin, onGoToSignup, showGoToSignup, }: ISocialAccountNotFoundProps) => JSX_2.Element>;
+export declare const SocialAccountNotFound: MemoExoticComponent<({ onRetryLogin, onGoToSignup }: ISocialAccountNotFoundProps) => JSX_2.Element>;
 
 export declare const SocialLoginMethods: NamedExoticComponent<ISocialLoginMethodsProps>;
 
@@ -5585,6 +5613,8 @@ export declare type TTrialSessionMessage = {
     };
 };
 
+declare type TUpdateCanvasConfig = (data: ICanvasUpdateConfig) => void;
+
 declare type TUpdateHeight = (height: number) => void;
 
 declare type TUserAccount = {
@@ -5636,12 +5666,14 @@ 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, initialCanvasData?: Array<IChannelMessage>) => {
-    publishStrokes: ((message: unknown) => boolean) | undefined;
+export declare const useCanvasSyncBroker: (channelId: string, logEvent: (type: string, payload?: Record<string, unknown>) => void, initialCanvasData?: Array<IChannelMessage>, type?: TRenderAs_2) => {
+    publishStrokes: ((message: IPublishData) => boolean) | undefined;
     channelStatus: ChannelStatus | undefined;
     closeChannel: () => void;
     initialStrokesData: Record<string, IActionData[]>;
     registerCallback: (qrId: string, cb: (data: IActionData) => void) => void;
+    setChannelMetadata: ((metadata: ICanvasUpdateConfig, merge?: boolean) => void) | undefined;
+    channelMetadata: ICanvasUpdateConfig | null | undefined;
 };
 
 export declare const useChapterPageJourney: () => {
@@ -5664,8 +5696,6 @@ export declare const useClassTimeAlerts: ({ alertLevel, classStartedOn, classDur
 
 export declare const useContextMenuClickHandler: IUseContextMenuClickHandler;
 
-export declare const useDeviceType: () => IUseDeviceTypeReturn;
-
 export declare const useForceReload: ({ threshold, trackEvent, shouldNotReload }: IUseForceReload) => void;
 
 export declare const useGetAllMilestonesdata: (initialQuery?: TQuery | undefined) => {