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

package/docs/SBUserProfile.md

@@ -21,44 +21,76 @@ User profile data
 
 • `Optional` **avatar**: [`SBUserAvatar`](../wiki/SBUserAvatar)
 
+#### Defined in
+
+[lib/widget-api-types.ts:145](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L145)
+
 ___
 
 ### department
 
 • `Optional` **department**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:146](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L146)
+
 ___
 
 ### firstName
 
 • **firstName**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:139](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L139)
+
 ___
 
 ### lastName
 
 • **lastName**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:140](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L140)
+
 ___
 
 ### location
 
 • `Optional` **location**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:143](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L143)
+
 ___
 
 ### phoneNumber
 
 • `Optional` **phoneNumber**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:141](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L141)
+
 ___
 
 ### position
 
 • `Optional` **position**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:144](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L144)
+
 ___
 
 ### publicEmailAddress
 
 • `Optional` **publicEmailAddress**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:142](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L142)

package/docs/UserListItem.md

@@ -17,20 +17,36 @@ Single user item
 
 • `Optional` **entityType**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:175](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L175)
+
 ___
 
 ### firstName
 
 • `Optional` **firstName**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:173](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L173)
+
 ___
 
 ### id
 
 • `Optional` **id**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:172](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L172)
+
 ___
 
 ### lastName
 
 • `Optional` **lastName**: `string`
+
+#### Defined in
+
+[lib/widget-api-types.ts:174](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L174)

package/docs/UserListRequestQuery.md

@@ -17,20 +17,36 @@ User list request parameters
 
 • `Optional` **filter**: `string`
 
+#### Defined in
+
+[lib/widget-api-types.ts:165](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L165)
+
 ___
 
 ### limit
 
 • `Optional` **limit**: `number`
 
+#### Defined in
+
+[lib/widget-api-types.ts:162](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L162)
+
 ___
 
 ### offset
 
 • `Optional` **offset**: `number`
 
+#### Defined in
+
+[lib/widget-api-types.ts:163](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L163)
+
 ___
 
 ### sort
 
 • `Optional` **sort**: [`UserListSorting`](../wiki/Home#userlistsorting)
+
+#### Defined in
+
+[lib/widget-api-types.ts:164](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L164)

package/docs/UserListResponse.md

@@ -17,20 +17,36 @@ Responded user list
 
 • **data**: [`UserListItem`](../wiki/UserListItem)[]
 
+#### Defined in
+
+[lib/widget-api-types.ts:182](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L182)
+
 ___
 
 ### limit
 
 • **limit**: `number`
 
+#### Defined in
+
+[lib/widget-api-types.ts:184](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L184)
+
 ___
 
 ### offset
 
 • **offset**: `number`
 
+#### Defined in
+
+[lib/widget-api-types.ts:183](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L183)
+
 ___
 
 ### total
 
 • **total**: `number`
+
+#### Defined in
+
+[lib/widget-api-types.ts:185](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api-types.ts#L185)

package/docs/WidgetApi.md

@@ -8,6 +8,7 @@ A class providing access to additional information about the Staffbase ecosystem
 
 ### Methods
 
+- [getIntegration](../wiki/WidgetApi#getintegration)
 - [getLegacyAppTheme](../wiki/WidgetApi#getlegacyapptheme)
 - [getUserInformation](../wiki/WidgetApi#getuserinformation)
 - [getUserInformationByExternalId](../wiki/WidgetApi#getuserinformationbyexternalid)
@@ -15,6 +16,39 @@ A class providing access to additional information about the Staffbase ecosystem
 
 ## Methods
 
+### getIntegration
+
+▸ **getIntegration**(`type`, `refresh?`): `Promise`<[`IntegrationInformation`](../wiki/IntegrationInformation)\>
+
+Call to retrieve a valid token to access the Microsoft API. Includes a time value to
+refresh the token.
+
+**`deprecated`** Returns a IntegrationToken or null if the user is not logged in. This will be replaced
+completely by the IntegrationInformation, containing the token.
+
+#### Parameters
+
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `type` | ``"ms365"`` | The name of the integration. ("ms365") |
+| `refresh?` | `boolean` | Force a refresh of the integration. |
+
+#### Returns
+
+`Promise`<[`IntegrationInformation`](../wiki/IntegrationInformation)\>
+
+A promise containing the IntegrationInformation is returned. If the user session is
+not existing, the status is set to 'loggedOut' and the token is null. Additionally if the
+integration is not configured the status returns 'unavailable'.
+
+In case of an error, the promise is rejected.
+
+#### Defined in
+
+[lib/widget-api.ts:74](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api.ts#L74)
+
+___
+
 ### getLegacyAppTheme
 
 ▸ **getLegacyAppTheme**(): [`ColorTheme`](../wiki/ColorTheme)
@@ -28,6 +62,10 @@ are currently redesigned, this method is called legacy.
 
 An object containing the color theme data is returned.
 
+#### Defined in
+
+[lib/widget-api.ts:29](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api.ts#L29)
+
 ___
 
 ### getUserInformation
@@ -49,6 +87,10 @@ Call to retrieve the user profile of the current or a specific user.
 A promise containing the SBUserProfile is returned. In case of an error,
 the promise is rejected.
 
+#### Defined in
+
+[lib/widget-api.ts:38](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api.ts#L38)
+
 ___
 
 ### getUserInformationByExternalId
@@ -70,6 +112,10 @@ Call to retrieve a user profile by its external ID.
 A promise containing the SBUserProfile is returned. In case of an error,
 the promise is rejected.
 
+#### Defined in
+
+[lib/widget-api.ts:47](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api.ts#L47)
+
 ___
 
 ### getUserList
@@ -90,3 +136,7 @@ Call to retrieve a list of users determined by the query object.
 
 A promise containing the UserListResponse is returned. In case of an error,
 the promise is rejected.
+
+#### Defined in
+
+[lib/widget-api.ts:56](https://github.com/Staffbase/widget-sdk/blob/7bb16cc/lib/widget-api.ts#L56)

package/package.json

@@ -1,13 +1,18 @@
 {
   "name": "@staffbase/widget-sdk",
-  "version": "3.3.5",
+  "version": "3.4.0-alpha.13",
   "description": "Staffbase SDK for Custom Widgets",
+  "module": "./dist/index.js",
+  "main": "./dist/index.js",
+  "exports": "./dist/index.js",
+  "typings": "./dist/index.d.ts",
+  "type": "module",
   "keywords": [
     "web-components"
   ],
   "scripts": {
     "clean-doc": "npx rimraf docs",
-    "doc": "npm run clean-doc && typedoc --out docs index.d.ts --plugin typedoc-plugin-markdown --readme none --disableSources --theme ./node_modules/typedoc-github-wiki-theme/dist",
+    "doc": "npm run clean-doc && typedoc --theme github-wiki --readme none --out docs lib/index.ts",
     "release": "semantic-release",
     "prepare": "husky install"
   },
@@ -18,17 +23,17 @@
     "@types/json-schema": "^7.0.9"
   },
   "devDependencies": {
-    "@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.36",
+    "@amanda-mitchell/semantic-release-npm-multiple": "2.17.0",
+    "@commitlint/cli": "16.1.0",
+    "@commitlint/config-conventional": "16.0.0",
+    "@tmware/semantic-release-npm-github-publish": "1.5.0",
+    "@types/react": "^17.0.38",
     "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"
+    "semantic-release": "^19.0.2",
+    "typedoc": "0.22.11",
+    "typedoc-github-wiki-theme": "1.0.0",
+    "typedoc-plugin-markdown": "3.11.12",
+    "typescript": "^4.5.5"
   },
   "repository": {
     "type": "git",

package/.commitlintrc.json

@@ -1,28 +0,0 @@
-{
-  "extends": ["@commitlint/config-conventional"],
-  "rules": {
-    "subject-case": [
-      2,
-      "always",
-      ["sentence-case", "start-case", "pascal-case", "upper-case", "lower-case"]
-    ],
-    "type-enum": [
-      2,
-      "always",
-      [
-        "build",
-        "chore",
-        "ci",
-        "docs",
-        "feat",
-        "fix",
-        "perf",
-        "refactor",
-        "revert",
-        "style",
-        "test",
-        "sample"
-      ]
-    ]
-  }
-}

package/.github/CODEOWNERS

@@ -1 +0,0 @@
-*       @Staffbase/need-for-speed-devs

package/.github/workflows/ci.yaml

@@ -1,61 +0,0 @@
-# This workflow will do a clean install of node dependencies, build the source code and run tests across different versions of node
-# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
-
-name: Continous Integration
-
-on:
-  push:
-    branches:
-      - '**'
-
-env:
-  GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
-  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-jobs:
-  test:
-    name: Build and Test
-    runs-on: ubuntu-20.04
-
-    steps:
-    - uses: actions/checkout@v2
-    - name: Use Node.js
-      uses: actions/setup-node@v2
-      with:
-        node-version: 14.x
-
-    - name: Install dependencies
-      env:
-        GITHUB_ACCESS_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        CI_BRANCH_BASE: ${{ steps.fetch_pr.outputs.pr_base || 'master' }}
-      run: npm install
-
-  release:
-    name: Release
-    needs: test
-    runs-on: ubuntu-20.04
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          token: ${{ secrets.GH_TOKEN_SEMANTIC_RELEASE }}
-          fetch-depth: 0
-
-      - uses: actions/setup-node@v2
-        with:
-          node-version: 14.x
-
-      - name: Install dependencies
-        run: npm install
-
-      - name: Remove NPM publish
-        if: ${{ github.ref == 'refs/heads/alpha' }}
-        run: "sed -i '/public:/d' .releaserc"
-
-      - name: Release
-        run: npm run release
-        env:
-          GH_TOKEN: ${{ secrets.GH_TOKEN }}
-          GITHUB_NPM_CONFIG_REGISTRY: https://npm.pkg.github.com/
-          GITHUB_NPM_TOKEN: ${{ secrets.GH_TOKEN }}
-          PUBLIC_NPM_CONFIG_REGISTRY: https://registry.npmjs.org
-          PUBLIC_NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/dependency-update.yml

@@ -1,24 +0,0 @@
-name: Dependency Update
-
-on:
-  schedule:
-    - cron: "0 12 * * 3" # every Wednesday at 12pm UTC
-  workflow_dispatch:
-
-env:
-  NPM_TOKEN: ${{ secrets.STAFFBOT_NPM_TOKEN_PACKAGE_READ }}
-  GITHUB_TOKEN: ${{ secrets.STAFFBOT_GITHUB_TOKEN }}
-
-jobs:
-  npm-audit-fix:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          persist-credentials: false
-      - uses: Staffbase/npm-audit-fix-action@v3.3.0
-        with:
-          github_token: ${{ secrets.STAFFBOT_GITHUB_TOKEN }}
-          github_user: "Staffbot"
-          github_email: "staffbot@staffbase.com"
-          labels: "dependencies, javascript, security, dev"

package/.husky/commit-msg

@@ -1,6 +0,0 @@
-#!/bin/sh
-. "$(dirname "$0")/_/husky.sh"
-
-[ -n "$CI" ] && exit 0
-
-npx --no-install commitlint --edit "$1"

package/.releaserc

@@ -1,38 +0,0 @@
-tagFormat: ${version}
-debug: true
-dryRun: false
-extends: '@tmware/semantic-release-npm-github-publish'
-plugins:
-  - - '@semantic-release/commit-analyzer'
-    - releaseRules:
-      - type: "build"
-        release: false
-      - type: "ci"
-        release: false
-      - type: "chore"
-        release: false
-      - type: "docs"
-        release: "patch"
-      - type: "refactor"
-        release: false
-      - type: "style"
-        release: false
-      - type: "test"
-        release: false
-
-  - '@semantic-release/release-notes-generator'
-  - '@semantic-release/changelog'
-  - - '@amanda-mitchell/semantic-release-npm-multiple'
-    - registries:
-        github: {}
-        public: {}
-  - - '@semantic-release/git'
-    - assets:
-        - package.json
-        - package-lock.json
-        - CHANGELOG.md
-      message: |-
-        release(version): Release ${nextRelease.version} [skip ci]
-
-        ${nextRelease.notes}
-  - '@semantic-release/github'