@squonk/data-manager-client 6.7.1 → 6.7.2

package/src/api/user/user.fetch.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,
@@ -40,6 +43,21 @@ import type { ErrorType } from "../../custom-fetch";
 
 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;
+};
+
 export type getUsersResponse200 = { data: UsersGetResponse; status: 200 };
 
 export type getUsersResponse401 = { data: void; status: 401 };
@@ -159,7 +177,7 @@ export function useGetUsers<
     queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -249,7 +267,7 @@ export function useGetUsersSuspense<
     TError
   > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 export type getUserAccountResponse200 = { data: UserAccountDetail; status: 200 };
@@ -394,7 +412,7 @@ export function useGetUserAccount<
     queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -504,7 +522,7 @@ export function useGetUserAccountSuspense<
     TError
   > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 export type patchUserAccountResponse204 = { data: void; status: 204 };
@@ -559,128 +577,70 @@ export const patchUserAccount = async (
   });
 };
 
-export const getPatchUserAccountQueryKey = (
-  userAccountPatchBodyBody?: UserAccountPatchBodyBody,
-) => {
-  return ["data-manager", "PATCH", "user", "account", userAccountPatchBodyBody] as const;
-};
-
-export const getPatchUserAccountQueryOptions = <
-  TData = Awaited<ReturnType<typeof patchUserAccount>>,
+export const getPatchUserAccountMutationOptions = <
   TError = ErrorType<void | DmError>,
->(
-  userAccountPatchBodyBody?: UserAccountPatchBodyBody,
-  options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof patchUserAccount>>, TError, TData>>;
-    request?: SecondParameter<typeof customFetch>;
-  },
-) => {
-  const { query: queryOptions, request: requestOptions } = options ?? {};
-
-  const queryKey = queryOptions?.queryKey ?? getPatchUserAccountQueryKey(userAccountPatchBodyBody);
-
-  const queryFn: QueryFunction<Awaited<ReturnType<typeof patchUserAccount>>> = ({ signal }) =>
-    patchUserAccount(userAccountPatchBodyBody, { signal, ...requestOptions });
-
-  return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
+  TContext = unknown,
+>(options?: {
+  mutation?: UseMutationOptions<
     Awaited<ReturnType<typeof patchUserAccount>>,
     TError,
-    TData
-  > & { queryKey: DataTag<QueryKey, TData, TError> };
+    { data?: UserAccountPatchBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customFetch>;
+}): UseMutationOptions<
+  Awaited<ReturnType<typeof patchUserAccount>>,
+  TError,
+  { data?: UserAccountPatchBodyBody },
+  TContext
+> => {
+  const mutationKey = ["patchUserAccount"];
+  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 patchUserAccount>>,
+    { data?: UserAccountPatchBodyBody }
+  > = (props) => {
+    const { data } = props ?? {};
+
+    return patchUserAccount(data, requestOptions);
+  };
+
+  return { mutationFn, ...mutationOptions };
 };
 
-export type PatchUserAccountQueryResult = NonNullable<Awaited<ReturnType<typeof patchUserAccount>>>;
-export type PatchUserAccountQueryError = ErrorType<void | DmError>;
+export type PatchUserAccountMutationResult = NonNullable<
+  Awaited<ReturnType<typeof patchUserAccount>>
+>;
+export type PatchUserAccountMutationBody = UserAccountPatchBodyBody | undefined;
+export type PatchUserAccountMutationError = ErrorType<void | DmError>;
 
-export function usePatchUserAccount<
-  TData = Awaited<ReturnType<typeof patchUserAccount>>,
-  TError = ErrorType<void | DmError>,
->(
-  userAccountPatchBodyBody: undefined | UserAccountPatchBodyBody,
-  options: {
-    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof patchUserAccount>>, TError, TData>> &
-      Pick<
-        DefinedInitialDataOptions<
-          Awaited<ReturnType<typeof patchUserAccount>>,
-          TError,
-          Awaited<ReturnType<typeof patchUserAccount>>
-        >,
-        "initialData"
-      >;
-    request?: SecondParameter<typeof customFetch>;
-  },
-  queryClient?: QueryClient,
-): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
-export function usePatchUserAccount<
-  TData = Awaited<ReturnType<typeof patchUserAccount>>,
-  TError = ErrorType<void | DmError>,
->(
-  userAccountPatchBodyBody?: UserAccountPatchBodyBody,
-  options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof patchUserAccount>>, TError, TData>> &
-      Pick<
-        UndefinedInitialDataOptions<
-          Awaited<ReturnType<typeof patchUserAccount>>,
-          TError,
-          Awaited<ReturnType<typeof patchUserAccount>>
-        >,
-        "initialData"
-      >;
-    request?: SecondParameter<typeof customFetch>;
-  },
-  queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
-export function usePatchUserAccount<
-  TData = Awaited<ReturnType<typeof patchUserAccount>>,
-  TError = ErrorType<void | DmError>,
->(
-  userAccountPatchBodyBody?: UserAccountPatchBodyBody,
-  options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof patchUserAccount>>, TError, TData>>;
-    request?: SecondParameter<typeof customFetch>;
-  },
-  queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Patch your account
  */
-
-export function usePatchUserAccount<
-  TData = Awaited<ReturnType<typeof patchUserAccount>>,
-  TError = ErrorType<void | DmError>,
->(
-  userAccountPatchBodyBody?: UserAccountPatchBodyBody,
+export const usePatchUserAccount = <TError = ErrorType<void | DmError>, TContext = unknown>(
   options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof patchUserAccount>>, TError, TData>>;
+    mutation?: UseMutationOptions<
+      Awaited<ReturnType<typeof patchUserAccount>>,
+      TError,
+      { data?: UserAccountPatchBodyBody },
+      TContext
+    >;
     request?: SecondParameter<typeof customFetch>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
-  const queryOptions = getPatchUserAccountQueryOptions(userAccountPatchBodyBody, options);
-
-  const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
-    queryKey: DataTag<QueryKey, TData, TError>;
-  };
-
-  return { ...query, queryKey: queryOptions.queryKey };
-}
-
-/**
- * @summary Patch your account
- */
-export const invalidatePatchUserAccount = async (
-  queryClient: QueryClient,
-  userAccountPatchBodyBody?: UserAccountPatchBodyBody,
-  options?: InvalidateOptions,
-): Promise<QueryClient> => {
-  await queryClient.invalidateQueries(
-    { queryKey: getPatchUserAccountQueryKey(userAccountPatchBodyBody) },
-    options,
-  );
-
-  return queryClient;
+): UseMutationResult<
+  Awaited<ReturnType<typeof patchUserAccount>>,
+  TError,
+  { data?: UserAccountPatchBodyBody },
+  TContext
+> => {
+  return useMutation(getPatchUserAccountMutationOptions(options), queryClient);
 };
-
 export type getUserApiLogResponse200 = { data: UserApiLogGetResponse; status: 200 };
 
 export type getUserApiLogResponse401 = { data: void; status: 401 };
@@ -819,7 +779,7 @@ export function useGetUserApiLog<
     queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -929,7 +889,7 @@ export function useGetUserApiLogSuspense<
     TError
   > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 export type getUserApiTokenResponse200 = { data: UserApiTokenGetResponse; status: 200 };
@@ -1050,7 +1010,7 @@ export function useGetUserApiToken<
     queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -1152,5 +1112,5 @@ export function useGetUserApiTokenSuspense<
     TError
   > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }

package/src/api/user/user.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,
@@ -40,6 +43,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;
+};
+
 /**
  * Returns a summary of all users that have accessed the Data Manager API and where the account is not `private`. Users can set their accounts to be private and therefore will not show up in methods like this
  * @summary Get information about all known Users
@@ -145,7 +163,7 @@ export function useGetUsers<
     queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -235,7 +253,7 @@ export function useGetUsersSuspense<
     TError
   > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -353,7 +371,7 @@ export function useGetUserAccount<
     queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -463,7 +481,7 @@ export function useGetUserAccountSuspense<
     TError
   > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -503,128 +521,70 @@ export const patchUserAccount = (
   );
 };
 
-export const getPatchUserAccountQueryKey = (
-  userAccountPatchBodyBody?: UserAccountPatchBodyBody,
-) => {
-  return ["data-manager", "PATCH", "user", "account", userAccountPatchBodyBody] as const;
-};
-
-export const getPatchUserAccountQueryOptions = <
-  TData = Awaited<ReturnType<typeof patchUserAccount>>,
+export const getPatchUserAccountMutationOptions = <
   TError = ErrorType<void | DmError>,
->(
-  userAccountPatchBodyBody?: UserAccountPatchBodyBody,
-  options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof patchUserAccount>>, TError, TData>>;
-    request?: SecondParameter<typeof customInstance>;
-  },
-) => {
-  const { query: queryOptions, request: requestOptions } = options ?? {};
-
-  const queryKey = queryOptions?.queryKey ?? getPatchUserAccountQueryKey(userAccountPatchBodyBody);
-
-  const queryFn: QueryFunction<Awaited<ReturnType<typeof patchUserAccount>>> = ({ signal }) =>
-    patchUserAccount(userAccountPatchBodyBody, requestOptions, signal);
-
-  return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
+  TContext = unknown,
+>(options?: {
+  mutation?: UseMutationOptions<
     Awaited<ReturnType<typeof patchUserAccount>>,
     TError,
-    TData
-  > & { queryKey: DataTag<QueryKey, TData, TError> };
+    { data?: UserAccountPatchBodyBody },
+    TContext
+  >;
+  request?: SecondParameter<typeof customInstance>;
+}): UseMutationOptions<
+  Awaited<ReturnType<typeof patchUserAccount>>,
+  TError,
+  { data?: UserAccountPatchBodyBody },
+  TContext
+> => {
+  const mutationKey = ["patchUserAccount"];
+  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 patchUserAccount>>,
+    { data?: UserAccountPatchBodyBody }
+  > = (props) => {
+    const { data } = props ?? {};
+
+    return patchUserAccount(data, requestOptions);
+  };
+
+  return { mutationFn, ...mutationOptions };
 };
 
-export type PatchUserAccountQueryResult = NonNullable<Awaited<ReturnType<typeof patchUserAccount>>>;
-export type PatchUserAccountQueryError = ErrorType<void | DmError>;
+export type PatchUserAccountMutationResult = NonNullable<
+  Awaited<ReturnType<typeof patchUserAccount>>
+>;
+export type PatchUserAccountMutationBody = UserAccountPatchBodyBody | undefined;
+export type PatchUserAccountMutationError = ErrorType<void | DmError>;
 
-export function usePatchUserAccount<
-  TData = Awaited<ReturnType<typeof patchUserAccount>>,
-  TError = ErrorType<void | DmError>,
->(
-  userAccountPatchBodyBody: undefined | UserAccountPatchBodyBody,
-  options: {
-    query: Partial<UseQueryOptions<Awaited<ReturnType<typeof patchUserAccount>>, TError, TData>> &
-      Pick<
-        DefinedInitialDataOptions<
-          Awaited<ReturnType<typeof patchUserAccount>>,
-          TError,
-          Awaited<ReturnType<typeof patchUserAccount>>
-        >,
-        "initialData"
-      >;
-    request?: SecondParameter<typeof customInstance>;
-  },
-  queryClient?: QueryClient,
-): DefinedUseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
-export function usePatchUserAccount<
-  TData = Awaited<ReturnType<typeof patchUserAccount>>,
-  TError = ErrorType<void | DmError>,
->(
-  userAccountPatchBodyBody?: UserAccountPatchBodyBody,
-  options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof patchUserAccount>>, TError, TData>> &
-      Pick<
-        UndefinedInitialDataOptions<
-          Awaited<ReturnType<typeof patchUserAccount>>,
-          TError,
-          Awaited<ReturnType<typeof patchUserAccount>>
-        >,
-        "initialData"
-      >;
-    request?: SecondParameter<typeof customInstance>;
-  },
-  queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
-export function usePatchUserAccount<
-  TData = Awaited<ReturnType<typeof patchUserAccount>>,
-  TError = ErrorType<void | DmError>,
->(
-  userAccountPatchBodyBody?: UserAccountPatchBodyBody,
-  options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof patchUserAccount>>, TError, TData>>;
-    request?: SecondParameter<typeof customInstance>;
-  },
-  queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> };
 /**
  * @summary Patch your account
  */
-
-export function usePatchUserAccount<
-  TData = Awaited<ReturnType<typeof patchUserAccount>>,
-  TError = ErrorType<void | DmError>,
->(
-  userAccountPatchBodyBody?: UserAccountPatchBodyBody,
+export const usePatchUserAccount = <TError = ErrorType<void | DmError>, TContext = unknown>(
   options?: {
-    query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof patchUserAccount>>, TError, TData>>;
+    mutation?: UseMutationOptions<
+      Awaited<ReturnType<typeof patchUserAccount>>,
+      TError,
+      { data?: UserAccountPatchBodyBody },
+      TContext
+    >;
     request?: SecondParameter<typeof customInstance>;
   },
   queryClient?: QueryClient,
-): UseQueryResult<TData, TError> & { queryKey: DataTag<QueryKey, TData, TError> } {
-  const queryOptions = getPatchUserAccountQueryOptions(userAccountPatchBodyBody, options);
-
-  const query = useQuery(queryOptions, queryClient) as UseQueryResult<TData, TError> & {
-    queryKey: DataTag<QueryKey, TData, TError>;
-  };
-
-  return { ...query, queryKey: queryOptions.queryKey };
-}
-
-/**
- * @summary Patch your account
- */
-export const invalidatePatchUserAccount = async (
-  queryClient: QueryClient,
-  userAccountPatchBodyBody?: UserAccountPatchBodyBody,
-  options?: InvalidateOptions,
-): Promise<QueryClient> => {
-  await queryClient.invalidateQueries(
-    { queryKey: getPatchUserAccountQueryKey(userAccountPatchBodyBody) },
-    options,
-  );
-
-  return queryClient;
+): UseMutationResult<
+  Awaited<ReturnType<typeof patchUserAccount>>,
+  TError,
+  { data?: UserAccountPatchBodyBody },
+  TContext
+> => {
+  return useMutation(getPatchUserAccountMutationOptions(options), queryClient);
 };
-
 /**
  * Returns a summary of your API activity optionally filtered by date. The API log does not include the use of GET methods, and only contains records of potential state-changing calls made against the Data Manager using your account
  * @summary Get the API call log recorded against your account
@@ -741,7 +701,7 @@ export function useGetUserApiLog<
     queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -851,7 +811,7 @@ export function useGetUserApiLogSuspense<
     TError
   > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -962,7 +922,7 @@ export function useGetUserApiToken<
     queryKey: DataTag<QueryKey, TData, TError>;
   };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }
 
 /**
@@ -1064,5 +1024,5 @@ export function useGetUserApiTokenSuspense<
     TError
   > & { queryKey: DataTag<QueryKey, TData, TError> };
 
-  return { ...query, queryKey: queryOptions.queryKey };
+  return withQueryKey(query, queryOptions.queryKey);
 }