@tivio/sdk-react 2.4.1 → 2.4.2-alpha

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

@@ -1,39 +1,46 @@
-import { SubscribeToTaggedVideos, UseCancelSubscription } from '@tivio/common';
+import { Currency, SubscribeToTaggedVideos, UseCancelSubscription } 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 type { AdSource, PlayerWrapper } from './customPlayer.types';
-import type { Monetization, QerkoPaymentInfo, Screen, SubscribeToItemsInRow, SubscribeToRowsInScreen, SubscribeToScreen, TvAppProps, Video, User, Purchase, UseSearch } from '@tivio/common';
+import type { Monetization, Purchase, QerkoPaymentInfo, Screen, SubscribeToItemsInRow, SubscribeToRowsInScreen, SubscribeToScreen, TvAppProps, User, UseSearch, Video } from '@tivio/common';
 import type React from 'react';
 declare type Settings = {
     onSetUser: (handler: (userId: string, userPayload: unknown) => void) => void;
     setUser: (userId: string, userPayload: unknown) => void;
 };
+interface PlayerCapability {
+    codec: 'h264' | 'h265';
+    encryption: 'fairplay' | 'none' | 'playready' | 'widevine';
+    protocol: 'dash' | 'hls';
+}
 declare type InternalConfig = {
-    enable?: boolean;
-    secret: string | null;
-    verbose?: boolean;
-    /**
-     * @private URL of resolver. Resolver is a script used to fetch remove code bundle
-     */
-    resolverUrl: string;
     /**
      * @private URL of remote code bundle to be fetched directly (without using resolver)
      */
     bundleUrlOverride?: string;
+    currency: Currency;
+    deviceCapabilities: PlayerCapability[];
     disableUnmounting?: boolean;
-    logger?: Logger | null;
-    fetchPackage: FetchPackage;
-    pubSub: PubSub;
-    LoaderComponent?: ComponentType;
+    enable?: boolean;
+    enableSentry?: boolean;
     ErrorComponent?: ComponentType<{
         error: string | null;
     }>;
+    fetchPackage: FetchPackage;
     language?: string;
+    LoaderComponent?: ComponentType;
+    logger?: Logger | null;
+    pubSub: PubSub;
+    /**
+     * @private URL of resolver. Resolver is a script used to fetch remove code bundle
+     */
+    resolverUrl: string;
     sdkVersion: string;
-    enableSentry?: boolean;
+    secret: string | null;
+    verbose?: boolean;
 };
 declare type Events = {
     'on-ready': RemoteBundleState;
@@ -43,7 +50,9 @@ 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, 'enable' | 'secret' | 'verbose' | 'logger' | 'disableUnmounting' | 'bundleUrlOverride' | 'LoaderComponent' | 'ErrorComponent' | 'language' | 'enableSentry'>;
+declare type Config = Pick<InternalConfig, 'bundleUrlOverride' | 'currency' | 'disableUnmounting' | 'enable' | 'enableSentry' | 'ErrorComponent' | 'language' | 'LoaderComponent' | 'logger' | 'secret' | 'verbose'> & {
+    deviceCapabilities: PlayerCapability[] | 'auto';
+};
 declare type TivioSubscriptions = {
     subscribeToUser: (cb: (error: string | null, user: User | null) => void) => void;
     /**
@@ -194,6 +203,8 @@ declare type TivioHooks = {
     useAd: () => [(AdSource | null)];
     useCancelSubscription: UseCancelSubscription;
     useSearch: UseSearch;
+    useVoucher: (voucherId: string) => any;
+    useLastVideoByWidgetId: (widgetId: string) => Video | null;
 };
 declare type TivioBundle = {
     components: TivioComponents;
@@ -201,8 +212,12 @@ declare type TivioBundle = {
     auth: TivioAuth;
     hooks: TivioHooks;
     init: (config: Config) => void | Promise<void>;
-    purchaseVideoWithQerko: (videoId: string, monetizationId: string) => Promise<QerkoPaymentInfo>;
-    purchaseSubscriptionWithQerko: (monetizationId: string) => Promise<QerkoPaymentInfo>;
+    purchaseVideoWithQerko: (videoId: string, monetizationId: string, voucher?: {
+        expirationDate: Date;
+    }) => Promise<QerkoPaymentInfo>;
+    purchaseSubscriptionWithQerko: (monetizationId: string, voucher?: {
+        expirationDate: Date;
+    }) => Promise<QerkoPaymentInfo>;
     setLanguage: (language: Language) => void;
     setUser: (userId: string, userPayload?: unknown) => void;
     sources: TivioSources;
@@ -217,4 +232,4 @@ declare type RemoteBundleState = {
     settings: Settings;
     state: 'loading' | 'error' | 'ready';
 } & Nullable<TivioBundle>;
-export type { RemoteBundleState, Config, Settings, InternalConfig, TivioBundle, TivioBundleFile, TivioHooks, TivioComponents, TivioAuth, TivioGetters, TivioSubscriptions, Events, PubSub, };
+export type { RemoteBundleState, Config, Settings, InternalConfig, TivioBundle, TivioBundleFile, TivioHooks, TivioComponents, TivioAuth, TivioGetters, TivioSubscriptions, Events, PubSub, PlayerCapability, Currency, };

package/doc/changelog.md

@@ -1,59 +0,0 @@
-## Changelog
-* Unreleased
-* v2.4.1
-  * patch: improved doc about player wrapper
-* v2.4.0
-  * patch: improved Player wrapper types
-  * minor: added Tivio DOM events `tivio_key_input_handling_change`, `tivio_context_switch` and `tivio_request_goto`
-  * patch: added support for remote code on browsers that do not implement [indexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)
-  * patch: added support for browsers that do not implement [indexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)
-* v2.3.4
-  * patch: fix of usePurchaseSubscription not reactive
-* v2.3.3
-  * patch: fix of useUser not updating
-* v2.3.2
-  * patch: next app doesn't fail anymore due to "self is not defined"
-* v2.3.1
-  * patch: fix of @tivio/common dependency
-* v2.3.0
-  * minor: add useTaggedVideos that allows to fetch videos with given tags
-  * minor: add option to fetch tags (on hook useItemsInRow), useVideo always fetching videos tags
-* v2.2.1
-  * patch: disable Sentry when no config is supplied to `TivioProvider`
-* v2.2.0
-  * patch: reduced bundle size
-  * minor: disable Sentry when no config is supplied to `TivioProvider` or when Tivio is disabled `{ enable: false }`, or when Sentry is disabled via config `{ enableSentry: false }`
-* v2.1.5
-  * patch fix of `useVideosInSection` hook (fetching video's monetizations)
-* v2.1.4
-  * patch: fix re-rendering of `useAd` during non-skippable ads (requires core-react-dom@2.1.9)
-* v2.1.3
-  * patch: fix changelog
-* v2.1.2
-  * patch: Fixed exported types
-* v2.1.1
-  * patch: TivioWidget now correctly reports `false` via `onEnabled` callback when in invalid internal state
-* v2.1.0
-  * patch: fix of useItemsInRow hook
-  * patch: fix of useScreen hook
-  * add: useRowsInScreen hook
-* v2.0.3
-  * patch: fix of useItemsInRow hook
-* v2.0.2
-  * patch: screen and row IDs fixed
-      * `TivioBundle.subscriptions.subscribeToItemsInRow` now accepts user-defined ID via studio.tiv.io
-      * `TivioBundle.subscriptions.subscribeToScreen` now accepts user-defined ID via studio.tiv.io
-      * `Screen` and `Row` types returned by `useScreen()` return their user-defined IDs (`.id`) correctly
-* v2.0.1
-  * no changes
-* v2.0.0
-  * major: video.channelId can now be `string | null` used to be `string`
-  * minor: added data API and hooks for screens (screens, rows of screen and row items)
-    * hooks: `useScreen()`,  `useItemsInRow()`
-    * api: `TivioBundle.subscriptions.subscribeToScreen`,  `TivioBundle.subscriptions.subscribeToItemsInRow`
-* v1.3.6
-  * ?
-* v1.3.5
-  * minor: added WebPlayer props (canReplay, showMarkers, customShortcuts, enableKeyboardShortcuts, source.poster)
-* v1.3.4
-  * ...

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tivio/sdk-react",
-    "version": "2.4.1",
+    "version": "2.4.2-alpha",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "source": "src/index.ts",
@@ -14,7 +14,7 @@
         "start": "yarn ts-node ./scripts/start.ts",
         "test": "jest --config=./jest.config.js --coverage",
         "clean": "rm -rf dist",
-        "prepublishOnly": "yarn && yarn ts-node ./scripts/prepublish.ts && yarn run build",
+        "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,18 +27,16 @@
         "@material-ui/core": "^4.11.2",
         "@material-ui/icons": "^4.11.2",
         "@sentry/browser": "^6.1.0",
-        "@tivio/common": "1.1.62",
+        "@tivio/common": "1.1.68",
         "firebase": "^8.2.3",
         "formik": "^2.2.7",
         "i18next": "^19.8.4",
         "mobx-react": "^7.1.0",
         "mobx": "^6.0.4",
-        "react-dom": "^17.0.2",
         "react-i18next": "^9.0.10",
         "react-router-dom": "^5.2.0",
         "react-spring": "^9.2.4",
         "react-virtualized": "^9.22.3",
-        "react": "^17.0.2",
         "styled-components": "^5.2.1",
         "yup": "^0.32.9"
     },
@@ -64,6 +62,8 @@
         "jest-fetch-mock": "^3.0.3",
         "madge": "^5.0.1",
         "node-fetch": "^2.6.1",
+        "react": "^17.0.2",
+        "react-dom": "^17.0.2",
         "stream-browserify": "^3.0.0",
         "timers-browserify": "^2.0.12",
         "ts-jest": "^26.4.4",