@tivio/sdk-react 5.0.1 → 5.0.3-alpha

package/README.md

@@ -6,6 +6,9 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* 5.0.2
+    * patch: export hook useChannelSource
+
 * 5.0.1
     * patch: move changelog
 

package/README.md.bak

@@ -6,6 +6,9 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* 5.0.2
+    * patch: export hook useChannelSource
+
 * 5.0.1
     * patch: move changelog
 

package/dist/index.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';
 
@@ -947,18 +948,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 */
@@ -2310,7 +2337,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;
     }>;
@@ -2450,6 +2477,7 @@ export declare type TivioHooks = {
         applyInviteCode: (code: string) => void;
         inviteCodeReset: () => void;
     };
+    useChannelSource: UseChannelSource;
 };
 
 /**
@@ -2509,7 +2537,6 @@ export declare type TivioInternalHooks = {
         loading: boolean;
     });
     useTvChannel: UseTvChannel;
-    useChannelSource: UseChannelSource;
     useUser: () => {
         user: User | null;
         error: string | null;
@@ -2698,6 +2725,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
  */
@@ -2724,6 +2756,7 @@ export declare interface TivioWidgetProps {
         width: number;
         x: number;
     }) => any;
+    navigateFunction?: any;
 }
 
 /**
@@ -2899,6 +2932,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
  */