@local-civics/mgmt-ui 0.1.230 → 0.1.232

package/dist/index.d.ts

@@ -879,6 +879,38 @@ interface SubmissionItem {
     pathwayId?: string;
 }
 
+/**
+ * LeaveCommentStudentOption
+ */
+type LeaveCommentStudentOption = {
+    userId: string;
+    name: string;
+};
+/**
+ * LeaveCommentBadgeOption
+ */
+type LeaveCommentBadgeOption = {
+    badgeId: string;
+    displayName: string;
+};
+/**
+ * LeaveCommentLessonOption
+ */
+type LeaveCommentLessonOption = {
+    lessonId: string;
+    displayName: string;
+};
+/**
+ * LeaveCommentPayload
+ */
+type LeaveCommentPayload = {
+    userId: string;
+    commentText: string;
+    requireValidation: boolean;
+    badgeId?: string;
+    lessonId?: string;
+};
+
 /**
  * FileLockerUserItem
  */
@@ -926,6 +958,7 @@ type FileLockerProps = {
     onBadgeClick?: (badgeId: string) => void;
     onLessonClick?: (lessonId: string) => void;
     onPathwayClick?: (pathwayId: string) => void;
+    onComment?: (comment: LeaveCommentPayload) => void;
 };
 /**
  * FileLocker
@@ -934,4 +967,104 @@ type FileLockerProps = {
  */
 declare const FileLocker: (props: FileLockerProps) => JSX.Element;
 
-export { AccountItem, AdminProvider, AdminProviderProps, App, AppProps, Badge, BadgeClass, BadgeItem, BadgeProps, BadgeUserItem, Badges, BadgesProps, Class, ClassItem, ClassProps, Classes, ClassesProps, Dashboard, DashboardClass, DashboardProps, FileLocker, FileLockerClass, FileLockerProps, FileLockerUserItem, GettingStarted, GettingStartedProps, Home, HomeProps, Lesson, LessonClass, LessonItem, LessonProps, LessonUserItem, Lessons, LessonsProps, MemberItem, Navbar, NavbarProps, NewTrialRegistration, Organization, OrganizationProps, Pathway, PathwayClass, PathwayProps, PathwayUserItem, Pathways, PathwaysItem, PathwaysProps, People, PeopleProps, StartAnonymousLesson, StartAnonymousLessonProps, Student, StudentProps, SwitchAccount, SwitchAccountProps, TrialHome, TrialHomeProps, TrialRegistration, TrialRegistrationProps, UserItem };
+/**
+ * CommentCenterClass
+ */
+type CommentCenterClass = {
+    classId: string;
+    name: string;
+    active: boolean;
+};
+/**
+ * CommentCenterItem
+ */
+type CommentCenterItem = {
+    commentId: string;
+    recipientId: string;
+    recipientName: string;
+    authorId: string;
+    authorName?: string;
+    badgeId?: string;
+    badgeName?: string;
+    lessonId?: string;
+    lessonName?: string;
+    commentText: string;
+    requireValidation: boolean;
+    resolvedAt?: string;
+    createdAt: string;
+};
+/**
+ * CommentCenterProps
+ */
+type CommentCenterProps = {
+    loading: boolean;
+    classes: CommentCenterClass[];
+    classId: string;
+    comments: CommentCenterItem[];
+    students: LeaveCommentStudentOption[];
+    badges: LeaveCommentBadgeOption[];
+    lessons: LeaveCommentLessonOption[];
+    onClassChange: (classId: string) => void;
+    onResolve: (commentId: string) => void;
+    onLeaveComment: (comment: LeaveCommentPayload) => void;
+};
+/**
+ * CommentCenter. Org-wide view of every comment left across the organization - grouped by student,
+ * badge, or lesson via the same pill-tab selector and class dropdown FileLocker uses - with the
+ * ability to resolve any comment that requires validation (see Comment.RequireValidation on the
+ * backend) and to leave a brand new comment for any student via LeaveCommentModal.
+ * @param props
+ * @constructor
+ */
+declare const CommentCenter: (props: CommentCenterProps) => JSX.Element;
+
+/**
+ * ValidationCenterClass
+ */
+type ValidationCenterClass = {
+    classId: string;
+    name: string;
+    active: boolean;
+};
+/**
+ * ValidationCenterBadge
+ */
+type ValidationCenterBadge = {
+    badgeId: string;
+    displayName: string;
+};
+/**
+ * ValidationCenterStudent
+ */
+type ValidationCenterStudent = {
+    userId: string;
+    name: string;
+    avatar?: string;
+    hasCredit: boolean;
+};
+/**
+ * ValidationCenterProps
+ */
+type ValidationCenterProps = {
+    loading: boolean;
+    classes: ValidationCenterClass[];
+    classId: string;
+    badges: ValidationCenterBadge[];
+    badgeId: string;
+    students: ValidationCenterStudent[];
+    onClassChange: (classId: string) => void;
+    onBadgeChange: (badgeId: string) => void;
+    onSubmit: (userIds: string[]) => void;
+};
+/**
+ * ValidationCenter. Lets an educator directly credit one or more students for a badge - superseding
+ * lesson/criteria requirements and any outstanding comments, exactly like study's
+ * BadgeActivity.Validate() (used via the bulk :validate endpoint). A student who already has credit
+ * shows a checkmark instead of a checkbox, since re-validating an already-finished badge is a no-op
+ * on the backend (Validate guards on FinishedAt != nil just like Submit).
+ * @param props
+ * @constructor
+ */
+declare const ValidationCenter: (props: ValidationCenterProps) => JSX.Element;
+
+export { AccountItem, AdminProvider, AdminProviderProps, App, AppProps, Badge, BadgeClass, BadgeItem, BadgeProps, BadgeUserItem, Badges, BadgesProps, Class, ClassItem, ClassProps, Classes, ClassesProps, CommentCenter, CommentCenterClass, CommentCenterItem, CommentCenterProps, Dashboard, DashboardClass, DashboardProps, FileLocker, FileLockerClass, FileLockerProps, FileLockerUserItem, GettingStarted, GettingStartedProps, Home, HomeProps, Lesson, LessonClass, LessonItem, LessonProps, LessonUserItem, Lessons, LessonsProps, MemberItem, Navbar, NavbarProps, NewTrialRegistration, Organization, OrganizationProps, Pathway, PathwayClass, PathwayProps, PathwayUserItem, Pathways, PathwaysItem, PathwaysProps, People, PeopleProps, StartAnonymousLesson, StartAnonymousLessonProps, Student, StudentProps, SwitchAccount, SwitchAccountProps, TrialHome, TrialHomeProps, TrialRegistration, TrialRegistrationProps, UserItem, ValidationCenter, ValidationCenterBadge, ValidationCenterClass, ValidationCenterProps, ValidationCenterStudent };