@staffbase/widget-sdk 3.3.4 → 3.3.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.
Files changed (35) hide show
  1. package/.github/workflows/ci.yaml +1 -1
  2. package/CHANGELOG.md +24 -0
  3. package/docs/.nojekyll +1 -0
  4. package/docs/BaseBlock.md +4629 -0
  5. package/docs/BlockAttributes.md +17 -0
  6. package/docs/{Interface: BlockDefinition.md → BlockDefinition.md} +25 -11
  7. package/docs/BlockElement.md +83 -0
  8. package/docs/ColorTheme.md +65 -0
  9. package/docs/ExternalBlockDefinition.md +46 -0
  10. package/docs/Home.md +32 -31
  11. package/docs/SBColors.md +415 -0
  12. package/docs/SBFileType.md +50 -0
  13. package/docs/SBImageEntity.md +50 -0
  14. package/docs/SBUserAvatar.md +36 -0
  15. package/docs/SBUserProfile.md +64 -0
  16. package/docs/UserListItem.md +36 -0
  17. package/docs/UserListRequestQuery.md +36 -0
  18. package/docs/UserListResponse.md +36 -0
  19. package/docs/WidgetApi.md +92 -0
  20. package/docs/_Sidebar.md +2 -19
  21. package/package.json +15 -15
  22. package/docs/Interface: BaseBlock.md +0 -3226
  23. package/docs/Interface: BlockAttributes.md +0 -11
  24. package/docs/Interface: BlockElement.md +0 -89
  25. package/docs/Interface: ColorTheme.md +0 -52
  26. package/docs/Interface: ExternalBlockDefinition.md +0 -38
  27. package/docs/Interface: SBColors.md +0 -354
  28. package/docs/Interface: SBFileType.md +0 -39
  29. package/docs/Interface: SBImageEntity.md +0 -39
  30. package/docs/Interface: SBUserAvatar.md +0 -27
  31. package/docs/Interface: SBUserProfile.md +0 -51
  32. package/docs/Interface: UserListItem.md +0 -27
  33. package/docs/Interface: UserListRequestQuery.md +0 -27
  34. package/docs/Interface: UserListResponse.md +0 -27
  35. package/docs/Interface: WidgetApi.md +0 -75
package/docs/Interface: UserListRequestQuery.md DELETED
@@ -1,27 +0,0 @@
1
- # Interface: UserListRequestQuery
2
-
3
- User list request parameters
4
-
5
- ## Properties
6
-
7
- ### filter
8
-
9
- • `Optional` **filter**: *string*
10
-
11
- ___
12
-
13
- ### limit
14
-
15
- • `Optional` **limit**: *number*
16
-
17
- ___
18
-
19
- ### offset
20
-
21
- • `Optional` **offset**: *number*
22
-
23
- ___
24
-
25
- ### sort
26
-
27
- • `Optional` **sort**: [*UserListSorting*](../wiki/Home#userlistsorting)
package/docs/Interface: UserListResponse.md DELETED
@@ -1,27 +0,0 @@
1
- # Interface: UserListResponse
2
-
3
- Responded user list
4
-
5
- ## Properties
6
-
7
- ### data
8
-
9
- • **data**: [*UserListItem*](../wiki/Interface:%20UserListItem)[]
10
-
11
- ___
12
-
13
- ### limit
14
-
15
- • **limit**: *number*
16
-
17
- ___
18
-
19
- ### offset
20
-
21
- • **offset**: *number*
22
-
23
- ___
24
-
25
- ### total
26
-
27
- • **total**: *number*
package/docs/Interface: WidgetApi.md DELETED
@@ -1,75 +0,0 @@
1
- # Interface: WidgetApi
2
-
3
- Widget API class.
4
-
5
- A class providing access to additional information about the Staffbase ecosystem for widgets.
6
-
7
- ## Methods
8
-
9
- ### getLegacyAppTheme
10
-
11
- ▸ **getLegacyAppTheme**(): [*ColorTheme*](../wiki/Interface:%20ColorTheme)
12
-
13
- Call to retrieve the color theme of the app. Since this theme definitions
14
- are currently redesigned, this method is called legacy.
15
-
16
- **Returns:** [*ColorTheme*](../wiki/Interface:%20ColorTheme)
17
-
18
- An object containing the color theme data is returned.
19
-
20
- ___
21
-
22
- ### getUserInformation
23
-
24
- ▸ **getUserInformation**(`userId?`: *string*): *Promise*<[*SBUserProfile*](../wiki/Interface:%20SBUserProfile)\>
25
-
26
- Call to retrieve the user profile of the current or a specific user.
27
-
28
- #### Parameters:
29
-
30
- | Name | Type | Description |
31
- | :------ | :------ | :------ |
32
- | `userId?` | *string* | User ID to lookup for; leave blank to retrieve current user |
33
-
34
- **Returns:** *Promise*<[*SBUserProfile*](../wiki/Interface:%20SBUserProfile)\>
35
-
36
- A promise containing the SBUserProfile is returned. In case of an error,
37
- the promise is rejected.
38
-
39
- ___
40
-
41
- ### getUserInformationByExternalId
42
-
43
- ▸ **getUserInformationByExternalId**(`externalId`: *string*): *Promise*<[*SBUserProfile*](../wiki/Interface:%20SBUserProfile)\>
44
-
45
- Call to retrieve a user profile by its external ID.
46
-
47
- #### Parameters:
48
-
49
- | Name | Type | Description |
50
- | :------ | :------ | :------ |
51
- | `externalId` | *string* | An external ID of the user that shall be returned |
52
-
53
- **Returns:** *Promise*<[*SBUserProfile*](../wiki/Interface:%20SBUserProfile)\>
54
-
55
- A promise containing the SBUserProfile is returned. In case of an error,
56
- the promise is rejected.
57
-
58
- ___
59
-
60
- ### getUserList
61
-
62
- ▸ **getUserList**(`query`: [*UserListRequestQuery*](../wiki/Interface:%20UserListRequestQuery)): *Promise*<[*UserListResponse*](../wiki/Interface:%20UserListResponse)\>
63
-
64
- Call to retrieve a list of users determined by the query object.
65
-
66
- #### Parameters:
67
-
68
- | Name | Type | Description |
69
- | :------ | :------ | :------ |
70
- | `query` | [*UserListRequestQuery*](../wiki/Interface:%20UserListRequestQuery) | Adjust limit, offset, filter, and sorting for the request |
71
-
72
- **Returns:** *Promise*<[*UserListResponse*](../wiki/Interface:%20UserListResponse)\>
73
-
74
- A promise containing the UserListResponse is returned. In case of an error,
75
- the promise is rejected.