@tivio/sdk-react 4.4.1 → 5.0.0

Sign up to get free protection for your applications and to get access to all the features.
package/README.md CHANGED
@@ -4,220 +4,6 @@
4
4
  above Tivio Studio. You can comfortably manage all you videos, settings such as application's screens and rows and also monetization
5
5
  settings in the administration of Tivio Studio while having the freedom to build your own application.
6
6
 
7
- ## Changelog
8
-
9
- * v4.4.1
10
- * patch: added waitForTags param in useSearch hook for videos
11
-
12
- * v4.4.0
13
- * minor: PrimaryButton component props type set to any for now
14
- * patch: isPurchasableAsVoucher added to PurchasableMonetization
15
- * patch: voucherPurchase flag added to purchase overlays
16
- * patch: item added to MonetizationsSelectOverlayData
17
- * minor: added hungarian language to `LangCode` enum
18
-
19
- * v4.3.0:
20
- * minor: add GetPurchaseInfoResponse and PurchaseEndpointPayload to exported types
21
- * minor: support for disabling purchase of specified subscriptions (new param in useOrganizationSubscriptions hook)
22
- * minor: more specific PurchasableMonetization type usage instead of Monetization
23
- * minor: monetization property deleted from Video type
24
- * minor: monetization now has originalPrice and promotion properties available
25
- * patch: remove not used OrganizationSubscriptionsContext, **this change requires bundle 3.20.0 or newer**
26
-
27
- * v4.2.0:
28
- * minor: fix useSearch loading type
29
- * patch: added italian language to `LangCode` enum
30
-
31
- * v4.1.0
32
- * patch: added italian language to `LangCode` enum
33
- * minor: fixed spanish language code in `LangCode` enum (`sp` -> `es`)
34
- * minor: other misc type changes
35
-
36
- * v4.0.1
37
- * patch: added setBundleVersion setter to bundle type
38
- * patch: added setStorageManager setter to bundle type
39
- * patch: `Purchase.isPurchased` is deprecated
40
- * patch: fill `useSearch` field `hasNextPage` with proper value
41
-
42
- * v4.0.0
43
- * minor: Types cleanup
44
- * MAJOR: Remove deprecated and unused stuff
45
- * auth
46
- * changePassword
47
- * changeUserPhoto
48
- * removeUserPhoto
49
- * getPurchasedVodsWithInitializedVideos
50
- * initializeUser
51
- * createFreePurchase
52
- * components
53
- * VideoAdBanner
54
- * getters
55
- * getExportedConfig
56
- * getChannelById
57
- * getSectionById
58
- * getWidgetById
59
- * hooks
60
- * useLastVideoByWidgetId
61
- * useScreen
62
- * useFreePurchase
63
- * useWidget
64
- * useChannel
65
- * useSection
66
- * useVideosInSection
67
- * useSectionsInChannel
68
- * useChannelsInWidget
69
- * subscriptions
70
- * subscribeToWidget
71
- * subscribeToChannel
72
- * subscribeToSection
73
- * subscribeToVideosInSection
74
- * subscribeToSectionsInChannel
75
- * subscribeToChannelsInWidget
76
- * subscribeToScreen
77
- ---
78
- _Versions <= v3.7.0 requires core-react-dom bundle < v3.0.0 (because sdk-react used some sdk API deleted in core-react-dom@4.0.0)_
79
-
80
- * v3.7.0
81
- * minor: purchase contains created and updated
82
-
83
- * v3.6.3
84
- * patch: improve README.md
85
-
86
- * v3.6.2
87
- * patch: Fix types
88
-
89
- * v3.6.1
90
- * patch: Fix README
91
-
92
- * v3.6.0
93
- * minor: Update types
94
-
95
- * v3.5.2
96
- * patch: All types are available again.
97
-
98
- * v3.5.1
99
- * patch: remove incorrect dependency (@tivio/types)
100
-
101
- * v3.5.0
102
- * minor: Types change - Video.price and Video.detailedPrice can be null
103
- * minor: Types change - Video.cover is marked as deprecated
104
-
105
- * v3.4.0
106
- * minor: more precise type for errors in usePurchaseRecovery and usePurchaseRecovery
107
- * patch: jsdocs for usePurchaseRecovery and usePurchaseRecovery
108
- * minor: inviteCodeReset in useApplyInviteCode
109
- * minor: Reset forgotten password
110
- * minor: Consolidating monetization logic
111
- * v3.3.2
112
- * patch: Adding new optional parameters (where, orderBy) to useTaggedVideos hook
113
- * v3.3.1
114
- * patch: Fixed types of `setUser`
115
- * v3.3.0
116
- * minor: Add getPlayerCapabilities to getters.
117
- * patch: Added option to log out via `setUser(null)`, requires @tivio/core-react-dom@2.17.9
118
- * v3.2.5
119
- * patch: added recovery flag to QerkoPaymentInfo type
120
- * patch: bundle.types changes - internal.components.WebVideoScreen
121
- * patch: types changes - add new onBack prop to WebPlayerProps
122
- * patch: Refactor useVideo hook, now uses hook from core-react
123
- * v3.2.4
124
- * minor: added useApplyInviteCode
125
- * minor: better errors from useVoucher
126
- * v3.2.3
127
- * minor: added usePurchaseRecovery hook
128
- * patch: deprecated `useLastVideoByWidgetId`
129
- * v3.2.2
130
- * minor: useRowsInScreen, useItemsInRow, useTaggedVideos - hasNextPage and loading added to pagination
131
- * minor: useRowsInScreen, useItemsInRow, useTaggedVideos - implementation moved to remote bundle
132
- * patch: Fixed Tivio startup on Tizen 6
133
- * minor: Added `forceCloudFnResolver` option
134
- * v3.2.1
135
- * patch: fix of @tivio/common version
136
- * v3.2.0
137
- * minor: Added `capabilitiesOptions` for finer configuration of device capabilities
138
- * minor: tag names are returned in correct language (the one from tivio config); language value should be one from enum "LangCode"
139
- * v3.1.3
140
- * patch: Hotfix made sure disabled Tivio does not break React Native
141
- * v3.1.2
142
- * patch: Allow `conf` prop of `TivioProvider` to be `null` or `undefined` in order to turn off Tivio
143
- * v3.1.1
144
- * patch: fixed `setUser()` crash when bundle fails to load
145
- * v3.1.0
146
- * patch: `useAdSegment()` now returns null if no monetization is configured, ad segments are not managed in that situation
147
- * minor: enriched `AdSegment` type from `useAdSegment()`
148
- * minor: Added `setUser()` function for login and logout
149
- * v3.0.0
150
- * minor: Added hook `useWatchWithoutAdsOffer` to trigger purchase dialog to "watch without ads", if available
151
- * patch: fix peerDependency declaration for react, react-dom
152
- * major: TivioProvider requires deviceCapabilities
153
- * major: TivioProvider requires currency
154
- * minor: add voucher support (see usePurchaseSubscription and useTransactionPayment hooks)
155
- * minor: device limit support
156
- * minor: drm (Widevine, PlayReady) support
157
- * minor: watermarking support
158
- * minor: add useSearch hook
159
- * patch: price on video is 0 when purchased
160
- * v2.4.2
161
- * patch: added back changelog
162
- * v2.4.1
163
- * patch: improved doc about player wrapper
164
- * v2.4.0
165
- * patch: improved Player wrapper types
166
- * minor: added Tivio DOM events `tivio_key_input_handling_change`, `tivio_context_switch` and `tivio_request_goto`
167
- * patch: added support for remote code on browsers that do not implement [indexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)
168
- * patch: added support for browsers that do not implement [indexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)
169
- * v2.3.4
170
- * patch: fix of usePurchaseSubscription not reactive
171
- * v2.3.3
172
- * patch: fix of useUser not updating
173
- * v2.3.2
174
- * patch: next app doesn't fail anymore due to "self is not defined"
175
- * v2.3.1
176
- * patch: fix of @tivio/common dependency
177
- * v2.3.0
178
- * minor: add useTaggedVideos that allows to fetch videos with given tags
179
- * minor: add option to fetch tags (on hook useItemsInRow), useVideo always fetching videos tags
180
- * v2.2.1
181
- * patch: disable Sentry when no config is supplied to `TivioProvider`
182
- * v2.2.0
183
- * patch: reduced bundle size
184
- * minor: disable Sentry when no config is supplied to `TivioProvider` or when Tivio is disabled `{ enable: false }`, or when Sentry is disabled via config `{ enableSentry: false }`
185
- * v2.1.5
186
- * patch fix of `useVideosInSection` hook (fetching video's monetizations)
187
- * v2.1.4
188
- * patch: fix re-rendering of `useAd` during non-skippable ads (requires core-react-dom@2.1.9)
189
- * v2.1.3
190
- * patch: fix changelog
191
- * v2.1.2
192
- * patch: Fixed exported types
193
- * v2.1.1
194
- * patch: TivioWidget now correctly reports `false` via `onEnabled` callback when in invalid internal state
195
- * v2.1.0
196
- * patch: fix of useItemsInRow hook
197
- * patch: fix of useScreen hook
198
- * add: useRowsInScreen hook
199
- * v2.0.3
200
- * patch: fix of useItemsInRow hook
201
- * v2.0.2
202
- * patch: screen and row IDs fixed
203
- * `TivioBundle.subscriptions.subscribeToItemsInRow` now accepts user-defined ID via studio.tiv.io
204
- * `TivioBundle.subscriptions.subscribeToScreen` now accepts user-defined ID via studio.tiv.io
205
- * `Screen` and `Row` types returned by `useScreen()` return their user-defined IDs (`.id`) correctly
206
- * v2.0.1
207
- * no changes
208
- * v2.0.0
209
- * major: video.channelId can now be `string | null` used to be `string`
210
- * minor: added data API and hooks for screens (screens, rows of screen and row items)
211
- * hooks: `useScreen()`, `useItemsInRow()`
212
- * api: `TivioBundle.subscriptions.subscribeToScreen`, `TivioBundle.subscriptions.subscribeToItemsInRow`
213
- * v1.3.6
214
- * ?
215
- * v1.3.5
216
- * minor: added WebPlayer props (canReplay, showMarkers, customShortcuts, enableKeyboardShortcuts, source.poster)
217
- * v1.3.4
218
- * ...
219
-
220
-
221
7
  ## Installation
222
8
 
223
9
  Install @tivio/sdk-react along with its peer dependencies
package/changelog.md ADDED
@@ -0,0 +1,224 @@
1
+ # Changelog @tivio/sdk-react
2
+
3
+ * 5.0.0
4
+ * major: upgrade to React 18, change react and react-dom peer dependencies to 17.x || 18.x
5
+ * major: fix typing for useReferralInfo, now correctly showing that `null` can be returned
6
+ * major: fix typing for `WebRowProps.onTileClick`, now correctly showing that `null` can be accepted
7
+ * minor: add analytics
8
+ * minor: add getSourceUrl function to video and tv channel types
9
+ * minor: add uri property to tv channel type
10
+ * minor: add useChannelSource to hooks
11
+
12
+ * v4.5.0
13
+ * minor: extend PurchaseEndpointPayload type with purchase previousStatus and newStatus fields
14
+
15
+ * v4.4.1
16
+ * patch: added waitForTags param in useSearch hook for videos
17
+
18
+ * v4.4.0
19
+ * minor: PrimaryButton component props type set to any for now
20
+ * patch: isPurchasableAsVoucher added to PurchasableMonetization
21
+ * patch: voucherPurchase flag added to purchase overlays
22
+ * patch: item added to MonetizationsSelectOverlayData
23
+ * minor: added hungarian language to `LangCode` enum
24
+
25
+ * v4.3.0:
26
+ * minor: add GetPurchaseInfoResponse and PurchaseEndpointPayload to exported types
27
+ * minor: support for disabling purchase of specified subscriptions (new param in useOrganizationSubscriptions hook)
28
+ * minor: more specific PurchasableMonetization type usage instead of Monetization
29
+ * minor: monetization property deleted from Video type
30
+ * minor: monetization now has originalPrice and promotion properties available
31
+ * patch: remove not used OrganizationSubscriptionsContext, **this change requires bundle 3.20.0 or newer**
32
+
33
+ * v4.2.0:
34
+ * minor: fix useSearch loading type
35
+ * patch: added italian language to `LangCode` enum
36
+
37
+ * v4.1.0
38
+ * patch: added italian language to `LangCode` enum
39
+ * minor: fixed spanish language code in `LangCode` enum (`sp` -> `es`)
40
+ * minor: other misc type changes
41
+
42
+ * v4.0.1
43
+ * patch: added setBundleVersion setter to bundle type
44
+ * patch: added setStorageManager setter to bundle type
45
+ * patch: `Purchase.isPurchased` is deprecated
46
+ * patch: fill `useSearch` field `hasNextPage` with proper value
47
+
48
+ * v4.0.0
49
+ * minor: Types cleanup
50
+ * MAJOR: Remove deprecated and unused stuff
51
+ * auth
52
+ * changePassword
53
+ * changeUserPhoto
54
+ * removeUserPhoto
55
+ * getPurchasedVodsWithInitializedVideos
56
+ * initializeUser
57
+ * createFreePurchase
58
+ * components
59
+ * VideoAdBanner
60
+ * getters
61
+ * getExportedConfig
62
+ * getChannelById
63
+ * getSectionById
64
+ * getWidgetById
65
+ * hooks
66
+ * useLastVideoByWidgetId
67
+ * useScreen
68
+ * useFreePurchase
69
+ * useWidget
70
+ * useChannel
71
+ * useSection
72
+ * useVideosInSection
73
+ * useSectionsInChannel
74
+ * useChannelsInWidget
75
+ * subscriptions
76
+ * subscribeToWidget
77
+ * subscribeToChannel
78
+ * subscribeToSection
79
+ * subscribeToVideosInSection
80
+ * subscribeToSectionsInChannel
81
+ * subscribeToChannelsInWidget
82
+ * subscribeToScreen
83
+ ---
84
+ _Versions <= v3.7.0 requires core-react-dom bundle < v3.0.0 (because sdk-react used some sdk API deleted in core-react-dom@4.0.0)_
85
+
86
+ * v3.7.0
87
+ * minor: purchase contains created and updated
88
+
89
+ * v3.6.3
90
+ * patch: improve README.md
91
+
92
+ * v3.6.2
93
+ * patch: Fix types
94
+
95
+ * v3.6.1
96
+ * patch: Fix README
97
+
98
+ * v3.6.0
99
+ * minor: Update types
100
+
101
+ * v3.5.2
102
+ * patch: All types are available again.
103
+
104
+ * v3.5.1
105
+ * patch: remove incorrect dependency (@tivio/types)
106
+
107
+ * v3.5.0
108
+ * minor: Types change - Video.price and Video.detailedPrice can be null
109
+ * minor: Types change - Video.cover is marked as deprecated
110
+
111
+ * v3.4.0
112
+ * minor: more precise type for errors in usePurchaseRecovery and usePurchaseRecovery
113
+ * patch: jsdocs for usePurchaseRecovery and usePurchaseRecovery
114
+ * minor: inviteCodeReset in useApplyInviteCode
115
+ * minor: Reset forgotten password
116
+ * minor: Consolidating monetization logic
117
+ * v3.3.2
118
+ * patch: Adding new optional parameters (where, orderBy) to useTaggedVideos hook
119
+ * v3.3.1
120
+ * patch: Fixed types of `setUser`
121
+ * v3.3.0
122
+ * minor: Add getPlayerCapabilities to getters.
123
+ * patch: Added option to log out via `setUser(null)`, requires @tivio/core-react-dom@2.17.9
124
+ * v3.2.5
125
+ * patch: added recovery flag to QerkoPaymentInfo type
126
+ * patch: bundle.types changes - internal.components.WebVideoScreen
127
+ * patch: types changes - add new onBack prop to WebPlayerProps
128
+ * patch: Refactor useVideo hook, now uses hook from core-react
129
+ * v3.2.4
130
+ * minor: added useApplyInviteCode
131
+ * minor: better errors from useVoucher
132
+ * v3.2.3
133
+ * minor: added usePurchaseRecovery hook
134
+ * patch: deprecated `useLastVideoByWidgetId`
135
+ * v3.2.2
136
+ * minor: useRowsInScreen, useItemsInRow, useTaggedVideos - hasNextPage and loading added to pagination
137
+ * minor: useRowsInScreen, useItemsInRow, useTaggedVideos - implementation moved to remote bundle
138
+ * patch: Fixed Tivio startup on Tizen 6
139
+ * minor: Added `forceCloudFnResolver` option
140
+ * v3.2.1
141
+ * patch: fix of @tivio/common version
142
+ * v3.2.0
143
+ * minor: Added `capabilitiesOptions` for finer configuration of device capabilities
144
+ * minor: tag names are returned in correct language (the one from tivio config); language value should be one from enum "LangCode"
145
+ * v3.1.3
146
+ * patch: Hotfix made sure disabled Tivio does not break React Native
147
+ * v3.1.2
148
+ * patch: Allow `conf` prop of `TivioProvider` to be `null` or `undefined` in order to turn off Tivio
149
+ * v3.1.1
150
+ * patch: fixed `setUser()` crash when bundle fails to load
151
+ * v3.1.0
152
+ * patch: `useAdSegment()` now returns null if no monetization is configured, ad segments are not managed in that situation
153
+ * minor: enriched `AdSegment` type from `useAdSegment()`
154
+ * minor: Added `setUser()` function for login and logout
155
+ * v3.0.0
156
+ * minor: Added hook `useWatchWithoutAdsOffer` to trigger purchase dialog to "watch without ads", if available
157
+ * patch: fix peerDependency declaration for react, react-dom
158
+ * major: TivioProvider requires deviceCapabilities
159
+ * major: TivioProvider requires currency
160
+ * minor: add voucher support (see usePurchaseSubscription and useTransactionPayment hooks)
161
+ * minor: device limit support
162
+ * minor: drm (Widevine, PlayReady) support
163
+ * minor: watermarking support
164
+ * minor: add useSearch hook
165
+ * patch: price on video is 0 when purchased
166
+ * v2.4.2
167
+ * patch: added back changelog
168
+ * v2.4.1
169
+ * patch: improved doc about player wrapper
170
+ * v2.4.0
171
+ * patch: improved Player wrapper types
172
+ * minor: added Tivio DOM events `tivio_key_input_handling_change`, `tivio_context_switch` and `tivio_request_goto`
173
+ * patch: added support for remote code on browsers that do not implement [indexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)
174
+ * patch: added support for browsers that do not implement [indexedDB API](https://developer.mozilla.org/en-US/docs/Web/API/IndexedDB_API)
175
+ * v2.3.4
176
+ * patch: fix of usePurchaseSubscription not reactive
177
+ * v2.3.3
178
+ * patch: fix of useUser not updating
179
+ * v2.3.2
180
+ * patch: next app doesn't fail anymore due to "self is not defined"
181
+ * v2.3.1
182
+ * patch: fix of @tivio/common dependency
183
+ * v2.3.0
184
+ * minor: add useTaggedVideos that allows to fetch videos with given tags
185
+ * minor: add option to fetch tags (on hook useItemsInRow), useVideo always fetching videos tags
186
+ * v2.2.1
187
+ * patch: disable Sentry when no config is supplied to `TivioProvider`
188
+ * v2.2.0
189
+ * patch: reduced bundle size
190
+ * minor: disable Sentry when no config is supplied to `TivioProvider` or when Tivio is disabled `{ enable: false }`, or when Sentry is disabled via config `{ enableSentry: false }`
191
+ * v2.1.5
192
+ * patch fix of `useVideosInSection` hook (fetching video's monetizations)
193
+ * v2.1.4
194
+ * patch: fix re-rendering of `useAd` during non-skippable ads (requires core-react-dom@2.1.9)
195
+ * v2.1.3
196
+ * patch: fix changelog
197
+ * v2.1.2
198
+ * patch: Fixed exported types
199
+ * v2.1.1
200
+ * patch: TivioWidget now correctly reports `false` via `onEnabled` callback when in invalid internal state
201
+ * v2.1.0
202
+ * patch: fix of useItemsInRow hook
203
+ * patch: fix of useScreen hook
204
+ * add: useRowsInScreen hook
205
+ * v2.0.3
206
+ * patch: fix of useItemsInRow hook
207
+ * v2.0.2
208
+ * patch: screen and row IDs fixed
209
+ * `TivioBundle.subscriptions.subscribeToItemsInRow` now accepts user-defined ID via studio.tiv.io
210
+ * `TivioBundle.subscriptions.subscribeToScreen` now accepts user-defined ID via studio.tiv.io
211
+ * `Screen` and `Row` types returned by `useScreen()` return their user-defined IDs (`.id`) correctly
212
+ * v2.0.1
213
+ * no changes
214
+ * v2.0.0
215
+ * major: video.channelId can now be `string | null` used to be `string`
216
+ * minor: added data API and hooks for screens (screens, rows of screen and row items)
217
+ * hooks: `useScreen()`, `useItemsInRow()`
218
+ * api: `TivioBundle.subscriptions.subscribeToScreen`, `TivioBundle.subscriptions.subscribeToItemsInRow`
219
+ * v1.3.6
220
+ * ?
221
+ * v1.3.5
222
+ * minor: added WebPlayer props (canReplay, showMarkers, customShortcuts, enableKeyboardShortcuts, source.poster)
223
+ * v1.3.4
224
+ * ...