@tivio/sdk-react 3.0.0 → 3.1.0

package/README.md

@@ -1,8 +1,14 @@
 # @tivio/sdk-react
 
 ## Changelog
+
 * UNRELEASED
-  *
+* v3.1.0
+  * patch: internal refactored `useAd`, `useAdSegment`
+  * patch: `useAdSegment()` now returns null if no monetization is configured, ad segments are not managed in that situation
+  * patch: internal: fixed refactored `setUser()`
+  * minor: enriched `AdSegment` type from `useAdSegment()`
+  * minor: Added `setUser()` function for login and logout
 * v3.0.0
   * minor: Added hook useWatchWithoutAdsOffer to trigger purchase dialog to "watch without ads", if available
   * patch: fix peerDependency declaration for react, react-dom
@@ -104,9 +110,24 @@ function App({children}) {
 }
 ```
 
-### Usage with authorization
+## Authentication
+
+A logged-in user can access more features, such as making purchases. In order to authenticate a user with Tivio, use the `setUser()` method.
+
+Verification of the user against 3rd party auth servers is implemented per customer.
+
+```typescript
+import { setUser } from '@tivio/sdk-react'
+
+// Log in
 
-// TODO
+// Payload is specific per customer
+// A common use-case is sending an auth token inside the payload, which Tivio can use to verify the user
+await setUser('userId', { token: 'xxx'})
+
+// Log out
+await setUser('userId', null)
+```
 
 ## Tivio widget
 

package/dist/components/hooks/playerHooks.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 type { AdSource, UsePlayerEvent } from '../../types/customPlayer.types';
+import type { UsePlayerEvent } from '../../types/customPlayer.types';
 import type { BetOffer, Marker } from '../../types/types';
 export declare const usePlayerEvent: UsePlayerEvent;
 export declare const useMarkers: () => Marker[] | null;
@@ -12,12 +12,17 @@ interface IntroMarker {
     skip: () => void;
 }
 export declare const useIntro: () => IntroMarker | null;
-export declare const useAd: () => AdSource | null;
+export declare const useAd: () => import("../../types/customPlayer.types").AdSource | null;
 export declare const useCurrentMarker: () => Marker | null;
 export declare const useSeekState: () => boolean | null;
-interface AdSegment {
+export declare const useAdSegment: () => {
+    id: string;
     remainingMs: number;
+    secondsToEnd: number;
+    secondsToSkippable: number | null;
     canSeek: boolean;
-}
-export declare const useAdSegment: () => AdSegment | null;
+    canSkip: boolean;
+    isSkippable: boolean;
+    skip: () => any;
+} | null;
 export {};

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

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

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

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

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

@@ -1,3 +1,6 @@
+/**
+ * TODO: Should be in core-js, we can't import types from it, though.
+ */
 declare type Voucher = {
     activate: () => void;
     isUsed: boolean;
@@ -6,7 +9,7 @@ declare type Voucher = {
     voucherInfo: any;
 };
 declare const useVoucher: (voucherId: string) => {
-    activate: (() => void) | null;
+    activate: (() => Promise<void>) | null;
     voucher: Voucher | null;
     error: Error | null;
 };

package/dist/index.d.ts

@@ -23,3 +23,4 @@ export { TivioGetters } from './types/bundle.types';
 export { TivioSubscriptions } from './types/bundle.types';
 export { PlayerCapability } from './types/bundle.types';
 export { Currency } from './types/bundle.types';
+export { setUser } from './services/login';