@knime/hub-features 1.2.14 → 1.2.15

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @knime/hub-features
 
+## 1.2.15
+
+### Patch Changes
+
+- Adjust parameter signature for success/failure callbacks of upload feature
+- Updated dependencies
+  - @knime/components@1.18.3
+  - @knime/utils@1.2.6
+
 ## 1.2.14
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/hub-features",
-  "version": "1.2.14",
+  "version": "1.2.15",
   "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)",
@@ -25,16 +25,18 @@
     "@vueuse/core": "10.4.1",
     "@vueuse/shared": "^10.10.0",
     "consola": "3.2.3",
+    "lodash-es": "4.17.21",
     "ofetch": "^1.4.1",
     "typescript": "^5.4.5",
-    "@knime/components": "1.18.2",
+    "@knime/components": "1.18.3",
     "@knime/styles": "1.3.0",
-    "@knime/utils": "1.2.5"
+    "@knime/utils": "1.2.6"
   },
   "peerDependencies": {
     "vue": "3.x"
   },
   "devDependencies": {
+    "@types/lodash-es": "^4.17.12",
     "@vitejs/plugin-vue": "^5.1.4",
     "@vitest/coverage-v8": "2.1.1",
     "@vue/test-utils": "2.4.4",

package/src/common/ofetchClient.ts

@@ -1,6 +1,7 @@
-import { ofetch } from "ofetch";
+import { merge } from "lodash-es";
+import { type FetchOptions, ofetch } from "ofetch";
 
-const defaultConfig = {
+export const defaultConfig: FetchOptions = {
   headers: {
     "Content-Type": "application/json",
 
@@ -9,4 +10,5 @@ const defaultConfig = {
   },
 } as const;
 
-export const $ofetch = ofetch.create(defaultConfig);
+export const getFetchClient = (customOptions?: FetchOptions) =>
+  ofetch.create(merge(customOptions, defaultConfig));

package/src/useFileUpload/useFileUpload.ts

@@ -1,10 +1,10 @@
 import { computed, reactive, readonly, ref } from "vue";
-import { FetchError } from "ofetch";
+import { FetchError, type FetchOptions } from "ofetch";
 
 import { useUploadManager } from "@knime/components";
 import { getFileMimeType, knimeFileFormats, promise } from "@knime/utils";
 
-import { $ofetch } from "../common/ofetchClient";
+import { getFetchClient } from "../common/ofetchClient";
 import { rfcErrors } from "../rfcErrors";
 
 const DEFAULT_MAX_UPLOAD_QUEUE_SIZE = 10;
@@ -21,13 +21,22 @@ type UseFileUploadOptions = {
    * will be ignored. This will also call the `onUploadQueueSizeExceeded` callback
    */
   maxUploadQueueSize?: number;
-  apiBaseUrl?: string;
-  onFileUploadComplete?: (
-    uploadId: string,
-    filePartIds: Record<number, string>,
-  ) => void;
-  onFileUploadFailed?: (uploadId: string, error: Error) => void;
+  onFileUploadComplete?: (payload: {
+    uploadId: string;
+    filePartIds: Record<number, string>;
+    parentId: string;
+  }) => void;
+  onFileUploadFailed?: (payload: {
+    uploadId: string;
+    error: Error;
+    parentId: string;
+  }) => void;
   onUploadQueueSizeExceeded?: (maxQueueSize: number) => void;
+  /**
+   * Options to customize the fetch client used internally to make http requests.
+   * e.g: headers, baseUrl, etc
+   */
+  customFetchClientOptions?: FetchOptions;
 };
 
 /**
@@ -100,7 +109,9 @@ type UseFileUploadOptions = {
  * ```
  */
 export const useFileUpload = (options: UseFileUploadOptions = {}) => {
-  const baseUrl = computed(() => options.apiBaseUrl ?? DEFAULT_API_BASE_URL);
+  const baseUrl =
+    options.customFetchClientOptions?.baseURL ?? DEFAULT_API_BASE_URL;
+  const $ofetch = getFetchClient(options.customFetchClientOptions);
 
   const prepareUpload = (
     parentId: string,
@@ -132,7 +143,7 @@ export const useFileUpload = (options: UseFileUploadOptions = {}) => {
     };
 
     return $ofetch<PrepareUploadResponse>(
-      `${baseUrl.value}/repository/${parentId}/manifest`,
+      `${baseUrl}/repository/${parentId}/manifest`,
       { method: "POST", body: { items } },
     ).then(({ items }) => {
       return Object.keys(items).map((name) => {
@@ -151,7 +162,7 @@ export const useFileUpload = (options: UseFileUploadOptions = {}) => {
     };
 
     return $ofetch<UploadURLResponse>(
-      `${baseUrl.value}/uploads/${uploadId}/parts/?partNumber=${partNumber}`,
+      `${baseUrl}/uploads/${uploadId}/parts/?partNumber=${partNumber}`,
       { method: "POST" },
     );
   };
@@ -160,14 +171,14 @@ export const useFileUpload = (options: UseFileUploadOptions = {}) => {
     uploadId: string,
     partIds: Record<number, string>,
   ) => {
-    return $ofetch(`${baseUrl.value}/uploads/${uploadId}`, {
+    return $ofetch(`${baseUrl}/uploads/${uploadId}`, {
       method: "POST",
       body: partIds,
     });
   };
 
   const cancelUpload = (uploadId: string) => {
-    return $ofetch(`${baseUrl.value}/uploads/${uploadId}`, {
+    return $ofetch(`${baseUrl}/uploads/${uploadId}`, {
       method: "DELETE",
     });
   };
@@ -200,11 +211,11 @@ export const useFileUpload = (options: UseFileUploadOptions = {}) => {
   useUploadManagerResult = useUploadManager({
     resolveFilePartUploadURL,
 
-    onFileUploadComplete: ({ uploadId, filePartIds }) => {
+    onFileUploadComplete: ({ uploadId, filePartIds, parentId }) => {
       promise
         .retryPromise({ fn: () => completeUpload(uploadId, filePartIds) })
         .then(() => {
-          options.onFileUploadComplete?.(uploadId, filePartIds);
+          options.onFileUploadComplete?.({ uploadId, filePartIds, parentId });
         })
         .catch((error) => {
           consola.error("Error attempting to complete upload", { error });
@@ -212,8 +223,8 @@ export const useFileUpload = (options: UseFileUploadOptions = {}) => {
         });
     },
 
-    onFileUploadFailed: (uploadId, error) => {
-      options?.onFileUploadFailed?.(uploadId, error);
+    onFileUploadFailed: ({ uploadId, error, parentId }) => {
+      options?.onFileUploadFailed?.({ uploadId, error, parentId });
     },
   });