@staffbase/widget-sdk 3.3.5 → 3.4.0-alpha.13

package/docs/BlockAttributes.md

@@ -15,3 +15,7 @@
 ### contentLanguage
 
 • **contentLanguage**: `string`
+
+#### Defined in
+
+[lib/block-attributes.ts:15](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-attributes.ts#L15)

package/docs/BlockDefinition.md

@@ -28,6 +28,10 @@
 
 DOM attributes of the element, must be in kebab-case.
 
+#### Defined in
+
+[lib/block-definition.ts:40](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-definition.ts#L40)
+
 ___
 
 ### blockLevel
@@ -37,6 +41,10 @@ ___
 Set to `inline` if you want the element to behave like a span element
 rather than a div element if not specified, it defaults to `block`.
 
+#### Defined in
+
+[lib/block-definition.ts:46](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-definition.ts#L46)
+
 ___
 
 ### configurationSchema
@@ -68,6 +76,10 @@ Schema used for defining the configuration form.
 
 **`see`** https://react-jsonschema-form.readthedocs.io/en/latest/
 
+#### Defined in
+
+[lib/block-definition.ts:73](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-definition.ts#L73)
+
 ___
 
 ### factory
@@ -76,6 +88,10 @@ ___
 
 The implementation of the web component.
 
+#### Defined in
+
+[lib/block-definition.ts:30](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-definition.ts#L30)
+
 ___
 
 ### iconUrl
@@ -85,6 +101,10 @@ ___
 Icon displayed on the widget installation page.
 We recommend an icon with the dimensions 32x32 px.
 
+#### Defined in
+
+[lib/block-definition.ts:100](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-definition.ts#L100)
+
 ___
 
 ### label
@@ -93,6 +113,10 @@ ___
 
 Label displayed in the settings dialog and in the default widget preview.
 
+#### Defined in
+
+[lib/block-definition.ts:94](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-definition.ts#L94)
+
 ___
 
 ### name
@@ -104,6 +128,10 @@ webcomponent naming conventions.
 
 **`see`** https://www.webcomponents.org/community/articles/how-should-i-name-my-element
 
+#### Defined in
+
+[lib/block-definition.ts:25](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-definition.ts#L25)
+
 ___
 
 ### options
@@ -112,6 +140,10 @@ ___
 
 Can be used for extending from a built-in element.
 
+#### Defined in
+
+[lib/block-definition.ts:35](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-definition.ts#L35)
+
 ___
 
 ### uiSchema
@@ -129,3 +161,7 @@ Schema to add more customization to the look and feel of the configuration form.
 ```
 
 **`see`** https://react-jsonschema-form.readthedocs.io/en/latest/api-reference/uiSchema/
+
+#### Defined in
+
+[lib/block-definition.ts:89](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-definition.ts#L89)

package/docs/BlockElement.md

@@ -22,6 +22,10 @@ Invoked when the custom element is moved to a new document.
 
 `void`
 
+#### Defined in
+
+[lib/block-element.ts:33](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-element.ts#L33)
+
 ___
 
 ### attributeChangedCallback
@@ -44,6 +48,10 @@ Note that you have to statically register the observed values with the 'observed
 
 `void`
 
+#### Defined in
+
+[lib/block-element.ts:44](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-element.ts#L44)
+
 ___
 
 ### connectedCallback
@@ -56,6 +64,10 @@ Invoked when the custom element is first connected to the DOM.
 
 `void`
 
+#### Defined in
+
+[lib/block-element.ts:23](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-element.ts#L23)
+
 ___
 
 ### disconnectedCallback
@@ -68,6 +80,10 @@ Invoked when the custom element is disconnected from the DOM.
 
 `void`
 
+#### Defined in
+
+[lib/block-element.ts:28](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-element.ts#L28)
+
 ___
 
 ### unmount
@@ -81,3 +97,7 @@ and revert the block to its initial state.
 #### Returns
 
 `void`
+
+#### Defined in
+
+[lib/block-element.ts:55](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-element.ts#L55)

package/docs/ColorTheme.md

@@ -22,44 +22,76 @@ and feel of the Staffbase ecosystem it was added to.
 
 • **bgColor**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:103](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L103)
+
 ___
 
 ### bgColorDarkened1
 
 • `Optional` **bgColorDarkened1**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:106](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L106)
+
 ___
 
 ### bgColorDarkened2
 
 • `Optional` **bgColorDarkened2**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:107](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L107)
+
 ___
 
 ### bgColorDarkened2Opaque
 
 • `Optional` **bgColorDarkened2Opaque**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:108](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L108)
+
 ___
 
 ### bgColorLum
 
 • `Optional` **bgColorLum**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:109](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L109)
+
 ___
 
 ### colors
 
 • **colors**: [`SBColors`](../wiki/SBColors)
 
+#### Defined in
+
+[lib/widget-api-types.ts:105](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L105)
+
 ___
 
 ### outlineColor
 
 • `Optional` **outlineColor**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:110](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L110)
+
 ___
 
 ### textColor
 
 • **textColor**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:104](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L104)

package/docs/ExternalBlockDefinition.md

@@ -27,6 +27,10 @@ and meta information (author and version of the widget).
 
 Name of the author.
 
+#### Defined in
+
+[lib/external-block-definition.ts:39](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/external-block-definition.ts#L39)
+
 ___
 
 ### blockDefinition
@@ -37,6 +41,10 @@ Definition of the block.
 
 Will be registered to the staffbase app.
 
+#### Defined in
+
+[lib/external-block-definition.ts:29](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/external-block-definition.ts#L29)
+
 ___
 
 ### version
@@ -44,3 +52,7 @@ ___
 • **version**: `string`
 
 Current version of the widget.
+
+#### Defined in
+
+[lib/external-block-definition.ts:34](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/external-block-definition.ts#L34)

package/docs/Home.md

@@ -2,6 +2,10 @@
 
 ## Table of contents
 
+### Enumerations
+
+- [IntegrationState](../wiki/IntegrationState)
+
 ### Interfaces
 
 - [BaseBlock](../wiki/BaseBlock)
@@ -10,6 +14,8 @@
 - [BlockElement](../wiki/BlockElement)
 - [ColorTheme](../wiki/ColorTheme)
 - [ExternalBlockDefinition](../wiki/ExternalBlockDefinition)
+- [IntegrationInformation](../wiki/IntegrationInformation)
+- [IntegrationToken](../wiki/IntegrationToken)
 - [SBColors](../wiki/SBColors)
 - [SBFileType](../wiki/SBFileType)
 - [SBImageEntity](../wiki/SBImageEntity)
@@ -23,6 +29,7 @@
 ### Type aliases
 
 - [BlockFactory](../wiki/Home#blockfactory)
+- [IntegrationType](../wiki/Home#integrationtype)
 - [UserListSorting](../wiki/Home#userlistsorting)
 
 ## Type aliases
@@ -60,6 +67,20 @@ Factory for the custom widgets.
 
 `CustomElementConstructor`
 
+#### Defined in
+
+[lib/block-factory.ts:38](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-factory.ts#L38)
+
+___
+
+### IntegrationType
+
+Ƭ **IntegrationType**: ``"ms365"``
+
+#### Defined in
+
+[lib/widget-api-types.ts:189](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L189)
+
 ___
 
 ### UserListSorting
@@ -73,3 +94,7 @@ The sorting order of the user list.
 **`param`** sort by date of creation descending
 
 **`param`** sort by date of last update descending
+
+#### Defined in
+
+[lib/widget-api-types.ts:156](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L156)

package/docs/IntegrationInformation.md

@@ -0,0 +1,70 @@
+# Interface: IntegrationInformation
+
+Information about the requested Integration target
+
+## Table of contents
+
+### Properties
+
+- [enabledFeatures](../wiki/IntegrationInformation#enabledfeatures)
+- [status](../wiki/IntegrationInformation#status)
+- [supportedFeatures](../wiki/IntegrationInformation#supportedfeatures)
+- [token](../wiki/IntegrationInformation#token)
+
+### Methods
+
+- [signIn](../wiki/IntegrationInformation#signin)
+
+## Properties
+
+### enabledFeatures
+
+• **enabledFeatures**: `string`[]
+
+#### Defined in
+
+[lib/widget-api-types.ts:218](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L218)
+
+___
+
+### status
+
+• **status**: [`IntegrationState`](../wiki/IntegrationState)
+
+#### Defined in
+
+[lib/widget-api-types.ts:216](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L216)
+
+___
+
+### supportedFeatures
+
+• **supportedFeatures**: `string`[]
+
+#### Defined in
+
+[lib/widget-api-types.ts:220](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L220)
+
+___
+
+### token
+
+• `Optional` **token**: [`IntegrationToken`](../wiki/IntegrationToken)
+
+#### Defined in
+
+[lib/widget-api-types.ts:222](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L222)
+
+## Methods
+
+### signIn
+
+▸ `Optional` **signIn**(): `void`
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[lib/widget-api-types.ts:224](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L224)

package/docs/IntegrationState.md

@@ -0,0 +1,41 @@
+# Enumeration: IntegrationState
+
+All available states the integration can take
+
+## Table of contents
+
+### Enumeration members
+
+- [AVAILABLE](../wiki/IntegrationState#available)
+- [LOGGED\_OUT](../wiki/IntegrationState#logged_out)
+- [UNAVAILABLE](../wiki/IntegrationState#unavailable)
+
+## Enumeration members
+
+### AVAILABLE
+
+• **AVAILABLE** = `"available"`
+
+#### Defined in
+
+[lib/widget-api-types.ts:207](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L207)
+
+___
+
+### LOGGED\_OUT
+
+• **LOGGED\_OUT** = `"loggedOut"`
+
+#### Defined in
+
+[lib/widget-api-types.ts:208](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L208)
+
+___
+
+### UNAVAILABLE
+
+• **UNAVAILABLE** = `"unavailable"`
+
+#### Defined in
+
+[lib/widget-api-types.ts:206](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L206)

package/docs/IntegrationToken.md

@@ -0,0 +1,30 @@
+# Interface: IntegrationToken
+
+Integration Token including the expiration time
+
+## Table of contents
+
+### Properties
+
+- [accessToken](../wiki/IntegrationToken#accesstoken)
+- [accessTokenExpiresAt](../wiki/IntegrationToken#accesstokenexpiresat)
+
+## Properties
+
+### accessToken
+
+• **accessToken**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:196](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L196)
+
+___
+
+### accessTokenExpiresAt
+
+• `Optional` **accessTokenExpiresAt**: `Date`
+
+#### Defined in
+
+[lib/widget-api-types.ts:199](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L199)