@squonk/account-server-client 0.1.26 → 0.1.27-rc.1

package/src/product/product.ts

@@ -8,9 +8,20 @@ A service that provides access to the Account Server, which gives *registered* u
 
  * OpenAPI spec version: 0.1
  */
-import axios, { AxiosRequestConfig, AxiosResponse } from "axios";
+import axios, { AxiosRequestConfig, AxiosResponse, AxiosError } from "axios";
+import {
+  useQuery,
+  useMutation,
+  UseQueryOptions,
+  UseMutationOptions,
+  QueryFunction,
+  MutationFunction,
+  UseQueryResult,
+  QueryKey,
+} from "react-query";
 import type {
   ProductsGetTypesResponse,
+  AsError,
   ProductsGetResponse,
   UnitProductPostResponse,
   UnitProductPostBodyBody,
@@ -18,114 +29,375 @@ import type {
   ProductPatchBodyBody,
 } from "../account-server-api.schemas";
 
-export const getProduct = () => {
-  /**
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (
+  ...args: any
+) => Promise<infer R>
+  ? R
+  : any;
+
+/**
  * Gets product types you can purchase
 
  * @summary Gets all Product Types
  */
-  const appApiProductGetTypes = <
-    TData = AxiosResponse<ProductsGetTypesResponse>
-  >(
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.get(`/product-type`, options);
+export const appApiProductGetTypes = (
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<ProductsGetTypesResponse>> => {
+  return axios.get(`/product-type`, options);
+};
+
+export const getAppApiProductGetTypesQueryKey = () => [`/product-type`];
+
+export type AppApiProductGetTypesQueryResult = NonNullable<
+  AsyncReturnType<typeof appApiProductGetTypes>
+>;
+export type AppApiProductGetTypesQueryError = AxiosError<AsError | void>;
+
+export const useAppApiProductGetTypes = <
+  TData = AsyncReturnType<typeof appApiProductGetTypes>,
+  TError = AxiosError<AsError | void>
+>(options?: {
+  query?: UseQueryOptions<
+    AsyncReturnType<typeof appApiProductGetTypes>,
+    TError,
+    TData
+  >;
+  axios?: AxiosRequestConfig;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, axios: axiosOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getAppApiProductGetTypesQueryKey();
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof appApiProductGetTypes>
+  > = () => appApiProductGetTypes(axiosOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof appApiProductGetTypes>,
+    TError,
+    TData
+  >(queryKey, queryFn, queryOptions);
+
+  return {
+    queryKey,
+    ...query,
   };
-  /**
+};
+
+/**
  * Gets products you have access to, across all Units and Organisations
 
  * @summary Gets all Products
  */
-  const appApiProductGet = <TData = AxiosResponse<ProductsGetResponse>>(
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.get(`/product`, options);
+export const appApiProductGet = (
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<ProductsGetResponse>> => {
+  return axios.get(`/product`, options);
+};
+
+export const getAppApiProductGetQueryKey = () => [`/product`];
+
+export type AppApiProductGetQueryResult = NonNullable<
+  AsyncReturnType<typeof appApiProductGet>
+>;
+export type AppApiProductGetQueryError = AxiosError<AsError | void>;
+
+export const useAppApiProductGet = <
+  TData = AsyncReturnType<typeof appApiProductGet>,
+  TError = AxiosError<AsError | void>
+>(options?: {
+  query?: UseQueryOptions<
+    AsyncReturnType<typeof appApiProductGet>,
+    TError,
+    TData
+  >;
+  axios?: AxiosRequestConfig;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, axios: axiosOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getAppApiProductGetQueryKey();
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof appApiProductGet>> = () =>
+    appApiProductGet(axiosOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof appApiProductGet>,
+    TError,
+    TData
+  >(queryKey, queryFn, queryOptions);
+
+  return {
+    queryKey,
+    ...query,
   };
-  /**
-   * @summary Creates a Product for an Organisational Unit
-   */
-  const appApiProductPost = <TData = AxiosResponse<UnitProductPostResponse>>(
-    unitId: string,
-    unitProductPostBodyBody: UnitProductPostBodyBody,
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.post(
-      `/product/unit/${unitId}`,
-      unitProductPostBodyBody,
-      options
-    );
+};
+
+/**
+ * @summary Creates a Product for an Organisational Unit
+ */
+export const appApiProductPost = (
+  unitId: string,
+  unitProductPostBodyBody: UnitProductPostBodyBody,
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<UnitProductPostResponse>> => {
+  return axios.post(
+    `/product/unit/${unitId}`,
+    unitProductPostBodyBody,
+    options
+  );
+};
+
+export type AppApiProductPostMutationResult = NonNullable<
+  AsyncReturnType<typeof appApiProductPost>
+>;
+export type AppApiProductPostMutationBody = UnitProductPostBodyBody;
+export type AppApiProductPostMutationError = AxiosError<AsError | void>;
+
+export const useAppApiProductPost = <
+  TError = AxiosError<AsError | void>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof appApiProductPost>,
+    TError,
+    { unitId: string; data: UnitProductPostBodyBody },
+    TContext
+  >;
+  axios?: AxiosRequestConfig;
+}) => {
+  const { mutation: mutationOptions, axios: axiosOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof appApiProductPost>,
+    { unitId: string; data: UnitProductPostBodyBody }
+  > = (props) => {
+    const { unitId, data } = props || {};
+
+    return appApiProductPost(unitId, data, axiosOptions);
   };
-  /**
+
+  return useMutation<
+    AsyncReturnType<typeof appApiProductPost>,
+    TError,
+    { unitId: string; data: UnitProductPostBodyBody },
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
  * Gets products you have access to based on an Organisational Unit
 
  * @summary Gets Products for an Organisational Unit
  */
-  const appApiProductGetForUnit = <TData = AxiosResponse<ProductsGetResponse>>(
-    unitId: string,
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.get(`/product/unit/${unitId}`, options);
+export const appApiProductGetForUnit = (
+  unitId: string,
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<ProductsGetResponse>> => {
+  return axios.get(`/product/unit/${unitId}`, options);
+};
+
+export const getAppApiProductGetForUnitQueryKey = (unitId: string) => [
+  `/product/unit/${unitId}`,
+];
+
+export type AppApiProductGetForUnitQueryResult = NonNullable<
+  AsyncReturnType<typeof appApiProductGetForUnit>
+>;
+export type AppApiProductGetForUnitQueryError = AxiosError<void | AsError>;
+
+export const useAppApiProductGetForUnit = <
+  TData = AsyncReturnType<typeof appApiProductGetForUnit>,
+  TError = AxiosError<void | AsError>
+>(
+  unitId: string,
+  options?: {
+    query?: UseQueryOptions<
+      AsyncReturnType<typeof appApiProductGetForUnit>,
+      TError,
+      TData
+    >;
+    axios?: AxiosRequestConfig;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, axios: axiosOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ?? getAppApiProductGetForUnitQueryKey(unitId);
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof appApiProductGetForUnit>
+  > = () => appApiProductGetForUnit(unitId, axiosOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof appApiProductGetForUnit>,
+    TError,
+    TData
+  >(queryKey, queryFn, { enabled: !!unitId, ...queryOptions });
+
+  return {
+    queryKey,
+    ...query,
   };
-  /**
+};
+
+/**
  * Gets a Unit's Product
 
  * @summary Gets a Unit's Product
  */
-  const appApiProductGetUnitProduct = <
-    TData = AxiosResponse<ProductUnitGetResponse>
-  >(
-    unitId: string,
-    productId: string,
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.get(`/product/unit/${unitId}/product/${productId}`, options);
+export const appApiProductGetUnitProduct = (
+  unitId: string,
+  productId: string,
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<ProductUnitGetResponse>> => {
+  return axios.get(`/product/unit/${unitId}/product/${productId}`, options);
+};
+
+export const getAppApiProductGetUnitProductQueryKey = (
+  unitId: string,
+  productId: string
+) => [`/product/unit/${unitId}/product/${productId}`];
+
+export type AppApiProductGetUnitProductQueryResult = NonNullable<
+  AsyncReturnType<typeof appApiProductGetUnitProduct>
+>;
+export type AppApiProductGetUnitProductQueryError = AxiosError<AsError | void>;
+
+export const useAppApiProductGetUnitProduct = <
+  TData = AsyncReturnType<typeof appApiProductGetUnitProduct>,
+  TError = AxiosError<AsError | void>
+>(
+  unitId: string,
+  productId: string,
+  options?: {
+    query?: UseQueryOptions<
+      AsyncReturnType<typeof appApiProductGetUnitProduct>,
+      TError,
+      TData
+    >;
+    axios?: AxiosRequestConfig;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, axios: axiosOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ??
+    getAppApiProductGetUnitProductQueryKey(unitId, productId);
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof appApiProductGetUnitProduct>
+  > = () => appApiProductGetUnitProduct(unitId, productId, axiosOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof appApiProductGetUnitProduct>,
+    TError,
+    TData
+  >(queryKey, queryFn, { enabled: !!(unitId && productId), ...queryOptions });
+
+  return {
+    queryKey,
+    ...query,
   };
-  /**
-   * @summary Deletes an existing Product
-   */
-  const appApiProductDelete = <TData = AxiosResponse<void>>(
-    unitId: string,
-    productId: string,
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.delete(
-      `/product/unit/${unitId}/product/${productId}`,
-      options
-    );
+};
+
+/**
+ * @summary Deletes an existing Product
+ */
+export const appApiProductDelete = (
+  unitId: string,
+  productId: string,
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<void>> => {
+  return axios.delete(`/product/unit/${unitId}/product/${productId}`, options);
+};
+
+export type AppApiProductDeleteMutationResult = NonNullable<
+  AsyncReturnType<typeof appApiProductDelete>
+>;
+
+export type AppApiProductDeleteMutationError = AxiosError<AsError>;
+
+export const useAppApiProductDelete = <
+  TError = AxiosError<AsError>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof appApiProductDelete>,
+    TError,
+    { unitId: string; productId: string },
+    TContext
+  >;
+  axios?: AxiosRequestConfig;
+}) => {
+  const { mutation: mutationOptions, axios: axiosOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof appApiProductDelete>,
+    { unitId: string; productId: string }
+  > = (props) => {
+    const { unitId, productId } = props || {};
+
+    return appApiProductDelete(unitId, productId, axiosOptions);
   };
-  /**
+
+  return useMutation<
+    AsyncReturnType<typeof appApiProductDelete>,
+    TError,
+    { unitId: string; productId: string },
+    TContext
+  >(mutationFn, mutationOptions);
+};
+/**
  * Used to update some adjustable parameters of a Product, i.e. to extend the Allowance or Limit. At the moment Data Manager products can be patched by changing the `name`, it's coin `allowance` or `limit`
 
  * @summary Adjust an existing Product
  */
-  const appApiProductPatch = <TData = AxiosResponse<void>>(
-    unitId: string,
-    productId: string,
-    productPatchBodyBody: ProductPatchBodyBody,
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.patch(
-      `/product/unit/${unitId}/product/${productId}`,
-      productPatchBodyBody,
-      options
-    );
-  };
-  return {
-    appApiProductGetTypes,
-    appApiProductGet,
-    appApiProductPost,
-    appApiProductGetForUnit,
-    appApiProductGetUnitProduct,
-    appApiProductDelete,
-    appApiProductPatch,
+export const appApiProductPatch = (
+  unitId: string,
+  productId: string,
+  productPatchBodyBody: ProductPatchBodyBody,
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<void>> => {
+  return axios.patch(
+    `/product/unit/${unitId}/product/${productId}`,
+    productPatchBodyBody,
+    options
+  );
+};
+
+export type AppApiProductPatchMutationResult = NonNullable<
+  AsyncReturnType<typeof appApiProductPatch>
+>;
+export type AppApiProductPatchMutationBody = ProductPatchBodyBody;
+export type AppApiProductPatchMutationError = AxiosError<AsError>;
+
+export const useAppApiProductPatch = <
+  TError = AxiosError<AsError>,
+  TContext = unknown
+>(options?: {
+  mutation?: UseMutationOptions<
+    AsyncReturnType<typeof appApiProductPatch>,
+    TError,
+    { unitId: string; productId: string; data: ProductPatchBodyBody },
+    TContext
+  >;
+  axios?: AxiosRequestConfig;
+}) => {
+  const { mutation: mutationOptions, axios: axiosOptions } = options || {};
+
+  const mutationFn: MutationFunction<
+    AsyncReturnType<typeof appApiProductPatch>,
+    { unitId: string; productId: string; data: ProductPatchBodyBody }
+  > = (props) => {
+    const { unitId, productId, data } = props || {};
+
+    return appApiProductPatch(unitId, productId, data, axiosOptions);
   };
+
+  return useMutation<
+    AsyncReturnType<typeof appApiProductPatch>,
+    TError,
+    { unitId: string; productId: string; data: ProductPatchBodyBody },
+    TContext
+  >(mutationFn, mutationOptions);
 };
-export type AppApiProductGetTypesResult =
-  AxiosResponse<ProductsGetTypesResponse>;
-export type AppApiProductGetResult = AxiosResponse<ProductsGetResponse>;
-export type AppApiProductPostResult = AxiosResponse<UnitProductPostResponse>;
-export type AppApiProductGetForUnitResult = AxiosResponse<ProductsGetResponse>;
-export type AppApiProductGetUnitProductResult =
-  AxiosResponse<ProductUnitGetResponse>;
-export type AppApiProductDeleteResult = AxiosResponse<void>;
-export type AppApiProductPatchResult = AxiosResponse<void>;

package/src/service/service.ts

@@ -8,35 +8,127 @@ A service that provides access to the Account Server, which gives *registered* u
 
  * OpenAPI spec version: 0.1
  */
-import axios, { AxiosRequestConfig, AxiosResponse } from "axios";
+import axios, { AxiosRequestConfig, AxiosResponse, AxiosError } from "axios";
+import {
+  useQuery,
+  UseQueryOptions,
+  QueryFunction,
+  UseQueryResult,
+  QueryKey,
+} from "react-query";
 import type {
   ServicesGetResponse,
+  AsError,
   ServiceGetResponse,
 } from "../account-server-api.schemas";
 
-export const getService = () => {
-  /**
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (
+  ...args: any
+) => Promise<infer R>
+  ? R
+  : any;
+
+/**
  * Gets services known to the Account Server
 
  * @summary Gets all Services
  */
-  const appApiServiceGet = <TData = AxiosResponse<ServicesGetResponse>>(
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.get(`/service`, options);
+export const appApiServiceGet = (
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<ServicesGetResponse>> => {
+  return axios.get(`/service`, options);
+};
+
+export const getAppApiServiceGetQueryKey = () => [`/service`];
+
+export type AppApiServiceGetQueryResult = NonNullable<
+  AsyncReturnType<typeof appApiServiceGet>
+>;
+export type AppApiServiceGetQueryError = AxiosError<AsError | void>;
+
+export const useAppApiServiceGet = <
+  TData = AsyncReturnType<typeof appApiServiceGet>,
+  TError = AxiosError<AsError | void>
+>(options?: {
+  query?: UseQueryOptions<
+    AsyncReturnType<typeof appApiServiceGet>,
+    TError,
+    TData
+  >;
+  axios?: AxiosRequestConfig;
+}): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, axios: axiosOptions } = options || {};
+
+  const queryKey = queryOptions?.queryKey ?? getAppApiServiceGetQueryKey();
+
+  const queryFn: QueryFunction<AsyncReturnType<typeof appApiServiceGet>> = () =>
+    appApiServiceGet(axiosOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof appApiServiceGet>,
+    TError,
+    TData
+  >(queryKey, queryFn, queryOptions);
+
+  return {
+    queryKey,
+    ...query,
   };
-  /**
+};
+
+/**
  * Gets a known service
 
  * @summary Gets a specific Service
  */
-  const appApiServiceGetId = <TData = AxiosResponse<ServiceGetResponse>>(
-    svcId: number,
-    options?: AxiosRequestConfig
-  ): Promise<TData> => {
-    return axios.get(`/service/${svcId}`, options);
+export const appApiServiceGetId = (
+  svcId: number,
+  options?: AxiosRequestConfig
+): Promise<AxiosResponse<ServiceGetResponse>> => {
+  return axios.get(`/service/${svcId}`, options);
+};
+
+export const getAppApiServiceGetIdQueryKey = (svcId: number) => [
+  `/service/${svcId}`,
+];
+
+export type AppApiServiceGetIdQueryResult = NonNullable<
+  AsyncReturnType<typeof appApiServiceGetId>
+>;
+export type AppApiServiceGetIdQueryError = AxiosError<AsError | void>;
+
+export const useAppApiServiceGetId = <
+  TData = AsyncReturnType<typeof appApiServiceGetId>,
+  TError = AxiosError<AsError | void>
+>(
+  svcId: number,
+  options?: {
+    query?: UseQueryOptions<
+      AsyncReturnType<typeof appApiServiceGetId>,
+      TError,
+      TData
+    >;
+    axios?: AxiosRequestConfig;
+  }
+): UseQueryResult<TData, TError> & { queryKey: QueryKey } => {
+  const { query: queryOptions, axios: axiosOptions } = options || {};
+
+  const queryKey =
+    queryOptions?.queryKey ?? getAppApiServiceGetIdQueryKey(svcId);
+
+  const queryFn: QueryFunction<
+    AsyncReturnType<typeof appApiServiceGetId>
+  > = () => appApiServiceGetId(svcId, axiosOptions);
+
+  const query = useQuery<
+    AsyncReturnType<typeof appApiServiceGetId>,
+    TError,
+    TData
+  >(queryKey, queryFn, { enabled: !!svcId, ...queryOptions });
+
+  return {
+    queryKey,
+    ...query,
   };
-  return { appApiServiceGet, appApiServiceGetId };
 };
-export type AppApiServiceGetResult = AxiosResponse<ServicesGetResponse>;
-export type AppApiServiceGetIdResult = AxiosResponse<ServiceGetResponse>;