Merge pull request #370 from siata13/dev

estruyf · web-flow · commit 569b37ed856b · 2019-09-18T09:46:24.000+02:00
FilePicker improvements.
diff --git a/docs/documentation/docs/controls/FilePicker.md b/docs/documentation/docs/controls/FilePicker.md
@@ -46,7 +46,7 @@ import { FilePicker, IFilePickerResult } from '@pnp/spfx-controls-react/lib/File
   buttonIcon="FileImage"
   onSave={(filePickerResult: IFilePickerResult) => { this.setState({filePickerResult }) }}
   onChanged={(filePickerResult: IFilePickerResult) => { this.setState({filePickerResult }) }}
-  webPartContext={this.props.context}
+  context={this.props.context}
 />
 ```
 
@@ -60,8 +60,8 @@ The FilePicker component can be configured with the following properties:
 | buttonLabel | string | no | Specifies the label of the file picker button. |
 | buttonIcon | string | no | In case it is provided the file picker will be rendered as an action button. |
 | onSave | (filePickerResult: IFilePickerResult) => void | yes | Handler when the file has been selected and picker has been closed. |
-| onChange | (filePickerResult: IFilePickerResult) => void | yes | Handler when the file selection has been changed. |
-| webPartContext | WebPartContext | yes | Current context. |
+| onChange | (filePickerResult: IFilePickerResult) => void | no | Handler when the file selection has been changed. |
+| context | ApplicationCustomizerContext | WebPartContext | yes | Current context. |
 | accepts | string[] | no | Array of strings containing allowed files extensions. E.g. [".gif", ".jpg", ".jpeg", ".bmp", ".dib", ".tif", ".tiff", ".ico", ".png", ".jxr", ".svg"] |
 | required | boolean | no | Sets the label to inform that the value is required. |
 | bingAPIKey | string | no | Used to execute WebSearch. If not provided SearchTab will not be available. |
@@ -79,12 +79,12 @@ interface `IFilePickerResult`
 
 Provides options for carousel buttons location.
 
-| Value | Description |
+| Value | Type | Description |
 | ---- | ---- |
-| fileName | string | yes | File namr of the result with the extension. |
-| fileNameWithoutExtension | string | yes | File namr of the result without the extension. |
-| fileAbsoluteUrl | string | yes | Absolute URL of the file. Null in case of file upload. |
-| file | File | yes | JS Object representing File. Will be set in case of file upload. |
+| fileName | string | File namr of the result with the extension. |
+| fileNameWithoutExtension | string | File name of the result without the extension. |
+| fileAbsoluteUrl | string | Absolute URL of the file. Null in case of file upload. |
+| downloadFileContent | () => Promise<File> | Function allows to download file content. Returns File object. |
 
 
 ![](https://telemetry.sharepointpnp.com/sp-dev-fx-controls-react/filePicker/FilePicker)
diff --git a/src/controls/filePicker/FilePicker.tsx b/src/controls/filePicker/FilePicker.tsx
@@ -39,10 +39,10 @@ export class FilePicker extends React.Component<IFilePickerProps, IFilePickerSta
     telemetry.track('ReactFilePicker', {});
 
     // Initialize file browser services
-    this.fileBrowserService = new FileBrowserService(props.webPartContext, this.props.itemsCountQueryLimit);
-    this.oneDriveService = new OneDriveService(props.webPartContext, this.props.itemsCountQueryLimit);
-    this.orgAssetsService = new OrgAssetsService(props.webPartContext, this.props.itemsCountQueryLimit);
-    this.fileSearchService = new FilesSearchService(props.webPartContext, this.props.bingAPIKey);
+    this.fileBrowserService = new FileBrowserService(props.context, this.props.itemsCountQueryLimit);
+    this.oneDriveService = new OneDriveService(props.context, this.props.itemsCountQueryLimit);
+    this.orgAssetsService = new OrgAssetsService(props.context, this.props.itemsCountQueryLimit);
+    this.fileSearchService = new FilesSearchService(props.context, this.props.bingAPIKey);
 
     this.state = {
       panelOpen: false,
@@ -68,7 +68,7 @@ export class FilePicker extends React.Component<IFilePickerProps, IFilePickerSta
 
     const linkTabProps = {
       accepts: accepts,
-      context: this.props.webPartContext,
+      context: this.props.context,
       onClose: () => this._handleClosePanel(),
       onSave: (value: IFilePickerResult) => { this._handleSave(value); }
     };
@@ -201,7 +201,7 @@ export class FilePicker extends React.Component<IFilePickerProps, IFilePickerSta
    * On save action
    */
   private _handleSave = (filePickerResult: IFilePickerResult) => {
-    this.props.onChanged(filePickerResult);
+    this.props.onSave(filePickerResult);
     this.setState({
       panelOpen: false
     });
diff --git a/src/controls/filePicker/FilePicker.types.ts b/src/controls/filePicker/FilePicker.types.ts
@@ -1,22 +1,39 @@
 import { WebPartContext } from "@microsoft/sp-webpart-base";
 import { IBreadcrumbItem } from "office-ui-fabric-react/lib/Breadcrumb";
 import { IFile, ILibrary } from "../../services/FileBrowserService.types";
+import { ApplicationCustomizerContext } from "@microsoft/sp-application-base";
 
 export interface FilePickerBreadcrumbItem extends IBreadcrumbItem {
   libraryData?: ILibrary;
   folderData?: IFile;
 }
 
 export interface IFilePickerTab {
-  context: WebPartContext;
+  context: ApplicationCustomizerContext | WebPartContext;
   accepts: string[];
   onSave: (value: IFilePickerResult) => void;
   onClose: () => void;
 }
 
+/**
+ * Represents the result of the FilePicker.
+ */
 export interface IFilePickerResult {
+  /**
+   * Selected file name with extension.
+   */
   fileName: string;
+  /**
+   * Selected file name without extension.
+   */
   fileNameWithoutExtension: string;
+  /**
+   * Absolute file URL. Undefined in case of file upload.
+   */
   fileAbsoluteUrl: string;
-  file: File;
+
+  /**
+   * Downloads file picker result content.
+   */
+  downloadFileContent: () => Promise<File>;
 }
diff --git a/src/controls/filePicker/IFilePickerProps.ts b/src/controls/filePicker/IFilePickerProps.ts
@@ -1,5 +1,6 @@
 import { WebPartContext } from "@microsoft/sp-webpart-base";
 import { IFilePickerResult } from "./FilePicker.types";
+import { ApplicationCustomizerContext } from "@microsoft/sp-application-base";
 
 export interface IFilePickerProps {
   /**
@@ -24,12 +25,12 @@ export interface IFilePickerProps {
   /**
    * Handler when file has been changed.
    */
-  onChanged: (filePickerResult: IFilePickerResult) => void;
+  onChanged?: (filePickerResult: IFilePickerResult) => void;
 
   /**
    * Current context.
    */
-  webPartContext: WebPartContext;
+  context: ApplicationCustomizerContext |  WebPartContext;
 
   /**
    * File extensions to be displayed.
diff --git a/src/controls/filePicker/LinkFilePickerTab/LinkFilePickerTab.tsx b/src/controls/filePicker/LinkFilePickerTab/LinkFilePickerTab.tsx
@@ -62,10 +62,10 @@ export default class LinkFilePickerTab extends React.Component<ILinkFilePickerTa
    */
   private _handleChange = (fileUrl: string) => {
     const filePickerResult: IFilePickerResult = fileUrl && this._isUrl(fileUrl) ? {
-      file: null,
       fileAbsoluteUrl: fileUrl,
       fileName: GeneralHelper.getFileNameFromUrl(fileUrl),
-      fileNameWithoutExtension: GeneralHelper.getFileNameWithoutExtension(fileUrl)
+      fileNameWithoutExtension: GeneralHelper.getFileNameWithoutExtension(fileUrl),
+      downloadFileContent: () => { return this.props.fileSearchService.downloadBingContent(fileUrl, GeneralHelper.getFileNameFromUrl(fileUrl)); }
     } : null;
     this.setState({
       filePickerResult
@@ -95,7 +95,7 @@ export default class LinkFilePickerTab extends React.Component<ILinkFilePickerTa
       return strings.NoExternalLinksValidationMessage;
     }
 
-    const fileExists = await this.props.fileSearchService.fetchFile(value);
+    const fileExists = await this.props.fileSearchService.checkFileExists(value);
     this.setState({ isValid: fileExists });
 
     const strResult = fileExists ? '' : strings.ProvidedValueIsInvalid;
diff --git a/src/controls/filePicker/OneDriveFilesTab/OneDriveFilesTab.tsx b/src/controls/filePicker/OneDriveFilesTab/OneDriveFilesTab.tsx
@@ -131,6 +131,9 @@ export class OneDriveFilesTab extends React.Component<IOneDriveFilesTabProps, IO
    * Is called when user selects a different file
    */
   private _handleSelectionChange = (filePickerResult: IFilePickerResult) => {
+    if (filePickerResult) {
+      filePickerResult.downloadFileContent = () => { return this.props.oneDriveService.downloadSPFileContent(filePickerResult.fileAbsoluteUrl, filePickerResult.fileName); };
+    }
     this.setState({
       filePickerResult
     });
diff --git a/src/controls/filePicker/RecentFilesTab/RecentFilesTab.tsx b/src/controls/filePicker/RecentFilesTab/RecentFilesTab.tsx
@@ -102,11 +102,12 @@ export default class RecentFilesTab extends React.Component<IRecentFilesTabProps
       //Get the selected key
       const selectedKey: IRecentFile = selectedItems[0] as IRecentFile;
       const filePickerResult: IFilePickerResult = {
-        file: null,
         fileAbsoluteUrl: selectedKey.fileUrl,
         fileName: GeneralHelper.getFileNameFromUrl(selectedKey.fileUrl),
-        fileNameWithoutExtension: GeneralHelper.getFileNameWithoutExtension(selectedKey.fileUrl)
+        fileNameWithoutExtension: GeneralHelper.getFileNameWithoutExtension(selectedKey.fileUrl),
+        downloadFileContent: () => { return this.props.fileSearchService.downloadSPFileContent(selectedKey.fileUrl, GeneralHelper.getFileNameFromUrl(selectedKey.fileUrl)); }
       };
+
       // Save the selected file
       this.setState({
         filePickerResult
diff --git a/src/controls/filePicker/SiteFilePickerTab/SiteFilePickerTab.tsx b/src/controls/filePicker/SiteFilePickerTab/SiteFilePickerTab.tsx
@@ -112,6 +112,10 @@ export default class SiteFilePickerTab extends React.Component<ISiteFilePickerTa
    * Is called when user selects a different file
    */
   private _handleSelectionChange = (filePickerResult: IFilePickerResult) => {
+    if (filePickerResult) {
+      filePickerResult.downloadFileContent = () => { return this.props.fileBrowserService.downloadSPFileContent(filePickerResult.fileAbsoluteUrl, filePickerResult.fileName); };
+    }
+    // this.props.fileBrowserService
     this.setState({
       filePickerResult
     });
diff --git a/src/controls/filePicker/UploadFilePickerTab/UploadFilePickerTab.tsx b/src/controls/filePicker/UploadFilePickerTab/UploadFilePickerTab.tsx
@@ -75,10 +75,10 @@ export default class UploadFilePickerTab extends React.Component<IUploadFilePick
     const file: File = files[0];
 
     const filePickerResult: IFilePickerResult = {
-      file,
       fileAbsoluteUrl: null,
       fileName: file.name,
-      fileNameWithoutExtension: GeneralHelper.getFileNameWithoutExtension(file.name)
+      fileNameWithoutExtension: GeneralHelper.getFileNameWithoutExtension(file.name),
+      downloadFileContent: () => { return Promise.resolve(file); }
     };
 
     if (GeneralHelper.isImage(file.name)) {
diff --git a/src/controls/filePicker/WebSearchTab/WebSearchTab.tsx b/src/controls/filePicker/WebSearchTab/WebSearchTab.tsx
@@ -102,10 +102,10 @@ export default class WebSearchTab extends React.Component<IWebSearchTabProps, IW
       // even if it breaks the page.
       const selectedUrl: string = selectedItem.contentUrl.replace('http://', 'https://');
       selectedFileResult = {
-        file: null,
         fileAbsoluteUrl: selectedUrl,
         fileName: GeneralHelper.getFileNameFromUrl(selectedUrl),
-        fileNameWithoutExtension: GeneralHelper.getFileNameWithoutExtension(selectedUrl)
+        fileNameWithoutExtension: GeneralHelper.getFileNameWithoutExtension(selectedUrl),
+        downloadFileContent: () => { return this.props.bingSearchService.downloadBingContent(selectedUrl, GeneralHelper.getFileNameFromUrl(selectedUrl)); }
       };
     }
 
diff --git a/src/controls/filePicker/controls/FileBrowser/FileBrowser.tsx b/src/controls/filePicker/controls/FileBrowser/FileBrowser.tsx
@@ -434,7 +434,7 @@ export class FileBrowser extends React.Component<IFileBrowserProps, IFileBrowser
         fileAbsoluteUrl: selectedItem.absoluteUrl,
         fileName: GeneralHelper.getFileNameFromUrl(selectedItem.name),
         fileNameWithoutExtension: GeneralHelper.getFileNameWithoutExtension(selectedItem.name),
-        file: null
+        downloadFileContent: null
       };
     }
     this.props.onChange(filePickerResult);
@@ -443,6 +443,9 @@ export class FileBrowser extends React.Component<IFileBrowserProps, IFileBrowser
     });
   }
 
+  /**
+   * Handles item click.
+   */
   private _handleItemInvoked = (item: IFile) => {
    // If a file is selected, open the library
    if (item.isFolder) {
diff --git a/src/index.ts b/src/index.ts
@@ -10,6 +10,7 @@ export * from './ListItemAttachments';
 export * from './ChartControl';
 export * from './Progress';
 export * from './DateTimePicker';
+export * from './FilePicker';
 
 export * from './IFrameDialog';
 export * from './IFramePanel';
diff --git a/src/services/FileBrowserService.ts b/src/services/FileBrowserService.ts
@@ -2,16 +2,17 @@ import { WebPartContext } from "@microsoft/sp-webpart-base";
 import { IFile, FilesQueryResult, ILibrary } from "./FileBrowserService.types";
 import { SPHttpClient } from "@microsoft/sp-http";
 import { GeneralHelper } from "..";
+import { ApplicationCustomizerContext } from "@microsoft/sp-application-base";
 
 export class FileBrowserService {
   protected itemsToDownloadCount: number;
-  protected context: WebPartContext;
+  protected context: ApplicationCustomizerContext | WebPartContext;
 
   protected driveAccessToken: string;
   protected mediaBaseUrl: string;
   protected callerStack: string;
 
-  constructor(context: WebPartContext, itemsToDownloadCount: number = 100) {
+  constructor(context: ApplicationCustomizerContext | WebPartContext, itemsToDownloadCount: number = 100) {
     this.context = context;
 
     this.itemsToDownloadCount = itemsToDownloadCount;
@@ -45,6 +46,9 @@ export class FileBrowserService {
   }
 
 
+  /**
+   * Provides the URL for file preview.
+   */
   public getFileThumbnailUrl = (file: IFile, thumbnailWidth: number, thumbnailHeight: number): string => {
     const thumbnailUrl = `${this.mediaBaseUrl}/transform/thumbnail?provider=spo&inputFormat=${file.fileType}&cs=${this.callerStack}&docid=${file.spItemUrl}&${this.driveAccessToken}&width=${thumbnailWidth}&height=${thumbnailHeight}`;
     return thumbnailUrl;
@@ -76,6 +80,26 @@ export class FileBrowserService {
     }
   }
 
+  /**
+   * Downloads document content from SP location.
+   */
+  public downloadSPFileContent = async (absoluteFileUrl: string, fileName: string): Promise<File> => {
+    try {
+      const fileDownloadResult = await this.context.spHttpClient.get(absoluteFileUrl, SPHttpClient.configurations.v1);
+
+      if (!fileDownloadResult || !fileDownloadResult.ok) {
+        throw new Error(`Something went wrong when downloading the file. Status='${fileDownloadResult.status}'`);
+      }
+
+      // Return file created from blob
+      const blob : Blob = await fileDownloadResult.blob();
+      return  new File([blob], fileName);
+    } catch (err) {
+      console.error(`[FileBrowserService.fetchFileContent] Err='${err.message}'`);
+      return null;
+    }
+  }
+
   /**
    * Executes query to load files with possible extension filtering
    * @param restApi
diff --git a/src/services/FilesSearchService.ts b/src/services/FilesSearchService.ts
diff --git a/src/services/OneDriveService.ts b/src/services/OneDriveService.ts
diff --git a/src/services/OrgAssetsService.ts b/src/services/OrgAssetsService.ts
diff --git a/src/webparts/controlsTest/components/ControlsTest.tsx b/src/webparts/controlsTest/components/ControlsTest.tsx
