@staffbase/widget-sdk 3.8.0-beta.1 → 3.8.0-beta.2

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 (9) hide show
  1. package/dist/widget-api-types.d.ts +4 -0
  2. package/docs/Home.md +4 -4
  3. package/docs/IntegrationInformation.md +5 -5
  4. package/docs/IntegrationToken.md +2 -2
  5. package/docs/SBUserProfile.md +51 -7
  6. package/docs/UserListItem.md +4 -4
  7. package/docs/UserListRequestQuery.md +4 -4
  8. package/docs/UserListResponse.md +4 -4
  9. package/package.json +1 -1
package/dist/widget-api-types.d.ts CHANGED
@@ -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/docs/Home.md CHANGED
@@ -80,7 +80,7 @@ ___
80
80
 
81
81
  #### Defined in
82
82
 
83
- [lib/widget-api-types.ts:211](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L211)
83
+ [lib/widget-api-types.ts:215](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L215)
84
84
 
85
85
  ___
86
86
 
@@ -90,7 +90,7 @@ ___
90
90
 
91
91
  #### Defined in
92
92
 
93
- [lib/widget-api-types.ts:189](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L189)
93
+ [lib/widget-api-types.ts:193](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L193)
94
94
 
95
95
  ___
96
96
 
@@ -108,7 +108,7 @@ The sorting order of the user list.
108
108
 
109
109
  #### Defined in
110
110
 
111
- [lib/widget-api-types.ts:156](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L156)
111
+ [lib/widget-api-types.ts:160](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L160)
112
112
 
113
113
  ## Variables
114
114
 
@@ -128,4 +128,4 @@ All available states the integration can take
128
128
 
129
129
  #### Defined in
130
130
 
131
- [lib/widget-api-types.ts:205](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L205)
131
+ [lib/widget-api-types.ts:209](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L209)
package/docs/IntegrationInformation.md CHANGED
@@ -23,7 +23,7 @@ Information about the requested Integration target
23
23
 
24
24
  #### Defined in
25
25
 
26
- [lib/widget-api-types.ts:220](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L220)
26
+ [lib/widget-api-types.ts:224](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L224)
27
27
 
28
28
  ___
29
29
 
@@ -33,7 +33,7 @@ ___
33
33
 
34
34
  #### Defined in
35
35
 
36
- [lib/widget-api-types.ts:218](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L218)
36
+ [lib/widget-api-types.ts:222](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L222)
37
37
 
38
38
  ___
39
39
 
@@ -43,7 +43,7 @@ ___
43
43
 
44
44
  #### Defined in
45
45
 
46
- [lib/widget-api-types.ts:222](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L222)
46
+ [lib/widget-api-types.ts:226](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L226)
47
47
 
48
48
  ___
49
49
 
@@ -53,7 +53,7 @@ ___
53
53
 
54
54
  #### Defined in
55
55
 
56
- [lib/widget-api-types.ts:224](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L224)
56
+ [lib/widget-api-types.ts:228](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L228)
57
57
 
58
58
  ## Methods
59
59
 
@@ -67,4 +67,4 @@ ___
67
67
 
68
68
  #### Defined in
69
69
 
70
- [lib/widget-api-types.ts:226](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L226)
70
+ [lib/widget-api-types.ts:230](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L230)
package/docs/IntegrationToken.md CHANGED
@@ -17,7 +17,7 @@ Integration Token including the expiration time
17
17
 
18
18
  #### Defined in
19
19
 
20
- [lib/widget-api-types.ts:196](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L196)
20
+ [lib/widget-api-types.ts:200](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L200)
21
21
 
22
22
  ___
23
23
 
@@ -27,4 +27,4 @@ ___
27
27
 
28
28
  #### Defined in
29
29
 
30
- [lib/widget-api-types.ts:199](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L199)
30
+ [lib/widget-api-types.ts:203](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L203)
package/docs/SBUserProfile.md CHANGED
@@ -8,11 +8,15 @@ User profile data
8
8
 
9
9
  - [avatar](../wiki/SBUserProfile#avatar)
10
10
  - [department](../wiki/SBUserProfile#department)
11
+ - [externalID](../wiki/SBUserProfile#externalid)
11
12
  - [firstName](../wiki/SBUserProfile#firstname)
13
+ - [id](../wiki/SBUserProfile#id)
12
14
  - [lastName](../wiki/SBUserProfile#lastname)
13
15
  - [location](../wiki/SBUserProfile#location)
14
16
  - [phoneNumber](../wiki/SBUserProfile#phonenumber)
15
17
  - [position](../wiki/SBUserProfile#position)
18
+ - [primaryEmail](../wiki/SBUserProfile#primaryemail)
19
+ - [primaryUsername](../wiki/SBUserProfile#primaryusername)
16
20
  - [publicEmailAddress](../wiki/SBUserProfile#publicemailaddress)
17
21
 
18
22
  ## Properties
@@ -23,7 +27,7 @@ User profile data
23
27
 
24
28
  #### Defined in
25
29
 
26
- [lib/widget-api-types.ts:145](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L145)
30
+ [lib/widget-api-types.ts:147](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L147)
27
31
 
28
32
  ___
29
33
 
@@ -33,7 +37,17 @@ ___
33
37
 
34
38
  #### Defined in
35
39
 
36
- [lib/widget-api-types.ts:146](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L146)
40
+ [lib/widget-api-types.ts:148](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L148)
41
+
42
+ ___
43
+
44
+ ### externalID
45
+
46
+ • `Optional` **externalID**: `string`
47
+
48
+ #### Defined in
49
+
50
+ [lib/widget-api-types.ts:140](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L140)
37
51
 
38
52
  ___
39
53
 
@@ -43,6 +57,16 @@ ___
43
57
 
44
58
  #### Defined in
45
59
 
60
+ [lib/widget-api-types.ts:141](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L141)
61
+
62
+ ___
63
+
64
+ ### id
65
+
66
+ • **id**: `string`
67
+
68
+ #### Defined in
69
+
46
70
  [lib/widget-api-types.ts:139](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L139)
47
71
 
48
72
  ___
@@ -53,7 +77,7 @@ ___
53
77
 
54
78
  #### Defined in
55
79
 
56
- [lib/widget-api-types.ts:140](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L140)
80
+ [lib/widget-api-types.ts:142](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L142)
57
81
 
58
82
  ___
59
83
 
@@ -63,7 +87,7 @@ ___
63
87
 
64
88
  #### Defined in
65
89
 
66
- [lib/widget-api-types.ts:143](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L143)
90
+ [lib/widget-api-types.ts:145](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L145)
67
91
 
68
92
  ___
69
93
 
@@ -73,7 +97,7 @@ ___
73
97
 
74
98
  #### Defined in
75
99
 
76
- [lib/widget-api-types.ts:141](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L141)
100
+ [lib/widget-api-types.ts:143](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L143)
77
101
 
78
102
  ___
79
103
 
@@ -83,7 +107,27 @@ ___
83
107
 
84
108
  #### Defined in
85
109
 
86
- [lib/widget-api-types.ts:144](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L144)
110
+ [lib/widget-api-types.ts:146](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L146)
111
+
112
+ ___
113
+
114
+ ### primaryEmail
115
+
116
+ • `Optional` **primaryEmail**: `string`
117
+
118
+ #### Defined in
119
+
120
+ [lib/widget-api-types.ts:149](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L149)
121
+
122
+ ___
123
+
124
+ ### primaryUsername
125
+
126
+ • `Optional` **primaryUsername**: `string`
127
+
128
+ #### Defined in
129
+
130
+ [lib/widget-api-types.ts:150](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L150)
87
131
 
88
132
  ___
89
133
 
@@ -93,4 +137,4 @@ ___
93
137
 
94
138
  #### Defined in
95
139
 
96
- [lib/widget-api-types.ts:142](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L142)
140
+ [lib/widget-api-types.ts:144](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L144)
package/docs/UserListItem.md CHANGED
@@ -19,7 +19,7 @@ Single user item
19
19
 
20
20
  #### Defined in
21
21
 
22
- [lib/widget-api-types.ts:175](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L175)
22
+ [lib/widget-api-types.ts:179](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L179)
23
23
 
24
24
  ___
25
25
 
@@ -29,7 +29,7 @@ ___
29
29
 
30
30
  #### Defined in
31
31
 
32
- [lib/widget-api-types.ts:173](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L173)
32
+ [lib/widget-api-types.ts:177](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L177)
33
33
 
34
34
  ___
35
35
 
@@ -39,7 +39,7 @@ ___
39
39
 
40
40
  #### Defined in
41
41
 
42
- [lib/widget-api-types.ts:172](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L172)
42
+ [lib/widget-api-types.ts:176](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L176)
43
43
 
44
44
  ___
45
45
 
@@ -49,4 +49,4 @@ ___
49
49
 
50
50
  #### Defined in
51
51
 
52
- [lib/widget-api-types.ts:174](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L174)
52
+ [lib/widget-api-types.ts:178](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L178)
package/docs/UserListRequestQuery.md CHANGED
@@ -19,7 +19,7 @@ User list request parameters
19
19
 
20
20
  #### Defined in
21
21
 
22
- [lib/widget-api-types.ts:165](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L165)
22
+ [lib/widget-api-types.ts:169](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L169)
23
23
 
24
24
  ___
25
25
 
@@ -29,7 +29,7 @@ ___
29
29
 
30
30
  #### Defined in
31
31
 
32
- [lib/widget-api-types.ts:162](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L162)
32
+ [lib/widget-api-types.ts:166](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L166)
33
33
 
34
34
  ___
35
35
 
@@ -39,7 +39,7 @@ ___
39
39
 
40
40
  #### Defined in
41
41
 
42
- [lib/widget-api-types.ts:163](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L163)
42
+ [lib/widget-api-types.ts:167](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L167)
43
43
 
44
44
  ___
45
45
 
@@ -49,4 +49,4 @@ ___
49
49
 
50
50
  #### Defined in
51
51
 
52
- [lib/widget-api-types.ts:164](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L164)
52
+ [lib/widget-api-types.ts:168](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L168)
package/docs/UserListResponse.md CHANGED
@@ -19,7 +19,7 @@ Responded user list
19
19
 
20
20
  #### Defined in
21
21
 
22
- [lib/widget-api-types.ts:182](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L182)
22
+ [lib/widget-api-types.ts:186](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L186)
23
23
 
24
24
  ___
25
25
 
@@ -29,7 +29,7 @@ ___
29
29
 
30
30
  #### Defined in
31
31
 
32
- [lib/widget-api-types.ts:184](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L184)
32
+ [lib/widget-api-types.ts:188](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L188)
33
33
 
34
34
  ___
35
35
 
@@ -39,7 +39,7 @@ ___
39
39
 
40
40
  #### Defined in
41
41
 
42
- [lib/widget-api-types.ts:183](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L183)
42
+ [lib/widget-api-types.ts:187](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L187)
43
43
 
44
44
  ___
45
45
 
@@ -49,4 +49,4 @@ ___
49
49
 
50
50
  #### Defined in
51
51
 
52
- [lib/widget-api-types.ts:185](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L185)
52
+ [lib/widget-api-types.ts:189](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L189)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@staffbase/widget-sdk",
3
- "version": "3.8.0-beta.1",
3
+ "version": "3.8.0-beta.2",
4
4
  "description": "Staffbase SDK for Custom Widgets",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",