@tivio/sdk-react 10.1.0 → 10.2.0

package/dist/sdk-react.d.ts

@@ -1,8 +1,7 @@
 import type { ComponentType } from 'react';
 import { DocumentReference } from '@firebase/firestore-types';
 import type duration from 'dayjs/plugin/duration';
-import type { default as firebase_2 } from '@firebase/app-types';
-import type { default as firebase_3 } from 'firebase';
+import type firebase from '@firebase/app-types';
 import { FunctionComponentElement } from 'react';
 import type { GeoPoint } from '@firebase/firestore-types';
 import { OperatingSystem } from 'detect-browser';
@@ -26,7 +25,22 @@ export declare interface ActivatedPromotionsWithIdsResponse {
     activatedPromotionsIds: string[];
 }
 
-export declare type ActivateVoucherResponse = string | ActivatedPromotionsResponse | ActivatedPromotionsWithIdsResponse;
+/**
+ * Response returned when `activateVoucher` is called with `responseFormat: 'extended'`.
+ *
+ * It always carries `voucherInfo` (safe server-side metadata) and, depending on the
+ * voucher type, either a `purchaseId` (transaction / subscription) or the list of
+ * `activatedPromotions` (promotion voucher).
+ */
+export declare interface ActivateVoucherExtendedResponse {
+    voucherInfo: VoucherInfoPublic;
+    purchaseId?: string;
+    activatedPromotions?: ActivatedPromotion[];
+}
+
+export declare type ActivateVoucherResponse = string | ActivatedPromotionsResponse | ActivatedPromotionsWithIdsResponse | ActivateVoucherExtendedResponse;
+
+export declare type ActivateVoucherResponseFormat = 'legacy' | 'extended';
 
 declare interface actualPriceDetails {
     amountCents: number;
@@ -599,7 +613,7 @@ export declare interface AvatarProps {
  */
 export declare type BadRequestError = Error & {
     details?: {
-        reason?: 'DOES_NOT_EXIST' | 'EXPIRED' | 'ALREADY_USED' | 'ALREADY_USED_BY_CURRENT_USER';
+        reason?: 'DOES_NOT_EXIST' | 'EXPIRED' | 'ALREADY_USED' | 'ALREADY_USED_BY_CURRENT_USER' | 'LIMIT_REACHED' | 'FULFILLED' | 'INVALID_VOUCHER_TYPE';
     };
 };
 
@@ -1498,7 +1512,9 @@ export declare enum CustomerId {
     THE_JOHNY = "THE_JOHNY",
     GOOD_MOVE = "GOOD_MOVE",
     JANA_HANZ = "JANA_HANZ",
-    MYSTICO = "MYSTICO"
+    MYSTICO = "MYSTICO",
+    MORAVEC = "MORAVEC",
+    JAN_TUNA = "JAN_TUNA"
 }
 
 /**
@@ -3621,6 +3637,16 @@ export declare interface MonetizationCardProps {
     focused?: boolean;
 }
 
+/**
+ * @public
+ */
+export declare type MonetizationCta = {
+    type: 'email';
+    payload: {
+        email: string;
+    };
+};
+
 export declare interface MonetizationsCountsSummaryItem {
     /**
      * Unix timestamp at which the data is aggregated
@@ -5021,6 +5047,11 @@ export declare interface PubSub {
  * @public
  */
 export declare interface PurchasableMonetization extends Monetization {
+    /**
+     * If CTA is configured, the monetization should not be directly purchasable in clients.
+     * Client apps should render CTA action instead of purchase button.
+     */
+    cta?: MonetizationCta;
     /**
      * Price before any discounts (e.g. promotions).
      */
@@ -7007,14 +7038,6 @@ export declare type SubscribeToTaggedVideosOptions = Omit<SubscribeToItemsInRowO
     orderBy?: OrderBy<TaggedVideosOrderByField>[];
 };
 
-declare interface SubscriptionInfo {
-    id: string;
-    type: 'subscription';
-    name: string;
-    benefits: string[];
-    frequency: string;
-}
-
 /**
  * Extended language codes for subtitle tracks.
  * Includes all LangCode values plus additional languages only needed for subtitles.
@@ -7483,7 +7506,7 @@ export declare interface TivioConfig {
     debug?: boolean;
     verbose?: boolean;
     firebaseApp?: any | null;
-    firebaseFactory?: (config: object, appName?: string) => firebase_2.FirebaseApp;
+    firebaseFactory?: (config: object, appName?: string) => firebase.FirebaseApp;
     authDomainOverride?: string;
     /**
      * @deprecated this field is no longer in use and has no impact when set.
@@ -7612,7 +7635,7 @@ export declare type TivioHooks = {
         data: Video | null;
         error: string | null;
     };
-    useVoucher: (voucherId: string) => any;
+    useVoucher: (voucherId: string) => UseVoucherReturn;
     useApplyInviteCode: () => {
         applyInviteCodeResult?: boolean;
         loading: boolean;
@@ -7863,7 +7886,7 @@ export declare type TivioReactBundle = {
     }, email?: string) => Promise<QerkoPaymentInfo>;
     purchaseSubscriptionWithQerko: (monetizationId: string, voucher?: {
         expirationDate: Date;
-    }) => Promise<QerkoPaymentInfo>;
+    }, email?: string, quantity?: number) => Promise<QerkoPaymentInfo>;
     cancelSubscriptionWithQerko: (subscriptionId: string) => Promise<QerkoCancellationInfo>;
     showConsentPreferences: () => void;
     /**
@@ -7972,17 +7995,6 @@ export declare interface Track {
     language: LangCode;
 }
 
-declare interface TransactionInfo {
-    id: string;
-    type: 'transaction';
-    name: string;
-    videoId: string;
-    cover: string;
-    description: string;
-    promotions?: firebase_3.firestore.DocumentReference<Promotion>[];
-    fullDiscount?: boolean;
-}
-
 /**
  * Represents one string in every supported language mutation.
  * @public
@@ -8831,19 +8843,28 @@ export declare const useVideo: (videoIdOrUrlName?: string) => {
 /**
  * @public
  */
-export declare const useVoucher: (voucherId: string) => {
-    activate: (() => Promise<void>) | null;
-    voucher: Voucher | null;
-    /**
-     * You can check error.details if you need to know error type when you want your own error messages
-     * (can be one of "DOES_NOT_EXIST", "EXPIRED", "ALREADY_USED_BY_CURRENT_USER" and "ALREADY_USED").
-     */
-    error: Error | BadRequestError | null;
-    /**
-     * True if voucher has been successfully activated in current session.
-     */
+export declare const useVoucher: (voucherId: string) => UseVoucherReturn;
+
+/**
+ * Return type of `useVoucher` hook (core-react / sdk-react).
+ *
+ * Activation is triggered via the top-level `activate`. After a successful activation
+ * `voucher` carries the server-provided metadata (`voucherInfo`, `videoId`,
+ * `subscriptionsToShow`) as flat attributes. While the voucher is still initializing,
+ * `voucher` is `null`.
+ */
+export declare interface UseVoucherReturn {
+    activate: () => Promise<void>;
+    voucher: {
+        organizationId: string | null;
+        isInitialized: boolean;
+        voucherInfo: VoucherInfoPublic | null;
+        videoId?: string;
+        subscriptionsToShow: PurchasableMonetization[];
+    } | null;
+    error: Error | null;
     activationSuccess: boolean;
-};
+}
 
 /**
  * @public
@@ -9477,15 +9498,30 @@ export declare interface VodTivioSourceParams extends PlayerSourceParams<SourceT
     sessionId?: string;
 }
 
-/**
- * TODO: Should be in core-js, we can't import types from it, though.
- */
-declare interface Voucher {
-    activate: () => void;
-    isUsed: boolean;
+export declare interface VoucherInfoBasePublic {
+    id: string;
     isExpired: boolean;
-    status: 'NEW' | 'USED';
-    voucherInfo: SubscriptionInfo | TransactionInfo;
+    status: VoucherInfoPublicStatus;
+    fullDiscount?: boolean;
+}
+
+export declare type VoucherInfoPublic = VoucherInfoSubscriptionPublic | VoucherInfoTransactionPublic;
+
+export declare type VoucherInfoPublicStatus = 'NEW' | 'USED' | 'FULFILLED';
+
+export declare interface VoucherInfoSubscriptionPublic extends VoucherInfoBasePublic {
+    type: 'subscription';
+    name: string;
+    benefits: string[];
+    frequency?: MONETIZATION_FREQUENCY;
+}
+
+export declare interface VoucherInfoTransactionPublic extends VoucherInfoBasePublic {
+    type: 'transaction';
+    name: string;
+    videoId: string;
+    cover: string;
+    description: string;
 }
 
 declare interface VoucherPageConfiguration {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tivio/sdk-react",
-    "version": "10.1.0",
+    "version": "10.2.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "source": "src/index.ts",
@@ -15,6 +15,8 @@
         "turbo:build:libs:dev": "yarn build:dev",
         "turbo:build:libs:prod": "yarn build:prod",
         "build:ci": "yarn build:prod",
+        "typecheck": "yarn tsc --noEmit",
+        "typecheck:tests": "yarn tsc --noEmit -P src/__tests__/tsconfig.test.json",
         "build:local": "bash ./scripts/build_with_local_bundle.sh && yarn typesRollup",
         "release": "ts-node ./scripts/release.ts -p=sdk-react -c=CHANGELOG.md",
         "release:patch": "yarn release -r=patch",
@@ -39,7 +41,7 @@
         "@material-ui/core": "^4.11.2",
         "@material-ui/icons": "^4.11.2",
         "@sentry/browser": "^6.1.0",
-        "@tivio/common": "1.1.135",
+        "@tivio/common": "1.1.136",
         "dayjs": "^1.11.0",
         "es7-object-polyfill": "^1.0.1",
         "firebase": "8.10.1",

package/CHANGELOG.md

@@ -1,333 +0,0 @@
-## Changelog
-* 10.1.0
-  * minor: expose useInteractiveWidget, usePollWidget, useQuizWidget, useRemoteController
-  * minor: expose useRemoteController hook
-
-* 10.0.0
-  * major: **BREAKING** new purchase flow — `PurchasableMonetization.frequency` is now a structured object (`{ unit, value, title }`) instead of a plain `MONETIZATION_FREQUENCY` enum value. Replace `frequency === MONETIZATION_FREQUENCY.X` checks with `frequency?.unit === MONETIZATION_FREQUENCY.X`. The new `value` and `title` fields make it easier to render recurring prices (e.g. "9.99 € / 3 months") without hand-rolling the period label.
-  * major: **BREAKING** `TileProps` renamed to `TileComponentProps` to avoid a naming collision with the `TileProps` exported from row types
-  * minor: support Single Sign-On (SSO) across all subdomains under the same parent domain
-  * minor: add `getTagsByIds` method for batch tag lookup
-
-* 9.2.0
-  * minor: remove deprecated TivioWidget component
-  * minor: remove deprecated TivioWidgetError component
-  * minor: remove deprecated TivioWidgetLoader component
-  * patch: deprecate PurchasesWithVideosContextProvider
-  * minor: remove unused WebProfileScreen component
-  * minor: remove unused ChannelContext context
-  * minor: added video controller return from renderWebPlayer
-  * minor: update docs usage of renderWebPlayer and video controller
-
-* 9.2.0-alpha.4
-  * patch: expose getUser, resetPassword and signOut methods in RemoteBundleState type
-  * patch: more precise types for user profile fields and methods
-  * patch: add missing jsdocs for some User type fields
-
-* 9.2.0-alpha.0
-  * minor: add renderWebPlayer method for rendering outside of React
-  * minor: "expose createTivio"
-
-* 9.1.7
-  * patch: update remote controller component API
-
-* 9.1.6
-  * minor: add remote controller
-
-* 9.1.5
-  * patch: expose purchase loyalty points through types
-  * patch: enable setUser check
-
-* 9.1.4
-  * patch: disable setUser check
-  * patch: rollback "add renderWebPlayer method for rendering outside of React"
-  * patch: rollback "expose createTivio"
-
-* 9.1.3
-  * patch: add renderWebPlayer method for rendering outside of React
-  * patch: expose createTivio
-
-* 9.1.4
-  * patch: disable setUser check
-
-* 9.1.3
-  * minor: add renderWebPlayer method for rendering outside of React
-  * minor: expose createTivio
-
-* 9.1.2
-  * patch: update PurchaseEndpointPayload type (cityName, externalId, geoPoint)
-
-* 9.1.1
-  * patch: fix changelog
-
-* 9.1.0
-    * patch: add gateway to Purchase type
-    * minor: add QerkoPaymentWebhookByApiKeyRequest to exported types
-
-* 9.0.0
-    * patch: remove i18next and react-i18next from externals and dependencies
-    * patch: do not send react-spring to core-react-dom bundle, remove react-spring from dependencies
-    * patch: clean-up externals in webpack config
-    * patch: send only required dependencies to the bundle
-    * major: change purchase statuses lifecycle
-    * minor: add originalPurchaseId to PurchaseEndpointPayload
-
-* 8.0.0
-    * major: deprecated usePurchasesWithVideos hook removed
-    * patch: add id to user type
-    * patch: add @types/react to peerDependencies
-
-* 7.1.0
-    * minor: export useTvChannelHook
-    * patch: bump "react-i18next", "i18next" versions.
-
-* 7.0.1
-    * patch: fix dependency to @tivio/common
-
-* 7.0.0
-    * major: delete deprecated useWatchWithoutAdsOffer hook
-    * major: consolidate duplicated source types
-    * patch: add new properties to PlayerInterface
-    * patch: expose getSeekingMatrixPreviewByTime in Video interface
-    * major: delete deprecated useBetOffer hook
-    * major: rework of source types
-    * major: make useChannelSource deprecated
-
-* 6.0.1
-    * patch: fix dependency to @tivio/common
-
-* 6.0.0
-    * major: delete usePlayerEvent hook
-    * major: replace uri attributes in types with url
-    * major: delete uri attributes from types
-    * minor: add purchase expiration to PurchaseEndpointPayload
-    * minor: add optional videoId parameter to useOrganizationSubscription hook
-
-* 5.0.2
-    * patch: export hook useChannelSource
-
-* 5.0.1
-    * patch: move changelog
-
-* 5.0.0
-    * major: upgrade to React 18, change react and react-dom peer dependencies to 17.x || 18.x
-    * major: fix typing for useReferralInfo, now correctly showing that `null` can be returned
-    * major: fix typing for `WebRowProps.onTileClick`, now correctly showing that `null` can be accepted
-    * minor: add analytics
-    * minor: add getSourceUrl function to video and tv channel types
-    * minor: add uri property to tv channel type
-    * minor: add useChannelSource to hooks
-
-* 4.5.0
-    * minor: extend PurchaseEndpointPayload type with purchase previousStatus and newStatus fields
-
-* 4.4.1
-    * patch: added waitForTags param in useSearch hook for videos
-
-* 4.4.0
-    * minor: PrimaryButton component props type set to any for now
-    * patch: isPurchasableAsVoucher added to PurchasableMonetization
-    * patch: voucherPurchase flag added to purchase overlays
-    * patch: item added to MonetizationsSelectOverlayData
-    * minor: added hungarian language to `LangCode` enum
-
-* 4.3.0:
-    * minor: add GetPurchaseInfoResponse and PurchaseEndpointPayload to exported types
-    * minor: support for disabling purchase of specified subscriptions (new param in useOrganizationSubscriptions hook)
-    * minor: more specific PurchasableMonetization type usage instead of Monetization
-    * minor: monetization property deleted from Video type
-    * minor: monetization now has originalPrice and promotion properties available
-    * patch: remove not used OrganizationSubscriptionsContext, **this change requires bundle 3.20.0 or newer**
-
-* 4.2.0:
-    * minor: fix useSearch loading type
-    * patch: added italian language to `LangCode` enum
-
-* 4.1.0
-    * patch: added italian language to `LangCode` enum
-    * minor: fixed spanish language code in `LangCode` enum (`sp` -> `es`)
-    * minor: other misc type changes
-
-* 4.0.1
-    * patch: added setBundleVersion setter to bundle type
-    * patch: added setStorageManager setter to bundle type
-    * patch: `Purchase.isPurchased` is deprecated
-    * patch: fill `useSearch` field `hasNextPage` with proper value
-
-* 4.0.0
-    * minor: Types cleanup
-    * MAJOR: Remove deprecated and unused stuff
-        * auth
-            * changePassword
-            * changeUserPhoto
-            * removeUserPhoto
-            * getPurchasedVodsWithInitializedVideos
-            * initializeUser
-            * createFreePurchase
-        * components
-            * videoAdBanner
-        * getters
-            * getExportedConfig
-            * getChannelById
-            * getSectionById
-            * getWidgetById
-        * hooks
-            * useLastVideoByWidgetId
-            * useScreen
-            * useFreePurchase
-            * useWidget
-            * useChannel
-            * useSection
-            * useVideosInSection
-            * useSectionsInChannel
-            * useChannelsInWidget
-        * subscriptions
-            * subscribeToWidget
-            * subscribeToChannel
-            * subscribeToSection
-            * subscribeToVideosInSection
-            * subscribeToSectionsInChannel
-            * subscribeToChannelsInWidget
-            * subscribeToScreen
----
-_Versions <= v3.7.0 requires core-react-dom bundle < v3.0.0 (because sdk-react used some sdk API deleted in core-react-dom@4.0.0)_
-
-* 3.7.0
-    * minor: purchase contains created and updated
-
-* 3.6.3
-    * patch: improve README.md
-
-* 3.6.2
-    * patch: Fix types
-
-* 3.6.1
-    * patch: Fix README
-
-* 3.6.0
-    * minor: Update types
-
-* 3.5.2
-    * patch: All types are available again.
-
-* 3.5.1
-    * patch: remove incorrect dependency (@tivio/types)
-
-* 3.5.0
-    * minor: Types change - Video.price and Video.detailedPrice can be null
-    * minor: Types change - Video.cover is marked as deprecated
-
-* 3.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
-* 3.3.2
-    * patch: Adding new optional parameters (where, orderBy) to useTaggedVideos hook
-* 3.3.1
-    * patch: Fixed types of `setUser`
-* 3.3.0
-    * minor: Add getPlayerCapabilities to getters.
-    * patch: Added option to log out via `setUser(null)`, requires @tivio/core-react-dom@2.17.9
-* 3.2.5
-    * patch: added recovery flag to QerkoPaymentInfo type
-    * patch: bundle.types changes - internal.components.WebVideoScreen
-    * patch: types changes - add new onBack prop to WebPlayerProps
-    * patch: Refactor useVideo hook, now uses hook from core-react
-* 3.2.4
-    * minor: added useApplyInviteCode
-    * minor: better errors from useVoucher
-* 3.2.3
-    * minor: added usePurchaseRecovery hook
-    * patch: deprecated `useLastVideoByWidgetId`
-* 3.2.2
-    * minor: useRowsInScreen, useItemsInRow, useTaggedVideos - hasNextPage and loading added to pagination
-    * minor: useRowsInScreen, useItemsInRow, useTaggedVideos - implementation moved to remote bundle
-    * patch: Fixed Tivio startup on Tizen 6
-    * minor: Added `forceCloudFnResolver` option
-* 3.2.1
-    * patch: fix of @tivio/common version
-* 3.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 "LangCode"
-* 3.1.3
-    * patch: Hotfix made sure disabled Tivio does not break React Native
-* 3.1.2
-    * patch: Allow `conf` prop of `TivioProvider` to be `null` or `undefined` in order to turn off Tivio
-* 3.1.1
-    * patch: fixed `setUser()` crash when bundle fails to load
-* 3.1.0
-    * patch: `useAdSegment()` now returns null if no monetization is configured, ad segments are not managed in that situation
-    * minor: enriched `AdSegment` type from `useAdSegment()`
-    * minor: Added `setUser()` function for login and logout
-* 3.0.0
-    * minor: Added hook `useWatchWithoutAdsOffer` to trigger purchase dialog to "watch without ads", if available
-    * 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
-* 2.4.2
-    * patch: added back changelog
-* 2.4.1
-    * patch: improved doc about player wrapper
-* 2.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)
-* 2.3.4
-    * patch: fix of usePurchaseSubscription not reactive
-* 2.3.3
-    * patch: fix of useUser not updating
-* 2.3.2
-    * patch: next app doesn't fail anymore due to "self is not defined"
-* 2.3.1
-    * patch: fix of @tivio/common dependency
-* 2.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
-* 2.2.1
-    * patch: disable Sentry when no config is supplied to `TivioProvider`
-* 2.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 }`
-* 2.1.5
-    * patch fix of `useVideosInSection` hook (fetching video's monetizations)
-* 2.1.4
-    * patch: fix re-rendering of `useAd` during non-skippable ads (requires core-react-dom@2.1.9)
-* 2.1.3
-    * patch: fix changelog
-* 2.1.2
-    * patch: Fixed exported types
-* 2.1.1
-    * patch: TivioWidget now correctly reports `false` via `onEnabled` callback when in invalid internal state
-* 2.1.0
-    * patch: fix of useItemsInRow hook
-    * patch: fix of useScreen hook
-    * add: useRowsInScreen hook
-* 2.0.3
-    * patch: fix of useItemsInRow hook
-* 2.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
-* 2.0.1
-    * no changes
-* 2.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`
-* 1.3.6
-    * ?
-* 1.3.5
-    * minor: added WebPlayer props (canReplay, showMarkers, customShortcuts, enableKeyboardShortcuts, source.poster)
-* 1.3.4
-    * ...