@staffbase/widget-sdk 3.4.0-beta.3 → 3.4.0-beta.7

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, IntegrationToken, IntegrationType, 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,15 +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")
-     * @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/docs/.nojekyll

@@ -0,0 +1 @@
+TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.