@ichicraft/widgets-widget-base 1.8.10 → 1.8.11

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.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

package/lib/types/index.d.ts

@@ -288,7 +288,7 @@ export interface WidgetContext {
      * @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, options?: FilePickerOptions) => 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.
@@ -629,5 +629,15 @@ export interface FilePickerOptions {
      */
     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.10",
+    "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",