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

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

@@ -0,0 +1,111 @@
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+
+export enum AnalyticsPrefix {
+    SCROLL = 'SCROLL_',
+    PLAYBACK = 'PLAYBACK_',
+}
+
+export enum AnalyticsEvents {
+    INSTALLED_APP = 'Installed app',
+    LOADED_APP = 'Loaded App',
+    LOGGED_IN = 'Logged In',
+    LOGGED_OUT = 'Logged Out',
+    CANCELLED_PURCHASE = 'Cancelled Purchase',
+    PURCHASE_COMPLETE = 'Purchase Complete',
+    HOME = 'home',
+    DETAILS = 'details',
+    PLAYER = 'player',
+    TECHNICAL_INFO = 'Technical information',
+}
+
+export enum DefaultScreens {
+    PLAYBACK = 'playback',
+}
+
+export const TWENTY_FOUR_IQ_TRIGGERS = [
+    // App
+    AnalyticsTriggers.APP_CLOSE,
+
+    // Scenes
+    AnalyticsTriggers.SCENE_VIEW,
+
+    // Data loading / Player buffering
+    AnalyticsTriggers.BUFFERING_START,
+    AnalyticsTriggers.BUFFERING_STOP,
+
+    // Playback
+    AnalyticsTriggers.PLAYBACK_10,
+    AnalyticsTriggers.PLAYBACK_25,
+    AnalyticsTriggers.PLAYBACK_50,
+    AnalyticsTriggers.PLAYBACK_75,
+    AnalyticsTriggers.PLAYBACK_90,
+    AnalyticsTriggers.PLAYBACK_PAUSE,
+    AnalyticsTriggers.PLAYBACK_START,
+    AnalyticsTriggers.PLAYBACK_STOP,
+
+    // Player
+    AnalyticsTriggers.PLAYER_CLOSE,
+    AnalyticsTriggers.PLAYER_OPEN,
+
+    // Scrolling in scene
+    AnalyticsTriggers.SCROLL_25,
+    AnalyticsTriggers.SCROLL_50,
+    AnalyticsTriggers.SCROLL_75,
+    AnalyticsTriggers.SCROLL_90,
+
+    // Ads
+    AnalyticsTriggers.AD_BUFFERING,
+    AnalyticsTriggers.AD_COMPLETE,
+    AnalyticsTriggers.AD_ERROR,
+    AnalyticsTriggers.AD_SKIPPED,
+    AnalyticsTriggers.AD_START,
+    AnalyticsTriggers.AD_STOP,
+];
+
+export enum EVENTS {
+    SCENE_VIEW = 'scene_view',
+    BUFFERING = 'buffering',
+    VIDEO_PROGRESS = 'video_progress',
+    VIDEO_START = 'video_start',
+    VIDEO_COMPLETE = 'video_complete',
+    VIDEO_STOP = 'video_stop',
+    VIDEO_PAUSE = 'video_pause',
+    PLAYER_CLOSE = 'player_close',
+    PLAYER_OPEN = 'player_open',
+    SCROLL = 'scroll',
+    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[]; } = {
+    [AnalyticsTriggers.SCENE_VIEW]: [EVENTS.SCENE_VIEW],
+    [AnalyticsTriggers.BUFFERING_START]: [EVENTS.BUFFERING],
+    [AnalyticsTriggers.BUFFERING_STOP]: [EVENTS.BUFFERING],
+    [AnalyticsTriggers.PLAYBACK_10]: [EVENTS.VIDEO_PROGRESS],
+    [AnalyticsTriggers.PLAYBACK_25]: [EVENTS.VIDEO_PROGRESS],
+    [AnalyticsTriggers.PLAYBACK_50]: [EVENTS.VIDEO_PROGRESS],
+    [AnalyticsTriggers.PLAYBACK_75]: [EVENTS.VIDEO_PROGRESS],
+    [AnalyticsTriggers.PLAYBACK_90]: [EVENTS.VIDEO_COMPLETE],
+    [AnalyticsTriggers.PLAYBACK_PAUSE]: [EVENTS.VIDEO_PAUSE],
+    [AnalyticsTriggers.PLAYBACK_START]: [EVENTS.VIDEO_START],
+    [AnalyticsTriggers.PLAYBACK_STOP]: [EVENTS.VIDEO_STOP],
+    [AnalyticsTriggers.PLAYER_CLOSE]: [EVENTS.PLAYER_CLOSE],
+    [AnalyticsTriggers.PLAYER_OPEN]: [EVENTS.PLAYER_OPEN],
+    [AnalyticsTriggers.SCROLL_25]: [EVENTS.SCROLL],
+    [AnalyticsTriggers.SCROLL_50]: [EVENTS.SCROLL],
+    [AnalyticsTriggers.SCROLL_75]: [EVENTS.SCROLL],
+    [AnalyticsTriggers.SCROLL_90]: [EVENTS.SCROLL],
+    [AnalyticsTriggers.APP_CLOSE]: [EVENTS.VIDEO_STOP, EVENTS.PLAYER_CLOSE],
+    [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/helper.ts

@@ -0,0 +1,34 @@
+import { time } from '@24i/bigscreen-sdk/time';
+import { MINUTES_PER_HOUR } from '@24i/bigscreen-sdk/utils';
+
+export const getTimezoneOffsetString = (): string => {
+    const timezoneOffset = time.getTimezoneOffset();
+    const offsetHours = Math.floor(Math.abs(timezoneOffset) / MINUTES_PER_HOUR);
+    const offsetMinutesRemainder = Math.abs(timezoneOffset) % MINUTES_PER_HOUR;
+
+    const sign = timezoneOffset <= 0 ? '+' : '-';
+
+    const offsetHoursString = offsetHours.toString().padStart(2, '0');
+    const offsetMinutesString = offsetMinutesRemainder.toString().padStart(2, '0');
+    return `${sign}${offsetHoursString}:${offsetMinutesString}`;
+};
+
+export const formatDateTime = (date: Date): string => {
+    if (Number.isNaN(date.getTime())) {
+        return '';
+    }
+    const year = date.getUTCFullYear();
+    const month = (date.getUTCMonth() + 1).toString().padStart(2, '0');
+    const day = date.getUTCDate().toString().padStart(2, '0');
+    const hours = date.getUTCHours().toString().padStart(2, '0');
+    const minutes = date.getUTCMinutes().toString().padStart(2, '0');
+    const seconds = date.getUTCSeconds().toString().padStart(2, '0');
+
+    return `${year}-${month}-${day}T${hours}:${minutes}:${seconds}+00:00`;
+};
+
+export const getAssetId = (url: string = ''): string => {
+    const urlParts = url.split('/');
+    const lastPart = urlParts[urlParts.length - 1];
+    return lastPart !== '' ? lastPart : '';
+};

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

@@ -0,0 +1,2 @@
+export { TwentyFourIQClient } from './TwentyFourIQClient';
+export { TWENTY_FOUR_IQ_TRIGGERS } from './constants';

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

@@ -0,0 +1,34 @@
+import {
+    EVENTS,
+} from './constants';
+import { mapSceneView } from './mappers/mapSceneView';
+import { mapBuffering } from './mappers/mapBuffering';
+import { mapScroll } from './mappers/mapScroll';
+import { mapVideoProgress } from './mappers/mapVideoProgress';
+import { mapVideoStop } from './mappers/mapVideoStop';
+import { mapVideoComplete } from './mappers/mapVideoComplete';
+import { mapPlayerOpen } from './mappers/mapPlayerOpen';
+import { mapPlayerClose } from './mappers/mapPlayerClose';
+import { mapVideoStart } from './mappers/mapVideoStart';
+import { mapVideoPause } from './mappers/mapVideoPause';
+import { mapAdEvent } from './mappers/mapAdEvent';
+import { EventMappingFunction } from './types';
+
+export const EVENTS_MAPPING: Record<EVENTS, EventMappingFunction> = {
+    [EVENTS.SCENE_VIEW]: mapSceneView,
+    [EVENTS.BUFFERING]: mapBuffering,
+    [EVENTS.SCROLL]: mapScroll,
+    [EVENTS.PLAYER_OPEN]: mapPlayerOpen,
+    [EVENTS.PLAYER_CLOSE]: mapPlayerClose,
+    [EVENTS.VIDEO_START]: mapVideoStart,
+    [EVENTS.VIDEO_STOP]: mapVideoStop,
+    [EVENTS.VIDEO_PROGRESS]: mapVideoProgress,
+    [EVENTS.VIDEO_COMPLETE]: mapVideoComplete,
+    [EVENTS.VIDEO_PAUSE]: mapVideoPause,
+    [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

@@ -0,0 +1,24 @@
+import { time } from '@24i/bigscreen-sdk/time';
+import { Payload, BaseResult } from '../types';
+import { formatDateTime, getTimezoneOffsetString } from '../helper';
+
+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 || '',
+        user_id: payload.userId || '',
+        user_profile_id: payload.userProfileId,
+        custom_gdpr_status: payload.gdprStatus,
+        ...(!payload.userId && { user_anon_id: payload.deviceId }),
+    };
+};

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

@@ -0,0 +1,15 @@
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import { Payload, BufferingResult } from '../types';
+import { mapBase } from './mapBase';
+
+export const mapBuffering = (
+    triggerName: AnalyticsTriggers,
+    payload: Payload,
+): BufferingResult => ({
+    ...mapBase(payload),
+    action: triggerName,
+    event_trigger: triggerName,
+    thing_id: payload.assetId || '',
+    attribution_id: payload.attributionId || '',
+    source_page: payload.sceneName,
+});

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

@@ -0,0 +1,25 @@
+import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import { DefaultScreens, EVENTS, HUNDRED_PERCENT } from '../constants';
+import { PlayerCloseResult, Payload } from '../types';
+import { mapBase } from './mapBase';
+
+export const mapPlayerClose = (
+    triggerName: AnalyticsTriggers,
+    payload: Payload,
+): PlayerCloseResult | undefined => {
+    const progressPercent = Number(payload.percentOfPlayback);
+    const assetDuration = Number(payload.duration) / SECOND_IN_MS
+        || payload?.asset?.duration || 0;
+    const duration = Math.round((assetDuration * progressPercent) / HUNDRED_PERCENT);
+    return {
+        ...mapBase(payload),
+        action: EVENTS.PLAYER_CLOSE,
+        event_trigger: triggerName,
+        source_page: DefaultScreens.PLAYBACK,
+        thing_id: payload.assetId || '',
+        attribution_id: payload.attributionId || '',
+        duration,
+        progress_pct: progressPercent,
+    };
+};

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

@@ -0,0 +1,17 @@
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import { DefaultScreens } from '../constants';
+import { PlayerOpenResult, Payload } from '../types';
+import { mapBase } from './mapBase';
+
+export const mapPlayerOpen = (
+    triggerName: AnalyticsTriggers,
+    payload: Payload,
+): PlayerOpenResult => ({
+    ...mapBase(payload),
+    action: triggerName,
+    event_trigger: triggerName,
+    source_page: DefaultScreens.PLAYBACK,
+    thing_id: payload.assetId || '',
+    attribution_id: payload.attributionId || '',
+    source_rail: '', // TODO: payload.payload.asset.sectionLabel,
+});

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

@@ -0,0 +1,15 @@
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import { Payload, SceneViewResult } from '../types';
+import { mapBase } from './mapBase';
+
+export const mapSceneView = (
+    triggerName: AnalyticsTriggers,
+    payload: Payload,
+): SceneViewResult | undefined => ({
+    ...mapBase(payload),
+    action: triggerName,
+    event_trigger: triggerName,
+    source_page: payload.sceneName,
+    thing_id: payload.assetId || '',
+    attribution_id: payload.attributionId || '',
+});

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

@@ -0,0 +1,17 @@
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import { EVENTS } from '../constants';
+import { Payload, ScrollResult } from '../types';
+import { mapBase } from './mapBase';
+
+export const mapScroll = (triggerName: AnalyticsTriggers, payload: Payload): ScrollResult => {
+    const percentScrolled = triggerName.split('_')[1];
+    return {
+        ...mapBase(payload),
+        action: EVENTS.SCROLL,
+        event_trigger: triggerName,
+        source_page: payload.sceneName,
+        thing_id: payload.assetId || '',
+        attribution_id: payload.attributionId || '',
+        percent_scrolled: percentScrolled,
+    };
+};

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

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

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

@@ -0,0 +1,25 @@
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
+import { DefaultScreens, EVENTS, HUNDRED_PERCENT } from '../constants';
+import { VideoPauseResult, Payload } from '../types';
+import { mapBase } from './mapBase';
+
+export const mapVideoPause = (
+    triggerName: AnalyticsTriggers,
+    payload: Payload,
+): VideoPauseResult => {
+    const { asset, duration = 0 } = payload;
+    const progressPercent = Number(payload.percentOfPlayback);
+    const assetDuration = duration / SECOND_IN_MS || asset?.duration || 0;
+    const overallDuration = Math.round((assetDuration * progressPercent) / HUNDRED_PERCENT);
+    return {
+        ...mapBase(payload),
+        action: EVENTS.VIDEO_PAUSE,
+        event_trigger: triggerName,
+        thing_id: payload.assetId || '',
+        attribution_id: payload.attributionId || '',
+        duration: overallDuration,
+        progress_pct: progressPercent,
+        source_page: DefaultScreens.PLAYBACK,
+    };
+};

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

@@ -0,0 +1,25 @@
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
+import { Payload, VideoProgressResult } from '../types';
+import { DefaultScreens, EVENTS, HUNDRED_PERCENT } from '../constants';
+import { mapBase } from './mapBase';
+
+export const mapVideoProgress = (
+    triggerName: AnalyticsTriggers,
+    payload: Payload,
+): VideoProgressResult => {
+    const { asset, duration = 0 } = payload;
+    const progressPercent = Number(triggerName.split('_')[1]);
+    const assetDuration = duration / SECOND_IN_MS || asset?.duration || 0;
+    const durationInSeconds = Math.round((assetDuration * progressPercent) / HUNDRED_PERCENT);
+    return {
+        ...mapBase(payload),
+        action: EVENTS.VIDEO_PROGRESS,
+        event_trigger: triggerName,
+        thing_id: payload.assetId || '',
+        attribution_id: payload.attributionId || '',
+        progress_pct: progressPercent,
+        duration: durationInSeconds,
+        source_page: DefaultScreens.PLAYBACK,
+    };
+};

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

@@ -0,0 +1,34 @@
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import { PropertyType } from '@24i/smartapps-datalayer/models';
+import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
+import { DefaultScreens, EVENTS } from '../constants';
+import { VideoStartResult, Payload } from '../types';
+import { mapBase } from './mapBase';
+
+const HUNDRED_PERCENT = 100;
+
+export const mapVideoStart = (
+    triggerName: AnalyticsTriggers,
+    payload: Payload,
+): VideoStartResult => {
+    const { duration = 0, asset } = payload;
+    const assetDuration = duration / SECOND_IN_MS || asset?.duration || 0;
+    const startPosition = Number(asset?.properties?.find(
+        (property) => property.type === PropertyType.WATCH_PROGRESS,
+    ) || 0);
+    let progressPercent = 0;
+    if (assetDuration !== 0 && startPosition !== 0) {
+        progressPercent = Number(((startPosition / assetDuration) * HUNDRED_PERCENT).toFixed(2));
+    }
+    return {
+        ...mapBase(payload),
+        action: EVENTS.VIDEO_START,
+        event_trigger: triggerName,
+        thing_id: payload.assetId || '',
+        attribution_id: payload.attributionId || '',
+        duration: assetDuration,
+        progress_pct: progressPercent,
+        source_page: DefaultScreens.PLAYBACK,
+        source_rail: '', // TODO: asset.sectionLabel,
+    };
+};

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

@@ -0,0 +1,32 @@
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
+import { PropertyType } from '@24i/smartapps-datalayer/models';
+import { DefaultScreens, EVENTS, HUNDRED_PERCENT } from '../constants';
+import { Payload, VideoStopResult } from '../types';
+import { mapBase } from './mapBase';
+
+export const mapVideoStop = (
+    triggerName: AnalyticsTriggers,
+    payload: Payload,
+): VideoStopResult | undefined => {
+    const { duration = 0, asset } = payload;
+    const assetDuration = duration / SECOND_IN_MS || asset?.duration || 0;
+    const startPosition = Number(asset?.properties?.find(
+        (property) => property.type === PropertyType.WATCH_PROGRESS,
+    ) || 0);
+    let progressPercent = 0;
+    if (assetDuration !== 0 && startPosition !== 0) {
+        progressPercent = Number(((startPosition / assetDuration) * HUNDRED_PERCENT));
+    }
+    return {
+        ...mapBase(payload),
+        action: EVENTS.VIDEO_STOP,
+        event_trigger: triggerName,
+        thing_id: payload.assetId || '',
+        attribution_id: payload.attributionId || '',
+        progress_pct: progressPercent,
+        duration,
+        source_page: DefaultScreens.PLAYBACK,
+        source_rail: '', // TODO: payload.payload.asset.sectionLabel,
+    };
+};

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

@@ -0,0 +1,132 @@
+import { Asset } from '@24i/smartapps-datalayer/models';
+import { AnalyticsTriggers } from '@24i/appstage-shared-analytics';
+import type { AnyPayload, UserInfo, AppInfo, AdType } from '../../interface';
+
+interface ScreenParams {
+    screen: string;
+    screenName: string;
+    id: string;
+    asset: Asset;
+}
+export interface CorePayload {
+    timestamp?: number;
+    params?: ScreenParams;
+    asset?: Asset;
+    source?: string;
+    duration?: number;
+    assetId?: string;
+    percentOfPlayback?: number;
+    attributionId?: string;
+}
+
+export interface SessionInfo {
+    sessionId: number;
+    sessionNumber: number;
+}
+
+export interface DeviceInfo {
+    appVersion: string,
+    manufacturer: string,
+    platform: string,
+    deviceId: string,
+    deviceModel: string,
+}
+
+export interface SceneInfo {
+    sceneName: string,
+    sceneId: string,
+    sceneType?: string,
+}
+
+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;
+
+export type EventMappingFunction = (
+    triggerName: AnalyticsTriggers,
+    payload: Payload
+) => 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;
+    user_profile_id?: string;
+    custom_gdpr_status?: boolean;
+};
+
+export type CoreResult = BaseResult & {
+    action: string;
+    event_trigger: string;
+};
+export type SceneViewResult = CoreResult & {
+    source_page: string;
+    thing_id: string;
+    attribution_id: string;
+};
+export type BufferingResult = SceneViewResult;
+
+export type ScrollResult = SceneViewResult & {
+    percent_scrolled: string;
+};
+export type PlayerOpenResult = CoreResult & {
+    thing_id: string;
+    attribution_id: string;
+    source_page: string;
+    source_rail?: string | null;
+};
+
+export type VideoBaseResult = CoreResult & {
+    thing_id: string;
+    attribution_id: string;
+    duration: number;
+    progress_pct: number;
+    source_page: string;
+};
+
+export type VideoStartResult = VideoBaseResult & {
+    source_rail?: string | null;
+};
+
+export type VideoPauseResult = VideoBaseResult;
+
+export type VideoStopResult = VideoStartResult;
+
+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;
+    custom_campaign_url: string;
+};

package/packages/analytics/src/constants.ts

@@ -0,0 +1 @@
+export * from '@24i/appstage-shared-analytics';

package/packages/analytics/src/index.ts

@@ -0,0 +1,3 @@
+export { analytics } from './Analytics';
+export { A } from './A';
+export { analyticsOnScroll } from './analyticsOnScroll';

package/packages/analytics/src/interface.ts

@@ -0,0 +1 @@
+export * from '@24i/appstage-shared-analytics/dist/interface';

package/packages/analytics/src/utils/generateSessionId.ts

@@ -0,0 +1,8 @@
+const RANDOM_SEED = 2147483647;
+/**
+ * Recommended way to generate session id by Google.
+ * Blackbox
+ */
+export const generateSessionId = () => (
+    Math.floor(Math.random() * (RANDOM_SEED - 0 + 1) + 0)
+);