cinnecta-logs/dist/index.d.ts

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

export { useTrackTime } from './hooks/useTrackTime/useTrackTime.js';
export { trackFilterUsage, trackOnDownload, trackUserModules, useTracks } from './hooks/useTracks/useTracks.js';
import './hooks/useTracks/useTracks.types.js';

interface InitializeHighlightParams {
    serviceName: string;
    backendUrl: string;
    environment: string;
    projectKey: string;
}
/**
 * Inicializa o Highlight no frontend com as configurações fornecidas.
 *
 * Esta função configura o Highlight para monitoramento de desempenho, gravação de tela,
 * rastreamento de rede e registro de dados relevantes no ambiente da aplicação.
 *
 * @param {InitializeHighlightParams} params - Objeto contendo as configurações de inicialização.
 * @param {string} params.serviceName - Nome do serviço a ser identificado no Highlight.
 * @param {string} params.backendUrl - URL do backend monitorado.
 * @param {string} params.environment - Ambiente atual (ex.: 'produção', 'staging').
 * @param {string} params.projectKey - Chave do projeto do Highlight.
 *
 * @example
 * initializeHighlight({
 *   serviceName: "Revenue",
 *   backendUrl: "https://api.meuservico.com",
 *   environment: "produção",
 *   projectKey: "MEU_PROJECT_KEY",
 * });
 */
declare const initializeHighlight: ({ backendUrl, environment, projectKey, serviceName, }: InitializeHighlightParams) => void;

export { initializeHighlight };