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

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@24i/bigscreen-sdk",
-    "version": "1.0.51",
+    "version": "1.0.53-alpha.2837",
     "description": "SmartApps BIGscreen SDK monorepo",
     "main": "index.js",
     "scripts": {
@@ -38,11 +38,11 @@
     },
     "homepage": "https://github.com/24i/smartapps-bigscreen-sdk#readme",
     "dependencies": {
-        "@24i/appstage-shared-analytics": "1.0.22",
+        "@24i/appstage-shared-analytics": "1.0.24",
         "@24i/appstage-shared-events-manager": "1.0.11",
         "@24i/appstage-shared-perf-utils": "1.0.11",
         "@24i/bigscreen-players-engine-base": "4.1.0",
-        "@24i/smartapps-datalayer": "3.0.21",
+        "@24i/smartapps-datalayer": "3.0.24",
         "@sentry/browser": "7.35.0",
         "@sentry/types": "7.35.0",
         "csstype": "^3.1.3",
@@ -193,6 +193,7 @@
         "./l10n": "./packages/l10n/src/index.ts",
         "./list/AttachDetachItem": "./packages/list/AttachDetachItem/index.ts",
         "./list/Basic": "./packages/list/BasicList/index.ts",
+        "./list/Double": "./packages/list/DoubleList/index.ts",
         "./list/Basic/static": "./packages/list/BasicList/static.ts",
         "./list/Centered": "./packages/list/CenteredList/index.ts",
         "./list/Centered/static": "./packages/list/CenteredList/static.ts",

package/packages/analytics/src/clients/GoogleAnalytics/constants.ts

@@ -31,8 +31,12 @@ export const GOOGLE_ANALYTICS_TRIGGERS = [
     AnalyticsTriggers.SEARCH,
     AnalyticsTriggers.RATE_CONTENT,
     // ads triggers
-    AnalyticsTriggers.AD_LOADED,
+    AnalyticsTriggers.AD_BUFFERING,
+    AnalyticsTriggers.AD_COMPLETE,
+    AnalyticsTriggers.AD_ERROR,
     AnalyticsTriggers.AD_SKIPPED,
+    AnalyticsTriggers.AD_START,
+    AnalyticsTriggers.AD_STOP,
     // user triggers
     AnalyticsTriggers.LOGIN,
     AnalyticsTriggers.LOGOUT,
@@ -87,8 +91,12 @@ export const TRIGGER_NAME_TO_GA_EVENTS: Record<
     [AnalyticsTriggers.RATE_CONTENT]: ['rate_content'],
 
     // ads triggers
-    [AnalyticsTriggers.AD_LOADED]: ['ad_loaded'],
+    [AnalyticsTriggers.AD_BUFFERING]: ['ad_buffering'],
+    [AnalyticsTriggers.AD_COMPLETE]: ['ad_complete'],
+    [AnalyticsTriggers.AD_ERROR]: ['ad_error'],
     [AnalyticsTriggers.AD_SKIPPED]: ['ad_skipped'],
+    [AnalyticsTriggers.AD_START]: ['ad_start'],
+    [AnalyticsTriggers.AD_STOP]: ['ad_stop'],
 
     // user triggers
     [AnalyticsTriggers.LOGIN]: ['login'],

package/packages/analytics/src/clients/GoogleAnalytics/interface.ts

@@ -17,8 +17,12 @@ export type GAEventsNames = (
     | 'favorite_add' // When a user add asset to favorites
     | 'favorite_remove' // When a user remove asset froms favorites
     | 'user_engagement' // Periodically, while the app is in the foreground
-    | 'ad_loaded' // When advertisement has been loaded
+    | 'ad_buffering' // When advertisement is buffering
+    | 'ad_complete' // When advertisement has been completed
+    | 'ad_error' // When advertisement has an error
     | 'ad_skipped' // When user skipped current advertisement
+    | 'ad_start' // When advertisement has been started
+    | 'ad_stop' // When advertisement has been stopped
     | 'app_exception' // When application throws an error
     | 'rate_content' // When user rates an asset
 );

package/packages/analytics/src/clients/TwentyFourIQ/TwentyFourIQClient.ts

@@ -26,6 +26,7 @@ export class TwentyFourIQClient implements AnalyticsClient {
         deviceId: '',
         manufacturer: '',
         platform: '',
+        deviceModel: '',
     };
 
     sessionTimeout = createTimeout();
@@ -42,6 +43,7 @@ export class TwentyFourIQClient implements AnalyticsClient {
         this.constantPayload.deviceId = await device.getUuid();
         this.constantPayload.manufacturer = await device.getManufacturerName();
         this.constantPayload.platform = await device.getPlatformName();
+        this.constantPayload.deviceModel = await device.getModelName();
         this.constantPayload.appVersion = this.appVersion;
         await this.startSession();
     }

package/packages/analytics/src/clients/TwentyFourIQ/constants.ts

@@ -54,8 +54,12 @@ export const TWENTY_FOUR_IQ_TRIGGERS = [
     AnalyticsTriggers.SCROLL_90,
 
     // Ads
-    AnalyticsTriggers.AD_LOADED,
+    AnalyticsTriggers.AD_BUFFERING,
+    AnalyticsTriggers.AD_COMPLETE,
+    AnalyticsTriggers.AD_ERROR,
     AnalyticsTriggers.AD_SKIPPED,
+    AnalyticsTriggers.AD_START,
+    AnalyticsTriggers.AD_STOP,
 ];
 
 export enum EVENTS {
@@ -69,8 +73,12 @@ export enum EVENTS {
     PLAYER_CLOSE = 'player_close',
     PLAYER_OPEN = 'player_open',
     SCROLL = 'scroll',
-    AD_LOADED = 'ad_loaded',
+    AD_BUFFERING = 'ad_buffering',
+    AD_COMPLETE = 'ad_complete',
+    AD_ERROR = 'ad_error',
     AD_SKIPPED = 'ad_skipped',
+    AD_START = 'ad_start',
+    AD_STOP = 'ad_stop',
 }
 
 export const TRIGGER_NAME_TO_24IQ_EVENTS: { [K in AnalyticsTriggers]?: EVENTS[]; } = {
@@ -92,9 +100,12 @@ export const TRIGGER_NAME_TO_24IQ_EVENTS: { [K in AnalyticsTriggers]?: EVENTS[];
     [AnalyticsTriggers.SCROLL_75]: [EVENTS.SCROLL],
     [AnalyticsTriggers.SCROLL_90]: [EVENTS.SCROLL],
     [AnalyticsTriggers.APP_CLOSE]: [EVENTS.VIDEO_STOP, EVENTS.PLAYER_CLOSE],
-    // VERSION 2 ?
-    [AnalyticsTriggers.AD_LOADED]: [EVENTS.AD_LOADED],
+    [AnalyticsTriggers.AD_BUFFERING]: [EVENTS.AD_BUFFERING],
+    [AnalyticsTriggers.AD_COMPLETE]: [EVENTS.AD_COMPLETE],
+    [AnalyticsTriggers.AD_ERROR]: [EVENTS.AD_ERROR],
     [AnalyticsTriggers.AD_SKIPPED]: [EVENTS.AD_SKIPPED],
+    [AnalyticsTriggers.AD_START]: [EVENTS.AD_START],
+    [AnalyticsTriggers.AD_STOP]: [EVENTS.AD_STOP],
 };
 
 export const HUNDRED_PERCENT = 100;

package/packages/analytics/src/clients/TwentyFourIQ/interface.ts

@@ -11,8 +11,7 @@ import { mapPlayerOpen } from './mappers/mapPlayerOpen';
 import { mapPlayerClose } from './mappers/mapPlayerClose';
 import { mapVideoStart } from './mappers/mapVideoStart';
 import { mapVideoPause } from './mappers/mapVideoPause';
-import { mapAdLoaded } from './mappers/mapAdLoaded';
-import { mapAdSkipped } from './mappers/mapAdSkipped';
+import { mapAdEvent } from './mappers/mapAdEvent';
 import { EventMappingFunction } from './types';
 
 export const EVENTS_MAPPING: Record<EVENTS, EventMappingFunction> = {
@@ -26,6 +25,10 @@ export const EVENTS_MAPPING: Record<EVENTS, EventMappingFunction> = {
     [EVENTS.VIDEO_PROGRESS]: mapVideoProgress,
     [EVENTS.VIDEO_COMPLETE]: mapVideoComplete,
     [EVENTS.VIDEO_PAUSE]: mapVideoPause,
-    [EVENTS.AD_LOADED]: mapAdLoaded,
-    [EVENTS.AD_SKIPPED]: mapAdSkipped,
+    [EVENTS.AD_BUFFERING]: mapAdEvent,
+    [EVENTS.AD_COMPLETE]: mapAdEvent,
+    [EVENTS.AD_ERROR]: mapAdEvent,
+    [EVENTS.AD_SKIPPED]: mapAdEvent,
+    [EVENTS.AD_START]: mapAdEvent,
+    [EVENTS.AD_STOP]: mapAdEvent,
 };

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapAdEvent.ts

@@ -0,0 +1,20 @@
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import { Payload, AdEventResult } from '../types';
+import { mapBase } from './mapBase';
+
+export const mapAdEvent = (
+    triggerName: AnalyticsTriggers,
+    payload: Payload,
+): AdEventResult => ({
+    ...mapBase(payload),
+    action: triggerName,
+    event_trigger: triggerName,
+    ad_id: payload.adId || '',
+    ad_name: payload.adName || '',
+    ad_position: payload.adType || '',
+    ad_playback_position: payload.adPosition || '',
+    ad_playback_duration: payload.adDuration || '',
+    thing_id: payload.assetId || '',
+    attribution_id: payload.attributionId || '',
+    custom_campaign_url: '',
+});

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapBase.ts

@@ -6,11 +6,13 @@ export const mapBase = (payload: Payload): BaseResult => {
     const timestampDate = time.getCurrentTime();
     const formattedTimestamp = getTimezoneOffsetString();
     return {
+        device_appversion: payload.appVersion || '',
         session_id: payload.sessionId.toString(),
         timestamp_initiated: formatDateTime(timestampDate),
         device_id: payload.deviceId,
         device_type: 'SmartTV',
         device_platform: payload.platform || '',
+        device_model: payload.deviceModel || '',
         device_manufacturer: payload.manufacturer || '',
         device_timezone: formattedTimestamp,
         service_id: payload.serviceId || '',

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapBuffering.ts

@@ -10,6 +10,6 @@ export const mapBuffering = (
     action: triggerName,
     event_trigger: triggerName,
     thing_id: payload.assetId || '',
-    attribution_id: payload.attributionId || null,
+    attribution_id: payload.attributionId || '',
     source_page: payload.sceneName,
 });

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapPlayerClose.ts

@@ -1,6 +1,6 @@
 import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
 import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import { EVENTS, HUNDRED_PERCENT } from '../constants';
+import { DefaultScreens, EVENTS, HUNDRED_PERCENT } from '../constants';
 import { PlayerCloseResult, Payload } from '../types';
 import { mapBase } from './mapBase';
 
@@ -16,8 +16,9 @@ export const mapPlayerClose = (
         ...mapBase(payload),
         action: EVENTS.PLAYER_CLOSE,
         event_trigger: triggerName,
+        source_page: DefaultScreens.PLAYBACK,
         thing_id: payload.assetId || '',
-        attribution_id: payload.attributionId || null,
+        attribution_id: payload.attributionId || '',
         duration,
         progress_pct: progressPercent,
     };

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapPlayerOpen.ts

@@ -12,6 +12,6 @@ export const mapPlayerOpen = (
     event_trigger: triggerName,
     source_page: DefaultScreens.PLAYBACK,
     thing_id: payload.assetId || '',
-    attribution_id: payload.attributionId || null,
+    attribution_id: payload.attributionId || '',
     source_rail: '', // TODO: payload.payload.asset.sectionLabel,
 });

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapSceneView.ts

@@ -11,5 +11,5 @@ export const mapSceneView = (
     event_trigger: triggerName,
     source_page: payload.sceneName,
     thing_id: payload.assetId || '',
-    attribution_id: payload.attributionId || null,
+    attribution_id: payload.attributionId || '',
 });

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapScroll.ts

@@ -11,7 +11,7 @@ export const mapScroll = (triggerName: AnalyticsTriggers, payload: Payload): Scr
         event_trigger: triggerName,
         source_page: payload.sceneName,
         thing_id: payload.assetId || '',
-        attribution_id: payload.attributionId || null,
+        attribution_id: payload.attributionId || '',
         percent_scrolled: percentScrolled,
     };
 };

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapVideoComplete.ts

@@ -1,6 +1,6 @@
 import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
 import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
-import { EVENTS } from '../constants';
+import { DefaultScreens, EVENTS } from '../constants';
 import { Payload, VideoCompleteResult } from '../types';
 import { mapBase } from './mapBase';
 
@@ -14,8 +14,9 @@ export const mapVideoComplete = (
         action: EVENTS.VIDEO_COMPLETE,
         event_trigger: triggerName,
         thing_id: payload.assetId || '',
-        attribution_id: payload.attributionId || null,
+        attribution_id: payload.attributionId || '',
         progress_pct: 90,
         duration: assetDuration,
+        source_page: DefaultScreens.PLAYBACK,
     };
 };

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapVideoPause.ts

@@ -1,6 +1,6 @@
 import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
 import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
-import { EVENTS, HUNDRED_PERCENT } from '../constants';
+import { DefaultScreens, EVENTS, HUNDRED_PERCENT } from '../constants';
 import { VideoPauseResult, Payload } from '../types';
 import { mapBase } from './mapBase';
 
@@ -17,8 +17,9 @@ export const mapVideoPause = (
         action: EVENTS.VIDEO_PAUSE,
         event_trigger: triggerName,
         thing_id: payload.assetId || '',
-        attribution_id: payload.attributionId || null,
+        attribution_id: payload.attributionId || '',
         duration: overallDuration,
         progress_pct: progressPercent,
+        source_page: DefaultScreens.PLAYBACK,
     };
 };

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapVideoProgress.ts

@@ -1,7 +1,7 @@
 import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
 import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
 import { Payload, VideoProgressResult } from '../types';
-import { EVENTS, HUNDRED_PERCENT } from '../constants';
+import { DefaultScreens, EVENTS, HUNDRED_PERCENT } from '../constants';
 import { mapBase } from './mapBase';
 
 export const mapVideoProgress = (
@@ -17,8 +17,9 @@ export const mapVideoProgress = (
         action: EVENTS.VIDEO_PROGRESS,
         event_trigger: triggerName,
         thing_id: payload.assetId || '',
-        attribution_id: payload.attributionId || null,
+        attribution_id: payload.attributionId || '',
         progress_pct: progressPercent,
         duration: durationInSeconds,
+        source_page: DefaultScreens.PLAYBACK,
     };
 };

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapVideoStart.ts

@@ -25,7 +25,7 @@ export const mapVideoStart = (
         action: EVENTS.VIDEO_START,
         event_trigger: triggerName,
         thing_id: payload.assetId || '',
-        attribution_id: payload.attributionId || null,
+        attribution_id: payload.attributionId || '',
         duration: assetDuration,
         progress_pct: progressPercent,
         source_page: DefaultScreens.PLAYBACK,

package/packages/analytics/src/clients/TwentyFourIQ/mappers/mapVideoStop.ts

@@ -23,7 +23,7 @@ export const mapVideoStop = (
         action: EVENTS.VIDEO_STOP,
         event_trigger: triggerName,
         thing_id: payload.assetId || '',
-        attribution_id: payload.attributionId || null,
+        attribution_id: payload.attributionId || '',
         progress_pct: progressPercent,
         duration,
         source_page: DefaultScreens.PLAYBACK,

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

@@ -1,6 +1,6 @@
 import { Asset } from '@24i/smartapps-datalayer/models';
 import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
-import type { AnyPayload, UserInfo, AppInfo } from '../../interface';
+import type { AnyPayload, UserInfo, AppInfo, AdType } from '../../interface';
 
 interface ScreenParams {
     screen: string;
@@ -29,6 +29,7 @@ export interface DeviceInfo {
     manufacturer: string,
     platform: string,
     deviceId: string,
+    deviceModel: string,
 }
 
 export interface SceneInfo {
@@ -37,7 +38,21 @@ export interface SceneInfo {
     sceneType?: string,
 }
 
-export type Payload = CorePayload & SceneInfo & SessionInfo & UserInfo & DeviceInfo & AppInfo;
+export interface AdInfo {
+    adId: string;
+    adName: string;
+    adType: AdType;
+    adDuration: string;
+    adPosition: string;
+}
+
+export type Payload = CorePayload
+& SceneInfo
+& SessionInfo
+& UserInfo
+& DeviceInfo
+& AppInfo
+& AdInfo;
 
 export type EventBody = AnyPayload;
 
@@ -47,12 +62,14 @@ export type EventMappingFunction = (
 ) => AnyPayload | void;
 
 export type BaseResult = {
+    device_appversion: string,
     session_id: string;
     timestamp_initiated: string;
     device_id: string;
     device_type: string;
     device_platform: string;
     device_manufacturer: string;
+    device_model: string;
     device_timezone: string;
     service_id: string;
     user_id?: string;
@@ -67,57 +84,49 @@ export type CoreResult = BaseResult & {
 export type SceneViewResult = CoreResult & {
     source_page: string;
     thing_id: string;
-    attribution_id: string | null;
+    attribution_id: string;
 };
 export type BufferingResult = SceneViewResult;
 
 export type ScrollResult = SceneViewResult & {
     percent_scrolled: string;
 };
-export type VideoProgressResult = CoreResult & {
-    thing_id: string;
-    attribution_id: string | null;
-    progress_pct: number;
-    duration: number;
-};
-
 export type PlayerOpenResult = CoreResult & {
     thing_id: string;
-    attribution_id: string | null;
+    attribution_id: string;
     source_page: string;
     source_rail?: string | null;
 };
 
-export type VideoStartResult = CoreResult & {
+export type VideoBaseResult = CoreResult & {
     thing_id: string;
-    attribution_id: string | null;
+    attribution_id: string;
     duration: number;
     progress_pct: number;
     source_page: string;
-    source_rail?: string | null;
 };
 
-export type VideoPauseResult = CoreResult & {
-    thing_id: string;
-    attribution_id: string | null;
-    duration: number;
-    progress_pct: number;
+export type VideoStartResult = VideoBaseResult & {
+    source_rail?: string | null;
 };
 
-export type AdLoadedResult = CoreResult & {
-    thing_id: string;
-    attribution_id: string | null;
-    player_advertisment_name: string;
-    player_advertisment_position: number;
-};
+export type VideoPauseResult = VideoBaseResult;
+
+export type VideoStopResult = VideoStartResult;
 
-export type AdSkippedResult = CoreResult & {
+export type VideoProgressResult = VideoBaseResult;
+
+export type VideoCompleteResult = VideoBaseResult;
+
+export type PlayerCloseResult = VideoBaseResult;
+
+export type AdEventResult = CoreResult & {
+    ad_id: string;
+    ad_name: string;
+    ad_position: AdType;
+    ad_playback_position: string;
+    ad_playback_duration: string;
     thing_id: string;
-    attribution_id: string | null;
-    player_advertisment_name: string;
-    player_advertisment_position: number;
+    attribution_id: string;
+    custom_campaign_url: string;
 };
-
-export type VideoCompleteResult = VideoPauseResult;
-export type VideoStopResult = VideoStartResult;
-export type PlayerCloseResult = VideoPauseResult;

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

@@ -3,6 +3,8 @@ import {
     ConnectionType,
     ScreenSaverStatus,
     VolumeRange,
+    IAPSuccessPayload,
+    IAPPurchaseProductData,
 } from '@24i/bigscreen-sdk/driver-base';
 import { IJavaScriptBridge, DeviceInfo } from './types';
 import { getFirmware } from './formatUserAgent';
@@ -245,4 +247,16 @@ export class DeviceAndroidTV extends DeviceBase {
         // not supported on AndroidTV 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-androidtv/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-androidtv/src/index.ts

@@ -1 +1,2 @@
 export { DeviceAndroidTV } from './DeviceAndroidTV';
+export type { IAPErrorEvent, IAPSuccessEvent } from './types';

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

@@ -31,6 +31,10 @@ interface JavaScriptBridge {
      * It simulates a native Android back press.
      */
     bridgeJavaScriptToAndroid_Back: () => void,
+    /**
+     * It reloads the video player
+     */
+    bridgeJavaScriptToAndroid_ReloadPlayer: () => void;
     /**
      * It simulates a native Android stop button press.
      */
@@ -87,6 +91,14 @@ interface JavaScriptBridge {
      * It sets audio track to be used.
      */
     bridgeJavaScriptToAndroid_SetAudioTrack: (track: string) => void;
+    /**
+     * It launch in app purchase.
+     */
+    bridgeReceiptAmazonIAPValidation: (sku: string) => void;
+    /**
+     * It validate purchase.
+     */
+    bridgeReceiptAmazonIAPValidated: (receiptId: string) => void;
 }
 
 export type DeviceInfo = {
@@ -131,3 +143,13 @@ export type DeviceInfo = {
 export interface IJavaScriptBridge {
     JavaScriptBridge: JavaScriptBridge,
 }
+
+export type IAPSuccessEvent = {
+    userId: string;
+    receipt: string;
+    sku: string;
+};
+
+export type IAPErrorEvent = {
+    message: string;
+};

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

@@ -10,6 +10,11 @@ import { KeycodeKeyMap } from './types/KeycodeKeyMap';
 import { DeviceEventMap } from './types/DeviceEvent';
 import { AdInfo } from './types/AdInfo';
 import { ScreenSaverStatus } from './types/ScreenSaverStatus';
+import {
+    SubscriptionFeaturesConfiguration,
+    IAPPurchaseProductData,
+    IAPSuccessPayload,
+} from './types/InAppPurchase';
 import { ExitOptions } from './types/ExitOptions';
 import { inRange } from './utils';
 import { ErrorTemplate } from './errors';
@@ -56,6 +61,11 @@ export abstract class DeviceBase<
 
     isOffline: boolean = false;
 
+    subscriptionFeaturesConfiguration: SubscriptionFeaturesConfiguration = {
+        purchase: false,
+        management: false,
+    };
+
     // MARK: Initialization
 
     /**
@@ -179,6 +189,10 @@ export abstract class DeviceBase<
 
     abstract getMacAddress(): Promise<string>;
 
+    abstract purchaseProduct(data: IAPPurchaseProductData): Promise<IAPSuccessPayload>;
+
+    abstract cancelSubscription(data: IAPPurchaseProductData): Promise<void>;
+
     // MARK: Private functions
 
     private bindPreventDefaultEvents(rootElement: HTMLElement) {

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;
@@ -108,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/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/InAppPurchase.ts

@@ -0,0 +1,25 @@
+import { Product } from '@24i/smartapps-datalayer/models';
+import { VendorType } from '@24i/smartapps-datalayer/src/api';
+
+export type SubscriptionFeaturesConfiguration = {
+    purchase: boolean,
+    management: boolean,
+};
+
+export type IAPSuccessPayload = {
+    platform: VendorType,
+    receiptPayload: object
+};
+
+export type IAPPurchaseProductData = Partial<{
+    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;