sgtm-analytics-lib v1.0.1

SGTM Analytics Library

Overview

The SGTM Analytics Library (sgtm-analytics-lib) simplifies the creation of structured, type-safe analytics payloads for Google Analytics (GA). It offers methods for generating payloads for various analytics events with TypeScript support, ensuring data integrity throughout the analytics workflow.

Current Features

• TypeScript Integration: Full typing support for data integrity.
• Event Payload Generation: Methods for generating event payloads, such as payment information, shipping details, cart updates, and more.
• Singleton Pattern Support: Import a singleton instance for a global analytics manager throughout your application.
• Modular and Lightweight: Import what you need, keeping the bundle size minimal.

Installation

Use Yarn to install the library:

yarn add sgtm-analytics-lib

Usage

Import the library's singleton instance and utilize its methods to create event payloads:

import analytics from 'sgtm-analytics-lib';

// Log payment information
const paymentPayload = analytics.generatePaymentInfoPayload('USD', 100.0, cartItems, 'SUMMER21', 'Credit Card');

// Log add to cart event
const addToCartPayload = analytics.generateAddToCartPayload('USD', 299.99, cartItems);

Future Plans

• Automated Payload Creation: Integrate a payload creator for automated and error-free payload generation.
• Server Communication: Send payloads directly to a custom tagging server using fetch.
• Advanced Data Structures: Enhance the library to handle more complex data and analytics events.

Contributing

We welcome contributions. Feel free to submit issues or pull requests to our GitHub repository.

License

This library is open-sourced under the MIT license.

Feel free to use the singleton instance for a consistent analytics manager across your application. Keep your configuration files like package.json and tsconfig.json updated to reflect any changes.