@staffbase/widget-sdk 3.4.0-beta.1 → 3.4.0-beta.5
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/CHANGELOG.md +93 -56
- package/lib/base-block.ts +2 -9
- package/lib/widget-api-types.ts +25 -0
- package/lib/widget-api.ts +12 -5
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,58 +1,41 @@
|
|
|
1
|
-
# [3.4.0-beta.
|
|
1
|
+
# [3.4.0-beta.5](https://github.com/Staffbase/widget-sdk/compare/3.4.0-beta.4...3.4.0-beta.5) (2022-01-21)
|
|
2
2
|
|
|
3
3
|
|
|
4
|
-
###
|
|
4
|
+
### Code Refactoring
|
|
5
5
|
|
|
6
|
-
*
|
|
6
|
+
* remove unused import ([5887ace](https://github.com/Staffbase/widget-sdk/commit/5887ace86935f8078b97f33a976ae11a1e26ef58))
|
|
7
7
|
|
|
8
8
|
|
|
9
|
-
###
|
|
9
|
+
### Documentation
|
|
10
10
|
|
|
11
|
-
*
|
|
12
|
-
* **deps:** npm audit fix ([330760c](https://github.com/Staffbase/widget-sdk/commit/330760cb4971042d132a93700fedecff16cde89b))
|
|
13
|
-
* **deps:** npm audit fix ([856ca6b](https://github.com/Staffbase/widget-sdk/commit/856ca6b503229bae8ebf841b0637868515f3367e))
|
|
11
|
+
* fix documentation ([2844477](https://github.com/Staffbase/widget-sdk/commit/2844477028de22386759e13a8c154480a3096aeb))
|
|
14
12
|
|
|
15
13
|
|
|
16
|
-
###
|
|
14
|
+
### Features
|
|
17
15
|
|
|
18
|
-
* add
|
|
19
|
-
*
|
|
20
|
-
*
|
|
21
|
-
*
|
|
22
|
-
*
|
|
23
|
-
* remove yarn ([5fb934f](https://github.com/Staffbase/widget-sdk/commit/5fb934f3aadc7eef2aea60a31b6b812335483b8f))
|
|
24
|
-
* removed unneeded env var ([52960df](https://github.com/Staffbase/widget-sdk/commit/52960dfef49d00432ebc00a3f84a3a902aaefc6f))
|
|
25
|
-
* **deps:** bump semver-regex from 3.1.2 to 3.1.3 ([#28](https://github.com/Staffbase/widget-sdk/issues/28)) ([05dc6db](https://github.com/Staffbase/widget-sdk/commit/05dc6dbdbd3c4743768fc612f994522c42459264))
|
|
16
|
+
* add integration state enum ([5c3f4cd](https://github.com/Staffbase/widget-sdk/commit/5c3f4cd836bd96eb2a5615aba0d0d295ff0bf16d))
|
|
17
|
+
* change type signature ([fff78ca](https://github.com/Staffbase/widget-sdk/commit/fff78ca2be153bc06f4d14c5c913650e7ed85f76))
|
|
18
|
+
* extend integration api ([ab53de9](https://github.com/Staffbase/widget-sdk/commit/ab53de9e78f92a09b54cc712fd83bcc948e7e62c))
|
|
19
|
+
* extend integration api ([be172b6](https://github.com/Staffbase/widget-sdk/commit/be172b6809bbe4dfba40e4d24fb5f7b9b420308a))
|
|
20
|
+
* harden return type, add refresh argument ([42719ac](https://github.com/Staffbase/widget-sdk/commit/42719ac56aff63016498b9e3f8d862f07bd5ad52))
|
|
26
21
|
|
|
27
22
|
|
|
28
|
-
###
|
|
23
|
+
### Miscellaneous
|
|
29
24
|
|
|
30
|
-
* add
|
|
25
|
+
* Merge branch 'NFS-1519-add-integrations' into beta ([f13d1f4](https://github.com/Staffbase/widget-sdk/commit/f13d1f494b5402a1c37e5aa35fb7fce1e0043499))
|
|
31
26
|
|
|
27
|
+
# [3.4.0-beta.4](https://github.com/Staffbase/widget-sdk/compare/3.4.0-beta.3...3.4.0-beta.4) (2021-11-23)
|
|
32
28
|
|
|
33
|
-
### Features
|
|
34
29
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
*
|
|
38
|
-
*
|
|
39
|
-
* changed type to date ([9aa8cc2](https://github.com/Staffbase/widget-sdk/commit/9aa8cc223b78b0d8e9046cc2a8ebbcdcc068ac84))
|
|
30
|
+
### Documentation
|
|
31
|
+
|
|
32
|
+
* change description ([a11bc08](https://github.com/Staffbase/widget-sdk/commit/a11bc085308f903501a4f97e8e7f755b0d3c8a32))
|
|
33
|
+
* fix typo ([5bca2d1](https://github.com/Staffbase/widget-sdk/commit/5bca2d1b092cb0f86e8413904ff767042e529aed))
|
|
40
34
|
|
|
41
35
|
|
|
42
36
|
### Miscellaneous
|
|
43
37
|
|
|
44
|
-
* Merge branch 'NFS-1519-add-integrations' into beta ([
|
|
45
|
-
* Merge branch 'NFS-1519-add-integrations' into beta ([3499518](https://github.com/Staffbase/widget-sdk/commit/3499518ee1bbad67fce3bc8e6ed473378d7f7a38))
|
|
46
|
-
* Merge branch 'master' into beta ([27dff30](https://github.com/Staffbase/widget-sdk/commit/27dff30a4d0da7f0fe65c39d4da0f362f8dc88a5))
|
|
47
|
-
* ([ed1232c](https://github.com/Staffbase/widget-sdk/commit/ed1232c889fb7294283312b3a8461ca969842d14))
|
|
48
|
-
* Set env variable ([9da7ec4](https://github.com/Staffbase/widget-sdk/commit/9da7ec4f026efb52beb920f0c5791ab7e201ab9c))
|
|
49
|
-
* Add env variable ([f0e5b1f](https://github.com/Staffbase/widget-sdk/commit/f0e5b1fdd07fd2f04ce3008c8b82260c27acd967))
|
|
50
|
-
* ([1622de1](https://github.com/Staffbase/widget-sdk/commit/1622de1c0741fe438e7efa7d706cb1c9c94d12ee))
|
|
51
|
-
* **version:** Release 3.3.0-beta.1 [skip ci] ([bfff946](https://github.com/Staffbase/widget-sdk/commit/bfff946703a6a438c7f5bbc19ff973c5bf102f11)), closes [#NFS-872](https://github.com/Staffbase/widget-sdk/issues/NFS-872)
|
|
52
|
-
* **version:** Release 3.3.1-beta.1 [skip ci] ([e0b175a](https://github.com/Staffbase/widget-sdk/commit/e0b175a69aabd0d08e16f3453bf6793e89eb389b)), closes [#NFS-872](https://github.com/Staffbase/widget-sdk/issues/NFS-872)
|
|
53
|
-
* **version:** Release 3.3.1-beta.2 [skip ci] ([4fa6ece](https://github.com/Staffbase/widget-sdk/commit/4fa6ece0161fa5a83e916ec8dcb85bbf2ab932d8))
|
|
54
|
-
* Merge branch 'nfs-1164-documentation' into beta ([e7cbe2c](https://github.com/Staffbase/widget-sdk/commit/e7cbe2c134682220a6b64232f287dd2d032ee43d))
|
|
55
|
-
* Merge branch 'beta' of github.com:Staffbase/widget-sdk into beta ([27c2943](https://github.com/Staffbase/widget-sdk/commit/27c2943b15d2ec462fd171dec304e0c99a66c223))
|
|
38
|
+
* Merge branch 'NFS-1519-add-integrations' into beta ([2b582e6](https://github.com/Staffbase/widget-sdk/commit/2b582e6e865be38d3a248cd1311f6783a101f870))
|
|
56
39
|
|
|
57
40
|
## [3.3.3](https://github.com/Staffbase/widget-sdk/compare/3.3.2...3.3.3) (2021-09-01)
|
|
58
41
|
|
|
@@ -132,38 +115,84 @@
|
|
|
132
115
|
|
|
133
116
|
### Bug Fixes
|
|
134
117
|
|
|
135
|
-
*
|
|
136
|
-
|
|
137
|
-
|
|
118
|
+
* changed package version ([3641fdd](https://github.com/Staffbase/widget-sdk/commit/3641fdd980ba84370f8736c7ec49b3a0c93a273d))
|
|
119
|
+
* changed props to contentLanguage #NFS-872 ([f8f0107](https://github.com/Staffbase/widget-sdk/commit/f8f01078f5798239e63f34921c43cfb1fb6e4e21)), closes [#NFS-872](https://github.com/Staffbase/widget-sdk/issues/NFS-872)
|
|
120
|
+
* update package-lock.json ([67163cf](https://github.com/Staffbase/widget-sdk/commit/67163cf3445d3f6dc4ae6862461b28409ea22328))
|
|
121
|
+
* update package-lock.json ([6480488](https://github.com/Staffbase/widget-sdk/commit/648048892f7804913747c24320c4f71dc7597cf7))
|
|
138
122
|
|
|
139
123
|
|
|
140
124
|
### Chores
|
|
141
125
|
|
|
142
|
-
* add
|
|
143
|
-
*
|
|
144
|
-
*
|
|
126
|
+
* add deleted block attributes file ([8c639df](https://github.com/Staffbase/widget-sdk/commit/8c639dfbe70197be614af7a4a57041d391caf372))
|
|
127
|
+
* add deleted block attributes file ([629d0c5](https://github.com/Staffbase/widget-sdk/commit/629d0c5276cb065979e0c66b3d849e083d73a032))
|
|
128
|
+
* add semantic release ([0dc3400](https://github.com/Staffbase/widget-sdk/commit/0dc340015f62702608b107199b977a13bcebdaa3))
|
|
129
|
+
* add semantic release ([63e0344](https://github.com/Staffbase/widget-sdk/commit/63e0344939cb24444afab2d1ab0c3553730a5cea))
|
|
130
|
+
* change release rules ([32f0520](https://github.com/Staffbase/widget-sdk/commit/32f05208e33801eb925c09d67dcd9ec6ae993b57))
|
|
131
|
+
* disabled dryrun ([f390c78](https://github.com/Staffbase/widget-sdk/commit/f390c78d85446decc62b0eb9efa1a346bedb32bd))
|
|
132
|
+
* fix blocked release ([9283e21](https://github.com/Staffbase/widget-sdk/commit/9283e210a788bee4c72856ecde5125a8daf45298))
|
|
133
|
+
* fix blocked release ([857dcac](https://github.com/Staffbase/widget-sdk/commit/857dcac7093892a3035297bc70b693c5c9a3d501))
|
|
134
|
+
* raise min node version ([c41863d](https://github.com/Staffbase/widget-sdk/commit/c41863d877c210b3ee46d5c7a7db77623b3c93ad))
|
|
135
|
+
* remove publish config ([c7b6198](https://github.com/Staffbase/widget-sdk/commit/c7b61980ff4c44f8aa58f78e28486fffa5975f4e))
|
|
136
|
+
* switched the release plugin ([5c907a6](https://github.com/Staffbase/widget-sdk/commit/5c907a6d46ee77a87b6d71c92dd9e13a3190ab1a))
|
|
137
|
+
* use default release rules ([5932645](https://github.com/Staffbase/widget-sdk/commit/59326457e0c73ff68762bf130c80c1b5e0b8725e))
|
|
145
138
|
|
|
146
139
|
|
|
147
|
-
###
|
|
140
|
+
### Code Refactoring
|
|
148
141
|
|
|
149
|
-
*
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
142
|
+
* make uischema optional ([0a0bc56](https://github.com/Staffbase/widget-sdk/commit/0a0bc5672d7964008f3440164752560ae86c8036))
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
### Features
|
|
146
|
+
|
|
147
|
+
* add ui schema support ([ea16238](https://github.com/Staffbase/widget-sdk/commit/ea16238f0f25da1461a0c3176a872948580bb8dc))
|
|
148
|
+
* add ui schema support ([3fe7510](https://github.com/Staffbase/widget-sdk/commit/3fe751072066f3b103c42f653a5f1e5927ee292a))
|
|
149
|
+
* set package name ([214990b](https://github.com/Staffbase/widget-sdk/commit/214990b8f0c1ab79c5492d6e88661b6577fce80b))
|
|
157
150
|
|
|
158
151
|
|
|
159
152
|
### Miscellaneous
|
|
160
153
|
|
|
161
|
-
*
|
|
162
|
-
*
|
|
163
|
-
* Merge branch '
|
|
164
|
-
*
|
|
154
|
+
* **version:** Release 3.3.0 [skip ci] ([215fe19](https://github.com/Staffbase/widget-sdk/commit/215fe190644cf2edbf34e7c20f3290d9712b080d)), closes [#NFS-872](https://github.com/Staffbase/widget-sdk/issues/NFS-872)
|
|
155
|
+
* NFS-1002: adds definitions for the parsing of attributes ([8d5e897](https://github.com/Staffbase/widget-sdk/commit/8d5e897f956f97f03b1b7ebd5190b343db9672e9))
|
|
156
|
+
* Merge branch 'next' into NFS-1002-parse-methods ([a4fc6e3](https://github.com/Staffbase/widget-sdk/commit/a4fc6e3b26e2fb89787c4f924235e0fdbb0b4a43))
|
|
157
|
+
* Make ui schema optional ([3c6e1b1](https://github.com/Staffbase/widget-sdk/commit/3c6e1b104ec99acd97c5febc8ee7544ee5a856fb))
|
|
158
|
+
* 3.3.0-beta-2 ([5ee39df](https://github.com/Staffbase/widget-sdk/commit/5ee39dff788cdd90054f097f13d8ca27844d53a0))
|
|
159
|
+
* NFS-989: Add colors to the sdk ([eb59ed1](https://github.com/Staffbase/widget-sdk/commit/eb59ed1c7670f91e8974e1648e354d925c4feae5))
|
|
160
|
+
* Merge branch 'Add_colors_to_the_SDK' of github.com:Staffbase/widget-sdk into Add_colors_to_the_SDK ([e576c4f](https://github.com/Staffbase/widget-sdk/commit/e576c4f8636ca8938d737bfd449d695171b42eb2))
|
|
161
|
+
* Merge branch 'master' into Add_colors_to_the_SDK ([be07592](https://github.com/Staffbase/widget-sdk/commit/be07592ab9f8682d466b78d127bdf0a4cac6cde0))
|
|
162
|
+
* NFS-1289: Widget SDK: As a widget developer I want to have user information provided ([7716a6f](https://github.com/Staffbase/widget-sdk/commit/7716a6f590eb3dff8b7d9ee14c84bda1a5d3a7eb))
|
|
163
|
+
* NFS-1289: Changes from review ([ccad4b1](https://github.com/Staffbase/widget-sdk/commit/ccad4b1605129db09e840619cf26a76c99d694b4))
|
|
164
|
+
* NFS-1289: Changes from review ([18fd04d](https://github.com/Staffbase/widget-sdk/commit/18fd04d635eedbba3f89f60cecdc6412e1a21dc1))
|
|
165
|
+
* NFS-1289: Changes from review ([766801f](https://github.com/Staffbase/widget-sdk/commit/766801faefd489163f2191d7f2fa329e68a7fa4d))
|
|
166
|
+
* NFS-1289: Comment adjustments from review ([6a5757b](https://github.com/Staffbase/widget-sdk/commit/6a5757b6e7f70648ce1152a67d15d6baae95fb3e))
|
|
167
|
+
* NFS-1289: Increase alpha version ([3201add](https://github.com/Staffbase/widget-sdk/commit/3201add07f2dc8bc3cee18c17f30c4fc9c219719))
|
|
168
|
+
* 3.3.0-alpha-1 ([ae51620](https://github.com/Staffbase/widget-sdk/commit/ae51620a8510591ef87ffb579ec4eaa5af4ffa84))
|
|
169
|
+
* NFS-1289: Rollback incomptible changes from NFS-872 ([d276698](https://github.com/Staffbase/widget-sdk/commit/d2766983ef168d0c7f97b6cb5583d0899b8d9192))
|
|
170
|
+
* NFS-1289: Make widgetApi non-optional ([e8ba6cc](https://github.com/Staffbase/widget-sdk/commit/e8ba6cc111c003ec4b4012a883c897fd6de064f9))
|
|
171
|
+
* NFS-1289: Add getUserList ([76a3aed](https://github.com/Staffbase/widget-sdk/commit/76a3aedbd7ede00836d6a5dbc514eedf70a45429))
|
|
172
|
+
* NFS-1289: Update naming and comments ([76ae96b](https://github.com/Staffbase/widget-sdk/commit/76ae96b9391052fa29617602c1b82f6cb5ca5351))
|
|
173
|
+
* NFS-1289: Add user info type ([2f09337](https://github.com/Staffbase/widget-sdk/commit/2f0933796de0878bdf69bd3249068a75c2ac3b1d))
|
|
174
|
+
* NFS-1289: Update index ([66b34c5](https://github.com/Staffbase/widget-sdk/commit/66b34c5a4e55222274b14571b694043201d3a838))
|
|
175
|
+
* NFS-1289: Add widget api definition ([979d944](https://github.com/Staffbase/widget-sdk/commit/979d944010869f361b934ae181988c22eeb8c7a9))
|
|
176
|
+
* add description for uischema ([ca052f4](https://github.com/Staffbase/widget-sdk/commit/ca052f4c68198b1035fa81ed261281079cfee531))
|
|
177
|
+
* add description for uischema ([793e83c](https://github.com/Staffbase/widget-sdk/commit/793e83cc4ae969898cba5593086abbea3d5668a3))
|
|
178
|
+
* NFS-872: change widget attribute ([596572b](https://github.com/Staffbase/widget-sdk/commit/596572b6121c0ed43180a584affce2d44e8c4046))
|
|
179
|
+
* Adding the SBColors type ([436d071](https://github.com/Staffbase/widget-sdk/commit/436d071dff28a4905dd5da0786e3e87f8fe6764e))
|
|
180
|
+
* Adding ColorTheme to the widgetApi ([98ab6e2](https://github.com/Staffbase/widget-sdk/commit/98ab6e256d93167da43965f1b1177711a03d8ac2))
|
|
181
|
+
* 3.2.1-alpha-groda-1 ([47c6c76](https://github.com/Staffbase/widget-sdk/commit/47c6c76c9fa23f1dcb9052b433971a754e158aeb))
|
|
182
|
+
* NFS-1289: Increase alpha version ([b82fa28](https://github.com/Staffbase/widget-sdk/commit/b82fa28d9ec06ed34352d087cc397388b851e3ed))
|
|
183
|
+
* Merge branch 'NFS-1289-Add-Widget-Api-Definition' of github.com:Staffbase/widget-sdk into NFS-1289-Add-Widget-Api-Definition ([2acd9fa](https://github.com/Staffbase/widget-sdk/commit/2acd9faf0af7a6b5dc625d2b31b4e53f515597d0))
|
|
184
|
+
* NFS-1289: Rollback incomptible changes from NFS-872 ([1006f62](https://github.com/Staffbase/widget-sdk/commit/1006f6201cc2dff7159582e8bde3e6674c057ae5))
|
|
185
|
+
* 3.3.0-alpha-1 ([39e2983](https://github.com/Staffbase/widget-sdk/commit/39e29831b7dac6b63c62b4b5ed1f787569784931))
|
|
186
|
+
* NFS-1289: Make widgetApi non-optional ([faa8223](https://github.com/Staffbase/widget-sdk/commit/faa82235e71210afe984624143f4a774ee94e897))
|
|
187
|
+
* NFS-1289: Add getUserList ([e96311b](https://github.com/Staffbase/widget-sdk/commit/e96311b8a81165ac594d42c0a45592845dc8a0a4))
|
|
188
|
+
* NFS-1289: Update naming and comments ([e5593d7](https://github.com/Staffbase/widget-sdk/commit/e5593d76deb6deae7386b16a3ae084ddfdb17f87))
|
|
189
|
+
* NFS-1289: Add user info type ([ac5e83b](https://github.com/Staffbase/widget-sdk/commit/ac5e83ba585a7b75698a138f820475415abbe50c))
|
|
190
|
+
* NFS-1289: Update index ([ef49c3d](https://github.com/Staffbase/widget-sdk/commit/ef49c3dddcf8f37656f1cf61ee54059e9c9e0c87))
|
|
191
|
+
* NFS-1289: Add widget api definition ([a16b267](https://github.com/Staffbase/widget-sdk/commit/a16b267805eccbcb354eb6d2020b90ddfc852d5e))
|
|
192
|
+
* Update lib/base-block.ts ([39c40ec](https://github.com/Staffbase/widget-sdk/commit/39c40ec298274f6814b7ed9a25622ea71946928a))
|
|
193
|
+
* NFS-1002: adds definitions for the parsing of attributes ([08f5675](https://github.com/Staffbase/widget-sdk/commit/08f5675da41be87b6535c5d4a28dfe1d913f0bd4))
|
|
165
194
|
|
|
166
|
-
# [3.3.0
|
|
195
|
+
# [3.3.0](https://github.com/Staffbase/widget-sdk/compare/3.2.0...3.3.0) (2021-05-11)
|
|
167
196
|
|
|
168
197
|
|
|
169
198
|
### Bug Fixes
|
|
@@ -178,8 +207,12 @@
|
|
|
178
207
|
|
|
179
208
|
* add deleted block attributes file ([8c639df](https://github.com/Staffbase/widget-sdk/commit/8c639dfbe70197be614af7a4a57041d391caf372))
|
|
180
209
|
* add deleted block attributes file ([629d0c5](https://github.com/Staffbase/widget-sdk/commit/629d0c5276cb065979e0c66b3d849e083d73a032))
|
|
210
|
+
* add semantic release ([0dc3400](https://github.com/Staffbase/widget-sdk/commit/0dc340015f62702608b107199b977a13bcebdaa3))
|
|
181
211
|
* add semantic release ([63e0344](https://github.com/Staffbase/widget-sdk/commit/63e0344939cb24444afab2d1ab0c3553730a5cea))
|
|
212
|
+
* change release rules ([32f0520](https://github.com/Staffbase/widget-sdk/commit/32f05208e33801eb925c09d67dcd9ec6ae993b57))
|
|
182
213
|
* disabled dryrun ([f390c78](https://github.com/Staffbase/widget-sdk/commit/f390c78d85446decc62b0eb9efa1a346bedb32bd))
|
|
214
|
+
* fix blocked release ([9283e21](https://github.com/Staffbase/widget-sdk/commit/9283e210a788bee4c72856ecde5125a8daf45298))
|
|
215
|
+
* fix blocked release ([857dcac](https://github.com/Staffbase/widget-sdk/commit/857dcac7093892a3035297bc70b693c5c9a3d501))
|
|
183
216
|
* raise min node version ([c41863d](https://github.com/Staffbase/widget-sdk/commit/c41863d877c210b3ee46d5c7a7db77623b3c93ad))
|
|
184
217
|
* switched the release plugin ([5c907a6](https://github.com/Staffbase/widget-sdk/commit/5c907a6d46ee77a87b6d71c92dd9e13a3190ab1a))
|
|
185
218
|
* use default release rules ([5932645](https://github.com/Staffbase/widget-sdk/commit/59326457e0c73ff68762bf130c80c1b5e0b8725e))
|
|
@@ -199,6 +232,8 @@
|
|
|
199
232
|
|
|
200
233
|
### Miscellaneous
|
|
201
234
|
|
|
235
|
+
* NFS-1002: adds definitions for the parsing of attributes ([8d5e897](https://github.com/Staffbase/widget-sdk/commit/8d5e897f956f97f03b1b7ebd5190b343db9672e9))
|
|
236
|
+
* Merge branch 'next' into NFS-1002-parse-methods ([a4fc6e3](https://github.com/Staffbase/widget-sdk/commit/a4fc6e3b26e2fb89787c4f924235e0fdbb0b4a43))
|
|
202
237
|
* Make ui schema optional ([3c6e1b1](https://github.com/Staffbase/widget-sdk/commit/3c6e1b104ec99acd97c5febc8ee7544ee5a856fb))
|
|
203
238
|
* 3.3.0-beta-2 ([5ee39df](https://github.com/Staffbase/widget-sdk/commit/5ee39dff788cdd90054f097f13d8ca27844d53a0))
|
|
204
239
|
* NFS-989: Add colors to the sdk ([eb59ed1](https://github.com/Staffbase/widget-sdk/commit/eb59ed1c7670f91e8974e1648e354d925c4feae5))
|
|
@@ -234,3 +269,5 @@
|
|
|
234
269
|
* NFS-1289: Add user info type ([ac5e83b](https://github.com/Staffbase/widget-sdk/commit/ac5e83ba585a7b75698a138f820475415abbe50c))
|
|
235
270
|
* NFS-1289: Update index ([ef49c3d](https://github.com/Staffbase/widget-sdk/commit/ef49c3dddcf8f37656f1cf61ee54059e9c9e0c87))
|
|
236
271
|
* NFS-1289: Add widget api definition ([a16b267](https://github.com/Staffbase/widget-sdk/commit/a16b267805eccbcb354eb6d2020b90ddfc852d5e))
|
|
272
|
+
* Update lib/base-block.ts ([39c40ec](https://github.com/Staffbase/widget-sdk/commit/39c40ec298274f6814b7ed9a25622ea71946928a))
|
|
273
|
+
* NFS-1002: adds definitions for the parsing of attributes ([08f5675](https://github.com/Staffbase/widget-sdk/commit/08f5675da41be87b6535c5d4a28dfe1d913f0bd4))
|
package/lib/base-block.ts
CHANGED
|
@@ -11,13 +11,6 @@
|
|
|
11
11
|
* limitations under the License.
|
|
12
12
|
*/
|
|
13
13
|
|
|
14
|
-
type Value = string | number | boolean | unknown[] | Record<string, unknown> | null | undefined;
|
|
15
|
-
|
|
16
|
-
/**
|
|
17
|
-
* Generic map of parsed attributes.
|
|
18
|
-
*/
|
|
19
|
-
type ValueMap = Record<string, Value>;
|
|
20
|
-
|
|
21
14
|
/**
|
|
22
15
|
* Base class for custom widgets.
|
|
23
16
|
*
|
|
@@ -86,7 +79,7 @@ export interface BaseBlock extends HTMLElement {
|
|
|
86
79
|
* NOTE: The default implementation turns every value in a string, except arrays and object, which
|
|
87
80
|
* are converted to base64 encoded data uris in the format `data:text/plain;base64,...`
|
|
88
81
|
*/
|
|
89
|
-
parseConfig<T extends
|
|
82
|
+
parseConfig<T extends Record<string, any>>(attributes: T): Record<string, string>;
|
|
90
83
|
|
|
91
84
|
/**
|
|
92
85
|
* Called when the config dialog is opened. The dialog uses the parsed attributes, to fill
|
|
@@ -102,7 +95,7 @@ export interface BaseBlock extends HTMLElement {
|
|
|
102
95
|
* NOTE: The default implementation converts every string to string, boolean or number and decodes
|
|
103
96
|
* and parses the data uris to the arrays and objects. Dates are remaining a string!
|
|
104
97
|
*/
|
|
105
|
-
parseAttributes():
|
|
98
|
+
parseAttributes<T extends Record<string, any>>(): T;
|
|
106
99
|
|
|
107
100
|
/**
|
|
108
101
|
* The content language as defined in the hosting system. Should be used to provide
|
package/lib/widget-api-types.ts
CHANGED
|
@@ -198,3 +198,28 @@ export interface IntegrationToken {
|
|
|
198
198
|
// date when the access token expires
|
|
199
199
|
accessTokenExpiresAt?: Date;
|
|
200
200
|
}
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* All available states the integration can take
|
|
204
|
+
*/
|
|
205
|
+
export enum IntegrationState {
|
|
206
|
+
UNAVAILABLE = 'unavailable',
|
|
207
|
+
AVAILABLE = 'available',
|
|
208
|
+
LOGGED_OUT = 'loggedOut',
|
|
209
|
+
}
|
|
210
|
+
|
|
211
|
+
/**
|
|
212
|
+
* Information about the requested Integration target
|
|
213
|
+
*/
|
|
214
|
+
export interface IntegrationInformation {
|
|
215
|
+
// The status of the integration
|
|
216
|
+
status: IntegrationState
|
|
217
|
+
// All features enabled for the current slug
|
|
218
|
+
enabledFeatures: string[],
|
|
219
|
+
// All features supported by the integration
|
|
220
|
+
supportedFeatures: string[],
|
|
221
|
+
// The integration token
|
|
222
|
+
token?: IntegrationToken,
|
|
223
|
+
// A function to trigger the sign-in flow of the integration
|
|
224
|
+
signIn?: () => void
|
|
225
|
+
}
|
package/lib/widget-api.ts
CHANGED
|
@@ -11,7 +11,7 @@
|
|
|
11
11
|
* limitations under the License.
|
|
12
12
|
*/
|
|
13
13
|
|
|
14
|
-
import { ColorTheme,
|
|
14
|
+
import { ColorTheme, IntegrationInformation, IntegrationType, SBUserProfile, UserListRequestQuery, UserListResponse } from './widget-api-types';
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
/**
|
|
@@ -55,14 +55,21 @@ export interface WidgetApi {
|
|
|
55
55
|
*/
|
|
56
56
|
getUserList(query: UserListRequestQuery): Promise<UserListResponse>;
|
|
57
57
|
|
|
58
|
-
|
|
59
58
|
/**
|
|
60
59
|
* Call to retrieve a valid token to access the Microsoft API. Includes a time value to
|
|
61
60
|
* refresh the token.
|
|
62
61
|
*
|
|
63
62
|
* @param type The name of the integration. ("ms365")
|
|
64
|
-
* @
|
|
65
|
-
*
|
|
63
|
+
* @param refresh Force a refresh of the integration.
|
|
64
|
+
*
|
|
65
|
+
* @returns A promise containing the IntegrationInformation is returned. If the user session is
|
|
66
|
+
* not existing, the status is set to 'loggedOut' and the token is null. Additionally if the
|
|
67
|
+
* integration is not configured the status returns 'unavailable'.
|
|
68
|
+
*
|
|
69
|
+
* In case of an error, the promise is rejected.
|
|
70
|
+
*
|
|
71
|
+
* @deprecated Returns a IntegrationToken or null if the user is not logged in. This will be replaced
|
|
72
|
+
* completely by the IntegrationInformation, containing the token.
|
|
66
73
|
*/
|
|
67
|
-
getIntegration(type: IntegrationType): Promise<
|
|
74
|
+
getIntegration(type: IntegrationType, refresh?: boolean): Promise<IntegrationInformation>;
|
|
68
75
|
}
|