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

package/CHANGELOG.md

@@ -1,3 +1,29 @@
+# [3.4.0-beta.5](https://github.com/Staffbase/widget-sdk/compare/3.4.0-beta.4...3.4.0-beta.5) (2022-01-21)
+
+
+### Code Refactoring
+
+* remove unused import ([5887ace](https://github.com/Staffbase/widget-sdk/commit/5887ace86935f8078b97f33a976ae11a1e26ef58))
+
+
+### Documentation
+
+* fix documentation ([2844477](https://github.com/Staffbase/widget-sdk/commit/2844477028de22386759e13a8c154480a3096aeb))
+
+
+### Features
+
+* add integration state enum ([5c3f4cd](https://github.com/Staffbase/widget-sdk/commit/5c3f4cd836bd96eb2a5615aba0d0d295ff0bf16d))
+* change type signature ([fff78ca](https://github.com/Staffbase/widget-sdk/commit/fff78ca2be153bc06f4d14c5c913650e7ed85f76))
+* extend integration api ([ab53de9](https://github.com/Staffbase/widget-sdk/commit/ab53de9e78f92a09b54cc712fd83bcc948e7e62c))
+* extend integration api ([be172b6](https://github.com/Staffbase/widget-sdk/commit/be172b6809bbe4dfba40e4d24fb5f7b9b420308a))
+* harden return type, add refresh argument ([42719ac](https://github.com/Staffbase/widget-sdk/commit/42719ac56aff63016498b9e3f8d862f07bd5ad52))
+
+
+### Miscellaneous
+
+* Merge branch 'NFS-1519-add-integrations' into beta ([f13d1f4](https://github.com/Staffbase/widget-sdk/commit/f13d1f494b5402a1c37e5aa35fb7fce1e0043499))
+
 # [3.4.0-beta.4](https://github.com/Staffbase/widget-sdk/compare/3.4.0-beta.3...3.4.0-beta.4) (2021-11-23)
 
 

package/lib/widget-api-types.ts

@@ -198,3 +198,28 @@ export interface IntegrationToken {
     // date when the access token expires
     accessTokenExpiresAt?: Date;
 }
+
+/**
+ * All available states the integration can take
+ */
+export enum IntegrationState {
+  UNAVAILABLE = 'unavailable',
+  AVAILABLE = 'available',
+  LOGGED_OUT = 'loggedOut',
+}
+
+/**
+ * Information about the requested Integration target
+ */
+export interface IntegrationInformation {
+    // The status of the integration
+    status: IntegrationState
+    // All features enabled for the current slug
+    enabledFeatures: string[],
+    // All features supported by the integration
+    supportedFeatures: string[],
+    // The integration token
+    token?: IntegrationToken,
+    // A function to trigger the sign-in flow of the integration
+    signIn?: () => void
+}

package/lib/widget-api.ts

@@ -11,7 +11,7 @@
  * limitations under the License.
  */
 
-import { ColorTheme, IntegrationToken, IntegrationType, SBUserProfile, UserListRequestQuery, UserListResponse } from './widget-api-types';
+import { ColorTheme, IntegrationInformation, IntegrationType, SBUserProfile, UserListRequestQuery, UserListResponse } from './widget-api-types';
 
 
 /**
@@ -55,14 +55,21 @@ export interface WidgetApi {
      */
     getUserList(query: UserListRequestQuery): Promise<UserListResponse>;
 
-
     /**
      * Call to retrieve a valid token to access the Microsoft API. Includes a time value to
      * refresh the token.
      *
      * @param type The name of the integration. ("ms365")
-     * @returns A promise containing the IntegrationToken is returned. If the user session is
-     * not existing, null is returned. In case of an error, the promise is rejected.
+     * @param refresh Force a refresh of the integration.
+     *
+     * @returns 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.
+     *
+     * @deprecated Returns a IntegrationToken or null if the user is not logged in. This will be replaced
+     * completely by the IntegrationInformation, containing the token.
      */
-    getIntegration(type: IntegrationType): Promise<IntegrationToken | null>;
+    getIntegration(type: IntegrationType, refresh?: boolean): Promise<IntegrationInformation>;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@staffbase/widget-sdk",
-  "version": "3.4.0-beta.4",
+  "version": "3.4.0-beta.5",
   "description": "Staffbase SDK for Custom Widgets",
   "keywords": [
     "web-components"