@ichicraft/widgets-widget-base 1.16.6 → 1.17.0

package/README.md

@@ -9,6 +9,10 @@ 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.17.0 - 2026-07-16
+
+-   Moved `UserHelper`, `ICPersona`, `ICPersonaType`, `ICSite`, `ICTeam` and `ICTerm` to an internal package.
+
 ## 1.16.6 - 2026-06-03
 
 -   Replaced unused `design.header.activeTextColor` with `design.header.subTextColor`

package/lib/types/index.d.ts

@@ -216,6 +216,11 @@ export interface WidgetContext {
      * Provide the id of the SP Group.
      */
     isCurrentUserMemberOfSPGroup?: (groupId: number) => Promise<boolean>;
+    /**
+     * Returns whether or not the currently signed in user is part of a Bloom Group.
+     * Provide the id (GUID) of the Bloom Group.
+     */
+    isCurrentUserMemberOfBloomGroup?: (groupId: string) => Promise<boolean>;
     /**
      * Generates a hash of all combined SP Groups of the current user. This can be used as
      * cache invalidator to detect changes.
@@ -445,7 +450,7 @@ export interface WidgetVariantContext {
     /**
      * A list of administrators able to edit the admin configuration of this widget variant.
      */
-    administrators?: ICPersona[];
+    administrators?: any[];
     /**
      * The icon defined for this widget variant.
      */
@@ -714,46 +719,6 @@ export interface WidgetDebugServeConfig {
      */
     debugComponentType?: DebugComponentType;
 }
-export declare enum ICPersonaType {
-    User = 0,
-    SPGroup = 1,
-    Other = 2,
-    Custom = 3
-}
-export interface ICPersona {
-    displayName: string;
-    id: string;
-    type?: ICPersonaType;
-    objectId?: string;
-}
-/**
- * Represents a SharePoint site.
- */
-export interface ICSite {
-    id: string;
-    displayName?: string;
-    url?: string;
-}
-/**
- * Represents a Microsoft Teams team.
- */
-export interface ICTeam {
-    id: string;
-    displayName?: string;
-    url?: string;
-}
-/**
- * Represents a SharePoint Taxonomy Term.
- */
-export interface ICTerm {
-    id: string;
-    displayName?: string;
-    path?: string;
-    termSetId: string;
-    termSetDisplayName?: string;
-    /** Was this term checked in an indeterminate state? Used e.g. when you only want to select the term itself, not its children. */
-    isIndeterminate?: boolean;
-}
 /**
  * Tells the severity of the command bar item, resulting in
  * distinguishable presentation of the item

package/lib/types/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommandBarItemType = exports.CustomCommandBarItemSeverity = exports.ICPersonaType = exports.DebugComponentType = void 0;
+exports.CommandBarItemType = exports.CustomCommandBarItemSeverity = exports.DebugComponentType = void 0;
 var DebugComponentType;
 (function (DebugComponentType) {
     /**
@@ -13,13 +13,6 @@ var DebugComponentType;
      */
     DebugComponentType["AdminConfig"] = "AdminConfig";
 })(DebugComponentType || (exports.DebugComponentType = DebugComponentType = {}));
-var ICPersonaType;
-(function (ICPersonaType) {
-    ICPersonaType[ICPersonaType["User"] = 0] = "User";
-    ICPersonaType[ICPersonaType["SPGroup"] = 1] = "SPGroup";
-    ICPersonaType[ICPersonaType["Other"] = 2] = "Other";
-    ICPersonaType[ICPersonaType["Custom"] = 3] = "Custom";
-})(ICPersonaType || (exports.ICPersonaType = ICPersonaType = {}));
 /**
  * Tells the severity of the command bar item, resulting in
  * distinguishable presentation of the item

package/lib/utils/index.d.ts

@@ -1,2 +1 @@
 export * from './ConfigurationHelper';
-export * from './UserHelper';

package/lib/utils/index.js

@@ -15,4 +15,3 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ConfigurationHelper"), exports);
-__exportStar(require("./UserHelper"), exports);

package/package.json

@@ -1,12 +1,15 @@
 {
     "name": "@ichicraft/widgets-widget-base",
-    "version": "1.16.6",
+    "version": "1.17.0",
     "description": "Part of the Widget Development Kit for building widgets for Bloom Intranet",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
     "scripts": {
-        "build": "tsc",
-        "prepare": "tsc"
+        "build": "tsc --build --force --verbose",
+        "build:watch": "tsc  --build --force --verbose --watch",
+        "clean": "rimraf lib",
+        "pretty": "prettier --write \"./**/*.{js,jsx,mjs,cjs,ts,tsx,json}\"",
+        "prepublishOnly": "npm run clean && npm run build"
     },
     "keywords": [
         "ichicraft",

package/lib/utils/UserHelper.d.ts

@@ -1,9 +0,0 @@
-import { ICPersona, WidgetContext } from '../types';
-/**
- * @class
- * Helper class for User related methods.
- */
-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

@@ -1,97 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserHelper = void 0;
-const types_1 = require("../types");
-/**
- * @class
- * Helper class for User related methods.
- */
-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;
-                        }
-                        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;
-                        }
-                        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.toLocaleLowerCase().indexOf('#ext#') === -1) {
-                                // This is an internal user and thus a member of the group
-                                userIsPartOfThis = true;
-                            }
-                            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];
-                        }
-                        const userIsMemberOfSecGroup = yield context.isCurrentUserMemberOfSecGroup(personaItemId);
-                        if (userIsMemberOfSecGroup) {
-                            userIsPartOfThis = true;
-                        }
-                        break;
-                    }
-                }
-                if (userIsPartOfThis)
-                    break;
-            }
-            return userIsPartOfThis;
-        });
-    }
-    static gatherAllNormalizedUserPersonaIds(userName, claimBasedLoginName, spGroups, secGroups) {
-        const 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((spg) => {
-            personas.push(`SPGROUP|${spg}`);
-        });
-        // 3. The Security Groups, as Guids
-        secGroups.forEach((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;
-    }
-}
-exports.UserHelper = UserHelper;