@tivio/sdk-react 7.0.0 → 7.1.0

package/README.md

@@ -6,6 +6,13 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* 7.1.0
+    * minor: export useTvChannelHook
+    * patch: bump "react-i18next", "i18next" versions.
+
+* 7.0.1
+    * patch: fix dependency to @tivio/common
+
 * 7.0.0
     * major: delete deprecated useWatchWithoutAdsOffer hook
     * major: consolidate duplicated source types

package/README.md.bak

@@ -6,6 +6,13 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* 7.1.0
+    * minor: export useTvChannelHook
+    * patch: bump "react-i18next", "i18next" versions.
+
+* 7.0.1
+    * patch: fix dependency to @tivio/common
+
 * 7.0.0
     * major: delete deprecated useWatchWithoutAdsOffer hook
     * major: consolidate duplicated source types

package/dist/index.d.ts

@@ -289,6 +289,31 @@ export declare interface AnalyticsInterface {
     }) => void;
 }
 
+/**
+ * @public
+ */
+export declare interface Application {
+    name: Translation;
+    type: ApplicationType;
+    urlHandle: string;
+    screens: ApplicationScreenConfig[] | null;
+}
+
+/**
+ * @public
+ */
+export declare interface ApplicationScreenConfig {
+    name: Translation;
+    order: number;
+    path: string;
+    screenConfig: ScreenConfig | null;
+}
+
+export declare enum ApplicationType {
+    TIVIO_PRO = "TIVIO_PRO",
+    ORGANIZATION = "ORGANIZATION"
+}
+
 /**
  * @public
  */
@@ -486,6 +511,7 @@ export declare interface CommonSourceInterface<T extends SourceType = SourceType
     isStarted: boolean;
     setIsStarted(isStarted: boolean): void;
     autoplay?: boolean;
+    autoplayMuteFallback: boolean;
     toLog(): any;
 }
 
@@ -1406,6 +1432,16 @@ export declare type LiveTvChannelSource = SourceBase & {
     channelName: string;
 };
 
+/**
+ * @public
+ */
+export declare type LoadScreenOptions = {
+    /**
+     * If true, then load rows of each loaded screen
+     */
+    loadRows?: boolean;
+};
+
 /**
  * If value of the field (only 1st level) is undefined it means that it was never saved
  * and might or might not be present in maxmind service.
@@ -1713,6 +1749,7 @@ declare type OrderByDirection = 'desc' | 'asc';
  */
 export declare interface Organization {
     userProfileConfiguration: any;
+    screenConfigs: ScreenConfig[];
 }
 
 /**
@@ -1889,6 +1926,7 @@ export declare interface PlayerEngineInterface {
     pause(): Promise<void>;
     unpause(): Promise<void>;
     isPaused(): boolean;
+    isSeeking: boolean;
     stop(): Promise<void>;
     addEventListener<T>(event: PlayerEngineEvent, callback: PlayerEngineListener<T>): void;
     addEventListener(event: 'statechange', callback: PlayerEngineListener<PlayerState>): void;
@@ -2013,7 +2051,7 @@ export declare interface PlayerInterface {
      * or just load it and keep it paused and ready to play if `source.autoplay` is false.
      * If source is `null`, stop and close the player (this is the same as if `this.stop()` was called.)
      */
-    setSource: (source: CommonSource | null) => void;
+    setSource: (source: CommonSource | null) => Promise<void> | void;
     /**
      * Set volume
      *
@@ -2082,6 +2120,7 @@ export declare interface PlayerSourceInterface<T extends NonAdSourceType = NonAd
     adSegment: AdSegment | null;
     consumedAds: ConsumedAds;
     currentMarker: any | null;
+    drm?: Drm;
     markers: any[];
     setMarkers(markers: any[]): void;
     isMarkersLoaded: boolean;
@@ -2815,6 +2854,7 @@ declare interface Screen_2 {
     rows: Row[];
     type?: ScreenType;
     filter?: RowFilterField | null;
+    embedUrl?: string | null;
 }
 export { Screen_2 as Screen }
 
@@ -3230,6 +3270,8 @@ export declare interface TivioConfig {
     firebaseApp?: any | null;
     firestore?: any | null;
     currency: Currency;
+    applicationId?: string;
+    isTivioProApp?: boolean;
     /**
      * Configuration for GDPR consent collection (CMP)
      */
@@ -3385,6 +3427,12 @@ export declare type TivioInternalHooks = {
     useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean, videoId?: string) => {
         subscriptions: PurchasableMonetization[];
     };
+    useCurrentApplication: () => {
+        screenConfigs: ScreenConfig[] | undefined;
+        isLoading: boolean;
+        switchApplicationByHandle: (handle?: string) => (Promise<void> | undefined);
+        isDefaultOrganization: boolean;
+    };
     useIsMonetizationPurchased: () => {
         isOneOfSubscriptionPurchased: (subscriptionIds: string[]) => boolean;
     };
@@ -4150,6 +4198,17 @@ export declare type UseTvChannel = (tvChannelId: string) => {
     loading: boolean;
 };
 
+/**
+ * Use Tv channel
+ * @param tvChannelId
+ * @public
+ */
+export declare const useTvChannel: (tvChannelId: string) => {
+    tvChannel: TvChannel | null;
+    error: Error | null;
+    loading: boolean;
+} | undefined;
+
 /**
  * @public
  */
@@ -4415,7 +4474,6 @@ export declare interface VirtualChannelSourceInterface extends ChannelSourceInte
     tvChannelType: TvChannelType.VIRTUAL;
     program?: TvProgram | null;
     video?: Video | null;
-    isPlayingBySchedule: boolean;
     clone(params?: Partial<VirtualChannelSourceParams>): VirtualChannelSourceInterface;
     initializeNext(): Promise<void>;
 }
@@ -4426,6 +4484,7 @@ export declare interface VirtualChannelSourceInterface extends ChannelSourceInte
 export declare interface VirtualChannelSourceParams extends ChannelSourceParams {
     tvChannelType: TvChannelType.VIRTUAL;
     currentProgram?: TvProgram | null;
+    drm?: Drm;
 }
 
 /**