@goralys/ui 0.0.0-stage → 0.1.0

package/dist/index.d.ts

@@ -0,0 +1,495 @@
+import React, { ComponentType, ReactNode, ReactElement, RefCallback, RefObject, InputEventHandler, ChangeEventHandler, SVGProps } from 'react';
+import { User, AuditAction, AuthToken, SubjectStatus, Subject, ConfirmOptions, DraftModalResult, SupportTicket, Toast } from '@goralys/core';
+
+type GoralysLink = ComponentType<{
+    href: string;
+    className?: string;
+    children: ReactNode;
+}>;
+type GoralysImage = ComponentType<{
+    src: string;
+    alt: string;
+    width?: number;
+    height?: number;
+    className?: string;
+    loading?: "lazy" | "eager";
+    priority?: boolean;
+}>;
+type GoralysRouter = {
+    push: (href: string) => void;
+    replace: (href: string) => void;
+    back: () => void;
+    refresh: () => void;
+};
+type GoralysSearchParams = {
+    get: (name: string) => string | null;
+    has: (name: string) => boolean;
+    toString: () => string;
+};
+type GoralysUIConfig = {
+    Link: GoralysLink;
+    Image: GoralysImage;
+    useRouter: () => GoralysRouter;
+    useSearchParams: () => GoralysSearchParams;
+    usePathname: () => string;
+};
+
+interface Props$I {
+    config: GoralysUIConfig;
+    children: ReactNode;
+}
+declare function GoralysUIProvider({ config, children }: Props$I): ReactElement;
+declare function useGoralysUI(): GoralysUIConfig;
+
+declare function useMediaQuery(query: string): boolean;
+
+/**
+ * A hook that provides a callback ref to auto-resize a textarea based on its content.
+ * It also handles ref forwarding (both RefObject and RefCallback).
+ *
+ * @param ref The external ref to forward to.
+ * @returns A RefCallback to be passed to the textarea's ref prop.
+ */
+declare function useAutoResize(ref: React.Ref<HTMLTextAreaElement> | undefined): RefCallback<HTMLTextAreaElement>;
+
+declare function useModalClose(modalRef: RefObject<HTMLDivElement | null>, visible: boolean, onClose: () => void): void;
+
+interface Props$H {
+    className?: string;
+    text: string;
+    type: "submit" | "button" | "reset";
+    onClick?: React.MouseEventHandler<HTMLButtonElement>;
+    color?: "sky" | "red" | "green" | "amber";
+    disabled?: boolean;
+}
+declare function Button({ text, type, className, onClick, color, disabled }: Props$H): ReactElement;
+
+interface Props$G {
+    title: string;
+}
+declare function CardTitle({ title }: Props$G): ReactElement;
+
+declare function Card({ children, className }: {
+    children: ReactNode;
+    className?: string;
+}): ReactElement;
+
+interface Props$F {
+    admin: User;
+}
+declare function AdminCard({ admin }: Props$F): ReactElement;
+
+interface Props$E {
+    type: "real" | "virtual";
+    admins: User[] | null;
+    setCurrentAdminsAction: React.Dispatch<React.SetStateAction<User[] | null>>;
+}
+declare function AdminsSearchBar({ type, admins, setCurrentAdminsAction }: Props$E): ReactElement;
+
+interface Props$D {
+    actions: AuditAction[] | null;
+}
+declare function AuditActionCard({ actions }: Props$D): ReactElement;
+
+interface Props$C {
+    publicId: string;
+    token: AuthToken;
+    onUpdate: () => Promise<void>;
+}
+declare function AuthTokenCard({ publicId, token, onUpdate }: Props$C): ReactElement;
+
+interface Props$B {
+    onUpdateAction: () => void;
+    syncKey: string;
+    virtualSyncKey: string;
+}
+declare function CreateAdminElement({ onUpdateAction, syncKey, virtualSyncKey }: Props$B): ReactElement;
+
+interface Props$A {
+    onReplaceAction: (firstName: string, lastName: string) => void;
+    dropDown?: boolean;
+}
+declare function ReplaceTeacherElement({ onReplaceAction, dropDown }: Props$A): ReactElement;
+
+interface Props$z {
+    user: User;
+}
+declare function UserCard({ user }: Props$z): ReactElement;
+
+interface Props$y {
+    type: "real" | "virtual";
+    users: User[] | null;
+    setCurrentUsers: React.Dispatch<React.SetStateAction<User[] | null>>;
+}
+declare function UsersSearchBar({ type, users, setCurrentUsers }: Props$y): ReactElement;
+
+interface Props$x {
+    total: number;
+    submitted: number;
+    approved: number;
+    rejected: number;
+    notSubmitted: number;
+}
+declare function StatusLegend({ total, submitted, approved, rejected, notSubmitted }: Props$x): ReactElement;
+
+interface Props$w {
+    status: SubjectStatus | "empty";
+    size?: number;
+}
+declare function SubjectStudentsDonut({ status, size }: Props$w): ReactElement;
+
+interface Props$v {
+    size?: number;
+    total: number;
+    notSubmitted: number;
+    submitted: number;
+    rejected: number;
+    approved: number;
+}
+declare function SubjectTeachersDonut({ size, total, notSubmitted, submitted, rejected, approved }: Props$v): ReactElement;
+
+interface Props$u {
+    subjects: Subject[] | null;
+}
+declare function UserSubjectsStudentCard({ subjects }: Props$u): ReactElement;
+
+interface Props$t {
+    subjects: Subject[] | null;
+}
+declare function UserSubjectsTeacherCard({ subjects }: Props$t): ReactElement;
+
+declare function CookieBanner(): ReactElement | null;
+
+interface Props$s {
+    label: string | ReactNode;
+    children?: ReactNode;
+    openDefault?: boolean;
+}
+declare function Dropdown({ label, children, openDefault }: Props$s): ReactElement;
+
+declare function GoralysLogoLoader(): ReactElement;
+
+interface Props$r {
+    id?: string;
+    label: string;
+    setValueAction: (v: boolean) => void;
+    defaultValue: boolean;
+    className?: string | null;
+    disabled?: boolean;
+}
+declare function Checkbox({ id, label, setValueAction, defaultValue, className, disabled }: Props$r): ReactElement;
+
+interface Props$q {
+    autocomplete?: string;
+    disabled?: boolean;
+    helper?: string;
+    id: string;
+    label: string;
+    password?: boolean;
+    email?: boolean;
+    required?: boolean;
+    defaultValue?: string;
+    value?: string;
+    onInput?: InputEventHandler<HTMLInputElement>;
+}
+declare function FloatingInput({ id, label, helper, autocomplete, password, email, disabled, required, defaultValue, value, onInput, }: Props$q): ReactElement;
+
+interface Props$p {
+    text: string;
+    maxSizeKB: number;
+    onFileSelected: CallableFunction;
+}
+declare function InputTextFile({ text, maxSizeKB, onFileSelected }: Props$p): ReactElement;
+
+interface Props$o {
+    text: string;
+    onFileSelected: CallableFunction;
+}
+declare function InputZipFile({ text, onFileSelected }: Props$o): ReactElement;
+
+interface Props$n {
+    helper?: string;
+    id: string;
+    label: string;
+    onChangeAction?: ChangeEventHandler<HTMLTextAreaElement>;
+    setIsInterdisciplinaryAction?: (v: boolean) => void;
+    subjectData: Subject;
+}
+declare function SubjectInputAdmin({ id, label, helper, subjectData, onChangeAction }: Props$n): ReactElement;
+
+interface Props$m {
+    helper?: string;
+    id: string;
+    label: string;
+    onChangeAction?: ChangeEventHandler<HTMLTextAreaElement>;
+    setIsInterdisciplinaryAction?: (v: boolean) => void;
+    subjectData: Subject;
+}
+declare function SubjectInputStudent({ id, label, helper, subjectData, setIsInterdisciplinaryAction, onChangeAction, }: Props$m): ReactElement;
+
+interface Props$l {
+    helper?: string;
+    id: string;
+    label: string;
+    onChangeAction?: ChangeEventHandler<HTMLTextAreaElement>;
+    setIsInterdisciplinaryAction?: (v: boolean) => void;
+    subjectData: Subject;
+}
+declare function SubjectInputTeacher({ id, label, helper, subjectData, onChangeAction }: Props$l): ReactElement;
+
+interface Props$k {
+    defaultValue?: string;
+    disabled?: boolean;
+    ref?: RefObject<HTMLTextAreaElement | null>;
+    helper?: string;
+    id: string;
+    label: string;
+    maxLength?: number;
+    onChangeAction?: ChangeEventHandler<HTMLTextAreaElement>;
+    subjectData: Subject;
+    animate: boolean;
+}
+declare function SubjectTextArea({ id, label, helper, disabled, ref, defaultValue, maxLength, onChangeAction, subjectData, animate, }: Props$k): ReactElement;
+
+interface Props$j {
+    defaultValue?: string;
+    disabled?: boolean;
+    ref?: RefObject<HTMLTextAreaElement | null>;
+    helper?: string;
+    id: string;
+    label: string;
+    onChangeAction?: ChangeEventHandler<HTMLTextAreaElement>;
+    required?: boolean;
+    maxLength?: number;
+}
+declare function TextArea({ id, label, helper, required, disabled, ref, defaultValue, onChangeAction, maxLength, }: Props$j): ReactElement;
+
+declare function Providers({ children }: {
+    children: React.ReactNode;
+}): ReactElement;
+
+interface Props$i {
+    title: string;
+    message: string;
+    visible: boolean;
+    onConfirmAction: () => void;
+    onCancelAction: () => void;
+}
+declare function ConfirmElement({ title, message, visible, onConfirmAction, onCancelAction }: Props$i): ReactElement;
+
+type ConfirmContext = {
+    showConfirm: (options: ConfirmOptions) => Promise<boolean>;
+};
+declare function ConfirmProvider({ children }: {
+    children: ReactNode;
+}): ReactElement;
+declare function useConfirm(): ConfirmContext;
+
+interface Props$h {
+    visible: boolean;
+    onCancelAction: () => void;
+    onChooseDraftAction: (file: File | null) => void;
+    onCloseModalAction: () => void;
+}
+declare function DraftModalElement({ visible, onChooseDraftAction, onCancelAction, onCloseModalAction }: Props$h): ReactElement;
+
+type DraftModalContext = {
+    showDraftModal: () => Promise<DraftModalResult>;
+};
+declare function DraftModalProvider({ children }: {
+    children: ReactNode;
+}): ReactElement;
+declare function useDraftModal(): DraftModalContext;
+
+interface Props$g {
+    visible: boolean;
+    onConfirmAction: (email: string) => void;
+    onCancelAction: () => void;
+    onCloseModalAction: () => void;
+    message: string;
+}
+declare function EmailModalElement({ visible, onConfirmAction, onCancelAction, onCloseModalAction, message }: Props$g): ReactElement;
+
+type EmailModalContext = {
+    showEmailModal: (message?: string) => Promise<string | null>;
+};
+declare function EmailModalProvider({ children }: {
+    children: ReactNode;
+}): ReactElement;
+declare function useEmailModal(): EmailModalContext;
+
+interface Props$f {
+    visible: boolean;
+    onCancelAction: () => void;
+    onImportTopicsAction: (file: File | null) => void;
+    onCloseModalAction: () => void;
+}
+declare function ImportTopicsModalElement({ visible, onImportTopicsAction, onCancelAction, onCloseModalAction }: Props$f): ReactElement;
+
+type ImportTopicsModalContext = {
+    showImportTopicsModal: () => Promise<File | string | null>;
+};
+declare function ImportTopicsModalProvider({ children }: {
+    children: ReactNode;
+}): ReactElement;
+declare function useImportTopicsModal(): ImportTopicsModalContext;
+
+interface Props$e {
+    visible: boolean;
+    onConfirmAction: (password: string) => void;
+    onCancelAction: () => void;
+    onCloseModalAction: () => void;
+    message: string;
+}
+declare function PasswordModalElement({ visible, onConfirmAction, onCancelAction, onCloseModalAction, message }: Props$e): ReactElement;
+
+type PasswordModalContext = {
+    showPasswordModal: (confirm?: string) => Promise<string | null>;
+};
+declare function PasswordModalProvider({ children }: {
+    children: ReactNode;
+}): ReactElement;
+declare function usePasswordModal(): PasswordModalContext;
+
+declare function DynamicNav(): ReactElement;
+
+declare function NavLink({ name, url, exact }: {
+    name: string;
+    url: string;
+    exact?: boolean;
+}): ReactElement;
+
+declare function SideNav(): ReactElement;
+
+declare function UserNav(): ReactElement;
+
+type Props$d = {
+    name: string;
+    url: string;
+    icon: ComponentType<SVGProps<SVGSVGElement>>;
+    exact?: boolean;
+};
+declare function TapBarLink({ name, url, icon: Icon, exact }: Props$d): ReactElement;
+
+declare function TapBarUser(): ReactElement;
+
+declare function TapBar(): ReactElement;
+
+declare function ButtonSkeleton({ className }: {
+    className?: string;
+}): ReactElement;
+
+declare function AdminPanelCardSkeleton(): ReactElement;
+
+declare function AuditActionCardSkeleton(): ReactElement;
+
+declare function UserCardSkeleton(): ReactElement;
+
+declare function UserSubjectsTeacherCardSkeleton(): ReactElement;
+
+declare function UserSubjectsStudentCardSkeleton(): ReactElement;
+
+interface Props$c {
+    showMeta?: boolean;
+}
+declare function SubjectInputSkeleton({ showMeta }: Props$c): ReactElement;
+
+declare function AdminSubjectCardSkeleton(): ReactElement;
+
+declare function CommentSkeleton(): ReactElement;
+
+interface Props$b {
+    showButtons?: boolean;
+}
+declare function StudentCardSkeleton({ showButtons }: Props$b): ReactElement;
+
+interface Props$a {
+    showButtons?: boolean;
+}
+declare function TeacherCardSkeleton({ showButtons }: Props$a): ReactElement;
+
+declare function SupportTicketCardSkeleton(): ReactElement;
+
+interface Props$9 {
+    subjectData: Subject;
+    onUpdateAction: () => void;
+    syncKey: string;
+}
+declare function AdminSubjectsCard({ subjectData, onUpdateAction, syncKey }: Props$9): ReactElement;
+
+interface Props$8 {
+    subjectData: Subject;
+    disabled: boolean;
+    onChange?: ChangeEventHandler<HTMLTextAreaElement>;
+}
+declare function CommentStudent({ subjectData, disabled, onChange }: Props$8): ReactElement;
+
+interface Props$7 {
+    subjectData: Subject;
+    disabled: boolean;
+    ref?: RefObject<HTMLTextAreaElement | null>;
+    onChange?: ChangeEventHandler<HTMLTextAreaElement>;
+}
+declare function CommentTeacher({ subjectData, disabled, ref, onChange }: Props$7): ReactElement;
+
+interface Props$6 {
+    subjectData: Subject;
+}
+declare function ReadonlyCard({ subjectData }: Props$6): ReactElement;
+
+interface Props$5 {
+    subjectData: Subject;
+    onUpdateAction: () => void;
+}
+declare function StudentCard({ subjectData, onUpdateAction }: Props$5): ReactElement;
+
+interface Props$4 {
+    subjects: Subject[];
+    setCurrentSubjects: (s: Subject[]) => void;
+    defaults?: Record<SubjectStatus, boolean>;
+}
+declare function SubjectsFilter({ subjects, setCurrentSubjects, defaults }: Props$4): ReactElement;
+
+interface Props$3 {
+    subjects: Subject[] | null;
+    setCurrentSubjects: React.Dispatch<React.SetStateAction<Subject[] | null>>;
+}
+declare function SubjectsSearchBar({ subjects, setCurrentSubjects }: Props$3): ReactElement;
+
+interface Props$2 {
+    subjectData: Subject;
+    onUpdateAction: () => void;
+}
+declare function TeacherCard({ subjectData, onUpdateAction }: Props$2): ReactElement;
+
+declare function SupportForm(): ReactElement;
+
+interface Props$1 {
+    ticket: SupportTicket;
+}
+declare function SupportTicketCard({ ticket }: Props$1): ReactElement;
+
+declare function FlashToastListener(): null;
+
+interface Props {
+    type: "info" | "warning" | "error" | "success";
+    title: string;
+    message: string;
+    visible: boolean;
+}
+declare function ToastElement({ type, title, message, visible }: Props): ReactElement;
+
+type ToastContext = {
+    showToast: (toast: Toast, animate?: boolean, duration?: number) => void;
+    cacheToast: (toast: Toast, duration?: number) => void;
+};
+declare function ToastProvider({ children }: {
+    children: ReactNode;
+}): ReactElement;
+declare function useToast(): ToastContext;
+
+declare function LoginForm(): ReactElement;
+
+declare function RegisterForm(): ReactElement;
+
+export { AdminCard, AdminPanelCardSkeleton, AdminSubjectCardSkeleton, AdminSubjectsCard, AdminsSearchBar, AuditActionCard, AuditActionCardSkeleton, AuthTokenCard, Button, ButtonSkeleton, Card, CardTitle, Checkbox, CommentSkeleton, CommentStudent, CommentTeacher, type ConfirmContext, ConfirmElement, ConfirmProvider, CookieBanner, CreateAdminElement, type DraftModalContext, DraftModalElement, DraftModalProvider, Dropdown, DynamicNav, type EmailModalContext, EmailModalElement, EmailModalProvider, FlashToastListener, FloatingInput, type GoralysImage, type GoralysLink, GoralysLogoLoader, type GoralysRouter, type GoralysSearchParams, type GoralysUIConfig, GoralysUIProvider, type ImportTopicsModalContext, ImportTopicsModalElement, ImportTopicsModalProvider, InputTextFile, InputZipFile, LoginForm, NavLink, type PasswordModalContext, PasswordModalElement, PasswordModalProvider, Providers, ReadonlyCard, RegisterForm, ReplaceTeacherElement, SideNav, StatusLegend, StudentCard, StudentCardSkeleton, SubjectInputAdmin, SubjectInputSkeleton, SubjectInputStudent, SubjectInputTeacher, SubjectStudentsDonut, SubjectTeachersDonut, SubjectTextArea, SubjectsFilter, SubjectsSearchBar, SupportForm, SupportTicketCard, SupportTicketCardSkeleton, TapBar, TapBarLink, TapBarUser, TeacherCard, TeacherCardSkeleton, TextArea, type ToastContext, ToastElement, ToastProvider, UserCard, UserCardSkeleton, UserNav, UserSubjectsStudentCard, UserSubjectsStudentCardSkeleton, UserSubjectsTeacherCard, UserSubjectsTeacherCardSkeleton, UsersSearchBar, useAutoResize, useConfirm, useDraftModal, useEmailModal, useGoralysUI, useImportTopicsModal, useMediaQuery, useModalClose, usePasswordModal, useToast };