@knime/hub-features 1.6.9 → 1.7.0

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @knime/hub-features
 
+## 1.7.0
+
+### Minor Changes
+
+- add method to versions api to query repository item permissions
+
 ## 1.6.9
 
 ### Patch Changes

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knime/hub-features",
-  "version": "1.6.9",
+  "version": "1.7.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/types.ts

@@ -12,6 +12,26 @@ export type NamedItemVersion = {
   createdOn: string;
 };
 
+interface MasonControl {
+  [key: string]: {
+    href: string;
+    method: string;
+    accept?: string[];
+    encoding?: string;
+    title?: string;
+  };
+}
+
+export type RepositoryItem = {
+  path: string;
+  id: string;
+  type: string;
+  owner: string;
+  author: string;
+  createdOn: string;
+  "@controls": Array<MasonControl>;
+};
+
 export type AssignedLabel = {
   labelId: string;
   message?: string;
@@ -43,3 +63,10 @@ export type ItemSavepoint = {
   itemVersionId?: string; // UUID
   changes: Array<ItemChange>;
 };
+
+export type ItemPermission =
+  | "DELETE"
+  | "EDIT"
+  | "CONFIGURATION"
+  | "MOVE"
+  | "COPY";

package/src/components/versions/useVersionsApi.ts

@@ -5,8 +5,10 @@ import type { HubAvatarData } from "@knime/hub-features";
 import { VERSION_DEFAULT_LIMIT } from "@knime/hub-features/versions";
 import type {
   AssignedLabel,
+  ItemPermission,
   ItemSavepoint,
   NamedItemVersion,
+  RepositoryItem,
   WithAvatar,
   WithLabels,
 } from "@knime/hub-features/versions";
@@ -40,6 +42,13 @@ export const useVersionsApi = ({ baseUrl }: UseVersionsApiOptions) => {
     return response.json();
   };
 
+  const fetchRepositoryItem = ({ itemId }: { itemId: string }) => {
+    return doHubRequestJson(
+      `/repository/${itemId}`,
+      {},
+    ) as Promise<RepositoryItem>;
+  };
+
   const fetchVersions = ({
     itemId,
     loadAll,
@@ -161,10 +170,34 @@ export const useVersionsApi = ({ baseUrl }: UseVersionsApiOptions) => {
     }>;
   };
 
+  const fetchPermissions = async ({
+    itemId,
+  }: {
+    itemId: string;
+  }): Promise<ItemPermission[]> => {
+    const masonControlsMap = {
+      "knime:delete": "DELETE",
+      edit: "EDIT",
+      "knime:configuration": "CONFIGURATION",
+      "knime:move": "MOVE",
+      "knime:copy": "COPY",
+    } as const;
+
+    const repositoryItem = await fetchRepositoryItem({
+      itemId,
+    });
+    return Object.keys(repositoryItem["@controls"])
+      .filter((control) => control in masonControlsMap)
+      .map(
+        (control) => masonControlsMap[control as keyof typeof masonControlsMap],
+      );
+  };
+
   return {
     fetchVersions,
     fetchResourceLabels,
     fetchItemSavepoints,
+    fetchPermissions,
     loadSavepointMetadata,
     deleteVersion,
     createVersion,