analytica-frontend-lib/dist/types/recommendedLessons.d.ts

Repositório público dos componentes utilizados nas plataformas da Analytica Ensino

/**
 * Recommended Lessons / Goals (Aulas Recomendadas) Type Definitions
 * Based on /recommended-class/history endpoint
 */
import { GenericApiStatus, GenericDisplayStatus, BadgeActionType } from './common';
/**
 * Goal status from backend API
 * Re-exported from common for backward compatibility
 */
export { GenericApiStatus as GoalApiStatus } from './common';
/**
 * Goal status for display in UI (Badge component)
 * Re-exported from common for backward compatibility
 */
export { GenericDisplayStatus as GoalDisplayStatus } from './common';
/**
 * Badge action types for goal status visualization
 * Re-exported from common for backward compatibility
 */
export { BadgeActionType as GoalBadgeActionType } from './common';
/**
 * Subject info from API response
 */
export interface GoalSubject {
    id: string;
    name: string;
}
/**
 * Creator info from API response
 */
export interface GoalCreator {
    id: string;
    name: string;
}
/**
 * Goal stats from API response
 */
export interface GoalStats {
    totalStudents: number;
    completedCount: number;
    completionPercentage: number;
}
/**
 * Class breakdown info from API response
 */
export interface GoalBreakdown {
    classId: string;
    className: string;
    schoolId: string;
    schoolName: string;
    studentCount: number;
    completedCount: number;
}
/**
 * Goal data from API response
 */
export interface GoalData {
    id: string;
    title: string;
    startDate: string | null;
    finalDate: string | null;
    createdAt: string;
    progress: number;
    totalLessons: number;
}
/**
 * Goal history item from /recommended-class/history endpoint
 */
export interface GoalHistoryItem {
    goal: GoalData;
    subject: GoalSubject | null;
    creator: GoalCreator | null;
    stats: GoalStats;
    breakdown: GoalBreakdown[];
}
/**
 * Goal table item interface for goals list table
 */
export interface GoalTableItem extends Record<string, unknown> {
    id: string;
    startDate: string | null;
    deadline: string | null;
    title: string;
    school: string;
    year: string;
    subject: string;
    class: string;
    status: GenericDisplayStatus;
    completionPercentage: number;
}
/**
 * Goals history API complete response from /recommended-class/history
 */
export interface GoalsHistoryApiResponse {
    message: string;
    data: {
        goals: GoalHistoryItem[];
        total: number;
    };
}
/**
 * Goal history filters for API query parameters
 */
export interface GoalHistoryFilters {
    page?: number;
    limit?: number;
    status?: GenericApiStatus;
    search?: string;
    startDate?: string;
    finalDate?: string;
    subjectId?: string;
    schoolId?: string;
    schoolIds?: string[];
    classId?: string;
    classIds?: string[];
    studentIds?: string[];
    sortBy?: 'createdAt' | 'finalDate' | 'title' | 'completionPercentage';
    sortOrder?: 'asc' | 'desc';
}
/**
 * Pagination info for goals history
 */
export interface GoalHistoryPagination {
    total: number;
    page: number;
    limit: number;
    totalPages: number;
}
/**
 * Filter option for dropdowns
 * Extends with index signature to be compatible with CheckBoxGroup Item type
 */
export interface GoalFilterOption {
    id: string;
    name: string;
    [key: string]: unknown;
}
/**
 * User data for filter options (schools, classes, subjects)
 */
export interface GoalUserFilterData {
    schools?: Array<{
        id: string;
        name: string;
    }>;
    classes?: Array<{
        id: string;
        name: string;
        schoolId?: string;
    }>;
    subjects?: Array<{
        id: string;
        name: string;
    }>;
    schoolYears?: Array<{
        id: string;
        name: string;
    }>;
}
/**
 * Get status badge action based on goal display status
 * @param status - Goal display status
 * @returns Badge action type for styling
 */
export declare const getGoalStatusBadgeAction: (status: GenericDisplayStatus) => BadgeActionType;
/**
 * Goal status options for filter (Vencida and Ativa)
 */
export declare const GOAL_FILTER_STATUS_OPTIONS: GoalFilterOption[];
/**
 * All goal status options
 */
export declare const GOAL_STATUS_OPTIONS: GoalFilterOption[];
/**
 * Student status for display in UI
 */
export declare enum StudentLessonStatus {
    A_INICIAR = "A INICIAR",
    EM_ANDAMENTO = "EM ANDAMENTO",
    NAO_FINALIZADO = "N\u00C3O FINALIZADO",
    CONCLUIDO = "CONCLU\u00CDDO"
}
/**
 * Badge action type for student status
 */
export declare const getStudentStatusBadgeAction: (status: StudentLessonStatus) => "success" | "warning" | "error" | "info";
/**
 * Checks if a deadline has passed
 * @param deadline - ISO date string of the deadline
 * @returns true if deadline has passed, false otherwise
 */
export declare const isDeadlinePassed: (deadline: string | null) => boolean;
/**
 * Derives student display status from progress, completedAt, and deadline
 * @param progress - Student progress percentage (0-100)
 * @param completedAt - ISO date string when student completed, or null
 * @param deadline - ISO date string of the goal deadline, or null
 * @returns The appropriate StudentLessonStatus
 */
export declare const deriveStudentStatus: (progress: number, completedAt: string | null, deadline?: string | null) => StudentLessonStatus;
/**
 * Formats days to complete as a readable string
 */
export declare const formatDaysToComplete: (daysToComplete: number | null) => string | null;
/**
 * Student data from /goals/{id}/details endpoint
 */
export interface GoalDetailStudent {
    userInstitutionId: string;
    userId: string;
    name: string;
    progress: number;
    completedAt: string | null;
    avgScore: number | null;
    daysToComplete: number | null;
}
/**
 * Aggregated stats from /goals/{id}/details endpoint
 */
export interface GoalDetailAggregated {
    completionPercentage: number;
    avgScore: number | null;
}
/**
 * Content performance item from /goals/{id}/details endpoint
 */
export interface GoalDetailContentPerformanceItem {
    contentId: string;
    contentName: string;
    rate: number;
}
/**
 * Content performance from /goals/{id}/details endpoint
 */
export interface GoalDetailContentPerformance {
    best: GoalDetailContentPerformanceItem | null;
    worst: GoalDetailContentPerformanceItem | null;
}
/**
 * Response data from /goals/{id}/details endpoint
 */
export interface GoalDetailsData {
    students: GoalDetailStudent[];
    aggregated: GoalDetailAggregated;
    contentPerformance: GoalDetailContentPerformance;
}
/**
 * Full API response from /goals/{id}/details endpoint
 */
export interface GoalDetailsApiResponse {
    message: string;
    data: GoalDetailsData;
}
/**
 * Subject info from lesson in /goals/{id} response
 */
export interface GoalLessonSubject {
    id: string;
    name: string;
    color: string;
    icon: string;
}
/**
 * Lesson info from /goals/{id} response
 */
export interface GoalLesson {
    id: string;
    content: {
        id: string;
        name: string;
    };
    subtopic: {
        id: string;
        name: string;
    };
    topic: {
        id: string;
        name: string;
    };
    subject: GoalLessonSubject;
}
/**
 * Lesson progress from /goals/{id} response
 */
export interface GoalLessonProgress {
    id: string;
    userId: string;
    lessonId: string;
    progress: number;
    lesson: GoalLesson;
}
/**
 * Lesson goal item from /goals/{id} response
 */
export interface GoalLessonGoalItem {
    goalId: string;
    supLessonsProgressId: string;
    supLessonsProgress: GoalLessonProgress;
}
/**
 * Goal metadata from /goals/{id} endpoint
 */
export interface GoalMetadata {
    id: string;
    title: string;
    startDate: string;
    finalDate: string;
    progress: number;
    lessonsGoals: GoalLessonGoalItem[];
}
/**
 * Full API response from /goals/{id} endpoint
 */
export interface GoalApiResponse {
    message: string;
    data: GoalMetadata;
}
/**
 * Combined data structure for RecommendedLessonDetails component
 * Combines data from /goals/{id}, /goals/{id}/details, and breakdown info
 */
export interface LessonDetailsData {
    /** Goal metadata from /goals/{id} */
    goal: GoalMetadata;
    /** Details from /goals/{id}/details */
    details: GoalDetailsData;
    /** Optional breakdown info from /recommended-class/history */
    breakdown?: GoalBreakdown;
}
//# sourceMappingURL=recommendedLessons.d.ts.map