@knime/hub-features 1.28.0 → 1.29.1

package/src/components/versions/composables/useVersionsApi.ts

@@ -1,254 +0,0 @@
-import { type FetchOptions } from "ofetch";
-
-import { type HubAvatarData, rfcErrors } from "@knime/hub-features";
-import { VERSION_DEFAULT_LIMIT } from "@knime/hub-features/versions";
-import type {
-  AssignedLabel,
-  ItemPermission,
-  ItemSavepoint,
-  NamedItemVersion,
-  RepositoryItem,
-  VersionLimit,
-  WithAvatar,
-  WithLabels,
-} from "@knime/hub-features/versions";
-
-import { getFetchClient } from "../../../common/ofetchClient";
-
-type UseVersionsApiOptions = {
-  customFetchClientOptions?: FetchOptions;
-};
-
-export const useVersionsApi = ({
-  customFetchClientOptions,
-}: UseVersionsApiOptions) => {
-  const $ofetch = getFetchClient(customFetchClientOptions);
-
-  const doHubRequest = async (path: string, fetchOptions?: FetchOptions) => {
-    const defaults: FetchOptions = {
-      method: "GET",
-    };
-
-    try {
-      consola.trace("useVersionsApi::calling", {
-        path,
-        options: fetchOptions,
-      });
-
-      return await $ofetch(path, { ...defaults, ...fetchOptions });
-    } catch (error) {
-      throw rfcErrors.tryParse(error) ?? error;
-    }
-  };
-
-  const fetchRepositoryItem = ({ itemId }: { itemId: string }) => {
-    return doHubRequest(`/repository/${itemId}`) as Promise<RepositoryItem>;
-  };
-
-  const fetchVersionLimit = ({ itemId }: { itemId: string }) => {
-    return doHubRequest(
-      `/repository/limits/${itemId}/item-versions`,
-    ) as Promise<VersionLimit>;
-  };
-
-  const fetchVersions = ({
-    itemId,
-    loadAll,
-  }: {
-    itemId: string;
-    loadAll: boolean;
-  }) => {
-    let path = `/repository/${itemId}/versions`;
-
-    if (loadAll) {
-      path += "?limit=-1";
-    }
-
-    return doHubRequest(path) as Promise<{
-      totalCount: number;
-      versions: Array<NamedItemVersion>;
-    }>;
-  };
-
-  const fetchResourceLabels = async ({
-    resourceType,
-    resourceId,
-  }: {
-    resourceType: "savepoint";
-    resourceId: string;
-  }): Promise<{
-    assignedLabels: Array<AssignedLabel>;
-  }> => {
-    try {
-      return await doHubRequest(
-        `/validation/validation/resources/${resourceType}/${resourceId}/labels`,
-      );
-    } catch (error) {
-      consola.error("useVersionsApi::Failed to fetch resource labels", {
-        resourceId,
-        resourceType,
-        error,
-      });
-
-      return { assignedLabels: [] };
-    }
-  };
-
-  const deleteVersion = ({
-    itemId,
-    version,
-  }: {
-    itemId: string;
-    version: NamedItemVersion["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 discardUnversionedChanges = ({ itemId }: { itemId: string }) => {
-    return doHubRequest(`/repository/${itemId}/workingArea`, {
-      method: "DELETE",
-    });
-  };
-
-  const createVersion = ({
-    itemId,
-    title,
-    description,
-  }: {
-    itemId: string;
-    title: string;
-    description: string;
-  }): Promise<NamedItemVersion> => {
-    return doHubRequest(`/repository/${itemId}/versions`, {
-      method: "POST",
-      body: JSON.stringify({
-        title,
-        description,
-      }),
-    });
-  };
-
-  const getAvatar = async ({
-    accountName,
-  }: {
-    accountName: string;
-  }): Promise<HubAvatarData> => {
-    try {
-      const accountInfo = await doHubRequest(`/accounts/name/${accountName}`, {
-        headers: {
-          Prefer: "representation=minimal",
-        },
-      });
-
-      return {
-        kind: accountInfo.type === "TEAM" ? "group" : "account",
-        name: accountInfo.name,
-        image: {
-          url: accountInfo.avatarUrl,
-          altText: `${accountInfo.realName ?? accountInfo.name} profile image`,
-        },
-      };
-    } catch (error) {
-      consola.error("useVersionsApi::Failed to fetch user avatar", {
-        accountName,
-        error,
-      });
-
-      return {
-        kind: "account",
-        name: "?",
-        tooltip: "unknown",
-      };
-    }
-  };
-
-  const loadSavepointMetadata = async (
-    savepoint: ItemSavepoint,
-  ): Promise<WithAvatar & WithLabels> => {
-    const avatar = await getAvatar({
-      accountName: savepoint.version?.author ?? savepoint.author,
-    });
-
-    const labels = savepoint.itemVersionId
-      ? await fetchResourceLabels({
-          resourceType: "savepoint",
-          resourceId: savepoint.itemVersionId,
-        }).then((response) => response.assignedLabels)
-      : [];
-
-    return { avatar, labels };
-  };
-
-  const fetchItemSavepoints = ({
-    itemId,
-    limit,
-  }: {
-    itemId: string;
-    limit?: number;
-  }) => {
-    return doHubRequest(
-      `/repository/${itemId}/savepoints?limit=${
-        limit ?? VERSION_DEFAULT_LIMIT
-      }`,
-    ) as Promise<{
-      totalCount: number;
-      savepoints: Array<ItemSavepoint>;
-    }>;
-  };
-
-  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,
-    fetchVersionLimit,
-    fetchResourceLabels,
-    fetchItemSavepoints,
-    fetchPermissions,
-    loadSavepointMetadata,
-    deleteVersion,
-    restoreVersion,
-    discardUnversionedChanges,
-    createVersion,
-    getAvatar,
-  };
-};
-
-export type VersionsAPI = ReturnType<typeof useVersionsApi>;

package/src/components/versions/constants.ts

@@ -1,3 +0,0 @@
-export const VERSION_DEFAULT_LIMIT = 10;
-export const CURRENT_STATE_VERSION = "current-state";
-export const MOST_RECENT_VERSION = "most-recent";

package/src/components/versions/index.ts

@@ -1,7 +0,0 @@
-import CreateVersionForm from "./components/CreateVersionForm.vue";
-import ManageVersions from "./components/ManageVersions.vue";
-
-export { CreateVersionForm, ManageVersions };
-export type * from "./types";
-export * from "./constants";
-export * from "./composables/useVersionsApi";

package/src/components/versions/types.ts

@@ -1,77 +0,0 @@
-import type { HubAvatarData } from "../avatars/HubAvatar.vue";
-
-import type { CURRENT_STATE_VERSION, MOST_RECENT_VERSION } from "./constants";
-
-// TODO: Generate from OpenAPI spec
-export type NamedItemVersion = {
-  version: number | typeof CURRENT_STATE_VERSION | typeof MOST_RECENT_VERSION;
-  title: string;
-  description?: string;
-  author: string;
-  authorAccountId?: string;
-  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;
-  createdAt?: string;
-  createdBy?: string; // UUID
-  label: {
-    name?: string;
-    description?: string;
-  };
-};
-
-export type WithAvatar = { avatar: HubAvatarData };
-export type WithLabels = { labels: Array<AssignedLabel> };
-
-type ItemChange = {
-  author: string;
-  createdOn: string;
-  eventActionType: "ADDED" | "UPDATED" | "MOVED" | "RENAMED";
-  message: string;
-  authorAccountId?: string;
-};
-
-export type ItemSavepoint = {
-  author: string;
-  authorAccountId?: string;
-  lastEditedOn: string;
-  savepointNumber: number;
-  version?: NamedItemVersion;
-  itemVersionId?: string; // UUID
-  changes: Array<ItemChange>;
-};
-
-export type ItemPermission =
-  | "DELETE"
-  | "EDIT"
-  | "CONFIGURATION"
-  | "MOVE"
-  | "COPY";
-
-export type VersionLimit = {
-  currentUsage: number;
-  limit?: number;
-};