@etsoo/shared 1.1.85 → 1.1.86

package/README.md

@@ -191,6 +191,7 @@ DOM/window related utilities
 |detectedCountry|Current detected country|
 |detectedCulture|Current detected culture|
 |dimensionEqual|Check two rectangles equality|
+|downloadFile|Download file from API fetch response body|
 |fileToDataURL|File to data URL|
 |formDataToObject|Form data to object|
 |getCulture|Get the available culture definition|

package/lib/cjs/DomUtils.d.ts

@@ -1,3 +1,4 @@
+/// <reference lib="dom" />
 import { DataTypes } from './DataTypes';
 import { FormDataFieldValue, IFormData } from './types/FormData';
 /**
@@ -50,6 +51,13 @@ export declare namespace DomUtils {
      * @param d2 Dimension 2
      */
     function dimensionEqual(d1?: DOMRect, d2?: DOMRect): boolean;
+    /**
+     * Download file from API fetch response body
+     * @param data Data
+     * @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>;
     /**
      * File to data URL
      * @param file File

package/lib/cjs/DomUtils.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.DomUtils = void 0;
+/// <reference lib="dom" />
 const DataTypes_1 = require("./DataTypes");
 if (typeof navigator === 'undefined') {
     // Test mock only
@@ -231,6 +232,48 @@ var DomUtils;
         return false;
     }
     DomUtils.dimensionEqual = dimensionEqual;
+    /**
+     * Download file from API fetch response body
+     * @param data Data
+     * @param suggestedName Suggested file name
+     * @param autoDetect Auto detect, false will use link click way
+     */
+    function downloadFile(data, suggestedName, autoDetect = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (autoDetect && 'showSaveFilePicker' in globalThis) {
+                    const handle = yield globalThis.showSaveFilePicker({
+                        suggestedName
+                    });
+                    const stream = yield handle.createWritable();
+                    if (data instanceof Blob) {
+                        data.stream().pipeTo(stream);
+                    }
+                    else {
+                        yield data.pipeTo(stream);
+                    }
+                }
+                else {
+                    const url = window.URL.createObjectURL(data instanceof Blob
+                        ? data
+                        : yield new Response(data).blob());
+                    const a = document.createElement('a');
+                    a.style.display = 'none';
+                    a.href = url;
+                    if (suggestedName)
+                        a.download = suggestedName;
+                    document.body.appendChild(a);
+                    a.click();
+                    a.remove();
+                    window.URL.revokeObjectURL(url);
+                }
+            }
+            catch (e) {
+                console.log(e);
+            }
+        });
+    }
+    DomUtils.downloadFile = downloadFile;
     /**
      * File to data URL
      * @param file File

package/lib/mjs/DomUtils.d.ts

@@ -1,3 +1,4 @@
+/// <reference lib="dom" />
 import { DataTypes } from './DataTypes';
 import { FormDataFieldValue, IFormData } from './types/FormData';
 /**
@@ -50,6 +51,13 @@ export declare namespace DomUtils {
      * @param d2 Dimension 2
      */
     function dimensionEqual(d1?: DOMRect, d2?: DOMRect): boolean;
+    /**
+     * Download file from API fetch response body
+     * @param data Data
+     * @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>;
     /**
      * File to data URL
      * @param file File

package/lib/mjs/DomUtils.js

@@ -7,6 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+/// <reference lib="dom" />
 import { DataTypes } from './DataTypes';
 if (typeof navigator === 'undefined') {
     // Test mock only
@@ -228,6 +229,48 @@ export var DomUtils;
         return false;
     }
     DomUtils.dimensionEqual = dimensionEqual;
+    /**
+     * Download file from API fetch response body
+     * @param data Data
+     * @param suggestedName Suggested file name
+     * @param autoDetect Auto detect, false will use link click way
+     */
+    function downloadFile(data, suggestedName, autoDetect = true) {
+        return __awaiter(this, void 0, void 0, function* () {
+            try {
+                if (autoDetect && 'showSaveFilePicker' in globalThis) {
+                    const handle = yield globalThis.showSaveFilePicker({
+                        suggestedName
+                    });
+                    const stream = yield handle.createWritable();
+                    if (data instanceof Blob) {
+                        data.stream().pipeTo(stream);
+                    }
+                    else {
+                        yield data.pipeTo(stream);
+                    }
+                }
+                else {
+                    const url = window.URL.createObjectURL(data instanceof Blob
+                        ? data
+                        : yield new Response(data).blob());
+                    const a = document.createElement('a');
+                    a.style.display = 'none';
+                    a.href = url;
+                    if (suggestedName)
+                        a.download = suggestedName;
+                    document.body.appendChild(a);
+                    a.click();
+                    a.remove();
+                    window.URL.revokeObjectURL(url);
+                }
+            }
+            catch (e) {
+                console.log(e);
+            }
+        });
+    }
+    DomUtils.downloadFile = downloadFile;
     /**
      * File to data URL
      * @param file File

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/shared",
-    "version": "1.1.85",
+    "version": "1.1.86",
     "description": "TypeScript shared utilities and functions",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",

package/src/DomUtils.ts

@@ -1,3 +1,4 @@
+/// <reference lib="dom" />
 import { DataTypes } from './DataTypes';
 import { FormDataFieldValue, IFormData } from './types/FormData';
 
@@ -270,6 +271,53 @@ export namespace DomUtils {
         return false;
     }
 
+    /**
+     * Download file from API fetch response body
+     * @param data Data
+     * @param suggestedName Suggested file name
+     * @param autoDetect Auto detect, false will use link click way
+     */
+    export async function downloadFile(
+        data: ReadableStream | Blob,
+        suggestedName?: string,
+        autoDetect: boolean = true
+    ) {
+        try {
+            if (autoDetect && 'showSaveFilePicker' in globalThis) {
+                const handle = await (globalThis as any).showSaveFilePicker({
+                    suggestedName
+                });
+
+                const stream = await handle.createWritable();
+
+                if (data instanceof Blob) {
+                    data.stream().pipeTo(stream);
+                } else {
+                    await data.pipeTo(stream);
+                }
+            } else {
+                const url = window.URL.createObjectURL(
+                    data instanceof Blob
+                        ? data
+                        : await new Response(data).blob()
+                );
+
+                const a = document.createElement('a');
+                a.style.display = 'none';
+                a.href = url;
+                if (suggestedName) a.download = suggestedName;
+
+                document.body.appendChild(a);
+                a.click();
+                a.remove();
+
+                window.URL.revokeObjectURL(url);
+            }
+        } catch (e) {
+            console.log(e);
+        }
+    }
+
     /**
      * File to data URL
      * @param file File