@24i/bigscreen-sdk 1.0.43-alpha.2726 → 1.0.43

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@24i/bigscreen-sdk",
-    "version": "1.0.43-alpha.2726",
+    "version": "1.0.43",
     "description": "SmartApps BIGscreen SDK monorepo",
     "main": "index.js",
     "scripts": {

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

@@ -2,7 +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 { findForLanguage } from './findForLanguage';
 import {
     BIGSCREEN_APP_TYPE,
     BIGSCREEN_OTT_TYPE,
@@ -20,6 +20,7 @@ import type {
     TealiumDataMapper,
     TealiumCustomConfiguration,
     CustomMappers,
+    TeaDynamicCoreResult,
 } from './types';
 
 // eslint-disable-next-line no-magic-numbers
@@ -30,11 +31,7 @@ const TEALIUM_BASE_URL = 'https://collect.tealiumiq.com/event';
 const DEFAULT_PAYLOAD: TeaStaticCoreResult = {
     tealium_account: '',
     tealium_profile: '',
-    language: '',
-    language_service: '',
     entity: '',
-    property_id: '',
-    short_language_service: '',
     platform_short: BIGSCREEN_PLATFORM_SHORT,
     platform_type: BIGSCREEN_PLATFORM_TYPE,
     app_type: BIGSCREEN_APP_TYPE,
@@ -79,26 +76,14 @@ export class TealiumAnalytics implements AnalyticsClient {
             customMappers,
             dataMapper = {} as TealiumDataMapper,
         } = this.config || {} as TealiumCustomConfiguration;
-        const {
-            entity,
-            property_ids: propertyIds,
-            language,
-            short_language_service: shortLanguageService,
-            platform_short: platformShort,
-            platform_type: platformType,
-            app_type: appType,
-        } = dataMapper || {} as TealiumDataMapper;
+        const { entity, platformShort, platformType, appType } = dataMapper;
         this.customMappers = customMappers;
         this.constantPayload = {
             tealium_account: account,
             tealium_profile: profile,
             tealium_environment: environment,
-            ...(datasource && { tealium_datasource: datasource }),
-            language: language || '',
-            language_service: `${entity} ${language}`,
             entity,
-            property_id: findIdForLanguage(propertyIds, language || '').toString(),
-            short_language_service: shortLanguageService || '',
+            ...(datasource && { tealium_datasource: datasource }),
             platform_short: platformShort ?? BIGSCREEN_PLATFORM_SHORT,
             platform_type: platformType ?? BIGSCREEN_PLATFORM_TYPE,
             app_type: appType ?? BIGSCREEN_APP_TYPE,
@@ -107,6 +92,24 @@ export class TealiumAnalytics implements AnalyticsClient {
         };
     }
 
+    getDynamicPayload({ language: payloadLanguage }: AnyPayload): TeaDynamicCoreResult {
+        if (!this.config || !this.config.dataMapper) {
+            console.warn(`[${this.name}] getDynamicPayload missing configuration`);
+            return {
+                language: '', language_service: '', property_id: '', short_language_service: '',
+            };
+        }
+        const { dataMapper } = this.config;
+        const { entity, languageMap, propertyIdsMap, shortLanguageServiceMap } = dataMapper;
+        const tealiumLanguage = findForLanguage(languageMap, payloadLanguage) || '';
+        return {
+            language: tealiumLanguage || '',
+            language_service: `${entity} ${tealiumLanguage}`,
+            property_id: findForLanguage(propertyIdsMap, payloadLanguage) || '',
+            short_language_service: findForLanguage(shortLanguageServiceMap, payloadLanguage) || '',
+        };
+    }
+
     async startSession() {
         const sessionNumber = parseInt(
             await Storage.getItem(TEALIUM_SESSION_COUNTER) ?? '0', 10,
@@ -157,6 +160,7 @@ export class TealiumAnalytics implements AnalyticsClient {
                     }
                     const eventBody = {
                         ...this.constantPayload,
+                        ...this.getDynamicPayload(payload),
                         ...mappingFunction(triggerName, payload as Payload, this.config),
                     };
                     const filteredEventBody: TeaResult = Object.entries(eventBody).reduce(

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

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

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

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

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

@@ -29,6 +29,8 @@ export const MEDIA_PAYLOAD: Payload = {
     section: 'BROWSE',
     subcontentType: 'section',
     seriesTitle: 'section',
+    language: 'en',
+    resolution: '1920x1080',
 };
 
 export const TEALIUM_PAGEINFO_PAYLOAD = {

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

@@ -1,7 +1,7 @@
 import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
 import { AppEvents, EVENTS, TrackEventType as TrackEventTypeEnum } from './constants';
 import type {
-    UserInfo, AppInfo, VideoProgress, SceneInfo, PlayerSession, ErrorInfo,
+    UserInfo, GeneralAppData, AppInfo, VideoProgress, SceneInfo, PlayerSession, ErrorInfo,
 } from '../../interface';
 
 export type TeaEventType = 'view' | 'link';
@@ -12,20 +12,20 @@ type TeaTrackEventType = `${TrackEventTypeEnum}`;
 type TeaAppEventValues = typeof AppEvents[keyof typeof AppEvents];
 type TeaAnalyticsTriggerValues = `${AnalyticsTriggers}`;
 
-export interface PropertyIds {
-    [key: string]: number;
+export interface LanguageMapper {
+    [key: string]: string;
 }
 
 export type CustomMappers = Partial<Record<EVENTS, EventMappingFunction>>;
 
 export type TealiumDataMapper = {
-    app_type: TeaAppType, // e.g. 'html5' for bigscreen
+    appType: TeaAppType,
     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'
+    platformShort?: string,
+    platformType?: string,
+    languageMap: LanguageMapper, // e.g: 'english'
+    propertyIdsMap: LanguageMapper, // e.g: 414
+    shortLanguageServiceMap: LanguageMapper, // e.g: 'eng'
 };
 
 export type TealiumCustomConfiguration = {
@@ -71,6 +71,7 @@ export type SubPageInfo = {
 };
 
 export type Payload = CorePayload &
+GeneralAppData &
 AppInfo &
 SceneInfo &
 SubPageInfo &
@@ -87,6 +88,13 @@ export type EventMappingFunction = (
     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,
@@ -96,13 +104,9 @@ export type TeaStaticCoreResult = {
     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 = {

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

@@ -1,9 +0,0 @@
-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;
-};