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

package/{lib/widget-api-types.ts → dist/widget-api-types.d.ts}

@@ -10,19 +10,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
 /**
  * File type entity
  */
 export interface SBFileType {
-    default: string,
-    ppt: string,
-    xls: string,
-    doc: string,
-    pdf: string,
-    img: string
+    default: string;
+    ppt: string;
+    xls: string;
+    doc: string;
+    pdf: string;
+    img: string;
 }
-
 /**
  * Detailed colors entity definition
  * @param clientForeground This color is meant to be used for foreground elements and is either black or white depending
@@ -37,64 +35,63 @@ export interface SBFileType {
  *
  */
 export interface SBColors {
-    fileType: SBFileType,
-    backdrop: string,
-    backgroundField: string,
-    backgroundFieldLight: string,
-    backgroundPrimary: string,
-    backgroundSecondary: string,
-    backgroundTertiary: string,
-    black: string,
-    borderSolid: string,
-    borderTranslucent: string,
-    clientForeground: string,
-    clientPrimary: string,
-    clientPrimaryA11y: string,
-    clientSecondary: string,
-    clientSecondaryA11y: string,
-    textPlaceholder: string,
-    textPrimary: string,
-    textSecondary: string,
-    textTertiary: string,
-    pressedState: string,
-    hoverState: string,
-    backgroundBase: string,
-    backgroundLevel1: string,
-    backgroundLevel2: string,
-    backgroundLevel3: string,
-    backgroundLevel4: string,
-    blue: string,
-    blueDark: string,
-    blueLight: string,
-    green: string,
-    greenDark: string,
-    greenLight: string,
-    grey: string,
-    greyDark: string,
-    greyLight: string,
-    hairline: string,
-    hairlineDark: string,
-    neutral: string,
-    neutralDark: string,
-    neutralLight: string,
-    orange: string,
-    orangeDark: string,
-    orangeLight: string,
-    overlay: string,
-    overlayDark: string,
-    red: string,
-    redDark: string,
-    redLight: string,
-    text: string,
-    textGreyBase: string,
-    textGreyLevel1: string,
-    textGreyLevel2: string,
-    textGreyLevel3: string,
-    textGreyLevel4: string,
-    textLight: string,
-    warningYellow: string
+    fileType: SBFileType;
+    backdrop: string;
+    backgroundField: string;
+    backgroundFieldLight: string;
+    backgroundPrimary: string;
+    backgroundSecondary: string;
+    backgroundTertiary: string;
+    black: string;
+    borderSolid: string;
+    borderTranslucent: string;
+    clientForeground: string;
+    clientPrimary: string;
+    clientPrimaryA11y: string;
+    clientSecondary: string;
+    clientSecondaryA11y: string;
+    textPlaceholder: string;
+    textPrimary: string;
+    textSecondary: string;
+    textTertiary: string;
+    pressedState: string;
+    hoverState: string;
+    backgroundBase: string;
+    backgroundLevel1: string;
+    backgroundLevel2: string;
+    backgroundLevel3: string;
+    backgroundLevel4: string;
+    blue: string;
+    blueDark: string;
+    blueLight: string;
+    green: string;
+    greenDark: string;
+    greenLight: string;
+    grey: string;
+    greyDark: string;
+    greyLight: string;
+    hairline: string;
+    hairlineDark: string;
+    neutral: string;
+    neutralDark: string;
+    neutralLight: string;
+    orange: string;
+    orangeDark: string;
+    orangeLight: string;
+    overlay: string;
+    overlayDark: string;
+    red: string;
+    redDark: string;
+    redLight: string;
+    text: string;
+    textGreyBase: string;
+    textGreyLevel1: string;
+    textGreyLevel2: string;
+    textGreyLevel3: string;
+    textGreyLevel4: string;
+    textLight: string;
+    warningYellow: string;
 }
-
 /**
  * The color theme allows the widget to mimic the look
  * and feel of the Staffbase ecosystem it was added to.
@@ -102,14 +99,13 @@ export interface SBColors {
 export interface ColorTheme {
     bgColor: string;
     textColor: string;
-    colors: SBColors,
+    colors: SBColors;
     bgColorDarkened1?: string;
-    bgColorDarkened2?: string,
+    bgColorDarkened2?: string;
     bgColorDarkened2Opaque?: string;
     bgColorLum?: string;
     outlineColor?: string;
 }
-
 /**
  * Image entity definition
  */
@@ -121,7 +117,6 @@ export interface SBImageEntity {
     url: string;
     width: number;
 }
-
 /**
  * User avatar definition
  */
@@ -131,7 +126,6 @@ export interface SBUserAvatar {
     publicID: string;
     thumb: SBImageEntity;
 }
-
 /**
  * User profile data
  */
@@ -145,7 +139,6 @@ export interface SBUserProfile {
     avatar?: SBUserAvatar;
     department?: string;
 }
-
 /**
  * The sorting order of the user list.
  *
@@ -153,18 +146,16 @@ export interface SBUserProfile {
  * @param created sort by date of creation descending
  * @param updated sort by date of last update descending
  */
-export type UserListSorting = 'lastname' | 'created' | 'updated';
-
+export declare type UserListSorting = 'lastname' | 'created' | 'updated';
 /**
  * User list request parameters
  */
- export interface UserListRequestQuery {
+export interface UserListRequestQuery {
     limit?: number;
     offset?: number;
     sort?: UserListSorting;
     filter?: string;
 }
-
 /**
  * Single user item
  */
@@ -174,7 +165,6 @@ export interface UserListItem {
     lastName?: string;
     entityType?: string;
 }
-
 /**
  * Responded user list
  */
@@ -184,3 +174,29 @@ export interface UserListResponse {
     limit: number;
     total: number;
 }
+export declare type IntegrationType = "ms365";
+/**
+ * Integration Token including the expiration time
+ */
+export interface IntegrationToken {
+    accessToken: string;
+    accessTokenExpiresAt?: Date;
+}
+/**
+ * All available states the integration can take
+ */
+export declare enum IntegrationState {
+    UNAVAILABLE = "unavailable",
+    AVAILABLE = "available",
+    LOGGED_OUT = "loggedOut"
+}
+/**
+ * Information about the requested Integration target
+ */
+export interface IntegrationInformation {
+    status: IntegrationState;
+    enabledFeatures: string[];
+    supportedFeatures: string[];
+    token?: IntegrationToken;
+    signIn?: () => void;
+}

package/dist/widget-api-types.js

@@ -0,0 +1,21 @@
+/*!
+ * Copyright 2021, Staffbase GmbH and contributors.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * All available states the integration can take
+ */
+export var IntegrationState;
+(function (IntegrationState) {
+    IntegrationState["UNAVAILABLE"] = "unavailable";
+    IntegrationState["AVAILABLE"] = "available";
+    IntegrationState["LOGGED_OUT"] = "loggedOut";
+})(IntegrationState || (IntegrationState = {}));

package/{lib/widget-api.ts → dist/widget-api.d.ts}

@@ -10,10 +10,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-
-import { ColorTheme, SBUserProfile, UserListRequestQuery, UserListResponse } from './widget-api-types';
-
-
+import { ColorTheme, IntegrationInformation, IntegrationType, SBUserProfile, UserListRequestQuery, UserListResponse } from './widget-api-types';
 /**
  * Widget API class.
  *
@@ -27,7 +24,6 @@ export interface WidgetApi {
      * @returns An object containing the color theme data is returned.
      */
     getLegacyAppTheme(): ColorTheme;
-
     /**
      * Call to retrieve the user profile of the current or a specific user.
      *
@@ -36,7 +32,6 @@ export interface WidgetApi {
      * the promise is rejected.
      */
     getUserInformation(userId?: string): Promise<SBUserProfile>;
-
     /**
      * Call to retrieve a user profile by its external ID.
      *
@@ -45,7 +40,6 @@ export interface WidgetApi {
      * the promise is rejected.
      */
     getUserInformationByExternalId(externalId: string): Promise<SBUserProfile>;
-
     /**
      * Call to retrieve a list of users determined by the query object.
      *
@@ -54,5 +48,21 @@ export interface WidgetApi {
      * the promise is rejected.
      */
     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")
+     * @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, refresh?: boolean): Promise<IntegrationInformation>;
 }

package/dist/widget-api.js

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2021, Staffbase GmbH and contributors.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};