@tivio/sdk-react 3.1.0 → 3.1.4-alpha

package/dist/services/bundlePromise.d.ts

@@ -1,4 +1,7 @@
 import { TivioBundle } from '../types/bundle.types';
 import type { RemoteBundleState } from './bundleLoader';
 export declare let tivioBundle: TivioBundle | null;
+/**
+ * rejects when bundle is not available
+ */
 export declare const bundlePromise: Promise<RemoteBundleState>;

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

@@ -1,4 +1,4 @@
-import { Currency, QerkoCancellationInfo, SubscribeToTaggedVideos, UseCancelSubscription } from '@tivio/common';
+import { Currency, QerkoCancellationInfo, ROW_ITEM_TYPES, SubscribeToTaggedVideos, Tag, TilePropsPartial, UseCancelSubscription } from '@tivio/common';
 import { ComponentType } from 'react';
 import { Logger } from '../services/logger';
 import { FetchPackage } from '../services/packageLoader';
@@ -25,6 +25,17 @@ declare type InternalConfig = {
     bundleUrlOverride?: string;
     currency: Currency;
     deviceCapabilities: PlayerCapability[];
+    /**
+     * Additional options for deviceCapabilities
+     */
+    capabilitiesOptions?: {
+        /**
+         * Should the player prefer HTTP sources instead HTTPs if they are available.
+         * This can be used on platforms that support mixed content but do not support
+         * specific HTTPS certificates. (e.g. certificates from Letsencrypt not supported on LG TVs)
+         */
+        preferHttp?: boolean;
+    };
     disableUnmounting?: boolean;
     enable?: boolean;
     enableSentry?: boolean;
@@ -52,8 +63,13 @@ 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;
 }
-declare type Config = Pick<InternalConfig, 'bundleUrlOverride' | 'currency' | 'disableUnmounting' | 'enable' | 'enableSentry' | 'ErrorComponent' | 'language' | 'LoaderComponent' | 'logger' | 'secret' | 'verbose'> & {
+declare type Config = Pick<InternalConfig, 'bundleUrlOverride' | 'currency' | 'disableUnmounting' | 'capabilitiesOptions' | 'enable' | 'enableSentry' | 'ErrorComponent' | 'language' | 'LoaderComponent' | 'logger' | 'secret' | 'verbose'> & {
     deviceCapabilities: PlayerCapability[] | 'auto';
+    /**
+     * @private
+     * Run HTML, CSS and JS feature support check
+     */
+    runFeatureSupportCheck?: boolean;
 };
 declare type TivioSubscriptions = {
     subscribeToUser: (cb: (error: string | null, user: User | null) => void) => void;
@@ -178,6 +194,11 @@ interface TivioAuth {
     signOut: () => Promise<void>;
     createFreePurchase: (monetizationId: string) => Promise<void>;
 }
+interface RouterOverridesContextState {
+    goToPlayer: (videoId: string, type: ROW_ITEM_TYPES, rowId?: string) => void;
+    goToTagPage: (tagId: string) => void;
+    goToLoginScreen: () => void;
+}
 declare type TivioComponents = {
     AdIndicationButtonWeb: React.ReactNode;
     Markers: React.ReactNode;
@@ -200,6 +221,15 @@ declare type TivioComponents = {
         onEnded?: () => any;
     }>;
     TvApp: React.ComponentType<TvAppProps>;
+    CustomerScreen: React.ComponentType<{
+        screenId: string;
+    }>;
+    WebTagScreen: React.ReactNode;
+    WebRow: React.ReactNode;
+    WebTile: React.ComponentType<{
+        item?: Video | Tag;
+    } & TilePropsPartial>;
+    FeatureSupportCheck: React.ComponentType<{}>;
 };
 declare type AdSegment = {
     id: string;
@@ -250,14 +280,63 @@ declare type TivioBundle = {
     setUser: (userId: string, userPayload: UserPayload | null) => Promise<void>;
     sources: TivioSources;
     subscriptions: TivioSubscriptions;
+    internal: {
+        hooks: TivioInternalHooks;
+        providers: TivioInternalProviders;
+    };
+};
+declare type TivioInternalHooks = {
+    useSubscriptionsOverlay: () => SubscriptionOverlayState;
+    useQerkoOverlay: () => QerkoOverlayState;
+    usePurchasesWithVideos: () => {
+        purchases: Purchase[];
+    };
+    useOrganizationSubscriptions: () => {
+        subscriptions: Monetization[];
+    };
+    useUser: () => {
+        user: User | null;
+        error: string | null;
+    };
+};
+declare type TivioInternalProviders = {
+    AppThemeProvider: React.ComponentType;
+    CustomerProvider: React.ComponentType;
+    UserContextProvider: React.ComponentType;
+    SubscriptionOverlayContextProvider: React.ComponentType;
+    QerkoOverlayContextProvider: React.ComponentType;
+    PurchasesWithVideosContextProvider: React.ComponentType;
+    OrganizationSubscriptionsContextProvider: React.ComponentType;
+    RouterOverridesContextProvider: React.ComponentType<RouterOverridesContextState>;
 };
 declare type TivioBundleFile = {
     Tivio: TivioBundle;
 };
+interface SubscriptionOverlayData {
+    subscriptions?: Monetization[];
+    onPurchase?: () => void;
+    onClose?: () => void;
+}
+declare type SubscriptionOverlayState = {
+    data: SubscriptionOverlayData | null;
+    closeSubscriptionOverlay: () => void;
+    openSubscriptionOverlay: (data: SubscriptionOverlayData) => void;
+};
+interface QerkoData {
+    monetization: Monetization;
+    video?: Video;
+    onPurchase?: () => void;
+    onClose?: () => void;
+}
+interface QerkoOverlayState {
+    data: QerkoData | null;
+    openQerkoOverlay: ((data: QerkoData) => void);
+    closeQerkoOverlay: () => void;
+}
 declare type RemoteBundleState = {
     config: InternalConfig;
     error: string | null;
     settings: Settings;
     state: 'loading' | 'error' | 'ready';
 } & Nullable<TivioBundle>;
-export type { RemoteBundleState, Config, Settings, InternalConfig, TivioBundle, TivioBundleFile, TivioHooks, TivioComponents, TivioAuth, TivioGetters, TivioSubscriptions, Events, PubSub, PlayerCapability, Currency, };
+export type { RemoteBundleState, Config, Settings, InternalConfig, TivioBundle, TivioBundleFile, TivioHooks, TivioComponents, TivioAuth, TivioGetters, TivioSubscriptions, TivioInternalHooks, TivioInternalProviders, Events, PubSub, PlayerCapability, Currency, };

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tivio/sdk-react",
-    "version": "3.1.0",
+    "version": "3.1.4-alpha",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "source": "src/index.ts",
@@ -14,8 +14,6 @@
         "start": "yarn ts-node ./scripts/start.ts",
         "test": "jest --config=./jest.config.js --coverage",
         "clean": "rm -rf dist",
-        "prepublishOnly": "yarn && yarn run build && yarn ts-node ./scripts/prepublish.ts",
-        "postpublish": "yarn ts-node ./scripts/postpublish.ts",
         "publish:alpha": "npm publish --tag alpha",
         "check:cycles": "npx madge --circular src/**/*"
     },
@@ -27,7 +25,7 @@
         "@material-ui/core": "^4.11.2",
         "@material-ui/icons": "^4.11.2",
         "@sentry/browser": "^6.1.0",
-        "@tivio/common": "1.1.71",
+        "@tivio/common": "*",
         "firebase": "^8.2.3",
         "formik": "^2.2.7",
         "i18next": "^19.8.4",

package/dist/components/context/OrganizationSubscriptionsContext.d.ts

@@ -1,9 +0,0 @@
-import { Monetization } from '@tivio/common';
-import React from 'react';
-interface OrganizationSubscriptionsContextState {
-    subscriptions: Monetization[];
-    setSubscriptions: (subscriptions: Monetization[]) => void;
-}
-declare const OrganizationSubscriptionsContext: React.Context<OrganizationSubscriptionsContextState>;
-declare const OrganizationSubscriptionsContextProvider: React.FC;
-export { OrganizationSubscriptionsContextProvider, OrganizationSubscriptionsContext, };

package/dist/components/context/PurchasesWithVideosContext.d.ts

@@ -1,9 +0,0 @@
-import { Purchase } from '@tivio/common';
-import React from 'react';
-interface PurchasesWithVideosContextState {
-    purchases: Purchase[];
-    setPurchases: (purchases: Purchase[]) => void;
-}
-declare const PurchasesWithVideosContext: React.Context<PurchasesWithVideosContextState>;
-declare const PurchasesWithVideosContextProvider: React.FC;
-export { PurchasesWithVideosContext, PurchasesWithVideosContextProvider, };

package/dist/components/context/UserContext.d.ts

@@ -1,9 +0,0 @@
-import { User } from '@tivio/common';
-import React from 'react';
-interface UserContextState {
-    user: User | null;
-    setUser: (user: User) => void;
-}
-declare const UserContext: React.Context<UserContextState>;
-declare const UserContextProvider: React.FC;
-export { UserContextProvider, UserContext, };