@tivio/sdk-react 3.3.0 → 3.4.0

package/.madgerc

@@ -0,0 +1,7 @@
+{
+	"detectiveOptions": {
+		"ts": {
+			"skipTypeImports": true
+		}
+	}
+}

package/README.md

@@ -2,6 +2,18 @@
 
 ## Changelog
 
+* UNRELEASED
+
+* v3.4.0
+  * minor: more precise type for errors in usePurchaseRecovery and usePurchaseRecovery
+  * patch: jsdocs for usePurchaseRecovery and usePurchaseRecovery
+  * minor: inviteCodeReset in useApplyInviteCode
+  * minor: Reset forgotten password
+  * minor: Consolidating monetization logic
+* v3.3.2
+  * patch: Adding new optional parameters (where, orderBy) to useTaggedVideos hook
+* v3.3.1
+  * patch: Fixed types of `setUser`
 * v3.3.0
   * minor: Add getPlayerCapabilities to getters.
   * patch: Added option to log out via `setUser(null)`, requires @tivio/core-react-dom@2.17.9
@@ -25,7 +37,7 @@
   * patch: fix of @tivio/common version
 * v3.2.0
   * minor: Added `capabilitiesOptions` for finer configuration of device capabilities
-  * minor: tag names are returned in correct language (the one from tivio config); language value should be one from enum "Language"
+  * minor: tag names are returned in correct language (the one from tivio config); language value should be one from enum "LangCode"
 * v3.1.3
   * patch: Hotfix made sure disabled Tivio does not break React Native
 * v3.1.2

package/README.md.bak

@@ -2,6 +2,18 @@
 
 ## Changelog
 
+* UNRELEASED
+
+* v3.4.0
+  * minor: more precise type for errors in usePurchaseRecovery and usePurchaseRecovery
+  * patch: jsdocs for usePurchaseRecovery and usePurchaseRecovery
+  * minor: inviteCodeReset in useApplyInviteCode
+  * minor: Reset forgotten password
+  * minor: Consolidating monetization logic
+* v3.3.2
+  * patch: Adding new optional parameters (where, orderBy) to useTaggedVideos hook
+* v3.3.1
+  * patch: Fixed types of `setUser`
 * v3.3.0
   * minor: Add getPlayerCapabilities to getters.
   * patch: Added option to log out via `setUser(null)`, requires @tivio/core-react-dom@2.17.9
@@ -25,19 +37,15 @@
   * patch: fix of @tivio/common version
 * v3.2.0
   * minor: Added `capabilitiesOptions` for finer configuration of device capabilities
-  * minor: tag names are returned in correct language (the one from tivio config); language value should be one from enum "Language"
+  * minor: tag names are returned in correct language (the one from tivio config); language value should be one from enum "LangCode"
 * v3.1.3
   * patch: Hotfix made sure disabled Tivio does not break React Native
-  * internal: Fixed conf.bundleUrlOverride error handling
 * v3.1.2
   * patch: Allow `conf` prop of `TivioProvider` to be `null` or `undefined` in order to turn off Tivio
-  * internal: Added `runFeatureSupportCheck` to `TivioProvider`
 * v3.1.1
   * patch: fixed `setUser()` crash when bundle fails to load
 * v3.1.0
-  * internal: refactored `useAd`, `useAdSegment`
   * patch: `useAdSegment()` now returns null if no monetization is configured, ad segments are not managed in that situation
-  * internal: fixed refactored `setUser()`
   * minor: enriched `AdSegment` type from `useAdSegment()`
   * minor: Added `setUser()` function for login and logout
 * v3.0.0

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

@@ -11,6 +11,7 @@ export * from './usePurchaseSubscription';
 export * from './contentHooks';
 export * from './playerHooks';
 export * from './useOrganizationSubscriptions';
+export * from './useIsMonetizationPurchased';
 export * from './usePurchasesWithVideos';
 export * from './useFreePurchase';
 export * from './useRowsInScreen';

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

@@ -1,6 +1,17 @@
+/**
+ *  Is used to login user through different device in which user is already logged in.
+ *  (e.g. login in tv app through web app)
+ *
+ *  @return applyInviteCodeResult - true if code was applied successfully, false otherwise.
+ *          loading - loading state
+ *          error - error in case request failure
+ *          applyInviteCode - function to apply invite code
+ *          inviteCodeReset - function to reset to initial state
+ */
 export declare function useApplyInviteCode(): {
     applyInviteCodeResult?: boolean | undefined;
     loading: boolean;
-    error?: any;
+    error?: import("../..").GenericOnCallError | undefined;
     applyInviteCode: (code: string) => void;
+    inviteCodeReset: () => void;
 };

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

@@ -0,0 +1,3 @@
+export declare const useIsMonetizationPurchased: () => {
+    isOneOfSubscriptionPurchased: (subscriptionIds: string[]) => boolean;
+};

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

@@ -1,6 +1,14 @@
+/**
+ * Is used to mark purchase in recovery state as PAID.
+ *
+ * @return purchaseRecoveryResult - message describing result of the recovery
+ *         loading - loading state
+ *         error - error in case request failure
+ *         purchaseRecovery - functions to execute purchase recovery
+ */
 export declare function usePurchaseRecovery(): {
     purchaseRecoveryResult?: string | undefined;
     loading: boolean;
-    error?: any;
+    error?: import("../..").GenericOnCallError | undefined;
     purchaseRecovery: (monetizationId: string) => void;
 };

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

@@ -1,4 +1,5 @@
 export declare const useUser: () => {
     user: import("@tivio/common/dist/types/externalTypes/user").User | null;
     error: string | null;
+    isInitialized: boolean;
 };

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

@@ -11,7 +11,20 @@ declare type Voucher = {
     isUsed: boolean;
     isExpired: boolean;
     status: 'NEW' | 'USED';
-    voucherInfo: any;
+    voucherInfo: SubscriptionInfo | TransactionInfo;
+};
+declare type SubscriptionInfo = {
+    type: 'subscription';
+    name: string;
+    benefits: string[];
+    frequency: string;
+};
+declare type TransactionInfo = {
+    type: 'transaction';
+    name: string;
+    videoId: string;
+    cover: string;
+    description: string;
 };
 declare const useVoucher: (voucherId: string) => {
     activate: (() => Promise<void>) | null;
@@ -21,5 +34,9 @@ declare const useVoucher: (voucherId: string) => {
      * (can be one of "DOES_NOT_EXIST", "EXPIRED" and "ALREADY_USED").
      */
     error: Error | BadRequestError | null;
+    /**
+     * True if voucher has been successfully activated in current session.
+     */
+    activationSuccess: boolean;
 };
 export { useVoucher, };

package/dist/index.d.ts

@@ -18,3 +18,4 @@ export { Empty } from './types/common';
 export { Nullable } from './types/common';
 export * from './types/bundle.types';
 export { setUser } from './services/login';
+export { showGdprConsentPreferences } from './services/gdpr';