@24i/bigscreen-sdk 0.9.9-alpha.2147

package/README.md

@@ -0,0 +1,47 @@
+---
+id: README
+title: README
+hide_title: true
+sidebar_label: README
+---
+
+# SmartApps BIGscreen SDK
+
+[![Build Status](https://travis-ci.com/24i/smartapps-bigscreen-sdk.svg?token=TvpGGSB2Z1L12QwPagEp&branch=development)](https://travis-ci.com/24i/smartapps-bigscreen-sdk)
+[![Coverage Status](https://coveralls.io/repos/github/24i/smartapps-bigscreen-sdk/badge.svg?branch=development&t=dGc701&kill_cache=1)](https://coveralls.io/github/24i/smartapps-bigscreen-sdk?branch=development)
+
+* [GitHub](https://github.com/24i/smartapps-bigscreen-sdk)
+* [Confluence](https://24imedia.atlassian.net/wiki/spaces/PRDNGBIGSCR/overview)
+* [JIRA Tickets](https://jira.24i.com/projects/PRDUPCYCLE/issues)
+* [Docusaurus](https://docs-bigscreen.vercel.app/docs/introduction)
+
+Repository which contains all source code for SmartApps BIGscreen development.
+Contains packages for UI, focus management, drivers and so on.
+
+## Contributing
+
+### Prerequisites
+To be able to contribute, you need to have account on [npmjs](https://www.npmjs.com/) and this account needs to have access to [@24i organization](https://www.npmjs.com/org/24i).
+
+### Developing
+The `npm install` will install root dependencies and bootstrap all subprojects.
+Then find README in relevant package in `packages` folder.
+We have commit hooks which run these linters and tests before the the commit goes through.
+
+To start developing a new feature or bug fix, there is typical flow:
+1) create new branch in name form: `<type>/<JIRA-ISSUE-KEY>-short_summary`
+2) if you work on new package, use `npm run create-package -- <my-pkg-name>` to create unified package setup (including folder structure with necessary config files). Output folder is located in `./packages/<my-pkg-name>`.
+3) commit your changes. Each commit must follow message convention [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+4) once it is ready, create a PR to `development` branch for code review
+
+### Tests
+- lintcheck will start linter checks
+- test start test suites
+- typecheck will start type checks
+
+`npm test` then runs lint and test commands in all subpackages.
+
+`npx jest packages/package_name` runs tests for a single project (subpackage) from root
+
+### Release
+To release packages follow the [How to Release Packages for SmartApps BIGscreen](https://docs-bigscreen.vercel.app/docs/guide/howtos/release) page.

package/package.json

@@ -0,0 +1,272 @@
+{
+    "name": "@24i/bigscreen-sdk",
+    "version": "0.9.9-alpha.2147",
+    "description": "SmartApps BIGscreen SDK monorepo",
+    "main": "index.js",
+    "scripts": {
+        "prepare": "husky install && npm run patch-types",
+        "postinstall": "npm run scripts:prepare",
+        "prepublishOnly": "npm run scripts:prepare:create-export-maps",
+        "scripts:prepare": "ts-node ./utils/run-scripts/index.ts \"prepare:.+\"",
+        "scripts:prepare:create-export-maps": "ts-node ./utils/create-export-maps/index.ts --project ./tsconfig.utils.json",
+        "scripts:prepare:webos": "cd packages/driver-webos && ts-node ./scripts/exportWebOSTVjs.ts --project ../../tsconfig.utils.json",
+        "scripts:create-package": "ts-node ./utils/create-package/src/index.ts --project ./tsconfig.utils.json",
+        "jest": "cross-env NODE_ICU_DATA=node_modules/full-icu jest",
+        "eslint": "eslint \"./packages/**/src/**/*.{ts,tsx}\"",
+        "stylelint": "stylelint \"./packages/**/src/**/*.scss\"",
+        "lintcheck": "npm run eslint && npm run stylelint",
+        "lintcheck:cached": "npm run eslint -- --cache && npm run stylelint -- --cache",
+        "typecheck": "tsc --noEmit",
+        "typecheck:cached": "npm run typecheck -- --incremental",
+        "test": "npm run jest -- --no-cache && npm run lintcheck",
+        "test:cached": "npm run jest && npm run lintcheck:cached",
+        "coverage": "npm run jest -- --runInBand --coverage && coveralls < coverage/lcov.info",
+        "branchlint": "branchlint",
+        "generate-changelog": "smartapps-bigscreen-changelog-generator",
+        "deploy-docs": "cd website && npm run build && vercel ./build/prd-nxg-bigscreen --token=$VERCEL_TOKEN_24I --local-config=./vercel.json --scope=24i -f -c --prod",
+        "patch-types": "patch-package && node ./packages/types-bigscreen-jsx/src/copyTypes.js",
+        "rebootstrap": "rm -rf node_modules && npm i"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/24i/smartapps-bigscreen-sdk.git"
+    },
+    "author": "24i",
+    "license": "ISC",
+    "bugs": {
+        "url": "https://github.com/24i/smartapps-bigscreen-sdk/issues"
+    },
+    "homepage": "https://github.com/24i/smartapps-bigscreen-sdk#readme",
+    "dependencies": {
+        "@24i/player-base": "6.10.0",
+        "@24i/smartapps-datalayer": "2.2.3",
+        "@sentry/browser": "^7.6.0",
+        "@types/prop-types": "^15.7.5",
+        "@types/scheduler": "^0.16.1",
+        "csstype": "^3.1.0",
+        "lottie-web": "5.9.6",
+        "prop-types": "^15.8.1"
+    },
+    "devDependencies": {
+        "@24i/bigscreen-sdk": "file:.",
+        "@24i/eslint-config-smartapps-bigscreen-linters": "file:./libs/linters",
+        "@24i/smartapps-bigscreen-changelog-generator": "0.17.0",
+        "@babel/core": "^7.18.6",
+        "@babel/preset-env": "^7.18.6",
+        "@types/fs-extra": "^9.0.13",
+        "@types/inquirer": "^8.2.1",
+        "@types/jest": "^28.1.5",
+        "@types/minimist": "^1.2.2",
+        "@types/node": "^17.0.43",
+        "@types/react": "^18.0.15",
+        "babel-jest": "^28.1.2",
+        "chalk": "^4.1.2",
+        "coveralls": "^3.1.0",
+        "cross-env": "^7.0.3",
+        "fs-extra": "^10.1.0",
+        "full-icu": "^1.4.0",
+        "identity-obj-proxy": "^3.0.0",
+        "inquirer": "^9.0.0",
+        "jest": "^28.1.2",
+        "jest-canvas-mock": "^2.4.0",
+        "jest-environment-jsdom": "^28.1.2",
+        "minimist": "^1.2.6",
+        "patch-package": "^6.2.1",
+        "sass": "^1.53.0",
+        "sass-true": "^6.1.0",
+        "ts-jest": "^28.0.4",
+        "ts-node": "^10.8.2",
+        "tsconfig-paths-jest": "0.0.1",
+        "typescript": "^4.7.2"
+    },
+    "exports": {
+        "./adobe-heartbeat": "./packages/adobe-heartbeat/src/index.ts",
+        "./animations/mock": "./packages/animations/src/__mocks__/JSAnimations.ts",
+        "./animations": "./packages/animations/src/index.ts",
+        "./announcement-banner": "./packages/announcement-banner/src/index.ts",
+        "./async-image": "./packages/async-image/src/index.ts",
+        "./conviva/convivaMock": "./packages/conviva/src/__mocks__/ConvivaMock.ts",
+        "./conviva/theoPlugin": "./packages/conviva/src/theoPlugin/index.ts",
+        "./conviva": "./packages/conviva/src/index.ts",
+        "./developer-tools/DeveloperConsole": "./packages/developer-tools/DeveloperConsole/index.ts",
+        "./developer-tools/DeveloperConsole/unstyled": "./packages/developer-tools/DeveloperConsole/unstyled.ts",
+        "./developer-tools/DeveloperToolsService": "./packages/developer-tools/DeveloperToolsService/index.ts",
+        "./developer-tools/DeveloperToolsService/unstyled": "./packages/developer-tools/DeveloperToolsService/unstyled.ts",
+        "./developer-tools/EnvironmentSelection": "./packages/developer-tools/EnvironmentSelection/index.ts",
+        "./developer-tools/EnvironmentSelection/unstyled": "./packages/developer-tools/EnvironmentSelection/unstyled.ts",
+        "./developer-tools/PlayerDebugWindow": "./packages/developer-tools/PlayerDebugWindow/index.ts",
+        "./developer-tools/PlayerDebugWindow/unstyled": "./packages/developer-tools/PlayerDebugWindow/unstyled.ts",
+        "./developer-tools/TechnicalInfo": "./packages/developer-tools/TechnicalInfo/index.ts",
+        "./developer-tools/TechnicalInfo/unstyled": "./packages/developer-tools/TechnicalInfo/unstyled.ts",
+        "./developer-tools": "./packages/developer-tools/src/index.ts",
+        "./device/keymap": "./packages/device/keymap.ts",
+        "./device/resolver": "./packages/device/resolver/index.ts",
+        "./device/resolver/keymap": "./packages/device/resolver/keymap.ts",
+        "./device": "./packages/device/src/index.ts",
+        "./digital-clock": "./packages/digital-clock/src/index.ts",
+        "./driver-base/keymap": "./packages/driver-base/src/KeyMap/index.ts",
+        "./driver-base": "./packages/driver-base/src/index.ts",
+        "./driver-browser": "./packages/driver-browser/src/index.ts",
+        "./driver-entone": "./packages/driver-entone/src/index.ts",
+        "./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-tizen": "./packages/driver-tizen/src/index.ts",
+        "./driver-webos/scripts/template": "./packages/driver-webos/scripts/template.ts",
+        "./driver-webos/scripts/exportWebOSTVjs": "./packages/driver-webos/scripts/exportWebOSTVjs.ts",
+        "./driver-webos": "./packages/driver-webos/src/index.ts",
+        "./driver-xbox": "./packages/driver-xbox/src/index.ts",
+        "./epg/interface": "./packages/epg/src/v2/interface.ts",
+        "./epg/styles/Basic": "./packages/epg/src/v2/styles/Basic/index.ts",
+        "./epg/styles/Whitelabel": "./packages/epg/src/v2/styles/Whitelabel/index.ts",
+        "./epg/DateToast": "./packages/epg/src/v2/DateToast/index.tsx",
+        "./epg/DateToast/styles": "./packages/epg/src/v2/DateToast/styles.ts",
+        "./epg/ProgramInfo": "./packages/epg/src/v2/ProgramInfo/index.ts",
+        "./epg/ProgramInfo/styles": "./packages/epg/src/v2/ProgramInfo/styles.ts",
+        "./epg/MockGenerator": "./packages/epg/src/v2/MockGenerator/index.ts",
+        "./epg": "./packages/epg/src/v2/index.ts",
+        "./events-manager": "./packages/events-manager/src/index.ts",
+        "./floating-focus": "./packages/floating-focus/src/index.ts",
+        "./focus/candidate": "./packages/focus/src/candidate.ts",
+        "./focus": "./packages/focus/src/index.ts",
+        "./gallup/mock": "./packages/gallup/src/GallupMock.ts",
+        "./gallup": "./packages/gallup/src/index.ts",
+        "./grid/interface": "./packages/grid/src/interface.ts",
+        "./grid/Basic": "./packages/grid/src/BasicGrid/BasicGrid.tsx",
+        "./grid/Basic/static": "./packages/grid/src/BasicGrid/BasicGridStatic.tsx",
+        "./grid/FirstOnly": "./packages/grid/src/FirstOnlyGrid/FirstOnlyGrid.tsx",
+        "./grid/FirstOnly/static": "./packages/grid/src/FirstOnlyGrid/FirstOnlyGridStatic.tsx",
+        "./grid/FixedToEnd": "./packages/grid/src/FixedToEndGrid/FixedToEndGrid.tsx",
+        "./grid/FixedToEnd/static": "./packages/grid/src/FixedToEndGrid/FixedToEndGridStatic.tsx",
+        "./i18n/utils/addResourceBundle": "./packages/i18n/src/addResourceBundle.ts",
+        "./i18n/middlewares/i18next/Context": "./packages/i18n/src/middlewares/i18next/Context/index.ts",
+        "./i18n/middlewares/i18next/Interpolation": "./packages/i18n/src/middlewares/i18next/Interpolation/index.ts",
+        "./i18n/middlewares/i18next/Nesting": "./packages/i18n/src/middlewares/i18next/Nesting/index.ts",
+        "./i18n/middlewares/i18next/Plurals": "./packages/i18n/src/middlewares/i18next/Plurals/index.ts",
+        "./i18n/middlewares/icu/DateInterpolation": "./packages/i18n/src/middlewares/icu/DateInterpolation/index.ts",
+        "./i18n/middlewares/icu/Interpolation": "./packages/i18n/src/middlewares/icu/Interpolation/index.ts",
+        "./i18n/middlewares/icu/NumberInterpolation": "./packages/i18n/src/middlewares/icu/NumberInterpolation/index.ts",
+        "./i18n/middlewares/icu/Plurals": "./packages/i18n/src/middlewares/icu/Plurals/index.ts",
+        "./i18n/middlewares/icu/Select": "./packages/i18n/src/middlewares/icu/Select/index.ts",
+        "./i18n/middlewares/icu/TimeInterpolation": "./packages/i18n/src/middlewares/icu/TimeInterpolation/index.ts",
+        "./i18n": "./packages/i18n/src/index.ts",
+        "./icon": "./packages/icon/src/index.ts",
+        "./ime": "./packages/ime/src/index.ts",
+        "./input": "./packages/input/src/index.ts",
+        "./interactable/interface": "./packages/interactable/src/interface.ts",
+        "./interactable": "./packages/interactable/src/index.ts",
+        "./ipify": "./packages/ipify/src/index.ts",
+        "./jsx/jsx-runtime": "./packages/jsx/src/jsx-runtime.ts",
+        "./jsx/test-utils": "./packages/jsx/src/test-utils/index.ts",
+        "./jsx": "./packages/jsx/src/index.ts",
+        "./key-sequence": "./packages/key-sequence/src/index.ts",
+        "./keyboard/ShiftMode": "./packages/keyboard/src/ShiftMode.ts",
+        "./keyboard/Android": "./packages/keyboard/src/AndroidKeyboard/index.ts",
+        "./keyboard/Default": "./packages/keyboard/src/DefaultKeyboard/index.ts",
+        "./keyboard/Mobi": "./packages/keyboard/src/MobiKeyboard/index.ts",
+        "./keyboard/Whitelabel": "./packages/keyboard/src/WhitelabelKeyboard/index.ts",
+        "./keyboard/Whitelabel/styles": "./packages/keyboard/src/WhitelabelKeyboard/WhitelabelStyles/index.ts",
+        "./keyboard/WhitelabelNumeric": "./packages/keyboard/src/WhitelabelNumericKeyboard/index.ts",
+        "./keyboard/WhitelabelNumeric/styles": "./packages/keyboard/src/WhitelabelNumericKeyboard/WhitelabelStyles/index.ts",
+        "./l10n/interface": "./packages/l10n/interface.ts",
+        "./l10n/locales/cs": "./packages/l10n/locales/cs.ts",
+        "./l10n/locales/en-001": "./packages/l10n/locales/en-001.ts",
+        "./l10n/locales/en-us": "./packages/l10n/locales/en-us.ts",
+        "./l10n": "./packages/l10n/src/index.ts",
+        "./list/AttachDetachItem": "./packages/list/AttachDetachItem/index.ts",
+        "./list/Basic": "./packages/list/BasicList/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",
+        "./list/EdgeOffset": "./packages/list/EdgeOffsetList/index.ts",
+        "./list/EdgeOffset/static": "./packages/list/EdgeOffsetList/static.ts",
+        "./list/FirstOnly": "./packages/list/FirstOnlyList/index.ts",
+        "./list/FirstOnly/static": "./packages/list/FirstOnlyList/static.ts",
+        "./list/FirstOnlyVaried": "./packages/list/FirstOnlyVariedList/index.ts",
+        "./list/FirstOnlyVaried/static": "./packages/list/FirstOnlyVariedList/static.ts",
+        "./list/FixedToEnd": "./packages/list/FixedToEndList/index.ts",
+        "./list/FixedToEnd/static": "./packages/list/FixedToEndList/static.ts",
+        "./list/interface": "./packages/list/src/interface.ts",
+        "./list/utils": "./packages/list/utils/index.ts",
+        "./logger/ConsoleLogger": "./packages/logger/src/loggers/ConsoleLogger/index.ts",
+        "./logger/SentryLogger": "./packages/logger/src/loggers/SentryLogger/index.ts",
+        "./logger": "./packages/logger/src/index.ts",
+        "./lottie-animations": "./packages/lottie-animations/src/index.ts",
+        "./menu/interface": "./packages/menu/src/MenuAndContentContainer/interface.ts",
+        "./menu/Whitelabel": "./packages/menu/WhitelabelMenu/index.ts",
+        "./menu/Whitelabel/interface": "./packages/menu/WhitelabelMenu/interface.ts",
+        "./menu/Whitelabel/styles": "./packages/menu/WhitelabelMenu/styles.ts",
+        "./menu": "./packages/menu/src/index.ts",
+        "./modal-service": "./packages/modal-service/src/index.ts",
+        "./mouse-navigation/ArrowNavigation": "./packages/mouse-navigation/src/ArrowNavigation/index.tsx",
+        "./mouse-navigation/ArrowNavigation/interface": "./packages/mouse-navigation/src/ArrowNavigation/ArrowNavigation.tsx",
+        "./mouse-navigation": "./packages/mouse-navigation/src/index.ts",
+        "./numeric-zapper/interface": "./packages/numeric-zapper/src/interface.ts",
+        "./numeric-zapper/styles": "./packages/numeric-zapper/src/styles.ts",
+        "./numeric-zapper": "./packages/numeric-zapper/src/index.ts",
+        "./perf-utils/array": "./packages/perf-utils/src/array/index.ts",
+        "./picker/DatePicker": "./packages/picker/src/DatePicker.tsx",
+        "./picker": "./packages/picker/src/index.ts",
+        "./pin-input": "./packages/pin-input/src/index.ts",
+        "./player-ui": "./packages/player-ui/src/index.ts",
+        "./progress-bar/interface": "./packages/progress-bar/src/interface.ts",
+        "./progress-bar": "./packages/progress-bar/src/index.ts",
+        "./qr-code": "./packages/qr-code/src/index.ts",
+        "./router": "./packages/router/src/index.ts",
+        "./runtime-config": "./packages/runtime-config/src/index.ts",
+        "./sass-utils/box-shadow": "./packages/sass-utils/src/box-shadow.scss",
+        "./sass-utils/ellipsis": "./packages/sass-utils/src/ellipsis.scss",
+        "./sass-utils/linear-gradient": "./packages/sass-utils/src/linear-gradient.scss",
+        "./sass-utils/prefix-property": "./packages/sass-utils/src/prefix-property.scss",
+        "./sass-utils/prefix-value": "./packages/sass-utils/src/prefix-value.scss",
+        "./sass-utils/prefix": "./packages/sass-utils/src/prefix.scss",
+        "./sass-utils/scale": "./packages/sass-utils/src/scale.scss",
+        "./sass-utils/transform": "./packages/sass-utils/src/transform.scss",
+        "./sass-utils/transition": "./packages/sass-utils/src/transition.scss",
+        "./scheduler": "./packages/scheduler/src/index.ts",
+        "./scroll-text/basic": "./packages/scroll-text/src/ScrollText.tsx",
+        "./scroll-text": "./packages/scroll-text/src/index.ts",
+        "./scroller": "./packages/scroller/src/index.ts",
+        "./splash/styles": "./packages/splash/src/styles.ts",
+        "./splash/Animated/animated": "./packages/splash/AnimatedSplashAnimated.ts",
+        "./splash/Animated/basic": "./packages/splash/AnimatedSplashBasic.ts",
+        "./splash/Animated": "./packages/splash/AnimatedSplash.ts",
+        "./splash/Static/animated": "./packages/splash/StaticSplashAnimated.ts",
+        "./splash/Static/basic": "./packages/splash/StaticSplashBasic.ts",
+        "./splash/Static": "./packages/splash/StaticSplash.ts",
+        "./splash/Automatic/animated": "./packages/splash/AutomaticSplashAnimated.ts",
+        "./splash/Automatic/basic": "./packages/splash/AutomaticSplashBasic.ts",
+        "./splash": "./packages/splash/src/index.ts",
+        "./storage/interface": "./packages/storage/src/types.ts",
+        "./storage/CookieStorage": "./packages/storage/src/CookieStorage/index.ts",
+        "./storage": "./packages/storage/src/index.ts",
+        "./throbber": "./packages/throbber/src/index.ts",
+        "./time/adapters/worldTimeApi": "./packages/time/src/adapters/worldTimeApi.ts",
+        "./time": "./packages/time/src/index.ts",
+        "./toast/styles": "./packages/toast/src/Toast/styles.ts",
+        "./toast": "./packages/toast/src/index.ts",
+        "./types-bigscreen-jsx": "./packages/types-bigscreen-jsx/index.js",
+        "./utils/addClass": "./packages/utils/src/addClass.ts",
+        "./utils/counter": "./packages/utils/src/counter.ts",
+        "./utils/debounce": "./packages/utils/src/debounce.ts",
+        "./utils/displayToggler": "./packages/utils/src/displayToggler.ts",
+        "./utils/elementUtils": "./packages/utils/src/elementUtils.ts",
+        "./utils/generateUuid": "./packages/utils/src/generateUuid.ts",
+        "./utils/memoryInfo": "./packages/utils/src/memoryInfo.ts",
+        "./utils/nTimes": "./packages/utils/src/nTimes.ts",
+        "./utils/noop": "./packages/utils/src/noop.ts",
+        "./utils/offsetPosition": "./packages/utils/src/offsetPosition.ts",
+        "./utils/removeClass": "./packages/utils/src/removeClass.ts",
+        "./utils/scaledImage": "./packages/utils/src/scaledImage.ts",
+        "./utils/stopEvent": "./packages/utils/src/stopEvent.ts",
+        "./utils/timeConstants": "./packages/utils/src/timeConstants.ts",
+        "./utils/timers": "./packages/utils/src/timers/index.ts",
+        "./utils/wait": "./packages/utils/src/wait.ts",
+        "./utils/xhr": "./packages/utils/src/xhr/index.ts",
+        "./utils": "./packages/utils/src/index.ts",
+        "./volume-control/interface": "./packages/volume-control/src/IVolumeControlUI.ts",
+        "./volume-control": "./packages/volume-control/src/index.ts",
+        "./zapping/interface": "./packages/zapping/src/interface.ts",
+        "./zapping": "./packages/zapping/src/index.ts"
+    }
+}

package/packages/adobe-heartbeat/README.md

@@ -0,0 +1,46 @@
+---
+id: README
+title: Adobe Heartbeat tracking
+hide_title: true
+sidebar_label: Adobe Heartbeat tracking
+---
+
+# Adobe Heartbeat tracking
+AdobeHeartbeat class is a wrapper for version 2.x of [Adobe Media Analytics SDK](https://experienceleague.adobe.com/docs/media-analytics/using/sdk-implement/setup/setup-overview.html?lang=en#minimum-platform-version).
+
+## Requirements
+For the wrapper to function you need to have Adobe Launch library included in your application. Usually its hosted by adobe and you need to acquire its URL from customer. Common implementation consist of following scripts in `<head>`.
+```html
+    <script>var dataLayer = dataLayer || []</script>
+    <script src="https://assets.adobedtm.com/just/example/url/launch-1234567890ab-development.min.js" async></script>
+```
+Note that there are usually multiple libraries provided - for production, staging, development, etc.
+
+## Usage
+The Adobe Media SDK is initialised and all relevant player event listeners are attached in constructor.
+Afterwards media tracking session is  started by calling `adobeHeartbeat.startSession` and stopped with `adobeHeartbeat.stopSession`. Tracking of `play`, `pause`, `ended`, `seeking`, `seeked` and `error` events is handled by the wrapper class through relevant player event listeners.
+```typescript
+    // with standard metadata only
+    const adobeHeartbeat = new AdobeHeartbeat(config, player);
+    adobeHeartbeat.startSession(metadata);
+    adobeHeartbeat.stopSession();
+```
+```typescript
+    // with customer provided custom metadata as well
+    const adobeHeartbeat = new AdobeHeartbeat<CustomerMetadataType>(config, player);
+    adobeHeartbeat.startSession(metadata, customMetadata);
+    adobeHeartbeat.stopSession();
+```
+
+In case where you have player instance available only at a later time (after intent tracking should have been reported already) you can attach it like so:
+```typescript
+    const adobeHeartbeat = new AdobeHeartbeat<CustomerMetadataType>(config);
+    adobeHeartbeat.startSession(metadata, customMetadata);
+    adobeHeartbeat.attackPlayer(player);
+    adobeHeartbeat.stopSession();
+```
+Note that if you do not attach a player instance the playback events will not be tracked.
+The wrapper also requires you to set metadata value `programEnd` on player for live streams.
+
+Tracking of ad breaks and ads is not automatic. One ad break can contain several ads which can be skipped or completed and there can be several ad breaks during media playback. To track ad breaks and ads use the following methods:
+`adBreakStarted`, `adStarted`, `adCompleted`, `adSkipped`, `adBreakComplete`.

package/packages/adobe-heartbeat/src/AdobeHeartbeat.ts

@@ -0,0 +1,244 @@
+/// <reference path='./__external__/Adobe/Adobe.d.ts' />
+import { IErrorEvent, PlayerBase } from '@24i/player-base';
+import { time } from '@24i/bigscreen-sdk/time';
+import { SECOND_IN_MS } from '@24i/bigscreen-sdk/utils';
+import { va as Adobe } from './__external__/Adobe/MediaSDK.min';
+import {
+    CustomerMetadata, HeartbeatConfig,
+    StandardMetadata, AdBreakMetadata, AdMetadata,
+} from './types';
+
+/**
+ * Wrapper class for version 2.x of Adobe Media Analytics SDK
+ * @typeparam CustomMetadata - defaults to void, as in no custom metadata are used
+ */
+export class AdobeHeartbeat<CustomMetadata extends CustomerMetadata | void = void> {
+    static StreamType = Adobe.MediaHeartbeat.StreamType;
+
+    private player?: PlayerBase<any>;
+
+    /**
+     * Heartbeat configuration object
+     */
+    config: HeartbeatConfig;
+
+    /**
+     * Heartbeat tracker instance
+     */
+    tracker?: Adobe.MediaHeartbeat;
+
+    /**
+     * Initializes Adobe Heartbeat tracker
+     * @param config - Heartbeat configuration object
+     * @param player - 24i universal player instance
+     */
+    constructor(config: HeartbeatConfig, player?: PlayerBase<any>) {
+        if (!window.s || !AppMeasurement) throw new Error('Missing Adobe Launch library!');
+        this.config = config;
+        this.player = player;
+
+        const {
+            visitor, pageName, charSet, trackingServer, trackingServerSecure, ssl,
+        } = window.s;
+        const appMeasurementOptions = {
+            visitor, pageName, charSet, trackingServer, trackingServerSecure, ssl,
+        };
+        // enable SSL forcefuly because default doesn't even if secure server is available
+        appMeasurementOptions.ssl = true;
+
+        const appMeasurement = AppMeasurement.getInstance(s.account);
+        Object.assign(appMeasurement, appMeasurementOptions);
+
+        const mediaConfig = new Adobe.MediaHeartbeatConfig();
+        Object.assign(mediaConfig, config);
+
+        const mediaDelegate = new Adobe.MediaHeartbeatDelegate();
+        Object.assign(mediaDelegate, this.getMediaDelegateMethods());
+
+        try {
+            this.tracker = new Adobe.MediaHeartbeat(mediaDelegate, mediaConfig, appMeasurement);
+        } catch (err) {}
+        if (!this.tracker) throw new Error('Failed to initialise Adobe Heartbeat tracking object!');
+
+        if (this.player) this.attachPlayerListeners(this.player);
+    }
+
+    private getMediaDelegateMethods() {
+        return {
+            getCurrentPlaybackTime: () => {
+                if (!this.player) return 0;
+                const { currentTime } = this.player.getMediaInfo() || {};
+                if (this.player.live) {
+                    try {
+                        const { programEnd = NaN } = this.player.getMetadata();
+                        return Math.floor((programEnd - currentTime) / SECOND_IN_MS)
+                            || time.getCurrentUnixTime();
+                    } catch (e) {
+                        return time.getCurrentUnixTime();
+                    }
+                }
+                return Math.floor(currentTime / SECOND_IN_MS) || 0;
+            },
+            getQoSObject: () => {
+                if (!this.player) return Adobe.MediaHeartbeat.createQoSObject();
+                const { bitrate, droppedVideoFrames } = this.player.getMediaInfo() || {};
+                return Adobe.MediaHeartbeat.createQoSObject(
+                    bitrate, undefined, undefined, droppedVideoFrames,
+                );
+            },
+        };
+    }
+
+    private attachPlayerListeners(player: PlayerBase<any>) {
+        player.addEventListener('play', this.onPlay);
+        player.addEventListener('pause', this.onPause);
+        player.addEventListener('ended', this.onEnded);
+        player.addEventListener('seeking', this.onSeekStart);
+        player.addEventListener('seeked', this.onSeekEnd);
+        player.addEventListener('error', this.onError);
+    }
+
+    private dettachPlayerListeners(player: PlayerBase<any>) {
+        player.removeEventListener('play', this.onPlay);
+        player.removeEventListener('pause', this.onPause);
+        player.removeEventListener('ended', this.onEnded);
+        player.removeEventListener('seeking', this.onSeekStart);
+        player.removeEventListener('seeked', this.onSeekEnd);
+        player.removeEventListener('error', this.onError);
+    }
+
+    private readonly onPlay = () => this.tracker?.trackPlay();
+
+    private readonly onPause = () => this.tracker?.trackPause();
+
+    private readonly onEnded = () => this.tracker?.trackComplete();
+
+    private readonly onSeekStart = () => (
+        this.tracker?.trackEvent(Adobe.MediaHeartbeat.Event.SeekStart)
+    );
+
+    private readonly onSeekEnd = () => (
+        this.tracker?.trackEvent(Adobe.MediaHeartbeat.Event.SeekComplete)
+    );
+
+    private readonly onError = (e: IErrorEvent) => this.tracker?.trackError(
+        e.error.code?.toString?.() ?? '',
+    );
+
+    private stringifyValues(
+        customMetadata: CustomerMetadata | void,
+    ): Record<string, string> | undefined {
+        if (!customMetadata) return undefined;
+        const result = {} as Record<string, string>;
+        Object.entries(customMetadata as Record<string, string>).forEach(([key, value]) => {
+            result[key] = String(value);
+        });
+        return result;
+    }
+
+    /**
+     * Provide a player instance to listen to for tracking events. Used if the player instance
+     * is only available after user's intent to start playback should be tracked and it wasnt
+     * provided in constructor. Alternatively if for some reason you have new player instance
+     * this will replace the old one.
+     * @param player - 24i universal player instance
+     */
+    attachPlayer(player: PlayerBase<any>) {
+        if (this.player) this.dettachPlayerListeners(this.player);
+        this.player = player;
+        if (this.player) this.attachPlayerListeners(this.player);
+    }
+
+    /**
+     * Starts the tracking session. Should be used to track the users
+     * intention to start playback, not the beginning of actual playback
+     * @param metadata - Media info metadata
+     * @param customMetadata - Optional, Additional metadata specific for customer
+     */
+    startSession(metadata: StandardMetadata, customMetadata: CustomMetadata) {
+        if (!this.tracker) return;
+        const mediaObject = Adobe.MediaHeartbeat.createMediaObject(
+            metadata.name,
+            metadata.mediaId,
+            metadata.lengthSec,
+            metadata.streamType,
+            Adobe.MediaHeartbeat.MediaType.Video, // only support video for now
+        );
+        // eslint-disable-next-line no-underscore-dangle
+        this.tracker._config.channel = metadata.channel;
+        this.tracker.trackSessionStart(
+            mediaObject,
+            this.stringifyValues(customMetadata),
+        );
+    }
+
+    /**
+     * Stops the tracking session.
+     */
+    stopSession() {
+        if (!this.tracker) return;
+        this.tracker.trackSessionEnd();
+    }
+
+    /**
+     * Starts the tracking session for ad break.
+     * @param metadata - AdBreak info metadata
+     */
+    adBreakStarted(metadata: AdBreakMetadata) {
+        if (!this.tracker) return;
+        const adBreakObject = Adobe.MediaHeartbeat.createAdBreakObject(
+            metadata.name,
+            metadata.position,
+            metadata.startTime,
+        );
+        this.tracker.trackEvent(
+            Adobe.MediaHeartbeat.Event.AdBreakStart,
+            adBreakObject,
+        );
+    }
+
+    /**
+     * Starts the tracking for a single ad in ad break.
+     * @param metadata - Ad info metadata
+     * @param customMetadata - Optional, Additional metadata specific for customer
+     */
+    adStarted(metadata: AdMetadata, customMetadata?: CustomerMetadata) {
+        if (!this.tracker) return;
+        const adObject = Adobe.MediaHeartbeat.createAdObject(
+            metadata.name,
+            metadata.adId,
+            metadata.position,
+            metadata.length,
+        );
+        this.tracker.trackEvent(
+            Adobe.MediaHeartbeat.Event.AdStart,
+            adObject,
+            this.stringifyValues(customMetadata),
+        );
+    }
+
+    /**
+     * To be called when ad playback reaches the end.
+     */
+    adCompleted() {
+        if (!this.tracker) return;
+        this.tracker.trackEvent(Adobe.MediaHeartbeat.Event.AdComplete);
+    }
+
+    /**
+     * To be called when ad playback didn't reach the end
+     * because the user skipped it.
+     */
+    adSkipped() {
+        if (!this.tracker) return;
+        this.tracker.trackEvent(Adobe.MediaHeartbeat.Event.AdSkip);
+    }
+
+    /**
+     * Tracks the end of ad break.
+     */
+    adBreakComplete() {
+        if (!this.tracker) return;
+        this.tracker.trackEvent(Adobe.MediaHeartbeat.Event.AdBreakComplete);
+    }
+}

package/packages/adobe-heartbeat/src/__external__/Adobe/Adobe.d.ts

@@ -0,0 +1,24 @@
+declare namespace s {
+    const account: string;
+    const visitor: any;
+    const pageName: any;
+    const charSet: any;
+    const trackingServer: any;
+    const trackingServerSecure: any;
+    const ssl: any;
+}
+
+declare interface VisitorAPIInstance {}
+
+declare interface AppMeasurementInstance {
+    trackingServer: string;
+    trackingServerSecure: string;
+    visitor: VisitorAPIInstance;
+    pageName: string;
+    charSet: string;
+    ssl: boolean;
+}
+
+declare class AppMeasurement {
+    static getInstance: (account: string) => AppMeasurementInstance;
+}