@ichicraft/widgets-widget-base 1.11.6 → 1.13.0

package/README.md

@@ -9,6 +9,17 @@ 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.13.0 - 2025-02-17
+-   Fixed an issue with detecting external users in `UserHelper`
+-   Changed target JavaScript version to `ES6`
+
+## 1.12.0 - 2025-02-11
+
+-   Added `ColorOption` interface.
+-   Added `WidgetDesignContext` interface.
+-   Added `design` property of type `WidgetDesignContext` to `WidgetContext` interface, to support UI settings within widgets.
+-   Deprecated `elementBorderRadius` property which is renamed to `borderRadius` and moved under `design` property in `WidgetContext` interface.
+
 ## 1.11.6 - 2025-01-30
 
 -   Added `spServiceScope` property to `WidgetContext` interface.

package/lib/BaseWidget.js

@@ -1,9 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var BaseWidget = /** @class */ (function () {
-    function BaseWidget(context) {
+class BaseWidget {
+    constructor(context) {
         this.context = context;
     }
-    return BaseWidget;
-}());
+}
 exports.default = BaseWidget;

package/lib/types/index.d.ts

@@ -33,6 +33,10 @@ export interface WidgetContext {
      * can exist in a widget board configuration.
      */
     manifest: WidgetManifestContext;
+    /**
+     * Metadata in the context of the user's current theme, e.g. color settings and the preferred border radius for UI elements.
+     */
+    design: WidgetDesignContext;
     /**
      * Tells whether the widget board is running in a Teams context
      */
@@ -158,7 +162,8 @@ export interface WidgetContext {
         isCurrent?: boolean;
     }[];
     /**
-     * Preferred border radius of UI elements as configured in Widget Board configuration
+     * Preferred border radius of UI elements as configured in Widget Board configuration.
+     * @deprecated This property has been moved under `design`.
      */
     elementBorderRadius: number;
     /**
@@ -419,6 +424,21 @@ export interface WidgetManifestContext {
      */
     id: string;
 }
+export interface WidgetDesignContext {
+    /** Available options in the ColorPicker.*/
+    colorOptions: ColorOption[];
+    /** Preferred border radius of UI elements.*/
+    borderRadius: number;
+    /** The height of a single row in the board grid. Use this to determine how many columns high a widget is. */
+    rowHeight: number;
+    /** Design settings related to icon badges. */
+    badge: {
+        /** Background color of an icon badge. */
+        color: string;
+        /** Inner text color of an icon badge. */
+        textColor: string;
+    };
+}
 export interface ValidationResult {
     isValid: boolean;
     errors: string[];
@@ -888,3 +908,8 @@ export interface BadgeProperties {
     count?: number;
     color?: string;
 }
+export interface ColorOption {
+    id: string;
+    title: string;
+    color: string;
+}

package/lib/utils/ConfigurationHelper.js

@@ -5,21 +5,18 @@ exports.ConfigurationHelper = void 0;
  * @class
  * Helper class for Configuration related things.
  */
-var ConfigurationHelper = /** @class */ (function () {
-    function ConfigurationHelper() {
-    }
+class ConfigurationHelper {
     /**
      *
      * @param config The serialized configuration to parse into an object
      * @param schema Deprecated: schema validation is no longer possible
      */
-    ConfigurationHelper.parseConfiguration = function (config, schema) {
-        var data = JSON.parse(config ? config : '{}');
+    static parseConfiguration(config, schema) {
+        const data = JSON.parse(config ? config : '{}');
         return data;
-    };
-    ConfigurationHelper.stringifyConfiguration = function (config) {
+    }
+    static stringifyConfiguration(config) {
         return JSON.stringify(config);
-    };
-    return ConfigurationHelper;
-}());
+    }
+}
 exports.ConfigurationHelper = ConfigurationHelper;

package/lib/utils/UserHelper.js

@@ -8,132 +8,83 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
-    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (g && (g = 0, op[0] && (_ = 0)), _) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UserHelper = void 0;
-var types_1 = require("../types");
+const types_1 = require("../types");
 /**
  * @class
  * Helper class for User related methods.
  */
-var UserHelper = /** @class */ (function () {
-    function UserHelper() {
-    }
-    UserHelper.isCurrentUserInScope = function (personas, context) {
-        return __awaiter(this, void 0, void 0, function () {
-            var userIsPartOfThis, i, personaItem, _a, userIsMemberOfSPGroup, personaItemId, userIsMemberOfSecGroup;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        userIsPartOfThis = false;
-                        i = 0;
-                        _b.label = 1;
-                    case 1:
-                        if (!(i < personas.length)) return [3 /*break*/, 9];
-                        personaItem = personas[i];
-                        _a = personaItem.type;
-                        switch (_a) {
-                            case types_1.ICPersonaType.SPGroup: return [3 /*break*/, 2];
-                            case types_1.ICPersonaType.User: return [3 /*break*/, 4];
-                            case types_1.ICPersonaType.Other: return [3 /*break*/, 5];
-                            case null: return [3 /*break*/, 5];
-                        }
-                        return [3 /*break*/, 7];
-                    case 2: return [4 /*yield*/, context.isCurrentUserMemberOfSPGroup(Number.parseInt(personaItem.id))];
-                    case 3:
-                        userIsMemberOfSPGroup = _b.sent();
+class UserHelper {
+    static isCurrentUserInScope(personas, context) {
+        return __awaiter(this, void 0, void 0, function* () {
+            let userIsPartOfThis = false;
+            for (let i = 0; i < personas.length; i++) {
+                const personaItem = personas[i];
+                switch (personaItem.type) {
+                    case types_1.ICPersonaType.SPGroup: {
+                        const userIsMemberOfSPGroup = yield context.isCurrentUserMemberOfSPGroup(Number.parseInt(personaItem.id));
                         if (userIsMemberOfSPGroup) {
                             userIsPartOfThis = true;
                         }
-                        return [3 /*break*/, 7];
-                    case 4:
-                        {
-                            // handle a username exact match and partial match in case picker is in format 'i:0#.f|membership|USERNAME'
-                            if (personaItem.id.toLowerCase() === context.userName.toLowerCase() ||
-                                personaItem.id.toLowerCase() ===
-                                    context.claimBasedLoginName.toLowerCase() ||
-                                (personaItem.id.indexOf('|') > -1 &&
-                                    personaItem.id
-                                        .toLowerCase()
-                                        .endsWith('|' + context.userName.toLowerCase()))) {
-                                userIsPartOfThis = true;
-                            }
-                            return [3 /*break*/, 7];
+                        break;
+                    }
+                    case types_1.ICPersonaType.User: {
+                        // handle a username exact match and partial match in case picker is in format 'i:0#.f|membership|USERNAME'
+                        if (personaItem.id.toLowerCase() === context.userName.toLowerCase() ||
+                            personaItem.id.toLowerCase() ===
+                                context.claimBasedLoginName.toLowerCase() ||
+                            (personaItem.id.indexOf('|') > -1 &&
+                                personaItem.id
+                                    .toLowerCase()
+                                    .endsWith('|' + context.userName.toLowerCase()))) {
+                            userIsPartOfThis = true;
                         }
-                        _b.label = 5;
-                    case 5:
-                        personaItemId = personaItem.id;
-                        // Check if this is the infamous "Everyone except external users" group, in which case we need special treatment
+                        break;
+                    }
+                    case types_1.ICPersonaType.Other:
+                    case null: {
+                        let personaItemId = personaItem.id;
+                        // Check if this is the infamous "Everyone except external users" group,
+                        // in which case we need special treatment to check if the user is internal
                         if (personaItemId.indexOf('c:0-.f|rolemanager|spo-grid-all-users/') === 0) {
                             // There you have it: we need special treatment.
                             // If this is an external user, break, otherwise, assume user is member of group
-                            if (context.claimBasedLoginName.indexOf('#ext#') === -1) {
-                                // This is an internal user
+                            if (context.claimBasedLoginName.toLocaleLowerCase().indexOf('#ext#') === -1) {
+                                // This is an internal user and thus a member of the group
                                 userIsPartOfThis = true;
                             }
-                            return [3 /*break*/, 7];
+                            break;
                         }
                         // Check if the id of the picker item contains a pipe, this means we need to strip the id
                         if (personaItemId.indexOf('|') > -1) {
                             personaItemId = personaItemId.split('|').slice(-1)[0];
                         }
-                        return [4 /*yield*/, context.isCurrentUserMemberOfSecGroup(personaItemId)];
-                    case 6:
-                        userIsMemberOfSecGroup = _b.sent();
+                        const userIsMemberOfSecGroup = yield context.isCurrentUserMemberOfSecGroup(personaItemId);
                         if (userIsMemberOfSecGroup) {
                             userIsPartOfThis = true;
                         }
-                        return [3 /*break*/, 7];
-                    case 7:
-                        if (userIsPartOfThis)
-                            return [3 /*break*/, 9];
-                        _b.label = 8;
-                    case 8:
-                        i++;
-                        return [3 /*break*/, 1];
-                    case 9: return [2 /*return*/, userIsPartOfThis];
+                        break;
+                    }
                 }
-            });
+                if (userIsPartOfThis)
+                    break;
+            }
+            return userIsPartOfThis;
         });
-    };
-    UserHelper.gatherAllNormalizedUserPersonaIds = function (userName, claimBasedLoginName, spGroups, secGroups) {
-        var personas = [];
+    }
+    static gatherAllNormalizedUserPersonaIds(userName, claimBasedLoginName, spGroups, secGroups) {
+        const personas = [];
         // 1. The user name in two known shapes
-        personas.push("USER|".concat(userName.toLowerCase()));
-        personas.push("USER|".concat(claimBasedLoginName.toLowerCase()));
+        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|".concat(spg));
+        spGroups.forEach((spg) => {
+            personas.push(`SPGROUP|${spg}`);
         });
         // 3. The Security Groups, as Guids
-        secGroups.forEach(function (secg) {
-            personas.push("ADGROUP|".concat(secg.toLowerCase()));
+        secGroups.forEach((secg) => {
+            personas.push(`ADGROUP|${secg.toLowerCase()}`);
         });
         // 4. Optionally the all users except external users group:
         if (claimBasedLoginName.indexOf('#ext#') === -1) {
@@ -141,7 +92,6 @@ var UserHelper = /** @class */ (function () {
             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.11.6",
+    "version": "1.13.0",
     "description": "Part of the Widget Development Kit for building widgets for Ichicraft Boards",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",