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

package/README.md

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

package/README.md.bak

@@ -6,12 +6,6 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
-* UNRELEASED
-    * major: delete usePlayerEvent hook
-    * major: replace uri attributes in types with url
-    * major: delete uri attributes from types
-    * minor: add purchase expiration to PurchaseEndpointPayload
-
 * 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 (url: string, name: string, description: string, skipDelayMs: number | null, adDurationMs: number, trackingContext?: any, // internal Tivio types
+    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;
-    url: string;
+    uri: string;
     durationMs: number;
     skipDelayMs: number | null;
     type: 'ad';
@@ -316,22 +316,6 @@ 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
@@ -354,14 +338,11 @@ export declare interface Channel {
     recentVideos: Video[];
 }
 
-/**
- * @public
- */
 export declare type ChannelSource = {
-    new (url: string, originalOptions: Record<string, any>, channelName: string, programName: string, programDescription: string, from: Date, to: Date): ChannelSource;
+    new (uri: string, originalOptions: Record<string, any>, channelName: string, programName: string, programDescription: string, from: Date, to: Date): ChannelSource;
     description: string;
     name: string;
-    url: string;
+    uri: string;
     from: Date;
     channelName: string;
     to: Date;
@@ -376,7 +357,7 @@ export declare type ChannelSource = {
  */
 export declare interface ChannelSourcePojo {
     type: 'ChannelSource';
-    url: string;
+    uri: string;
     originalOptions: any;
     channelName: string;
     programName: string;
@@ -625,38 +606,11 @@ export declare type DocumentOptions = Partial<{
 }>;
 
 export declare interface Drm {
-    encryption: VideoSourceEncryption;
-    /**
-     * Url to retrieve fairplay from.
-     */
-    certificateUrl?: string;
-    /**
-     * Url to send license to.
-     */
-    licenseUrl: string;
-    /**
-     * Headers with corresponding values to send to license server.
-     */
-    licenseRequestHeaders: {
-        [key: string]: string;
-    };
-}
-
-export declare enum DrmProvider {
+    configuration: FairplayDrmConfiguration | PlayreadyDrmConfiguration | WidevineDrmConfiguration;
     /**
-     * Original oktagon stream provider.
-     *
-     * https://streamonline.pl
+     * License string
      */
-    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"
+    license: string;
 }
 
 /**
@@ -675,76 +629,6 @@ 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
  */
@@ -771,6 +655,17 @@ 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
@@ -1355,22 +1250,6 @@ 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
  */
@@ -1490,9 +1369,9 @@ export declare type Player = {
  * @public
  */
 export declare interface PlayerCapability {
-    codec: VideoSourceCodec;
-    encryption: VideoSourceEncryption;
-    protocol: VideoSourceProtocol;
+    codec: 'h264' | 'h265';
+    encryption: 'fairplay' | 'none' | 'playready' | 'widevine';
+    protocol: 'dash' | 'hls' | 'mp4';
 }
 
 /**
@@ -1554,135 +1433,6 @@ 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
  */
@@ -1740,10 +1490,7 @@ export declare type PlayerProviderProps = {
     playerWrapperId?: string;
 };
 
-/**
- * @public
- */
-export declare type PlayerState = 'idle' | 'playing' | 'paused';
+declare type PlayerState = 'playing' | 'paused' | 'idle';
 
 /**
  * @public
@@ -1839,6 +1586,13 @@ export declare enum PlayerWrapperEventType {
  */
 export declare type PlayerWrapperEventTypeType = `${PlayerWrapperEventType}`;
 
+export declare interface PlayreadyDrmConfiguration {
+    /**
+     * Url to send license to.
+     */
+    playreadyLicenseUrl: string;
+}
+
 /**
  * @public
  */
@@ -1890,10 +1644,6 @@ 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[];
 }
 
 /**
@@ -1956,11 +1706,6 @@ 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".
          */
@@ -1970,21 +1715,21 @@ export declare type PurchaseEndpointPayload = {
          */
         id: string;
         /**
-         * True if delayed payment is confirmed but not charged yet, undefined in all other cases.
+         * Timestamp of the last change of the purchase - in this case it is timestamp when it was paid.
          */
-        isDelayedPayment?: boolean;
+        updated: number;
         /**
-         * Purchase status after change.
+         * True if delayed payment is confirmed but not charged yet, undefined in all other cases.
          */
-        newStatus: PurchaseStatus;
+        isDelayedPayment?: boolean;
         /**
          * Purchase status before change.
          */
         previousStatus: PurchaseStatus;
         /**
-         * Timestamp of the last change of the purchase - in this case it is timestamp when it was paid.
+         * Purchase status after change.
          */
-        updated: number;
+        newStatus: PurchaseStatus;
     };
     /**
      * Information about the monetization which has been bought by this purchase. Monetization definition may change in time so information provided here
@@ -2733,7 +2478,6 @@ export declare type TivioComponents = {
     WebTile: React_2.ComponentType<{
         item?: ItemsInRow;
     } & TilePropsPartial>;
-    ChannelContext: React_2.Context<TvChannel | undefined>;
 };
 
 /**
@@ -2860,7 +2604,6 @@ export declare type TivioHooks = {
         inviteCodeReset: () => void;
     };
     useChannelSource: UseChannelSource;
-    useTvChannel: UseTvChannel;
 };
 
 /**
@@ -2902,7 +2645,7 @@ export declare type TivioInternalHooks = {
     usePurchasesWithVideos: () => {
         purchases: Purchase[];
     };
-    useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean, videoId?: string) => {
+    useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean) => {
         subscriptions: PurchasableMonetization[];
     };
     useIsMonetizationPurchased: () => {
@@ -2970,7 +2713,7 @@ export declare type TivioJsBundleExposedApi = {
      * @param id - player wrapper id
      * @returns {Player} player wrapper instance
      */
-    getPlayerWrapper: (id: string) => Player;
+    getPlayer: (id: string) => Player;
     /**
      * Get tv channel by its id.
      * @param tvChannelId - tv channel id
@@ -3179,20 +2922,6 @@ 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;
@@ -3209,8 +2938,6 @@ export declare type Translation = {
     [key in LangCode]?: string;
 };
 
-export declare type TriggerType = 'scheduled' | 'manual';
-
 /**
  * @public
  */
@@ -3225,13 +2952,11 @@ export declare type TvAppProps = {
 export declare interface TvChannel extends RowItem {
     id: string;
     itemType: ROW_ITEM_TYPES.TV_CHANNEL;
-    type?: TvChannelType;
     name: string;
     path: string;
     country?: string;
     filters: string[];
     logo?: string;
-    logoPendingOverlayWidth?: string;
     hls: string;
     dash: string;
     /**
@@ -3248,18 +2973,7 @@ export declare interface TvChannel extends RowItem {
     price: number;
     cover: string;
     isPlayable: boolean;
-    url: string;
-}
-
-export declare enum TvChannelType {
-    /**
-     * Classic live tv channel
-     */
-    CLASSIC = "CLASSIC",
-    /**
-     * "Virtual" tv channel constructed from separate videos
-     */
-    VIRTUAL = "VIRTUAL"
+    uri: string;
 }
 
 export declare interface TvProgram {
@@ -3267,7 +2981,7 @@ export declare interface TvProgram {
     to: Date | null;
     name: string;
     description: string;
-    url: string;
+    uri: string;
     image: string;
     video: Video | null;
 }
@@ -3437,6 +3151,16 @@ export declare const useOrganizationSubscriptions: (onlyPurchasableSubscriptions
     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.
  *
@@ -3509,12 +3233,6 @@ export declare type User = {
     setActiveUserProfileId: (id: string) => void;
 };
 
-export declare enum UserGroup {
-    ALL = "all",
-    FREE = "free",
-    PREMIUM = "premium"
-}
-
 /**
  * @public
  */
@@ -3741,6 +3459,7 @@ export declare interface Video extends RowItem {
     urlName?: string;
     price: number | null;
     detailedPrice: DetailedPrice | null;
+    uri: string;
     url: string;
     adMonetizationId?: string;
     from?: Date;
@@ -3762,7 +3481,7 @@ export declare interface Video extends RowItem {
     removeFromFavorites: () => void;
     availability: VideoAvailability | null;
     sourceLanguages: LangCode[];
-    urlByLanguage: (lang: LangCode) => string | undefined;
+    uriByLanguage: (lang: LangCode) => string | undefined;
 }
 
 /**
@@ -3793,29 +3512,6 @@ 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
@@ -3873,9 +3569,8 @@ export declare interface ViewCountItem {
 /**
  * @public
  */
-export declare interface VirtualChannelSourcePojo {
+export declare interface VirtualChannelSourcePojo extends Omit<ChannelSourcePojo, 'type'> {
     type: 'VirtualChannelSource';
-    tvChannel: TvChannel;
     epg: TvProgram[];
 }
 
@@ -3883,22 +3578,22 @@ export declare interface VirtualChannelSourcePojo {
  * @public
  */
 export declare type VodExternalSource = {
-    new (url: string, monetizationId: string, name: string, description: string, originalOptions: Record<string, any>): VodTivioSource;
+    new (uri: string, monetizationId: string, name: string, description: string, originalOptions: Record<string, any>): VodTivioSource;
     type: 'vod_external';
     description: string;
     name: string;
-    url: string;
+    uri: string;
 };
 
 /**
  * @public
  */
 export declare type VodTivioSource = {
-    new (url: string, videoId: string, name: string, description: string, adMonetizationId?: string): VodTivioSource;
+    new (uri: string, videoId: string, name: string, description: string, adMonetizationId?: string): VodTivioSource;
     type: 'vod_tivio';
     description: string;
     name: string;
-    url: string;
+    uri: string;
 };
 
 declare interface VodTivioSourcePojo {
@@ -3906,7 +3601,7 @@ declare interface VodTivioSourcePojo {
     description: string;
     path: string;
     name: string;
-    url: string;
+    uri: string;
     poster?: string;
     adMonetizationId?: string;
     availability: VideoAvailability | null;
@@ -4022,6 +3717,13 @@ 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
  */