@staffbase/widget-sdk 3.7.3 → 3.8.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 +1 -1
- package/dist/widget-api-types.d.ts +4 -0
- package/package.json +2 -3
- package/docs/.nojekyll +0 -1
- package/docs/BaseBlock.md +0 -5887
- package/docs/BlockAttributes.md +0 -21
- package/docs/BlockDefinition.md +0 -167
- package/docs/BlockElement.md +0 -103
- package/docs/ColorTheme.md +0 -97
- package/docs/ExternalBlockDefinition.md +0 -58
- package/docs/Home.md +0 -131
- package/docs/IntegrationInformation.md +0 -70
- package/docs/IntegrationToken.md +0 -30
- package/docs/SBColors.md +0 -639
- package/docs/SBFileType.md +0 -74
- package/docs/SBImageEntity.md +0 -74
- package/docs/SBUserAvatar.md +0 -52
- package/docs/SBUserProfile.md +0 -96
- package/docs/UserListItem.md +0 -52
- package/docs/UserListRequestQuery.md +0 -52
- package/docs/UserListResponse.md +0 -52
- package/docs/WidgetApi.md +0 -138
- package/docs/_Sidebar.md +0 -3
package/README.md
CHANGED
|
@@ -21,7 +21,7 @@ Install the Widget SDK with yarn:
|
|
|
21
21
|
|
|
22
22
|
## Documentation
|
|
23
23
|
|
|
24
|
-
The documentation for all the modules can be found in the [
|
|
24
|
+
The documentation for all the modules can be found in the [wiki](./wiki/Home.md) folder.
|
|
25
25
|
|
|
26
26
|
|
|
27
27
|
## Support
|
|
@@ -130,6 +130,8 @@ export interface SBUserAvatar {
|
|
|
130
130
|
* User profile data
|
|
131
131
|
*/
|
|
132
132
|
export interface SBUserProfile {
|
|
133
|
+
id: string;
|
|
134
|
+
externalID?: string;
|
|
133
135
|
firstName: string;
|
|
134
136
|
lastName: string;
|
|
135
137
|
phoneNumber?: string;
|
|
@@ -138,6 +140,8 @@ export interface SBUserProfile {
|
|
|
138
140
|
position?: string;
|
|
139
141
|
avatar?: SBUserAvatar;
|
|
140
142
|
department?: string;
|
|
143
|
+
primaryEmail?: string;
|
|
144
|
+
primaryUsername?: string;
|
|
141
145
|
}
|
|
142
146
|
/**
|
|
143
147
|
* The sorting order of the user list.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@staffbase/widget-sdk",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.8.0",
|
|
4
4
|
"description": "Staffbase SDK for Custom Widgets",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"module": "./dist/index.mjs",
|
|
@@ -10,8 +10,7 @@
|
|
|
10
10
|
"web-components"
|
|
11
11
|
],
|
|
12
12
|
"scripts": {
|
|
13
|
-
"
|
|
14
|
-
"doc": "npm run clean-doc && typedoc --theme github-wiki --readme none --out docs lib/index.ts",
|
|
13
|
+
"doc": "typedoc --theme github-wiki --readme none --out docs lib/index.ts",
|
|
15
14
|
"build": "npx tsc & npx esbuild lib/index.ts --bundle --format=cjs --outfile=dist/index.js & npx esbuild lib/index.ts --bundle --format=esm --outfile=dist/index.mjs",
|
|
16
15
|
"release": "semantic-release",
|
|
17
16
|
"prepare": "husky install"
|
package/docs/.nojekyll
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
|