@local-civics/mgmt-ui 0.1.117-beta.1 → 0.1.117-beta.3

package/dist/index.d.ts

@@ -0,0 +1,686 @@
+export { showNotification, updateNotification } from '@mantine/notifications';
+import * as React from 'react';
+
+/**
+ * NavbarProps
+ */
+interface NavbarProps {
+    active: string;
+    version: string;
+    image: string;
+    name: string;
+    email: string;
+    links: Record<string, {
+        notifications: number;
+        href: string;
+        hidden?: boolean;
+    }>;
+    trial?: boolean;
+    loading?: boolean;
+    onLogout: () => void;
+    onGettingStarted: () => void;
+    onSwitchAccounts?: () => void;
+}
+declare function Navbar(props: NavbarProps): JSX.Element;
+
+/**
+ * GettingStartedProps
+ */
+type GettingStartedProps = {
+    opened: boolean;
+    loading: boolean;
+    videoURL: string;
+    onClose: () => void;
+};
+/**
+ * GettingStarted
+ * @param props
+ * @constructor
+ */
+declare const GettingStarted: (props: GettingStartedProps) => JSX.Element;
+
+/**
+ * AccountItem
+ */
+type AccountItem = {
+    accountId: string;
+    name: string;
+    isAdmin?: boolean;
+    isGroupAdmin?: boolean;
+};
+/**
+ * SwitchAccountProps
+ */
+type SwitchAccountProps = {
+    opened: boolean;
+    account: string;
+    loading: boolean;
+    accounts: AccountItem[];
+    onClick: (account: string) => void;
+    onClose: () => void;
+};
+/**
+ * SwitchAccount
+ * @param props
+ * @constructor
+ */
+declare const SwitchAccount: (props: SwitchAccountProps) => JSX.Element;
+
+/**
+ * Item
+ */
+interface Item$j {
+    lessonName: string;
+    completion: number;
+    isStarted?: boolean;
+    href: string;
+}
+
+/**
+ * Item
+ */
+interface Item$i {
+    userId: string;
+    avatar: string;
+    name: string;
+    email: string;
+    isComplete?: boolean;
+    lessons: Item$j[];
+}
+
+/**
+ * Item
+ */
+interface Item$h {
+    lessonId: string;
+    lessonName: string;
+    percentageCompletion: number;
+    href: string;
+}
+
+/**
+ * BadgeUserItem
+ */
+type BadgeUserItem = Item$i;
+/**
+ * BadgeClass
+ */
+type BadgeClass = {
+    classId: string;
+    name: string;
+    active: boolean;
+};
+/**
+ * BadgeProps
+ */
+type BadgeProps = {
+    loading: boolean;
+    displayName: string;
+    description: string;
+    classes: BadgeClass[];
+    lessons: Item$h[];
+    classId: string;
+    students: BadgeUserItem[];
+    href: string;
+    trial?: boolean;
+    lessonsCompleted?: number;
+    onBackClick: () => void;
+    onClassChange: (classId: string) => void;
+    onCopyLinkClick: () => void;
+    onExportDataClick: () => void;
+};
+/**
+ * Badge
+ * @param props
+ * @constructor
+ */
+declare const Badge: (props: BadgeProps) => JSX.Element;
+
+/**
+ * Item
+ */
+interface Item$g {
+    badgeId: string;
+    name: string;
+    description: string;
+    href: string;
+}
+
+/**
+ * BadgeItem
+ */
+type BadgeItem = Item$g;
+/**
+ * BadgesProps
+ */
+type BadgesProps = {
+    loading: boolean;
+    badges: BadgeItem[];
+    onAutocompleteChange: (value: string) => void;
+};
+/**
+ * Badges
+ * @param props
+ * @constructor
+ */
+declare const Badges: (props: BadgesProps) => JSX.Element;
+
+/**
+ * Item
+ */
+interface Item$f {
+    studentId: string;
+    studentName: string;
+    className: string;
+}
+
+/**
+ * Item
+ */
+interface Item$e {
+    lessonName: string;
+    studentName: string;
+    reflection: string;
+    updatedAt: string;
+}
+
+/**
+ * Item
+ */
+interface Item$d {
+    studentName: string;
+    impactStatement: string;
+}
+
+/**
+ * Item
+ */
+interface Item$c {
+    badgeId: string;
+    name: string;
+    description: string;
+    percentageCompletion: number;
+}
+
+/**
+ * Item
+ */
+interface Item$b {
+    lessonId: string;
+    name: string;
+    description: string;
+    percentageCompletion: number;
+}
+
+/**
+ * DashboardClass
+ */
+type DashboardClass = {
+    classId: string;
+    name: string;
+};
+/**
+ * DashboardProps
+ */
+type DashboardProps = {
+    loading: boolean;
+    students: Item$f[];
+    impacts: Item$d[];
+    reflections: Item$e[];
+    classes: DashboardClass[];
+    badges: Item$c[];
+    lessons: Item$b[];
+    classId: string;
+    percentageOfAccountsCreated: number;
+    numberOfBadgesEarned: number;
+    numberOfLessonsCompleted: number;
+    onClassChange: (classId: string) => void;
+    onViewStudentProfile: (student: Item$f) => void;
+    onBadgeClick: (badge: Item$c) => void;
+    onLessonClick: (lesson: Item$b) => void;
+};
+/**
+ * Dashboard
+ * @param props
+ * @constructor
+ */
+declare const Dashboard: (props: DashboardProps) => JSX.Element;
+
+/**
+ * Item
+ */
+type Item$a = {
+    classId: string;
+    userId: string;
+    avatar: string;
+    email: string;
+    givenName: string;
+    familyName: string;
+    lastActivity: Date | null;
+    readonly: boolean;
+    hasAccount: boolean;
+    badgesEarned: number;
+    lessonsCompleted: number;
+    isAdmin: boolean;
+    href: string;
+};
+
+/**
+ * MemberItem
+ */
+type MemberItem = Item$a;
+/**
+ * ClassProps
+ */
+type ClassProps = {
+    loading: boolean;
+    displayName: string;
+    description: string;
+    members: MemberItem[];
+    percentageOfAccountsCreated: number;
+    numberOfBadgesEarned: number;
+    numberOfLessonsCompleted: number;
+    onBackClick: () => void;
+    onCreateMembers: (members: MemberItem[]) => void;
+    onDeleteMember: (student: MemberItem) => void;
+    onChangeUserRole: (user: MemberItem, role: string | null) => void;
+    onCopyLinkClick: () => void;
+};
+/**
+ * Class
+ * @param props
+ * @constructor
+ */
+declare const Class: (props: ClassProps) => JSX.Element;
+
+/**
+ * Item
+ */
+type Item$9 = {
+    href: string;
+    classId: string;
+    name: string;
+    description: string;
+    numberOfStudents: number;
+};
+
+/**
+ * ClassItem
+ */
+type ClassItem = Item$9;
+/**
+ * ClassesProps
+ */
+type ClassesProps = {
+    loading: boolean;
+    classes: ClassItem[];
+    onCreateClass: (group: ClassItem) => void;
+    onDeleteClass: (group: ClassItem) => void;
+    onAutocompleteChange: (next: string) => void;
+};
+/**
+ * Classes
+ * @param props
+ * @constructor
+ */
+declare const Classes: (props: ClassesProps) => JSX.Element;
+
+/**
+ * Item
+ */
+interface Item$8 {
+    badgeId: string;
+    badgeName: string;
+    isComplete?: boolean;
+}
+
+/**
+ * Item
+ */
+interface Item$7 {
+    lessonId: string;
+    lessonName: string;
+    questionName: string;
+    answer: string[];
+    href: string;
+}
+
+/**
+ * Item
+ */
+interface Item$6 {
+    lessonId: string;
+    lessonName: string;
+    reflection: string;
+    rating: number;
+    href: string;
+}
+
+/**
+ * StudentProps
+ */
+type StudentProps = {
+    loading: boolean;
+    name: string;
+    impactStatement: string;
+    numberOfProblemsSolved: number;
+    percentageOfLessonsCompleted: number;
+    badges: Item$8[];
+    answers: Item$7[];
+    reflections: Item$6[];
+    onBackClick: () => void;
+};
+declare const Student: (props: StudentProps) => JSX.Element;
+
+/**
+ * HomeProps
+ */
+type HomeProps = {
+    loading: boolean;
+    avatarURL: string;
+    name: string;
+    impactStatement: string;
+    organization: {
+        name: string;
+        description: string;
+        image: string;
+        website: string;
+    };
+    onDashboardClick: () => void;
+    onClassesClick: () => void;
+    onLessonsClick: () => void;
+    onBadgesClick: () => void;
+};
+/**
+ * Home
+ * @param props
+ * @constructor
+ */
+declare const Home: (props: HomeProps) => JSX.Element;
+
+/**
+ * Item
+ */
+interface Item$5 {
+    studentName: string;
+    reflection: string;
+    rating: number;
+}
+
+/**
+ * Item
+ */
+interface Item$4 {
+    questionName: string;
+    answer: string[];
+}
+
+/**
+ * Item
+ */
+interface Item$3 {
+    userId: string;
+    avatar: string;
+    name: string;
+    email: string;
+    answers: Item$4[];
+    isStarted?: boolean;
+    isComplete?: boolean;
+    href: string;
+}
+
+/**
+ * Item
+ */
+interface Item$2 {
+    question: string;
+    answers: string[][];
+    choices?: string[];
+    chart?: boolean;
+}
+
+/**
+ * LessonUserItem
+ */
+type LessonUserItem = Item$3;
+/**
+ * LessonClass
+ */
+type LessonClass = {
+    classId: string;
+    name: string;
+    active: boolean;
+};
+/**
+ * LessonProps
+ */
+type LessonProps = {
+    loading: boolean;
+    displayName: string;
+    description: string;
+    href: string;
+    classId: string;
+    classes: LessonClass[];
+    students: LessonUserItem[];
+    reflections: Item$5[];
+    questions: Item$2[];
+    trial?: boolean;
+    lessonsCompleted?: number;
+    contributors?: {
+        name: string;
+    }[];
+    onBackClick: () => void;
+    onClassChange: (classId: string) => void;
+    onCopyLinkClick: () => void;
+    onExportDataClick: () => void;
+};
+/**
+ * Lesson
+ * @param props
+ * @constructor
+ */
+declare const Lesson: (props: LessonProps) => JSX.Element;
+
+/**
+ * Item
+ */
+interface Item$1 {
+    lessonId: string;
+    name: string;
+    description: string;
+    href: string;
+}
+
+/**
+ * LessonItem
+ */
+type LessonItem = Item$1;
+/**
+ * LessonsProps
+ */
+type LessonsProps = {
+    loading: boolean;
+    lessons: LessonItem[];
+    onAutocompleteChange: (next: string) => void;
+};
+/**
+ * Lessons
+ * @param props
+ * @constructor
+ */
+declare const Lessons: (props: LessonsProps) => JSX.Element;
+
+/**
+ * OrganizationProps
+ */
+type OrganizationProps = {
+    loading: boolean;
+    displayName: string;
+    description: string;
+    numberOfStudents: number;
+    numberOfEducators: number;
+    percentageOfAccountsActive: number;
+    accessCode: string;
+    peopleLink: string;
+    onBackClick: () => void;
+    onCopyAccessCode: () => void;
+};
+/**
+ * Organization
+ * @param props
+ * @constructor
+ */
+declare const Organization: (props: OrganizationProps) => JSX.Element;
+
+/**
+ * Item
+ */
+type Item = {
+    userId: string;
+    avatar: string;
+    email: string;
+    givenName: string;
+    familyName: string;
+    lastActivity: Date | null;
+    readonly: boolean;
+    hasAccount: boolean;
+    isAdmin: boolean;
+    isGroupAdmin: boolean;
+    numberOfClasses: number;
+    href: string;
+};
+
+/**
+ * UserItem
+ */
+type UserItem = Item;
+/**
+ * PeopleProps
+ */
+type PeopleProps = {
+    loading: boolean;
+    users: UserItem[];
+    percentageOfAccountsCreated: number;
+    percentageRostered: number;
+    withOrganizationLink?: boolean;
+    onBackClick: () => void;
+    onCreateUsers: (users: UserItem[]) => void;
+    onDeleteUser: (user: UserItem) => void;
+    onChangeUserRole: (user: UserItem, role: string | null) => void;
+    onCopyLinkClick: () => void;
+    onAutocompleteChange: (next: string) => void;
+};
+/**
+ * Class
+ * @param props
+ * @constructor
+ */
+declare const People: (props: PeopleProps) => JSX.Element;
+
+/**
+ * StartAnonymousLessonProps
+ */
+type StartAnonymousLessonProps = {
+    title: string;
+    description: string;
+    educatorName: string;
+    studentName?: string;
+    onStart: (name: string) => void;
+};
+/**
+ * StartAnonymousLesson
+ * @param props
+ * @constructor
+ */
+declare const StartAnonymousLesson: (props: StartAnonymousLessonProps) => JSX.Element;
+
+/**
+ * BadgeGridProps
+ */
+type BadgeGridProps = {
+    badges: TaskCardProps[];
+    onAssign: (taskId: string) => void;
+};
+type TaskCardProps = {
+    taskId: string;
+    title: string;
+    description: string;
+    href: string;
+    onAssign: (taskId: string) => void;
+};
+
+/**
+ * TrialHomeProps
+ */
+type TrialHomeProps = BadgeGridProps & {
+    loading: boolean;
+    name: string;
+    firstName: string;
+    daysRemaining: number;
+    upgradeHref: string;
+};
+/**
+ * TrialHome
+ * @param props
+ * @constructor
+ */
+declare const TrialHome: (props: TrialHomeProps) => JSX.Element;
+
+/**
+ * TrialRegistrationProps
+ */
+type TrialRegistrationProps = {
+    organizations: {
+        organizationId: string;
+        displayName: string;
+    }[];
+    onBegin: (data: NewTrialRegistration) => void;
+    onQueryOrganizations: (name: string) => void;
+};
+type NewTrialRegistration = {
+    firstName: string;
+    lastName: string;
+    organizationId: string;
+    organizationName: string;
+    interests: string[];
+};
+/**
+ * TrialRegistration
+ * @param props
+ * @constructor
+ */
+declare const TrialRegistration: (props: TrialRegistrationProps) => JSX.Element;
+
+/**
+ * AdminProviderProps
+ */
+interface AdminProviderProps {
+    notificationLimit?: number;
+    children: React.ReactNode;
+}
+/**
+ * AdminProvider
+ * @constructor
+ * @param props
+ */
+declare const AdminProvider: (props: AdminProviderProps) => JSX.Element;
+
+/**
+ * AppProps
+ */
+type AppProps = {
+    loading?: boolean;
+    account?: string;
+    accounts?: AccountItem[];
+    navbar?: React.ReactElement<NavbarProps>;
+    page: React.ReactNode;
+    onAccountChange?: (account: string) => Promise<void>;
+};
+/**
+ * App
+ * @param props
+ * @constructor
+ */
+declare const App: (props: AppProps) => JSX.Element;
+
+export { AccountItem, AdminProvider, AdminProviderProps, App, AppProps, Badge, BadgeClass, BadgeItem, BadgeProps, BadgeUserItem, Badges, BadgesProps, Class, ClassItem, ClassProps, Classes, ClassesProps, Dashboard, DashboardClass, DashboardProps, GettingStarted, GettingStartedProps, Home, HomeProps, Lesson, LessonClass, LessonItem, LessonProps, LessonUserItem, Lessons, LessonsProps, MemberItem, Navbar, NavbarProps, NewTrialRegistration, Organization, OrganizationProps, People, PeopleProps, StartAnonymousLesson, StartAnonymousLessonProps, Student, StudentProps, SwitchAccount, SwitchAccountProps, TrialHome, TrialHomeProps, TrialRegistration, TrialRegistrationProps, UserItem };