@tivio/sdk-react 9.1.0 → 9.1.2

package/README.md

@@ -6,8 +6,13 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* 9.1.2
+  * patch: update PurchaseEndpointPayload type (cityName, externalId, geoPoint)
+
+* 9.1.1
+  * patch: fix changelog
+
 * 9.1.0
-    * minor: revert add originalPurchaseId to PurchaseEndpointPayload
     * patch: add gateway to Purchase type
     * minor: add QerkoPaymentWebhookByApiKeyRequest to exported types
 

package/README.md.bak

@@ -6,8 +6,13 @@ settings in the administration of Tivio Studio while having the freedom to build
 
 ## Changelog
 
+* 9.1.2
+  * patch: update PurchaseEndpointPayload type (cityName, externalId, geoPoint)
+
+* 9.1.1
+  * patch: fix changelog
+
 * 9.1.0
-    * minor: revert add originalPurchaseId to PurchaseEndpointPayload
     * patch: add gateway to Purchase type
     * minor: add QerkoPaymentWebhookByApiKeyRequest to exported types
 

package/dist/index.d.ts

@@ -1,8 +1,10 @@
 import { ComponentType } from 'react';
+import type dayjs from 'dayjs';
 import { DocumentReference } from '@firebase/firestore-types';
+import type duration from 'dayjs/plugin/duration';
 import firebase from '@firebase/app-types';
 import { FunctionComponentElement } from 'react';
-import { GeoPoint } from '@firebase/firestore-types';
+import type { GeoPoint } from '@firebase/firestore-types';
 import { OperatingSystem } from 'detect-browser';
 import type { PaletteType } from '@material-ui/core';
 import { default as React_2 } from 'react';
@@ -487,6 +489,7 @@ export declare interface BannerProps {
     hoverable: boolean;
     height: number;
     cover?: string | null;
+    created?: Date | null;
     overlay: boolean;
     price: string;
     borderRadius?: string | number;
@@ -845,12 +848,12 @@ export declare const createPubSub: () => PubSub;
  * Fetch & load CommonJS remote module.
  * @public
  */
-export declare const createRemotePackageLoader: () => (secret: string, conf: InternalConfig) => Promise<TivioBundle>;
+export declare const createRemotePackageLoader: () => (secret: string, conf: InternalConfig, checkBundleCharCount?: boolean) => Promise<TivioBundle>;
 
 /**
  * @public
  */
-export declare const createUseRemoteBundle: () => (conf: InternalConfig) => RemoteBundleState;
+export declare const createUseRemoteBundle: () => (conf: InternalConfig, checkBundleCharCount?: boolean) => RemoteBundleState;
 
 export declare interface CreateUserPayload {
     displayName?: string;
@@ -924,7 +927,9 @@ export declare enum CustomerId {
     VIRTUAL_CHANNEL_VIDEOS = "VIRTUAL_CHANNEL_VIDEOS",
     VOJTA_ZIZKA = "VOJTA_ZIZKA",
     LIGA_NARUBY = "LIGA_NARUBY",
-    VIC_NEZ_SI_MYSLITE = "VIC_NEZ_SI_MYSLITE"
+    VIC_NEZ_SI_MYSLITE = "VIC_NEZ_SI_MYSLITE",
+    ZIMAK = "ZIMAK",
+    TYDENIK_HOROSKOPU = "TYDENIK_HOROSKOPU"
 }
 
 export declare interface CustomScript {
@@ -990,6 +995,23 @@ export declare type DeviceInfo = ArrisDeviceInfo | ReactNativeDeviceInfo;
  */
 export declare type DeviceOs = OperatingSystem | 'Tizen' | 'webOS' | 'Arris' | 'Android TV' | 'tvOS';
 
+/**
+ * Window object with Didomi SDK properties.
+ */
+export declare interface DidomiWindow {
+    didomiEventListeners: Array<{
+        event: string;
+        listener: () => void;
+    }>;
+    /**
+     * The window.didomiOnReady callbacks are called after the SDK
+     * is initialized and has loaded its configuration.
+     *
+     * https://developers.didomi.io/cmp/web-sdk/reference/api
+     */
+    didomiOnReady: (() => void)[];
+}
+
 /**
  * @public
  */
@@ -1059,6 +1081,8 @@ export declare interface Duration {
     value: number;
 }
 
+declare type DurationUnit = duration.DurationUnitType & ('day' | 'week' | 'month' | 'year');
+
 /**
  * @public
  */
@@ -1067,6 +1091,14 @@ export declare enum DurationUnits {
     MONTH = "month"
 }
 
+/**
+ * Duration field using dayjs duration
+ */
+export declare interface DurationWithUnit {
+    value: number;
+    unit: DurationUnit;
+}
+
 /**
  * @public
  */
@@ -1209,7 +1241,7 @@ export declare type ExternalTvConfig = {
  * @throws if fetch fails
  * @public
  */
-export declare const fetchBundle: (secret: string, conf: InternalConfig) => Promise<string>;
+export declare const fetchBundle: (secret: string, conf: InternalConfig, checkBundleCharCount?: boolean) => Promise<string>;
 
 /**
  * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
@@ -1664,7 +1696,7 @@ export declare type ItemComponent = RowItemComponent | BannerItemComponent;
 /**
  * @public
  */
-export declare type ItemInRow = Tag | Video | TvChannel | Advertisement | Application | Article;
+export declare type ItemInRow = Tag | Video | TvChannel | Advertisement | Application | Article | Series;
 
 /**
  * @public
@@ -2074,19 +2106,84 @@ export declare type NonAdSourceType = Exclude<SourceType, SourceType.ADVERTISEME
 declare interface Notification_2 {
     id: string;
     name: string;
-    targeting: UserGroup;
+    targeting: NotificationTargeting | null;
     templateId: string;
     thumbnailUrl?: string;
-    triggerType: TriggerType;
+    triggerType: NotificationTriggerType;
+    scheduleTime?: Date;
     status?: NotificationStatus;
+    substitutions: NotificationSubstitution[];
 }
 export { Notification_2 as Notification }
 
+export declare interface NotificationDuration {
+    value: number;
+    unit: dayjs.ManipulateType;
+}
+
+export declare type NotificationFilterType = NotificationFirestoreFilterType | NotificationSurveyFilterType | NotificationLastActivityFilterType;
+
+export declare type NotificationFirestoreFilterType = NotificationSubscriptionFilterType | NotificationMembershipFilterType;
+
+export declare interface NotificationLastActivity {
+    value: number;
+    unit: 'DAY' | 'WEEK' | 'MONTH';
+}
+
+export declare interface NotificationLastActivityFilterType {
+    type: 'lastActivity';
+    value: NotificationLastActivity;
+}
+
+export declare interface NotificationMembershipFilterType {
+    type: 'membership';
+    value: {
+        membershipId: string;
+        isActive: boolean;
+    };
+}
+
 export declare enum NotificationStatus {
+    AUTOMATIC = "automatic",
+    DRAFT = "draft",
     PLANNED = "planned",
-    SENT = "sent"
+    SENT = "sent",
+    WAITING = "waiting",
+    RUNNING = "running"
+}
+
+export declare interface NotificationSubscriptionFilterType {
+    type: 'subscription';
+    value: {
+        subscriptionId: string;
+        isActive: boolean;
+    };
+}
+
+export declare interface NotificationSubstitution {
+    key: string;
+    value: string;
+}
+
+export declare interface NotificationSurveyFilterType {
+    type: 'survey';
+    value: {
+        ageFrom: number;
+        ageTo?: number;
+        gender: 'm' | 'f' | 'all';
+    };
 }
 
+export declare interface NotificationTargeting {
+    monetizationId: string;
+    membershipId: string;
+    isActive: boolean;
+    from?: Date;
+    to?: Date;
+}
+
+export declare type NotificationTriggerType = 'scheduled' | 'manual' | 'purchaseStatusChange' | 'duration' | 'userRegistration';
+
 /**
  * @public
  */
@@ -2139,6 +2236,10 @@ export declare interface Organization {
     profilePhoto: string | null;
 }
 
+export declare interface OrganizationInterface {
+    allowedSignInProviders: SignInProvider[];
+}
+
 /**
  * If Tivio PlayerWrapper is an interception layer, it should allow the pass-through
  * of not just Tivio source types but any other source types that the 3rd party app may be using.
@@ -2545,6 +2646,7 @@ export declare interface PlayerInterface {
      */
     getNativeImaAdUrl?: () => string | null;
     lastQuality?: number | null;
+    getQualities?: () => Track[];
     /**
      * Attribute indicating that the video is to be played "inline"
      * https://developer.mozilla.org/en-US/docs/Web/HTML/Element/video#playsinline
@@ -2709,6 +2811,7 @@ export declare interface PlayerWrapper {
     changeVolumeBy: (volume: number) => void;
     setMuted: (muted: boolean) => void;
     toggleMuted: () => void;
+    getQualities: () => Track[];
 }
 
 /**
@@ -2859,7 +2962,8 @@ export declare enum PurchaseDocumentGateway {
     'comgate' = "comgate",
     'tivio' = "tivio",
     'patreon' = "patreon",
-    'paypal' = "paypal"
+    'paypal' = "paypal",
+    'unknown' = "unknown"
 }
 
 /**
@@ -2873,6 +2977,17 @@ export declare type PurchaseEndpointPayload = {
      * Information about the purchase which changes status to PAID.
      */
     purchase: {
+        /**
+         * See {@link LocationField["city"]["cityName"]} type.
+         */
+        cityName?: string;
+        /**
+         * See {@link LocationField["geoPoint"]} type. Here it is serialized from Firebase.GeoPoint type.
+         */
+        geoPoint?: {
+            latitude: number;
+            longitude: number;
+        };
         /**
          * Two-letter upper-case continent code.
          */
@@ -2887,7 +3002,7 @@ export declare type PurchaseEndpointPayload = {
          */
         expiration?: number;
         /**
-         * If purchase was made outside of standard Tivio payment method (e.g PayPal), this is its ID.
+         * Paypal Id, Qerko Id or Voucher Id based on the gateway.
          */
         externalId?: string;
         /**
@@ -3332,6 +3447,7 @@ export declare interface RouterOverrides {
     goToRecommendedFromOrganizationRow: (screenId: string, rowId: string) => void;
     goToMagentaMomentsPage: (voucher?: string) => void;
     goToVoucherRedeemPage: () => void;
+    updateParams: (params: URLSearchParams) => void;
 }
 
 /**
@@ -3375,7 +3491,8 @@ export declare enum ROW_ITEM_TYPES {
     TAG = "TAG",
     TV_CHANNEL = "TV_CHANNEL",
     ADVERTISEMENT = "ADVERTISEMENT",
-    ARTICLE = "ARTICLE"
+    ARTICLE = "ARTICLE",
+    SERIES = "SERIES"
 }
 
 /**
@@ -3579,6 +3696,10 @@ export declare type ScalableAsset = {
  */
 export declare type Scale = '@1' | '@2' | '@3';
 
+export declare interface ScheduleNotificationRequest {
+    notificationPath: string;
+}
+
 /**
  * @public
  */
@@ -3698,6 +3819,35 @@ export declare interface SendFinalizeRegistrationEmailPayload {
     authUserId: string;
 }
 
+export declare interface SendTivioTemplateEmailRequest {
+    notificationId: string;
+    organizationId: string;
+    testEmailAddress?: string;
+}
+
+/**
+ * @public
+ */
+export declare interface Series extends RowItem, MonetizableItem, ReactableContent {
+    id: string;
+    itemType: ROW_ITEM_TYPES.SERIES;
+    cover: string;
+    organizationId?: string;
+    /**
+     * Only used for non migrated series
+     */
+    originalSeriesTagRef?: any;
+    ref: DocumentReference<any>;
+    availableSeasons: AvailableSeason[];
+    actors?: DocumentReference<any>[];
+}
+
+export declare interface SeriesTileSpecificData {
+    organizationId: string;
+    assets?: AssetsField;
+    availableSeasons: AvailableSeason[];
+}
+
 /**
  * Used for entities, that can be global (e.g. asset presets, tag types).
  * Non-global is stored under organizations (in sub-collection), and shown for organization's users and super-admin.
@@ -3723,6 +3873,11 @@ export declare const setUser: (userId: string | null, payload?: UserPayload) =>
  */
 export declare const showGdprConsentPreferences: () => Promise<void>;
 
+/**
+ * @public
+ */
+export declare type SignInProvider = 'google' | 'patreon' | 'apple';
+
 export declare enum SocialNetworks {
     FACEBOOK = 0,
     INSTAGRAM = 1,
@@ -3844,6 +3999,18 @@ export declare type SubscribeToItemsInRowOptions = Partial<{
  */
 export declare type SubscribeToRowsInScreen = (screenId: string, cb: (error: Error | null, data: PaginationInterface<Row> | null) => void, options?: PaginationOptions) => Disposer_2;
 
+/**
+ * @public
+ */
+export declare type SubscribeToSeriesEpisodes = (seriesRef: any, cb: (error: Error | null, data: PaginationInterface<Video> | null) => void, options?: SubscribeToSeriesEpisodesOptions) => Disposer_2;
+
+/**
+ * @public
+ */
+export declare type SubscribeToSeriesEpisodesOptions = Omit<SubscribeToItemsInRowOptions, 'orderBy'> & {
+    orderBy?: OrderBy<TaggedVideosOrderByField>[];
+};
+
 /**
  * @public
  */
@@ -3890,6 +4057,11 @@ export declare interface Tag extends RowItem {
     removeFromFavorites: () => void;
     cover: string;
     getApplicationName: () => string | undefined;
+    seriesRef?: DocumentReference<any>;
+    fetchData: () => Promise<void>;
+    getSeriesEntity: (path: string) => Promise<Series>;
+    ref: DocumentReference<any>;
+    seriesEntity: Series | null;
 }
 
 export declare interface TagAvailableSeasonsFieldType extends TagMetadataFieldDefinition {
@@ -3962,6 +4134,8 @@ export declare interface TagTranslationFieldType extends TagMetadataFieldDefinit
     value: Translation;
 }
 
+export declare type TemplateSubstitutionType = 'text' | 'html' | 'image' | 'video';
+
 export declare type Tier = {
     attributes: {
         amount_cents: number;
@@ -3987,7 +4161,7 @@ export declare interface TileApplicationData {
     profilePhoto?: string;
 }
 
-export declare interface TileData<ItemSpecificData = VideoTileSpecificData | TvChannelTileSpecificData | TagTileSpecificData | ArticleTileSpecificData> {
+export declare interface TileData<ItemSpecificData = VideoTileSpecificData | TvChannelTileSpecificData | TagTileSpecificData | ArticleTileSpecificData | SeriesTileSpecificData> {
     /**
      * Tile item ID.
      */
@@ -4616,12 +4790,13 @@ export declare interface TopWatchItem {
  * @public
  * Video track
  */
-declare interface Track {
+export declare interface Track {
     id: number;
     /**
      * e.g. 480, 720, 1080
      */
     height: number;
+    width: number;
     active: boolean;
     language: LangCode;
 }
@@ -4642,8 +4817,6 @@ export declare type Translation = {
     [key in LangCode]?: string;
 };
 
-export declare type TriggerType = 'scheduled' | 'manual';
-
 /**
  * @public
  */
@@ -5021,7 +5194,7 @@ export declare type User = {
      * Returns last expired subscription which user can renew or undefined
      */
     extendableSubscription?: Purchase;
-    getPurchasedVideos: () => Video[];
+    getPurchasedVideos: () => unknown[];
     getOneTimePurchases: () => Purchase[];
     isPurchasesInitialized: boolean;
     isSignedIn: boolean;
@@ -5254,6 +5427,9 @@ export declare type VastApiFramework = string | 'VPAID' | null;
  */
 export declare enum VastProvider {
     CNC_PREBID = "cnc-prebid",
+    CNC_STARGAZE_PREROLL_1 = "cnc-stargaze-preroll-1",
+    CNC_STARGAZE_PREROLL_2 = "cnc-stargaze-preroll-2",
+    CNC_STARGAZE_MIDROLL = "cnc-stargaze-midroll",
     ETARGET_PREBID = "etarget-prebid",
     FALLBACK_HLS = "fallback-hls",
     FALLBACK_MP4 = "fallback",
@@ -5366,6 +5542,8 @@ export declare interface Video extends RowItem, MonetizableItem, ReactableConten
     setApplicationData: (applicationData: RowItemApplicationData) => void;
     linkedVideosInNotLoaded: () => boolean | undefined;
     initApplication: () => Promise<void>;
+    init: () => Promise<void>;
+    progress?: number;
 }
 
 /**