@douglasneuroinformatics/libui 2.1.0 → 2.2.0

package/dist/hooks/useDownload.d.ts

@@ -1,13 +1,20 @@
 import type { Promisable } from 'type-fest';
-type DownloadOptions<T extends Blob | string = Blob | string> = T extends Blob ? {
-    blobType: 'image/png';
-} : {
+type DownloadTextOptions = {
     blobType: 'text/csv' | 'text/plain';
 };
+type DownloadBlobOptions = {
+    blobType: 'application/zip' | 'image/jpeg' | 'image/png' | 'image/webp';
+};
+interface DownloadFunction {
+    (filename: string, data: Blob, options: DownloadBlobOptions): Promise<void>;
+    (filename: string, data: () => Promisable<Blob>, options: DownloadBlobOptions): Promise<void>;
+    (filename: string, data: string, options?: DownloadTextOptions): Promise<void>;
+    (filename: string, data: () => Promisable<string>, options?: DownloadTextOptions): Promise<void>;
+}
 /**
  * Used to trigger downloads of arbitrary data to the client
  * @returns A function to invoke the download
  */
-export declare function useDownload(): <T extends string | Blob>(filename: string, fetchData: () => Promisable<T>, options?: DownloadOptions<T>) => Promise<void>;
+export declare function useDownload(): DownloadFunction;
 export {};
 //# sourceMappingURL=useDownload.d.ts.map

package/dist/hooks/useDownload.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useDownload.d.ts","sourceRoot":"","sources":["../../src/hooks/useDownload.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAI5C,KAAK,eAAe,CAAC,CAAC,SAAS,IAAI,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,IAAI,CAAC,SAAS,IAAI,GAC1E;IAAE,QAAQ,EAAE,WAAW,CAAA;CAAE,GACzB;IAAE,QAAQ,EAAE,UAAU,GAAG,YAAY,CAAA;CAAE,CAAC;AAE5C;;;GAGG;AACH,wBAAgB,WAAW,wCA2Bb,MAAM,aACL,MAAM,WAAW,CAAC,CAAC,YACpB,gBAAgB,CAAC,CAAC,mBAiB/B"}
+{"version":3,"file":"useDownload.d.ts","sourceRoot":"","sources":["../../src/hooks/useDownload.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,WAAW,CAAC;AAI5C,KAAK,mBAAmB,GAAG;IACzB,QAAQ,EAAE,UAAU,GAAG,YAAY,CAAC;CACrC,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACzB,QAAQ,EAAE,iBAAiB,GAAG,YAAY,GAAG,WAAW,GAAG,YAAY,CAAC;CACzE,CAAC;AAGF,UAAU,gBAAgB;IACxB,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5E,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9F,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/E,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClG;AAED;;;GAGG;AACH,wBAAgB,WAAW,IAAI,gBAAgB,CA0C9C"}

package/dist/hooks/useDownload.js

@@ -22,9 +22,9 @@ export function useDownload() {
             setState(null);
         }
     }, [state]);
-    return async (filename, fetchData, options) => {
+    return async (filename, _data, options) => {
         try {
-            const data = await fetchData();
+            const data = typeof _data === 'function' ? await _data() : _data;
             if (typeof data !== 'string' && !options?.blobType) {
                 throw new Error("argument 'blobType' must be defined when download is called with a Blob object");
             }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@douglasneuroinformatics/libui",
   "type": "module",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "packageManager": "pnpm@8.15.3",
   "description": "Generic UI components for DNP projects, built using React and TailwindCSS",
   "author": {

package/src/hooks/useDownload.ts

@@ -4,18 +4,30 @@ import type { Promisable } from 'type-fest';
 
 import { useNotificationsStore } from './useNotificationsStore.js';
 
-type DownloadOptions<T extends Blob | string = Blob | string> = T extends Blob
-  ? { blobType: 'image/png' }
-  : { blobType: 'text/csv' | 'text/plain' };
+type DownloadTextOptions = {
+  blobType: 'text/csv' | 'text/plain';
+};
+
+type DownloadBlobOptions = {
+  blobType: 'application/zip' | 'image/jpeg' | 'image/png' | 'image/webp';
+};
+
+// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
+interface DownloadFunction {
+  (filename: string, data: Blob, options: DownloadBlobOptions): Promise<void>;
+  (filename: string, data: () => Promisable<Blob>, options: DownloadBlobOptions): Promise<void>;
+  (filename: string, data: string, options?: DownloadTextOptions): Promise<void>;
+  (filename: string, data: () => Promisable<string>, options?: DownloadTextOptions): Promise<void>;
+}
 
 /**
  * Used to trigger downloads of arbitrary data to the client
  * @returns A function to invoke the download
  */
-export function useDownload() {
+export function useDownload(): DownloadFunction {
   const notifications = useNotificationsStore();
   const [state, setState] = useState<{
-    blobType: DownloadOptions['blobType'];
+    blobType: string;
     data: Blob | string;
     filename: string;
   } | null>(null);
@@ -38,13 +50,9 @@ export function useDownload() {
     }
   }, [state]);
 
-  return async <T extends Blob | string>(
-    filename: string,
-    fetchData: () => Promisable<T>,
-    options?: DownloadOptions<T>
-  ) => {
+  return async (filename, _data, options) => {
     try {
-      const data = await fetchData();
+      const data = typeof _data === 'function' ? await _data() : _data;
       if (typeof data !== 'string' && !options?.blobType) {
         throw new Error("argument 'blobType' must be defined when download is called with a Blob object");
       }