@24i/bigscreen-sdk 1.0.54-alpha.2836 → 2.1.1-alpha.2133

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

@@ -1,72 +0,0 @@
-import { Payload } from '../../types';
-
-export const MEDIA_PAYLOAD: Payload = {
-    duration: 120,
-    currentTime: 60,
-    title: 'Test Video',
-    url: 'https://example.com/video',
-    contentType: 'video/mp4',
-    percent: 2,
-    provider: 'provider',
-    assetId: '12345',
-    app_id: 'app_id',
-    app_type: 'html5',
-    sceneName: 'pageName',
-    sceneId: 'categories',
-    sceneType: 'vod',
-    sessionId: 1,
-    sessionNumber: 1,
-    userId: '10',
-    userProfileId: 'a1',
-    applicationId: 'app',
-    appVersion: 'v1.0',
-    deviceId: 'ott',
-    deviceType: 'smarttv',
-    searchTerm: '',
-    itemId: '',
-    pubDate: '2012/02/12',
-    message: 'error message',
-    section: 'BROWSE',
-    subcontentType: 'section',
-    seriesTitle: 'section',
-    language: 'en',
-    resolution: '1920x1080',
-};
-
-export const TEALIUM_PAGEINFO_PAYLOAD = {
-    categories: 'categories',
-    content_type: 'video',
-    page_name: 'pageName',
-    page_title: 'pageName',
-    section: 'section',
-    subcontent_type: 'section',
-};
-
-export const TEALIUM_STATIC_CORE_PAYLOAD = {
-    tealium_account: 'test',
-    tealium_profile: 'main',
-    tealium_environment: 'dev',
-    tealium_datasource: 'abc',
-    app_id: 'auto html5 : v1.0-test',
-    app_type: 'html5',
-    entity: 'auto',
-    language: 'english',
-    language_service: 'auto english',
-    ott_type: 'SmartTV',
-    platform_short: 'o',
-    platform_type: 'ott',
-    property_id: '1',
-    short_language_service: 'eng',
-};
-
-export const TEALIUM_MEDIA_PAYLOAD = {
-    article_uid: '12345',
-    byline: 'N/A',
-    canonical_url: 'https://example.com/video',
-    media_type: 'video/mp4',
-    pub_date: '2012/02/12',
-    video_length: 120,
-    video_name: 'Test Video',
-    video_position: 60,
-    video_series_title: 'section',
-};

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

@@ -1,36 +0,0 @@
-import { Payload, TeaMediaResult } from '../types';
-
-export const mapMediaPayload = (
-    payload: Payload,
-): TeaMediaResult => {
-    const {
-        duration,
-        currentTime,
-        title,
-        url,
-        contentType,
-        assetId,
-        pubDate,
-        seriesTitle,
-        sceneName,
-        sceneId,
-    } = payload;
-    return {
-        video_name: title || '',
-        video_length: duration,
-        video_position: currentTime,
-        media_type: contentType,
-        canonical_url: url || '',
-        byline: 'N/A',
-        pub_date: pubDate || '',
-        article_uid: assetId,
-        video_series_title: seriesTitle || '',
-        tags: '',
-        page_title: sceneName || '',
-        page_name: sceneName || '',
-        content_type: 'video',
-        section: seriesTitle || '',
-        categories: sceneId,
-        subcontent_type: seriesTitle || '',
-    };
-};

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

@@ -1,13 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { TeaErrorResult, Payload } from '../types';
-import { AppEvents, TrackEventType } from '../constants';
-
-export const mapAppError = (
-    triggerName: AnalyticsTriggers,
-    payload: Payload,
-): TeaErrorResult => ({
-    app_events: AppEvents.app_error,
-    event_trigger: triggerName,
-    track_event_type: TrackEventType.ACTIVITY,
-    message: payload.message || '',
-});

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

@@ -1,13 +0,0 @@
-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',
-});

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

@@ -1,11 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { TeaCoreResult } from '../types';
-import { AppEvents, TrackEventType } from '../constants';
-
-export const mapFavoriteAdd = (
-    triggerName: AnalyticsTriggers,
-): TeaCoreResult => ({
-    app_events: AppEvents.favorite_add,
-    event_trigger: triggerName,
-    track_event_type: TrackEventType.ACTIVITY,
-});

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

@@ -1,11 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { TeaCoreResult } from '../types';
-import { AppEvents, TrackEventType } from '../constants';
-
-export const mapFavoriteRemove = (
-    triggerName: AnalyticsTriggers,
-): TeaCoreResult => ({
-    app_events: AppEvents.favorite_remove,
-    event_trigger: triggerName,
-    track_event_type: TrackEventType.ACTIVITY,
-});

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

@@ -1,15 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { Payload, TeaVideoResult } from '../types';
-import { AppEvents, TrackEventType } from '../constants';
-import { mapMediaPayload } from './helper';
-
-export const mapPlayerClose = (
-    triggerName: AnalyticsTriggers,
-    payload: Payload,
-): TeaVideoResult => ({
-    app_events: AppEvents.player_close,
-    event_trigger: triggerName,
-    track_event_type: TrackEventType.ACTIVITY,
-    video_event: AppEvents.player_close,
-    ...(mapMediaPayload(payload)),
-});

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

@@ -1,15 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { Payload, TeaVideoResult } from '../types';
-import { AppEvents, TrackEventType } from '../constants';
-import { mapMediaPayload } from './helper';
-
-export const mapPlayerOpen = (
-    triggerName: AnalyticsTriggers,
-    payload: Payload,
-): TeaVideoResult => ({
-    app_events: AppEvents.player_open,
-    event_trigger: triggerName,
-    track_event_type: TrackEventType.ACTIVITY,
-    video_event: AppEvents.player_open,
-    ...(mapMediaPayload(payload)),
-});

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

@@ -1,18 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { Payload, TeaSceneViewResult } from '../types';
-import { TrackEventType } from '../constants';
-
-export const mapSceneView = (
-    _: AnalyticsTriggers,
-    payload: Payload,
-): TeaSceneViewResult => ({
-    app_events: '',
-    event_trigger: AnalyticsTriggers.SCENE_VIEW,
-    track_event_type: TrackEventType.VIEW,
-    page_title: payload.sceneName || '',
-    page_name: payload.sceneName || '',
-    content_type: payload.sceneType || '',
-    section: payload.section || '',
-    categories: payload.sceneId,
-    subcontent_type: payload.subcontentType || '',
-});

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

@@ -1,18 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { Payload, TeaSearchResult } from '../types';
-import { AppEvents, TrackEventType } from '../constants';
-
-export const mapSearch = (
-    triggerName: AnalyticsTriggers,
-    payload: Payload,
-): TeaSearchResult => {
-    const searchEventName = payload.searchSuccess
-        ? AnalyticsTriggers.SEARCH_SUCCESS
-        : AnalyticsTriggers.SEARCH_FAILED;
-    return {
-        app_events: AppEvents[searchEventName],
-        event_trigger: searchEventName,
-        track_event_type: TrackEventType.ACTIVITY,
-        search_keyword: payload.searchTerm,
-    };
-};

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

@@ -1,8 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { Payload, TeaSearchResult } from '../types';
-import { mapSearch } from './mapSearch';
-
-export const mapSearchFailed = (
-    triggerName: AnalyticsTriggers,
-    payload: Payload,
-): TeaSearchResult => (mapSearch(triggerName, payload));

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

@@ -1,8 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { Payload, TeaSearchResult } from '../types';
-import { mapSearch } from './mapSearch';
-
-export const mapSearchSuccess = (
-    triggerName: AnalyticsTriggers,
-    payload: Payload,
-): TeaSearchResult => (mapSearch(triggerName, payload));

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

@@ -1,15 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { Payload, TeaVideoResult } from '../types';
-import { AppEvents, TrackEventType } from '../constants';
-import { mapMediaPayload } from './helper';
-
-export const mapVideoPause = (
-    triggerName: AnalyticsTriggers,
-    payload: Payload,
-): TeaVideoResult => ({
-    app_events: AppEvents.playback_pause,
-    event_trigger: triggerName,
-    track_event_type: TrackEventType.ACTIVITY,
-    video_event: AppEvents.playback_pause,
-    ...(mapMediaPayload(payload)),
-});

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

@@ -1,18 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { Payload, TeaVideoResult } from '../types';
-import { AppEvents, TrackEventType } from '../constants';
-import { mapMediaPayload } from './helper';
-
-export const mapVideoProgress = (
-    triggerName: AnalyticsTriggers,
-    payload: Payload,
-): TeaVideoResult => {
-    const appEvent = (AppEvents as any)[triggerName] ?? '';
-    return {
-        app_events: appEvent,
-        event_trigger: triggerName,
-        track_event_type: TrackEventType.ACTIVITY,
-        video_event: appEvent,
-        ...(mapMediaPayload(payload)),
-    };
-};

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

@@ -1,15 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { Payload, TeaVideoResult } from '../types';
-import { AppEvents, TrackEventType } from '../constants';
-import { mapMediaPayload } from './helper';
-
-export const mapVideoResume = (
-    triggerName: AnalyticsTriggers,
-    payload: Payload,
-): TeaVideoResult => ({
-    app_events: AppEvents.playback_unpause,
-    event_trigger: triggerName,
-    track_event_type: TrackEventType.ACTIVITY,
-    video_event: AppEvents.playback_unpause,
-    ...(mapMediaPayload(payload)),
-});

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

@@ -1,15 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { Payload, TeaVideoResult } from '../types';
-import { AppEvents, TrackEventType } from '../constants';
-import { mapMediaPayload } from './helper';
-
-export const mapVideoStart = (
-    triggerName: AnalyticsTriggers,
-    payload: Payload,
-): TeaVideoResult => ({
-    app_events: AppEvents.playback_start,
-    event_trigger: triggerName,
-    track_event_type: TrackEventType.ACTIVITY,
-    video_event: AppEvents.playback_start,
-    ...(mapMediaPayload(payload)),
-});

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

@@ -1,15 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { Payload, TeaVideoResult } from '../types';
-import { AppEvents, TrackEventType } from '../constants';
-import { mapMediaPayload } from './helper';
-
-export const mapVideoStop = (
-    triggerName: AnalyticsTriggers,
-    payload: Payload,
-): TeaVideoResult => ({
-    app_events: AppEvents.playback_stop,
-    event_trigger: triggerName,
-    track_event_type: TrackEventType.ACTIVITY,
-    video_event: AppEvents.playback_stop,
-    ...(mapMediaPayload(payload)),
-});

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

@@ -1,161 +0,0 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { AppEvents, EVENTS, TrackEventType as TrackEventTypeEnum } from './constants';
-import type {
-    UserInfo, GeneralAppData, AppInfo, VideoProgress, SceneInfo, PlayerSession, ErrorInfo,
-} from '../../interface';
-
-export type TeaEventType = 'view' | 'link';
-type TeaAppType = 'html5' | 'react' | 'native';
-type TeaOttType = 'Samsung' | 'LG' | 'AndroidTV' | 'FireTV' | 'tvOS' | 'Chromecast'
-| 'Roku' | 'Set-top Box' | 'Xiaomi' | 'SmartTV';
-type TeaTrackEventType = `${TrackEventTypeEnum}`;
-type TeaAppEventValues = typeof AppEvents[keyof typeof AppEvents];
-type TeaAnalyticsTriggerValues = `${AnalyticsTriggers}`;
-
-export interface LanguageMapper {
-    [key: string]: string;
-}
-
-export type CustomMappers = Partial<Record<EVENTS, EventMappingFunction>>;
-
-export type TealiumDataMapper = {
-    appType?: TeaAppType,
-    entity: string, // e.g: 'rfe'
-    platformShort?: string,
-    platformType?: string,
-    languageMap: LanguageMapper, // e.g: 'english'
-    propertyIdsMap: LanguageMapper, // e.g: 414
-    shortLanguageServiceMap: LanguageMapper, // e.g: 'eng'
-};
-
-export type TealiumCustomConfiguration = {
-    customMappers?: CustomMappers,
-};
-
-export type TealiumAnalyticsConfiguration = {
-    account: string, // e.g: 'bbg'
-    profile: string, // e.g: 'main'
-    environment: string, // e.g: 'dev'
-    dataMapper?: TealiumDataMapper,
-    datasource?: string, // e.g: '6g2fzf'
-    baseURL?: string, // e.g: 'https://collect.tealiumiq.com/event',
-} & TealiumCustomConfiguration;
-
-export type CorePayload = {
-    app_id: string;
-    app_type: TeaAppType;
-};
-
-export type SessionInfo = {
-    sessionId: number;
-    sessionNumber: number;
-};
-
-export type DeviceInfo = {
-    appVersion: string,
-    manufacturer: string,
-    platform: string,
-    platformVersion: string,
-    deviceId: string,
-};
-
-export type SearchInfo = {
-    searchTerm?: string,
-    searchSuccess?: boolean,
-};
-
-export type SubPageInfo = {
-    section: string,
-    subcontentType?: string,
-    pubDate?: string,
-};
-
-export type Payload = CorePayload &
-GeneralAppData &
-AppInfo &
-SceneInfo &
-SubPageInfo &
-PlayerSession &
-VideoProgress &
-SessionInfo &
-UserInfo &
-SearchInfo &
-ErrorInfo;
-
-export type EventMappingFunction = (
-    triggerName: AnalyticsTriggers,
-    payload: Payload,
-    config?: TealiumAnalyticsConfiguration,
-) => TeaResult;
-
-export type TeaDynamicCoreResult = {
-    language: string;
-    language_service: string;
-    property_id: string;
-    short_language_service: string;
-};
-
-export type TeaStaticCoreResult = {
-    tealium_account: string,
-    tealium_profile: string,
-    tealium_environment?: string,
-    tealium_datasource?: string,
-    instance?: string,
-    app_id: string;
-    app_type: TeaAppType;
-    entity: string;
-    ott_type: TeaOttType;
-    platform_short: string;
-    platform_type: string;
-};
-
-export type TeaCoreResult = {
-    app_events?: TeaAppEventValues | '', // '' for Scene View event
-    event_trigger: TeaAnalyticsTriggerValues,
-    track_event_type: TeaTrackEventType,
-};
-
-export type TeaPageResult = {
-    page_name: string,
-    page_title?: string,
-    content_type: string,
-    section?: string,
-    categories: string,
-    subcontent_type?: string;
-};
-
-export type TeaMediaResult = TeaPageResult & {
-    video_name: string,
-    video_length: number,
-    video_position: number,
-    media_type: string,
-    canonical_url: string,
-    video_series_title: string,
-    byline: string,
-    pub_date: string,
-    article_uid: string,
-    tags: string,
-};
-
-export type TeaSceneViewResult = TeaCoreResult & TeaPageResult;
-
-export type TeaVideoResult = TeaCoreResult & TeaMediaResult & {
-    video_event?: string,
-};
-
-export type TeaErrorResult = TeaCoreResult & {
-    message: string,
-};
-
-export type TeaPlayerOpenResult = TeaCoreResult & {
-    thing_id: string;
-    source_page: string;
-    source_rail?: string | null;
-};
-
-export type TeaSearchResult = TeaCoreResult & {
-    search_keyword?: string;
-};
-
-export type TeaResult = TeaSceneViewResult | TeaVideoResult | TeaErrorResult
-| TeaPlayerOpenResult | TeaSearchResult;

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

@@ -1,107 +0,0 @@
-import { Storage } from '@24i/bigscreen-sdk/storage';
-import { device } from '@24i/bigscreen-sdk/device';
-import { MINUTE_IN_MS } from '@24i/bigscreen-sdk/utils/timeConstants';
-import { createTimeout } from '@24i/bigscreen-sdk/utils/timers';
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import {
-    TRIGGER_NAME_TO_24IQ_EVENTS,
-} from './constants';
-import { EVENTS_MAPPING } from './interface';
-import type { AnalyticsClient, AnyPayload } from '../../interface';
-import { generateSessionId } from '../../utils/generateSessionId';
-import { CorePayload, DeviceInfo, EventBody, Payload, SessionInfo } from './types';
-
-// eslint-disable-next-line no-magic-numbers
-const SESSION_TIMEOUT = 30 * MINUTE_IN_MS;
-
-const TWENTY_FOUR_IQ_SESSION_COUNTER = '24iQ_session_counter';
-
-export class TwentyFourIQClient implements AnalyticsClient {
-    name = '24iQ';
-
-    constantPayload: CorePayload & SessionInfo & DeviceInfo = {
-        sessionNumber: 0,
-        sessionId: 0,
-        appVersion: '',
-        deviceId: '',
-        manufacturer: '',
-        platform: '',
-        deviceModel: '',
-    };
-
-    sessionTimeout = createTimeout();
-
-    isSessionActive = false;
-
-    sessionStartSent = false;
-
-    constructor(private baseURL: string, private appVersion: string = '') {
-        this.init();
-    }
-
-    async init() {
-        this.constantPayload.deviceId = await device.getUuid();
-        this.constantPayload.manufacturer = await device.getManufacturerName();
-        this.constantPayload.platform = await device.getPlatformName();
-        this.constantPayload.deviceModel = await device.getModelName();
-        this.constantPayload.appVersion = this.appVersion;
-        await this.startSession();
-    }
-
-    async startSession() {
-        const sessionNumber = parseInt(
-            await Storage.getItem(TWENTY_FOUR_IQ_SESSION_COUNTER) ?? '0', 10,
-        ) + 1;
-        this.constantPayload.sessionNumber = sessionNumber;
-        this.constantPayload.sessionId = generateSessionId();
-        await Storage.setItem(TWENTY_FOUR_IQ_SESSION_COUNTER, sessionNumber.toString());
-        this.isSessionActive = true;
-        this.setSessionTimeout();
-    }
-
-    setSessionTimeout() {
-        this.sessionTimeout.set(() => {
-            this.isSessionActive = false;
-            this.sessionStartSent = false;
-        }, SESSION_TIMEOUT);
-    }
-
-    async sendEvent(eventBody: EventBody) {
-        try {
-            await fetch(this.baseURL, {
-                method: 'POST',
-                body: JSON.stringify(eventBody),
-                headers: {
-                    Accept: 'application/json',
-                    'Content-Type': 'application/json;charset=UTF-8',
-                },
-            });
-        } catch (error) {
-            console.warn(`[${this.name}] Error sendEvent: `, error);
-        }
-    }
-
-    async onEvent(triggerName: AnalyticsTriggers, payload: AnyPayload): Promise<void> {
-        const events = TRIGGER_NAME_TO_24IQ_EVENTS[triggerName];
-        if (this.isSessionActive) {
-            this.setSessionTimeout();
-        } else {
-            await this.startSession();
-        }
-        if (!events) return;
-        await Promise.all(
-            events.map(async (event) => {
-                const mappingFunction = EVENTS_MAPPING[event];
-                try {
-                    const eventBody = mappingFunction?.(triggerName, {
-                        ...this.constantPayload,
-                        ...payload,
-                    } as unknown as Payload);
-                    if (eventBody) await this.sendEvent(eventBody);
-                } catch (e) {
-                    console.warn(`[${this.name}] Error onEvent: `, e);
-                }
-            }),
-        );
-    }
-}