@scm-manager/ui-api 2.36.1 → 2.36.2-20220522-120507

package/src/urls.ts

@@ -1,118 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2020-present Cloudogu GmbH and Contributors
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import queryString from "query-string";
-
-//@ts-ignore
-export const contextPath = window.ctxPath || "";
-
-export function withContextPath(path: string) {
-  return contextPath + path;
-}
-
-export function withEndingSlash(url: string) {
-  if (url.endsWith("/")) {
-    return url;
-  }
-  return url + "/";
-}
-
-export function withStartingSlash(url: string) {
-  if (url.startsWith("/")) {
-    return url;
-  }
-  return "/" + url;
-}
-
-export function concat(base: string, ...parts: string[]) {
-  let url = base;
-  for (const p of parts) {
-    url = withEndingSlash(url) + p;
-  }
-  return url;
-}
-
-export function getNamespaceAndPageFromMatch(match: any) {
-  const namespaceFromMatch: string = match.params.namespace;
-  const pageFromMatch: string = match.params.page;
-
-  if (!namespaceFromMatch && !pageFromMatch) {
-    return { namespace: undefined, page: 1 };
-  }
-
-  if (!pageFromMatch) {
-    if (namespaceFromMatch.match(/^\d{1,3}$/)) {
-      return { namespace: undefined, page: parsePageNumber(namespaceFromMatch) };
-    } else {
-      return { namespace: namespaceFromMatch, page: 1 };
-    }
-  }
-
-  return { namespace: namespaceFromMatch, page: parsePageNumber(pageFromMatch) };
-}
-
-export function getPageFromMatch(match: any) {
-  return parsePageNumber(match.params.page);
-}
-
-function parsePageNumber(pageAsString: string) {
-  const page = parseInt(pageAsString, 10);
-  if (isNaN(page) || !page) {
-    return 1;
-  }
-  return page;
-}
-
-export function getQueryStringFromLocation(location: { search?: string }): string | undefined {
-  if (location.search) {
-    const query = queryString.parse(location.search).q;
-    if (query && !Array.isArray(query)) {
-      return query;
-    }
-  }
-}
-
-export function stripEndingSlash(url: string) {
-  if (url.endsWith("/")) {
-    return url.substring(0, url.length - 1);
-  }
-  return url;
-}
-
-export function matchedUrlFromMatch(match: any) {
-  return stripEndingSlash(match.url);
-}
-
-export function matchedUrl(props: any) {
-  const match = props.match;
-  return matchedUrlFromMatch(match);
-}
-
-export function escapeUrlForRoute(url: string) {
-  return url.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
-}
-
-export function unescapeUrlForRoute(url: string) {
-  return url.replace(/\\/g, "");
-}

package/src/usePluginCenterAuthInfo.ts

@@ -1,91 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2020-present Cloudogu GmbH and Contributors
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { ApiResult, useIndexLink } from "./base";
-import { Link, PluginCenterAuthenticationInfo } from "@scm-manager/ui-types";
-import { useMutation, useQuery, useQueryClient } from "react-query";
-import { apiClient } from "./apiclient";
-import { useLocation } from "react-router-dom";
-
-const appendQueryParam = (link: Link, name: string, value: string) => {
-  let href = link.href;
-  if (href.includes("?")) {
-    href += "&";
-  } else {
-    href += "?";
-  }
-  link.href = href + name + "=" + value;
-};
-
-export const usePluginCenterAuthInfo = (): ApiResult<PluginCenterAuthenticationInfo> => {
-  const link = useIndexLink("pluginCenterAuth");
-  const location = useLocation();
-  return useQuery<PluginCenterAuthenticationInfo, Error>(
-    ["pluginCenterAuth"],
-    () => {
-      if (!link) {
-        throw new Error("no such plugin center auth link");
-      }
-      return apiClient
-        .get(link)
-        .then(response => response.json())
-        .then((result: PluginCenterAuthenticationInfo) => {
-          if (result._links?.login) {
-            appendQueryParam(result._links.login as Link, "source", location.pathname);
-          }
-          if (result._links?.reconnect) {
-            appendQueryParam(result._links.reconnect as Link, "source", location.pathname);
-          }
-          return result;
-        });
-    },
-    {
-      enabled: !!link
-    }
-  );
-};
-
-export const usePluginCenterLogout = (authenticationInfo: PluginCenterAuthenticationInfo) => {
-  const queryClient = useQueryClient();
-  const { mutate, isLoading, error } = useMutation<unknown, Error>(
-    () => {
-      if (!authenticationInfo._links.logout) {
-        throw new Error("authenticationInfo has no logout link");
-      }
-      const logout = authenticationInfo._links.logout as Link;
-      return apiClient.delete(logout.href);
-    },
-    {
-      onSuccess: () => queryClient.invalidateQueries("pluginCenterAuth")
-    }
-  );
-
-  return {
-    logout: () => {
-      mutate();
-    },
-    isLoading,
-    error
-  };
-};

package/src/userSuggestions.ts

@@ -1,32 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2020-present Cloudogu GmbH and Contributors
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-import { Link } from "@scm-manager/ui-types";
-import { useIndexLinks } from "./base";
-import { useSuggestions } from "./suggestions";
-
-export const useUserSuggestions = () => {
-  const indexLinks = useIndexLinks();
-  const autocompleteLink = (indexLinks.autocomplete as Link[]).find((i) => i.name === "users");
-  return useSuggestions(autocompleteLink?.href);
-};

package/src/users.test.ts

@@ -1,310 +0,0 @@
-/*
- * MIT License
- *
- * Copyright (c) 2020-present Cloudogu GmbH and Contributors
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- */
-
-import { User, UserCollection } from "@scm-manager/ui-types";
-import fetchMock from "fetch-mock-jest";
-import createInfiniteCachingClient from "./tests/createInfiniteCachingClient";
-import { setIndexLink } from "./tests/indexLinks";
-import { renderHook } from "@testing-library/react-hooks";
-import createWrapper from "./tests/createWrapper";
-import { act } from "react-test-renderer";
-import {
-  useConvertToExternal,
-  useConvertToInternal,
-  useCreateUser,
-  useDeleteUser,
-  useUpdateUser,
-  useUser,
-  useUsers,
-} from "./users";
-
-describe("Test user hooks", () => {
-  const yoda: User = {
-    active: false,
-    displayName: "",
-    external: false,
-    password: "",
-    name: "yoda",
-    _links: {
-      delete: {
-        href: "/users/yoda",
-      },
-      update: {
-        href: "/users/yoda",
-      },
-      convertToInternal: {
-        href: "/users/yoda/convertToInternal",
-      },
-      convertToExternal: {
-        href: "/users/yoda/convertToExternal",
-      },
-    },
-    _embedded: {
-      members: [],
-    },
-  };
-
-  const userCollection: UserCollection = {
-    _links: {},
-    page: 0,
-    pageTotal: 0,
-    _embedded: {
-      users: [yoda],
-    },
-  };
-
-  afterEach(() => {
-    fetchMock.reset();
-  });
-
-  describe("useUsers tests", () => {
-    it("should return users", async () => {
-      const queryClient = createInfiniteCachingClient();
-      setIndexLink(queryClient, "users", "/users");
-      fetchMock.get("/api/v2/users", userCollection);
-      const { result, waitFor } = renderHook(() => useUsers(), {
-        wrapper: createWrapper(undefined, queryClient),
-      });
-      await waitFor(() => !!result.current.data);
-      expect(result.current.data).toEqual(userCollection);
-    });
-
-    it("should return paged users", async () => {
-      const queryClient = createInfiniteCachingClient();
-      setIndexLink(queryClient, "users", "/users");
-      fetchMock.get("/api/v2/users", userCollection, {
-        query: {
-          page: "42",
-        },
-      });
-      const { result, waitFor } = renderHook(() => useUsers({ page: 42 }), {
-        wrapper: createWrapper(undefined, queryClient),
-      });
-      await waitFor(() => !!result.current.data);
-      expect(result.current.data).toEqual(userCollection);
-    });
-
-    it("should return searched users", async () => {
-      const queryClient = createInfiniteCachingClient();
-      setIndexLink(queryClient, "users", "/users");
-      fetchMock.get("/api/v2/users", userCollection, {
-        query: {
-          q: "yoda",
-        },
-      });
-      const { result, waitFor } = renderHook(() => useUsers({ search: "yoda" }), {
-        wrapper: createWrapper(undefined, queryClient),
-      });
-      await waitFor(() => !!result.current.data);
-      expect(result.current.data).toEqual(userCollection);
-    });
-
-    it("should update user cache", async () => {
-      const queryClient = createInfiniteCachingClient();
-      setIndexLink(queryClient, "users", "/users");
-      fetchMock.get("/api/v2/users", userCollection);
-      const { result, waitFor } = renderHook(() => useUsers(), {
-        wrapper: createWrapper(undefined, queryClient),
-      });
-      await waitFor(() => !!result.current.data);
-      expect(queryClient.getQueryData(["user", "yoda"])).toEqual(yoda);
-    });
-  });
-
-  describe("useUser tests", () => {
-    it("should return user", async () => {
-      const queryClient = createInfiniteCachingClient();
-      setIndexLink(queryClient, "users", "/users");
-      fetchMock.get("/api/v2/users/yoda", yoda);
-      const { result, waitFor } = renderHook(() => useUser("yoda"), {
-        wrapper: createWrapper(undefined, queryClient),
-      });
-      await waitFor(() => !!result.current.data);
-      expect(result.current.data).toEqual(yoda);
-    });
-  });
-
-  describe("useCreateUser tests", () => {
-    it("should create user", async () => {
-      const queryClient = createInfiniteCachingClient();
-      setIndexLink(queryClient, "users", "/users");
-
-      fetchMock.postOnce("/api/v2/users", {
-        status: 201,
-        headers: {
-          Location: "/users/yoda",
-        },
-      });
-
-      fetchMock.getOnce("/api/v2/users/yoda", yoda);
-
-      const { result, waitForNextUpdate } = renderHook(() => useCreateUser(), {
-        wrapper: createWrapper(undefined, queryClient),
-      });
-
-      await act(() => {
-        const { create } = result.current;
-        create(yoda);
-        return waitForNextUpdate();
-      });
-
-      expect(result.current.user).toEqual(yoda);
-    });
-
-    it("should fail without location header", async () => {
-      const queryClient = createInfiniteCachingClient();
-      setIndexLink(queryClient, "users", "/users");
-
-      fetchMock.postOnce("/api/v2/users", {
-        status: 201,
-      });
-
-      fetchMock.getOnce("/api/v2/users/yoda", yoda);
-
-      const { result, waitForNextUpdate } = renderHook(() => useCreateUser(), {
-        wrapper: createWrapper(undefined, queryClient),
-      });
-
-      await act(() => {
-        const { create } = result.current;
-        create(yoda);
-        return waitForNextUpdate();
-      });
-
-      expect(result.current.error).toBeDefined();
-    });
-  });
-
-  describe("useDeleteUser tests", () => {
-    it("should delete user", async () => {
-      const queryClient = createInfiniteCachingClient();
-      setIndexLink(queryClient, "users", "/users");
-
-      fetchMock.deleteOnce("/api/v2/users/yoda", {
-        status: 200,
-      });
-
-      const { result, waitForNextUpdate } = renderHook(() => useDeleteUser(), {
-        wrapper: createWrapper(undefined, queryClient),
-      });
-
-      await act(() => {
-        const { remove } = result.current;
-        remove(yoda);
-        return waitForNextUpdate();
-      });
-
-      expect(result.current.error).toBeFalsy();
-      expect(result.current.isDeleted).toBe(true);
-      expect(result.current.isLoading).toBe(false);
-      expect(queryClient.getQueryData(["user", "yoda"])).toBeUndefined();
-    });
-  });
-
-  describe("useUpdateUser tests", () => {
-    it("should update user", async () => {
-      const queryClient = createInfiniteCachingClient();
-      setIndexLink(queryClient, "users", "/users");
-
-      const newJedis = {
-        ...yoda,
-        description: "may the 4th be with you",
-      };
-
-      fetchMock.putOnce("/api/v2/users/yoda", {
-        status: 200,
-      });
-
-      fetchMock.getOnce("/api/v2/users/yoda", newJedis);
-
-      const { result, waitForNextUpdate } = renderHook(() => useUpdateUser(), {
-        wrapper: createWrapper(undefined, queryClient),
-      });
-
-      await act(() => {
-        const { update } = result.current;
-        update(newJedis);
-        return waitForNextUpdate();
-      });
-
-      expect(result.current.error).toBeFalsy();
-      expect(result.current.isUpdated).toBe(true);
-      expect(result.current.isLoading).toBe(false);
-      expect(queryClient.getQueryData(["user", "yoda"])).toBeUndefined();
-      expect(queryClient.getQueryData(["users"])).toBeUndefined();
-    });
-  });
-
-  describe("useConvertToInternal tests", () => {
-    it("should convert user", async () => {
-      const queryClient = createInfiniteCachingClient();
-
-      fetchMock.putOnce("/api/v2/users/yoda/convertToInternal", {
-        status: 200,
-      });
-
-      const { result, waitForNextUpdate } = renderHook(() => useConvertToInternal(), {
-        wrapper: createWrapper(undefined, queryClient),
-      });
-
-      await act(() => {
-        const { convertToInternal } = result.current;
-        convertToInternal(yoda, "thisisaverystrongpassword");
-        return waitForNextUpdate();
-      });
-
-      expect(result.current.error).toBeFalsy();
-      expect(result.current.isConverted).toBe(true);
-      expect(result.current.isLoading).toBe(false);
-      expect(queryClient.getQueryData(["user", "yoda"])).toBeUndefined();
-      expect(queryClient.getQueryData(["users"])).toBeUndefined();
-    });
-  });
-
-  describe("useConvertToExternal tests", () => {
-    it("should convert user", async () => {
-      const queryClient = createInfiniteCachingClient();
-
-      fetchMock.putOnce("/api/v2/users/yoda/convertToExternal", {
-        status: 200,
-      });
-
-      const { result, waitForNextUpdate } = renderHook(() => useConvertToExternal(), {
-        wrapper: createWrapper(undefined, queryClient),
-      });
-
-      await act(() => {
-        const { convertToExternal } = result.current;
-        convertToExternal(yoda);
-        return waitForNextUpdate();
-      });
-
-      expect(result.current.error).toBeFalsy();
-      expect(result.current.isConverted).toBe(true);
-      expect(result.current.isLoading).toBe(false);
-      expect(queryClient.getQueryData(["user", "yoda"])).toBeUndefined();
-      expect(queryClient.getQueryData(["users"])).toBeUndefined();
-    });
-  });
-});