@staffbase/widget-sdk 3.3.1 → 3.4.0-beta.1

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.
Files changed (35) hide show
  1. package/.github/CODEOWNERS +1 -0
  2. package/.github/workflows/ci.yaml +0 -2
  3. package/.github/workflows/dependency-update.yml +24 -0
  4. package/.releaserc +1 -1
  5. package/CHANGELOG.md +136 -74
  6. package/README.md +34 -1
  7. package/catalog-info.yaml +11 -0
  8. package/docs/Home.md +74 -0
  9. package/docs/Interface: BaseBlock.md +3226 -0
  10. package/docs/Interface: BlockAttributes.md +11 -0
  11. package/docs/Interface: BlockDefinition.md +117 -0
  12. package/docs/Interface: BlockElement.md +89 -0
  13. package/docs/Interface: ColorTheme.md +52 -0
  14. package/docs/Interface: ExternalBlockDefinition.md +38 -0
  15. package/docs/Interface: SBColors.md +354 -0
  16. package/docs/Interface: SBFileType.md +39 -0
  17. package/docs/Interface: SBImageEntity.md +39 -0
  18. package/docs/Interface: SBUserAvatar.md +27 -0
  19. package/docs/Interface: SBUserProfile.md +51 -0
  20. package/docs/Interface: UserListItem.md +27 -0
  21. package/docs/Interface: UserListRequestQuery.md +27 -0
  22. package/docs/Interface: UserListResponse.md +27 -0
  23. package/docs/Interface: WidgetApi.md +75 -0
  24. package/docs/_Sidebar.md +20 -0
  25. package/lib/base-block.ts +10 -3
  26. package/lib/block-attributes.ts +1 -1
  27. package/lib/block-definition.ts +43 -9
  28. package/lib/block-element.ts +6 -6
  29. package/lib/block-factory.ts +1 -1
  30. package/lib/external-block-definition.ts +1 -1
  31. package/lib/global.d.ts +1 -1
  32. package/lib/widget-api-types.ts +18 -2
  33. package/lib/widget-api.ts +18 -8
  34. package/package.json +16 -10
  35. package/tsconfig.json +13 -0
package/.github/CODEOWNERS ADDED
@@ -0,0 +1 @@
1
+ * @Staffbase/need-for-speed-devs
package/.github/workflows/ci.yaml CHANGED
@@ -11,8 +11,6 @@ on:
11
11
  env:
12
12
  GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
13
13
  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
14
- STAFFBASE_GITHUB_PACKAGES_TOKEN: ${{ secrets.GH_TOKEN }}
15
- STAFFBASE_NPM_JS_TOKEN: ${{ secrets.NPM_TOKEN }}
16
14
 
17
15
  jobs:
18
16
  test:
package/.github/workflows/dependency-update.yml ADDED
@@ -0,0 +1,24 @@
1
+ name: Dependency Update
2
+
3
+ on:
4
+ schedule:
5
+ - cron: "0 12 * * 3" # every Wednesday at 12pm UTC
6
+ workflow_dispatch:
7
+
8
+ env:
9
+ NPM_TOKEN: ${{ secrets.STAFFBOT_NPM_TOKEN_PACKAGE_READ }}
10
+ GITHUB_TOKEN: ${{ secrets.STAFFBOT_GITHUB_TOKEN }}
11
+
12
+ jobs:
13
+ npm-audit-fix:
14
+ runs-on: ubuntu-latest
15
+ steps:
16
+ - uses: actions/checkout@v2
17
+ with:
18
+ persist-credentials: false
19
+ - uses: Staffbase/npm-audit-fix-action@v3.3.0
20
+ with:
21
+ github_token: ${{ secrets.STAFFBOT_GITHUB_TOKEN }}
22
+ github_user: "Staffbot"
23
+ github_email: "staffbot@staffbase.com"
24
+ labels: "dependencies, javascript, security, dev"
package/.releaserc CHANGED
@@ -12,7 +12,7 @@ plugins:
12
12
  - type: "chore"
13
13
  release: false
14
14
  - type: "docs"
15
- release: false
15
+ release: "patch"
16
16
  - type: "refactor"
17
17
  release: false
18
18
  - type: "style"
package/CHANGELOG.md CHANGED
@@ -1,3 +1,119 @@
1
+ # [3.4.0-beta.1](https://github.com/Staffbase/widget-sdk/compare/3.3.3...3.4.0-beta.1) (2021-11-23)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * change types to allow casting ([ebc524a](https://github.com/Staffbase/widget-sdk/commit/ebc524a1d4fbc64d4f688bca949c0cdefb476185))
7
+
8
+
9
+ ### Build System
10
+
11
+ * **deps:** npm audit fix ([89951f4](https://github.com/Staffbase/widget-sdk/commit/89951f4aa7db18babc21918bab37a6da10d330b9))
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))
14
+
15
+
16
+ ### Chores
17
+
18
+ * add dependency update bot ([48be50e](https://github.com/Staffbase/widget-sdk/commit/48be50e36508ab89cb17f0b5643162180a7b7d38))
19
+ * exchange token vars ([4ef9c78](https://github.com/Staffbase/widget-sdk/commit/4ef9c78bf81e9b272f4014cd5e8df1cb6b2d2f3b))
20
+ * exchange token vars ([80bebb5](https://github.com/Staffbase/widget-sdk/commit/80bebb5825c5f7d410f3bc2d1493d492d757a2e4))
21
+ * remove unneeded env vars ([c368fde](https://github.com/Staffbase/widget-sdk/commit/c368fdee2473b0ff7fa8b54464740200718370bd))
22
+ * remove unneeded env vars ([a823c98](https://github.com/Staffbase/widget-sdk/commit/a823c98a51a5d9b928ce857d36e5ced7f8e10d98))
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))
26
+
27
+
28
+ ### Documentation
29
+
30
+ * add explanation ([85f5af3](https://github.com/Staffbase/widget-sdk/commit/85f5af391d99877f88e0ffe1989cbe48dac21587))
31
+
32
+
33
+ ### Features
34
+
35
+ * add integrations support to the api ([f091004](https://github.com/Staffbase/widget-sdk/commit/f091004c98115a7fdd663f7781cd1e86ac0c5e80))
36
+ * add null to return value ([478256b](https://github.com/Staffbase/widget-sdk/commit/478256ba7704d9410dcdabd57967ca434bd4a07b))
37
+ * add value map type ([3371441](https://github.com/Staffbase/widget-sdk/commit/33714410ba35c89ad12ab0242762b751cfabceeb))
38
+ * change type, add docu ([89a1622](https://github.com/Staffbase/widget-sdk/commit/89a16224b75bd2d75e275a5ea641bf1fffd1bd24))
39
+ * changed type to date ([9aa8cc2](https://github.com/Staffbase/widget-sdk/commit/9aa8cc223b78b0d8e9046cc2a8ebbcdcc068ac84))
40
+
41
+
42
+ ### Miscellaneous
43
+
44
+ * Merge branch 'NFS-1519-add-integrations' into beta ([8857284](https://github.com/Staffbase/widget-sdk/commit/88572843757d178ead03b39700455d74fe9e065e))
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))
56
+
57
+ ## [3.3.3](https://github.com/Staffbase/widget-sdk/compare/3.3.2...3.3.3) (2021-09-01)
58
+
59
+
60
+ ### Bug Fixes
61
+
62
+ * dependency update ([c9de860](https://github.com/Staffbase/widget-sdk/commit/c9de860af14e902ebf58c32bc84700cdf3b18a53))
63
+
64
+
65
+ ### Chores
66
+
67
+ * npm audit fix ([9176053](https://github.com/Staffbase/widget-sdk/commit/9176053a1d453df87e5e8f2ae316a42098adcb8a))
68
+ * **deps:** bump trim-newlines from 3.0.0 to 3.0.1 ([9d34aec](https://github.com/Staffbase/widget-sdk/commit/9d34aec5ff491dafcad315fa41c32e8b4aac98d6))
69
+ * Trigger push ([66e5c87](https://github.com/Staffbase/widget-sdk/commit/66e5c879cf8c34e25ff00439b7d14c0a576cc028))
70
+ * **deps:** bump normalize-url from 6.0.0 to 6.0.1 ([f1ec4cb](https://github.com/Staffbase/widget-sdk/commit/f1ec4cbffb8264d8d0f376a7cfea2500815fa704))
71
+ * Trigger push ([84035d4](https://github.com/Staffbase/widget-sdk/commit/84035d446f4e2c400d988e1551de877a9a90f4eb))
72
+ * update dependencies ([b18d9ac](https://github.com/Staffbase/widget-sdk/commit/b18d9ac734459784f457b4120a9816ba743f53d6))
73
+ * **deps:** bump normalize-url from 6.0.0 to 6.0.1 ([178e0f0](https://github.com/Staffbase/widget-sdk/commit/178e0f05286dbb2dc27e375b03eb4c19989fb17a))
74
+ * **deps:** bump trim-newlines from 3.0.0 to 3.0.1 ([e4f0e7b](https://github.com/Staffbase/widget-sdk/commit/e4f0e7bd9517ecbcb95663545d002819bc80648e))
75
+
76
+
77
+ ### Miscellaneous
78
+
79
+ * NFS-000: Release new version ([1bbeb5b](https://github.com/Staffbase/widget-sdk/commit/1bbeb5bb76675cffc127441a305cf9311bf57af1))
80
+ * NFS-000: Dependency update ([f0c12f6](https://github.com/Staffbase/widget-sdk/commit/f0c12f6a74893028e94475240b2aa4c28aa8c9a2))
81
+ * 3.3.3-beta.1 ([6e21d16](https://github.com/Staffbase/widget-sdk/commit/6e21d16ee70d130a7c2f2c03a899290b7637db66))
82
+ * 3.3.3-beta.0 ([6f9859e](https://github.com/Staffbase/widget-sdk/commit/6f9859e28420ce1d97ca886574b40ab67af3c096))
83
+ * NFS-000: Dependency update ([ffa68ed](https://github.com/Staffbase/widget-sdk/commit/ffa68edd3c617c8b3f2e5611efd5ad8b40aab854))
84
+ * Add catalog-info.yaml for Backstage (#14) ([d7caa8e](https://github.com/Staffbase/widget-sdk/commit/d7caa8ed45d091860da33dbb5abb0a2938068235)), closes [#14](https://github.com/Staffbase/widget-sdk/issues/14)
85
+
86
+ ## [3.3.2](https://github.com/Staffbase/widget-sdk/compare/3.3.1...3.3.2) (2021-05-25)
87
+
88
+
89
+ ### Chores
90
+
91
+ * add scripts to generate docs ([30ec320](https://github.com/Staffbase/widget-sdk/commit/30ec320a9a0d82d4b83496dd04da710a17bc2c99))
92
+ * change release rule for docs ([a4a6d13](https://github.com/Staffbase/widget-sdk/commit/a4a6d136c78e39380b1e8f2e2c63c58507803ed6))
93
+ * fix dependencies ([68ea122](https://github.com/Staffbase/widget-sdk/commit/68ea122d30bf67235439869cffdda35fde6d35e8))
94
+
95
+
96
+ ### Documentation
97
+
98
+ * add example for the json schema ([f454896](https://github.com/Staffbase/widget-sdk/commit/f45489631c1a67046b298fa0234a44f6d8bb2d93))
99
+ * add more to the readme ([15f59fe](https://github.com/Staffbase/widget-sdk/commit/15f59fe1206f27dade3dd9f1fe66c5c914edae36))
100
+ * add typedoc and generated docs files ([7241869](https://github.com/Staffbase/widget-sdk/commit/7241869d1080b41e144e5ec14c23c0dc9104ed7e))
101
+ * add typedoc and generated docs files ([8c61df0](https://github.com/Staffbase/widget-sdk/commit/8c61df0a3f98aaa82cb1ccc8a3d161cf57d4c3ce))
102
+ * Apply suggestions from code review ([b69f838](https://github.com/Staffbase/widget-sdk/commit/b69f83823674ca1a105345fa6a99d38963d4a557))
103
+ * create new doc files ([f3d72f2](https://github.com/Staffbase/widget-sdk/commit/f3d72f232b1e805cab195cdd8ab646b020a70ec9))
104
+ * fix missing comment line ([abe01df](https://github.com/Staffbase/widget-sdk/commit/abe01df6f8e18a173ec4edd8b237a30cc24c81b4))
105
+ * fix wording, remove readme and defined links ([0454faf](https://github.com/Staffbase/widget-sdk/commit/0454faf9d793a62d9ab2d3fc93054125a70bcd7b))
106
+ * update documentation ([54f9212](https://github.com/Staffbase/widget-sdk/commit/54f92123879b889b93e7690f29f69d641de93edd))
107
+ * update generated docs ([8cb1a22](https://github.com/Staffbase/widget-sdk/commit/8cb1a229b58b927d1d90dcc51bb979d565a1ecf9))
108
+ * updated generated doc ([c7eeede](https://github.com/Staffbase/widget-sdk/commit/c7eeeded002f2ec468de58c478262bf30a520459))
109
+
110
+
111
+ ### Miscellaneous
112
+
113
+ * Merge branch 'master' into nfs-1164-documentation ([d911c98](https://github.com/Staffbase/widget-sdk/commit/d911c98b947767a29d7b2349b97f9bb17171eb4f))
114
+ * Next Release ([fd88885](https://github.com/Staffbase/widget-sdk/commit/fd88885a245639601d471ee6a4d51cb994fb9b15))
115
+ * Merge branch 'next' into nfs-1164-documentation ([92881b1](https://github.com/Staffbase/widget-sdk/commit/92881b173480451aa9b6731f336e7b96d30898f3))
116
+
1
117
  ## [3.3.1](https://github.com/Staffbase/widget-sdk/compare/3.3.0...3.3.1) (2021-05-19)
2
118
 
3
119
 
@@ -16,84 +132,38 @@
16
132
 
17
133
  ### Bug Fixes
18
134
 
19
- * changed package version ([3641fdd](https://github.com/Staffbase/widget-sdk/commit/3641fdd980ba84370f8736c7ec49b3a0c93a273d))
20
- * 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)
21
- * update package-lock.json ([67163cf](https://github.com/Staffbase/widget-sdk/commit/67163cf3445d3f6dc4ae6862461b28409ea22328))
22
- * update package-lock.json ([6480488](https://github.com/Staffbase/widget-sdk/commit/648048892f7804913747c24320c4f71dc7597cf7))
135
+ * change types to allow casting ([ebc524a](https://github.com/Staffbase/widget-sdk/commit/ebc524a1d4fbc64d4f688bca949c0cdefb476185))
23
136
 
137
+ ## [3.3.1-beta.1](https://github.com/Staffbase/widget-sdk/compare/3.3.0...3.3.1-beta.1) (2021-05-11)
24
138
 
25
- ### Chores
26
139
 
27
- * add deleted block attributes file ([8c639df](https://github.com/Staffbase/widget-sdk/commit/8c639dfbe70197be614af7a4a57041d391caf372))
28
- * add deleted block attributes file ([629d0c5](https://github.com/Staffbase/widget-sdk/commit/629d0c5276cb065979e0c66b3d849e083d73a032))
29
- * add semantic release ([0dc3400](https://github.com/Staffbase/widget-sdk/commit/0dc340015f62702608b107199b977a13bcebdaa3))
30
- * add semantic release ([63e0344](https://github.com/Staffbase/widget-sdk/commit/63e0344939cb24444afab2d1ab0c3553730a5cea))
31
- * change release rules ([32f0520](https://github.com/Staffbase/widget-sdk/commit/32f05208e33801eb925c09d67dcd9ec6ae993b57))
32
- * disabled dryrun ([f390c78](https://github.com/Staffbase/widget-sdk/commit/f390c78d85446decc62b0eb9efa1a346bedb32bd))
33
- * fix blocked release ([9283e21](https://github.com/Staffbase/widget-sdk/commit/9283e210a788bee4c72856ecde5125a8daf45298))
34
- * fix blocked release ([857dcac](https://github.com/Staffbase/widget-sdk/commit/857dcac7093892a3035297bc70b693c5c9a3d501))
35
- * raise min node version ([c41863d](https://github.com/Staffbase/widget-sdk/commit/c41863d877c210b3ee46d5c7a7db77623b3c93ad))
36
- * remove publish config ([c7b6198](https://github.com/Staffbase/widget-sdk/commit/c7b61980ff4c44f8aa58f78e28486fffa5975f4e))
37
- * switched the release plugin ([5c907a6](https://github.com/Staffbase/widget-sdk/commit/5c907a6d46ee77a87b6d71c92dd9e13a3190ab1a))
38
- * use default release rules ([5932645](https://github.com/Staffbase/widget-sdk/commit/59326457e0c73ff68762bf130c80c1b5e0b8725e))
39
-
40
-
41
- ### Code Refactoring
140
+ ### Chores
42
141
 
43
- * make uischema optional ([0a0bc56](https://github.com/Staffbase/widget-sdk/commit/0a0bc5672d7964008f3440164752560ae86c8036))
142
+ * add scripts to generate docs ([30ec320](https://github.com/Staffbase/widget-sdk/commit/30ec320a9a0d82d4b83496dd04da710a17bc2c99))
143
+ * change release rule for docs ([a4a6d13](https://github.com/Staffbase/widget-sdk/commit/a4a6d136c78e39380b1e8f2e2c63c58507803ed6))
144
+ * fix dependencies ([68ea122](https://github.com/Staffbase/widget-sdk/commit/68ea122d30bf67235439869cffdda35fde6d35e8))
44
145
 
45
146
 
46
- ### Features
147
+ ### Documentation
47
148
 
48
- * add ui schema support ([ea16238](https://github.com/Staffbase/widget-sdk/commit/ea16238f0f25da1461a0c3176a872948580bb8dc))
49
- * add ui schema support ([3fe7510](https://github.com/Staffbase/widget-sdk/commit/3fe751072066f3b103c42f653a5f1e5927ee292a))
50
- * set package name ([214990b](https://github.com/Staffbase/widget-sdk/commit/214990b8f0c1ab79c5492d6e88661b6577fce80b))
149
+ * add example for the json schema ([f454896](https://github.com/Staffbase/widget-sdk/commit/f45489631c1a67046b298fa0234a44f6d8bb2d93))
150
+ * add more to the readme ([15f59fe](https://github.com/Staffbase/widget-sdk/commit/15f59fe1206f27dade3dd9f1fe66c5c914edae36))
151
+ * add typedoc and generated docs files ([8c61df0](https://github.com/Staffbase/widget-sdk/commit/8c61df0a3f98aaa82cb1ccc8a3d161cf57d4c3ce))
152
+ * create new doc files ([f3d72f2](https://github.com/Staffbase/widget-sdk/commit/f3d72f232b1e805cab195cdd8ab646b020a70ec9))
153
+ * fix missing comment line ([abe01df](https://github.com/Staffbase/widget-sdk/commit/abe01df6f8e18a173ec4edd8b237a30cc24c81b4))
154
+ * update documentation ([54f9212](https://github.com/Staffbase/widget-sdk/commit/54f92123879b889b93e7690f29f69d641de93edd))
155
+ * update generated docs ([8cb1a22](https://github.com/Staffbase/widget-sdk/commit/8cb1a229b58b927d1d90dcc51bb979d565a1ecf9))
156
+ * updated generated doc ([c7eeede](https://github.com/Staffbase/widget-sdk/commit/c7eeeded002f2ec468de58c478262bf30a520459))
51
157
 
52
158
 
53
159
  ### Miscellaneous
54
160
 
55
- * **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)
56
- * NFS-1002: adds definitions for the parsing of attributes ([8d5e897](https://github.com/Staffbase/widget-sdk/commit/8d5e897f956f97f03b1b7ebd5190b343db9672e9))
57
- * Merge branch 'next' into NFS-1002-parse-methods ([a4fc6e3](https://github.com/Staffbase/widget-sdk/commit/a4fc6e3b26e2fb89787c4f924235e0fdbb0b4a43))
58
- * Make ui schema optional ([3c6e1b1](https://github.com/Staffbase/widget-sdk/commit/3c6e1b104ec99acd97c5febc8ee7544ee5a856fb))
59
- * 3.3.0-beta-2 ([5ee39df](https://github.com/Staffbase/widget-sdk/commit/5ee39dff788cdd90054f097f13d8ca27844d53a0))
60
- * NFS-989: Add colors to the sdk ([eb59ed1](https://github.com/Staffbase/widget-sdk/commit/eb59ed1c7670f91e8974e1648e354d925c4feae5))
61
- * 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))
62
- * Merge branch 'master' into Add_colors_to_the_SDK ([be07592](https://github.com/Staffbase/widget-sdk/commit/be07592ab9f8682d466b78d127bdf0a4cac6cde0))
63
- * NFS-1289: Widget SDK: As a widget developer I want to have user information provided ([7716a6f](https://github.com/Staffbase/widget-sdk/commit/7716a6f590eb3dff8b7d9ee14c84bda1a5d3a7eb))
64
- * NFS-1289: Changes from review ([ccad4b1](https://github.com/Staffbase/widget-sdk/commit/ccad4b1605129db09e840619cf26a76c99d694b4))
65
- * NFS-1289: Changes from review ([18fd04d](https://github.com/Staffbase/widget-sdk/commit/18fd04d635eedbba3f89f60cecdc6412e1a21dc1))
66
- * NFS-1289: Changes from review ([766801f](https://github.com/Staffbase/widget-sdk/commit/766801faefd489163f2191d7f2fa329e68a7fa4d))
67
- * NFS-1289: Comment adjustments from review ([6a5757b](https://github.com/Staffbase/widget-sdk/commit/6a5757b6e7f70648ce1152a67d15d6baae95fb3e))
68
- * NFS-1289: Increase alpha version ([3201add](https://github.com/Staffbase/widget-sdk/commit/3201add07f2dc8bc3cee18c17f30c4fc9c219719))
69
- * 3.3.0-alpha-1 ([ae51620](https://github.com/Staffbase/widget-sdk/commit/ae51620a8510591ef87ffb579ec4eaa5af4ffa84))
70
- * NFS-1289: Rollback incomptible changes from NFS-872 ([d276698](https://github.com/Staffbase/widget-sdk/commit/d2766983ef168d0c7f97b6cb5583d0899b8d9192))
71
- * NFS-1289: Make widgetApi non-optional ([e8ba6cc](https://github.com/Staffbase/widget-sdk/commit/e8ba6cc111c003ec4b4012a883c897fd6de064f9))
72
- * NFS-1289: Add getUserList ([76a3aed](https://github.com/Staffbase/widget-sdk/commit/76a3aedbd7ede00836d6a5dbc514eedf70a45429))
73
- * NFS-1289: Update naming and comments ([76ae96b](https://github.com/Staffbase/widget-sdk/commit/76ae96b9391052fa29617602c1b82f6cb5ca5351))
74
- * NFS-1289: Add user info type ([2f09337](https://github.com/Staffbase/widget-sdk/commit/2f0933796de0878bdf69bd3249068a75c2ac3b1d))
75
- * NFS-1289: Update index ([66b34c5](https://github.com/Staffbase/widget-sdk/commit/66b34c5a4e55222274b14571b694043201d3a838))
76
- * NFS-1289: Add widget api definition ([979d944](https://github.com/Staffbase/widget-sdk/commit/979d944010869f361b934ae181988c22eeb8c7a9))
77
- * add description for uischema ([ca052f4](https://github.com/Staffbase/widget-sdk/commit/ca052f4c68198b1035fa81ed261281079cfee531))
78
- * add description for uischema ([793e83c](https://github.com/Staffbase/widget-sdk/commit/793e83cc4ae969898cba5593086abbea3d5668a3))
79
- * NFS-872: change widget attribute ([596572b](https://github.com/Staffbase/widget-sdk/commit/596572b6121c0ed43180a584affce2d44e8c4046))
80
- * Adding the SBColors type ([436d071](https://github.com/Staffbase/widget-sdk/commit/436d071dff28a4905dd5da0786e3e87f8fe6764e))
81
- * Adding ColorTheme to the widgetApi ([98ab6e2](https://github.com/Staffbase/widget-sdk/commit/98ab6e256d93167da43965f1b1177711a03d8ac2))
82
- * 3.2.1-alpha-groda-1 ([47c6c76](https://github.com/Staffbase/widget-sdk/commit/47c6c76c9fa23f1dcb9052b433971a754e158aeb))
83
- * NFS-1289: Increase alpha version ([b82fa28](https://github.com/Staffbase/widget-sdk/commit/b82fa28d9ec06ed34352d087cc397388b851e3ed))
84
- * 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))
85
- * NFS-1289: Rollback incomptible changes from NFS-872 ([1006f62](https://github.com/Staffbase/widget-sdk/commit/1006f6201cc2dff7159582e8bde3e6674c057ae5))
86
- * 3.3.0-alpha-1 ([39e2983](https://github.com/Staffbase/widget-sdk/commit/39e29831b7dac6b63c62b4b5ed1f787569784931))
87
- * NFS-1289: Make widgetApi non-optional ([faa8223](https://github.com/Staffbase/widget-sdk/commit/faa82235e71210afe984624143f4a774ee94e897))
88
- * NFS-1289: Add getUserList ([e96311b](https://github.com/Staffbase/widget-sdk/commit/e96311b8a81165ac594d42c0a45592845dc8a0a4))
89
- * NFS-1289: Update naming and comments ([e5593d7](https://github.com/Staffbase/widget-sdk/commit/e5593d76deb6deae7386b16a3ae084ddfdb17f87))
90
- * NFS-1289: Add user info type ([ac5e83b](https://github.com/Staffbase/widget-sdk/commit/ac5e83ba585a7b75698a138f820475415abbe50c))
91
- * NFS-1289: Update index ([ef49c3d](https://github.com/Staffbase/widget-sdk/commit/ef49c3dddcf8f37656f1cf61ee54059e9c9e0c87))
92
- * NFS-1289: Add widget api definition ([a16b267](https://github.com/Staffbase/widget-sdk/commit/a16b267805eccbcb354eb6d2020b90ddfc852d5e))
93
- * Update lib/base-block.ts ([39c40ec](https://github.com/Staffbase/widget-sdk/commit/39c40ec298274f6814b7ed9a25622ea71946928a))
94
- * NFS-1002: adds definitions for the parsing of attributes ([08f5675](https://github.com/Staffbase/widget-sdk/commit/08f5675da41be87b6535c5d4a28dfe1d913f0bd4))
161
+ * Merge branch 'nfs-1164-documentation' into beta ([e7cbe2c](https://github.com/Staffbase/widget-sdk/commit/e7cbe2c134682220a6b64232f287dd2d032ee43d))
162
+ * Merge branch 'next' into nfs-1164-documentation ([92881b1](https://github.com/Staffbase/widget-sdk/commit/92881b173480451aa9b6731f336e7b96d30898f3))
163
+ * Merge branch 'beta' of github.com:Staffbase/widget-sdk into beta ([27c2943](https://github.com/Staffbase/widget-sdk/commit/27c2943b15d2ec462fd171dec304e0c99a66c223))
164
+ * **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)
95
165
 
96
- # [3.3.0](https://github.com/Staffbase/widget-sdk/compare/3.2.0...3.3.0) (2021-05-11)
166
+ # [3.3.0-beta.1](https://github.com/Staffbase/widget-sdk/compare/3.2.0...3.3.0-beta.1) (2021-05-11)
97
167
 
98
168
 
99
169
  ### Bug Fixes
@@ -108,12 +178,8 @@
108
178
 
109
179
  * add deleted block attributes file ([8c639df](https://github.com/Staffbase/widget-sdk/commit/8c639dfbe70197be614af7a4a57041d391caf372))
110
180
  * add deleted block attributes file ([629d0c5](https://github.com/Staffbase/widget-sdk/commit/629d0c5276cb065979e0c66b3d849e083d73a032))
111
- * add semantic release ([0dc3400](https://github.com/Staffbase/widget-sdk/commit/0dc340015f62702608b107199b977a13bcebdaa3))
112
181
  * add semantic release ([63e0344](https://github.com/Staffbase/widget-sdk/commit/63e0344939cb24444afab2d1ab0c3553730a5cea))
113
- * change release rules ([32f0520](https://github.com/Staffbase/widget-sdk/commit/32f05208e33801eb925c09d67dcd9ec6ae993b57))
114
182
  * disabled dryrun ([f390c78](https://github.com/Staffbase/widget-sdk/commit/f390c78d85446decc62b0eb9efa1a346bedb32bd))
115
- * fix blocked release ([9283e21](https://github.com/Staffbase/widget-sdk/commit/9283e210a788bee4c72856ecde5125a8daf45298))
116
- * fix blocked release ([857dcac](https://github.com/Staffbase/widget-sdk/commit/857dcac7093892a3035297bc70b693c5c9a3d501))
117
183
  * raise min node version ([c41863d](https://github.com/Staffbase/widget-sdk/commit/c41863d877c210b3ee46d5c7a7db77623b3c93ad))
118
184
  * switched the release plugin ([5c907a6](https://github.com/Staffbase/widget-sdk/commit/5c907a6d46ee77a87b6d71c92dd9e13a3190ab1a))
119
185
  * use default release rules ([5932645](https://github.com/Staffbase/widget-sdk/commit/59326457e0c73ff68762bf130c80c1b5e0b8725e))
@@ -133,8 +199,6 @@
133
199
 
134
200
  ### Miscellaneous
135
201
 
136
- * NFS-1002: adds definitions for the parsing of attributes ([8d5e897](https://github.com/Staffbase/widget-sdk/commit/8d5e897f956f97f03b1b7ebd5190b343db9672e9))
137
- * Merge branch 'next' into NFS-1002-parse-methods ([a4fc6e3](https://github.com/Staffbase/widget-sdk/commit/a4fc6e3b26e2fb89787c4f924235e0fdbb0b4a43))
138
202
  * Make ui schema optional ([3c6e1b1](https://github.com/Staffbase/widget-sdk/commit/3c6e1b104ec99acd97c5febc8ee7544ee5a856fb))
139
203
  * 3.3.0-beta-2 ([5ee39df](https://github.com/Staffbase/widget-sdk/commit/5ee39dff788cdd90054f097f13d8ca27844d53a0))
140
204
  * NFS-989: Add colors to the sdk ([eb59ed1](https://github.com/Staffbase/widget-sdk/commit/eb59ed1c7670f91e8974e1648e354d925c4feae5))
@@ -170,5 +234,3 @@
170
234
  * NFS-1289: Add user info type ([ac5e83b](https://github.com/Staffbase/widget-sdk/commit/ac5e83ba585a7b75698a138f820475415abbe50c))
171
235
  * NFS-1289: Update index ([ef49c3d](https://github.com/Staffbase/widget-sdk/commit/ef49c3dddcf8f37656f1cf61ee54059e9c9e0c87))
172
236
  * NFS-1289: Add widget api definition ([a16b267](https://github.com/Staffbase/widget-sdk/commit/a16b267805eccbcb354eb6d2020b90ddfc852d5e))
173
- * Update lib/base-block.ts ([39c40ec](https://github.com/Staffbase/widget-sdk/commit/39c40ec298274f6814b7ed9a25622ea71946928a))
174
- * NFS-1002: adds definitions for the parsing of attributes ([08f5675](https://github.com/Staffbase/widget-sdk/commit/08f5675da41be87b6535c5d4a28dfe1d913f0bd4))
package/README.md CHANGED
@@ -1,3 +1,36 @@
1
+
1
2
  # Staffbase Widget SDK
2
3
 
3
- Type definitions and utilities for Staffbase widgets.
4
+ This library is a set of TypeScript definitions, which helps you to develop a custom widget for the Staffbase ecosystem.
5
+
6
+
7
+
8
+ ## Installation
9
+
10
+ Install the Widget SDK with npm:
11
+
12
+ ```bash
13
+ npm install -D @staffbase/widget-sdk
14
+ ```
15
+
16
+ Install the Widget SDK with yarn:
17
+
18
+ ```bash
19
+ yarn add -D @staffbase/widget-sdk
20
+ ```
21
+
22
+ ## Documentation
23
+
24
+ The documentation for all the modules can be found in the [docs](./docs/Home.md) folder.
25
+
26
+
27
+ ## Support
28
+
29
+ For support, create an issue in this repository.
30
+
31
+
32
+ ## License
33
+
34
+ [Apache 2.0](https://choosealicense.com/licenses/apache-2.0/)
35
+
36
+
package/catalog-info.yaml ADDED
@@ -0,0 +1,11 @@
1
+ apiVersion: backstage.io/v1alpha1
2
+ kind: Component
3
+ metadata:
4
+ name: widget-sdk
5
+ annotations:
6
+ github.com/project-slug: Staffbase/widget-sdk
7
+ tags:
8
+ - TypeScript
9
+ spec:
10
+ type: service
11
+ lifecycle: production
package/docs/Home.md ADDED
@@ -0,0 +1,74 @@
1
+ # @staffbase/widget-sdk
2
+
3
+ ## Table of contents
4
+
5
+ ### Interfaces
6
+
7
+ - [BaseBlock](../wiki/Interface:%20BaseBlock)
8
+ - [BlockAttributes](../wiki/Interface:%20BlockAttributes)
9
+ - [BlockDefinition](../wiki/Interface:%20BlockDefinition)
10
+ - [BlockElement](../wiki/Interface:%20BlockElement)
11
+ - [ColorTheme](../wiki/Interface:%20ColorTheme)
12
+ - [ExternalBlockDefinition](../wiki/Interface:%20ExternalBlockDefinition)
13
+ - [SBColors](../wiki/Interface:%20SBColors)
14
+ - [SBFileType](../wiki/Interface:%20SBFileType)
15
+ - [SBImageEntity](../wiki/Interface:%20SBImageEntity)
16
+ - [SBUserAvatar](../wiki/Interface:%20SBUserAvatar)
17
+ - [SBUserProfile](../wiki/Interface:%20SBUserProfile)
18
+ - [UserListItem](../wiki/Interface:%20UserListItem)
19
+ - [UserListRequestQuery](../wiki/Interface:%20UserListRequestQuery)
20
+ - [UserListResponse](../wiki/Interface:%20UserListResponse)
21
+ - [WidgetApi](../wiki/Interface:%20WidgetApi)
22
+
23
+ ## Type aliases
24
+
25
+ ### BlockFactory
26
+
27
+ Ƭ **BlockFactory**: (`Base`: () => [*BaseBlock*](../wiki/Interface:%20BaseBlock), `widgetApi`: [*WidgetApi*](../wiki/Interface:%20WidgetApi)) => CustomElementConstructor
28
+
29
+ Factory for the custom widgets.
30
+
31
+ **`param`** base class for the custom widgets to inherit from.
32
+ The class itself is a subclass of `HTMLElement` of the relevant `window` object,
33
+ with additional functionality.
34
+
35
+ **`param`** API providing methods for additional information by the Staffbase framework
36
+
37
+ **`example`**
38
+ const factory: BlockFactory = Base => {
39
+
40
+ return class CustomBlock extends Base {
41
+ constructor() {
42
+ super();
43
+ }
44
+
45
+ // widget implementation follows ...
46
+ }
47
+ };
48
+
49
+ #### Type declaration:
50
+
51
+ ▸ (`Base`: () => [*BaseBlock*](../wiki/Interface:%20BaseBlock), `widgetApi`: [*WidgetApi*](../wiki/Interface:%20WidgetApi)): CustomElementConstructor
52
+
53
+ #### Parameters:
54
+
55
+ | Name | Type |
56
+ | :------ | :------ |
57
+ | `Base` | () => [*BaseBlock*](../wiki/Interface:%20BaseBlock) |
58
+ | `widgetApi` | [*WidgetApi*](../wiki/Interface:%20WidgetApi) |
59
+
60
+ **Returns:** CustomElementConstructor
61
+
62
+ ___
63
+
64
+ ### UserListSorting
65
+
66
+ Ƭ **UserListSorting**: ``"lastname"`` \| ``"created"`` \| ``"updated"``
67
+
68
+ The sorting order of the user list.
69
+
70
+ **`param`** sort response by lastName_ASC_firstName_ASC (default)
71
+
72
+ **`param`** sort by date of creation descending
73
+
74
+ **`param`** sort by date of last update descending