@squonk/account-server-client 4.4.0-4-4.2195235454 → 4.4.0-4-4.2197069952

package/src/api/unit/unit.ts

@@ -10,7 +10,9 @@ A service that provides access to the Account Server, which gives *registered* u
  */
 import { useMutation, useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
+  InvalidateOptions,
   MutationFunction,
+  QueryClient,
   QueryFunction,
   QueryKey,
   UseMutationOptions,
@@ -32,12 +34,10 @@ import type {
   UnitAllDetail,
   UnitPatchBodyBody,
   UnitsGetResponse,
-} from "../api.schemas";
+} from ".././api-schemas";
 
-import { customInstance } from "../../custom-instance";
-import type { ErrorType } from "../../custom-instance";
-import { queryMutator } from "../../options-mutator";
-import { mutationMutator } from "../../options-mutator";
+import { customInstance } from "../../custom-axios";
+import type { ErrorType } from "../../custom-axios";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
@@ -58,10 +58,10 @@ export const getOrganisationUnits = (
 };
 
 export const getGetOrganisationUnitsQueryKey = (orgId?: string) => {
-  return [`/organisation/${orgId}/unit`] as const;
+  return ["account-server", "organisation", orgId, "unit"] as const;
 };
 
-export const useGetOrganisationUnitsQueryOptions = <
+export const getGetOrganisationUnitsQueryOptions = <
   TData = Awaited<ReturnType<typeof getOrganisationUnits>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -78,9 +78,7 @@ export const useGetOrganisationUnitsQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getOrganisationUnits>>> = ({ signal }) =>
     getOrganisationUnits(orgId, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseQueryOptions<
+  return { queryKey, queryFn, enabled: !!orgId, ...queryOptions } as UseQueryOptions<
     Awaited<ReturnType<typeof getOrganisationUnits>>,
     TError,
     TData
@@ -106,7 +104,7 @@ export function useGetOrganisationUnits<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetOrganisationUnitsQueryOptions(orgId, options);
+  const queryOptions = getGetOrganisationUnitsQueryOptions(orgId, options);
 
   const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
@@ -115,7 +113,23 @@ export function useGetOrganisationUnits<
   return query;
 }
 
-export const useGetOrganisationUnitsSuspenseQueryOptions = <
+/**
+ * @summary Gets Organisational Units
+ */
+export const invalidateGetOrganisationUnits = async (
+  queryClient: QueryClient,
+  orgId: string,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries(
+    { queryKey: getGetOrganisationUnitsQueryKey(orgId) },
+    options,
+  );
+
+  return queryClient;
+};
+
+export const getGetOrganisationUnitsSuspenseQueryOptions = <
   TData = Awaited<ReturnType<typeof getOrganisationUnits>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -136,9 +150,7 @@ export const useGetOrganisationUnitsSuspenseQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getOrganisationUnits>>> = ({ signal }) =>
     getOrganisationUnits(orgId, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseSuspenseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
     Awaited<ReturnType<typeof getOrganisationUnits>>,
     TError,
     TData
@@ -168,7 +180,7 @@ export function useGetOrganisationUnitsSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetOrganisationUnitsSuspenseQueryOptions(orgId, options);
+  const queryOptions = getGetOrganisationUnitsSuspenseQueryOptions(orgId, options);
 
   const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
@@ -206,7 +218,7 @@ export const createOrganisationUnit = (
   );
 };
 
-export const useCreateOrganisationUnitMutationOptions = <
+export const getCreateOrganisationUnitMutationOptions = <
   TError = ErrorType<AsError | void>,
   TContext = unknown,
 >(options?: {
@@ -239,9 +251,7 @@ export const useCreateOrganisationUnitMutationOptions = <
     return createOrganisationUnit(orgId, data, requestOptions);
   };
 
-  const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
-
-  return customOptions;
+  return { mutationFn, ...mutationOptions };
 };
 
 export type CreateOrganisationUnitMutationResult = NonNullable<
@@ -270,7 +280,7 @@ export const useCreateOrganisationUnit = <
   { orgId: string; data: OrganisationUnitPostBodyBody },
   TContext
 > => {
-  const mutationOptions = useCreateOrganisationUnitMutationOptions(options);
+  const mutationOptions = getCreateOrganisationUnitMutationOptions(options);
 
   return useMutation(mutationOptions);
 };
@@ -288,10 +298,10 @@ export const getUnit = (
 };
 
 export const getGetUnitQueryKey = (unitId?: string) => {
-  return [`/unit/${unitId}`] as const;
+  return ["account-server", "unit", unitId] as const;
 };
 
-export const useGetUnitQueryOptions = <
+export const getGetUnitQueryOptions = <
   TData = Awaited<ReturnType<typeof getUnit>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -308,11 +318,11 @@ export const useGetUnitQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getUnit>>> = ({ signal }) =>
     getUnit(unitId, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseQueryOptions<Awaited<ReturnType<typeof getUnit>>, TError, TData> & {
-    queryKey: QueryKey;
-  };
+  return { queryKey, queryFn, enabled: !!unitId, ...queryOptions } as UseQueryOptions<
+    Awaited<ReturnType<typeof getUnit>>,
+    TError,
+    TData
+  > & { queryKey: QueryKey };
 };
 
 export type GetUnitQueryResult = NonNullable<Awaited<ReturnType<typeof getUnit>>>;
@@ -332,7 +342,7 @@ export function useGetUnit<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetUnitQueryOptions(unitId, options);
+  const queryOptions = getGetUnitQueryOptions(unitId, options);
 
   const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
@@ -341,7 +351,20 @@ export function useGetUnit<
   return query;
 }
 
-export const useGetUnitSuspenseQueryOptions = <
+/**
+ * @summary Gets an Organisational Unit
+ */
+export const invalidateGetUnit = async (
+  queryClient: QueryClient,
+  unitId: string,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries({ queryKey: getGetUnitQueryKey(unitId) }, options);
+
+  return queryClient;
+};
+
+export const getGetUnitSuspenseQueryOptions = <
   TData = Awaited<ReturnType<typeof getUnit>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -358,9 +381,7 @@ export const useGetUnitSuspenseQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getUnit>>> = ({ signal }) =>
     getUnit(unitId, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseSuspenseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
     Awaited<ReturnType<typeof getUnit>>,
     TError,
     TData
@@ -384,7 +405,7 @@ export function useGetUnitSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetUnitSuspenseQueryOptions(unitId, options);
+  const queryOptions = getGetUnitSuspenseQueryOptions(unitId, options);
 
   const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
@@ -418,7 +439,7 @@ export const patchUnit = (
   );
 };
 
-export const usePatchUnitMutationOptions = <
+export const getPatchUnitMutationOptions = <
   TError = ErrorType<void | AsError>,
   TContext = unknown,
 >(options?: {
@@ -451,9 +472,7 @@ export const usePatchUnitMutationOptions = <
     return patchUnit(unitId, data, requestOptions);
   };
 
-  const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
-
-  return customOptions;
+  return { mutationFn, ...mutationOptions };
 };
 
 export type PatchUnitMutationResult = NonNullable<Awaited<ReturnType<typeof patchUnit>>>;
@@ -477,7 +496,7 @@ export const usePatchUnit = <TError = ErrorType<void | AsError>, TContext = unkn
   { unitId: string; data: UnitPatchBodyBody },
   TContext
 > => {
-  const mutationOptions = usePatchUnitMutationOptions(options);
+  const mutationOptions = getPatchUnitMutationOptions(options);
 
   return useMutation(mutationOptions);
 };
@@ -497,7 +516,7 @@ export const deleteOrganisationUnit = (
   return customInstance<void>({ url: `/unit/${unitId}`, method: "DELETE" }, options);
 };
 
-export const useDeleteOrganisationUnitMutationOptions = <
+export const getDeleteOrganisationUnitMutationOptions = <
   TError = ErrorType<void | AsError>,
   TContext = unknown,
 >(options?: {
@@ -530,9 +549,7 @@ export const useDeleteOrganisationUnitMutationOptions = <
     return deleteOrganisationUnit(unitId, requestOptions);
   };
 
-  const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
-
-  return customOptions;
+  return { mutationFn, ...mutationOptions };
 };
 
 export type DeleteOrganisationUnitMutationResult = NonNullable<
@@ -561,7 +578,7 @@ export const useDeleteOrganisationUnit = <
   { unitId: string },
   TContext
 > => {
-  const mutationOptions = useDeleteOrganisationUnitMutationOptions(options);
+  const mutationOptions = getDeleteOrganisationUnitMutationOptions(options);
 
   return useMutation(mutationOptions);
 };
@@ -576,10 +593,10 @@ export const getPersonalUnit = (
 };
 
 export const getGetPersonalUnitQueryKey = () => {
-  return [`/personal-unit`] as const;
+  return ["account-server", "personal-unit"] as const;
 };
 
-export const useGetPersonalUnitQueryOptions = <
+export const getGetPersonalUnitQueryOptions = <
   TData = Awaited<ReturnType<typeof getPersonalUnit>>,
   TError = ErrorType<void | AsError>,
 >(options?: {
@@ -593,9 +610,7 @@ export const useGetPersonalUnitQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getPersonalUnit>>> = ({ signal }) =>
     getPersonalUnit(requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
     Awaited<ReturnType<typeof getPersonalUnit>>,
     TError,
     TData
@@ -616,7 +631,7 @@ export function useGetPersonalUnit<
   query?: UseQueryOptions<Awaited<ReturnType<typeof getPersonalUnit>>, TError, TData>;
   request?: SecondParameter<typeof customInstance>;
 }): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetPersonalUnitQueryOptions(options);
+  const queryOptions = getGetPersonalUnitQueryOptions(options);
 
   const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
@@ -625,7 +640,19 @@ export function useGetPersonalUnit<
   return query;
 }
 
-export const useGetPersonalUnitSuspenseQueryOptions = <
+/**
+ * @summary Gets your Personal Unit (if you have one)
+ */
+export const invalidateGetPersonalUnit = async (
+  queryClient: QueryClient,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries({ queryKey: getGetPersonalUnitQueryKey() }, options);
+
+  return queryClient;
+};
+
+export const getGetPersonalUnitSuspenseQueryOptions = <
   TData = Awaited<ReturnType<typeof getPersonalUnit>>,
   TError = ErrorType<void | AsError>,
 >(options?: {
@@ -639,9 +666,7 @@ export const useGetPersonalUnitSuspenseQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getPersonalUnit>>> = ({ signal }) =>
     getPersonalUnit(requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseSuspenseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
     Awaited<ReturnType<typeof getPersonalUnit>>,
     TError,
     TData
@@ -664,7 +689,7 @@ export function useGetPersonalUnitSuspense<
   query?: UseSuspenseQueryOptions<Awaited<ReturnType<typeof getPersonalUnit>>, TError, TData>;
   request?: SecondParameter<typeof customInstance>;
 }): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetPersonalUnitSuspenseQueryOptions(options);
+  const queryOptions = getGetPersonalUnitSuspenseQueryOptions(options);
 
   const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
@@ -697,7 +722,7 @@ export const createPersonalUnit = (
   );
 };
 
-export const useCreatePersonalUnitMutationOptions = <
+export const getCreatePersonalUnitMutationOptions = <
   TError = ErrorType<AsError | void>,
   TContext = unknown,
 >(options?: {
@@ -730,9 +755,7 @@ export const useCreatePersonalUnitMutationOptions = <
     return createPersonalUnit(data, requestOptions);
   };
 
-  const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
-
-  return customOptions;
+  return { mutationFn, ...mutationOptions };
 };
 
 export type CreatePersonalUnitMutationResult = NonNullable<
@@ -761,7 +784,7 @@ export const useCreatePersonalUnit = <
   { data: PersonalUnitPutBodyBody },
   TContext
 > => {
-  const mutationOptions = useCreatePersonalUnitMutationOptions(options);
+  const mutationOptions = getCreatePersonalUnitMutationOptions(options);
 
   return useMutation(mutationOptions);
 };
@@ -774,7 +797,7 @@ export const deletePersonalUnit = (options?: SecondParameter<typeof customInstan
   return customInstance<void>({ url: `/personal-unit`, method: "DELETE" }, options);
 };
 
-export const useDeletePersonalUnitMutationOptions = <
+export const getDeletePersonalUnitMutationOptions = <
   TError = ErrorType<void | AsError>,
   TContext = unknown,
 >(options?: {
@@ -797,9 +820,7 @@ export const useDeletePersonalUnitMutationOptions = <
     return deletePersonalUnit(requestOptions);
   };
 
-  const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
-
-  return customOptions;
+  return { mutationFn, ...mutationOptions };
 };
 
 export type DeletePersonalUnitMutationResult = NonNullable<
@@ -823,7 +844,7 @@ export const useDeletePersonalUnit = <
   >;
   request?: SecondParameter<typeof customInstance>;
 }): UseMutationResult<Awaited<ReturnType<typeof deletePersonalUnit>>, TError, void, TContext> => {
-  const mutationOptions = useDeletePersonalUnitMutationOptions(options);
+  const mutationOptions = getDeletePersonalUnitMutationOptions(options);
 
   return useMutation(mutationOptions);
 };
@@ -843,10 +864,10 @@ export const getUnits = (
 };
 
 export const getGetUnitsQueryKey = (params?: GetUnitsParams) => {
-  return [`/unit`, ...(params ? [params] : [])] as const;
+  return ["account-server", "unit", ...(params ? [params] : [])] as const;
 };
 
-export const useGetUnitsQueryOptions = <
+export const getGetUnitsQueryOptions = <
   TData = Awaited<ReturnType<typeof getUnits>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -863,11 +884,11 @@ export const useGetUnitsQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getUnits>>> = ({ signal }) =>
     getUnits(params, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseQueryOptions<Awaited<ReturnType<typeof getUnits>>, TError, TData> & {
-    queryKey: QueryKey;
-  };
+  return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
+    Awaited<ReturnType<typeof getUnits>>,
+    TError,
+    TData
+  > & { queryKey: QueryKey };
 };
 
 export type GetUnitsQueryResult = NonNullable<Awaited<ReturnType<typeof getUnits>>>;
@@ -887,7 +908,7 @@ export function useGetUnits<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetUnitsQueryOptions(params, options);
+  const queryOptions = getGetUnitsQueryOptions(params, options);
 
   const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
@@ -896,7 +917,20 @@ export function useGetUnits<
   return query;
 }
 
-export const useGetUnitsSuspenseQueryOptions = <
+/**
+ * @summary Gets Units
+ */
+export const invalidateGetUnits = async (
+  queryClient: QueryClient,
+  params?: GetUnitsParams,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries({ queryKey: getGetUnitsQueryKey(params) }, options);
+
+  return queryClient;
+};
+
+export const getGetUnitsSuspenseQueryOptions = <
   TData = Awaited<ReturnType<typeof getUnits>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -913,9 +947,7 @@ export const useGetUnitsSuspenseQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getUnits>>> = ({ signal }) =>
     getUnits(params, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseSuspenseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
     Awaited<ReturnType<typeof getUnits>>,
     TError,
     TData
@@ -939,7 +971,7 @@ export function useGetUnitsSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetUnitsSuspenseQueryOptions(params, options);
+  const queryOptions = getGetUnitsSuspenseQueryOptions(params, options);
 
   const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
@@ -974,7 +1006,7 @@ export const createDefaultUnit = (
   );
 };
 
-export const useCreateDefaultUnitMutationOptions = <
+export const getCreateDefaultUnitMutationOptions = <
   TError = ErrorType<AsError | void>,
   TContext = unknown,
 >(options?: {
@@ -1007,9 +1039,7 @@ export const useCreateDefaultUnitMutationOptions = <
     return createDefaultUnit(data, requestOptions);
   };
 
-  const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
-
-  return customOptions;
+  return { mutationFn, ...mutationOptions };
 };
 
 export type CreateDefaultUnitMutationResult = NonNullable<
@@ -1038,7 +1068,7 @@ export const useCreateDefaultUnit = <
   { data: PersonalUnitPutBodyBody },
   TContext
 > => {
-  const mutationOptions = useCreateDefaultUnitMutationOptions(options);
+  const mutationOptions = getCreateDefaultUnitMutationOptions(options);
 
   return useMutation(mutationOptions);
 };
@@ -1053,7 +1083,7 @@ export const deleteDefaultUnit = (options?: SecondParameter<typeof customInstanc
   return customInstance<void>({ url: `/unit`, method: "DELETE" }, options);
 };
 
-export const useDeleteDefaultUnitMutationOptions = <
+export const getDeleteDefaultUnitMutationOptions = <
   TError = ErrorType<void | AsError>,
   TContext = unknown,
 >(options?: {
@@ -1076,9 +1106,7 @@ export const useDeleteDefaultUnitMutationOptions = <
     return deleteDefaultUnit(requestOptions);
   };
 
-  const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
-
-  return customOptions;
+  return { mutationFn, ...mutationOptions };
 };
 
 export type DeleteDefaultUnitMutationResult = NonNullable<
@@ -1102,7 +1130,7 @@ export const useDeleteDefaultUnit = <
   >;
   request?: SecondParameter<typeof customInstance>;
 }): UseMutationResult<Awaited<ReturnType<typeof deleteDefaultUnit>>, TError, void, TContext> => {
-  const mutationOptions = useDeleteDefaultUnitMutationOptions(options);
+  const mutationOptions = getDeleteDefaultUnitMutationOptions(options);
 
   return useMutation(mutationOptions);
 };