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

package/src/api/charges/charges.ts

@@ -10,6 +10,8 @@ A service that provides access to the Account Server, which gives *registered* u
  */
 import { useQuery, useSuspenseQuery } from "@tanstack/react-query";
 import type {
+  InvalidateOptions,
+  QueryClient,
   QueryFunction,
   QueryKey,
   UseQueryOptions,
@@ -28,11 +30,10 @@ import type {
   OrganisationChargesGetResponse,
   ProductChargesGetResponse,
   UnitChargesGetResponse,
-} from "../api.schemas";
+} from ".././api-schemas";
 
-import { customInstance } from "../../custom-instance";
-import type { ErrorType } from "../../custom-instance";
-import { queryMutator } from "../../options-mutator";
+import { customInstance } from "../../custom-axios";
+import type { ErrorType } from "../../custom-axios";
 
 type SecondParameter<T extends (...args: never) => unknown> = Parameters<T>[1];
 
@@ -55,10 +56,10 @@ export const getCharges = (
 };
 
 export const getGetChargesQueryKey = (params?: GetChargesParams) => {
-  return [`/charges`, ...(params ? [params] : [])] as const;
+  return ["account-server", "charges", ...(params ? [params] : [])] as const;
 };
 
-export const useGetChargesQueryOptions = <
+export const getGetChargesQueryOptions = <
   TData = Awaited<ReturnType<typeof getCharges>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -75,11 +76,11 @@ export const useGetChargesQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getCharges>>> = ({ signal }) =>
     getCharges(params, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseQueryOptions<Awaited<ReturnType<typeof getCharges>>, TError, TData> & {
-    queryKey: QueryKey;
-  };
+  return { queryKey, queryFn, ...queryOptions } as UseQueryOptions<
+    Awaited<ReturnType<typeof getCharges>>,
+    TError,
+    TData
+  > & { queryKey: QueryKey };
 };
 
 export type GetChargesQueryResult = NonNullable<Awaited<ReturnType<typeof getCharges>>>;
@@ -99,7 +100,7 @@ export function useGetCharges<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetChargesQueryOptions(params, options);
+  const queryOptions = getGetChargesQueryOptions(params, options);
 
   const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
@@ -108,7 +109,20 @@ export function useGetCharges<
   return query;
 }
 
-export const useGetChargesSuspenseQueryOptions = <
+/**
+ * @summary Gets charges for all Organisations
+ */
+export const invalidateGetCharges = async (
+  queryClient: QueryClient,
+  params?: GetChargesParams,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries({ queryKey: getGetChargesQueryKey(params) }, options);
+
+  return queryClient;
+};
+
+export const getGetChargesSuspenseQueryOptions = <
   TData = Awaited<ReturnType<typeof getCharges>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -125,9 +139,7 @@ export const useGetChargesSuspenseQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getCharges>>> = ({ signal }) =>
     getCharges(params, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseSuspenseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
     Awaited<ReturnType<typeof getCharges>>,
     TError,
     TData
@@ -151,7 +163,7 @@ export function useGetChargesSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetChargesSuspenseQueryOptions(params, options);
+  const queryOptions = getGetChargesSuspenseQueryOptions(params, options);
 
   const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
@@ -185,10 +197,10 @@ export const getGetOrganisationChargesQueryKey = (
   orgId?: string,
   params?: GetOrganisationChargesParams,
 ) => {
-  return [`/charges/organisation/${orgId}`, ...(params ? [params] : [])] as const;
+  return ["account-server", "charges", "organisation", orgId, ...(params ? [params] : [])] as const;
 };
 
-export const useGetOrganisationChargesQueryOptions = <
+export const getGetOrganisationChargesQueryOptions = <
   TData = Awaited<ReturnType<typeof getOrganisationCharges>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -206,9 +218,7 @@ export const useGetOrganisationChargesQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getOrganisationCharges>>> = ({ signal }) =>
     getOrganisationCharges(orgId, params, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseQueryOptions<
+  return { queryKey, queryFn, enabled: !!orgId, ...queryOptions } as UseQueryOptions<
     Awaited<ReturnType<typeof getOrganisationCharges>>,
     TError,
     TData
@@ -235,7 +245,7 @@ export function useGetOrganisationCharges<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetOrganisationChargesQueryOptions(orgId, params, options);
+  const queryOptions = getGetOrganisationChargesQueryOptions(orgId, params, options);
 
   const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
@@ -244,7 +254,24 @@ export function useGetOrganisationCharges<
   return query;
 }
 
-export const useGetOrganisationChargesSuspenseQueryOptions = <
+/**
+ * @summary Gets charges for all Units in an Organisation
+ */
+export const invalidateGetOrganisationCharges = async (
+  queryClient: QueryClient,
+  orgId: string,
+  params?: GetOrganisationChargesParams,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries(
+    { queryKey: getGetOrganisationChargesQueryKey(orgId, params) },
+    options,
+  );
+
+  return queryClient;
+};
+
+export const getGetOrganisationChargesSuspenseQueryOptions = <
   TData = Awaited<ReturnType<typeof getOrganisationCharges>>,
   TError = ErrorType<void | AsError>,
 >(
@@ -266,9 +293,7 @@ export const useGetOrganisationChargesSuspenseQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getOrganisationCharges>>> = ({ signal }) =>
     getOrganisationCharges(orgId, params, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseSuspenseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
     Awaited<ReturnType<typeof getOrganisationCharges>>,
     TError,
     TData
@@ -299,7 +324,7 @@ export function useGetOrganisationChargesSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetOrganisationChargesSuspenseQueryOptions(orgId, params, options);
+  const queryOptions = getGetOrganisationChargesSuspenseQueryOptions(orgId, params, options);
 
   const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
@@ -336,10 +361,10 @@ export const getGetProductChargesQueryKey = (
   productId?: string,
   params?: GetProductChargesParams,
 ) => {
-  return [`/charges/product/${productId}`, ...(params ? [params] : [])] as const;
+  return ["account-server", "charges", "product", productId, ...(params ? [params] : [])] as const;
 };
 
-export const useGetProductChargesQueryOptions = <
+export const getGetProductChargesQueryOptions = <
   TData = Awaited<ReturnType<typeof getProductCharges>>,
   TError = ErrorType<AsError | void>,
 >(
@@ -357,9 +382,7 @@ export const useGetProductChargesQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getProductCharges>>> = ({ signal }) =>
     getProductCharges(productId, params, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseQueryOptions<
+  return { queryKey, queryFn, enabled: !!productId, ...queryOptions } as UseQueryOptions<
     Awaited<ReturnType<typeof getProductCharges>>,
     TError,
     TData
@@ -386,7 +409,7 @@ export function useGetProductCharges<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetProductChargesQueryOptions(productId, params, options);
+  const queryOptions = getGetProductChargesQueryOptions(productId, params, options);
 
   const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
@@ -395,7 +418,24 @@ export function useGetProductCharges<
   return query;
 }
 
-export const useGetProductChargesSuspenseQueryOptions = <
+/**
+ * @summary Get charges made against a Product
+ */
+export const invalidateGetProductCharges = async (
+  queryClient: QueryClient,
+  productId: string,
+  params?: GetProductChargesParams,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries(
+    { queryKey: getGetProductChargesQueryKey(productId, params) },
+    options,
+  );
+
+  return queryClient;
+};
+
+export const getGetProductChargesSuspenseQueryOptions = <
   TData = Awaited<ReturnType<typeof getProductCharges>>,
   TError = ErrorType<AsError | void>,
 >(
@@ -413,9 +453,7 @@ export const useGetProductChargesSuspenseQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getProductCharges>>> = ({ signal }) =>
     getProductCharges(productId, params, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseSuspenseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
     Awaited<ReturnType<typeof getProductCharges>>,
     TError,
     TData
@@ -442,7 +480,7 @@ export function useGetProductChargesSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetProductChargesSuspenseQueryOptions(productId, params, options);
+  const queryOptions = getGetProductChargesSuspenseQueryOptions(productId, params, options);
 
   const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;
@@ -475,10 +513,10 @@ export const getUnitCharges = (
 };
 
 export const getGetUnitChargesQueryKey = (unitId?: string, params?: GetUnitChargesParams) => {
-  return [`/charges/unit/${unitId}`, ...(params ? [params] : [])] as const;
+  return ["account-server", "charges", "unit", unitId, ...(params ? [params] : [])] as const;
 };
 
-export const useGetUnitChargesQueryOptions = <
+export const getGetUnitChargesQueryOptions = <
   TData = Awaited<ReturnType<typeof getUnitCharges>>,
   TError = ErrorType<AsError | void>,
 >(
@@ -496,9 +534,7 @@ export const useGetUnitChargesQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getUnitCharges>>> = ({ signal }) =>
     getUnitCharges(unitId, params, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseQueryOptions<
+  return { queryKey, queryFn, enabled: !!unitId, ...queryOptions } as UseQueryOptions<
     Awaited<ReturnType<typeof getUnitCharges>>,
     TError,
     TData
@@ -523,7 +559,7 @@ export function useGetUnitCharges<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetUnitChargesQueryOptions(unitId, params, options);
+  const queryOptions = getGetUnitChargesQueryOptions(unitId, params, options);
 
   const query = useQuery(queryOptions) as UseQueryResult<TData, TError> & { queryKey: QueryKey };
 
@@ -532,7 +568,24 @@ export function useGetUnitCharges<
   return query;
 }
 
-export const useGetUnitChargesSuspenseQueryOptions = <
+/**
+ * @summary Get charges made against a Unit
+ */
+export const invalidateGetUnitCharges = async (
+  queryClient: QueryClient,
+  unitId: string,
+  params?: GetUnitChargesParams,
+  options?: InvalidateOptions,
+): Promise<QueryClient> => {
+  await queryClient.invalidateQueries(
+    { queryKey: getGetUnitChargesQueryKey(unitId, params) },
+    options,
+  );
+
+  return queryClient;
+};
+
+export const getGetUnitChargesSuspenseQueryOptions = <
   TData = Awaited<ReturnType<typeof getUnitCharges>>,
   TError = ErrorType<AsError | void>,
 >(
@@ -550,9 +603,7 @@ export const useGetUnitChargesSuspenseQueryOptions = <
   const queryFn: QueryFunction<Awaited<ReturnType<typeof getUnitCharges>>> = ({ signal }) =>
     getUnitCharges(unitId, params, requestOptions, signal);
 
-  const customOptions = queryMutator({ ...queryOptions, queryKey, queryFn });
-
-  return customOptions as UseSuspenseQueryOptions<
+  return { queryKey, queryFn, ...queryOptions } as UseSuspenseQueryOptions<
     Awaited<ReturnType<typeof getUnitCharges>>,
     TError,
     TData
@@ -579,7 +630,7 @@ export function useGetUnitChargesSuspense<
     request?: SecondParameter<typeof customInstance>;
   },
 ): UseSuspenseQueryResult<TData, TError> & { queryKey: QueryKey } {
-  const queryOptions = useGetUnitChargesSuspenseQueryOptions(unitId, params, options);
+  const queryOptions = getGetUnitChargesSuspenseQueryOptions(unitId, params, options);
 
   const query = useSuspenseQuery(queryOptions) as UseSuspenseQueryResult<TData, TError> & {
     queryKey: QueryKey;