@ichicraft/widgets-widget-base 1.11.0 → 1.11.1

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.11.1 - 2024-10-17
+
+-   Made `buddy` property of type `WidgetBuddyContext` optional.
+
 ## 1.11.0 - 2024-10-17
 
 -   Added `renderBuddy` function to the `BaseWidget` class, to support rendering widgets as a buddy.

package/lib/types/index.d.ts

@@ -7,16 +7,15 @@ export type { AadTokenProviderFactory, AadTokenProvider, AadHttpClientFactory, A
 export interface WidgetContext {
     /**
      * Metadata and functions in the context of a widget instance. A widget instance
-     * is a single and specific widget that a user has on his/her board. It has its own
+     * is a single and specific widget that a user has on their board. It has its own
      * unique ID and possibly configuration data if the widget is configurable by the user
      */
     instance: WidgetInstanceContext;
     /**
-     * Metadata and functions in the context of a widget boddy. A widget buddy
-     * is a single and specific widget that a user has on his/her board. It has its own
-     * unique ID and possibly configuration data if the widget is configurable by the user
+     * Metadata and functions in the context of a widget buddy. A widget buddy
+     * is a single and specific widget instance that a user has in their buddy bar.
      */
-    buddy: WidgetBuddyContext;
+    buddy?: WidgetBuddyContext;
     /**
      * Metadata and functions in the context of a widget's variant (fka definition). A widget variant is
      * a widget that's been installed by an administrator from within the board administration.
@@ -357,9 +356,10 @@ export interface WidgetInstanceContext {
 }
 export interface WidgetBuddyContext {
     /**
-     * Allows setting the badge properties of the buddy, e.g. its visibility, count or color.
+     * Allows updating the badge properties of the buddy, e.g. its visibility, count or color.
+     * This will only override the provided properties.
      */
-    setBadgeProperties?: (props: Partial<BadgeProperties>) => void;
+    updateBadgeProperties: (props: Partial<BadgeProperties>) => void;
 }
 /**
  * Widget variant context providing metadata and functionality offered by the widget board. A widget variant is

package/package.json

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