@tivio/sdk-react 9.1.3-alpha2 → 9.1.3-alpha4

package/dist/distTypes/components/ContextProvider.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import type { RemoteBundleState } from '../types/bundle.types';
+interface Props {
+    bundleState: RemoteBundleState;
+    children?: React.ReactNode;
+}
+declare const ContextProvider: React.FC<Props>;
+export { ContextProvider, };

package/dist/distTypes/components/PlayerProvider.d.ts

@@ -0,0 +1,28 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+import React, { FunctionComponentElement } from 'react';
+import type { PlayerWrapper } from '@tivio/types';
+/**
+ * @public
+ */
+export type PlayerProviderProps = {
+    children: React.ReactNode;
+    playerWrapperId?: string;
+};
+/**
+ * value
+ *  - undefined - you are trying to access this context but are not inside <PlayerContext /> that is a bug
+ *  - null - we are waiting for remote code
+ *  - Player - player is ready
+ */
+export declare const PlayerContext: React.Context<PlayerWrapper | null | undefined>;
+/**
+ * @public
+ */
+export declare const PlayerProvider: ({ children, playerWrapperId, }: PlayerProviderProps) => FunctionComponentElement<PlayerProviderProps>;
+/**
+ * @public
+ */
+export declare function withPlayerContext(id: string): <P extends JSX.IntrinsicAttributes>(WrappedComponent: React.ComponentType<P>) => (props: P) => React.JSX.Element;

package/dist/distTypes/components/TivioProvider.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+import React from 'react';
+import type { RemoteBundleState, SdkReactConfig } from '../types/bundle.types';
+/**
+ * @public
+ */
+export type TivioProviderProps = {
+    /**
+     * This prop must be set only once and not change value afterwards
+     */
+    conf: SdkReactConfig | undefined | null;
+    children: React.ReactNode;
+};
+/**
+ * @public
+ */
+export declare const TivioContext: React.Context<RemoteBundleState | null>;
+/**
+ * @public
+ */
+export declare const TivioProvider: React.FC<TivioProviderProps>;

package/dist/distTypes/components/TivioWidget.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+import React from 'react';
+import type { TivioWidgetProps, TivioWidgetRef } from '@tivio/types';
+/**
+ * @public
+ */
+export declare const TivioWidget: React.ForwardRefExoticComponent<Omit<TivioWidgetProps, "ref"> & React.RefAttributes<TivioWidgetRef>>;

package/dist/distTypes/components/TivioWidgetError.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+import React from 'react';
+type TivioWidgetErrorProps = {
+    error: string | null;
+};
+/**
+ * @public
+ */
+export declare const TivioWidgetError: React.FC<TivioWidgetErrorProps>;
+export {};

package/dist/distTypes/components/TivioWidgetLoader.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+import React from 'react';
+/**
+ * @public
+ */
+export declare const TivioWidgetLoader: React.FC;

package/dist/distTypes/components/TvTivioProvider.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+import React from 'react';
+import { TivioProviderProps } from './TivioProvider';
+/**
+ * @public
+ */
+export declare const TvTivioProvider: React.FC<TivioProviderProps>;

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

@@ -0,0 +1,19 @@
+export * from './useUser';
+export * from './useTaggedVideos';
+export * from './useSearch';
+export * from './useItemsInRow';
+export * from './useCancelSubscription';
+export * from './useTransactionPayment';
+export * from './usePurchaseRecovery';
+export * from './usePurchaseSubscription';
+export * from './useVideo';
+export * from './playerHooks';
+export * from './useOrganizationSubscriptions';
+export * from './useIsMonetizationPurchased';
+export * from './useRowsInScreen';
+export * from './useVoucher';
+export * from './useTivio';
+export * from './useApplyInviteCode';
+export * from './useIsLoaded';
+export * from './useChannelSource';
+export * from './useTvChannel';

package/dist/distTypes/components/hooks/playerHooks.d.ts

@@ -0,0 +1,43 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+import type { Marker } from '@tivio/types';
+/**
+ * @public
+ */
+export declare const useMarkers: () => Marker[] | null;
+interface IntroMarker {
+    marker: Marker;
+    skip: () => void;
+}
+/**
+ * @public
+ */
+export declare const useIntro: () => IntroMarker | null;
+/**
+ * @public
+ */
+export declare const useAd: () => import("@tivio/types").AdExternal | null;
+/**
+ * @public
+ */
+export declare const useCurrentMarker: () => Marker | null;
+/**
+ * @public
+ */
+export declare const useSeekState: () => boolean | null;
+/**
+ * @public
+ */
+export declare const useAdSegment: () => {
+    id: string;
+    remainingMs: number;
+    secondsToEnd: number;
+    secondsToSkippable: number | null;
+    canSeek: boolean;
+    canSkip: boolean;
+    isSkippable: boolean;
+    skip: () => any;
+} | null;
+export {};

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

@@ -0,0 +1,18 @@
+/**
+ *  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
+ * @public
+ */
+export declare function useApplyInviteCode(): {
+    applyInviteCodeResult?: boolean | undefined;
+    loading: boolean;
+    error?: import("@tivio/types").GenericOnCallError | undefined;
+    applyInviteCode: (code: string) => void;
+    inviteCodeReset: () => void;
+};

package/dist/distTypes/components/hooks/useCancelSubscription.d.ts

@@ -0,0 +1,5 @@
+import { UseCancelSubscription } from '@tivio/types';
+/**
+ * @public
+ */
+export declare const useCancelSubscription: UseCancelSubscription;

package/dist/distTypes/components/hooks/useChannelSource.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Use channel source
+ * @param tvChannelId
+ * @deprecated No longer used. Pass channel path to 'WebPlayer.source' prop instead. Path can be obtained with useTvChannel hook.
+ * @public
+ */
+export declare const useChannelSource: (tvChannelId: string) => {
+    source: string;
+    error: Error | null;
+} | {
+    error: null;
+    source: null;
+};

package/dist/distTypes/components/hooks/useError.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Hook for displaying errors in UI components
+ * @public
+ */
+declare const useError: () => {
+    error: Error | null;
+    raiseError: (error: Error) => void;
+    resetError: () => void;
+};
+export { useError, };

package/dist/distTypes/components/hooks/useIsLoaded.d.ts

@@ -0,0 +1,6 @@
+/**
+ * @public
+ */
+export declare const useIsLoaded: () => {
+    isTivioLoaded: boolean;
+};

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

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

package/dist/distTypes/components/hooks/useItemsInRow.d.ts

@@ -0,0 +1,11 @@
+import { UseItemsInRow } from '@tivio/types';
+/**
+ * Use row items
+ * @param rowId - row ID
+ * @param options - subscription options
+ * @public
+ */
+export declare const useItemsInRow: ({ rowId, organizationId, options, }: UseItemsInRow) => {
+    pagination: import("@tivio/types").PaginationInterface<import("@tivio/types").ItemInRow> | null;
+    error: Error | null;
+};

package/dist/distTypes/components/hooks/useOrganizationSubscriptions.d.ts

@@ -0,0 +1,11 @@
+/**
+ * @public
+ *
+ * @param onlyPurchasableSubscriptions When it is true, it returns only enabled subscriptions.
+ * @param videoId If it is not defined returns all subscriptions except one time payment.
+ * When it is set, returns only subscriptions which is described in tagIds for video.
+ * @returns Array of subscriptions according to set parameters
+ */
+export declare const useOrganizationSubscriptions: (onlyPurchasableSubscriptions?: boolean, videoId?: string) => {
+    subscriptions: import("@tivio/types").PurchasableMonetization[];
+};

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

@@ -0,0 +1,15 @@
+/**
+ * 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
+ * @public
+ */
+export declare function usePurchaseRecovery(): {
+    purchaseRecoveryResult?: string | undefined;
+    loading: boolean;
+    error?: import("@tivio/types").GenericOnCallError | undefined;
+    purchaseRecovery: (monetizationId: string) => void;
+};

package/dist/distTypes/components/hooks/usePurchaseSubscription.d.ts

@@ -0,0 +1,5 @@
+import { NewVoucher, QerkoTransaction } from '@tivio/types';
+/**
+ * @public
+ */
+export declare const usePurchaseSubscription: (monetizationId: string, voucher?: NewVoucher) => QerkoTransaction;

package/dist/distTypes/components/hooks/useRowsInScreen.d.ts

@@ -0,0 +1,8 @@
+import { PaginationInterface, PaginationOptions, Row } from '@tivio/types';
+/**
+ * @public
+ */
+export declare const useRowsInScreen: (screenId: string, options?: PaginationOptions) => {
+    pagination: PaginationInterface<Row> | null;
+    error: Error | null;
+};

package/dist/distTypes/components/hooks/useSearch.d.ts

@@ -0,0 +1,8 @@
+import { UseSearch } from '@tivio/types';
+/**
+ * Full text search that returns entities based on search query.
+ * @param indexName - index that search would be performed on ('videos', 'tags', etc.)
+ * @param options - pagination options
+ * @public
+ */
+export declare const useSearch: UseSearch;

package/dist/distTypes/components/hooks/useTaggedVideos.d.ts

@@ -0,0 +1,11 @@
+import { PaginationInterface, SubscribeToTaggedVideosOptions, Video } from '@tivio/types';
+/**
+ * Returns videos with given tag ids
+ * @param tagIds - tag ids
+ * @param options - subscription options
+ * @public
+ */
+export declare const useTaggedVideos: (tagIds: string[], options?: SubscribeToTaggedVideosOptions) => {
+    pagination: PaginationInterface<Video> | null;
+    error: Error | null;
+};

package/dist/distTypes/components/hooks/useTivio.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @public
+ */
+export declare const useTivioData: () => import("../..").RemoteBundleState;
+/**
+ * @public
+ */
+export declare const useTivioReadyData: () => import("../..").RemoteBundleState | null;

package/dist/distTypes/components/hooks/useTransactionPayment.d.ts

@@ -0,0 +1,5 @@
+import { NewVoucher, QerkoTransaction } from '@tivio/types';
+/**
+ * @public
+ */
+export declare const useTransactionPayment: (videoId: string, monetizationId: string, voucher?: NewVoucher) => QerkoTransaction;

package/dist/distTypes/components/hooks/useTvChannel.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Use Tv channel
+ * @param tvChannelId
+ * @public
+ */
+export declare const useTvChannel: (tvChannelId: string) => {
+    tvChannel: import("@tivio/types").TvChannel | null;
+    error: Error | null;
+    loading: boolean;
+} | undefined;

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

@@ -0,0 +1,9 @@
+/**
+ * @public
+ */
+export declare const useUser: () => {
+    user: import("@tivio/types").User | null;
+    error: string | null;
+    isInitialized: boolean;
+    isSignedIn: boolean;
+};

package/dist/distTypes/components/hooks/useVideo.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Use video
+ * @param videoIdOrUrlName - video id or video nice url (e.g. some-interesting-video)
+ * @public
+ */
+export declare const useVideo: (videoIdOrUrlName?: string) => {
+    data: import("@tivio/types/dist/types/externalTypes/video").Video | null;
+    error: string | null;
+};

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

@@ -0,0 +1,48 @@
+/**
+ * @public
+ */
+export type BadRequestError = Error & {
+    details?: {
+        reason?: 'DOES_NOT_EXIST' | 'EXPIRED' | 'ALREADY_USED' | 'ALREADY_USED_BY_CURRENT_USER';
+    };
+};
+/**
+ * TODO: Should be in core-js, we can't import types from it, though.
+ */
+type Voucher = {
+    activate: () => void;
+    isUsed: boolean;
+    isExpired: boolean;
+    status: 'NEW' | 'USED';
+    voucherInfo: SubscriptionInfo | TransactionInfo;
+};
+type SubscriptionInfo = {
+    type: 'subscription';
+    name: string;
+    benefits: string[];
+    frequency: string;
+};
+type TransactionInfo = {
+    type: 'transaction';
+    name: string;
+    videoId: string;
+    cover: string;
+    description: 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.
+     */
+    activationSuccess: boolean;
+};
+export {};

package/dist/distTypes/config.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+/// <reference types="react" />
+import { LangCode } from '@tivio/types';
+import type { SdkReactConfig as ExternalConfig, InternalConfig } from './types/bundle.types';
+import type { Currency } from '@tivio/types';
+export declare const defaultConf: {
+    secret: string;
+    resolverUrl: string;
+    currency: Currency;
+    language: LangCode;
+    disableUnmounting: boolean;
+    fetchPackage: import("./services/packageLoader").FetchPackage;
+    pubSub: import("./types/bundle.types").PubSub;
+    LoaderComponent: import("react").FC<{}>;
+    ErrorComponent: import("react").FC<{
+        error: string | null;
+    }>;
+};
+export declare const createInternalConf: (conf: ExternalConfig | undefined | null) => InternalConfig;

package/dist/distTypes/index.d.ts

@@ -0,0 +1,21 @@
+import 'whatwg-fetch';
+import 'es7-object-polyfill';
+export { PlayerProvider, withPlayerContext } from './components/PlayerProvider';
+export type { PlayerProviderProps } from './components/PlayerProvider';
+export { bundlePromise } from './services/bundlePromise';
+export * from './components/hooks';
+export * from './components/TivioProvider';
+export * from './components/TivioWidget';
+export * from './components/TivioWidgetError';
+export * from './components/TvTivioProvider';
+export * from './components/TivioWidgetLoader';
+export * from './services/bundleLoader';
+export * from './services/pubSub';
+export * from './types/types';
+export { Disposer } from './types/common';
+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';
+export * from '@tivio/types';

package/dist/distTypes/info.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @public
+ */
+declare const logInfo: () => void;
+export { logInfo };

package/dist/distTypes/services/bundleLoader.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+import type { InternalConfig, RemoteBundleState, TivioBundle } from '../types/bundle.types';
+/**
+ * @throws if fetch fails
+ * @public
+ */
+export declare const fetchBundle: (secret: string, conf: InternalConfig, checkBundleCharCount?: boolean) => Promise<string>;
+/**
+ * Fetch & load CommonJS remote module.
+ * @public
+ */
+export declare const createRemotePackageLoader: () => (secret: string, conf: InternalConfig, checkBundleCharCount?: boolean) => Promise<TivioBundle>;
+/**
+ * @public
+ */
+export declare const createUseRemoteBundle: () => (conf: InternalConfig, checkBundleCharCount?: boolean) => RemoteBundleState;

package/dist/distTypes/services/bundlePromise.d.ts

@@ -0,0 +1,8 @@
+import { TivioBundle } from '../types/bundle.types';
+import type { RemoteBundleState } from '../types/bundle.types';
+export declare let tivioBundle: TivioBundle | null;
+/**
+ * rejects when bundle is not available
+ * @public
+ */
+export declare const bundlePromise: Promise<RemoteBundleState>;

package/dist/distTypes/services/dependencyResolver.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+import * as materialUiCore from '@material-ui/core';
+import * as materialUiIcons from '@material-ui/icons';
+import * as formik from 'formik';
+import * as mobx from 'mobx';
+import * as mobxReact from 'mobx-react';
+import * as react from 'react';
+import * as reactDom from 'react-dom';
+import * as reactRouterDom from 'react-router-dom';
+import * as reactVirtualized from 'react-virtualized';
+import * as styledComponents from 'styled-components';
+import * as yup from 'yup';
+export type SharedDependency = typeof react | typeof reactDom | typeof mobx | typeof styledComponents | typeof materialUiCore | typeof materialUiIcons | typeof formik | typeof reactRouterDom | typeof reactVirtualized | typeof yup | typeof mobxReact | null;
+export declare const resolveShared: (name: string) => SharedDependency;

package/dist/distTypes/services/gdpr.d.ts

@@ -0,0 +1,4 @@
+/**
+ * @public
+ */
+export declare const showGdprConsentPreferences: () => Promise<void>;

package/dist/distTypes/services/localFetch/coreReactDomDist.d.ts

@@ -0,0 +1 @@
+export declare const loadBundleFromDist: () => import("@tivio/types").TivioReactBundle;

package/dist/distTypes/services/localFetch/none.d.ts

@@ -0,0 +1 @@
+export declare const loadBundleFromDist: () => void;

package/dist/distTypes/services/logger.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+export type LoggerArgs = any[];
+export interface Logger {
+    /** important messages */
+    warn(...data: LoggerArgs): void;
+    /** errors */
+    error(...data: LoggerArgs): void;
+    /** critical errors */
+    exception(...data: LoggerArgs): void;
+    /** metrics */
+    info(...data: LoggerArgs): void;
+    /** non-production messages */
+    debug(...data: LoggerArgs): void;
+}
+export type LoggerConf = {
+    isConsoleEnabled: boolean;
+    isSentryEnabled?: boolean;
+};
+export type Severity = 'warn' | 'error' | 'info' | 'debug';
+/**
+ * Factory
+ **/
+export declare const createLogger: (conf: LoggerConf) => Logger;

package/dist/distTypes/services/login.d.ts

@@ -0,0 +1,9 @@
+import type { UserPayload } from '@tivio/types';
+/**
+ * Set user to sign in/out.
+ *
+ * Sign in - setUser('userID', { token: 'xxx' })
+ * Sign out - setUser(null)
+ * @public
+ */
+export declare const setUser: (userId: string | null, payload?: UserPayload) => Promise<void>;

package/dist/distTypes/services/packageLoader.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+export type FetchPackage = (url: string) => Promise<string>;
+export declare const fetchPackage: FetchPackage;

package/dist/distTypes/services/pubSub.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
+ * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
+ */
+/**
+ * Export Tivio Events API
+ */
+import { PubSub } from '../types/bundle.types';
+/**
+ * @public
+ */
+export declare const createPubSub: () => PubSub;
+/**
+ * Share singleton instance
+ * @public
+ */
+export declare const getPubSub: () => PubSub;

package/dist/distTypes/services/sentry.d.ts

@@ -0,0 +1,4 @@
+import * as _Sentry from '@sentry/browser';
+export declare let Sentry: null | typeof _Sentry;
+export declare const disableSentry: () => void;
+export declare const initSentry: () => void;