@npo/player 1.22.4 → 1.23.0

package/lib/src/services/segmentHandlers/handleSegmentSeek.d.ts

@@ -0,0 +1,5 @@
+import { PlayerContext, Segment } from 'types/interfaces';
+export declare const handleSegmentSeek: (playerContext: PlayerContext, segment: Segment) => (e: any) => void;
+export declare const getSeekTarget: (event: any) => number;
+export declare const isSeekOutsideSegment: (seekTarget: number, segment: Segment) => boolean;
+export declare const clampSeekTarget: (seekTarget: number, segment: Segment) => number;

package/lib/src/services/segmentHandlers/handleSegmentSeek.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/src/services/segmentHandlers/handleSegmentTimeChanged.d.ts

@@ -0,0 +1,2 @@
+import { PlayerContext, Segment } from 'types/interfaces';
+export declare const handleSegmentTimeChanged: (playerContext: PlayerContext, segment: Segment) => (e: any) => void;

package/lib/src/services/segmentHandlers/handleSegmentTimeChanged.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/src/services/segmentHandlers/initSegment.d.ts

@@ -0,0 +1,7 @@
+import { Fragment, PlayerContext, Segment } from 'types/interfaces';
+type SegmentOrFragment = {
+    segment?: Segment;
+    fragment?: Fragment;
+};
+export declare const initSegment: (playerContext: PlayerContext, options: SegmentOrFragment) => void;
+export {};

package/lib/src/services/segmentHandlers/initSegment.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/src/services/segmentHandlers/setSegmentMarkers.d.ts

@@ -0,0 +1,2 @@
+import { Segment, TimeLineMarker } from 'types/interfaces';
+export declare function setSegmentMarkers(segment: Segment, title: string): Array<TimeLineMarker>;

package/lib/src/services/segmentHandlers/setSegmentMarkers.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/src/services/services.d.ts

@@ -0,0 +1,14 @@
+import { ApiPayload, Fragment, PlayerContext, Profile, Segment, TimeLineMarker, LocalStorageData, LocalStorageValues } from 'types/interfaces';
+import { AVType } from '@npotag/tag/dist/types/src/streamTracker';
+export declare class NpoPlayerServices {
+    getAVType(avType: string): AVType;
+    keyboardHandler(playerContext: PlayerContext, e: KeyboardEvent): void;
+    convertFragmentToSegment(fragment: Fragment): Segment;
+    segmentMarkersHandler(segment: Segment, title: string): Array<TimeLineMarker>;
+    decideProfile(playerContext: PlayerContext, preferredDRM?: string): Promise<Profile>;
+    verifyDRM(playerContext: PlayerContext, payload: ApiPayload): Promise<void>;
+    setStoredUserPrefs(key: LocalStorageValues, value: any): void;
+    getStoredUserPrefs(): LocalStorageData;
+    handleUserPrefs(playerContext: PlayerContext): void;
+    setAccessibilityAttributes(playerContext: PlayerContext): void;
+}

package/lib/src/types/events.d.ts

@@ -0,0 +1,91 @@
+export declare enum PlayerEvent {
+    Ready = "ready",
+    Play = "play",
+    Playing = "playing",
+    Paused = "paused",
+    Seek = "seek",
+    Seeked = "seeked",
+    TimeShift = "timeshift",
+    TimeShifted = "timeshifted",
+    VolumeChanged = "volumechanged",
+    Muted = "muted",
+    Unmuted = "unmuted",
+    PlayerResized = "playerresized",
+    PlaybackFinished = "playbackfinished",
+    Error = "error",
+    Warning = "warning",
+    StallStarted = "stallstarted",
+    StallEnded = "stallended",
+    AudioChanged = "audiochanged",
+    AudioAdded = "audioadded",
+    AudioRemoved = "audioremoved",
+    VideoQualityChanged = "videoqualitychanged",
+    AudioQualityChanged = "audioqualitychanged",
+    VideoDownloadQualityChange = "videodownloadqualitychange",
+    AudioDownloadQualityChange = "audiodownloadqualitychange",
+    VideoDownloadQualityChanged = "videodownloadqualitychanged",
+    AudioDownloadQualityChanged = "audiodownloadqualitychanged",
+    VideoPlaybackQualityChanged = "videoplaybackqualitychanged",
+    AudioPlaybackQualityChanged = "audioplaybackqualitychanged",
+    TimeChanged = "timechanged",
+    CueParsed = "cueparsed",
+    CueEnter = "cueenter",
+    CueUpdate = "cueupdate",
+    CueExit = "cueexit",
+    SegmentPlayback = "segmentplayback",
+    Metadata = "metadata",
+    MetadataParsed = "metadataparsed",
+    MetadataChanged = "metadatachanged",
+    VideoAdaptation = "videoadaptation",
+    AudioAdaptation = "audioadaptation",
+    DownloadFinished = "downloadfinished",
+    SegmentRequestFinished = "segmentrequestfinished",
+    AdManifestLoaded = "admanifestloaded",
+    AdStarted = "adstarted",
+    OverlayAdStarted = "overlayadstarted",
+    AdQuartile = "adquartile",
+    AdSkipped = "adskipped",
+    AdClicked = "adclicked",
+    AdInteraction = "adinteraction",
+    AdLinearityChanged = "adlinearitychanged",
+    AdBreakStarted = "adbreakstarted",
+    AdBreakFinished = "adbreakfinished",
+    AdFinished = "adfinished",
+    AdError = "aderror",
+    VRViewingDirectionChange = "vrviewingdirectionchange",
+    VRViewingDirectionChanged = "vrviewingdirectionchanged",
+    VRStereoChanged = "vrstereochanged",
+    CastAvailable = "castavailable",
+    CastStopped = "caststopped",
+    CastStart = "caststart",
+    CastStarted = "caststarted",
+    CastWaitingForDevice = "castwaitingfordevice",
+    SourceLoaded = "sourceloaded",
+    SourceUnloaded = "sourceunloaded",
+    PeriodSwitch = "periodswitch",
+    PeriodSwitched = "periodswitched",
+    DVRWindowExceeded = "dvrwindowexceeded",
+    SubtitleAdded = "subtitleadded",
+    SubtitleRemoved = "subtitleremoved",
+    ShowAirplayTargetPicker = "showairplaytargetpicker",
+    AirplayAvailable = "airplayavailable",
+    AirplayChanged = "airplaychanged",
+    Destroy = "destroy",
+    PlaybackSpeedChanged = "playbackspeedchanged",
+    DurationChanged = "durationchanged",
+    ViewModeChanged = "viewmodechanged",
+    ModuleReady = "moduleready",
+    SubtitleEnable = "subtitleenable",
+    SubtitleEnabled = "subtitleenabled",
+    SubtitleDisable = "subtitledisable",
+    SubtitleDisabled = "subtitledisabled",
+    VideoQualityAdded = "videoqualityadded",
+    VideoQualityRemoved = "videoqualityremoved",
+    AudioQualityAdded = "audioqualityadded",
+    AudioQualityRemoved = "audioqualityremoved",
+    TargetLatencyChanged = "targetlatencychanged",
+    LatencyModeChanged = "latencymodechanged",
+    LicenseValidated = "licensevalidated",
+    DrmLicenseAdded = "drmlicenseadded",
+    AspectRatioChanged = "aspectratiochanged"
+}

package/lib/src/types/interfaces.d.ts

@@ -1,11 +1,24 @@
-import { type SourceConfig } from 'bitmovin-player';
+import { PlayerEventCallback, type SourceConfig } from 'bitmovin-player';
 import { type ErrorMessageOverlay, type Label, ControlBar, SettingsPanelItem, Button, SeekBar, CastToggleButton, SettingsPanel } from 'bitmovin-player-ui';
 import { type NPOTag, type PageTracker } from '@npotag/tag';
 import { ButtonConfig } from 'bitmovin-player-ui/dist/js/framework/components/button';
+import NpoPlayer from '../npoplayer';
+import { NpoPlayerAPI } from '../services/npoPlayerAPI/npoPlayerAPI';
+export { Technology } from 'bitmovin-player';
 export interface Profile {
     profileName: string;
     drm: string;
 }
+export interface Segment {
+    inpoint: number;
+    outpoint: number;
+    duration: number;
+}
+export interface EventListeners {
+    liveStreamHandleTimeChangedCallback?: PlayerEventCallback;
+    segmentHandleTimeChangedCallback?: PlayerEventCallback;
+    segmentSeekFunctionCallback?: PlayerEventCallback;
+}
 export interface StreamObject {
     stream: StreamObject_Stream;
     metadata: StreamObject_Metadata;
@@ -13,6 +26,11 @@ export interface StreamObject {
     user: {
         type: 'plus' | 'anonymous';
     };
+    segment?: Segment;
+}
+export interface PlayerContext {
+    player: NpoPlayerAPI;
+    npoplayer: NpoPlayer;
 }
 export interface ApiPayload {
     baseURL: string;
@@ -34,7 +52,7 @@ export interface DRMProfile {
 export interface NPOTagObject {
     npoTagInstance: NPOTag | undefined;
     heartbeatInterval: number | undefined;
-    pageTracker: PageTracker | null;
+    pageTracker: PageTracker | undefined;
 }
 interface StreamObject_Stream {
     avType: string;
@@ -53,7 +71,7 @@ interface Subtitle {
 }
 interface StreamObject_Assets {
     scrubbingThumbnail: string;
-    subtitles: Subtitle[] | null;
+    subtitles: Subtitle[] | undefined;
     preroll?: string;
 }
 export interface StreamObject_Metadata {
@@ -75,21 +93,17 @@ export interface StreamObject_Metadata {
     title: string;
     hasPreroll?: string;
 }
-export interface Section {
-    cssClasses?: string[];
-    start: number;
-    end: number;
+interface FragmentSection {
+    time: number;
+    duration: number;
     title: string;
 }
-export interface Fragments {
-    sections: Section[];
-    startAtBeginOfFragment?: boolean;
-    startAtFragment?: number;
-    stopAtEndOfFragment?: boolean;
+export interface Fragment {
+    sections: FragmentSection[];
 }
 export interface StreamOptions {
     sourceConfig?: SourceConfig;
-    fragments?: Fragments;
+    fragments?: Fragment;
     startOffset?: number;
     liveOffset?: boolean;
     liveProgramTime?: number;
@@ -121,7 +135,7 @@ export interface UIComponents {
     }> | undefined;
     seekBar?: SeekBar | undefined;
     chromeCastButton?: CastToggleButton | undefined;
-    settingsPanel?: SettingsPanel | undefined;
+    settingsPanels?: SettingsPanel[] | undefined;
 }
 export interface CustomMessageHandlerInterface {
     defaultActionRequired?: boolean;
@@ -166,6 +180,11 @@ export declare enum NpoPlayerUIVariants {
     AUDIO = "audio",
     AD = "ad"
 }
+export declare enum ViewMode {
+    Inline = "inline",
+    Fullscreen = "fullscreen",
+    PictureInPicture = "pictureinpicture"
+}
 export interface PlayNext {
     showPlayNext?: boolean;
     duration?: number;
@@ -179,4 +198,9 @@ export type TimeLineMarker = {
     duration?: number;
     cssClasses?: string[];
 };
-export {};
+export declare enum LocalStorageValues {
+    IS_MUTED = "ismuted",
+    VOLUME = "volume",
+    SUBTITLES_ENABLED = "subtitles_enabled"
+}
+export type LocalStorageData = Partial<Record<LocalStorageValues, string | number>>;

package/lib/{js → src}/ui/components/adbutton.d.ts

@@ -1,5 +1,5 @@
 import { Button } from 'bitmovin-player-ui';
-import type NpoPlayer from '../../../npoplayer';
+import type NpoPlayer from '../../npoplayer';
 export declare function createAdButton(npoplayer: NpoPlayer): Button<{
     cssClass: string;
     text: string;

package/lib/{js → src}/ui/components/adlabel.d.ts

@@ -1,5 +1,5 @@
 import { Label } from 'bitmovin-player-ui';
-import type NpoPlayer from '../../../npoplayer';
+import type NpoPlayer from '../../npoplayer';
 export declare function createAdLabel(npoplayer: NpoPlayer): Label<{
     text: string;
     cssClass: string;

package/lib/{js → src}/ui/components/audio/controlbar.d.ts

@@ -1,3 +1,3 @@
 import { ControlBar } from 'bitmovin-player-ui';
-import type NpoPlayer from '../../../../npoplayer';
+import type NpoPlayer from '../../../npoplayer';
 export declare function createAudioControlBar(npoplayer: NpoPlayer): ControlBar;

package/lib/{js → src}/ui/components/buttons.d.ts

@@ -1,12 +1,12 @@
 import { type PlayerAPI } from 'bitmovin-player';
 import { Button, ControlBar } from 'bitmovin-player-ui';
-import type NpoPlayer from '../../../npoplayer';
+import type NpoPlayer from '../../npoplayer';
 export declare function createMiddleButtons(player: PlayerAPI): ControlBar;
-export declare function createRewindButton(player: PlayerAPI | null): Button<{
+export declare function createRewindButton(player: PlayerAPI | undefined): Button<{
     cssClass: string;
     ariaLabel: string;
 }>;
-export declare function createForwardButton(player: PlayerAPI | null): Button<{
+export declare function createForwardButton(player: PlayerAPI | undefined): Button<{
     cssClass: string;
     ariaLabel: string;
 }>;

package/lib/src/ui/components/controlbar.d.ts

@@ -0,0 +1,3 @@
+import { ControlBar } from 'bitmovin-player-ui';
+import type NpoPlayer from '../../npoplayer';
+export declare function createControlBar(npoplayer: NpoPlayer): ControlBar;

package/lib/{js → src}/ui/components/ctabar.d.ts

@@ -1,9 +1,9 @@
 import { Button, Container, Label } from 'bitmovin-player-ui';
-import type NpoPlayer from '../../../npoplayer';
+import type NpoPlayer from '../../npoplayer';
 import { type PlayerAPI } from 'bitmovin-player';
 import { ButtonConfig } from 'bitmovin-player-ui/dist/js/framework/components/button';
 import { LabelConfig } from 'bitmovin-player-ui/dist/js/framework/components/label';
-import { NpoPlayerUIVariants } from '../../../types/interfaces';
+import { NpoPlayerUIVariants } from '../../types/interfaces';
 export declare function createCTABar(player: PlayerAPI, npoplayer: NpoPlayer, variant: NpoPlayerUIVariants): Container<{
     components: (Button<ButtonConfig> | Label<LabelConfig>)[];
     cssClasses: string[];

package/lib/src/ui/components/nativemobile/controlbar.d.ts

@@ -0,0 +1,3 @@
+import { PlayerAPI } from 'bitmovin-player';
+import { ControlBar } from 'bitmovin-player-ui';
+export declare function createControlBar(player: PlayerAPI): ControlBar;

package/lib/src/ui/components/nativemobile/topbar.d.ts

@@ -0,0 +1,3 @@
+import { TitleBar } from 'bitmovin-player-ui';
+import { PlayerAPI } from 'bitmovin-player';
+export declare function createTopBar(player: PlayerAPI): TitleBar;

package/lib/{js → src}/ui/components/playnext.d.ts

@@ -1,6 +1,6 @@
 import { Container } from 'bitmovin-player-ui';
 import { type PlayerAPI } from 'bitmovin-player';
-import type NpoPlayer from '../../../npoplayer';
+import type NpoPlayer from '../../npoplayer';
 export declare function createPlayNextScreen(player: PlayerAPI, npoplayer: NpoPlayer): Container<{
     components: import("bitmovin-player-ui").Button<{
         cssClass: string;

package/lib/src/{js/ui → ui}/components/seekbar.d.ts

@@ -1,5 +1,5 @@
 import { Container, PlaybackTimeLabel, SeekBar } from 'bitmovin-player-ui';
-import type NpoPlayer from '../../../npoplayer';
+import type NpoPlayer from '../../npoplayer';
 export declare function createSeekBar(npoplayer: NpoPlayer): Container<{
     components: (PlaybackTimeLabel | SeekBar)[];
     cssClasses: string[];

package/lib/src/{js/ui → ui}/components/settingspanel.d.ts

@@ -1,4 +1,4 @@
 import { SettingsPanel } from 'bitmovin-player-ui';
-import type NpoPlayer from '../../../npoplayer';
+import type NpoPlayer from '../../npoplayer';
 import { PlayerAPI } from 'bitmovin-player';
 export declare function createSettingsPanel(npoplayer: NpoPlayer | PlayerAPI): SettingsPanel;

package/lib/{js → src}/ui/components/titlebar.d.ts

@@ -1,3 +1,3 @@
 import { TitleBar } from 'bitmovin-player-ui';
-import type NpoPlayer from '../../../npoplayer';
+import type NpoPlayer from '../../npoplayer';
 export declare function createTitleBar(npoplayer: NpoPlayer): TitleBar;

package/lib/src/ui/components/topbar.d.ts

@@ -0,0 +1,3 @@
+import { TitleBar } from 'bitmovin-player-ui';
+import NpoPlayer from 'npoplayer';
+export declare function createTopBar(npoplayer: NpoPlayer): TitleBar;

package/lib/src/ui/handlers/accessibilityhandler.test.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/src/ui/handlers/domhandlers.d.ts

@@ -0,0 +1,3 @@
+import { StreamObject } from 'types/interfaces';
+import { PlayerAPI } from 'bitmovin-player';
+export declare function handleLiveStreamNoDvr(player: PlayerAPI, streamObject: StreamObject): void;

package/lib/src/ui/handlers/domhandlers.test.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/lib/{js → src}/ui/handlers/nicamhandler.d.ts

@@ -1,6 +1,6 @@
 import { PlayerAPI } from 'bitmovin-player';
 import { UIManager } from 'bitmovin-player-ui';
 import { StreamObject, StreamOptions } from 'types/interfaces';
-export declare function processNicam(streamObject: StreamObject, nicamElement: HTMLElement | null, streamOptions: StreamOptions | null): void;
+export declare function processNicam(streamObject: StreamObject, nicamElement: HTMLElement | undefined, streamOptions: StreamOptions | undefined): void;
 export declare function addNicamIcon(character: string, nicamElement: Element): void;
-export declare function showNicamAfterUiDelay(player: PlayerAPI, uiManager: UIManager | null): void;
+export declare function showNicamAfterUiDelay(player: PlayerAPI, uiManager: UIManager | undefined): void;

package/lib/src/ui/handlers/nicamhandler.test.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/lib/{js → src}/ui/handlers/playnextstreen.test.d.ts

@@ -1,6 +1,6 @@
+import '@testing-library/jest-dom';
 declare global {
     interface Window {
         bitmovin: any;
     }
 }
-export {};

package/lib/src/{js/ui → ui}/handlers/streamhandler.d.ts

@@ -1,4 +1,4 @@
-import { type StreamObject, type StreamOptions } from '../../../types/interfaces';
+import { PlayerContext, type StreamObject, type StreamOptions } from '../../types/interfaces';
 import { PlayerAPI, SourceConfig } from 'bitmovin-player';
 import { UIManager } from 'bitmovin-player-ui';
-export declare function processStream(streamObject: StreamObject | undefined, container: HTMLElement, streamOptions: StreamOptions | null, player: PlayerAPI, uiManager: UIManager, sourceConfig: SourceConfig): void;
+export declare function processStream(streamObject: StreamObject | undefined, container: HTMLElement, streamOptions: StreamOptions | undefined, player: PlayerAPI, uiManager: UIManager | undefined, sourceConfig: SourceConfig, playerContext: PlayerContext): void;

package/lib/{js → src}/ui/nativemobileuicontainer.d.ts

@@ -1,5 +1,5 @@
 import { UIContainer } from 'bitmovin-player-ui';
 import { PlayerAPI } from 'bitmovin-player';
-import { CustomMessageHandlerInterface, CustomMessages } from '../../types/interfaces';
+import { CustomMessageHandlerInterface, CustomMessages } from '../types/interfaces';
 export declare function sendCustomMessage(message: CustomMessages, data?: CustomMessageHandlerInterface): CustomMessageHandlerInterface;
 export declare function nativeMobileUIContainer(player: PlayerAPI): UIContainer;

package/lib/src/ui/nativemobileuifactory.test.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/lib/{js → src}/ui/uicontainer.d.ts

@@ -1,6 +1,5 @@
-import type NpoPlayer from '../../npoplayer';
+import type NpoPlayer from '../npoplayer';
 import { UIContainer } from 'bitmovin-player-ui';
 import { PlayerAPI } from 'bitmovin-player';
-import { NpoPlayerUIVariants } from '../../types/interfaces';
+import { NpoPlayerUIVariants } from '../types/interfaces';
 export declare function createUIContainer(npoplayer: NpoPlayer, player: PlayerAPI, variant: NpoPlayerUIVariants, container: HTMLElement): UIContainer;
-export declare function removeUIContainer(container: HTMLElement): void;

package/lib/tests/mocks/mockNpoplayer.js

@@ -1,3 +1,12 @@
+import { NpoPlayerServices } from '../../src/services/services';
+const settingsPanelMock = {
+    isShown: jest.fn().mockReturnValue(true),
+    hide: jest.fn(),
+    activePage: jest.fn(),
+    navigationStack: jest.fn(),
+    settingsPanelEvents: jest.fn(),
+    hideTimeout: jest.fn()
+};
 export const mockNpoPlayer = {
     playerConfig: {
         key: jest.fn().mockReturnValue('mock-key'),
@@ -18,20 +27,12 @@ export const mockNpoPlayer = {
     },
     sourceConfig: {},
     streamObject: {},
-    uiManager: null,
+    uiManager: undefined,
     canceledPlayNextScreen: false,
     npoTag: undefined,
-    fragment: null,
     logEmitter: {},
     uiComponents: {
-        settingsPanel: {
-            isShown: jest.fn().mockReturnValue(true),
-            hide: jest.fn(),
-            activePage: jest.fn(),
-            navigationStack: jest.fn(),
-            settingsPanelEvents: jest.fn(),
-            hideTimeout: jest.fn(),
-        },
+        settingsPanels: [settingsPanelMock, settingsPanelMock]
     },
     container: document.createElement('div'),
     initPlayer: jest.fn(),
@@ -39,7 +40,7 @@ export const mockNpoPlayer = {
     createUIManager: jest.fn(),
     doError: jest.fn(),
     player: {
-        getCurrentTime: jest.fn().mockReturnValue(10),
+        getCurrentTime: jest.fn().mockReturnValue(10)
     },
     streamTracker: {
         start: jest.fn(),
@@ -54,7 +55,7 @@ export const mockNpoPlayer = {
         stop: jest.fn(),
         windowed: jest.fn(),
         time: jest.fn(),
-        seek: jest.fn(),
+        seek: jest.fn()
     },
     adBreakActive: false,
     streamOptions: {},
@@ -63,10 +64,10 @@ export const mockNpoPlayer = {
     version: '',
     drmProfile: {},
     variant: '',
+    playerContext: {},
     isShowingPlayNextScreen: false,
-    keyPress: function (e) {
-        jest.fn();
-    },
+    userPreferences: {},
+    eventListeners: undefined,
     setVolume: function (volume) {
         jest.fn();
     },
@@ -115,4 +116,6 @@ export const mockNpoPlayer = {
     updateMarkers: function () {
         jest.fn();
     },
+    npoplayerServices: new NpoPlayerServices(),
+    mockNpoPlayer: undefined
 };

package/lib/tests/mocks/mockPlayerAPI.d.ts

@@ -0,0 +1,3 @@
+/// <reference types="jest" />
+import { PlayerAPI } from 'bitmovin-player';
+export declare const mockPlayerAPI: jest.Mocked<PlayerAPI>;