feat: Support for SettingsIdentifier, SuggestedStartLocation and Sugg…

…estedFileName on WASM
unoplatform · Aug 23, 2021 · 0048e4b · 0048e4b
1 parent 60d4a34
commit 0048e4b
Show file tree

Hide file tree

Showing 11 changed files with 94 additions and 17 deletions.
diff --git a/src/SamplesApp/UITests.Shared/Windows_Storage/Pickers/FileSavePickerTests.xaml b/src/SamplesApp/UITests.Shared/Windows_Storage/Pickers/FileSavePickerTests.xaml
@@ -23,6 +23,7 @@
 			<TextBox Header="Settings identifier" Text="{x:Bind ViewModel.SettingsIdentifier, Mode=TwoWay}" />
             <TextBox Header="Commit button text" Text="{x:Bind ViewModel.CommitButtonText, Mode=TwoWay}" />
 
+            <TextBox Header="Suggested file name" Text="{x:Bind ViewModel.SuggestedFileName, Mode=TwoWay}" />
             <StackPanel Orientation="Horizontal" Spacing="4">
                 <Button Click="{x:Bind ViewModel.PickSuggestedSaveFile}" Content="Pick suggested save file" />
                 <Button Click="{x:Bind ViewModel.PickSuggestedSaveFile}" Content="Clear" />

diff --git a/src/Uno.UI/WasmScripts/Uno.UI.d.ts b/src/Uno.UI/WasmScripts/Uno.UI.d.ts
@@ -1024,21 +1024,21 @@ declare namespace Windows.Storage {
 declare namespace Windows.Storage.Pickers {
     class FileOpenPicker {
         static isNativeSupported(): boolean;
-        static nativePickFilesAsync(multiple: boolean, showAllEntry: boolean, fileTypesJson: string): Promise<string>;
+        static nativePickFilesAsync(multiple: boolean, showAllEntry: boolean, fileTypesJson: string, id: string, startIn: StartInDirectory): Promise<string>;
         static uploadPickFilesAsync(multiple: boolean, targetPath: string, accept: string): Promise<string>;
     }
 }
 declare namespace Windows.Storage.Pickers {
     class FileSavePicker {
         static isNativeSupported(): boolean;
-        static nativePickSaveFileAsync(showAllEntry: boolean, fileTypesJson: string): Promise<string>;
+        static nativePickSaveFileAsync(showAllEntry: boolean, fileTypesJson: string, suggestedFileName: string, id: string, startIn: StartInDirectory): Promise<string>;
         static SaveAs(fileName: string, dataPtr: any, size: number): void;
     }
 }
 declare namespace Windows.Storage.Pickers {
     class FolderPicker {
         static isNativeSupported(): boolean;
-        static pickSingleFolderAsync(): Promise<string>;
+        static pickSingleFolderAsync(id: string, startIn: StartInDirectory): Promise<string>;
     }
 }
 declare namespace Uno.Storage.Pickers {

diff --git a/src/Uno.UI/WasmScripts/Uno.UI.js b/src/Uno.UI/WasmScripts/Uno.UI.js
@@ -3499,14 +3499,16 @@ var Windows;
                 static isNativeSupported() {
                     return typeof showOpenFilePicker === "function";
                 }
-                static async nativePickFilesAsync(multiple, showAllEntry, fileTypesJson) {
+                static async nativePickFilesAsync(multiple, showAllEntry, fileTypesJson, id, startIn) {
                     if (!FileOpenPicker.isNativeSupported()) {
                         return JSON.stringify([]);
                     }
                     const options = {
                         excludeAcceptAllOption: !showAllEntry,
                         multiple: multiple,
                         types: [],
+                        id: id,
+                        startIn: startIn
                     };
                     const acceptTypes = JSON.parse(fileTypesJson);
                     for (const acceptType of acceptTypes) {
@@ -3578,14 +3580,19 @@ var Windows;
                 static isNativeSupported() {
                     return typeof showSaveFilePicker === "function";
                 }
-                static async nativePickSaveFileAsync(showAllEntry, fileTypesJson) {
+                static async nativePickSaveFileAsync(showAllEntry, fileTypesJson, suggestedFileName, id, startIn) {
                     if (!FileSavePicker.isNativeSupported()) {
                         return null;
                     }
                     const options = {
                         excludeAcceptAllOption: !showAllEntry,
                         types: [],
+                        id: id,
+                        startIn: startIn
                     };
+                    if (suggestedFileName != "") {
+                        options.suggestedName = suggestedFileName;
+                    }
                     const acceptTypes = JSON.parse(fileTypesJson);
                     for (const acceptType of acceptTypes) {
                         const pickerAcceptType = {
@@ -3637,12 +3644,16 @@ var Windows;
                 static isNativeSupported() {
                     return typeof showDirectoryPicker === "function";
                 }
-                static async pickSingleFolderAsync() {
+                static async pickSingleFolderAsync(id, startIn) {
                     if (!FolderPicker.isNativeSupported()) {
                         return null;
                     }
                     try {
-                        const selectedFolder = await showDirectoryPicker();
+                        const options = {
+                            id: id,
+                            startIn: startIn
+                        };
+                        const selectedFolder = await showDirectoryPicker(options);
                         const info = Uno.Storage.NativeStorageItem.getInfos(selectedFolder)[0];
                         return JSON.stringify(info);
                     }

diff --git a/src/Uno.UI/ts/Windows/Storage/Pickers/FileOpenPicker.ts b/src/Uno.UI/ts/Windows/Storage/Pickers/FileOpenPicker.ts
@@ -8,7 +8,10 @@
 		public static async nativePickFilesAsync(
 			multiple: boolean,
 			showAllEntry: boolean,
-			fileTypesJson: string): Promise<string> {
+			fileTypesJson: string,
+			id: string,
+			startIn: StartInDirectory
+		): Promise<string> {
 
 			if (!FileOpenPicker.isNativeSupported()) {
 				return JSON.stringify([]);
@@ -18,6 +21,8 @@
 				excludeAcceptAllOption: !showAllEntry,
 				multiple: multiple,
 				types: [],
+				id: id,
+				startIn: startIn
 			};
 
 			const acceptTypes = <Uno.Storage.Pickers.NativeFilePickerAcceptType[]>JSON.parse(fileTypesJson);

diff --git a/src/Uno.UI/ts/Windows/Storage/Pickers/FileSavePicker.ts b/src/Uno.UI/ts/Windows/Storage/Pickers/FileSavePicker.ts
@@ -5,7 +5,7 @@
 			return typeof showSaveFilePicker === "function";
 		}
 
-		public static async nativePickSaveFileAsync(showAllEntry: boolean, fileTypesJson: string): Promise<string> {
+		public static async nativePickSaveFileAsync(showAllEntry: boolean, fileTypesJson: string, suggestedFileName: string, id: string, startIn: StartInDirectory): Promise<string> {
 
 			if (!FileSavePicker.isNativeSupported()) {
 				return null;
@@ -14,8 +14,14 @@
 			const options: SaveFilePickerOptions = {
 				excludeAcceptAllOption: !showAllEntry,
 				types: [],
+				id: id,
+				startIn: startIn
 			};
 
+			if (suggestedFileName != "") {
+				options.suggestedName = suggestedFileName;
+			}
+
 			const acceptTypes = <Uno.Storage.Pickers.NativeFilePickerAcceptType[]>JSON.parse(fileTypesJson);
 
 			for (const acceptType of acceptTypes) {				

diff --git a/src/Uno.UI/ts/Windows/Storage/Pickers/FolderPicker.Native.ts b/src/Uno.UI/ts/Windows/Storage/Pickers/FolderPicker.Native.ts
@@ -5,13 +5,18 @@
 			return typeof showDirectoryPicker === "function";
 		}
 
-		public static async pickSingleFolderAsync(): Promise<string> {
+		public static async pickSingleFolderAsync(id: string, startIn: StartInDirectory): Promise<string> {
 			if (!FolderPicker.isNativeSupported()) {
 				return null;
 			}
 
 			try {
-				const selectedFolder = await showDirectoryPicker();
+				const options: DirectoryPickerOptions = {
+					id: id,
+					startIn: startIn
+				};
+
+				const selectedFolder = await showDirectoryPicker(options);
 
 				const info = Uno.Storage.NativeStorageItem.getInfos(selectedFolder)[0];
 				return JSON.stringify(info);

diff --git a/src/Uno.UI/ts/types/wicg-file-system-access/index.d.ts b/src/Uno.UI/ts/types/wicg-file-system-access/index.d.ts
@@ -28,6 +28,17 @@ declare class BaseFileSystemHandle {
 }
 
 declare global {
+
+	type WellKnownDirectory =
+		"desktop" |
+		"documents" |
+		"downloads" |
+		"music" |
+		"pictures" |
+		"videos";
+
+	type StartInDirectory = WellKnownDirectory | FileSystemHandle;
+
 	interface FilePickerAcceptType {
 		description?: string;
 		accept: Record<string, string | string[]>;
@@ -36,17 +47,24 @@ declare global {
 	interface FilePickerOptions {
 		types?: FilePickerAcceptType[];
 		excludeAcceptAllOption?: boolean;
+		id?: string;
+		startIn?: StartInDirectory;
 	}
 
 	interface OpenFilePickerOptions extends FilePickerOptions {
 		multiple?: boolean;
 	}
 
 	// tslint:disable-next-line:no-empty-interface
-	interface SaveFilePickerOptions extends FilePickerOptions { }
+	interface SaveFilePickerOptions extends FilePickerOptions {
+		suggestedName?: string;
+	}
 
 	// tslint:disable-next-line:no-empty-interface
-	interface DirectoryPickerOptions { }
+	interface DirectoryPickerOptions {
+		id?: string;
+		startIn?: StartInDirectory;
+	}
 
 	type FileSystemPermissionMode = 'read' | 'readwrite';
 

diff --git a/src/Uno.UWP/Storage/Pickers/FileOpenPicker.wasm.cs b/src/Uno.UWP/Storage/Pickers/FileOpenPicker.wasm.cs
@@ -10,6 +10,7 @@
 using Uno.Foundation;
 using Uno.Helpers.Serialization;
 using Uno.Storage.Internal;
+using Uno.Storage.Pickers;
 using Uno.Storage.Pickers.Internal;
 
 namespace Windows.Storage.Pickers
@@ -62,8 +63,9 @@ private async Task<FilePickerSelectedFilesArray> NativePickerPickFilesAsync(bool
 			var fileTypeAcceptTypes = BuildFileTypesMap();
 			var fileTypeAcceptTypesJson = JsonHelper.Serialize(fileTypeAcceptTypes);
 			var fileTypeMapParameter = WebAssemblyRuntime.EscapeJs(fileTypeAcceptTypesJson);
-
-			var nativeStorageItemInfosJson = await WebAssemblyRuntime.InvokeAsync($"{JsType}.nativePickFilesAsync({multipleParameter},{showAllEntryParameter},'{fileTypeMapParameter}')");
+			var id = WebAssemblyRuntime.EscapeJs(SettingsIdentifier ?? "");
+			var startIn = SuggestedStartLocation.ToStartInDirectory();
+			var nativeStorageItemInfosJson = await WebAssemblyRuntime.InvokeAsync($"{JsType}.nativePickFilesAsync({multipleParameter},{showAllEntryParameter},'{fileTypeMapParameter}','{id}','{startIn}')");
 			var infos = JsonHelper.Deserialize<NativeStorageItemInfo[]>(nativeStorageItemInfosJson);
 
 			var results = new List<StorageFile>();

diff --git a/src/Uno.UWP/Storage/Pickers/FileSavePicker.wasm.cs b/src/Uno.UWP/Storage/Pickers/FileSavePicker.wasm.cs
@@ -10,6 +10,7 @@
 using Uno.Foundation;
 using Uno.Helpers.Serialization;
 using Uno.Storage.Internal;
+using Uno.Storage.Pickers;
 using Uno.Storage.Pickers.Internal;
 
 namespace Windows.Storage.Pickers
@@ -49,7 +50,12 @@ private bool IsNativePickerSupported()
 			var showAllEntryParameter = "true";
 			var fileTypeMapParameter = JsonHelper.Serialize(BuildFileTypesMap());
 
-			var promise = $"{JsType}.nativePickSaveFileAsync({showAllEntryParameter},'{WebAssemblyRuntime.EscapeJs(fileTypeMapParameter)}')";
+			var suggestedFileName = string.IsNullOrEmpty(SuggestedFileName) ?
+				"" : WebAssemblyRuntime.EscapeJs(SuggestedFileName);
+			var id = WebAssemblyRuntime.EscapeJs(SettingsIdentifier ?? "");
+
+			var startIn = SuggestedStartLocation.ToStartInDirectory();
+			var promise = $"{JsType}.nativePickSaveFileAsync({showAllEntryParameter},'{WebAssemblyRuntime.EscapeJs(fileTypeMapParameter)}','{suggestedFileName}','{id}','{startIn}')";
 			var nativeStorageItemInfo = await WebAssemblyRuntime.InvokeAsync(promise);
 			if (nativeStorageItemInfo is null)
 			{

diff --git a/src/Uno.UWP/Storage/Pickers/FolderPicker.wasm.cs b/src/Uno.UWP/Storage/Pickers/FolderPicker.wasm.cs
@@ -6,6 +6,7 @@
 using Uno.Foundation;
 using Uno.Helpers.Serialization;
 using Uno.Storage.Internal;
+using Uno.Storage.Pickers;
 
 namespace Windows.Storage.Pickers
 {
@@ -20,7 +21,10 @@ public partial class FolderPicker
 				throw new NotSupportedException("Could not handle the request using any picker implementation.");
 			}
 
-			var pickedFolderJson = await WebAssemblyRuntime.InvokeAsync($"{JsType}.pickSingleFolderAsync()");
+			var id = WebAssemblyRuntime.EscapeJs(SettingsIdentifier ?? "");
+			var startIn = SuggestedStartLocation.ToStartInDirectory();
+
+			var pickedFolderJson = await WebAssemblyRuntime.InvokeAsync($"{JsType}.pickSingleFolderAsync('{id}','{startIn}')");
 
 			if (pickedFolderJson is null)
 			{

diff --git a/src/Uno.UWP/Storage/Pickers/Internal/PickerLocationIdExtensions.wasm.cs b/src/Uno.UWP/Storage/Pickers/Internal/PickerLocationIdExtensions.wasm.cs
@@ -0,0 +1,19 @@
+using Windows.Storage.Pickers;
+
+namespace Uno.Storage.Pickers
+{
+	internal static class PickerLocationIdExtensions
+	{
+		internal static string ToStartInDirectory(this PickerLocationId location) =>
+			location switch
+			{
+				PickerLocationId.DocumentsLibrary => "documents",
+				PickerLocationId.Desktop => "desktop",
+				PickerLocationId.Downloads => "downloads",
+				PickerLocationId.MusicLibrary => "music",
+				PickerLocationId.PicturesLibrary => "pictures",
+				PickerLocationId.VideosLibrary => "videos",
+				_ => ""
+			};
+	}
+}