@ichicraft/widgets-widget-base 1.11.5 → 1.12.0

package/README.md

@@ -9,6 +9,20 @@ 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.12.0 - 2025-02-11
+
+-   Added `ColorOption` interface.
+-   Added `WidgetDesignContext` interface.
+-   Added `design` property of type `WidgetDesignContext` to `WidgetContext` interface, to support UI settings within widgets.
+-   Deprecated `elementBorderRadius` property which is renamed to `borderRadius` and moved under `design` property in `WidgetContext` interface.
+
+## 1.11.6 - 2025-01-30
+
+-   Added `spServiceScope` property to `WidgetContext` interface.
+-   Added `loadComponentById` function to `WidgetContext` interface.
+-   Deprecated `definition` property which is replaced by `variant` property in `WidgetContext` interface.
+-   Deprecated `instance.publishNotification` function in `WidgetContext` interface because feature is no longer available.
+
 ## 1.11.5 - 2025-01-21
 
 -   Added `defaultColor` property to `WidgetBuddyContext` interface.

package/lib/types/index.d.ts

@@ -8,7 +8,7 @@ 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 their board. It has its own
-     * unique ID and possibly configuration data if the widget is configurable by the user
+     * unique ID and possibly configuration data if the widget is configurable by the user.
      */
     instance: WidgetInstanceContext;
     /**
@@ -17,16 +17,26 @@ export interface WidgetContext {
      */
     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.
+     * Metadata and functions in the context of a widget's variant (fka 'definition'). A widget variant is
+     * a widget that's been installed and possibly configured by an administrator from within the admin center.
+     * @deprecated Use `variant` instead
      */
-    definition: WidgetVariantContext;
+    definition?: WidgetVariantContext;
+    /**
+     * Metadata and functions in the context of a widget's variant (fka 'definition'). A widget variant is
+     * a widget that's been installed and possibly configured by an administrator from within the admin center.
+     */
+    variant: WidgetVariantContext;
     /**
      * Metadata and functions in the context of a widget's manifest. A widget manifest contains
      * all information of the originally installed widget. Multiple `variants` of the same widget `manifest`
      * can exist in a widget board configuration.
      */
     manifest: WidgetManifestContext;
+    /**
+     * Metadata in the context of the user's current theme, e.g. color settings and the preferred border radius for UI elements.
+     */
+    design: WidgetDesignContext;
     /**
      * Tells whether the widget board is running in a Teams context
      */
@@ -64,7 +74,8 @@ export interface WidgetContext {
      */
     tenantId: string;
     /**
-     * ID of current Ichicraft Boards installation. Could either be a Site Collection ID (SP Shell) or a fixed ID (Teams Shell)
+     * ID of current Ichicraft Boards installation. Could either be a Site Collection ID (SP Shell)
+     * or a fixed ID (Teams Shell)
      */
     boardsInstanceId: string;
     /**
@@ -151,11 +162,13 @@ export interface WidgetContext {
         isCurrent?: boolean;
     }[];
     /**
-     * Preferred border radius of UI elements as configured in Widget Board configuration
+     * Preferred border radius of UI elements as configured in Widget Board configuration.
+     * @deprecated This property has been moved under `design`.
      */
     elementBorderRadius: number;
     /**
-     * Interacts with the SharePoint REST api, such as fetching/updating sites, lists and users.
+     * A multi purpose SharePoint interface that can be used to interact with SharePoint.
+     * It's based on the PnPjs library.
      */
     sp: SPFI;
     /**
@@ -166,6 +179,10 @@ export interface WidgetContext {
      * Provides a set of switches for enabling/disabling various features of the SPHttpClient.
      */
     spHttpClientConfiguration: SPHttpClientConfiguration;
+    /**
+     * SharePoint Service Scope, taken from SPFx WebPart Context. Type is removed to avoid dependency on SPFx.
+     */
+    spServiceScope?: unknown;
     /**
      * MS Graph Client Factory class as provided by the WebPartContext object.
      */
@@ -214,6 +231,10 @@ export interface WidgetContext {
      * Functionality offered by the widget board to load a script using SPComponentLoader.
      */
     loadScript?: <TModule>(url: string, options?: any) => Promise<TModule>;
+    /**
+     * Functionality offered by the widget board to load a publicly available SharePoint component using SPComponentLoader.
+     */
+    loadComponentById?: <TComponent>(id: string, version?: string) => Promise<TComponent>;
     /**
      * Functionality offered by the widget board to open a File Picker panel to select files.
      * @param onFilePicked Function that's called when a file was picked. Returns the url of the picked file.
@@ -273,10 +294,7 @@ export interface WidgetInstanceContext {
      */
     getDeepLinkData?: () => string;
     /**
-     * Call this function from within a widget instance to publish a notification to the
-     * notitication box on top of the widget board. It should provide information for this specific
-     * widget instance. Notitifcation content is limited to one single line and a widget instance
-     * can only have one active notification at a time
+     * @deprecated This feature is no longer available. It will be removed in a future release.
      */
     publishNotification?: (content: string, expirationDateTime: Date) => void;
     /**
@@ -406,6 +424,21 @@ export interface WidgetManifestContext {
      */
     id: string;
 }
+export interface WidgetDesignContext {
+    /** Available options in the ColorPicker.*/
+    colorOptions: ColorOption[];
+    /** Preferred border radius of UI elements.*/
+    borderRadius: number;
+    /** The height of a single row in the board grid. Use this to determine how many columns high a widget is. */
+    rowHeight: number;
+    /** Design settings related to icon badges. */
+    badge: {
+        /** Background color of an icon badge. */
+        color: string;
+        /** Inner text color of an icon badge. */
+        textColor: string;
+    };
+}
 export interface ValidationResult {
     isValid: boolean;
     errors: string[];
@@ -875,3 +908,8 @@ export interface BadgeProperties {
     count?: number;
     color?: string;
 }
+export interface ColorOption {
+    id: string;
+    title: string;
+    color: string;
+}

package/package.json

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