@24i/bigscreen-sdk 1.0.40-alpha.2687 → 1.0.40

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

@@ -1,156 +1,156 @@
-import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { AppEvents, EVENTS, TrackEventType as TrackEventTypeEnum } from './constants';
-import type {
-    UserInfo, 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 PropertyIds {
-    [key: string]: number;
-}
-
-export type CustomMappers = Partial<Record<EVENTS, EventMappingFunction>>;
-
-export type TealiumDataMapper = {
-    app_type: TeaAppType, // e.g. 'html5' for bigscreen
-    entity: string, // e.g: 'rfe'
-    property_ids: PropertyIds, // e.g: 414
-    language?: string, // e.g: 'english'
-    platform_short?: string,
-    platform_type?: string,
-    short_language_service?: string, // 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 &
-AppInfo &
-SceneInfo &
-SubPageInfo &
-PlayerSession &
-VideoProgress &
-SessionInfo &
-UserInfo &
-SearchInfo &
-ErrorInfo;
-
-export type EventMappingFunction = (
-    triggerName: AnalyticsTriggers,
-    payload: Payload
-) => TeaResult;
-
-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;
-    language: string;
-    language_service: string;
-    ott_type: TeaOttType;
-    platform_short: string;
-    platform_type: string;
-    property_id: string;
-    short_language_service: 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;
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import { AppEvents, EVENTS, TrackEventType as TrackEventTypeEnum } from './constants';
+import type {
+    UserInfo, 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 PropertyIds {
+    [key: string]: number;
+}
+
+export type CustomMappers = Partial<Record<EVENTS, EventMappingFunction>>;
+
+export type TealiumDataMapper = {
+    app_type: TeaAppType, // e.g. 'html5' for bigscreen
+    entity: string, // e.g: 'rfe'
+    property_ids: PropertyIds, // e.g: 414
+    language?: string, // e.g: 'english'
+    platform_short?: string,
+    platform_type?: string,
+    short_language_service?: string, // 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 &
+AppInfo &
+SceneInfo &
+SubPageInfo &
+PlayerSession &
+VideoProgress &
+SessionInfo &
+UserInfo &
+SearchInfo &
+ErrorInfo;
+
+export type EventMappingFunction = (
+    triggerName: AnalyticsTriggers,
+    payload: Payload
+) => TeaResult;
+
+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;
+    language: string;
+    language_service: string;
+    ott_type: TeaOttType;
+    platform_short: string;
+    platform_type: string;
+    property_id: string;
+    short_language_service: 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,116 +1,116 @@
-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 TWENYFOURIQ_SESSION_COUNTER = '24iQ_session_counter';
-
-export class TwentyFourIQClient implements AnalyticsClient {
-    name = '24iQ';
-
-    deviceInfo = {
-        manufacturer: '',
-        platform: '',
-        platformVersion: '',
-        deviceId: '',
-        appVersion: '',
-        applicationId: '',
-        deviceType: '',
-    };
-
-    constantPayload: CorePayload & SessionInfo & DeviceInfo = {
-        sessionNumber: 0,
-        sessionId: 0,
-        ...this.deviceInfo,
-    };
-
-    sessionTimeout = createTimeout();
-
-    isSessionActive = false;
-
-    sessionStartSent = false;
-
-    constructor(private baseURL: string, private appVersion: string = '') {
-        this.init();
-    }
-
-    async init() {
-        this.deviceInfo.manufacturer = await device.getManufacturerName();
-        this.deviceInfo.platform = await device.getPlatformName();
-        this.deviceInfo.platformVersion = await device.getPlatformVersion();
-        this.deviceInfo.deviceId = await device.getUuid();
-        await this.startSession();
-    }
-
-    async startSession() {
-        const sessionNumber = parseInt(
-            await Storage.getItem(TWENYFOURIQ_SESSION_COUNTER) ?? '0', 10,
-        ) + 1;
-        this.constantPayload.sessionNumber = sessionNumber;
-        this.constantPayload.sessionId = generateSessionId();
-        this.constantPayload.manufacturer = this.deviceInfo.manufacturer;
-        this.constantPayload.platform = this.deviceInfo.platform;
-        this.constantPayload.platformVersion = this.deviceInfo.platformVersion;
-        this.constantPayload.appVersion = this.appVersion;
-        await Storage.setItem(TWENYFOURIQ_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);
-                }
-            }),
-        );
-    }
-}
+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 TWENYFOURIQ_SESSION_COUNTER = '24iQ_session_counter';
+
+export class TwentyFourIQClient implements AnalyticsClient {
+    name = '24iQ';
+
+    deviceInfo = {
+        manufacturer: '',
+        platform: '',
+        platformVersion: '',
+        deviceId: '',
+        appVersion: '',
+        applicationId: '',
+        deviceType: '',
+    };
+
+    constantPayload: CorePayload & SessionInfo & DeviceInfo = {
+        sessionNumber: 0,
+        sessionId: 0,
+        ...this.deviceInfo,
+    };
+
+    sessionTimeout = createTimeout();
+
+    isSessionActive = false;
+
+    sessionStartSent = false;
+
+    constructor(private baseURL: string, private appVersion: string = '') {
+        this.init();
+    }
+
+    async init() {
+        this.deviceInfo.manufacturer = await device.getManufacturerName();
+        this.deviceInfo.platform = await device.getPlatformName();
+        this.deviceInfo.platformVersion = await device.getPlatformVersion();
+        this.deviceInfo.deviceId = await device.getUuid();
+        await this.startSession();
+    }
+
+    async startSession() {
+        const sessionNumber = parseInt(
+            await Storage.getItem(TWENYFOURIQ_SESSION_COUNTER) ?? '0', 10,
+        ) + 1;
+        this.constantPayload.sessionNumber = sessionNumber;
+        this.constantPayload.sessionId = generateSessionId();
+        this.constantPayload.manufacturer = this.deviceInfo.manufacturer;
+        this.constantPayload.platform = this.deviceInfo.platform;
+        this.constantPayload.platformVersion = this.deviceInfo.platformVersion;
+        this.constantPayload.appVersion = this.appVersion;
+        await Storage.setItem(TWENYFOURIQ_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);
+                }
+            }),
+        );
+    }
+}