@24i/bigscreen-sdk 1.0.21-alpha.2355 → 1.0.21-alpha.2358

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@24i/bigscreen-sdk",
-    "version": "1.0.21-alpha.2355",
+    "version": "1.0.21-alpha.2358",
     "description": "SmartApps BIGscreen SDK monorepo",
     "main": "index.js",
     "scripts": {
@@ -121,6 +121,7 @@
         "./driver-hbbtv": "./packages/driver-hbbtv/src/index.ts",
         "./driver-kreatv": "./packages/driver-kreatv/src/index.ts",
         "./driver-saphi": "./packages/driver-saphi/src/index.ts",
+        "./driver-smartcast": "./packages/driver-smartcast/src/index.ts",
         "./driver-tizen": "./packages/driver-tizen/src/index.ts",
         "./driver-vidaa": "./packages/driver-vidaa/src/index.ts",
         "./driver-webos/scripts/template": "./packages/driver-webos/scripts/template.ts",

package/packages/device/src/driver/index.smartcast.tv.ts

@@ -0,0 +1 @@
+export { DeviceSmartCast as Device } from '@24i/bigscreen-sdk/driver-smartcast';

package/packages/device/src/resolver/resolver.ts

@@ -7,6 +7,7 @@ import { DeviceKreaTV } from '@24i/bigscreen-sdk/driver-kreatv';
 import { DeviceSaphi } from '@24i/bigscreen-sdk/driver-saphi';
 import { DeviceTizen } from '@24i/bigscreen-sdk/driver-tizen';
 import { DeviceVidaa } from '@24i/bigscreen-sdk/driver-vidaa';
+import { DeviceSmartCast } from '@24i/bigscreen-sdk/driver-smartcast';
 import { DeviceWebos } from '@24i/bigscreen-sdk/driver-webos';
 import { DeviceXbox } from '@24i/bigscreen-sdk/driver-xbox';
 
@@ -29,6 +30,10 @@ const getDevice = () => {
         info('Tizen');
         return new DeviceTizen();
     }
+    if (userAgent.match(/Vizio/i)) {
+        info('SmartCast');
+        return new DeviceSmartCast();
+    }
     if (userAgent.match(/Web0S/)) { // Yes, it is Web ZERO S
         info('WebOS');
         return new DeviceWebos();

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

@@ -217,4 +217,8 @@ export abstract class DeviceBase<
     isMouseUsed() {
         return this.isMouseActive;
     }
+
+    getResolution() {
+        return { width: window.screen?.width, height: window.screen?.height };
+    }
 }

package/packages/driver-base/src/types/DeviceEvent.ts

@@ -1,9 +1,11 @@
 type NetworkChangeListener = (payload: { isConnected: boolean }) => void;
 type VisibilityChangeListener = (payload: { isVisible: boolean }) => void;
 type MouseActiveListener = (payload: { isMouseActive: boolean }) => void;
+type CCToggleListener = (payload: { isEnabled: boolean }) => void;
 
 export interface DeviceEventMap {
     'networkchange': NetworkChangeListener,
     'visibilitychange': VisibilityChangeListener,
     'mouseactive': MouseActiveListener,
+    'cctoggle': CCToggleListener,
 }

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

@@ -0,0 +1,310 @@
+import {
+    DeviceBase, ConnectionType, ScreenSaverStatus, VolumeRange,
+} from '@24i/bigscreen-sdk/driver-base';
+import { runAsync } from '@24i/bigscreen-sdk/utils/timers';
+import { getKeyMap } from './keymap';
+import { ISmartCastApi, IFA, DEFAULT_TTS_TIMEOUT, DevicePlaybackQuality } from './types';
+
+declare const window: Window & { VIZIO: ISmartCastApi };
+
+export class DeviceSmartCast extends DeviceBase {
+    keyMap = getKeyMap();
+
+    deviceId = '';
+
+    deviceModel = '';
+
+    deviceFirmware = '';
+
+    readonly backAsBackspaceInSearch = true;
+
+    devicePlaybackQualities: DevicePlaybackQuality[] = [];
+
+    closedCaptionsStatus = false;
+
+    textToSpeechStatus = false;
+
+    textToSpeechTimeout?: null | number;
+
+    lastTextToSpeechItem?: { delay: number, text: string } | null;
+
+    API?: ISmartCastApi;
+
+    IFA?: IFA;
+
+    async initDevice() {
+        this.initNetworkChangeListener();
+        this.initVisibilityChangeListener();
+        this.initMouseActiveListener();
+        await this.initPlatformApiListeners();
+    }
+
+    async initPlatformApiListeners(): Promise<void> {
+        return new Promise((resolve) => {
+            document.addEventListener('VIZIO_LIBRARY_DID_LOAD', async () => {
+                const API = window.VIZIO;
+                this.API = window.VIZIO;
+                const promises = [];
+
+                API.setClosedCaptionHandler((isEnabled: boolean) => {
+                    this.closedCaptionsStatus = isEnabled;
+                    this.triggerEvent('cctoggle', { isEnabled });
+                });
+
+                promises.push(new Promise<void>((r) => {
+                    API.setAdvertiserIDListener((advertiserID: IFA) => {
+                        this.IFA = advertiserID;
+                        r();
+                    });
+                }));
+
+                promises.push(new Promise<void>((r) => {
+                    API.getDeviceId((id: string) => {
+                        this.deviceId = id;
+                        r();
+                    });
+                }));
+
+                this.deviceModel = API.deviceModel;
+
+                promises.push(new Promise<void>((r) => {
+                    API.getFirmwareVersion((version: string) => {
+                        this.deviceFirmware = version;
+                        r();
+                    });
+                }));
+
+                promises.push(new Promise<void>((r) => {
+                    API.getDevicePlaybackQualities((qualities: DevicePlaybackQuality[]) => {
+                        this.devicePlaybackQualities = qualities;
+                        r();
+                    });
+                }));
+
+                // eslint-disable-next-line @typescript-eslint/no-unused-vars
+                API.setContentChangeHandler(this.handleDeeplink);
+
+                await Promise.all(promises);
+
+                resolve();
+            });
+
+            document.addEventListener('VIZIO_TTS_ENABLED', () => {
+                this.textToSpeechStatus = true;
+            }, false);
+
+            document.addEventListener('VIZIO_TTS_DISABLED', () => {
+                this.lastTextToSpeechItem = null;
+                this.textToSpeechStatus = false;
+                window.clearTimeout(this.textToSpeechTimeout as any);
+                this.API?.Chromevox.cancel();
+            }, false);
+
+            const object = document.createElement('script');
+            object.src = 'http://127.0.0.1:12345/scfs/cl/js/vizio-companion-lib.js';
+            document.body.appendChild(object);
+        });
+    }
+
+    initNetworkChangeListener() {
+        window.addEventListener('online', () => {
+            this.triggerEvent('networkchange', { isConnected: true });
+        });
+        window.addEventListener('offline', () => {
+            this.triggerEvent('networkchange', { isConnected: false });
+        });
+    }
+
+    initVisibilityChangeListener() {
+        document.addEventListener('visibilitychange', () => {
+            this.triggerEvent('visibilitychange', {
+                isVisible: document.visibilityState === 'visible',
+            });
+        });
+    }
+
+    initMouseActiveListener() {
+        document.addEventListener('mousemove', this.onMouseActive);
+    }
+
+    onMouseActive = () => {
+        document.removeEventListener('mousemove', this.onMouseActive);
+        document.addEventListener('keydown', this.onMouseInactive, true);
+        this.isMouseActive = true;
+        this.triggerEvent('mouseactive', { isMouseActive: true });
+    };
+
+    onMouseInactive = (event: KeyboardEvent) => {
+        if (!this.isDirectionalArrow(event)) return;
+        document.removeEventListener('keydown', this.onMouseInactive);
+        this.initMouseActiveListener();
+
+        // to let other handlers to use this property before change
+        runAsync(() => {
+            this.isMouseActive = false;
+        });
+        this.triggerEvent('mouseactive', { isMouseActive: false });
+    };
+
+    handleDeeplink = (deeplinkUrl: string) => {
+        if (typeof deeplinkUrl !== 'string') return;
+        const newRoute = deeplinkUrl.split('#')[1];
+        if (newRoute) {
+            const currentUrl = window.location.href.split('#')[0];
+            window.location.href = `${currentUrl}#${newRoute}`;
+        }
+    };
+
+    /**
+     * Reads provided text by the device internal reader.
+     */
+    readText({ text, delay = DEFAULT_TTS_TIMEOUT }: {
+        text: string, delay?: number
+    }) {
+        if (this.textToSpeechStatus && text) {
+            if (this.textToSpeechTimeout) {
+                this.lastTextToSpeechItem = { text, delay };
+            } else {
+                this.API?.Chromevox.play(text);
+
+                this.textToSpeechTimeout = window.setTimeout(() => {
+                    this.textToSpeechTimeout = null;
+
+                    if (this.lastTextToSpeechItem) {
+                        const last = this.lastTextToSpeechItem;
+
+                        this.API?.Chromevox.play(last.text);
+                        this.lastTextToSpeechItem = null;
+                    }
+                }, delay);
+            }
+        }
+    }
+
+    exit() {
+        this.API?.exitApplication();
+    }
+
+    reboot() {
+        window.location.reload();
+    }
+
+    /**
+     * Returs the status of Closed Captions feature.
+     */
+    async getClosedCaptionsStatus() {
+        return this.closedCaptionsStatus;
+    }
+
+    /**
+     * Returs the status of Text to Speech Engine if it is available by the device.
+     */
+    async getTextToSpeechStatus() {
+        return this.textToSpeechStatus;
+    }
+
+    /**
+     * Returns filled in Vast Tag URL.
+     */
+    getVastTagUrl(template: string): null | string {
+        const IFAObject = this.IFA;
+        const resolution = this.getResolution();
+
+        if (!IFAObject) return null;
+
+        return template
+            .replace('{{width}}', String(resolution.width))
+            .replace('{{height}}', String(resolution.height))
+            .replace('{{cb}}', String(Date.now()))
+            .replace('{{user_agent}}', encodeURIComponent(window.navigator.userAgent))
+            .replace('{{ifa}}', IFAObject.IFA)
+            .replace('{{ifa_type}}', IFAObject.IFA_TYPE)
+            .replace('{{lmt}}', String(IFAObject.LMT));
+    }
+
+    async getManufacturerName() {
+        return 'VIZIO';
+    }
+
+    async getPlatformName() {
+        return 'SmartCast';
+    }
+
+    async getPlatformVersion() {
+        return '';
+    }
+
+    async getDeviceName() {
+        return 'VIZIO SmartCast';
+    }
+
+    async getModelName() {
+        return this.deviceModel;
+    }
+
+    async getFirmware() {
+        return this.deviceFirmware;
+    }
+
+    async is4KSupported() {
+        return this.devicePlaybackQualities.includes('UHD');
+    }
+
+    async is8KSupported() {
+        return false;
+    }
+
+    async getUuid() {
+        return this.deviceId;
+    }
+
+    async getVolume() {
+        return VolumeRange.UNSUPPORTED;
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async setVolume(volumePercentage: number) {
+        // not supported on SmartCast platform
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async mute(mute: boolean) {
+        // not supported on SmartCast platform
+    }
+
+    async isMute() {
+        return false;
+    }
+
+    async getScreenSaver() {
+        return { enabled: false };
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async setScreenSaver(status: ScreenSaverStatus) {
+        // not supported on SmartCast platform
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async setUserAgent(userAgent: string) {
+        return false;
+    }
+
+    async getConnectionType() {
+        return 'unknown' as ConnectionType;
+    }
+
+    async isNetworkConnected() {
+        return window.navigator.onLine;
+    }
+
+    async getLocalIP() {
+        // not supported on SmartCast platform
+        return '';
+    }
+
+    async getMacAddress() {
+        // not supported on SmartCast platform
+        return '';
+    }
+}

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

@@ -0,0 +1,49 @@
+import { IFA, ISmartCastApi, DevicePlaybackQuality } from '../types';
+
+export const deviceId = '2bd671ef-02cd-445f-9295-b3565dbaf1e8';
+export const deviceModel = 'D24f4-J01';
+export const firmware = '3.520.28.1-2';
+export const playbackQualities = ['UHD', 'HD'] as DevicePlaybackQuality[];
+// eslint-disable-next-line max-len
+export const deeplinkUrl = 'https://smartapps-bigscreen.24i.com/#/detail/SERIES/FO03OogBXRsigNB1VRz_/undefined/undefined/';
+// eslint-disable-next-line max-len
+export const deeplinkUrl2 = 'https://smartapps-bigscreen.24i.com/#/detail/SERIES/Ge1sO4gBXRsigNB1TBwy/undefined/undefined/';
+// eslint-disable-next-line max-len
+export const vastTagTemplate = 'w={{width}}&h={{height}}&did={{ifa}}&ifa_type={{ifa_type}}&lmt={{lmt}}';
+
+export const SmartCastMockApi: ISmartCastApi = {
+    deviceModel,
+
+    getDeviceId: (callback: (id: string) => void): void => callback(deviceId),
+
+    getFirmwareVersion: (callback: (id: string) => void): void => callback(firmware),
+
+    getDevicePlaybackQualities: (
+        callback: (
+            qualities: DevicePlaybackQuality[]
+        ) => void,
+    ): void => callback(playbackQualities),
+
+    exitApplication: (): void => {},
+
+    setClosedCaptionHandler: (callback: (isEnabled: boolean) => void): void => callback(false),
+
+    setAdvertiserIDListener: (callback: (advertiserID: IFA) => void): void => callback({
+        IFA: deviceId,
+        IFA_TYPE: 'vida',
+        LMT: 0,
+    }),
+
+    setContentChangeHandler:
+        (callback: (contentUrl: string) => void): void => callback(deeplinkUrl),
+
+    Chromevox: {
+        cancel: (): void => {
+            throw new Error('Function not implemented.');
+        },
+        play: (text: string): void => {
+            // eslint-disable-next-line no-console
+            console.log(text);
+        },
+    },
+};

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

@@ -0,0 +1 @@
+export { DeviceSmartCast } from './DeviceSmartCast';

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

@@ -0,0 +1,9 @@
+import { generateKeyCodeKeyMap, overrideValues } from '@24i/bigscreen-sdk/driver-base/keymap';
+
+export const getKeyMap = () => {
+    overrideValues({
+        CHANNEL_PREVIOUS: { code: 'PrevCh', keyCode: 500 },
+        SUBTITLES: { keyCode: 204 },
+    });
+    return generateKeyCodeKeyMap();
+};

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

@@ -0,0 +1,65 @@
+export type ISmartCastApi = {
+    /**
+     * Sets the callback to receive the device UID in standard 32 digits.
+     */
+    getDeviceId: (callback: (id: string) => void) => void;
+
+    /**
+     * Sets the callback to receive the device firmware version.
+     */
+    getFirmwareVersion: (callback: (firmwareVersion: string) => void) => void;
+
+    /**
+     * Sets the callback to receive the device playback qualities.
+     */
+    getDevicePlaybackQualities: (callback: (qualities: DevicePlaybackQuality[]) => void) => void;
+
+    /**
+     * Exits the application.
+     */
+    exitApplication: () => void;
+
+    /**
+     * Sets the callback to receive the device CC toggle event.
+     */
+    setClosedCaptionHandler: (callback: (isEnabled: boolean) => void) => void;
+
+    /**
+     * Sets the callback to receive IFA object with the device ads related parameters.
+     */
+    setAdvertiserIDListener: (callback: (advertiserID: IFA) => void) => void;
+
+    /**
+     * Sets the callback to receive the device content change event.
+     */
+    setContentChangeHandler: (callback: (contentUrl: string) => void) => void;
+
+    /**
+     * Device model.
+     */
+    deviceModel: string;
+
+    /**
+     * Chromevox Text-to-Speech accessibility playback engine.
+     */
+    Chromevox: {
+        cancel: () => void,
+        play: (text: string) => void,
+    };
+};
+
+/**
+ * Identifier For Advertising (IFA) and Limited Tracking parameter object
+ */
+export type IFA = {
+    /** Unique identifier string for advertising */
+    IFA: string,
+    /** String value for IFA type ("vida") */
+    IFA_TYPE: string,
+    /** O or 1 (1=Limited tracking enabled, 0=Limited tracking disabled) */
+    LMT: 0 | 1
+};
+
+export type DevicePlaybackQuality = 'UHD' | 'HD' | 'SD';
+
+export const DEFAULT_TTS_TIMEOUT = 3000;

package/packages/keyboard/src/KeyboardBase.tsx

@@ -1,5 +1,5 @@
 import { Component, createRef, Reference } from '@24i/bigscreen-sdk/jsx';
-import { getKeyDigit } from '@24i/bigscreen-sdk/device';
+import { getKeyDigit, device } from '@24i/bigscreen-sdk/device';
 import { isRtl } from '@24i/bigscreen-sdk/i18n';
 import { EventsManager } from '@24i/bigscreen-sdk/events-manager';
 import {
@@ -121,8 +121,15 @@ export abstract class KeyboardBase<
      */
     onKeyDown(event: KeyboardEvent) {
         const { handleRemoteDigits, handleHWKeyboard } = this.props;
+        const preventBack = 'backAsBackspaceInSearch' in device && !!device.backAsBackspaceInSearch;
+        const inputLength = this.inputElement?.value?.length;
+
         if (BACK.is(event)) {
-            this.onCancel();
+            if (preventBack && inputLength) {
+                this.onBackspace();
+            } else {
+                this.onCancel();
+            }
         } else {
             let char: string | null = null;
             if (handleHWKeyboard) {

package/packages/list/src/CenteredList/controller.ts

@@ -30,7 +30,6 @@ export class CenteredListController<T> extends UnifiedListController<T, Props<an
         this.scrollListScroller(-this.topOffset);
         if (initialFocusIndex !== 0) {
             base.index = initialFocusIndex!;
-            this.focusCurrentItem();
             this.scroll(base.index, false);
         }
     }