@ichicraft/widgets-widget-base 1.13.1 → 1.14.0

package/README.md

@@ -9,6 +9,12 @@ 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.14.0 - 2025-05-21
+-   Version bumped `@microsoft/sp-http` dependency to latest SPFx version `1.21.1`
+
+## 1.13.2 - 2025-04-11
+-   Minor update in documentation of `WebApiPermissionRequest` interface
+
 ## 1.13.1 - 2025-03-11
 -   Added new interface `ICSite`, used to represent a SharePoint site object in code
 

package/lib/BaseWidget.d.ts

@@ -1,4 +1,4 @@
-import { WidgetContext, ValidationResult, ExportData } from './types';
+import { ExportData, ValidationResult, WidgetContext } from './types';
 export default abstract class BaseWidget {
     protected readonly context: WidgetContext;
     constructor(context: WidgetContext);

package/lib/BaseWidget.js

@@ -1,8 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-class BaseWidget {
+export default class BaseWidget {
     constructor(context) {
         this.context = context;
     }
 }
-exports.default = BaseWidget;

package/lib/index.js

@@ -1,23 +1,2 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BaseWidget = void 0;
-var BaseWidget_1 = require("./BaseWidget");
-Object.defineProperty(exports, "BaseWidget", { enumerable: true, get: function () { return __importDefault(BaseWidget_1).default; } });
-__exportStar(require("./types"), exports);
+export { default as BaseWidget } from './BaseWidget';
+export * from './types';

package/lib/types/index.d.ts

@@ -457,11 +457,16 @@ export interface WidgetResource {
 }
 export interface WebApiPermissionRequest {
     /**
-     * Specifies the name of the resource service principle to wich access has been granted. Use the same principle names as in a SPPKG packages webApiPermissionRequests.
+     * Specifies the name of the API to which access has to be granted.
+     * This can be something like "Microsoft Graph" or "Power BI Service" and is the same
+     * as what's used in the package-solution file in an SPPKG package.
      */
     resource: string;
     /**
-     * Specifies the name of the scope claim that the resource application should expect in the OAuth 2.0 access token. Use the same scope names as in a SPPKG packages webApiPermissionRequests.
+     * Specifies the name of one scope claim that the resource application
+     * should expect in the OAuth 2.0 access token.
+     * This can be something like "User.Read.All" (for Graph) or "Report.Read.All" (for Power BI) and is the same
+     * as what's used in the package-solution file in an SPPKG package.
      */
     scope: string;
 }

package/lib/types/index.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommandBarItemType = exports.CustomCommandBarItemSeverity = exports.ICPersonaType = exports.DebugComponentType = void 0;
-var DebugComponentType;
+export var DebugComponentType;
 (function (DebugComponentType) {
     /**
      * This is the default component type and just opens the default widget board.
@@ -12,29 +9,29 @@ var DebugComponentType;
      * dialog of the widget you're working on
      */
     DebugComponentType["AdminConfig"] = "AdminConfig";
-})(DebugComponentType || (exports.DebugComponentType = DebugComponentType = {}));
-var ICPersonaType;
+})(DebugComponentType || (DebugComponentType = {}));
+export 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 = {}));
+})(ICPersonaType || (ICPersonaType = {}));
 /**
  * Tells the severity of the command bar item, resulting in
  * distinguishable presentation of the item
  */
-var CustomCommandBarItemSeverity;
+export var CustomCommandBarItemSeverity;
 (function (CustomCommandBarItemSeverity) {
     /** Normal severity, displays just like all the other command bar items */
     CustomCommandBarItemSeverity[CustomCommandBarItemSeverity["Normal"] = 0] = "Normal";
     /** Warning severity, displays the item with a more noticable warning color */
     CustomCommandBarItemSeverity[CustomCommandBarItemSeverity["Warning"] = 1] = "Warning";
-})(CustomCommandBarItemSeverity || (exports.CustomCommandBarItemSeverity = CustomCommandBarItemSeverity = {}));
+})(CustomCommandBarItemSeverity || (CustomCommandBarItemSeverity = {}));
 /**
  * Tells how to render the command bar item, e.g. as an icon button or as a link.
  */
-var CommandBarItemType;
+export var CommandBarItemType;
 (function (CommandBarItemType) {
     /** Renders the item as an Icon */
     CommandBarItemType["Icon"] = "icon";
@@ -44,4 +41,4 @@ var CommandBarItemType;
     CommandBarItemType["SearchBar"] = "search-bar";
     /** Renders the item in the overflow menu */
     CommandBarItemType["Overflow"] = "overflow";
-})(CommandBarItemType || (exports.CommandBarItemType = CommandBarItemType = {}));
+})(CommandBarItemType || (CommandBarItemType = {}));

package/lib/utils/ConfigurationHelper.js

@@ -1,11 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfigurationHelper = void 0;
 /**
  * @class
  * Helper class for Configuration related things.
  */
-class ConfigurationHelper {
+export class ConfigurationHelper {
     /**
      *
      * @param config The serialized configuration to parse into an object
@@ -19,4 +16,3 @@ class ConfigurationHelper {
         return JSON.stringify(config);
     }
 }
-exports.ConfigurationHelper = ConfigurationHelper;

package/lib/utils/UserHelper.js

@@ -1,4 +1,3 @@
-"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) {
@@ -8,28 +7,26 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UserHelper = void 0;
-const types_1 = require("../types");
+import { ICPersonaType } from '../types';
 /**
  * @class
  * Helper class for User related methods.
  */
-class UserHelper {
+export 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: {
+                    case ICPersonaType.SPGroup: {
                         const userIsMemberOfSPGroup = yield context.isCurrentUserMemberOfSPGroup(Number.parseInt(personaItem.id));
                         if (userIsMemberOfSPGroup) {
                             userIsPartOfThis = true;
                         }
                         break;
                     }
-                    case types_1.ICPersonaType.User: {
+                    case 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() ===
@@ -42,7 +39,7 @@ class UserHelper {
                         }
                         break;
                     }
-                    case types_1.ICPersonaType.Other:
+                    case ICPersonaType.Other:
                     case null: {
                         let personaItemId = personaItem.id;
                         // Check if this is the infamous "Everyone except external users" group,
@@ -94,4 +91,3 @@ class UserHelper {
         return personas;
     }
 }
-exports.UserHelper = UserHelper;

package/lib/utils/index.js

@@ -1,18 +1,2 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./ConfigurationHelper"), exports);
-__exportStar(require("./UserHelper"), exports);
+export * from './ConfigurationHelper';
+export * from './UserHelper';

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ichicraft/widgets-widget-base",
-    "version": "1.13.1",
+    "version": "1.14.0",
     "description": "Part of the Widget Development Kit for building widgets for Ichicraft Boards",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -22,10 +22,17 @@
         "requirejs": "2.3.7"
     },
     "dependencies": {
-        "@microsoft/sp-http": "1.18.2",
+        "@microsoft/sp-http": "1.21.1",
         "@pnp/sp": "4.0.1"
     },
     "devDependencies": {
-        "typescript": "^5.4.5"
+        "@ianvs/prettier-plugin-sort-imports": "4.4.1",
+        "eslint": "8.57.0",
+        "eslint-config-prettier": "9.1.0",
+        "eslint-plugin-prettier": "5.2.1",
+        "eslint-plugin-react": "7.35.2",
+        "eslint-plugin-react-hooks": "4.6.2",
+        "prettier": "3.3.3",
+        "typescript": "~5.3.3"
     }
 }