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

package/dist/index.d.ts

@@ -140,6 +140,14 @@ export declare interface Advertisement extends RowItem {
     type?: string | null;
 }
 
+export declare type AdvertisementAnalyticParams = {
+    adFramework?: string;
+    adOrder: number;
+    adProvider?: string;
+    adTitle?: string;
+    videoId: string;
+};
+
 /**
  * @public
  */
@@ -198,14 +206,22 @@ export declare enum AnalyticsConversionTargetBase {
 }
 
 export declare interface AnalyticsInterface {
-    reportAdvertisementPlay: () => void;
+    reportAdvertisementPlay: (params: AdvertisementAnalyticParams) => void;
     reportAdvertisementProgress: () => void;
     reportElementClick: (elementId: string) => void;
     reportLocationChange: (path: string, pathParam?: string) => void;
     createMonetizationPurchase: () => void;
     completeMonetizationPurchase: (status: AnalyticsConversionStatus, monetizationId?: string) => void;
     reportVideoPlay: (status: AnalyticsConversionStatus, videoId: string) => void;
-    reportVideoProgress: (videoId: string, videoDuration: number, checkpoint: number) => void;
+    reportVideoProgress: (data: {
+        checkpoint: number;
+        organizationId?: string;
+        seriesId?: string;
+        videoDuration: string;
+        videoId: string;
+        videoMonetizationId?: string;
+        videoType?: VideoType;
+    }) => void;
 }
 
 /**
@@ -399,6 +415,7 @@ export declare interface ConfirmationOverlayPayloadBase {
 
 /**
  * Entity aggregate conversion statistics per day
+ * TODO in future change structure, new used like array item
  */
 export declare interface ConversionAnalytic {
     /**
@@ -588,6 +605,14 @@ export declare type DocumentOptions = Partial<{
     subscribeOnChanges: boolean;
 }>;
 
+export declare interface Drm {
+    configuration: FairplayDrmConfiguration | PlayreadyDrmConfiguration | WidevineDrmConfiguration;
+    /**
+     * License string
+     */
+    license: string;
+}
+
 /**
  * @public
  */
@@ -630,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
@@ -671,6 +707,31 @@ export declare interface GenericOnCallError extends Error {
     details?: Record<string, string>;
 }
 
+export declare interface GetBaseAnalyticsRequest {
+    /**
+     * Id of organization to return analytics data.
+     */
+    organizationId: string;
+    /**
+     * Date in string with format e.g. '2023-04-19'.
+     */
+    startDate: string;
+    /**
+     * Date in string with format e.g. '2023-04-26'.
+     */
+    endDate: string;
+}
+
+export declare interface GetConversionAnalyticsRequest extends GetBaseAnalyticsRequest {
+}
+
+export declare interface GetMonetizationsAnalyticsRequest extends GetBaseAnalyticsRequest {
+}
+
+export declare interface GetMonetizationsAnalyticsResponse {
+    monetizationsAnalytics: MonetizationSummaryItem[];
+}
+
 /**
  * Share singleton instance
  * @public
@@ -748,6 +809,18 @@ export declare interface GetSourceUrlResponse {
      * Which sources did client (or cloud function) has already tried out.
      */
     sourceHistory: string[];
+    /**
+     * DRM configuration to {@link url} if source is encrypted.
+     */
+    drm?: Drm;
+}
+
+export declare interface GetViewAnalyticsResponse {
+    viewCountAnalytics: ViewCountItem[];
+    topWatched: TopWatchItem[];
+}
+
+export declare interface GetViewsAnalyticsRequest extends GetBaseAnalyticsRequest {
 }
 
 /**
@@ -1121,11 +1194,51 @@ export declare type MonetizationsSelectOverlayState = {
     closeMonetizationsSelectOverlay: () => void;
 };
 
+export declare interface MonetizationSummaryItem {
+    /**
+     * Unix timestamp at which the data is aggregated
+     */
+    date: number;
+    /**
+     * Monetization under the videos played, if not filled it is free
+     */
+    monetizationId: string;
+    /**
+     * Sum of successful (new and regular) payment price in current period
+     */
+    totalPrice: number;
+    /**
+     * Count of new payments in the current period
+     */
+    newPaymentCount: number;
+    /**
+     * Count of payments cancelled in in the current period
+     */
+    cancelledPaymentCount: number;
+    /**
+     * Count of payments made regularly like in the previous period
+     */
+    regularPaymentCount: number;
+    /**
+     * Price which was charged independent on price list (full and discounted)
+     */
+    paymentPrice: number;
+    /**
+     * Monetization type frequency
+     */
+    monetizationFrequency: MONETIZATION_FREQUENCY;
+    /**
+     * For PPV payments there will be videoId for which payment charged
+     * If not filled it is not PPV
+     */
+    videoId?: string;
+}
+
 /**
  * @public
  * @TODO change to enum
  */
-export declare type MonetizationType = 'advertisement' | 'transaction' | 'subscription';
+export declare type MonetizationType = 'advertisement' | 'transaction' | 'subscription' | 'display';
 
 /**
  * TODO: Duplicate, because we can't import types from core-js.
@@ -1221,7 +1334,11 @@ export declare enum PLATFORM {
      */
     MOBILE = "MOBILE",
     WEB = "WEB",
-    TV = "TV"
+    TV = "TV",
+    /**
+     * @deprecated Used only in big query. In the future we'll migrate to undefined value and delete this.
+     */
+    UNKNOWN = "unknown"
 }
 
 /**
@@ -1469,6 +1586,13 @@ export declare enum PlayerWrapperEventType {
  */
 export declare type PlayerWrapperEventTypeType = `${PlayerWrapperEventType}`;
 
+export declare interface PlayreadyDrmConfiguration {
+    /**
+     * Url to send license to.
+     */
+    playreadyLicenseUrl: string;
+}
+
 /**
  * @public
  */
@@ -1919,6 +2043,9 @@ declare interface RowBase {
     type: ScreenRowType;
     isLiveRow: boolean;
     numberOfLines?: number;
+    monetizations?: {
+        monetizationRef: any;
+    }[];
 }
 
 /**
@@ -1957,8 +2084,7 @@ export declare interface RowItemAssets {
 export declare enum RowItemComponent {
     ROW_ITEM_PORTRAIT = "ROW_ITEM_PORTRAIT",
     ROW_ITEM_LANDSCAPE = "ROW_ITEM_LANDSCAPE",
-    ROW_ITEM_CIRCLED = "ROW_ITEM_CIRCLED",
-    ROW_ITEM_BANNER = "ROW_ITEM_BANNER"
+    ROW_ITEM_CIRCLED = "ROW_ITEM_CIRCLED"
 }
 
 /**
@@ -2757,6 +2883,7 @@ export declare interface TivioWidgetProps {
         x: number;
     }) => any;
     navigateFunction?: any;
+    isFocused?: boolean;
 }
 
 /**
@@ -2775,6 +2902,26 @@ export declare interface TivioWidgetRef {
     });
 }
 
+export declare interface TopWatchItem {
+    videoId: string;
+    /**
+     * If video is part of series we get a tagId to series
+     */
+    seriesId?: string;
+    /**
+     * Video type {@link VideoType}
+     */
+    videoType: VideoType;
+    /**
+     * Uniq users count
+     */
+    userCount: number;
+    /**
+     * Count of video view events
+     */
+    viewCount: number;
+}
+
 declare type TransactionInfo = {
     type: 'transaction';
     name: string;
@@ -2796,6 +2943,7 @@ export declare type Translation = {
  */
 export declare type TvAppProps = {
     customer: CustomerId;
+    navigateFunction: (url: string) => void;
 };
 
 /**
@@ -2816,7 +2964,11 @@ export declare interface TvChannel extends RowItem {
      * Transactions before subscriptions, sorted by price ascending.
      */
     getPurchasableMonetizations(options?: GetPurchasableMonetizationsOptions): PurchasableMonetization[];
-    getSourceUrl(fallbackUrl?: string): Promise<GetSourceUrlResponse>;
+    getSourceUrl(options?: {
+        language?: LangCode;
+    }): Promise<GetSourceUrlResponse & {
+        language?: LangCode;
+    }>;
     purchasableMonetization: any | null;
     price: number;
     cover: string;
@@ -2824,6 +2976,16 @@ export declare interface TvChannel extends RowItem {
     uri: string;
 }
 
+export declare interface TvProgram {
+    from: Date | null;
+    to: Date | null;
+    name: string;
+    description: string;
+    uri: string;
+    image: string;
+    video: Video | null;
+}
+
 /**
  * @public
  */
@@ -2928,7 +3090,7 @@ export declare interface UseCancelSubscriptionsResult {
  * @public
  */
 export declare type UseChannelSource = (tvChannelId: string) => {
-    source: ChannelSourcePojo | null;
+    source: ChannelSourcePojo | VirtualChannelSourcePojo | null;
     error: Error | null;
 };
 
@@ -2938,7 +3100,7 @@ export declare type UseChannelSource = (tvChannelId: string) => {
  * @public
  */
 export declare const useChannelSource: (tvChannelId: string) => {
-    source: ChannelSourcePojo | null;
+    source: ChannelSourcePojo | VirtualChannelSourcePojo | null;
     error: Error | null;
 };
 
@@ -3282,7 +3444,11 @@ export declare interface Video extends RowItem {
      * Transactions before subscriptions, sorted by price ascending.
      */
     getPurchasableMonetizations(options?: GetPurchasableMonetizationsOptions): PurchasableMonetization[];
-    getSourceUrl(fallbackUrl?: string): Promise<GetSourceUrlResponse>;
+    getSourceUrl(options?: {
+        language?: LangCode;
+    }): Promise<GetSourceUrlResponse & {
+        language?: LangCode;
+    }>;
     purchasableMonetization: any | null;
     transaction: PurchasableMonetization | undefined;
     subscriptions: PurchasableMonetization[];
@@ -3377,10 +3543,37 @@ export declare enum VideoType {
 /**
  * @public
  */
-export declare type VideoUrlName = {
+export declare type VideoUrlNames = {
     [key in LangCode]?: string[];
 };
 
+export declare interface ViewCountItem {
+    /**
+     * Unix timestamp
+     */
+    date: number;
+    /**
+     * Monetization under the videos played, if not filled it is free
+     */
+    monetizationId?: string;
+    /**
+     * Device where the video played
+     */
+    deviceType: PLATFORM;
+    /**
+     * Count of video view events in group
+     */
+    totalCount: number;
+}
+
+/**
+ * @public
+ */
+export declare interface VirtualChannelSourcePojo extends Omit<ChannelSourcePojo, 'type'> {
+    type: 'VirtualChannelSource';
+    epg: TvProgram[];
+}
+
 /**
  * @public
  */
@@ -3439,7 +3632,7 @@ export declare interface WarningConfirmationOverlayPayload extends ConfirmationO
  */
 export declare interface WebPlayerProps {
     id: string;
-    source?: VodTivioSourcePojo | ChannelSourcePojo | VideoPath | null;
+    source?: VodTivioSourcePojo | ChannelSourcePojo | VirtualChannelSourcePojo | VideoPath | null;
     onEnded?: () => any;
     /**
      * If this function is specified, then "Back" button is shown in top right corner.
@@ -3524,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
  */