@knime/hub-features 1.10.4 → 1.10.5

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @knime/hub-features
 
+## 1.10.5
+
+### Patch Changes
+
+- 805588d: update async download flow in useDownloadArtifact to reflect api changes
+
 ## 1.10.4
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/hub-features",
-  "version": "1.10.4",
+  "version": "1.10.5",
   "description": "Vue components & composables for shared hub features",
   "homepage": "https://knime.github.io/webapps-common/",
   "license": "GPL 3 and Additional Permissions according to Sec. 7 (SEE the file LICENSE)",

package/src/useDownloadArtifact/useDownloadArtifact.ts

@@ -18,8 +18,20 @@ type ArtifactStatusResponse = {
   downloadUrl?: string;
 };
 
-type RequestDownloadResponse = {
-  downloadId: string;
+// Initial request can have either download url (if it can be downloaded immediately) or download id (to poll for the status)
+type RequestDownloadResponse =
+  | {
+      downloadId: string;
+    }
+  | {
+      downloadUrl: string;
+    };
+
+// type guard
+const hasDownloadUrl = (
+  response: RequestDownloadResponse,
+): response is { downloadUrl: string } => {
+  return "downloadUrl" in response;
 };
 
 /**
@@ -255,24 +267,20 @@ export const useDownloadArtifact = (
           query: { version },
         },
       );
-      const downloadId = response.downloadId;
-
-      const downloadStatusResponse = await fetchDownloadStatus({ downloadId });
-
-      if (
-        // download is ready immediately, no polling needed
-        downloadStatusResponse?.status === "READY" &&
-        downloadStatusResponse?.downloadUrl
-      ) {
-        openDownload(downloadStatusResponse.downloadUrl);
-      } else {
-        await pollDownloadItem({
-          itemId,
-          version,
-          downloadId,
-          name,
-        });
+
+      // if download is ready, open url immediately
+      if (hasDownloadUrl(response)) {
+        openDownload(response.downloadUrl);
+        return;
       }
+
+      // otherwise start polling download status
+      await pollDownloadItem({
+        itemId,
+        version,
+        downloadId: response.downloadId,
+        name,
+      });
     } catch (error: unknown) {
       // here only errors thrown by the initial requests are caught;
       // errors occurring while polling will be handled in pollDownloadItem