@tivio/sdk-react 2.4.1 → 2.4.2-alpha

package/README.md

@@ -1,6 +1,76 @@
 # @tivio/sdk-react
 
-See changelog [here](./doc/changelog.md)
+## Changelog
+* UNRELEASED
+  * patch: fix peerDependency declaration for react, react-dom
+  * major: TivioProvider requires deviceCapabilities
+  * major: TivioProvider requires currency
+  * minor: add voucher support (see usePurchaseSubscription and useTransactionPayment hooks)
+  * minor: device limit support
+  * minor: drm (Widevine, PlayReady) support
+  * minor: watermarking support
+  * minor: add useSearch hook
+  * patch: price on video is 0 when purchased
+* v2.4.2
+  * patch: added back changelog
+* 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
+  * ...
+
 
 ## Installation
 
@@ -179,11 +249,11 @@ function CustomPlayer() {
 
 ``` javascript
     // Report that video failed to load (e.g. due to a wrong URI)
-    playerWrapper.onLoadError(ms)
+    playerWrapper.onLoadError(new Error('video failed to load'))
 
     // Report that video failed during playback (e.g. due to bad connection, corrupted chunks of stream video etc.)
     // This type of error may be auto-recoverable
-    playerWrapper.onError(ms)
+    playerWrapper.onError(new Error('playback error'))
 }
 ```
 

package/dist/components/TivioProvider.d.ts

@@ -9,7 +9,7 @@ export declare type TivioProviderProps = {
     /**
      * This prop must be set only once and not change value afterwards
      */
-    conf?: Config;
+    conf: Config;
     children: React.ReactNode;
 };
 declare const TivioContext: React.Context<RemoteBundleState | null>;

package/dist/components/hooks/index.d.ts

@@ -13,6 +13,8 @@ export * from './useOrganizationSubscriptions';
 export * from './usePurchasesWithVideos';
 export * from './useFreePurchase';
 export * from './useRowsInScreen';
+export * from './useVoucher';
 export * from './useTivio';
 export * from './useOverlay';
 export * from './useWatchWithoutAds';
+export * from './useLastVideoByWidgetId';

package/dist/components/hooks/useLastVideoByWidgetId.d.ts

@@ -0,0 +1,2 @@
+import { Video } from '@tivio/common';
+export declare function useLastVideoByWidgetId(widgetId: string): Video | null;

package/dist/components/hooks/usePurchaseSubscription.d.ts

@@ -1,3 +1,4 @@
 import { QerkoTransaction } from '@tivio/common';
-declare const usePurchaseSubscription: (monetizationId: string) => QerkoTransaction;
+import { Voucher } from './useTransactionPayment';
+declare const usePurchaseSubscription: (monetizationId: string, voucher?: Voucher | undefined) => QerkoTransaction;
 export { usePurchaseSubscription, };

package/dist/components/hooks/useTransactionPayment.d.ts

@@ -1,3 +1,10 @@
 import { QerkoTransaction } from '@tivio/common';
-declare const useTransactionPayment: (videoId: string, monetizationId: string) => QerkoTransaction;
+declare type Voucher = {
+    /**
+     * Voucher expiration date as a Date object or timestamp in ms.
+     */
+    expirationDate: Date | number;
+};
+declare const useTransactionPayment: (videoId: string, monetizationId: string, voucher?: Voucher | undefined) => QerkoTransaction;
 export { useTransactionPayment, };
+export type { Voucher, };

package/dist/components/hooks/useVoucher.d.ts

@@ -0,0 +1,12 @@
+declare type Voucher = {
+    activate: () => void;
+    isUsed: boolean;
+    isExpired: boolean;
+    status: 'NEW' | 'USED';
+};
+declare const useVoucher: (voucherId: string) => {
+    activate: (() => void) | null;
+    voucher: Voucher | null;
+    error: Error | null;
+};
+export { useVoucher, };

package/dist/config.d.ts

@@ -2,7 +2,7 @@
  * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
  * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
  */
-import { Config as ExternalConfig, InternalConfig } from './types/bundle.types';
+import type { Config as ExternalConfig, InternalConfig } from './types/bundle.types';
 export declare const defaultConf: {
     secret: null;
     resolverUrl: string;
@@ -14,4 +14,4 @@ export declare const defaultConf: {
         error: string | null;
     }>;
 };
-export declare const createInternalConf: (conf: ExternalConfig | null) => InternalConfig;
+export declare const createInternalConf: (conf: ExternalConfig) => InternalConfig;

package/dist/index.d.ts

@@ -21,3 +21,5 @@ export { TivioComponents } from './types/bundle.types';
 export { TivioAuth } from './types/bundle.types';
 export { TivioGetters } from './types/bundle.types';
 export { TivioSubscriptions } from './types/bundle.types';
+export { PlayerCapability } from './types/bundle.types';
+export { Currency } from './types/bundle.types';