cinnecta-logs/dist/hooks/useTracks/useTracks.d.ts

Biblioteca para centralizar a configuração e eventos personalizados do Highlight.run, compatível com React e Next.js.

import { TrackFilterUsage, TrackOnDownload, TrackUserModules } from './useTracks.types.js';

/**
 * Rastreia a utilização de um filtro na aplicação.
 *
 * @param {string} filterName - O nome do filtro utilizado.
 * @param {string} filterValue - O valor aplicado no filtro.
 * @param {string} pathname - O nome da rota que o filtro foi usado.
 *
 * @example
 * trackFilterUsage('Segmentos', 'Solteiro(a)', 'Visão geral');
 */
declare const trackFilterUsage: ({ filterName, filterValue, pathname, }: TrackFilterUsage) => void;
/**
 * Rastreia um evento de download na aplicação.
 *
 * @param {string} pathname - O nome da rota do download realizado.
 * @param {DownloadBody} downloadBody - O conteúdo associado ao download, pode ser uma string, número ou booleano.
 *
 * @example
 * trackOnDownload('Visão geral', '[23, 55 ,66 , 77]');
 *
 */
declare const trackOnDownload: ({ downloadBody, pathname, timeTakenInDownload, segmentFilter, type, }: TrackOnDownload) => void;
/**
 * Rastreia os módulos acessados e contratados por um usuário na aplicação.
 *
 * Esta função envia informações sobre os módulos que o usuário acessou e os módulos contratados para análise.
 *
 * @param {Array<string>} accessedModules - Uma lista com os nomes dos módulos acessados pelo usuário.
 * @param {Array<string>} accessedPages - Uma lista com os nomes das páginas acessadas pelo usuário.
 * @param {Array<string>} contractedModules - Uma lista com os nomes dos módulos contratados pelo usuário.
 * @param {string} clientName - Nome do cliente que o user está vinculado
 * @example
 * trackUserModules({
 *   accessedModules: ['Visão geral', 'Inadimplencia'],
 *   contractedModules: ['Visão geral', 'Inadimplencia', 'Analise de crédito'],
 *   accessedPages: ['Visão geral', 'Inadimplencia', 'Segmentação', 'Configuração'],
 * });
 */
declare const trackUserModules: ({ accessedModules, contractedModules, accessedPages, clientName, }: TrackUserModules) => void;
/**
 * Hook customizado para rastrear eventos de uso no Highlight.
 *
 * Este hook fornece funções para rastrear o uso de filtros e eventos de download.
 * Ele utiliza a biblioteca Highlight para enviar os dados.
 *
 * @returns {Object} Um objeto contendo as funções de rastreamento:
 * - `trackFilterUsage`: Rastreia a utilização de um filtro.
 * - `trackOnDownload`: Rastreia eventos de download.
 */
declare const useTracks: () => {
    trackFilterUsage: ({ filterName, filterValue, pathname, }: TrackFilterUsage) => void;
    trackOnDownload: ({ downloadBody, pathname, timeTakenInDownload, segmentFilter, type, }: TrackOnDownload) => void;
    trackUserModules: ({ accessedModules, contractedModules, accessedPages, clientName, }: TrackUserModules) => void;
};

export { trackFilterUsage, trackOnDownload, trackUserModules, useTracks };