@24i/bigscreen-sdk 1.0.42-alpha.2709 → 1.0.42

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@24i/bigscreen-sdk",
-    "version": "1.0.42-alpha.2709",
+    "version": "1.0.42",
     "description": "SmartApps BIGscreen SDK monorepo",
     "main": "index.js",
     "scripts": {
@@ -38,7 +38,7 @@
     },
     "homepage": "https://github.com/24i/smartapps-bigscreen-sdk#readme",
     "dependencies": {
-        "@24i/appstage-shared-analytics": "1.0.20-alpha.72",
+        "@24i/appstage-shared-analytics": "1.0.22",
         "@24i/appstage-shared-events-manager": "1.0.11",
         "@24i/appstage-shared-perf-utils": "1.0.11",
         "@24i/bigscreen-players-engine-base": "4.0.10",

package/packages/analytics/src/clients/GoogleAnalytics/GoogleAnalytics.ts

@@ -5,7 +5,7 @@ import { createTimeout } from '@24i/bigscreen-sdk/utils/timers';
 import { MINUTE_IN_MS } from '@24i/bigscreen-sdk/utils/timeConstants';
 import { generateUuid } from '@24i/bigscreen-sdk/utils/generateUuid';
 import { i18n } from '@24i/bigscreen-sdk/i18n';
-import type { AnalyticsClient, AnalyticsEventsMap, SceneInfo } from '../../interface';
+import type { AnalyticsClient, AnalyticsEventsMap, AnyPayload } from '../../interface';
 import { mapEventParamsToUrlParams, mapPayload } from './mapPayload';
 import { prepareBody } from './prepareBody';
 import { getUrl } from './getUrl';
@@ -123,18 +123,10 @@ export class GoogleAnalytics implements AnalyticsClient {
         this.lastOnEvent = now;
         await Promise.all(events.map(async (event, index) => {
             const sessionInfo = await this.getSessionInfo(
-                index === 0 ? engagementTime : undefined,
+                payload!, index === 0 ? engagementTime : undefined,
             );
-            const gtagPayload = mapPayload(
-                event, triggerName, {
-                    ...payload,
-                    ...sessionInfo,
-                },
-            );
-            const urlParams = mapEventParamsToUrlParams({
-                ...sessionInfo as SessionInfo,
-                ...payload as SceneInfo,
-            });
+            const gtagPayload = mapPayload(event, triggerName, { ...payload, ...sessionInfo });
+            const urlParams = mapEventParamsToUrlParams({ ...sessionInfo, ...payload });
             this.send(event, gtagPayload, urlParams);
         }));
     }
@@ -177,7 +169,10 @@ export class GoogleAnalytics implements AnalyticsClient {
 
     private sendQueueWithDelay = debounce(this.sendQueue, SEND_DEBOUNCE_MS);
 
-    private async getSessionInfo(engagementTime: number | undefined): Promise<SessionInfo> {
+    private async getSessionInfo(
+        payload: AnyPayload,
+        engagementTime: number | undefined,
+    ): Promise<SessionInfo> {
         const sessionStarted = !this.sessionStartSent;
         this.sessionStartSent = true;
         const { firstEvent } = this;
@@ -194,6 +189,7 @@ export class GoogleAnalytics implements AnalyticsClient {
             sessionStarted,
             engagementTime,
             firstEvent,
+            isAuthenticated: payload?.userId ? '1' : '0',
             firstVisit: firstVisit as boolean,
         };
     }

package/packages/analytics/src/clients/GoogleAnalytics/interface.ts

@@ -38,6 +38,7 @@ export type SessionInfo = {
     referrer: string,
     engagementTime: number | undefined,
     sessionStarted: boolean,
+    isAuthenticated: '0' | '1',
     firstEvent: boolean,
     firstVisit: boolean,
 };

package/packages/analytics/src/clients/GoogleAnalytics/mapPayload.ts

@@ -8,6 +8,7 @@ const map: Record<string, string> = {
     referrer: 'dr',
     sceneId: 'dl',
     sceneName: 'dt',
+    isAuthenticated: 'up.is_authenticated',
 };
 
 export const mapEventParamsToUrlParams = (eventParams: Record<string, any>)

package/packages/analytics/src/clients/TealiumAnalytics/TealiumAnalytics.ts

@@ -103,7 +103,7 @@ export class TealiumAnalytics implements AnalyticsClient {
             platform_type: platformType ?? BIGSCREEN_PLATFORM_TYPE,
             app_type: appType ?? BIGSCREEN_APP_TYPE,
             ott_type: BIGSCREEN_OTT_TYPE,
-            app_id: `${entity} ${language} : ${this.appVersion}`,
+            app_id: `${entity} ${appType ?? BIGSCREEN_APP_TYPE} : ${this.appVersion}`,
         };
     }
 

package/packages/analytics/src/clients/TealiumAnalytics/constants.ts

@@ -10,6 +10,7 @@ export const BIGSCREEN_PLATFORM_TYPE = 'ott';
 
 export const TEALIUM_TRIGGERS = [
     // App
+    AnalyticsTriggers.APP_OPEN,
     AnalyticsTriggers.APP_CLOSE,
     AnalyticsTriggers.APP_ERROR,
 
@@ -42,6 +43,7 @@ export const TEALIUM_TRIGGERS = [
 ];
 
 export const AppEvents = {
+    [AnalyticsTriggers.APP_OPEN]: '',
     [AnalyticsTriggers.SCENE_VIEW]: '',
     [AnalyticsTriggers.PLAYBACK_10]: 'media_milestone_10_video',
     [AnalyticsTriggers.PLAYBACK_50]: 'media_milestone_50_video',
@@ -50,7 +52,7 @@ export const AppEvents = {
     [AnalyticsTriggers.PLAYBACK_PAUSE]: 'video_pause',
     [AnalyticsTriggers.PLAYBACK_UNPAUSE]: 'video_resume',
     [AnalyticsTriggers.PLAYBACK_START]: 'video_play',
-    [AnalyticsTriggers.PLAYER_OPEN]: 'player_x',
+    [AnalyticsTriggers.PLAYER_OPEN]: 'player_open',
     [AnalyticsTriggers.PLAYER_CLOSE]: 'player_x',
     [AnalyticsTriggers.FAVORITE_ADD]: 'subscribe_to_fav',
     [AnalyticsTriggers.FAVORITE_REMOVE]: 'subscribe_to_fav',
@@ -61,6 +63,7 @@ export const AppEvents = {
 } as const;
 
 export enum EVENTS {
+    APP_OPEN = 'app_open',
     SCENE_VIEW = 'scene_view',
     VIDEO_PROGRESS = 'video_progress',
     VIDEO_START = 'video_start',
@@ -82,6 +85,7 @@ export enum TrackEventType {
 }
 
 export const TRIGGER_NAME_TO_TEALIUM_EVENTS: { [K in AnalyticsTriggers]?: EVENTS[]; } = {
+    [AnalyticsTriggers.APP_OPEN]: [EVENTS.APP_OPEN],
     [AnalyticsTriggers.SCENE_VIEW]: [EVENTS.SCENE_VIEW],
     [AnalyticsTriggers.PLAYBACK_10]: [EVENTS.VIDEO_PROGRESS],
     [AnalyticsTriggers.PLAYBACK_50]: [EVENTS.VIDEO_PROGRESS],

package/packages/analytics/src/clients/TealiumAnalytics/interface.ts

@@ -13,10 +13,12 @@ import { mapFavoriteRemove } from './mappers/mapFavoriteRemove';
 import { mapVideoResume } from './mappers/mapVideoResume';
 import { mapSearchSuccess } from './mappers/mapSearchSuccess';
 import { mapSearchFailed } from './mappers/mapSearchFailed';
-import { EventMappingFunction } from './types';
 import { mapAppError } from './mappers/mapAppError';
+import { mapAppOpen } from './mappers/mapAppOpen';
+import { EventMappingFunction } from './types';
 
 export const EVENTS_MAPPING: Record<EVENTS, EventMappingFunction> = {
+    [EVENTS.APP_OPEN]: mapAppOpen,
     [EVENTS.SCENE_VIEW]: mapSceneView,
     [EVENTS.PLAYER_OPEN]: mapPlayerOpen,
     [EVENTS.PLAYER_CLOSE]: mapPlayerClose,

package/packages/analytics/src/clients/TealiumAnalytics/mappers/__mocks__/mediaPayload.ts

@@ -45,7 +45,7 @@ export const TEALIUM_STATIC_CORE_PAYLOAD = {
     tealium_profile: 'main',
     tealium_environment: 'dev',
     tealium_datasource: 'abc',
-    app_id: 'auto english : v1.0-test',
+    app_id: 'auto html5 : v1.0-test',
     app_type: 'html5',
     entity: 'auto',
     language: 'english',

package/packages/analytics/src/clients/TealiumAnalytics/mappers/mapAppOpen.ts

@@ -0,0 +1,13 @@
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import { TeaSceneViewResult } from '../types';
+import { TrackEventType } from '../constants';
+
+export const mapAppOpen = (): Omit<TeaSceneViewResult, 'categories'> => ({
+    event_trigger: AnalyticsTriggers.SCENE_VIEW,
+    track_event_type: TrackEventType.VIEW,
+    page_title: 'app open',
+    page_name: 'app open',
+    content_type: 'onboarding',
+    section: 'onboarding',
+    subcontent_type: 'welcomeScreen',
+});