@24i/bigscreen-sdk 1.0.51 → 1.0.53-alpha.2837

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

@@ -1,5 +1,7 @@
 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';
@@ -179,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-entone/src/DeviceEntone.ts

@@ -1,4 +1,10 @@
-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';
@@ -241,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-firetv/src/DeviceFireTV.ts

@@ -1,4 +1,14 @@
-import { DeviceAndroidTV } from '@24i/bigscreen-sdk/driver-androidtv';
+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.
@@ -6,6 +16,11 @@ import { DeviceAndroidTV } from '@24i/bigscreen-sdk/driver-androidtv';
  * See https://github.com/24i/prd-smart-ott-androidtv
  */
 export class DeviceFireTV extends DeviceAndroidTV {
+    subscriptionFeaturesConfiguration = {
+        purchase: true,
+        management: false,
+    };
+
     async getPlatformName(): Promise<string> {
         return 'FireTV';
     }
@@ -30,4 +45,47 @@ export class DeviceFireTV extends DeviceAndroidTV {
         }
         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

@@ -18,6 +18,7 @@ export const mockJavaScriptBridge: IJavaScriptBridge = {
         bridgeJavaScriptToAndroid_GetOsLanguage: () => '',
         bridgeJavaScriptToAndroid_GetMediaInfo: () => '{}',
         bridgeJavaScriptToAndroid_Back: () => {},
+        bridgeJavaScriptToAndroid_ReloadPlayer: () => {},
         bridgeJavaScriptToAndroid_StopVideo: () => {},
         bridgeJavaScriptToAndroid_FullScreenVideo: () => {},
         // eslint-disable-next-line @typescript-eslint/no-unused-vars
@@ -36,5 +37,9 @@ export const mockJavaScriptBridge: IJavaScriptBridge = {
         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/types.ts

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

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

@@ -1,5 +1,7 @@
 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';
@@ -322,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,6 +3,8 @@ import {
     ConnectionType,
     ScreenSaverStatus,
     VolumeRange,
+    IAPSuccessPayload,
+    IAPPurchaseProductData,
 } from '@24i/bigscreen-sdk/driver-base';
 import { generateUuid } from '@24i/bigscreen-sdk/utils';
 import { getKeyMap } from './keymap';
@@ -280,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,6 +3,8 @@ 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';
@@ -153,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');
+    }
 }

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

@@ -1,8 +1,11 @@
 import {
     DeviceBase, ConnectionType, ScreenSaverStatus, VolumeRange,
+    IAPSuccessPayload,
+    IAPPurchaseProductData,
 } from '@24i/bigscreen-sdk/driver-base';
 import { runAsync } from '@24i/bigscreen-sdk/utils/timers';
 import { ipify } from '@24i/bigscreen-sdk/ipify';
+import { VendorType } from '@24i/smartapps-datalayer/api';
 import { getKeyMap } from './keymap';
 import {
     ISmartCastApi,
@@ -10,6 +13,7 @@ import {
     DEFAULT_TTS_TIMEOUT,
     DevicePlaybackQuality,
     DeviceLanguage,
+    PurchaseData,
 } from './types';
 
 declare const window: Window & { VIZIO: ISmartCastApi };
@@ -48,6 +52,7 @@ export class DeviceSmartCast extends DeviceBase {
         this.initVisibilityChangeListener();
         this.initMouseActiveListener();
         await this.initPlatformApiListeners();
+        this.setSubscriptionFeaturesConfiguration();
     }
 
     async initPlatformApiListeners(): Promise<void> {
@@ -244,6 +249,12 @@ export class DeviceSmartCast extends DeviceBase {
             .replace('{{us_privacy}}', IFAObject.LMT ? '1YYN' : '1YNN');
     }
 
+    async getUserMetadata() {
+        await this.checkAndLinkTv();
+        const result = await this.API!.Account.getUserMetadata();
+        return result?.data || null;
+    }
+
     async getManufacturerName() {
         return 'VIZIO';
     }
@@ -342,4 +353,42 @@ export class DeviceSmartCast extends DeviceBase {
         // not supported on SmartCast platform
         return '';
     }
+
+    setSubscriptionFeaturesConfiguration() {
+        try {
+            this.subscriptionFeaturesConfiguration.purchase = this.API?.Account.isSVODEnabled?.()
+                || false;
+        } catch {}
+    }
+
+    registerPartner(callback: (challenge: string) => Promise<string>, appKeyId: string) {
+        this.API!.Account.registerPartner(callback, appKeyId);
+    }
+
+    async checkAndLinkTv() {
+        const isLinked = await this.API!.Account.getLinkStatus();
+        if (!isLinked) await this.API!.Account.startTVLink();
+    }
+
+    async purchaseProduct({ sku, serviceId }: IAPPurchaseProductData): Promise<IAPSuccessPayload> {
+        await this.checkAndLinkTv();
+        await this.API!.Account.getPlans({ includeBundlePlans: true });
+        const purchaseResult = await this.API!.Account.startSVODPurchase(
+            sku!, serviceId ?? '',
+        );
+        const receiptPayload: PurchaseData = {
+            customerId: purchaseResult.data.customerId,
+            partnerAccountId: purchaseResult.data.partnerAccountId,
+            planCode: purchaseResult.data.planCode,
+            addOnCodes: purchaseResult.data.addOnCodes,
+            subscriptionId: purchaseResult.data.subscriptionId,
+        };
+        return { platform: VendorType.VIZIO, receiptPayload };
+    }
+
+    // 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-smartcast/src/__mocks__/api.ts

@@ -50,4 +50,30 @@ export const SmartCastMockApi: ISmartCastApi = {
             console.log(text);
         },
     },
+
+    Account: {
+        isSVODEnabled: () => true,
+        startSVODPurchase: async () => ({
+            id: 'id',
+            data: {
+                customerId: 'customerId',
+                partnerAccountId: 'partnerAccountId',
+                planCode: 'planCode',
+                subscriptionId: 'subscriptionId',
+            },
+        }),
+        registerPartner: jest.fn(),
+        getLinkStatus: async () => true,
+        getUserMetadata: async () => ({
+            id: 'id',
+            data: {
+                customerId: 'customerId',
+                email: 'email@example.com',
+                firstName: 'First',
+                lastName: 'Last',
+            },
+        }),
+        startTVLink: async () => ({}),
+        getPlans: async () => ({ id: 'id', data: [] }),
+    },
 };

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

@@ -39,6 +39,24 @@ export type ISmartCastApi = {
      */
     setDeviceLanguageHandler: (callback: (deviceLanguage: DeviceLanguage) => void) => void;
 
+    Account: {
+        isSVODEnabled: () => boolean,
+        startSVODPurchase: (
+            planCode: string,
+            partnerAccountId: string,
+            couponCode?: string,
+            addOnCodes?: string[],
+            noFreeTrial?: boolean,
+        ) => Promise<{ id: string, data: PurchaseData }>
+        registerPartner: (callback:(challenge: string) => Promise<string>, keyId: string) => void
+        getLinkStatus: () => Promise<boolean>
+        getUserMetadata: () => Promise<{ id: string, data: UserMetadata }>
+        startTVLink: () => Promise<object>
+        getPlans: (options: { includeBundlePlans?: boolean }) => Promise<{
+            id: string, data: object[]
+        }>
+    }
+
     /**
      * Device model.
      */
@@ -52,6 +70,24 @@ export type ISmartCastApi = {
         play: (text: string) => void,
     };
 };
+/**
+ *  Data type when purchase successfull.
+ */
+
+export type PurchaseData = {
+    customerId: string,
+    partnerAccountId: string,
+    planCode: string,
+    addOnCodes?: string[],
+    subscriptionId: string
+};
+
+export type UserMetadata = {
+    customerId: string;
+    email: string;
+    firstName: string;
+    lastName: string;
+};
 
 /**
  * Identifier For Advertising (IFA) and Limited Tracking parameter object

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

@@ -4,20 +4,29 @@ import {
     ScreenSaverStatus,
     VolumeRange,
     ExitOptions,
+    IAPSuccessPayload,
+    IAPPurchaseProductData,
 } from '@24i/bigscreen-sdk/driver-base';
 import { Storage } from '@24i/bigscreen-sdk/storage';
 import { runAsync } from '@24i/bigscreen-sdk/utils/timers';
-import { TizenKeys } from './TizenKeys';
+import { VendorType } from '@24i/smartapps-datalayer/api';
 import {
-    VENDOR,
+    type Webapis,
+    BillingBuyData,
     NetworkState,
     NetworkActiveConnectionType,
     AppCommonScreenSaverState,
+    CancelSubscriptionData,
+    CancelSubscriptionAPIResult,
+} from './IWebapis';
+import { Tizen, Application } from './ITizen';
+import { TizenKeys } from './TizenKeys';
+import {
+    VENDOR,
 } from './constants';
-import { IWebapis, ITizen, TizenApplication } from './types';
 
-declare const webapis: IWebapis;
-declare const tizen: ITizen;
+declare const webapis: Webapis;
+declare const tizen: Tizen;
 
 const isNetworkConnected = (state: NetworkState) => {
     switch (state) {
@@ -36,7 +45,7 @@ const isNetworkConnected = (state: NetworkState) => {
 export class DeviceTizen extends DeviceBase {
     // MARK: Properties
 
-    application: TizenApplication = tizen.application.getCurrentApplication();
+    application: Application = tizen.application.getCurrentApplication();
 
     keys: TizenKeys = new TizenKeys();
 
@@ -46,6 +55,11 @@ export class DeviceTizen extends DeviceBase {
 
     screenSaverStatus: AppCommonScreenSaverState = AppCommonScreenSaverState.SCREEN_SAVER_OFF;
 
+    subscriptionFeaturesConfiguration = {
+        purchase: true,
+        management: true,
+    };
+
     // MARK: Initialization
 
     async initDevice(): Promise<void> {
@@ -270,7 +284,7 @@ export class DeviceTizen extends DeviceBase {
             ? AppCommonScreenSaverState.SCREEN_SAVER_ON
             : AppCommonScreenSaverState.SCREEN_SAVER_OFF;
         return new Promise((resolve) => {
-            webapis.appCommon.setScreenSaver(
+            webapis.appcommon.setScreenSaver(
                 status,
                 () => {
                     this.screenSaverStatus = status;
@@ -319,4 +333,85 @@ export class DeviceTizen extends DeviceBase {
     async getMacAddress() {
         return webapis.network.getMac();
     }
+
+    async purchaseProduct({
+        sku, product, appId,
+    }: IAPPurchaseProductData): Promise<IAPSuccessPayload> {
+        return new Promise((resolve, reject) => {
+            if (!product || !appId) reject(new Error('Missing product or appId'));
+            const paymentDetails = {
+                OrderItemID: sku,
+                OrderTitle: product!.title,
+                OrderTotal: product!.price![0].amount,
+                OrderCurrencyID: product!.price![0].currency,
+                OrderCustomID: webapis.sso.getLoginUid(),
+            };
+            const onSuccess = (data: BillingBuyData) => {
+                try {
+                    if (data.payResult !== 'SUCCESS') throw new Error('Purchase failed');
+                    const countryCode = webapis.productinfo.getSystemConfig(
+                        webapis.productinfo.ProductInfoConfigKey.CONFIG_KEY_SERVICE_COUNTRY,
+                    );
+                    const detail = JSON.parse(data.payDetail);
+                    resolve({
+                        platform: VendorType.SAMSUNG,
+                        receiptPayload: {
+                            appId,
+                            samsungInvoiceId: detail.InvoiceID,
+                            samsungCustomId: paymentDetails.OrderCustomID,
+                            countryCode,
+                        },
+                    });
+                } catch (e) {
+                    reject(e);
+                }
+            };
+            webapis.billing.buyItem(
+                appId!, 'PRD', JSON.stringify(paymentDetails), onSuccess, reject,
+            );
+        });
+    }
+
+    async cancelSubscription(
+        { product, appId }: IAPPurchaseProductData,
+    ): Promise<void> {
+        return new Promise((resolve, reject) => {
+            if (!product || !appId) {
+                reject(new Error('Missing product or appId'));
+            }
+            const UID = webapis.sso.getLoginUid();
+            const countryCode = webapis.productinfo.getSystemConfig(
+                webapis.productinfo.ProductInfoConfigKey.CONFIG_KEY_SERVICE_COUNTRY,
+            );
+            try {
+                const vendorTransactionId = product?.vendorTransactionId;
+                if (!vendorTransactionId) {
+                    reject(new Error('Missing vendorTransactionId'));
+                }
+                const onSuccess = (data: CancelSubscriptionData) => {
+                    try {
+                        const result: CancelSubscriptionAPIResult = JSON.parse(data.apiResult);
+                        if (result.CPStatus === '100000') {
+                            resolve();
+                        } else {
+                            reject(new Error(`Cancel subscription failed: ${result.CPStatus}`));
+                        }
+                    } catch (e) {
+                        reject(e);
+                    }
+                };
+                webapis.billing.cancelSubscription(
+                    appId!,
+                    product!.vendorTransactionId!.toString(),
+                    UID,
+                    countryCode,
+                    'PRD',
+                    onSuccess,
+                    reject,
+                );
+            } catch (e) {
+                reject(e);
+            }
+        });
+    }
 }