@tivio/sdk-react 3.5.0 → 3.5.1

package/dist/types/customPlayer.types.d.ts

@@ -0,0 +1,171 @@
+import { Empty } from './common';
+export declare type ChannelSource = {
+    new (uri: string, originalOptions: Record<string, any>, channelName: string, programName: string, programDescription: string, from: Date, to: Date): ChannelSource;
+    description: string;
+    name: string;
+    uri: string;
+    from: Date;
+    channelName: string;
+    to: Date;
+    type: 'channel';
+    watchWithoutAdsRecommendation: {
+        showPurchaseDialog: () => void;
+    } | null;
+};
+export declare type AdSource = {
+    new (uri: string, name: string, description: string, skipDelayMs: number | null, adDurationMs: number, trackingContext?: any, // internal Tivio types
+    adMarker?: any, // internal Tivio types
+    packInfo?: any, // internal Tivio types
+    provider?: any): AdSource;
+    description: string;
+    name: string;
+    uri: string;
+    durationMs: number;
+    skipDelayMs: number | null;
+    type: 'ad';
+    /**
+     * true if is skippable and skip countdown has passed
+     */
+    canSkip: boolean;
+    /**
+     * true ad if is skippable after some skipDelayMs (if it is skippable, skipDelayMs is defined)
+     */
+    isSkippable: boolean;
+    /**
+     * Skip ad. Only works when canSkip is true
+     */
+    skip: () => void;
+    /**
+     * Order in ad break (ad break is a group of ads played right after each other)
+     */
+    order: number;
+    /**
+     * Total number of ads in ad break (ad break is a group of ads played right after each other)
+     */
+    totalCount: number;
+    secondsToEnd: number;
+    secondsToSkippable: number | null;
+};
+export declare type VodTivioSource = {
+    new (uri: string, videoId: string, name: string, description: string, adMonetizationId?: string): VodTivioSource;
+    type: 'vod_tivio';
+    description: string;
+    name: string;
+    uri: string;
+};
+export declare type VodExternalSource = {
+    new (uri: string, monetizationId: string, name: string, description: string, originalOptions: Record<string, any>): VodTivioSource;
+    type: 'vod_external';
+    description: string;
+    name: string;
+    uri: string;
+};
+export declare type InputSource = AdSource | ChannelSource | VodTivioSource | VodExternalSource;
+declare type PlayerState = 'playing' | 'paused' | 'idle';
+export interface PlayerInterface {
+    pause: () => void;
+    /**
+     * unpause
+     */
+    play: () => void;
+    /**
+     * @param {number} ms - milliseconds relative to start of video (relative to 0 ms)
+     *  or in case of TV programs relative to start of the program (relative to source.from ms)
+     */
+    seekTo: (ms: number) => void;
+    /**
+     * Source to be passed to player.
+     *
+     * Depending on autoplay settings it should either start playing
+     * immediately or just be loaded by player and stay paused.
+     */
+    setSource: (source: InputSource | null) => void;
+    /**
+     * volume in [0,1]
+     */
+    setVolume?: (volume: number) => void;
+    mute?: () => void;
+    /**
+     * restore volume to previous value
+     */
+    unmute?: () => void;
+}
+export declare type PlayerWrapper = {
+    /**
+     * Report that playback of video has finished
+     */
+    onPlaybackEnded: () => void;
+    /**
+     * Report video progress in milliseconds
+     */
+    onTimeChanged: (ms: number) => void;
+    /**
+     * Report that video state changed
+     */
+    onStateChanged: (state: PlayerState) => void;
+    /**
+     * Send source to Tivio
+     */
+    onSourceChanged: (source: InputSource | null) => void;
+    /**
+     * Report that video failed to load (never started playing)
+     */
+    onLoadError: (error: Error) => void;
+    /**
+     * Report that video failed during playback (successfully loaded and then failed, e.g. part of stream is invalid)
+     */
+    onError: (error: Error) => void;
+    /**
+     * Unpause video
+     */
+    play: () => void;
+    /**
+     * Pause video
+     */
+    pause: () => void;
+    /**
+     * Currently playing source
+     */
+    source: InputSource | null;
+    events: {
+        isSupported: (even: string) => boolean;
+        addListener: <T = any>(event: string, cb: (value: T) => Empty) => void;
+        removeListener: <T = any>(event: string, cb: (value: T) => Empty) => void;
+        removeAllListeners: () => void;
+    };
+    /**
+     * Register a low level player that implements player methods, like play video, change volume, etc.
+     */
+    register: (playerInterface: PlayerInterface) => void;
+    /**
+     * duration of current source in ms (both setter and getter)
+     */
+    durationMs: number | null;
+    isPlaybackStarted: boolean;
+    isPaused: boolean;
+    isPlaying: boolean;
+    isIdle: boolean;
+    error: Error | null;
+    /**
+     * Replay the video that finished playback
+     */
+    replay: () => void;
+    /**
+     * Retry to play a video that failed to start playing (e.g. due to a network error)
+     */
+    retry: () => void;
+    togglePlayPause: () => void;
+    seekTo: (ms: number) => void;
+    /**
+     * set volume to value between 0,1
+     */
+    setVolume: (volume: number) => void;
+    /**
+     * change volume by value between -1,1
+     */
+    changeVolumeBy: (volume: number) => void;
+    setMuted: (muted: boolean) => void;
+    toggleMuted: () => void;
+};
+export declare type UsePlayerEvent = <T = any>(eventName: string) => T | null;
+export {};

package/dist/types/types.d.ts

@@ -0,0 +1,174 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+/**
+ * Export public client side API
+ */
+import type { Monetization, Video, User } from '@tivio/common';
+import type React from 'react';
+declare type RemoteProviderProps = {
+    disableUnmounting?: boolean;
+    language?: string;
+};
+declare enum LangCode {
+    CS = "cs",
+    DE = "de",
+    EN = "en",
+    FR = "fr",
+    PL = "pl",
+    SK = "sk",
+    SP = "sp"
+}
+declare type Widget = {
+    id: string;
+    channels: Channel[];
+    isEnabled: boolean | null;
+    name: string | null;
+    recentVideos: Video[] | null;
+    widgetId: string | null;
+    lastVideo: Video | null;
+};
+declare type Channel = {
+    id: string;
+    name: string;
+    header: string;
+    headerLogo: string;
+    recentVideos: Video[];
+};
+declare type Section = {
+    id: string;
+    name: string;
+    channel: Channel;
+    videos: Video[];
+};
+declare type Chapter = any;
+declare type Purchase = {
+    isPurchased: boolean;
+    monetizationId: string;
+    videoId: string;
+    status: string;
+    video: Video | null;
+};
+declare type Marker = {
+    id: string;
+    type: string;
+    from: Date;
+    to: Date;
+    count?: number;
+    fromMs?: number;
+    toMs?: number;
+};
+declare type BetOffer = {
+    betService: string;
+    league: string;
+    odds: {
+        winner: string;
+        rate: number;
+    }[];
+    sport: string;
+    opponent1: string;
+    opponent2: string;
+    time: Date;
+};
+export interface TivioWidgetProps {
+    id: string;
+    ref: React.MutableRefObject<TivioWidgetRef>;
+    onEnabled?: (enabled: boolean) => any;
+    onBlur?: (event: {
+        key: string;
+        width: number;
+        x: number;
+    }) => any;
+}
+export interface TivioWidgetRef {
+    focus: (args: {
+        x?: number;
+    }) => void;
+    handleKey: (key: string) => ({
+        handled: boolean;
+        x: number;
+    });
+    unfocus: () => ({
+        x: number;
+    });
+}
+interface VodTivioSourcePojo {
+    type: 'VodTivioSource';
+    description: string;
+    path: string;
+    name: string;
+    uri: string;
+    poster?: string;
+    adMonetizationId?: string;
+}
+interface ChannelSourcePojo {
+    type: 'ChannelSource';
+    uri: string;
+    originalOptions: any;
+    channelName: string;
+    programName: string;
+    programDescription: string;
+    from: Date;
+    to: Date;
+    poster?: string;
+}
+declare type VideoPath = string;
+interface WebPlayerProps {
+    id: string;
+    source?: VodTivioSourcePojo | ChannelSourcePojo | VideoPath | null;
+    onEnded?: () => any;
+    /**
+     * If this function is specified, then "Back" button is shown in top right corner.
+     */
+    onBack?: () => void;
+    className?: string;
+    /**
+     * default false
+     *
+     * If you choose `autoplay` make sure that autoplay is allowed in the specific situation.
+     * In some cases it may not be allowed, e.g. before the user interacted with the site, and the video
+     * will stay paused.
+     *
+     * Source: https://developer.mozilla.org/en-US/docs/Web/Media/Autoplay_guide
+     */
+    autoplay?: boolean;
+    /**
+     * default false
+     */
+    canReplay?: boolean;
+    /**
+     * default false
+     */
+    showMarkers?: boolean;
+    /**
+     * number[] is array of keyboard event.which numeric codes
+     * (see https://keycode.info/)
+     */
+    customShortcuts?: Partial<{
+        toggleFullscreen: number[];
+        togglePause: number[];
+        toggleMute: number[];
+        jumpForward: number[];
+        jumpBack: number[];
+        volumeUp: number[];
+        volumeDown: number[];
+    }>;
+    /**
+     * default true
+     */
+    enableKeyboardShortcuts?: boolean;
+    onProgress?: (event: React.ChangeEvent<HTMLVideoElement>) => void;
+    /**
+     * @deprecated this callback is never called. Will be removed in @tivio/sdk-react version 4
+     */
+    onPlayerControllerCreated?: (playerController: any) => void;
+}
+declare type TivioSources = {
+    AdSource: any;
+    ChannelSource: any;
+    VodExternalSource: any;
+    VodTivioSource: any;
+};
+export type { RemoteProviderProps, WebPlayerProps, Marker, BetOffer, Purchase, Chapter, Widget, Channel, Section, Video, TivioSources, User, Monetization, VodTivioSourcePojo, ChannelSourcePojo, };
+export { LangCode };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tivio/sdk-react",
-    "version": "3.5.0",
+    "version": "3.5.1",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "source": "src/index.ts",
@@ -9,17 +9,16 @@
         "access": "public"
     },
     "scripts": {
-        "build": "bash ./scripts/build_prod.sh && yarn typesRollup",
-        "build:dev": "bash ./scripts/build_dev.sh && yarn typesRollup",
-        "build:local": "bash ./scripts/build_with_local_bundle.sh && yarn typesRollup",
+        "build": "bash ./scripts/build_prod.sh",
+        "build:dev": "bash ./scripts/build_dev.sh",
+        "build:local": "bash ./scripts/build_with_local_bundle.sh",
         "start": "yarn ts-node ./scripts/start.ts",
         "test": "jest --config=./jest.config.js --coverage",
         "clean": "rm -rf dist",
         "prepublishOnly": "yarn && yarn run build && yarn ts-node ./scripts/prepublish.ts",
         "postpublish": "yarn ts-node ./scripts/postpublish.ts",
         "publish:alpha": "npm publish --tag alpha",
-        "check:cycles": "npx madge --circular src/**/*",
-        "typesRollup": "yarn ts-node ./scripts/typesRollup.ts"
+        "check:cycles": "npx madge --circular src/**/*"
     },
     "peerDependencies": {
         "react": "^17.0.0",
@@ -29,7 +28,7 @@
         "@material-ui/core": "^4.11.2",
         "@material-ui/icons": "^4.11.2",
         "@sentry/browser": "^6.1.0",
-        "@tivio/common": "1.1.87",
+        "@tivio/common": "1.1.88",
         "dayjs": "^1.11.0",
         "es7-object-polyfill": "^1.0.1",
         "firebase": "^8.2.3",
@@ -46,12 +45,10 @@
         "yup": "^0.32.9"
     },
     "devDependencies": {
-        "@microsoft/api-extractor": "^7.23.0",
         "@testing-library/jest-dom": "^5.11.9",
         "@testing-library/react": "^11.2.3",
         "@testing-library/react-hooks": "^5.0.3",
         "@testing-library/user-event": "^12.1.10",
-        "@tivio/types": "*",
         "@types/jest": "^26.0.15",
         "@types/node": "^12.0.0",
         "@types/node-fetch": "^2.5.8",