@tivio/sdk-react 9.1.5 → 9.1.6

package/README.md

@@ -5,6 +5,9 @@ above Tivio Studio. You can comfortably manage all you videos, settings such as
 settings in the administration of Tivio Studio while having the freedom to build your own application.
 
 ## Changelog
+* 9.1.6
+  * minor: add remote controller
+
 * 9.1.5
   * patch: expose purchase loyalty points through types
 

package/README.md.bak

@@ -5,6 +5,9 @@ above Tivio Studio. You can comfortably manage all you videos, settings such as
 settings in the administration of Tivio Studio while having the freedom to build your own application.
 
 ## Changelog
+* 9.1.6
+  * minor: add remote controller
+
 * 9.1.5
   * patch: expose purchase loyalty points through types
 

package/dist/index.d.ts

@@ -28,6 +28,11 @@ export declare interface ActivatedPromotionsWithIdsResponse {
 
 export declare type ActivateVoucherResponse = string | ActivatedPromotionsResponse | ActivatedPromotionsWithIdsResponse;
 
+declare interface actualPriceDetails {
+    amountCents: number;
+    currency?: primaSupportedCurrency;
+}
+
 export declare type AdBannerScene = InteractiveWidgetSceneBase<InteractiveWidgetSceneTemplateType.AD_BANNER>;
 
 export declare type AddEditCommentResponse = {
@@ -854,6 +859,22 @@ export declare type ContentType = 'ARTICLE' | 'VIDEO' | 'SERIES' | 'EPISODE';
  */
 export declare type ContinuePosition = number | null | Promise<number | null>;
 
+export declare interface ControlPlayback {
+    delaySegmentCount?: number;
+    status: ControlPlaybackStatus;
+}
+
+export declare enum ControlPlaybackStatus {
+    PAUSED = "paused",
+    PLAYING = "playing"
+}
+
+export declare interface ControlReplay {
+    videoId: string;
+    fromSegment?: number;
+    toSegment?: number;
+}
+
 /**
  * @public
  */
@@ -1069,6 +1090,14 @@ export declare interface CurrentQuestion {
 
 export declare type CurrentQuestionScene = InteractiveWidgetSceneBase<InteractiveWidgetSceneTemplateType.CURRENT_QUESTION>;
 
+export declare interface currentSubscription {
+    subscriptionId?: string;
+    subscriptionItemType: primaSubscriptionItemType;
+    startDatetime?: Date;
+    endDateTime?: Date;
+    actualPrice: actualPriceDetails;
+}
+
 /**
  * @public
  */
@@ -1126,7 +1155,8 @@ export declare enum CustomerId {
     LEPSI_UZ_TO_NEBUDE = "LEPSI_UZ_TO_NEBUDE",
     BEAT_SEXISM = "BEAT_SEXISM",
     KAROL_A_KVIDO = "KAROL_A_KVIDO",
-    UZ_BUDU = "UZ_BUDU"
+    UZ_BUDU = "UZ_BUDU",
+    PRIMA = "PRIMA"
 }
 
 export declare interface CustomScript {
@@ -1280,6 +1310,15 @@ export declare enum DurationUnits {
     MONTH = "month"
 }
 
+/**
+ * Custom text for duration units used by formatDuration
+ */
+export declare interface DurationUnitTexts {
+    hour: string;
+    minute: string;
+    seconds?: string;
+}
+
 /**
  * Duration field using dayjs duration
  */
@@ -1467,6 +1506,14 @@ export declare interface ForbiddenOnCallError extends GenericOnCallError {
 export declare enum ForbiddenReason {
     MONETIZATION = "MONETIZATION",
     GEO_BLOCKING = "GEO_BLOCKING",
+    EMAIL_ALREADY_EXISTS = "EMAIL_ALREADY_EXISTS",
+    EMAIL_CONTAINS_PLUS_SIGN = "EMAIL_CONTAINS_PLUS_SIGN",
+    EMAIL_NOT_VERIFIED = "EMAIL_NOT_VERIFIED",
+    INVALID_BIRTH_YEAR = "INVALID_BIRTH_YEAR",
+    INVALID_EMAIL_ADDRESS = "INVALID_EMAIL_ADDRESS",
+    NAME_CONTAINS_INVALID_CHAR = "NAME_CONTAINS_INVALID_CHAR",
+    USER_ACCOUNT_LOCKED = "USER_ACCOUNT_LOCKED",
+    USER_NOT_FOUND = "USER_NOT_FOUND",
     UNSUPPORTED_BROWSER = "UNSUPPORTED_BROWSER"
 }
 
@@ -1554,6 +1601,7 @@ export declare const getPubSub: () => PubSub;
  */
 export declare interface GetPurchasableMonetizationsOptions {
     includeMonetizationsWithPurchaseDisabled: boolean;
+    ignoreActiveOrganizationCheck?: boolean;
 }
 
 /**
@@ -1654,6 +1702,10 @@ export declare interface GetSourceUrlResponse {
      * Current session id for given user and source.
      */
     sessionId?: string;
+    /**
+     * Active content (e.g. video) id in generated session.
+     */
+    activeContentId?: string;
     /**
      * Template for generating image previews for user scrubbing in player.
      */
@@ -2149,7 +2201,9 @@ export declare interface LinkedVideo {
     /**
     * Will not render separate player, it will override main video source.
     */
-    | 'COMPOSED_PIP';
+    | 'COMPOSED_PIP' | 'MATRIX';
+    name?: string;
+    color?: string;
 }
 
 /**
@@ -2420,7 +2474,8 @@ export declare enum MONETIZATION_FREQUENCY {
     WEEKLY = "WEEKLY",
     MONTHLY = "MONTHLY",
     HALF_ANNUALLY = "HALF_ANNUALLY",
-    ANNUALLY = "ANNUALLY"
+    ANNUALLY = "ANNUALLY",
+    EVENT = "EVENT"
 }
 
 /**
@@ -3299,6 +3354,8 @@ export declare interface PlayerSourceParams<T extends NonAdSourceType = NonAdSou
     from?: Date;
     sourceHistory?: string[];
     seekingMatrix?: SeekingMatrixTemplate;
+    sessionType?: VideoSourceField['sessionType'];
+    sessionId?: string;
 }
 
 export declare type PlayersScene = InteractiveWidgetSceneBase<InteractiveWidgetSceneTemplateType.PLAYERS>;
@@ -3401,6 +3458,80 @@ export declare enum PlayerWrapperEventType {
  */
 export declare type PlayerWrapperEventTypeType = `${PlayerWrapperEventType}`;
 
+export declare enum primaPlusMonetizationLevel {
+    light = "z7soJTA2dYSxnOOJw7B0",
+    premium = "kwfM0D7Vzv5wfLf5go8o",
+    noAds = "L4dzWZHCZenezYawqEbl"
+}
+
+export declare interface primaPlusRefreshTokenResponse {
+    result?: {
+        data: {
+            payload: {
+                sessionId: string | null;
+                userUuid: string;
+                accessToken: {
+                    token: string;
+                    insecure: boolean;
+                    expiresAt: string;
+                };
+                refreshToken: {
+                    token: string;
+                    insecure: boolean;
+                    expiresAt: string;
+                };
+            };
+        };
+        datetime: string;
+    };
+    error?: {
+        code: number;
+        message: string;
+        datetime: string;
+    };
+}
+
+export declare interface primaPlusSubscription {
+    result?: {
+        data: {
+            subscription: {
+                currentSubscription?: currentSubscription;
+            };
+        };
+    };
+    error?: {
+        code: number;
+        message: string;
+        datetime: string;
+    };
+}
+
+export declare enum primaSubscriptionItemType {
+    REGISTERED = "REGISTERED",
+    HVOD_STANDARD = "HVOD_STANDARD",
+    SVOD_STANDARD = "SVOD_STANDARD",
+    IPBR_STANDARD = "IPBR_STANDARD",
+    PREMIUM_STANDARD = "PREMIUM_STANDARD",
+    IPRIMA_NO_ADS_STANDARD = "IPRIMA_NO_ADS_STANDARD",
+    HVOD_PARTIAL = "HVOD_PARTIAL",
+    IPBR_PARTIAL = "IPBR_PARTIAL",
+    PREMIUM_PARTIAL = "PREMIUM_PARTIAL",
+    IPRIMA_NO_ADS_PARTIAL = "IPRIMA_NO_ADS_PARTIAL",
+    SVOD_PREPAID_VOUCHER = "SVOD_PREPAID_VOUCHER",
+    SVOD_DISCOUNT_VOUCHER = "SVOD_DISCOUNT_VOUCHER",
+    HVOD_PREPAID_VOUCHER = "HVOD_PREPAID_VOUCHER",
+    HVOD_DISCOUNT_VOUCHER = "HVOD_DISCOUNT_VOUCHER"
+}
+
+declare enum primaSupportedCurrency {
+    CZK = "CZK",
+    EUR = "EUR",
+    PLN = "PLN",
+    USD = "USD",
+    GBP = "GBP",
+    HUF = "HUF"
+}
+
 /**
  * Values that user entered in survey for given profile.
  */
@@ -3561,7 +3692,8 @@ export declare enum PurchaseDocumentGateway {
     'patreon' = "patreon",
     'paypal' = "paypal",
     'unknown' = "unknown",
-    'stargaze' = "stargaze"
+    'stargaze' = "stargaze",
+    'prima' = "prima"
 }
 
 /**
@@ -4048,6 +4180,76 @@ export declare type RemoteBundleState = {
     state: 'loading' | 'error' | 'ready';
 } & Nullable<TivioBundle>;
 
+export declare interface RemoteControlGenerateSourceResponse {
+    sessionId?: string;
+    url?: string;
+}
+
+export declare interface RemoteControlGetSourceUrlPayload {
+    videoId: string;
+    userId: string;
+    profileId: string;
+    capabilities: PlayerCapability[];
+    activeVideoId: string;
+}
+
+/**
+ * @public
+ */
+export declare interface RemoteControllerProps {
+    video: Video;
+    className?: string;
+}
+
+export declare enum RemoteControlMethod {
+    pairDevice = "pairDevice",
+    unpairDevice = "unpairDevice",
+    playHighlight = "playHighlight",
+    playbackControl = "playbackControl",
+    selectCamera = "selectCamera",
+    getSourceUrl = "getSourceUrl"
+}
+
+export declare interface RemoteControlPairPayload {
+    code: string;
+    videoId: string;
+    profileId: string;
+}
+
+export declare interface RemoteControlPlaybackControlPayload {
+    sessionId: string;
+    videoId: string;
+    playback: ControlPlayback;
+    activeVideoId?: string;
+}
+
+export declare interface RemoteControlPlayHighlightPayload {
+    sessionId: string;
+    videoId: string;
+    activeVideoId: string;
+    replay: ControlReplay;
+}
+
+export declare type RemoteControlRequest = RemoteControlRequestBase<RemoteControlMethod.pairDevice> | RemoteControlRequestBase<RemoteControlMethod.unpairDevice> | RemoteControlRequestBase<RemoteControlMethod.playHighlight> | RemoteControlRequestBase<RemoteControlMethod.playbackControl> | RemoteControlRequestBase<RemoteControlMethod.selectCamera> | RemoteControlRequestBase<RemoteControlMethod.getSourceUrl>;
+
+declare interface RemoteControlRequestBase<TMethod extends RemoteControlMethod> {
+    method: TMethod;
+    payload: RemoteControlRequestPayload<TMethod>;
+}
+
+export declare type RemoteControlRequestPayload<TMethod extends RemoteControlMethod> = TMethod extends RemoteControlMethod.pairDevice ? RemoteControlPairPayload : TMethod extends RemoteControlMethod.unpairDevice ? RemoteControlUnpairPayload : TMethod extends RemoteControlMethod.playHighlight ? RemoteControlPlayHighlightPayload : TMethod extends RemoteControlMethod.playbackControl ? RemoteControlPlaybackControlPayload : TMethod extends RemoteControlMethod.selectCamera ? RemoteControlSelectCameraPayload : TMethod extends RemoteControlMethod.getSourceUrl ? RemoteControlGetSourceUrlPayload : object;
+
+export declare interface RemoteControlSelectCameraPayload {
+    sessionId: string;
+    videoId: string;
+    activeVideoId: string;
+}
+
+export declare interface RemoteControlUnpairPayload {
+    sessionId: string;
+    videoId: string;
+}
+
 /**
  * @public
  */
@@ -4881,7 +5083,9 @@ export declare enum SurveyItemComponent {
     SURVEY = "SURVEY"
 }
 
-export declare type SynchronizeUserTypeFunction = (payload: CreateUserPayload, tenantId: string, tenantUserId: string, organizationId?: string) => Promise<string>;
+export declare type SynchronizeUserTypeFunction = (payload: CreateUserPayload, tenantId: string, tenantUserId: string, organizationId?: string, additionalData?: {
+    [key: string]: any;
+}) => Promise<string>;
 
 /**
  * @public
@@ -5185,6 +5389,7 @@ export declare interface TivioComponents {
     ContentSortPicker: React_2.ComponentType<ContentSortPickerProps>;
     WebProfileScreen: React_2.ComponentType<WebProfileScreenProps>;
     WebTivioProVideoScreen: React_2.ComponentType<WebTivioProVideoScreenProps>;
+    RemoteController: React_2.ComponentType<RemoteControllerProps>;
 }
 
 /**
@@ -6150,6 +6355,7 @@ export declare type User = {
     invalidateAllTokens: (type: TokenType) => Promise<void>;
     isPartiallyRegistered: boolean;
     conversationStore: ConversationStore;
+    streamingSessions?: UserStreamingSessionFieldInterface[];
 };
 
 /**
@@ -6216,6 +6422,14 @@ export declare type UserProfile = {
     survey?: ProfileSurvey;
 };
 
+export declare interface UserStreamingSessionFieldInterface {
+    sessionId: string;
+    sessionType: Exclude<VideoSourceField['sessionType'], undefined>;
+    contentId: string;
+    activeContentId?: string;
+    created: Date;
+}
+
 /**
  * @public
  */
@@ -6552,11 +6766,12 @@ export declare interface VideoHighlight {
     id: string;
     title: string;
     description?: string;
-    fromTimestamp?: number;
-    toTimestamp?: number;
+    fromSegment?: number;
+    toSegment?: number;
     imageUrl?: string;
     videoTime?: string;
     videoId?: string;
+    created?: Date;
 }
 
 declare type VideoPath = string;
@@ -6811,6 +7026,7 @@ export declare interface VodTivioSourceInterface extends PlayerSourceInterface<S
     managementUrl?: string;
     video: Video;
     clone: (params?: Partial<VodTivioSourceParams>) => VodTivioSourceInterface;
+    sessionType?: VideoSourceField['sessionType'];
 }
 
 /**
@@ -6825,8 +7041,13 @@ export declare interface VodTivioSourceParams extends PlayerSourceParams<SourceT
     /**
      * URL for source modification for user (e.g. add PIP window to livestream).
      * TODO mb move to PlayerSourceParams
+     * TODO: Remove managementUrl
      */
     managementUrl?: string;
+    /**
+     * Session ID for authentication and optionally controlling the cameras
+     */
+    sessionId?: string;
 }
 
 /**