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