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

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

/**
 * Send Activity Types
 *
 * Types for the useSendActivity hook that handles
 * sending activities to students with API injection pattern.
 */
import type { CategoryConfig } from '../CheckBoxGroup/index';
import type { SendActivityFormData, SendActivityModalInitialData } from '../SendActivityModal/types';
import type { BaseApiClient } from './api';
/**
 * Recipient item for category selection
 * Extends Item type with index signature for CheckboxGroup compatibility
 */
export interface RecipientItem {
    id: string;
    name: string;
    escolaId?: string;
    serieId?: string;
    turmaId?: string;
    studentId?: string;
    userInstitutionId?: string;
    institutionId?: string;
    [key: string]: unknown;
}
/**
 * Categories data from API for recipient selection
 */
export interface SendActivityCategoriesData {
    schools: RecipientItem[];
    schoolYears: RecipientItem[];
    classes: RecipientItem[];
    students: RecipientItem[];
}
/**
 * Payload for creating an activity
 */
export interface CreateActivityPayload {
    title: string;
    subjectId: string | null;
    questionIds: string[];
    subtype: string;
    type?: 'ATIVIDADE' | 'PROVA';
    isDigital?: boolean;
    notification?: string;
    startDate: string;
    finalDate: string | null;
    canRetry: boolean;
}
/**
 * Student payload for sending activity
 */
export interface StudentPayload {
    studentId: string;
    userInstitutionId: string;
}
/**
 * Model/Draft item for the modal
 */
export interface ActivityModelItem {
    id: string;
    title: string;
    subjectId: string | null;
}
/**
 * Configuration for the useSendActivity hook
 * Pass a BaseApiClient instance and the hook will handle all API calls internally
 */
export interface UseSendActivityConfig {
    /**
     * API client for making HTTP requests
     * The hook will use backend-monolito endpoints internally
     */
    api: BaseApiClient;
    /**
     * Callback when activity is sent successfully
     * @param message - Success message
     */
    onSuccess?: (message: string) => void;
    /**
     * Callback when an error occurs
     * @param message - Error message
     */
    onError?: (message: string) => void;
}
/**
 * Return type for the useSendActivity hook
 */
export interface UseSendActivityReturn {
    /** Whether the modal is open */
    isOpen: boolean;
    /** Open the modal with a selected model */
    openModal: (model: ActivityModelItem) => void;
    /** Close the modal */
    closeModal: () => void;
    /** Currently selected model */
    selectedModel: ActivityModelItem | null;
    /** Initial data for pre-filling the modal */
    initialData: SendActivityModalInitialData | undefined;
    /** Categories for recipient selection */
    categories: CategoryConfig[];
    /** Handler for categories change */
    onCategoriesChange: (categories: CategoryConfig[]) => void;
    /** Whether the submit is loading */
    isLoading: boolean;
    /** Whether categories are being loaded */
    isCategoriesLoading: boolean;
    /** Handle form submission */
    handleSubmit: (data: SendActivityFormData) => Promise<void>;
}
//# sourceMappingURL=sendActivity.d.ts.map