@o3r/analytics 10.0.0-next.8 → 11.0.0-next.0

package/fesm2022/o3r-analytics.mjs

@@ -2,10 +2,10 @@ import * as i0 from '@angular/core';
 import { InjectionToken, Injectable, Optional, Inject, Directive, Input, NgModule } from '@angular/core';
 import * as i1 from '@angular/router';
 import { NavigationEnd } from '@angular/router';
-import { BehaviorSubject, ReplaySubject, combineLatest, fromEvent } from 'rxjs';
+import { BehaviorSubject, ReplaySubject, fromEvent, combineLatest } from 'rxjs';
 import { filter, withLatestFrom, take, takeWhile, delay, skip, skipWhile } from 'rxjs/operators';
 import * as i1$1 from '@ngrx/store';
-import { createAction, props, on, createReducer, StoreModule, createFeatureSelector, createSelector } from '@ngrx/store';
+import { props, createAction, on, createReducer, StoreModule, createFeatureSelector, createSelector } from '@ngrx/store';
 
 /* eslint-disable @typescript-eslint/naming-convention */
 
@@ -106,7 +106,6 @@ class EventTrackService {
     }
     /**
      * Populate performance payload with FP object
-     *
      * @param FP
      */
     addFPToPerfPayload(FP) {
@@ -137,7 +136,6 @@ class EventTrackService {
     /**
      * Mark the first paint value
      * Store the first paint timing value to be emitted at Navigation End
-     *
      * @param emit If true, sets the FP to the current page. Otherwise, wait for next NavigationEnd event to happen
      */
     async markFP(emit = false) {
@@ -149,7 +147,6 @@ class EventTrackService {
     }
     /**
      * Mark the first meaningful paint value.
-     *
      * @param markOnlyFirstLoad If false, marks the FMP for subsequent loads else only for the first load of the application
      */
     async markFMP(markOnlyFirstLoad = true) {
@@ -182,7 +179,6 @@ class EventTrackService {
     }
     /**
      * Add a custom event and its measurements
-     *
      * @param label The event name
      */
     async addCustomMark(label) {
@@ -193,7 +189,6 @@ class EventTrackService {
     }
     /**
      * Add a server call object in the list of server calls metrics
-     *
      * @param serverCall The object to add in the server calls metrics
      */
     addServerCallMark(serverCall) {
@@ -203,7 +198,6 @@ class EventTrackService {
     /**
      * Add a DxAPI SDK server call object, created by the SDK Probe plugin, in the list of server calls metrics.
      * In order to have requestId for the DxAPI calls, your server has to expose 'ama-request-id' via Access-Control-Expose-Headers
-     *
      * @param serverMark The mark object
      */
     async addSDKServerCallMark(serverMark) {
@@ -227,7 +221,6 @@ class EventTrackService {
     }
     /**
      * Add a custom event and mark the start time, and returns the element index
-     *
      * @param label Event name
      * @returns the element index if tracking is active. Otherwise, -1
      */
@@ -244,7 +237,6 @@ class EventTrackService {
     /**
      * End the event mark given in parameter;
      * Returns false if the custom event is not found in the list of custom marks; true otherwise
-     *
      * @param eventIndex Index of the custom event to be marked as ended
      */
     endCustomMark(eventIndex) {
@@ -271,8 +263,7 @@ class EventTrackService {
      * and the end of the composite rendering (upper bound measurement - a time mark that occurs after the real composite)
      * For the first load of the application, the start time is considered as the start of navigation to ensure a cumulative measure.
      * It is using the 'NgZone' service to runOutsideAngular to prevent any change detection to occur, nor angular error handling, speeding up the measurement.
-     *
-     * @example markFMP() is called in ngAfterViewInit(), the end time will be computed once the render pipeline stage completed the changes triggered by the javascript
+     * Example {@link markFMP} is called in {@link ngAfterViewInit}, the end time will be computed once the render pipeline stage completed the changes triggered by the javascript
      */
     getTiming() {
         const startTime = this.isFirstLoad ? 0 : Math.round(window.performance.now());
@@ -287,7 +278,6 @@ class EventTrackService {
     }
     /**
      * Add an event to the stream of captured UI events
-     *
      * @param uiEvent emitted event object
      */
     addUiEvent(uiEvent) {
@@ -295,7 +285,6 @@ class EventTrackService {
     }
     /**
      * Add an event to the stream of captured custom events
-     *
      * @param customEvent emitted event object
      */
     addCustomEvent(customEvent) {
@@ -303,7 +292,6 @@ class EventTrackService {
     }
     /**
      * Activate/deactivate the tracking mode for UI events
-     *
      * @param activate activation/deactivation boolean
      */
     toggleUiTracking(activate) {
@@ -311,24 +299,23 @@ class EventTrackService {
     }
     /**
      * Activate/deactivate the tracking mode for performance measurements
-     *
      * @param activate activation/deactivation boolean
      */
     togglePerfTracking(activate) {
         this.perfTrackingActivated.next(activate);
     }
-    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: EventTrackService, deps: [{ token: i1.Router }, { token: i0.NgZone }, { token: EVENT_TRACK_SERVICE_CONFIGURATION, optional: true }], target: i0.ɵɵFactoryTarget.Injectable }); }
-    /** @nocollapse */ static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: EventTrackService, providedIn: 'root' }); }
+    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: EventTrackService, deps: [{ token: i1.Router }, { token: i0.NgZone }, { token: EVENT_TRACK_SERVICE_CONFIGURATION, optional: true }], target: i0.ɵɵFactoryTarget.Injectable }); }
+    /** @nocollapse */ static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: EventTrackService, providedIn: 'root' }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: EventTrackService, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: EventTrackService, decorators: [{
             type: Injectable,
             args: [{ providedIn: 'root' }]
-        }], ctorParameters: function () { return [{ type: i1.Router }, { type: i0.NgZone }, { type: undefined, decorators: [{
+        }], ctorParameters: () => [{ type: i1.Router }, { type: i0.NgZone }, { type: undefined, decorators: [{
                     type: Optional
                 }, {
                     type: Inject,
                     args: [EVENT_TRACK_SERVICE_CONFIGURATION]
-                }] }]; } });
+                }] }] });
 
 class BaseTrackEvents {
     constructor(el, trackEventsService, renderer) {
@@ -356,7 +343,6 @@ class BaseTrackEvents {
     }
     /**
      * Create the listener for the given event
-     *
      * @param event name
      */
     nativeListen(event) {
@@ -384,7 +370,6 @@ class BaseTrackEvents {
     }
     /**
      * Keep the events to be listen and create the listener event for the given event name
-     *
      * @param event name
      */
     trackEvent(event) {
@@ -397,23 +382,24 @@ class BaseTrackEvents {
     ngOnDestroy() {
         this.subscription.unsubscribe();
     }
-    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: BaseTrackEvents, deps: [{ token: i0.ElementRef }, { token: EventTrackService }, { token: i0.Renderer2 }], target: i0.ɵɵFactoryTarget.Directive }); }
-    /** @nocollapse */ static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "16.2.0", type: BaseTrackEvents, ngImport: i0 }); }
+    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: BaseTrackEvents, deps: [{ token: i0.ElementRef }, { token: EventTrackService }, { token: i0.Renderer2 }], target: i0.ɵɵFactoryTarget.Directive }); }
+    /** @nocollapse */ static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "17.0.8", type: BaseTrackEvents, ngImport: i0 }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: BaseTrackEvents, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: BaseTrackEvents, decorators: [{
             type: Directive
-        }], ctorParameters: function () { return [{ type: i0.ElementRef }, { type: EventTrackService }, { type: i0.Renderer2 }]; } });
+        }], ctorParameters: () => [{ type: i0.ElementRef }, { type: EventTrackService }, { type: i0.Renderer2 }] });
 
 /**
  * Directive to capture the 'click' event on the reference element.
  * The captured event will be exposed via EventTrackService
- *
- * @example:
+ * @example
+ * ```html
  * <my-component
  *    (click)="doSomething()"
  *    trackClick
  *    [trackEventContext]="{context: 'click on the component with tag: my-component'}">
  * </my-component>
+ * ```
  */
 class TrackClickDirective extends BaseTrackEvents {
     constructor(el, trackEventsService, renderer) {
@@ -424,15 +410,15 @@ class TrackClickDirective extends BaseTrackEvents {
         this.trackEvent('contextmenu');
         this.trackEvent('auxclick');
     }
-    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: TrackClickDirective, deps: [{ token: i0.ElementRef }, { token: EventTrackService }, { token: i0.Renderer2 }], target: i0.ɵɵFactoryTarget.Directive }); }
-    /** @nocollapse */ static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "16.2.0", type: TrackClickDirective, selector: "[trackClick]", inputs: { trackEventContext: "trackEventContext", trackEventContextConstructor: "trackEventContextConstructor", trackEventContextConstructorParameters: "trackEventContextConstructorParameters" }, usesInheritance: true, ngImport: i0 }); }
+    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: TrackClickDirective, deps: [{ token: i0.ElementRef }, { token: EventTrackService }, { token: i0.Renderer2 }], target: i0.ɵɵFactoryTarget.Directive }); }
+    /** @nocollapse */ static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "17.0.8", type: TrackClickDirective, selector: "[trackClick]", inputs: { trackEventContext: "trackEventContext", trackEventContextConstructor: "trackEventContextConstructor", trackEventContextConstructorParameters: "trackEventContextConstructorParameters" }, usesInheritance: true, ngImport: i0 }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: TrackClickDirective, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: TrackClickDirective, decorators: [{
             type: Directive,
             args: [{
                     selector: '[trackClick]'
                 }]
-        }], ctorParameters: function () { return [{ type: i0.ElementRef }, { type: EventTrackService }, { type: i0.Renderer2 }]; }, propDecorators: { trackEventContext: [{
+        }], ctorParameters: () => [{ type: i0.ElementRef }, { type: EventTrackService }, { type: i0.Renderer2 }], propDecorators: { trackEventContext: [{
                 type: Input
             }], trackEventContextConstructor: [{
                 type: Input
@@ -443,13 +429,14 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.0", ngImpor
 /**
  * Directive to capture the events given as input, on the reference element.
  * The captured event will be exposed via EventTrackService
- *
- * @example:
+ * @example
+ * ```html
  * <my-component
  *    (click)="doSomething()"
  *    [trackEvents]="['mouseenter', 'mouseleave']"
  *    [trackEventContext]="{context: 'click on the component with tag: my-component'}">
  * </my-component>
+ * ```
  */
 class TrackEventsDirective extends BaseTrackEvents {
     constructor(el, trackEventsService, renderer) {
@@ -464,15 +451,15 @@ class TrackEventsDirective extends BaseTrackEvents {
             this.trackEventNames.forEach((eventName) => this.trackEvent(eventName));
         }
     }
-    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: TrackEventsDirective, deps: [{ token: i0.ElementRef }, { token: EventTrackService }, { token: i0.Renderer2 }], target: i0.ɵɵFactoryTarget.Directive }); }
-    /** @nocollapse */ static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "16.2.0", type: TrackEventsDirective, selector: "[trackEvents]", inputs: { trackEventContext: "trackEventContext", trackEventContextConstructor: "trackEventContextConstructor", trackEventContextConstructorParameters: "trackEventContextConstructorParameters", trackEventNames: ["trackEvents", "trackEventNames"] }, usesInheritance: true, usesOnChanges: true, ngImport: i0 }); }
+    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: TrackEventsDirective, deps: [{ token: i0.ElementRef }, { token: EventTrackService }, { token: i0.Renderer2 }], target: i0.ɵɵFactoryTarget.Directive }); }
+    /** @nocollapse */ static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "17.0.8", type: TrackEventsDirective, selector: "[trackEvents]", inputs: { trackEventContext: "trackEventContext", trackEventContextConstructor: "trackEventContextConstructor", trackEventContextConstructorParameters: "trackEventContextConstructorParameters", trackEventNames: ["trackEvents", "trackEventNames"] }, usesInheritance: true, usesOnChanges: true, ngImport: i0 }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: TrackEventsDirective, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: TrackEventsDirective, decorators: [{
             type: Directive,
             args: [{
                     selector: '[trackEvents]'
                 }]
-        }], ctorParameters: function () { return [{ type: i0.ElementRef }, { type: EventTrackService }, { type: i0.Renderer2 }]; }, propDecorators: { trackEventContext: [{
+        }], ctorParameters: () => [{ type: i0.ElementRef }, { type: EventTrackService }, { type: i0.Renderer2 }], propDecorators: { trackEventContext: [{
                 type: Input
             }], trackEventContextConstructor: [{
                 type: Input
@@ -486,12 +473,13 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.0", ngImpor
 /**
  * Directive to capture the 'focus' event on the reference element.
  * The captured event will be exposed via EventTrackService
- *
- * @example:
+ * @example
+ * ```html
  * <my-component
  *    trackFocus
  *    [trackEventContext]="{context: 'focus on the component with tag: my-component'}">
  * </my-component>
+ * ```
  */
 class TrackFocusDirective extends BaseTrackEvents {
     constructor(el, trackEventsService, renderer) {
@@ -500,15 +488,15 @@ class TrackFocusDirective extends BaseTrackEvents {
     ngOnInit() {
         this.trackEvent('focus');
     }
-    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: TrackFocusDirective, deps: [{ token: i0.ElementRef }, { token: EventTrackService }, { token: i0.Renderer2 }], target: i0.ɵɵFactoryTarget.Directive }); }
-    /** @nocollapse */ static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "16.2.0", type: TrackFocusDirective, selector: "[trackFocus]", inputs: { trackEventContext: "trackEventContext", trackEventContextConstructor: "trackEventContextConstructor", trackEventContextConstructorParameters: "trackEventContextConstructorParameters" }, usesInheritance: true, ngImport: i0 }); }
+    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: TrackFocusDirective, deps: [{ token: i0.ElementRef }, { token: EventTrackService }, { token: i0.Renderer2 }], target: i0.ɵɵFactoryTarget.Directive }); }
+    /** @nocollapse */ static { this.ɵdir = i0.ɵɵngDeclareDirective({ minVersion: "14.0.0", version: "17.0.8", type: TrackFocusDirective, selector: "[trackFocus]", inputs: { trackEventContext: "trackEventContext", trackEventContextConstructor: "trackEventContextConstructor", trackEventContextConstructorParameters: "trackEventContextConstructorParameters" }, usesInheritance: true, ngImport: i0 }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: TrackFocusDirective, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: TrackFocusDirective, decorators: [{
             type: Directive,
             args: [{
                     selector: '[trackFocus]'
                 }]
-        }], ctorParameters: function () { return [{ type: i0.ElementRef }, { type: EventTrackService }, { type: i0.Renderer2 }]; }, propDecorators: { trackEventContext: [{
+        }], ctorParameters: () => [{ type: i0.ElementRef }, { type: EventTrackService }, { type: i0.Renderer2 }], propDecorators: { trackEventContext: [{
                 type: Input
             }], trackEventContextConstructor: [{
                 type: Input
@@ -517,11 +505,11 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.0", ngImpor
             }] } });
 
 class TrackEventsModule {
-    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: TrackEventsModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
-    /** @nocollapse */ static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "16.2.0", ngImport: i0, type: TrackEventsModule, declarations: [TrackEventsDirective, TrackClickDirective, TrackFocusDirective], exports: [TrackEventsDirective, TrackClickDirective, TrackFocusDirective] }); }
-    /** @nocollapse */ static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: TrackEventsModule }); }
+    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: TrackEventsModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
+    /** @nocollapse */ static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "17.0.8", ngImport: i0, type: TrackEventsModule, declarations: [TrackEventsDirective, TrackClickDirective, TrackFocusDirective], exports: [TrackEventsDirective, TrackClickDirective, TrackFocusDirective] }); }
+    /** @nocollapse */ static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: TrackEventsModule }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: TrackEventsModule, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: TrackEventsModule, decorators: [{
             type: NgModule,
             args: [{
                     declarations: [TrackEventsDirective, TrackClickDirective, TrackFocusDirective],
@@ -569,7 +557,6 @@ const eventTrackInitialState = {
 /**
  * Return all the involved API endpoints present in the component including its child & subchild
  * Iterate recursively till the component with no children
- *
  * @param component
  * @returns string[]
  */
@@ -583,7 +570,6 @@ function getComponentInvolvedEndPoints(component) {
  * Get all the involved API endpoints of the heroComponent with maximum TTI value
  * If the parent contains max TTI, then all its child & subchild end points are used
  * otherwise only component with max TTI end points are used
- *
  * @param component
  * @param maxTTI
  * @returns string[]
@@ -601,7 +587,6 @@ function getInvolvedAPIEndpoints(component, maxTTI) {
  * Recursively iterate the page hierarchy
  * and set the TTI for the specified component
  * and compute the TTI for the corresponding parent
- *
  * @param component the parent component/page
  * @param id the identifier of the component/page
  * @param value the TTI value
@@ -628,7 +613,6 @@ function computeTTI(component, id, value, endpoints = []) {
 }
 /**
  * Check if the TTI for the page is computed
- *
  * @param component the parent component/page
  * @returns boolean
  */
@@ -685,13 +669,13 @@ class EventTrackStoreModule {
             ]
         };
     }
-    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: EventTrackStoreModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
-    /** @nocollapse */ static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "16.2.0", ngImport: i0, type: EventTrackStoreModule, imports: [i1$1.StoreFeatureModule] }); }
-    /** @nocollapse */ static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: EventTrackStoreModule, providers: [
+    /** @nocollapse */ static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: EventTrackStoreModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
+    /** @nocollapse */ static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "17.0.8", ngImport: i0, type: EventTrackStoreModule, imports: [i1$1.StoreFeatureModule] }); }
+    /** @nocollapse */ static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: EventTrackStoreModule, providers: [
             { provide: EVENT_TRACK_REDUCER_TOKEN, useFactory: getDefaultEventTrackReducer }
         ], imports: [StoreModule.forFeature(EVENT_TRACK_STORE_NAME, EVENT_TRACK_REDUCER_TOKEN)] }); }
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "16.2.0", ngImport: i0, type: EventTrackStoreModule, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "17.0.8", ngImport: i0, type: EventTrackStoreModule, decorators: [{
             type: NgModule,
             args: [{
                     imports: [