feat: add service support to analytics mechnism

Author: kpanot

docs/analytics/ANALYTICS.md

@@ -8,7 +8,7 @@ The practice of analytics is there for supporting decision-making by providing t
 When you generate your component, you can decide to activate the otter analytics structure.
 
 ### A new file analytic.ts
-The otter component generator will create one file suffixed by `analytics.ts`. 
+The otter component generator will create one file suffixed by `analytics.ts`.
 Inside you will find an interface to define all the events that your component can trigger and a const to inject inside your component.
 
 ```typescript

docs/analytics/TRACK_EVENTS.md

@@ -32,6 +32,7 @@
     "@angular/router": "~18.0.0",
     "@ngrx/store": "~18.0.0",
     "@o3r/core": "workspace:^",
+    "@o3r/logger": "workspace:^",
     "@o3r/schematics": "workspace:^",
     "@schematics/angular": "~18.0.0",
     "jasmine": "^5.0.0",
@@ -80,6 +81,7 @@
     "@o3r/build-helpers": "workspace:^",
     "@o3r/core": "workspace:^",
     "@o3r/eslint-plugin": "workspace:^",
+    "@o3r/logger": "workspace:^",
     "@o3r/test-helpers": "workspace:^",
     "@schematics/angular": "~18.0.0",
     "@stylistic/eslint-plugin-ts": "^2.0.0",

packages/@o3r/analytics/package.json

@@ -1,4 +1,4 @@
-import {<% if (activateDummy) { %>EventInfo, AnalyticsEvent, Attribute, ConstructorAnalyticsEvent, ConstructorAnalyticsEventParameters,<% } %> AnalyticsEvents} from '@o3r/analytics';
+import type {<% if (activateDummy) { %>EventInfo, AnalyticsEvent, Attribute, ConstructorAnalyticsEvent, ConstructorAnalyticsEventParameters,<% } %> AnalyticsEvents} from '@o3r/analytics';
 
 <% if (activateDummy) { %>/**
  * Dummy event to show how we can use analytics event

packages/@o3r/analytics/schematics/analytics-to-component/templates/__name__.analytics.ts.template

@@ -0,0 +1,58 @@
+import type { EventInfo, AnalyticsEvent, Attribute, ConstructorAnalyticsEvent, ConstructorAnalyticsEventParameters, AnalyticsEvents} from '@o3r/analytics';
+
+const dummyEvent = () => {
+  
+}
+
+  /**
+   * Dummy event to show how we can use analytics event
+   */
+  export class DummyEvent implements AnalyticsEvent {
+    /** @inheritdoc */
+    public eventInfo: EventInfo = {
+      eventName: 'DummyEvent'
+    };
+  }
+
+  /**
+   * Interface to define the inputs that RuntimeDummyEvent needs to be created
+   */
+  export interface RuntimeDummyEventConstructorAnalyticsEventParameters extends ConstructorAnalyticsEventParameters {
+    /**
+     * Example of runtime data
+     */
+    runtimeData?: string;
+  }
+
+  /**
+   * Dummy event with runtime data to show how we can use analytics event
+   */
+  export class RuntimeDummyEvent implements AnalyticsEvent {
+    /** @inheritdoc */
+    public eventInfo: EventInfo = {
+      eventName: 'RuntimeDummyEvent'
+    };
+
+    /** @inheritdoc */
+    public attributes: Attribute[]
+
+    constructor(parameters?: RuntimeDummyEventConstructorAnalyticsEventParameters) {
+      this.attributes = parameters?.runtimeData ? [{ key: 'runtimeData', value: parameters.runtimeData }] : [];
+    }
+  }
+
+/**
+ * Interface for the analytics of <%= componentName %>
+ */
+export interface ComponentAnalytics extends AnalyticsEvents {
+    dummyEvent: ConstructorAnalyticsEvent<DummyEvent>;
+    runtimeDummyEvent: ConstructorAnalyticsEvent<RuntimeDummyEvent>;
+}
+
+/**
+ * Definition of the analytics of <%= componentName %>
+ */
+export const analyticsEvents: ComponentAnalytics = {
+    dummyEvent: DummyEvent,
+    runtimeDummyEvent: RuntimeDummyEvent
+};

packages/@o3r/analytics/schematics/analytics-to-component/templates/ttt.ts

@@ -38,19 +38,28 @@ export class EventTrackServiceFixture implements Readonly<Partial<EventTrackServ
   /** @inheritdoc */
   public addEvent: jasmine.Spy = jasmine.createSpy('addEvent');
 
-  /** @inheritdoc */
+  /**
+   * @inheritdoc
+   * @deprecated use {@link AnalyticsEventReporter} instead, will be removed in v12
+   */
   public addUiEvent: jasmine.Spy = jasmine.createSpy('addUiEvent');
 
   /** @inheritdoc */
   public toggleTracking: jasmine.Spy = jasmine.createSpy('toggleTracking');
 
-  /** @inheritdoc */
+  /**
+   * @inheritdoc
+   * @deprecated use {@link AnalyticsEventReporter} instead, will be removed in v12
+   */
   public toggleUiTracking: jasmine.Spy = jasmine.createSpy('toggleUiTracking');
 
   /** @inheritdoc */
   public togglePerfTracking: jasmine.Spy = jasmine.createSpy('togglePerfTracking');
 
-  /** @inheritdoc */
+  /**
+   * @inheritdoc
+   * @deprecated use {@link AnalyticsEventReporter} instead, will be removed in v12
+   */
   public addCustomEvent: jasmine.Spy = jasmine.createSpy('addCustomEvent');
 
 }