@staffbase/widget-sdk 3.4.0-beta.6 → 3.4.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/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/dist/index.d.ts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
export * from './base-block
|
|
2
|
-
export * from './block-attributes
|
|
3
|
-
export * from './block-definition
|
|
4
|
-
export * from './block-element
|
|
5
|
-
export * from './block-factory
|
|
6
|
-
export * from './external-block-definition
|
|
7
|
-
export * from './widget-api-types
|
|
8
|
-
export * from './widget-api
|
|
9
|
-
export * from './global
|
|
1
|
+
export * from './base-block';
|
|
2
|
+
export * from './block-attributes';
|
|
3
|
+
export * from './block-definition';
|
|
4
|
+
export * from './block-element';
|
|
5
|
+
export * from './block-factory';
|
|
6
|
+
export * from './external-block-definition';
|
|
7
|
+
export * from './widget-api-types';
|
|
8
|
+
export * from './widget-api';
|
|
9
|
+
export * from './global';
|
package/dist/index.js
CHANGED
|
@@ -1,9 +1,48 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
1
|
+
var __defProp = Object.defineProperty;
|
|
2
|
+
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
3
|
+
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
4
|
+
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
5
|
+
var __markAsModule = (target) => __defProp(target, "__esModule", { value: true });
|
|
6
|
+
var __export = (target, all) => {
|
|
7
|
+
for (var name in all)
|
|
8
|
+
__defProp(target, name, { get: all[name], enumerable: true });
|
|
9
|
+
};
|
|
10
|
+
var __reExport = (target, module2, copyDefault, desc) => {
|
|
11
|
+
if (module2 && typeof module2 === "object" || typeof module2 === "function") {
|
|
12
|
+
for (let key of __getOwnPropNames(module2))
|
|
13
|
+
if (!__hasOwnProp.call(target, key) && (copyDefault || key !== "default"))
|
|
14
|
+
__defProp(target, key, { get: () => module2[key], enumerable: !(desc = __getOwnPropDesc(module2, key)) || desc.enumerable });
|
|
15
|
+
}
|
|
16
|
+
return target;
|
|
17
|
+
};
|
|
18
|
+
var __toCommonJS = /* @__PURE__ */ ((cache) => {
|
|
19
|
+
return (module2, temp) => {
|
|
20
|
+
return cache && cache.get(module2) || (temp = __reExport(__markAsModule({}), module2, 1), cache && cache.set(module2, temp), temp);
|
|
21
|
+
};
|
|
22
|
+
})(typeof WeakMap !== "undefined" ? /* @__PURE__ */ new WeakMap() : 0);
|
|
23
|
+
|
|
24
|
+
// lib/index.ts
|
|
25
|
+
var lib_exports = {};
|
|
26
|
+
__export(lib_exports, {
|
|
27
|
+
IntegrationStates: () => IntegrationStates
|
|
28
|
+
});
|
|
29
|
+
|
|
30
|
+
// lib/widget-api-types.ts
|
|
31
|
+
var IntegrationStates = {
|
|
32
|
+
UNAVAILABLE: "unavailable",
|
|
33
|
+
AVAILABLE: "available",
|
|
34
|
+
LOGGED_OUT: "loggedOut"
|
|
35
|
+
};
|
|
36
|
+
module.exports = __toCommonJS(lib_exports);
|
|
37
|
+
/*!
|
|
38
|
+
* Copyright 2021, Staffbase GmbH and contributors.
|
|
39
|
+
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
40
|
+
* you may not use this file except in compliance with the License.
|
|
41
|
+
* You may obtain a copy of the License at
|
|
42
|
+
* http://www.apache.org/licenses/LICENSE-2.0
|
|
43
|
+
* Unless required by applicable law or agreed to in writing, software
|
|
44
|
+
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
45
|
+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
46
|
+
* See the License for the specific language governing permissions and
|
|
47
|
+
* limitations under the License.
|
|
48
|
+
*/
|
|
@@ -1,3 +1,12 @@
|
|
|
1
|
+
// lib/widget-api-types.ts
|
|
2
|
+
var IntegrationStates = {
|
|
3
|
+
UNAVAILABLE: "unavailable",
|
|
4
|
+
AVAILABLE: "available",
|
|
5
|
+
LOGGED_OUT: "loggedOut"
|
|
6
|
+
};
|
|
7
|
+
export {
|
|
8
|
+
IntegrationStates
|
|
9
|
+
};
|
|
1
10
|
/*!
|
|
2
11
|
* Copyright 2021, Staffbase GmbH and contributors.
|
|
3
12
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
@@ -10,4 +19,3 @@
|
|
|
10
19
|
* See the License for the specific language governing permissions and
|
|
11
20
|
* limitations under the License.
|
|
12
21
|
*/
|
|
13
|
-
export {};
|
|
@@ -185,11 +185,12 @@ export interface IntegrationToken {
|
|
|
185
185
|
/**
|
|
186
186
|
* All available states the integration can take
|
|
187
187
|
*/
|
|
188
|
-
export declare
|
|
189
|
-
UNAVAILABLE
|
|
190
|
-
AVAILABLE
|
|
191
|
-
LOGGED_OUT
|
|
192
|
-
}
|
|
188
|
+
export declare const IntegrationStates: {
|
|
189
|
+
readonly UNAVAILABLE: "unavailable";
|
|
190
|
+
readonly AVAILABLE: "available";
|
|
191
|
+
readonly LOGGED_OUT: "loggedOut";
|
|
192
|
+
};
|
|
193
|
+
export declare type IntegrationState = typeof IntegrationStates[keyof typeof IntegrationStates];
|
|
193
194
|
/**
|
|
194
195
|
* Information about the requested Integration target
|
|
195
196
|
*/
|
package/docs/BaseBlock.md
CHANGED
|
@@ -1355,7 +1355,7 @@ to that language.
|
|
|
1355
1355
|
|
|
1356
1356
|
#### Defined in
|
|
1357
1357
|
|
|
1358
|
-
[lib/base-block.ts:108](https://github.com/Staffbase/widget-sdk/blob/
|
|
1358
|
+
[lib/base-block.ts:108](https://github.com/Staffbase/widget-sdk/blob/next/lib/base-block.ts#L108)
|
|
1359
1359
|
|
|
1360
1360
|
___
|
|
1361
1361
|
|
|
@@ -3827,7 +3827,7 @@ order to let the base class know about the arguments that it might be interested
|
|
|
3827
3827
|
|
|
3828
3828
|
#### Defined in
|
|
3829
3829
|
|
|
3830
|
-
[lib/base-block.ts:65](https://github.com/Staffbase/widget-sdk/blob/
|
|
3830
|
+
[lib/base-block.ts:65](https://github.com/Staffbase/widget-sdk/blob/next/lib/base-block.ts#L65)
|
|
3831
3831
|
|
|
3832
3832
|
___
|
|
3833
3833
|
|
|
@@ -4904,7 +4904,7 @@ and parses the data uris to the arrays and objects. Dates are remaining a string
|
|
|
4904
4904
|
|
|
4905
4905
|
#### Defined in
|
|
4906
4906
|
|
|
4907
|
-
[lib/base-block.ts:98](https://github.com/Staffbase/widget-sdk/blob/
|
|
4907
|
+
[lib/base-block.ts:98](https://github.com/Staffbase/widget-sdk/blob/next/lib/base-block.ts#L98)
|
|
4908
4908
|
|
|
4909
4909
|
___
|
|
4910
4910
|
|
|
@@ -4934,7 +4934,7 @@ Override this if the attributes are handled with a different logic then the defa
|
|
|
4934
4934
|
|
|
4935
4935
|
#### Defined in
|
|
4936
4936
|
|
|
4937
|
-
[lib/base-block.ts:82](https://github.com/Staffbase/widget-sdk/blob/
|
|
4937
|
+
[lib/base-block.ts:82](https://github.com/Staffbase/widget-sdk/blob/next/lib/base-block.ts#L82)
|
|
4938
4938
|
|
|
4939
4939
|
___
|
|
4940
4940
|
|
|
@@ -5360,7 +5360,7 @@ Default implementation is a noop.
|
|
|
5360
5360
|
|
|
5361
5361
|
#### Defined in
|
|
5362
5362
|
|
|
5363
|
-
[lib/base-block.ts:31](https://github.com/Staffbase/widget-sdk/blob/
|
|
5363
|
+
[lib/base-block.ts:31](https://github.com/Staffbase/widget-sdk/blob/next/lib/base-block.ts#L31)
|
|
5364
5364
|
|
|
5365
5365
|
___
|
|
5366
5366
|
|
|
@@ -5386,7 +5386,7 @@ with the widget name and icon.
|
|
|
5386
5386
|
|
|
5387
5387
|
#### Defined in
|
|
5388
5388
|
|
|
5389
|
-
[lib/base-block.ts:44](https://github.com/Staffbase/widget-sdk/blob/
|
|
5389
|
+
[lib/base-block.ts:44](https://github.com/Staffbase/widget-sdk/blob/next/lib/base-block.ts#L44)
|
|
5390
5390
|
|
|
5391
5391
|
___
|
|
5392
5392
|
|
|
@@ -5858,7 +5858,7 @@ Override this in order to implement your unmount logic.
|
|
|
5858
5858
|
|
|
5859
5859
|
#### Defined in
|
|
5860
5860
|
|
|
5861
|
-
[lib/base-block.ts:53](https://github.com/Staffbase/widget-sdk/blob/
|
|
5861
|
+
[lib/base-block.ts:53](https://github.com/Staffbase/widget-sdk/blob/next/lib/base-block.ts#L53)
|
|
5862
5862
|
|
|
5863
5863
|
___
|
|
5864
5864
|
|
package/docs/BlockAttributes.md
CHANGED
package/docs/BlockDefinition.md
CHANGED
|
@@ -30,7 +30,7 @@ DOM attributes of the element, must be in kebab-case.
|
|
|
30
30
|
|
|
31
31
|
#### Defined in
|
|
32
32
|
|
|
33
|
-
[lib/block-definition.ts:40](https://github.com/Staffbase/widget-sdk/blob/
|
|
33
|
+
[lib/block-definition.ts:40](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-definition.ts#L40)
|
|
34
34
|
|
|
35
35
|
___
|
|
36
36
|
|
|
@@ -43,7 +43,7 @@ rather than a div element if not specified, it defaults to `block`.
|
|
|
43
43
|
|
|
44
44
|
#### Defined in
|
|
45
45
|
|
|
46
|
-
[lib/block-definition.ts:46](https://github.com/Staffbase/widget-sdk/blob/
|
|
46
|
+
[lib/block-definition.ts:46](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-definition.ts#L46)
|
|
47
47
|
|
|
48
48
|
___
|
|
49
49
|
|
|
@@ -78,7 +78,7 @@ Schema used for defining the configuration form.
|
|
|
78
78
|
|
|
79
79
|
#### Defined in
|
|
80
80
|
|
|
81
|
-
[lib/block-definition.ts:73](https://github.com/Staffbase/widget-sdk/blob/
|
|
81
|
+
[lib/block-definition.ts:73](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-definition.ts#L73)
|
|
82
82
|
|
|
83
83
|
___
|
|
84
84
|
|
|
@@ -90,7 +90,7 @@ The implementation of the web component.
|
|
|
90
90
|
|
|
91
91
|
#### Defined in
|
|
92
92
|
|
|
93
|
-
[lib/block-definition.ts:30](https://github.com/Staffbase/widget-sdk/blob/
|
|
93
|
+
[lib/block-definition.ts:30](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-definition.ts#L30)
|
|
94
94
|
|
|
95
95
|
___
|
|
96
96
|
|
|
@@ -103,7 +103,7 @@ We recommend an icon with the dimensions 32x32 px.
|
|
|
103
103
|
|
|
104
104
|
#### Defined in
|
|
105
105
|
|
|
106
|
-
[lib/block-definition.ts:100](https://github.com/Staffbase/widget-sdk/blob/
|
|
106
|
+
[lib/block-definition.ts:100](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-definition.ts#L100)
|
|
107
107
|
|
|
108
108
|
___
|
|
109
109
|
|
|
@@ -115,7 +115,7 @@ Label displayed in the settings dialog and in the default widget preview.
|
|
|
115
115
|
|
|
116
116
|
#### Defined in
|
|
117
117
|
|
|
118
|
-
[lib/block-definition.ts:94](https://github.com/Staffbase/widget-sdk/blob/
|
|
118
|
+
[lib/block-definition.ts:94](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-definition.ts#L94)
|
|
119
119
|
|
|
120
120
|
___
|
|
121
121
|
|
|
@@ -130,7 +130,7 @@ webcomponent naming conventions.
|
|
|
130
130
|
|
|
131
131
|
#### Defined in
|
|
132
132
|
|
|
133
|
-
[lib/block-definition.ts:25](https://github.com/Staffbase/widget-sdk/blob/
|
|
133
|
+
[lib/block-definition.ts:25](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-definition.ts#L25)
|
|
134
134
|
|
|
135
135
|
___
|
|
136
136
|
|
|
@@ -142,7 +142,7 @@ Can be used for extending from a built-in element.
|
|
|
142
142
|
|
|
143
143
|
#### Defined in
|
|
144
144
|
|
|
145
|
-
[lib/block-definition.ts:35](https://github.com/Staffbase/widget-sdk/blob/
|
|
145
|
+
[lib/block-definition.ts:35](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-definition.ts#L35)
|
|
146
146
|
|
|
147
147
|
___
|
|
148
148
|
|
|
@@ -164,4 +164,4 @@ Schema to add more customization to the look and feel of the configuration form.
|
|
|
164
164
|
|
|
165
165
|
#### Defined in
|
|
166
166
|
|
|
167
|
-
[lib/block-definition.ts:89](https://github.com/Staffbase/widget-sdk/blob/
|
|
167
|
+
[lib/block-definition.ts:89](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-definition.ts#L89)
|
package/docs/BlockElement.md
CHANGED
|
@@ -24,7 +24,7 @@ Invoked when the custom element is moved to a new document.
|
|
|
24
24
|
|
|
25
25
|
#### Defined in
|
|
26
26
|
|
|
27
|
-
[lib/block-element.ts:33](https://github.com/Staffbase/widget-sdk/blob/
|
|
27
|
+
[lib/block-element.ts:33](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-element.ts#L33)
|
|
28
28
|
|
|
29
29
|
___
|
|
30
30
|
|
|
@@ -50,7 +50,7 @@ Note that you have to statically register the observed values with the 'observed
|
|
|
50
50
|
|
|
51
51
|
#### Defined in
|
|
52
52
|
|
|
53
|
-
[lib/block-element.ts:44](https://github.com/Staffbase/widget-sdk/blob/
|
|
53
|
+
[lib/block-element.ts:44](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-element.ts#L44)
|
|
54
54
|
|
|
55
55
|
___
|
|
56
56
|
|
|
@@ -66,7 +66,7 @@ Invoked when the custom element is first connected to the DOM.
|
|
|
66
66
|
|
|
67
67
|
#### Defined in
|
|
68
68
|
|
|
69
|
-
[lib/block-element.ts:23](https://github.com/Staffbase/widget-sdk/blob/
|
|
69
|
+
[lib/block-element.ts:23](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-element.ts#L23)
|
|
70
70
|
|
|
71
71
|
___
|
|
72
72
|
|
|
@@ -82,7 +82,7 @@ Invoked when the custom element is disconnected from the DOM.
|
|
|
82
82
|
|
|
83
83
|
#### Defined in
|
|
84
84
|
|
|
85
|
-
[lib/block-element.ts:28](https://github.com/Staffbase/widget-sdk/blob/
|
|
85
|
+
[lib/block-element.ts:28](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-element.ts#L28)
|
|
86
86
|
|
|
87
87
|
___
|
|
88
88
|
|
|
@@ -100,4 +100,4 @@ and revert the block to its initial state.
|
|
|
100
100
|
|
|
101
101
|
#### Defined in
|
|
102
102
|
|
|
103
|
-
[lib/block-element.ts:55](https://github.com/Staffbase/widget-sdk/blob/
|
|
103
|
+
[lib/block-element.ts:55](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-element.ts#L55)
|
package/docs/ColorTheme.md
CHANGED
|
@@ -24,7 +24,7 @@ and feel of the Staffbase ecosystem it was added to.
|
|
|
24
24
|
|
|
25
25
|
#### Defined in
|
|
26
26
|
|
|
27
|
-
[lib/widget-api-types.ts:103](https://github.com/Staffbase/widget-sdk/blob/
|
|
27
|
+
[lib/widget-api-types.ts:103](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L103)
|
|
28
28
|
|
|
29
29
|
___
|
|
30
30
|
|
|
@@ -34,7 +34,7 @@ ___
|
|
|
34
34
|
|
|
35
35
|
#### Defined in
|
|
36
36
|
|
|
37
|
-
[lib/widget-api-types.ts:106](https://github.com/Staffbase/widget-sdk/blob/
|
|
37
|
+
[lib/widget-api-types.ts:106](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L106)
|
|
38
38
|
|
|
39
39
|
___
|
|
40
40
|
|
|
@@ -44,7 +44,7 @@ ___
|
|
|
44
44
|
|
|
45
45
|
#### Defined in
|
|
46
46
|
|
|
47
|
-
[lib/widget-api-types.ts:107](https://github.com/Staffbase/widget-sdk/blob/
|
|
47
|
+
[lib/widget-api-types.ts:107](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L107)
|
|
48
48
|
|
|
49
49
|
___
|
|
50
50
|
|
|
@@ -54,7 +54,7 @@ ___
|
|
|
54
54
|
|
|
55
55
|
#### Defined in
|
|
56
56
|
|
|
57
|
-
[lib/widget-api-types.ts:108](https://github.com/Staffbase/widget-sdk/blob/
|
|
57
|
+
[lib/widget-api-types.ts:108](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L108)
|
|
58
58
|
|
|
59
59
|
___
|
|
60
60
|
|
|
@@ -64,7 +64,7 @@ ___
|
|
|
64
64
|
|
|
65
65
|
#### Defined in
|
|
66
66
|
|
|
67
|
-
[lib/widget-api-types.ts:109](https://github.com/Staffbase/widget-sdk/blob/
|
|
67
|
+
[lib/widget-api-types.ts:109](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L109)
|
|
68
68
|
|
|
69
69
|
___
|
|
70
70
|
|
|
@@ -74,7 +74,7 @@ ___
|
|
|
74
74
|
|
|
75
75
|
#### Defined in
|
|
76
76
|
|
|
77
|
-
[lib/widget-api-types.ts:105](https://github.com/Staffbase/widget-sdk/blob/
|
|
77
|
+
[lib/widget-api-types.ts:105](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L105)
|
|
78
78
|
|
|
79
79
|
___
|
|
80
80
|
|
|
@@ -84,7 +84,7 @@ ___
|
|
|
84
84
|
|
|
85
85
|
#### Defined in
|
|
86
86
|
|
|
87
|
-
[lib/widget-api-types.ts:110](https://github.com/Staffbase/widget-sdk/blob/
|
|
87
|
+
[lib/widget-api-types.ts:110](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L110)
|
|
88
88
|
|
|
89
89
|
___
|
|
90
90
|
|
|
@@ -94,4 +94,4 @@ ___
|
|
|
94
94
|
|
|
95
95
|
#### Defined in
|
|
96
96
|
|
|
97
|
-
[lib/widget-api-types.ts:104](https://github.com/Staffbase/widget-sdk/blob/
|
|
97
|
+
[lib/widget-api-types.ts:104](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L104)
|
|
@@ -29,7 +29,7 @@ Name of the author.
|
|
|
29
29
|
|
|
30
30
|
#### Defined in
|
|
31
31
|
|
|
32
|
-
[lib/external-block-definition.ts:39](https://github.com/Staffbase/widget-sdk/blob/
|
|
32
|
+
[lib/external-block-definition.ts:39](https://github.com/Staffbase/widget-sdk/blob/next/lib/external-block-definition.ts#L39)
|
|
33
33
|
|
|
34
34
|
___
|
|
35
35
|
|
|
@@ -43,7 +43,7 @@ Will be registered to the staffbase app.
|
|
|
43
43
|
|
|
44
44
|
#### Defined in
|
|
45
45
|
|
|
46
|
-
[lib/external-block-definition.ts:29](https://github.com/Staffbase/widget-sdk/blob/
|
|
46
|
+
[lib/external-block-definition.ts:29](https://github.com/Staffbase/widget-sdk/blob/next/lib/external-block-definition.ts#L29)
|
|
47
47
|
|
|
48
48
|
___
|
|
49
49
|
|
|
@@ -55,4 +55,4 @@ Current version of the widget.
|
|
|
55
55
|
|
|
56
56
|
#### Defined in
|
|
57
57
|
|
|
58
|
-
[lib/external-block-definition.ts:34](https://github.com/Staffbase/widget-sdk/blob/
|
|
58
|
+
[lib/external-block-definition.ts:34](https://github.com/Staffbase/widget-sdk/blob/next/lib/external-block-definition.ts#L34)
|
package/docs/Home.md
CHANGED
|
@@ -2,10 +2,6 @@
|
|
|
2
2
|
|
|
3
3
|
## Table of contents
|
|
4
4
|
|
|
5
|
-
### Enumerations
|
|
6
|
-
|
|
7
|
-
- [IntegrationState](../wiki/IntegrationState)
|
|
8
|
-
|
|
9
5
|
### Interfaces
|
|
10
6
|
|
|
11
7
|
- [BaseBlock](../wiki/BaseBlock)
|
|
@@ -29,9 +25,14 @@
|
|
|
29
25
|
### Type aliases
|
|
30
26
|
|
|
31
27
|
- [BlockFactory](../wiki/Home#blockfactory)
|
|
28
|
+
- [IntegrationState](../wiki/Home#integrationstate)
|
|
32
29
|
- [IntegrationType](../wiki/Home#integrationtype)
|
|
33
30
|
- [UserListSorting](../wiki/Home#userlistsorting)
|
|
34
31
|
|
|
32
|
+
### Variables
|
|
33
|
+
|
|
34
|
+
- [IntegrationStates](../wiki/Home#integrationstates)
|
|
35
|
+
|
|
35
36
|
## Type aliases
|
|
36
37
|
|
|
37
38
|
### BlockFactory
|
|
@@ -69,7 +70,17 @@ Factory for the custom widgets.
|
|
|
69
70
|
|
|
70
71
|
#### Defined in
|
|
71
72
|
|
|
72
|
-
[lib/block-factory.ts:38](https://github.com/Staffbase/widget-sdk/blob/
|
|
73
|
+
[lib/block-factory.ts:38](https://github.com/Staffbase/widget-sdk/blob/next/lib/block-factory.ts#L38)
|
|
74
|
+
|
|
75
|
+
___
|
|
76
|
+
|
|
77
|
+
### IntegrationState
|
|
78
|
+
|
|
79
|
+
Ƭ **IntegrationState**: typeof [`IntegrationStates`](../wiki/Home#integrationstates)[keyof typeof [`IntegrationStates`](../wiki/Home#integrationstates)]
|
|
80
|
+
|
|
81
|
+
#### Defined in
|
|
82
|
+
|
|
83
|
+
[lib/widget-api-types.ts:211](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L211)
|
|
73
84
|
|
|
74
85
|
___
|
|
75
86
|
|
|
@@ -79,7 +90,7 @@ ___
|
|
|
79
90
|
|
|
80
91
|
#### Defined in
|
|
81
92
|
|
|
82
|
-
[lib/widget-api-types.ts:189](https://github.com/Staffbase/widget-sdk/blob/
|
|
93
|
+
[lib/widget-api-types.ts:189](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L189)
|
|
83
94
|
|
|
84
95
|
___
|
|
85
96
|
|
|
@@ -97,4 +108,24 @@ The sorting order of the user list.
|
|
|
97
108
|
|
|
98
109
|
#### Defined in
|
|
99
110
|
|
|
100
|
-
[lib/widget-api-types.ts:156](https://github.com/Staffbase/widget-sdk/blob/
|
|
111
|
+
[lib/widget-api-types.ts:156](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L156)
|
|
112
|
+
|
|
113
|
+
## Variables
|
|
114
|
+
|
|
115
|
+
### IntegrationStates
|
|
116
|
+
|
|
117
|
+
• **IntegrationStates**: `Object`
|
|
118
|
+
|
|
119
|
+
All available states the integration can take
|
|
120
|
+
|
|
121
|
+
#### Type declaration
|
|
122
|
+
|
|
123
|
+
| Name | Type |
|
|
124
|
+
| :------ | :------ |
|
|
125
|
+
| `AVAILABLE` | ``"available"`` |
|
|
126
|
+
| `LOGGED_OUT` | ``"loggedOut"`` |
|
|
127
|
+
| `UNAVAILABLE` | ``"unavailable"`` |
|
|
128
|
+
|
|
129
|
+
#### Defined in
|
|
130
|
+
|
|
131
|
+
[lib/widget-api-types.ts:205](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L205)
|
|
@@ -23,17 +23,17 @@ Information about the requested Integration target
|
|
|
23
23
|
|
|
24
24
|
#### Defined in
|
|
25
25
|
|
|
26
|
-
[lib/widget-api-types.ts:
|
|
26
|
+
[lib/widget-api-types.ts:220](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L220)
|
|
27
27
|
|
|
28
28
|
___
|
|
29
29
|
|
|
30
30
|
### status
|
|
31
31
|
|
|
32
|
-
• **status**: [`IntegrationState`](../wiki/
|
|
32
|
+
• **status**: [`IntegrationState`](../wiki/Home#integrationstate)
|
|
33
33
|
|
|
34
34
|
#### Defined in
|
|
35
35
|
|
|
36
|
-
[lib/widget-api-types.ts:
|
|
36
|
+
[lib/widget-api-types.ts:218](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L218)
|
|
37
37
|
|
|
38
38
|
___
|
|
39
39
|
|
|
@@ -43,7 +43,7 @@ ___
|
|
|
43
43
|
|
|
44
44
|
#### Defined in
|
|
45
45
|
|
|
46
|
-
[lib/widget-api-types.ts:
|
|
46
|
+
[lib/widget-api-types.ts:222](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L222)
|
|
47
47
|
|
|
48
48
|
___
|
|
49
49
|
|
|
@@ -53,7 +53,7 @@ ___
|
|
|
53
53
|
|
|
54
54
|
#### Defined in
|
|
55
55
|
|
|
56
|
-
[lib/widget-api-types.ts:
|
|
56
|
+
[lib/widget-api-types.ts:224](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L224)
|
|
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:
|
|
70
|
+
[lib/widget-api-types.ts:226](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L226)
|
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/
|
|
20
|
+
[lib/widget-api-types.ts:196](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L196)
|
|
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/
|
|
30
|
+
[lib/widget-api-types.ts:199](https://github.com/Staffbase/widget-sdk/blob/next/lib/widget-api-types.ts#L199)
|