@ichicraft/widgets-widget-base 1.10.5 → 1.10.7

package/README.md

@@ -9,6 +9,14 @@ 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.10.7 - 2024-08-20
+
+-   Replaced `onInit` function with a new asynchronous `init` function in the `BaseWidget` class, to allow waiting until initialization is complete.
+
+## 1.10.6 - 2024-08-19
+
+-   Added `userDisplayName` property to the `WidgetContext` interface, to allow using the currently signed-in user's display name in widgets.
+
 ## 1.10.5 - 2024-08-07
 
 -   Added `onSearch` property to the `CommandBarSearchItem` interface, to allow executing a callback when the user presses enter in the search box.

package/lib/BaseWidget.d.ts

@@ -2,7 +2,7 @@ import { WidgetContext, ValidationResult, ExportData } from './types';
 export default abstract class BaseWidget {
     protected readonly context: WidgetContext;
     constructor(context: WidgetContext);
-    protected onInit(): Promise<void>;
+    abstract init(): Promise<void>;
     abstract render(domElement: HTMLDivElement): void;
     verifyPersistedUserConfiguration?(config: string): Promise<boolean>;
     renderUserConfigurationForm?(domElement: HTMLDivElement): void;

package/lib/BaseWidget.js

@@ -1,51 +1,9 @@
 "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());
-    });
-};
-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;
-    return g = { next: verb(0), "throw": verb(1), "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 });
 var BaseWidget = /** @class */ (function () {
     function BaseWidget(context) {
         this.context = context;
-        this.onInit();
     }
-    BaseWidget.prototype.onInit = function () {
-        return __awaiter(this, void 0, void 0, function () { return __generator(this, function (_a) {
-            return [2 /*return*/];
-        }); });
-    };
     return BaseWidget;
 }());
 exports.default = BaseWidget;

package/lib/types/index.d.ts

@@ -71,7 +71,14 @@ export interface WidgetContext {
      */
     siteUrl: string;
     /**
-     * User name of the currently signed in user
+     * Display name of the currently signed in user
+     *
+     * @remarks
+     * Example: `"Alex Wilber"`
+     */
+    userDisplayName: string;
+    /**
+     * User principal name of the currently signed in user
      */
     userName: string;
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@ichicraft/widgets-widget-base",
-    "version": "1.10.5",
+    "version": "1.10.7",
     "description": "Part of the Widget Development Kit for building widgets for Ichicraft Boards",
     "main": "lib/index.js",
     "types": "lib/index.d.ts",