@ichicraft/widgets-widget-base 1.7.10 → 1.8.1

package/README.md

@@ -8,8 +8,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.7.10 - 2022-03-23
-* Added `hideWidgetHeader()` function to the `instance` object of the `WidgetContext` interface, allowing widgets to render in full height.
+## 1.8.1 - 2022-06-17
+* Added new section `analytics` to `WidgetManifestConfig` interface to allow definition of time-based events that can be raised by a widget.
+* Added `raiseEvent(...)` to the `instance` object of the `WidgetContent` interface, allowing widgets to raise an event.
+
+## 1.7.11 - 2022-03-23
+* Added `setWidgetHeaderVisibilty()` function to the `instance` object of the `WidgetContext` interface, allowing widgets to render in full height.
 
 ## 1.7.9 - 2022-01-20
 * Added `userAccountCreated` date/time to the `WidgetContext` interface.

package/lib/types/index.d.ts

@@ -46,9 +46,9 @@ export interface WidgetContext {
          */
         setWidgetTitle?: (title: string) => void;
         /**
-         * Hide the header of the widget, giving the widget space to grow
+         * Show or hide the header of the widget, allowing widgets to take control of full widget real estate
          */
-        hideWidgetHeader?: () => void;
+        setWidgetHeaderVisibilty?: (visible: boolean) => void;
         /**
          * Optional callback to handle the click event of the widget title
          */
@@ -63,6 +63,16 @@ export interface WidgetContext {
          * Removes the custom command bar item that was added by the [registerCommandBarItem] function
          */
         unregisterCustomCommandBarItem?: () => void;
+        /**
+         * Raises an event to be handled by the Time-based Events feature of Ichicraft Boards.
+         * @param object The object this event concerns (e.g. app, report, newsArticle, ...). Use camelCase.
+         * @param action The action that was performed to/on the object (e.g. viewed, clicked, deleted, ...). Use camelCase.
+         * @param data Optionally provide extra metadata to be included with the raised event.
+         * widgetAlias property (from manifest) and variantTitle property will automatically be added by the widget board.
+         */
+        raiseEvent?: (object: string, action: string, data?: {
+            [key: string]: string;
+        }) => void;
     };
     /**
      * Metadata and functions in the context of a widget's definition. A widget definition is
@@ -402,6 +412,30 @@ export interface WidgetManifestConfig {
             };
         };
     };
+    /**
+     * Everything related to analytics of this widget in Ichicraft Boards
+     */
+    analytics?: {
+        /**
+         * A list of time-based events this widget can raise. All the possible events MUST be
+         * described in this list for the widget board to be able to pick them up.
+         * @ref Use WidgetContext.instance.raiseEvent(object: string, action: string, data?: { [key: string]: string }) to raise these events
+         */
+        timeBasedEvents: {
+            /**
+             * The object this event concerns (e.g. app, report, newsArticle, ...). Use camelCase.
+             */
+            object: string;
+            /**
+             * The action that was performed to/on the object (e.g. viewed, clicked, deleted, ...). Use camelCase.
+             */
+            action: string;
+            /**
+             * A descriptive text used in the Administration panel to describe this event
+             */
+            description: string;
+        }[];
+    };
 }
 export declare enum DebugComponentType {
     /**

package/package.json

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