@ichicraft/widgets-widget-base 1.8.16 → 1.9.0

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.0 - 2023-10-20
+
+-   Added optional `importData()` function to the `BaseWidget` class, used to import widget-specific data.
+-   Added optional `exportData()` function to the `BaseWidget` class, used to export widget-specific data.
+-   Added new exported `ExportData` type.
+
+## 1.8.17 - 2023-10-09
+
+-   Added `iconName` property to the `definition` object of the `WidgetContext` interface, to support using an icon to represent a widget.
+
 ## 1.8.16 - 2023-09-26
 
 -   Added `Custom` value to `ICPersonaType` enum, to support a custom ICPersona.

package/lib/BaseWidget.d.ts

@@ -1,4 +1,4 @@
-import { WidgetContext, ValidationResult } from './types';
+import { WidgetContext, ValidationResult, ExportData } from './types';
 export default abstract class BaseWidget {
     protected readonly context: WidgetContext;
     constructor(context: WidgetContext);
@@ -12,5 +12,7 @@ export default abstract class BaseWidget {
     renderAdminConfigurationForm?(domElement: HTMLDivElement): void;
     validateAdminConfigurationForm?(): ValidationResult;
     getSerializedAdminConfiguration?(): string;
+    importData?(exportData: ExportData): Promise<void>;
+    exportData?(): Promise<ExportData>;
     cleanupResources?(): void;
 }

package/lib/types/index.d.ts

@@ -113,6 +113,10 @@ export interface WidgetContext {
          * A list of board types applicable for this widget variant.
          */
         allowedBoardTypes?: BoardType[];
+        /**
+         * The icon defined for this widget variant.
+         */
+        iconName?: string;
     };
     /**
      * Metadata and functions in the context of a widget's manifest. A widget manifest contains
@@ -648,3 +652,6 @@ export interface FilePickerFileProps {
 }
 export declare type BoardType = 'shared' | 'personal';
 export declare type UserRole = 'administrator' | 'board-owner';
+export interface ExportData {
+    data: object[];
+}

package/package.json

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