Merge pull request #2 from unix14/lib

created a pub dev lib

Author: unix14

analytix/.gitignore

@@ -0,0 +1,7 @@
+# https://dart.dev/guides/libraries/private-files
+# Created by `dart pub`
+.dart_tool/
+
+# Avoid committing pubspec.lock for library packages; see
+# https://dart.dev/guides/libraries/private-files#pubspeclock.
+pubspec.lock

analytix/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 1.0.0
+
+- Initial version.

analytix/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Eyal Yaakobi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES, OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

analytix/README.md

@@ -0,0 +1,99 @@
+# analytix
+
+A Flutter library for custom analytics management, designed to streamline integration and usage for efficient event tracking and reporting in Dart applications.
+
+## Features
+
+- **Custom Event Tracking**: Easily log and manage events in your application.
+- **Screen View Logging**: Track screen views to gain insights into user navigation.
+- **Robust Reporting**: Access detailed reports on user interactions and events.
+
+## Getting Started
+
+### Installation
+
+To use the Analytix library, add the following dependency to your `pubspec.yaml` file:
+
+```yaml
+dependencies:
+  analytix: ^1.0.0  # Replace with the latest version
+```
+
+### Importing the Library
+Import the library in your Dart files:
+
+```dart
+import 'package:analitix/analitix.dart';
+```
+
+### Basic Usage
+Here’s a quick example of how to integrate Analytix into your Flutter application:
+
+```dart
+import 'package:flutter/material.dart';
+import 'package:analitix/analitix/abstract/analytix_manager.dart';
+
+void main() {
+  runApp(MyApp());
+}
+
+class MyApp extends StatelessWidget {
+  @override
+  Widget build(BuildContext context) {
+    return MaterialApp(
+      home: SimpleEventExampleScreen(),
+    );
+  }
+}
+
+class SimpleEventExampleScreen extends StatefulWidget {
+  @override
+  State<SimpleEventExampleScreen> createState() => _SimpleEventExampleScreenState();
+}
+
+class _SimpleEventExampleScreenState extends State<SimpleEventExampleScreen> {
+  int _counter = 0;
+
+  @override
+  void initState() {
+    super.initState();
+    AnalytixManager().logScreenView("simple_event_example_screen.dart");
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    return Scaffold(
+      appBar: AppBar(
+        title: const Text("Analytix Demo"),
+      ),
+      body: Center(
+        child: Column(
+          mainAxisAlignment: MainAxisAlignment.center,
+          children: <Widget>[
+            Text('Button pressed: $_counter times'),
+            ElevatedButton(
+              onPressed: _incrementCounter,
+              child: const Text('Press Me'),
+            ),
+          ],
+        ),
+      ),
+    );
+  }
+
+  void _incrementCounter() {
+    setState(() {
+      _counter++;
+    });
+    AnalytixManager().logEvent('button_press', 'User pressed the button', params: {'counter': _counter});
+  }
+}
+```
+
+## More
+
+For help getting started with Flutter development, view the online
+[documentation](https://flutter.dev/).
+
+For instructions integrating Flutter modules to your existing applications,
+see the [add-to-app documentation](https://flutter.dev/docs/development/add-to-app).

analytix/analysis_options.yaml

@@ -0,0 +1,30 @@
+# This file configures the static analysis results for your project (errors,
+# warnings, and lints).
+#
+# This enables the 'recommended' set of lints from `package:lints`.
+# This set helps identify many issues that may lead to problems when running
+# or consuming Dart code, and enforces writing Dart using a single, idiomatic
+# style and format.
+#
+# If you want a smaller set of lints you can change this to specify
+# 'package:lints/core.yaml'. These are just the most critical lints
+# (the recommended set includes the core lints).
+# The core lints are also what is used by pub.dev for scoring packages.
+
+include: package:lints/recommended.yaml
+
+# Uncomment the following section to specify additional rules.
+
+# linter:
+#   rules:
+#     - camel_case_types
+
+# analyzer:
+#   exclude:
+#     - path/to/excluded/files/**
+
+# For more information about the core and recommended set of lints, see
+# https://dart.dev/go/core-lints
+
+# For additional information about configuring this file, see
+# https://dart.dev/guides/language/analysis-options

analytix/example/analytix_example.dart

@@ -0,0 +1,37 @@
+import 'package:analytix/analytix.dart';
+import 'package:analytix/src/abstract/analytix_manager.dart';
+
+
+void main() {
+  _initAnalytics();
+  _testAnalytics();
+}
+
+_testAnalytics() {
+  // Log a screen view
+  AnalytixManager().logScreenView("HomeScreen");
+
+  // Log an event
+  AnalytixManager().logEvent("button_click", "login_button", params: {
+    "button_name": "login",
+    "button_color": "blue",
+    "button_size": "large",
+  });
+}
+
+_initAnalytics() {
+  // Init the AnalytixManager
+  AnalytixManager().init();
+
+  // Set the user properties
+  AnalytixManager().setUserId("1234567890");
+  AnalytixManager().setUserProperty("name", "Eyal");
+  AnalytixManager().setUserProperty("last_name", "Yaakobi");
+  AnalytixManager().setUserProperty("email", "[email protected]");
+  AnalytixManager().setUserProperty("website", "https://www.3p-cups.com");
+  AnalytixManager().setUserProperty("isMale", true);
+  AnalytixManager().setUserProperty("isAdmin", false);
+  AnalytixManager().setUserProperty("amountOfConnectedSessions", 3);
+  AnalytixManager().setUserProperty("lastLoginTime", DateTime.now());
+  AnalytixManager().setUserProperty("refreshToken", "FNvof-Qq3llcnu8nvknerk87@#aaAxz-zZq3");
+}

analytix/lib/analytix.dart

@@ -0,0 +1,8 @@
+/// Support for doing something awesome.
+///
+/// More dartdocs go here.
+library;
+
+export 'src/analytix_base.dart';
+
+// TODO: Export any libraries intended for clients of this package.

analytix/lib/src/abstract/analytix_manager.dart

@@ -0,0 +1,113 @@
+
+
+
+import 'package:analytix/src/abstract/base_reporter.dart';
+import 'package:analytix/src/reporters/custom_reporter.dart';
+import 'package:analytix/src/reporters/printer_reporter.dart';
+
+import '../models/analytix_event.dart';
+import '../reporters/excel_reporter.dart';
+
+class AnalytixManager {
+
+  static final AnalytixManager _instance = AnalytixManager._internal();
+
+  bool _isCollectionEnabled = true;
+  String? _screenName;
+  String? _userId;
+  Map<String, dynamic> _userProperties = {};
+  Map<String, dynamic> _deviceProperties = {};
+  final List<AnalytixEvent> _allEvents = [];
+
+  factory AnalytixManager() {
+    return _instance;
+  }
+
+  AnalytixManager._internal();
+
+  List<BaseReporter> reporters = [
+    PrinterReporter(),
+    CustomReporter(),
+    ExcelReporter(),
+  ];
+
+  void init() {
+    print('AnalytixManager init');
+  }
+
+  void logScreenView(String screenName) {
+    print('AnalytixManager setScreenName: $screenName');
+    _screenName = screenName;
+    logEvent('screen_view', screenName);
+  }
+
+  void logEvent(String name, String subEventName, {Map<String, dynamic> params = const {} }) {
+    if(!_isCollectionEnabled) {
+      print('AnalytixManager logEvent: Collection is disabled');
+      return;
+    }
+    print('AnalytixManager logEvent: $name, $params');
+    Map<String, dynamic> newParams = {};
+    newParams.addAll(params);
+
+    for(BaseReporter reporter in reporters) {
+      newParams['screenName'] = _screenName;
+      newParams['userId'] = _userId;
+      newParams['userProperties'] = _userProperties;
+      newParams['deviceProperties'] = _deviceProperties;
+      newParams['eventTime'] = DateTime.now();
+      var newEvent = AnalytixEvent(name, subEventName: subEventName, parameters: newParams);
+      reporter.logEvent(newEvent);
+      _allEvents.add(newEvent);
+    }
+  }
+
+  void addReporters(List<BaseReporter> reporters) {
+    reporters.addAll(reporters);
+  }
+
+  void addReporter(BaseReporter reporter) {
+    reporters.add(reporter);
+  }
+
+  void removeReporters(List<BaseReporter> reporters) {
+    reporters.removeWhere((element) => reporters.contains(element));
+  }
+
+  void removeReporter(BaseReporter reporter) {
+    reporters.remove(reporter);
+  }
+
+  void clearReporters() {
+    reporters.clear();
+  }
+
+  void setDeviceProperties(Map<String, dynamic> properties) {
+    print('AnalytixManager setDeviceProperties: $properties');
+    _userProperties.addAll(properties);
+  }
+
+  void setUserProperty(String name, dynamic value) {
+    print('AnalytixManager setUserProperty: $name, $value');
+    _userProperties[name] = value;
+  }
+
+  void setUserId(String userId) {
+    print('AnalytixManager setUserId: $userId');
+    _userId = userId;
+  }
+
+  void setAnalyticsCollectionEnabled(bool enabled) {
+    print('AnalytixManager setAnalyticsCollectionEnabled: $enabled');
+    _isCollectionEnabled = enabled;
+  }
+
+  void resetAnalyticsData() {
+    print('AnalytixManager resetAnalyticsData');
+    _userId = null;
+    _screenName = null;
+    _userProperties = {};
+    _deviceProperties = {};
+    _allEvents.clear();
+  }
+}

analytix/lib/src/abstract/base_reporter.dart

@@ -0,0 +1,7 @@
+
+import '../models/analytix_event.dart';
+
+abstract class BaseReporter {
+  void init();
+  void logEvent(AnalytixEvent event);
+}

analytix/lib/src/analytix_base.dart

@@ -0,0 +1,6 @@
+// TODO: Put public facing types in this file.
+
+/// Checks if you are awesome. Spoiler: you are.
+class Awesome {
+  bool get isAwesome => true;
+}