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

package/src/api/organisation/organisation.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,
@@ -30,12 +32,10 @@ import type {
   OrganisationPostBodyBody,
   OrganisationPostResponse,
   OrganisationsGetResponse,
-} 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 getOrganisations = (
 };
 
 export const getGetOrganisationsQueryKey = (params?: GetOrganisationsParams) => {
-  return [`/organisation`, ...(params ? [params] : [])] as const;
+  return ["account-server", "organisation", ...(params ? [params] : [])] as const;
 };
 
-export const useGetOrganisationsQueryOptions = <
+export const getGetOrganisationsQueryOptions = <
   TData = Awaited<ReturnType<typeof getOrganisations>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -78,9 +78,7 @@ export const useGetOrganisationsQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getOrganisations>>> = ({ signal }) =>
     getOrganisations(params, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
     Awaited<ReturnType<typeof getOrganisations>>,
     TError,
     TData
@@ -104,7 +102,7 @@ export function useGetOrganisations<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetOrganisationsQueryOptions(params, options);
+  const queryOptions = getGetOrganisationsQueryOptions(params, options);
 
   const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
@@ -113,7 +111,20 @@ export function useGetOrganisations<
   return query;
 }
 
-export const useGetOrganisationsSuspenseQueryOptions = <
+/**
+ * @summary Gets Organisations
+ */
+export const invalidateGetOrganisations = async (
+  queryClient: QueryClient,
+  params?: GetOrganisationsParams,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries({ queryKey: getGetOrganisationsQueryKey(params) }, options);
+
+  return queryClient;
+};
+
+export const getGetOrganisationsSuspenseQueryOptions = <
   TData = Awaited<ReturnType<typeof getOrganisations>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -130,9 +141,7 @@ export const useGetOrganisationsSuspenseQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getOrganisations>>> = ({ signal }) =>
     getOrganisations(params, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseSuspenseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
     Awaited<ReturnType<typeof getOrganisations>>,
     TError,
     TData
@@ -158,7 +167,7 @@ export function useGetOrganisationsSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetOrganisationsSuspenseQueryOptions(params, options);
+  const queryOptions = getGetOrganisationsSuspenseQueryOptions(params, options);
 
   const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
@@ -195,7 +204,7 @@ export const createOrganisation = (
   );
 };
 
-export const useCreateOrganisationMutationOptions = <
+export const getCreateOrganisationMutationOptions = <
   TError = ErrorType<AsError | void>,
   TContext = unknown,
 >(options?: {
@@ -228,9 +237,7 @@ export const useCreateOrganisationMutationOptions = <
     return createOrganisation(data, requestOptions);
   };
 
-  const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
-
-  return customOptions;
+  return { mutationFn, ...mutationOptions };
 };
 
 export type CreateOrganisationMutationResult = NonNullable<
@@ -259,7 +266,7 @@ export const useCreateOrganisation = <
   { data: OrganisationPostBodyBody },
   TContext
 > => {
-  const mutationOptions = useCreateOrganisationMutationOptions(options);
+  const mutationOptions = getCreateOrganisationMutationOptions(options);
 
   return useMutation(mutationOptions);
 };
@@ -282,10 +289,10 @@ export const getOrganisation = (
 };
 
 export const getGetOrganisationQueryKey = (orgId?: string) => {
-  return [`/organisation/${orgId}`] as const;
+  return ["account-server", "organisation", orgId] as const;
 };
 
-export const useGetOrganisationQueryOptions = <
+export const getGetOrganisationQueryOptions = <
   TData = Awaited<ReturnType<typeof getOrganisation>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -302,9 +309,7 @@ export const useGetOrganisationQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getOrganisation>>> = ({ signal }) =>
     getOrganisation(orgId, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseQueryOptions<
+  return { queryKey, queryFn, enabled: !!orgId, ...queryOptions } as UseQueryOptions<
     Awaited<ReturnType<typeof getOrganisation>>,
     TError,
     TData
@@ -328,7 +333,7 @@ export function useGetOrganisation<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetOrganisationQueryOptions(orgId, options);
+  const queryOptions = getGetOrganisationQueryOptions(orgId, options);
 
   const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
@@ -337,7 +342,20 @@ export function useGetOrganisation<
   return query;
 }
 
-export const useGetOrganisationSuspenseQueryOptions = <
+/**
+ * @summary Gets an Organisation
+ */
+export const invalidateGetOrganisation = async (
+  queryClient: QueryClient,
+  orgId: string,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries({ queryKey: getGetOrganisationQueryKey(orgId) }, options);
+
+  return queryClient;
+};
+
+export const getGetOrganisationSuspenseQueryOptions = <
   TData = Awaited<ReturnType<typeof getOrganisation>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -354,9 +372,7 @@ export const useGetOrganisationSuspenseQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getOrganisation>>> = ({ signal }) =>
     getOrganisation(orgId, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseSuspenseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
     Awaited<ReturnType<typeof getOrganisation>>,
     TError,
     TData
@@ -382,7 +398,7 @@ export function useGetOrganisationSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetOrganisationSuspenseQueryOptions(orgId, options);
+  const queryOptions = getGetOrganisationSuspenseQueryOptions(orgId, options);
 
   const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
@@ -418,7 +434,7 @@ export const patchOrganisation = (
   );
 };
 
-export const usePatchOrganisationMutationOptions = <
+export const getPatchOrganisationMutationOptions = <
   TError = ErrorType<void | AsError>,
   TContext = unknown,
 >(options?: {
@@ -451,9 +467,7 @@ export const usePatchOrganisationMutationOptions = <
     return patchOrganisation(orgId, data, requestOptions);
   };
 
-  const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
-
-  return customOptions;
+  return { mutationFn, ...mutationOptions };
 };
 
 export type PatchOrganisationMutationResult = NonNullable<
@@ -482,7 +496,7 @@ export const usePatchOrganisation = <
   { orgId: string; data: OrganisationPatchBodyBody },
   TContext
 > => {
-  const mutationOptions = usePatchOrganisationMutationOptions(options);
+  const mutationOptions = getPatchOrganisationMutationOptions(options);
 
   return useMutation(mutationOptions);
 };
@@ -500,7 +514,7 @@ export const deleteOrganisation = (
   return customInstance<void>({ url: `/organisation/${orgId}`, method: "DELETE" }, options);
 };
 
-export const useDeleteOrganisationMutationOptions = <
+export const getDeleteOrganisationMutationOptions = <
   TError = ErrorType<AsError | void>,
   TContext = unknown,
 >(options?: {
@@ -533,9 +547,7 @@ export const useDeleteOrganisationMutationOptions = <
     return deleteOrganisation(orgId, requestOptions);
   };
 
-  const customOptions = mutationMutator({ ...mutationOptions, mutationFn });
-
-  return customOptions;
+  return { mutationFn, ...mutationOptions };
 };
 
 export type DeleteOrganisationMutationResult = NonNullable<
@@ -564,7 +576,7 @@ export const useDeleteOrganisation = <
   { orgId: string },
   TContext
 > => {
-  const mutationOptions = useDeleteOrganisationMutationOptions(options);
+  const mutationOptions = getDeleteOrganisationMutationOptions(options);
 
   return useMutation(mutationOptions);
 };
@@ -586,10 +598,10 @@ export const getDefaultOrganisation = (
 };
 
 export const getGetDefaultOrganisationQueryKey = () => {
-  return [`/default/organisation`] as const;
+  return ["account-server", "default", "organisation"] as const;
 };
 
-export const useGetDefaultOrganisationQueryOptions = <
+export const getGetDefaultOrganisationQueryOptions = <
   TData = Awaited<ReturnType<typeof getDefaultOrganisation>>,
   TError = ErrorType<void | AsError>,
 >(options?: {
@@ -603,9 +615,7 @@ export const useGetDefaultOrganisationQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getDefaultOrganisation>>> = ({ signal }) =>
     getDefaultOrganisation(requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
     Awaited<ReturnType<typeof getDefaultOrganisation>>,
     TError,
     TData
@@ -628,7 +638,7 @@ export function useGetDefaultOrganisation<
   query?: UseQueryOptions<Awaited<ReturnType<typeof getDefaultOrganisation>>, TError, TData>;
   request?: SecondParameter<typeof customInstance>;
 }): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetDefaultOrganisationQueryOptions(options);
+  const queryOptions = getGetDefaultOrganisationQueryOptions(options);
 
   const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
@@ -637,7 +647,19 @@ export function useGetDefaultOrganisation<
   return query;
 }
 
-export const useGetDefaultOrganisationSuspenseQueryOptions = <
+/**
+ * @summary Gets the Default Organisation
+ */
+export const invalidateGetDefaultOrganisation = async (
+  queryClient: QueryClient,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries({ queryKey: getGetDefaultOrganisationQueryKey() }, options);
+
+  return queryClient;
+};
+
+export const getGetDefaultOrganisationSuspenseQueryOptions = <
   TData = Awaited<ReturnType<typeof getDefaultOrganisation>>,
   TError = ErrorType<void | AsError>,
 >(options?: {
@@ -655,9 +677,7 @@ export const useGetDefaultOrganisationSuspenseQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getDefaultOrganisation>>> = ({ signal }) =>
     getDefaultOrganisation(requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseSuspenseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
     Awaited<ReturnType<typeof getDefaultOrganisation>>,
     TError,
     TData
@@ -684,7 +704,7 @@ export function useGetDefaultOrganisationSuspense<
   >;
   request?: SecondParameter<typeof customInstance>;
 }): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetDefaultOrganisationSuspenseQueryOptions(options);
+  const queryOptions = getGetDefaultOrganisationSuspenseQueryOptions(options);
 
   const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;