Sobre el proyecto
El SDK de JS de tgram-analytics es una biblioteca cliente mínima para enviar eventos de análisis a un servidor tgram-analytics. Se ejecuta en el navegador utilizando únicamente API nativas, no tiene dependencias externas y el archivo compilado pesa menos de dos kilobytes con gzip, lo que lo hace rápido de cargar.
Características principales:
- Cero dependencias y tamaño de paquete reducido.
- Definiciones completas de TypeScript incluidas, no se necesita un paquete @types separado.
- Diseño centrado en la privacidad: sin cookies, sin fingerprinting, respeto opcional por la configuración Do Not Track del navegador, e IDs de sesión almacenados solo en sessionStorage.
- Seguimiento automático de pageview para aplicaciones de página única, con deduplicación de URLs idénticas consecutivas. Funciona con React Router, Vue Router, Next.js, Svelte Kit y cualquier framework que utilice History API.
- Rastreo manual de eventos mediante un método track simple, con soporte para valores escalares y matrices de escalares para propiedades multi_valor.
- Método identify para asociar propiedades persistentes del usuario a todos los eventos posteriores.
- Control de opt-in/opt-out para consentimiento del usuario, con persistencia opcional manejada por la aplicación.
- Agrupación opcional de eventos para reducir solicitudes de red, configurable por tamaño máximo de lote y tiempo de espera máximo.
- Opciones de configuración para URL del servidor, manejo automático de pageview, respeto a DNT, recopilación de contexto, e IDs de sesión personalizados.
- Instalación sencilla mediante npm o una etiqueta script sin compilación.
- API completa: init, track, pageview, identify, opt, flush, reset.
- Manejo claro de errores para formas de evento inválidas y configuración faltante.
- Licencia MIT y abierto a contribuciones.
El uso típico implica importar la exportación predeterminada, inicializarla una vez con la clave API del proyecto y la URL del servidor, y luego llamar a track donde se necesiten registrar eventos personalizados. Los pageview se envían automáticamente a menos que se desactiven.
El SDK también incluye un objeto global TGA cuando se carga mediante una etiqueta script, lo que permite su uso inmediato sin un sistema de módulos.
Las medidas de privacidad aseguran que no se almacenen identificadores persistentes más allá de la pestaña actual, y el servidor aplica una lista blanca de dominios por proyecto para prevenir recopilación no autorizada de datos.
Para desarrolladores, el paquete proporciona scripts de compilación, un conjunto de pruebas, verificación de tipos de TypeScript, herramientas de linting y formateo, y directrices claras de contribución.
En general, el SDK de JS de tgram-analytics ofrece una forma sencilla y de baja sobrecarga para recopilar datos de eventos respetando la privacidad del usuario y la experiencia del desarrollador.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.