Sobre o projeto
O SDK JS do tgram-analytics é uma biblioteca cliente mínima para enviar eventos de análise a um servidor tgram-analytics. Executa-se no navegador usando apenas APIs nativas, não possui dependências externas e o arquivo construído tem menos de dois kilobytes quando comprimido com gzip, tornando-o rápido de carregar.
Principais funcionalidades incluem:
- Zero dependências e tamanho de bundle reduzido.
- Definições TypeScript completas incluídas, sem necessidade de pacote @types separado.
- Design focado em privacidade: sem cookies, sem fingerprinting, respeito opcional à configuração Do Not Track do navegador e IDs de sessão armazenados apenas no sessionStorage.
- Rastreamento automático de pageviews para single-page applications, com deduplicação de URLs idênticas consecutivas. Funciona com React Router, Vue Router, Next.js, Svelte Kit e qualquer framework que use a History API.
- Rastreamento manual de eventos por meio de um método track simples, suportando valores escalares e arrays de escalares para propriedades multi valor.
- Método identify para vincular propriedades persistentes do usuário a todos os eventos subsequentes.
- Controle opt-in/opt-out para consentimento do usuário, com persistência opcional tratada pela aplicação.
- Batch opcional de eventos para reduzir requisições de rede, configurável por tamanho máximo de batch e tempo máximo de espera.
- Opções de configuração para URL do servidor, manipulação automática de pageviews, respeito ao DNT, coleta de contexto e IDs de sessão personalizados.
- Instalação simples via npm ou tag script plain para projetos sem build step.
- API completa: init, track, pageview, identify, opt, flush, reset.
- Tratamento de erros claro para shapes de evento inválidos e configuração ausente.
- Licenciado sob MIT e aberto para contribuições.
O uso típico envolve importar a exportação padrão, inicializá-la uma vez com a chave de API do projeto e a URL do servidor, e então chamar track sempre que eventos personalizados precisarem ser registrados. Pageviews são enviados automaticamente, salvo se desabilitados.
O SDK também inclui um objeto global TGA quando carregado via tag script, permitindo uso imediato sem um sistema de módulos.
As medidas de privacidade garantem que nenhum identificador persistente seja armazenado além da aba atual, e o servidor aplica uma allowlist de domínio por projeto para evitar coleta de dados não autorizada.
Para desenvolvedores, o pacote oferece scripts de build, suíte de testes, verificação de tipos TypeScript, ferramentas de linting e formatação, e diretrizes claras de contribuição.
No geral, o SDK JS do tgram-analytics oferece uma maneira direta e de baixa sobrecarga para coletar dados de eventos, respeitando a privacidade do usuário e a ergonomia do desenvolvedor.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.