analytica-frontend-lib 1.1.92 → 1.1.93

package/dist/index.d.mts

@@ -42,7 +42,7 @@ export { default as NotFound } from './NotFound/index.mjs';
 export { default as VideoPlayer } from './VideoPlayer/index.mjs';
 export { default as Whiteboard } from './Whiteboard/index.mjs';
 export { default as DownloadButton, DownloadButtonProps, DownloadContent } from './DownloadButton/index.mjs';
-export { AuthProvider, ProtectedRoute, PublicRoute, getRootDomain, useAuth, useAuthGuard, useRouteAuth, withAuth } from './Auth/index.mjs';
+export { AuthContextType, AuthProvider, ProtectedRoute, PublicRoute, getRootDomain, useAuth, useAuthGuard, useRouteAuth, withAuth } from './Auth/index.mjs';
 export { CardAccordation } from './Accordation/index.mjs';
 export { AlternativesList } from './Alternative/index.mjs';
 export { createZustandAuthAdapter } from './Auth/zustandAuthAdapter/index.mjs';
@@ -56,8 +56,8 @@ export { MultipleChoiceList } from './MultipleChoice/index.mjs';
 export { default as IconRender } from './IconRender/index.mjs';
 export { DeviceType, getDeviceType, useMobile } from './hooks/useMobile/index.mjs';
 export { useTheme } from './hooks/useTheme/index.mjs';
+import * as zustand_middleware from 'zustand/middleware';
 export { cn, getSubjectColorWithOpacity, syncDropdownState } from './utils/index.mjs';
-import 'zustand/middleware';
 import 'clsx';
 
 /**
@@ -431,4 +431,182 @@ declare const QuizListResultByMateria: ({ subject, onQuestionClick, subjectName,
     subjectName?: string;
 }) => react_jsx_runtime.JSX.Element;
 
-export { CheckboxList, CheckboxListItem, FetchNotificationsParams, Notification, type NotificationActions, NotificationApiClient, NotificationEntityType, NotificationGroup, type NotificationState, type NotificationStore, NotificationType, Question, QuizAlternative, QuizConnectDots, QuizDissertative, QuizHeaderResult, QuizImageQuestion, QuizListResult, QuizListResultByMateria, QuizMultipleChoice, QuizResultHeaderTitle, QuizResultPerformance, QuizResultTitle, QuizTrueOrFalse, createNotificationStore, createNotificationsHook, createUseNotificationStore, createUseNotifications, formatTimeAgo, getStatusBadge };
+/**
+ * Interface representing user authentication tokens.
+ */
+interface AuthTokens {
+    token: string;
+    refreshToken: string;
+    [key: string]: unknown;
+}
+/**
+ * Interface representing a user profile.
+ */
+interface UserProfile {
+    id: string;
+    name?: string;
+    email?: string;
+    [key: string]: unknown;
+}
+/**
+ * Interface representing a user.
+ */
+interface User {
+    id: string;
+    name?: string;
+    email?: string;
+    [key: string]: unknown;
+}
+/**
+ * Interface representing session information from the API.
+ */
+interface SessionInfo {
+    sessionId: string;
+    userId: string;
+    profileId: string;
+    institutionId: string;
+    schoolId: string;
+    schoolYearId: string;
+    classId: string;
+    subjects: string[];
+    schools: string[];
+    [key: string]: unknown;
+}
+/**
+ * Interface defining the authentication state.
+ */
+interface AuthState {
+    user: User | null;
+    tokens: AuthTokens | null;
+    isAuthenticated: boolean;
+    profiles: UserProfile[];
+    selectedProfile: UserProfile | null;
+    sessionInfo: SessionInfo | null;
+    setUser: (user: User | null) => void;
+    setTokens: (tokens: AuthTokens | null) => void;
+    setProfiles: (profiles: UserProfile[]) => void;
+    setSelectedProfile: (profile: UserProfile | null) => void;
+    setSessionInfo: (sessionInfo: SessionInfo | null) => void;
+    signIn: (user: User, tokens: AuthTokens, profiles: UserProfile[]) => void;
+    signOut: () => void;
+    updateUserSession: (sessionData: Partial<User>) => void;
+}
+/**
+ * Zustand store for managing authentication state with persistence.
+ */
+declare const useAuthStore: zustand.UseBoundStore<Omit<zustand.StoreApi<AuthState>, "persist"> & {
+    persist: {
+        setOptions: (options: Partial<zustand_middleware.PersistOptions<AuthState, unknown>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => Promise<void> | void;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: AuthState) => void) => () => void;
+        onFinishHydration: (fn: (state: AuthState) => void) => () => void;
+        getOptions: () => Partial<zustand_middleware.PersistOptions<AuthState, unknown>>;
+    };
+}>;
+
+/**
+ * Hook que gerencia a inicialização da aplicação e funções de autenticação
+ * Combina a lógica de obtenção do institutionId, inicialização do app store e funções de auth
+ *
+ * @param {UseAppInitializationProps} props - Propriedades do hook
+ * @returns {object} Estado da inicialização, funções relacionadas e funções de autenticação
+ */
+declare function useAppInitialization(): {
+    getInstitutionId: string | null;
+    initialize: (id: string | null) => void;
+    initialized: boolean;
+    institutionId: string | null;
+    authFunctions: {
+        checkAuth: () => Promise<boolean>;
+        signOut: () => void;
+        getUser: () => User | null;
+        getSessionInfo: () => SessionInfo | null;
+        getTokens: () => AuthTokens | null;
+    };
+};
+
+/**
+ * Interface para as configurações do hook useAppContent
+ */
+interface UseAppContentConfig {
+    /** API instance para configuração */
+    api: {
+        get: (endpoint: string, config: unknown) => Promise<unknown>;
+    };
+    /** ID da instituição obtido externamente */
+    getInstitutionId: string | null | undefined;
+    /** Função de inicialização obtida externamente */
+    initialize: (institutionId: string) => void;
+    /** Estado de inicialização obtido externamente */
+    initialized: boolean;
+    /** Endpoint para autenticação via URL */
+    endpoint?: string;
+    /** Número máximo de tentativas em caso de erro */
+    maxRetries?: number;
+    /** Delay entre tentativas em ms */
+    retryDelay?: number;
+    /** Callback para limpeza de parâmetros da URL */
+    onClearParamsFromURL?: () => void;
+    /** Callback para tratamento de erro */
+    onError?: (error: unknown) => void;
+    /** Callback para navegação quando página não encontrada */
+    onNotFoundNavigation?: () => void;
+}
+/**
+ * Hook que encapsula toda a lógica do componente AppContent
+ * Centraliza a configuração de autenticação, tema, navegação e inicialização
+ *
+ * @param {UseAppContentConfig} config - Configurações do hook
+ * @returns {object} Funções e estado necessários para o AppContent
+ */
+declare function useAppContent(config: UseAppContentConfig): {
+    handleNotFoundNavigation: () => void;
+    urlAuthConfig: {
+        setTokens: (tokens: AuthTokens | null) => void;
+        setSessionInfo: (sessionInfo: SessionInfo | null) => void;
+        setSelectedProfile: (profile: {
+            id: string;
+        }) => void;
+        api: {
+            get: (endpoint: string, config: unknown) => Promise<unknown>;
+        };
+        endpoint: string;
+        clearParamsFromURL: () => void;
+        maxRetries: number;
+        retryDelay: number;
+        onError: (error: unknown) => void;
+    };
+    institutionIdToUse: string | null | undefined;
+};
+
+declare function useInstitutionId(): string | null;
+
+/**
+ * Interface defining the application state
+ */
+interface AppState {
+    institutionId: string | null;
+    initialized: boolean;
+    setInstitutionId: (institutionId: string | null) => void;
+    setInitialized: (initialized: boolean) => void;
+    initialize: (id: string | null) => void;
+}
+/**
+ * Zustand store for managing application-wide state with persistence
+ * @returns {AppState} The application state store
+ */
+declare const useAppStore: zustand.UseBoundStore<Omit<zustand.StoreApi<AppState>, "persist"> & {
+    persist: {
+        setOptions: (options: Partial<zustand_middleware.PersistOptions<AppState, unknown>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => Promise<void> | void;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: AppState) => void) => () => void;
+        onFinishHydration: (fn: (state: AppState) => void) => () => void;
+        getOptions: () => Partial<zustand_middleware.PersistOptions<AppState, unknown>>;
+    };
+}>;
+
+export { type AuthState, CheckboxList, CheckboxListItem, FetchNotificationsParams, Notification, type NotificationActions, NotificationApiClient, NotificationEntityType, NotificationGroup, type NotificationState, type NotificationStore, NotificationType, Question, QuizAlternative, QuizConnectDots, QuizDissertative, QuizHeaderResult, QuizImageQuestion, QuizListResult, QuizListResultByMateria, QuizMultipleChoice, QuizResultHeaderTitle, QuizResultPerformance, QuizResultTitle, QuizTrueOrFalse, createNotificationStore, createNotificationsHook, createUseNotificationStore, createUseNotifications, formatTimeAgo, getStatusBadge, useAppContent, useAppInitialization, useAppStore, useAuthStore, useInstitutionId };

package/dist/index.d.ts

@@ -42,7 +42,7 @@ export { default as NotFound } from './NotFound/index.js';
 export { default as VideoPlayer } from './VideoPlayer/index.js';
 export { default as Whiteboard } from './Whiteboard/index.js';
 export { default as DownloadButton, DownloadButtonProps, DownloadContent } from './DownloadButton/index.js';
-export { AuthProvider, ProtectedRoute, PublicRoute, getRootDomain, useAuth, useAuthGuard, useRouteAuth, withAuth } from './Auth/index.js';
+export { AuthContextType, AuthProvider, ProtectedRoute, PublicRoute, getRootDomain, useAuth, useAuthGuard, useRouteAuth, withAuth } from './Auth/index.js';
 export { CardAccordation } from './Accordation/index.js';
 export { AlternativesList } from './Alternative/index.js';
 export { createZustandAuthAdapter } from './Auth/zustandAuthAdapter/index.js';
@@ -56,8 +56,8 @@ export { MultipleChoiceList } from './MultipleChoice/index.js';
 export { default as IconRender } from './IconRender/index.js';
 export { DeviceType, getDeviceType, useMobile } from './hooks/useMobile/index.js';
 export { useTheme } from './hooks/useTheme/index.js';
+import * as zustand_middleware from 'zustand/middleware';
 export { cn, getSubjectColorWithOpacity, syncDropdownState } from './utils/index.js';
-import 'zustand/middleware';
 import 'clsx';
 
 /**
@@ -431,4 +431,182 @@ declare const QuizListResultByMateria: ({ subject, onQuestionClick, subjectName,
     subjectName?: string;
 }) => react_jsx_runtime.JSX.Element;
 
-export { CheckboxList, CheckboxListItem, FetchNotificationsParams, Notification, type NotificationActions, NotificationApiClient, NotificationEntityType, NotificationGroup, type NotificationState, type NotificationStore, NotificationType, Question, QuizAlternative, QuizConnectDots, QuizDissertative, QuizHeaderResult, QuizImageQuestion, QuizListResult, QuizListResultByMateria, QuizMultipleChoice, QuizResultHeaderTitle, QuizResultPerformance, QuizResultTitle, QuizTrueOrFalse, createNotificationStore, createNotificationsHook, createUseNotificationStore, createUseNotifications, formatTimeAgo, getStatusBadge };
+/**
+ * Interface representing user authentication tokens.
+ */
+interface AuthTokens {
+    token: string;
+    refreshToken: string;
+    [key: string]: unknown;
+}
+/**
+ * Interface representing a user profile.
+ */
+interface UserProfile {
+    id: string;
+    name?: string;
+    email?: string;
+    [key: string]: unknown;
+}
+/**
+ * Interface representing a user.
+ */
+interface User {
+    id: string;
+    name?: string;
+    email?: string;
+    [key: string]: unknown;
+}
+/**
+ * Interface representing session information from the API.
+ */
+interface SessionInfo {
+    sessionId: string;
+    userId: string;
+    profileId: string;
+    institutionId: string;
+    schoolId: string;
+    schoolYearId: string;
+    classId: string;
+    subjects: string[];
+    schools: string[];
+    [key: string]: unknown;
+}
+/**
+ * Interface defining the authentication state.
+ */
+interface AuthState {
+    user: User | null;
+    tokens: AuthTokens | null;
+    isAuthenticated: boolean;
+    profiles: UserProfile[];
+    selectedProfile: UserProfile | null;
+    sessionInfo: SessionInfo | null;
+    setUser: (user: User | null) => void;
+    setTokens: (tokens: AuthTokens | null) => void;
+    setProfiles: (profiles: UserProfile[]) => void;
+    setSelectedProfile: (profile: UserProfile | null) => void;
+    setSessionInfo: (sessionInfo: SessionInfo | null) => void;
+    signIn: (user: User, tokens: AuthTokens, profiles: UserProfile[]) => void;
+    signOut: () => void;
+    updateUserSession: (sessionData: Partial<User>) => void;
+}
+/**
+ * Zustand store for managing authentication state with persistence.
+ */
+declare const useAuthStore: zustand.UseBoundStore<Omit<zustand.StoreApi<AuthState>, "persist"> & {
+    persist: {
+        setOptions: (options: Partial<zustand_middleware.PersistOptions<AuthState, unknown>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => Promise<void> | void;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: AuthState) => void) => () => void;
+        onFinishHydration: (fn: (state: AuthState) => void) => () => void;
+        getOptions: () => Partial<zustand_middleware.PersistOptions<AuthState, unknown>>;
+    };
+}>;
+
+/**
+ * Hook que gerencia a inicialização da aplicação e funções de autenticação
+ * Combina a lógica de obtenção do institutionId, inicialização do app store e funções de auth
+ *
+ * @param {UseAppInitializationProps} props - Propriedades do hook
+ * @returns {object} Estado da inicialização, funções relacionadas e funções de autenticação
+ */
+declare function useAppInitialization(): {
+    getInstitutionId: string | null;
+    initialize: (id: string | null) => void;
+    initialized: boolean;
+    institutionId: string | null;
+    authFunctions: {
+        checkAuth: () => Promise<boolean>;
+        signOut: () => void;
+        getUser: () => User | null;
+        getSessionInfo: () => SessionInfo | null;
+        getTokens: () => AuthTokens | null;
+    };
+};
+
+/**
+ * Interface para as configurações do hook useAppContent
+ */
+interface UseAppContentConfig {
+    /** API instance para configuração */
+    api: {
+        get: (endpoint: string, config: unknown) => Promise<unknown>;
+    };
+    /** ID da instituição obtido externamente */
+    getInstitutionId: string | null | undefined;
+    /** Função de inicialização obtida externamente */
+    initialize: (institutionId: string) => void;
+    /** Estado de inicialização obtido externamente */
+    initialized: boolean;
+    /** Endpoint para autenticação via URL */
+    endpoint?: string;
+    /** Número máximo de tentativas em caso de erro */
+    maxRetries?: number;
+    /** Delay entre tentativas em ms */
+    retryDelay?: number;
+    /** Callback para limpeza de parâmetros da URL */
+    onClearParamsFromURL?: () => void;
+    /** Callback para tratamento de erro */
+    onError?: (error: unknown) => void;
+    /** Callback para navegação quando página não encontrada */
+    onNotFoundNavigation?: () => void;
+}
+/**
+ * Hook que encapsula toda a lógica do componente AppContent
+ * Centraliza a configuração de autenticação, tema, navegação e inicialização
+ *
+ * @param {UseAppContentConfig} config - Configurações do hook
+ * @returns {object} Funções e estado necessários para o AppContent
+ */
+declare function useAppContent(config: UseAppContentConfig): {
+    handleNotFoundNavigation: () => void;
+    urlAuthConfig: {
+        setTokens: (tokens: AuthTokens | null) => void;
+        setSessionInfo: (sessionInfo: SessionInfo | null) => void;
+        setSelectedProfile: (profile: {
+            id: string;
+        }) => void;
+        api: {
+            get: (endpoint: string, config: unknown) => Promise<unknown>;
+        };
+        endpoint: string;
+        clearParamsFromURL: () => void;
+        maxRetries: number;
+        retryDelay: number;
+        onError: (error: unknown) => void;
+    };
+    institutionIdToUse: string | null | undefined;
+};
+
+declare function useInstitutionId(): string | null;
+
+/**
+ * Interface defining the application state
+ */
+interface AppState {
+    institutionId: string | null;
+    initialized: boolean;
+    setInstitutionId: (institutionId: string | null) => void;
+    setInitialized: (initialized: boolean) => void;
+    initialize: (id: string | null) => void;
+}
+/**
+ * Zustand store for managing application-wide state with persistence
+ * @returns {AppState} The application state store
+ */
+declare const useAppStore: zustand.UseBoundStore<Omit<zustand.StoreApi<AppState>, "persist"> & {
+    persist: {
+        setOptions: (options: Partial<zustand_middleware.PersistOptions<AppState, unknown>>) => void;
+        clearStorage: () => void;
+        rehydrate: () => Promise<void> | void;
+        hasHydrated: () => boolean;
+        onHydrate: (fn: (state: AppState) => void) => () => void;
+        onFinishHydration: (fn: (state: AppState) => void) => () => void;
+        getOptions: () => Partial<zustand_middleware.PersistOptions<AppState, unknown>>;
+    };
+}>;
+
+export { type AuthState, CheckboxList, CheckboxListItem, FetchNotificationsParams, Notification, type NotificationActions, NotificationApiClient, NotificationEntityType, NotificationGroup, type NotificationState, type NotificationStore, NotificationType, Question, QuizAlternative, QuizConnectDots, QuizDissertative, QuizHeaderResult, QuizImageQuestion, QuizListResult, QuizListResultByMateria, QuizMultipleChoice, QuizResultHeaderTitle, QuizResultPerformance, QuizResultTitle, QuizTrueOrFalse, createNotificationStore, createNotificationsHook, createUseNotificationStore, createUseNotifications, formatTimeAgo, getStatusBadge, useAppContent, useAppInitialization, useAppStore, useAuthStore, useInstitutionId };