@staffbase/widget-sdk 3.4.0-alpha.13 → 3.4.0-beta.10
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/dist/index.d.ts +9 -9
- package/dist/index.js +48 -9
- package/dist/{base-block.js → index.mjs} +9 -1
- package/dist/widget-api-types.d.ts +6 -5
- package/docs/BaseBlock.md +7 -7
- package/docs/BlockAttributes.md +1 -1
- package/docs/BlockDefinition.md +9 -9
- package/docs/BlockElement.md +5 -5
- package/docs/ColorTheme.md +8 -8
- package/docs/ExternalBlockDefinition.md +3 -3
- package/docs/Home.md +38 -7
- package/docs/IntegrationInformation.md +6 -6
- package/docs/IntegrationToken.md +2 -2
- package/docs/SBColors.md +56 -56
- package/docs/SBFileType.md +6 -6
- package/docs/SBImageEntity.md +6 -6
- package/docs/SBUserAvatar.md +4 -4
- package/docs/SBUserProfile.md +8 -8
- package/docs/UserListItem.md +4 -4
- package/docs/UserListRequestQuery.md +4 -4
- package/docs/UserListResponse.md +4 -4
- package/docs/WidgetApi.md +5 -5
- package/package.json +5 -3
- package/dist/block-attributes.js +0 -13
- package/dist/block-definition.js +0 -13
- package/dist/block-element.js +0 -13
- package/dist/block-factory.js +0 -13
- package/dist/external-block-definition.js +0 -13
- package/dist/global.js +0 -13
- package/dist/widget-api-types.js +0 -21
- package/dist/widget-api.js +0 -13
- package/docs/IntegrationState.md +0 -41
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/
|
|
22
|
+
[lib/widget-api-types.ts:175](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L175)
|
|
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/
|
|
32
|
+
[lib/widget-api-types.ts:173](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L173)
|
|
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/
|
|
42
|
+
[lib/widget-api-types.ts:172](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L172)
|
|
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/
|
|
52
|
+
[lib/widget-api-types.ts:174](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L174)
|
|
@@ -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/
|
|
22
|
+
[lib/widget-api-types.ts:165](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L165)
|
|
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/
|
|
32
|
+
[lib/widget-api-types.ts:162](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L162)
|
|
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/
|
|
42
|
+
[lib/widget-api-types.ts:163](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L163)
|
|
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/
|
|
52
|
+
[lib/widget-api-types.ts:164](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L164)
|
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/
|
|
22
|
+
[lib/widget-api-types.ts:182](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L182)
|
|
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/
|
|
32
|
+
[lib/widget-api-types.ts:184](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L184)
|
|
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/
|
|
42
|
+
[lib/widget-api-types.ts:183](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L183)
|
|
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/
|
|
52
|
+
[lib/widget-api-types.ts:185](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api-types.ts#L185)
|
package/docs/WidgetApi.md
CHANGED
|
@@ -45,7 +45,7 @@ In case of an error, the promise is rejected.
|
|
|
45
45
|
|
|
46
46
|
#### Defined in
|
|
47
47
|
|
|
48
|
-
[lib/widget-api.ts:74](https://github.com/Staffbase/widget-sdk/blob/
|
|
48
|
+
[lib/widget-api.ts:74](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api.ts#L74)
|
|
49
49
|
|
|
50
50
|
___
|
|
51
51
|
|
|
@@ -64,7 +64,7 @@ An object containing the color theme data is returned.
|
|
|
64
64
|
|
|
65
65
|
#### Defined in
|
|
66
66
|
|
|
67
|
-
[lib/widget-api.ts:29](https://github.com/Staffbase/widget-sdk/blob/
|
|
67
|
+
[lib/widget-api.ts:29](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api.ts#L29)
|
|
68
68
|
|
|
69
69
|
___
|
|
70
70
|
|
|
@@ -89,7 +89,7 @@ the promise is rejected.
|
|
|
89
89
|
|
|
90
90
|
#### Defined in
|
|
91
91
|
|
|
92
|
-
[lib/widget-api.ts:38](https://github.com/Staffbase/widget-sdk/blob/
|
|
92
|
+
[lib/widget-api.ts:38](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api.ts#L38)
|
|
93
93
|
|
|
94
94
|
___
|
|
95
95
|
|
|
@@ -114,7 +114,7 @@ the promise is rejected.
|
|
|
114
114
|
|
|
115
115
|
#### Defined in
|
|
116
116
|
|
|
117
|
-
[lib/widget-api.ts:47](https://github.com/Staffbase/widget-sdk/blob/
|
|
117
|
+
[lib/widget-api.ts:47](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api.ts#L47)
|
|
118
118
|
|
|
119
119
|
___
|
|
120
120
|
|
|
@@ -139,4 +139,4 @@ the promise is rejected.
|
|
|
139
139
|
|
|
140
140
|
#### Defined in
|
|
141
141
|
|
|
142
|
-
[lib/widget-api.ts:56](https://github.com/Staffbase/widget-sdk/blob/
|
|
142
|
+
[lib/widget-api.ts:56](https://github.com/Staffbase/widget-sdk/blob/beta/lib/widget-api.ts#L56)
|
package/package.json
CHANGED
|
@@ -1,11 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@staffbase/widget-sdk",
|
|
3
|
-
"version": "3.4.0-
|
|
3
|
+
"version": "3.4.0-beta.10",
|
|
4
4
|
"description": "Staffbase SDK for Custom Widgets",
|
|
5
|
-
"module": "./dist/index.js",
|
|
6
5
|
"main": "./dist/index.js",
|
|
7
6
|
"exports": "./dist/index.js",
|
|
8
|
-
"
|
|
7
|
+
"module": "./dist/index.mjs",
|
|
8
|
+
"types": "./dist/index.d.ts",
|
|
9
9
|
"type": "module",
|
|
10
10
|
"keywords": [
|
|
11
11
|
"web-components"
|
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
"scripts": {
|
|
14
14
|
"clean-doc": "npx rimraf docs",
|
|
15
15
|
"doc": "npm run clean-doc && typedoc --theme github-wiki --readme none --out docs lib/index.ts",
|
|
16
|
+
"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
17
|
"release": "semantic-release",
|
|
17
18
|
"prepare": "husky install"
|
|
18
19
|
},
|
|
@@ -28,6 +29,7 @@
|
|
|
28
29
|
"@commitlint/config-conventional": "16.0.0",
|
|
29
30
|
"@tmware/semantic-release-npm-github-publish": "1.5.0",
|
|
30
31
|
"@types/react": "^17.0.38",
|
|
32
|
+
"esbuild": "0.14.20",
|
|
31
33
|
"husky": "^7.0.4",
|
|
32
34
|
"semantic-release": "^19.0.2",
|
|
33
35
|
"typedoc": "0.22.11",
|
package/dist/block-attributes.js
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright 2021, Staffbase GmbH and contributors.
|
|
3
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
-
* you may not use this file except in compliance with the License.
|
|
5
|
-
* You may obtain a copy of the License at
|
|
6
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
7
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
8
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
9
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
10
|
-
* See the License for the specific language governing permissions and
|
|
11
|
-
* limitations under the License.
|
|
12
|
-
*/
|
|
13
|
-
export {};
|
package/dist/block-definition.js
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright 2021, Staffbase GmbH and contributors.
|
|
3
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
-
* you may not use this file except in compliance with the License.
|
|
5
|
-
* You may obtain a copy of the License at
|
|
6
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
7
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
8
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
9
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
10
|
-
* See the License for the specific language governing permissions and
|
|
11
|
-
* limitations under the License.
|
|
12
|
-
*/
|
|
13
|
-
export {};
|
package/dist/block-element.js
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright 2021, Staffbase GmbH and contributors.
|
|
3
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
-
* you may not use this file except in compliance with the License.
|
|
5
|
-
* You may obtain a copy of the License at
|
|
6
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
7
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
8
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
9
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
10
|
-
* See the License for the specific language governing permissions and
|
|
11
|
-
* limitations under the License.
|
|
12
|
-
*/
|
|
13
|
-
export {};
|
package/dist/block-factory.js
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright 2021, Staffbase GmbH and contributors.
|
|
3
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
-
* you may not use this file except in compliance with the License.
|
|
5
|
-
* You may obtain a copy of the License at
|
|
6
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
7
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
8
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
9
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
10
|
-
* See the License for the specific language governing permissions and
|
|
11
|
-
* limitations under the License.
|
|
12
|
-
*/
|
|
13
|
-
export {};
|
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright 2021, Staffbase GmbH and contributors.
|
|
3
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
-
* you may not use this file except in compliance with the License.
|
|
5
|
-
* You may obtain a copy of the License at
|
|
6
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
7
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
8
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
9
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
10
|
-
* See the License for the specific language governing permissions and
|
|
11
|
-
* limitations under the License.
|
|
12
|
-
*/
|
|
13
|
-
export {};
|
package/dist/global.js
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright 2021, Staffbase GmbH and contributors.
|
|
3
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
-
* you may not use this file except in compliance with the License.
|
|
5
|
-
* You may obtain a copy of the License at
|
|
6
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
7
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
8
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
9
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
10
|
-
* See the License for the specific language governing permissions and
|
|
11
|
-
* limitations under the License.
|
|
12
|
-
*/
|
|
13
|
-
export {};
|
package/dist/widget-api-types.js
DELETED
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright 2021, Staffbase GmbH and contributors.
|
|
3
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
-
* you may not use this file except in compliance with the License.
|
|
5
|
-
* You may obtain a copy of the License at
|
|
6
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
7
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
8
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
9
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
10
|
-
* See the License for the specific language governing permissions and
|
|
11
|
-
* limitations under the License.
|
|
12
|
-
*/
|
|
13
|
-
/**
|
|
14
|
-
* All available states the integration can take
|
|
15
|
-
*/
|
|
16
|
-
export var IntegrationState;
|
|
17
|
-
(function (IntegrationState) {
|
|
18
|
-
IntegrationState["UNAVAILABLE"] = "unavailable";
|
|
19
|
-
IntegrationState["AVAILABLE"] = "available";
|
|
20
|
-
IntegrationState["LOGGED_OUT"] = "loggedOut";
|
|
21
|
-
})(IntegrationState || (IntegrationState = {}));
|
package/dist/widget-api.js
DELETED
|
@@ -1,13 +0,0 @@
|
|
|
1
|
-
/*!
|
|
2
|
-
* Copyright 2021, Staffbase GmbH and contributors.
|
|
3
|
-
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
-
* you may not use this file except in compliance with the License.
|
|
5
|
-
* You may obtain a copy of the License at
|
|
6
|
-
* http://www.apache.org/licenses/LICENSE-2.0
|
|
7
|
-
* Unless required by applicable law or agreed to in writing, software
|
|
8
|
-
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
9
|
-
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
10
|
-
* See the License for the specific language governing permissions and
|
|
11
|
-
* limitations under the License.
|
|
12
|
-
*/
|
|
13
|
-
export {};
|
package/docs/IntegrationState.md
DELETED
|
@@ -1,41 +0,0 @@
|
|
|
1
|
-
# Enumeration: IntegrationState
|
|
2
|
-
|
|
3
|
-
All available states the integration can take
|
|
4
|
-
|
|
5
|
-
## Table of contents
|
|
6
|
-
|
|
7
|
-
### Enumeration members
|
|
8
|
-
|
|
9
|
-
- [AVAILABLE](../wiki/IntegrationState#available)
|
|
10
|
-
- [LOGGED\_OUT](../wiki/IntegrationState#logged_out)
|
|
11
|
-
- [UNAVAILABLE](../wiki/IntegrationState#unavailable)
|
|
12
|
-
|
|
13
|
-
## Enumeration members
|
|
14
|
-
|
|
15
|
-
### AVAILABLE
|
|
16
|
-
|
|
17
|
-
• **AVAILABLE** = `"available"`
|
|
18
|
-
|
|
19
|
-
#### Defined in
|
|
20
|
-
|
|
21
|
-
[lib/widget-api-types.ts:207](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L207)
|
|
22
|
-
|
|
23
|
-
___
|
|
24
|
-
|
|
25
|
-
### LOGGED\_OUT
|
|
26
|
-
|
|
27
|
-
• **LOGGED\_OUT** = `"loggedOut"`
|
|
28
|
-
|
|
29
|
-
#### Defined in
|
|
30
|
-
|
|
31
|
-
[lib/widget-api-types.ts:208](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L208)
|
|
32
|
-
|
|
33
|
-
___
|
|
34
|
-
|
|
35
|
-
### UNAVAILABLE
|
|
36
|
-
|
|
37
|
-
• **UNAVAILABLE** = `"unavailable"`
|
|
38
|
-
|
|
39
|
-
#### Defined in
|
|
40
|
-
|
|
41
|
-
[lib/widget-api-types.ts:206](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L206)
|