@tivio/sdk-react 3.5.2 → 3.6.0

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@tivio/sdk-react",
-    "version": "3.5.2",
+    "version": "3.6.0",
     "main": "dist/index.js",
     "typings": "dist/index.d.ts",
     "source": "src/index.ts",
@@ -9,16 +9,17 @@
         "access": "public"
     },
     "scripts": {
-        "build": "bash ./scripts/build_prod.sh",
-        "build:dev": "bash ./scripts/build_dev.sh",
-        "build:local": "bash ./scripts/build_with_local_bundle.sh",
+        "build": "bash ./scripts/build_prod.sh && yarn typesRollup",
+        "build:dev": "bash ./scripts/build_dev.sh && yarn typesRollup",
+        "build:local": "bash ./scripts/build_with_local_bundle.sh && yarn typesRollup",
         "start": "yarn ts-node ./scripts/start.ts",
         "test": "jest --config=./jest.config.js --coverage",
         "clean": "rm -rf dist",
         "prepublishOnly": "yarn && yarn run build && yarn ts-node ./scripts/prepublish.ts",
         "postpublish": "yarn ts-node ./scripts/postpublish.ts",
         "publish:alpha": "npm publish --tag alpha",
-        "check:cycles": "npx madge --circular src/**/*"
+        "check:cycles": "npx madge --circular src/**/*",
+        "typesRollup": "yarn ts-node ./scripts/typesRollup.ts"
     },
     "peerDependencies": {
         "react": "^17.0.0",
@@ -28,10 +29,10 @@
         "@material-ui/core": "^4.11.2",
         "@material-ui/icons": "^4.11.2",
         "@sentry/browser": "^6.1.0",
-        "@tivio/common": "1.1.89",
+        "@tivio/common": "1.1.90",
         "dayjs": "^1.11.0",
         "es7-object-polyfill": "^1.0.1",
-        "firebase": "^8.2.3",
+        "firebase": "8.10.1",
         "formik": "^2.2.7",
         "i18next": "^19.8.4",
         "mobx": "^6.0.4",
@@ -45,10 +46,12 @@
         "yup": "^0.32.9"
     },
     "devDependencies": {
+        "@microsoft/api-extractor": "^7.23.0",
         "@testing-library/jest-dom": "^5.11.9",
         "@testing-library/react": "^11.2.3",
         "@testing-library/react-hooks": "^5.0.3",
         "@testing-library/user-event": "^12.1.10",
+        "@tivio/types": "*",
         "@types/jest": "^26.0.15",
         "@types/node": "^12.0.0",
         "@types/node-fetch": "^2.5.8",

package/dist/components/ContextProvider.d.ts

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

package/dist/components/PlayerProvider.d.ts

@@ -1,19 +0,0 @@
-/**
- * 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 '../types/customPlayer.types';
-export declare 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>;
-export declare const PlayerProvider: ({ children, playerWrapperId, }: PlayerProviderProps) => FunctionComponentElement<PlayerProviderProps>;
-export declare function withPlayerContext(id: string): <P>(WrappedComponent: React.ComponentType<P>) => (props: P) => JSX.Element;

package/dist/components/TivioProvider.d.ts

@@ -1,16 +0,0 @@
-/**
- * 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 { Config, RemoteBundleState } from '../types/bundle.types';
-export declare type TivioProviderProps = {
-    /**
-     * This prop must be set only once and not change value afterwards
-     */
-    conf: Config | undefined | null;
-    children: React.ReactNode;
-};
-declare const TivioContext: React.Context<RemoteBundleState | null>;
-export declare const TivioProvider: React.FC<TivioProviderProps>;
-export { TivioContext, };

package/dist/components/TivioWidget.d.ts

@@ -1,7 +0,0 @@
-/**
- * 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 '../types/types';
-export declare const TivioWidget: React.ForwardRefExoticComponent<Pick<TivioWidgetProps, "id" | "onEnabled" | "onBlur"> & React.RefAttributes<TivioWidgetRef>>;

package/dist/components/TivioWidgetError.d.ts

@@ -1,10 +0,0 @@
-/**
- * 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';
-declare type TivioWidgetErrorProps = {
-    error: string | null;
-};
-export declare const TivioWidgetError: React.FC<TivioWidgetErrorProps>;
-export {};

package/dist/components/TivioWidgetLoader.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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';
-export declare const TivioWidgetLoader: React.FC;

package/dist/components/TvTivioProvider.d.ts

@@ -1,7 +0,0 @@
-/**
- * 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';
-export declare const TvTivioProvider: React.FC<TivioProviderProps>;

package/dist/components/context/ChannelsContext.d.ts

@@ -1,6 +0,0 @@
-import { Channel } from '@tivio/common';
-import React from 'react';
-import type { DataState } from './types';
-declare const ChannelsContext: React.Context<DataState<Channel>>;
-declare const ChannelsContextProvider: React.FC;
-export { ChannelsContext, ChannelsContextProvider, };

package/dist/components/context/RowItemsContext.d.ts

@@ -1,7 +0,0 @@
-import React from 'react';
-import type { DataState } from './types';
-import type { Tag, Video } from '@tivio/common';
-declare type Item = Video | Tag;
-declare const RowItemsContext: React.Context<DataState<Item> | null>;
-declare const RowItemsContextProvider: React.FC;
-export { RowItemsContext, RowItemsContextProvider, };

package/dist/components/context/ScreensContext.d.ts

@@ -1,6 +0,0 @@
-import React from 'react';
-import type { SingleDataState } from './types';
-import type { Screen } from '@tivio/common';
-declare const ScreensContext: React.Context<SingleDataState<Screen> | null>;
-declare const ScreensContextProvider: React.FC;
-export { ScreensContext, ScreensContextProvider, };

package/dist/components/context/SectionsContext.d.ts

@@ -1,6 +0,0 @@
-import { Section } from '@tivio/common';
-import React from 'react';
-import { DataState } from './types';
-declare const SectionsContext: React.Context<DataState<Section>>;
-declare const SectionsContextProvider: React.FC;
-export { SectionsContext, SectionsContextProvider, };

package/dist/components/context/VideosContext.d.ts

@@ -1,6 +0,0 @@
-import { Video } from '@tivio/common';
-import React from 'react';
-import { DataState } from './types';
-declare const VideosContext: React.Context<DataState<Video>>;
-declare const VideosContextProvider: React.FC;
-export { VideosContext, VideosContextProvider, };

package/dist/components/context/index.d.ts

@@ -1,5 +0,0 @@
-export * from './ChannelsContext';
-export * from './ScreensContext';
-export * from './SectionsContext';
-export * from './VideosContext';
-export * from './RowItemsContext';

package/dist/components/context/types.d.ts

@@ -1,27 +0,0 @@
-export interface SingleHookData<T> {
-    data: T | null;
-    error: Error | null;
-    isLoading: boolean;
-}
-export interface SingleDataState<T> {
-    data: {
-        [key: string]: SingleHookData<T>;
-    };
-    setData: (key: string, data: SingleHookData<T>) => void;
-}
-export declare type PaginationData<T> = {
-    items: T[];
-    hasNextPage: boolean;
-    fetchMore: Function;
-};
-export interface HookData<T> {
-    data: PaginationData<T> | null;
-    error: Error | null;
-    isLoading: boolean;
-}
-export interface DataState<T> {
-    data: {
-        [key: string]: HookData<T>;
-    };
-    setData: (key: string, data: HookData<T>) => void;
-}

package/dist/components/hooks/contentHooks.d.ts

@@ -1,68 +0,0 @@
-import { Channel, Section, Video, Widget } from '../..';
-import { ChannelsContext, SectionsContext, VideosContext } from '../context';
-/**
- * Use widget
- * @param widgetId - widget id
- */
-declare const useWidget: (widgetId: string) => {
-    error: string;
-    widget: Widget | null;
-};
-/**
- * Use channel
- * @param channelId - channel id
- */
-declare const useChannel: (channelId: string) => {
-    error: string | null;
-    data: Channel | null;
-};
-/**
- * Use section
- * @param sectionId - section id
- */
-declare const useSection: (sectionId: string) => {
-    error: string | null;
-    data: Section | null;
-};
-/**
- * Use video
- * @param videoId - video id
- */
-declare const useVideo: (videoId?: string | undefined) => {
-    data: Video | null;
-    error: string | null;
-};
-/**
- * Use videos in section
- * @param sectionId - section id
- * @param [limit] - videos count, defaults to 10
- */
-declare const useVideosInSection: (sectionId?: string | undefined, limit?: number) => {
-    error: Error | null;
-    data: import("../context/types").PaginationData<Video> | null;
-    isLoading: boolean;
-};
-/**
- * Use section in channel
- * @param channelId - channel id
- * @param [limit] - sections count, defaults to 10
- */
-declare const useSectionsInChannel: (channelId: string, limit?: number) => {
-    error: Error | null;
-    data: import("../context/types").PaginationData<import("@tivio/common").Section> | null;
-    isLoading: boolean;
-};
-/**
- * Use channels in widget
- * @param widgetId - widget id
- * @param [limit] - channels count, defaults to 10
- */
-declare const useChannelsInWidget: (widgetId: string, limit?: number) => {
-    error: Error | null;
-    data: import("../context/types").PaginationData<import("@tivio/common").Channel> | null;
-    isLoading: boolean;
-};
-declare const useIsLoaded: () => {
-    isTivioLoaded: boolean;
-};
-export { useWidget, useChannel, useIsLoaded, useSection, useVideo, useVideosInSection, useSectionsInChannel, useChannelsInWidget, VideosContext, SectionsContext, ChannelsContext, };

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

@@ -1,22 +0,0 @@
-export * from './useUser';
-export * from './useTaggedVideos';
-export * from './useScreens';
-export * from './useScreen';
-export * from './useSearch';
-export * from './useItemsInRow';
-export * from './useCancelSubscription';
-export * from './useTransactionPayment';
-export * from './usePurchaseRecovery';
-export * from './usePurchaseSubscription';
-export * from './contentHooks';
-export * from './playerHooks';
-export * from './useOrganizationSubscriptions';
-export * from './useIsMonetizationPurchased';
-export * from './usePurchasesWithVideos';
-export * from './useFreePurchase';
-export * from './useRowsInScreen';
-export * from './useVoucher';
-export * from './useTivio';
-export * from './useLastVideoByWidgetId';
-export * from './useWatchWithoutAdsOffer';
-export * from './useApplyInviteCode';

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

@@ -1,28 +0,0 @@
-/**
- * Copyright (c) 2021, nangu.TV, a.s. All rights reserved.
- * nangu.TV, a.s PROPRIETARY/CONFIDENTIAL. Use is subject to license terms.
- */
-import type { UsePlayerEvent } from '../../types/customPlayer.types';
-import type { BetOffer, Marker } from '../../types/types';
-export declare const usePlayerEvent: UsePlayerEvent;
-export declare const useMarkers: () => Marker[] | null;
-export declare const useBetOffer: () => BetOffer | null;
-interface IntroMarker {
-    marker: Marker;
-    skip: () => void;
-}
-export declare const useIntro: () => IntroMarker | null;
-export declare const useAd: () => import("../../types/customPlayer.types").AdSource | null;
-export declare const useCurrentMarker: () => Marker | null;
-export declare const useSeekState: () => boolean | null;
-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/components/hooks/useApplyInviteCode.d.ts

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

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

@@ -1,2 +0,0 @@
-import { UseCancelSubscription } from '@tivio/common';
-export declare const useCancelSubscription: UseCancelSubscription;

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

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

package/dist/components/hooks/useFreePurchase.d.ts

@@ -1,4 +0,0 @@
-declare const useFreePurchase: () => {
-    purchase: (monetizationId: string) => Promise<void>;
-};
-export { useFreePurchase, };

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

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

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

@@ -1,11 +0,0 @@
-import { ItemsInRow, PaginationInterface, SubscribeToItemsInRowOptions } from '@tivio/common';
-/**
- * Use row items
- * @param rowId - row ID
- * @param options - subscription options
- */
-declare const useItemsInRow: (rowId: string, options?: SubscribeToItemsInRowOptions) => {
-    pagination: PaginationInterface<ItemsInRow> | null;
-    error: Error | null;
-};
-export { useItemsInRow, };

package/dist/components/hooks/useLastVideoByWidgetId.d.ts

@@ -1,5 +0,0 @@
-import { Video } from '@tivio/common';
-/**
- * @deprecated will be removed in v4
- */
-export declare function useLastVideoByWidgetId(widgetId: string): Video | null;

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

@@ -1,3 +0,0 @@
-export declare const useOrganizationSubscriptions: () => {
-    subscriptions: import("@tivio/common").Monetization[];
-};

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

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

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

@@ -1,4 +0,0 @@
-import { QerkoTransaction } from '@tivio/common';
-import { NewVoucher } from '../../types/bundle.types';
-declare const usePurchaseSubscription: (monetizationId: string, voucher?: NewVoucher | undefined) => QerkoTransaction;
-export { usePurchaseSubscription, };

package/dist/components/hooks/usePurchasesWithVideos.d.ts

@@ -1,7 +0,0 @@
-/**
- * Return purchases with initialized video (purchases[i].video not null)
- */
-declare const usePurchasesWithVideos: () => {
-    purchases: import("@tivio/common").Purchase[];
-};
-export { usePurchasesWithVideos, };

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

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

package/dist/components/hooks/useScreen.d.ts

@@ -1,10 +0,0 @@
-import { ScreenOptions } from '@tivio/common';
-/**
- * @deprecated
- *
- * Use app screen
- * @param screenId - screen ID
- * @param options - subscribe to screen options
- */
-declare const useScreen: (screenId: string, options?: ScreenOptions | undefined) => never;
-export { useScreen, };

package/dist/components/hooks/useScreens.d.ts

@@ -1,5 +0,0 @@
-import { Screen } from '@tivio/common';
-declare const useScreens: () => {
-    screens: Screen[];
-};
-export { useScreens, };

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

@@ -1,8 +0,0 @@
-import { ALGOLIA_INDEX_NAME, UseSearch } from '@tivio/common';
-/**
- * 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
- */
-export declare const useSearch: UseSearch;
-export { ALGOLIA_INDEX_NAME };

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

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

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

@@ -1,3 +0,0 @@
-declare const useTivioData: () => import("../../types/bundle.types").RemoteBundleState;
-declare const useTivioReadyData: () => import("../../types/bundle.types").RemoteBundleState | null;
-export { useTivioData, useTivioReadyData, };

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

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

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

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

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

@@ -1,42 +0,0 @@
-export declare type BadRequestError = Error & {
-    details?: {
-        reason?: 'DOES_NOT_EXIST' | 'EXPIRED' | 'ALREADY_USED';
-    };
-};
-/**
- * TODO: Should be in core-js, we can't import types from it, though.
- */
-declare type Voucher = {
-    activate: () => void;
-    isUsed: boolean;
-    isExpired: boolean;
-    status: 'NEW' | 'USED';
-    voucherInfo: SubscriptionInfo | TransactionInfo;
-};
-declare type SubscriptionInfo = {
-    type: 'subscription';
-    name: string;
-    benefits: string[];
-    frequency: string;
-};
-declare type TransactionInfo = {
-    type: 'transaction';
-    name: string;
-    videoId: string;
-    cover: string;
-    description: string;
-};
-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" and "ALREADY_USED").
-     */
-    error: Error | BadRequestError | null;
-    /**
-     * True if voucher has been successfully activated in current session.
-     */
-    activationSuccess: boolean;
-};
-export { useVoucher, };

package/dist/components/hooks/useWatchWithoutAdsOffer.d.ts

@@ -1,4 +0,0 @@
-export declare const useWatchWithoutAdsOffer: () => {
-    canPurchaseWatchWithoutAds: boolean;
-    showPurchaseDialog: () => void;
-};

package/dist/config.d.ts

@@ -1,20 +0,0 @@
-/**
- * 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 type { Config as ExternalConfig, InternalConfig } from './types/bundle.types';
-import type { Currency } from '@tivio/common';
-export declare const defaultConf: {
-    secret: null;
-    resolverUrl: string;
-    currency: Currency;
-    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;