@npo/player 1.9.0

package/lib/types/interfaces.d.ts

@@ -0,0 +1,105 @@
+import { type SourceConfig } from 'bitmovin-player';
+import { type ErrorMessageOverlay, type Label, ControlBar, SettingsPanelItem, Button, SeekBar } from 'bitmovin-player-ui';
+import { type NPOTag, type PageTracker } from '@npotag/tag';
+import { ButtonConfig } from 'bitmovin-player-ui/dist/js/framework/components/button';
+export interface Profile {
+    tech: string;
+    drm: string;
+}
+export interface StreamObject {
+    stream: StreamObject_Stream;
+    metadata: StreamObject_Metadata;
+    assets: StreamObject_Assets;
+}
+export interface ApiPayload {
+    baseURL: string;
+    jwt: string;
+    data: Record<string, unknown>;
+}
+export interface NPOTagObject {
+    npoTagInstance: NPOTag | undefined;
+    heartbeatInterval: number | undefined;
+    pageTracker: PageTracker | null;
+}
+interface StreamObject_Stream {
+    drmToken?: string;
+    drmType: string;
+    streamProfile: string;
+    streamURL: string;
+    isLiveStream?: boolean;
+}
+interface Subtitle {
+    iso: string;
+    location: string;
+    name: string;
+}
+interface StreamObject_Assets {
+    scrubbingThumbnail: string;
+    subtitles: Subtitle[] | null;
+    preroll?: string;
+}
+interface StreamObject_Metadata {
+    broadcaster?: string;
+    broadcasters?: string[];
+    country?: string[];
+    credits?: string[];
+    description: string;
+    duration?: string;
+    genre?: string[];
+    isDubbed?: boolean;
+    language?: string[];
+    nicam?: string[] | null;
+    poster?: string;
+    prid?: string;
+    sourceIP?: string;
+    ageRating?: string;
+    title: string;
+    hasPreroll?: string;
+}
+export interface Section {
+    cssClasses?: string[];
+    start: number;
+    end: number;
+    title: string;
+}
+export interface Fragments {
+    sections: Section[];
+    startAtBeginOfFragment?: boolean;
+    startAtFragment?: number;
+    stopAtEndOfFragment?: boolean;
+}
+export interface StreamOptions {
+    sourceConfig?: SourceConfig;
+    fragments?: Fragments;
+    startOffset?: number;
+    liveOffset?: boolean;
+    liveProgramTime?: number;
+    endpoint?: string;
+    preferredDRM?: string;
+    prid?: string;
+}
+export interface UIComponents {
+    errorMessageOverlay?: ErrorMessageOverlay;
+    nicam?: Label<{
+        text: string;
+        cssClass: string;
+    }>;
+    subtitlesButton?: SettingsPanelItem | undefined;
+    qualityButton?: SettingsPanelItem | undefined;
+    watchFromStartButton?: Button<ButtonConfig> | undefined;
+    controlbar?: ControlBar | undefined;
+    adbutton?: Button<ButtonConfig> | undefined;
+    adlabel?: Label<{
+        text: string;
+        cssClass: string;
+    }> | undefined;
+    seekBar?: SeekBar | undefined;
+}
+export interface CustomMessageHandlerResult {
+    defaultActionRequired?: boolean;
+}
+export declare enum CustomMessages {
+    TOGGLE_SETTINGS_PANEL = "toggleSettingsPanel",
+    DO_PLAY_NEXT = "doPlayNext"
+}
+export {};

package/lib/types/interfaces.js

@@ -0,0 +1,6 @@
+export var CustomMessages;
+(function (CustomMessages) {
+    CustomMessages["TOGGLE_SETTINGS_PANEL"] = "toggleSettingsPanel";
+    CustomMessages["DO_PLAY_NEXT"] = "doPlayNext";
+})(CustomMessages || (CustomMessages = {}));
+//# sourceMappingURL=interfaces.js.map

package/lib/types/interfaces.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interfaces.js","sourceRoot":"","sources":["../../../src/types/interfaces.ts"],"names":[],"mappings":"AAuHA,MAAM,CAAN,IAAY,cAGX;AAHD,WAAY,cAAc;IACtB,+DAA6C,CAAA;IAC7C,6CAA2B,CAAA;AAC/B,CAAC,EAHW,cAAc,KAAd,cAAc,QAGzB"}

package/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@npo/player",
+  "version": "1.9.0",
+  "description": "NPO Player",
+  "author": "Publieke Omroep <player@npo.nl>",
+  "contributors": [
+    "Tim Haerkens",
+    "Sven van der Leest",
+    "Arjan Kruithof"
+  ],
+  "engines": {
+    "node": "^18.16.0"
+  },
+  "license": "ISC",
+  "main": "npoplayer",
+  "types": "npoplayer.d.ts",
+  "scripts": {
+    "build": "webpack --hot",
+    "build:scss": "npm run build:web-styles && npm run build:web-styles && npm run build:mobile-styles-min && npm run build:mobile-styles && cp src/scss/*.css dist",
+    "build:web-styles": "sass --no-source-map src/scss/npoplayer.scss src/scss/npoplayer.css",
+    "build:web-styles-min": "sass --no-source-map --style=compressed src/scss/npoplayer.scss src/scss/npoplayer.min.css",
+    "build:mobile-styles": "node-sass --no-source-map src/scss/npoplayer-mobile.scss src/scss/npoplayer-mobile.css",
+    "build:mobile-styles-min": "sass --no-source-map --style=compressed src/scss/npoplayer-mobile.scss src/scss/npoplayer-mobile.min.css",
+    "lint": "eslint src --fix",
+    "bundle": "npm run lint && ts-node build.ts && webpack && npm run build:scss",
+    "build:ts": "ts-node build.ts",
+    "test": "jest",
+    "test:ci": "node_modules/.bin/jest",
+    "version:dev": "npm version prerelease --preid=dev --no-git-tag-version"
+  },
+  "files": [
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md",
+    "lib",
+    "src/scss/components",
+    "src/scss/variants",
+    "src/scss/vars",
+    "src/scss/npoplayer.scss",
+    "src/scss/npoplayer.css"
+  ],
+  "devDependencies": {
+    "@babel/core": "^7.20.12",
+    "@babel/preset-env": "^7.20.2",
+    "@babel/preset-typescript": "^7.18.6",
+    "@types/fs-extra": "^11.0.1",
+    "@types/jest": "^29.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.58.0",
+    "@typescript-eslint/parser": "^5.58.0",
+    "babel-jest": "^28.1.3",
+    "babel-loader": "^8.3.0",
+    "css-loader": "^6.7.3",
+    "eslint": "^8.38.0",
+    "eslint-config-standard-with-typescript": "^34.0.1",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-n": "^15.7.0",
+    "eslint-plugin-promise": "^6.1.1",
+    "eslint-plugin-sonarjs": "^0.19.0",
+    "fs-extra": "^11.1.1",
+    "jest": "^28.1.3",
+    "jest-environment-jsdom": "^29.4.1",
+    "jest-sonar-reporter": "2.0.0",
+    "jest-transform-css": "^6.0.1",
+    "mini-css-extract-plugin": "^2.7.2",
+    "node-fetch": "^3.3.0",
+    "node-sass": "^7.0.3",
+    "sass": "^1.58.0",
+    "sass-loader": "^12.6.0",
+    "style-loader": "^3.3.1",
+    "ts-jest": "^28.0.8",
+    "ts-loader": "^9.4.2",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.9.5",
+    "webpack": "^5.75.0",
+    "webpack-cli": "^4.10.0",
+    "webpack-dev-server": "^4.11.1"
+  },
+  "dependencies": {
+    "@npotag/tag": "^2.0.0",
+    "bitmovin-player": "^8.125.0",
+    "bitmovin-player-ui": "^3.48.0"
+  },
+  "keywords": [
+    "video",
+    "player",
+    "stream"
+  ]
+}

package/src/scss/components/_advert.scss

@@ -0,0 +1,74 @@
+&.bmpui-ster-ad{
+    .bmpui-seekbar-playbackposition-marker{
+        display: none !important;
+    }
+    .bmpui-ui-controlbar{
+        &.bmpui-controlbar-middle{
+            display: none !important;
+        }
+        .bmpui-ui-rewindbutton, 
+        .bmpui-ui-forwardbutton,
+        .bmpui-ui-settingstogglebutton{
+            display: none !important;
+        }      
+        .bmpui-controlbar-bottom{
+            display: block !important;
+        }
+    }
+    .bmpui-ui-seekbar {
+        .bmpui-seekbar {
+            .bmpui-seekbar-bufferlevel {
+                background-color: var(--npo-player-white);
+                opacity: 0.6;
+            }
+
+            .bmpui-seekbar-backdrop {
+                background-color: var(--npo-player-white);
+                opacity: 0.3;
+            }
+
+            .bmpui-seekbar-playbackposition {
+                background: var(--npo-player-white);
+                backdrop-filter: blur(50px);
+                border-radius: 5px;
+            }
+        }
+    }
+    .bmpui-ui-hugeplaybacktogglebutton{
+        display: none !important;
+    }
+    .videoAdUiClickElement{
+        display: none;
+    }
+    .bmpui-adLabel{
+        position: relative;
+        padding-right: 15px;
+        font-family: var(--fontBold);
+        &::before{
+            content: "";
+            pointer-events: none;
+            position: absolute;
+            height: 44px;
+            width: 59px;
+            bottom: -12px;
+            left: -65px;
+            background-image: url("data:image/svg+xml,%3Csvg width='59' height='44' viewBox='0 0 39 30' fill='none' xmlns='http://www.w3.org/2000/svg'%3E%3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M0 15.0338L19.4156 0.414307L38.8238 15.0338L19.4156 29.5855L0 15.0338ZM19.4223 27.5128L36.0603 15.0303L19.4223 2.48968L2.76764 15.0301L19.4223 27.5128Z' fill='white'/%3E%3Cpath fill-rule='evenodd' clip-rule='evenodd' d='M13.2215 13.9887C12.4213 13.3085 11.7303 12.721 11.7303 11.9329C11.7303 11.2697 12.064 10.8895 12.6461 10.8895C12.8494 10.8895 13.5139 10.9733 13.6141 12.0211L15.2164 11.8445C15.0406 10.3315 14.1464 9.42878 12.8164 9.42878C11.1077 9.42878 10.1279 10.3468 10.1279 11.9472C10.1279 13.5345 11.202 14.4297 12.1495 15.2195C12.9488 15.8859 13.704 16.5152 13.704 17.4532C13.704 18.0625 13.3087 18.4261 12.6463 18.4261C12.0333 18.4261 11.6413 17.8635 11.5647 16.8842C11.4962 16.894 10.0231 17.1058 9.96039 17.1152C10.0361 18.5001 10.8656 19.8866 12.5614 19.8866C14.2547 19.8866 15.3066 18.8944 15.3066 17.297C15.3062 15.7618 14.1987 14.8196 13.2215 13.9887ZM15.7374 13.4513V12.1456H16.6171V10.0881H18.2065V12.1456H19.2708V13.4513H18.2067V17.8506C18.2067 18.2478 18.377 18.4748 18.746 18.4748H19.271V19.837C19.0583 19.8936 18.8736 19.922 18.4762 19.922C17.2843 19.922 16.6173 19.3688 16.6173 18.2048V13.4513H15.7374ZM26.2467 19.7803V12.1458H27.7649V13.0398H27.7933C28.1768 12.3871 28.8435 12.0041 29.5958 12.0041H29.922V13.6642C29.6383 13.5932 29.3688 13.5081 28.9002 13.5081C28.3611 13.5081 27.8358 13.8485 27.8358 14.5297V19.7803H26.2467ZM23.4859 17.5288C23.4599 18.3273 23.1512 18.6659 22.6083 18.6659C22.0409 18.6659 21.7284 18.2968 21.7284 17.4167V16.3098H25.0775V14.8908C25.0775 13.2164 24.4249 12.0528 22.6085 12.0528C20.7921 12.0528 20.1395 13.2164 20.1395 14.8908V17.133C20.1395 18.8073 20.7921 19.9714 22.6085 19.9714C24.2771 19.9714 24.9661 18.9917 25.0655 17.5288H23.4859ZM21.7284 14.6073C21.7284 13.7275 22.0409 13.3583 22.6083 13.3583C23.1761 13.3583 23.4882 13.7275 23.4882 14.6073V15.0049H21.7284V14.6073Z' fill='white'/%3E%3C/svg%3E%0A");
+        }
+    }
+    .bmpui-controlbar-textbuttons{
+        padding: 0px 40px 17% 0px !important;
+        .bmpui-ui-textbutton.ui-sterbutton{
+            padding: 14px 10px !important;
+            border: none !important;
+            border-radius: 6px !important;
+            height: fit-content !important;
+            width: fit-content !important;
+            .bmpui-label{
+                font-family: var(--fontNormal) !important;
+                font-size: 12px;
+                line-height: 0;
+                text-align: left;
+            }
+        }
+    }
+}

package/src/scss/components/_buffering.scss

@@ -0,0 +1,6 @@
+.bmpui-ui-buffering-overlay {
+    background-color: var(--npo-player-bufferingcolor);
+}
+.bmpui-ui-buffering-overlay-indicator {
+    background-image: url($buffering_indicator) !important;
+}

package/src/scss/components/_container.scss

@@ -0,0 +1,8 @@
+.bitmovinplayer-container {
+    font-style: normal !important;
+    overflow: visible;
+
+    ::selection {
+        background-color: var(--npo-player-primarycolor);
+    }
+}

package/src/scss/components/_controlbars.scss

@@ -0,0 +1,36 @@
+.bmpui-ui-controlbar {
+    background: var(--npo-player-bottomcolor);
+}
+
+.bmpui-controlbar-title {
+    top: 0;
+    bottom: auto;
+}
+
+.bmpui-controlbar-middle {
+    height: 100%;
+    display: flex;
+
+    .bmpui-container-wrapper {
+        display: flex;
+        flex-direction: row;
+        justify-content: space-evenly; //instead of space-between
+        align-items: center;
+        padding: 0px;
+        // gap: 67px;
+        width: 100%; //Fix for gap pushing buttons out of screen
+        margin: 0 auto;
+    }
+
+    button {
+        // height: 44px;
+        // width: 44px;
+        font-size: 2em;
+    }
+}
+
+.bmpui-controlbar-bottom {
+    button {
+        display: block;
+    }
+}

package/src/scss/components/_error.scss

@@ -0,0 +1,26 @@
+.bmpui-ui-errormessage-overlay {
+    .bmpui-ui-tvnoisecanvas{
+        display: none;
+    }
+    &::before{
+        content: "";
+        background-color: var(--npo-player-secondarycolor);
+        opacity: 0.7;
+        width: 100%;
+        height: 100%;
+        top: 0;
+        left: 0;
+        bottom: 0;
+        right: 0;
+        position: absolute;
+    }
+}
+.bmpui-ui-errormessage-label {
+    font-family: 'NPOSansBold';
+    font-weight: 700;
+    font-size: 22px;
+    line-height: 130%;
+    text-shadow: 0px 0px 10px rgba(0, 0, 0, 0.9);
+    padding: 15px 5px;
+    user-select: none;
+}

package/src/scss/components/_fonts.scss

@@ -0,0 +1,19 @@
+.bmpui-ui-label {
+    font-family: var(--fontBold);
+
+    &.bmpui-label-metadata-description {
+        font-family: var(--fontRegular) !important;
+    }
+}
+
+.bmpui-ui-selectbox {
+    font-family: var(--fontRegular) !important;
+}
+
+.bmpui-ui-errormessage-label {
+    font-family: var(--fontRegular) !important;
+}
+
+.bmpui-ui-playbacktimelabel {
+    font-family: var(--fontBold) !important;
+}

package/src/scss/components/_icons.scss

@@ -0,0 +1,241 @@
+.bmpui-ui-rewindbutton,
+.bmpui-ui-forwardbutton,
+.bmpui-ui-subtitlesettingstogglebutton,
+.bmpui-ui-settingstogglebutton,
+.bmpui-ui-fullscreentogglebutton,
+.bmpui-ui-playbacktogglebutton,
+.bmpui-ui-volumetogglebutton,
+.bmpui-ui-casttogglebutton,
+.bmpui-ui-airplaytogglebutton,
+.bmpui-ui-piptogglebutton,
+.bmpui-ui-audiotracksettingstogglebutton {
+    padding: 8px;
+    margin: 0;
+}
+
+.bmpui-controlbar-bottom {
+    .bmpui-container-wrapper {
+        gap: 8px;
+    }
+}
+
+/*Forward / backward */
+.bmpui-ui-rewindbutton {
+    background-image: url($icon_backwards);
+    background-size: contain;
+}
+
+.bmpui-ui-forwardbutton {
+    background-image: url($icon_forward);
+    background-size: contain;
+}
+
+.bmpui-ui-rewindbutton:hover,
+.bmpui-ui-forwardbutton:hover {
+    -webkit-filter: drop-shadow(0 0 1px #fff);
+    filter: drop-shadow(0 0 1px #fff);
+}
+
+/* Icon Play */
+&.bmpui-player-state-paused, &.bmpui-player-state-prepared, &.bmpui-player-state-finished {
+    .bmpui-ui-hugeplaybacktogglebutton {
+        .bmpui-image {
+            cursor: pointer;
+            animation: none !important;
+            position: relative;
+            background: none;
+            background-image: none !important;
+            display: flex;
+            align-items: center;
+            justify-content: center;
+            &:after, &:before{
+                content: "";
+                position: absolute;
+                height: 76px;
+                width: 76px;
+            }
+            &:hover{
+                &:after{
+                    background-size: 55% !important;
+                }
+            }
+            &:after{
+                background-image: url($icon_bigplay) !important;
+                background-repeat: no-repeat;
+                background-position: center;
+                transition: background-size linear 0.3s !important;
+                background-size: 40%;
+            }
+            &:before{
+                border-radius: 500px;
+                background: rgba(0, 0, 0, 0.5);
+            }
+        }
+        &:hover{
+            .bmpui-image{
+                &:before{
+                    background: linear-gradient(90deg, var(--npo-player-primarycolor) 0%, var(--npo-player-primarycolor-light) 100%);
+                    animation: gradientAnimation 2s linear infinite;
+                }
+            }
+        }
+    }
+
+    @container (min-width: 600px){
+        .bmpui-ui-hugeplaybacktogglebutton .bmpui-image {
+            &:after, &:before{
+                height: 88px;
+                width: 88px;
+            }
+        }
+    }
+
+    @container (min-width: 1200px){
+        .bmpui-ui-hugeplaybacktogglebutton .bmpui-image {
+            &:after, &:before{
+                height: 100px;
+                width: 100px;
+            }
+        }
+    }
+}
+
+@keyframes gradientAnimation {
+    0% {
+        background-position: 0% 50%;
+    }
+    50% {
+        background-position: 100% 50%;
+    }
+    100% {
+        background-position: 0% 50%;
+    }
+}
+
+// Loading icon, does not currently work
+&.bmpui-ui-uicontainer .bmpui-ui-hugeplaybacktogglebutton.bmpui-on .bmpui-image{
+    background: none !important;
+    background-position: center !important;
+    background-repeat: no-repeat !important;
+    background-size: 15% !important;
+    background-image:  url($icon_bigplay) !important;
+}
+&.bmpui-ui-uicontainer:not(.bmpui-player-state-prepared):not(.bmpui-player-state-playing):not(.bmpui-player-state-paused):not(.bmpui-player-state-finished) .bmpui-image {
+    background-image: none !important;
+    &:after{
+        animation: rotation 1s infinite linear;
+        background-image: url($icon_loading) !important;
+        background-repeat: no-repeat;
+        background-position: center;
+        background-size: 4em;
+    }
+}
+
+/* Icon Audio Quality */
+.bmpui-ui-subtitlesettingstogglebutton {
+    &.bmpui-off {
+        background-image: url($icon_subtitles);
+    }
+    &.bmpui-on {
+        background-image: url($icon_subtitles_active);
+    }
+}
+
+/* Icon Subtitles */
+.bmpui-ui-subtitlesettingstogglebutton {
+    &.bmpui-off {
+        background-image: url($icon_subtitles);
+    }
+    &.bmpui-on {
+        background-image: url($icon_subtitles_active);
+    }
+}
+
+/* Icon Small Play + Pause */
+.bmpui-ui-playbacktogglebutton {
+    &.bmpui-off {
+        background-image: url($icon_playbackplay);
+    }
+    &.bmpui-on {
+        background-image: url($icon_playbackpause);
+    }
+}
+
+@keyframes rotation {
+    from {
+        transform: rotate(0deg);
+    }
+    to {
+        transform: rotate(359deg);
+    }
+}
+
+.bmpui-ui-fullscreentogglebutton {
+    &.bmpui-off {
+        background-image: url($icon_fullscreen);
+    }
+    &.bmpui-on {
+        background-image: url($icon_fullscreen_active);
+    }
+}
+
+/* Icon Settings */
+.bmpui-ui-settingstogglebutton {
+    &.bmpui-off {
+        background-image: url($icon_settings);
+    }
+    &.bmpui-on {
+        background-image: url($icon_settings_active);
+    }
+}
+
+/* Icon Cast */
+.bmpui-ui-casttogglebutton {
+    &.bmpui-off {
+        background-image: url($icon_cast);
+    }
+    &.bmpui-on {
+        background-image: url($icon_cast_active);
+    }
+}
+
+/* Icon Airplay */
+.bmpui-ui-airplaytogglebutton {
+    &.bmpui-off {
+        background-image: url($icon_airplay);
+    }
+    &.bmpui-on {
+        background-image: url($icon_airplay_active);
+    }
+}
+
+/* Icon PIP */
+.bmpui-ui-piptogglebutton {
+    &.bmpui-off {
+        background-image: url($icon_pip);
+    }
+    &.bmpui-on {
+        background-image: url($icon_pip_active);
+    }
+}
+
+/* Icon Volume */
+.bmpui-ui-volumetogglebutton.bmpui-muted {
+    background-image: url($icon_volume_muted);
+}
+.bmpui-ui-volumetogglebutton.bmpui-unmuted[data-bmpui-volume-level-tens='1'],
+.bmpui-ui-volumetogglebutton.bmpui-unmuted[data-bmpui-volume-level-tens='2'],
+.bmpui-ui-volumetogglebutton.bmpui-unmuted[data-bmpui-volume-level-tens='3'],
+.bmpui-ui-volumetogglebutton.bmpui-unmuted[data-bmpui-volume-level-tens='4'] {
+    background-image: url($icon_volume_1);
+}
+.bmpui-ui-volumetogglebutton.bmpui-unmuted[data-bmpui-volume-level-tens='5'],
+.bmpui-ui-volumetogglebutton.bmpui-unmuted[data-bmpui-volume-level-tens='6'],
+.bmpui-ui-volumetogglebutton.bmpui-unmuted[data-bmpui-volume-level-tens='7'] {
+    background-image: url($icon_volume_2);
+}
+.bmpui-ui-volumetogglebutton.bmpui-unmuted[data-bmpui-volume-level-tens='8'],
+.bmpui-ui-volumetogglebutton.bmpui-unmuted[data-bmpui-volume-level-tens='9'],
+.bmpui-ui-volumetogglebutton.bmpui-unmuted[data-bmpui-volume-level-tens='10'] {
+    background-image: url($icon_volume_3);
+}