@staffbase/widget-sdk 3.4.0-beta.5 → 3.4.0-beta.6

package/docs/BlockAttributes.md

@@ -0,0 +1,21 @@
+# Interface: BlockAttributes
+
+## Indexable
+
+▪ [key: `string`]: `number` \| `boolean` \| `string`
+
+## Table of contents
+
+### Properties
+
+- [contentLanguage](../wiki/BlockAttributes#contentlanguage)
+
+## Properties
+
+### 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

@@ -0,0 +1,167 @@
+# Interface: BlockDefinition<Factory\>
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Factory` | [`BlockFactory`](../wiki/Home#blockfactory) |
+
+## Table of contents
+
+### Properties
+
+- [attributes](../wiki/BlockDefinition#attributes)
+- [blockLevel](../wiki/BlockDefinition#blocklevel)
+- [configurationSchema](../wiki/BlockDefinition#configurationschema)
+- [factory](../wiki/BlockDefinition#factory)
+- [iconUrl](../wiki/BlockDefinition#iconurl)
+- [label](../wiki/BlockDefinition#label)
+- [name](../wiki/BlockDefinition#name)
+- [options](../wiki/BlockDefinition#options)
+- [uiSchema](../wiki/BlockDefinition#uischema)
+
+## Properties
+
+### attributes
+
+• **attributes**: `string`[]
+
+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
+
+• `Optional` **blockLevel**: ``"block"`` \| ``"inline"``
+
+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
+
+• **configurationSchema**: `JSONSchema7`
+
+Schema used for defining the configuration form.
+
+**`example`**
+```json
+{
+ "type": "object",
+ "required": [
+   "firstName",
+   "lastName"
+   ],
+ "properties": {
+   "firstName": {
+     "type": "string",
+     "title": "First name"
+     },
+ "lastName": {
+   "type": "string",
+   "title": "Last name"
+   }
+ }
+}
+```
+
+**`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
+
+• **factory**: `Factory`
+
+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
+
+• `Optional` **iconUrl**: `string`
+
+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
+
+• `Optional` **label**: `string`
+
+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
+
+• **name**: `string`
+
+The tag name of the widget. It must be compatible with
+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
+
+• `Optional` **options**: `ElementDefinitionOptions`
+
+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
+
+• `Optional` **uiSchema**: `UiSchema`
+
+Schema to add more customization to the look and feel of the configuration form.
+
+```json
+{
+  "firstName": {
+     "ui:help": "Your first name."
+  }
+}
+```
+
+**`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

@@ -0,0 +1,103 @@
+# Interface: BlockElement
+
+## Table of contents
+
+### Methods
+
+- [adoptedCallback](../wiki/BlockElement#adoptedcallback)
+- [attributeChangedCallback](../wiki/BlockElement#attributechangedcallback)
+- [connectedCallback](../wiki/BlockElement#connectedcallback)
+- [disconnectedCallback](../wiki/BlockElement#disconnectedcallback)
+- [unmount](../wiki/BlockElement#unmount)
+
+## Methods
+
+### adoptedCallback
+
+▸ **adoptedCallback**(): `void`
+
+Invoked when the custom element is moved to a new document.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[lib/block-element.ts:33](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-element.ts#L33)
+
+___
+
+### attributeChangedCallback
+
+▸ **attributeChangedCallback**(`attrName`, `oldValue`, `newValue`): `void`
+
+Invoked when one of the attributes of the custom element is added, removed, or changed.
+
+Note that you have to statically register the observed values with the 'observedAttributes' static getter.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `attrName` | `string` | The changed attributes name |
+| `oldValue` | `undefined` \| `string` | The old value |
+| `newValue` | `undefined` \| `string` | The new value |
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[lib/block-element.ts:44](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-element.ts#L44)
+
+___
+
+### connectedCallback
+
+▸ **connectedCallback**(): `void`
+
+Invoked when the custom element is first connected to the DOM.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[lib/block-element.ts:23](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-element.ts#L23)
+
+___
+
+### disconnectedCallback
+
+▸ **disconnectedCallback**(): `void`
+
+Invoked when the custom element is disconnected from the DOM.
+
+#### Returns
+
+`void`
+
+#### Defined in
+
+[lib/block-element.ts:28](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/block-element.ts#L28)
+
+___
+
+### unmount
+
+▸ **unmount**(): `void`
+
+Method to unmount / revert any effects applied by rendering.
+E.g. to be used in editor cases to remove any rendered content
+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

@@ -0,0 +1,97 @@
+# Interface: ColorTheme
+
+The color theme allows the widget to mimic the look
+and feel of the Staffbase ecosystem it was added to.
+
+## Table of contents
+
+### Properties
+
+- [bgColor](../wiki/ColorTheme#bgcolor)
+- [bgColorDarkened1](../wiki/ColorTheme#bgcolordarkened1)
+- [bgColorDarkened2](../wiki/ColorTheme#bgcolordarkened2)
+- [bgColorDarkened2Opaque](../wiki/ColorTheme#bgcolordarkened2opaque)
+- [bgColorLum](../wiki/ColorTheme#bgcolorlum)
+- [colors](../wiki/ColorTheme#colors)
+- [outlineColor](../wiki/ColorTheme#outlinecolor)
+- [textColor](../wiki/ColorTheme#textcolor)
+
+## Properties
+
+### bgColor
+
+• **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

@@ -0,0 +1,58 @@
+# Interface: ExternalBlockDefinition<Factory\>
+
+Defintion of the Widget.
+
+Includes the implementation of the BlockDefinition
+and meta information (author and version of the widget).
+
+## Type parameters
+
+| Name | Type |
+| :------ | :------ |
+| `Factory` | [`BlockFactory`](../wiki/Home#blockfactory) |
+
+## Table of contents
+
+### Properties
+
+- [author](../wiki/ExternalBlockDefinition#author)
+- [blockDefinition](../wiki/ExternalBlockDefinition#blockdefinition)
+- [version](../wiki/ExternalBlockDefinition#version)
+
+## Properties
+
+### author
+
+• **author**: `string`
+
+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
+
+• **blockDefinition**: [`BlockDefinition`](../wiki/BlockDefinition)<`Factory`\>
+
+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
+
+• **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,39 +2,49 @@
 
 ## Table of contents
 
+### Enumerations
+
+- [IntegrationState](../wiki/IntegrationState)
+
 ### Interfaces
 
-- [BaseBlock](../wiki/Interface:%20BaseBlock)
-- [BlockAttributes](../wiki/Interface:%20BlockAttributes)
-- [BlockDefinition](../wiki/Interface:%20BlockDefinition)
-- [BlockElement](../wiki/Interface:%20BlockElement)
-- [ColorTheme](../wiki/Interface:%20ColorTheme)
-- [ExternalBlockDefinition](../wiki/Interface:%20ExternalBlockDefinition)
-- [SBColors](../wiki/Interface:%20SBColors)
-- [SBFileType](../wiki/Interface:%20SBFileType)
-- [SBImageEntity](../wiki/Interface:%20SBImageEntity)
-- [SBUserAvatar](../wiki/Interface:%20SBUserAvatar)
-- [SBUserProfile](../wiki/Interface:%20SBUserProfile)
-- [UserListItem](../wiki/Interface:%20UserListItem)
-- [UserListRequestQuery](../wiki/Interface:%20UserListRequestQuery)
-- [UserListResponse](../wiki/Interface:%20UserListResponse)
-- [WidgetApi](../wiki/Interface:%20WidgetApi)
+- [BaseBlock](../wiki/BaseBlock)
+- [BlockAttributes](../wiki/BlockAttributes)
+- [BlockDefinition](../wiki/BlockDefinition)
+- [BlockElement](../wiki/BlockElement)
+- [ColorTheme](../wiki/ColorTheme)
+- [ExternalBlockDefinition](../wiki/ExternalBlockDefinition)
+- [IntegrationInformation](../wiki/IntegrationInformation)
+- [IntegrationToken](../wiki/IntegrationToken)
+- [SBColors](../wiki/SBColors)
+- [SBFileType](../wiki/SBFileType)
+- [SBImageEntity](../wiki/SBImageEntity)
+- [SBUserAvatar](../wiki/SBUserAvatar)
+- [SBUserProfile](../wiki/SBUserProfile)
+- [UserListItem](../wiki/UserListItem)
+- [UserListRequestQuery](../wiki/UserListRequestQuery)
+- [UserListResponse](../wiki/UserListResponse)
+- [WidgetApi](../wiki/WidgetApi)
+
+### Type aliases
+
+- [BlockFactory](../wiki/Home#blockfactory)
+- [IntegrationType](../wiki/Home#integrationtype)
+- [UserListSorting](../wiki/Home#userlistsorting)
 
 ## Type aliases
 
 ### BlockFactory
 
-Ƭ **BlockFactory**: (`Base`: () => [*BaseBlock*](../wiki/Interface:%20BaseBlock), `widgetApi`: [*WidgetApi*](../wiki/Interface:%20WidgetApi)) => CustomElementConstructor
+Ƭ **BlockFactory**: (`Base`: () => [`BaseBlock`](../wiki/BaseBlock), `widgetApi`: [`WidgetApi`](../wiki/WidgetApi)) => `CustomElementConstructor`
 
-Factory for the custom widgets.
+#### Type declaration
 
-**`param`** base class for the custom widgets to inherit from.
-The class itself is a subclass of `HTMLElement` of the relevant `window` object,
-with additional functionality.
+▸ (`Base`, `widgetApi`): `CustomElementConstructor`
 
-**`param`** API providing methods for additional information by the Staffbase framework
+Factory for the custom widgets.
 
-**`example`** 
+**`example`**
   const factory: BlockFactory = Base => {
 
     return class CustomBlock extends Base {
@@ -46,18 +56,30 @@ with additional functionality.
     }
   };
 
-#### Type declaration:
+##### Parameters
 
-▸ (`Base`: () => [*BaseBlock*](../wiki/Interface:%20BaseBlock), `widgetApi`: [*WidgetApi*](../wiki/Interface:%20WidgetApi)): CustomElementConstructor
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `Base` | () => [`BaseBlock`](../wiki/BaseBlock) | base class for the custom widgets to inherit from. The class itself is a subclass of `HTMLElement` of the relevant `window` object, with additional functionality. |
+| `widgetApi` | [`WidgetApi`](../wiki/WidgetApi) | API providing methods for additional information by the Staffbase framework |
 
-#### Parameters:
+##### Returns
 
-| Name | Type |
-| :------ | :------ |
-| `Base` | () => [*BaseBlock*](../wiki/Interface:%20BaseBlock) |
-| `widgetApi` | [*WidgetApi*](../wiki/Interface:%20WidgetApi) |
+`CustomElementConstructor`
 
-**Returns:** 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)
 
 ___
 
@@ -72,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)