@tivio/sdk-react 2.0.1 → 2.1.1-alpha1

package/README.md

@@ -2,17 +2,33 @@
 
 ## Changelog
 
-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
-  - ...
+* Unreleased
+* 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
+  * ...
 
 ## Installation
 
@@ -289,7 +305,7 @@ Gets array of Video or Tag objects for a specified row. It is possible to use
 ```ts
 /**
  * Hook to fetch row items for rows received from `useScreen()`
- * @param id - row ID
+ * @param id - row ID configured via studio.tiv.io
  * @param [limit] - row items count, defaults to 10
  */
 useItemsInRow: (id: string, limit?: number) => {

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

@@ -1,6 +1,6 @@
+import type { Tag, Video } from '@tivio/common';
 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;

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

@@ -62,26 +62,7 @@ declare const useChannelsInWidget: (widgetId: string, limit?: number) => {
     data: import("../context/types").PaginationData<Channel> | null;
     isLoading: boolean;
 };
-/**
- * Use app screen
- * @param id - screen ID
- */
-declare const useScreen: (id: string) => {
-    error: Error | null;
-    data: import("@tivio/common/dist/types").Screen | null;
-    isLoading: boolean;
-};
-/**
- * Use row items
- * @param id - row ID
- * @param [limit] - row items count, defaults to 10
- */
-declare const useItemsInRow: (id: string, limit?: number | undefined) => {
-    error: Error | null;
-    data: import("../context/types").PaginationData<Video | import("@tivio/common/dist/types").Tag> | null;
-    isLoading: boolean;
-};
 declare const useIsLoaded: () => {
     isTivioLoaded: boolean;
 };
-export { useWidget, useChannel, useIsLoaded, useItemsInRow, useScreen, useSection, useVideo, useVideosInSection, useSectionsInChannel, useChannelsInWidget, VideosContext, SectionsContext, ChannelsContext, };
+export { useWidget, useChannel, useIsLoaded, useSection, useVideo, useVideosInSection, useSectionsInChannel, useChannelsInWidget, VideosContext, SectionsContext, ChannelsContext, };

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

@@ -1,4 +1,7 @@
 export * from './useUser';
+export * from './useScreens';
+export * from './useScreen';
+export * from './useItemsInRow';
 export * from './useTransactionPayment';
 export * from './usePurchaseSubscription';
 export * from './contentHooks';
@@ -6,3 +9,4 @@ export * from './playerHooks';
 export * from './useOrganizationSubscriptions';
 export * from './usePurchasesWithVideos';
 export * from './useFreePurchase';
+export * from './useRowsInScreen';

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

@@ -0,0 +1,9 @@
+/**
+ * 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/useItemsInRow.d.ts

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

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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,12 @@
+import { ScreenOptions } from '@tivio/common';
+/**
+ * Use app screen
+ * @param screenId - screen ID
+ * @param options - subscribe to screen options
+ */
+declare const useScreen: (screenId: string, options?: ScreenOptions | undefined) => {
+    error: Error | null;
+    data: import("@tivio/common").Screen | null;
+    isLoading: boolean;
+};
+export { useScreen, };

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

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