@scm-manager/ui-api 2.20.1-20210621-094534 → 2.20.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scm-manager/ui-api",
-  "version": "2.20.1-20210621-094534",
+  "version": "2.20.1",
   "description": "React hook api for the SCM-Manager backend",
   "main": "src/index.ts",
   "files": [
@@ -25,7 +25,7 @@
     "react-test-renderer": "^17.0.1"
   },
   "dependencies": {
-    "@scm-manager/ui-types": "^2.20.1-20210621-094534",
+    "@scm-manager/ui-types": "^2.20.1",
     "fetch-mock-jest": "^1.5.1",
     "gitdiff-parser": "^0.1.2",
     "query-string": "5",

package/src/base.ts

@@ -22,24 +22,22 @@
  * SOFTWARE.
  */
 
-import { HalRepresentation, IndexResources, Link } from "@scm-manager/ui-types";
+import { IndexResources, Link } from "@scm-manager/ui-types";
 import { useQuery } from "react-query";
 import { apiClient } from "./apiclient";
 import { useLegacyContext } from "./LegacyContext";
 import { MissingLinkError, UnauthorizedError } from "./errors";
-import { requiredLink } from "./links";
 
 export type ApiResult<T> = {
   isLoading: boolean;
   error: Error | null;
   data?: T;
 };
-export type DeleteFunction<T> = (entity: T) => void;
 
 export const useIndex = (): ApiResult<IndexResources> => {
   const legacy = useLegacyContext();
-  return useQuery<IndexResources, Error>("index", () => apiClient.get("/").then((response) => response.json()), {
-    onSuccess: (index) => {
+  return useQuery<IndexResources, Error>("index", () => apiClient.get("/").then(response => response.json()), {
+    onSuccess: index => {
       // ensure legacy code is notified
       if (legacy.onIndexFetched) {
         legacy.onIndexFetched(index);
@@ -51,7 +49,7 @@ export const useIndex = (): ApiResult<IndexResources> => {
       // This only happens once because the error response automatically invalidates the cookie.
       // In this event, we have to try the request once again.
       return error instanceof UnauthorizedError && failureCount === 0;
-    },
+    }
   });
 };
 
@@ -96,20 +94,7 @@ export const useVersion = (): string => {
 
 export const useIndexJsonResource = <T>(name: string): ApiResult<T> => {
   const link = useIndexLink(name);
-  return useQuery<T, Error>(name, () => apiClient.get(link!).then((response) => response.json()), {
-    enabled: !!link,
+  return useQuery<T, Error>(name, () => apiClient.get(link!).then(response => response.json()), {
+    enabled: !!link
   });
 };
-
-export const useJsonResource = <T>(entity: HalRepresentation, name: string, key: string[]): ApiResult<T> =>
-  useQuery<T, Error>(key, () => apiClient.get(requiredLink(entity, name)).then((response) => response.json()));
-
-export function fetchResourceFromLocationHeader(response: Response) {
-  const location = response.headers.get("Location");
-  if (!location) {
-    throw new Error("Server does not return required Location header");
-  }
-  return apiClient.get(location);
-}
-
-export const getResponseJson = (response: Response) => response.json();

package/src/branches.test.ts

@@ -36,9 +36,9 @@ describe("Test branches hooks", () => {
     type: "hg",
     _links: {
       branches: {
-        href: "/hog/branches",
-      },
-    },
+        href: "/hog/branches"
+      }
+    }
   };
 
   const develop: Branch = {
@@ -46,16 +46,16 @@ describe("Test branches hooks", () => {
     revision: "42",
     _links: {
       delete: {
-        href: "/hog/branches/develop",
-      },
-    },
+        href: "/hog/branches/develop"
+      }
+    }
   };
 
   const branches: BranchCollection = {
     _embedded: {
-      branches: [develop],
+      branches: [develop]
     },
-    _links: {},
+    _links: {}
   };
 
   const queryClient = createInfiniteCachingClient();
@@ -73,7 +73,7 @@ describe("Test branches hooks", () => {
       fetchMock.getOnce("/api/v2/hog/branches", branches);
 
       const { result, waitFor } = renderHook(() => useBranches(repository), {
-        wrapper: createWrapper(undefined, queryClient),
+        wrapper: createWrapper(undefined, queryClient)
       });
       await waitFor(() => {
         return !!result.current.data;
@@ -94,7 +94,7 @@ describe("Test branches hooks", () => {
         "repository",
         "hitchhiker",
         "heart-of-gold",
-        "branches",
+        "branches"
       ]);
       expect(data).toEqual(branches);
     });
@@ -105,7 +105,7 @@ describe("Test branches hooks", () => {
       fetchMock.getOnce("/api/v2/hog/branches/develop", develop);
 
       const { result, waitFor } = renderHook(() => useBranch(repository, "develop"), {
-        wrapper: createWrapper(undefined, queryClient),
+        wrapper: createWrapper(undefined, queryClient)
       });
 
       expect(result.error).toBeUndefined();
@@ -128,14 +128,14 @@ describe("Test branches hooks", () => {
       fetchMock.postOnce("/api/v2/hog/branches", {
         status: 201,
         headers: {
-          Location: "/hog/branches/develop",
-        },
+          Location: "/hog/branches/develop"
+        }
       });
 
       fetchMock.getOnce("/api/v2/hog/branches/develop", develop);
 
       const { result, waitForNextUpdate } = renderHook(() => useCreateBranch(repository), {
-        wrapper: createWrapper(undefined, queryClient),
+        wrapper: createWrapper(undefined, queryClient)
       });
 
       await act(() => {
@@ -160,7 +160,7 @@ describe("Test branches hooks", () => {
         "hitchhiker",
         "heart-of-gold",
         "branch",
-        "develop",
+        "develop"
       ]);
       expect(branch).toEqual(develop);
     });
@@ -177,11 +177,11 @@ describe("Test branches hooks", () => {
   describe("useDeleteBranch tests", () => {
     const deleteBranch = async () => {
       fetchMock.deleteOnce("/api/v2/hog/branches/develop", {
-        status: 204,
+        status: 204
       });
 
       const { result, waitForNextUpdate } = renderHook(() => useDeleteBranch(repository), {
-        wrapper: createWrapper(undefined, queryClient),
+        wrapper: createWrapper(undefined, queryClient)
       });
 
       await act(() => {
@@ -198,12 +198,12 @@ describe("Test branches hooks", () => {
       expect(isDeleted).toBe(true);
     });
 
-    it("should delete branch cache", async () => {
+    it("should invalidate branch", async () => {
       queryClient.setQueryData(["repository", "hitchhiker", "heart-of-gold", "branch", "develop"], develop);
       await deleteBranch();
 
       const queryState = queryClient.getQueryState(["repository", "hitchhiker", "heart-of-gold", "branch", "develop"]);
-      expect(queryState).toBeUndefined();
+      expect(queryState!.isInvalidated).toBe(true);
     });
 
     it("should invalidate cached branches list", async () => {

package/src/branches.ts

@@ -88,7 +88,7 @@ export const useDeleteBranch = (repository: Repository) => {
     },
     {
       onSuccess: async (_, branch) => {
-        queryClient.removeQueries(branchQueryKey(repository, branch));
+        await queryClient.invalidateQueries(branchQueryKey(repository, branch));
         await queryClient.invalidateQueries(repoQueryKey(repository, "branches"));
       }
     }

package/src/changesets.ts

@@ -34,7 +34,7 @@ type UseChangesetsRequest = {
   page?: string | number;
 };
 
-export const changesetQueryKey = (repository: NamespaceAndName, id: string) => {
+const changesetQueryKey = (repository: NamespaceAndName, id: string) => {
   return repoQueryKey(repository, "changeset", id);
 };
 

package/src/diff.ts

@@ -30,14 +30,9 @@ import { Diff, Link } from "@scm-manager/ui-types";
 
 type UseDiffOptions = {
   limit?: number;
-  refetchOnWindowFocus?: boolean;
 };
 
-const defaultOptions: UseDiffOptions = {
-  refetchOnWindowFocus: true,
-};
-
-export const useDiff = (link: string, options: UseDiffOptions = defaultOptions) => {
+export const useDiff = (link: string, options: UseDiffOptions = {}) => {
   let initialLink = link;
   if (options.limit) {
     const separator = initialLink.includes("?") ? "&" : "?";
@@ -46,7 +41,7 @@ export const useDiff = (link: string, options: UseDiffOptions = defaultOptions)
   const { isLoading, error, data, isFetchingNextPage, fetchNextPage } = useInfiniteQuery<Diff, Error, Diff>(
     ["link", link],
     ({ pageParam }) => {
-      return apiClient.get(pageParam || initialLink).then((response) => {
+      return apiClient.get(pageParam || initialLink).then(response => {
         const contentType = response.headers.get("Content-Type");
         if (contentType && contentType.toLowerCase() === "application/vnd.scmm-diffparsed+json;v=2") {
           return response.json();
@@ -54,19 +49,18 @@ export const useDiff = (link: string, options: UseDiffOptions = defaultOptions)
           return response
             .text()
             .then(parser.parse)
-            .then((parsedGit) => {
+            .then(parsedGit => {
               return {
                 files: parsedGit,
                 partial: false,
-                _links: {},
+                _links: {}
               };
             });
         }
       });
     },
     {
-      getNextPageParam: (lastPage) => (lastPage._links.next as Link)?.href,
-      refetchOnWindowFocus: options.refetchOnWindowFocus,
+      getNextPageParam: lastPage => (lastPage._links.next as Link)?.href
     }
   );
 
@@ -77,7 +71,7 @@ export const useDiff = (link: string, options: UseDiffOptions = defaultOptions)
     fetchNextPage: () => {
       fetchNextPage();
     },
-    data: merge(data?.pages),
+    data: merge(data?.pages)
   };
 };
 
@@ -85,9 +79,9 @@ const merge = (diffs?: Diff[]): Diff | undefined => {
   if (!diffs || diffs.length === 0) {
     return;
   }
-  const joinedFiles = diffs.flatMap((diff) => diff.files);
+  const joinedFiles = diffs.flatMap(diff => diff.files);
   return {
     ...diffs[diffs.length - 1],
-    files: joinedFiles,
+    files: joinedFiles
   };
 };

package/src/import.ts

@@ -22,93 +22,11 @@
  * SOFTWARE.
  */
 
-import { ApiResult, fetchResourceFromLocationHeader, getResponseJson, useRequiredIndexLink } from "./base";
-import { useMutation, useQuery } from "react-query";
+import { ApiResult, useRequiredIndexLink } from "./base";
+import { useQuery } from "react-query";
 import { apiClient } from "./apiclient";
-import { Repository, RepositoryCreation, RepositoryType, RepositoryUrlImport } from "@scm-manager/ui-types";
-import { requiredLink } from "./links";
 
-export const useImportLog = (logId: string): ApiResult<string> => {
+export const useImportLog = (logId: string) : ApiResult<string> => {
   const link = useRequiredIndexLink("importLog").replace("{logId}", logId);
-  return useQuery<string, Error>(["importLog", logId], () => apiClient.get(link).then((response) => response.text()));
-};
-
-export const useImportRepositoryFromUrl = (repositoryType: RepositoryType) => {
-  const url = requiredLink(repositoryType, "import", "url");
-  const { isLoading, error, data, mutate } = useMutation<Repository, Error, RepositoryUrlImport>((repo) =>
-    apiClient
-      .post(url, repo, "application/vnd.scmm-repository+json;v=2")
-      .then(fetchResourceFromLocationHeader)
-      .then(getResponseJson)
-  );
-
-  return {
-    isLoading,
-    error,
-    importRepositoryFromUrl: (repository: RepositoryUrlImport) => mutate(repository),
-    importedRepository: data,
-  };
-};
-
-const importRepository = (url: string, repository: RepositoryCreation, file: File, password?: string) => {
-  return apiClient
-    .postBinary(url, (formData) => {
-      formData.append("bundle", file, file?.name);
-      formData.append("repository", JSON.stringify({ ...repository, password }));
-    })
-    .then(fetchResourceFromLocationHeader)
-    .then(getResponseJson);
-};
-
-type ImportRepositoryFromBundleRequest = {
-  repository: RepositoryCreation;
-  file: File;
-  compressed?: boolean;
-  password?: string;
-};
-
-export const useImportRepositoryFromBundle = (repositoryType: RepositoryType) => {
-  const url = requiredLink(repositoryType, "import", "bundle");
-  const { isLoading, error, data, mutate } = useMutation<Repository, Error, ImportRepositoryFromBundleRequest>(
-    ({ repository, file, compressed, password }) =>
-      importRepository(compressed ? url + "?compressed=true" : url, repository, file, password)
-  );
-
-  return {
-    isLoading,
-    error,
-    importRepositoryFromBundle: (repository: RepositoryCreation, file: File, compressed?: boolean, password?: string) =>
-      mutate({
-        repository,
-        file,
-        compressed,
-        password,
-      }),
-    importedRepository: data,
-  };
-};
-
-type ImportFullRepositoryRequest = {
-  repository: RepositoryCreation;
-  file: File;
-  password?: string;
-};
-
-export const useImportFullRepository = (repositoryType: RepositoryType) => {
-  const { isLoading, error, data, mutate } = useMutation<Repository, Error, ImportFullRepositoryRequest>(
-    ({ repository, file, password }) =>
-      importRepository(requiredLink(repositoryType, "import", "fullImport"), repository, file, password)
-  );
-
-  return {
-    isLoading,
-    error,
-    importFullRepository: (repository: RepositoryCreation, file: File, password?: string) =>
-      mutate({
-        repository,
-        file,
-        password,
-      }),
-    importedRepository: data,
-  };
-};
+  return useQuery<string, Error>(["importLog", logId], () => apiClient.get(link).then(response => response.text()));
+}

package/src/index.ts

@@ -50,13 +50,6 @@ export * from "./import";
 export * from "./diff";
 export * from "./notifications";
 export * from "./configLink";
-export * from "./apiKeys";
-export * from "./publicKeys";
-export * from "./fileContent";
-export * from "./history";
-export * from "./contentType";
-export * from "./annotations";
-export * from "./search";
 
 export { default as ApiProvider } from "./ApiProvider";
 export * from "./ApiProvider";

package/src/links.test.ts

@@ -60,40 +60,4 @@ describe("requireLink tests", () => {
     };
     expect(() => requiredLink(object, "spaceship")).toThrowError();
   });
-
-  it("should return sub-link if it exists", () => {
-    const object = {
-      _links: {
-        spaceship: [
-          {
-            name: "one",
-            href: "/v2/one"
-          },
-          {
-            name: "two",
-            href: "/v2/two"
-          }
-        ]
-      }
-    };
-    expect(requiredLink(object, "spaceship", "one")).toBe("/v2/one");
-  });
-
-  it("should throw error, if sub-link does not exist in link array", () => {
-    const object = {
-      _links: {
-        spaceship: [
-          {
-            name: "one",
-            href: "/v2/one"
-          },
-          {
-            name: "two",
-            href: "/v2/two"
-          }
-        ]
-      }
-    };
-    expect(() => requiredLink(object, "spaceship", "three")).toThrowError();
-  });
 });

package/src/links.ts

@@ -21,32 +21,14 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-import { HalRepresentation, Link } from "@scm-manager/ui-types";
+import { HalRepresentation } from "@scm-manager/ui-types";
 import { MissingLinkError } from "./errors";
 
-export const requiredLink = (object: HalRepresentation, name: string, subName?: string): string => {
+export const requiredLink = (object: HalRepresentation, name: string) => {
   const link = object._links[name];
   if (!link) {
     throw new MissingLinkError(`could not find link with name ${name}`);
   }
-  if (Array.isArray(link)) {
-    if (subName) {
-      const subLink = link.find((l: Link) => l.name === subName);
-      if (subLink) {
-        return subLink.href;
-      }
-      throw new Error(`could not return href, sub-link ${subName} in ${name} does not exist`);
-    }
-    throw new Error(`could not return href, link ${name} is a multi link`);
-  }
-  return link.href;
-};
-
-export const objectLink = (object: HalRepresentation, name: string) => {
-  const link = object._links[name];
-  if (!link) {
-    return null;
-  }
   if (Array.isArray(link)) {
     throw new Error(`could not return href, link ${name} is a multi link`);
   }

package/src/permissions.ts

@@ -21,21 +21,18 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
-import { ApiResult, useIndexJsonResource, useJsonResource } from "./base";
+import { ApiResult, useIndexJsonResource } from "./base";
 import { useMutation, useQuery, useQueryClient } from "react-query";
 import {
-  GlobalPermissionsCollection,
-  Group,
   Namespace,
   Permission,
   PermissionCollection,
   PermissionCreateEntry,
   Repository,
-  RepositoryVerbs,
-  User,
+  RepositoryVerbs
 } from "@scm-manager/ui-types";
 import { apiClient } from "./apiclient";
-import { objectLink, requiredLink } from "./links";
+import { requiredLink } from "./links";
 import { repoQueryKey } from "./keys";
 import { useRepositoryRoles } from "./repository-roles";
 
@@ -43,9 +40,6 @@ export const useRepositoryVerbs = (): ApiResult<RepositoryVerbs> => {
   return useIndexJsonResource<RepositoryVerbs>("repositoryVerbs");
 };
 
-/**
- * *IMPORTANT NOTE:* These are actually *REPOSITORY* permissions.
- */
 export const useAvailablePermissions = () => {
   const roles = useRepositoryRoles();
   const verbs = useRepositoryVerbs();
@@ -53,14 +47,14 @@ export const useAvailablePermissions = () => {
   if (roles.data && verbs.data) {
     data = {
       repositoryVerbs: verbs.data.verbs,
-      repositoryRoles: roles.data._embedded.repositoryRoles,
+      repositoryRoles: roles.data._embedded.repositoryRoles
     };
   }
 
   return {
     isLoading: roles.isLoading || verbs.isLoading,
     error: roles.error || verbs.error,
-    data,
+    data
   };
 };
 
@@ -79,21 +73,21 @@ const createQueryKey = (namespaceOrRepository: Namespace | Repository) => {
 export const usePermissions = (namespaceOrRepository: Namespace | Repository): ApiResult<PermissionCollection> => {
   const link = requiredLink(namespaceOrRepository, "permissions");
   const queryKey = createQueryKey(namespaceOrRepository);
-  return useQuery<PermissionCollection, Error>(queryKey, () => apiClient.get(link).then((response) => response.json()));
+  return useQuery<PermissionCollection, Error>(queryKey, () => apiClient.get(link).then(response => response.json()));
 };
 
 const createPermission = (link: string) => {
   return (permission: PermissionCreateEntry) => {
     return apiClient
       .post(link, permission, "application/vnd.scmm-repositoryPermission+json")
-      .then((response) => {
+      .then(response => {
         const location = response.headers.get("Location");
         if (!location) {
           throw new Error("Server does not return required Location header");
         }
         return apiClient.get(location);
       })
-      .then((response) => response.json());
+      .then(response => response.json());
   };
 };
 
@@ -106,21 +100,21 @@ export const useCreatePermission = (namespaceOrRepository: Namespace | Repositor
       onSuccess: () => {
         const queryKey = createQueryKey(namespaceOrRepository);
         return queryClient.invalidateQueries(queryKey);
-      },
+      }
     }
   );
   return {
     isLoading,
     error,
     create: (permission: PermissionCreateEntry) => mutate(permission),
-    permission: data,
+    permission: data
   };
 };
 
 export const useUpdatePermission = (namespaceOrRepository: Namespace | Repository) => {
   const queryClient = useQueryClient();
   const { isLoading, error, mutate, data } = useMutation<unknown, Error, Permission>(
-    (permission) => {
+    permission => {
       const link = requiredLink(permission, "update");
       return apiClient.put(link, permission, "application/vnd.scmm-repositoryPermission+json");
     },
@@ -128,21 +122,21 @@ export const useUpdatePermission = (namespaceOrRepository: Namespace | Repositor
       onSuccess: () => {
         const queryKey = createQueryKey(namespaceOrRepository);
         return queryClient.invalidateQueries(queryKey);
-      },
+      }
     }
   );
   return {
     isLoading,
     error,
     update: (permission: Permission) => mutate(permission),
-    isUpdated: !!data,
+    isUpdated: !!data
   };
 };
 
 export const useDeletePermission = (namespaceOrRepository: Namespace | Repository) => {
   const queryClient = useQueryClient();
   const { isLoading, error, mutate, data } = useMutation<unknown, Error, Permission>(
-    (permission) => {
+    permission => {
       const link = requiredLink(permission, "delete");
       return apiClient.delete(link);
     },
@@ -150,53 +144,13 @@ export const useDeletePermission = (namespaceOrRepository: Namespace | Repositor
       onSuccess: () => {
         const queryKey = createQueryKey(namespaceOrRepository);
         return queryClient.invalidateQueries(queryKey);
-      },
+      }
     }
   );
   return {
     isLoading,
     error,
     remove: (permission: Permission) => mutate(permission),
-    isDeleted: !!data,
-  };
-};
-
-const userPermissionsKey = (user: User) => ["user", user.name, "permissions"];
-const groupPermissionsKey = (group: Group) => ["group", group.name, "permissions"];
-
-export const useGroupPermissions = (group: Group) =>
-  useJsonResource<GlobalPermissionsCollection>(group, "permissions", groupPermissionsKey(group));
-export const useUserPermissions = (user: User) =>
-  useJsonResource<GlobalPermissionsCollection>(user, "permissions", userPermissionsKey(user));
-export const useAvailableGlobalPermissions = () =>
-  useIndexJsonResource<Omit<GlobalPermissionsCollection, "_links">>("permissions");
-
-const useSetEntityPermissions = (permissionCollection?: GlobalPermissionsCollection, key?: string[]) => {
-  const queryClient = useQueryClient();
-  const url = permissionCollection ? objectLink(permissionCollection, "overwrite") : null;
-  const { isLoading, error, mutate, data } = useMutation<unknown, Error, string[]>(
-    (permissions) =>
-      apiClient.put(
-        url!,
-        {
-          permissions,
-        },
-        "application/vnd.scmm-permissionCollection+json;v=2"
-      ),
-    {
-      onSuccess: () => queryClient.invalidateQueries(key),
-    }
-  );
-  const setPermissions = (permissions: string[]) => mutate(permissions);
-  return {
-    isLoading,
-    error,
-    setPermissions: url ? setPermissions : undefined,
-    isUpdated: !!data,
+    isDeleted: !!data
   };
 };
-
-export const useSetUserPermissions = (user: User, permissions?: GlobalPermissionsCollection) =>
-  useSetEntityPermissions(permissions, userPermissionsKey(user));
-export const useSetGroupPermissions = (group: Group, permissions?: GlobalPermissionsCollection) =>
-  useSetEntityPermissions(permissions, groupPermissionsKey(group));