@squonk/data-manager-client 6.7.1 → 6.7.2

package/src/api/metadata/metadata.ts

@@ -1,5 +1,5 @@
 /**
- * Generated by orval v8.16.0 🍺
+ * Generated by orval v8.22.0 🍺
  * Do not edit manually.
  * Dataset Manager API
  * The Dataset Manager API service.
@@ -8,16 +8,19 @@
  *
  * OpenAPI spec version: 6.7
  */
-import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
+import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
   DataTag,
   DefinedInitialDataOptions,
   DefinedUseQueryResult,
   InvalidateOptions,
+  MutationFunction,
   QueryClient,
   QueryFunction,
   QueryKey,
   UndefinedInitialDataOptions,
+  UseMutationOptions,
+  UseMutationResult,
   UseQueryOptions,
   UseQueryResult,
   UseSuspenseQueryOptions,
@@ -36,6 +39,21 @@ import type { ErrorType } from "../../custom-axios";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
+const withQueryKey = <T extends object, K>(query: T, queryKey: K): T & { queryKey: K } => {
+  const result = { queryKey } as T & { queryKey: K };
+  for (const key of Object.keys(query)) {
+    // The explicit queryKey always wins, matching the previous
+    // `{ ...query, queryKey }` spread where it was set last.
+    if (key === "queryKey") continue;
+    Object.defineProperty(result, key, {
+      enumerable: true,
+      configurable: true,
+      get: () => (query as Record<string, unknown>)[key],
+    });
+  }
+  return result;
+};
+
 /**
  * Update parameters or add new annotations of the specified type(s) and to the Metadata for a **Dataset Version**.
  *
@@ -71,180 +89,70 @@ export const addMetadataVersion = (
   );
 };
 
-export const getAddMetadataVersionQueryKey = (
-  datasetId: string,
-  datasetVersion: number,
-  datasetVersionMetaPostBodyBody?: DatasetVersionMetaPostBodyBody,
-) => {
-  return [
-    "data-manager",
-    "POST",
-    "dataset",
-    datasetId,
-    "meta",
-    datasetVersion,
-    datasetVersionMetaPostBodyBody,
-  ] as const;
-};
-
-export const getAddMetadataVersionQueryOptions = <
-  TData = Awaited<ReturnType<typeof addMetadataVersion>>,
+export const getAddMetadataVersionMutationOptions = <
   TError = ErrorType<DmError | void>,
->(
-  datasetId: string,
-  datasetVersion: number,
-  datasetVersionMetaPostBodyBody: DatasetVersionMetaPostBodyBody,
-  options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof addMetadataVersion>>, TError, TData>>;
-    request?: SecondParameter<typeof customInstance>;
-  },
-) => {
-  const { query: queryOptions, request: requestOptions } = options ?? {};
-
-  const queryKey =
-    queryOptions?.queryKey ??
-    getAddMetadataVersionQueryKey(datasetId, datasetVersion, datasetVersionMetaPostBodyBody);
-
-  const queryFn: QueryFunction<Awaited<ReturnType<typeof addMetadataVersion>>> = ({ signal }) =>
-    addMetadataVersion(
-      datasetId,
-      datasetVersion,
-      datasetVersionMetaPostBodyBody,
-      requestOptions,
-      signal,
-    );
-
-  return {
-    queryKey,
-    queryFn,
-    enabled:
-      datasetId !== null &&
-      datasetId !== undefined &&
-      datasetVersion !== null &&
-      datasetVersion !== undefined,
-    ...queryOptions,
-  } as UseQueryOptions<Awaited<ReturnType<typeof addMetadataVersion>>, TError, TData> & {
-    queryKey: DataTag<QueryKey, TData, TError>;
+  TContext = unknown,
+>(options?: {
+  mutation?: UseMutationOptions<
+    Awaited<ReturnType<typeof addMetadataVersion>>,
+    TError,
+    { datasetId: string; datasetVersion: number; data: DatasetVersionMetaPostBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}): UseMutationOptions<
+  Awaited<ReturnType<typeof addMetadataVersion>>,
+  TError,
+  { datasetId: string; datasetVersion: number; data: DatasetVersionMetaPostBodyBody },
+  TContext
+> => {
+  const mutationKey = ["addMetadataVersion"];
+  const { mutation: mutationOptions, request: requestOptions } = options
+    ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
+      ? options
+      : { ...options, mutation: { ...options.mutation, mutationKey } }
+    : { mutation: { mutationKey }, request: undefined };
+
+  const mutationFn: MutationFunction<
+    Awaited<ReturnType<typeof addMetadataVersion>>,
+    { datasetId: string; datasetVersion: number; data: DatasetVersionMetaPostBodyBody }
+  > = (props) => {
+    const { datasetId, datasetVersion, data } = props ?? {};
+
+    return addMetadataVersion(datasetId, datasetVersion, data, requestOptions);
   };
+
+  return { mutationFn, ...mutationOptions };
 };
 
-export type AddMetadataVersionQueryResult = NonNullable<
+export type AddMetadataVersionMutationResult = NonNullable<
   Awaited<ReturnType<typeof addMetadataVersion>>
 >;
-export type AddMetadataVersionQueryError = ErrorType<DmError | void>;
+export type AddMetadataVersionMutationBody = DatasetVersionMetaPostBodyBody;
+export type AddMetadataVersionMutationError = ErrorType<DmError | void>;
 
-export function useAddMetadataVersion<
-  TData = Awaited<ReturnType<typeof addMetadataVersion>>,
-  TError = ErrorType<DmError | void>,
->(
-  datasetId: string,
-  datasetVersion: number,
-  datasetVersionMetaPostBodyBody: DatasetVersionMetaPostBodyBody,
-  options: {
-    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof addMetadataVersion>>, TError, TData>> &
-      Pick<
-        DefinedInitialDataOptions<
-          Awaited<ReturnType<typeof addMetadataVersion>>,
-          TError,
-          Awaited<ReturnType<typeof addMetadataVersion>>
-        >,
-        "initialData"
-      >;
-    request?: SecondParameter<typeof customInstance>;
-  },
-  queryClient?: QueryClient,
-): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
-export function useAddMetadataVersion<
-  TData = Awaited<ReturnType<typeof addMetadataVersion>>,
-  TError = ErrorType<DmError | void>,
->(
-  datasetId: string,
-  datasetVersion: number,
-  datasetVersionMetaPostBodyBody: DatasetVersionMetaPostBodyBody,
-  options?: {
-    query?: Partial<
-      UseQueryOptions<Awaited<ReturnType<typeof addMetadataVersion>>, TError, TData>
-    > &
-      Pick<
-        UndefinedInitialDataOptions<
-          Awaited<ReturnType<typeof addMetadataVersion>>,
-          TError,
-          Awaited<ReturnType<typeof addMetadataVersion>>
-        >,
-        "initialData"
-      >;
-    request?: SecondParameter<typeof customInstance>;
-  },
-  queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
-export function useAddMetadataVersion<
-  TData = Awaited<ReturnType<typeof addMetadataVersion>>,
-  TError = ErrorType<DmError | void>,
->(
-  datasetId: string,
-  datasetVersion: number,
-  datasetVersionMetaPostBodyBody: DatasetVersionMetaPostBodyBody,
-  options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof addMetadataVersion>>, TError, TData>>;
-    request?: SecondParameter<typeof customInstance>;
-  },
-  queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Update Metadata for the Dataset version
  */
-
-export function useAddMetadataVersion<
-  TData = Awaited<ReturnType<typeof addMetadataVersion>>,
-  TError = ErrorType<DmError | void>,
->(
-  datasetId: string,
-  datasetVersion: number,
-  datasetVersionMetaPostBodyBody: DatasetVersionMetaPostBodyBody,
+export const useAddMetadataVersion = <TError = ErrorType<DmError | void>, TContext = unknown>(
   options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof addMetadataVersion>>, TError, TData>>;
+    mutation?: UseMutationOptions<
+      Awaited<ReturnType<typeof addMetadataVersion>>,
+      TError,
+      { datasetId: string; datasetVersion: number; data: DatasetVersionMetaPostBodyBody },
+      TContext
+    >;
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
-  const queryOptions = getAddMetadataVersionQueryOptions(
-    datasetId,
-    datasetVersion,
-    datasetVersionMetaPostBodyBody,
-    options,
-  );
-
-  const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
-    queryKey: DataTag<QueryKey, TData, TError>;
-  };
-
-  return { ...query, queryKey: queryOptions.queryKey };
-}
-
-/**
- * @summary Update Metadata for the Dataset version
- */
-export const invalidateAddMetadataVersion = async (
-  queryClient: QueryClient,
-  datasetId: string,
-  datasetVersion: number,
-  datasetVersionMetaPostBodyBody: DatasetVersionMetaPostBodyBody,
-  options?: InvalidateOptions,
-): Promise<QueryClient> => {
-  await queryClient.invalidateQueries(
-    {
-      queryKey: getAddMetadataVersionQueryKey(
-        datasetId,
-        datasetVersion,
-        datasetVersionMetaPostBodyBody,
-      ),
-    },
-    options,
-  );
-
-  return queryClient;
+): UseMutationResult<
+  Awaited<ReturnType<typeof addMetadataVersion>>,
+  TError,
+  { datasetId: string; datasetVersion: number; data: DatasetVersionMetaPostBodyBody },
+  TContext
+> => {
+  return useMutation(getAddMetadataVersionMutationOptions(options), queryClient);
 };
-
 /**
  * Returns the Metadata for a **Dataset Version** in JSON format.
  * @summary Gets the Metadata for a specific Dataset Version
@@ -379,7 +287,7 @@ export function useGetMetadataVersion<
     queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -503,7 +411,7 @@ export function useGetMetadataVersionSuspense<
     TError
   > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -540,139 +448,68 @@ export const addMetadata = (
   );
 };
 
-export const getAddMetadataQueryKey = (
-  datasetId: string,
-  datasetMetaPostBodyBody?: DatasetMetaPostBodyBody,
-) => {
-  return ["data-manager", "POST", "dataset", datasetId, "meta", datasetMetaPostBodyBody] as const;
-};
-
-export const getAddMetadataQueryOptions = <
-  TData = Awaited<ReturnType<typeof addMetadata>>,
+export const getAddMetadataMutationOptions = <
   TError = ErrorType<DmError | void>,
->(
-  datasetId: string,
-  datasetMetaPostBodyBody: DatasetMetaPostBodyBody,
-  options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof addMetadata>>, TError, TData>>;
-    request?: SecondParameter<typeof customInstance>;
-  },
-) => {
-  const { query: queryOptions, request: requestOptions } = options ?? {};
-
-  const queryKey =
-    queryOptions?.queryKey ?? getAddMetadataQueryKey(datasetId, datasetMetaPostBodyBody);
-
-  const queryFn: QueryFunction<Awaited<ReturnType<typeof addMetadata>>> = ({ signal }) =>
-    addMetadata(datasetId, datasetMetaPostBodyBody, requestOptions, signal);
-
-  return {
-    queryKey,
-    queryFn,
-    enabled: datasetId !== null && datasetId !== undefined,
-    ...queryOptions,
-  } as UseQueryOptions<Awaited<ReturnType<typeof addMetadata>>, TError, TData> & {
-    queryKey: DataTag<QueryKey, TData, TError>;
+  TContext = unknown,
+>(options?: {
+  mutation?: UseMutationOptions<
+    Awaited<ReturnType<typeof addMetadata>>,
+    TError,
+    { datasetId: string; data: DatasetMetaPostBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}): UseMutationOptions<
+  Awaited<ReturnType<typeof addMetadata>>,
+  TError,
+  { datasetId: string; data: DatasetMetaPostBodyBody },
+  TContext
+> => {
+  const mutationKey = ["addMetadata"];
+  const { mutation: mutationOptions, request: requestOptions } = options
+    ? options.mutation && "mutationKey" in options.mutation && options.mutation.mutationKey
+      ? options
+      : { ...options, mutation: { ...options.mutation, mutationKey } }
+    : { mutation: { mutationKey }, request: undefined };
+
+  const mutationFn: MutationFunction<
+    Awaited<ReturnType<typeof addMetadata>>,
+    { datasetId: string; data: DatasetMetaPostBodyBody }
+  > = (props) => {
+    const { datasetId, data } = props ?? {};
+
+    return addMetadata(datasetId, data, requestOptions);
   };
+
+  return { mutationFn, ...mutationOptions };
 };
 
-export type AddMetadataQueryResult = NonNullable<Awaited<ReturnType<typeof addMetadata>>>;
-export type AddMetadataQueryError = ErrorType<DmError | void>;
+export type AddMetadataMutationResult = NonNullable<Awaited<ReturnType<typeof addMetadata>>>;
+export type AddMetadataMutationBody = DatasetMetaPostBodyBody;
+export type AddMetadataMutationError = ErrorType<DmError | void>;
 
-export function useAddMetadata<
-  TData = Awaited<ReturnType<typeof addMetadata>>,
-  TError = ErrorType<DmError | void>,
->(
-  datasetId: string,
-  datasetMetaPostBodyBody: DatasetMetaPostBodyBody,
-  options: {
-    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof addMetadata>>, TError, TData>> &
-      Pick<
-        DefinedInitialDataOptions<
-          Awaited<ReturnType<typeof addMetadata>>,
-          TError,
-          Awaited<ReturnType<typeof addMetadata>>
-        >,
-        "initialData"
-      >;
-    request?: SecondParameter<typeof customInstance>;
-  },
-  queryClient?: QueryClient,
-): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
-export function useAddMetadata<
-  TData = Awaited<ReturnType<typeof addMetadata>>,
-  TError = ErrorType<DmError | void>,
->(
-  datasetId: string,
-  datasetMetaPostBodyBody: DatasetMetaPostBodyBody,
-  options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof addMetadata>>, TError, TData>> &
-      Pick<
-        UndefinedInitialDataOptions<
-          Awaited<ReturnType<typeof addMetadata>>,
-          TError,
-          Awaited<ReturnType<typeof addMetadata>>
-        >,
-        "initialData"
-      >;
-    request?: SecondParameter<typeof customInstance>;
-  },
-  queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
-export function useAddMetadata<
-  TData = Awaited<ReturnType<typeof addMetadata>>,
-  TError = ErrorType<DmError | void>,
->(
-  datasetId: string,
-  datasetMetaPostBodyBody: DatasetMetaPostBodyBody,
-  options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof addMetadata>>, TError, TData>>;
-    request?: SecondParameter<typeof customInstance>;
-  },
-  queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Update Metadata for the Dataset
  */
-
-export function useAddMetadata<
-  TData = Awaited<ReturnType<typeof addMetadata>>,
-  TError = ErrorType<DmError | void>,
->(
-  datasetId: string,
-  datasetMetaPostBodyBody: DatasetMetaPostBodyBody,
+export const useAddMetadata = <TError = ErrorType<DmError | void>, TContext = unknown>(
   options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof addMetadata>>, TError, TData>>;
+    mutation?: UseMutationOptions<
+      Awaited<ReturnType<typeof addMetadata>>,
+      TError,
+      { datasetId: string; data: DatasetMetaPostBodyBody },
+      TContext
+    >;
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
-  const queryOptions = getAddMetadataQueryOptions(datasetId, datasetMetaPostBodyBody, options);
-
-  const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
-    queryKey: DataTag<QueryKey, TData, TError>;
-  };
-
-  return { ...query, queryKey: queryOptions.queryKey };
-}
-
-/**
- * @summary Update Metadata for the Dataset
- */
-export const invalidateAddMetadata = async (
-  queryClient: QueryClient,
-  datasetId: string,
-  datasetMetaPostBodyBody: DatasetMetaPostBodyBody,
-  options?: InvalidateOptions,
-): Promise<QueryClient> => {
-  await queryClient.invalidateQueries(
-    { queryKey: getAddMetadataQueryKey(datasetId, datasetMetaPostBodyBody) },
-    options,
-  );
-
-  return queryClient;
+): UseMutationResult<
+  Awaited<ReturnType<typeof addMetadata>>,
+  TError,
+  { datasetId: string; data: DatasetMetaPostBodyBody },
+  TContext
+> => {
+  return useMutation(getAddMetadataMutationOptions(options), queryClient);
 };
-
 /**
  * Returns the Metadata for a Dataset in JSON format.
  * @summary Gets the Metadata for a specific Dataset
@@ -792,7 +629,7 @@ export function useGetMetadata<
     queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -898,5 +735,5 @@ export function useGetMetadataSuspense<
     TError
   > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }