@scm-manager/ui-api 2.33.1-20220411-113741 → 2.34.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scm-manager/ui-api",
-  "version": "2.33.1-20220411-113741",
+  "version": "2.34.0",
   "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.33.1-20220411-113741",
+    "@scm-manager/ui-types": "^2.34.0",
     "fetch-mock-jest": "^1.5.1",
     "gitdiff-parser": "^0.2.2",
     "query-string": "6.14.1",

package/src/ApiProvider.test.tsx

@@ -36,7 +36,7 @@ describe("ApiProvider tests", () => {
 
   it("should register QueryClient", () => {
     const { result } = renderHook(() => useQueryClient(), {
-      wrapper: createWrapper({ initialize: () => null }),
+      wrapper: createWrapper({ initialize: () => null })
     });
     expect(result.current).toBeDefined();
   });
@@ -48,7 +48,7 @@ describe("ApiProvider tests", () => {
     };
 
     const { result } = renderHook(() => useLegacyContext(), {
-      wrapper: createWrapper({ onIndexFetched, initialize: () => null }),
+      wrapper: createWrapper({ onIndexFetched, initialize: () => null })
     });
 
     if (result.current?.onIndexFetched) {

package/src/ApiProvider.tsx

@@ -31,9 +31,9 @@ import { reset } from "./reset";
 const queryClient = new QueryClient({
   defaultOptions: {
     queries: {
-      retry: false,
-    },
-  },
+      retry: false
+    }
+  }
 });
 
 type Props = LegacyContext & {

package/src/LegacyContext.test.tsx

@@ -40,7 +40,7 @@ describe("LegacyContext tests", () => {
 
   it("should return provided context", () => {
     const { result } = renderHook(() => useLegacyContext(), {
-      wrapper: createWrapper(),
+      wrapper: createWrapper()
     });
     expect(result.current).toBeDefined();
   });

package/src/LegacyContext.tsx

@@ -32,7 +32,7 @@ export type BaseContext = {
 };
 
 export type LegacyContext = BaseContext & {
-  initialize?: () => void;
+  initialize: () => void;
 };
 
 const Context = createContext<LegacyContext | undefined>(undefined);
@@ -61,7 +61,7 @@ const createInitialContext = (queryClient: QueryClient, base: BaseContext): Lega
           ctx.onMeFetched(me);
         }
       }
-    },
+    }
   };
 
   return ctx;

package/src/alerts.ts

@@ -51,21 +51,21 @@ const fetchAlerts = (request: AlertRequest) => {
   return fetch(url, {
     method: "POST",
     headers: {
-      "Content-Type": "application/json",
+      "Content-Type": "application/json"
     },
-    body: JSON.stringify(request.body),
+    body: JSON.stringify(request.body)
   })
-    .then((response) => {
+    .then(response => {
       if (!response.ok) {
         throw new Error("Failed to fetch alerts");
       }
       return response;
     })
-    .then((response) => response.json())
+    .then(response => response.json())
     .then((data: AlertsResponse) => {
       const storageItem: LocalStorageAlerts = {
         ...data,
-        checksum: request.checksum,
+        checksum: request.checksum
       };
       localStorage.setItem("alerts", JSON.stringify(storageItem));
       return data;
@@ -90,18 +90,18 @@ export const useAlerts = (): ApiResult<AlertsResponse> => {
       }
       return apiClient
         .get(link)
-        .then((response) => response.json())
+        .then(response => response.json())
         .then(restoreOrFetch);
     },
     {
       enabled: !!link,
-      staleTime: Infinity,
+      staleTime: Infinity
     }
   );
 
   return {
     data,
     error,
-    isLoading,
+    isLoading
   };
 };

package/src/apiclient.test.ts

@@ -45,9 +45,9 @@ describe("error handling tests", () => {
     context: [
       {
         type: "planet",
-        id: "earth",
-      },
-    ],
+        id: "earth"
+      }
+    ]
   };
 
   afterEach(() => {
@@ -55,9 +55,9 @@ describe("error handling tests", () => {
     fetchMock.restore();
   });
 
-  it("should create a normal error, if the content type is not scmm-error", (done) => {
+  it("should create a normal error, if the content type is not scmm-error", done => {
     fetchMock.getOnce("/api/v2/error", {
-      status: 404,
+      status: 404
     });
 
     apiClient.get("/error").catch((err: Error) => {
@@ -67,9 +67,9 @@ describe("error handling tests", () => {
     });
   });
 
-  it("should create a bad gateway error", (done) => {
+  it("should create a bad gateway error", done => {
     fetchMock.getOnce("/api/v2/error", {
-      status: 502,
+      status: 502
     });
 
     apiClient.get("/error").catch((err: Error) => {
@@ -78,13 +78,13 @@ describe("error handling tests", () => {
     });
   });
 
-  it("should create an backend error, if the content type is scmm-error", (done) => {
+  it("should create an backend error, if the content type is scmm-error", done => {
     fetchMock.getOnce("/api/v2/error", {
       status: 404,
       headers: {
-        "Content-Type": "application/vnd.scmm-error+json;v=2",
+        "Content-Type": "application/vnd.scmm-error+json;v=2"
       },
-      body: earthNotFoundError,
+      body: earthNotFoundError
     });
 
     apiClient.get("/error").catch((err: BackendError) => {
@@ -98,8 +98,8 @@ describe("error handling tests", () => {
       expect(err.context).toEqual([
         {
           type: "planet",
-          id: "earth",
-        },
+          id: "earth"
+        }
       ]);
       done();
     });

package/src/apiclient.ts

@@ -31,7 +31,7 @@ import {
   isBackendError,
   TOKEN_EXPIRED_ERROR_CODE,
   TokenExpiredError,
-  UnauthorizedError,
+  UnauthorizedError
 } from "./errors";
 
 type SubscriptionEvent = {
@@ -63,7 +63,12 @@ type SubscriptionArgument = MessageListeners | SubscriptionContext;
 
 type Cancel = () => void;
 
-const sessionId = (Date.now().toString(36) + Math.random().toString(36).substr(2, 5)).toUpperCase();
+const sessionId = (
+  Date.now().toString(36) +
+  Math.random()
+    .toString(36)
+    .substr(2, 5)
+).toUpperCase();
 
 const extractXsrfTokenFromJwt = (jwt: string) => {
   const parts = jwt.split(".");
@@ -98,7 +103,7 @@ const createRequestHeaders = () => {
     // identify the web interface
     "X-SCM-Client": "WUI",
     // identify the window session
-    "X-SCM-Session-ID": sessionId,
+    "X-SCM-Session-ID": sessionId
   };
 
   const xsrf = extractXsrfToken();
@@ -108,10 +113,10 @@ const createRequestHeaders = () => {
   return headers;
 };
 
-const applyFetchOptions: (p: RequestInit) => RequestInit = (o) => {
+const applyFetchOptions: (p: RequestInit) => RequestInit = o => {
   if (o.headers) {
     o.headers = {
-      ...createRequestHeaders(),
+      ...createRequestHeaders()
     };
   } else {
     o.headers = createRequestHeaders();
@@ -172,7 +177,9 @@ class ApiClient {
   requestListeners: RequestListener[] = [];
 
   get = (url: string): Promise<Response> => {
-    return this.request(url, applyFetchOptions({})).then(handleFailure).catch(this.notifyAndRethrow);
+    return this.request(url, applyFetchOptions({}))
+      .then(handleFailure)
+      .catch(this.notifyAndRethrow);
   };
 
   post = (
@@ -199,7 +206,7 @@ class ApiClient {
     const options: RequestInit = {
       method: "POST",
       body: formData,
-      headers: additionalHeaders,
+      headers: additionalHeaders
     };
     return this.httpRequestWithBinaryBody(options, url);
   };
@@ -210,18 +217,22 @@ class ApiClient {
 
   head = (url: string) => {
     let options: RequestInit = {
-      method: "HEAD",
+      method: "HEAD"
     };
     options = applyFetchOptions(options);
-    return this.request(url, options).then(handleFailure).catch(this.notifyAndRethrow);
+    return this.request(url, options)
+      .then(handleFailure)
+      .catch(this.notifyAndRethrow);
   };
 
   delete = (url: string): Promise<Response> => {
     let options: RequestInit = {
-      method: "DELETE",
+      method: "DELETE"
     };
     options = applyFetchOptions(options);
-    return this.request(url, options).then(handleFailure).catch(this.notifyAndRethrow);
+    return this.request(url, options)
+      .then(handleFailure)
+      .catch(this.notifyAndRethrow);
   };
 
   httpRequestWithJSONBody = (
@@ -233,7 +244,7 @@ class ApiClient {
   ): Promise<Response> => {
     const options: RequestInit = {
       method: method,
-      headers: additionalHeaders,
+      headers: additionalHeaders
     };
     if (payload) {
       options.body = JSON.stringify(payload);
@@ -249,7 +260,7 @@ class ApiClient {
   ) => {
     const options: RequestInit = {
       method: method,
-      headers: additionalHeaders,
+      headers: additionalHeaders
     };
     options.body = payload;
     return this.httpRequestWithBinaryBody(options, url, "text/plain");
@@ -265,12 +276,14 @@ class ApiClient {
       options.headers["Content-Type"] = contentType;
     }
 
-    return this.request(url, options).then(handleFailure).catch(this.notifyAndRethrow);
+    return this.request(url, options)
+      .then(handleFailure)
+      .catch(this.notifyAndRethrow);
   };
 
   subscribe(url: string, argument: SubscriptionArgument): Cancel {
     const es = new EventSource(createUrlWithIdentifiers(url), {
-      withCredentials: true,
+      withCredentials: true
     });
 
     let listeners: MessageListeners;
@@ -311,11 +324,11 @@ class ApiClient {
   };
 
   private notifyRequestListeners = (url: string, options: RequestInit) => {
-    this.requestListeners.forEach((requestListener) => requestListener(url, options));
+    this.requestListeners.forEach(requestListener => requestListener(url, options));
   };
 
   private notifyAndRethrow = (error: Error): never => {
-    this.errorListeners.forEach((errorListener) => errorListener(error));
+    this.errorListeners.forEach(errorListener => errorListener(error));
     throw error;
   };
 }

package/src/base.test.ts

@@ -34,7 +34,7 @@ describe("Test base api hooks", () => {
   describe("useIndex tests", () => {
     fetchMock.get("/api/v2/", {
       version: "x.y.z",
-      _links: {},
+      _links: {}
     });
 
     it("should return index", async () => {
@@ -48,10 +48,10 @@ describe("Test base api hooks", () => {
     it("should call onIndexFetched of LegacyContext", async () => {
       let index: IndexResources;
       const context: LegacyContext = {
-        onIndexFetched: (fetchedIndex) => {
+        onIndexFetched: fetchedIndex => {
           index = fetchedIndex;
         },
-        initialize: () => null,
+        initialize: () => null
       };
       const { result, waitFor } = renderHook(() => useIndex(), { wrapper: createWrapper(context) });
       await waitFor(() => {
@@ -71,10 +71,10 @@ describe("Test base api hooks", () => {
       const queryClient = new QueryClient();
       queryClient.setQueryData("index", {
         version: "x.y.z",
-        _links: {},
+        _links: {}
       });
       const { result } = renderHook(() => useIndexLink("spaceships"), {
-        wrapper: createWrapper(undefined, queryClient),
+        wrapper: createWrapper(undefined, queryClient)
       });
       expect(result.current).toBeUndefined();
     });
@@ -87,17 +87,17 @@ describe("Test base api hooks", () => {
           spaceships: [
             {
               name: "heartOfGold",
-              href: "/spaceships/heartOfGold",
+              href: "/spaceships/heartOfGold"
             },
             {
               name: "razorCrest",
-              href: "/spaceships/razorCrest",
-            },
-          ],
-        },
+              href: "/spaceships/razorCrest"
+            }
+          ]
+        }
       });
       const { result } = renderHook(() => useIndexLink("spaceships"), {
-        wrapper: createWrapper(undefined, queryClient),
+        wrapper: createWrapper(undefined, queryClient)
       });
       expect(result.current).toBeUndefined();
     });
@@ -108,12 +108,12 @@ describe("Test base api hooks", () => {
         version: "x.y.z",
         _links: {
           spaceships: {
-            href: "/api/spaceships",
-          },
-        },
+            href: "/api/spaceships"
+          }
+        }
       });
       const { result } = renderHook(() => useIndexLink("spaceships"), {
-        wrapper: createWrapper(undefined, queryClient),
+        wrapper: createWrapper(undefined, queryClient)
       });
       expect(result.current).toBe("/api/spaceships");
     });
@@ -131,12 +131,12 @@ describe("Test base api hooks", () => {
         version: "x.y.z",
         _links: {
           spaceships: {
-            href: "/api/spaceships",
-          },
-        },
+            href: "/api/spaceships"
+          }
+        }
       });
       const { result } = renderHook(() => useIndexLinks(), {
-        wrapper: createWrapper(undefined, queryClient),
+        wrapper: createWrapper(undefined, queryClient)
       });
       expect((result.current!.spaceships as Link).href).toBe("/api/spaceships");
     });
@@ -151,10 +151,10 @@ describe("Test base api hooks", () => {
     it("should return version", () => {
       const queryClient = new QueryClient();
       queryClient.setQueryData("index", {
-        version: "x.y.z",
+        version: "x.y.z"
       });
       const { result } = renderHook(() => useVersion(), {
-        wrapper: createWrapper(undefined, queryClient),
+        wrapper: createWrapper(undefined, queryClient)
       });
       expect(result.current).toBe("x.y.z");
     });
@@ -165,10 +165,10 @@ describe("Test base api hooks", () => {
       const queryClient = new QueryClient();
       queryClient.setQueryData("index", {
         version: "x.y.z",
-        _links: {},
+        _links: {}
       });
       const { result } = renderHook(() => useRequiredIndexLink("spaceships"), {
-        wrapper: createWrapper(undefined, queryClient),
+        wrapper: createWrapper(undefined, queryClient)
       });
       expect(result.error).toBeDefined();
     });
@@ -179,12 +179,12 @@ describe("Test base api hooks", () => {
         version: "x.y.z",
         _links: {
           spaceships: {
-            href: "/api/spaceships",
-          },
-        },
+            href: "/api/spaceships"
+          }
+        }
       });
       const { result } = renderHook(() => useRequiredIndexLink("spaceships"), {
-        wrapper: createWrapper(undefined, queryClient),
+        wrapper: createWrapper(undefined, queryClient)
       });
       expect(result.current).toBe("/api/spaceships");
     });
@@ -197,19 +197,19 @@ describe("Test base api hooks", () => {
         version: "x.y.z",
         _links: {
           spaceships: {
-            href: "/spaceships",
-          },
-        },
+            href: "/spaceships"
+          }
+        }
       });
 
       const spaceship = {
-        name: "heartOfGold",
+        name: "heartOfGold"
       };
 
       fetchMock.get("/api/v2/spaceships", spaceship);
 
       const { result, waitFor } = renderHook(() => useIndexJsonResource<typeof spaceship>("spaceships"), {
-        wrapper: createWrapper(undefined, queryClient),
+        wrapper: createWrapper(undefined, queryClient)
       });
 
       await waitFor(() => {
@@ -224,11 +224,11 @@ describe("Test base api hooks", () => {
     const queryClient = new QueryClient();
     queryClient.setQueryData("index", {
       version: "x.y.z",
-      _links: {},
+      _links: {}
     });
 
     const { result } = renderHook(() => useIndexJsonResource<{}>("spaceships"), {
-      wrapper: createWrapper(undefined, queryClient),
+      wrapper: createWrapper(undefined, queryClient)
     });
 
     expect(result.current.isLoading).toBe(false);

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 = {
@@ -47,9 +47,9 @@ describe("Test branches hooks", () => {
     lastCommitter: { name: "trillian" },
     _links: {
       delete: {
-        href: "/hog/branches/develop",
-      },
-    },
+        href: "/hog/branches/develop"
+      }
+    }
   };
 
   const feature: Branch = {
@@ -58,16 +58,16 @@ describe("Test branches hooks", () => {
     lastCommitter: { name: "trillian" },
     _links: {
       delete: {
-        href: "/hog/branches/feature%2Fsomething-special",
-      },
-    },
+        href: "/hog/branches/feature%2Fsomething-special"
+      }
+    }
   };
 
   const branches: BranchCollection = {
     _embedded: {
-      branches: [develop],
+      branches: [develop]
     },
-    _links: {},
+    _links: {}
   };
 
   const queryClient = createInfiniteCachingClient();
@@ -85,7 +85,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;
@@ -106,7 +106,7 @@ describe("Test branches hooks", () => {
         "repository",
         "hitchhiker",
         "heart-of-gold",
-        "branches",
+        "branches"
       ]);
       expect(data).toEqual(branches);
     });
@@ -117,7 +117,7 @@ describe("Test branches hooks", () => {
       fetchMock.getOnce("/api/v2/hog/branches/" + encodeURIComponent(name), branch);
 
       const { result, waitFor } = renderHook(() => useBranch(repository, name), {
-        wrapper: createWrapper(undefined, queryClient),
+        wrapper: createWrapper(undefined, queryClient)
       });
 
       expect(result.error).toBeUndefined();
@@ -145,14 +145,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(() => {
@@ -177,7 +177,7 @@ describe("Test branches hooks", () => {
         "hitchhiker",
         "heart-of-gold",
         "branch",
-        "develop",
+        "develop"
       ]);
       expect(branch).toEqual(develop);
     });
@@ -194,11 +194,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(() => {