@24i/bigscreen-sdk 1.0.37-alpha.2648 → 1.0.37-alpha.2649

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@24i/bigscreen-sdk",
-    "version": "1.0.37-alpha.2648",
+    "version": "1.0.37-alpha.2649",
     "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.70",
+        "@24i/appstage-shared-analytics": "1.0.20-alpha.72",
         "@24i/appstage-shared-events-manager": "1.0.11",
         "@24i/appstage-shared-perf-utils": "1.0.11",
         "@24i/bigscreen-players-engine-base": "4.0.4",

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

@@ -2,6 +2,7 @@ import { Storage } from '@24i/bigscreen-sdk/storage';
 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 { findIdForLanguage } from './findIdForLanguage';
 import {
     BIGSCREEN_APP_TYPE,
     BIGSCREEN_OTT_TYPE,
@@ -16,11 +17,13 @@ import type {
     Payload,
     TealiumAnalyticsConfiguration,
     TeaResult,
+    TealiumDataMapper,
+    TealiumCustomConfiguration,
+    CustomMappers,
 } from './types';
 
 // eslint-disable-next-line no-magic-numbers
 const SESSION_TIMEOUT = 30 * MINUTE_IN_MS;
-const TEALIUM_INSTANCE = 'tealium_analytics_bigscreen';
 const TEALIUM_SESSION_COUNTER = 'tealium_session_counter';
 const TEALIUM_BASE_URL = 'https://collect.tealiumiq.com/event';
 
@@ -52,6 +55,8 @@ export class TealiumAnalytics implements AnalyticsClient {
 
     baseUrl: string = '';
 
+    customMappers: CustomMappers | undefined = undefined;
+
     constructor(private config: TealiumAnalyticsConfiguration, private appVersion: string = '') {
         this.init();
     }
@@ -62,37 +67,43 @@ export class TealiumAnalytics implements AnalyticsClient {
     }
 
     prepareDatasetPayload() {
-        const { options } = this.config;
-        if (!options) {
-            console.warn(`[${this.name}] prepareDatasetPayload missing options`);
+        if (!this.config) {
+            console.warn(`[${this.name}] prepareDatasetPayload missing configuration`);
             return;
         }
         const {
-            datasource,
-            entity,
-            language,
             account,
             profile,
             environment,
-            property_id: propertyId,
+            datasource,
+            customMappers,
+            dataMapper = {} as TealiumDataMapper,
+        } = this.config || {} as TealiumCustomConfiguration;
+        const {
+            entity,
+            property_ids: propertyIds,
+            language,
             short_language_service: shortLanguageService,
-        } = options;
+            platform_short: platformShort,
+            platform_type: platformType,
+            app_type: appType,
+        } = dataMapper || {} as TealiumDataMapper;
+        this.customMappers = customMappers;
         this.constantPayload = {
             tealium_account: account,
             tealium_profile: profile,
             tealium_environment: environment,
-            tealium_datasource: datasource,
-            instance: TEALIUM_INSTANCE,
-            language,
+            ...(datasource && { tealium_datasource: datasource }),
+            language: language || '',
             language_service: `${entity} ${language}`,
             entity,
-            property_id: `${propertyId}`,
-            short_language_service: shortLanguageService,
-            platform_short: BIGSCREEN_PLATFORM_SHORT,
-            platform_type: BIGSCREEN_PLATFORM_TYPE,
-            app_type: BIGSCREEN_APP_TYPE,
+            property_id: findIdForLanguage(propertyIds, language || '').toString(),
+            short_language_service: shortLanguageService || '',
+            platform_short: platformShort ?? BIGSCREEN_PLATFORM_SHORT,
+            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} ${language}:${this.appVersion}`,
         };
     }
 
@@ -135,11 +146,10 @@ export class TealiumAnalytics implements AnalyticsClient {
             await this.startSession();
         }
         if (!events) return;
-        const { config } = this;
         await Promise.all(
             events.map(async (event) => {
-                const mappingFunction = config?.customMappers
-                    ? config.customMappers[event]
+                const mappingFunction = this.customMappers && this.customMappers[event]
+                    ? this.customMappers[event]
                     : EVENTS_MAPPING[event];
                 try {
                     if (!mappingFunction) {

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

@@ -2,7 +2,7 @@ import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
 
 export const BIGSCREEN_OTT_TYPE = 'SmartTV';
 
-export const BIGSCREEN_APP_TYPE = 'HTML5';
+export const BIGSCREEN_APP_TYPE = 'html5';
 
 export const BIGSCREEN_PLATFORM_SHORT = 'o';
 

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

@@ -0,0 +1,9 @@
+import { PropertyIds } from '@24i/bigscreen-sdk/analytics/TealiumAnalytics';
+
+export const findIdForLanguage = (
+    property_ids: PropertyIds = {},
+    language: string,
+): number => {
+    const languageKey = Object.keys(property_ids).find((key) => key.endsWith(language));
+    return languageKey ? property_ids[languageKey] : -1;
+};

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

@@ -1,3 +1,4 @@
 export { TealiumAnalytics } from './TealiumAnalytics';
+export { findIdForLanguage } from './findIdForLanguage';
 export * from './constants';
 export * from './types';

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

@@ -11,7 +11,7 @@ export const MEDIA_PAYLOAD: Payload = {
     provider: 'provider',
     assetId: '12345',
     app_id: 'app_id',
-    app_type: 'HTML5',
+    app_type: 'html5',
     sceneName: '',
     sceneId: '',
     sceneType: '',
@@ -40,21 +40,20 @@ export const TEALIUM_PAGEINFO_PAYLOAD = {
 };
 
 export const TEALIUM_STATIC_CORE_PAYLOAD = {
-    tealium_account: 'bbg',
+    tealium_account: 'test',
     tealium_profile: 'main',
     tealium_environment: 'dev',
     tealium_datasource: 'abc',
-    app_id: 'rfe russian v1.0-test',
-    app_type: 'HTML5',
-    entity: 'rfe',
-    instance: 'tealium_analytics_bigscreen',
-    language: 'russian',
-    language_service: 'rfe russian',
+    app_id: 'auto english: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: '414',
-    short_language_service: 'rus',
+    property_id: '1',
+    short_language_service: 'eng',
 };
 
 export const TEALIUM_MEDIA_PAYLOAD = {

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

@@ -5,34 +5,42 @@ import type {
 } from '../../interface';
 
 export type TeaEventType = 'view' | 'link';
-type TeaAppType = 'HTML5' | 'react' | 'native';
+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 type TealiumAnalyticsOptions = {
-    account: string, // e.g: 'bbg'
-    profile: string, // e.g: 'main'
-    environment: string, // e.g: 'dev'
-    app_type: TeaAppType, // e.g. 'HTML5' for bigscreen
+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'
-    language: string, // e.g: 'russian'
-    short_language_service: string, // e.g: 'rus'
-    property_id: number, // e.g: 414
-    datasource?: string, // e.g: '6g2fzf'
-    instance?: string, // unique instance name
+    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 TealiumAnalyticsConfiguration = {
-    name: string, // Telium
-    baseURL: string, // e.g: 'https://collect.tealiumiq.com/event',
-    enabled: boolean,
-    options?: TealiumAnalyticsOptions,
-    customMappers?: Record<EVENTS, EventMappingFunction>,
+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;
@@ -90,23 +98,23 @@ export type TeaStaticCoreResult = {
     language: string;
     language_service: string;
     ott_type: TeaOttType;
-    platform_short: 'o';
-    platform_type: 'ott';
+    platform_short: string;
+    platform_type: string;
     property_id: string;
     short_language_service: string;
 };
 
 export type TeaCoreResult = {
-    app_events: TeaAppEventValues | '', // '' for Scene View event
+    app_events?: TeaAppEventValues | '', // '' for Scene View event
     event_trigger: TeaAnalyticsTriggerValues,
     track_event_type: TeaTrackEventType,
 };
 
 export type TeaPageResult = {
-    page_title: string,
     page_name: string,
+    page_title?: string,
     content_type: string,
-    section: string,
+    section?: string,
     categories: string,
     subcontent_type?: string;
 };