@tivio/sdk-react 9.2.0 → 9.3.1

package/dist/index.d.ts

@@ -11,6 +11,7 @@ import type { PaletteType } from '@material-ui/core';
 import { default as React_2 } from 'react';
 import { RecommendationsQuery } from '@algolia/recommend';
 import type { TagManagerArgs } from 'react-gtm-module';
+import type { Timestamp } from '@firebase/firestore-types';
 
 export declare interface ActivatedPromotion {
     id: string;
@@ -607,6 +608,10 @@ export declare interface BannerProps {
  */
 export declare type BannerPropsPartial = Partial<BannerProps>;
 
+declare interface BaseWidgetControlPayload {
+    widgetPath: string;
+}
+
 /**
  * @public
  */
@@ -661,6 +666,35 @@ export declare interface CancellingMonetizationsSummaryItem {
     cancellingUsers: number;
 }
 
+declare interface ChangeStateResponse {
+    success: boolean;
+}
+
+declare interface ChangeWidgetStatePayload extends BaseWidgetControlPayload {
+    prevState: InteractiveWidgetState;
+    targetState: InteractiveWidgetState;
+}
+
+export declare interface ChangeWidgetStateRequest {
+    /** Path to the widget instance document */
+    widgetPath: string;
+    /** The state the client believes the widget is currently in */
+    prevState: InteractiveWidgetState;
+    /** The desired target state to transition to */
+    targetState: InteractiveWidgetState;
+    /** Active scene id */
+    activeSceneId?: string;
+    /** Audience delay in seconds */
+    audienceDelay?: number;
+    /** Time in seconds for the audience to answer the question */
+    answerTime?: number;
+}
+
+declare interface ChangeWidgetStateRequest_2 {
+    action: 'changeState';
+    payload: ChangeWidgetStatePayload;
+}
+
 /**
  * @public
  * @deprecated this channel structure is not used anymore (don't confuse with tv channels, which are used).
@@ -714,6 +748,11 @@ export declare interface ChurnedMonetizationsSummaryItem {
     expiredUsers: number;
 }
 
+export declare enum CloudflareStreamingPurchaseStatus {
+    PAID = "paid",
+    FREE = "free"
+}
+
 /**
  * @public
  */
@@ -1353,6 +1392,18 @@ export declare interface EditMessageOptions extends Omit<AddMessageOptions, 'par
     videoTime?: number;
 }
 
+export declare interface EmailNotification {
+    id: string;
+    name: string;
+    targeting: NotificationTargeting | null;
+    templateId: string;
+    thumbnailUrl?: string;
+    triggerType: NotificationTriggerType;
+    scheduleTime?: Date;
+    status?: NotificationStatus;
+    substitutions: NotificationSubstitution[];
+}
+
 /**
  * Represents a SendGrid transactional template.
  */
@@ -1474,6 +1525,11 @@ export declare type Events = {
     'on-error': Error;
 };
 
+export declare interface ExtensionMetadata {
+    purchaseStatus: CloudflareStreamingPurchaseStatus;
+    activeVideoId?: string;
+}
+
 /**
  * @public
  */
@@ -1482,6 +1538,23 @@ export declare type ExternalTvConfig = {
     splashScreenBackgroundColor?: string;
 };
 
+export declare interface FavoriteTagWithData {
+    content: Tag;
+    type: 'tag';
+}
+
+export declare interface FavoriteVideoWithData {
+    content: Video;
+    type: 'video';
+}
+
+/**
+ * @public
+ */
+export declare type FavoriteWithData = FavoriteVideoWithData | (FavoriteTagWithData & {
+    profileId?: string;
+});
+
 /**
  * @throws if fetch fails
  * @public
@@ -1543,6 +1616,24 @@ export declare type FrequencyInfo = {
     value: number;
 };
 
+export declare interface GenerateSourceRequest {
+    profileId: string;
+    videoId: string;
+    protocol: VideoSourceProtocol;
+    sessionType: SessionType;
+    extensionMetadata: ExtensionMetadata;
+}
+
+export declare interface GenerateWidgetJoinCodeRequest {
+    action: 'generateWidgetJoinCode';
+    payload: BaseWidgetControlPayload;
+}
+
+declare interface GenerateWidgetJoinCodeResponse {
+    code: string;
+    qrCodeUri: string;
+}
+
 /**
  * On call error interface for front-end.
  * Do not use it / throw it from @tivio/api.
@@ -1739,6 +1830,14 @@ export declare interface GetSourceUrlResponse {
 
 export declare type GetTilesInRowResponse<U extends NextPageParamType = NextPageParamType> = PaginatedResponse<TileData, U>;
 
+export declare interface GetUserProfileDataOptions {
+    /**
+     * If true, the data will be returned for all user profiles.
+     * If false, the data will be returned only for the active user profile.
+     */
+    ignoreActiveUserProfile?: boolean;
+}
+
 export declare interface GetUserRssUrlRequest {
     organizationId: string;
 }
@@ -1961,6 +2060,7 @@ export declare interface InteractiveWidget<T extends InteractiveWidgetScene = In
     readonly isWaitingForStart: boolean;
     answerQuestion(answerId: string): void;
     submitAnswer(request: Pick<SubmitAnswerRequest, 'answerOptionId' | 'answerText'>): Promise<void>;
+    verifyJoinCode(joinCode: string, shouldJoinPlayer?: boolean): Promise<boolean>;
     destroy(): void;
 }
 
@@ -1986,6 +2086,7 @@ export declare interface InteractiveWidgetSceneBase<TType extends InteractiveWid
     type: TType;
     name: Translation;
     metadata: SceneMetadata<TType>;
+    state: InteractiveWidgetState;
 }
 
 export declare enum InteractiveWidgetSceneTemplateType {
@@ -2211,6 +2312,12 @@ export declare interface LeaderboardPlayer {
 
 export declare type LeaderboardScene = InteractiveWidgetSceneBase<InteractiveWidgetSceneTemplateType.LEADERBOARD>;
 
+export declare interface LeaderboardsRequest {
+    widgetPath: string;
+    lastQuestionIndex: number;
+    allPlayers?: boolean;
+}
+
 /**
  * @public
  */
@@ -2354,6 +2461,21 @@ export declare interface MallTvExternals {
     mallTvEntityId: string;
 }
 
+/**
+ * Response for {@link ManagementGenerateSourceRequest}
+ * @private
+ * @example ```json
+ * {
+ *   "sessionId": "f6439376-bc57-4891-ac64-4dde4254a423",
+ *   "url": "https://live.streaming.tivio.studio/live/ol24ae7lQ4ES1PN6UYSk/tRRu9BMn3eTTX22iTyLz/f6439376-bc57-4891-ac64-4dde4254a423/index.m3u8"
+ * }
+ * ```
+ */
+export declare interface ManagementGenerateSourceResponse {
+    sessionId: string;
+    url: string;
+}
+
 /**
  * @public
  */
@@ -2654,17 +2776,11 @@ export declare type NoGraphicsScene = InteractiveWidgetSceneBase<InteractiveWidg
  */
 export declare type NonAdSourceType = Exclude<SourceType, SourceType.ADVERTISEMENT>;
 
-declare interface Notification_2 {
-    id: string;
-    name: string;
-    targeting: NotificationTargeting | null;
-    templateId: string;
-    thumbnailUrl?: string;
-    triggerType: NotificationTriggerType;
-    scheduleTime?: Date;
-    status?: NotificationStatus;
-    substitutions: NotificationSubstitution[];
-}
+declare type Notification_2 = {
+    type: NotificationType.PUSH;
+} & SchedulePushNotificationPayload | {
+    type?: NotificationType.EMAIL;
+} & EmailNotification;
 export { Notification_2 as Notification }
 
 export declare interface NotificationDuration {
@@ -2735,6 +2851,11 @@ export declare interface NotificationTargeting {
 
 export declare type NotificationTriggerType = 'scheduled' | 'manual' | 'purchaseStatusChange' | 'duration' | 'userRegistration';
 
+export declare enum NotificationType {
+    PUSH = "PUSH",
+    EMAIL = "EMAIL"
+}
+
 /**
  * @public
  */
@@ -2839,6 +2960,7 @@ export declare interface OrganizationSettingsField extends OrganizationResponsiv
     };
     rss?: {
         title?: string;
+        enabled?: boolean;
     };
     /**
      * Setting for EPG screen on web
@@ -2868,6 +2990,9 @@ export declare interface OrganizationSettingsField extends OrganizationResponsiv
         };
     };
     voucher?: VoucherPageConfiguration;
+    pushNotifications?: {
+        enabled?: boolean;
+    };
 }
 
 /**
@@ -4053,6 +4178,20 @@ export declare enum PurchaseStatus {
  */
 export declare type PurchaseType = 'transaction' | 'subscription' | 'voucher';
 
+export declare type PushNotificationSchedulerRequest = {
+    operation: SchedulerOperation.SCHEDULE;
+    status: NotificationStatus;
+    payload: SchedulePushNotificationPayload;
+} | {
+    operation: SchedulerOperation.UNSCHEDULE;
+    organizationId: string;
+    contentId: string;
+} | {
+    operation: SchedulerOperation.GET_STATUS;
+    organizationId: string;
+    contentId: string;
+};
+
 /**
  * TODO more generic name, since we support stargaze payment gateway as well
  * @public
@@ -4219,6 +4358,8 @@ export declare interface QuizGameGroupStats {
 
 export declare enum QuizGameGroupType {
     HIGHLIGHTED_PLAYERS = "HIGHLIGHTED_PLAYERS",
+    /** Participants playing in Offline mode */
+    LOCAL_PLAYERS = "LOCAL_PLAYERS",
     ALL = "ALL",
     PARTY = "PARTY"
 }
@@ -4226,7 +4367,8 @@ export declare enum QuizGameGroupType {
 export declare enum QuizGameRole {
     OBS = "OBS",
     HOST = "HOST",
-    PLAYER = "PLAYER"
+    PLAYER = "PLAYER",
+    LOCAL_PLAYER = "LOCAL_PLAYER"
 }
 
 export declare enum QuizGameStatus {
@@ -4471,6 +4613,7 @@ export declare interface RouterOverrides {
         urlHandle?: string;
         replace?: boolean;
         params?: string;
+        callbackUrl?: string;
     }) => void;
     goToRegistrationPage: (options?: {
         origin?: RegistrationRedirect;
@@ -4784,6 +4927,38 @@ export declare interface ScheduleNotificationRequest {
     notificationPath: string;
 }
 
+export declare interface SchedulePushNotificationPayload {
+    /**
+     * To which content document will this notification relate to.
+     */
+    contentId: string;
+    /**
+     * Content document type.
+     */
+    contentType: 'video' | 'article';
+    /**
+     * To users of which organization should notifications be sent.
+     */
+    organizationId: string;
+    /**
+     * Contents of notification message that will be shown to users.
+     */
+    notification: {
+        title: string;
+        body?: string;
+        imageUrl?: string;
+        data?: {
+            [key: string]: string;
+        };
+    };
+}
+
+export declare enum SchedulerOperation {
+    SCHEDULE = "SCHEDULE",
+    UNSCHEDULE = "UNSCHEDULE",
+    GET_STATUS = "GET_STATUS"
+}
+
 /**
  * @public
  */
@@ -4968,6 +5143,27 @@ export declare interface SendMessageResponse {
     messageId?: string;
 }
 
+export declare interface SendPushNotificationsResponse {
+    /**
+     * Potential user count to send notifications to.
+     * Will include organization users that have at least 1 device registered to receive notifications.
+     */
+    potentialUserCount: number;
+    /**
+     * Potential device count from users to send notifications to.
+     * Resulting number is equals to {@link successNotificationCount} + {@link failureNotificationCount}
+     */
+    potentialDeviceCount: number;
+    /**
+     * Number of successfully sent notifications.
+     */
+    successNotificationCount: number;
+    /**
+     * Number of notifications that failed to send.
+     */
+    failureNotificationCount: number;
+}
+
 export declare interface SendTivioTemplateEmailRequest {
     notificationId: string;
     organizationId: string;
@@ -5003,6 +5199,24 @@ export declare interface SeriesTileSpecificData {
     availableSeasons: AvailableSeason[];
 }
 
+/**
+ * @public
+ */
+export declare enum SessionType {
+    /**
+     * Umbrella streaming - viewer will be able to switch between different sources linked to the main source.
+     */
+    INTERACTIVE = "interactive",
+    /**
+     * Classic streaming - viewer will be able to watch a single LIVE source.
+     */
+    LIVE = "live",
+    /**
+     * On-demand streaming - viewer will be able to watch a single VOD source.
+     */
+    ON_DEMAND = "ondemand"
+}
+
 export declare interface SetCustomClaimsRequest {
     organizationId: string;
 }
@@ -5263,6 +5477,19 @@ export declare type StartAndContinuePosition = {
     continueFromPosition?: number;
 };
 
+export declare type StartLiveStreamPayload = BaseWidgetControlPayload;
+
+declare interface StartLiveStreamRequest {
+    action: 'startLiveStream';
+    payload: StartLiveStreamPayload;
+}
+
+export declare interface StartLiveStreamResponse {
+    liveStreamProcessPath: string;
+    streamingStudioProcessPath: string;
+    error?: string;
+}
+
 /**
  * @public
  */
@@ -5385,8 +5612,8 @@ export declare interface Tag extends RowItem {
     detailBanner?: string;
     availableSeasons?: AvailableSeason[];
     isFavorite: boolean;
-    addToFavorites: () => void;
-    removeFromFavorites: () => void;
+    addToFavorites: () => Promise<void>;
+    removeFromFavorites: () => Promise<void>;
     cover: string;
     getApplicationName: () => string | undefined;
     seriesRef?: DocumentReference<any>;
@@ -6292,6 +6519,25 @@ export declare enum TvStreamType {
  */
 export declare const TvTivioProvider: React_2.FC<TivioProviderProps>;
 
+export declare type UpdateNotificationSettingsRequest = {
+    tokenToAdd: string;
+    platform: string;
+    tokenToDelete?: string;
+    validateToken?: never;
+} | {
+    tokenToDelete: string;
+    tokenToAdd?: never;
+    platform?: never;
+    validateToken?: never;
+} | {
+    validateToken: string;
+    tokenToAdd?: never;
+    platform?: never;
+    tokenToDelete?: never;
+};
+
+export declare type UpdateNotificationSettingsResponse = Promise<boolean>;
+
 export declare type UpsertCommentResponse = AddEditCommentResponse | DeleteCommentResponse;
 
 /**
@@ -6386,7 +6632,7 @@ export declare const useChannelSource: (tvChannelId: string) => {
  * but for live video with comments, we want to subscribe to conversation
  */
 export declare type UseComments = (options: UseMessagesOptions) => {
-    pagination: PaginationInterface<Comment>;
+    pagination: PaginationInterface<unknown>;
     addComment: (options: AddMessageOptions) => Promise<UseMessagesAddEditMessageResponse>;
     editComment: (options: EditMessageOptions) => Promise<UseMessagesAddEditMessageResponse>;
     deleteComment: (commentId: string) => Promise<UseMessagesDeleteMessageResponse>;
@@ -6649,6 +6895,9 @@ export declare type User = {
     getAllExtendableSubscriptions: () => Promise<Purchase[]>;
     getRssValidToken: () => Promise<TokenInterface | undefined>;
     getRssUrl: () => Promise<GetUserRssUrlResponse>;
+    getFavorites: (options?: GetUserProfileDataOptions) => Promise<FavoriteWithData[]>;
+    getWatchPositions: (options?: GetUserProfileDataOptions) => Promise<WatchPositionWithData[]>;
+    getWatchHistory: (options?: GetUserProfileDataOptions) => Promise<WatchPositionWithData[]>;
     invalidateAllTokens: (type: TokenType) => Promise<void>;
     isPartiallyRegistered: boolean;
     conversationStore: ConversationStore;
@@ -6680,6 +6929,16 @@ export declare enum UserGroup {
     PREMIUM = "premium"
 }
 
+export declare interface UserNotificationRegistrationToken {
+    token: string;
+    platform?: string;
+    created: Timestamp;
+}
+
+export declare interface UserNotificationSettings {
+    registrationTokens?: UserNotificationRegistrationToken[];
+}
+
 /**
  * @public
  */
@@ -6948,6 +7207,16 @@ export declare interface verifyCustomTokenProps {
     organizationPath: string;
 }
 
+declare interface VerifyJoinCodePayload extends BaseWidgetControlPayload {
+    joinCode: string;
+    shouldJoinPlayer?: boolean;
+}
+
+export declare interface VerifyJoinCodeRequest {
+    action: 'verifyJoinCode';
+    payload: VerifyJoinCodePayload;
+}
+
 /**
  * @public
  */
@@ -7004,8 +7273,8 @@ export declare interface Video extends RowItem, MonetizableItem, ReactableConten
     tasting: Video | null;
     watchPosition: number | null;
     isFavorite: boolean;
-    addToFavorites: () => void;
-    removeFromFavorites: () => void;
+    addToFavorites: () => Promise<void>;
+    removeFromFavorites: () => Promise<void>;
     availability: ContentAvailability | null;
     sourceLanguages: LangCode[];
     urlByLanguage: (lang: LangCode) => string | undefined;
@@ -7529,6 +7798,21 @@ export declare interface WarningConfirmationOverlayPayload extends ConfirmationO
     subscriptionExpirationText?: string;
 }
 
+/**
+ * @public
+ */
+export declare interface WatchPositionWithData extends Omit<UserWatchPositionField, 'videoRef' | 'tagRef'> {
+    /**
+     * Video that given watch position is related to.
+     */
+    video: Video;
+    /**
+     * If user watches episode of series, we have to save series ref as well.
+     * Same for {@link episodeNumber} and {@link seasonNumber}.
+     */
+    tag?: Tag;
+}
+
 /**
  * @public
  */
@@ -7938,6 +8222,16 @@ export declare type Widget = {
     lastVideo: Video | null;
 };
 
+export declare type WidgetControlRequest = StartLiveStreamRequest | ChangeWidgetStateRequest_2 | GenerateWidgetJoinCodeRequest | VerifyJoinCodeRequest;
+
+export declare type WidgetControlResponse<T extends WidgetControlRequest['action']> = T extends 'startLiveStream' ? StartLiveStreamResponse : T extends 'changeState' ? ChangeStateResponse : T extends 'generateWidgetJoinCode' ? GenerateWidgetJoinCodeResponse : T extends 'verifyJoinCode' ? boolean : never;
+
+export declare interface WidgetSecret {
+    code: string;
+    type: 'JWT' | 'alphanumeric';
+    expired?: Date;
+}
+
 /**
  * @public
  */