@knime/hub-features 1.7.3 → 1.8.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @knime/hub-features
 
+## 1.8.0
+
+### Minor Changes
+
+- add restoreVersion to versionsApi
+
+## 1.7.4
+
+### Patch Changes
+
+- df25c75: switch to ofetch and improve error handling
+
 ## 1.7.3
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/hub-features",
-  "version": "1.7.3",
+  "version": "1.8.0",
   "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/components/versions/useVersionsApi.ts

@@ -1,7 +1,6 @@
-/* global RequestInit */
-import { merge } from "lodash-es";
+import { FetchError, type FetchOptions } from "ofetch";
 
-import type { HubAvatarData } from "@knime/hub-features";
+import { type HubAvatarData, rfcErrors } from "@knime/hub-features";
 import { VERSION_DEFAULT_LIMIT } from "@knime/hub-features/versions";
 import type {
   AssignedLabel,
@@ -13,40 +12,47 @@ import type {
   WithLabels,
 } from "@knime/hub-features/versions";
 
+import { DEFAULT_API_BASE_URL } from "../../common/constants";
+import { getFetchClient } from "../../common/ofetchClient";
+
 type UseVersionsApiOptions = {
   baseUrl?: string;
+  customFetchClientOptions?: FetchOptions;
 };
 
-export const useVersionsApi = ({ baseUrl }: UseVersionsApiOptions) => {
-  const doHubRequest = (path: string, requestOptions: RequestInit = {}) => {
-    const res = `${baseUrl}${path}`;
-    consola.trace(`useVersionsApi::fetching '${res}'`, requestOptions);
+export const useVersionsApi = ({
+  baseUrl,
+  customFetchClientOptions,
+}: UseVersionsApiOptions) => {
+  const $ofetch = getFetchClient(customFetchClientOptions);
 
-    const defaults = {
+  const doHubRequest = (path: string, fetchOptions?: FetchOptions) => {
+    const res = `${baseUrl ?? DEFAULT_API_BASE_URL}${path}`;
+    const defaults: FetchOptions = {
       method: "GET",
     };
-    return fetch(res, {
-      ...defaults,
-      ...requestOptions,
-    });
-  };
 
-  const doHubRequestJson = async (
-    path: string,
-    requestOptions: RequestInit = {},
-  ) => {
-    merge(requestOptions, {
-      headers: { "Content-Type": "application/json" as const },
-    });
-    const response = await doHubRequest(path, requestOptions);
-    return response.json();
+    try {
+      consola.trace("useVersionsApi::calling", {
+        path: res,
+        options: fetchOptions,
+      });
+
+      return $ofetch(res, {
+        ...defaults,
+        ...fetchOptions,
+      });
+    } catch (error) {
+      if (error instanceof FetchError) {
+        throw rfcErrors.tryParse(error);
+      }
+
+      throw error;
+    }
   };
 
   const fetchRepositoryItem = ({ itemId }: { itemId: string }) => {
-    return doHubRequestJson(
-      `/repository/${itemId}`,
-      {},
-    ) as Promise<RepositoryItem>;
+    return doHubRequest(`/repository/${itemId}`) as Promise<RepositoryItem>;
   };
 
   const fetchVersions = ({
@@ -62,7 +68,7 @@ export const useVersionsApi = ({ baseUrl }: UseVersionsApiOptions) => {
       path += "?limit=-1";
     }
 
-    return doHubRequestJson(path) as Promise<{
+    return doHubRequest(path) as Promise<{
       totalCount: number;
       versions: Array<NamedItemVersion>;
     }>;
@@ -75,36 +81,50 @@ export const useVersionsApi = ({ baseUrl }: UseVersionsApiOptions) => {
     resourceType: "savepoint";
     resourceId: string;
   }) => {
-    return doHubRequestJson(
+    return doHubRequest(
       `/validation/validation/resources/${resourceType}/${resourceId}/labels`,
-      {},
     ).catch(() => ({ assignedLabels: [] })) as Promise<{
       assignedLabels: Array<AssignedLabel>;
     }>;
   };
 
   const deleteVersion = ({
-    projectItemId,
+    itemId,
     version,
   }: {
-    projectItemId: string;
+    itemId: string;
     version: NamedItemVersion["version"];
   }) => {
-    return doHubRequest(`/repository/${projectItemId}/versions/${version}`, {
+    return doHubRequest(`/repository/${itemId}/versions/${version}`, {
       method: "DELETE",
     });
   };
 
+  const restoreVersion = ({
+    itemId,
+    version,
+  }: {
+    itemId: string;
+    version: NamedItemVersion["version"];
+  }) => {
+    return doHubRequest(
+      `/repository/${itemId}/workingArea?fromVersion=${version}`,
+      {
+        method: "POST",
+      },
+    );
+  };
+
   const createVersion = ({
-    projectItemId,
+    itemId,
     title,
     description,
   }: {
-    projectItemId: string;
+    itemId: string;
     title: string;
     description: string;
   }): Promise<NamedItemVersion> => {
-    return doHubRequestJson(`/repository/${projectItemId}/versions`, {
+    return doHubRequest(`/repository/${itemId}/versions`, {
       method: "POST",
       body: JSON.stringify({
         title,
@@ -118,14 +138,11 @@ export const useVersionsApi = ({ baseUrl }: UseVersionsApiOptions) => {
   }: {
     accountName: string;
   }): Promise<HubAvatarData> => {
-    const accountInfo = await doHubRequestJson(
-      `/accounts/name/${accountName}`,
-      {
-        headers: {
-          Prefer: "representation=minimal",
-        },
+    const accountInfo = await doHubRequest(`/accounts/name/${accountName}`, {
+      headers: {
+        Prefer: "representation=minimal",
       },
-    );
+    });
 
     return {
       kind: accountInfo.type === "TEAM" ? "group" : "account",
@@ -134,7 +151,7 @@ export const useVersionsApi = ({ baseUrl }: UseVersionsApiOptions) => {
         url: accountInfo.avatarUrl,
         altText: `${accountInfo.realName ?? accountInfo.name} profile image`,
       },
-    } satisfies HubAvatarData;
+    };
   };
 
   const loadSavepointMetadata = async (
@@ -160,7 +177,7 @@ export const useVersionsApi = ({ baseUrl }: UseVersionsApiOptions) => {
     itemId: string;
     limit?: number;
   }) => {
-    return doHubRequestJson(
+    return doHubRequest(
       `/repository/${itemId}/savepoints?limit=${
         limit ?? VERSION_DEFAULT_LIMIT
       }`,
@@ -200,6 +217,7 @@ export const useVersionsApi = ({ baseUrl }: UseVersionsApiOptions) => {
     fetchPermissions,
     loadSavepointMetadata,
     deleteVersion,
+    restoreVersion,
     createVersion,
     getAvatar,
   };

package/src/useFileUpload/useFileUpload.ts

@@ -43,7 +43,7 @@ type UseFileUploadOptions = {
  * It is a multi-step process which is described as follows:
  *
  * Step 1:
- * First we need to prepare an upload. The items will will be uploaded to a `parent` container
+ * First we need to prepare an upload. The items will be uploaded to a `parent` container
  * identified by its id. Then, for each file we want to upload, we must provide paths relative
  * to the parent that identify each file. Example:
  *  ```