@tivio/sdk-react 5.0.1 → 5.0.3-alpha

package/dist/sdk-react.d.ts

@@ -1,5 +1,6 @@
 import { ComponentType } from 'react';
 import { FunctionComponentElement } from 'react';
+import { GeoPoint } from '@firebase/firestore-types';
 import { OperatingSystem } from 'detect-browser';
 import { default as React_2 } from 'react';
 
@@ -1100,18 +1101,44 @@ export declare type LiveTvChannelSource = SourceBase & {
 };
 
 /**
+ * If value of the field (only 1st level) is undefined it means that it was never saved
+ * and might or might not be present in maxmind service.
+ *
+ * If it is null it means that maxmind does not have data for this field.
+ *
  * @public
  */
-export declare type LocationField = {
+export declare interface LocationField {
     /**
-     * Two-letter uppercase continent code (TODO not sure if this ISO-3166 format or something else, we get these from maxmind service)
+     * Two-letter uppercase continent code (TODO not sure if this ISO-3166 format or something else, we get these from maxmind service).
      */
-    continentCode?: 'AF' | 'AN' | 'AS' | 'EU' | 'NA' | 'OC' | 'SA';
+    continentCode?: 'AF' | 'AN' | 'AS' | 'EU' | 'NA' | 'OC' | 'SA' | null;
     /**
-     * Two-letter uppercase country code according to ISO-3166 format (see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes)
+     * Two-letter uppercase country code according to ISO-3166 format (see https://en.wikipedia.org/wiki/List_of_ISO_3166_country_codes).
      */
-    countryIsoCode?: string;
-};
+    countryIsoCode?: string | null;
+    /**
+     *
+     */
+    city?: {
+        /**
+         * Maxmind specific id, works as key for identifying cities
+         * (see https://support.maxmind.com/hc/en-us/articles/4414877149467-IP-Geolocation-Data#h_01FRRNFD5Z5EWNCAXM6SZZ5H2C).
+         */
+        geonameId: number;
+        /**
+         * City name in english (see https://maxmind.github.io/GeoIP2-node/interfaces/CityRecord.html#names).
+         */
+        cityName?: string;
+    } | null;
+    /**
+     * The approximate latitude and longitude of the location associated with the IP address.
+     * This value is not precise and should not be used to identify a particular address or household.
+     *
+     * Source https://maxmind.github.io/GeoIP2-node/interfaces/LocationRecord.html#latitude.
+     */
+    geoPoint?: GeoPoint | null;
+}
 
 declare interface Logger {
     /** important messages */
@@ -2552,7 +2579,7 @@ export declare type TivioComponents = {
         onEnded?: () => any;
     }>;
     TvApp: React_2.ComponentType<TvAppProps>;
-    FeatureSupportCheck: React_2.ComponentType<{}>;
+    FeatureSupportCheck: React_2.ComponentType;
     CustomerScreen: React_2.ComponentType<{
         screenId: string;
     }>;
@@ -2692,6 +2719,7 @@ export declare type TivioHooks = {
         applyInviteCode: (code: string) => void;
         inviteCodeReset: () => void;
     };
+    useChannelSource: UseChannelSource;
 };
 
 /**
@@ -2751,7 +2779,6 @@ export declare type TivioInternalHooks = {
         loading: boolean;
     });
     useTvChannel: UseTvChannel;
-    useChannelSource: UseChannelSource;
     useUser: () => {
         user: User | null;
         error: string | null;
@@ -2948,6 +2975,11 @@ export declare type TivioVodSource = SourceBase & StartAndContinuePosition & {
  */
 export declare const TivioWidget: React_2.ForwardRefExoticComponent<Omit<TivioWidgetProps, "ref"> & React_2.RefAttributes<TivioWidgetRef>>;
 
+/**
+ * @public
+ */
+export declare const TivioWidgetApp: React_2.ForwardRefExoticComponent<Omit<TivioWidgetProps, "ref"> & React_2.RefAttributes<unknown>>;
+
 /**
  * @public
  */
@@ -2974,6 +3006,7 @@ export declare interface TivioWidgetProps {
         width: number;
         x: number;
     }) => any;
+    navigateFunction?: any;
 }
 
 /**
@@ -3149,6 +3182,16 @@ export declare type UseChannelSource = (tvChannelId: string) => {
     error: Error | null;
 };
 
+/**
+ * Use channel source
+ * @param tvChannelId
+ * @public
+ */
+export declare const useChannelSource: (tvChannelId: string) => {
+    source: ChannelSourcePojo | null;
+    error: Error | null;
+};
+
 /**
  * @public
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tivio/sdk-react",
-    "version": "5.0.1",
+    "version": "5.0.3-alpha",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "source": "src/index.ts",
@@ -13,7 +13,7 @@
         "build:dev": "cat ./.env.dev > ./.env && yarn build --config=webpack.config.dev.js && yarn typesRollup",
         "build:prod": "cat ./.env.prod > ./.env && yarn build --config=webpack.config.prod.js && yarn typesRollup",
         "build:local": "bash ./scripts/build_with_local_bundle.sh && yarn typesRollup",
-        "release": "ts-node ./scripts/release.ts -p=sdk-react",
+        "release": "ts-node ./scripts/release.ts -p=sdk-react -c=README.md",
         "release:patch": "yarn release -r=patch",
         "release:minor": "yarn release -r=minor",
         "release:major": "yarn release -r=major",
@@ -33,7 +33,7 @@
         "@material-ui/core": "^4.11.2",
         "@material-ui/icons": "^4.11.2",
         "@sentry/browser": "^6.1.0",
-        "@tivio/common": "1.1.103",
+        "@tivio/common": "1.1.105",
         "dayjs": "^1.11.0",
         "es7-object-polyfill": "^1.0.1",
         "firebase": "8.10.1",

package/changelog.md

@@ -1,224 +0,0 @@
-# Changelog @tivio/sdk-react
-
-* 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
-
-* v4.5.0
-    * minor: extend PurchaseEndpointPayload type with purchase previousStatus and newStatus fields
-
-* v4.4.1
-    * patch: added waitForTags param in useSearch hook for videos
-
-* v4.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
-
-* v4.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**
-
-* v4.2.0:
-    * minor: fix useSearch loading type
-    * patch: added italian language to `LangCode` enum
-
-* v4.1.0
-    * patch: added italian language to `LangCode` enum
-    * minor: fixed spanish language code in `LangCode` enum (`sp` -> `es`)
-    * minor: other misc type changes
-
-* v4.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
-
-* v4.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)_
-
-* v3.7.0
-    * minor: purchase contains created and updated
-
-* v3.6.3
-    * patch: improve README.md
-
-* v3.6.2
-    * patch: Fix types
-
-* v3.6.1
-    * patch: Fix README
-
-* v3.6.0
-    * minor: Update types
-
-* v3.5.2
-    * patch: All types are available again.
-
-* v3.5.1
-    * patch: remove incorrect dependency (@tivio/types)
-
-* v3.5.0
-    * minor: Types change - Video.price and Video.detailedPrice can be null
-    * minor: Types change - Video.cover is marked as deprecated
-
-* 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
-* v3.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
-* v3.2.4
-    * minor: added useApplyInviteCode
-    * minor: better errors from useVoucher
-* v3.2.3
-    * minor: added usePurchaseRecovery hook
-    * patch: deprecated `useLastVideoByWidgetId`
-* v3.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
-* v3.2.1
-    * 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 "LangCode"
-* v3.1.3
-    * patch: Hotfix made sure disabled Tivio does not break React Native
-* v3.1.2
-    * patch: Allow `conf` prop of `TivioProvider` to be `null` or `undefined` in order to turn off Tivio
-* v3.1.1
-    * patch: fixed `setUser()` crash when bundle fails to load
-* v3.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
-* 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
-    * 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
-    * ...