@ichicraft/widgets-widget-base 1.7.4 → 1.7.8

package/README.md

@@ -8,6 +8,21 @@ All notable changes to this project will be documented here.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 1.7.8 - 2022-01-18
+### Changed
+* Added `initiateWidgetDeletion()` function to the `WidgetContext` interface.
+
+## 1.7.7 - 2022-01-14
+### Changed
+* Added `tenantId` property to the `WidgetContext` interface.
+
+## 1.7.6 - 2021-11-04
+### Changed
+* Added `theme` property to the `WidgetContext` interface to give access to currently applied theme.
+
+## 1.7.5 - 2021-10-26
+### Changed
+* Added `userSecurityGroups` and `userSharePointGroups` properties to the `WidgetContext` interface to inform widgets of SharePoint and security group memberships of the current user.
 
 ## 1.7.4 - 2021-10-20
 ### Changed

package/lib/types/index.d.ts

@@ -1,4 +1,5 @@
 import { MSGraphClientFactory, AadTokenProviderFactory, AadHttpClientFactory } from '@microsoft/sp-http';
+import { IReadonlyTheme } from '@microsoft/sp-component-base';
 import * as microsoftTeams from '@microsoft/teams-js';
 /**
  * Widget context providing widget metadata and functionality offered by the widget board
@@ -31,6 +32,11 @@ export interface WidgetContext {
          * menu of the widget.
          */
         openConfiguration?: () => void;
+        /**
+         * Call this function to open the widget delete confirmation dialog for a user. This offers widget developers
+         * the ability to trigger the "widget deletion process". This allows different methods to delete the widget.
+         */
+        initiateWidgetDeletion?: () => void;
         /**
          * Functionality offered by the widget board to open a url in an iframe dialog.
          */
@@ -116,6 +122,10 @@ export interface WidgetContext {
      * Tells whether the widget board is running in a mobile webview context
      */
     isMobileWebView: boolean;
+    /**
+     * Tenant ID of current SharePoint tenant
+     */
+    tenantId: string;
     /**
      * Site url of the site where the widget board is running
      */
@@ -131,10 +141,22 @@ export interface WidgetContext {
      * Example: `"example@contoso.com"`
      */
     userEmail: string;
+    /**
+     * SharePoint ID of the user in the current site
+     */
+    spUserId: number;
     /**
      * Login name of current user in claim style: i:0#.f|myprovider|myuser
      */
     claimBasedLoginName: string;
+    /**
+     * Azure AD Security groups that user is member of
+     */
+    userSecurityGroups: string[];
+    /**
+     * SharePoint groups in this site collection that user is member of
+     */
+    userSharePointGroups: number[];
     /**
      * Language code of currently used UI rendering language in SharePoint
      */
@@ -162,9 +184,13 @@ export interface WidgetContext {
          */
         friendlyName: string;
         /**
-         * Whether this is the default content language of the Widget Board
+         * Whether this is the default UI language of the Widget Board
          */
         isDefault?: boolean;
+        /**
+         * Whether this is the current UI language of the Widget Board
+         */
+        isCurrent?: boolean;
     }[];
     /**
      * MS Graph Client Factory class as provided by the WebPartContext object.
@@ -178,6 +204,10 @@ export interface WidgetContext {
      * AAD Token Provider Factory class as provided by the WebPartContext object.
      */
     aadTokenProviderFactory: AadTokenProviderFactory;
+    /**
+     * Currently in use theme (by SharePoint/Teams)
+     */
+    theme: IReadonlyTheme;
     /**
      * Returns whether or not the currently signed in user is part of an AAD security group.
      * Provide the guid of the group.

package/lib/utils/UserHelper.d.ts

@@ -5,4 +5,5 @@ import { ICPersona, WidgetContext } from '../types';
  */
 export declare class UserHelper {
     static isCurrentUserInScope(personas: ICPersona[], context: WidgetContext): Promise<boolean>;
+    static gatherAllNormalizedUserPersonaIds(userName: string, claimBasedLoginName: string, spGroups: number[], secGroups: string[]): string[];
 }

package/lib/utils/UserHelper.js

@@ -120,6 +120,26 @@ var UserHelper = /** @class */ (function () {
             });
         });
     };
+    UserHelper.gatherAllNormalizedUserPersonaIds = function (userName, claimBasedLoginName, spGroups, secGroups) {
+        var personas = [];
+        // 1. The user name in two known shapes
+        personas.push("USER|" + userName.toLowerCase());
+        personas.push("USER|" + claimBasedLoginName.toLowerCase());
+        // 2. The SP Groups, just as they are: numeric strings
+        spGroups.forEach(function (spg) {
+            personas.push("SPGROUP|" + spg);
+        });
+        // 3. The Security Groups, as Guids
+        secGroups.forEach(function (secg) {
+            personas.push("ADGROUP|" + secg.toLowerCase());
+        });
+        // 4. Optionally the all users except external users group:
+        if (claimBasedLoginName.indexOf('#ext#') === -1) {
+            // This is an internal user
+            personas.push('ADGROUP|spo-grid-all-users');
+        }
+        return personas;
+    };
     return UserHelper;
 }());
 exports.UserHelper = UserHelper;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ichicraft/widgets-widget-base",
-    "version": "1.7.4",
+    "version": "1.7.8",
     "description": "Part of the Widget Development Kit for building widgets for Ichicraft Boards",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -19,8 +19,9 @@
         "lib/**/*"
     ],
     "dependencies": {
-        "@microsoft/sp-http": "^1.11.0",
-        "@microsoft/teams-js": "^1.9.0"
+        "@microsoft/sp-component-base": "^1.11.0",
+        "@microsoft/sp-http": "1.11.0",
+        "@microsoft/teams-js": "1.9.0"
     },
     "devDependencies": {
         "typescript": "^3.6.4"