@squonk/data-manager-client 0.7.0 → 0.7.1

package/src/annotation/annotation.ts

@@ -1,217 +0,0 @@
-/**
- * Generated by orval v6.6.0 🍺
- * Do not edit manually.
- * Dataset Manager API
- * The Dataset Manager API service.
-
-A service that allows *registered* users to make **Datasets** and associated **Metadata** available to **Applications** and **Jobs** using **Projects** and **Files**.
-
- * OpenAPI spec version: 0.7
- */
-import {
-  useQuery,
-  useMutation,
-  UseQueryOptions,
-  UseMutationOptions,
-  QueryFunction,
-  MutationFunction,
-  UseQueryResult,
-  QueryKey,
-} from "react-query";
-import type {
-  DatasetAnnotationsPostResponse,
-  DmError,
-  DatasetAnnotationsPostBodyBody,
-  DatasetMetaGetResponse,
-} from "../data-manager-api.schemas";
-import { customInstance, ErrorType } from ".././custom-instance";
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (
-  ...args: any
-) => Promise<infer R>
-  ? R
-  : any;
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-type SecondParameter<T extends (...args: any) => any> = T extends (
-  config: any,
-  args: infer P
-) => any
-  ? P
-  : never;
-
-/**
- * Creates new annotations of the specified type(s) and add to the metadata for the dataset.
-The annotations are provided in a list in JSON format. For details of the annotations that can be created, see the data-manager-metadata library,
-
- * @summary Add new annotations to the Metadata for the Dataset
- */
-export const addAnnotations = (
-  datasetid: string,
-  datasetversion: number,
-  datasetAnnotationsPostBodyBody: DatasetAnnotationsPostBodyBody,
-  options?: SecondParameter<typeof customInstance>
-) => {
-  const formData = new FormData();
-  formData.append("annotations", datasetAnnotationsPostBodyBody.annotations);
-
-  return customInstance<DatasetAnnotationsPostResponse>(
-    {
-      url: `/dataset/${datasetid}/annotations/${datasetversion}`,
-      method: "post",
-      data: formData,
-    },
-    options
-  );
-};
-
-export const useAddAnnotations = <
-  TError = ErrorType<DmError | void>,
-  TContext = unknown
->(options?: {
-  mutation?: UseMutationOptions<
-    AsyncReturnType<typeof addAnnotations>,
-    TError,
-    {
-      datasetid: string;
-      datasetversion: number;
-      data: DatasetAnnotationsPostBodyBody;
-    },
-    TContext
-  >;
-  request?: SecondParameter<typeof customInstance>;
-}) => {
-  const { mutation: mutationOptions, request: requestOptions } = options || {};
-
-  const mutationFn: MutationFunction<
-    AsyncReturnType<typeof addAnnotations>,
-    {
-      datasetid: string;
-      datasetversion: number;
-      data: DatasetAnnotationsPostBodyBody;
-    }
-  > = (props) => {
-    const { datasetid, datasetversion, data } = props || {};
-
-    return addAnnotations(datasetid, datasetversion, data, requestOptions);
-  };
-
-  return useMutation<
-    AsyncReturnType<typeof addAnnotations>,
-    TError,
-    {
-      datasetid: string;
-      datasetversion: number;
-      data: DatasetAnnotationsPostBodyBody;
-    },
-    TContext
-  >(mutationFn, mutationOptions);
-};
-/**
- * Returns the metadata for a Dataset versions in JSON format.
-
- * @summary Gets the metadata for a specific Dataset
- */
-export const getMetadata = (
-  datasetid: string,
-  datasetversion: number,
-  options?: SecondParameter<typeof customInstance>
-) => {
-  return customInstance<DatasetMetaGetResponse>(
-    { url: `/dataset/${datasetid}/meta/${datasetversion}`, method: "get" },
-    options
-  );
-};
-
-export const getGetMetadataQueryKey = (
-  datasetid: string,
-  datasetversion: number
-) => [`/dataset/${datasetid}/meta/${datasetversion}`];
-
-export const useGetMetadata = <
-  TData = AsyncReturnType<typeof getMetadata>,
-  TError = ErrorType<void | DmError>
->(
-  datasetid: string,
-  datasetversion: number,
-  options?: {
-    query?: UseQueryOptions<AsyncReturnType<typeof getMetadata>, TError, TData>;
-    request?: SecondParameter<typeof customInstance>;
-  }
-): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
-  const { query: queryOptions, request: requestOptions } = options || {};
-
-  const queryKey =
-    queryOptions?.queryKey ?? getGetMetadataQueryKey(datasetid, datasetversion);
-
-  const queryFn: QueryFunction<AsyncReturnType<typeof getMetadata>> = () =>
-    getMetadata(datasetid, datasetversion, requestOptions);
-
-  const query = useQuery<AsyncReturnType<typeof getMetadata>, TError, TData>(
-    queryKey,
-    queryFn,
-    { enabled: !!(datasetid && datasetversion), ...queryOptions }
-  );
-
-  return {
-    queryKey,
-    ...query,
-  };
-};
-
-/**
- * Updates the metadata for a Dataset based on the given parameter array.
-
- * @summary Update the metadata for a specific Dataset
- */
-export const updateMetadata = (
-  datasetid: string,
-  datasetversion: number,
-  metaparameters: string,
-  options?: SecondParameter<typeof customInstance>
-) => {
-  return customInstance<void>(
-    {
-      url: `/dataset/${datasetid}/meta/${datasetversion}/${metaparameters}`,
-      method: "patch",
-    },
-    options
-  );
-};
-
-export const useUpdateMetadata = <
-  TError = ErrorType<DmError>,
-  TContext = unknown
->(options?: {
-  mutation?: UseMutationOptions<
-    AsyncReturnType<typeof updateMetadata>,
-    TError,
-    { datasetid: string; datasetversion: number; metaparameters: string },
-    TContext
-  >;
-  request?: SecondParameter<typeof customInstance>;
-}) => {
-  const { mutation: mutationOptions, request: requestOptions } = options || {};
-
-  const mutationFn: MutationFunction<
-    AsyncReturnType<typeof updateMetadata>,
-    { datasetid: string; datasetversion: number; metaparameters: string }
-  > = (props) => {
-    const { datasetid, datasetversion, metaparameters } = props || {};
-
-    return updateMetadata(
-      datasetid,
-      datasetversion,
-      metaparameters,
-      requestOptions
-    );
-  };
-
-  return useMutation<
-    AsyncReturnType<typeof updateMetadata>,
-    TError,
-    { datasetid: string; datasetversion: number; metaparameters: string },
-    TContext
-  >(mutationFn, mutationOptions);
-};