@24i/bigscreen-sdk 1.0.51-alpha.2785 → 1.0.51-alpha.2791

package/package.json

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

package/packages/developer-tools/src/TechnicalInfo/TechnicalInfoProvider.ts

@@ -111,6 +111,15 @@ class TechnicalInfoProvider implements ITechnicalInfoProvider {
         return value || unknown;
     }
 
+    async getDeviceOsLanguage() {
+        let value;
+        const { unknown } = this.translations;
+        try {
+            value = await this.props.device.getOsLanguage();
+        } catch (e) {}
+        return value || unknown;
+    }
+
     async getPlatformType() {
         let value;
         const { unknown } = this.translations;
@@ -137,6 +146,16 @@ class TechnicalInfoProvider implements ITechnicalInfoProvider {
         return value || unknown;
     }
 
+    async getAdInfo() {
+        let value;
+        const { unknown } = this.translations;
+        try {
+            const { adId, type, latEnabled } = await this.props.device.getAdInfo();
+            value = `LAT: ${latEnabled}, AD ID TYPE: ${type}, AD ID: ${adId}`;
+        } catch (e) {}
+        return value || unknown;
+    }
+
     async getLocalIpAddress() {
         let value;
         const { unknown } = this.translations;
@@ -283,8 +302,8 @@ class TechnicalInfoProvider implements ITechnicalInfoProvider {
     async getSourceDataLayout() {
         const {
             username, profile, appVersion, firmwareVersion, deviceModel,
-            deviceManufacturer, platform, player, serialNumber, localIpAddress,
-            publicIpAddress, connectionType, macAddress, memoryHeapSize,
+            deviceManufacturer, deviceLanguage, platform, player, serialNumber, adInfo,
+            localIpAddress, publicIpAddress, connectionType, macAddress, memoryHeapSize,
             usedLocalStorage, timeZone, dateAndTime, flavour, userAgent,
             emeSupport, emeDrmSystems, mseSupport, fourKSupport, resolution, baseUrl,
             appCoreVersions, androidWrapperVersion,
@@ -297,9 +316,11 @@ class TechnicalInfoProvider implements ITechnicalInfoProvider {
             { label: firmwareVersion, getter: this.getFirmwareVersion },
             { label: deviceModel, getter: this.getDeviceModelName },
             { label: deviceManufacturer, getter: this.getDeviceManufacturer },
+            { label: deviceLanguage, getter: this.getDeviceOsLanguage },
             { label: platform, getter: this.getPlatformType },
             { label: player, getter: this.getPlayerType },
             { label: serialNumber, getter: this.getDeviceSerialNumber },
+            { label: adInfo, getter: this.getAdInfo },
             { label: localIpAddress, getter: this.getLocalIpAddress },
             { label: publicIpAddress, getter: this.getPublicIpAddress },
             { label: connectionType, getter: this.getConnectionType },

package/packages/developer-tools/src/TechnicalInfo/__mocks__/Device.ts

@@ -43,6 +43,14 @@ class Device {
         return 'connection type';
     }
 
+    async getOsLanguage() {
+        return 'device language';
+    }
+
+    async getAdInfo() {
+        return { adId: 'ad-id', type: 'ad-id-type', latEnabled: false };
+    }
+
     async getMacAddress() {
         return 'mac address';
     }

package/packages/developer-tools/src/TechnicalInfo/translations.ts

@@ -15,9 +15,11 @@ export type TranslationKeys = {
     firmwareVersion: string,
     deviceModel: string,
     deviceManufacturer: string,
+    deviceLanguage: string;
     platform: string,
     player: string,
     serialNumber: string,
+    adInfo: string,
     localIpAddress: string,
     publicIpAddress: string,
     connectionType: string,
@@ -54,9 +56,11 @@ export const defaultTranslations = {
     firmwareVersion: 'Firmware version',
     deviceModel: 'Device model',
     deviceManufacturer: 'Device manufacturer',
+    deviceLanguage: 'Device Language',
     platform: 'Platform',
     player: 'Player',
     serialNumber: 'Serial number',
+    adInfo: 'Ad info',
     localIpAddress: 'Local IP address',
     publicIpAddress: 'Public IP address',
     connectionType: 'Connection type',

package/packages/driver-androidtv/src/DeviceAndroidTV.ts

@@ -177,6 +177,15 @@ export class DeviceAndroidTV extends DeviceBase {
         return { adId, type, latEnabled };
     }
 
+    async getOsLanguage() {
+        try {
+            return window.JavaScriptBridge.bridgeJavaScriptToAndroid_GetOsLanguage() || '';
+        } catch (e) {
+            console.error('[DeviceAndroidTV] Failed to getOsLanguage', e);
+            return '';
+        }
+    }
+
     async getVolume(): Promise<number> {
         return VolumeRange.UNSUPPORTED;
     }

package/packages/driver-androidtv/src/__mocks__/javaScriptBridge.ts

@@ -15,6 +15,7 @@ export const mockJavaScriptBridge: IJavaScriptBridge = {
         ),
         bridgeJavaScriptToAndroid_GetAdId: () => 'gaid-id',
         bridgeJavaScriptToAndroid_GetLimitAdTracking: () => false,
+        bridgeJavaScriptToAndroid_GetOsLanguage: () => '',
         bridgeJavaScriptToAndroid_GetMediaInfo: () => '{}',
         bridgeJavaScriptToAndroid_Back: () => {},
         bridgeJavaScriptToAndroid_StopVideo: () => {},

package/packages/driver-androidtv/src/types.ts

@@ -18,6 +18,11 @@ interface JavaScriptBridge {
      * @return true if limit ad tracking is enabled, false if not and null if not available.
      */
     bridgeJavaScriptToAndroid_GetLimitAdTracking: () => boolean | null,
+    /**
+     * It returns the language of the OS.
+     * @return Language of the OS. Ex. "en"
+     */
+    bridgeJavaScriptToAndroid_GetOsLanguage: () => string,
     /**
      * It returns media info including statistics
      */

package/packages/driver-base/src/DeviceBase.ts

@@ -155,6 +155,8 @@ export abstract class DeviceBase<
 
     abstract getAdInfo(): Promise<AdInfo>;
 
+    abstract getOsLanguage(): Promise<string>;
+
     abstract getVolume(): Promise<number>;
 
     abstract setVolume(volumePercentage: number): Promise<void>;

package/packages/driver-base/src/__mocks__/DeviceBase.ts

@@ -53,6 +53,10 @@ export class DeviceBase extends AbstractDeviceBase {
         return this.getBaseUuid();
     }
 
+    async getOsLanguage() {
+        return '';
+    }
+
     async getAdInfo() {
         const adId = 'uuid';
         const type = 'id type';

package/packages/driver-browser/src/DeviceBrowser.ts

@@ -122,6 +122,10 @@ export class DeviceBrowser extends DeviceBase {
         return { adId, type, latEnabled };
     }
 
+    async getOsLanguage() {
+        return (window.navigator.language || '').slice(0, 2);
+    }
+
     async getVolume() {
         return this.volume;
     }

package/packages/driver-entone/src/DeviceEntone.ts

@@ -128,6 +128,10 @@ export class DeviceEntone extends DeviceBase {
         return { adId, type, latEnabled };
     }
 
+    async getOsLanguage() {
+        return (window.navigator.language || '').slice(0, 2);
+    }
+
     async getVolume() {
         try {
             const { leftVolPercentage, rightVolPercentage } = ENTONE.stb.getAudioVolume();

package/packages/driver-firetv/src/__mocks__/javaScriptBridge.ts

@@ -15,6 +15,7 @@ export const mockJavaScriptBridge: IJavaScriptBridge = {
         ),
         bridgeJavaScriptToAndroid_GetAdId: () => 'afai-id',
         bridgeJavaScriptToAndroid_GetLimitAdTracking: () => false,
+        bridgeJavaScriptToAndroid_GetOsLanguage: () => '',
         bridgeJavaScriptToAndroid_GetMediaInfo: () => '{}',
         bridgeJavaScriptToAndroid_Back: () => {},
         bridgeJavaScriptToAndroid_StopVideo: () => {},

package/packages/driver-hbbtv/src/DeviceHbbTV.ts

@@ -253,6 +253,10 @@ export class DeviceHbbTV extends DeviceBase {
         return { adId, type, latEnabled };
     }
 
+    async getOsLanguage() {
+        return (window.navigator.language || '').slice(0, 2);
+    }
+
     async getVolume() {
         // TODO: not yet implemented
         return VolumeRange.UNSUPPORTED;

package/packages/driver-kreatv/src/DeviceKreaTV.ts

@@ -167,6 +167,10 @@ export class DeviceKreaTV extends DeviceBase {
         return { adId, type, latEnabled };
     }
 
+    async getOsLanguage() {
+        return (window.navigator.language || '').slice(0, 2);
+    }
+
     getSupportedAudioConnections() {
         const { audioOutputService } = this.toiInstance;
         const { ToiAudioOutputService } = this.toiInstance.consts;

package/packages/driver-saphi/src/DeviceSaphi.ts

@@ -89,6 +89,10 @@ export class DeviceSaphi extends DeviceBase {
         return { adId, type, latEnabled };
     }
 
+    async getOsLanguage() {
+        return (window.navigator.language || '').slice(0, 2);
+    }
+
     async getVolume(): Promise<number> {
         return VolumeRange.UNSUPPORTED;
     }

package/packages/driver-smartcast/src/DeviceSmartCast.ts

@@ -4,7 +4,13 @@ import {
 import { runAsync } from '@24i/bigscreen-sdk/utils/timers';
 import { ipify } from '@24i/bigscreen-sdk/ipify';
 import { getKeyMap } from './keymap';
-import { ISmartCastApi, IFA, DEFAULT_TTS_TIMEOUT, DevicePlaybackQuality } from './types';
+import {
+    ISmartCastApi,
+    IFA,
+    DEFAULT_TTS_TIMEOUT,
+    DevicePlaybackQuality,
+    DeviceLanguage,
+} from './types';
 
 declare const window: Window & { VIZIO: ISmartCastApi };
 
@@ -29,6 +35,8 @@ export class DeviceSmartCast extends DeviceBase {
 
     lastTextToSpeechItem?: { delay: number, text: string } | null;
 
+    deviceLanguage?: DeviceLanguage;
+
     API?: ISmartCastApi;
 
     IFA?: IFA;
@@ -84,6 +92,13 @@ export class DeviceSmartCast extends DeviceBase {
                     });
                 }));
 
+                promises.push(new Promise<void>((r) => {
+                    API.setDeviceLanguageHandler((deviceLanguage: DeviceLanguage) => {
+                        this.deviceLanguage = deviceLanguage;
+                        r();
+                    });
+                }));
+
                 // eslint-disable-next-line @typescript-eslint/no-unused-vars
                 API.setContentChangeHandler(this.handleDeeplink);
 
@@ -272,6 +287,10 @@ export class DeviceSmartCast extends DeviceBase {
         return { adId, type, latEnabled };
     }
 
+    async getOsLanguage() {
+        return this.deviceLanguage?.code || '';
+    }
+
     async getVolume() {
         return VolumeRange.UNSUPPORTED;
     }

package/packages/driver-smartcast/src/__mocks__/api.ts

@@ -1,4 +1,4 @@
-import { IFA, ISmartCastApi, DevicePlaybackQuality } from '../types';
+import { IFA, ISmartCastApi, DevicePlaybackQuality, DeviceLanguage } from '../types';
 
 export const deviceId = '2bd671ef-02cd-445f-9295-b3565dbaf1e8';
 export const deviceModel = 'D24f4-J01';
@@ -37,6 +37,10 @@ export const SmartCastMockApi: ISmartCastApi = {
     setContentChangeHandler:
         (callback: (contentUrl: string) => void): void => callback(deeplinkUrl),
 
+    setDeviceLanguageHandler: (
+        callback: (deviceLanguage: DeviceLanguage) => void,
+    ): void => callback({ code: 'en', name: 'English' }),
+
     Chromevox: {
         cancel: (): void => {
             throw new Error('Function not implemented.');

package/packages/driver-smartcast/src/types.ts

@@ -34,6 +34,11 @@ export type ISmartCastApi = {
      */
     setContentChangeHandler: (callback: (contentUrl: string) => void) => void;
 
+    /**
+     * Sets the callback to receive device language object.
+     */
+    setDeviceLanguageHandler: (callback: (deviceLanguage: DeviceLanguage) => void) => void;
+
     /**
      * Device model.
      */
@@ -63,3 +68,8 @@ export type IFA = {
 export type DevicePlaybackQuality = 'UHD' | 'HD' | 'SD';
 
 export const DEFAULT_TTS_TIMEOUT = 3000;
+
+export type DeviceLanguage = {
+    code: string,
+    name: string,
+};

package/packages/driver-tizen/src/DeviceTizen.ts

@@ -211,6 +211,16 @@ export class DeviceTizen extends DeviceBase {
         return { adId, type, latEnabled };
     }
 
+    async getOsLanguage() {
+        return new Promise<string>((resolve) => {
+            tizen.systeminfo.getPropertyValue(
+                'LOCALE',
+                ({ language }) => resolve(language),
+                () => resolve(''),
+            );
+        });
+    }
+
     async getVolume() {
         try {
             const volume = tizen.tvaudiocontrol.getVolume();

package/packages/driver-tizen/src/__mocks__/tizen.ts

@@ -28,6 +28,9 @@ export const tizen = {
         unregisterKey: () => {},
         registerKey: () => {},
     },
+    systeminfo: {
+        getPropertyValue: async () => {},
+    },
 };
 
 declare global {

package/packages/driver-vidaa/src/DeviceVidaa.ts

@@ -88,6 +88,10 @@ export class DeviceVidaa extends DeviceBase {
         return { adId, type, latEnabled };
     }
 
+    async getOsLanguage() {
+        return (window.navigator.language || '').slice(0, 2);
+    }
+
     async getVolume(): Promise<number> {
         return VolumeRange.UNSUPPORTED;
     }

package/packages/driver-webos/src/DeviceWebos.ts

@@ -252,6 +252,32 @@ export class DeviceWebos extends DeviceBase {
         return { adId, type, latEnabled };
     }
 
+    async getOsLanguage(): Promise<string> {
+        return new Promise<string>((resolve) => {
+            webOS.service.request(ApiUrls.SETTINGS_SERVICE, {
+                method: 'getSystemSettings',
+                parameters: {
+                    keys: ['localeInfo'],
+                },
+                onSuccess: (response) => {
+                    if (response.returnValue) {
+                        const uiLanguage = response?.settings?.localeInfo?.locales?.UI;
+                        resolve((uiLanguage || '').slice(0, 2));
+                    }
+                    resolve('');
+                },
+                onFailure: (error) => {
+                    // ex. returns error for webOS 1.0, 2.0 as not supported
+                    const { errorCode = '0', errorText } = error || {};
+                    console.error(
+                        `[DeviceWebos] getOsLanguage onFailure: [${errorCode}] ${errorText}`,
+                    );
+                    resolve('');
+                },
+            });
+        });
+    }
+
     async getVolume() {
         // TODO: not yet implemented
         return VolumeRange.UNSUPPORTED;

package/packages/driver-webos/src/__mocks__/webos.ts

@@ -63,6 +63,39 @@ const mockServices = {
                 callbackName: 'onSuccess',
             },
         },
+        'luna://com.webos.settingsservice#getSystemSettings': {
+            responses: {
+                success: {
+                    returnValue: true,
+                    method: 'getSystemSettings',
+                    settings: {
+                        localeInfo: {
+                            locales: {
+                                UI: 'en-GB',
+                                TV: 'en-GB',
+                                FMT: 'en-GB',
+                                NLP: 'en-GB',
+                                STT: 'fr-FR',
+                                AUD: 'fr-FR',
+                                AUD2: 'en-GB',
+                            },
+                            clock: 'locale',
+                            keyboards: ['en'],
+                            timezone: '',
+                        },
+                    },
+                },
+                error: {
+                    returnValue: false,
+                    errorCode: 'ERR.001',
+                    errorText: 'There is no matched result from DB',
+                },
+            },
+            selected: {
+                responseId: 'success',
+                callbackName: 'onSuccess',
+            },
+        },
         'luna://com.webos.service.connectionmanager#getStatus': {
             responses: {
                 successWired: {

package/packages/driver-webos/src/constants.ts

@@ -17,4 +17,5 @@ export const ApiUrls = {
     CONNECTION_MANAGER_WEBOS: 'luna://com.webos.service.connectionmanager',
     SYSTEM_PROPERTY: 'luna://com.webos.service.tv.systemproperty',
     SM: 'luna://com.webos.service.sm',
+    SETTINGS_SERVICE: 'luna://com.webos.settingsservice',
 } as const;

package/packages/driver-webos/src/types.ts

@@ -331,11 +331,41 @@ export type DuidOptions = {
     onComplete?: (response: NegativeResponse | DuidResponse) => any,
 };
 
+type SettingsService = {
+    method: 'getSystemSettings',
+    settings: {
+        localeInfo: {
+            locales: {
+                UI: string,
+                TV: string,
+                FMT: string,
+                NLP: string,
+                STT: string,
+                AUD: string,
+                AUD2: string,
+            },
+            clock: string,
+            keyboards: string[],
+            timezone: string,
+        },
+    },
+};
+export type SettingsServiceResponse = PositiveResponse & SettingsService;
+export type SettingsServiceOptions = {
+    method: 'getSystemSettings',
+    parameters: {
+        keys: ['localeInfo'],
+    },
+    onSuccess?: (response: NegativeResponse | SettingsServiceResponse) => any,
+    onFailure?: (response: NegativeResponse) => any,
+};
+
 interface RequestTypeMap {
     [ApiUrls.CONNECTION_MANAGER_PALM]: ConnectionManagerOptions,
     [ApiUrls.CONNECTION_MANAGER_WEBOS]: ConnectionManagerOptions,
     [ApiUrls.SYSTEM_PROPERTY]: SystemPropertyOptions,
     [ApiUrls.SM]: DuidOptions,
+    [ApiUrls.SETTINGS_SERVICE]: SettingsServiceOptions,
 }
 
 // MARK: IPalmSystem

package/packages/driver-xbox/src/DeviceXbox.ts

@@ -159,6 +159,10 @@ export class DeviceXbox extends DeviceBase {
         return { adId, type, latEnabled };
     }
 
+    async getOsLanguage() {
+        return (window.navigator.language || '').slice(0, 2);
+    }
+
     async getVolume() {
         return VolumeRange.UNSUPPORTED;
     }