@24i/bigscreen-sdk 1.0.4 → 1.0.5-4.alpha-2832

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

@@ -320,6 +320,10 @@ export const GUIDE = new Key({
     keyCode: 458,
 });
 
+export const SUBTITLES = new Key({
+    id: 'SUBTITLES',
+});
+
 // MARK: Xbox specials
 export const GAMEPAD_LEFT_THUMBSTICK_UP = new Key({
     id: 'GAMEPAD_LEFT_THUMBSTICK_UP',

package/packages/driver-base/src/KeyMap/interface.ts

@@ -4,4 +4,5 @@ export interface KeyConfig {
     code: string,
     alternativeKeyCodes: number[],
     alternativeCodes: string[],
+    key : string,
 }

package/packages/driver-base/src/KeyMap/overrideValues.ts

@@ -6,11 +6,12 @@ import * as KeyMap from './KeyMap';
 export const overrideValues = (map: Partial<Record<keyof KeycodeKeyMap, Partial<Key>>>) => {
     // @ts-ignore - map and KeyMap have same keys
     forEach(Object.entries(map), ([keyName, {
-        keyCode, code, alternativeKeyCodes, alternativeCodes,
+        keyCode, code, alternativeKeyCodes, alternativeCodes, key,
     }]: [keyof typeof import('./KeyMap'), Partial<Key>]) => {
         if (typeof keyCode === 'number') KeyMap[keyName].keyCode = keyCode;
         if (typeof code === 'string') KeyMap[keyName].code = code;
         if (alternativeKeyCodes) KeyMap[keyName].alternativeKeyCodes = alternativeKeyCodes;
         if (alternativeCodes) KeyMap[keyName].alternativeCodes = alternativeCodes;
+        if (key) KeyMap[keyName].key = key;
     });
 };

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

@@ -1,6 +1,7 @@
 import { DeviceBase as AbstractDeviceBase } from '../DeviceBase';
 import { ScreenSaverStatus } from '../types/ScreenSaverStatus';
 import { ConnectionType } from '../ConnectionType';
+import { IAPPurchaseProductData, IAPSuccessPayload } from '../types/InAppPurchase';
 
 export class DeviceBase extends AbstractDeviceBase {
     volume = 0;
@@ -53,6 +54,17 @@ export class DeviceBase extends AbstractDeviceBase {
         return this.getBaseUuid();
     }
 
+    async getOsLanguage() {
+        return '';
+    }
+
+    async getAdInfo() {
+        const adId = 'uuid';
+        const type = 'id type';
+        const latEnabled = null;
+        return { adId, type, latEnabled };
+    }
+
     async getVolume() {
         return this.volume;
     }
@@ -97,4 +109,16 @@ export class DeviceBase extends AbstractDeviceBase {
     async getMacAddress() {
         return '00:11:22:33:44:55';
     }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async purchaseProduct(data: IAPPurchaseProductData): Promise<IAPSuccessPayload> {
+        // not supported
+        throw new Error('Not supported');
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async cancelSubscription(data: IAPPurchaseProductData): Promise<void> {
+        // not supported
+        throw new Error('Not supported');
+    }
 }

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

@@ -38,4 +38,5 @@ export const KEYMAP = {
     KP_9: 105,
     CHANNEL_UP: 33,
     CHANNEL_DOWN: 34,
+    SUBTITLES: 83,
 };

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

@@ -5,6 +5,9 @@ export { VolumeRange } from './VolumeRange';
 export type { ScreenSize } from './ScreenSize';
 export type { KeycodeKeyMap } from './types/KeycodeKeyMap';
 export type { DeviceEventMap } from './types/DeviceEvent';
+export type {
+    IAPSuccessPayload, IAPErrorPayload, IAPPromiseResolve, IAPPromiseReject, IAPPurchaseProductData,
+} from './types/InAppPurchase';
 export type { ScreenSaverStatus } from './types/ScreenSaverStatus';
 export type { ExitOptions } from './types/ExitOptions';
 export * as KeyMap from './KeyMap';

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

@@ -0,0 +1,5 @@
+export type AdInfo = {
+    adId: string | null;
+    type: string;
+    latEnabled: boolean | null;
+};

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-base/src/types/InAppPurchase.ts

@@ -0,0 +1,20 @@
+import { Product } from '@24i/smartapps-datalayer/models';
+import { VendorType } from '@24i/smartapps-datalayer/src/api';
+
+export type IAPSuccessPayload = {
+    platform: VendorType,
+    receiptPayload: object
+};
+
+export type IAPPurchaseProductData = {
+    sku: string,
+    serviceId?: string,
+    product?: Product,
+    appId?: string,
+};
+
+export type IAPErrorPayload = { message: string };
+
+export type IAPPromiseResolve = (value: IAPSuccessPayload | PromiseLike<IAPSuccessPayload>) => void;
+
+export type IAPPromiseReject = (reason?: unknown) => void;

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

@@ -61,6 +61,7 @@ export type KeycodeKeyMap = {
     EXIT: number,
     INFO: number,
     GUIDE: number,
+    SUBTITLES: number,
 
     // Xbox specials
     GAMEPAD_LEFT_THUMBSTICK_UP: number,

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

@@ -1,7 +1,10 @@
 import {
     DeviceBase, ConnectionType, ScreenSaverStatus, VolumeRange,
+    IAPSuccessPayload,
+    IAPPurchaseProductData,
 } from '@24i/bigscreen-sdk/driver-base';
 import { runAsync } from '@24i/bigscreen-sdk/utils/timers';
+import { generateUuid } from '@24i/bigscreen-sdk/utils';
 import { getKeyMap } from './keymap';
 import { patchSuitestKeys } from './patchSuitestKeys';
 import { getBrowser } from './getBrowser';
@@ -114,6 +117,17 @@ export class DeviceBrowser extends DeviceBase {
         return this.getBaseUuid();
     }
 
+    async getAdInfo() {
+        const adId = generateUuid();
+        const type = 'sessionid';
+        const latEnabled = null;
+        return { adId, type, latEnabled };
+    }
+
+    async getOsLanguage() {
+        return (window.navigator.language || '').slice(0, 2);
+    }
+
     async getVolume() {
         return this.volume;
     }
@@ -167,4 +181,16 @@ export class DeviceBrowser extends DeviceBase {
         // for development purpose. Correctly, it should return '' for unknown MAC addr.
         return '00:00:00:00:00:00';
     }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async purchaseProduct(data: IAPPurchaseProductData): Promise<IAPSuccessPayload> {
+        // not supported
+        throw new Error('Not supported');
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async cancelSubscription(data: IAPPurchaseProductData): Promise<void> {
+        // not supported
+        throw new Error('Not supported');
+    }
 }

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

@@ -9,6 +9,14 @@ export const getKeyMap = () => {
         VOL_UP: { code: 'KeyU', keyCode: 85 },
         VOL_DOWN: { code: 'KeyJ', keyCode: 74 },
         MUTE: { code: 'KeyM', keyCode: 77 },
+        PLAY: { code: 'KeyO', keyCode: 79 },
+        PAUSE: { code: 'KeyP', keyCode: 80 },
+        PLAYPAUSE: { code: 'Space', keyCode: 32 },
+        FF: { code: 'Period', keyCode: 190 },
+        REW: { code: 'Comma', keyCode: 188 },
+        STOP: { code: 'Escape', keyCode: 27 },
+        SUBTITLES: { code: 'KeyS', keyCode: 83 },
+        REC: { code: 'KeyI', keyCode: 73 },
     });
     return generateKeyCodeKeyMap();
 };

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

@@ -1,4 +1,11 @@
-import { DeviceBase, ScreenSaverStatus, VolumeRange } from '@24i/bigscreen-sdk/driver-base';
+import {
+    DeviceBase,
+    IAPPurchaseProductData,
+    IAPSuccessPayload,
+    ScreenSaverStatus,
+    VolumeRange,
+} from '@24i/bigscreen-sdk/driver-base';
+import { generateUuid } from '@24i/bigscreen-sdk/utils';
 import { getKeyMap } from './keymap';
 import { EntoneDeviceModelName } from './constants';
 import { IEntone, NetworkEvent } from './IEntone';
@@ -120,6 +127,17 @@ export class DeviceEntone extends DeviceBase {
         return '';
     }
 
+    async getAdInfo() {
+        const adId = generateUuid();
+        const type = 'sessionid';
+        const latEnabled = null;
+        return { adId, type, latEnabled };
+    }
+
+    async getOsLanguage() {
+        return (window.navigator.language || '').slice(0, 2);
+    }
+
     async getVolume() {
         try {
             const { leftVolPercentage, rightVolPercentage } = ENTONE.stb.getAudioVolume();
@@ -229,4 +247,16 @@ export class DeviceEntone extends DeviceBase {
         }
         return macAddress || '';
     }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async purchaseProduct(data: IAPPurchaseProductData): Promise<IAPSuccessPayload> {
+        // not supported
+        throw new Error('Not supported');
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async cancelSubscription(data: IAPPurchaseProductData): Promise<void> {
+        // not supported
+        throw new Error('Not supported');
+    }
 }

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

@@ -51,6 +51,7 @@ export function getKeyMap() {
         EXIT: { keyCode: EntoneInput.KEY_EXIT },
         INFO: { keyCode: EntoneInput.KEY_INFO },
         GUIDE: { keyCode: EntoneInput.KEY_GUIDE },
+        SUBTITLES: { keyCode: EntoneInput.KEY_SUBTITLE },
     });
     return KeyMap.generateKeyCodeKeyMap();
 }

package/packages/driver-firetv/src/DeviceFireTV.ts

@@ -0,0 +1,86 @@
+import {
+    DeviceAndroidTV,
+    IAPErrorEvent,
+    IAPSuccessEvent,
+} from '@24i/bigscreen-sdk/driver-androidtv';
+import {
+    IAPSuccessPayload, IAPPromiseReject, IAPPromiseResolve,
+    IAPPurchaseProductData,
+} from '@24i/bigscreen-sdk/driver-base';
+import { VendorType } from '@24i/smartapps-datalayer/api';
+import { Receipt } from './types';
+
+/**
+ * Fire TV driver implementing API of Android TV Bridge.
+ *
+ * See https://github.com/24i/prd-smart-ott-androidtv
+ */
+export class DeviceFireTV extends DeviceAndroidTV {
+    async getPlatformName(): Promise<string> {
+        return 'FireTV';
+    }
+
+    async getDeviceName(): Promise<string> {
+        const modelName = await this.getModelName();
+        const manufacturerName = await this.getManufacturerName();
+        return `FireTV ${manufacturerName} ${modelName}`.trim();
+    }
+
+    async getAdInfo() {
+        let adId = null;
+        let latEnabled = null;
+        const type = 'afai';
+        try {
+            adId = window.JavaScriptBridge.bridgeJavaScriptToAndroid_GetAdId() ?? null;
+            latEnabled = window.JavaScriptBridge.bridgeJavaScriptToAndroid_GetLimitAdTracking()
+                ?? true;
+        } catch (e) {
+            latEnabled = true;
+            console.error('[DeviceFireTV] Failed to getAdInfo', e);
+        }
+        return { adId, type, latEnabled };
+    }
+
+    onIAPSuccess = (resolve: IAPPromiseResolve, reject: IAPPromiseReject) => (event: unknown) => {
+        this.removeIAPListeners(resolve, reject);
+        try {
+            const { userId, receipt: receiptToParse } = event as IAPSuccessEvent;
+            const receipt: Receipt = JSON.parse(receiptToParse);
+            window.JavaScriptBridge
+                .bridgeReceiptAmazonIAPValidated(receipt.receiptId);
+            resolve({
+                platform: VendorType.AMAZON,
+                receiptPayload: {
+                    userId,
+                    receiptId: receipt.receiptId,
+                },
+            });
+        } catch (e) {
+            reject(e);
+        }
+    };
+
+    onIAPError = (resolve: IAPPromiseResolve, reject: IAPPromiseReject) => (event: unknown) => {
+        this.removeIAPListeners(resolve, reject);
+        reject(new Error((event as IAPErrorEvent).message));
+    };
+
+    removeIAPListeners(resolve: IAPPromiseResolve, reject: IAPPromiseReject) {
+        document.removeEventListener('iapSuccess', this.onIAPSuccess(resolve, reject));
+        document.removeEventListener('iapError', this.onIAPError(resolve, reject));
+    }
+
+    async purchaseProduct(data: IAPPurchaseProductData): Promise<IAPSuccessPayload> {
+        return new Promise((resolve, reject) => {
+            document.addEventListener('iapSuccess', this.onIAPSuccess(resolve, reject));
+            document.addEventListener('iapError', this.onIAPError(resolve, reject));
+            window.JavaScriptBridge.bridgeReceiptAmazonIAPValidation(data.sku);
+        });
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async cancelSubscription(data: IAPPurchaseProductData): Promise<void> {
+        // not supported
+        throw new Error('Not supported');
+    }
+}

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

@@ -0,0 +1,45 @@
+import { IJavaScriptBridge } from '../../../driver-androidtv/src/types';
+
+export const mockJavaScriptBridge: IJavaScriptBridge = {
+    JavaScriptBridge: {
+        bridgeJavaScriptToAndroid_GetDeviceInfo: () => (
+            JSON.stringify({
+                deviceBrand: 'Amazon',
+                deviceModel: 'AFTR',
+                osVersion: '8.0.0',
+                appVersion: '0.0.1',
+                appFlavor: 'appstage-bigscreen',
+                drmKeySystems: '["W3C Clear Key", "Google Widevine"]',
+                ipLocal: '127.0.0.1',
+            })
+        ),
+        bridgeJavaScriptToAndroid_GetAdId: () => 'afai-id',
+        bridgeJavaScriptToAndroid_GetLimitAdTracking: () => false,
+        bridgeJavaScriptToAndroid_GetOsLanguage: () => '',
+        bridgeJavaScriptToAndroid_GetMediaInfo: () => '{}',
+        bridgeJavaScriptToAndroid_Back: () => {},
+        bridgeJavaScriptToAndroid_ReloadPlayer: () => {},
+        bridgeJavaScriptToAndroid_StopVideo: () => {},
+        bridgeJavaScriptToAndroid_FullScreenVideo: () => {},
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        bridgeJavaScriptToAndroid_SetVideoPath: (url: string) => {},
+        bridgeJavaScriptToAndroid_IsPlaying: () => true,
+        bridgeJavaScriptToAndroid_PauseVideo: () => {},
+        bridgeJavaScriptToAndroid_PlayVideo: () => {},
+        bridgeJavaScriptToAndroid_IsLive: () => false,
+        bridgeJavaScriptToAndroid_GetCurrentTime: () => Date.now(),
+        bridgeJavaScriptToAndroid_GetTotalTime: () => Date.now(),
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        bridgeJavaScriptToAndroid_SeekTo: (milliseconds: number) => {},
+        bridgeJavaScriptToAndroid_getCurrentSubtitleTrack: () => '{}',
+        bridgeJavaScriptToAndroid_getCurrentAudioTrack: () => '{}',
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        bridgeJavaScriptToAndroid_SetTrack: (track: string) => {},
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        bridgeJavaScriptToAndroid_SetAudioTrack: (track: string) => {},
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        bridgeReceiptAmazonIAPValidation: (sku: string) => {},
+        // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        bridgeReceiptAmazonIAPValidated: (receiptId: string) => {},
+    },
+};

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

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

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

@@ -0,0 +1 @@
+export type Receipt = object & { receiptId: string };

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

@@ -1,6 +1,9 @@
 import {
     DeviceBase, ConnectionType, ScreenSaverStatus, loadObject, VolumeRange,
+    IAPSuccessPayload,
+    IAPPurchaseProductData,
 } from '@24i/bigscreen-sdk/driver-base';
+import { generateUuid } from '@24i/bigscreen-sdk/utils';
 import { getKeyMap } from './keymap';
 import { getVersion } from './getVersion';
 import { getDeviceInfo } from './deviceInfo';
@@ -245,6 +248,17 @@ export class DeviceHbbTV extends DeviceBase {
         return this.getBaseUuid();
     }
 
+    async getAdInfo() {
+        const adId = generateUuid();
+        const type = 'sessionid';
+        const latEnabled = null;
+        return { adId, type, latEnabled };
+    }
+
+    async getOsLanguage() {
+        return (window.navigator.language || '').slice(0, 2);
+    }
+
     async getVolume() {
         // TODO: not yet implemented
         return VolumeRange.UNSUPPORTED;
@@ -310,4 +324,16 @@ export class DeviceHbbTV extends DeviceBase {
             console.warn('[HbbTV] Broadcast tune failed');
         }
     }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async purchaseProduct(data: IAPPurchaseProductData): Promise<IAPSuccessPayload> {
+        // not supported
+        throw new Error('Not supported');
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async cancelSubscription(data: IAPPurchaseProductData): Promise<void> {
+        // not supported
+        throw new Error('Not supported');
+    }
 }

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

@@ -3,7 +3,10 @@ import {
     ConnectionType,
     ScreenSaverStatus,
     VolumeRange,
+    IAPSuccessPayload,
+    IAPPurchaseProductData,
 } from '@24i/bigscreen-sdk/driver-base';
+import { generateUuid } from '@24i/bigscreen-sdk/utils';
 import { getKeyMap } from './keymap';
 import { toi2 } from './toi2';
 import { toi3 } from './toi3';
@@ -159,6 +162,17 @@ export class DeviceKreaTV extends DeviceBase {
         return '';
     }
 
+    async getAdInfo() {
+        const adId = generateUuid();
+        const type = 'sessionid';
+        const latEnabled = null;
+        return { adId, type, latEnabled };
+    }
+
+    async getOsLanguage() {
+        return (window.navigator.language || '').slice(0, 2);
+    }
+
     getSupportedAudioConnections() {
         const { audioOutputService } = this.toiInstance;
         const { ToiAudioOutputService } = this.toiInstance.consts;
@@ -268,4 +282,16 @@ export class DeviceKreaTV extends DeviceBase {
     async getMacAddress(): Promise<string> {
         return this.toiResolver.getMacAddress();
     }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async purchaseProduct(data: IAPPurchaseProductData): Promise<IAPSuccessPayload> {
+        // not supported
+        throw new Error('Not supported');
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async cancelSubscription(data: IAPPurchaseProductData): Promise<void> {
+        // not supported
+        throw new Error('Not supported');
+    }
 }

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

@@ -3,7 +3,10 @@ import {
     ConnectionType,
     ScreenSaverStatus,
     VolumeRange,
+    IAPSuccessPayload,
+    IAPPurchaseProductData,
 } from '@24i/bigscreen-sdk/driver-base';
+import { generateUuid } from '@24i/bigscreen-sdk/utils';
 import { getDeviceInfo, getFirmware, getPlatformInfo } from './formatUserAgent';
 import { ISmartTvAApi } from './types';
 import { getKeyMap } from './keymap';
@@ -81,6 +84,17 @@ export class DeviceSaphi extends DeviceBase {
         return this.getBaseUuid();
     }
 
+    async getAdInfo() {
+        const adId = generateUuid();
+        const type = 'sessionid';
+        const latEnabled = null;
+        return { adId, type, latEnabled };
+    }
+
+    async getOsLanguage() {
+        return (window.navigator.language || '').slice(0, 2);
+    }
+
     async getVolume(): Promise<number> {
         return VolumeRange.UNSUPPORTED;
     }
@@ -141,4 +155,16 @@ export class DeviceSaphi extends DeviceBase {
         // not supported on Saphi platform
         return '';
     }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async purchaseProduct(data: IAPPurchaseProductData): Promise<IAPSuccessPayload> {
+        // not supported
+        throw new Error('Not supported');
+    }
+
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    async cancelSubscription(data: IAPPurchaseProductData): Promise<void> {
+        // not supported
+        throw new Error('Not supported');
+    }
 }