@staffbase/widget-sdk 3.3.4 → 3.3.5

package/docs/WidgetApi.md

@@ -0,0 +1,92 @@
+# Interface: WidgetApi
+
+Widget API class.
+
+A class providing access to additional information about the Staffbase ecosystem for widgets.
+
+## Table of contents
+
+### Methods
+
+- [getLegacyAppTheme](../wiki/WidgetApi#getlegacyapptheme)
+- [getUserInformation](../wiki/WidgetApi#getuserinformation)
+- [getUserInformationByExternalId](../wiki/WidgetApi#getuserinformationbyexternalid)
+- [getUserList](../wiki/WidgetApi#getuserlist)
+
+## Methods
+
+### getLegacyAppTheme
+
+▸ **getLegacyAppTheme**(): [`ColorTheme`](../wiki/ColorTheme)
+
+Call to retrieve the color theme of the app. Since this theme definitions
+are currently redesigned, this method is called legacy.
+
+#### Returns
+
+[`ColorTheme`](../wiki/ColorTheme)
+
+An object containing the color theme data is returned.
+
+___
+
+### getUserInformation
+
+▸ **getUserInformation**(`userId?`): `Promise`<[`SBUserProfile`](../wiki/SBUserProfile)\>
+
+Call to retrieve the user profile of the current or a specific user.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `userId?` | `string` | User ID to lookup for; leave blank to retrieve current user |
+
+#### Returns
+
+`Promise`<[`SBUserProfile`](../wiki/SBUserProfile)\>
+
+A promise containing the SBUserProfile is returned. In case of an error,
+the promise is rejected.
+
+___
+
+### getUserInformationByExternalId
+
+▸ **getUserInformationByExternalId**(`externalId`): `Promise`<[`SBUserProfile`](../wiki/SBUserProfile)\>
+
+Call to retrieve a user profile by its external ID.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `externalId` | `string` | An external ID of the user that shall be returned |
+
+#### Returns
+
+`Promise`<[`SBUserProfile`](../wiki/SBUserProfile)\>
+
+A promise containing the SBUserProfile is returned. In case of an error,
+the promise is rejected.
+
+___
+
+### getUserList
+
+▸ **getUserList**(`query`): `Promise`<[`UserListResponse`](../wiki/UserListResponse)\>
+
+Call to retrieve a list of users determined by the query object.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `query` | [`UserListRequestQuery`](../wiki/UserListRequestQuery) | Adjust limit, offset, filter, and sorting for the request |
+
+#### Returns
+
+`Promise`<[`UserListResponse`](../wiki/UserListResponse)\>
+
+A promise containing the UserListResponse is returned. In case of an error,
+the promise is rejected.

package/docs/_Sidebar.md

@@ -1,20 +1,3 @@
-## [@staffbase/widget-sdk](../wiki/Home)
+## @staffbase/widget-sdk
 
-
-### 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)
+- [Home](../wiki/Home)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@staffbase/widget-sdk",
-  "version": "3.3.4",
+  "version": "3.3.5",
   "description": "Staffbase SDK for Custom Widgets",
   "keywords": [
     "web-components"
@@ -14,28 +14,28 @@
   "license": "Apache-2.0",
   "author": "Staffbase",
   "dependencies": {
-    "@rjsf/core": "3.0.0",
-    "@types/json-schema": "^7.0.5"
+    "@rjsf/core": "^3.2.1",
+    "@types/json-schema": "^7.0.9"
   },
   "devDependencies": {
-    "@amanda-mitchell/semantic-release-npm-multiple": "2.12.0",
-    "@commitlint/cli": "13.1.0",
-    "@commitlint/config-conventional": "13.1.0",
+    "@amanda-mitchell/semantic-release-npm-multiple": "2.15.0",
+    "@commitlint/cli": "15.0.0",
+    "@commitlint/config-conventional": "15.0.0",
     "@tmware/semantic-release-npm-github-publish": "1.4.4",
-    "@types/react": "^17.0.15",
-    "husky": "^7.0.1",
-    "semantic-release": "^17.4.2",
-    "typedoc": "0.21.5",
-    "typedoc-github-wiki-theme": "0.5.1",
-    "typedoc-plugin-markdown": "3.10.4",
-    "typescript": "^4.2.4"
+    "@types/react": "^17.0.36",
+    "husky": "^7.0.4",
+    "semantic-release": "^17.4.7",
+    "typedoc": "0.22.9",
+    "typedoc-github-wiki-theme": "0.6.0",
+    "typedoc-plugin-markdown": "3.11.7",
+    "typescript": "^4.4.2"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/Staffbase/widget-sdk"
   },
   "engines": {
-    "node": ">= 12",
-    "npm": ">= 6.11.0"
+    "node": ">= 14",
+    "npm": ">= 7"
   }
 }