@etsoo/shared 1.1.86 → 1.1.88

package/README.md

@@ -204,6 +204,7 @@ DOM/window related utilities
 |mergeFormData|Merge form data to primary one|
 |mergeURLSearchParams|Merge URL search parameters|
 |setFocus|Set HTML element focus by name|
+|verifyPermission|Verify file system permission|
 
 ## ExtendUtils
 Extend current class/object functioning

package/lib/cjs/DomUtils.d.ts

@@ -57,7 +57,7 @@ export declare namespace DomUtils {
      * @param suggestedName Suggested file name
      * @param autoDetect Auto detect, false will use link click way
      */
-    function downloadFile(data: ReadableStream | Blob, suggestedName?: string, autoDetect?: boolean): Promise<void>;
+    function downloadFile(data: ReadableStream | Blob, suggestedName?: string, autoDetect?: boolean): Promise<boolean | undefined>;
     /**
      * File to data URL
      * @param file File
@@ -141,4 +141,12 @@ export declare namespace DomUtils {
      * @param container Container, limits the element range
      */
     function setFocus(name: string | object, container?: HTMLElement): void;
+    /**
+     * Verify file system permission
+     * https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission
+     * @param fileHandle FileSystemHandle
+     * @param withWrite With write permission
+     * @returns Result
+     */
+    function verifyPermission(fileHandle: any, withWrite?: boolean): Promise<boolean>;
 }

package/lib/cjs/DomUtils.js

@@ -242,9 +242,12 @@ var DomUtils;
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 if (autoDetect && 'showSaveFilePicker' in globalThis) {
+                    // AbortError - Use dismisses the window
                     const handle = yield globalThis.showSaveFilePicker({
                         suggestedName
                     });
+                    if (!(yield verifyPermission(handle, true)))
+                        return undefined;
                     const stream = yield handle.createWritable();
                     if (data instanceof Blob) {
                         data.stream().pipeTo(stream);
@@ -252,6 +255,7 @@ var DomUtils;
                     else {
                         yield data.pipeTo(stream);
                     }
+                    return true;
                 }
                 else {
                     const url = window.URL.createObjectURL(data instanceof Blob
@@ -266,11 +270,13 @@ var DomUtils;
                     a.click();
                     a.remove();
                     window.URL.revokeObjectURL(url);
+                    return true;
                 }
             }
             catch (e) {
                 console.log(e);
             }
+            return false;
         });
     }
     DomUtils.downloadFile = downloadFile;
@@ -471,4 +477,31 @@ var DomUtils;
             element.focus();
     }
     DomUtils.setFocus = setFocus;
+    /**
+     * Verify file system permission
+     * https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission
+     * @param fileHandle FileSystemHandle
+     * @param withWrite With write permission
+     * @returns Result
+     */
+    function verifyPermission(fileHandle, withWrite = false) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!('queryPermission' in fileHandle) ||
+                !('requestPermission' in fileHandle))
+                return false;
+            // FileSystemHandlePermissionDescriptor
+            const opts = { mode: withWrite ? 'readwrite' : 'read' };
+            // Check if we already have permission, if so, return true.
+            if ((yield fileHandle.queryPermission(opts)) === 'granted') {
+                return true;
+            }
+            // Request permission to the file, if the user grants permission, return true.
+            if ((yield fileHandle.requestPermission(opts)) === 'granted') {
+                return true;
+            }
+            // The user did not grant permission, return false.
+            return false;
+        });
+    }
+    DomUtils.verifyPermission = verifyPermission;
 })(DomUtils = exports.DomUtils || (exports.DomUtils = {}));

package/lib/mjs/DomUtils.d.ts

@@ -57,7 +57,7 @@ export declare namespace DomUtils {
      * @param suggestedName Suggested file name
      * @param autoDetect Auto detect, false will use link click way
      */
-    function downloadFile(data: ReadableStream | Blob, suggestedName?: string, autoDetect?: boolean): Promise<void>;
+    function downloadFile(data: ReadableStream | Blob, suggestedName?: string, autoDetect?: boolean): Promise<boolean | undefined>;
     /**
      * File to data URL
      * @param file File
@@ -141,4 +141,12 @@ export declare namespace DomUtils {
      * @param container Container, limits the element range
      */
     function setFocus(name: string | object, container?: HTMLElement): void;
+    /**
+     * Verify file system permission
+     * https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission
+     * @param fileHandle FileSystemHandle
+     * @param withWrite With write permission
+     * @returns Result
+     */
+    function verifyPermission(fileHandle: any, withWrite?: boolean): Promise<boolean>;
 }

package/lib/mjs/DomUtils.js

@@ -239,9 +239,12 @@ export var DomUtils;
         return __awaiter(this, void 0, void 0, function* () {
             try {
                 if (autoDetect && 'showSaveFilePicker' in globalThis) {
+                    // AbortError - Use dismisses the window
                     const handle = yield globalThis.showSaveFilePicker({
                         suggestedName
                     });
+                    if (!(yield verifyPermission(handle, true)))
+                        return undefined;
                     const stream = yield handle.createWritable();
                     if (data instanceof Blob) {
                         data.stream().pipeTo(stream);
@@ -249,6 +252,7 @@ export var DomUtils;
                     else {
                         yield data.pipeTo(stream);
                     }
+                    return true;
                 }
                 else {
                     const url = window.URL.createObjectURL(data instanceof Blob
@@ -263,11 +267,13 @@ export var DomUtils;
                     a.click();
                     a.remove();
                     window.URL.revokeObjectURL(url);
+                    return true;
                 }
             }
             catch (e) {
                 console.log(e);
             }
+            return false;
         });
     }
     DomUtils.downloadFile = downloadFile;
@@ -468,4 +474,31 @@ export var DomUtils;
             element.focus();
     }
     DomUtils.setFocus = setFocus;
+    /**
+     * Verify file system permission
+     * https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission
+     * @param fileHandle FileSystemHandle
+     * @param withWrite With write permission
+     * @returns Result
+     */
+    function verifyPermission(fileHandle, withWrite = false) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!('queryPermission' in fileHandle) ||
+                !('requestPermission' in fileHandle))
+                return false;
+            // FileSystemHandlePermissionDescriptor
+            const opts = { mode: withWrite ? 'readwrite' : 'read' };
+            // Check if we already have permission, if so, return true.
+            if ((yield fileHandle.queryPermission(opts)) === 'granted') {
+                return true;
+            }
+            // Request permission to the file, if the user grants permission, return true.
+            if ((yield fileHandle.requestPermission(opts)) === 'granted') {
+                return true;
+            }
+            // The user did not grant permission, return false.
+            return false;
+        });
+    }
+    DomUtils.verifyPermission = verifyPermission;
 })(DomUtils || (DomUtils = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.86",
+    "version": "1.1.88",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",
@@ -58,7 +58,7 @@
         "@types/lodash.isequal": "^4.5.6",
         "jest": "^29.3.1",
         "jest-environment-jsdom": "^29.3.1",
-        "ts-jest": "^29.0.3",
+        "ts-jest": "^29.0.4",
         "typescript": "^4.9.4"
     },
     "dependencies": {

package/src/DomUtils.ts

@@ -284,10 +284,13 @@ export namespace DomUtils {
     ) {
         try {
             if (autoDetect && 'showSaveFilePicker' in globalThis) {
+                // AbortError - Use dismisses the window
                 const handle = await (globalThis as any).showSaveFilePicker({
                     suggestedName
                 });
 
+                if (!(await verifyPermission(handle, true))) return undefined;
+
                 const stream = await handle.createWritable();
 
                 if (data instanceof Blob) {
@@ -295,6 +298,8 @@ export namespace DomUtils {
                 } else {
                     await data.pipeTo(stream);
                 }
+
+                return true;
             } else {
                 const url = window.URL.createObjectURL(
                     data instanceof Blob
@@ -312,10 +317,14 @@ export namespace DomUtils {
                 a.remove();
 
                 window.URL.revokeObjectURL(url);
+
+                return true;
             }
         } catch (e) {
             console.log(e);
         }
+
+        return false;
     }
 
     /**
@@ -541,4 +550,38 @@ export namespace DomUtils {
 
         if (element != null) element.focus();
     }
+
+    /**
+     * Verify file system permission
+     * https://developer.mozilla.org/en-US/docs/Web/API/FileSystemHandle/requestPermission
+     * @param fileHandle FileSystemHandle
+     * @param withWrite With write permission
+     * @returns Result
+     */
+    export async function verifyPermission(
+        fileHandle: any,
+        withWrite: boolean = false
+    ) {
+        if (
+            !('queryPermission' in fileHandle) ||
+            !('requestPermission' in fileHandle)
+        )
+            return false;
+
+        // FileSystemHandlePermissionDescriptor
+        const opts = { mode: withWrite ? 'readwrite' : 'read' };
+
+        // Check if we already have permission, if so, return true.
+        if ((await fileHandle.queryPermission(opts)) === 'granted') {
+            return true;
+        }
+
+        // Request permission to the file, if the user grants permission, return true.
+        if ((await fileHandle.requestPermission(opts)) === 'granted') {
+            return true;
+        }
+
+        // The user did not grant permission, return false.
+        return false;
+    }
 }