@tivio/sdk-react 5.0.3-alpha-4 → 6.0.0

package/README.md

@@ -6,6 +6,13 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* 6.0.0
+    * major: delete usePlayerEvent hook
+    * major: replace uri attributes in types with url
+    * major: delete uri attributes from types
+    * minor: add purchase expiration to PurchaseEndpointPayload
+    * minor: add optional videoId parameter to useOrganizationSubscription hook
+
 * 5.0.2
     * patch: export hook useChannelSource
 

package/README.md.bak

@@ -6,6 +6,13 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* 6.0.0
+    * major: delete usePlayerEvent hook
+    * major: replace uri attributes in types with url
+    * major: delete uri attributes from types
+    * minor: add purchase expiration to PurchaseEndpointPayload
+    * minor: add optional videoId parameter to useOrganizationSubscription hook
+
 * 5.0.2
     * patch: export hook useChannelSource
 

package/dist/index.d.ts

@@ -90,13 +90,13 @@ declare type AdSegment = {
  * @public
  */
 export declare type AdSource = {
-    new (uri: string, name: string, description: string, skipDelayMs: number | null, adDurationMs: number, trackingContext?: any, // internal Tivio types
+    new (url: 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;
+    url: string;
     durationMs: number;
     skipDelayMs: number | null;
     type: 'ad';
@@ -316,6 +316,22 @@ export declare type BetOffer = {
     time: Date;
 };
 
+/**
+ * @public
+ */
+export declare interface BufferChunk {
+    startMs: number;
+    endMs: number;
+}
+
+/**
+ * @public
+ */
+export declare interface BufferPercentChunk extends BufferChunk {
+    startPercent: number;
+    endPercent: number;
+}
+
 /**
  * rejects when bundle is not available
  * @public
@@ -338,11 +354,14 @@ export declare interface Channel {
     recentVideos: Video[];
 }
 
+/**
+ * @public
+ */
 export declare type ChannelSource = {
-    new (uri: string, originalOptions: Record<string, any>, channelName: string, programName: string, programDescription: string, from: Date, to: Date): ChannelSource;
+    new (url: string, originalOptions: Record<string, any>, channelName: string, programName: string, programDescription: string, from: Date, to: Date): ChannelSource;
     description: string;
     name: string;
-    uri: string;
+    url: string;
     from: Date;
     channelName: string;
     to: Date;
@@ -357,7 +376,7 @@ export declare type ChannelSource = {
  */
 export declare interface ChannelSourcePojo {
     type: 'ChannelSource';
-    uri: string;
+    url: string;
     originalOptions: any;
     channelName: string;
     programName: string;
@@ -606,11 +625,38 @@ export declare type DocumentOptions = Partial<{
 }>;
 
 export declare interface Drm {
-    configuration: FairplayDrmConfiguration | PlayreadyDrmConfiguration | WidevineDrmConfiguration;
+    encryption: VideoSourceEncryption;
+    /**
+     * Url to retrieve fairplay from.
+     */
+    certificateUrl?: string;
     /**
-     * License string
+     * Url to send license to.
+     */
+    licenseUrl: string;
+    /**
+     * Headers with corresponding values to send to license server.
      */
-    license: string;
+    licenseRequestHeaders: {
+        [key: string]: string;
+    };
+}
+
+export declare enum DrmProvider {
+    /**
+     * Original oktagon stream provider.
+     *
+     * https://streamonline.pl
+     */
+    STREAMONLINE = "streamonline",
+    /**
+     * New stream provider for tivio. Also known as insys video technologies.
+     *
+     * https://insysvideotechnologies.com
+     * https://www.drm.cloud
+     * https://videokit.cloud
+     */
+    INSYS = "insys"
 }
 
 /**
@@ -629,6 +675,76 @@ export declare enum DurationUnits {
     MONTH = "month"
 }
 
+/**
+ * Represents a SendGrid transactional template.
+ */
+export declare interface EmailTemplate {
+    /**
+     * The ID of the transactional template.
+     */
+    id: string;
+    /**
+     * The name of the transactional template.
+     * @maxLength 100
+     */
+    name: string;
+    /**
+     * Defines the generation of the template.
+     * @format 'dynamic' | 'legacy'
+     */
+    generation: 'dynamic' | 'legacy';
+    /**
+     * The date and time the template was last updated.
+     */
+    updated_at: string;
+    /**
+     * An array of versions associated with the template.
+     */
+    versions: EmailTemplateVersion[];
+}
+
+export declare interface EmailTemplateVersion {
+    /**
+     * ID of the transactional template version.
+     */
+    id: string;
+    /**
+     * ID of the transactional template.
+     */
+    template_id: string;
+    /**
+     * Set the version as the active version associated with the template.
+     * Only one version of a template can be active.
+     * The first version created for a template will automatically be set to Active.
+     */
+    active: boolean;
+    /**
+     * Name of the transactional template version.
+     */
+    name: string;
+    /**
+     * Subject of the new transactional template version.
+     * @maxLength 255
+     */
+    subject: string;
+    /**
+     * The date and time that this transactional template version was updated.
+     */
+    updated_at: string;
+    /**
+     * If true, plain_content is always generated from html_content. If false, plain_content is not altered.
+     */
+    generate_plain_content: boolean;
+    /**
+     * The editor used in the UI.
+     */
+    editor: string;
+    /**
+     * A Thumbnail preview of the template's html content.
+     */
+    thumbnail_url: string;
+}
+
 /**
  * @public
  */
@@ -655,17 +771,6 @@ export declare type ExternalTvConfig = {
     splashScreenBackgroundColor?: string;
 };
 
-export declare interface FairplayDrmConfiguration {
-    /**
-     * Url to retrieve fairplay certificate from.
-     */
-    fairplayCertificateUrl: string;
-    /**
-     * Url to send license to.
-     */
-    fairplayLicenseUrl: string;
-}
-
 /**
  * @throws if fetch fails
  * @public
@@ -1250,6 +1355,22 @@ export declare type NewVoucher = {
     expirationDate: Date | number;
 };
 
+declare interface Notification_2 {
+    id: string;
+    name: string;
+    targeting: UserGroup;
+    templateId: string;
+    thumbnailUrl?: string;
+    triggerType: TriggerType;
+    status?: NotificationStatus;
+}
+export { Notification_2 as Notification }
+
+export declare enum NotificationStatus {
+    PLANNED = "planned",
+    SENT = "sent"
+}
+
 /**
  * @public
  */
@@ -1369,9 +1490,9 @@ export declare type Player = {
  * @public
  */
 export declare interface PlayerCapability {
-    codec: 'h264' | 'h265';
-    encryption: 'fairplay' | 'none' | 'playready' | 'widevine';
-    protocol: 'dash' | 'hls' | 'mp4';
+    codec: VideoSourceCodec;
+    encryption: VideoSourceEncryption;
+    protocol: VideoSourceProtocol;
 }
 
 /**
@@ -1433,6 +1554,135 @@ export declare type PlayerConfig = {
     };
 };
 
+/**
+ * @public
+ */
+export declare interface PlayerEngineConfig {
+    getDrmConfiguration?: () => Promise<Drm | undefined>;
+    encryption?: string;
+    isAd?: boolean;
+    positionMs?: number;
+    url: string;
+}
+
+/**
+ * @public
+ */
+export declare type PlayerEngineEvent = 'bufferingchange' | 'bufferedinfochange' | 'statechange' | 'loaded' | 'loadfailed' | 'togglefullscreen' | 'durationchange' | 'busychange' | 'trackschanged' | 'abort' | 'canplay' | 'canplaythrough' | 'emptied' | 'ended' | 'error' | 'loadeddata' | 'loadedmetadata' | 'loadstart' | 'pause' | 'play' | 'playing' | 'progress' | 'ratechange' | 'seeked' | 'seeking' | 'stalled' | 'suspend' | 'timeupdate' | 'volumechange' | 'waiting' | 'click' | 'fullscreenchange';
+
+/**
+ * @public
+ */
+export declare type PlayerEngineFactory = (videoElement: HTMLVideoElement) => PlayerEngineInterface;
+
+/**
+ * @public
+ */
+export declare interface PlayerEngineInterface {
+    /**
+     * Loads video but keeps it paused
+     */
+    load(config: PlayerEngineConfig): Promise<void>;
+    /**
+     * Loads and starts playing video
+     * @throws
+     */
+    play(config: PlayerEngineConfig): Promise<void>;
+    pause(): Promise<void>;
+    unpause(): Promise<void>;
+    isPaused(): boolean;
+    stop(): Promise<void>;
+    addEventListener<T>(event: PlayerEngineEvent, callback: PlayerEngineListener<T>): void;
+    addEventListener(event: 'statechange', callback: PlayerEngineListener<PlayerState>): void;
+    addEventListener(event: 'bufferingchange', callback: PlayerEngineListener<boolean>): void;
+    addEventListener(event: 'bufferedinfochange', callback: PlayerEngineListener<BufferPercentChunk[]>): void;
+    addEventListener(event: 'togglefullscreen', callback: PlayerEngineListener<boolean>): void;
+    removeEventListener<T>(event: PlayerEngineEvent, listener: PlayerEngineListener<T>): void;
+    /**
+     * @returns currently playing audio track in ISO 639-1 format ('cs', 'en' etc.) or null if not available
+     */
+    getActiveAudioTrack?: () => LangCode | null;
+    /**
+     * @returns currently selected subtitles in  ISO 639-1 format ('cs', 'en' etc.)
+     */
+    getActiveSubtitles?: () => LangCode | null;
+    /**
+     * Returns currently available audio tracks of currently playing video.
+     *
+     * @returns array of available audio tracks in ISO 639-1 format ('cs', 'en' etc.)
+     */
+    getAudioTracks?: () => LangCode[];
+    /**
+     * @returns array of available subtitles in ISO 639-1 format ('cs', 'en' etc.)
+     */
+    getSubtitles?: () => LangCode[];
+    getCurrentQuality?: (lang?: LangCode) => Track | null;
+    getQualities?: () => Track[];
+    /**
+     * options.force to change quality immediately, otherwise it takes some time
+     * (because previously loaded higher or lower quality chunks are not discarded)
+     */
+    selectQuality?: (track: Track, options?: {
+        force: boolean;
+    }) => void;
+    /**
+     * Is automatic selection of video quality based on network bandwidth (aka ABR) enabled?
+     */
+    isAdaptationEnabled?: () => boolean;
+    /**
+     * Turn on automatic selection of video quality based on network bandwidth (aka ABR).
+     * It is enabled by default.
+     * It automatically becomes disabled when selectQuality() is called.
+     */
+    enableAdaptation?: (enable: boolean) => void;
+    goFullScreen(): Promise<void>;
+    /**
+     * @param {number} value 0-1
+     */
+    changeVolume(value: number): void;
+    getState(): PlayerState;
+    isIdle(): boolean;
+    mute(): void;
+    unmute(): void;
+    /**
+     * @returns {number} duration in seconds
+     */
+    getDuration(): number;
+    seekTo(ms: number): void;
+    /**
+     * Changes audio track of currently playing video.
+     *
+     * @param {LangCode} audioTrack - audio track to select in ISO 639-1 format ('cs', 'en' etc.)
+     */
+    selectAudioTrack?: (audioTrack: LangCode) => void;
+    /**
+     * Changes audio track of currently playing video.
+     * @param {LangCode} langCode - subtitles to select in ISO 639-1 format ('cs', 'en' etc.) or null to disable subtitles
+     */
+    selectSubtitles?: (langCode: LangCode | null) => void;
+    /**
+     * Changes audio track of currently playing video.
+     *
+     * @param {number} playbackSpeed - playback speed to select (1 = normal speed, 2 = twice as fast, etc.)
+     */
+    selectPlaybackSpeed?: (playbackSpeed: number) => void;
+    destroy(): Promise<void>;
+    getBufferedInfo?(): BufferChunk[];
+    lastQuality: number | null;
+}
+
+/**
+ * @public
+ */
+export declare type PlayerEngineListener<T> = (value: T) => any;
+
+/**
+ * @public
+ */
+export declare interface PlayerEngineOptions {
+    seekDebounceMs?: number;
+}
+
 /**
  * @public
  */
@@ -1490,7 +1740,10 @@ export declare type PlayerProviderProps = {
     playerWrapperId?: string;
 };
 
-declare type PlayerState = 'playing' | 'paused' | 'idle';
+/**
+ * @public
+ */
+export declare type PlayerState = 'idle' | 'playing' | 'paused';
 
 /**
  * @public
@@ -1586,13 +1839,6 @@ export declare enum PlayerWrapperEventType {
  */
 export declare type PlayerWrapperEventTypeType = `${PlayerWrapperEventType}`;
 
-export declare interface PlayreadyDrmConfiguration {
-    /**
-     * Url to send license to.
-     */
-    playreadyLicenseUrl: string;
-}
-
 /**
  * @public
  */
@@ -1644,6 +1890,10 @@ export declare interface PurchasableMonetization extends Monetization {
      * If not set or set to false, users cannot buy it as a voucher.
      */
     isPurchasableAsVoucher?: boolean;
+    /**
+     * Returns array of tag ids of monetization placements
+     */
+    tagIds: string[];
 }
 
 /**
@@ -1706,6 +1956,11 @@ export declare type PurchaseEndpointPayload = {
          * Two-letter upper-case country code according to ISO-3166 format (see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
          */
         countryIsoCode?: LocationField['countryIsoCode'];
+        /**
+         * Purchase expiration timestamp. Only present for "subscription" monetization type. This timestamp does not mean it will
+         * really expire at this timestamp - additional payment of this subscription can occur so expiration timestamp may be increased.
+         */
+        expiration?: number;
         /**
          * Gateway name or "voucher".
          */
@@ -1714,22 +1969,22 @@ export declare type PurchaseEndpointPayload = {
          * Tivio ID of the purchase.
          */
         id: string;
-        /**
-         * Timestamp of the last change of the purchase - in this case it is timestamp when it was paid.
-         */
-        updated: number;
         /**
          * True if delayed payment is confirmed but not charged yet, undefined in all other cases.
          */
         isDelayedPayment?: boolean;
+        /**
+         * Purchase status after change.
+         */
+        newStatus: PurchaseStatus;
         /**
          * Purchase status before change.
          */
         previousStatus: PurchaseStatus;
         /**
-         * Purchase status after change.
+         * Timestamp of the last change of the purchase - in this case it is timestamp when it was paid.
          */
-        newStatus: PurchaseStatus;
+        updated: number;
     };
     /**
      * Information about the monetization which has been bought by this purchase. Monetization definition may change in time so information provided here
@@ -2463,7 +2718,7 @@ export declare type TivioComponents = {
         onEnded?: () => any;
     }>;
     TvApp: React_2.ComponentType<TvAppProps>;
-    FeatureSupportCheck: React_2.ComponentType;
+    FeatureSupportCheck: React_2.ComponentType<{}>;
     CustomerScreen: React_2.ComponentType<{
         screenId: string;
     }>;
@@ -2645,7 +2900,7 @@ export declare type TivioInternalHooks = {
     usePurchasesWithVideos: () => {
         purchases: Purchase[];
     };
-    useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean) => {
+    useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean, videoId?: string) => {
         subscriptions: PurchasableMonetization[];
     };
     useIsMonetizationPurchased: () => {
@@ -2713,7 +2968,7 @@ export declare type TivioJsBundleExposedApi = {
      * @param id - player wrapper id
      * @returns {Player} player wrapper instance
      */
-    getPlayer: (id: string) => Player;
+    getPlayerWrapper: (id: string) => Player;
     /**
      * Get tv channel by its id.
      * @param tvChannelId - tv channel id
@@ -2851,11 +3106,6 @@ export declare type TivioVodSource = SourceBase & StartAndContinuePosition & {
  */
 export declare const TivioWidget: React_2.ForwardRefExoticComponent<Omit<TivioWidgetProps, "ref"> & React_2.RefAttributes<TivioWidgetRef>>;
 
-/**
- * @public
- */
-export declare const TivioWidgetApp: React_2.ForwardRefExoticComponent<Omit<TivioWidgetProps, "ref"> & React_2.RefAttributes<unknown>>;
-
 /**
  * @public
  */
@@ -2882,8 +3132,6 @@ export declare interface TivioWidgetProps {
         width: number;
         x: number;
     }) => any;
-    navigateFunction?: any;
-    isFocused?: boolean;
 }
 
 /**
@@ -2922,6 +3170,20 @@ export declare interface TopWatchItem {
     viewCount: number;
 }
 
+/**
+ * @public
+ * Video track
+ */
+declare interface Track {
+    id: number;
+    /**
+     * e.g. 480, 720, 1080
+     */
+    height: number;
+    active: boolean;
+    language: LangCode;
+}
+
 declare type TransactionInfo = {
     type: 'transaction';
     name: string;
@@ -2938,12 +3200,13 @@ export declare type Translation = {
     [key in LangCode]?: string;
 };
 
+export declare type TriggerType = 'scheduled' | 'manual';
+
 /**
  * @public
  */
 export declare type TvAppProps = {
     customer: CustomerId;
-    navigateFunction: (url: string) => void;
 };
 
 /**
@@ -2973,7 +3236,7 @@ export declare interface TvChannel extends RowItem {
     price: number;
     cover: string;
     isPlayable: boolean;
-    uri: string;
+    url: string;
 }
 
 export declare interface TvProgram {
@@ -2981,7 +3244,7 @@ export declare interface TvProgram {
     to: Date | null;
     name: string;
     description: string;
-    uri: string;
+    url: string;
     image: string;
     video: Video | null;
 }
@@ -3146,21 +3409,16 @@ export declare const useMarkers: () => Marker[] | null;
 
 /**
  * @public
+ *
+ * @param onlyPurchasableSubscriptions When it is true, it returns only enabled subscriptions.
+ * @param videoId If it is not defined returns all subscriptions except one time payment.
+ * When it is set, returns only subscriptions which is described in tagIds for video.
+ * @returns Array of subscriptions according to set parameters
  */
-export declare const useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean) => {
+export declare const useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean, videoId?: string) => {
     subscriptions: PurchasableMonetization[];
 };
 
-/**
- * @public
- */
-export declare type UsePlayerEvent = <T = any>(eventName: string) => T | null;
-
-/**
- * @public
- */
-export declare const usePlayerEvent: UsePlayerEvent;
-
 /**
  * Is used to mark purchase in recovery state as PAID.
  *
@@ -3233,6 +3491,12 @@ export declare type User = {
     setActiveUserProfileId: (id: string) => void;
 };
 
+export declare enum UserGroup {
+    ALL = "all",
+    FREE = "free",
+    PREMIUM = "premium"
+}
+
 /**
  * @public
  */
@@ -3459,7 +3723,6 @@ export declare interface Video extends RowItem {
     urlName?: string;
     price: number | null;
     detailedPrice: DetailedPrice | null;
-    uri: string;
     url: string;
     adMonetizationId?: string;
     from?: Date;
@@ -3481,7 +3744,7 @@ export declare interface Video extends RowItem {
     removeFromFavorites: () => void;
     availability: VideoAvailability | null;
     sourceLanguages: LangCode[];
-    uriByLanguage: (lang: LangCode) => string | undefined;
+    urlByLanguage: (lang: LangCode) => string | undefined;
 }
 
 /**
@@ -3512,6 +3775,29 @@ export declare type VideoExternals = JojExternals | MallTvExternals | OktagonExt
 
 declare type VideoPath = string;
 
+export declare enum VideoSourceCodec {
+    H264 = "h264",
+    H265 = "h265"
+}
+
+export declare enum VideoSourceEncryption {
+    NONE = "none",
+    WIDEVINE = "widevine",
+    FAIRPLAY = "fairplay",
+    PLAYREADY = "playready"
+}
+
+/**
+ * Lower number = higher priority.
+ */
+export declare type VideoSourcePriority = 1 | 2 | 3 | 4 | 5;
+
+export declare enum VideoSourceProtocol {
+    HLS = "hls",
+    DASH = "dash",
+    MP4 = "mp4"
+}
+
 /**
  * Video type.
  * @public
@@ -3578,22 +3864,22 @@ export declare interface VirtualChannelSourcePojo extends Omit<ChannelSourcePojo
  * @public
  */
 export declare type VodExternalSource = {
-    new (uri: string, monetizationId: string, name: string, description: string, originalOptions: Record<string, any>): VodTivioSource;
+    new (url: string, monetizationId: string, name: string, description: string, originalOptions: Record<string, any>): VodTivioSource;
     type: 'vod_external';
     description: string;
     name: string;
-    uri: string;
+    url: string;
 };
 
 /**
  * @public
  */
 export declare type VodTivioSource = {
-    new (uri: string, videoId: string, name: string, description: string, adMonetizationId?: string): VodTivioSource;
+    new (url: string, videoId: string, name: string, description: string, adMonetizationId?: string): VodTivioSource;
     type: 'vod_tivio';
     description: string;
     name: string;
-    uri: string;
+    url: string;
 };
 
 declare interface VodTivioSourcePojo {
@@ -3601,7 +3887,7 @@ declare interface VodTivioSourcePojo {
     description: string;
     path: string;
     name: string;
-    uri: string;
+    url: string;
     poster?: string;
     adMonetizationId?: string;
     availability: VideoAvailability | null;
@@ -3717,13 +4003,6 @@ export declare type WhereFilterArray = [string, WhereFilterOp, any];
 
 declare type WhereFilterOp = '<' | '<=' | '==' | '!=' | '>=' | '>' | 'array-contains' | 'in' | 'array-contains-any' | 'not-in';
 
-export declare interface WidevineDrmConfiguration {
-    /**
-     * Url to send license to.
-     */
-    widevineLicenseUrl: string;
-}
-
 /**
  * @public
  */