@ichicraft/widgets-widget-base 1.9.10 → 1.9.12

package/README.md

@@ -9,6 +9,16 @@ 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.9.12 - 2024-06-17
+
+-   Added `sp` object to `WidgetContext` interface, to allow using a centralized PnPjs version across all widgets.
+-   Added `siteId` property to `WidgetContext` interface.
+-   Added `boardsInstanceId` property to `WidgetContext` interface.
+
+## 1.9.11 - 2024-06-14
+
+-   Fixed handling of null `ICPersonaType` values in `isCurrentUserInScope` function of `UserHelper` class.
+
 ## 1.9.10 - 2024-06-04
 
 -   Renamed `CustomCommandBarItemProps` interface to `CommandBarItemProps`.

package/lib/types/index.d.ts

@@ -1,4 +1,5 @@
 import type { AadHttpClientFactory, AadTokenProviderFactory } from '@microsoft/sp-http';
+import type { SPFI } from '@pnp/sp/fi';
 export type { AadTokenProviderFactory, AadTokenProvider, AadHttpClientFactory, AadHttpClient, AadHttpClientConfiguration, AadHttpClientResponse, } from '@microsoft/sp-http';
 /**
  * Widget context providing widget metadata and functionality offered by the widget board
@@ -21,6 +22,10 @@ export interface WidgetContext {
      * can exist in a widget board configuration.
      */
     manifest: WidgetManifestContext;
+    /**
+     * Interacts with the SharePoint REST api, such as fetching/updating sites, lists and users.
+     */
+    sp: SPFI;
     /**
      * Tells whether the widget board is running in a Teams context
      */
@@ -54,19 +59,27 @@ export interface WidgetContext {
      */
     isMobileWebView: boolean;
     /**
-     * Tenant ID of current SharePoint tenant
+     * Tenant ID of current SharePoint tenant.
      */
     tenantId: string;
     /**
-     * Site url of the site where the widget board is running
+     * ID of current Ichicraft Boards installation. Could either be a Site Collection ID (SP Shell) or a fixed ID (Teams Shell)
+     */
+    boardsInstanceId: string;
+    /**
+     * Site ID of the SharePoint site where the widget board is running
+     */
+    siteId: string;
+    /**
+     * Site url of the SharePoint site where the widget board is running
      */
     siteUrl: string;
     /**
-     * User name of the currently signed in user.
+     * User name of the currently signed in user
      */
     userName: string;
     /**
-     * The email address for the current user.
+     * The email address for the current user
      *
      * @remarks
      * Example: `"example@contoso.com"`

package/lib/utils/UserHelper.js

@@ -62,6 +62,7 @@ var UserHelper = /** @class */ (function () {
                             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))];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ichicraft/widgets-widget-base",
-    "version": "1.9.10",
+    "version": "1.9.12",
     "description": "Part of the Widget Development Kit for building widgets for Ichicraft Boards",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",
@@ -19,7 +19,8 @@
         "lib/**/*"
     ],
     "dependencies": {
-        "@microsoft/sp-http": "1.18.2"
+        "@microsoft/sp-http": "1.18.2",
+        "@pnp/sp": "4.0.1"
     },
     "devDependencies": {
         "typescript": "^5.4.5"