@24i/bigscreen-sdk 1.0.52 → 1.0.54-alpha.2817

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@24i/bigscreen-sdk",
-    "version": "1.0.52",
+    "version": "1.0.54-alpha.2817",
     "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.22",
+        "@24i/appstage-shared-analytics": "1.0.24",
         "@24i/appstage-shared-events-manager": "1.0.11",
         "@24i/appstage-shared-perf-utils": "1.0.11",
         "@24i/bigscreen-players-engine-base": "4.1.0",

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

@@ -31,8 +31,12 @@ export const GOOGLE_ANALYTICS_TRIGGERS = [
     AnalyticsTriggers.SEARCH,
     AnalyticsTriggers.RATE_CONTENT,
     // ads triggers
-    AnalyticsTriggers.AD_LOADED,
+    AnalyticsTriggers.AD_BUFFERING,
+    AnalyticsTriggers.AD_COMPLETE,
+    AnalyticsTriggers.AD_ERROR,
     AnalyticsTriggers.AD_SKIPPED,
+    AnalyticsTriggers.AD_START,
+    AnalyticsTriggers.AD_STOP,
     // user triggers
     AnalyticsTriggers.LOGIN,
     AnalyticsTriggers.LOGOUT,
@@ -87,8 +91,12 @@ export const TRIGGER_NAME_TO_GA_EVENTS: Record<
     [AnalyticsTriggers.RATE_CONTENT]: ['rate_content'],
 
     // ads triggers
-    [AnalyticsTriggers.AD_LOADED]: ['ad_loaded'],
+    [AnalyticsTriggers.AD_BUFFERING]: ['ad_buffering'],
+    [AnalyticsTriggers.AD_COMPLETE]: ['ad_complete'],
+    [AnalyticsTriggers.AD_ERROR]: ['ad_error'],
     [AnalyticsTriggers.AD_SKIPPED]: ['ad_skipped'],
+    [AnalyticsTriggers.AD_START]: ['ad_start'],
+    [AnalyticsTriggers.AD_STOP]: ['ad_stop'],
 
     // user triggers
     [AnalyticsTriggers.LOGIN]: ['login'],

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

@@ -17,8 +17,12 @@ export type GAEventsNames = (
     | 'favorite_add' // When a user add asset to favorites
     | 'favorite_remove' // When a user remove asset froms favorites
     | 'user_engagement' // Periodically, while the app is in the foreground
-    | 'ad_loaded' // When advertisement has been loaded
+    | 'ad_buffering' // When advertisement is buffering
+    | 'ad_complete' // When advertisement has been completed
+    | 'ad_error' // When advertisement has an error
     | 'ad_skipped' // When user skipped current advertisement
+    | 'ad_start' // When advertisement has been started
+    | 'ad_stop' // When advertisement has been stopped
     | 'app_exception' // When application throws an error
     | 'rate_content' // When user rates an asset
 );

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

@@ -54,8 +54,12 @@ export const TWENTY_FOUR_IQ_TRIGGERS = [
     AnalyticsTriggers.SCROLL_90,
 
     // Ads
-    AnalyticsTriggers.AD_LOADED,
+    AnalyticsTriggers.AD_BUFFERING,
+    AnalyticsTriggers.AD_COMPLETE,
+    AnalyticsTriggers.AD_ERROR,
     AnalyticsTriggers.AD_SKIPPED,
+    AnalyticsTriggers.AD_START,
+    AnalyticsTriggers.AD_STOP,
 ];
 
 export enum EVENTS {
@@ -69,8 +73,12 @@ export enum EVENTS {
     PLAYER_CLOSE = 'player_close',
     PLAYER_OPEN = 'player_open',
     SCROLL = 'scroll',
-    AD_LOADED = 'ad_loaded',
+    AD_BUFFERING = 'ad_buffering',
+    AD_COMPLETE = 'ad_complete',
+    AD_ERROR = 'ad_error',
     AD_SKIPPED = 'ad_skipped',
+    AD_START = 'ad_start',
+    AD_STOP = 'ad_stop',
 }
 
 export const TRIGGER_NAME_TO_24IQ_EVENTS: { [K in AnalyticsTriggers]?: EVENTS[]; } = {
@@ -92,9 +100,12 @@ export const TRIGGER_NAME_TO_24IQ_EVENTS: { [K in AnalyticsTriggers]?: EVENTS[];
     [AnalyticsTriggers.SCROLL_75]: [EVENTS.SCROLL],
     [AnalyticsTriggers.SCROLL_90]: [EVENTS.SCROLL],
     [AnalyticsTriggers.APP_CLOSE]: [EVENTS.VIDEO_STOP, EVENTS.PLAYER_CLOSE],
-    // VERSION 2 ?
-    [AnalyticsTriggers.AD_LOADED]: [EVENTS.AD_LOADED],
+    [AnalyticsTriggers.AD_BUFFERING]: [EVENTS.AD_BUFFERING],
+    [AnalyticsTriggers.AD_COMPLETE]: [EVENTS.AD_COMPLETE],
+    [AnalyticsTriggers.AD_ERROR]: [EVENTS.AD_ERROR],
     [AnalyticsTriggers.AD_SKIPPED]: [EVENTS.AD_SKIPPED],
+    [AnalyticsTriggers.AD_START]: [EVENTS.AD_START],
+    [AnalyticsTriggers.AD_STOP]: [EVENTS.AD_STOP],
 };
 
 export const HUNDRED_PERCENT = 100;

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

@@ -11,8 +11,7 @@ import { mapPlayerOpen } from './mappers/mapPlayerOpen';
 import { mapPlayerClose } from './mappers/mapPlayerClose';
 import { mapVideoStart } from './mappers/mapVideoStart';
 import { mapVideoPause } from './mappers/mapVideoPause';
-import { mapAdLoaded } from './mappers/mapAdLoaded';
-import { mapAdSkipped } from './mappers/mapAdSkipped';
+import { mapAdEvent } from './mappers/mapAdEvent';
 import { EventMappingFunction } from './types';
 
 export const EVENTS_MAPPING: Record<EVENTS, EventMappingFunction> = {
@@ -26,6 +25,10 @@ export const EVENTS_MAPPING: Record<EVENTS, EventMappingFunction> = {
     [EVENTS.VIDEO_PROGRESS]: mapVideoProgress,
     [EVENTS.VIDEO_COMPLETE]: mapVideoComplete,
     [EVENTS.VIDEO_PAUSE]: mapVideoPause,
-    [EVENTS.AD_LOADED]: mapAdLoaded,
-    [EVENTS.AD_SKIPPED]: mapAdSkipped,
+    [EVENTS.AD_BUFFERING]: mapAdEvent,
+    [EVENTS.AD_COMPLETE]: mapAdEvent,
+    [EVENTS.AD_ERROR]: mapAdEvent,
+    [EVENTS.AD_SKIPPED]: mapAdEvent,
+    [EVENTS.AD_START]: mapAdEvent,
+    [EVENTS.AD_STOP]: mapAdEvent,
 };

package/packages/analytics/src/clients/TwentyFourIQ/mappers/{mapAdSkipped.ts → mapAdEvent.ts}

@@ -1,16 +1,19 @@
 import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { Payload, AdSkippedResult } from '../types';
+import { Payload, AdEventResult } from '../types';
 import { mapBase } from './mapBase';
 
-export const mapAdSkipped = (
+export const mapAdEvent = (
     triggerName: AnalyticsTriggers,
     payload: Payload,
-): AdSkippedResult => ({
+): AdEventResult => ({
     ...mapBase(payload),
     action: triggerName,
     event_trigger: triggerName,
+    ad_id: payload.adId || '',
+    ad_position: payload.adType || '',
+    ad_playback_position: payload.adPosition || '',
+    ad_playback_duration: payload.adDuration || '',
     thing_id: payload.assetId || '',
     attribution_id: payload.attributionId || '',
-    player_advertisment_name: '', // TODO: adPayload?.adName,
-    player_advertisment_position: 0, // TODO:  adPayload?.adPosition,
+    custom_campaign_url: '',
 });

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapPlayerClose.ts

@@ -1,6 +1,6 @@
 import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
 import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { EVENTS, HUNDRED_PERCENT } from '../constants';
+import { DefaultScreens, EVENTS, HUNDRED_PERCENT } from '../constants';
 import { PlayerCloseResult, Payload } from '../types';
 import { mapBase } from './mapBase';
 
@@ -16,6 +16,7 @@ export const mapPlayerClose = (
         ...mapBase(payload),
         action: EVENTS.PLAYER_CLOSE,
         event_trigger: triggerName,
+        source_page: DefaultScreens.PLAYBACK,
         thing_id: payload.assetId || '',
         attribution_id: payload.attributionId || '',
         duration,

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapVideoComplete.ts

@@ -1,6 +1,6 @@
 import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
 import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
-import { EVENTS } from '../constants';
+import { DefaultScreens, EVENTS } from '../constants';
 import { Payload, VideoCompleteResult } from '../types';
 import { mapBase } from './mapBase';
 
@@ -17,5 +17,6 @@ export const mapVideoComplete = (
         attribution_id: payload.attributionId || '',
         progress_pct: 90,
         duration: assetDuration,
+        source_page: DefaultScreens.PLAYBACK,
     };
 };

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapVideoPause.ts

@@ -1,6 +1,6 @@
 import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
 import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
-import { EVENTS, HUNDRED_PERCENT } from '../constants';
+import { DefaultScreens, EVENTS, HUNDRED_PERCENT } from '../constants';
 import { VideoPauseResult, Payload } from '../types';
 import { mapBase } from './mapBase';
 
@@ -20,5 +20,6 @@ export const mapVideoPause = (
         attribution_id: payload.attributionId || '',
         duration: overallDuration,
         progress_pct: progressPercent,
+        source_page: DefaultScreens.PLAYBACK,
     };
 };

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapVideoProgress.ts

@@ -1,7 +1,7 @@
 import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
 import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
 import { Payload, VideoProgressResult } from '../types';
-import { EVENTS, HUNDRED_PERCENT } from '../constants';
+import { DefaultScreens, EVENTS, HUNDRED_PERCENT } from '../constants';
 import { mapBase } from './mapBase';
 
 export const mapVideoProgress = (
@@ -20,5 +20,6 @@ export const mapVideoProgress = (
         attribution_id: payload.attributionId || '',
         progress_pct: progressPercent,
         duration: durationInSeconds,
+        source_page: DefaultScreens.PLAYBACK,
     };
 };

package/packages/analytics/src/clients/TwentyFourIQ/types.ts

@@ -1,6 +1,6 @@
 import { Asset } from '@24i/smartapps-datalayer/models';
 import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import type { AnyPayload, UserInfo, AppInfo } from '../../interface';
+import type { AnyPayload, UserInfo, AppInfo, AdType } from '../../interface';
 
 interface ScreenParams {
     screen: string;
@@ -37,7 +37,20 @@ export interface SceneInfo {
     sceneType?: string,
 }
 
-export type Payload = CorePayload & SceneInfo & SessionInfo & UserInfo & DeviceInfo & AppInfo;
+export interface AdInfo {
+    adId: string;
+    adType: AdType;
+    adDuration: string;
+    adPosition: string;
+}
+
+export type Payload = CorePayload
+& SceneInfo
+& SessionInfo
+& UserInfo
+& DeviceInfo
+& AppInfo
+& AdInfo;
 
 export type EventBody = AnyPayload;
 
@@ -74,13 +87,6 @@ export type BufferingResult = SceneViewResult;
 export type ScrollResult = SceneViewResult & {
     percent_scrolled: string;
 };
-export type VideoProgressResult = CoreResult & {
-    thing_id: string;
-    attribution_id: string;
-    progress_pct: number;
-    duration: number;
-};
-
 export type PlayerOpenResult = CoreResult & {
     thing_id: string;
     attribution_id: string;
@@ -88,36 +94,34 @@ export type PlayerOpenResult = CoreResult & {
     source_rail?: string | null;
 };
 
-export type VideoStartResult = CoreResult & {
+export type VideoBaseResult = CoreResult & {
     thing_id: string;
     attribution_id: string;
     duration: number;
     progress_pct: number;
     source_page: string;
-    source_rail?: string | null;
 };
 
-export type VideoPauseResult = CoreResult & {
-    thing_id: string;
-    attribution_id: string;
-    duration: number;
-    progress_pct: number;
+export type VideoStartResult = VideoBaseResult & {
+    source_rail?: string | null;
 };
 
-export type AdLoadedResult = CoreResult & {
-    thing_id: string;
-    attribution_id: string;
-    player_advertisment_name: string;
-    player_advertisment_position: number;
-};
+export type VideoPauseResult = VideoBaseResult;
+
+export type VideoStopResult = VideoStartResult;
+
+export type VideoProgressResult = VideoBaseResult;
+
+export type VideoCompleteResult = VideoBaseResult;
 
-export type AdSkippedResult = CoreResult & {
+export type PlayerCloseResult = VideoBaseResult;
+
+export type AdEventResult = CoreResult & {
+    ad_id: string;
+    ad_position: AdType;
+    ad_playback_position: string;
+    ad_playback_duration: string;
     thing_id: string;
     attribution_id: string;
-    player_advertisment_name: string;
-    player_advertisment_position: number;
+    custom_campaign_url: string;
 };
-
-export type VideoCompleteResult = VideoPauseResult;
-export type VideoStopResult = VideoStartResult;
-export type PlayerCloseResult = VideoPauseResult;

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapAdLoaded.ts

@@ -1,13 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { Payload, AdLoadedResult } from '../types';
-import { mapBase } from './mapBase';
-
-export const mapAdLoaded = (triggerName: AnalyticsTriggers, payload: Payload): AdLoadedResult => ({
-    ...mapBase(payload),
-    action: triggerName,
-    event_trigger: triggerName,
-    thing_id: payload.assetId || '',
-    attribution_id: payload.attributionId || '',
-    player_advertisment_name: '', // TODO: adPayload?.adName,
-    player_advertisment_position: 0, // TODO: adPayload?.adPosition,
-});