@ichicraft/widgets-widget-base 1.8.9 → 1.8.11

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.8.11 - 2023-04-03
+
+-   Changed `openFilePicker` function to return more details of the picked file in the shape of `FilePickerFileProps`
+
+## 1.8.10 - 2023-03-30
+
+-   Changed `openFilePicker` function to accept `options`, to support configuration of picker behavior
+
 ## 1.8.9 - 2023-03-06
 
 -   Added `registerCustomCommandBarItems` function to the `instance` object of the `WidgetContext` interface, to support multiple custom buttons in the widget header.

package/lib/types/index.d.ts

@@ -95,7 +95,7 @@ export interface WidgetContext {
         }) => void;
     };
     /**
-     * Metadata and functions in the context of a widget's definition. A widget definition is
+     * 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.
      */
     definition: {
@@ -116,13 +116,12 @@ export interface WidgetContext {
     };
     /**
      * Metadata and functions in the context of a widget's manifest. A widget manifest contains
-     * all information of the originally installed widget. If multiple instances of the same widget 'type'
-     * exist in a widget board configuration, they share this manifest.
-     * We use the term 'definition' to distinguish each instance of a manifest.
+     * all information of the originally installed widget. Multiple `variants` of the same widget `manifest`
+     * can exist in a widget board configuration.
      */
     manifest: {
         /**
-         * Unique id of a widget 'type', also used in the widget manifest in the original script source manifest file.
+         * Unique id of a widget 'type', also used in the widget manifest config file in the original script source manifest file.
          * If this is a 'single instance widget', which means that no more than one instance of this
          * widget can be installed in the widget board, the id of the definition is the same as the id of the manifest.
          */
@@ -286,8 +285,10 @@ export interface WidgetContext {
     loadScript?: <TModule>(url: string, options?: any) => Promise<TModule>;
     /**
      * 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.
+     * @param options Options to change the behavior of the file picker
      */
-    openFilePicker?: (onFilePicked: (fileUrl: string) => void, onCancel?: () => void) => void;
+    openFilePicker?: (onFilePicked: (fileUrl: string, fileProps: FilePickerFileProps) => void, options?: FilePickerOptions) => void;
     /**
      * Functionality offered by the widget board to open a url in an iframe dialog.
      * @param url The url to open in a dialog.
@@ -348,7 +349,7 @@ export interface WidgetManifestConfig {
      */
     manifestVersion: number;
     /**
-     * Unique id (Guid) to identify the widget
+     * Unique id to identify the widget
      */
     id: string;
     /**
@@ -593,5 +594,50 @@ export interface IFrameDialogOptions {
      */
     onDismissed?: () => void;
 }
+/**
+ * Options to pass to openFilePicker function
+ */
+export interface FilePickerOptions {
+    /**
+     * Array of file extensions that will be used to filter the files in the picker.
+     * @default ['.gif', '.jpg', '.jpeg', '.png']
+     */
+    extensions?: string[];
+    /**
+     * Maximum number of files to show in a folder
+     * @default 100
+     */
+    itemsCountQueryLimit?: number;
+    /**
+     * Whether or not to hide the organisational site files tab
+     * @default false
+     */
+    hideOrganisationalAssetTab?: boolean;
+    /**
+     * Whether or not to hide the site files tab
+     * @default false
+     */
+    hideSiteFilesTab?: boolean;
+    /**
+     * Whether or not to hide the upload tab
+     * @default false
+     */
+    hideLocalUploadTab?: boolean;
+    /**
+     * Function that's called when user closes file picker without picking a file
+     * @default undefined
+     */
+    onCancel?: () => void;
+}
+export interface FilePickerFileProps {
+    /**
+     * Unique identifier of the file item in SharePoint, in the shape of a Guid.
+     */
+    uniqueId: string;
+    /**
+     * Unique identifier of the site in SharePoint, in the shape of a Guid.
+     */
+    siteId: string;
+}
 export declare type BoardType = 'shared' | 'personal';
 export declare type UserRole = 'administrator' | 'board-owner';

package/package.json

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