@tivio/sdk-react 4.5.0 → 5.0.0

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