@tivio/sdk-react 3.3.2 → 3.4.0

package/dist/services/gdpr.d.ts

@@ -0,0 +1 @@
+export declare const showGdprConsentPreferences: () => Promise<void>;

package/dist/types/bundle.types.d.ts

@@ -1,11 +1,11 @@
-import { Currency, ItemsInRow, PaginationInterface, PaginationOptions, QerkoCancellationInfo, Row, ROW_ITEM_TYPES, SubscribeToItemsInRowOptions, SubscribeToTaggedVideos, Tag, TilePropsPartial, UseCancelSubscription, CUSTOMER_BUILD, PLATFORM, WebRowProps, WebSeriesDetailScreenProps } from '@tivio/common';
+import { Currency, ItemsInRow, PaginationInterface, PaginationOptions, QerkoCancellationInfo, Row, SubscribeToItemsInRowOptions, SubscribeToTaggedVideos, Tag, TilePropsPartial, UseCancelSubscription, CUSTOMER_BUILD, PLATFORM, WebRowProps, WebSeriesDetailScreenProps, AuthOverlayState, CreateUserWithEmailAndPassword, UseChannelSource } from '@tivio/common';
 import { ComponentType } from 'react';
 import { Logger } from '../services/logger';
 import { FetchPackage } from '../services/packageLoader';
 import { Disposer, Empty, Nullable } from './common';
-import { Channel, Language, RemoteProviderProps, Section, TivioSources, TivioWidgetProps, UserData, WebPlayerProps, Widget } from './types';
+import { Channel, LangCode, RemoteProviderProps, Section, TivioSources, TivioWidgetProps, WebPlayerProps, Widget } from './types';
 import type { AdSource, PlayerWrapper } from './customPlayer.types';
-import type { Monetization, Purchase, QerkoPaymentInfo, Screen, SubscribeToItemsInRow, SubscribeToRowsInScreen, SubscribeToScreen, TvAppProps, User, UseSearch, Video } from '@tivio/common';
+import type { Monetization, Purchase, QerkoPaymentInfo, Screen, SubscribeToItemsInRow, SubscribeToRowsInScreen, SubscribeToScreen, TvAppProps, User, UseSearch, UseTvChannel, Video } from '@tivio/common';
 import type React from 'react';
 declare type Settings = {
     /**
@@ -47,7 +47,7 @@ declare type InternalConfig = {
         error: string | null;
     }>;
     fetchPackage: FetchPackage;
-    language?: Language;
+    language?: LangCode;
     LoaderComponent?: ComponentType;
     logger?: Logger | null;
     pubSub: PubSub;
@@ -71,6 +71,11 @@ interface PubSub {
     publish: <K extends keyof Events>(triggerName: K, payload: Events[K]) => Empty;
     subscribe: <K extends keyof Events>(triggerName: K, onMessage: (data: Events[K]) => Empty) => Disposer;
 }
+export interface GenericOnCallError {
+    code: string;
+    message?: string;
+    details?: string[];
+}
 declare type Config = Pick<InternalConfig, 'bundleUrlOverride' | 'currency' | 'disableUnmounting' | 'capabilitiesOptions' | 'enable' | 'enableSentry' | 'ErrorComponent' | 'language' | 'LoaderComponent' | 'logger' | 'secret' | 'verbose' | 'forceCloudFnResolver'> & {
     deviceCapabilities: PlayerCapability[] | 'auto';
     /**
@@ -196,7 +201,7 @@ interface TivioAuth {
      * @param email
      * @param password
      */
-    createUserWithEmailAndPassword: (email: string, password: string, userData?: UserData) => Promise<void>;
+    createUserWithEmailAndPassword: CreateUserWithEmailAndPassword;
     /**
      * Sign in the user and starts listening on his purchases
      * @param email
@@ -205,15 +210,20 @@ interface TivioAuth {
     signInWithEmailAndPassword: (email: string, password: string) => Promise<void>;
     initializeUser: () => Promise<void>;
     signOut: () => Promise<void>;
+    /**
+     * Used for reset forgotten password by user
+     */
+    resetPassword: (email: string) => Promise<void>;
     createFreePurchase: (monetizationId: string) => Promise<void>;
 }
 export interface RouterOverrides {
-    goToVideoDetailPage: (videoId: string, type: ROW_ITEM_TYPES, rowId?: string) => void;
+    goToVideoDetailPage: (videoId: string) => void;
     goToSeriesDetailPage: (tagId: string) => void;
-    goToPlayer: (videoId: string, type: ROW_ITEM_TYPES, rowId?: string) => void;
     goToTagPage: (tagId: string) => void;
     goToLoginScreen: () => void;
     goBack: () => void;
+    goLivePlayer: (videoId: string) => void;
+    goVodPlayer: (tvChannelId: string) => void;
 }
 export interface RouterOverridesContextState {
     routerOverrides: RouterOverrides;
@@ -250,6 +260,9 @@ declare type TivioComponents = {
         tagId: string;
         onError?: (error: Error) => void;
     }>;
+    WebSearchScreen: React.ComponentType<{
+        searchQuery?: string;
+    }>;
     WebRow: React.ComponentType<WebRowProps>;
     WebTile: React.ComponentType<{
         item?: Video | Tag;
@@ -286,7 +299,7 @@ declare type TivioHooks = {
     usePurchaseRecovery: () => {
         purchaseRecoveryResult?: string;
         loading: boolean;
-        error?: any;
+        error?: GenericOnCallError;
         purchaseRecovery: (monetizationId: string) => void;
     };
     useRowsInScreen: (screenId: string, options: PaginationOptions) => {
@@ -314,8 +327,9 @@ declare type TivioHooks = {
     useApplyInviteCode: () => {
         applyInviteCodeResult?: boolean;
         loading: boolean;
-        error?: any;
+        error?: GenericOnCallError;
         applyInviteCode: (code: string) => void;
+        inviteCodeReset: () => void;
     };
 };
 export declare type UserPayload = Record<string, any>;
@@ -332,8 +346,9 @@ declare type TivioBundle = {
         expirationDate: Date;
     }) => Promise<QerkoPaymentInfo>;
     cancelSubscriptionWithQerko: (subscriptionId: string) => Promise<QerkoCancellationInfo>;
-    setLanguage: (language: Language) => void;
+    setLanguage: (language: LangCode) => void;
     setUser: (userId: string | null, userPayload?: UserPayload) => Promise<void>;
+    showConsentPreferences: () => void;
     sources: TivioSources;
     subscriptions: TivioSubscriptions;
     internal: {
@@ -343,8 +358,10 @@ declare type TivioBundle = {
     };
 };
 declare type TivioInternalComponents = {
-    CustomButton: React.ComponentType;
-    WebLandingScreen: React.ComponentType;
+    PrimaryButton: React.ComponentType;
+    WebLandingScreen: React.ComponentType<{
+        logo?: string;
+    }>;
     WebVideoScreen: React.ComponentType<{
         videoId: string;
     }>;
@@ -360,9 +377,16 @@ declare type TivioInternalHooks = {
     useOrganizationSubscriptions: () => {
         subscriptions: Monetization[];
     };
+    useIsMonetizationPurchased: () => {
+        isOneOfSubscriptionPurchased: (subscriptionIds: string[]) => boolean;
+    };
+    useReferralInfo: any;
+    useTvChannel: UseTvChannel;
+    useChannelSource: UseChannelSource;
     useUser: () => {
         user: User | null;
         error: string | null;
+        isInitialized: boolean;
     };
 };
 declare type TivioInternalProviders = {
@@ -384,12 +408,6 @@ declare type TivioInternalProviders = {
 declare type TivioBundleFile = {
     Tivio: TivioBundle;
 };
-declare type AuthOverlayType = 'login' | 'registration' | 'closed';
-interface AuthOverlayState {
-    type: AuthOverlayType;
-    closeAuthOverlay: () => void;
-    openAuthOverlay: (type: AuthOverlayType) => void;
-}
 interface SubscriptionOverlayData {
     subscriptions?: Monetization[];
     onPurchase?: () => void;
@@ -423,4 +441,4 @@ declare type RemoteBundleState = {
 declare type NewVoucher = {
     expirationDate: Date | number;
 };
-export type { RemoteBundleState, Config, Settings, InternalConfig, TivioBundle, TivioBundleFile, TivioHooks, TivioComponents, TivioAuth, TivioGetters, TivioSubscriptions, TivioInternalComponents, TivioInternalHooks, TivioInternalProviders, Events, PubSub, PlayerCapability, Currency, AuthOverlayState, AuthOverlayType, SubscriptionOverlayData, SubscriptionOverlayState, QerkoData, QerkoOverlayState, NewVoucher, };
+export type { RemoteBundleState, Config, Settings, InternalConfig, TivioBundle, TivioBundleFile, TivioHooks, TivioComponents, TivioAuth, TivioGetters, TivioSubscriptions, TivioInternalComponents, TivioInternalHooks, TivioInternalProviders, Events, PubSub, PlayerCapability, Currency, SubscriptionOverlayData, SubscriptionOverlayState, QerkoData, QerkoOverlayState, NewVoucher, };

package/dist/types/types.d.ts

@@ -11,7 +11,7 @@ declare type RemoteProviderProps = {
     disableUnmounting?: boolean;
     language?: string;
 };
-declare enum Language {
+declare enum LangCode {
     CS = "cs",
     DE = "de",
     EN = "en",
@@ -20,9 +20,6 @@ declare enum Language {
     SK = "sk",
     SP = "sp"
 }
-interface UserData {
-    name?: string;
-}
 declare type Widget = {
     id: string;
     channels: Channel[];
@@ -162,7 +159,9 @@ interface WebPlayerProps {
      */
     enableKeyboardShortcuts?: boolean;
     onProgress?: (event: React.ChangeEvent<HTMLVideoElement>) => void;
-    onLoadedMetadata?: (event: React.ChangeEvent<HTMLVideoElement>) => void;
+    /**
+     * @deprecated this callback is never called. Will be removed in @tivio/sdk-react version 4
+     */
     onPlayerControllerCreated?: (playerController: any) => void;
 }
 declare type TivioSources = {
@@ -171,5 +170,5 @@ declare type TivioSources = {
     VodExternalSource: any;
     VodTivioSource: any;
 };
-export type { RemoteProviderProps, WebPlayerProps, Marker, BetOffer, Purchase, Chapter, Widget, Channel, Section, Video, TivioSources, UserData, User, Monetization, VodTivioSourcePojo, ChannelSourcePojo, };
-export { Language };
+export type { RemoteProviderProps, WebPlayerProps, Marker, BetOffer, Purchase, Chapter, Widget, Channel, Section, Video, TivioSources, User, Monetization, VodTivioSourcePojo, ChannelSourcePojo, };
+export { LangCode };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tivio/sdk-react",
-    "version": "3.3.2",
+    "version": "3.4.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "source": "src/index.ts",
@@ -28,7 +28,7 @@
         "@material-ui/core": "^4.11.2",
         "@material-ui/icons": "^4.11.2",
         "@sentry/browser": "^6.1.0",
-        "@tivio/common": "1.1.83",
+        "@tivio/common": "1.1.86",
         "es7-object-polyfill": "^1.0.1",
         "firebase": "^8.2.3",
         "formik": "^2.2.7",
@@ -51,14 +51,14 @@
         "@types/jest": "^26.0.15",
         "@types/node": "^12.0.0",
         "@types/node-fetch": "^2.5.8",
-        "@types/react": "^17.0.0",
-        "@types/react-dom": "^17.0.0",
+        "@types/react": "^17.0.13",
+        "@types/react-dom": "^17.0.2",
         "@types/react-router-dom": "^5.1.6",
         "@types/react-virtualized": "^9.21.13",
         "@types/styled-components": "^5.1.7",
         "@typescript-eslint/eslint-plugin": "^4.14.0",
         "@typescript-eslint/parser": "^4.14.2",
-        "dotenv": "^8.2.0",
+        "dotenv": "^9.0.0",
         "eslint": "^7.19.0",
         "fork-ts-checker-webpack-plugin": "^7.0.0",
         "jest": "^27.0.1",
@@ -73,9 +73,6 @@
         "ts-jest": "^26.4.4",
         "typescript": "^4.1.3",
         "web-vitals": "^1.0.1",
-        "webpack": "^5.15.0",
-        "webpack-cli": "^4.4.0",
-        "webpack-merge": "^5.7.3",
         "yargs": "17"
     }
 }