mirror of
https://github.com/scm-manager/scm-manager.git
synced 2026-01-22 23:42:11 +01:00
113 lines
3.6 KiB
TypeScript
113 lines
3.6 KiB
TypeScript
/*
|
|
* Copyright (c) 2020 - present Cloudogu GmbH
|
|
*
|
|
* This program is free software: you can redistribute it and/or modify it under
|
|
* the terms of the GNU Affero General Public License as published by the Free
|
|
* Software Foundation, version 3.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but WITHOUT
|
|
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
|
* FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
|
|
* details.
|
|
*
|
|
* You should have received a copy of the GNU Affero General Public License
|
|
* along with this program. If not, see https://www.gnu.org/licenses/.
|
|
*/
|
|
|
|
import { HalRepresentation, 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 ApiResultWithFetching<T> = ApiResult<T> & {
|
|
isFetching: boolean;
|
|
};
|
|
|
|
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) => {
|
|
// ensure legacy code is notified
|
|
if (legacy.onIndexFetched) {
|
|
legacy.onIndexFetched(index);
|
|
}
|
|
},
|
|
refetchOnMount: false,
|
|
retry: (failureCount, error) => {
|
|
// The index resource returns a 401 if the access token expired.
|
|
// 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;
|
|
},
|
|
});
|
|
};
|
|
|
|
export const useIndexLink = (name: string): string | undefined => {
|
|
const { data } = useIndex();
|
|
if (!data) {
|
|
throw new Error("could not find index data");
|
|
}
|
|
const linkObject = data._links[name] as Link;
|
|
if (linkObject && linkObject.href) {
|
|
return linkObject.href;
|
|
}
|
|
};
|
|
|
|
export const useIndexLinks = () => {
|
|
const { data } = useIndex();
|
|
if (!data) {
|
|
throw new Error("could not find index data");
|
|
}
|
|
return data._links;
|
|
};
|
|
|
|
export const useRequiredIndexLink = (name: string): string => {
|
|
const link = useIndexLink(name);
|
|
if (!link) {
|
|
throw new MissingLinkError(`Could not find link ${name} in index resource`);
|
|
}
|
|
return link;
|
|
};
|
|
|
|
export const useVersion = (): string => {
|
|
const { data } = useIndex();
|
|
if (!data) {
|
|
throw new Error("could not find index data");
|
|
}
|
|
const { version } = data;
|
|
if (!version) {
|
|
throw new Error("could not find version in index data");
|
|
}
|
|
return version;
|
|
};
|
|
|
|
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,
|
|
});
|
|
};
|
|
|
|
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();
|